1 #LyX 1.5.2svn 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 % provides missing characters,
19 \usepackage{ifpdf} % part of the hyperref bundle
20 \ifpdf % if pdflatex is used
22 % set fonts for nicer pdf view
23 \IfFileExists{lmodern.sty}{\usepackage{lmodern}}
24 {\usepackage[scaled=0.92]{helvet}
26 \usepackage{courier} }
28 % the pages of the TOC are numbered roman
29 % and a pdf-bookmark for the TOC is added
31 \let\myTOC\tableofcontents
32 \renewcommand\tableofcontents{%
33 \pdfbookmark[1]{Contents}{}
36 \pagenumbering{arabic} }
38 % link all cross references and URLs in pdf output
39 \usepackage[colorlinks=true, bookmarks, bookmarksnumbered,
40 bookmarksopen, bookmarksopenlevel=2,
41 linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,
42 pdfpagelayout=OneColumn, pdfnewwindow=true,
43 pdfstartview=XYZ, plainpages=false, pdfpagelabels,
44 pdfauthor={LyX Team}, pdftex,
45 pdftitle={The LyX User's Guide},pdfsubject={LyX-documentation Intro},
46 pdfkeywords={LyX}]{hyperref}
48 \else % if dvi or ps is produced
50 % link all cross references and URLs in dvi output
51 \usepackage[ps2pdf]{hyperref}
53 % the pages of the TOC are numbered roman
55 \let\myTOC\tableofcontents
56 \renewcommand\tableofcontents{%
57 \pdfbookmark[1]{Contents}{}
60 \pagenumbering{arabic} }
64 % redefine the \LyX macro for PDF bookmarks
65 \def\LyX{\texorpdfstring{%
66 L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
73 \font_typewriter default
74 \font_default_family default
88 \paperorientation portrait
91 \paragraph_separation indent
93 \quotes_language english
96 \paperpagestyle default
97 \tracking_changes false
114 \begin_layout Standard
116 If you have comments or error corrections, please send them to the LyX Documenta
119 lyx-docs@lists.lyx.org
127 \begin_layout Standard
128 \begin_inset LatexCommand tableofcontents
135 \begin_layout Section
136 The Philosophy of LyX
139 \begin_layout Subsection
143 \begin_layout Standard
144 LyX is a document preparation system.
145 It excels at letting you create complex technical and scientific articles
146 with mathematics, cross-references, bibliographies, indices, etc.
147 It is very good at documents of any length in which the usual processing
148 abilities are required: automatic sectioning and pagination, spellchecking,
150 It can also be used to write a letter to your mom, though granted, there
151 are probably simpler programs available for that.
152 It is definitely not the best tool for creating banners, flyers, or advertiseme
153 nts (we'll explain why later), though with some effort all these can be
155 Some examples of what it is used for: memos, letters, dissertations and
156 theses, lecture notes, seminar notebooks, conference proceedings, software
157 documentation, books, articles in refereed scientific journals, scripts
158 for plays and movies, business proposals, presentations \SpecialChar \ldots{}
162 \begin_layout Standard
163 LyX is a program that provides a modern approach to writing documents with
164 a computer by using a markup language paradigm, an approach that breaks
165 with the obsolete tradition of the
166 \begin_inset Quotes eld
170 \begin_inset Quotes erd
174 It is designed for authors who want professional output quickly with a
175 minimum of effort without becoming specialists in typesetting.
176 The job of typesetting is done mostly by the computer, not the author;
177 with LyX, the author can concentrate on the contents of her writing.
180 \begin_layout Standard
181 Part of the initial challenge of using LyX comes from the change in thinking
182 that you, the user, must make.
183 At one time, all we had for creating documents were typewriters, so we
184 all learned certain tricks to get around their limitations.
185 Underlining, which is little more than overstriking with the
186 \begin_inset Quotes eld
190 \begin_inset Quotes erd
193 character, became a way to emphasize text.
194 You were forced to figure out column sizes and tab stops, and set them,
195 before creating a table.
196 The same applied for letters and other right justified text.
197 Hyphenation at the end of a line required a careful eye and a lot of foresight.
200 \begin_layout Standard
201 In other words, we've all been trained to worry about the little details
202 of which character goes where.
203 Consequently, almost all word processors have this mentality.
204 They still use tab stops for adding whitespace.
205 You still need to worry about exactly where on the page something will
207 Emphasizing text means changing a font, similar to changing the typewriter
209 This is the underlying philosophy of a WYSIWYG word processor:
210 \begin_inset Quotes eld
213 What You See Is What You Get
214 \begin_inset Quotes erd
218 Unfortunately, that paradigm often results in
219 \begin_inset Quotes eld
222 What You See Is All You Get
223 \begin_inset Quotes erd
229 \begin_layout Standard
230 This is where LyX differs from an ordinary word processor.
231 You don't concern yourself with what character goes where.
236 and LyX takes care of the rest, following a set of rules called a
244 \begin_layout Standard
245 To be fair, most recent versions of the most popular office suites now have
246 some sort of style sheets which follow a similar markup method.
247 However, our experience is that they are still rarely used in practice.
252 Let's look at a little example:
255 \begin_layout Standard
256 Suppose you are writing a report.
257 To begin your report, you want a section called
258 \begin_inset Quotes eld
261 Introduction\SpecialChar \@.
263 \begin_inset Quotes erd
266 So, you go into whatever menu it is in your word processor that changes
267 font sizes and decide on a new font size.
268 Then you turn on bold face.
270 \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\InsetSpace ~
318 However, you forget that you were using 18pt bold instead of 16pt, so you
319 type in the heading for Section\InsetSpace ~
320 4 in a different font that what you used
321 for Section\InsetSpace ~
323 That problem doesn't even exist in LyX.
324 The computer takes care of all that silly bookkeeping about which thing
325 has what size font, not you.
326 After all, that's what a computer is good at.
329 \begin_layout Standard
330 Here's another example.
331 Suppose you're making a list.
332 In other word processors, a list is just a bunch of tab stops and newlines.
333 You need to figure out where to put the label for each list item, what
334 that label should be, how many blank lines to put between each item, and
336 Under LyX, you have only two concerns: what kind of list is this, and what
337 do I want to put in it.
341 \begin_layout Standard
342 So, the basic idea behind LyX is: specify
352 \begin_inset Quotes eld
355 What You See Is What You Get,
356 \begin_inset Quotes erd
360 \begin_inset Quotes eld
363 What You See Is What You
368 \begin_inset Quotes erd
372 \begin_inset Quotes eld
376 \begin_inset Quotes erd
379 It's a powerful idea that greatly simplifies the mechanics of writing documents.
380 This is also why LyX isn't so good for creating posters and flyers---in
385 want to specify exactly where everything goes, because there are no functional
386 units like paragraphs, sections, etc.
387 This doesn't mean LyX is missing some cool function.
388 It simply means that it isn't the right tool for the job --- you don't
389 use a screwdriver to drive in nails.
392 \begin_layout Subsection
393 Differences between LyX and Other Word Processors
397 \begin_layout Standard
401 \begin_layout Standard
414 \begin_layout Standard
421 and Other Word Processors
429 \begin_layout Standard
430 Here's a list of things you won't find in LyX:
433 \begin_layout Itemize
437 \begin_layout Itemize
441 \begin_layout Itemize
442 Extra whitespace (i.e.
454 \begin_layout Standard
455 Tab stops, along with a ruler showing you the position of things on the
456 page, are useless in LyX.
457 The program worries about where things go on the page, not you.
458 Extra whitespace is similar; LyX adds them where necessary, depending on
460 Not being able to type two blank lines in a row will be annoying at first,
461 but it makes more sense once you're thinking in WYSIWYM terms.
464 \begin_layout Standard
465 Here are some things that exist in LyX, but aren't used as you might think:
468 \begin_layout Itemize
472 \begin_layout Itemize
476 \begin_layout Itemize
478 single spaced, double spaced, etc.)
481 \begin_layout Itemize
482 Whitespace, horizontal and vertical
485 \begin_layout Itemize
489 \begin_layout Itemize
490 Typefaces (bold, italic, underline, etc.)
493 \begin_layout Standard
494 Although they exist in LyX, you generally don't need them.
495 LyX will take care of these things for you, depending on what you're doing.
496 Different parts of the document are automatically set in a different typeface
498 Paragraph indenting is context dependent; different types of paragraphs
499 get indented differently.
500 Page breaks get handled automatically, as well.
501 In general, the space between lines, between words, and between paragraphs
502 is variable, set by LyX.
506 \begin_layout Standard
507 There are ways to adjust all of these (only some of which require knowledge
508 of LaTeX), either for a whole document or for a specific location in a
526 \begin_layout Standard
527 Lastly, there are a few areas where we believe LyX (and LaTeX) surpasses
528 many word processors:
531 \begin_layout Itemize
535 \begin_layout Itemize
539 \begin_layout Itemize
543 \begin_layout Itemize
547 \begin_layout Itemize
551 \begin_layout Standard
552 Granted, many modern word processors can handle mathematical symbols, tables,
553 and hyphenation, and many have moved towards style definitions and the
555 However, they've only recently been able to do so, whereas LyX is built
556 upon the LaTeX document preparation system.
557 LaTeX has been around for over 20 years, and
564 \begin_layout Subsection
568 \begin_layout Standard
569 LaTeX is a document preparation system designed by Leslie Lamport in 1985.
573 \begin_layout Standard
574 The source for the info in this section is
575 \begin_inset Quotes eld
583 \begin_inset Quotes erd
586 by Helmut Kopka and Patrick Daly, which has an entry in the bibliography
597 It was built up from a typesetting language called TeX, created by Donald
599 TeX takes a sequence of typesetting commands, written in a script in an
600 ASCII file, and executes them.
602 \begin_inset Quotes eld
606 \begin_inset Quotes erd
609 of the printing trade were modeled by Knuth as computer algorithms and
610 incorporated into TeX, thus its excellent printed appearance.
611 What comes directly out of TeX is the portable document format
616 \begin_inset Quotes eld
620 \begin_inset Quotes erd
628 The dvi format is often used for previews and can later be converted to
629 other formats like PostScript.
633 \begin_layout Standard
634 TeX isn't only a typesetting engine, it also allows you to define macros.
635 Most people who use TeX are actually using a macro package which Knuth
636 created to hide a lot of the typesetting details.
637 This is where Leslie Lamport enters our story.
638 He wanted a macro package that was more user- and less typesetter-oriented,
639 with a set of commands that consistently typeset things like sections,
640 tables or math formulas in an uniform, consistent fashion.
641 This is how LaTeX was born.
644 \begin_layout Standard
645 Now, in parallel with the development and growth of LaTeX, other folks were
646 creating their own custom macro packages for TeX, ones to make slides or
647 articles for math journals and so on.
648 Some used the raw TeX facilities to do this, others began modifying LaTeX.
649 To try and unify this mess, a team of LaTeX-nicians began to work on LaTeX2e,
650 the current version of LaTeX, during the late 1980's.
651 This new version of LaTeX has commands which provide an easier-to-use interface
652 to TeX's macro-creating commands, aid in the use of new fonts, and so on.
653 In fact, LaTeX is quite an extensive language in its own right! Users around
654 the world have been creating their own add-ons for LaTeX beyond the standard
658 \begin_layout Standard
659 There are two ways to extend LaTeX: classes and styles.
664 is a set of LaTeX macros describing a new type of document, like a book,
666 There are classes for slides, for physics and math journals\SpecialChar \ldots{}
668 even have a class for their thesis format! A
672 differs from a class in that it doesn't define a new type of document,
673 but a different type of
677 that any document can use.
678 For example, LyX controls page margins and line spacing using two different
679 LaTeX style-files designed for these purposes.
680 There are style-files for a whole slew of things: printing labels or envelopes,
681 changing indentation behavior, adding new fonts, manipulating graphics,
682 designing fancy page headings, customizing bibliographies, altering the
683 location and appearance of footnotes, tables, and figures, customizing
687 \begin_layout Standard
691 \begin_layout Description
692 TeX: Typesetting language with macro capability.
695 \begin_layout Description
696 LaTeX: Macro package built upon TeX\SpecialChar \@.
700 \begin_layout Description
701 classes: Descriptions of a type of document, using LaTeX\SpecialChar \@.
705 \begin_layout Description
706 styles: Alters the default behavior of LaTeX in some way.
709 \begin_layout Description
710 LyX: Visual, WYSIWYM word-processor that uses LaTeX to do its printing.
713 \begin_layout Standard
714 LaTeX is the reason why LyX differs from other word processors.
715 LyX is a graphical user interface (GUI) frontend for LaTeX.
716 It is designed to typeset documents using LaTeX without knowing its macro
718 But although LyX can never support all commands graphically, it offers
719 its usage, so that LyX is as functional as LaTeX.
722 \begin_layout Standard
723 Just like LaTeX, LyX focuses on the context of your writing ---
728 The computer then handles how it should look.
731 \begin_layout Section
732 Navigating the Documentation
735 \begin_layout Standard
736 To make it easier to answer your questions and describe all of the features
737 of LyX, the documentation has been split up into several different files.
738 Each one has its own purpose, as described below.
739 Before you go plowing into any of those files, however, you should read
740 this chapter thoroughly first, since it contains a lot of useful information
741 and commentary that can save you some time.
744 \begin_layout Standard
745 The developing of LyX will hopefully never stop, so that some of the documentati
746 on may be incomplete or a bit out of date, though we try to keep up.
747 Like the rest of LyX, the manuals are the work of a group of volunteers
749 \begin_inset Quotes eld
753 \begin_inset Quotes erd
756 , families, dishes to clean, kitty litter to dispose of, et cetera.
757 If you want to help out, be sure to read Section\InsetSpace ~
759 \begin_inset LatexCommand ref
760 reference "sec:Contrib"
764 in addition to the rest of this document.)
767 \begin_layout Standard
768 Also, please do us a favor -- if anything in these manuals confuses you,
769 is unclear, or wrong, don't hesitate to let us know! You can reach the
770 current document maintainers by mailing to
772 lyx-docs@lists.lyx.org
775 If you have questions which are not obviously answered in the documentation,
776 and need help fast, there is an active users' mailing list which you can
779 lyx-users@lists.lyx.org
784 \begin_layout Subsection
785 The Format of the Manuals
788 \begin_layout Standard
789 Some may have printed out the manuals.
790 Others may be reading it within LyX.
791 There are some differences between the LyX-file and the printed version.
792 First, the title is simply at the top of the document, not formatted on
793 a separate page as in some of the printed versions.
794 Nor are any of the footnotes or the Table of Contents fully visible.
795 To open a footnote, which looks like this:
796 \begin_inset Graphics
797 filename clipart/footnoteQt4.png
802 , click on it with the left mouse button.
803 For the Table of Contents, either click on the grey box or click on the
808 menu, where the contents are displayed automatically\SpecialChar \@.
812 \begin_layout Standard
813 In the printed manuals, all cross-references appear as the actual numbers
814 for a chapter, section, subsection, and so on.
815 Online, however, all cross-references appear as a light-grey box like the
817 \begin_inset Graphics
818 filename clipart/referenceQt4.png
824 If you click on that box with the left mouse button, a dialog box will
825 appear containing a list of all the cross-references in the document.
826 This introduction has only two, the first one is named
827 \begin_inset Quotes eld
831 \begin_inset Quotes erd
835 You can go to the referred section by right-clicking on the box or by clicking
842 in the opened dialog.
843 Going back to where you came from is just as easy.
848 to go back to your earlier location.
851 \begin_layout Standard
852 Now that we've cleared up some of the differences between the printed and
853 online versions of this file, we can start looking at the format of this
855 You'll occasionally notice things in different fonts:
858 \begin_layout Itemize
863 is used for general emphasis, generic arguments, book titles, names of
864 sections of other manuals, and notes from the authors.
867 \begin_layout Itemize
872 is used for program and file names, LyX code and functions.
875 \begin_layout Itemize
880 is used for menu, button, or dialog box names, and the names of keyboard
884 \begin_layout Itemize
889 is used for people's names.
892 \begin_layout Itemize
897 is used for LaTeX code
900 \begin_layout Standard
901 For menu accelerator keys and keybindings, you'll probably get referred
907 \begin_inset Quotes eld
912 Extended Features Manual
915 \begin_inset Quotes erd
923 When we do need to reference keys, we'll use the following prefixing convention
927 \begin_layout Itemize
928 \begin_inset Quotes eld
936 \begin_inset Quotes erd
946 \begin_layout Itemize
947 \begin_inset Quotes eld
955 \begin_inset Quotes erd
965 \begin_layout Itemize
966 \begin_inset Quotes eld
974 \begin_inset Quotes erd
981 key, which on some keyboards will be the
988 \begin_layout Itemize
989 \begin_inset Quotes eld
997 \begin_inset Quotes erd
1000 \SpecialChar \ldots{}
1002 \begin_inset Quotes eld
1010 \begin_inset Quotes erd
1013 are the function keys.
1016 \begin_layout Itemize
1017 \begin_inset Quotes eld
1025 \begin_inset Quotes erd
1031 \begin_layout Itemize
1032 \begin_inset Quotes eld
1040 \begin_inset Quotes erd
1044 \begin_inset Quotes eld
1052 \begin_inset Quotes erd
1056 \begin_inset Quotes eld
1064 \begin_inset Quotes erd
1068 \begin_inset Quotes eld
1076 \begin_inset Quotes erd
1082 \begin_layout Itemize
1085 \begin_inset Quotes eld
1091 \begin_inset Quotes erd
1095 \begin_inset Quotes eld
1103 \begin_inset Quotes erd
1107 \begin_inset Quotes eld
1115 \begin_inset Quotes erd
1119 \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
1154 : these are the 6 keys that appear above the cursor keys on many PC keyboards.
1156 \begin_inset Quotes eld
1164 \begin_inset Quotes erd
1168 \begin_inset Quotes eld
1176 \begin_inset Quotes erd
1180 \begin_inset Quotes eld
1188 \begin_inset Quotes erd
1192 \begin_inset Quotes eld
1200 \begin_inset Quotes erd
1206 \begin_layout Itemize
1215 both refer to the same key.
1216 Some keyboards label the
1221 \begin_inset Quotes eld
1225 \begin_inset Quotes erd
1229 \begin_inset Quotes eld
1233 \begin_inset Quotes erd
1236 still others have two keys.
1237 LyX treats all of them as the same key, so we'll use
1248 \begin_layout Standard
1249 You'll also see something like
1250 \begin_inset Quotes eld
1256 \begin_inset Quotes els
1262 \begin_inset Quotes ers
1266 \begin_inset Quotes erd
1270 We've listed the possible default keybindings for a function in its entry
1272 \begin_inset Quotes eld
1277 Extended Features Manual
1280 \begin_inset Quotes erd
1283 so check there, too.
1284 Note that there are two different keybinding maps in common use in the
1286 \begin_inset Quotes eld
1290 \begin_inset Quotes erd
1293 style which is the default and familiar to those coming from the PC world,
1295 \begin_inset Quotes eld
1299 \begin_inset Quotes erd
1302 style, which is common with those who
1303 \begin_inset Quotes eld
1307 \begin_inset Quotes erd
1310 on Unix systems and use the Emacs editor.
1311 Unless specifically noted, the keybindings in the documentation are from
1312 the default CUA map.
1313 If you like Emacs, you should be smart enough to read the documentation
1314 and figure out the bindings on your own.
1317 \begin_layout Subsection
1318 Units used in the Manuals
1321 \begin_layout Standard
1322 To understand the units described in this documentation, Table\InsetSpace ~
1324 \begin_inset LatexCommand ref
1325 reference "cap:Units-for-image"
1329 explains all units available in LyX.
1332 \begin_layout Standard
1333 \begin_inset Float table
1339 \begin_layout Standard
1340 \begin_inset Caption
1342 \begin_layout Standard
1343 \begin_inset LatexCommand label
1344 name "cap:Units-for-image"
1356 \begin_layout Standard
1357 \begin_inset VSpace medskip
1363 \begin_layout Standard
1365 \begin_inset Tabular
1366 <lyxtabular version="3" rows="20" columns="2">
1368 <column alignment="center" valignment="top" leftline="true" width="0">
1369 <column alignment="center" valignment="top" leftline="true" rightline="true" width="0">
1370 <row topline="true" bottomline="true">
1371 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1374 \begin_layout Standard
1380 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1383 \begin_layout Standard
1390 <row topline="true">
1391 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1394 \begin_layout Standard
1400 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1403 \begin_layout Standard
1410 <row topline="true">
1411 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1414 \begin_layout Standard
1420 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1423 \begin_layout Standard
1430 <row topline="true">
1431 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1434 \begin_layout Standard
1440 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1443 \begin_layout Standard
1450 <row topline="true">
1451 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1454 \begin_layout Standard
1460 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1463 \begin_layout Standard
1465 \begin_inset Formula $\,$
1469 \begin_inset Formula $\,$
1478 <row topline="true">
1479 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1482 \begin_layout Standard
1488 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1491 \begin_layout Standard
1493 \begin_inset Formula $\,$
1497 \begin_inset Formula $\,$
1506 <row topline="true">
1507 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1510 \begin_layout Standard
1516 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1519 \begin_layout Standard
1521 \begin_inset Formula $\,$
1525 \begin_inset Formula $\,$
1534 <row topline="true">
1535 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1538 \begin_layout Standard
1544 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1547 \begin_layout Standard
1549 \begin_inset Formula $\,$
1553 \begin_inset Formula $\,$
1562 <row topline="true">
1563 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1566 \begin_layout Standard
1572 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1575 \begin_layout Standard
1577 \begin_inset Formula $\,$
1581 \begin_inset Formula $\approx$
1585 \begin_inset Formula $\,$
1594 <row topline="true">
1595 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1598 \begin_layout Standard
1604 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1607 \begin_layout Standard
1609 \begin_inset Formula $\,$
1613 \begin_inset Formula $\,$
1622 <row topline="true">
1623 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1626 \begin_layout Standard
1632 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1635 \begin_layout Standard
1636 % of original image width
1642 <row topline="true">
1643 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1646 \begin_layout Standard
1652 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1655 \begin_layout Standard
1662 <row topline="true">
1663 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1666 \begin_layout Standard
1672 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1675 \begin_layout Standard
1682 <row topline="true">
1683 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1686 \begin_layout Standard
1692 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1695 \begin_layout Standard
1702 <row topline="true">
1703 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1706 \begin_layout Standard
1712 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1715 \begin_layout Standard
1722 <row topline="true">
1723 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1726 \begin_layout Standard
1732 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1735 \begin_layout Standard
1742 <row topline="true">
1743 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1746 \begin_layout Standard
1752 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1755 \begin_layout Standard
1762 <row topline="true">
1763 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1766 \begin_layout Standard
1772 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1775 \begin_layout Standard
1786 <row topline="true">
1787 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1790 \begin_layout Standard
1796 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1799 \begin_layout Standard
1810 <row topline="true" bottomline="true">
1811 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1814 \begin_layout Standard
1820 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1823 \begin_layout Standard
1825 \begin_inset Formula $\,$
1829 \begin_inset Formula $\,$
1850 \begin_layout Subsection
1854 \begin_layout Standard
1855 The following list describes the contents of each of the files in the documentat
1859 \begin_layout Description
1860 Introduction This file.
1863 \begin_layout Description
1864 Tutorial If you are new to LyX, and have never used LaTeX before, you should
1866 If you have used LaTeX before, you should still read the
1870 , starting with the section on
1871 \begin_inset Quotes eld
1874 LyX for LaTeX users.
1875 \begin_inset Quotes erd
1878 (Skimming the rest of the document wouldn't hurt, either.)
1881 \begin_layout Description
1883 Guide The primary documentation.
1888 of the basic operation and available features of LyX here.
1889 The main manual assumes that you've read the
1896 \begin_layout Description
1897 Embedded\InsetSpace ~
1898 Objects Extension of the
1903 Documents in detail how to use tables, graphics, floats, notes, and boxes.
1904 It also includes many tricks of the LaTeX masters.
1907 \begin_layout Description
1908 Extended\InsetSpace ~
1909 Features Extension of the
1914 Documents how to use raw LaTeX commands, additional layouts, and special-purpos
1918 \begin_layout Description
1919 Customization A description of advanced LyX features, including how to customize
1920 the overall behavior of LyX\SpecialChar \@.
1921 This includes such things as keybindings, internati
1922 onalization, and configuration files.
1925 \begin_layout Description
1927 configuration LyX investigates your system upon installation.
1928 This file contains info on what LyX learned about your installation.
1929 Check it to see if you're missing something you might like to have.
1932 \begin_layout Standard
1933 These files will reference one another as necessary.
1942 information on installation and customization, but refers the reader to
1945 Customization Manual
1947 for more information.
1950 \begin_layout Standard
1951 We'll state again an important point:
1954 \begin_layout Standard
1955 \begin_inset VSpace bigskip
1961 \begin_layout Standard
1963 If you are new to LyX, read the
1972 \begin_layout Standard
1973 \begin_inset VSpace bigskip
1979 \begin_layout Standard
1980 Otherwise, you could needlessly frustrate yourself.
1981 LyX does all that you need a word processor to do, but using a different
1985 \begin_layout Section
1986 \begin_inset LatexCommand label
1991 Contributing to the LyX Project
1994 \begin_layout Subsection
1998 \begin_layout Standard
1999 LyX is mostly written in C++ (the LaTeX importer is written in Python).
2000 It is a large project, and as a result it is not free from bugs, or the
2001 need for improvements in the source code.
2004 \begin_layout Subsubsection
2008 \begin_layout Standard
2009 While using LyX, you may find behavior which you consider a bug.
2010 Crashes, though rare, can happen.
2011 User interface problems are considered major bugs by the LyX team: especially
2012 helpful are indications of parts of the LyX interface you find confusing,
2016 \begin_layout Standard
2017 LyX has a bug tracking system, which you can find at
2020 \begin_inset LatexCommand url
2021 target "http://bugzilla.lyx.org/"
2028 You should check the bug tracker before reporting any bugs, in case it
2029 has already been reported.
2030 If you have a comment on an existing bug, or wish to report a new bug,
2031 you may either use the bug tracker, or send an e-mail to the development
2034 lyx-devel@lists.lyx.org
2037 Archives of this list are linked from the main LyX website,
2040 \begin_inset LatexCommand url
2041 target "http://www.lyx.org/"
2050 \begin_layout Standard
2051 A useful bug report will at a minimum include the version of LyX you are
2052 having the problem with.
2053 Accurate, detailed descriptions are preferred - the more time developers
2054 have to spend to pinpoint the source of a bug, the less time they have
2055 for other improvements.
2056 Mention the system and system version you are running LyX with.
2057 Give the versions of the libraries you have installed on your system, and,
2058 if relevant, the versions of external programs that LyX uses.
2059 If it's a compilation or configuration problem, include the file
2063 , and mention which compiler you are using.
2067 \begin_layout Subsubsection
2068 Contributing fixes and new features
2071 \begin_layout Standard
2072 If you have made changes to LyX's source that you think should become part
2073 of LyX, send your changes as a diff file (in unified format) to the development
2074 list referenced above, along with a change log, and a description of what
2078 \begin_layout Subsection
2079 Contributing to the Documentation
2082 \begin_layout Standard
2083 LyX's documentation is extensive; however LyX is under constant development,
2084 and each new release adds new features.
2085 You may find some documentation needs improvement.
2086 This section describes what to do if you find an error, or have some suggestion
2087 s for improving the documentation.
2090 \begin_layout Subsubsection
2091 Reporting Errors in the Manuals
2094 \begin_layout Standard
2095 If you find a problem with the documentation, send a message to the mailing
2098 lyx-docs@lists.lyx.org
2101 The documentation team will make any necessary fixes.
2104 \begin_layout Subsubsection
2105 Joining the Documentation Team.
2108 \begin_layout Standard
2109 The LyX Documentation Project, like anything else in the LyX project, can
2110 always use assistance! If you're interested in contributing to the Documentatio
2111 n Project, you need to do the following:
2114 \begin_layout Enumerate
2115 Get the latest LyX source code from
2118 \begin_inset LatexCommand url
2119 target "http://www.lyx.org/trac/browser/lyx-devel/trunk/lib/doc"
2125 Inside that directory is a file called
2130 Read it; it's the style sheet for the documentation.
2133 \begin_layout Enumerate
2144 The point of this exercise is to give you ideas.
2153 is likely to be the most up-to-date of all of the documentation.
2154 You should be able to glean some insights into how we want the manuals
2155 to read and to look.
2158 \begin_layout Enumerate
2159 Contact the team at:
2163 lyx-docs@lists.lyx.org
2167 to discuss your intended changes, and get some feedback on them.
2170 \begin_layout Standard
2171 The changes you wish to make may range from improving clarity of the text,
2172 to doing major re-structuring of the documentation.
2173 Any and all improvements are gladly received.