1 #LyX 2.0.0svn 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 \fi % end if pdflatex is used
24 % the pages of the TOC is numbered roman
25 % and a pdf-bookmark for the TOC is added
27 \let\myTOC\tableofcontents
28 \renewcommand\tableofcontents{%
29 \pdfbookmark[1]{\contentsname}{}
32 \pagenumbering{arabic} }
34 % redefine the \LyX macro for PDF bookmarks
35 \def\LyX{\texorpdfstring{%
36 L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
39 \use_default_options false
40 \maintain_unincluded_children false
46 \font_typewriter default
47 \font_default_family default
55 \default_output_format default
57 \bibtex_command default
58 \index_command default
62 \pdf_title "Introduction to LyX"
63 \pdf_author "LyX Team"
64 \pdf_subject "LyX-documentation Intro"
65 \pdf_keywords "LyX, documentation"
67 \pdf_bookmarksnumbered true
68 \pdf_bookmarksopen true
69 \pdf_bookmarksopenlevel 2
74 \pdf_pdfusetitle false
75 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
85 \paperorientation portrait
94 \paragraph_separation indent
95 \paragraph_indentation default
96 \quotes_language english
99 \paperpagestyle default
100 \tracking_changes false
101 \output_changes false
103 \html_be_strict false
117 \begin_layout Plain Layout
119 If you have comments or error corrections, please send them to the LyX Documenta
121 \begin_inset CommandInset href
123 target "lyx-docs@lists.lyx.org"
136 \begin_layout Standard
137 \begin_inset CommandInset toc
138 LatexCommand tableofcontents
145 \begin_layout Section
146 The Philosophy of LyX
149 \begin_layout Subsection
153 \begin_layout Standard
154 LyX is a document preparation system.
155 It excels at letting you create complex technical and scientific articles
156 with mathematics, cross-references, bibliographies, indices, etc.
157 It is very good at documents of any length in which the usual processing
158 abilities are required: automatic sectioning and pagination, spell checking,
160 It can also be used to write a letter to your mom, though granted, there
161 are probably simpler programs available for that.
162 It is definitely not the best tool for creating banners, flyers, or advertiseme
163 nts (we'll explain why later), though with some effort all these can be
165 Some examples of what it is used for: memos, letters, dissertations and
166 theses, lecture notes, seminar notebooks, conference proceedings, software
167 documentation, books, articles in refereed scientific journals, scripts
168 for plays and movies, business proposals, presentations \SpecialChar \ldots{}
172 \begin_layout Standard
173 LyX is a program that provides a modern approach to writing documents with
174 a computer by using a markup language paradigm, an approach that breaks
175 with the obsolete tradition of the
176 \begin_inset Quotes eld
180 \begin_inset Quotes erd
184 It is designed for authors who want professional output quickly with a
185 minimum of effort without becoming specialists in typesetting.
186 The job of typesetting is done mostly by the computer, not the author;
187 with LyX, the author can concentrate on the contents of his writing.
190 \begin_layout Standard
191 Part of the initial challenge of using LyX comes from the change in thinking
192 that you, the user, must make.
193 At one time, all we had for creating documents were typewriters, so we
194 all learned certain tricks to get around their limitations.
195 Underlining, which is little more than overstriking with the
196 \begin_inset Quotes eld
200 \begin_inset Quotes erd
203 character, became a way to emphasize text.
204 You were forced to figure out column sizes and tab stops, and set them,
205 before creating a table.
206 The same applied for letters and other right justified text.
207 Hyphenation at the end of a line required a careful eye and a lot of foresight.
210 \begin_layout Standard
211 In other words, we've all been trained to worry about the little details
212 of which character goes where.
213 Consequently, almost all word processors have this mentality.
214 They still use tab stops for adding whitespace.
215 You still need to worry about exactly where on the page something will
217 Emphasizing text means changing a font, similar to changing the typewriter
219 This is the underlying philosophy of a WYSIWYG word processor:
220 \begin_inset Quotes eld
223 What You See Is What You Get
224 \begin_inset Quotes erd
228 Unfortunately, that paradigm often results in
229 \begin_inset Quotes eld
232 What You See Is All You Get
233 \begin_inset Quotes erd
239 \begin_layout Standard
240 This is where LyX differs from an ordinary word processor.
241 You don't concern yourself with what character goes where.
246 and LyX takes care of the rest, following a set of rules called a
254 \begin_layout Plain Layout
255 To be fair, most recent versions of the most popular office suites now have
256 some sort of style sheets which follow a similar markup method.
257 However, our experience is that they are still rarely used in practice.
262 Let's look at a little example:
265 \begin_layout Standard
266 Suppose you are writing a report.
267 To begin your report, you want a section called
268 \begin_inset Quotes eld
271 Introduction\SpecialChar \@.
273 \begin_inset Quotes erd
276 So, you go into whatever menu it is in your word processor that changes
277 font sizes and decide on a new font size.
278 Then you turn on bold face.
280 \begin_inset Quotes eld
292 \begin_inset Quotes erd
296 Of course, if you later decide that this section belongs someplace else
297 in the document, or if you insert a new section before it, you need to
298 change the numbering for this and all following sections, as well as any
299 entry in the table of contents.
303 \begin_layout Standard
304 In LyX, you go to the pull-down on the far left of the button bar and select
310 \begin_inset Quotes eld
313 Introduction\SpecialChar \@.
315 \begin_inset Quotes erd
321 \begin_layout Standard
323 If you cut and paste the section, it will automatically be renumbered —
325 And if you enter references to that section correctly (by inserting cross-refer
326 ence tags), LyX will automatically update them all throughout the file so
327 that you never, ever type a section number.
330 \begin_layout Standard
331 Now let's look at the problem of consistency.
332 Five days later, you reopen your report and start Section
337 However, you forget that you were using 18
338 \begin_inset space \thinspace{}
341 pt bold instead of 16
342 \begin_inset space \thinspace{}
345 pt, so you type in the heading for Section
349 4 in a different font from the one you used for Section
354 That problem doesn't even exist in LyX.
355 The computer takes care of all that silly bookkeeping about which thing
356 has what size font, not you.
357 After all, that's what a computer is good at.
360 \begin_layout Standard
361 Here's another example.
362 Suppose you're making a list.
363 In other word processors, a list is just a bunch of tab stops and newlines.
364 You need to figure out where to put the label for each list item, what
365 that label should be, how many blank lines to put between each item, and
367 Under LyX, you have only two concerns: what kind of list is this, and what
368 do I want to put in it.
372 \begin_layout Standard
373 So, the basic idea behind LyX is: specify
383 \begin_inset Quotes eld
386 What You See Is What You Get,
387 \begin_inset Quotes erd
391 \begin_inset Quotes eld
394 What You See Is What You
399 \begin_inset Quotes erd
403 \begin_inset Quotes eld
407 \begin_inset Quotes erd
410 It's a powerful idea that greatly simplifies the mechanics of writing documents.
411 This is also why LyX isn't so good for creating posters and flyers.
416 want to specify exactly where everything goes, because there are no functional
417 units like paragraphs, sections, etc.
418 This doesn't mean LyX is missing some cool function.
419 It simply means that it isn't the right tool for the job — you don't use
420 a screwdriver to drive in nails.
423 \begin_layout Subsection
424 Differences between LyX and Other Word Processors
425 \begin_inset Argument
428 \begin_layout Plain Layout
432 \begin_layout Plain Layout
445 \begin_layout Plain Layout
452 and Other Word Processors
460 \begin_layout Standard
461 Here's a list of things you won't find in LyX:
464 \begin_layout Itemize
468 \begin_layout Itemize
472 \begin_layout Itemize
474 \begin_inset space \thinspace{}
478 \begin_inset space \space{}
492 \begin_layout Standard
493 Tab stops, along with a ruler showing you the position of things on the
494 page, are useless in LyX.
495 The program worries about where things go on the page, not you.
496 Extra whitespace is similar; LyX adds them where necessary, depending on
498 Not being able to type two blank lines in a row will be annoying at first,
499 but it makes more sense once you're thinking in WYSIWYM terms.
502 \begin_layout Standard
503 Here are some things that exist in LyX, but aren't used as you might think:
506 \begin_layout Itemize
510 \begin_layout Itemize
514 \begin_layout Itemize
516 \begin_inset space \thinspace{}
520 \begin_inset space \space{}
523 single spaced, double spaced, etc.)
526 \begin_layout Itemize
527 Whitespace, horizontal and vertical
530 \begin_layout Itemize
534 \begin_layout Itemize
535 Typefaces (bold, italic, underline, etc.)
538 \begin_layout Standard
539 Although they exist in LyX, you generally don't need them.
540 LyX will take care of these things for you, depending on what you're doing.
541 Different parts of the document are automatically set in a different typeface
543 Paragraph indenting is context dependent; different types of paragraphs
544 get indented differently.
545 Page breaks get handled automatically, as well.
546 In general, the space between lines, between words, and between paragraphs
547 is variable, set by LyX.
551 \begin_layout Plain Layout
552 There are ways to adjust all of these (only some of which require knowledge
553 of LaTeX), either for a whole document or for a specific location in a
571 \begin_layout Standard
572 Lastly, there are a few areas where we believe LyX (and LaTeX) surpasses
573 many word processors:
576 \begin_layout Itemize
580 \begin_layout Itemize
584 \begin_layout Itemize
588 \begin_layout Itemize
592 \begin_layout Itemize
596 \begin_layout Standard
597 Granted, many modern word processors can handle mathematical symbols, tables,
598 and hyphenation, and many have moved towards style definitions and the
600 However, they've only recently been able to do so, whereas LyX is built
601 upon the LaTeX document preparation system.
602 LaTeX has been around for over 20 years, and
609 \begin_layout Subsection
613 \begin_layout Standard
614 LaTeX is a document preparation system designed by Leslie Lamport in 1985.
618 \begin_layout Plain Layout
619 The source for the info in this section is
620 \begin_inset Quotes eld
628 \begin_inset Quotes erd
631 by Helmut Kopka and Patrick Daly, which has an entry in the bibliography
642 It was built up from a typesetting language called TeX, created by Donald
644 TeX takes a sequence of typesetting commands, written in a script in an
645 ASCII file, and executes them.
647 \begin_inset Quotes eld
651 \begin_inset Quotes erd
654 of the printing trade were modeled by Knuth as computer algorithms and
655 incorporated into TeX, thus its excellent printed appearance.
656 What comes directly out of TeX is the portable document format
661 \begin_inset Quotes eld
665 \begin_inset Quotes erd
673 The dvi format is often used for previews and can later be converted to
674 other formats like PostScript.
678 \begin_layout Standard
679 TeX isn't only a typesetting engine; it also allows you to define macros.
680 Most people who use TeX are actually using a macro package which Knuth
681 created to hide a lot of the typesetting details.
682 This is where Leslie Lamport enters our story.
683 He wanted a macro package that was more user- and less typesetter-oriented,
684 with a set of commands that consistently typeset things like sections,
685 tables or math formulas in an uniform, consistent fashion.
686 This is how LaTeX was born.
689 \begin_layout Standard
690 Now, in parallel with the development and growth of LaTeX, other folks were
691 creating their own custom macro packages for TeX, ones to make slides or
692 articles for math journals and so on.
693 Some used the raw TeX facilities to do this, others began modifying LaTeX.
694 To try and unify this mess, a team of LaTeX-nicians began to work on LaTeX2e,
695 the current version of LaTeX, during the late 1980's.
696 This new version of LaTeX has commands which provide an easier-to-use interface
697 to TeX's macro-creating commands, aid in the use of new fonts, and so on.
698 In fact, LaTeX is quite an extensive language in its own right! Users around
699 the world have been creating their own add-ons for LaTeX beyond the standard
703 \begin_layout Standard
704 There are two ways to extend LaTeX: classes and styles.
709 is a set of LaTeX macros describing a new type of document, like a book,
711 There are classes for slides, for physics and math journals\SpecialChar \ldots{}
713 even have a class for their thesis format! A
717 differs from a class in that it doesn't define a new type of document,
718 but a different type of
722 that any document can use.
723 For example, LyX controls page margins and line spacing using two different
724 LaTeX style-files designed for these purposes.
725 There are style-files for a whole slew of things: printing labels or envelopes,
726 changing indentation behavior, adding new fonts, manipulating graphics,
727 designing fancy page headings, customizing bibliographies, altering the
728 location and appearance of footnotes, tables, and figures, customizing
732 \begin_layout Standard
736 \begin_layout Description
737 TeX: Typesetting language with macro capability.
740 \begin_layout Description
741 LaTeX: Macro package built upon TeX\SpecialChar \@.
745 \begin_layout Description
746 classes: Descriptions of a type of document, using LaTeX\SpecialChar \@.
750 \begin_layout Description
751 styles: Alters the default behavior of LaTeX in some way.
754 \begin_layout Description
755 LyX: Visual, WYSIWYM word-processor that uses LaTeX to do its typesetting.
758 \begin_layout Standard
759 This section attempts to account for the difference between LyX and other
761 Simply put, LaTeX is the difference.
762 By using LaTeX as its backend, LyX helps you think more about
771 The computer then handles
778 \begin_layout Section
779 Navigating the Documentation
782 \begin_layout Standard
783 To make it easier to answer your questions and describe all of the features
784 of LyX, the documentation has been split up into several different files.
785 Each one has its own purpose, as described below.
786 Before you go ploughing into any of those files, however, you should read
787 this chapter thoroughly first, since it contains a lot of useful information
788 and commentary that can save you some time.
791 \begin_layout Standard
792 The developing of LyX will hopefully never stop, so that some of the documentati
793 on may be incomplete or a bit out of date, though we try to keep up.
794 Like the rest of LyX, the manuals are the work of a group of volunteers
796 \begin_inset Quotes eld
800 \begin_inset Quotes erd
803 , families, dishes to clean, kitty litter to dispose of, et cetera.
804 If you want to help out, be sure to read Section
809 \begin_inset CommandInset ref
811 reference "sec:Contrib"
815 in addition to the rest of this document.
818 \begin_layout Standard
819 Also, please do us a favor – if anything in these manuals confuses you,
820 is unclear, or wrong, don't hesitate to let us know! You can reach the
821 current document maintainers by mailing to
822 \begin_inset CommandInset href
824 target "lyx-docs@lists.lyx.org"
830 If you have questions which are not obviously answered in the documentation,
831 and need help fast, there is an active users' mailing list which you can
833 \begin_inset CommandInset href
835 target "lyx-users@lists.lyx.org"
843 \begin_layout Subsection
844 The Format of the Manuals
847 \begin_layout Standard
848 Some may have printed out the manuals.
849 Others may be reading it within LyX.
850 There are some differences between the LyX-file and the printed version.
851 First, the title is simply at the top of the document, not formatted on
852 a separate page as in some of the printed versions.
853 Nor are any of the footnotes or the Table of Contents fully visible.
854 To open a footnote, which looks like this:
855 \begin_inset Graphics
856 filename clipart/footnoteQt4.png
861 , click on it with the left mouse button.
862 For the Table of Contents, either click on the grey box or click on the
867 menu, where the contents are displayed automatically\SpecialChar \@.
871 \begin_layout Standard
872 In the printed manuals, all cross-references appear as the actual numbers
873 for a chapter, section, subsection, and so on.
874 Online, however, all cross-references appear as a light-grey box like the
876 \begin_inset Graphics
877 filename clipart/referenceQt4.png
883 If you click on that box with the left mouse button, a dialog box will
884 appear containing a list of all the cross-references in the document.
885 You can go to the referred section by right-clicking on the box or by clicking
898 in the opened dialog.
899 Going back to where you came from is just as easy.
908 to go back to your earlier location.
911 \begin_layout Standard
912 Now that we've cleared up some of the differences between the printed and
913 online versions of this file, we can start looking at the format of this
915 You'll occasionally notice things in different fonts:
918 \begin_layout Itemize
923 is used for general emphasis, generic arguments, book titles, names of
924 sections of other manuals, and notes from the authors.
927 \begin_layout Itemize
932 is used for program and file names, LyX code and functions.
935 \begin_layout Itemize
940 is used for menu, button, or dialog box names, and the names of keyboard
944 \begin_layout Itemize
949 is used for people's names.
952 \begin_layout Itemize
957 is used for LaTeX code
960 \begin_layout Standard
961 When we do need to reference keys, we'll use the following prefixing convention:
964 \begin_layout Itemize
965 \begin_inset Quotes eld
973 \begin_inset Quotes erd
983 \begin_layout Itemize
984 \begin_inset Quotes eld
992 \begin_inset Quotes erd
1002 \begin_layout Itemize
1003 \begin_inset Quotes eld
1011 \begin_inset Quotes erd
1025 \begin_layout Itemize
1026 \begin_inset Quotes eld
1034 \begin_inset Quotes erd
1037 \SpecialChar \ldots{}
1039 \begin_inset Quotes eld
1047 \begin_inset Quotes erd
1050 are the function keys.
1053 \begin_layout Itemize
1054 \begin_inset Quotes eld
1062 \begin_inset Quotes erd
1068 \begin_layout Itemize
1069 \begin_inset Quotes eld
1077 \begin_inset Quotes erd
1081 \begin_inset Quotes eld
1089 \begin_inset Quotes erd
1093 \begin_inset Quotes eld
1101 \begin_inset Quotes erd
1105 \begin_inset Quotes eld
1113 \begin_inset Quotes erd
1119 \begin_layout Itemize
1122 \begin_inset Quotes eld
1128 \begin_inset Quotes erd
1132 \begin_inset Quotes eld
1140 \begin_inset Quotes erd
1144 \begin_inset Quotes eld
1152 \begin_inset Quotes erd
1156 \begin_inset Quotes eld
1164 \begin_inset Quotes erd
1168 \begin_inset Quotes eld
1176 \begin_inset Quotes erd
1180 \begin_inset Quotes eld
1188 \begin_inset Quotes erd
1191 : these are the 6 keys that appear above the cursor keys on many PC keyboards.
1193 \begin_inset Quotes eld
1201 \begin_inset Quotes erd
1205 \begin_inset Quotes eld
1213 \begin_inset Quotes erd
1217 \begin_inset Quotes eld
1225 \begin_inset Quotes erd
1229 \begin_inset Quotes eld
1237 \begin_inset Quotes erd
1243 \begin_layout Itemize
1252 both refer to the same key.
1253 Some keyboards label the
1258 \begin_inset Quotes eld
1262 \begin_inset Quotes erd
1266 \begin_inset Quotes eld
1270 \begin_inset Quotes erd
1273 still others have two keys.
1274 LyX treats all of them as the same key, so we'll use
1285 \begin_layout Standard
1286 The list with the currently set shortcuts can be found in the
1297 \begin_layout Subsection
1298 Units used in the Manuals
1301 \begin_layout Standard
1302 To understand the units described in this documentation, Table
1303 \begin_inset space ~
1307 \begin_inset CommandInset ref
1309 reference "cap:Units-for-image"
1313 explains all units available in LyX.
1316 \begin_layout Standard
1317 \begin_inset Float table
1323 \begin_layout Plain Layout
1324 \begin_inset Caption
1326 \begin_layout Plain Layout
1327 \begin_inset CommandInset label
1329 name "cap:Units-for-image"
1341 \begin_layout Plain Layout
1342 \begin_inset VSpace medskip
1348 \begin_layout Plain Layout
1350 \begin_inset Tabular
1351 <lyxtabular version="3" rows="20" columns="2">
1352 <features tabularvalignment="middle">
1353 <column alignment="center" valignment="top" width="0">
1354 <column alignment="center" valignment="top" width="0">
1356 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1359 \begin_layout Plain Layout
1365 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1368 \begin_layout Plain Layout
1376 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1379 \begin_layout Plain Layout
1385 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1388 \begin_layout Plain Layout
1396 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1399 \begin_layout Plain Layout
1405 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1408 \begin_layout Plain Layout
1416 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1419 \begin_layout Plain Layout
1425 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1428 \begin_layout Plain Layout
1436 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1439 \begin_layout Plain Layout
1445 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1448 \begin_layout Plain Layout
1450 \begin_inset space \thinspace{}
1454 \begin_inset space \thinspace{}
1464 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1467 \begin_layout Plain Layout
1473 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1476 \begin_layout Plain Layout
1478 \begin_inset space \thinspace{}
1482 \begin_inset space \thinspace{}
1492 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1495 \begin_layout Plain Layout
1501 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1504 \begin_layout Plain Layout
1506 \begin_inset space \thinspace{}
1510 \begin_inset space \thinspace{}
1520 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1523 \begin_layout Plain Layout
1529 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1532 \begin_layout Plain Layout
1534 \begin_inset space \thinspace{}
1538 \begin_inset space \thinspace{}
1548 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1551 \begin_layout Plain Layout
1557 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1560 \begin_layout Plain Layout
1562 \begin_inset space \thinspace{}
1566 \begin_inset Formula $\approx$
1570 \begin_inset space \thinspace{}
1580 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1583 \begin_layout Plain Layout
1589 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1592 \begin_layout Plain Layout
1594 \begin_inset space \thinspace{}
1598 \begin_inset space \thinspace{}
1608 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1611 \begin_layout Plain Layout
1617 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1620 \begin_layout Plain Layout
1621 % of original image width
1628 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1631 \begin_layout Plain Layout
1637 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1640 \begin_layout Plain Layout
1648 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1651 \begin_layout Plain Layout
1657 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1660 \begin_layout Plain Layout
1668 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1671 \begin_layout Plain Layout
1677 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1680 \begin_layout Plain Layout
1688 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1691 \begin_layout Plain Layout
1697 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1700 \begin_layout Plain Layout
1708 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1711 \begin_layout Plain Layout
1717 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1720 \begin_layout Plain Layout
1728 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1731 \begin_layout Plain Layout
1737 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1740 \begin_layout Plain Layout
1748 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1751 \begin_layout Plain Layout
1757 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1760 \begin_layout Plain Layout
1772 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1775 \begin_layout Plain Layout
1781 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1784 \begin_layout Plain Layout
1796 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1799 \begin_layout Plain Layout
1805 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1808 \begin_layout Plain Layout
1810 \begin_inset space \thinspace{}
1814 \begin_inset space \thinspace{}
1835 \begin_layout Subsection
1839 \begin_layout Standard
1840 The following list describes the contents of the basic documentation files
1841 that you find in the
1848 \begin_layout Description
1849 Introduction This file.
1852 \begin_layout Description
1853 Tutorial If you are new to LyX, and have never used LaTeX before, you should
1855 If you have used LaTeX before, you should still read the
1859 , starting with the section on
1860 \begin_inset Quotes eld
1863 LyX for LaTeX users.
1864 \begin_inset Quotes erd
1867 (Skimming the rest of the document wouldn't hurt, either.)
1870 \begin_layout Description
1872 \begin_inset space ~
1875 Guide The primary documentation.
1880 of the basic operation and available features of LyX here.
1881 The main manual assumes that you've read the
1888 \begin_layout Description
1890 \begin_inset space ~
1893 Objects Extension of the
1898 Documents in detail how to use tables, graphics, floats, notes, program
1899 listings, and boxes.
1900 It also includes many tricks of the LaTeX masters.
1903 \begin_layout Description
1904 Math Extension of the
1909 Documents in detail how to typeset any kind of formulas.
1912 \begin_layout Description
1914 \begin_inset space ~
1917 Features Extension of the
1922 Documents how to use raw LaTeX commands, additional layouts, and special-purpos
1926 \begin_layout Description
1927 Customization A description of advanced LyX features, including how to customize
1928 the overall behavior of LyX\SpecialChar \@.
1929 This includes such things as keybindings, internati
1930 onalization, and configuration files.
1931 It also includes information about layout files, which are needed to get
1932 LyX to support LaTeX classes or packages.
1935 \begin_layout Description
1936 Shortcuts Tables with the currently defined LyX shortcuts.
1939 \begin_layout Description
1941 \begin_inset space ~
1944 configuration LyX investigates your system upon installation.
1945 This file contains info on what LyX learned about your installation.
1946 Check it to see if you're missing something you might like to have.
1949 \begin_layout Standard
1950 These files will reference one another as necessary.
1959 information on installation and customization, but refers the reader to
1962 Customization Manual
1964 for more information.
1967 \begin_layout Standard
1968 We'll state again an important point:
1971 \begin_layout Standard
1972 \begin_inset VSpace bigskip
1978 \begin_layout Standard
1980 If you are new to LyX, read the
1989 \begin_layout Standard
1990 \begin_inset VSpace bigskip
1996 \begin_layout Standard
1997 Otherwise, you could needlessly frustrate yourself.
2000 \begin_layout Section
2001 Contributing to the LyX Project
2002 \begin_inset CommandInset label
2011 \begin_layout Subsection
2015 \begin_layout Standard
2016 LyX is mostly written in C++ (the LaTeX importer is written in Python).
2017 It is a large project, and as a result it is not free from bugs, or the
2018 need for improvements in the source code.
2021 \begin_layout Subsubsection
2025 \begin_layout Standard
2026 While using LyX, you may find behavior which you consider a bug.
2027 Crashes, though rare, can happen.
2028 User interface problems are considered major bugs by the LyX team: especially
2029 helpful are indications of parts of the LyX interface you find confusing,
2033 \begin_layout Standard
2034 LyX has a bug tracking system, which you can find at
2037 \begin_inset Flex URL
2040 \begin_layout Plain Layout
2042 http://www.lyx.org/trac/wiki/BugTrackerHome
2050 You should check the bug tracker before reporting any bugs, in case it
2051 has already been reported.
2052 If you have a comment on an existing bug, or wish to report a new bug,
2053 you may either use the bug tracker, or send an e-mail to the development
2055 \begin_inset CommandInset href
2057 target "lyx-devel@lists.lyx.org"
2063 Archives of this list are linked from the main LyX website,
2066 \begin_inset Flex URL
2069 \begin_layout Plain Layout
2081 \begin_layout Standard
2082 A useful bug report will at a minimum include the version of LyX you are
2083 having the problem with.
2084 Accurate, detailed descriptions are preferred - the more time developers
2085 have to spend to pinpoint the source of a bug, the less time they have
2086 for other improvements.
2087 Mention the system and system version you are running LyX with.
2088 Give the versions of the libraries you have installed on your system, and,
2089 if relevant, the versions of external programs that LyX uses.
2090 If it's a compilation or configuration problem, include the file
2094 , and mention which compiler you are using.
2098 \begin_layout Subsubsection
2099 Contributing fixes and new features
2102 \begin_layout Standard
2103 If you have made changes to LyX's source that you think should become part
2104 of LyX, send your changes as a diff file (in unified format) to the development
2105 list referenced above, along with a change log, and a description of what
2109 \begin_layout Subsection
2110 Contributing to the Documentation
2113 \begin_layout Standard
2114 LyX's documentation is extensive; however LyX is under constant development,
2115 and each new release adds new features.
2116 You may find some documentation needs improvement.
2117 This section describes what to do if you find an error, or have some suggestion
2118 s for improving the documentation.
2121 \begin_layout Subsubsection
2122 Reporting Errors in the Manuals
2125 \begin_layout Standard
2126 If you find a problem with the documentation, send a message to the mailing
2128 \begin_inset CommandInset href
2130 target "lyx-docs@lists.lyx.org"
2136 The documentation team will make any necessary fixes.
2139 \begin_layout Subsubsection
2140 Joining the Documentation Team.
2143 \begin_layout Standard
2144 The LyX Documentation Project, like anything else in the LyX project, can
2145 always use assistance! If you're interested in contributing to the Documentatio
2146 n Project, you need to do the following:
2149 \begin_layout Enumerate
2150 Get the latest LyX source code from
2151 \begin_inset Newline newline
2155 \begin_inset Flex URL
2158 \begin_layout Plain Layout
2160 http://www.lyx.org/trac/browser/lyx-devel/trunk/lib/doc
2168 \begin_layout Enumerate
2178 \begin_inset Newline newline
2181 The point of this exercise is to give you ideas.
2190 is likely to be the most up-to-date of all of the documentation.
2191 You should be able to glean some insights into how we want the manuals
2192 to read and to look.
2195 \begin_layout Enumerate
2196 Contact the team at:
2197 \begin_inset Newline newline
2201 \begin_inset CommandInset href
2203 target "lyx-docs@lists.lyx.org"
2209 \begin_inset Newline newline
2212 to discuss your intended changes, and get some feedback on them.
2215 \begin_layout Standard
2216 The changes you wish to make may range from improving clarity of the text,
2217 to doing major re-structuring of the documentation.
2218 Any and all improvements are gladly received.