1 #LyX 2.2 created this file. For more info see http://www.lyx.org/
5 \origin /systemlyxdir/doc/
8 % DO NOT ALTER THIS PREAMBLE!!!
10 %This preamble is designed to ensure that the document prints
11 % out as advertised. If you mess with this preamble,
12 % parts of the document may not print out as expected. If you
13 % have problems LaTeXing this file, please contact
14 % the documentation team
15 % email: lyx-docs@lists.lyx.org
17 % the pages of the TOC is numbered roman
18 % and a pdf-bookmark for the TOC is added
20 \let\myTOC\tableofcontents
21 \renewcommand\tableofcontents{%
22 \pdfbookmark[1]{\contentsname}{}
25 \pagenumbering{arabic} }
27 \use_default_options false
28 \maintain_unincluded_children false
30 \language_package default
33 \font_roman "palatino" "default"
34 \font_sans "helvet" "default"
35 \font_typewriter "courier" "default"
36 \font_math "auto" "auto"
37 \font_default_family default
38 \use_non_tex_fonts false
41 \font_sf_scale 100 100
42 \font_tt_scale 100 100
44 \default_output_format pdf2
46 \bibtex_command default
47 \index_command default
51 \pdf_title "Introduction to LyX"
52 \pdf_author "LyX Team"
53 \pdf_subject "LyX-documentation Intro"
54 \pdf_keywords "LyX, documentation"
56 \pdf_bookmarksnumbered true
57 \pdf_bookmarksopen true
58 \pdf_bookmarksopenlevel 2
63 \pdf_pdfusetitle false
64 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
67 \use_package amsmath 1
68 \use_package amssymb 1
71 \use_package mathdots 1
72 \use_package mathtools 0
74 \use_package stackrel 0
75 \use_package stmaryrd 0
76 \use_package undertilde 0
78 \cite_engine_type default
82 \paperorientation portrait
92 \paragraph_separation indent
93 \paragraph_indentation default
94 \quotes_language english
97 \paperpagestyle default
98 \tracking_changes false
102 \html_be_strict false
108 Introduction to \SpecialChar LyX
113 by the \SpecialChar LyX
118 \begin_layout Plain Layout
120 If you have comments on or corrections to this documentation, please send
121 them to the \SpecialChar LyX
122 Documentation mailing list:
123 \begin_inset CommandInset href
125 target "lyx-docs@lists.lyx.org"
138 \begin_layout Standard
139 \begin_inset CommandInset toc
140 LatexCommand tableofcontents
147 \begin_layout Section
148 The Philosophy of \SpecialChar LyX
152 \begin_layout Subsection
153 What is \SpecialChar LyX
157 \begin_layout Standard
159 is a document preparation system.
160 It excels at letting you create complex technical and scientific articles
161 with mathematics, cross-references, bibliographies, indexes, etc.
162 It is very good for working with documents of any length in which the usual
163 processing abilities are required: automatic sectioning and pagination,
164 spell checking and so forth.
165 It can also be used to write a letter to your mom, though granted, there
166 are probably simpler programs available for that.
167 It is definitely not the best tool for creating banners, flyers, or advertiseme
168 nts (we'll explain why later), though with some effort all these can be
170 Here are some examples of what it is used for: memos, letters, dissertations
171 and theses, lecture notes, seminar notebooks, conference proceedings, software
172 documentation, books, articles in refereed scientific journals, scripts
173 for plays and movies, business proposals, presentations \SpecialChar ldots
177 \begin_layout Standard
179 is a program that provides a modern approach to writing documents with
180 a computer by using a markup language paradigm, an approach that breaks
181 with the obsolete tradition of the
182 \begin_inset Quotes eld
186 \begin_inset Quotes erd
190 It is designed for authors who want professional output quickly with a
191 minimum of effort and without becoming specialists in typesetting.
192 The job of typesetting is done mostly by the computer, not the author;
193 with \SpecialChar LyX
194 , the author can concentrate on the contents of his writing.
197 \begin_layout Standard
198 Part of the initial challenge of using \SpecialChar LyX
199 comes from the change in thinking
200 that you, the user, must make.
201 At one time, all we had for creating documents were typewriters, so we
202 all learned certain tricks to get around their limitations.
203 Underlining, which is little more than overstriking with the
204 \begin_inset Quotes eld
208 \begin_inset Quotes erd
211 character, became a way to emphasize text.
212 You were forced to figure out column sizes and tab stops, and set them,
213 before creating a table.
214 The same applied for letters and other right justified text.
215 Hyphenation at the end of a line required a careful eye and a lot of foresight.
218 \begin_layout Standard
219 In other words, we've all been trained to worry about the little details
220 of which character goes where.
221 Consequently, almost all word processors have this mentality.
222 They still use tab stops for adding whitespace.
223 You still need to worry about exactly where on the page something will
225 Emphasizing text means changing a font, similar to changing the typewriter
227 This is the underlying philosophy of a WYSIWYG word processor:
228 \begin_inset Quotes eld
231 What You See Is What You Get
232 \begin_inset Quotes erd
236 Unfortunately, that paradigm often results in
237 \begin_inset Quotes eld
240 What You See Is All You Get
241 \begin_inset Quotes erd
247 \begin_layout Standard
248 This is where \SpecialChar LyX
249 differs from an ordinary word processor.
250 You don't concern yourself with what character goes where.
251 You tell \SpecialChar LyX
257 takes care of the rest, following a set of rules called a
265 \begin_layout Plain Layout
266 To be fair, most recent versions of the most popular office suites now have
267 some sort of style sheets which follow a similar markup method.
268 However, our experience is that they are still rarely used in practice.
273 Let's look at a little example:
276 \begin_layout Standard
277 Suppose you are writing a report.
278 To begin your report, you want a section called
279 \begin_inset Quotes eld
282 Introduction\SpecialChar endofsentence
284 \begin_inset Quotes erd
287 So, you go into whatever menu it is in your word processor that changes
288 font sizes and decide on a new font size.
289 Then you turn on bold face.
291 \begin_inset Quotes eld
303 \begin_inset Quotes erd
307 Of course, if you later decide that this section belongs someplace else
308 in the document or if you insert a new section before it, you need to change
309 the numbering for this and all following sections, as well as any entry
310 in the table of contents.
313 \begin_layout Standard
315 , you go to the pull-down on the far left of the button bar and select
321 \begin_inset Quotes eld
325 \begin_inset Quotes erd
331 \begin_layout Standard
333 If you cut and paste the section, it will automatically be renumbered —
335 And if you enter references to that section correctly (by inserting cross-refer
336 ence tags), \SpecialChar LyX
337 will automatically update them all throughout the file so that
338 you never, ever type a section number.
341 \begin_layout Standard
342 Now let's look at the problem of consistency.
343 Five days later, you reopen your report and start Section
348 However, you forget that you were using 18
349 \begin_inset space \thinspace{}
352 pt bold instead of 16
353 \begin_inset space \thinspace{}
356 pt, so you type in the heading for Section
360 4 in a different font from the one you used for Section
365 That problem doesn't even exist in \SpecialChar LyX
367 The computer takes care of all that silly bookkeeping about which thing
368 has what size font, not you.
369 After all, that's what a computer is good at.
372 \begin_layout Standard
373 Here's another example.
374 Suppose you're making a list.
375 In other word processors, a list is just a bunch of tab stops and newlines.
376 You need to figure out where to put the label for each list item, what
377 that label should be, how many blank lines to put between each item, and
379 Under \SpecialChar LyX
380 , you have only two concerns: what kind of list is this, and what
381 do I want to put in it? That is it.
384 \begin_layout Standard
385 So, the basic idea behind \SpecialChar LyX
396 \begin_inset Quotes eld
399 What You See Is What You Get,
400 \begin_inset Quotes erd
405 \begin_inset Quotes eld
408 What You See Is What You
413 \begin_inset Quotes erd
417 \begin_inset Quotes eld
421 \begin_inset Quotes erd
424 It's a powerful idea that greatly simplifies the mechanics of writing documents.
425 This is also why \SpecialChar LyX
426 isn't so good for creating posters and flyers.
431 want to specify exactly where everything goes, because there are no functional
432 units like paragraphs, sections, etc.
433 This doesn't mean \SpecialChar LyX
434 is missing some cool function.
435 It simply means that it isn't the right tool for the job — you don't use
436 a screwdriver to drive in nails.
439 \begin_layout Subsection
440 Differences between \SpecialChar LyX
441 and Other Word Processors
442 \begin_inset Argument 1
445 \begin_layout Plain Layout
449 \begin_layout Plain Layout
463 \begin_layout Plain Layout
470 and Other Word Processors
478 \begin_layout Standard
479 Here's a list of things you won't find in \SpecialChar LyX
483 \begin_layout Itemize
487 \begin_layout Itemize
491 \begin_layout Itemize
493 \begin_inset space \thinspace{}
497 \begin_inset space \space{}
511 \begin_layout Standard
512 Tab stops, along with a ruler showing you the position of things on the
513 page, are useless in \SpecialChar LyX
515 The program worries about where things go on the page, not you.
516 Extra whitespace is similar; \SpecialChar LyX
517 adds it where necessary, depending on context.
518 Not being able to type two blank lines in a row will be annoying at first,
519 but it makes more sense once you're thinking in WYSIWYM terms.
522 \begin_layout Standard
523 Here are some things that exist in \SpecialChar LyX
524 , but aren't used as you might think:
527 \begin_layout Itemize
531 \begin_layout Itemize
535 \begin_layout Itemize
537 \begin_inset space \thinspace{}
541 \begin_inset space \space{}
544 single spaced, double spaced, etc.)
547 \begin_layout Itemize
548 Whitespace, horizontal and vertical
551 \begin_layout Itemize
555 \begin_layout Itemize
556 Typefaces (bold, italic, underline, etc.)
559 \begin_layout Standard
560 Although they exist in \SpecialChar LyX
561 , you generally don't need them.
563 will take care of these things for you, depending on what you're doing.
564 Different parts of the document are automatically set in a different typeface
566 Paragraph indenting is context dependent; different types of paragraphs
567 get indented differently.
568 Page breaks get handled automatically, as well.
569 In general, the space between lines, between words, and between paragraphs
570 is variable, set by \SpecialChar LyX
575 \begin_layout Plain Layout
576 There are ways to adjust all of these (only some of which require knowledge
577 of \SpecialChar LaTeX
578 ), either for a whole document or for a specific location in a document.
595 \begin_layout Standard
596 Lastly, there are a few areas where we believe \SpecialChar LyX
597 (and \SpecialChar LaTeX
598 ) surpasses many word
602 \begin_layout Itemize
606 \begin_layout Itemize
610 \begin_layout Itemize
614 \begin_layout Itemize
618 \begin_layout Itemize
622 \begin_layout Standard
623 Granted, many modern word processors can handle mathematical symbols, tables,
624 and hyphenation, and many have moved towards style definitions and the
626 However, they've only recently been able to do so, whereas \SpecialChar LyX
628 the \SpecialChar LaTeX
629 document preparation system.
631 has been around since 1985, and
638 \begin_layout Subsection
639 What is \SpecialChar LaTeX
643 \begin_layout Standard
645 is a document preparation system designed by Leslie Lamport in 1985.
649 \begin_layout Plain Layout
650 The source for the info in this section is
652 A Guide to \SpecialChar LaTeX2e
655 , by Helmut Kopka and Patrick Daly, which has an entry in the bibliography
660 \SpecialChar endofsentence
666 It was built up from a typesetting language called \SpecialChar TeX
670 takes a sequence of typesetting commands, written in a script in an ASCII
671 file, and executes them.
673 \begin_inset Quotes eld
677 \begin_inset Quotes erd
680 of the printing trade were modeled by Knuth as computer algorithms and
681 incorporated into \SpecialChar TeX
682 , hence its excellent printed appearance.
683 What comes directly out of \SpecialChar TeX
684 is the portable document format
689 \begin_inset Quotes eld
693 \begin_inset Quotes erd
701 The dvi format is often used for previews and can later be converted to
702 other formats like PostScript.
706 \begin_layout Standard
708 isn't only a typesetting engine; it also allows you to define macros.
709 Most people who use \SpecialChar TeX
710 are actually using a macro package which Knuth created
711 to hide a lot of the typesetting details.
712 This is where Leslie Lamport enters our story.
713 He wanted a macro package that was more user- and less typesetter-oriented,
714 with a set of commands that consistently typeset things like sections,
715 tables or math formulas in a uniform, consistent fashion.
716 This is how \SpecialChar LaTeX
720 \begin_layout Standard
721 Now, in parallel with the development and growth of \SpecialChar LaTeX
722 , other folks were creating
723 their own custom macro packages for \SpecialChar TeX
724 , ones to make slides or articles for
725 math journals and so on.
726 Some used the raw \SpecialChar TeX
727 facilities to do this, others began modifying \SpecialChar LaTeX
729 To try and unify this mess, a team of \SpecialChar LaTeX
730 -nicians began to work on \SpecialChar LaTeX2e
732 version of \SpecialChar LaTeX
733 , during the late 1980's.
734 This new version of \SpecialChar LaTeX
735 has commands which provide an easier-to-use interface
737 's macro-creating commands, aid in the use of new fonts, and so on.
738 In fact, \SpecialChar LaTeX
739 is quite an extensive language in its own right! Users around
740 the world have been creating their own add-ons for \SpecialChar LaTeX
745 \begin_layout Standard
746 There are two ways to extend \SpecialChar LaTeX
747 : classes and styles.
752 is a set of \SpecialChar LaTeX
753 macros describing a new type of document, like a book, or
755 There are classes for slides, for physics and math journals\SpecialChar ldots
757 even have a class for their thesis format.
762 differs from a class in that it doesn't define a new type of document,
763 but a different type of
767 that any document can use.
768 For example, \SpecialChar LyX
769 controls page margins and line spacing using two different
771 style-files designed for these purposes.
772 There are style-files for a whole slew of things: printing labels or envelopes,
773 changing indentation behavior, adding new fonts, manipulating graphics,
774 designing fancy page headings, customizing bibliographies, altering the
775 location and appearance of footnotes, tables, and figures, customizing
779 \begin_layout Standard
783 \begin_layout Description
785 : Typesetting language with macro capability.
788 \begin_layout Description
790 : Macro package built upon \SpecialChar TeX
791 \SpecialChar endofsentence
795 \begin_layout Description
796 classes: Descriptions of types of document used with \SpecialChar LaTeX
797 \SpecialChar endofsentence
801 \begin_layout Description
802 styles: Descriptions of the default behavior of particular elements of \SpecialChar LaTeX
806 \begin_layout Description
808 : Visual, WYSIWYM document processor that uses \SpecialChar LaTeX
809 to do its typesetting.
812 \begin_layout Standard
813 This section attempts to explain the difference between \SpecialChar LyX
814 and a word processor.
815 Simply put, \SpecialChar LaTeX
817 By using \SpecialChar LaTeX
818 as its backend, \SpecialChar LyX
819 helps you to think more about
828 The computer then handles
835 \begin_layout Section
836 Navigating the Documentation
839 \begin_layout Standard
840 To make it easier to answer your questions and describe all of the features
842 , the documentation has been split up into several different files.
843 Each one has its own purpose, as described below.
844 Before you go ploughing into any of those files, however, you should read
845 this chapter thoroughly, since it contains a lot of useful information
846 and commentary that can save you some time.
849 \begin_layout Standard
850 Hopefully, the development of \SpecialChar LyX
851 will never stop; so some of the documentation
852 may be incomplete or a bit out of date, though we try to keep up-to-date.
853 Like the rest of \SpecialChar LyX
854 , the manuals are the work of a group of volunteers who
856 \begin_inset Quotes eld
860 \begin_inset Quotes erd
863 , families, dishes to clean,
868 If you want to help out, be sure to read Section
873 \begin_inset CommandInset ref
875 reference "sec:Contrib"
879 in addition to the rest of this document.
882 \begin_layout Standard
883 Also, please do us a favor – if anything in these manuals confuses you,
884 is unclear, or wrong, don't hesitate to let us know! You can reach the
885 current document maintainers by emailing
886 \begin_inset CommandInset href
888 target "lyx-docs@lists.lyx.org"
894 If you have questions that are not obviously answered in the documentation,
895 and need help fast, there is an active users' mailing list which you can
897 \begin_inset CommandInset href
899 target "lyx-users@lists.lyx.org"
907 \begin_layout Subsection
908 The Format of the Manuals
911 \begin_layout Standard
912 Some of you may have printed out the manuals.
913 Others may be reading them within \SpecialChar LyX
915 There are some differences between the \SpecialChar LyX
916 -file and the printed version.
918 , the title is simply at the top of the document, not formatted on a
919 separate page as in some of the printed versions.
920 Nor are any of the footnotes or the Table of Contents fully visible.
921 To open a footnote, which looks like this:
922 \begin_inset Graphics
923 filename clipart/footnoteQt4.png
928 , click on it with the left mouse button.
929 For the Table of Contents, either click on the grey box or click on the
934 menu, where the contents are displayed automatically\SpecialChar endofsentence
938 \begin_layout Standard
939 In the printed manuals, all cross-references appear as the actual numbers
940 for a chapter, section, subsection, and so on.
941 In the \SpecialChar LyX
942 -file, however, all cross-references appear as light-grey boxes
944 \begin_inset Graphics
945 filename clipart/referenceQt4.png
951 If you click on such a box with the left mouse button, a dialog box will
952 appear containing a list of all the cross-references in the document.
953 You can go to the referenced section by right-clicking on the box or by
966 in the opened dialog.
967 Going back to where you came from is just as easy.
976 to go back to your earlier location.
979 \begin_layout Standard
980 Now that we've cleared up some of the differences between the printed and
982 -file versions of this file, we can start looking at the format of this
984 You'll occasionally notice things in different fonts:
987 \begin_layout Itemize
992 is used for general emphasis, generic arguments, book titles, names of
993 sections of other manuals, and notes from the authors.
996 \begin_layout Itemize
1001 is used for program and file names, \SpecialChar LyX
1005 \begin_layout Itemize
1010 is used for menu, button, or dialog box names, and the names of keyboard
1014 \begin_layout Itemize
1019 is used for people's names.
1022 \begin_layout Itemize
1027 is used for \SpecialChar LaTeX
1031 \begin_layout Standard
1032 When we do need to reference keys, we'll use the following prefixing convention:
1035 \begin_layout Itemize
1036 \begin_inset Quotes eld
1044 \begin_inset Quotes erd
1054 \begin_layout Itemize
1055 \begin_inset Quotes eld
1063 \begin_inset Quotes erd
1073 \begin_layout Itemize
1074 \begin_inset Quotes eld
1082 \begin_inset Quotes erd
1096 \begin_layout Itemize
1097 \begin_inset Quotes eld
1105 \begin_inset Quotes erd
1110 \begin_inset Quotes eld
1118 \begin_inset Quotes erd
1121 are the function keys.
1124 \begin_layout Itemize
1125 \begin_inset Quotes eld
1133 \begin_inset Quotes erd
1139 \begin_layout Itemize
1140 \begin_inset Quotes eld
1148 \begin_inset Quotes erd
1152 \begin_inset Quotes eld
1160 \begin_inset Quotes erd
1164 \begin_inset Quotes eld
1172 \begin_inset Quotes erd
1176 \begin_inset Quotes eld
1184 \begin_inset Quotes erd
1190 \begin_layout Itemize
1193 \begin_inset Quotes eld
1199 \begin_inset Quotes erd
1203 \begin_inset Quotes eld
1211 \begin_inset Quotes erd
1215 \begin_inset Quotes eld
1223 \begin_inset Quotes erd
1227 \begin_inset Quotes eld
1235 \begin_inset Quotes erd
1239 \begin_inset Quotes eld
1247 \begin_inset Quotes erd
1251 \begin_inset Quotes eld
1259 \begin_inset Quotes erd
1262 : these are the 6 keys that appear above the cursor keys on many PC keyboards.
1264 \begin_inset Quotes eld
1272 \begin_inset Quotes erd
1276 \begin_inset Quotes eld
1284 \begin_inset Quotes erd
1288 \begin_inset Quotes eld
1296 \begin_inset Quotes erd
1300 \begin_inset Quotes eld
1308 \begin_inset Quotes erd
1314 \begin_layout Itemize
1323 both refer to the same key.
1324 Some keyboards label the
1329 \begin_inset Quotes eld
1333 \begin_inset Quotes erd
1337 \begin_inset Quotes eld
1341 \begin_inset Quotes erd
1344 still others have two keys.
1346 treats all of them as the same key, so we'll use
1357 \begin_layout Standard
1358 The list with the currently set shortcuts can be found in the
1369 \begin_layout Subsection
1370 Units used in the Manuals
1373 \begin_layout Standard
1374 To understand the units described in this documentation, Table
1375 \begin_inset space ~
1379 \begin_inset CommandInset ref
1381 reference "tab:Units"
1385 explains all units available in \SpecialChar LyX
1389 \begin_layout Standard
1390 \begin_inset Float table
1395 \begin_layout Plain Layout
1396 \begin_inset Caption Standard
1398 \begin_layout Plain Layout
1399 \begin_inset CommandInset label
1413 \begin_layout Plain Layout
1414 \begin_inset VSpace medskip
1420 \begin_layout Plain Layout
1422 \begin_inset Tabular
1423 <lyxtabular version="3" rows="20" columns="2">
1424 <features booktabs="true" tabularvalignment="middle">
1425 <column alignment="center" valignment="top" width="0pt">
1426 <column alignment="center" valignment="top">
1428 <cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
1431 \begin_layout Plain Layout
1437 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1440 \begin_layout Plain Layout
1448 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1451 \begin_layout Plain Layout
1457 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1460 \begin_layout Plain Layout
1468 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1471 \begin_layout Plain Layout
1477 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1480 \begin_layout Plain Layout
1488 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1491 \begin_layout Plain Layout
1497 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1500 \begin_layout Plain Layout
1502 \begin_inset space \thinspace{}
1506 \begin_inset space \thinspace{}
1516 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1519 \begin_layout Plain Layout
1525 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1528 \begin_layout Plain Layout
1530 \begin_inset space \thinspace{}
1534 \begin_inset space \thinspace{}
1544 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1547 \begin_layout Plain Layout
1553 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1556 \begin_layout Plain Layout
1558 \begin_inset space \thinspace{}
1562 \begin_inset space \thinspace{}
1572 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1575 \begin_layout Plain Layout
1581 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1584 \begin_layout Plain Layout
1586 \begin_inset space \thinspace{}
1590 \begin_inset space \thinspace{}
1600 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1603 \begin_layout Plain Layout
1609 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1612 \begin_layout Plain Layout
1614 \begin_inset space \thinspace{}
1618 \begin_inset space \thinspace{}
1628 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1631 \begin_layout Plain Layout
1637 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1640 \begin_layout Plain Layout
1642 \begin_inset space \thinspace{}
1646 \begin_inset Formula $\approx$
1650 \begin_inset space \thinspace{}
1660 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1663 \begin_layout Plain Layout
1669 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1672 \begin_layout Plain Layout
1674 \begin_inset space \thinspace{}
1678 \begin_inset space \thinspace{}
1688 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1691 \begin_layout Plain Layout
1697 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1700 \begin_layout Plain Layout
1701 % of original image width
1708 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1711 \begin_layout Plain Layout
1717 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1720 \begin_layout Plain Layout
1728 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1731 \begin_layout Plain Layout
1737 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1740 \begin_layout Plain Layout
1748 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1751 \begin_layout Plain Layout
1757 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1760 \begin_layout Plain Layout
1768 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1771 \begin_layout Plain Layout
1777 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1780 \begin_layout Plain Layout
1788 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1791 \begin_layout Plain Layout
1797 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1800 \begin_layout Plain Layout
1808 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1811 \begin_layout Plain Layout
1817 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1820 \begin_layout Plain Layout
1828 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1831 \begin_layout Plain Layout
1837 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1840 \begin_layout Plain Layout
1852 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1855 \begin_layout Plain Layout
1861 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1864 \begin_layout Plain Layout
1876 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1879 \begin_layout Plain Layout
1885 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1888 \begin_layout Plain Layout
1890 \begin_inset space \thinspace{}
1894 \begin_inset space \thinspace{}
1915 \begin_layout Subsection
1919 \begin_layout Standard
1920 The following list describes the contents of the basic documentation files
1921 that you find in the
1928 \begin_layout Description
1929 Introduction This file.
1932 \begin_layout Description
1933 Tutorial If you are new to \SpecialChar LyX
1934 , and have never used \SpecialChar LaTeX
1935 before, you should start
1937 If you have used \SpecialChar LaTeX
1938 before, you should still read the
1942 , starting with the section on
1943 \begin_inset Quotes eld
1947 for \SpecialChar LaTeX
1949 \begin_inset Quotes erd
1952 (Skimming through the rest of the document wouldn't hurt, either.)
1955 \begin_layout Description
1957 \begin_inset space ~
1960 Guide The primary documentation.
1965 of the basic operation and available features of \SpecialChar LyX
1967 The main manual assumes that you have read the
1974 \begin_layout Description
1976 \begin_inset space ~
1979 Objects Extension of the
1984 Documents in detail how to use tables, graphics, floats, notes, program
1986 It also includes many tricks of the \SpecialChar LaTeX
1990 \begin_layout Description
1991 Math Extension of the
1996 Documents in detail how to typeset any kind of formula.
1999 \begin_layout Description
2001 \begin_inset space ~
2004 Features Extension of the
2009 Documents how to use raw \SpecialChar LaTeX
2010 commands, additional layouts and special-purpose
2014 \begin_layout Description
2015 Customization A description of advanced \SpecialChar LyX
2016 features, including how to customize
2017 the overall behavior of \SpecialChar LyX
2018 \SpecialChar endofsentence
2019 This includes such things as keybindings, internationa
2020 lization and configuration files.
2021 It also includes information about layout files, which are needed to get
2023 to support \SpecialChar LaTeX
2024 classes or packages.
2027 \begin_layout Description
2028 Shortcuts Tables of the currently defined \SpecialChar LyX
2032 \begin_layout Description
2035 \begin_inset space ~
2038 Configuration A report produced by \SpecialChar LyX
2040 This file contains information on what \SpecialChar LyX
2041 learned about your installation.
2042 Check it to see if you're missing something you might like to have.
2045 \begin_layout Standard
2046 These files will reference one another as necessary.
2055 information on installation and customization, but refers the reader to
2058 Customization Manual
2060 for more information.
2063 \begin_layout Standard
2064 We'll state again an important point:
2067 \begin_layout Standard
2068 \begin_inset VSpace bigskip
2074 \begin_layout Standard
2076 If you are new to \SpecialChar LyX
2082 Now\SpecialChar endofsentence
2086 \begin_layout Standard
2087 \begin_inset VSpace bigskip
2093 \begin_layout Standard
2094 Otherwise, you could needlessly frustrate yourself.
2097 \begin_layout Section
2098 Contributing to the \SpecialChar LyX
2100 \begin_inset CommandInset label
2109 \begin_layout Subsection
2110 Contributing to \SpecialChar LyX
2114 \begin_layout Standard
2116 is mostly written in C++ (the \SpecialChar LaTeX
2117 importer is written in Python).
2118 It is a large project, and as a result it is not free from bugs, or the
2119 need for improvements in the source code.
2122 \begin_layout Subsubsection
2126 \begin_layout Standard
2127 While using \SpecialChar LyX
2128 , you may find behavior which you consider a bug.
2129 Crashes, though rare, can happen.
2130 User interface problems are considered major bugs by the \SpecialChar LyX
2132 helpful are indications of parts of the \SpecialChar LyX
2133 interface you find confusing,
2137 \begin_layout Standard
2139 has a bug tracking system, which you can find at
2142 \begin_inset Flex URL
2145 \begin_layout Plain Layout
2147 http://www.lyx.org/trac/wiki/BugTrackerHome
2155 You should check the bug tracker before reporting any bugs, in case it
2156 has already been reported.
2157 If you have a comment on an existing bug, or wish to report a new bug,
2158 you may either use the bug tracker, or send an e-mail to the development
2160 \begin_inset CommandInset href
2162 target "lyx-devel@lists.lyx.org"
2168 Archives of this list are linked from the main \SpecialChar LyX
2172 \begin_inset Flex URL
2175 \begin_layout Plain Layout
2187 \begin_layout Standard
2188 A useful bug report will at a minimum include the version of \SpecialChar LyX
2191 Accurate, detailed descriptions are preferred - the more time developers
2192 have to spend to pinpoint the source of a bug, the less time they have
2193 for other improvements.
2194 Mention the system and system version on which you are running \SpecialChar LyX
2196 Give the versions of the libraries you have installed on your system, and,
2197 if relevant, the versions of external programs that \SpecialChar LyX
2199 If it's a compilation or configuration problem, include the file
2203 , and mention which compiler you are using.
2206 \begin_layout Subsubsection
2207 Contributing fixes and new features
2210 \begin_layout Standard
2211 If you have made changes to \SpecialChar LyX
2212 's source that you think should become part
2214 , send your changes as a diff file (in unified format) to the development
2215 list referenced above, along with a change log, and a description of what
2219 \begin_layout Subsection
2220 Contributing to the Documentation
2223 \begin_layout Standard
2225 's documentation is extensive; however \SpecialChar LyX
2226 is under constant development, and
2227 each new release adds new features.
2228 You may find some documentation needs improvement.
2229 This section describes what to do if you find an error, or have some suggestion
2230 s for improving the documentation.
2233 \begin_layout Subsubsection
2234 Reporting Errors in the Manuals
2237 \begin_layout Standard
2238 If you find a problem with the documentation, send a message to the mailing
2240 \begin_inset CommandInset href
2242 target "lyx-docs@lists.lyx.org"
2248 The documentation team will make any necessary fixes.
2251 \begin_layout Subsubsection
2252 Joining the Documentation Team.
2255 \begin_layout Standard
2256 The \SpecialChar LyX
2257 Documentation Project, like anything else in the \SpecialChar LyX
2259 use assistance! If you're interested in contributing to the Documentation
2260 Project, you need to do the following:
2263 \begin_layout Enumerate
2264 Get the latest \SpecialChar LyX
2266 \begin_inset Newline newline
2270 \begin_inset Flex URL
2273 \begin_layout Plain Layout
2275 http://www.lyx.org/trac/browser/lyxgit/lib/doc?rev=master
2283 \begin_layout Enumerate
2293 \begin_inset Newline newline
2296 The point of this exercise is to give you ideas.
2305 are likely to be the most up-to-date of all of the documentation.
2306 You should be able to glean some insights into how we want the manuals
2307 to read and to look.
2310 \begin_layout Enumerate
2311 Contact the team at:
2312 \begin_inset Newline newline
2316 \begin_inset CommandInset href
2318 target "lyx-docs@lists.lyx.org"
2324 \begin_inset Newline newline
2327 to discuss your intended changes and to get some feedback on them.
2330 \begin_layout Standard
2331 The changes you wish to make may range from improving clarity of the text,
2332 to doing major re-structuring of the documentation.
2333 Any and all improvements are gladly received.