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
108 \begin_layout Standard
110 If you have comments or error corrections, please send them to the LyX Documenta
113 lyx-docs@lists.lyx.org
121 \begin_layout Standard
122 \begin_inset LatexCommand tableofcontents
129 \begin_layout Section
130 The Philosophy of LyX
133 \begin_layout Subsection
137 \begin_layout Standard
138 LyX is a document preparation system.
139 It excels at letting you create complex technical and scientific articles
140 with mathematics, cross-references, bibliographies, indices, etc.
141 It is very good at documents of any length in which the usual processing
142 abilities are required: automatic sectioning and pagination, spellchecking,
144 It can also be used to write a letter to your mom, though granted, there
145 are probably simpler programs available for that.
146 It is definitely not the best tool for creating banners, flyers, or advertiseme
147 nts (we'll explain why later), though with some effort all these can be
149 Some examples of what it is used for: memos, letters, dissertations and
150 theses, lecture notes, seminar notebooks, conference proceedings, software
151 documentation, books, articles in refereed scientific journals, scripts
152 for plays and movies, business proposals, presentations \SpecialChar \ldots{}
156 \begin_layout Standard
157 LyX is a program that provides a modern approach to writing documents with
158 a computer by using a markup language paradigm, an approach that breaks
159 with the obsolete tradition of the
160 \begin_inset Quotes eld
164 \begin_inset Quotes erd
168 It is designed for authors who want professional output quickly with a
169 minimum of effort without becoming specialists in typesetting.
170 The job of typesetting is done mostly by the computer, not the author;
171 with LyX, the author can concentrate on the contents of her writing.
174 \begin_layout Standard
175 Part of the initial challenge of using LyX comes from the change in thinking
176 that you, the user, must make.
177 At one time, all we had for creating documents were typewriters, so we
178 all learned certain tricks to get around their limitations.
179 Underlining, which is little more than overstriking with the
180 \begin_inset Quotes eld
184 \begin_inset Quotes erd
187 character, became a way to emphasize text.
188 You were forced to figure out column sizes and tab stops, and set them,
189 before creating a table.
190 The same applied for letters and other right justified text.
191 Hyphenation at the end of a line required a careful eye and a lot of foresight.
194 \begin_layout Standard
195 In other words, we've all been trained to worry about the little details
196 of which character goes where.
197 Consequently, almost all word processors have this mentality.
198 They still use tab stops for adding whitespace.
199 You still need to worry about exactly where on the page something will
201 Emphasizing text means changing a font, similar to changing the typewriter
203 This is the underlying philosophy of a WYSIWYG word processor:
204 \begin_inset Quotes eld
207 What You See Is What You Get
208 \begin_inset Quotes erd
212 Unfortunately, that paradigm often results in
213 \begin_inset Quotes eld
216 What You See Is All You Get
217 \begin_inset Quotes erd
223 \begin_layout Standard
224 This is where LyX differs from an ordinary word processor.
225 You don't concern yourself with what character goes where.
230 and LyX takes care of the rest, following a set of rules called a
238 \begin_layout Standard
239 To be fair, most recent versions of the most popular office suites now have
240 some sort of style sheets which follow a similar markup method.
241 However, our experience is that they are still rarely used in practice.
246 Let's look at a little example:
249 \begin_layout Standard
250 Suppose you are writing a report.
251 To begin your report, you want a section called
252 \begin_inset Quotes eld
255 Introduction\SpecialChar \@.
257 \begin_inset Quotes erd
260 So, you go into whatever menu it is in your word processor that changes
261 font sizes and decide on a new font size.
262 Then you turn on bold face.
264 \begin_inset Quotes eld
270 \begin_inset Quotes erd
274 Of course, if you later decide that this section belongs someplace else
275 in the document, or if you insert a new section before it, you need to
276 change the numbering for this and all following sections, as well as any
277 entry in the table of contents.
281 \begin_layout Standard
282 In LyX, you go to the pull-down on the far left of the button bar and select
288 \begin_inset Quotes eld
291 Introduction\SpecialChar \@.
293 \begin_inset Quotes erd
299 \begin_layout Standard
301 If you cut and paste the section, it will automatically be renumbered ---
303 And if you enter references to that section correctly (by inserting cross-refer
304 ence tags), LyX will automatically update them all throughout the file so
305 that you never, ever type a section number.
308 \begin_layout Standard
309 Now let's look at the problem of consistency.
310 Five days later, you reopen your report and start Section\InsetSpace ~
312 However, you forget that you were using 18pt bold instead of 16pt, so you
313 type in the heading for Section\InsetSpace ~
314 4 in a different font that what you used
315 for Section\InsetSpace ~
317 That problem doesn't even exist in LyX.
318 The computer takes care of all that silly bookkeeping about which thing
319 has what size font, not you.
320 After all, that's what a computer is good at.
323 \begin_layout Standard
324 Here's another example.
325 Suppose you're making a list.
326 In other word processors, a list is just a bunch of tab stops and newlines.
327 You need to figure out where to put the label for each list item, what
328 that label should be, how many blank lines to put between each item, and
330 Under LyX, you have only two concerns: what kind of list is this, and what
331 do I want to put in it.
335 \begin_layout Standard
336 So, the basic idea behind LyX is: specify
346 \begin_inset Quotes eld
349 What You See Is What You Get,
350 \begin_inset Quotes erd
354 \begin_inset Quotes eld
357 What You See Is What You
362 \begin_inset Quotes erd
366 \begin_inset Quotes eld
370 \begin_inset Quotes erd
373 It's a powerful idea that greatly simplifies the mechanics of writing documents.
374 This is also why LyX isn't so good for creating posters and flyers---in
379 want to specify exactly where everything goes, because there are no functional
380 units like paragraphs, sections, etc.
381 This doesn't mean LyX is missing some cool function.
382 It simply means that it isn't the right tool for the job --- you don't
383 use a screwdriver to drive in nails.
386 \begin_layout Subsection
387 Differences between LyX and Other Word Processors
391 \begin_layout Standard
395 \begin_layout Standard
408 \begin_layout Standard
415 and Other Word Processors
423 \begin_layout Standard
424 Here's a list of things you won't find in LyX:
427 \begin_layout Itemize
431 \begin_layout Itemize
435 \begin_layout Itemize
436 Extra whitespace (i.e.
448 \begin_layout Standard
449 Tab stops, along with a ruler showing you the position of things on the
450 page, are useless in LyX.
451 The program worries about where things go on the page, not you.
452 Extra whitespace is similar; LyX adds them where necessary, depending on
454 Not being able to type two blank lines in a row will be annoying at first,
455 but it makes more sense once you're thinking in WYSIWYM terms.
458 \begin_layout Standard
459 Here are some things that exist in LyX, but aren't used as you might think:
462 \begin_layout Itemize
466 \begin_layout Itemize
470 \begin_layout Itemize
472 single spaced, double spaced, etc.)
475 \begin_layout Itemize
476 Whitespace, horizontal and vertical
479 \begin_layout Itemize
483 \begin_layout Itemize
484 Typefaces (bold, italic, underline, etc.)
487 \begin_layout Standard
488 Although they exist in LyX, you generally don't need them.
489 LyX will take care of these things for you, depending on what you're doing.
490 Different parts of the document are automatically set in a different typeface
492 Paragraph indenting is context dependent; different types of paragraphs
493 get indented differently.
494 Page breaks get handled automatically, as well.
495 In general, the space between lines, between words, and between paragraphs
496 is variable, set by LyX.
500 \begin_layout Standard
501 There are ways to adjust all of these (only some of which require knowledge
502 of LaTeX), either for a whole document or for a specific location in a
520 \begin_layout Standard
521 Lastly, there are a few areas where we believe LyX (and LaTeX) surpasses
522 many word processors:
525 \begin_layout Itemize
529 \begin_layout Itemize
533 \begin_layout Itemize
537 \begin_layout Itemize
541 \begin_layout Itemize
545 \begin_layout Standard
546 Granted, many modern word processors can handle mathematical symbols, tables,
547 and hyphenation, and many have moved towards style definitions and the
549 However, they've only recently been able to do so, whereas LyX is built
550 upon the LaTeX document preparation system.
551 LaTeX has been around for over 20 years, and
558 \begin_layout Subsection
562 \begin_layout Standard
563 LaTeX is a document preparation system designed by Leslie Lamport in 1985.
567 \begin_layout Standard
568 The source for the info in this section is
569 \begin_inset Quotes eld
577 \begin_inset Quotes erd
580 by Helmut Kopka and Patrick Daly, which has an entry in the bibliography
591 It was built up from a typesetting language called TeX, created by Donald
593 TeX takes a sequence of typesetting commands, written in a script in an
594 ASCII file, and executes them.
596 \begin_inset Quotes eld
600 \begin_inset Quotes erd
603 of the printing trade were modeled by Knuth as computer algorithms and
604 incorporated into TeX, thus its excellent printed appearance.
605 What comes directly out of TeX is the portable document format
610 \begin_inset Quotes eld
614 \begin_inset Quotes erd
622 The dvi format is often used for previews and can later be converted to
623 other formats like PostScript.
627 \begin_layout Standard
628 TeX isn't only a typesetting engine, it also allows you to define macros.
629 Most people who use TeX are actually using a macro package which Knuth
630 created to hide a lot of the typesetting details.
631 This is where Leslie Lamport enters our story.
632 He wanted a macro package that was more user- and less typesetter-oriented,
633 with a set of commands that consistently typeset things like sections,
634 tables or math formulas in an uniform, consistent fashion.
635 This is how LaTeX was born.
638 \begin_layout Standard
639 Now, in parallel with the development and growth of LaTeX, other folks were
640 creating their own custom macro packages for TeX, ones to make slides or
641 articles for math journals and so on.
642 Some used the raw TeX facilities to do this, others began modifying LaTeX.
643 To try and unify this mess, a team of LaTeX-nicians began to work on LaTeX2e,
644 the current version of LaTeX, during the late 1980's.
645 This new version of LaTeX has commands which provide an easier-to-use interface
646 to TeX's macro-creating commands, aid in the use of new fonts, and so on.
647 In fact, LaTeX is quite an extensive language in its own right! Users around
648 the world have been creating their own add-ons for LaTeX beyond the standard
652 \begin_layout Standard
653 There are two ways to extend LaTeX: classes and styles.
658 is a set of LaTeX macros describing a new type of document, like a book,
660 There are classes for slides, for physics and math journals\SpecialChar \ldots{}
662 even have a class for their thesis format! A
666 differs from a class in that it doesn't define a new type of document,
667 but a different type of
671 that any document can use.
672 For example, LyX controls page margins and line spacing using two different
673 LaTeX style-files designed for these purposes.
674 There are style-files for a whole slew of things: printing labels or envelopes,
675 changing indentation behavior, adding new fonts, manipulating graphics,
676 designing fancy page headings, customizing bibliographies, altering the
677 location and appearance of footnotes, tables, and figures, customizing
681 \begin_layout Standard
685 \begin_layout Description
686 TeX: Typesetting language with macro capability.
689 \begin_layout Description
690 LaTeX: Macro package built upon TeX\SpecialChar \@.
694 \begin_layout Description
695 classes: Descriptions of a type of document, using LaTeX\SpecialChar \@.
699 \begin_layout Description
700 styles: Alters the default behavior of LaTeX in some way.
703 \begin_layout Description
704 LyX: Visual, WYSIWYM word-processor that uses LaTeX to do its printing.
707 \begin_layout Standard
708 LaTeX is the reason why LyX differs from other word processors.
709 LyX is a graphical user interface (GUI) frontend for LaTeX.
710 It is designed to typeset documents using LaTeX without knowing its macro
712 But although LyX can never support all commands graphically, it offers
713 its usage, so that LyX is as functional as LaTeX.
716 \begin_layout Standard
717 Just like LaTeX, LyX focuses on the context of your writing ---
722 The computer then handles how it should look.
725 \begin_layout Section
726 Navigating the Documentation
729 \begin_layout Standard
730 To make it easier to answer your questions and describe all of the features
731 of LyX, the documentation has been split up into several different files.
732 Each one has its own purpose, as described below.
733 Before you go plowing into any of those files, however, you should read
734 this chapter thoroughly first, since it contains a lot of useful information
735 and commentary that can save you some time.
738 \begin_layout Standard
739 The developing of LyX will hopefully never stop, so that some of the documentati
740 on may be incomplete or a bit out of date, though we try to keep up.
741 Like the rest of LyX, the manuals are the work of a group of volunteers
743 \begin_inset Quotes eld
747 \begin_inset Quotes erd
750 , families, dishes to clean, kitty litter to dispose of, et cetera.
751 If you want to help out, be sure to read Section\InsetSpace ~
753 \begin_inset LatexCommand ref
754 reference "sec:Contrib"
758 in addition to the rest of this document.)
761 \begin_layout Standard
762 Also, please do us a favor -- if anything in these manuals confuses you,
763 is unclear, or wrong, don't hesitate to let us know! You can reach the
764 current document maintainers by mailing to
766 lyx-docs@lists.lyx.org
769 If you have questions which are not obviously answered in the documentation,
770 and need help fast, there is an active users' mailing list which you can
773 lyx-users@lists.lyx.org
778 \begin_layout Subsection
779 The Format of the Manuals
782 \begin_layout Standard
783 Some may have printed out the manuals.
784 Others may be reading it within LyX.
785 There are some differences between the LyX-file and the printed version.
786 First, the title is simply at the top of the document, not formatted on
787 a separate page as in some of the printed versions.
788 Nor are any of the footnotes or the Table of Contents fully visible.
789 To open a footnote, which looks like this:
790 \begin_inset Graphics
791 filename clipart/footnoteQt4.png
796 , click on it with the left mouse button.
797 For the Table of Contents, either click on the grey box or click on the
802 menu, where the contents are displayed automatically\SpecialChar \@.
806 \begin_layout Standard
807 In the printed manuals, all cross-references appear as the actual numbers
808 for a chapter, section, subsection, and so on.
809 Online, however, all cross-references appear as a light-grey box like the
811 \begin_inset Graphics
812 filename clipart/referenceQt4.png
818 If you click on that box with the left mouse button, a dialog box will
819 appear containing a list of all the cross-references in the document.
820 This introduction has only two, the first one is named
821 \begin_inset Quotes eld
825 \begin_inset Quotes erd
829 You can go to the referred section by right-clicking on the box or by clicking
836 in the opened dialog.
837 Going back to where you came from is just as easy.
842 to go back to your earlier location.
845 \begin_layout Standard
846 Now that we've cleared up some of the differences between the printed and
847 online versions of this file, we can start looking at the format of this
849 You'll occasionally notice things in different fonts:
852 \begin_layout Itemize
857 is used for general emphasis, generic arguments, book titles, names of
858 sections of other manuals, and notes from the authors.
861 \begin_layout Itemize
866 is used for program and file names, LyX code and functions.
869 \begin_layout Itemize
874 is used for menu, button, or dialog box names, and the names of keyboard
878 \begin_layout Itemize
883 is used for people's names.
886 \begin_layout Itemize
891 is used for LaTeX code
894 \begin_layout Standard
895 For menu accelerator keys and keybindings, you'll probably get referred
901 \begin_inset Quotes eld
906 Extended Features Manual
909 \begin_inset Quotes erd
917 When we do need to reference keys, we'll use the following prefixing convention
921 \begin_layout Itemize
922 \begin_inset Quotes eld
930 \begin_inset Quotes erd
940 \begin_layout Itemize
941 \begin_inset Quotes eld
949 \begin_inset Quotes erd
959 \begin_layout Itemize
960 \begin_inset Quotes eld
968 \begin_inset Quotes erd
975 key, which on some keyboards will be the
982 \begin_layout Itemize
983 \begin_inset Quotes eld
991 \begin_inset Quotes erd
994 \SpecialChar \ldots{}
996 \begin_inset Quotes eld
1004 \begin_inset Quotes erd
1007 are the function keys.
1010 \begin_layout Itemize
1011 \begin_inset Quotes eld
1019 \begin_inset Quotes erd
1025 \begin_layout Itemize
1026 \begin_inset Quotes eld
1034 \begin_inset Quotes erd
1038 \begin_inset Quotes eld
1046 \begin_inset Quotes erd
1050 \begin_inset Quotes eld
1058 \begin_inset Quotes erd
1062 \begin_inset Quotes eld
1070 \begin_inset Quotes erd
1076 \begin_layout Itemize
1079 \begin_inset Quotes eld
1085 \begin_inset Quotes erd
1089 \begin_inset Quotes eld
1097 \begin_inset Quotes erd
1101 \begin_inset Quotes eld
1109 \begin_inset Quotes erd
1113 \begin_inset Quotes eld
1121 \begin_inset Quotes erd
1125 \begin_inset Quotes eld
1133 \begin_inset Quotes erd
1137 \begin_inset Quotes eld
1145 \begin_inset Quotes erd
1148 : these are the 6 keys that appear above the cursor keys on many PC keyboards.
1150 \begin_inset Quotes eld
1158 \begin_inset Quotes erd
1162 \begin_inset Quotes eld
1170 \begin_inset Quotes erd
1174 \begin_inset Quotes eld
1182 \begin_inset Quotes erd
1186 \begin_inset Quotes eld
1194 \begin_inset Quotes erd
1200 \begin_layout Itemize
1209 both refer to the same key.
1210 Some keyboards label the
1215 \begin_inset Quotes eld
1219 \begin_inset Quotes erd
1223 \begin_inset Quotes eld
1227 \begin_inset Quotes erd
1230 still others have two keys.
1231 LyX treats all of them as the same key, so we'll use
1242 \begin_layout Standard
1243 You'll also see something like
1244 \begin_inset Quotes eld
1250 \begin_inset Quotes els
1256 \begin_inset Quotes ers
1260 \begin_inset Quotes erd
1264 We've listed the possible default keybindings for a function in its entry
1266 \begin_inset Quotes eld
1271 Extended Features Manual
1274 \begin_inset Quotes erd
1277 so check there, too.
1278 Note that there are two different keybinding maps in common use in the
1280 \begin_inset Quotes eld
1284 \begin_inset Quotes erd
1287 style which is the default and familiar to those coming from the PC world,
1289 \begin_inset Quotes eld
1293 \begin_inset Quotes erd
1296 style, which is common with those who
1297 \begin_inset Quotes eld
1301 \begin_inset Quotes erd
1304 on Unix systems and use the Emacs editor.
1305 Unless specifically noted, the keybindings in the documentation are from
1306 the default CUA map.
1307 If you like Emacs, you should be smart enough to read the documentation
1308 and figure out the bindings on your own.
1311 \begin_layout Subsection
1312 Units used in the Manuals
1315 \begin_layout Standard
1316 To understand the units described in this documentation, Table\InsetSpace ~
1318 \begin_inset LatexCommand ref
1319 reference "cap:Units-for-image"
1323 explains all units available in LyX.
1326 \begin_layout Standard
1327 \begin_inset Float table
1333 \begin_layout Standard
1334 \begin_inset Caption
1336 \begin_layout Standard
1337 \begin_inset LatexCommand label
1338 name "cap:Units-for-image"
1350 \begin_layout Standard
1351 \begin_inset VSpace medskip
1357 \begin_layout Standard
1359 \begin_inset Tabular
1360 <lyxtabular version="3" rows="20" columns="2">
1362 <column alignment="center" valignment="top" leftline="true" width="0">
1363 <column alignment="center" valignment="top" leftline="true" rightline="true" width="0">
1364 <row topline="true" bottomline="true">
1365 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1368 \begin_layout Standard
1374 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1377 \begin_layout Standard
1384 <row topline="true">
1385 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1388 \begin_layout Standard
1394 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1397 \begin_layout Standard
1404 <row topline="true">
1405 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1408 \begin_layout Standard
1414 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1417 \begin_layout Standard
1424 <row topline="true">
1425 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1428 \begin_layout Standard
1434 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1437 \begin_layout Standard
1444 <row topline="true">
1445 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1448 \begin_layout Standard
1454 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1457 \begin_layout Standard
1459 \begin_inset Formula $\,$
1463 \begin_inset Formula $\,$
1472 <row topline="true">
1473 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1476 \begin_layout Standard
1482 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1485 \begin_layout Standard
1487 \begin_inset Formula $\,$
1491 \begin_inset Formula $\,$
1500 <row topline="true">
1501 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1504 \begin_layout Standard
1510 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1513 \begin_layout Standard
1515 \begin_inset Formula $\,$
1519 \begin_inset Formula $\,$
1528 <row topline="true">
1529 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1532 \begin_layout Standard
1538 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1541 \begin_layout Standard
1543 \begin_inset Formula $\,$
1547 \begin_inset Formula $\,$
1556 <row topline="true">
1557 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1560 \begin_layout Standard
1566 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1569 \begin_layout Standard
1571 \begin_inset Formula $\,$
1575 \begin_inset Formula $\approx$
1579 \begin_inset Formula $\,$
1588 <row topline="true">
1589 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1592 \begin_layout Standard
1598 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1601 \begin_layout Standard
1603 \begin_inset Formula $\,$
1607 \begin_inset Formula $\,$
1616 <row topline="true">
1617 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1620 \begin_layout Standard
1626 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1629 \begin_layout Standard
1630 % of original image width
1636 <row topline="true">
1637 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1640 \begin_layout Standard
1646 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1649 \begin_layout Standard
1656 <row topline="true">
1657 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1660 \begin_layout Standard
1666 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1669 \begin_layout Standard
1676 <row topline="true">
1677 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1680 \begin_layout Standard
1686 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1689 \begin_layout Standard
1696 <row topline="true">
1697 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1700 \begin_layout Standard
1706 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1709 \begin_layout Standard
1716 <row topline="true">
1717 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1720 \begin_layout Standard
1726 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1729 \begin_layout Standard
1736 <row topline="true">
1737 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1740 \begin_layout Standard
1746 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1749 \begin_layout Standard
1756 <row topline="true">
1757 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1760 \begin_layout Standard
1766 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1769 \begin_layout Standard
1780 <row topline="true">
1781 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1784 \begin_layout Standard
1790 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1793 \begin_layout Standard
1804 <row topline="true" bottomline="true">
1805 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1808 \begin_layout Standard
1814 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1817 \begin_layout Standard
1819 \begin_inset Formula $\,$
1823 \begin_inset Formula $\,$
1844 \begin_layout Subsection
1848 \begin_layout Standard
1849 The following list describes the contents of each of the files in the documentat
1853 \begin_layout Description
1854 Introduction This file.
1857 \begin_layout Description
1858 Tutorial If you are new to LyX, and have never used LaTeX before, you should
1860 If you have used LaTeX before, you should still read the
1864 , starting with the section on
1865 \begin_inset Quotes eld
1868 LyX for LaTeX users.
1869 \begin_inset Quotes erd
1872 (Skimming the rest of the document wouldn't hurt, either.)
1875 \begin_layout Description
1877 Guide The primary documentation.
1882 of the basic operation and available features of LyX here.
1883 The main manual assumes that you've read the
1890 \begin_layout Description
1891 Embedded\InsetSpace ~
1892 Objects Extension of the
1897 Documents in detail how to use tables, graphics, floats, notes, and boxes.
1898 It also includes many tricks of the LaTeX masters.
1901 \begin_layout Description
1902 Extended\InsetSpace ~
1903 Features Extension of the
1908 Documents how to use raw LaTeX commands, additional layouts, and special-purpos
1912 \begin_layout Description
1913 Customization A description of advanced LyX features, including how to customize
1914 the overall behavior of LyX\SpecialChar \@.
1915 This includes such things as keybindings, internati
1916 onalization, and configuration files.
1919 \begin_layout Description
1921 configuration LyX investigates your system upon installation.
1922 This file contains info on what LyX learned about your installation.
1923 Check it to see if you're missing something you might like to have.
1926 \begin_layout Standard
1927 These files will reference one another as necessary.
1936 information on installation and customization, but refers the reader to
1939 Customization Manual
1941 for more information.
1944 \begin_layout Standard
1945 We'll state again an important point:
1948 \begin_layout Standard
1949 \begin_inset VSpace bigskip
1955 \begin_layout Standard
1957 If you are new to LyX, read the
1966 \begin_layout Standard
1967 \begin_inset VSpace bigskip
1973 \begin_layout Standard
1974 Otherwise, you could needlessly frustrate yourself.
1975 LyX does all that you need a word processor to do, but using a different
1979 \begin_layout Section
1980 \begin_inset LatexCommand label
1985 Contributing to the LyX Project
1988 \begin_layout Subsection
1992 \begin_layout Standard
1993 LyX is mostly written in C++ (the LaTeX importer is written in Python).
1994 It is a large project, and as a result it is not free from bugs, or the
1995 need for improvements in the source code.
1998 \begin_layout Subsubsection
2002 \begin_layout Standard
2003 While using LyX, you may find behavior which you consider a bug.
2004 Crashes, though rare, can happen.
2005 User interface problems are considered major bugs by the LyX team: especially
2006 helpful are indications of parts of the LyX interface you find confusing,
2010 \begin_layout Standard
2011 LyX has a bug tracking system, which you can find at
2014 \begin_inset LatexCommand url
2015 target "http://bugzilla.lyx.org/"
2022 You should check the bug tracker before reporting any bugs, in case it
2023 has already been reported.
2024 If you have a comment on an existing bug, or wish to report a new bug,
2025 you may either use the bug tracker, or send an e-mail to the development
2028 lyx-devel@lists.lyx.org
2031 Archives of this list are linked from the main LyX website,
2034 \begin_inset LatexCommand url
2035 target "http://www.lyx.org/"
2044 \begin_layout Standard
2045 A useful bug report will at a minimum include the version of LyX you are
2046 having the problem with.
2047 Accurate, detailed descriptions are preferred - the more time developers
2048 have to spend to pinpoint the source of a bug, the less time they have
2049 for other improvements.
2050 Mention the system and system version you are running LyX with.
2051 Give the versions of the libraries you have installed on your system, and,
2052 if relevant, the versions of external programs that LyX uses.
2053 If it's a compilation or configuration problem, include the file
2057 , and mention which compiler you are using.
2061 \begin_layout Subsubsection
2062 Contributing fixes and new features
2065 \begin_layout Standard
2066 If you have made changes to LyX's source that you think should become part
2067 of LyX, send your changes as a diff file (in unified format) to the development
2068 list referenced above, along with a change log, and a description of what
2072 \begin_layout Subsection
2073 Contributing to the Documentation
2076 \begin_layout Standard
2077 LyX's documentation is extensive; however LyX is under constant development,
2078 and each new release adds new features.
2079 You may find some documentation needs improvement.
2080 This section describes what to do if you find an error, or have some suggestion
2081 s for improving the documentation.
2084 \begin_layout Subsubsection
2085 Reporting Errors in the Manuals
2088 \begin_layout Standard
2089 If you find a problem with the documentation, send a message to the mailing
2092 lyx-docs@lists.lyx.org
2095 The documentation team will make any necessary fixes.
2098 \begin_layout Subsubsection
2099 Joining the Documentation Team.
2102 \begin_layout Standard
2103 The LyX Documentation Project, like anything else in the LyX project, can
2104 always use assistance! If you're interested in contributing to the Documentatio
2105 n Project, you need to do the following:
2108 \begin_layout Enumerate
2109 Get the latest LyX source code from
2112 \begin_inset LatexCommand url
2113 target "http://www.lyx.org/trac/browser/lyx-devel/trunk/lib/doc"
2119 Inside that directory is a file called
2124 Read it; it's the style sheet for the documentation.
2127 \begin_layout Enumerate
2138 The point of this exercise is to give you ideas.
2147 is likely to be the most up-to-date of all of the documentation.
2148 You should be able to glean some insights into how we want the manuals
2149 to read and to look.
2152 \begin_layout Enumerate
2153 Contact the team at:
2157 lyx-docs@lists.lyx.org
2161 to discuss your intended changes, and get some feedback on them.
2164 \begin_layout Standard
2165 The changes you wish to make may range from improving clarity of the text,
2166 to doing major re-structuring of the documentation.
2167 Any and all improvements are gladly received.