1 #LyX 1.5.3 created this file. For more info see http://www.lyx.org/
7 % DO NOT ALTER THIS PREAMBLE!!!
9 %This preamble is designed to ensure that the document prints
10 % out as advertised. If you mess with this preamble,
11 % parts of the document may not print out as expected. If you
12 % have problems LaTeXing this file, please contact
13 % the documentation team
14 % email: lyx-docs@lists.lyx.org
16 \usepackage{ifpdf} % part of the hyperref bundle
17 \ifpdf % if pdflatex is used
19 % set fonts for nicer pdf view
20 \IfFileExists{lmodern.sty}{\usepackage{lmodern}}
21 {\usepackage[scaled=0.92]{helvet}
23 \usepackage{courier} }
25 % link all cross references and URLs in pdf output
26 \usepackage[colorlinks=true, bookmarks, bookmarksnumbered,
27 bookmarksopen, bookmarksopenlevel=2,
28 linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,
29 pdfpagelayout=OneColumn, pdfnewwindow=true,
30 pdfstartview=XYZ, plainpages=false, pdfpagelabels,
31 pdfauthor={LyX Team}, pdftex,
32 pdftitle={Introduction to LyX},pdfsubject={LyX-documentation Intro},
33 pdfkeywords={LyX, documentation}]{hyperref}
35 \else % if dvi or ps is produced
37 % link all cross references and URLs in dvi output
38 \usepackage[ps2pdf]{hyperref}
40 \fi % end if pdflatex is used
42 % the pages of the TOC are numbered roman
43 % and a pdf-bookmark for the TOC is added
45 \let\myTOC\tableofcontents
46 \renewcommand\tableofcontents{%
47 \pdfbookmark[1]{Contents}{}
50 \pagenumbering{arabic} }
52 % redefine the \LyX macro for PDF bookmarks
53 \def\LyX{\texorpdfstring{%
54 L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
61 \font_typewriter default
62 \font_default_family default
76 \paperorientation portrait
79 \paragraph_separation indent
81 \quotes_language english
84 \paperpagestyle default
85 \tracking_changes false
102 \begin_layout Standard
104 If you have comments or error corrections, please send them to the LyX Documenta
107 lyx-docs@lists.lyx.org
115 \begin_layout Standard
116 \begin_inset LatexCommand tableofcontents
123 \begin_layout Section
124 The Philosophy of LyX
127 \begin_layout Subsection
131 \begin_layout Standard
132 LyX is a document preparation system.
133 It excels at letting you create complex technical and scientific articles
134 with mathematics, cross-references, bibliographies, indices, etc.
135 It is very good at documents of any length in which the usual processing
136 abilities are required: automatic sectioning and pagination, spellchecking,
138 It can also be used to write a letter to your mom, though granted, there
139 are probably simpler programs available for that.
140 It is definitely not the best tool for creating banners, flyers, or advertiseme
141 nts (we'll explain why later), though with some effort all these can be
143 Some examples of what it is used for: memos, letters, dissertations and
144 theses, lecture notes, seminar notebooks, conference proceedings, software
145 documentation, books, articles in refereed scientific journals, scripts
146 for plays and movies, business proposals, presentations \SpecialChar \ldots{}
150 \begin_layout Standard
151 LyX is a program that provides a modern approach to writing documents with
152 a computer by using a markup language paradigm, an approach that breaks
153 with the obsolete tradition of the
154 \begin_inset Quotes eld
158 \begin_inset Quotes erd
162 It is designed for authors who want professional output quickly with a
163 minimum of effort without becoming specialists in typesetting.
164 The job of typesetting is done mostly by the computer, not the author;
165 with LyX, the author can concentrate on the contents of her writing.
168 \begin_layout Standard
169 Part of the initial challenge of using LyX comes from the change in thinking
170 that you, the user, must make.
171 At one time, all we had for creating documents were typewriters, so we
172 all learned certain tricks to get around their limitations.
173 Underlining, which is little more than overstriking with the
174 \begin_inset Quotes eld
178 \begin_inset Quotes erd
181 character, became a way to emphasize text.
182 You were forced to figure out column sizes and tab stops, and set them,
183 before creating a table.
184 The same applied for letters and other right justified text.
185 Hyphenation at the end of a line required a careful eye and a lot of foresight.
188 \begin_layout Standard
189 In other words, we've all been trained to worry about the little details
190 of which character goes where.
191 Consequently, almost all word processors have this mentality.
192 They still use tab stops for adding whitespace.
193 You still need to worry about exactly where on the page something will
195 Emphasizing text means changing a font, similar to changing the typewriter
197 This is the underlying philosophy of a WYSIWYG word processor:
198 \begin_inset Quotes eld
201 What You See Is What You Get
202 \begin_inset Quotes erd
206 Unfortunately, that paradigm often results in
207 \begin_inset Quotes eld
210 What You See Is All You Get
211 \begin_inset Quotes erd
217 \begin_layout Standard
218 This is where LyX differs from an ordinary word processor.
219 You don't concern yourself with what character goes where.
224 and LyX takes care of the rest, following a set of rules called a
232 \begin_layout Standard
233 To be fair, most recent versions of the most popular office suites now have
234 some sort of style sheets which follow a similar markup method.
235 However, our experience is that they are still rarely used in practice.
240 Let's look at a little example:
243 \begin_layout Standard
244 Suppose you are writing a report.
245 To begin your report, you want a section called
246 \begin_inset Quotes eld
249 Introduction\SpecialChar \@.
251 \begin_inset Quotes erd
254 So, you go into whatever menu it is in your word processor that changes
255 font sizes and decide on a new font size.
256 Then you turn on bold face.
258 \begin_inset Quotes eld
264 \begin_inset Quotes erd
268 Of course, if you later decide that this section belongs someplace else
269 in the document, or if you insert a new section before it, you need to
270 change the numbering for this and all following sections, as well as any
271 entry in the table of contents.
275 \begin_layout Standard
276 In LyX, you go to the pull-down on the far left of the button bar and select
282 \begin_inset Quotes eld
285 Introduction\SpecialChar \@.
287 \begin_inset Quotes erd
293 \begin_layout Standard
295 If you cut and paste the section, it will automatically be renumbered ---
297 And if you enter references to that section correctly (by inserting cross-refer
298 ence tags), LyX will automatically update them all throughout the file so
299 that you never, ever type a section number.
302 \begin_layout Standard
303 Now let's look at the problem of consistency.
304 Five days later, you reopen your report and start Section\InsetSpace ~
306 However, you forget that you were using 18pt bold instead of 16pt, so you
307 type in the heading for Section\InsetSpace ~
308 4 in a different font that what you used
309 for Section\InsetSpace ~
311 That problem doesn't even exist in LyX.
312 The computer takes care of all that silly bookkeeping about which thing
313 has what size font, not you.
314 After all, that's what a computer is good at.
317 \begin_layout Standard
318 Here's another example.
319 Suppose you're making a list.
320 In other word processors, a list is just a bunch of tab stops and newlines.
321 You need to figure out where to put the label for each list item, what
322 that label should be, how many blank lines to put between each item, and
324 Under LyX, you have only two concerns: what kind of list is this, and what
325 do I want to put in it.
329 \begin_layout Standard
330 So, the basic idea behind LyX is: specify
340 \begin_inset Quotes eld
343 What You See Is What You Get,
344 \begin_inset Quotes erd
348 \begin_inset Quotes eld
351 What You See Is What You
356 \begin_inset Quotes erd
360 \begin_inset Quotes eld
364 \begin_inset Quotes erd
367 It's a powerful idea that greatly simplifies the mechanics of writing documents.
368 This is also why LyX isn't so good for creating posters and flyers---in
373 want to specify exactly where everything goes, because there are no functional
374 units like paragraphs, sections, etc.
375 This doesn't mean LyX is missing some cool function.
376 It simply means that it isn't the right tool for the job --- you don't
377 use a screwdriver to drive in nails.
380 \begin_layout Subsection
381 Differences between LyX and Other Word Processors
385 \begin_layout Standard
389 \begin_layout Standard
402 \begin_layout Standard
409 and Other Word Processors
417 \begin_layout Standard
418 Here's a list of things you won't find in LyX:
421 \begin_layout Itemize
425 \begin_layout Itemize
429 \begin_layout Itemize
430 Extra whitespace (i.e.
442 \begin_layout Standard
443 Tab stops, along with a ruler showing you the position of things on the
444 page, are useless in LyX.
445 The program worries about where things go on the page, not you.
446 Extra whitespace is similar; LyX adds them where necessary, depending on
448 Not being able to type two blank lines in a row will be annoying at first,
449 but it makes more sense once you're thinking in WYSIWYM terms.
452 \begin_layout Standard
453 Here are some things that exist in LyX, but aren't used as you might think:
456 \begin_layout Itemize
460 \begin_layout Itemize
464 \begin_layout Itemize
466 single spaced, double spaced, etc.)
469 \begin_layout Itemize
470 Whitespace, horizontal and vertical
473 \begin_layout Itemize
477 \begin_layout Itemize
478 Typefaces (bold, italic, underline, etc.)
481 \begin_layout Standard
482 Although they exist in LyX, you generally don't need them.
483 LyX will take care of these things for you, depending on what you're doing.
484 Different parts of the document are automatically set in a different typeface
486 Paragraph indenting is context dependent; different types of paragraphs
487 get indented differently.
488 Page breaks get handled automatically, as well.
489 In general, the space between lines, between words, and between paragraphs
490 is variable, set by LyX.
494 \begin_layout Standard
495 There are ways to adjust all of these (only some of which require knowledge
496 of LaTeX), either for a whole document or for a specific location in a
514 \begin_layout Standard
515 Lastly, there are a few areas where we believe LyX (and LaTeX) surpasses
516 many word processors:
519 \begin_layout Itemize
523 \begin_layout Itemize
527 \begin_layout Itemize
531 \begin_layout Itemize
535 \begin_layout Itemize
539 \begin_layout Standard
540 Granted, many modern word processors can handle mathematical symbols, tables,
541 and hyphenation, and many have moved towards style definitions and the
543 However, they've only recently been able to do so, whereas LyX is built
544 upon the LaTeX document preparation system.
545 LaTeX has been around for over 20 years, and
552 \begin_layout Subsection
556 \begin_layout Standard
557 LaTeX is a document preparation system designed by Leslie Lamport in 1985.
561 \begin_layout Standard
562 The source for the info in this section is
563 \begin_inset Quotes eld
571 \begin_inset Quotes erd
574 by Helmut Kopka and Patrick Daly, which has an entry in the bibliography
585 It was built up from a typesetting language called TeX, created by Donald
587 TeX takes a sequence of typesetting commands, written in a script in an
588 ASCII file, and executes them.
590 \begin_inset Quotes eld
594 \begin_inset Quotes erd
597 of the printing trade were modeled by Knuth as computer algorithms and
598 incorporated into TeX, thus its excellent printed appearance.
599 What comes directly out of TeX is the portable document format
604 \begin_inset Quotes eld
608 \begin_inset Quotes erd
616 The dvi format is often used for previews and can later be converted to
617 other formats like PostScript.
621 \begin_layout Standard
622 TeX isn't only a typesetting engine, it also allows you to define macros.
623 Most people who use TeX are actually using a macro package which Knuth
624 created to hide a lot of the typesetting details.
625 This is where Leslie Lamport enters our story.
626 He wanted a macro package that was more user- and less typesetter-oriented,
627 with a set of commands that consistently typeset things like sections,
628 tables or math formulas in an uniform, consistent fashion.
629 This is how LaTeX was born.
632 \begin_layout Standard
633 Now, in parallel with the development and growth of LaTeX, other folks were
634 creating their own custom macro packages for TeX, ones to make slides or
635 articles for math journals and so on.
636 Some used the raw TeX facilities to do this, others began modifying LaTeX.
637 To try and unify this mess, a team of LaTeX-nicians began to work on LaTeX2e,
638 the current version of LaTeX, during the late 1980's.
639 This new version of LaTeX has commands which provide an easier-to-use interface
640 to TeX's macro-creating commands, aid in the use of new fonts, and so on.
641 In fact, LaTeX is quite an extensive language in its own right! Users around
642 the world have been creating their own add-ons for LaTeX beyond the standard
646 \begin_layout Standard
647 There are two ways to extend LaTeX: classes and styles.
652 is a set of LaTeX macros describing a new type of document, like a book,
654 There are classes for slides, for physics and math journals\SpecialChar \ldots{}
656 even have a class for their thesis format! A
660 differs from a class in that it doesn't define a new type of document,
661 but a different type of
665 that any document can use.
666 For example, LyX controls page margins and line spacing using two different
667 LaTeX style-files designed for these purposes.
668 There are style-files for a whole slew of things: printing labels or envelopes,
669 changing indentation behavior, adding new fonts, manipulating graphics,
670 designing fancy page headings, customizing bibliographies, altering the
671 location and appearance of footnotes, tables, and figures, customizing
675 \begin_layout Standard
679 \begin_layout Description
680 TeX: Typesetting language with macro capability.
683 \begin_layout Description
684 LaTeX: Macro package built upon TeX\SpecialChar \@.
688 \begin_layout Description
689 classes: Descriptions of a type of document, using LaTeX\SpecialChar \@.
693 \begin_layout Description
694 styles: Alters the default behavior of LaTeX in some way.
697 \begin_layout Description
698 LyX: Visual, WYSIWYM word-processor that uses LaTeX to do its typesetting.
701 \begin_layout Standard
702 This section attempts to account for the difference between LyX and other
704 Simply put, LaTeX is the difference.
705 By using LaTeX as its backend, LyX helps you think more about
714 The computer then handles
721 \begin_layout Section
722 Navigating the Documentation
725 \begin_layout Standard
726 To make it easier to answer your questions and describe all of the features
727 of LyX, the documentation has been split up into several different files.
728 Each one has its own purpose, as described below.
729 Before you go plowing into any of those files, however, you should read
730 this chapter thoroughly first, since it contains a lot of useful information
731 and commentary that can save you some time.
734 \begin_layout Standard
735 The developing of LyX will hopefully never stop, so that some of the documentati
736 on may be incomplete or a bit out of date, though we try to keep up.
737 Like the rest of LyX, the manuals are the work of a group of volunteers
739 \begin_inset Quotes eld
743 \begin_inset Quotes erd
746 , families, dishes to clean, kitty litter to dispose of, et cetera.
747 If you want to help out, be sure to read Section\InsetSpace ~
749 \begin_inset LatexCommand ref
750 reference "sec:Contrib"
754 in addition to the rest of this document.)
757 \begin_layout Standard
758 Also, please do us a favor -- if anything in these manuals confuses you,
759 is unclear, or wrong, don't hesitate to let us know! You can reach the
760 current document maintainers by mailing to
762 lyx-docs@lists.lyx.org
765 If you have questions which are not obviously answered in the documentation,
766 and need help fast, there is an active users' mailing list which you can
769 lyx-users@lists.lyx.org
774 \begin_layout Subsection
775 The Format of the Manuals
778 \begin_layout Standard
779 Some may have printed out the manuals.
780 Others may be reading it within LyX.
781 There are some differences between the LyX-file and the printed version.
782 First, the title is simply at the top of the document, not formatted on
783 a separate page as in some of the printed versions.
784 Nor are any of the footnotes or the Table of Contents fully visible.
785 To open a footnote, which looks like this:
786 \begin_inset Graphics
787 filename clipart/footnoteQt4.png
792 , click on it with the left mouse button.
793 For the Table of Contents, either click on the grey box or click on the
798 menu, where the contents are displayed automatically\SpecialChar \@.
802 \begin_layout Standard
803 In the printed manuals, all cross-references appear as the actual numbers
804 for a chapter, section, subsection, and so on.
805 Online, however, all cross-references appear as a light-grey box like the
807 \begin_inset Graphics
808 filename clipart/referenceQt4.png
814 If you click on that box with the left mouse button, a dialog box will
815 appear containing a list of all the cross-references in the document.
816 This introduction has only two, the first one is named
817 \begin_inset Quotes eld
821 \begin_inset Quotes erd
825 You can go to the referred section by right-clicking on the box or by clicking
832 in the opened dialog.
833 Going back to where you came from is just as easy.
838 to go back to your earlier location.
841 \begin_layout Standard
842 Now that we've cleared up some of the differences between the printed and
843 online versions of this file, we can start looking at the format of this
845 You'll occasionally notice things in different fonts:
848 \begin_layout Itemize
853 is used for general emphasis, generic arguments, book titles, names of
854 sections of other manuals, and notes from the authors.
857 \begin_layout Itemize
862 is used for program and file names, LyX code and functions.
865 \begin_layout Itemize
870 is used for menu, button, or dialog box names, and the names of keyboard
874 \begin_layout Itemize
879 is used for people's names.
882 \begin_layout Itemize
887 is used for LaTeX code
890 \begin_layout Standard
891 For menu accelerator keys and keybindings, you'll probably get referred
897 \begin_inset Quotes eld
902 Extended Features Manual
905 \begin_inset Quotes erd
913 When we do need to reference keys, we'll use the following prefixing convention
917 \begin_layout Itemize
918 \begin_inset Quotes eld
926 \begin_inset Quotes erd
936 \begin_layout Itemize
937 \begin_inset Quotes eld
945 \begin_inset Quotes erd
955 \begin_layout Itemize
956 \begin_inset Quotes eld
964 \begin_inset Quotes erd
971 key, which on some keyboards will be the
978 \begin_layout Itemize
979 \begin_inset Quotes eld
987 \begin_inset Quotes erd
990 \SpecialChar \ldots{}
992 \begin_inset Quotes eld
1000 \begin_inset Quotes erd
1003 are the function keys.
1006 \begin_layout Itemize
1007 \begin_inset Quotes eld
1015 \begin_inset Quotes erd
1021 \begin_layout Itemize
1022 \begin_inset Quotes eld
1030 \begin_inset Quotes erd
1034 \begin_inset Quotes eld
1042 \begin_inset Quotes erd
1046 \begin_inset Quotes eld
1054 \begin_inset Quotes erd
1058 \begin_inset Quotes eld
1066 \begin_inset Quotes erd
1072 \begin_layout Itemize
1075 \begin_inset Quotes eld
1081 \begin_inset Quotes erd
1085 \begin_inset Quotes eld
1093 \begin_inset Quotes erd
1097 \begin_inset Quotes eld
1105 \begin_inset Quotes erd
1109 \begin_inset Quotes eld
1117 \begin_inset Quotes erd
1121 \begin_inset Quotes eld
1129 \begin_inset Quotes erd
1133 \begin_inset Quotes eld
1141 \begin_inset Quotes erd
1144 : these are the 6 keys that appear above the cursor keys on many PC keyboards.
1146 \begin_inset Quotes eld
1154 \begin_inset Quotes erd
1158 \begin_inset Quotes eld
1166 \begin_inset Quotes erd
1170 \begin_inset Quotes eld
1178 \begin_inset Quotes erd
1182 \begin_inset Quotes eld
1190 \begin_inset Quotes erd
1196 \begin_layout Itemize
1205 both refer to the same key.
1206 Some keyboards label the
1211 \begin_inset Quotes eld
1215 \begin_inset Quotes erd
1219 \begin_inset Quotes eld
1223 \begin_inset Quotes erd
1226 still others have two keys.
1227 LyX treats all of them as the same key, so we'll use
1238 \begin_layout Standard
1239 You'll also see something like
1240 \begin_inset Quotes eld
1246 \begin_inset Quotes els
1252 \begin_inset Quotes ers
1256 \begin_inset Quotes erd
1260 We've listed the possible default keybindings for a function in its entry
1262 \begin_inset Quotes eld
1267 Extended Features Manual
1270 \begin_inset Quotes erd
1273 so check there, too.
1274 Note that there are two different keybinding maps in common use in the
1276 \begin_inset Quotes eld
1280 \begin_inset Quotes erd
1283 style which is the default and familiar to those coming from the PC world,
1285 \begin_inset Quotes eld
1289 \begin_inset Quotes erd
1292 style, which is common with those who
1293 \begin_inset Quotes eld
1297 \begin_inset Quotes erd
1300 on Unix systems and use the Emacs editor.
1301 Unless specifically noted, the keybindings in the documentation are from
1302 the default CUA map.
1303 If you like Emacs, you should be smart enough to read the documentation
1304 and figure out the bindings on your own.
1307 \begin_layout Subsection
1308 Units used in the Manuals
1311 \begin_layout Standard
1312 To understand the units described in this documentation, Table\InsetSpace ~
1314 \begin_inset LatexCommand ref
1315 reference "cap:Units-for-image"
1319 explains all units available in LyX.
1322 \begin_layout Standard
1323 \begin_inset Float table
1329 \begin_layout Standard
1330 \begin_inset Caption
1332 \begin_layout Standard
1333 \begin_inset LatexCommand label
1334 name "cap:Units-for-image"
1346 \begin_layout Standard
1347 \begin_inset VSpace medskip
1353 \begin_layout Standard
1355 \begin_inset Tabular
1356 <lyxtabular version="3" rows="20" columns="2">
1358 <column alignment="center" valignment="top" leftline="true" width="0">
1359 <column alignment="center" valignment="top" leftline="true" rightline="true" width="0">
1360 <row topline="true" bottomline="true">
1361 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1364 \begin_layout Standard
1370 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1373 \begin_layout Standard
1380 <row topline="true">
1381 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1384 \begin_layout Standard
1390 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1393 \begin_layout Standard
1400 <row topline="true">
1401 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1404 \begin_layout Standard
1410 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1413 \begin_layout Standard
1420 <row topline="true">
1421 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1424 \begin_layout Standard
1430 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1433 \begin_layout Standard
1440 <row topline="true">
1441 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1444 \begin_layout Standard
1450 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1453 \begin_layout Standard
1455 \begin_inset Formula $\,$
1459 \begin_inset Formula $\,$
1468 <row topline="true">
1469 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1472 \begin_layout Standard
1478 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1481 \begin_layout Standard
1483 \begin_inset Formula $\,$
1487 \begin_inset Formula $\,$
1496 <row topline="true">
1497 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1500 \begin_layout Standard
1506 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1509 \begin_layout Standard
1511 \begin_inset Formula $\,$
1515 \begin_inset Formula $\,$
1524 <row topline="true">
1525 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1528 \begin_layout Standard
1534 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1537 \begin_layout Standard
1539 \begin_inset Formula $\,$
1543 \begin_inset Formula $\,$
1552 <row topline="true">
1553 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1556 \begin_layout Standard
1562 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1565 \begin_layout Standard
1567 \begin_inset Formula $\,$
1571 \begin_inset Formula $\approx$
1575 \begin_inset Formula $\,$
1584 <row topline="true">
1585 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1588 \begin_layout Standard
1594 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1597 \begin_layout Standard
1599 \begin_inset Formula $\,$
1603 \begin_inset Formula $\,$
1612 <row topline="true">
1613 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1616 \begin_layout Standard
1622 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1625 \begin_layout Standard
1626 % of original image width
1632 <row topline="true">
1633 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1636 \begin_layout Standard
1642 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1645 \begin_layout Standard
1652 <row topline="true">
1653 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1656 \begin_layout Standard
1662 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1665 \begin_layout Standard
1672 <row topline="true">
1673 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1676 \begin_layout Standard
1682 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1685 \begin_layout Standard
1692 <row topline="true">
1693 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1696 \begin_layout Standard
1702 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1705 \begin_layout Standard
1712 <row topline="true">
1713 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1716 \begin_layout Standard
1722 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1725 \begin_layout Standard
1732 <row topline="true">
1733 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1736 \begin_layout Standard
1742 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1745 \begin_layout Standard
1752 <row topline="true">
1753 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1756 \begin_layout Standard
1762 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1765 \begin_layout Standard
1776 <row topline="true">
1777 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1780 \begin_layout Standard
1786 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1789 \begin_layout Standard
1800 <row topline="true" bottomline="true">
1801 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1804 \begin_layout Standard
1810 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1813 \begin_layout Standard
1815 \begin_inset Formula $\,$
1819 \begin_inset Formula $\,$
1840 \begin_layout Subsection
1844 \begin_layout Standard
1845 The following list describes the contents of each of the files in the documentat
1849 \begin_layout Description
1850 Introduction This file.
1853 \begin_layout Description
1854 Tutorial If you are new to LyX, and have never used LaTeX before, you should
1856 If you have used LaTeX before, you should still read the
1860 , starting with the section on
1861 \begin_inset Quotes eld
1864 LyX for LaTeX users.
1865 \begin_inset Quotes erd
1868 (Skimming the rest of the document wouldn't hurt, either.)
1871 \begin_layout Description
1873 Guide The primary documentation.
1878 of the basic operation and available features of LyX here.
1879 The main manual assumes that you've read the
1886 \begin_layout Description
1887 Embedded\InsetSpace ~
1888 Objects Extension of the
1893 Documents in detail how to use tables, graphics, floats, notes, and boxes.
1894 It also includes many tricks of the LaTeX masters.
1897 \begin_layout Description
1898 Extended\InsetSpace ~
1899 Features Extension of the
1904 Documents how to use raw LaTeX commands, additional layouts, and special-purpos
1908 \begin_layout Description
1909 Customization A description of advanced LyX features, including how to customize
1910 the overall behavior of LyX\SpecialChar \@.
1911 This includes such things as keybindings, internati
1912 onalization, and configuration files.
1915 \begin_layout Description
1917 configuration LyX investigates your system upon installation.
1918 This file contains info on what LyX learned about your installation.
1919 Check it to see if you're missing something you might like to have.
1922 \begin_layout Standard
1923 These files will reference one another as necessary.
1932 information on installation and customization, but refers the reader to
1935 Customization Manual
1937 for more information.
1940 \begin_layout Standard
1941 We'll state again an important point:
1944 \begin_layout Standard
1945 \begin_inset VSpace bigskip
1951 \begin_layout Standard
1953 If you are new to LyX, read the
1962 \begin_layout Standard
1963 \begin_inset VSpace bigskip
1969 \begin_layout Standard
1970 Otherwise, you could needlessly frustrate yourself.
1971 LyX does all that you need a word processor to do, but using a different
1975 \begin_layout Section
1976 \begin_inset LatexCommand label
1981 Contributing to the LyX Project
1984 \begin_layout Subsection
1988 \begin_layout Standard
1989 LyX is mostly written in C++ (the LaTeX importer is written in Python).
1990 It is a large project, and as a result it is not free from bugs, or the
1991 need for improvements in the source code.
1994 \begin_layout Subsubsection
1998 \begin_layout Standard
1999 While using LyX, you may find behavior which you consider a bug.
2000 Crashes, though rare, can happen.
2001 User interface problems are considered major bugs by the LyX team: especially
2002 helpful are indications of parts of the LyX interface you find confusing,
2006 \begin_layout Standard
2007 LyX has a bug tracking system, which you can find at
2010 \begin_inset LatexCommand url
2011 target "http://bugzilla.lyx.org/"
2018 You should check the bug tracker before reporting any bugs, in case it
2019 has already been reported.
2020 If you have a comment on an existing bug, or wish to report a new bug,
2021 you may either use the bug tracker, or send an e-mail to the development
2024 lyx-devel@lists.lyx.org
2027 Archives of this list are linked from the main LyX website,
2030 \begin_inset LatexCommand url
2031 target "http://www.lyx.org/"
2040 \begin_layout Standard
2041 A useful bug report will at a minimum include the version of LyX you are
2042 having the problem with.
2043 Accurate, detailed descriptions are preferred - the more time developers
2044 have to spend to pinpoint the source of a bug, the less time they have
2045 for other improvements.
2046 Mention the system and system version you are running LyX with.
2047 Give the versions of the libraries you have installed on your system, and,
2048 if relevant, the versions of external programs that LyX uses.
2049 If it's a compilation or configuration problem, include the file
2053 , and mention which compiler you are using.
2057 \begin_layout Subsubsection
2058 Contributing fixes and new features
2061 \begin_layout Standard
2062 If you have made changes to LyX's source that you think should become part
2063 of LyX, send your changes as a diff file (in unified format) to the development
2064 list referenced above, along with a change log, and a description of what
2068 \begin_layout Subsection
2069 Contributing to the Documentation
2072 \begin_layout Standard
2073 LyX's documentation is extensive; however LyX is under constant development,
2074 and each new release adds new features.
2075 You may find some documentation needs improvement.
2076 This section describes what to do if you find an error, or have some suggestion
2077 s for improving the documentation.
2080 \begin_layout Subsubsection
2081 Reporting Errors in the Manuals
2084 \begin_layout Standard
2085 If you find a problem with the documentation, send a message to the mailing
2088 lyx-docs@lists.lyx.org
2091 The documentation team will make any necessary fixes.
2094 \begin_layout Subsubsection
2095 Joining the Documentation Team.
2098 \begin_layout Standard
2099 The LyX Documentation Project, like anything else in the LyX project, can
2100 always use assistance! If you're interested in contributing to the Documentatio
2101 n Project, you need to do the following:
2104 \begin_layout Enumerate
2105 Get the latest LyX source code from
2108 \begin_inset LatexCommand url
2109 target "http://www.lyx.org/trac/browser/lyx-devel/trunk/lib/doc"
2115 Inside that directory is a file called
2120 Read it; it's the style sheet for the documentation.
2123 \begin_layout Enumerate
2134 The point of this exercise is to give you ideas.
2143 is likely to be the most up-to-date of all of the documentation.
2144 You should be able to glean some insights into how we want the manuals
2145 to read and to look.
2148 \begin_layout Enumerate
2149 Contact the team at:
2153 lyx-docs@lists.lyx.org
2157 to discuss your intended changes, and get some feedback on them.
2160 \begin_layout Standard
2161 The changes you wish to make may range from improving clarity of the text,
2162 to doing major re-structuring of the documentation.
2163 Any and all improvements are gladly received.