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 % link all cross references and URLs in pdf output
29 \usepackage[colorlinks=true, bookmarks, bookmarksnumbered,
30 bookmarksopen, bookmarksopenlevel=2,
31 linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,
32 pdfpagelayout=OneColumn, pdfnewwindow=true,
33 pdfstartview=XYZ, plainpages=false, pdfpagelabels,
34 pdfauthor={LyX Team}, pdftex,
35 pdftitle={The LyX User's Guide},pdfsubject={LyX-documentation Intro},
36 pdfkeywords={LyX}]{hyperref}
38 \else % if dvi or ps is produced
40 % link all cross references and URLs in dvi output
41 \usepackage[ps2pdf]{hyperref}
43 \fi % end if pdflatex is used
45 % the pages of the TOC are numbered roman
46 % and a pdf-bookmark for the TOC is added
48 \let\myTOC\tableofcontents
49 \renewcommand\tableofcontents{%
50 \pdfbookmark[1]{Contents}{}
53 \pagenumbering{arabic} }
55 % redefine the \LyX macro for PDF bookmarks
56 \def\LyX{\texorpdfstring{%
57 L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
64 \font_typewriter default
65 \font_default_family default
79 \paperorientation portrait
82 \paragraph_separation indent
84 \quotes_language english
87 \paperpagestyle default
88 \tracking_changes false
105 \begin_layout Standard
107 If you have comments or error corrections, please send them to the LyX Documenta
110 lyx-docs@lists.lyx.org
118 \begin_layout Standard
119 \begin_inset LatexCommand tableofcontents
126 \begin_layout Section
127 The Philosophy of LyX
130 \begin_layout Subsection
134 \begin_layout Standard
135 LyX is a document preparation system.
136 It excels at letting you create complex technical and scientific articles
137 with mathematics, cross-references, bibliographies, indices, etc.
138 It is very good at documents of any length in which the usual processing
139 abilities are required: automatic sectioning and pagination, spellchecking,
141 It can also be used to write a letter to your mom, though granted, there
142 are probably simpler programs available for that.
143 It is definitely not the best tool for creating banners, flyers, or advertiseme
144 nts (we'll explain why later), though with some effort all these can be
146 Some examples of what it is used for: memos, letters, dissertations and
147 theses, lecture notes, seminar notebooks, conference proceedings, software
148 documentation, books, articles in refereed scientific journals, scripts
149 for plays and movies, business proposals, presentations \SpecialChar \ldots{}
153 \begin_layout Standard
154 LyX is a program that provides a modern approach to writing documents with
155 a computer by using a markup language paradigm, an approach that breaks
156 with the obsolete tradition of the
157 \begin_inset Quotes eld
161 \begin_inset Quotes erd
165 It is designed for authors who want professional output quickly with a
166 minimum of effort without becoming specialists in typesetting.
167 The job of typesetting is done mostly by the computer, not the author;
168 with LyX, the author can concentrate on the contents of her writing.
171 \begin_layout Standard
172 Part of the initial challenge of using LyX comes from the change in thinking
173 that you, the user, must make.
174 At one time, all we had for creating documents were typewriters, so we
175 all learned certain tricks to get around their limitations.
176 Underlining, which is little more than overstriking with the
177 \begin_inset Quotes eld
181 \begin_inset Quotes erd
184 character, became a way to emphasize text.
185 You were forced to figure out column sizes and tab stops, and set them,
186 before creating a table.
187 The same applied for letters and other right justified text.
188 Hyphenation at the end of a line required a careful eye and a lot of foresight.
191 \begin_layout Standard
192 In other words, we've all been trained to worry about the little details
193 of which character goes where.
194 Consequently, almost all word processors have this mentality.
195 They still use tab stops for adding whitespace.
196 You still need to worry about exactly where on the page something will
198 Emphasizing text means changing a font, similar to changing the typewriter
200 This is the underlying philosophy of a WYSIWYG word processor:
201 \begin_inset Quotes eld
204 What You See Is What You Get
205 \begin_inset Quotes erd
209 Unfortunately, that paradigm often results in
210 \begin_inset Quotes eld
213 What You See Is All You Get
214 \begin_inset Quotes erd
220 \begin_layout Standard
221 This is where LyX differs from an ordinary word processor.
222 You don't concern yourself with what character goes where.
227 and LyX takes care of the rest, following a set of rules called a
235 \begin_layout Standard
236 To be fair, most recent versions of the most popular office suites now have
237 some sort of style sheets which follow a similar markup method.
238 However, our experience is that they are still rarely used in practice.
243 Let's look at a little example:
246 \begin_layout Standard
247 Suppose you are writing a report.
248 To begin your report, you want a section called
249 \begin_inset Quotes eld
252 Introduction\SpecialChar \@.
254 \begin_inset Quotes erd
257 So, you go into whatever menu it is in your word processor that changes
258 font sizes and decide on a new font size.
259 Then you turn on bold face.
261 \begin_inset Quotes eld
267 \begin_inset Quotes erd
271 Of course, if you later decide that this section belongs someplace else
272 in the document, or if you insert a new section before it, you need to
273 change the numbering for this and all following sections, as well as any
274 entry in the table of contents.
278 \begin_layout Standard
279 In LyX, you go to the pull-down on the far left of the button bar and select
285 \begin_inset Quotes eld
288 Introduction\SpecialChar \@.
290 \begin_inset Quotes erd
296 \begin_layout Standard
298 If you cut and paste the section, it will automatically be renumbered ---
300 And if you enter references to that section correctly (by inserting cross-refer
301 ence tags), LyX will automatically update them all throughout the file so
302 that you never, ever type a section number.
305 \begin_layout Standard
306 Now let's look at the problem of consistency.
307 Five days later, you reopen your report and start Section\InsetSpace ~
309 However, you forget that you were using 18pt bold instead of 16pt, so you
310 type in the heading for Section\InsetSpace ~
311 4 in a different font that what you used
312 for Section\InsetSpace ~
314 That problem doesn't even exist in LyX.
315 The computer takes care of all that silly bookkeeping about which thing
316 has what size font, not you.
317 After all, that's what a computer is good at.
320 \begin_layout Standard
321 Here's another example.
322 Suppose you're making a list.
323 In other word processors, a list is just a bunch of tab stops and newlines.
324 You need to figure out where to put the label for each list item, what
325 that label should be, how many blank lines to put between each item, and
327 Under LyX, you have only two concerns: what kind of list is this, and what
328 do I want to put in it.
332 \begin_layout Standard
333 So, the basic idea behind LyX is: specify
343 \begin_inset Quotes eld
346 What You See Is What You Get,
347 \begin_inset Quotes erd
351 \begin_inset Quotes eld
354 What You See Is What You
359 \begin_inset Quotes erd
363 \begin_inset Quotes eld
367 \begin_inset Quotes erd
370 It's a powerful idea that greatly simplifies the mechanics of writing documents.
371 This is also why LyX isn't so good for creating posters and flyers---in
376 want to specify exactly where everything goes, because there are no functional
377 units like paragraphs, sections, etc.
378 This doesn't mean LyX is missing some cool function.
379 It simply means that it isn't the right tool for the job --- you don't
380 use a screwdriver to drive in nails.
383 \begin_layout Subsection
384 Differences between LyX and Other Word Processors
388 \begin_layout Standard
392 \begin_layout Standard
405 \begin_layout Standard
412 and Other Word Processors
420 \begin_layout Standard
421 Here's a list of things you won't find in LyX:
424 \begin_layout Itemize
428 \begin_layout Itemize
432 \begin_layout Itemize
433 Extra whitespace (i.e.
445 \begin_layout Standard
446 Tab stops, along with a ruler showing you the position of things on the
447 page, are useless in LyX.
448 The program worries about where things go on the page, not you.
449 Extra whitespace is similar; LyX adds them where necessary, depending on
451 Not being able to type two blank lines in a row will be annoying at first,
452 but it makes more sense once you're thinking in WYSIWYM terms.
455 \begin_layout Standard
456 Here are some things that exist in LyX, but aren't used as you might think:
459 \begin_layout Itemize
463 \begin_layout Itemize
467 \begin_layout Itemize
469 single spaced, double spaced, etc.)
472 \begin_layout Itemize
473 Whitespace, horizontal and vertical
476 \begin_layout Itemize
480 \begin_layout Itemize
481 Typefaces (bold, italic, underline, etc.)
484 \begin_layout Standard
485 Although they exist in LyX, you generally don't need them.
486 LyX will take care of these things for you, depending on what you're doing.
487 Different parts of the document are automatically set in a different typeface
489 Paragraph indenting is context dependent; different types of paragraphs
490 get indented differently.
491 Page breaks get handled automatically, as well.
492 In general, the space between lines, between words, and between paragraphs
493 is variable, set by LyX.
497 \begin_layout Standard
498 There are ways to adjust all of these (only some of which require knowledge
499 of LaTeX), either for a whole document or for a specific location in a
517 \begin_layout Standard
518 Lastly, there are a few areas where we believe LyX (and LaTeX) surpasses
519 many word processors:
522 \begin_layout Itemize
526 \begin_layout Itemize
530 \begin_layout Itemize
534 \begin_layout Itemize
538 \begin_layout Itemize
542 \begin_layout Standard
543 Granted, many modern word processors can handle mathematical symbols, tables,
544 and hyphenation, and many have moved towards style definitions and the
546 However, they've only recently been able to do so, whereas LyX is built
547 upon the LaTeX document preparation system.
548 LaTeX has been around for over 20 years, and
555 \begin_layout Subsection
559 \begin_layout Standard
560 LaTeX is a document preparation system designed by Leslie Lamport in 1985.
564 \begin_layout Standard
565 The source for the info in this section is
566 \begin_inset Quotes eld
574 \begin_inset Quotes erd
577 by Helmut Kopka and Patrick Daly, which has an entry in the bibliography
588 It was built up from a typesetting language called TeX, created by Donald
590 TeX takes a sequence of typesetting commands, written in a script in an
591 ASCII file, and executes them.
593 \begin_inset Quotes eld
597 \begin_inset Quotes erd
600 of the printing trade were modeled by Knuth as computer algorithms and
601 incorporated into TeX, thus its excellent printed appearance.
602 What comes directly out of TeX is the portable document format
607 \begin_inset Quotes eld
611 \begin_inset Quotes erd
619 The dvi format is often used for previews and can later be converted to
620 other formats like PostScript.
624 \begin_layout Standard
625 TeX isn't only a typesetting engine, it also allows you to define macros.
626 Most people who use TeX are actually using a macro package which Knuth
627 created to hide a lot of the typesetting details.
628 This is where Leslie Lamport enters our story.
629 He wanted a macro package that was more user- and less typesetter-oriented,
630 with a set of commands that consistently typeset things like sections,
631 tables or math formulas in an uniform, consistent fashion.
632 This is how LaTeX was born.
635 \begin_layout Standard
636 Now, in parallel with the development and growth of LaTeX, other folks were
637 creating their own custom macro packages for TeX, ones to make slides or
638 articles for math journals and so on.
639 Some used the raw TeX facilities to do this, others began modifying LaTeX.
640 To try and unify this mess, a team of LaTeX-nicians began to work on LaTeX2e,
641 the current version of LaTeX, during the late 1980's.
642 This new version of LaTeX has commands which provide an easier-to-use interface
643 to TeX's macro-creating commands, aid in the use of new fonts, and so on.
644 In fact, LaTeX is quite an extensive language in its own right! Users around
645 the world have been creating their own add-ons for LaTeX beyond the standard
649 \begin_layout Standard
650 There are two ways to extend LaTeX: classes and styles.
655 is a set of LaTeX macros describing a new type of document, like a book,
657 There are classes for slides, for physics and math journals\SpecialChar \ldots{}
659 even have a class for their thesis format! A
663 differs from a class in that it doesn't define a new type of document,
664 but a different type of
668 that any document can use.
669 For example, LyX controls page margins and line spacing using two different
670 LaTeX style-files designed for these purposes.
671 There are style-files for a whole slew of things: printing labels or envelopes,
672 changing indentation behavior, adding new fonts, manipulating graphics,
673 designing fancy page headings, customizing bibliographies, altering the
674 location and appearance of footnotes, tables, and figures, customizing
678 \begin_layout Standard
682 \begin_layout Description
683 TeX: Typesetting language with macro capability.
686 \begin_layout Description
687 LaTeX: Macro package built upon TeX\SpecialChar \@.
691 \begin_layout Description
692 classes: Descriptions of a type of document, using LaTeX\SpecialChar \@.
696 \begin_layout Description
697 styles: Alters the default behavior of LaTeX in some way.
700 \begin_layout Description
701 LyX: Visual, WYSIWYM word-processor that uses LaTeX to do its printing.
704 \begin_layout Standard
705 LaTeX is the reason why LyX differs from other word processors.
706 LyX is a graphical user interface (GUI) frontend for LaTeX.
707 It is designed to typeset documents using LaTeX without knowing its macro
709 But although LyX can never support all commands graphically, it offers
710 its usage, so that LyX is as functional as LaTeX.
713 \begin_layout Standard
714 Just like LaTeX, LyX focuses on the context of your writing ---
719 The computer then handles how it should look.
722 \begin_layout Section
723 Navigating the Documentation
726 \begin_layout Standard
727 To make it easier to answer your questions and describe all of the features
728 of LyX, the documentation has been split up into several different files.
729 Each one has its own purpose, as described below.
730 Before you go plowing into any of those files, however, you should read
731 this chapter thoroughly first, since it contains a lot of useful information
732 and commentary that can save you some time.
735 \begin_layout Standard
736 The developing of LyX will hopefully never stop, so that some of the documentati
737 on may be incomplete or a bit out of date, though we try to keep up.
738 Like the rest of LyX, the manuals are the work of a group of volunteers
740 \begin_inset Quotes eld
744 \begin_inset Quotes erd
747 , families, dishes to clean, kitty litter to dispose of, et cetera.
748 If you want to help out, be sure to read Section\InsetSpace ~
750 \begin_inset LatexCommand ref
751 reference "sec:Contrib"
755 in addition to the rest of this document.)
758 \begin_layout Standard
759 Also, please do us a favor -- if anything in these manuals confuses you,
760 is unclear, or wrong, don't hesitate to let us know! You can reach the
761 current document maintainers by mailing to
763 lyx-docs@lists.lyx.org
766 If you have questions which are not obviously answered in the documentation,
767 and need help fast, there is an active users' mailing list which you can
770 lyx-users@lists.lyx.org
775 \begin_layout Subsection
776 The Format of the Manuals
779 \begin_layout Standard
780 Some may have printed out the manuals.
781 Others may be reading it within LyX.
782 There are some differences between the LyX-file and the printed version.
783 First, the title is simply at the top of the document, not formatted on
784 a separate page as in some of the printed versions.
785 Nor are any of the footnotes or the Table of Contents fully visible.
786 To open a footnote, which looks like this:
787 \begin_inset Graphics
788 filename clipart/footnoteQt4.png
793 , click on it with the left mouse button.
794 For the Table of Contents, either click on the grey box or click on the
799 menu, where the contents are displayed automatically\SpecialChar \@.
803 \begin_layout Standard
804 In the printed manuals, all cross-references appear as the actual numbers
805 for a chapter, section, subsection, and so on.
806 Online, however, all cross-references appear as a light-grey box like the
808 \begin_inset Graphics
809 filename clipart/referenceQt4.png
815 If you click on that box with the left mouse button, a dialog box will
816 appear containing a list of all the cross-references in the document.
817 This introduction has only two, the first one is named
818 \begin_inset Quotes eld
822 \begin_inset Quotes erd
826 You can go to the referred section by right-clicking on the box or by clicking
833 in the opened dialog.
834 Going back to where you came from is just as easy.
839 to go back to your earlier location.
842 \begin_layout Standard
843 Now that we've cleared up some of the differences between the printed and
844 online versions of this file, we can start looking at the format of this
846 You'll occasionally notice things in different fonts:
849 \begin_layout Itemize
854 is used for general emphasis, generic arguments, book titles, names of
855 sections of other manuals, and notes from the authors.
858 \begin_layout Itemize
863 is used for program and file names, LyX code and functions.
866 \begin_layout Itemize
871 is used for menu, button, or dialog box names, and the names of keyboard
875 \begin_layout Itemize
880 is used for people's names.
883 \begin_layout Itemize
888 is used for LaTeX code
891 \begin_layout Standard
892 For menu accelerator keys and keybindings, you'll probably get referred
898 \begin_inset Quotes eld
903 Extended Features Manual
906 \begin_inset Quotes erd
914 When we do need to reference keys, we'll use the following prefixing convention
918 \begin_layout Itemize
919 \begin_inset Quotes eld
927 \begin_inset Quotes erd
937 \begin_layout Itemize
938 \begin_inset Quotes eld
946 \begin_inset Quotes erd
956 \begin_layout Itemize
957 \begin_inset Quotes eld
965 \begin_inset Quotes erd
972 key, which on some keyboards will be the
979 \begin_layout Itemize
980 \begin_inset Quotes eld
988 \begin_inset Quotes erd
991 \SpecialChar \ldots{}
993 \begin_inset Quotes eld
1001 \begin_inset Quotes erd
1004 are the function keys.
1007 \begin_layout Itemize
1008 \begin_inset Quotes eld
1016 \begin_inset Quotes erd
1022 \begin_layout Itemize
1023 \begin_inset Quotes eld
1031 \begin_inset Quotes erd
1035 \begin_inset Quotes eld
1043 \begin_inset Quotes erd
1047 \begin_inset Quotes eld
1055 \begin_inset Quotes erd
1059 \begin_inset Quotes eld
1067 \begin_inset Quotes erd
1073 \begin_layout Itemize
1076 \begin_inset Quotes eld
1082 \begin_inset Quotes erd
1086 \begin_inset Quotes eld
1094 \begin_inset Quotes erd
1098 \begin_inset Quotes eld
1106 \begin_inset Quotes erd
1110 \begin_inset Quotes eld
1118 \begin_inset Quotes erd
1122 \begin_inset Quotes eld
1130 \begin_inset Quotes erd
1134 \begin_inset Quotes eld
1142 \begin_inset Quotes erd
1145 : these are the 6 keys that appear above the cursor keys on many PC keyboards.
1147 \begin_inset Quotes eld
1155 \begin_inset Quotes erd
1159 \begin_inset Quotes eld
1167 \begin_inset Quotes erd
1171 \begin_inset Quotes eld
1179 \begin_inset Quotes erd
1183 \begin_inset Quotes eld
1191 \begin_inset Quotes erd
1197 \begin_layout Itemize
1206 both refer to the same key.
1207 Some keyboards label the
1212 \begin_inset Quotes eld
1216 \begin_inset Quotes erd
1220 \begin_inset Quotes eld
1224 \begin_inset Quotes erd
1227 still others have two keys.
1228 LyX treats all of them as the same key, so we'll use
1239 \begin_layout Standard
1240 You'll also see something like
1241 \begin_inset Quotes eld
1247 \begin_inset Quotes els
1253 \begin_inset Quotes ers
1257 \begin_inset Quotes erd
1261 We've listed the possible default keybindings for a function in its entry
1263 \begin_inset Quotes eld
1268 Extended Features Manual
1271 \begin_inset Quotes erd
1274 so check there, too.
1275 Note that there are two different keybinding maps in common use in the
1277 \begin_inset Quotes eld
1281 \begin_inset Quotes erd
1284 style which is the default and familiar to those coming from the PC world,
1286 \begin_inset Quotes eld
1290 \begin_inset Quotes erd
1293 style, which is common with those who
1294 \begin_inset Quotes eld
1298 \begin_inset Quotes erd
1301 on Unix systems and use the Emacs editor.
1302 Unless specifically noted, the keybindings in the documentation are from
1303 the default CUA map.
1304 If you like Emacs, you should be smart enough to read the documentation
1305 and figure out the bindings on your own.
1308 \begin_layout Subsection
1309 Units used in the Manuals
1312 \begin_layout Standard
1313 To understand the units described in this documentation, Table\InsetSpace ~
1315 \begin_inset LatexCommand ref
1316 reference "cap:Units-for-image"
1320 explains all units available in LyX.
1323 \begin_layout Standard
1324 \begin_inset Float table
1330 \begin_layout Standard
1331 \begin_inset Caption
1333 \begin_layout Standard
1334 \begin_inset LatexCommand label
1335 name "cap:Units-for-image"
1347 \begin_layout Standard
1348 \begin_inset VSpace medskip
1354 \begin_layout Standard
1356 \begin_inset Tabular
1357 <lyxtabular version="3" rows="20" columns="2">
1359 <column alignment="center" valignment="top" leftline="true" width="0">
1360 <column alignment="center" valignment="top" leftline="true" rightline="true" width="0">
1361 <row topline="true" bottomline="true">
1362 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1365 \begin_layout Standard
1371 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1374 \begin_layout Standard
1381 <row topline="true">
1382 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1385 \begin_layout Standard
1391 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1394 \begin_layout Standard
1401 <row topline="true">
1402 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1405 \begin_layout Standard
1411 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1414 \begin_layout Standard
1421 <row topline="true">
1422 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1425 \begin_layout Standard
1431 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1434 \begin_layout Standard
1441 <row topline="true">
1442 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1445 \begin_layout Standard
1451 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1454 \begin_layout Standard
1456 \begin_inset Formula $\,$
1460 \begin_inset Formula $\,$
1469 <row topline="true">
1470 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1473 \begin_layout Standard
1479 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1482 \begin_layout Standard
1484 \begin_inset Formula $\,$
1488 \begin_inset Formula $\,$
1497 <row topline="true">
1498 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1501 \begin_layout Standard
1507 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1510 \begin_layout Standard
1512 \begin_inset Formula $\,$
1516 \begin_inset Formula $\,$
1525 <row topline="true">
1526 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1529 \begin_layout Standard
1535 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1538 \begin_layout Standard
1540 \begin_inset Formula $\,$
1544 \begin_inset Formula $\,$
1553 <row topline="true">
1554 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1557 \begin_layout Standard
1563 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1566 \begin_layout Standard
1568 \begin_inset Formula $\,$
1572 \begin_inset Formula $\approx$
1576 \begin_inset Formula $\,$
1585 <row topline="true">
1586 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1589 \begin_layout Standard
1595 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1598 \begin_layout Standard
1600 \begin_inset Formula $\,$
1604 \begin_inset Formula $\,$
1613 <row topline="true">
1614 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1617 \begin_layout Standard
1623 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1626 \begin_layout Standard
1627 % of original image width
1633 <row topline="true">
1634 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1637 \begin_layout Standard
1643 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1646 \begin_layout Standard
1653 <row topline="true">
1654 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1657 \begin_layout Standard
1663 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1666 \begin_layout Standard
1673 <row topline="true">
1674 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1677 \begin_layout Standard
1683 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1686 \begin_layout Standard
1693 <row topline="true">
1694 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1697 \begin_layout Standard
1703 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1706 \begin_layout Standard
1713 <row topline="true">
1714 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1717 \begin_layout Standard
1723 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1726 \begin_layout Standard
1733 <row topline="true">
1734 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1737 \begin_layout Standard
1743 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1746 \begin_layout Standard
1753 <row topline="true">
1754 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1757 \begin_layout Standard
1763 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1766 \begin_layout Standard
1777 <row topline="true">
1778 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1781 \begin_layout Standard
1787 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1790 \begin_layout Standard
1801 <row topline="true" bottomline="true">
1802 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1805 \begin_layout Standard
1811 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1814 \begin_layout Standard
1816 \begin_inset Formula $\,$
1820 \begin_inset Formula $\,$
1841 \begin_layout Subsection
1845 \begin_layout Standard
1846 The following list describes the contents of each of the files in the documentat
1850 \begin_layout Description
1851 Introduction This file.
1854 \begin_layout Description
1855 Tutorial If you are new to LyX, and have never used LaTeX before, you should
1857 If you have used LaTeX before, you should still read the
1861 , starting with the section on
1862 \begin_inset Quotes eld
1865 LyX for LaTeX users.
1866 \begin_inset Quotes erd
1869 (Skimming the rest of the document wouldn't hurt, either.)
1872 \begin_layout Description
1874 Guide The primary documentation.
1879 of the basic operation and available features of LyX here.
1880 The main manual assumes that you've read the
1887 \begin_layout Description
1888 Embedded\InsetSpace ~
1889 Objects Extension of the
1894 Documents in detail how to use tables, graphics, floats, notes, and boxes.
1895 It also includes many tricks of the LaTeX masters.
1898 \begin_layout Description
1899 Extended\InsetSpace ~
1900 Features Extension of the
1905 Documents how to use raw LaTeX commands, additional layouts, and special-purpos
1909 \begin_layout Description
1910 Customization A description of advanced LyX features, including how to customize
1911 the overall behavior of LyX\SpecialChar \@.
1912 This includes such things as keybindings, internati
1913 onalization, and configuration files.
1916 \begin_layout Description
1918 configuration LyX investigates your system upon installation.
1919 This file contains info on what LyX learned about your installation.
1920 Check it to see if you're missing something you might like to have.
1923 \begin_layout Standard
1924 These files will reference one another as necessary.
1933 information on installation and customization, but refers the reader to
1936 Customization Manual
1938 for more information.
1941 \begin_layout Standard
1942 We'll state again an important point:
1945 \begin_layout Standard
1946 \begin_inset VSpace bigskip
1952 \begin_layout Standard
1954 If you are new to LyX, read the
1963 \begin_layout Standard
1964 \begin_inset VSpace bigskip
1970 \begin_layout Standard
1971 Otherwise, you could needlessly frustrate yourself.
1972 LyX does all that you need a word processor to do, but using a different
1976 \begin_layout Section
1977 \begin_inset LatexCommand label
1982 Contributing to the LyX Project
1985 \begin_layout Subsection
1989 \begin_layout Standard
1990 LyX is mostly written in C++ (the LaTeX importer is written in Python).
1991 It is a large project, and as a result it is not free from bugs, or the
1992 need for improvements in the source code.
1995 \begin_layout Subsubsection
1999 \begin_layout Standard
2000 While using LyX, you may find behavior which you consider a bug.
2001 Crashes, though rare, can happen.
2002 User interface problems are considered major bugs by the LyX team: especially
2003 helpful are indications of parts of the LyX interface you find confusing,
2007 \begin_layout Standard
2008 LyX has a bug tracking system, which you can find at
2011 \begin_inset LatexCommand url
2012 target "http://bugzilla.lyx.org/"
2019 You should check the bug tracker before reporting any bugs, in case it
2020 has already been reported.
2021 If you have a comment on an existing bug, or wish to report a new bug,
2022 you may either use the bug tracker, or send an e-mail to the development
2025 lyx-devel@lists.lyx.org
2028 Archives of this list are linked from the main LyX website,
2031 \begin_inset LatexCommand url
2032 target "http://www.lyx.org/"
2041 \begin_layout Standard
2042 A useful bug report will at a minimum include the version of LyX you are
2043 having the problem with.
2044 Accurate, detailed descriptions are preferred - the more time developers
2045 have to spend to pinpoint the source of a bug, the less time they have
2046 for other improvements.
2047 Mention the system and system version you are running LyX with.
2048 Give the versions of the libraries you have installed on your system, and,
2049 if relevant, the versions of external programs that LyX uses.
2050 If it's a compilation or configuration problem, include the file
2054 , and mention which compiler you are using.
2058 \begin_layout Subsubsection
2059 Contributing fixes and new features
2062 \begin_layout Standard
2063 If you have made changes to LyX's source that you think should become part
2064 of LyX, send your changes as a diff file (in unified format) to the development
2065 list referenced above, along with a change log, and a description of what
2069 \begin_layout Subsection
2070 Contributing to the Documentation
2073 \begin_layout Standard
2074 LyX's documentation is extensive; however LyX is under constant development,
2075 and each new release adds new features.
2076 You may find some documentation needs improvement.
2077 This section describes what to do if you find an error, or have some suggestion
2078 s for improving the documentation.
2081 \begin_layout Subsubsection
2082 Reporting Errors in the Manuals
2085 \begin_layout Standard
2086 If you find a problem with the documentation, send a message to the mailing
2089 lyx-docs@lists.lyx.org
2092 The documentation team will make any necessary fixes.
2095 \begin_layout Subsubsection
2096 Joining the Documentation Team.
2099 \begin_layout Standard
2100 The LyX Documentation Project, like anything else in the LyX project, can
2101 always use assistance! If you're interested in contributing to the Documentatio
2102 n Project, you need to do the following:
2105 \begin_layout Enumerate
2106 Get the latest LyX source code from
2109 \begin_inset LatexCommand url
2110 target "http://www.lyx.org/trac/browser/lyx-devel/trunk/lib/doc"
2116 Inside that directory is a file called
2121 Read it; it's the style sheet for the documentation.
2124 \begin_layout Enumerate
2135 The point of this exercise is to give you ideas.
2144 is likely to be the most up-to-date of all of the documentation.
2145 You should be able to glean some insights into how we want the manuals
2146 to read and to look.
2149 \begin_layout Enumerate
2150 Contact the team at:
2154 lyx-docs@lists.lyx.org
2158 to discuss your intended changes, and get some feedback on them.
2161 \begin_layout Standard
2162 The changes you wish to make may range from improving clarity of the text,
2163 to doing major re-structuring of the documentation.
2164 Any and all improvements are gladly received.