1 #LyX 1.6.0beta3 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 are numbered roman
25 % and a pdf-bookmark for the TOC is added
27 \let\myTOC\tableofcontents
28 \renewcommand\tableofcontents{%
29 \pdfbookmark[1]{Contents}{}
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\@}
43 \font_typewriter default
44 \font_default_family default
53 \pdf_title "Introduction to LyX"
54 \pdf_author "LyX Team"
55 \pdf_subject "LyX-documentation Intro"
56 \pdf_keywords "LyX, documentation"
58 \pdf_bookmarksnumbered true
59 \pdf_bookmarksopen true
60 \pdf_bookmarksopenlevel 2
65 \pdf_pagebackref false
66 \pdf_pdfusetitle false
67 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false, pdfpagelabels"
74 \paperorientation portrait
77 \paragraph_separation indent
79 \quotes_language english
82 \paperpagestyle default
83 \tracking_changes false
100 \begin_layout Plain Layout
102 If you have comments or error corrections, please send them to the LyX Documenta
104 \begin_inset CommandInset href
106 target "lyx-docs@lists.lyx.org"
119 \begin_layout Standard
120 \begin_inset CommandInset toc
121 LatexCommand tableofcontents
128 \begin_layout Section
129 The Philosophy of LyX
132 \begin_layout Subsection
136 \begin_layout Standard
137 LyX is a document preparation system.
138 It excels at letting you create complex technical and scientific articles
139 with mathematics, cross-references, bibliographies, indices, etc.
140 It is very good at documents of any length in which the usual processing
141 abilities are required: automatic sectioning and pagination, spellchecking,
143 It can also be used to write a letter to your mom, though granted, there
144 are probably simpler programs available for that.
145 It is definitely not the best tool for creating banners, flyers, or advertiseme
146 nts (we'll explain why later), though with some effort all these can be
148 Some examples of what it is used for: memos, letters, dissertations and
149 theses, lecture notes, seminar notebooks, conference proceedings, software
150 documentation, books, articles in refereed scientific journals, scripts
151 for plays and movies, business proposals, presentations \SpecialChar \ldots{}
155 \begin_layout Standard
156 LyX is a program that provides a modern approach to writing documents with
157 a computer by using a markup language paradigm, an approach that breaks
158 with the obsolete tradition of the
159 \begin_inset Quotes eld
163 \begin_inset Quotes erd
167 It is designed for authors who want professional output quickly with a
168 minimum of effort without becoming specialists in typesetting.
169 The job of typesetting is done mostly by the computer, not the author;
170 with LyX, the author can concentrate on the contents of her writing.
173 \begin_layout Standard
174 Part of the initial challenge of using LyX comes from the change in thinking
175 that you, the user, must make.
176 At one time, all we had for creating documents were typewriters, so we
177 all learned certain tricks to get around their limitations.
178 Underlining, which is little more than overstriking with the
179 \begin_inset Quotes eld
183 \begin_inset Quotes erd
186 character, became a way to emphasize text.
187 You were forced to figure out column sizes and tab stops, and set them,
188 before creating a table.
189 The same applied for letters and other right justified text.
190 Hyphenation at the end of a line required a careful eye and a lot of foresight.
193 \begin_layout Standard
194 In other words, we've all been trained to worry about the little details
195 of which character goes where.
196 Consequently, almost all word processors have this mentality.
197 They still use tab stops for adding whitespace.
198 You still need to worry about exactly where on the page something will
200 Emphasizing text means changing a font, similar to changing the typewriter
202 This is the underlying philosophy of a WYSIWYG word processor:
203 \begin_inset Quotes eld
206 What You See Is What You Get
207 \begin_inset Quotes erd
211 Unfortunately, that paradigm often results in
212 \begin_inset Quotes eld
215 What You See Is All You Get
216 \begin_inset Quotes erd
222 \begin_layout Standard
223 This is where LyX differs from an ordinary word processor.
224 You don't concern yourself with what character goes where.
229 and LyX takes care of the rest, following a set of rules called a
237 \begin_layout Plain Layout
238 To be fair, most recent versions of the most popular office suites now have
239 some sort of style sheets which follow a similar markup method.
240 However, our experience is that they are still rarely used in practice.
245 Let's look at a little example:
248 \begin_layout Standard
249 Suppose you are writing a report.
250 To begin your report, you want a section called
251 \begin_inset Quotes eld
254 Introduction\SpecialChar \@.
256 \begin_inset Quotes erd
259 So, you go into whatever menu it is in your word processor that changes
260 font sizes and decide on a new font size.
261 Then you turn on bold face.
263 \begin_inset Quotes eld
275 \begin_inset Quotes erd
279 Of course, if you later decide that this section belongs someplace else
280 in the document, or if you insert a new section before it, you need to
281 change the numbering for this and all following sections, as well as any
282 entry in the table of contents.
286 \begin_layout Standard
287 In LyX, you go to the pull-down on the far left of the button bar and select
293 \begin_inset Quotes eld
296 Introduction\SpecialChar \@.
298 \begin_inset Quotes erd
304 \begin_layout Standard
306 If you cut and paste the section, it will automatically be renumbered ---
308 And if you enter references to that section correctly (by inserting cross-refer
309 ence tags), LyX will automatically update them all throughout the file so
310 that you never, ever type a section number.
313 \begin_layout Standard
314 Now let's look at the problem of consistency.
315 Five days later, you reopen your report and start Section
320 However, you forget that you were using 18pt bold instead of 16pt, so you
321 type in the heading for Section
325 4 in a different font that what you used for Section
330 That problem doesn't even exist in LyX.
331 The computer takes care of all that silly bookkeeping about which thing
332 has what size font, not you.
333 After all, that's what a computer is good at.
336 \begin_layout Standard
337 Here's another example.
338 Suppose you're making a list.
339 In other word processors, a list is just a bunch of tab stops and newlines.
340 You need to figure out where to put the label for each list item, what
341 that label should be, how many blank lines to put between each item, and
343 Under LyX, you have only two concerns: what kind of list is this, and what
344 do I want to put in it.
348 \begin_layout Standard
349 So, the basic idea behind LyX is: specify
359 \begin_inset Quotes eld
362 What You See Is What You Get,
363 \begin_inset Quotes erd
367 \begin_inset Quotes eld
370 What You See Is What You
375 \begin_inset Quotes erd
379 \begin_inset Quotes eld
383 \begin_inset Quotes erd
386 It's a powerful idea that greatly simplifies the mechanics of writing documents.
387 This is also why LyX isn't so good for creating posters and flyers---in
392 want to specify exactly where everything goes, because there are no functional
393 units like paragraphs, sections, etc.
394 This doesn't mean LyX is missing some cool function.
395 It simply means that it isn't the right tool for the job --- you don't
396 use a screwdriver to drive in nails.
399 \begin_layout Subsection
400 Differences between LyX and Other Word Processors
404 \begin_layout Plain Layout
408 \begin_layout Plain Layout
421 \begin_layout Plain Layout
428 and Other Word Processors
436 \begin_layout Standard
437 Here's a list of things you won't find in LyX:
440 \begin_layout Itemize
444 \begin_layout Itemize
448 \begin_layout Itemize
449 Extra whitespace (i.e.
461 \begin_layout Standard
462 Tab stops, along with a ruler showing you the position of things on the
463 page, are useless in LyX.
464 The program worries about where things go on the page, not you.
465 Extra whitespace is similar; LyX adds them where necessary, depending on
467 Not being able to type two blank lines in a row will be annoying at first,
468 but it makes more sense once you're thinking in WYSIWYM terms.
471 \begin_layout Standard
472 Here are some things that exist in LyX, but aren't used as you might think:
475 \begin_layout Itemize
479 \begin_layout Itemize
483 \begin_layout Itemize
485 single spaced, double spaced, etc.)
488 \begin_layout Itemize
489 Whitespace, horizontal and vertical
492 \begin_layout Itemize
496 \begin_layout Itemize
497 Typefaces (bold, italic, underline, etc.)
500 \begin_layout Standard
501 Although they exist in LyX, you generally don't need them.
502 LyX will take care of these things for you, depending on what you're doing.
503 Different parts of the document are automatically set in a different typeface
505 Paragraph indenting is context dependent; different types of paragraphs
506 get indented differently.
507 Page breaks get handled automatically, as well.
508 In general, the space between lines, between words, and between paragraphs
509 is variable, set by LyX.
513 \begin_layout Plain Layout
514 There are ways to adjust all of these (only some of which require knowledge
515 of LaTeX), either for a whole document or for a specific location in a
533 \begin_layout Standard
534 Lastly, there are a few areas where we believe LyX (and LaTeX) surpasses
535 many word processors:
538 \begin_layout Itemize
542 \begin_layout Itemize
546 \begin_layout Itemize
550 \begin_layout Itemize
554 \begin_layout Itemize
558 \begin_layout Standard
559 Granted, many modern word processors can handle mathematical symbols, tables,
560 and hyphenation, and many have moved towards style definitions and the
562 However, they've only recently been able to do so, whereas LyX is built
563 upon the LaTeX document preparation system.
564 LaTeX has been around for over 20 years, and
571 \begin_layout Subsection
575 \begin_layout Standard
576 LaTeX is a document preparation system designed by Leslie Lamport in 1985.
580 \begin_layout Plain Layout
581 The source for the info in this section is
582 \begin_inset Quotes eld
590 \begin_inset Quotes erd
593 by Helmut Kopka and Patrick Daly, which has an entry in the bibliography
604 It was built up from a typesetting language called TeX, created by Donald
606 TeX takes a sequence of typesetting commands, written in a script in an
607 ASCII file, and executes them.
609 \begin_inset Quotes eld
613 \begin_inset Quotes erd
616 of the printing trade were modeled by Knuth as computer algorithms and
617 incorporated into TeX, thus its excellent printed appearance.
618 What comes directly out of TeX is the portable document format
623 \begin_inset Quotes eld
627 \begin_inset Quotes erd
635 The dvi format is often used for previews and can later be converted to
636 other formats like PostScript.
640 \begin_layout Standard
641 TeX isn't only a typesetting engine, it also allows you to define macros.
642 Most people who use TeX are actually using a macro package which Knuth
643 created to hide a lot of the typesetting details.
644 This is where Leslie Lamport enters our story.
645 He wanted a macro package that was more user- and less typesetter-oriented,
646 with a set of commands that consistently typeset things like sections,
647 tables or math formulas in an uniform, consistent fashion.
648 This is how LaTeX was born.
651 \begin_layout Standard
652 Now, in parallel with the development and growth of LaTeX, other folks were
653 creating their own custom macro packages for TeX, ones to make slides or
654 articles for math journals and so on.
655 Some used the raw TeX facilities to do this, others began modifying LaTeX.
656 To try and unify this mess, a team of LaTeX-nicians began to work on LaTeX2e,
657 the current version of LaTeX, during the late 1980's.
658 This new version of LaTeX has commands which provide an easier-to-use interface
659 to TeX's macro-creating commands, aid in the use of new fonts, and so on.
660 In fact, LaTeX is quite an extensive language in its own right! Users around
661 the world have been creating their own add-ons for LaTeX beyond the standard
665 \begin_layout Standard
666 There are two ways to extend LaTeX: classes and styles.
671 is a set of LaTeX macros describing a new type of document, like a book,
673 There are classes for slides, for physics and math journals\SpecialChar \ldots{}
675 even have a class for their thesis format! A
679 differs from a class in that it doesn't define a new type of document,
680 but a different type of
684 that any document can use.
685 For example, LyX controls page margins and line spacing using two different
686 LaTeX style-files designed for these purposes.
687 There are style-files for a whole slew of things: printing labels or envelopes,
688 changing indentation behavior, adding new fonts, manipulating graphics,
689 designing fancy page headings, customizing bibliographies, altering the
690 location and appearance of footnotes, tables, and figures, customizing
694 \begin_layout Standard
698 \begin_layout Description
699 TeX: Typesetting language with macro capability.
702 \begin_layout Description
703 LaTeX: Macro package built upon TeX\SpecialChar \@.
707 \begin_layout Description
708 classes: Descriptions of a type of document, using LaTeX\SpecialChar \@.
712 \begin_layout Description
713 styles: Alters the default behavior of LaTeX in some way.
716 \begin_layout Description
717 LyX: Visual, WYSIWYM word-processor that uses LaTeX to do its typesetting.
720 \begin_layout Standard
721 This section attempts to account for the difference between LyX and other
723 Simply put, LaTeX is the difference.
724 By using LaTeX as its backend, LyX helps you think more about
733 The computer then handles
740 \begin_layout Section
741 Navigating the Documentation
744 \begin_layout Standard
745 To make it easier to answer your questions and describe all of the features
746 of LyX, the documentation has been split up into several different files.
747 Each one has its own purpose, as described below.
748 Before you go plowing into any of those files, however, you should read
749 this chapter thoroughly first, since it contains a lot of useful information
750 and commentary that can save you some time.
753 \begin_layout Standard
754 The developing of LyX will hopefully never stop, so that some of the documentati
755 on may be incomplete or a bit out of date, though we try to keep up.
756 Like the rest of LyX, the manuals are the work of a group of volunteers
758 \begin_inset Quotes eld
762 \begin_inset Quotes erd
765 , families, dishes to clean, kitty litter to dispose of, et cetera.
766 If you want to help out, be sure to read Section
771 \begin_inset CommandInset ref
773 reference "sec:Contrib"
777 in addition to the rest of this document.)
780 \begin_layout Standard
781 Also, please do us a favor -- if anything in these manuals confuses you,
782 is unclear, or wrong, don't hesitate to let us know! You can reach the
783 current document maintainers by mailing to
784 \begin_inset CommandInset href
786 target "lyx-docs@lists.lyx.org"
792 If you have questions which are not obviously answered in the documentation,
793 and need help fast, there is an active users' mailing list which you can
795 \begin_inset CommandInset href
797 target "lyx-users@lists.lyx.org"
805 \begin_layout Subsection
806 The Format of the Manuals
809 \begin_layout Standard
810 Some may have printed out the manuals.
811 Others may be reading it within LyX.
812 There are some differences between the LyX-file and the printed version.
813 First, the title is simply at the top of the document, not formatted on
814 a separate page as in some of the printed versions.
815 Nor are any of the footnotes or the Table of Contents fully visible.
816 To open a footnote, which looks like this:
817 \begin_inset Graphics
818 filename clipart/footnoteQt4.png
823 , click on it with the left mouse button.
824 For the Table of Contents, either click on the grey box or click on the
829 menu, where the contents are displayed automatically\SpecialChar \@.
833 \begin_layout Standard
834 In the printed manuals, all cross-references appear as the actual numbers
835 for a chapter, section, subsection, and so on.
836 Online, however, all cross-references appear as a light-grey box like the
838 \begin_inset Graphics
839 filename clipart/referenceQt4.png
845 If you click on that box with the left mouse button, a dialog box will
846 appear containing a list of all the cross-references in the document.
847 This introduction has only two, the first one is named
848 \begin_inset Quotes eld
852 \begin_inset Quotes erd
856 You can go to the referred section by right-clicking on the box or by clicking
869 in the opened dialog.
870 Going back to where you came from is just as easy.
875 to go back to your earlier location.
878 \begin_layout Standard
879 Now that we've cleared up some of the differences between the printed and
880 online versions of this file, we can start looking at the format of this
882 You'll occasionally notice things in different fonts:
885 \begin_layout Itemize
890 is used for general emphasis, generic arguments, book titles, names of
891 sections of other manuals, and notes from the authors.
894 \begin_layout Itemize
899 is used for program and file names, LyX code and functions.
902 \begin_layout Itemize
907 is used for menu, button, or dialog box names, and the names of keyboard
911 \begin_layout Itemize
916 is used for people's names.
919 \begin_layout Itemize
924 is used for LaTeX code
927 \begin_layout Standard
928 For menu accelerator keys and keybindings, you'll probably get referred
934 \begin_inset Quotes eld
939 Extended Features Manual
942 \begin_inset Quotes erd
950 When we do need to reference keys, we'll use the following prefixing convention
954 \begin_layout Itemize
955 \begin_inset Quotes eld
963 \begin_inset Quotes erd
973 \begin_layout Itemize
974 \begin_inset Quotes eld
982 \begin_inset Quotes erd
992 \begin_layout Itemize
993 \begin_inset Quotes eld
1001 \begin_inset Quotes erd
1008 key, which on some keyboards will be the
1015 \begin_layout Itemize
1016 \begin_inset Quotes eld
1024 \begin_inset Quotes erd
1027 \SpecialChar \ldots{}
1029 \begin_inset Quotes eld
1037 \begin_inset Quotes erd
1040 are the function keys.
1043 \begin_layout Itemize
1044 \begin_inset Quotes eld
1052 \begin_inset Quotes erd
1058 \begin_layout Itemize
1059 \begin_inset Quotes eld
1067 \begin_inset Quotes erd
1071 \begin_inset Quotes eld
1079 \begin_inset Quotes erd
1083 \begin_inset Quotes eld
1091 \begin_inset Quotes erd
1095 \begin_inset Quotes eld
1103 \begin_inset Quotes erd
1109 \begin_layout Itemize
1112 \begin_inset Quotes eld
1118 \begin_inset Quotes erd
1122 \begin_inset Quotes eld
1130 \begin_inset Quotes erd
1134 \begin_inset Quotes eld
1142 \begin_inset Quotes erd
1146 \begin_inset Quotes eld
1154 \begin_inset Quotes erd
1158 \begin_inset Quotes eld
1166 \begin_inset Quotes erd
1170 \begin_inset Quotes eld
1178 \begin_inset Quotes erd
1181 : these are the 6 keys that appear above the cursor keys on many PC keyboards.
1183 \begin_inset Quotes eld
1191 \begin_inset Quotes erd
1195 \begin_inset Quotes eld
1203 \begin_inset Quotes erd
1207 \begin_inset Quotes eld
1215 \begin_inset Quotes erd
1219 \begin_inset Quotes eld
1227 \begin_inset Quotes erd
1233 \begin_layout Itemize
1242 both refer to the same key.
1243 Some keyboards label the
1248 \begin_inset Quotes eld
1252 \begin_inset Quotes erd
1256 \begin_inset Quotes eld
1260 \begin_inset Quotes erd
1263 still others have two keys.
1264 LyX treats all of them as the same key, so we'll use
1275 \begin_layout Standard
1276 You'll also see something like
1277 \begin_inset Quotes eld
1283 \begin_inset Quotes els
1289 \begin_inset Quotes ers
1293 \begin_inset Quotes erd
1297 We've listed the possible default keybindings for a function in its entry
1299 \begin_inset Quotes eld
1304 Extended Features Manual
1307 \begin_inset Quotes erd
1310 so check there, too.
1311 Note that there are two different keybinding maps in common use in the
1313 \begin_inset Quotes eld
1317 \begin_inset Quotes erd
1320 style which is the default and familiar to those coming from the PC world,
1322 \begin_inset Quotes eld
1326 \begin_inset Quotes erd
1329 style, which is common with those who
1330 \begin_inset Quotes eld
1334 \begin_inset Quotes erd
1337 on Unix systems and use the Emacs editor.
1338 Unless specifically noted, the keybindings in the documentation are from
1339 the default CUA map.
1340 If you like Emacs, you should be smart enough to read the documentation
1341 and figure out the bindings on your own.
1344 \begin_layout Subsection
1345 Units used in the Manuals
1348 \begin_layout Standard
1349 To understand the units described in this documentation, Table
1350 \begin_inset space ~
1354 \begin_inset CommandInset ref
1356 reference "cap:Units-for-image"
1360 explains all units available in LyX.
1363 \begin_layout Standard
1364 \begin_inset Float table
1370 \begin_layout Plain Layout
1371 \begin_inset Caption
1373 \begin_layout Plain Layout
1374 \begin_inset CommandInset label
1376 name "cap:Units-for-image"
1388 \begin_layout Plain Layout
1389 \begin_inset VSpace medskip
1395 \begin_layout Plain Layout
1397 \begin_inset Tabular
1398 <lyxtabular version="3" rows="20" columns="2">
1400 <column alignment="center" valignment="top" width="0">
1401 <column alignment="center" valignment="top" width="0">
1403 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1406 \begin_layout Plain Layout
1412 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1415 \begin_layout Plain Layout
1423 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1426 \begin_layout Plain Layout
1432 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1435 \begin_layout Plain Layout
1443 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1446 \begin_layout Plain Layout
1452 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1455 \begin_layout Plain Layout
1463 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1466 \begin_layout Plain Layout
1472 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1475 \begin_layout Plain Layout
1483 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1486 \begin_layout Plain Layout
1492 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1495 \begin_layout Plain Layout
1497 \begin_inset Formula $\,$
1501 \begin_inset Formula $\,$
1511 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1514 \begin_layout Plain Layout
1520 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1523 \begin_layout Plain Layout
1525 \begin_inset Formula $\,$
1529 \begin_inset Formula $\,$
1539 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1542 \begin_layout Plain Layout
1548 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1551 \begin_layout Plain Layout
1553 \begin_inset Formula $\,$
1557 \begin_inset Formula $\,$
1567 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1570 \begin_layout Plain Layout
1576 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1579 \begin_layout Plain Layout
1581 \begin_inset Formula $\,$
1585 \begin_inset Formula $\,$
1595 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1598 \begin_layout Plain Layout
1604 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1607 \begin_layout Plain Layout
1609 \begin_inset Formula $\,$
1613 \begin_inset Formula $\approx$
1617 \begin_inset Formula $\,$
1627 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1630 \begin_layout Plain Layout
1636 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1639 \begin_layout Plain Layout
1641 \begin_inset Formula $\,$
1645 \begin_inset Formula $\,$
1655 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1658 \begin_layout Plain Layout
1664 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1667 \begin_layout Plain Layout
1668 % of original image width
1675 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1678 \begin_layout Plain Layout
1684 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1687 \begin_layout Plain Layout
1695 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1698 \begin_layout Plain Layout
1704 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1707 \begin_layout Plain Layout
1715 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1718 \begin_layout Plain Layout
1724 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1727 \begin_layout Plain Layout
1735 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1738 \begin_layout Plain Layout
1744 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1747 \begin_layout Plain Layout
1755 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1758 \begin_layout Plain Layout
1764 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1767 \begin_layout Plain Layout
1775 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1778 \begin_layout Plain Layout
1784 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1787 \begin_layout Plain Layout
1795 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1798 \begin_layout Plain Layout
1804 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1807 \begin_layout Plain Layout
1819 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1822 \begin_layout Plain Layout
1828 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1831 \begin_layout Plain Layout
1843 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1846 \begin_layout Plain Layout
1852 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1855 \begin_layout Plain Layout
1857 \begin_inset Formula $\,$
1861 \begin_inset Formula $\,$
1882 \begin_layout Subsection
1886 \begin_layout Standard
1887 The following list describes the contents of each of the files in the documentat
1891 \begin_layout Description
1892 Introduction This file.
1895 \begin_layout Description
1896 Tutorial If you are new to LyX, and have never used LaTeX before, you should
1898 If you have used LaTeX before, you should still read the
1902 , starting with the section on
1903 \begin_inset Quotes eld
1906 LyX for LaTeX users.
1907 \begin_inset Quotes erd
1910 (Skimming the rest of the document wouldn't hurt, either.)
1913 \begin_layout Description
1915 \begin_inset space ~
1918 Guide The primary documentation.
1923 of the basic operation and available features of LyX here.
1924 The main manual assumes that you've read the
1931 \begin_layout Description
1933 \begin_inset space ~
1936 Objects Extension of the
1941 Documents in detail how to use tables, graphics, floats, notes, and boxes.
1942 It also includes many tricks of the LaTeX masters.
1945 \begin_layout Description
1947 \begin_inset space ~
1950 Features Extension of the
1955 Documents how to use raw LaTeX commands, additional layouts, and special-purpos
1959 \begin_layout Description
1960 Customization A description of advanced LyX features, including how to customize
1961 the overall behavior of LyX\SpecialChar \@.
1962 This includes such things as keybindings, internati
1963 onalization, and configuration files.
1966 \begin_layout Description
1968 \begin_inset space ~
1971 configuration LyX investigates your system upon installation.
1972 This file contains info on what LyX learned about your installation.
1973 Check it to see if you're missing something you might like to have.
1976 \begin_layout Standard
1977 These files will reference one another as necessary.
1986 information on installation and customization, but refers the reader to
1989 Customization Manual
1991 for more information.
1994 \begin_layout Standard
1995 We'll state again an important point:
1998 \begin_layout Standard
1999 \begin_inset VSpace bigskip
2005 \begin_layout Standard
2007 If you are new to LyX, read the
2016 \begin_layout Standard
2017 \begin_inset VSpace bigskip
2023 \begin_layout Standard
2024 Otherwise, you could needlessly frustrate yourself.
2025 LyX does all that you need a word processor to do, but using a different
2029 \begin_layout Section
2030 \begin_inset CommandInset label
2036 Contributing to the LyX Project
2039 \begin_layout Subsection
2043 \begin_layout Standard
2044 LyX is mostly written in C++ (the LaTeX importer is written in Python).
2045 It is a large project, and as a result it is not free from bugs, or the
2046 need for improvements in the source code.
2049 \begin_layout Subsubsection
2053 \begin_layout Standard
2054 While using LyX, you may find behavior which you consider a bug.
2055 Crashes, though rare, can happen.
2056 User interface problems are considered major bugs by the LyX team: especially
2057 helpful are indications of parts of the LyX interface you find confusing,
2061 \begin_layout Standard
2062 LyX has a bug tracking system, which you can find at
2065 \begin_inset Flex URL
2068 \begin_layout Plain Layout
2070 http://bugzilla.lyx.org/
2078 You should check the bug tracker before reporting any bugs, in case it
2079 has already been reported.
2080 If you have a comment on an existing bug, or wish to report a new bug,
2081 you may either use the bug tracker, or send an e-mail to the development
2083 \begin_inset CommandInset href
2085 target "lyx-devel@lists.lyx.org"
2091 Archives of this list are linked from the main LyX website,
2094 \begin_inset Flex URL
2097 \begin_layout Plain Layout
2109 \begin_layout Standard
2110 A useful bug report will at a minimum include the version of LyX you are
2111 having the problem with.
2112 Accurate, detailed descriptions are preferred - the more time developers
2113 have to spend to pinpoint the source of a bug, the less time they have
2114 for other improvements.
2115 Mention the system and system version you are running LyX with.
2116 Give the versions of the libraries you have installed on your system, and,
2117 if relevant, the versions of external programs that LyX uses.
2118 If it's a compilation or configuration problem, include the file
2122 , and mention which compiler you are using.
2126 \begin_layout Subsubsection
2127 Contributing fixes and new features
2130 \begin_layout Standard
2131 If you have made changes to LyX's source that you think should become part
2132 of LyX, send your changes as a diff file (in unified format) to the development
2133 list referenced above, along with a change log, and a description of what
2137 \begin_layout Subsection
2138 Contributing to the Documentation
2141 \begin_layout Standard
2142 LyX's documentation is extensive; however LyX is under constant development,
2143 and each new release adds new features.
2144 You may find some documentation needs improvement.
2145 This section describes what to do if you find an error, or have some suggestion
2146 s for improving the documentation.
2149 \begin_layout Subsubsection
2150 Reporting Errors in the Manuals
2153 \begin_layout Standard
2154 If you find a problem with the documentation, send a message to the mailing
2156 \begin_inset CommandInset href
2158 target "lyx-docs@lists.lyx.org"
2164 The documentation team will make any necessary fixes.
2167 \begin_layout Subsubsection
2168 Joining the Documentation Team.
2171 \begin_layout Standard
2172 The LyX Documentation Project, like anything else in the LyX project, can
2173 always use assistance! If you're interested in contributing to the Documentatio
2174 n Project, you need to do the following:
2177 \begin_layout Enumerate
2178 Get the latest LyX source code from
2179 \begin_inset Newline newline
2183 \begin_inset Flex URL
2186 \begin_layout Plain Layout
2188 http://www.lyx.org/trac/browser/lyx-devel/trunk/lib/doc
2194 \begin_inset Newline newline
2197 Inside that directory is a file called
2202 Read it; it's the style sheet for the documentation.
2205 \begin_layout Enumerate
2215 \begin_inset Newline newline
2218 The point of this exercise is to give you ideas.
2227 is likely to be the most up-to-date of all of the documentation.
2228 You should be able to glean some insights into how we want the manuals
2229 to read and to look.
2232 \begin_layout Enumerate
2233 Contact the team at:
2234 \begin_inset Newline newline
2238 \begin_inset CommandInset href
2240 target "lyx-docs@lists.lyx.org"
2246 \begin_inset Newline newline
2249 to discuss your intended changes, and get some feedback on them.
2252 \begin_layout Standard
2253 The changes you wish to make may range from improving clarity of the text,
2254 to doing major re-structuring of the documentation.
2255 Any and all improvements are gladly received.