1 #LyX 1.6.0 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
54 \pdf_title "Introduction to LyX"
55 \pdf_author "LyX Team"
56 \pdf_subject "LyX-documentation Intro"
57 \pdf_keywords "LyX, documentation"
59 \pdf_bookmarksnumbered true
60 \pdf_bookmarksopen true
61 \pdf_bookmarksopenlevel 2
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
450 \begin_inset space \thinspace{}
454 \begin_inset space \space{}
468 \begin_layout Standard
469 Tab stops, along with a ruler showing you the position of things on the
470 page, are useless in LyX.
471 The program worries about where things go on the page, not you.
472 Extra whitespace is similar; LyX adds them where necessary, depending on
474 Not being able to type two blank lines in a row will be annoying at first,
475 but it makes more sense once you're thinking in WYSIWYM terms.
478 \begin_layout Standard
479 Here are some things that exist in LyX, but aren't used as you might think:
482 \begin_layout Itemize
486 \begin_layout Itemize
490 \begin_layout Itemize
492 \begin_inset space \thinspace{}
496 \begin_inset space \space{}
499 single spaced, double spaced, etc.)
502 \begin_layout Itemize
503 Whitespace, horizontal and vertical
506 \begin_layout Itemize
510 \begin_layout Itemize
511 Typefaces (bold, italic, underline, etc.)
514 \begin_layout Standard
515 Although they exist in LyX, you generally don't need them.
516 LyX will take care of these things for you, depending on what you're doing.
517 Different parts of the document are automatically set in a different typeface
519 Paragraph indenting is context dependent; different types of paragraphs
520 get indented differently.
521 Page breaks get handled automatically, as well.
522 In general, the space between lines, between words, and between paragraphs
523 is variable, set by LyX.
527 \begin_layout Plain Layout
528 There are ways to adjust all of these (only some of which require knowledge
529 of LaTeX), either for a whole document or for a specific location in a
547 \begin_layout Standard
548 Lastly, there are a few areas where we believe LyX (and LaTeX) surpasses
549 many word processors:
552 \begin_layout Itemize
556 \begin_layout Itemize
560 \begin_layout Itemize
564 \begin_layout Itemize
568 \begin_layout Itemize
572 \begin_layout Standard
573 Granted, many modern word processors can handle mathematical symbols, tables,
574 and hyphenation, and many have moved towards style definitions and the
576 However, they've only recently been able to do so, whereas LyX is built
577 upon the LaTeX document preparation system.
578 LaTeX has been around for over 20 years, and
585 \begin_layout Subsection
589 \begin_layout Standard
590 LaTeX is a document preparation system designed by Leslie Lamport in 1985.
594 \begin_layout Plain Layout
595 The source for the info in this section is
596 \begin_inset Quotes eld
604 \begin_inset Quotes erd
607 by Helmut Kopka and Patrick Daly, which has an entry in the bibliography
618 It was built up from a typesetting language called TeX, created by Donald
620 TeX takes a sequence of typesetting commands, written in a script in an
621 ASCII file, and executes them.
623 \begin_inset Quotes eld
627 \begin_inset Quotes erd
630 of the printing trade were modeled by Knuth as computer algorithms and
631 incorporated into TeX, thus its excellent printed appearance.
632 What comes directly out of TeX is the portable document format
637 \begin_inset Quotes eld
641 \begin_inset Quotes erd
649 The dvi format is often used for previews and can later be converted to
650 other formats like PostScript.
654 \begin_layout Standard
655 TeX isn't only a typesetting engine, it also allows you to define macros.
656 Most people who use TeX are actually using a macro package which Knuth
657 created to hide a lot of the typesetting details.
658 This is where Leslie Lamport enters our story.
659 He wanted a macro package that was more user- and less typesetter-oriented,
660 with a set of commands that consistently typeset things like sections,
661 tables or math formulas in an uniform, consistent fashion.
662 This is how LaTeX was born.
665 \begin_layout Standard
666 Now, in parallel with the development and growth of LaTeX, other folks were
667 creating their own custom macro packages for TeX, ones to make slides or
668 articles for math journals and so on.
669 Some used the raw TeX facilities to do this, others began modifying LaTeX.
670 To try and unify this mess, a team of LaTeX-nicians began to work on LaTeX2e,
671 the current version of LaTeX, during the late 1980's.
672 This new version of LaTeX has commands which provide an easier-to-use interface
673 to TeX's macro-creating commands, aid in the use of new fonts, and so on.
674 In fact, LaTeX is quite an extensive language in its own right! Users around
675 the world have been creating their own add-ons for LaTeX beyond the standard
679 \begin_layout Standard
680 There are two ways to extend LaTeX: classes and styles.
685 is a set of LaTeX macros describing a new type of document, like a book,
687 There are classes for slides, for physics and math journals\SpecialChar \ldots{}
689 even have a class for their thesis format! A
693 differs from a class in that it doesn't define a new type of document,
694 but a different type of
698 that any document can use.
699 For example, LyX controls page margins and line spacing using two different
700 LaTeX style-files designed for these purposes.
701 There are style-files for a whole slew of things: printing labels or envelopes,
702 changing indentation behavior, adding new fonts, manipulating graphics,
703 designing fancy page headings, customizing bibliographies, altering the
704 location and appearance of footnotes, tables, and figures, customizing
708 \begin_layout Standard
712 \begin_layout Description
713 TeX: Typesetting language with macro capability.
716 \begin_layout Description
717 LaTeX: Macro package built upon TeX\SpecialChar \@.
721 \begin_layout Description
722 classes: Descriptions of a type of document, using LaTeX\SpecialChar \@.
726 \begin_layout Description
727 styles: Alters the default behavior of LaTeX in some way.
730 \begin_layout Description
731 LyX: Visual, WYSIWYM word-processor that uses LaTeX to do its typesetting.
734 \begin_layout Standard
735 This section attempts to account for the difference between LyX and other
737 Simply put, LaTeX is the difference.
738 By using LaTeX as its backend, LyX helps you think more about
747 The computer then handles
754 \begin_layout Section
755 Navigating the Documentation
758 \begin_layout Standard
759 To make it easier to answer your questions and describe all of the features
760 of LyX, the documentation has been split up into several different files.
761 Each one has its own purpose, as described below.
762 Before you go plowing into any of those files, however, you should read
763 this chapter thoroughly first, since it contains a lot of useful information
764 and commentary that can save you some time.
767 \begin_layout Standard
768 The developing of LyX will hopefully never stop, so that some of the documentati
769 on may be incomplete or a bit out of date, though we try to keep up.
770 Like the rest of LyX, the manuals are the work of a group of volunteers
772 \begin_inset Quotes eld
776 \begin_inset Quotes erd
779 , families, dishes to clean, kitty litter to dispose of, et cetera.
780 If you want to help out, be sure to read Section
785 \begin_inset CommandInset ref
787 reference "sec:Contrib"
791 in addition to the rest of this document.
794 \begin_layout Standard
795 Also, please do us a favor -- if anything in these manuals confuses you,
796 is unclear, or wrong, don't hesitate to let us know! You can reach the
797 current document maintainers by mailing to
798 \begin_inset CommandInset href
800 target "lyx-docs@lists.lyx.org"
806 If you have questions which are not obviously answered in the documentation,
807 and need help fast, there is an active users' mailing list which you can
809 \begin_inset CommandInset href
811 target "lyx-users@lists.lyx.org"
819 \begin_layout Subsection
820 The Format of the Manuals
823 \begin_layout Standard
824 Some may have printed out the manuals.
825 Others may be reading it within LyX.
826 There are some differences between the LyX-file and the printed version.
827 First, the title is simply at the top of the document, not formatted on
828 a separate page as in some of the printed versions.
829 Nor are any of the footnotes or the Table of Contents fully visible.
830 To open a footnote, which looks like this:
831 \begin_inset Graphics
832 filename clipart/footnoteQt4.png
837 , click on it with the left mouse button.
838 For the Table of Contents, either click on the grey box or click on the
843 menu, where the contents are displayed automatically\SpecialChar \@.
847 \begin_layout Standard
848 In the printed manuals, all cross-references appear as the actual numbers
849 for a chapter, section, subsection, and so on.
850 Online, however, all cross-references appear as a light-grey box like the
852 \begin_inset Graphics
853 filename clipart/referenceQt4.png
859 If you click on that box with the left mouse button, a dialog box will
860 appear containing a list of all the cross-references in the document.
861 You can go to the referred section by right-clicking on the box or by clicking
874 in the opened dialog.
875 Going back to where you came from is just as easy.
884 to go back to your earlier location.
887 \begin_layout Standard
888 Now that we've cleared up some of the differences between the printed and
889 online versions of this file, we can start looking at the format of this
891 You'll occasionally notice things in different fonts:
894 \begin_layout Itemize
899 is used for general emphasis, generic arguments, book titles, names of
900 sections of other manuals, and notes from the authors.
903 \begin_layout Itemize
908 is used for program and file names, LyX code and functions.
911 \begin_layout Itemize
916 is used for menu, button, or dialog box names, and the names of keyboard
920 \begin_layout Itemize
925 is used for people's names.
928 \begin_layout Itemize
933 is used for LaTeX code
936 \begin_layout Standard
937 For menu accelerator keys and keybindings, you'll probably get referred
943 \begin_inset Quotes eld
948 Addtional Features Manual
951 \begin_inset Quotes erd
959 When we do need to reference keys, we'll use the following prefixing convention
963 \begin_layout Itemize
964 \begin_inset Quotes eld
972 \begin_inset Quotes erd
982 \begin_layout Itemize
983 \begin_inset Quotes eld
991 \begin_inset Quotes erd
1001 \begin_layout Itemize
1002 \begin_inset Quotes eld
1010 \begin_inset Quotes erd
1017 key, which on some keyboards will be the
1024 \begin_layout Itemize
1025 \begin_inset Quotes eld
1033 \begin_inset Quotes erd
1036 \SpecialChar \ldots{}
1038 \begin_inset Quotes eld
1046 \begin_inset Quotes erd
1049 are the function keys.
1052 \begin_layout Itemize
1053 \begin_inset Quotes eld
1061 \begin_inset Quotes erd
1067 \begin_layout Itemize
1068 \begin_inset Quotes eld
1076 \begin_inset Quotes erd
1080 \begin_inset Quotes eld
1088 \begin_inset Quotes erd
1092 \begin_inset Quotes eld
1100 \begin_inset Quotes erd
1104 \begin_inset Quotes eld
1112 \begin_inset Quotes erd
1118 \begin_layout Itemize
1121 \begin_inset Quotes eld
1127 \begin_inset Quotes erd
1131 \begin_inset Quotes eld
1139 \begin_inset Quotes erd
1143 \begin_inset Quotes eld
1151 \begin_inset Quotes erd
1155 \begin_inset Quotes eld
1163 \begin_inset Quotes erd
1167 \begin_inset Quotes eld
1175 \begin_inset Quotes erd
1179 \begin_inset Quotes eld
1187 \begin_inset Quotes erd
1190 : these are the 6 keys that appear above the cursor keys on many PC keyboards.
1192 \begin_inset Quotes eld
1200 \begin_inset Quotes erd
1204 \begin_inset Quotes eld
1212 \begin_inset Quotes erd
1216 \begin_inset Quotes eld
1224 \begin_inset Quotes erd
1228 \begin_inset Quotes eld
1236 \begin_inset Quotes erd
1242 \begin_layout Itemize
1251 both refer to the same key.
1252 Some keyboards label the
1257 \begin_inset Quotes eld
1261 \begin_inset Quotes erd
1265 \begin_inset Quotes eld
1269 \begin_inset Quotes erd
1272 still others have two keys.
1273 LyX treats all of them as the same key, so we'll use
1284 \begin_layout Standard
1285 You'll also see something like
1286 \begin_inset Quotes eld
1292 \begin_inset Quotes els
1298 \begin_inset Quotes ers
1302 \begin_inset Quotes erd
1306 We've listed the possible default keybindings for a function in its entry
1308 \begin_inset Quotes eld
1313 Additional Features Manual
1316 \begin_inset Quotes erd
1319 so check there, too.
1320 Note that there are two different keybinding maps in common use in the
1322 \begin_inset Quotes eld
1326 \begin_inset Quotes erd
1329 style which is the default and familiar to those coming from the PC world,
1331 \begin_inset Quotes eld
1335 \begin_inset Quotes erd
1338 style, which is common with those who
1339 \begin_inset Quotes eld
1343 \begin_inset Quotes erd
1346 on Unix systems and use the Emacs editor.
1347 Unless specifically noted, the keybindings in the documentation are from
1348 the default CUA map.
1349 If you like Emacs, you should be smart enough to read the documentation
1350 and figure out the bindings on your own.
1353 \begin_layout Subsection
1354 Units used in the Manuals
1357 \begin_layout Standard
1358 To understand the units described in this documentation, Table
1359 \begin_inset space ~
1363 \begin_inset CommandInset ref
1365 reference "cap:Units-for-image"
1369 explains all units available in LyX.
1372 \begin_layout Standard
1373 \begin_inset Float table
1379 \begin_layout Plain Layout
1380 \begin_inset Caption
1382 \begin_layout Plain Layout
1383 \begin_inset CommandInset label
1385 name "cap:Units-for-image"
1397 \begin_layout Plain Layout
1398 \begin_inset VSpace medskip
1404 \begin_layout Plain Layout
1406 \begin_inset Tabular
1407 <lyxtabular version="3" rows="20" columns="2">
1409 <column alignment="center" valignment="top" width="0">
1410 <column alignment="center" valignment="top" width="0">
1412 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1415 \begin_layout Plain Layout
1421 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1424 \begin_layout Plain Layout
1432 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1435 \begin_layout Plain Layout
1441 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1444 \begin_layout Plain Layout
1452 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1455 \begin_layout Plain Layout
1461 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1464 \begin_layout Plain Layout
1472 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1475 \begin_layout Plain Layout
1481 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1484 \begin_layout Plain Layout
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 space \thinspace{}
1576 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1579 \begin_layout Plain Layout
1585 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1588 \begin_layout Plain Layout
1590 \begin_inset space \thinspace{}
1594 \begin_inset space \thinspace{}
1604 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1607 \begin_layout Plain Layout
1613 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1616 \begin_layout Plain Layout
1618 \begin_inset space \thinspace{}
1622 \begin_inset Formula $\approx$
1626 \begin_inset space \thinspace{}
1636 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1639 \begin_layout Plain Layout
1645 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1648 \begin_layout Plain Layout
1650 \begin_inset space \thinspace{}
1654 \begin_inset space \thinspace{}
1664 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1667 \begin_layout Plain Layout
1673 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1676 \begin_layout Plain Layout
1677 % of original image width
1684 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1687 \begin_layout Plain Layout
1693 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1696 \begin_layout Plain Layout
1704 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1707 \begin_layout Plain Layout
1713 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1716 \begin_layout Plain Layout
1724 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1727 \begin_layout Plain Layout
1733 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1736 \begin_layout Plain Layout
1744 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1747 \begin_layout Plain Layout
1753 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1756 \begin_layout Plain Layout
1764 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1767 \begin_layout Plain Layout
1773 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1776 \begin_layout Plain Layout
1784 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1787 \begin_layout Plain Layout
1793 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1796 \begin_layout Plain Layout
1804 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1807 \begin_layout Plain Layout
1813 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1816 \begin_layout Plain Layout
1828 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1831 \begin_layout Plain Layout
1837 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1840 \begin_layout Plain Layout
1852 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1855 \begin_layout Plain Layout
1861 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1864 \begin_layout Plain Layout
1866 \begin_inset space \thinspace{}
1870 \begin_inset space \thinspace{}
1891 \begin_layout Subsection
1895 \begin_layout Standard
1896 The following list describes the contents of each of the files in the documentat
1900 \begin_layout Description
1901 Introduction This file.
1904 \begin_layout Description
1905 Tutorial If you are new to LyX, and have never used LaTeX before, you should
1907 If you have used LaTeX before, you should still read the
1911 , starting with the section on
1912 \begin_inset Quotes eld
1915 LyX for LaTeX users.
1916 \begin_inset Quotes erd
1919 (Skimming the rest of the document wouldn't hurt, either.)
1922 \begin_layout Description
1924 \begin_inset space ~
1927 Guide The primary documentation.
1932 of the basic operation and available features of LyX here.
1933 The main manual assumes that you've read the
1940 \begin_layout Description
1942 \begin_inset space ~
1945 Objects Extension of the
1950 Documents in detail how to use tables, graphics, floats, notes, and boxes.
1951 It also includes many tricks of the LaTeX masters.
1954 \begin_layout Description
1956 \begin_inset space ~
1959 Features Extension of the
1964 Documents how to use raw LaTeX commands, additional layouts, and special-purpos
1968 \begin_layout Description
1969 Customization A description of advanced LyX features, including how to customize
1970 the overall behavior of LyX\SpecialChar \@.
1971 This includes such things as keybindings, internati
1972 onalization, and configuration files.
1975 \begin_layout Description
1977 \begin_inset space ~
1980 configuration LyX investigates your system upon installation.
1981 This file contains info on what LyX learned about your installation.
1982 Check it to see if you're missing something you might like to have.
1985 \begin_layout Standard
1986 These files will reference one another as necessary.
1995 information on installation and customization, but refers the reader to
1998 Customization Manual
2000 for more information.
2003 \begin_layout Standard
2004 We'll state again an important point:
2007 \begin_layout Standard
2008 \begin_inset VSpace bigskip
2014 \begin_layout Standard
2016 If you are new to LyX, read the
2025 \begin_layout Standard
2026 \begin_inset VSpace bigskip
2032 \begin_layout Standard
2033 Otherwise, you could needlessly frustrate yourself.
2034 LyX does all that you need a word processor to do, but using a different
2038 \begin_layout Section
2039 Contributing to the LyX Project
2040 \begin_inset CommandInset label
2049 \begin_layout Subsection
2053 \begin_layout Standard
2054 LyX is mostly written in C++ (the LaTeX importer is written in Python).
2055 It is a large project, and as a result it is not free from bugs, or the
2056 need for improvements in the source code.
2059 \begin_layout Subsubsection
2063 \begin_layout Standard
2064 While using LyX, you may find behavior which you consider a bug.
2065 Crashes, though rare, can happen.
2066 User interface problems are considered major bugs by the LyX team: especially
2067 helpful are indications of parts of the LyX interface you find confusing,
2071 \begin_layout Standard
2072 LyX has a bug tracking system, which you can find at
2075 \begin_inset Flex URL
2078 \begin_layout Plain Layout
2080 http://bugzilla.lyx.org/
2088 You should check the bug tracker before reporting any bugs, in case it
2089 has already been reported.
2090 If you have a comment on an existing bug, or wish to report a new bug,
2091 you may either use the bug tracker, or send an e-mail to the development
2093 \begin_inset CommandInset href
2095 target "lyx-devel@lists.lyx.org"
2101 Archives of this list are linked from the main LyX website,
2104 \begin_inset Flex URL
2107 \begin_layout Plain Layout
2119 \begin_layout Standard
2120 A useful bug report will at a minimum include the version of LyX you are
2121 having the problem with.
2122 Accurate, detailed descriptions are preferred - the more time developers
2123 have to spend to pinpoint the source of a bug, the less time they have
2124 for other improvements.
2125 Mention the system and system version you are running LyX with.
2126 Give the versions of the libraries you have installed on your system, and,
2127 if relevant, the versions of external programs that LyX uses.
2128 If it's a compilation or configuration problem, include the file
2132 , and mention which compiler you are using.
2136 \begin_layout Subsubsection
2137 Contributing fixes and new features
2140 \begin_layout Standard
2141 If you have made changes to LyX's source that you think should become part
2142 of LyX, send your changes as a diff file (in unified format) to the development
2143 list referenced above, along with a change log, and a description of what
2147 \begin_layout Subsection
2148 Contributing to the Documentation
2151 \begin_layout Standard
2152 LyX's documentation is extensive; however LyX is under constant development,
2153 and each new release adds new features.
2154 You may find some documentation needs improvement.
2155 This section describes what to do if you find an error, or have some suggestion
2156 s for improving the documentation.
2159 \begin_layout Subsubsection
2160 Reporting Errors in the Manuals
2163 \begin_layout Standard
2164 If you find a problem with the documentation, send a message to the mailing
2166 \begin_inset CommandInset href
2168 target "lyx-docs@lists.lyx.org"
2174 The documentation team will make any necessary fixes.
2177 \begin_layout Subsubsection
2178 Joining the Documentation Team.
2181 \begin_layout Standard
2182 The LyX Documentation Project, like anything else in the LyX project, can
2183 always use assistance! If you're interested in contributing to the Documentatio
2184 n Project, you need to do the following:
2187 \begin_layout Enumerate
2188 Get the latest LyX source code from
2189 \begin_inset Newline newline
2193 \begin_inset Flex URL
2196 \begin_layout Plain Layout
2198 http://www.lyx.org/trac/browser/lyx-devel/trunk/lib/doc
2204 \begin_inset Newline newline
2207 Inside that directory is a file called
2212 Read it; it's the style sheet for the documentation.
2215 \begin_layout Enumerate
2225 \begin_inset Newline newline
2228 The point of this exercise is to give you ideas.
2237 is likely to be the most up-to-date of all of the documentation.
2238 You should be able to glean some insights into how we want the manuals
2239 to read and to look.
2242 \begin_layout Enumerate
2243 Contact the team at:
2244 \begin_inset Newline newline
2248 \begin_inset CommandInset href
2250 target "lyx-docs@lists.lyx.org"
2256 \begin_inset Newline newline
2259 to discuss your intended changes, and get some feedback on them.
2262 \begin_layout Standard
2263 The changes you wish to make may range from improving clarity of the text,
2264 to doing major re-structuring of the documentation.
2265 Any and all improvements are gladly received.