1 #LyX 1.5.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 % 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 linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,
41 pdfpagelayout=OneColumn, pdfnewwindow=true,
42 pdfstartview=XYZ, plainpages=false, pdfpagelabels,
43 pdfauthor={LyX Team}, pdftex,
44 pdftitle={The LyX User's Guide},pdfsubject={LyX-documentation Intro},
45 pdfkeywords={LyX}]{hyperref}
47 \else % if dvi or ps is produced
49 % link all cross references and URLs in dvi output
50 \usepackage[ps2pdf]{hyperref}
52 % the pages of the TOC are numbered roman
54 \let\myTOC\tableofcontents
55 \renewcommand\tableofcontents{%
56 \pdfbookmark[1]{Contents}{}
59 \pagenumbering{arabic} }
67 \font_typewriter default
68 \font_default_family default
82 \paperorientation portrait
85 \paragraph_separation indent
87 \quotes_language english
90 \paperpagestyle default
91 \tracking_changes false
107 \begin_layout Standard
109 If you have comments or error corrections, please send them to the LyX Documenta
112 lyx-docs@lists.lyx.org
120 \begin_layout Standard
121 \begin_inset LatexCommand tableofcontents
128 \begin_layout Section
129 The Philosophy of LyX
132 \begin_layout Subsection
136 \begin_layout Standard
137 LyX is a document preparation system.
138 It excels at letting you create complex technical and scientific articles
139 with mathematics, cross-references, bibliographies, indices, etc.
140 It is very good at documents of any length in which the usual processing
141 abilities are required: automatic sectioning and pagination, spellchecking,
143 It can also be used to write a letter to your mom, though granted, there
144 are probably simpler programs available for that.
145 It is definitely not the best tool for creating banners, flyers, or advertiseme
146 nts (we'll explain why later), though with some effort all these can be
148 Some examples of what it is used for: memos, letters, dissertations and
149 theses, lecture notes, seminar notebooks, conference proceedings, software
150 documentation, books, articles in refereed scientific journals, scripts
151 for plays and movies, business proposals, presentations \SpecialChar \ldots{}
155 \begin_layout Standard
156 LyX is a program that provides a modern approach to writing documents with
157 a computer by using a markup language paradigm, an approach that breaks
158 with the obsolete tradition of the
159 \begin_inset Quotes eld
163 \begin_inset Quotes erd
167 It is designed for authors who want professional output quickly with a
168 minimum of effort without becoming specialists in typesetting.
169 The job of typesetting is done mostly by the computer, not the author;
170 with LyX, the author can concentrate on the contents of her writing.
173 \begin_layout Standard
174 Part of the initial challenge of using LyX comes from the change in thinking
175 that you, the user, must make.
176 At one time, all we had for creating documents were typewriters, so we
177 all learned certain tricks to get around their limitations.
178 Underlining, which is little more than overstriking with the
179 \begin_inset Quotes eld
183 \begin_inset Quotes erd
186 character, became a way to emphasize text.
187 You were forced to figure out column sizes and tab stops, and set them,
188 before creating a table.
189 The same applied for letters and other right justified text.
190 Hyphenation at the end of a line required a careful eye and a lot of foresight.
193 \begin_layout Standard
194 In other words, we've all been trained to worry about the little details
195 of which character goes where.
196 Consequently, almost all word processors have this mentality.
197 They still use tab stops for adding whitespace.
198 You still need to worry about exactly where on the page something will
200 Emphasizing text means changing a font, similar to changing the typewriter
202 This is the underlying philosophy of a WYSIWYG word processor:
203 \begin_inset Quotes eld
206 What You See Is What You Get
207 \begin_inset Quotes erd
211 Unfortunately, that paradigm often results in
212 \begin_inset Quotes eld
215 What You See Is All You Get
216 \begin_inset Quotes erd
222 \begin_layout Standard
223 This is where LyX differs from an ordinary word processor.
224 You don't concern yourself with what character goes where.
229 and LyX takes care of the rest, following a set of rules called a
237 \begin_layout Standard
238 To be fair, most recent versions of the most popular office suites now have
239 some sort of style sheets which follow a similar markup method.
240 However, our experience is that they are still rarely used in practice.
245 Let's look at a little example:
248 \begin_layout Standard
249 Suppose you are writing a report.
250 To begin your report, you want a section called
251 \begin_inset Quotes eld
254 Introduction\SpecialChar \@.
256 \begin_inset Quotes erd
259 So, you go into whatever menu it is in your word processor that changes
260 font sizes and decide on a new font size.
261 Then you turn on bold face.
263 \begin_inset Quotes eld
269 \begin_inset Quotes erd
273 Of course, if you later decide that this section belongs someplace else
274 in the document, or if you insert a new section before it, you need to
275 change the numbering for this and all following sections, as well as any
276 entry in the table of contents.
280 \begin_layout Standard
281 In LyX, you go to the pull-down on the far left of the button bar and select
287 \begin_inset Quotes eld
290 Introduction\SpecialChar \@.
292 \begin_inset Quotes erd
298 \begin_layout Standard
300 If you cut and paste the section, it will automatically be renumbered ---
302 And if you enter references to that section correctly (by inserting cross-refer
303 ence tags), LyX will automatically update them all throughout the file so
304 that you never, ever type a section number.
307 \begin_layout Standard
308 Now let's look at the problem of consistency.
309 Five days later, you reopen your report and start Section\InsetSpace ~
311 However, you forget that you were using 18pt bold instead of 16pt, so you
312 type in the heading for Section\InsetSpace ~
313 4 in a different font that what you used
314 for Section\InsetSpace ~
316 That problem doesn't even exist in LyX.
317 The computer takes care of all that silly bookkeeping about which thing
318 has what size font, not you.
319 After all, that's what a computer is good at.
322 \begin_layout Standard
323 Here's another example.
324 Suppose you're making a list.
325 In other word processors, a list is just a bunch of tab stops and newlines.
326 You need to figure out where to put the label for each list item, what
327 that label should be, how many blank lines to put between each item, and
329 Under LyX, you have only two concerns: what kind of list is this, and what
330 do I want to put in it.
334 \begin_layout Standard
335 So, the basic idea behind LyX is: specify
345 \begin_inset Quotes eld
348 What You See Is What You Get,
349 \begin_inset Quotes erd
353 \begin_inset Quotes eld
356 What You See Is What You
361 \begin_inset Quotes erd
365 \begin_inset Quotes eld
369 \begin_inset Quotes erd
372 It's a powerful idea that greatly simplifies the mechanics of writing documents.
373 This is also why LyX isn't so good for creating posters and flyers---in
378 want to specify exactly where everything goes, because there are no functional
379 units like paragraphs, sections, etc.
380 This doesn't mean LyX is missing some cool function.
381 It simply means that it isn't the right tool for the job --- you don't
382 use a screwdriver to drive in nails.
385 \begin_layout Subsection
386 Differences between LyX and Other Word Processors
390 \begin_layout Standard
394 \begin_layout Standard
407 \begin_layout Standard
414 and Other Word Processors
422 \begin_layout Standard
423 Here's a list of things you won't find in LyX:
426 \begin_layout Itemize
430 \begin_layout Itemize
434 \begin_layout Itemize
435 Extra whitespace (i.e.
447 \begin_layout Standard
448 Tab stops, along with a ruler showing you the position of things on the
449 page, are useless in LyX.
450 The program worries about where things go on the page, not you.
451 Extra whitespace is similar; LyX adds them where necessary, depending on
453 Not being able to type two blank lines in a row will be annoying at first,
454 but it makes more sense once you're thinking in WYSIWYM terms.
457 \begin_layout Standard
458 Here are some things that exist in LyX, but aren't used as you might think:
461 \begin_layout Itemize
465 \begin_layout Itemize
469 \begin_layout Itemize
471 single spaced, double spaced, etc.)
474 \begin_layout Itemize
475 Whitespace, horizontal and vertical
478 \begin_layout Itemize
482 \begin_layout Itemize
483 Typefaces (bold, italic, underline, etc.)
486 \begin_layout Standard
487 Although they exist in LyX, you generally don't need them.
488 LyX will take care of these things for you, depending on what you're doing.
489 Different parts of the document are automatically set in a different typeface
491 Paragraph indenting is context dependent; different types of paragraphs
492 get indented differently.
493 Page breaks get handled automatically, as well.
494 In general, the space between lines, between words, and between paragraphs
495 is variable, set by LyX.
499 \begin_layout Standard
500 There are ways to adjust all of these (only some of which require knowledge
501 of LaTeX), either for a whole document or for a specific location in a
519 \begin_layout Standard
520 Lastly, there are a few areas where we believe LyX (and LaTeX) surpasses
521 many word processors:
524 \begin_layout Itemize
528 \begin_layout Itemize
532 \begin_layout Itemize
536 \begin_layout Itemize
540 \begin_layout Itemize
544 \begin_layout Standard
545 Granted, many modern word processors can handle mathematical symbols, tables,
546 and hyphenation, and many have moved towards style definitions and the
548 However, they've only recently been able to do so, whereas LyX is built
549 upon the LaTeX document preparation system.
550 LaTeX has been around for over 20 years, and
557 \begin_layout Subsection
561 \begin_layout Standard
562 LaTeX is a document preparation system designed by Leslie Lamport in 1985.
566 \begin_layout Standard
567 The source for the info in this section is
568 \begin_inset Quotes eld
576 \begin_inset Quotes erd
579 by Helmut Kopka and Patrick Daly, which has an entry in the bibliography
590 It was built up from a typesetting language called TeX, created by Donald
592 TeX takes a sequence of typesetting commands, written in a script in an
593 ASCII file, and executes them.
595 \begin_inset Quotes eld
599 \begin_inset Quotes erd
602 of the printing trade were modeled by Knuth as computer algorithms and
603 incorporated into TeX, thus its excellent printed appearance.
604 What comes directly out of TeX is the portable document format
609 \begin_inset Quotes eld
613 \begin_inset Quotes erd
621 The dvi format is often used for previews and can later be converted to
622 other formats like PostScript.
626 \begin_layout Standard
627 TeX isn't only a typesetting engine, it also allows you to define macros.
628 Most people who use TeX are actually using a macro package which Knuth
629 created to hide a lot of the typesetting details.
630 This is where Leslie Lamport enters our story.
631 He wanted a macro package that was more user- and less typesetter-oriented,
632 with a set of commands that consistently typeset things like sections,
633 tables or math formulas in an uniform, consistent fashion.
634 This is how LaTeX was born.
637 \begin_layout Standard
638 Now, in parallel with the development and growth of LaTeX, other folks were
639 creating their own custom macro packages for TeX, ones to make slides or
640 articles for math journals and so on.
641 Some used the raw TeX facilities to do this, others began modifying LaTeX.
642 To try and unify this mess, a team of LaTeX-nicians began to work on LaTeX2e,
643 the current version of LaTeX, during the late 1980's.
644 This new version of LaTeX has commands which provide an easier-to-use interface
645 to TeX's macro-creating commands, aid in the use of new fonts, and so on.
646 In fact, LaTeX is quite an extensive language in its own right! Users around
647 the world have been creating their own add-ons for LaTeX beyond the standard
651 \begin_layout Standard
652 There are two ways to extend LaTeX: classes and styles.
657 is a set of LaTeX macros describing a new type of document, like a book,
659 There are classes for slides, for physics and math journals\SpecialChar \ldots{}
661 even have a class for their thesis format! A
665 differs from a class in that it doesn't define a new type of document,
666 but a different type of
670 that any document can use.
671 For example, LyX controls page margins and line spacing using two different
672 LaTeX style-files designed for these purposes.
673 There are style-files for a whole slew of things: printing labels or envelopes,
674 changing indentation behavior, adding new fonts, manipulating graphics,
675 designing fancy page headings, customizing bibliographies, altering the
676 location and appearance of footnotes, tables, and figures, customizing
680 \begin_layout Standard
684 \begin_layout Description
685 TeX: Typesetting language with macro capability.
688 \begin_layout Description
689 LaTeX: Macro package built upon TeX\SpecialChar \@.
693 \begin_layout Description
694 classes: Descriptions of a type of document, using LaTeX\SpecialChar \@.
698 \begin_layout Description
699 styles: Alters the default behavior of LaTeX in some way.
702 \begin_layout Description
703 LyX: Visual, WYSIWYM word-processor that uses LaTeX to do its printing.
706 \begin_layout Standard
707 LaTeX is the reason why LyX differs from other word processors.
708 LyX is a graphical user interface (GUI) frontend for LaTeX.
709 It is designed to typeset documents with by using LaTeX without knowing
711 But although LyX can never support all commands graphically, it offers
712 its usage, so that LyX is as functional as LaTeX.
715 \begin_layout Standard
716 Just like LaTeX, LyX focuses on the context of your writing ---
721 The computer then handles how it should look.
724 \begin_layout Section
725 Navigating the Documentation
728 \begin_layout Standard
729 To make it easier to answer your questions and describe all of the features
730 of LyX, the documentation has been split up into several different files.
731 Each one has its own purpose, as described below.
732 Before you go plowing into any of those files, however, you should read
733 this chapter thoroughly first, since it contains a lot of useful information
734 and commentary that can save you some time.
737 \begin_layout Standard
738 The developing of LyX will hopefully never stop, so that some of the documentati
739 on may be incomplete or a bit out of date, though we try to keep up.
740 Like the rest of LyX, the manuals are the work of a group of volunteers
742 \begin_inset Quotes eld
746 \begin_inset Quotes erd
749 , families, dishes to clean, kitty litter to dispose of, et cetera.
750 If you want to help out, be sure to read Section\InsetSpace ~
752 \begin_inset LatexCommand ref
753 reference "sec:Contrib"
757 in addition to the rest of this document.)
760 \begin_layout Standard
761 Also, please do us a favor -- if anything in these manuals confuses you,
762 is unclear, or wrong, don't hesitate to let us know! You can reach the
763 current document maintainers by mailing to
765 lyx-docs@lists.lyx.org
768 If you have questions which are not obviously answered in the documentation,
769 and need help fast, there is an active users' mailing list which you can
772 lyx-users@lists.lyx.org
777 \begin_layout Subsection
778 The Format of the Manuals
781 \begin_layout Standard
782 Some may have printed out the manuals.
783 Others may be reading it within LyX.
784 There are some differences between the LyX-file and the printed version.
785 First, the title is simply at the top of the document, not formatted on
786 a separate page as in some of the printed versions.
787 Nor are any of the footnotes or the Table of Contents fully visible.
788 To open a footnote, which looks like this:
789 \begin_inset Graphics
790 filename clipart/footnoteQt4.png
795 , click on it with the left mouse button.
796 For the Table of Contents, either click on the grey box or click on the
801 menu, where the contents are displayed automatically\SpecialChar \@.
805 \begin_layout Standard
806 In the printed manuals, all cross-references appear as the actual numbers
807 for a chapter, section, subsection, and so on.
808 Online, however, all cross-references appear as a light-grey box like the
810 \begin_inset Graphics
811 filename clipart/referenceQt4.png
817 If you click on that box with the left mouse button, a dialog box will
818 appear containing a list of all the cross-references in the document.
819 This introduction has only two, the first one is named
820 \begin_inset Quotes eld
824 \begin_inset Quotes erd
828 You can go to the referred section by right-clicking on the box or by clicking
835 in the opened dialog.
836 Going back to where you came from is just as easy.
841 to go back to your earlier location.
844 \begin_layout Standard
845 Now that we've cleared up some of the differences between the printed and
846 online versions of this file, we can start looking at the format of this
848 You'll occasionally notice things in different fonts:
851 \begin_layout Itemize
856 is used for general emphasis, generic arguments, book titles, names of
857 sections of other manuals, and notes from the authors.
860 \begin_layout Itemize
865 is used for program and file names, LyX code and functions.
868 \begin_layout Itemize
873 is used for menu, button, or dialog box names, and the names of keyboard
877 \begin_layout Itemize
882 is used for people's names.
885 \begin_layout Itemize
890 is used for LaTeX code
893 \begin_layout Standard
894 For menu accelerator keys and keybindings, you'll probably get referred
900 \begin_inset Quotes eld
905 Extended Features Manual
908 \begin_inset Quotes erd
916 When we do need to reference keys, we'll use the following prefixing convention
920 \begin_layout Itemize
921 \begin_inset Quotes eld
929 \begin_inset Quotes erd
939 \begin_layout Itemize
940 \begin_inset Quotes eld
948 \begin_inset Quotes erd
958 \begin_layout Itemize
959 \begin_inset Quotes eld
967 \begin_inset Quotes erd
974 key, which on some keyboards will be the
981 \begin_layout Itemize
982 \begin_inset Quotes eld
990 \begin_inset Quotes erd
993 \SpecialChar \ldots{}
995 \begin_inset Quotes eld
1003 \begin_inset Quotes erd
1006 are the function keys.
1009 \begin_layout Itemize
1010 \begin_inset Quotes eld
1018 \begin_inset Quotes erd
1024 \begin_layout Itemize
1025 \begin_inset Quotes eld
1033 \begin_inset Quotes erd
1037 \begin_inset Quotes eld
1045 \begin_inset Quotes erd
1049 \begin_inset Quotes eld
1057 \begin_inset Quotes erd
1061 \begin_inset Quotes eld
1069 \begin_inset Quotes erd
1075 \begin_layout Itemize
1078 \begin_inset Quotes eld
1084 \begin_inset Quotes erd
1088 \begin_inset Quotes eld
1096 \begin_inset Quotes erd
1100 \begin_inset Quotes eld
1108 \begin_inset Quotes erd
1112 \begin_inset Quotes eld
1120 \begin_inset Quotes erd
1124 \begin_inset Quotes eld
1132 \begin_inset Quotes erd
1136 \begin_inset Quotes eld
1144 \begin_inset Quotes erd
1147 : these are the 6 keys that appear above the cursor keys on many PC keyboards.
1149 \begin_inset Quotes eld
1157 \begin_inset Quotes erd
1161 \begin_inset Quotes eld
1169 \begin_inset Quotes erd
1173 \begin_inset Quotes eld
1181 \begin_inset Quotes erd
1185 \begin_inset Quotes eld
1193 \begin_inset Quotes erd
1199 \begin_layout Itemize
1208 both refer to the same key.
1209 Some keyboards label the
1214 \begin_inset Quotes eld
1218 \begin_inset Quotes erd
1222 \begin_inset Quotes eld
1226 \begin_inset Quotes erd
1229 still others have two keys.
1230 LyX treats all of them as the same key, so we'll use
1241 \begin_layout Standard
1242 You'll also see something like
1243 \begin_inset Quotes eld
1249 \begin_inset Quotes els
1255 \begin_inset Quotes ers
1259 \begin_inset Quotes erd
1263 We've listed the possible default keybindings for a function in its entry
1265 \begin_inset Quotes eld
1270 Extended Features Manual
1273 \begin_inset Quotes erd
1276 so check there, too.
1277 Note that there are two different keybinding maps in common use in the
1279 \begin_inset Quotes eld
1283 \begin_inset Quotes erd
1286 style which is the default and familiar to those coming from the PC world,
1288 \begin_inset Quotes eld
1292 \begin_inset Quotes erd
1295 style, which is common with those who
1296 \begin_inset Quotes eld
1300 \begin_inset Quotes erd
1303 on Unix systems and use the Emacs editor.
1304 Unless specifically noted, the keybindings in the documentation are from
1305 the default CUA map.
1306 If you like Emacs, you should be smart enough to read the documentation
1307 and figure out the bindings on your own.
1310 \begin_layout Subsection
1311 Units used in the Manuals
1314 \begin_layout Standard
1315 To understand the units described in this documentation, Table\InsetSpace ~
1317 \begin_inset LatexCommand ref
1318 reference "cap:Units-for-image"
1322 explains all units available in LyX.
1325 \begin_layout Standard
1326 \begin_inset Float table
1332 \begin_layout Standard
1333 \begin_inset Caption
1335 \begin_layout Standard
1336 \begin_inset LatexCommand label
1337 name "cap:Units-for-image"
1349 \begin_layout Standard
1350 \begin_inset VSpace medskip
1356 \begin_layout Standard
1358 \begin_inset Tabular
1359 <lyxtabular version="3" rows="20" columns="2">
1361 <column alignment="center" valignment="top" leftline="true" width="0">
1362 <column alignment="center" valignment="top" leftline="true" rightline="true" width="0">
1363 <row topline="true" bottomline="true">
1364 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1367 \begin_layout Standard
1373 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1376 \begin_layout Standard
1383 <row topline="true">
1384 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1387 \begin_layout Standard
1393 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1396 \begin_layout Standard
1403 <row topline="true">
1404 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1407 \begin_layout Standard
1413 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1416 \begin_layout Standard
1423 <row topline="true">
1424 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1427 \begin_layout Standard
1433 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1436 \begin_layout Standard
1443 <row topline="true">
1444 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1447 \begin_layout Standard
1453 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1456 \begin_layout Standard
1458 \begin_inset Formula $\,$
1462 \begin_inset Formula $\,$
1471 <row topline="true">
1472 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1475 \begin_layout Standard
1481 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1484 \begin_layout Standard
1486 \begin_inset Formula $\,$
1490 \begin_inset Formula $\,$
1499 <row topline="true">
1500 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1503 \begin_layout Standard
1509 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1512 \begin_layout Standard
1514 \begin_inset Formula $\,$
1518 \begin_inset Formula $\,$
1527 <row topline="true">
1528 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1531 \begin_layout Standard
1537 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1540 \begin_layout Standard
1542 \begin_inset Formula $\,$
1546 \begin_inset Formula $\,$
1555 <row topline="true">
1556 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1559 \begin_layout Standard
1565 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1568 \begin_layout Standard
1570 \begin_inset Formula $\,$
1574 \begin_inset Formula $\approx$
1578 \begin_inset Formula $\,$
1587 <row topline="true">
1588 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1591 \begin_layout Standard
1597 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1600 \begin_layout Standard
1602 \begin_inset Formula $\,$
1606 \begin_inset Formula $\,$
1615 <row topline="true">
1616 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1619 \begin_layout Standard
1625 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1628 \begin_layout Standard
1629 % of original image width
1635 <row topline="true">
1636 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1639 \begin_layout Standard
1645 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1648 \begin_layout Standard
1655 <row topline="true">
1656 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1659 \begin_layout Standard
1665 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1668 \begin_layout Standard
1675 <row topline="true">
1676 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1679 \begin_layout Standard
1685 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1688 \begin_layout Standard
1695 <row topline="true">
1696 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1699 \begin_layout Standard
1705 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1708 \begin_layout Standard
1715 <row topline="true">
1716 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1719 \begin_layout Standard
1725 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1728 \begin_layout Standard
1735 <row topline="true">
1736 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1739 \begin_layout Standard
1745 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1748 \begin_layout Standard
1755 <row topline="true">
1756 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1759 \begin_layout Standard
1765 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1768 \begin_layout Standard
1779 <row topline="true">
1780 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1783 \begin_layout Standard
1789 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1792 \begin_layout Standard
1803 <row topline="true" bottomline="true">
1804 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1807 \begin_layout Standard
1813 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1816 \begin_layout Standard
1818 \begin_inset Formula $\,$
1822 \begin_inset Formula $\,$
1843 \begin_layout Subsection
1847 \begin_layout Standard
1848 The following list describes the contents of each of the files in the documentat
1852 \begin_layout Description
1853 Introduction This file.
1856 \begin_layout Description
1857 Tutorial If you are new to LyX, and have never used LaTeX before, you should
1859 If you have used LaTeX before, you should still read the
1863 , starting with the section on
1864 \begin_inset Quotes eld
1867 LyX for LaTeX users.
1868 \begin_inset Quotes erd
1871 (Skimming the rest of the document wouldn't hurt, either.)
1874 \begin_layout Description
1876 Guide The primary documentation.
1881 of the basic operation and available features of LyX here.
1882 The main manual assumes that you've read the
1889 \begin_layout Description
1890 ExtendedInsets Extension of the
1895 Documents in detail how to use tables, graphics, floats, notes, and boxes.
1896 It also includes many tricks of the LaTeX masters.
1899 \begin_layout Description
1900 Extended\InsetSpace ~
1901 Features Extension of the
1906 Documents how to use raw LaTeX commands, additional layouts, and special-purpos
1910 \begin_layout Description
1911 Customization A description of advanced LyX features, including how to customize
1912 the overall behavior of LyX\SpecialChar \@.
1913 This includes such things as keybindings, internati
1914 onalization, and configuration files.
1917 \begin_layout Description
1919 configuration LyX investigates your system upon installation.
1920 This file contains info on what LyX learned about your installation.
1921 Check it to see if you're missing something you might like to have.
1924 \begin_layout Standard
1925 These files will reference one another as necessary.
1934 information on installation and customization, but refers the reader to
1937 Customization Manual
1939 for more information.
1942 \begin_layout Standard
1943 We'll state again an important point:
1946 \begin_layout Standard
1947 \begin_inset VSpace bigskip
1953 \begin_layout Standard
1955 If you are new to LyX, read the
1964 \begin_layout Standard
1965 \begin_inset VSpace bigskip
1971 \begin_layout Standard
1972 Otherwise, you could needlessly frustrate yourself.
1973 LyX does all that you need a word processor to do, but using a different
1977 \begin_layout Section
1978 \begin_inset LatexCommand label
1983 Contributing to the LyX Project
1986 \begin_layout Subsection
1990 \begin_layout Standard
1991 LyX is mostly written in C++ (the LaTeX importer is written in Python).
1992 It is a large project, and as a result it is not free from bugs, or the
1993 need for improvements in the source code.
1996 \begin_layout Subsubsection
2000 \begin_layout Standard
2001 While using LyX, you may find behavior which you consider a bug.
2002 Crashes, though rare, can happen.
2003 User interface problems are considered major bugs by the LyX team: especially
2004 helpful are indications of parts of the LyX interface you find confusing,
2008 \begin_layout Standard
2009 LyX has a bug tracking system, which you can find at
2012 \begin_inset LatexCommand url
2013 target "http://bugzilla.lyx.org/"
2020 You should check the bug tracker before reporting any bugs, in case it
2021 has already been reported.
2022 If you have a comment on an existing bug, or wish to report a new bug,
2023 you may either use the bug tracker, or send an e-mail to the development
2026 lyx-devel@lists.lyx.org
2029 Archives of this list are linked from the main LyX website,
2032 \begin_inset LatexCommand url
2033 target "http://www.lyx.org/"
2042 \begin_layout Standard
2043 A useful bug report will at a minimum include the version of LyX you are
2044 having the problem with.
2045 Accurate, detailed descriptions are preferred - the more time developers
2046 have to spend to pinpoint the source of a bug, the less time they have
2047 for other improvements.
2048 Mention the system and system version you are running LyX with.
2049 Give the versions of the libraries you have installed on your system, and,
2050 if relevant, the versions of external programs that LyX uses.
2051 If it's a compilation or configuration problem, include the file
2055 , and mention which compiler you are using.
2059 \begin_layout Subsubsection
2060 Contributing fixes and new features
2063 \begin_layout Standard
2064 If you have made changes to LyX's source that you think should become part
2065 of LyX, send your changes as a diff file (in unified format) to the development
2066 list referenced above, along with a change log, and a description of what
2070 \begin_layout Subsection
2071 Contributing to the Documentation
2074 \begin_layout Standard
2075 LyX's documentation is extensive; however LyX is under constant development,
2076 and each new release adds new features.
2077 You may find some documentation needs improvement.
2078 This section describes what to do if you find an error, or have some suggestion
2079 s for improving the documentation.
2082 \begin_layout Subsubsection
2083 Reporting Errors in the Manuals
2086 \begin_layout Standard
2087 If you find a problem with the documentation, send a message to the mailing
2090 lyx-docs@lists.lyx.org
2093 The documentation team will make any necessary fixes.
2096 \begin_layout Subsubsection
2097 Joining the Documentation Team.
2100 \begin_layout Standard
2101 The LyX Documentation Project, like anything else in the LyX project, can
2102 always use assistance! If you're interested in contributing to the Documentatio
2103 n Project, you need to do the following:
2106 \begin_layout Enumerate
2107 Get the latest LyX source code from
2110 \begin_inset LatexCommand url
2111 target "http://www.lyx.org/trac/browser/lyx-devel/trunk/lib/doc"
2117 Inside that directory is a file called
2122 Read it; it's the style sheet for the documentation.
2125 \begin_layout Enumerate
2136 The point of this exercise is to give you ideas.
2145 is likely to be the most up-to-date of all of the documentation.
2146 You should be able to glean some insights into how we want the manuals
2147 to read and to look.
2150 \begin_layout Enumerate
2151 Contact the team at:
2155 lyx-docs@lists.lyx.org
2159 to discuss your intended changes, and get some feedback on them.
2162 \begin_layout Standard
2163 The changes you wish to make may range from improving clarity of the text,
2164 to doing major re-structuring of the documentation.
2165 Any and all improvements are gladly received.