1 #LyX 1.6.0rc5 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
44 \font_typewriter default
45 \font_default_family default
55 \pdf_title "Introduction to LyX"
56 \pdf_author "LyX Team"
57 \pdf_subject "LyX-documentation Intro"
58 \pdf_keywords "LyX, documentation"
60 \pdf_bookmarksnumbered true
61 \pdf_bookmarksopen true
62 \pdf_bookmarksopenlevel 2
67 \pdf_pdfusetitle false
68 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false, pdfpagelabels"
75 \paperorientation portrait
78 \paragraph_separation indent
80 \quotes_language english
83 \paperpagestyle default
84 \tracking_changes false
101 \begin_layout Plain Layout
103 If you have comments or error corrections, please send them to the LyX Documenta
105 \begin_inset CommandInset href
107 target "lyx-docs@lists.lyx.org"
120 \begin_layout Standard
121 \begin_inset CommandInset toc
122 LatexCommand tableofcontents
129 \begin_layout Section
130 The Philosophy of LyX
133 \begin_layout Subsection
137 \begin_layout Standard
138 LyX is a document preparation system.
139 It excels at letting you create complex technical and scientific articles
140 with mathematics, cross-references, bibliographies, indices, etc.
141 It is very good at documents of any length in which the usual processing
142 abilities are required: automatic sectioning and pagination, spellchecking,
144 It can also be used to write a letter to your mom, though granted, there
145 are probably simpler programs available for that.
146 It is definitely not the best tool for creating banners, flyers, or advertiseme
147 nts (we'll explain why later), though with some effort all these can be
149 Some examples of what it is used for: memos, letters, dissertations and
150 theses, lecture notes, seminar notebooks, conference proceedings, software
151 documentation, books, articles in refereed scientific journals, scripts
152 for plays and movies, business proposals, presentations \SpecialChar \ldots{}
156 \begin_layout Standard
157 LyX is a program that provides a modern approach to writing documents with
158 a computer by using a markup language paradigm, an approach that breaks
159 with the obsolete tradition of the
160 \begin_inset Quotes eld
164 \begin_inset Quotes erd
168 It is designed for authors who want professional output quickly with a
169 minimum of effort without becoming specialists in typesetting.
170 The job of typesetting is done mostly by the computer, not the author;
171 with LyX, the author can concentrate on the contents of her writing.
174 \begin_layout Standard
175 Part of the initial challenge of using LyX comes from the change in thinking
176 that you, the user, must make.
177 At one time, all we had for creating documents were typewriters, so we
178 all learned certain tricks to get around their limitations.
179 Underlining, which is little more than overstriking with the
180 \begin_inset Quotes eld
184 \begin_inset Quotes erd
187 character, became a way to emphasize text.
188 You were forced to figure out column sizes and tab stops, and set them,
189 before creating a table.
190 The same applied for letters and other right justified text.
191 Hyphenation at the end of a line required a careful eye and a lot of foresight.
194 \begin_layout Standard
195 In other words, we've all been trained to worry about the little details
196 of which character goes where.
197 Consequently, almost all word processors have this mentality.
198 They still use tab stops for adding whitespace.
199 You still need to worry about exactly where on the page something will
201 Emphasizing text means changing a font, similar to changing the typewriter
203 This is the underlying philosophy of a WYSIWYG word processor:
204 \begin_inset Quotes eld
207 What You See Is What You Get
208 \begin_inset Quotes erd
212 Unfortunately, that paradigm often results in
213 \begin_inset Quotes eld
216 What You See Is All You Get
217 \begin_inset Quotes erd
223 \begin_layout Standard
224 This is where LyX differs from an ordinary word processor.
225 You don't concern yourself with what character goes where.
230 and LyX takes care of the rest, following a set of rules called a
238 \begin_layout Plain Layout
239 To be fair, most recent versions of the most popular office suites now have
240 some sort of style sheets which follow a similar markup method.
241 However, our experience is that they are still rarely used in practice.
246 Let's look at a little example:
249 \begin_layout Standard
250 Suppose you are writing a report.
251 To begin your report, you want a section called
252 \begin_inset Quotes eld
255 Introduction\SpecialChar \@.
257 \begin_inset Quotes erd
260 So, you go into whatever menu it is in your word processor that changes
261 font sizes and decide on a new font size.
262 Then you turn on bold face.
264 \begin_inset Quotes eld
276 \begin_inset Quotes erd
280 Of course, if you later decide that this section belongs someplace else
281 in the document, or if you insert a new section before it, you need to
282 change the numbering for this and all following sections, as well as any
283 entry in the table of contents.
287 \begin_layout Standard
288 In LyX, you go to the pull-down on the far left of the button bar and select
294 \begin_inset Quotes eld
297 Introduction\SpecialChar \@.
299 \begin_inset Quotes erd
305 \begin_layout Standard
307 If you cut and paste the section, it will automatically be renumbered ---
309 And if you enter references to that section correctly (by inserting cross-refer
310 ence tags), LyX will automatically update them all throughout the file so
311 that you never, ever type a section number.
314 \begin_layout Standard
315 Now let's look at the problem of consistency.
316 Five days later, you reopen your report and start Section
321 However, you forget that you were using 18pt bold instead of 16pt, so you
322 type in the heading for Section
326 4 in a different font that what you used for Section
331 That problem doesn't even exist in LyX.
332 The computer takes care of all that silly bookkeeping about which thing
333 has what size font, not you.
334 After all, that's what a computer is good at.
337 \begin_layout Standard
338 Here's another example.
339 Suppose you're making a list.
340 In other word processors, a list is just a bunch of tab stops and newlines.
341 You need to figure out where to put the label for each list item, what
342 that label should be, how many blank lines to put between each item, and
344 Under LyX, you have only two concerns: what kind of list is this, and what
345 do I want to put in it.
349 \begin_layout Standard
350 So, the basic idea behind LyX is: specify
360 \begin_inset Quotes eld
363 What You See Is What You Get,
364 \begin_inset Quotes erd
368 \begin_inset Quotes eld
371 What You See Is What You
376 \begin_inset Quotes erd
380 \begin_inset Quotes eld
384 \begin_inset Quotes erd
387 It's a powerful idea that greatly simplifies the mechanics of writing documents.
388 This is also why LyX isn't so good for creating posters and flyers---in
393 want to specify exactly where everything goes, because there are no functional
394 units like paragraphs, sections, etc.
395 This doesn't mean LyX is missing some cool function.
396 It simply means that it isn't the right tool for the job --- you don't
397 use a screwdriver to drive in nails.
400 \begin_layout Subsection
401 Differences between LyX and Other Word Processors
405 \begin_layout Plain Layout
409 \begin_layout Plain Layout
422 \begin_layout Plain Layout
429 and Other Word Processors
437 \begin_layout Standard
438 Here's a list of things you won't find in LyX:
441 \begin_layout Itemize
445 \begin_layout Itemize
449 \begin_layout Itemize
451 \begin_inset space \thinspace{}
455 \begin_inset space \space{}
469 \begin_layout Standard
470 Tab stops, along with a ruler showing you the position of things on the
471 page, are useless in LyX.
472 The program worries about where things go on the page, not you.
473 Extra whitespace is similar; LyX adds them where necessary, depending on
475 Not being able to type two blank lines in a row will be annoying at first,
476 but it makes more sense once you're thinking in WYSIWYM terms.
479 \begin_layout Standard
480 Here are some things that exist in LyX, but aren't used as you might think:
483 \begin_layout Itemize
487 \begin_layout Itemize
491 \begin_layout Itemize
493 \begin_inset space \thinspace{}
497 \begin_inset space \space{}
500 single spaced, double spaced, etc.)
503 \begin_layout Itemize
504 Whitespace, horizontal and vertical
507 \begin_layout Itemize
511 \begin_layout Itemize
512 Typefaces (bold, italic, underline, etc.)
515 \begin_layout Standard
516 Although they exist in LyX, you generally don't need them.
517 LyX will take care of these things for you, depending on what you're doing.
518 Different parts of the document are automatically set in a different typeface
520 Paragraph indenting is context dependent; different types of paragraphs
521 get indented differently.
522 Page breaks get handled automatically, as well.
523 In general, the space between lines, between words, and between paragraphs
524 is variable, set by LyX.
528 \begin_layout Plain Layout
529 There are ways to adjust all of these (only some of which require knowledge
530 of LaTeX), either for a whole document or for a specific location in a
548 \begin_layout Standard
549 Lastly, there are a few areas where we believe LyX (and LaTeX) surpasses
550 many word processors:
553 \begin_layout Itemize
557 \begin_layout Itemize
561 \begin_layout Itemize
565 \begin_layout Itemize
569 \begin_layout Itemize
573 \begin_layout Standard
574 Granted, many modern word processors can handle mathematical symbols, tables,
575 and hyphenation, and many have moved towards style definitions and the
577 However, they've only recently been able to do so, whereas LyX is built
578 upon the LaTeX document preparation system.
579 LaTeX has been around for over 20 years, and
586 \begin_layout Subsection
590 \begin_layout Standard
591 LaTeX is a document preparation system designed by Leslie Lamport in 1985.
595 \begin_layout Plain Layout
596 The source for the info in this section is
597 \begin_inset Quotes eld
605 \begin_inset Quotes erd
608 by Helmut Kopka and Patrick Daly, which has an entry in the bibliography
619 It was built up from a typesetting language called TeX, created by Donald
621 TeX takes a sequence of typesetting commands, written in a script in an
622 ASCII file, and executes them.
624 \begin_inset Quotes eld
628 \begin_inset Quotes erd
631 of the printing trade were modeled by Knuth as computer algorithms and
632 incorporated into TeX, thus its excellent printed appearance.
633 What comes directly out of TeX is the portable document format
638 \begin_inset Quotes eld
642 \begin_inset Quotes erd
650 The dvi format is often used for previews and can later be converted to
651 other formats like PostScript.
655 \begin_layout Standard
656 TeX isn't only a typesetting engine, it also allows you to define macros.
657 Most people who use TeX are actually using a macro package which Knuth
658 created to hide a lot of the typesetting details.
659 This is where Leslie Lamport enters our story.
660 He wanted a macro package that was more user- and less typesetter-oriented,
661 with a set of commands that consistently typeset things like sections,
662 tables or math formulas in an uniform, consistent fashion.
663 This is how LaTeX was born.
666 \begin_layout Standard
667 Now, in parallel with the development and growth of LaTeX, other folks were
668 creating their own custom macro packages for TeX, ones to make slides or
669 articles for math journals and so on.
670 Some used the raw TeX facilities to do this, others began modifying LaTeX.
671 To try and unify this mess, a team of LaTeX-nicians began to work on LaTeX2e,
672 the current version of LaTeX, during the late 1980's.
673 This new version of LaTeX has commands which provide an easier-to-use interface
674 to TeX's macro-creating commands, aid in the use of new fonts, and so on.
675 In fact, LaTeX is quite an extensive language in its own right! Users around
676 the world have been creating their own add-ons for LaTeX beyond the standard
680 \begin_layout Standard
681 There are two ways to extend LaTeX: classes and styles.
686 is a set of LaTeX macros describing a new type of document, like a book,
688 There are classes for slides, for physics and math journals\SpecialChar \ldots{}
690 even have a class for their thesis format! A
694 differs from a class in that it doesn't define a new type of document,
695 but a different type of
699 that any document can use.
700 For example, LyX controls page margins and line spacing using two different
701 LaTeX style-files designed for these purposes.
702 There are style-files for a whole slew of things: printing labels or envelopes,
703 changing indentation behavior, adding new fonts, manipulating graphics,
704 designing fancy page headings, customizing bibliographies, altering the
705 location and appearance of footnotes, tables, and figures, customizing
709 \begin_layout Standard
713 \begin_layout Description
714 TeX: Typesetting language with macro capability.
717 \begin_layout Description
718 LaTeX: Macro package built upon TeX\SpecialChar \@.
722 \begin_layout Description
723 classes: Descriptions of a type of document, using LaTeX\SpecialChar \@.
727 \begin_layout Description
728 styles: Alters the default behavior of LaTeX in some way.
731 \begin_layout Description
732 LyX: Visual, WYSIWYM word-processor that uses LaTeX to do its typesetting.
735 \begin_layout Standard
736 This section attempts to account for the difference between LyX and other
738 Simply put, LaTeX is the difference.
739 By using LaTeX as its backend, LyX helps you think more about
748 The computer then handles
755 \begin_layout Section
756 Navigating the Documentation
759 \begin_layout Standard
760 To make it easier to answer your questions and describe all of the features
761 of LyX, the documentation has been split up into several different files.
762 Each one has its own purpose, as described below.
763 Before you go plowing into any of those files, however, you should read
764 this chapter thoroughly first, since it contains a lot of useful information
765 and commentary that can save you some time.
768 \begin_layout Standard
769 The developing of LyX will hopefully never stop, so that some of the documentati
770 on may be incomplete or a bit out of date, though we try to keep up.
771 Like the rest of LyX, the manuals are the work of a group of volunteers
773 \begin_inset Quotes eld
777 \begin_inset Quotes erd
780 , families, dishes to clean, kitty litter to dispose of, et cetera.
781 If you want to help out, be sure to read Section
786 \begin_inset CommandInset ref
788 reference "sec:Contrib"
792 in addition to the rest of this document.
795 \begin_layout Standard
796 Also, please do us a favor -- if anything in these manuals confuses you,
797 is unclear, or wrong, don't hesitate to let us know! You can reach the
798 current document maintainers by mailing to
799 \begin_inset CommandInset href
801 target "lyx-docs@lists.lyx.org"
807 If you have questions which are not obviously answered in the documentation,
808 and need help fast, there is an active users' mailing list which you can
810 \begin_inset CommandInset href
812 target "lyx-users@lists.lyx.org"
820 \begin_layout Subsection
821 The Format of the Manuals
824 \begin_layout Standard
825 Some may have printed out the manuals.
826 Others may be reading it within LyX.
827 There are some differences between the LyX-file and the printed version.
828 First, the title is simply at the top of the document, not formatted on
829 a separate page as in some of the printed versions.
830 Nor are any of the footnotes or the Table of Contents fully visible.
831 To open a footnote, which looks like this:
832 \begin_inset Graphics
833 filename clipart/footnoteQt4.png
838 , click on it with the left mouse button.
839 For the Table of Contents, either click on the grey box or click on the
844 menu, where the contents are displayed automatically\SpecialChar \@.
848 \begin_layout Standard
849 In the printed manuals, all cross-references appear as the actual numbers
850 for a chapter, section, subsection, and so on.
851 Online, however, all cross-references appear as a light-grey box like the
853 \begin_inset Graphics
854 filename clipart/referenceQt4.png
860 If you click on that box with the left mouse button, a dialog box will
861 appear containing a list of all the cross-references in the document.
862 This introduction has only two, the first one is named
863 \begin_inset Quotes eld
867 \begin_inset Quotes erd
871 You can go to the referred section by right-clicking on the box or by clicking
884 in the opened dialog.
885 Going back to where you came from is just as easy.
890 to go back to your earlier location.
893 \begin_layout Standard
894 Now that we've cleared up some of the differences between the printed and
895 online versions of this file, we can start looking at the format of this
897 You'll occasionally notice things in different fonts:
900 \begin_layout Itemize
905 is used for general emphasis, generic arguments, book titles, names of
906 sections of other manuals, and notes from the authors.
909 \begin_layout Itemize
914 is used for program and file names, LyX code and functions.
917 \begin_layout Itemize
922 is used for menu, button, or dialog box names, and the names of keyboard
926 \begin_layout Itemize
931 is used for people's names.
934 \begin_layout Itemize
939 is used for LaTeX code
942 \begin_layout Standard
943 For menu accelerator keys and keybindings, you'll probably get referred
949 \begin_inset Quotes eld
954 Addtional Features Manual
957 \begin_inset Quotes erd
965 When we do need to reference keys, we'll use the following prefixing convention
969 \begin_layout Itemize
970 \begin_inset Quotes eld
978 \begin_inset Quotes erd
988 \begin_layout Itemize
989 \begin_inset Quotes eld
997 \begin_inset Quotes erd
1007 \begin_layout Itemize
1008 \begin_inset Quotes eld
1016 \begin_inset Quotes erd
1023 key, which on some keyboards will be the
1030 \begin_layout Itemize
1031 \begin_inset Quotes eld
1039 \begin_inset Quotes erd
1042 \SpecialChar \ldots{}
1044 \begin_inset Quotes eld
1052 \begin_inset Quotes erd
1055 are the function keys.
1058 \begin_layout Itemize
1059 \begin_inset Quotes eld
1067 \begin_inset Quotes erd
1073 \begin_layout Itemize
1074 \begin_inset Quotes eld
1082 \begin_inset Quotes erd
1086 \begin_inset Quotes eld
1094 \begin_inset Quotes erd
1098 \begin_inset Quotes eld
1106 \begin_inset Quotes erd
1110 \begin_inset Quotes eld
1118 \begin_inset Quotes erd
1124 \begin_layout Itemize
1127 \begin_inset Quotes eld
1133 \begin_inset Quotes erd
1137 \begin_inset Quotes eld
1145 \begin_inset Quotes erd
1149 \begin_inset Quotes eld
1157 \begin_inset Quotes erd
1161 \begin_inset Quotes eld
1169 \begin_inset Quotes erd
1173 \begin_inset Quotes eld
1181 \begin_inset Quotes erd
1185 \begin_inset Quotes eld
1193 \begin_inset Quotes erd
1196 : these are the 6 keys that appear above the cursor keys on many PC keyboards.
1198 \begin_inset Quotes eld
1206 \begin_inset Quotes erd
1210 \begin_inset Quotes eld
1218 \begin_inset Quotes erd
1222 \begin_inset Quotes eld
1230 \begin_inset Quotes erd
1234 \begin_inset Quotes eld
1242 \begin_inset Quotes erd
1248 \begin_layout Itemize
1257 both refer to the same key.
1258 Some keyboards label the
1263 \begin_inset Quotes eld
1267 \begin_inset Quotes erd
1271 \begin_inset Quotes eld
1275 \begin_inset Quotes erd
1278 still others have two keys.
1279 LyX treats all of them as the same key, so we'll use
1290 \begin_layout Standard
1291 You'll also see something like
1292 \begin_inset Quotes eld
1298 \begin_inset Quotes els
1304 \begin_inset Quotes ers
1308 \begin_inset Quotes erd
1312 We've listed the possible default keybindings for a function in its entry
1314 \begin_inset Quotes eld
1319 Additional Features Manual
1322 \begin_inset Quotes erd
1325 so check there, too.
1326 Note that there are two different keybinding maps in common use in the
1328 \begin_inset Quotes eld
1332 \begin_inset Quotes erd
1335 style which is the default and familiar to those coming from the PC world,
1337 \begin_inset Quotes eld
1341 \begin_inset Quotes erd
1344 style, which is common with those who
1345 \begin_inset Quotes eld
1349 \begin_inset Quotes erd
1352 on Unix systems and use the Emacs editor.
1353 Unless specifically noted, the keybindings in the documentation are from
1354 the default CUA map.
1355 If you like Emacs, you should be smart enough to read the documentation
1356 and figure out the bindings on your own.
1359 \begin_layout Subsection
1360 Units used in the Manuals
1363 \begin_layout Standard
1364 To understand the units described in this documentation, Table
1365 \begin_inset space ~
1369 \begin_inset CommandInset ref
1371 reference "cap:Units-for-image"
1375 explains all units available in LyX.
1378 \begin_layout Standard
1379 \begin_inset Float table
1385 \begin_layout Plain Layout
1386 \begin_inset Caption
1388 \begin_layout Plain Layout
1389 \begin_inset CommandInset label
1391 name "cap:Units-for-image"
1403 \begin_layout Plain Layout
1404 \begin_inset VSpace medskip
1410 \begin_layout Plain Layout
1412 \begin_inset Tabular
1413 <lyxtabular version="3" rows="20" columns="2">
1415 <column alignment="center" valignment="top" width="0">
1416 <column alignment="center" valignment="top" width="0">
1418 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1421 \begin_layout Plain Layout
1427 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1430 \begin_layout Plain Layout
1438 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1441 \begin_layout Plain Layout
1447 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1450 \begin_layout Plain Layout
1458 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1461 \begin_layout Plain Layout
1467 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1470 \begin_layout Plain Layout
1478 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1481 \begin_layout Plain Layout
1487 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1490 \begin_layout Plain Layout
1498 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1501 \begin_layout Plain Layout
1507 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1510 \begin_layout Plain Layout
1512 \begin_inset space \thinspace{}
1516 \begin_inset space \thinspace{}
1526 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1529 \begin_layout Plain Layout
1535 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1538 \begin_layout Plain Layout
1540 \begin_inset space \thinspace{}
1544 \begin_inset space \thinspace{}
1554 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1557 \begin_layout Plain Layout
1563 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1566 \begin_layout Plain Layout
1568 \begin_inset space \thinspace{}
1572 \begin_inset space \thinspace{}
1582 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1585 \begin_layout Plain Layout
1591 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1594 \begin_layout Plain Layout
1596 \begin_inset space \thinspace{}
1600 \begin_inset space \thinspace{}
1610 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1613 \begin_layout Plain Layout
1619 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1622 \begin_layout Plain Layout
1624 \begin_inset space \thinspace{}
1628 \begin_inset Formula $\approx$
1632 \begin_inset space \thinspace{}
1642 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1645 \begin_layout Plain Layout
1651 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1654 \begin_layout Plain Layout
1656 \begin_inset space \thinspace{}
1660 \begin_inset space \thinspace{}
1670 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1673 \begin_layout Plain Layout
1679 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1682 \begin_layout Plain Layout
1683 % of original image width
1690 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1693 \begin_layout Plain Layout
1699 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1702 \begin_layout Plain Layout
1710 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1713 \begin_layout Plain Layout
1719 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1722 \begin_layout Plain Layout
1730 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1733 \begin_layout Plain Layout
1739 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1742 \begin_layout Plain Layout
1750 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1753 \begin_layout Plain Layout
1759 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1762 \begin_layout Plain Layout
1770 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1773 \begin_layout Plain Layout
1779 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1782 \begin_layout Plain Layout
1790 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1793 \begin_layout Plain Layout
1799 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1802 \begin_layout Plain Layout
1810 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1813 \begin_layout Plain Layout
1819 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1822 \begin_layout Plain Layout
1834 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1837 \begin_layout Plain Layout
1843 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1846 \begin_layout Plain Layout
1858 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1861 \begin_layout Plain Layout
1867 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1870 \begin_layout Plain Layout
1872 \begin_inset space \thinspace{}
1876 \begin_inset space \thinspace{}
1897 \begin_layout Subsection
1901 \begin_layout Standard
1902 The following list describes the contents of each of the files in the documentat
1906 \begin_layout Description
1907 Introduction This file.
1910 \begin_layout Description
1911 Tutorial If you are new to LyX, and have never used LaTeX before, you should
1913 If you have used LaTeX before, you should still read the
1917 , starting with the section on
1918 \begin_inset Quotes eld
1921 LyX for LaTeX users.
1922 \begin_inset Quotes erd
1925 (Skimming the rest of the document wouldn't hurt, either.)
1928 \begin_layout Description
1930 \begin_inset space ~
1933 Guide The primary documentation.
1938 of the basic operation and available features of LyX here.
1939 The main manual assumes that you've read the
1946 \begin_layout Description
1948 \begin_inset space ~
1951 Objects Extension of the
1956 Documents in detail how to use tables, graphics, floats, notes, and boxes.
1957 It also includes many tricks of the LaTeX masters.
1960 \begin_layout Description
1962 \begin_inset space ~
1965 Features Extension of the
1970 Documents how to use raw LaTeX commands, additional layouts, and special-purpos
1974 \begin_layout Description
1975 Customization A description of advanced LyX features, including how to customize
1976 the overall behavior of LyX\SpecialChar \@.
1977 This includes such things as keybindings, internati
1978 onalization, and configuration files.
1981 \begin_layout Description
1983 \begin_inset space ~
1986 configuration LyX investigates your system upon installation.
1987 This file contains info on what LyX learned about your installation.
1988 Check it to see if you're missing something you might like to have.
1991 \begin_layout Standard
1992 These files will reference one another as necessary.
2001 information on installation and customization, but refers the reader to
2004 Customization Manual
2006 for more information.
2009 \begin_layout Standard
2010 We'll state again an important point:
2013 \begin_layout Standard
2014 \begin_inset VSpace bigskip
2020 \begin_layout Standard
2022 If you are new to LyX, read the
2031 \begin_layout Standard
2032 \begin_inset VSpace bigskip
2038 \begin_layout Standard
2039 Otherwise, you could needlessly frustrate yourself.
2040 LyX does all that you need a word processor to do, but using a different
2044 \begin_layout Section
2045 Contributing to the LyX Project
2046 \begin_inset CommandInset label
2055 \begin_layout Subsection
2059 \begin_layout Standard
2060 LyX is mostly written in C++ (the LaTeX importer is written in Python).
2061 It is a large project, and as a result it is not free from bugs, or the
2062 need for improvements in the source code.
2065 \begin_layout Subsubsection
2069 \begin_layout Standard
2070 While using LyX, you may find behavior which you consider a bug.
2071 Crashes, though rare, can happen.
2072 User interface problems are considered major bugs by the LyX team: especially
2073 helpful are indications of parts of the LyX interface you find confusing,
2077 \begin_layout Standard
2078 LyX has a bug tracking system, which you can find at
2081 \begin_inset Flex URL
2084 \begin_layout Plain Layout
2086 http://bugzilla.lyx.org/
2094 You should check the bug tracker before reporting any bugs, in case it
2095 has already been reported.
2096 If you have a comment on an existing bug, or wish to report a new bug,
2097 you may either use the bug tracker, or send an e-mail to the development
2099 \begin_inset CommandInset href
2101 target "lyx-devel@lists.lyx.org"
2107 Archives of this list are linked from the main LyX website,
2110 \begin_inset Flex URL
2113 \begin_layout Plain Layout
2125 \begin_layout Standard
2126 A useful bug report will at a minimum include the version of LyX you are
2127 having the problem with.
2128 Accurate, detailed descriptions are preferred - the more time developers
2129 have to spend to pinpoint the source of a bug, the less time they have
2130 for other improvements.
2131 Mention the system and system version you are running LyX with.
2132 Give the versions of the libraries you have installed on your system, and,
2133 if relevant, the versions of external programs that LyX uses.
2134 If it's a compilation or configuration problem, include the file
2138 , and mention which compiler you are using.
2142 \begin_layout Subsubsection
2143 Contributing fixes and new features
2146 \begin_layout Standard
2147 If you have made changes to LyX's source that you think should become part
2148 of LyX, send your changes as a diff file (in unified format) to the development
2149 list referenced above, along with a change log, and a description of what
2153 \begin_layout Subsection
2154 Contributing to the Documentation
2157 \begin_layout Standard
2158 LyX's documentation is extensive; however LyX is under constant development,
2159 and each new release adds new features.
2160 You may find some documentation needs improvement.
2161 This section describes what to do if you find an error, or have some suggestion
2162 s for improving the documentation.
2165 \begin_layout Subsubsection
2166 Reporting Errors in the Manuals
2169 \begin_layout Standard
2170 If you find a problem with the documentation, send a message to the mailing
2172 \begin_inset CommandInset href
2174 target "lyx-docs@lists.lyx.org"
2180 The documentation team will make any necessary fixes.
2183 \begin_layout Subsubsection
2184 Joining the Documentation Team.
2187 \begin_layout Standard
2188 The LyX Documentation Project, like anything else in the LyX project, can
2189 always use assistance! If you're interested in contributing to the Documentatio
2190 n Project, you need to do the following:
2193 \begin_layout Enumerate
2194 Get the latest LyX source code from
2195 \begin_inset Newline newline
2199 \begin_inset Flex URL
2202 \begin_layout Plain Layout
2204 http://www.lyx.org/trac/browser/lyx-devel/trunk/lib/doc
2210 \begin_inset Newline newline
2213 Inside that directory is a file called
2218 Read it; it's the style sheet for the documentation.
2221 \begin_layout Enumerate
2231 \begin_inset Newline newline
2234 The point of this exercise is to give you ideas.
2243 is likely to be the most up-to-date of all of the documentation.
2244 You should be able to glean some insights into how we want the manuals
2245 to read and to look.
2248 \begin_layout Enumerate
2249 Contact the team at:
2250 \begin_inset Newline newline
2254 \begin_inset CommandInset href
2256 target "lyx-docs@lists.lyx.org"
2262 \begin_inset Newline newline
2265 to discuss your intended changes, and get some feedback on them.
2268 \begin_layout Standard
2269 The changes you wish to make may range from improving clarity of the text,
2270 to doing major re-structuring of the documentation.
2271 Any and all improvements are gladly received.