1 #LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
7 % DO NOT ALTER THIS PREAMBLE!!!
9 %This preamble is designed to ensure that the document prints
10 % out as advertised. If you mess with this preamble,
11 % parts of the document may not print out as expected. If you
12 % have problems LaTeXing this file, please contact
13 % the documentation team
14 % email: lyx-docs@lists.lyx.org
16 \usepackage{ifpdf} % part of the hyperref bundle
17 \ifpdf % if pdflatex is used
19 % set fonts for nicer pdf view
20 \IfFileExists{lmodern.sty}{\usepackage{lmodern}}{}
22 \fi % end if pdflatex is used
24 % the pages of the TOC is numbered roman
25 % and a pdf-bookmark for the TOC is added
27 \let\myTOC\tableofcontents
28 \renewcommand\tableofcontents{%
29 \pdfbookmark[1]{\contentsname}{}
32 \pagenumbering{arabic} }
34 % redefine the \LyX macro for PDF bookmarks
35 \def\LyX{\texorpdfstring{%
36 L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
39 \use_default_options false
45 \font_typewriter default
46 \font_default_family default
54 \default_output_format default
55 \bibtex_command default
56 \index_command default
60 \pdf_title "Introduction to LyX"
61 \pdf_author "LyX Team"
62 \pdf_subject "LyX-documentation Intro"
63 \pdf_keywords "LyX, documentation"
65 \pdf_bookmarksnumbered true
66 \pdf_bookmarksopen true
67 \pdf_bookmarksopenlevel 2
72 \pdf_pdfusetitle false
73 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false, pdfpagelabels"
82 \paperorientation portrait
90 \paragraph_separation indent
91 \paragraph_indentation default
92 \quotes_language english
95 \paperpagestyle default
96 \tracking_changes true
100 \author 1 "Richard Heck"
114 \begin_layout Plain Layout
116 If you have comments or error corrections, please send them to the LyX Documenta
118 \begin_inset CommandInset href
120 target "lyx-docs@lists.lyx.org"
133 \begin_layout Standard
134 \begin_inset CommandInset toc
135 LatexCommand tableofcontents
142 \begin_layout Section
143 The Philosophy of LyX
146 \begin_layout Subsection
150 \begin_layout Standard
151 LyX is a document preparation system.
152 It excels at letting you create complex technical and scientific articles
153 with mathematics, cross-references, bibliographies, indices, etc.
154 It is very good at documents of any length in which the usual processing
155 abilities are required: automatic sectioning and pagination, spell checking,
157 It can also be used to write a letter to your mom, though granted, there
158 are probably simpler programs available for that.
159 It is definitely not the best tool for creating banners, flyers, or advertiseme
160 nts (we'll explain why later), though with some effort all these can be
162 Some examples of what it is used for: memos, letters, dissertations and
163 theses, lecture notes, seminar notebooks, conference proceedings, software
164 documentation, books, articles in refereed scientific journals, scripts
165 for plays and movies, business proposals, presentations \SpecialChar \ldots{}
169 \begin_layout Standard
170 LyX is a program that provides a modern approach to writing documents with
171 a computer by using a markup language paradigm, an approach that breaks
172 with the obsolete tradition of the
173 \begin_inset Quotes eld
177 \begin_inset Quotes erd
181 It is designed for authors who want professional output quickly with a
182 minimum of effort without becoming specialists in typesetting.
183 The job of typesetting is done mostly by the computer, not the author;
184 with LyX, the author can concentrate on the contents of his writing.
187 \begin_layout Standard
188 Part of the initial challenge of using LyX comes from the change in thinking
189 that you, the user, must make.
190 At one time, all we had for creating documents were typewriters, so we
191 all learned certain tricks to get around their limitations.
192 Underlining, which is little more than overstriking with the
193 \begin_inset Quotes eld
197 \begin_inset Quotes erd
200 character, became a way to emphasize text.
201 You were forced to figure out column sizes and tab stops, and set them,
202 before creating a table.
203 The same applied for letters and other right justified text.
204 Hyphenation at the end of a line required a careful eye and a lot of foresight.
207 \begin_layout Standard
208 In other words, we've all been trained to worry about the little details
209 of which character goes where.
210 Consequently, almost all word processors have this mentality.
211 They still use tab stops for adding whitespace.
212 You still need to worry about exactly where on the page something will
214 Emphasizing text means changing a font, similar to changing the typewriter
216 This is the underlying philosophy of a WYSIWYG word processor:
217 \begin_inset Quotes eld
220 What You See Is What You Get
221 \begin_inset Quotes erd
225 Unfortunately, that paradigm often results in
226 \begin_inset Quotes eld
229 What You See Is All You Get
230 \begin_inset Quotes erd
236 \begin_layout Standard
237 This is where LyX differs from an ordinary word processor.
238 You don't concern yourself with what character goes where.
243 and LyX takes care of the rest, following a set of rules called a
251 \begin_layout Plain Layout
252 To be fair, most recent versions of the most popular office suites now have
253 some sort of style sheets which follow a similar markup method.
254 However, our experience is that they are still rarely used in practice.
259 Let's look at a little example:
262 \begin_layout Standard
263 Suppose you are writing a report.
264 To begin your report, you want a section called
265 \begin_inset Quotes eld
268 Introduction\SpecialChar \@.
270 \begin_inset Quotes erd
273 So, you go into whatever menu it is in your word processor that changes
274 font sizes and decide on a new font size.
275 Then you turn on bold face.
277 \begin_inset Quotes eld
289 \begin_inset Quotes erd
293 Of course, if you later decide that this section belongs someplace else
294 in the document, or if you insert a new section before it, you need to
295 change the numbering for this and all following sections, as well as any
296 entry in the table of contents.
300 \begin_layout Standard
301 In LyX, you go to the pull-down on the far left of the button bar and select
307 \begin_inset Quotes eld
310 Introduction\SpecialChar \@.
312 \begin_inset Quotes erd
318 \begin_layout Standard
320 If you cut and paste the section, it will automatically be renumbered---everywh
322 And if you enter references to that section correctly (by inserting cross-refer
323 ence tags), LyX will automatically update them all throughout the file so
324 that you never, ever type a section number.
327 \begin_layout Standard
328 Now let's look at the problem of consistency.
329 Five days later, you reopen your report and start Section
334 However, you forget that you were using 18pt bold instead of 16pt, so you
335 type in the heading for Section
339 4 in a different font that what you used for Section
344 That problem doesn't even exist in LyX.
345 The computer takes care of all that silly bookkeeping about which thing
346 has what size font, not you.
347 After all, that's what a computer is good at.
350 \begin_layout Standard
351 Here's another example.
352 Suppose you're making a list.
353 In other word processors, a list is just a bunch of tab stops and newlines.
354 You need to figure out where to put the label for each list item, what
355 that label should be, how many blank lines to put between each item, and
357 Under LyX, you have only two concerns: what kind of list is this, and what
358 do I want to put in it.
362 \begin_layout Standard
363 So, the basic idea behind LyX is: specify
373 \begin_inset Quotes eld
376 What You See Is What You Get,
377 \begin_inset Quotes erd
381 \begin_inset Quotes eld
384 What You See Is What You
389 \begin_inset Quotes erd
393 \begin_inset Quotes eld
397 \begin_inset Quotes erd
400 It's a powerful idea that greatly simplifies the mechanics of writing documents.
401 This is also why LyX isn't so good for creating posters and flyers.
406 want to specify exactly where everything goes, because there are no functional
407 units like paragraphs, sections, etc.
408 This doesn't mean LyX is missing some cool function.
409 It simply means that it isn't the right tool for the job — you don't use
410 a screwdriver to drive in nails.
413 \begin_layout Subsection
414 Differences between LyX and Other Word Processors
418 \begin_layout Plain Layout
422 \begin_layout Plain Layout
435 \begin_layout Plain Layout
442 and Other Word Processors
450 \begin_layout Standard
451 Here's a list of things you won't find in LyX:
454 \begin_layout Itemize
458 \begin_layout Itemize
462 \begin_layout Itemize
464 \begin_inset space \thinspace{}
468 \begin_inset space \space{}
482 \begin_layout Standard
483 Tab stops, along with a ruler showing you the position of things on the
484 page, are useless in LyX.
485 The program worries about where things go on the page, not you.
486 Extra whitespace is similar; LyX adds them where necessary, depending on
488 Not being able to type two blank lines in a row will be annoying at first,
489 but it makes more sense once you're thinking in WYSIWYM terms.
492 \begin_layout Standard
493 Here are some things that exist in LyX, but aren't used as you might think:
496 \begin_layout Itemize
500 \begin_layout Itemize
504 \begin_layout Itemize
506 \begin_inset space \thinspace{}
510 \begin_inset space \space{}
513 single spaced, double spaced, etc.)
516 \begin_layout Itemize
517 Whitespace, horizontal and vertical
520 \begin_layout Itemize
524 \begin_layout Itemize
525 Typefaces (bold, italic, underline, etc.)
528 \begin_layout Standard
529 Although they exist in LyX, you generally don't need them.
530 LyX will take care of these things for you, depending on what you're doing.
531 Different parts of the document are automatically set in a different typeface
533 Paragraph indenting is context dependent; different types of paragraphs
534 get indented differently.
535 Page breaks get handled automatically, as well.
536 In general, the space between lines, between words, and between paragraphs
537 is variable, set by LyX.
541 \begin_layout Plain Layout
542 There are ways to adjust all of these (only some of which require knowledge
543 of LaTeX), either for a whole document or for a specific location in a
561 \begin_layout Standard
562 Lastly, there are a few areas where we believe LyX (and LaTeX) surpasses
563 many word processors:
566 \begin_layout Itemize
570 \begin_layout Itemize
574 \begin_layout Itemize
578 \begin_layout Itemize
582 \begin_layout Itemize
586 \begin_layout Standard
587 Granted, many modern word processors can handle mathematical symbols, tables,
588 and hyphenation, and many have moved towards style definitions and the
590 However, they've only recently been able to do so, whereas LyX is built
591 upon the LaTeX document preparation system.
592 LaTeX has been around for over 20 years, and
599 \begin_layout Subsection
603 \begin_layout Standard
604 LaTeX is a document preparation system designed by Leslie Lamport in 1985.
608 \begin_layout Plain Layout
609 The source for the info in this section is
610 \begin_inset Quotes eld
618 \begin_inset Quotes erd
621 by Helmut Kopka and Patrick Daly, which has an entry in the bibliography
632 It was built up from a typesetting language called TeX, created by Donald
634 TeX takes a sequence of typesetting commands, written in a script in an
635 ASCII file, and executes them.
637 \begin_inset Quotes eld
641 \begin_inset Quotes erd
644 of the printing trade were modeled by Knuth as computer algorithms and
645 incorporated into TeX, thus its excellent printed appearance.
646 What comes directly out of TeX is the portable document format
651 \begin_inset Quotes eld
655 \begin_inset Quotes erd
663 The dvi format is often used for previews and can later be converted to
664 other formats like PostScript.
668 \begin_layout Standard
669 TeX isn't only a typesetting engine; it also allows you to define macros.
670 Most people who use TeX are actually using a macro package which Knuth
671 created to hide a lot of the typesetting details.
672 This is where Leslie Lamport enters our story.
673 He wanted a macro package that was more user- and less typesetter-oriented,
674 with a set of commands that consistently typeset things like sections,
675 tables or math formulas in an uniform, consistent fashion.
676 This is how LaTeX was born.
679 \begin_layout Standard
680 Now, in parallel with the development and growth of LaTeX, other folks were
681 creating their own custom macro packages for TeX, ones to make slides or
682 articles for math journals and so on.
683 Some used the raw TeX facilities to do this, others began modifying LaTeX.
684 To try and unify this mess, a team of LaTeX-nicians began to work on LaTeX2e,
685 the current version of LaTeX, during the late 1980's.
686 This new version of LaTeX has commands which provide an easier-to-use interface
687 to TeX's macro-creating commands, aid in the use of new fonts, and so on.
688 In fact, LaTeX is quite an extensive language in its own right! Users around
689 the world have been creating their own add-ons for LaTeX beyond the standard
693 \begin_layout Standard
694 There are two ways to extend LaTeX: classes and styles.
699 is a set of LaTeX macros describing a new type of document, like a book,
701 There are classes for slides, for physics and math journals\SpecialChar \ldots{}
703 even have a class for their thesis format! A
707 differs from a class in that it doesn't define a new type of document,
708 but a different type of
712 that any document can use.
713 For example, LyX controls page margins and line spacing using two different
714 LaTeX style-files designed for these purposes.
715 There are style-files for a whole slew of things: printing labels or envelopes,
716 changing indentation behavior, adding new fonts, manipulating graphics,
717 designing fancy page headings, customizing bibliographies, altering the
718 location and appearance of footnotes, tables, and figures, customizing
722 \begin_layout Standard
726 \begin_layout Description
727 TeX: Typesetting language with macro capability.
730 \begin_layout Description
731 LaTeX: Macro package built upon TeX\SpecialChar \@.
735 \begin_layout Description
736 classes: Descriptions of a type of document, using LaTeX\SpecialChar \@.
740 \begin_layout Description
741 styles: Alters the default behavior of LaTeX in some way.
744 \begin_layout Description
745 LyX: Visual, WYSIWYM word-processor that uses LaTeX to do its typesetting.
748 \begin_layout Standard
749 This section attempts to account for the difference between LyX and other
751 Simply put, LaTeX is the difference.
752 By using LaTeX as its backend, LyX helps you think more about
761 The computer then handles
768 \begin_layout Section
769 Navigating the Documentation
772 \begin_layout Standard
773 To make it easier to answer your questions and describe all of the features
774 of LyX, the documentation has been split up into several different files.
775 Each one has its own purpose, as described below.
776 Before you go plowing into any of those files, however, you should read
777 this chapter thoroughly first, since it contains a lot of useful information
778 and commentary that can save you some time.
781 \begin_layout Standard
782 The developing of LyX will hopefully never stop, so that some of the documentati
783 on may be incomplete or a bit out of date, though we try to keep up.
784 Like the rest of LyX, the manuals are the work of a group of volunteers
786 \begin_inset Quotes eld
790 \begin_inset Quotes erd
793 , families, dishes to clean, kitty litter to dispose of, et cetera.
794 If you want to help out, be sure to read Section
799 \begin_inset CommandInset ref
801 reference "sec:Contrib"
805 in addition to the rest of this document.
808 \begin_layout Standard
809 Also, please do us a favor – if anything in these manuals confuses you,
810 is unclear, or wrong, don't hesitate to let us know! You can reach the
811 current document maintainers by mailing to
812 \begin_inset CommandInset href
814 target "lyx-docs@lists.lyx.org"
820 If you have questions which are not obviously answered in the documentation,
821 and need help fast, there is an active users' mailing list which you can
823 \begin_inset CommandInset href
825 target "lyx-users@lists.lyx.org"
833 \begin_layout Subsection
834 The Format of the Manuals
837 \begin_layout Standard
838 Some may have printed out the manuals.
839 Others may be reading it within LyX.
840 There are some differences between the LyX-file and the printed version.
841 First, the title is simply at the top of the document, not formatted on
842 a separate page as in some of the printed versions.
843 Nor are any of the footnotes or the Table of Contents fully visible.
844 To open a footnote, which looks like this:
845 \begin_inset Graphics
846 filename clipart/footnoteQt4.png
851 , click on it with the left mouse button.
852 For the Table of Contents, either click on the grey box or click on the
857 menu, where the contents are displayed automatically\SpecialChar \@.
861 \begin_layout Standard
862 In the printed manuals, all cross-references appear as the actual numbers
863 for a chapter, section, subsection, and so on.
864 Online, however, all cross-references appear as a light-grey box like the
866 \begin_inset Graphics
867 filename clipart/referenceQt4.png
873 If you click on that box with the left mouse button, a dialog box will
874 appear containing a list of all the cross-references in the document.
875 You can go to the referred section by right-clicking on the box or by clicking
888 in the opened dialog.
889 Going back to where you came from is just as easy.
898 to go back to your earlier location.
901 \begin_layout Standard
902 Now that we've cleared up some of the differences between the printed and
903 online versions of this file, we can start looking at the format of this
905 You'll occasionally notice things in different fonts:
908 \begin_layout Itemize
913 is used for general emphasis, generic arguments, book titles, names of
914 sections of other manuals, and notes from the authors.
917 \begin_layout Itemize
922 is used for program and file names, LyX code and functions.
925 \begin_layout Itemize
930 is used for menu, button, or dialog box names, and the names of keyboard
934 \begin_layout Itemize
939 is used for people's names.
942 \begin_layout Itemize
947 is used for LaTeX code
950 \begin_layout Standard
951 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
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 The list with the currently set shortcuts can be found in the
1287 \begin_layout Subsection
1288 Units used in the Manuals
1291 \begin_layout Standard
1292 To understand the units described in this documentation, Table
1293 \begin_inset space ~
1297 \begin_inset CommandInset ref
1299 reference "cap:Units-for-image"
1303 explains all units available in LyX.
1306 \begin_layout Standard
1307 \begin_inset Float table
1313 \begin_layout Plain Layout
1314 \begin_inset Caption
1316 \begin_layout Plain Layout
1317 \begin_inset CommandInset label
1319 name "cap:Units-for-image"
1331 \begin_layout Plain Layout
1332 \begin_inset VSpace medskip
1338 \begin_layout Plain Layout
1340 \begin_inset Tabular
1341 <lyxtabular version="3" rows="20" columns="2">
1342 <features tabularvalignment="middle">
1343 <column alignment="center" valignment="top" width="0">
1344 <column alignment="center" valignment="top" width="0">
1346 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1349 \begin_layout Plain Layout
1355 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1358 \begin_layout Plain Layout
1366 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1369 \begin_layout Plain Layout
1375 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1378 \begin_layout Plain Layout
1386 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1389 \begin_layout Plain Layout
1395 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1398 \begin_layout Plain Layout
1406 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1409 \begin_layout Plain Layout
1415 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1418 \begin_layout Plain Layout
1426 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1429 \begin_layout Plain Layout
1435 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1438 \begin_layout Plain Layout
1440 \begin_inset space \thinspace{}
1444 \begin_inset space \thinspace{}
1454 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1457 \begin_layout Plain Layout
1463 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1466 \begin_layout Plain Layout
1468 \begin_inset space \thinspace{}
1472 \begin_inset space \thinspace{}
1482 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1485 \begin_layout Plain Layout
1491 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1494 \begin_layout Plain Layout
1496 \begin_inset space \thinspace{}
1500 \begin_inset space \thinspace{}
1510 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1513 \begin_layout Plain Layout
1519 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1522 \begin_layout Plain Layout
1524 \begin_inset space \thinspace{}
1528 \begin_inset space \thinspace{}
1538 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1541 \begin_layout Plain Layout
1547 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1550 \begin_layout Plain Layout
1552 \begin_inset space \thinspace{}
1556 \begin_inset Formula $\approx$
1560 \begin_inset space \thinspace{}
1570 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1573 \begin_layout Plain Layout
1579 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1582 \begin_layout Plain Layout
1584 \begin_inset space \thinspace{}
1588 \begin_inset space \thinspace{}
1598 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1601 \begin_layout Plain Layout
1607 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1610 \begin_layout Plain Layout
1611 % of original image width
1618 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1621 \begin_layout Plain Layout
1627 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1630 \begin_layout Plain Layout
1638 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1641 \begin_layout Plain Layout
1647 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1650 \begin_layout Plain Layout
1658 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1661 \begin_layout Plain Layout
1667 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1670 \begin_layout Plain Layout
1678 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1681 \begin_layout Plain Layout
1687 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1690 \begin_layout Plain Layout
1698 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1701 \begin_layout Plain Layout
1707 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1710 \begin_layout Plain Layout
1718 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1721 \begin_layout Plain Layout
1727 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1730 \begin_layout Plain Layout
1738 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1741 \begin_layout Plain Layout
1747 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1750 \begin_layout Plain Layout
1762 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1765 \begin_layout Plain Layout
1771 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1774 \begin_layout Plain Layout
1786 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1789 \begin_layout Plain Layout
1795 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1798 \begin_layout Plain Layout
1800 \begin_inset space \thinspace{}
1804 \begin_inset space \thinspace{}
1825 \begin_layout Subsection
1829 \begin_layout Standard
1830 The following list describes the contents of the basic documentation files
1831 that you find in the
1838 \begin_layout Description
1839 Introduction This file.
1842 \begin_layout Description
1843 Tutorial If you are new to LyX, and have never used LaTeX before, you should
1845 If you have used LaTeX before, you should still read the
1849 , starting with the section on
1850 \begin_inset Quotes eld
1853 LyX for LaTeX users.
1854 \begin_inset Quotes erd
1857 (Skimming the rest of the document wouldn't hurt, either.)
1860 \begin_layout Description
1862 \begin_inset space ~
1865 Guide The primary documentation.
1870 of the basic operation and available features of LyX here.
1871 The main manual assumes that you've read the
1878 \begin_layout Description
1880 \begin_inset space ~
1883 Objects Extension of the
1888 Documents in detail how to use tables, graphics, floats, notes, program
1889 listings, and boxes.
1890 It also includes many tricks of the LaTeX masters.
1893 \begin_layout Description
1894 Math Extension of the
1899 Documents in detail how to typeset any kind of formulas.
1902 \begin_layout Description
1904 \begin_inset space ~
1907 Features Extension of the
1912 Documents how to use raw LaTeX commands, additional layouts, and special-purpos
1916 \begin_layout Description
1917 Customization A description of advanced LyX features, including how to customize
1918 the overall behavior of LyX\SpecialChar \@.
1919 This includes such things as keybindings, internati
1920 onalization, and configuration files.
1922 \change_inserted 1 1262886910
1923 It also includes LyX's layout files, which are what you will need to create
1924 or modify to get LyX to support new LaTeX classes or packages.
1929 \begin_layout Description
1930 Shortcuts Tables with the currently defined LyX shortcuts.
1933 \begin_layout Description
1935 \begin_inset space ~
1938 configuration LyX investigates your system upon installation.
1939 This file contains info on what LyX learned about your installation.
1940 Check it to see if you're missing something you might like to have.
1943 \begin_layout Standard
1944 These files will reference one another as necessary.
1953 information on installation and customization, but refers the reader to
1956 Customization Manual
1958 for more information.
1961 \begin_layout Standard
1962 We'll state again an important point:
1965 \begin_layout Standard
1966 \begin_inset VSpace bigskip
1972 \begin_layout Standard
1974 If you are new to LyX, read the
1983 \begin_layout Standard
1984 \begin_inset VSpace bigskip
1990 \begin_layout Standard
1991 Otherwise, you could needlessly frustrate yourself.
1994 \begin_layout Section
1995 Contributing to the LyX Project
1996 \begin_inset CommandInset label
2005 \begin_layout Subsection
2009 \begin_layout Standard
2010 LyX is mostly written in C++ (the LaTeX importer is written in Python).
2011 It is a large project, and as a result it is not free from bugs, or the
2012 need for improvements in the source code.
2015 \begin_layout Subsubsection
2019 \begin_layout Standard
2020 While using LyX, you may find behavior which you consider a bug.
2021 Crashes, though rare, can happen.
2022 User interface problems are considered major bugs by the LyX team: especially
2023 helpful are indications of parts of the LyX interface you find confusing,
2027 \begin_layout Standard
2028 LyX has a bug tracking system, which you can find at
2031 \begin_inset Flex URL
2034 \begin_layout Plain Layout
2036 http://www.lyx.org/trac/wiki/BugTrackerHome
2044 You should check the bug tracker before reporting any bugs, in case it
2045 has already been reported.
2046 If you have a comment on an existing bug, or wish to report a new bug,
2047 you may either use the bug tracker, or send an e-mail to the development
2049 \begin_inset CommandInset href
2051 target "lyx-devel@lists.lyx.org"
2057 Archives of this list are linked from the main LyX website,
2060 \begin_inset Flex URL
2063 \begin_layout Plain Layout
2075 \begin_layout Standard
2076 A useful bug report will at a minimum include the version of LyX you are
2077 having the problem with.
2078 Accurate, detailed descriptions are preferred - the more time developers
2079 have to spend to pinpoint the source of a bug, the less time they have
2080 for other improvements.
2081 Mention the system and system version you are running LyX with.
2082 Give the versions of the libraries you have installed on your system, and,
2083 if relevant, the versions of external programs that LyX uses.
2084 If it's a compilation or configuration problem, include the file
2088 , and mention which compiler you are using.
2092 \begin_layout Subsubsection
2093 Contributing fixes and new features
2096 \begin_layout Standard
2097 If you have made changes to LyX's source that you think should become part
2098 of LyX, send your changes as a diff file (in unified format) to the development
2099 list referenced above, along with a change log, and a description of what
2103 \begin_layout Subsection
2104 Contributing to the Documentation
2107 \begin_layout Standard
2108 LyX's documentation is extensive; however LyX is under constant development,
2109 and each new release adds new features.
2110 You may find some documentation needs improvement.
2111 This section describes what to do if you find an error, or have some suggestion
2112 s for improving the documentation.
2115 \begin_layout Subsubsection
2116 Reporting Errors in the Manuals
2119 \begin_layout Standard
2120 If you find a problem with the documentation, send a message to the mailing
2122 \begin_inset CommandInset href
2124 target "lyx-docs@lists.lyx.org"
2130 The documentation team will make any necessary fixes.
2133 \begin_layout Subsubsection
2134 Joining the Documentation Team.
2137 \begin_layout Standard
2138 The LyX Documentation Project, like anything else in the LyX project, can
2139 always use assistance! If you're interested in contributing to the Documentatio
2140 n Project, you need to do the following:
2143 \begin_layout Enumerate
2144 Get the latest LyX source code from
2145 \begin_inset Newline newline
2149 \begin_inset Flex URL
2152 \begin_layout Plain Layout
2154 http://www.lyx.org/trac/browser/lyx-devel/trunk/lib/doc
2162 \begin_layout Enumerate
2172 \begin_inset Newline newline
2175 The point of this exercise is to give you ideas.
2184 is likely to be the most up-to-date of all of the documentation.
2185 You should be able to glean some insights into how we want the manuals
2186 to read and to look.
2189 \begin_layout Enumerate
2190 Contact the team at:
2191 \begin_inset Newline newline
2195 \begin_inset CommandInset href
2197 target "lyx-docs@lists.lyx.org"
2203 \begin_inset Newline newline
2206 to discuss your intended changes, and get some feedback on them.
2209 \begin_layout Standard
2210 The changes you wish to make may range from improving clarity of the text,
2211 to doing major re-structuring of the documentation.
2212 Any and all improvements are gladly received.