1 #LyX 1.5.4svn 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}}{}
22 % link all cross references and URLs in pdf output
23 \usepackage[colorlinks=true, bookmarks, bookmarksnumbered,
24 bookmarksopen, bookmarksopenlevel=2,
25 linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,
26 pdfpagelayout=OneColumn, pdfnewwindow=true,
27 pdfstartview=XYZ, plainpages=false, pdfpagelabels,
28 pdfauthor={LyX Team}, pdftex,
29 pdftitle={Introduction to LyX},pdfsubject={LyX-documentation Intro},
30 pdfkeywords={LyX, documentation}]{hyperref}
32 \else % if dvi or ps is produced
34 % link all cross references and URLs in dvi output
35 \usepackage[ps2pdf]{hyperref}
37 \fi % end if pdflatex is used
39 % the pages of the TOC are numbered roman
40 % and a pdf-bookmark for the TOC is added
42 \let\myTOC\tableofcontents
43 \renewcommand\tableofcontents{%
44 \pdfbookmark[1]{Contents}{}
47 \pagenumbering{arabic} }
49 % redefine the \LyX macro for PDF bookmarks
50 \def\LyX{\texorpdfstring{%
51 L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
58 \font_typewriter default
59 \font_default_family default
73 \paperorientation portrait
76 \paragraph_separation indent
78 \quotes_language english
81 \paperpagestyle default
82 \tracking_changes false
99 \begin_layout Standard
101 If you have comments or error corrections, please send them to the LyX Documenta
104 lyx-docs@lists.lyx.org
112 \begin_layout Standard
113 \begin_inset LatexCommand tableofcontents
120 \begin_layout Section
121 The Philosophy of LyX
124 \begin_layout Subsection
128 \begin_layout Standard
129 LyX is a document preparation system.
130 It excels at letting you create complex technical and scientific articles
131 with mathematics, cross-references, bibliographies, indices, etc.
132 It is very good at documents of any length in which the usual processing
133 abilities are required: automatic sectioning and pagination, spellchecking,
135 It can also be used to write a letter to your mom, though granted, there
136 are probably simpler programs available for that.
137 It is definitely not the best tool for creating banners, flyers, or advertiseme
138 nts (we'll explain why later), though with some effort all these can be
140 Some examples of what it is used for: memos, letters, dissertations and
141 theses, lecture notes, seminar notebooks, conference proceedings, software
142 documentation, books, articles in refereed scientific journals, scripts
143 for plays and movies, business proposals, presentations \SpecialChar \ldots{}
147 \begin_layout Standard
148 LyX is a program that provides a modern approach to writing documents with
149 a computer by using a markup language paradigm, an approach that breaks
150 with the obsolete tradition of the
151 \begin_inset Quotes eld
155 \begin_inset Quotes erd
159 It is designed for authors who want professional output quickly with a
160 minimum of effort without becoming specialists in typesetting.
161 The job of typesetting is done mostly by the computer, not the author;
162 with LyX, the author can concentrate on the contents of her writing.
165 \begin_layout Standard
166 Part of the initial challenge of using LyX comes from the change in thinking
167 that you, the user, must make.
168 At one time, all we had for creating documents were typewriters, so we
169 all learned certain tricks to get around their limitations.
170 Underlining, which is little more than overstriking with the
171 \begin_inset Quotes eld
175 \begin_inset Quotes erd
178 character, became a way to emphasize text.
179 You were forced to figure out column sizes and tab stops, and set them,
180 before creating a table.
181 The same applied for letters and other right justified text.
182 Hyphenation at the end of a line required a careful eye and a lot of foresight.
185 \begin_layout Standard
186 In other words, we've all been trained to worry about the little details
187 of which character goes where.
188 Consequently, almost all word processors have this mentality.
189 They still use tab stops for adding whitespace.
190 You still need to worry about exactly where on the page something will
192 Emphasizing text means changing a font, similar to changing the typewriter
194 This is the underlying philosophy of a WYSIWYG word processor:
195 \begin_inset Quotes eld
198 What You See Is What You Get
199 \begin_inset Quotes erd
203 Unfortunately, that paradigm often results in
204 \begin_inset Quotes eld
207 What You See Is All You Get
208 \begin_inset Quotes erd
214 \begin_layout Standard
215 This is where LyX differs from an ordinary word processor.
216 You don't concern yourself with what character goes where.
221 and LyX takes care of the rest, following a set of rules called a
229 \begin_layout Standard
230 To be fair, most recent versions of the most popular office suites now have
231 some sort of style sheets which follow a similar markup method.
232 However, our experience is that they are still rarely used in practice.
237 Let's look at a little example:
240 \begin_layout Standard
241 Suppose you are writing a report.
242 To begin your report, you want a section called
243 \begin_inset Quotes eld
246 Introduction\SpecialChar \@.
248 \begin_inset Quotes erd
251 So, you go into whatever menu it is in your word processor that changes
252 font sizes and decide on a new font size.
253 Then you turn on bold face.
255 \begin_inset Quotes eld
261 \begin_inset Quotes erd
265 Of course, if you later decide that this section belongs someplace else
266 in the document, or if you insert a new section before it, you need to
267 change the numbering for this and all following sections, as well as any
268 entry in the table of contents.
272 \begin_layout Standard
273 In LyX, you go to the pull-down on the far left of the button bar and select
279 \begin_inset Quotes eld
282 Introduction\SpecialChar \@.
284 \begin_inset Quotes erd
290 \begin_layout Standard
292 If you cut and paste the section, it will automatically be renumbered ---
294 And if you enter references to that section correctly (by inserting cross-refer
295 ence tags), LyX will automatically update them all throughout the file so
296 that you never, ever type a section number.
299 \begin_layout Standard
300 Now let's look at the problem of consistency.
301 Five days later, you reopen your report and start Section\InsetSpace ~
303 However, you forget that you were using 18pt bold instead of 16pt, so you
304 type in the heading for Section\InsetSpace ~
305 4 in a different font that what you used
306 for Section\InsetSpace ~
308 That problem doesn't even exist in LyX.
309 The computer takes care of all that silly bookkeeping about which thing
310 has what size font, not you.
311 After all, that's what a computer is good at.
314 \begin_layout Standard
315 Here's another example.
316 Suppose you're making a list.
317 In other word processors, a list is just a bunch of tab stops and newlines.
318 You need to figure out where to put the label for each list item, what
319 that label should be, how many blank lines to put between each item, and
321 Under LyX, you have only two concerns: what kind of list is this, and what
322 do I want to put in it.
326 \begin_layout Standard
327 So, the basic idea behind LyX is: specify
337 \begin_inset Quotes eld
340 What You See Is What You Get,
341 \begin_inset Quotes erd
345 \begin_inset Quotes eld
348 What You See Is What You
353 \begin_inset Quotes erd
357 \begin_inset Quotes eld
361 \begin_inset Quotes erd
364 It's a powerful idea that greatly simplifies the mechanics of writing documents.
365 This is also why LyX isn't so good for creating posters and flyers---in
370 want to specify exactly where everything goes, because there are no functional
371 units like paragraphs, sections, etc.
372 This doesn't mean LyX is missing some cool function.
373 It simply means that it isn't the right tool for the job --- you don't
374 use a screwdriver to drive in nails.
377 \begin_layout Subsection
378 Differences between LyX and Other Word Processors
382 \begin_layout Standard
386 \begin_layout Standard
399 \begin_layout Standard
406 and Other Word Processors
414 \begin_layout Standard
415 Here's a list of things you won't find in LyX:
418 \begin_layout Itemize
422 \begin_layout Itemize
426 \begin_layout Itemize
427 Extra whitespace (i.e.
439 \begin_layout Standard
440 Tab stops, along with a ruler showing you the position of things on the
441 page, are useless in LyX.
442 The program worries about where things go on the page, not you.
443 Extra whitespace is similar; LyX adds them where necessary, depending on
445 Not being able to type two blank lines in a row will be annoying at first,
446 but it makes more sense once you're thinking in WYSIWYM terms.
449 \begin_layout Standard
450 Here are some things that exist in LyX, but aren't used as you might think:
453 \begin_layout Itemize
457 \begin_layout Itemize
461 \begin_layout Itemize
463 single spaced, double spaced, etc.)
466 \begin_layout Itemize
467 Whitespace, horizontal and vertical
470 \begin_layout Itemize
474 \begin_layout Itemize
475 Typefaces (bold, italic, underline, etc.)
478 \begin_layout Standard
479 Although they exist in LyX, you generally don't need them.
480 LyX will take care of these things for you, depending on what you're doing.
481 Different parts of the document are automatically set in a different typeface
483 Paragraph indenting is context dependent; different types of paragraphs
484 get indented differently.
485 Page breaks get handled automatically, as well.
486 In general, the space between lines, between words, and between paragraphs
487 is variable, set by LyX.
491 \begin_layout Standard
492 There are ways to adjust all of these (only some of which require knowledge
493 of LaTeX), either for a whole document or for a specific location in a
511 \begin_layout Standard
512 Lastly, there are a few areas where we believe LyX (and LaTeX) surpasses
513 many word processors:
516 \begin_layout Itemize
520 \begin_layout Itemize
524 \begin_layout Itemize
528 \begin_layout Itemize
532 \begin_layout Itemize
536 \begin_layout Standard
537 Granted, many modern word processors can handle mathematical symbols, tables,
538 and hyphenation, and many have moved towards style definitions and the
540 However, they've only recently been able to do so, whereas LyX is built
541 upon the LaTeX document preparation system.
542 LaTeX has been around for over 20 years, and
549 \begin_layout Subsection
553 \begin_layout Standard
554 LaTeX is a document preparation system designed by Leslie Lamport in 1985.
558 \begin_layout Standard
559 The source for the info in this section is
560 \begin_inset Quotes eld
568 \begin_inset Quotes erd
571 by Helmut Kopka and Patrick Daly, which has an entry in the bibliography
582 It was built up from a typesetting language called TeX, created by Donald
584 TeX takes a sequence of typesetting commands, written in a script in an
585 ASCII file, and executes them.
587 \begin_inset Quotes eld
591 \begin_inset Quotes erd
594 of the printing trade were modeled by Knuth as computer algorithms and
595 incorporated into TeX, thus its excellent printed appearance.
596 What comes directly out of TeX is the portable document format
601 \begin_inset Quotes eld
605 \begin_inset Quotes erd
613 The dvi format is often used for previews and can later be converted to
614 other formats like PostScript.
618 \begin_layout Standard
619 TeX isn't only a typesetting engine, it also allows you to define macros.
620 Most people who use TeX are actually using a macro package which Knuth
621 created to hide a lot of the typesetting details.
622 This is where Leslie Lamport enters our story.
623 He wanted a macro package that was more user- and less typesetter-oriented,
624 with a set of commands that consistently typeset things like sections,
625 tables or math formulas in an uniform, consistent fashion.
626 This is how LaTeX was born.
629 \begin_layout Standard
630 Now, in parallel with the development and growth of LaTeX, other folks were
631 creating their own custom macro packages for TeX, ones to make slides or
632 articles for math journals and so on.
633 Some used the raw TeX facilities to do this, others began modifying LaTeX.
634 To try and unify this mess, a team of LaTeX-nicians began to work on LaTeX2e,
635 the current version of LaTeX, during the late 1980's.
636 This new version of LaTeX has commands which provide an easier-to-use interface
637 to TeX's macro-creating commands, aid in the use of new fonts, and so on.
638 In fact, LaTeX is quite an extensive language in its own right! Users around
639 the world have been creating their own add-ons for LaTeX beyond the standard
643 \begin_layout Standard
644 There are two ways to extend LaTeX: classes and styles.
649 is a set of LaTeX macros describing a new type of document, like a book,
651 There are classes for slides, for physics and math journals\SpecialChar \ldots{}
653 even have a class for their thesis format! A
657 differs from a class in that it doesn't define a new type of document,
658 but a different type of
662 that any document can use.
663 For example, LyX controls page margins and line spacing using two different
664 LaTeX style-files designed for these purposes.
665 There are style-files for a whole slew of things: printing labels or envelopes,
666 changing indentation behavior, adding new fonts, manipulating graphics,
667 designing fancy page headings, customizing bibliographies, altering the
668 location and appearance of footnotes, tables, and figures, customizing
672 \begin_layout Standard
676 \begin_layout Description
677 TeX: Typesetting language with macro capability.
680 \begin_layout Description
681 LaTeX: Macro package built upon TeX\SpecialChar \@.
685 \begin_layout Description
686 classes: Descriptions of a type of document, using LaTeX\SpecialChar \@.
690 \begin_layout Description
691 styles: Alters the default behavior of LaTeX in some way.
694 \begin_layout Description
695 LyX: Visual, WYSIWYM word-processor that uses LaTeX to do its typesetting.
698 \begin_layout Standard
699 This section attempts to account for the difference between LyX and other
701 Simply put, LaTeX is the difference.
702 By using LaTeX as its backend, LyX helps you think more about
711 The computer then handles
718 \begin_layout Section
719 Navigating the Documentation
722 \begin_layout Standard
723 To make it easier to answer your questions and describe all of the features
724 of LyX, the documentation has been split up into several different files.
725 Each one has its own purpose, as described below.
726 Before you go plowing into any of those files, however, you should read
727 this chapter thoroughly first, since it contains a lot of useful information
728 and commentary that can save you some time.
731 \begin_layout Standard
732 The developing of LyX will hopefully never stop, so that some of the documentati
733 on may be incomplete or a bit out of date, though we try to keep up.
734 Like the rest of LyX, the manuals are the work of a group of volunteers
736 \begin_inset Quotes eld
740 \begin_inset Quotes erd
743 , families, dishes to clean, kitty litter to dispose of, et cetera.
744 If you want to help out, be sure to read Section\InsetSpace ~
746 \begin_inset LatexCommand ref
747 reference "sec:Contrib"
751 in addition to the rest of this document.)
754 \begin_layout Standard
755 Also, please do us a favor -- if anything in these manuals confuses you,
756 is unclear, or wrong, don't hesitate to let us know! You can reach the
757 current document maintainers by mailing to
759 lyx-docs@lists.lyx.org
762 If you have questions which are not obviously answered in the documentation,
763 and need help fast, there is an active users' mailing list which you can
766 lyx-users@lists.lyx.org
771 \begin_layout Subsection
772 The Format of the Manuals
775 \begin_layout Standard
776 Some may have printed out the manuals.
777 Others may be reading it within LyX.
778 There are some differences between the LyX-file and the printed version.
779 First, the title is simply at the top of the document, not formatted on
780 a separate page as in some of the printed versions.
781 Nor are any of the footnotes or the Table of Contents fully visible.
782 To open a footnote, which looks like this:
783 \begin_inset Graphics
784 filename clipart/footnoteQt4.png
789 , click on it with the left mouse button.
790 For the Table of Contents, either click on the grey box or click on the
795 menu, where the contents are displayed automatically\SpecialChar \@.
799 \begin_layout Standard
800 In the printed manuals, all cross-references appear as the actual numbers
801 for a chapter, section, subsection, and so on.
802 Online, however, all cross-references appear as a light-grey box like the
804 \begin_inset Graphics
805 filename clipart/referenceQt4.png
811 If you click on that box with the left mouse button, a dialog box will
812 appear containing a list of all the cross-references in the document.
813 This introduction has only two, the first one is named
814 \begin_inset Quotes eld
818 \begin_inset Quotes erd
822 You can go to the referred section by right-clicking on the box or by clicking
829 in the opened dialog.
830 Going back to where you came from is just as easy.
835 to go back to your earlier location.
838 \begin_layout Standard
839 Now that we've cleared up some of the differences between the printed and
840 online versions of this file, we can start looking at the format of this
842 You'll occasionally notice things in different fonts:
845 \begin_layout Itemize
850 is used for general emphasis, generic arguments, book titles, names of
851 sections of other manuals, and notes from the authors.
854 \begin_layout Itemize
859 is used for program and file names, LyX code and functions.
862 \begin_layout Itemize
867 is used for menu, button, or dialog box names, and the names of keyboard
871 \begin_layout Itemize
876 is used for people's names.
879 \begin_layout Itemize
884 is used for LaTeX code
887 \begin_layout Standard
888 For menu accelerator keys and keybindings, you'll probably get referred
894 \begin_inset Quotes eld
899 Extended Features Manual
902 \begin_inset Quotes erd
910 When we do need to reference keys, we'll use the following prefixing convention
914 \begin_layout Itemize
915 \begin_inset Quotes eld
923 \begin_inset Quotes erd
933 \begin_layout Itemize
934 \begin_inset Quotes eld
942 \begin_inset Quotes erd
952 \begin_layout Itemize
953 \begin_inset Quotes eld
961 \begin_inset Quotes erd
968 key, which on some keyboards will be the
975 \begin_layout Itemize
976 \begin_inset Quotes eld
984 \begin_inset Quotes erd
987 \SpecialChar \ldots{}
989 \begin_inset Quotes eld
997 \begin_inset Quotes erd
1000 are the function keys.
1003 \begin_layout Itemize
1004 \begin_inset Quotes eld
1012 \begin_inset Quotes erd
1018 \begin_layout Itemize
1019 \begin_inset Quotes eld
1027 \begin_inset Quotes erd
1031 \begin_inset Quotes eld
1039 \begin_inset Quotes erd
1043 \begin_inset Quotes eld
1051 \begin_inset Quotes erd
1055 \begin_inset Quotes eld
1063 \begin_inset Quotes erd
1069 \begin_layout Itemize
1072 \begin_inset Quotes eld
1078 \begin_inset Quotes erd
1082 \begin_inset Quotes eld
1090 \begin_inset Quotes erd
1094 \begin_inset Quotes eld
1102 \begin_inset Quotes erd
1106 \begin_inset Quotes eld
1114 \begin_inset Quotes erd
1118 \begin_inset Quotes eld
1126 \begin_inset Quotes erd
1130 \begin_inset Quotes eld
1138 \begin_inset Quotes erd
1141 : these are the 6 keys that appear above the cursor keys on many PC keyboards.
1143 \begin_inset Quotes eld
1151 \begin_inset Quotes erd
1155 \begin_inset Quotes eld
1163 \begin_inset Quotes erd
1167 \begin_inset Quotes eld
1175 \begin_inset Quotes erd
1179 \begin_inset Quotes eld
1187 \begin_inset Quotes erd
1193 \begin_layout Itemize
1202 both refer to the same key.
1203 Some keyboards label the
1208 \begin_inset Quotes eld
1212 \begin_inset Quotes erd
1216 \begin_inset Quotes eld
1220 \begin_inset Quotes erd
1223 still others have two keys.
1224 LyX treats all of them as the same key, so we'll use
1235 \begin_layout Standard
1236 You'll also see something like
1237 \begin_inset Quotes eld
1243 \begin_inset Quotes els
1249 \begin_inset Quotes ers
1253 \begin_inset Quotes erd
1257 We've listed the possible default keybindings for a function in its entry
1259 \begin_inset Quotes eld
1264 Extended Features Manual
1267 \begin_inset Quotes erd
1270 so check there, too.
1271 Note that there are two different keybinding maps in common use in the
1273 \begin_inset Quotes eld
1277 \begin_inset Quotes erd
1280 style which is the default and familiar to those coming from the PC world,
1282 \begin_inset Quotes eld
1286 \begin_inset Quotes erd
1289 style, which is common with those who
1290 \begin_inset Quotes eld
1294 \begin_inset Quotes erd
1297 on Unix systems and use the Emacs editor.
1298 Unless specifically noted, the keybindings in the documentation are from
1299 the default CUA map.
1300 If you like Emacs, you should be smart enough to read the documentation
1301 and figure out the bindings on your own.
1304 \begin_layout Subsection
1305 Units used in the Manuals
1308 \begin_layout Standard
1309 To understand the units described in this documentation, Table\InsetSpace ~
1311 \begin_inset LatexCommand ref
1312 reference "cap:Units-for-image"
1316 explains all units available in LyX.
1319 \begin_layout Standard
1320 \begin_inset Float table
1326 \begin_layout Standard
1327 \begin_inset Caption
1329 \begin_layout Standard
1330 \begin_inset LatexCommand label
1331 name "cap:Units-for-image"
1343 \begin_layout Standard
1344 \begin_inset VSpace medskip
1350 \begin_layout Standard
1352 \begin_inset Tabular
1353 <lyxtabular version="3" rows="20" columns="2">
1355 <column alignment="center" valignment="top" leftline="true" width="0">
1356 <column alignment="center" valignment="top" leftline="true" rightline="true" width="0">
1357 <row topline="true" bottomline="true">
1358 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1361 \begin_layout Standard
1367 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1370 \begin_layout Standard
1377 <row topline="true">
1378 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1381 \begin_layout Standard
1387 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1390 \begin_layout Standard
1397 <row topline="true">
1398 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1401 \begin_layout Standard
1407 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1410 \begin_layout Standard
1417 <row topline="true">
1418 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1421 \begin_layout Standard
1427 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1430 \begin_layout Standard
1437 <row topline="true">
1438 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1441 \begin_layout Standard
1447 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1450 \begin_layout Standard
1452 \begin_inset Formula $\,$
1456 \begin_inset Formula $\,$
1465 <row topline="true">
1466 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1469 \begin_layout Standard
1475 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1478 \begin_layout Standard
1480 \begin_inset Formula $\,$
1484 \begin_inset Formula $\,$
1493 <row topline="true">
1494 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1497 \begin_layout Standard
1503 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1506 \begin_layout Standard
1508 \begin_inset Formula $\,$
1512 \begin_inset Formula $\,$
1521 <row topline="true">
1522 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1525 \begin_layout Standard
1531 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1534 \begin_layout Standard
1536 \begin_inset Formula $\,$
1540 \begin_inset Formula $\,$
1549 <row topline="true">
1550 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1553 \begin_layout Standard
1559 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1562 \begin_layout Standard
1564 \begin_inset Formula $\,$
1568 \begin_inset Formula $\approx$
1572 \begin_inset Formula $\,$
1581 <row topline="true">
1582 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1585 \begin_layout Standard
1591 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1594 \begin_layout Standard
1596 \begin_inset Formula $\,$
1600 \begin_inset Formula $\,$
1609 <row topline="true">
1610 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1613 \begin_layout Standard
1619 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1622 \begin_layout Standard
1623 % of original image width
1629 <row topline="true">
1630 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1633 \begin_layout Standard
1639 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1642 \begin_layout Standard
1649 <row topline="true">
1650 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1653 \begin_layout Standard
1659 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1662 \begin_layout Standard
1669 <row topline="true">
1670 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1673 \begin_layout Standard
1679 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1682 \begin_layout Standard
1689 <row topline="true">
1690 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1693 \begin_layout Standard
1699 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1702 \begin_layout Standard
1709 <row topline="true">
1710 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1713 \begin_layout Standard
1719 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1722 \begin_layout Standard
1729 <row topline="true">
1730 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1733 \begin_layout Standard
1739 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1742 \begin_layout Standard
1749 <row topline="true">
1750 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1753 \begin_layout Standard
1759 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1762 \begin_layout Standard
1773 <row topline="true">
1774 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1777 \begin_layout Standard
1783 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1786 \begin_layout Standard
1797 <row topline="true" bottomline="true">
1798 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1801 \begin_layout Standard
1807 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1810 \begin_layout Standard
1812 \begin_inset Formula $\,$
1816 \begin_inset Formula $\,$
1837 \begin_layout Subsection
1841 \begin_layout Standard
1842 The following list describes the contents of each of the files in the documentat
1846 \begin_layout Description
1847 Introduction This file.
1850 \begin_layout Description
1851 Tutorial If you are new to LyX, and have never used LaTeX before, you should
1853 If you have used LaTeX before, you should still read the
1857 , starting with the section on
1858 \begin_inset Quotes eld
1861 LyX for LaTeX users.
1862 \begin_inset Quotes erd
1865 (Skimming the rest of the document wouldn't hurt, either.)
1868 \begin_layout Description
1870 Guide The primary documentation.
1875 of the basic operation and available features of LyX here.
1876 The main manual assumes that you've read the
1883 \begin_layout Description
1884 Embedded\InsetSpace ~
1885 Objects Extension of the
1890 Documents in detail how to use tables, graphics, floats, notes, and boxes.
1891 It also includes many tricks of the LaTeX masters.
1894 \begin_layout Description
1895 Extended\InsetSpace ~
1896 Features Extension of the
1901 Documents how to use raw LaTeX commands, additional layouts, and special-purpos
1905 \begin_layout Description
1906 Customization A description of advanced LyX features, including how to customize
1907 the overall behavior of LyX\SpecialChar \@.
1908 This includes such things as keybindings, internati
1909 onalization, and configuration files.
1912 \begin_layout Description
1914 configuration LyX investigates your system upon installation.
1915 This file contains info on what LyX learned about your installation.
1916 Check it to see if you're missing something you might like to have.
1919 \begin_layout Standard
1920 These files will reference one another as necessary.
1929 information on installation and customization, but refers the reader to
1932 Customization Manual
1934 for more information.
1937 \begin_layout Standard
1938 We'll state again an important point:
1941 \begin_layout Standard
1942 \begin_inset VSpace bigskip
1948 \begin_layout Standard
1950 If you are new to LyX, read the
1959 \begin_layout Standard
1960 \begin_inset VSpace bigskip
1966 \begin_layout Standard
1967 Otherwise, you could needlessly frustrate yourself.
1968 LyX does all that you need a word processor to do, but using a different
1972 \begin_layout Section
1973 \begin_inset LatexCommand label
1978 Contributing to the LyX Project
1981 \begin_layout Subsection
1985 \begin_layout Standard
1986 LyX is mostly written in C++ (the LaTeX importer is written in Python).
1987 It is a large project, and as a result it is not free from bugs, or the
1988 need for improvements in the source code.
1991 \begin_layout Subsubsection
1995 \begin_layout Standard
1996 While using LyX, you may find behavior which you consider a bug.
1997 Crashes, though rare, can happen.
1998 User interface problems are considered major bugs by the LyX team: especially
1999 helpful are indications of parts of the LyX interface you find confusing,
2003 \begin_layout Standard
2004 LyX has a bug tracking system, which you can find at
2007 \begin_inset LatexCommand url
2008 target "http://bugzilla.lyx.org/"
2015 You should check the bug tracker before reporting any bugs, in case it
2016 has already been reported.
2017 If you have a comment on an existing bug, or wish to report a new bug,
2018 you may either use the bug tracker, or send an e-mail to the development
2021 lyx-devel@lists.lyx.org
2024 Archives of this list are linked from the main LyX website,
2027 \begin_inset LatexCommand url
2028 target "http://www.lyx.org/"
2037 \begin_layout Standard
2038 A useful bug report will at a minimum include the version of LyX you are
2039 having the problem with.
2040 Accurate, detailed descriptions are preferred - the more time developers
2041 have to spend to pinpoint the source of a bug, the less time they have
2042 for other improvements.
2043 Mention the system and system version you are running LyX with.
2044 Give the versions of the libraries you have installed on your system, and,
2045 if relevant, the versions of external programs that LyX uses.
2046 If it's a compilation or configuration problem, include the file
2050 , and mention which compiler you are using.
2054 \begin_layout Subsubsection
2055 Contributing fixes and new features
2058 \begin_layout Standard
2059 If you have made changes to LyX's source that you think should become part
2060 of LyX, send your changes as a diff file (in unified format) to the development
2061 list referenced above, along with a change log, and a description of what
2065 \begin_layout Subsection
2066 Contributing to the Documentation
2069 \begin_layout Standard
2070 LyX's documentation is extensive; however LyX is under constant development,
2071 and each new release adds new features.
2072 You may find some documentation needs improvement.
2073 This section describes what to do if you find an error, or have some suggestion
2074 s for improving the documentation.
2077 \begin_layout Subsubsection
2078 Reporting Errors in the Manuals
2081 \begin_layout Standard
2082 If you find a problem with the documentation, send a message to the mailing
2085 lyx-docs@lists.lyx.org
2088 The documentation team will make any necessary fixes.
2091 \begin_layout Subsubsection
2092 Joining the Documentation Team.
2095 \begin_layout Standard
2096 The LyX Documentation Project, like anything else in the LyX project, can
2097 always use assistance! If you're interested in contributing to the Documentatio
2098 n Project, you need to do the following:
2101 \begin_layout Enumerate
2102 Get the latest LyX source code from
2105 \begin_inset LatexCommand url
2106 target "http://www.lyx.org/trac/browser/lyx-devel/trunk/lib/doc"
2112 Inside that directory is a file called
2117 Read it; it's the style sheet for the documentation.
2120 \begin_layout Enumerate
2131 The point of this exercise is to give you ideas.
2140 is likely to be the most up-to-date of all of the documentation.
2141 You should be able to glean some insights into how we want the manuals
2142 to read and to look.
2145 \begin_layout Enumerate
2146 Contact the team at:
2150 lyx-docs@lists.lyx.org
2154 to discuss your intended changes, and get some feedback on them.
2157 \begin_layout Standard
2158 The changes you wish to make may range from improving clarity of the text,
2159 to doing major re-structuring of the documentation.
2160 Any and all improvements are gladly received.