1 #LyX 1.6.0svn created this file. For more info see http://www.lyx.org/
7 % DO NOT ALTER THIS PREAMBLE!!!
9 %This preamble is designed to ensure that the document prints
10 % out as advertised. If you mess with this preamble,
11 % parts of the document may not print out as expected. If you
12 % have problems LaTeXing this file, please contact
13 % the documentation team
14 % email: lyx-docs@lists.lyx.org
16 \usepackage{ifpdf} % part of the hyperref bundle
17 \ifpdf % if pdflatex is used
19 % set fonts for nicer pdf view
20 \IfFileExists{lmodern.sty}{\usepackage{lmodern}}{}
22 \fi % end if pdflatex is used
24 % the pages of the TOC is numbered roman
25 % and a pdf-bookmark for the TOC is added
27 \let\myTOC\tableofcontents
28 \renewcommand\tableofcontents{%
29 \pdfbookmark[1]{\contentsname}{}
32 \pagenumbering{arabic} }
34 % redefine the \LyX macro for PDF bookmarks
35 \def\LyX{\texorpdfstring{%
36 L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
43 \font_typewriter default
44 \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_pagebackref false
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
450 Extra whitespace (i.e.
462 \begin_layout Standard
463 Tab stops, along with a ruler showing you the position of things on the
464 page, are useless in LyX.
465 The program worries about where things go on the page, not you.
466 Extra whitespace is similar; LyX adds them where necessary, depending on
468 Not being able to type two blank lines in a row will be annoying at first,
469 but it makes more sense once you're thinking in WYSIWYM terms.
472 \begin_layout Standard
473 Here are some things that exist in LyX, but aren't used as you might think:
476 \begin_layout Itemize
480 \begin_layout Itemize
484 \begin_layout Itemize
486 single spaced, double spaced, etc.)
489 \begin_layout Itemize
490 Whitespace, horizontal and vertical
493 \begin_layout Itemize
497 \begin_layout Itemize
498 Typefaces (bold, italic, underline, etc.)
501 \begin_layout Standard
502 Although they exist in LyX, you generally don't need them.
503 LyX will take care of these things for you, depending on what you're doing.
504 Different parts of the document are automatically set in a different typeface
506 Paragraph indenting is context dependent; different types of paragraphs
507 get indented differently.
508 Page breaks get handled automatically, as well.
509 In general, the space between lines, between words, and between paragraphs
510 is variable, set by LyX.
514 \begin_layout Plain Layout
515 There are ways to adjust all of these (only some of which require knowledge
516 of LaTeX), either for a whole document or for a specific location in a
534 \begin_layout Standard
535 Lastly, there are a few areas where we believe LyX (and LaTeX) surpasses
536 many word processors:
539 \begin_layout Itemize
543 \begin_layout Itemize
547 \begin_layout Itemize
551 \begin_layout Itemize
555 \begin_layout Itemize
559 \begin_layout Standard
560 Granted, many modern word processors can handle mathematical symbols, tables,
561 and hyphenation, and many have moved towards style definitions and the
563 However, they've only recently been able to do so, whereas LyX is built
564 upon the LaTeX document preparation system.
565 LaTeX has been around for over 20 years, and
572 \begin_layout Subsection
576 \begin_layout Standard
577 LaTeX is a document preparation system designed by Leslie Lamport in 1985.
581 \begin_layout Plain Layout
582 The source for the info in this section is
583 \begin_inset Quotes eld
591 \begin_inset Quotes erd
594 by Helmut Kopka and Patrick Daly, which has an entry in the bibliography
605 It was built up from a typesetting language called TeX, created by Donald
607 TeX takes a sequence of typesetting commands, written in a script in an
608 ASCII file, and executes them.
610 \begin_inset Quotes eld
614 \begin_inset Quotes erd
617 of the printing trade were modeled by Knuth as computer algorithms and
618 incorporated into TeX, thus its excellent printed appearance.
619 What comes directly out of TeX is the portable document format
624 \begin_inset Quotes eld
628 \begin_inset Quotes erd
636 The dvi format is often used for previews and can later be converted to
637 other formats like PostScript.
641 \begin_layout Standard
642 TeX isn't only a typesetting engine, it also allows you to define macros.
643 Most people who use TeX are actually using a macro package which Knuth
644 created to hide a lot of the typesetting details.
645 This is where Leslie Lamport enters our story.
646 He wanted a macro package that was more user- and less typesetter-oriented,
647 with a set of commands that consistently typeset things like sections,
648 tables or math formulas in an uniform, consistent fashion.
649 This is how LaTeX was born.
652 \begin_layout Standard
653 Now, in parallel with the development and growth of LaTeX, other folks were
654 creating their own custom macro packages for TeX, ones to make slides or
655 articles for math journals and so on.
656 Some used the raw TeX facilities to do this, others began modifying LaTeX.
657 To try and unify this mess, a team of LaTeX-nicians began to work on LaTeX2e,
658 the current version of LaTeX, during the late 1980's.
659 This new version of LaTeX has commands which provide an easier-to-use interface
660 to TeX's macro-creating commands, aid in the use of new fonts, and so on.
661 In fact, LaTeX is quite an extensive language in its own right! Users around
662 the world have been creating their own add-ons for LaTeX beyond the standard
666 \begin_layout Standard
667 There are two ways to extend LaTeX: classes and styles.
672 is a set of LaTeX macros describing a new type of document, like a book,
674 There are classes for slides, for physics and math journals\SpecialChar \ldots{}
676 even have a class for their thesis format! A
680 differs from a class in that it doesn't define a new type of document,
681 but a different type of
685 that any document can use.
686 For example, LyX controls page margins and line spacing using two different
687 LaTeX style-files designed for these purposes.
688 There are style-files for a whole slew of things: printing labels or envelopes,
689 changing indentation behavior, adding new fonts, manipulating graphics,
690 designing fancy page headings, customizing bibliographies, altering the
691 location and appearance of footnotes, tables, and figures, customizing
695 \begin_layout Standard
699 \begin_layout Description
700 TeX: Typesetting language with macro capability.
703 \begin_layout Description
704 LaTeX: Macro package built upon TeX\SpecialChar \@.
708 \begin_layout Description
709 classes: Descriptions of a type of document, using LaTeX\SpecialChar \@.
713 \begin_layout Description
714 styles: Alters the default behavior of LaTeX in some way.
717 \begin_layout Description
718 LyX: Visual, WYSIWYM word-processor that uses LaTeX to do its typesetting.
721 \begin_layout Standard
722 This section attempts to account for the difference between LyX and other
724 Simply put, LaTeX is the difference.
725 By using LaTeX as its backend, LyX helps you think more about
734 The computer then handles
741 \begin_layout Section
742 Navigating the Documentation
745 \begin_layout Standard
746 To make it easier to answer your questions and describe all of the features
747 of LyX, the documentation has been split up into several different files.
748 Each one has its own purpose, as described below.
749 Before you go plowing into any of those files, however, you should read
750 this chapter thoroughly first, since it contains a lot of useful information
751 and commentary that can save you some time.
754 \begin_layout Standard
755 The developing of LyX will hopefully never stop, so that some of the documentati
756 on may be incomplete or a bit out of date, though we try to keep up.
757 Like the rest of LyX, the manuals are the work of a group of volunteers
759 \begin_inset Quotes eld
763 \begin_inset Quotes erd
766 , families, dishes to clean, kitty litter to dispose of, et cetera.
767 If you want to help out, be sure to read Section
772 \begin_inset CommandInset ref
774 reference "sec:Contrib"
778 in addition to the rest of this document.
781 \begin_layout Standard
782 Also, please do us a favor -- if anything in these manuals confuses you,
783 is unclear, or wrong, don't hesitate to let us know! You can reach the
784 current document maintainers by mailing to
785 \begin_inset CommandInset href
787 target "lyx-docs@lists.lyx.org"
793 If you have questions which are not obviously answered in the documentation,
794 and need help fast, there is an active users' mailing list which you can
796 \begin_inset CommandInset href
798 target "lyx-users@lists.lyx.org"
806 \begin_layout Subsection
807 The Format of the Manuals
810 \begin_layout Standard
811 Some may have printed out the manuals.
812 Others may be reading it within LyX.
813 There are some differences between the LyX-file and the printed version.
814 First, the title is simply at the top of the document, not formatted on
815 a separate page as in some of the printed versions.
816 Nor are any of the footnotes or the Table of Contents fully visible.
817 To open a footnote, which looks like this:
818 \begin_inset Graphics
819 filename clipart/footnoteQt4.png
824 , click on it with the left mouse button.
825 For the Table of Contents, either click on the grey box or click on the
830 menu, where the contents are displayed automatically\SpecialChar \@.
834 \begin_layout Standard
835 In the printed manuals, all cross-references appear as the actual numbers
836 for a chapter, section, subsection, and so on.
837 Online, however, all cross-references appear as a light-grey box like the
839 \begin_inset Graphics
840 filename clipart/referenceQt4.png
846 If you click on that box with the left mouse button, a dialog box will
847 appear containing a list of all the cross-references in the document.
848 This introduction has only two, the first one is named
849 \begin_inset Quotes eld
853 \begin_inset Quotes erd
857 You can go to the referred section by right-clicking on the box or by clicking
870 in the opened dialog.
871 Going back to where you came from is just as easy.
876 to go back to your earlier location.
879 \begin_layout Standard
880 Now that we've cleared up some of the differences between the printed and
881 online versions of this file, we can start looking at the format of this
883 You'll occasionally notice things in different fonts:
886 \begin_layout Itemize
891 is used for general emphasis, generic arguments, book titles, names of
892 sections of other manuals, and notes from the authors.
895 \begin_layout Itemize
900 is used for program and file names, LyX code and functions.
903 \begin_layout Itemize
908 is used for menu, button, or dialog box names, and the names of keyboard
912 \begin_layout Itemize
917 is used for people's names.
920 \begin_layout Itemize
925 is used for LaTeX code
928 \begin_layout Standard
929 For menu accelerator keys and keybindings, you'll probably get referred
935 \begin_inset Quotes eld
940 Extended Features Manual
943 \begin_inset Quotes erd
951 When we do need to reference keys, we'll use the following prefixing convention
955 \begin_layout Itemize
956 \begin_inset Quotes eld
964 \begin_inset Quotes erd
974 \begin_layout Itemize
975 \begin_inset Quotes eld
983 \begin_inset Quotes erd
993 \begin_layout Itemize
994 \begin_inset Quotes eld
1002 \begin_inset Quotes erd
1009 key, which on some keyboards will be the
1016 \begin_layout Itemize
1017 \begin_inset Quotes eld
1025 \begin_inset Quotes erd
1028 \SpecialChar \ldots{}
1030 \begin_inset Quotes eld
1038 \begin_inset Quotes erd
1041 are the function keys.
1044 \begin_layout Itemize
1045 \begin_inset Quotes eld
1053 \begin_inset Quotes erd
1059 \begin_layout Itemize
1060 \begin_inset Quotes eld
1068 \begin_inset Quotes erd
1072 \begin_inset Quotes eld
1080 \begin_inset Quotes erd
1084 \begin_inset Quotes eld
1092 \begin_inset Quotes erd
1096 \begin_inset Quotes eld
1104 \begin_inset Quotes erd
1110 \begin_layout Itemize
1113 \begin_inset Quotes eld
1119 \begin_inset Quotes erd
1123 \begin_inset Quotes eld
1131 \begin_inset Quotes erd
1135 \begin_inset Quotes eld
1143 \begin_inset Quotes erd
1147 \begin_inset Quotes eld
1155 \begin_inset Quotes erd
1159 \begin_inset Quotes eld
1167 \begin_inset Quotes erd
1171 \begin_inset Quotes eld
1179 \begin_inset Quotes erd
1182 : these are the 6 keys that appear above the cursor keys on many PC keyboards.
1184 \begin_inset Quotes eld
1192 \begin_inset Quotes erd
1196 \begin_inset Quotes eld
1204 \begin_inset Quotes erd
1208 \begin_inset Quotes eld
1216 \begin_inset Quotes erd
1220 \begin_inset Quotes eld
1228 \begin_inset Quotes erd
1234 \begin_layout Itemize
1243 both refer to the same key.
1244 Some keyboards label the
1249 \begin_inset Quotes eld
1253 \begin_inset Quotes erd
1257 \begin_inset Quotes eld
1261 \begin_inset Quotes erd
1264 still others have two keys.
1265 LyX treats all of them as the same key, so we'll use
1276 \begin_layout Standard
1277 You'll also see something like
1278 \begin_inset Quotes eld
1284 \begin_inset Quotes els
1290 \begin_inset Quotes ers
1294 \begin_inset Quotes erd
1298 We've listed the possible default keybindings for a function in its entry
1300 \begin_inset Quotes eld
1305 Extended Features Manual
1308 \begin_inset Quotes erd
1311 so check there, too.
1312 Note that there are two different keybinding maps in common use in the
1314 \begin_inset Quotes eld
1318 \begin_inset Quotes erd
1321 style which is the default and familiar to those coming from the PC world,
1323 \begin_inset Quotes eld
1327 \begin_inset Quotes erd
1330 style, which is common with those who
1331 \begin_inset Quotes eld
1335 \begin_inset Quotes erd
1338 on Unix systems and use the Emacs editor.
1339 Unless specifically noted, the keybindings in the documentation are from
1340 the default CUA map.
1341 If you like Emacs, you should be smart enough to read the documentation
1342 and figure out the bindings on your own.
1345 \begin_layout Subsection
1346 Units used in the Manuals
1349 \begin_layout Standard
1350 To understand the units described in this documentation, Table
1351 \begin_inset space ~
1355 \begin_inset CommandInset ref
1357 reference "cap:Units-for-image"
1361 explains all units available in LyX.
1364 \begin_layout Standard
1365 \begin_inset Float table
1371 \begin_layout Plain Layout
1372 \begin_inset Caption
1374 \begin_layout Plain Layout
1375 \begin_inset CommandInset label
1377 name "cap:Units-for-image"
1389 \begin_layout Plain Layout
1390 \begin_inset VSpace medskip
1396 \begin_layout Plain Layout
1398 \begin_inset Tabular
1399 <lyxtabular version="3" rows="20" columns="2">
1401 <column alignment="center" valignment="top" width="0">
1402 <column alignment="center" valignment="top" width="0">
1404 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1407 \begin_layout Plain Layout
1413 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1416 \begin_layout Plain Layout
1424 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1427 \begin_layout Plain Layout
1433 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1436 \begin_layout Plain Layout
1444 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1447 \begin_layout Plain Layout
1453 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1456 \begin_layout Plain Layout
1464 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1467 \begin_layout Plain Layout
1473 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1476 \begin_layout Plain Layout
1484 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1487 \begin_layout Plain Layout
1493 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1496 \begin_layout Plain Layout
1498 \begin_inset space \thinspace{}
1502 \begin_inset space \thinspace{}
1512 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1515 \begin_layout Plain Layout
1521 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1524 \begin_layout Plain Layout
1526 \begin_inset space \thinspace{}
1530 \begin_inset space \thinspace{}
1540 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1543 \begin_layout Plain Layout
1549 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1552 \begin_layout Plain Layout
1554 \begin_inset space \thinspace{}
1558 \begin_inset space \thinspace{}
1568 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1571 \begin_layout Plain Layout
1577 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1580 \begin_layout Plain Layout
1582 \begin_inset space \thinspace{}
1586 \begin_inset space \thinspace{}
1596 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1599 \begin_layout Plain Layout
1605 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1608 \begin_layout Plain Layout
1610 \begin_inset space \thinspace{}
1614 \begin_inset Formula $\approx$
1618 \begin_inset space \thinspace{}
1628 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1631 \begin_layout Plain Layout
1637 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1640 \begin_layout Plain Layout
1642 \begin_inset space \thinspace{}
1646 \begin_inset space \thinspace{}
1656 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1659 \begin_layout Plain Layout
1665 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1668 \begin_layout Plain Layout
1669 % of original image width
1676 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1679 \begin_layout Plain Layout
1685 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1688 \begin_layout Plain Layout
1696 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1699 \begin_layout Plain Layout
1705 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1708 \begin_layout Plain Layout
1716 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1719 \begin_layout Plain Layout
1725 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1728 \begin_layout Plain Layout
1736 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1739 \begin_layout Plain Layout
1745 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1748 \begin_layout Plain Layout
1756 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1759 \begin_layout Plain Layout
1765 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1768 \begin_layout Plain Layout
1776 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1779 \begin_layout Plain Layout
1785 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1788 \begin_layout Plain Layout
1796 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1799 \begin_layout Plain Layout
1805 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1808 \begin_layout Plain Layout
1820 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1823 \begin_layout Plain Layout
1829 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1832 \begin_layout Plain Layout
1844 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1847 \begin_layout Plain Layout
1853 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1856 \begin_layout Plain Layout
1858 \begin_inset space \thinspace{}
1862 \begin_inset space \thinspace{}
1883 \begin_layout Subsection
1887 \begin_layout Standard
1888 The following list describes the contents of each of the files in the documentat
1892 \begin_layout Description
1893 Introduction This file.
1896 \begin_layout Description
1897 Tutorial If you are new to LyX, and have never used LaTeX before, you should
1899 If you have used LaTeX before, you should still read the
1903 , starting with the section on
1904 \begin_inset Quotes eld
1907 LyX for LaTeX users.
1908 \begin_inset Quotes erd
1911 (Skimming the rest of the document wouldn't hurt, either.)
1914 \begin_layout Description
1916 \begin_inset space ~
1919 Guide The primary documentation.
1924 of the basic operation and available features of LyX here.
1925 The main manual assumes that you've read the
1932 \begin_layout Description
1934 \begin_inset space ~
1937 Objects Extension of the
1942 Documents in detail how to use tables, graphics, floats, notes, and boxes.
1943 It also includes many tricks of the LaTeX masters.
1946 \begin_layout Description
1948 \begin_inset space ~
1951 Features Extension of the
1956 Documents how to use raw LaTeX commands, additional layouts, and special-purpos
1960 \begin_layout Description
1961 Customization A description of advanced LyX features, including how to customize
1962 the overall behavior of LyX\SpecialChar \@.
1963 This includes such things as keybindings, internati
1964 onalization, and configuration files.
1967 \begin_layout Description
1969 \begin_inset space ~
1972 configuration LyX investigates your system upon installation.
1973 This file contains info on what LyX learned about your installation.
1974 Check it to see if you're missing something you might like to have.
1977 \begin_layout Standard
1978 These files will reference one another as necessary.
1987 information on installation and customization, but refers the reader to
1990 Customization Manual
1992 for more information.
1995 \begin_layout Standard
1996 We'll state again an important point:
1999 \begin_layout Standard
2000 \begin_inset VSpace bigskip
2006 \begin_layout Standard
2008 If you are new to LyX, read the
2017 \begin_layout Standard
2018 \begin_inset VSpace bigskip
2024 \begin_layout Standard
2025 Otherwise, you could needlessly frustrate yourself.
2026 LyX does all that you need a word processor to do, but using a different
2030 \begin_layout Section
2031 \begin_inset CommandInset label
2037 Contributing to the LyX Project
2040 \begin_layout Subsection
2044 \begin_layout Standard
2045 LyX is mostly written in C++ (the LaTeX importer is written in Python).
2046 It is a large project, and as a result it is not free from bugs, or the
2047 need for improvements in the source code.
2050 \begin_layout Subsubsection
2054 \begin_layout Standard
2055 While using LyX, you may find behavior which you consider a bug.
2056 Crashes, though rare, can happen.
2057 User interface problems are considered major bugs by the LyX team: especially
2058 helpful are indications of parts of the LyX interface you find confusing,
2062 \begin_layout Standard
2063 LyX has a bug tracking system, which you can find at
2066 \begin_inset Flex URL
2069 \begin_layout Plain Layout
2071 http://bugzilla.lyx.org/
2079 You should check the bug tracker before reporting any bugs, in case it
2080 has already been reported.
2081 If you have a comment on an existing bug, or wish to report a new bug,
2082 you may either use the bug tracker, or send an e-mail to the development
2084 \begin_inset CommandInset href
2086 target "lyx-devel@lists.lyx.org"
2092 Archives of this list are linked from the main LyX website,
2095 \begin_inset Flex URL
2098 \begin_layout Plain Layout
2110 \begin_layout Standard
2111 A useful bug report will at a minimum include the version of LyX you are
2112 having the problem with.
2113 Accurate, detailed descriptions are preferred - the more time developers
2114 have to spend to pinpoint the source of a bug, the less time they have
2115 for other improvements.
2116 Mention the system and system version you are running LyX with.
2117 Give the versions of the libraries you have installed on your system, and,
2118 if relevant, the versions of external programs that LyX uses.
2119 If it's a compilation or configuration problem, include the file
2123 , and mention which compiler you are using.
2127 \begin_layout Subsubsection
2128 Contributing fixes and new features
2131 \begin_layout Standard
2132 If you have made changes to LyX's source that you think should become part
2133 of LyX, send your changes as a diff file (in unified format) to the development
2134 list referenced above, along with a change log, and a description of what
2138 \begin_layout Subsection
2139 Contributing to the Documentation
2142 \begin_layout Standard
2143 LyX's documentation is extensive; however LyX is under constant development,
2144 and each new release adds new features.
2145 You may find some documentation needs improvement.
2146 This section describes what to do if you find an error, or have some suggestion
2147 s for improving the documentation.
2150 \begin_layout Subsubsection
2151 Reporting Errors in the Manuals
2154 \begin_layout Standard
2155 If you find a problem with the documentation, send a message to the mailing
2157 \begin_inset CommandInset href
2159 target "lyx-docs@lists.lyx.org"
2165 The documentation team will make any necessary fixes.
2168 \begin_layout Subsubsection
2169 Joining the Documentation Team.
2172 \begin_layout Standard
2173 The LyX Documentation Project, like anything else in the LyX project, can
2174 always use assistance! If you're interested in contributing to the Documentatio
2175 n Project, you need to do the following:
2178 \begin_layout Enumerate
2179 Get the latest LyX source code from
2180 \begin_inset Newline newline
2184 \begin_inset Flex URL
2187 \begin_layout Plain Layout
2189 http://www.lyx.org/trac/browser/lyx-devel/trunk/lib/doc
2195 \begin_inset Newline newline
2198 Inside that directory is a file called
2203 Read it; it's the style sheet for the documentation.
2206 \begin_layout Enumerate
2216 \begin_inset Newline newline
2219 The point of this exercise is to give you ideas.
2228 is likely to be the most up-to-date of all of the documentation.
2229 You should be able to glean some insights into how we want the manuals
2230 to read and to look.
2233 \begin_layout Enumerate
2234 Contact the team at:
2235 \begin_inset Newline newline
2239 \begin_inset CommandInset href
2241 target "lyx-docs@lists.lyx.org"
2247 \begin_inset Newline newline
2250 to discuss your intended changes, and get some feedback on them.
2253 \begin_layout Standard
2254 The changes you wish to make may range from improving clarity of the text,
2255 to doing major re-structuring of the documentation.
2256 Any and all improvements are gladly received.