1 #LyX 2.3 created this file. For more info see http://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 %This preamble is designed to ensure that the document prints
12 % out as advertised. If you mess with this preamble,
13 % parts of the document may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC is numbered roman
19 % and a pdf-bookmark for the TOC is added
21 \let\myTOC\tableofcontents
22 \renewcommand\tableofcontents{%
23 \pdfbookmark[1]{\contentsname}{}
26 \pagenumbering{arabic} }
28 \use_default_options false
29 \maintain_unincluded_children false
31 \language_package default
34 \font_roman "palatino" "default"
35 \font_sans "helvet" "default"
36 \font_typewriter "courier" "default"
37 \font_math "auto" "auto"
38 \font_default_family default
39 \use_non_tex_fonts false
42 \font_sf_scale 100 100
43 \font_tt_scale 100 100
45 \use_dash_ligatures false
47 \default_output_format pdf2
49 \bibtex_command default
50 \index_command default
54 \pdf_title "Introduction to LyX"
55 \pdf_author "LyX Team"
56 \pdf_subject "LyX-documentation Intro"
57 \pdf_keywords "LyX, documentation"
59 \pdf_bookmarksnumbered true
60 \pdf_bookmarksopen true
61 \pdf_bookmarksopenlevel 2
66 \pdf_pdfusetitle false
67 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
70 \use_package amsmath 1
71 \use_package amssymb 1
74 \use_package mathdots 1
75 \use_package mathtools 0
77 \use_package stackrel 0
78 \use_package stmaryrd 0
79 \use_package undertilde 0
81 \cite_engine_type default
85 \paperorientation portrait
95 \paragraph_separation indent
96 \paragraph_indentation default
101 \paperpagestyle default
102 \tracking_changes false
103 \output_changes false
106 \html_be_strict false
112 Introduction to \SpecialChar LyX
117 by the \SpecialChar LyX
122 \begin_layout Plain Layout
124 If you have comments on or corrections to this documentation, please send
125 them to the \SpecialChar LyX
126 Documentation mailing list:
127 \begin_inset CommandInset href
129 target "lyx-docs@lists.lyx.org"
143 \begin_layout Standard
144 \begin_inset CommandInset toc
145 LatexCommand tableofcontents
152 \begin_layout Section
153 The Philosophy of \SpecialChar LyX
157 \begin_layout Subsection
158 What is \SpecialChar LyX
162 \begin_layout Standard
164 is a document preparation system.
165 It excels at letting you create complex technical and scientific articles
166 with mathematics, cross-references, bibliographies, indexes, etc.
167 It is very good for working with documents of any length in which the usual
168 processing abilities are required: automatic sectioning and pagination,
169 spell checking and so forth.
170 It can also be used to write a letter to your mom, though granted, there
171 are probably simpler programs available for that.
172 It is definitely not the best tool for creating banners, flyers, or advertiseme
173 nts (we'll explain why later), though with some effort all these can be
175 Here are some examples of what it is used for: memos, letters, dissertations
176 and theses, lecture notes, seminar notebooks, conference proceedings, software
177 documentation, books, articles in refereed scientific journals, scripts
178 for plays and movies, business proposals, presentations \SpecialChar ldots
182 \begin_layout Standard
184 is a program that provides a modern approach to writing documents with
185 a computer by using a markup language paradigm, an approach that breaks
186 with the obsolete tradition of the
187 \begin_inset Quotes eld
191 \begin_inset Quotes erd
195 It is designed for authors who want professional output quickly with a
196 minimum of effort and without becoming specialists in typesetting.
197 The job of typesetting is done mostly by the computer, not the author;
198 with \SpecialChar LyX
199 , the author can concentrate on the contents of his writing.
202 \begin_layout Standard
203 Part of the initial challenge of using \SpecialChar LyX
204 comes from the change in thinking
205 that you, the user, must make.
206 At one time, all we had for creating documents were typewriters, so we
207 all learned certain tricks to get around their limitations.
208 Underlining, which is little more than overstriking with the
209 \begin_inset Quotes eld
213 \begin_inset Quotes erd
216 character, became a way to emphasize text.
217 You were forced to figure out column sizes and tab stops, and set them,
218 before creating a table.
219 The same applied for letters and other right justified text.
220 Hyphenation at the end of a line required a careful eye and a lot of foresight.
223 \begin_layout Standard
224 In other words, we've all been trained to worry about the little details
225 of which character goes where.
226 Consequently, almost all word processors have this mentality.
227 They still use tab stops for adding whitespace.
228 You still need to worry about exactly where on the page something will
230 Emphasizing text means changing a font, similar to changing the typewriter
232 This is the underlying philosophy of a WYSIWYG word processor:
233 \begin_inset Quotes eld
236 What You See Is What You Get
237 \begin_inset Quotes erd
241 Unfortunately, that paradigm often results in
242 \begin_inset Quotes eld
245 What You See Is All You Get
246 \begin_inset Quotes erd
252 \begin_layout Standard
253 This is where \SpecialChar LyX
254 differs from an ordinary word processor.
255 You don't concern yourself with what character goes where.
256 You tell \SpecialChar LyX
262 takes care of the rest, following a set of rules called a
270 \begin_layout Plain Layout
271 To be fair, most recent versions of the most popular office suites now have
272 some sort of style sheets which follow a similar markup method.
273 However, our experience is that they are still rarely used in practice.
278 Let's look at a little example:
281 \begin_layout Standard
282 Suppose you are writing a report.
283 To begin your report, you want a section called
284 \begin_inset Quotes eld
287 Introduction\SpecialChar endofsentence
289 \begin_inset Quotes erd
292 So, you go into whatever menu it is in your word processor that changes
293 font sizes and decide on a new font size.
294 Then you turn on bold face.
296 \begin_inset Quotes eld
308 \begin_inset Quotes erd
312 Of course, if you later decide that this section belongs someplace else
313 in the document or if you insert a new section before it, you need to change
314 the numbering for this and all following sections, as well as any entry
315 in the table of contents.
318 \begin_layout Standard
320 , you go to the pull-down on the far left of the button bar and select
326 \begin_inset Quotes eld
330 \begin_inset Quotes erd
336 \begin_layout Standard
338 If you cut and paste the section, it will automatically be renumbered —
340 And if you enter references to that section correctly (by inserting cross-refer
341 ence tags), \SpecialChar LyX
342 will automatically update them all throughout the file so that
343 you never, ever type a section number.
346 \begin_layout Standard
347 Now let's look at the problem of consistency.
348 Five days later, you reopen your report and start Section
353 However, you forget that you were using 18
354 \begin_inset space \thinspace{}
357 pt bold instead of 16
358 \begin_inset space \thinspace{}
361 pt, so you type in the heading for Section
365 4 in a different font from the one you used for Section
370 That problem doesn't even exist in \SpecialChar LyX
372 The computer takes care of all that silly bookkeeping about which thing
373 has what size font, not you.
374 After all, that's what a computer is good at.
377 \begin_layout Standard
378 Here's another example.
379 Suppose you're making a list.
380 In other word processors, a list is just a bunch of tab stops and newlines.
381 You need to figure out where to put the label for each list item, what
382 that label should be, how many blank lines to put between each item, and
384 Under \SpecialChar LyX
385 , you have only two concerns: what kind of list is this, and what
386 do I want to put in it? That is it.
389 \begin_layout Standard
390 So, the basic idea behind \SpecialChar LyX
401 \begin_inset Quotes eld
404 What You See Is What You Get,
405 \begin_inset Quotes erd
410 \begin_inset Quotes eld
413 What You See Is What You
418 \begin_inset Quotes erd
422 \begin_inset Quotes eld
426 \begin_inset Quotes erd
429 It's a powerful idea that greatly simplifies the mechanics of writing documents.
430 This is also why \SpecialChar LyX
431 isn't so good for creating posters and flyers.
436 want to specify exactly where everything goes, because there are no functional
437 units like paragraphs, sections, etc.
438 This doesn't mean \SpecialChar LyX
439 is missing some cool function.
440 It simply means that it isn't the right tool for the job — you don't use
441 a screwdriver to drive in nails.
444 \begin_layout Subsection
445 Differences between \SpecialChar LyX
446 and Other Word Processors
447 \begin_inset Argument 1
450 \begin_layout Plain Layout
454 \begin_layout Plain Layout
468 \begin_layout Plain Layout
475 and Other Word Processors
483 \begin_layout Standard
484 Here's a list of things you won't find in \SpecialChar LyX
488 \begin_layout Itemize
492 \begin_layout Itemize
496 \begin_layout Itemize
498 \begin_inset space \thinspace{}
502 \begin_inset space \space{}
516 \begin_layout Standard
517 Tab stops, along with a ruler showing you the position of things on the
518 page, are useless in \SpecialChar LyX
520 The program worries about where things go on the page, not you.
521 Extra whitespace is similar; \SpecialChar LyX
522 adds it where necessary, depending on context.
523 Not being able to type two blank lines in a row will be annoying at first,
524 but it makes more sense once you're thinking in WYSIWYM terms.
527 \begin_layout Standard
528 Here are some things that exist in \SpecialChar LyX
529 , but aren't used as you might think:
532 \begin_layout Itemize
536 \begin_layout Itemize
540 \begin_layout Itemize
542 \begin_inset space \thinspace{}
546 \begin_inset space \space{}
549 single spaced, double spaced, etc.)
552 \begin_layout Itemize
553 Whitespace, horizontal and vertical
556 \begin_layout Itemize
560 \begin_layout Itemize
561 Typefaces (bold, italic, underline, etc.)
564 \begin_layout Standard
565 Although they exist in \SpecialChar LyX
566 , you generally don't need them.
568 will take care of these things for you, depending on what you're doing.
569 Different parts of the document are automatically set in a different typeface
571 Paragraph indenting is context dependent; different types of paragraphs
572 get indented differently.
573 Page breaks get handled automatically, as well.
574 In general, the space between lines, between words, and between paragraphs
575 is variable, set by \SpecialChar LyX
580 \begin_layout Plain Layout
581 There are ways to adjust all of these (only some of which require knowledge
582 of \SpecialChar LaTeX
583 ), either for a whole document or for a specific location in a document.
600 \begin_layout Standard
601 Lastly, there are a few areas where we believe \SpecialChar LyX
602 (and \SpecialChar LaTeX
603 ) surpasses many word
607 \begin_layout Itemize
611 \begin_layout Itemize
615 \begin_layout Itemize
619 \begin_layout Itemize
623 \begin_layout Itemize
627 \begin_layout Standard
628 Granted, many modern word processors can handle mathematical symbols, tables,
629 and hyphenation, and many have moved towards style definitions and the
631 However, they've only recently been able to do so, whereas \SpecialChar LyX
633 the \SpecialChar LaTeX
634 document preparation system.
636 has been around since 1985, and
643 \begin_layout Subsection
644 What is \SpecialChar LaTeX
648 \begin_layout Standard
650 is a document preparation system designed by Leslie Lamport in 1985.
654 \begin_layout Plain Layout
655 The source for the info in this section is
657 A Guide to \SpecialChar LaTeX2e
660 , by Helmut Kopka and Patrick Daly, which has an entry in the bibliography
665 \SpecialChar endofsentence
671 It was built up from a typesetting language called \SpecialChar TeX
675 takes a sequence of typesetting commands, written in a script in an ASCII
676 file, and executes them.
678 \begin_inset Quotes eld
682 \begin_inset Quotes erd
685 of the printing trade were modeled by Knuth as computer algorithms and
686 incorporated into \SpecialChar TeX
687 , hence its excellent printed appearance.
688 What comes directly out of \SpecialChar TeX
689 is the portable document format
694 \begin_inset Quotes eld
698 \begin_inset Quotes erd
706 The dvi format is often used for previews and can later be converted to
707 other formats like PostScript.
711 \begin_layout Standard
713 isn't only a typesetting engine; it also allows you to define macros.
714 Most people who use \SpecialChar TeX
715 are actually using a macro package which Knuth created
716 to hide a lot of the typesetting details.
717 This is where Leslie Lamport enters our story.
718 He wanted a macro package that was more user- and less typesetter-oriented,
719 with a set of commands that consistently typeset things like sections,
720 tables or math formulas in a uniform, consistent fashion.
721 This is how \SpecialChar LaTeX
725 \begin_layout Standard
726 Now, in parallel with the development and growth of \SpecialChar LaTeX
727 , other folks were creating
728 their own custom macro packages for \SpecialChar TeX
729 , ones to make slides or articles for
730 math journals and so on.
731 Some used the raw \SpecialChar TeX
732 facilities to do this, others began modifying \SpecialChar LaTeX
734 To try and unify this mess, a team of \SpecialChar LaTeX
735 -nicians began to work on \SpecialChar LaTeX2e
737 version of \SpecialChar LaTeX
738 , during the late 1980's.
739 This new version of \SpecialChar LaTeX
740 has commands which provide an easier-to-use interface
742 's macro-creating commands, aid in the use of new fonts, and so on.
743 In fact, \SpecialChar LaTeX
744 is quite an extensive language in its own right! Users around
745 the world have been creating their own add-ons for \SpecialChar LaTeX
750 \begin_layout Standard
751 There are two ways to extend \SpecialChar LaTeX
752 : classes and styles.
757 is a set of \SpecialChar LaTeX
758 macros describing a new type of document, like a book, or
760 There are classes for slides, for physics and math journals\SpecialChar ldots
762 even have a class for their thesis format.
767 differs from a class in that it doesn't define a new type of document,
768 but a different type of
772 that any document can use.
773 For example, \SpecialChar LyX
774 controls page margins and line spacing using two different
776 style-files designed for these purposes.
777 There are style-files for a whole slew of things: printing labels or envelopes,
778 changing indentation behavior, adding new fonts, manipulating graphics,
779 designing fancy page headings, customizing bibliographies, altering the
780 location and appearance of footnotes, tables, and figures, customizing
784 \begin_layout Standard
788 \begin_layout Description
790 : Typesetting language with macro capability.
793 \begin_layout Description
795 : Macro package built upon \SpecialChar TeX
796 \SpecialChar endofsentence
800 \begin_layout Description
801 classes: Descriptions of types of document used with \SpecialChar LaTeX
802 \SpecialChar endofsentence
806 \begin_layout Description
807 styles: Descriptions of the default behavior of particular elements of \SpecialChar LaTeX
811 \begin_layout Description
813 : Visual, WYSIWYM document processor that uses \SpecialChar LaTeX
814 to do its typesetting.
817 \begin_layout Standard
818 This section attempts to explain the difference between \SpecialChar LyX
819 and a word processor.
820 Simply put, \SpecialChar LaTeX
822 By using \SpecialChar LaTeX
823 as its backend, \SpecialChar LyX
824 helps you to think more about
833 The computer then handles
840 \begin_layout Section
841 Navigating the Documentation
844 \begin_layout Standard
845 To make it easier to answer your questions and describe all of the features
847 , the documentation has been split up into several different files.
848 Each one has its own purpose, as described below.
849 Before you go ploughing into any of those files, however, you should read
850 this chapter thoroughly, since it contains a lot of useful information
851 and commentary that can save you some time.
854 \begin_layout Standard
855 Hopefully, the development of \SpecialChar LyX
856 will never stop; so some of the documentation
857 may be incomplete or a bit out of date, though we try to keep up-to-date.
858 Like the rest of \SpecialChar LyX
859 , the manuals are the work of a group of volunteers who
861 \begin_inset Quotes eld
865 \begin_inset Quotes erd
868 , families, dishes to clean,
873 If you want to help out, be sure to read Section
878 \begin_inset CommandInset ref
880 reference "sec:Contrib"
884 in addition to the rest of this document.
887 \begin_layout Standard
888 Also, please do us a favor – if anything in these manuals confuses you,
889 is unclear, or wrong, don't hesitate to let us know! You can reach the
890 current document maintainers by emailing
891 \begin_inset CommandInset href
893 target "lyx-docs@lists.lyx.org"
900 If you have questions that are not obviously answered in the documentation,
901 and need help fast, there is an active users' mailing list which you can
903 \begin_inset CommandInset href
905 target "lyx-users@lists.lyx.org"
914 \begin_layout Subsection
915 The Format of the Manuals
918 \begin_layout Standard
919 Some of you may have printed out the manuals.
920 Others may be reading them within \SpecialChar LyX
922 There are some differences between the \SpecialChar LyX
923 -file and the printed version.
925 , the title is simply at the top of the document, not formatted on a
926 separate page as in some of the printed versions.
927 Nor are any of the footnotes or the Table of Contents fully visible.
928 To open a footnote, which looks like this:
929 \begin_inset Graphics
930 filename clipart/footnote.png
935 , click on it with the left mouse button.
936 For the Table of Contents, either click on the grey box or click on the
941 menu, where the contents are displayed automatically\SpecialChar endofsentence
945 \begin_layout Standard
946 In the printed manuals, all cross-references appear as the actual numbers
947 for a chapter, section, subsection, and so on.
948 In the \SpecialChar LyX
949 -file, however, all cross-references appear as light-grey boxes
951 \begin_inset Graphics
952 filename clipart/reference.png
958 If you click on such a box with the left mouse button, a dialog box will
959 appear containing a list of all the cross-references in the document.
960 You can go to the referenced section by right-clicking on the box or by
973 in the opened dialog.
974 Going back to where you came from is just as easy.
983 to go back to your earlier location.
986 \begin_layout Standard
987 Now that we've cleared up some of the differences between the printed and
989 -file versions of this file, we can start looking at the format of this
991 You'll occasionally notice things in different fonts:
994 \begin_layout Itemize
999 is used for general emphasis, generic arguments, book titles, names of
1000 sections of other manuals, and notes from the authors.
1003 \begin_layout Itemize
1008 is used for program and file names, \SpecialChar LyX
1012 \begin_layout Itemize
1017 is used for menu, button, or dialog box names, and the names of keyboard
1021 \begin_layout Itemize
1026 is used for people's names.
1029 \begin_layout Itemize
1034 is used for \SpecialChar LaTeX
1038 \begin_layout Standard
1039 When we do need to reference keys, we'll use the following prefixing convention:
1042 \begin_layout Itemize
1043 \begin_inset Quotes eld
1051 \begin_inset Quotes erd
1061 \begin_layout Itemize
1062 \begin_inset Quotes eld
1070 \begin_inset Quotes erd
1080 \begin_layout Itemize
1081 \begin_inset Quotes eld
1089 \begin_inset Quotes erd
1103 \begin_layout Itemize
1104 \begin_inset Quotes eld
1112 \begin_inset Quotes erd
1117 \begin_inset Quotes eld
1125 \begin_inset Quotes erd
1128 are the function keys.
1131 \begin_layout Itemize
1132 \begin_inset Quotes eld
1140 \begin_inset Quotes erd
1146 \begin_layout Itemize
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
1200 \begin_inset Quotes eld
1206 \begin_inset Quotes erd
1210 \begin_inset Quotes eld
1218 \begin_inset Quotes erd
1222 \begin_inset Quotes eld
1230 \begin_inset Quotes erd
1234 \begin_inset Quotes eld
1242 \begin_inset Quotes erd
1246 \begin_inset Quotes eld
1254 \begin_inset Quotes erd
1258 \begin_inset Quotes eld
1266 \begin_inset Quotes erd
1269 : these are the 6 keys that appear above the cursor keys on many PC keyboards.
1271 \begin_inset Quotes eld
1279 \begin_inset Quotes erd
1283 \begin_inset Quotes eld
1291 \begin_inset Quotes erd
1295 \begin_inset Quotes eld
1303 \begin_inset Quotes erd
1307 \begin_inset Quotes eld
1315 \begin_inset Quotes erd
1321 \begin_layout Itemize
1330 both refer to the same key.
1331 Some keyboards label the
1336 \begin_inset Quotes eld
1340 \begin_inset Quotes erd
1344 \begin_inset Quotes eld
1348 \begin_inset Quotes erd
1351 still others have two keys.
1353 treats all of them as the same key, so we'll use
1364 \begin_layout Standard
1365 The list with the currently set shortcuts can be found in the
1376 \begin_layout Subsection
1377 Units used in the Manuals
1380 \begin_layout Standard
1381 To understand the units described in this documentation, Table
1382 \begin_inset space ~
1386 \begin_inset CommandInset ref
1388 reference "tab:Units"
1392 explains all units available in \SpecialChar LyX
1396 \begin_layout Standard
1397 \begin_inset Float table
1402 \begin_layout Plain Layout
1403 \begin_inset Caption Standard
1405 \begin_layout Plain Layout
1406 \begin_inset CommandInset label
1420 \begin_layout Plain Layout
1421 \begin_inset VSpace medskip
1427 \begin_layout Plain Layout
1429 \begin_inset Tabular
1430 <lyxtabular version="3" rows="20" columns="2">
1431 <features booktabs="true" tabularvalignment="middle">
1432 <column alignment="center" valignment="top" width="0pt">
1433 <column alignment="center" valignment="top">
1435 <cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
1438 \begin_layout Plain Layout
1444 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1447 \begin_layout Plain Layout
1455 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1458 \begin_layout Plain Layout
1464 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1467 \begin_layout Plain Layout
1475 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1478 \begin_layout Plain Layout
1484 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1487 \begin_layout Plain Layout
1495 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1498 \begin_layout Plain Layout
1504 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1507 \begin_layout Plain Layout
1509 \begin_inset space \thinspace{}
1513 \begin_inset space \thinspace{}
1523 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1526 \begin_layout Plain Layout
1532 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1535 \begin_layout Plain Layout
1537 \begin_inset space \thinspace{}
1541 \begin_inset space \thinspace{}
1551 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1554 \begin_layout Plain Layout
1560 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1563 \begin_layout Plain Layout
1565 \begin_inset space \thinspace{}
1569 \begin_inset space \thinspace{}
1579 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1582 \begin_layout Plain Layout
1588 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1591 \begin_layout Plain Layout
1593 \begin_inset space \thinspace{}
1597 \begin_inset space \thinspace{}
1607 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1610 \begin_layout Plain Layout
1616 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1619 \begin_layout Plain Layout
1621 \begin_inset space \thinspace{}
1625 \begin_inset space \thinspace{}
1635 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1638 \begin_layout Plain Layout
1644 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1647 \begin_layout Plain Layout
1649 \begin_inset space \thinspace{}
1653 \begin_inset Formula $\approx$
1657 \begin_inset space \thinspace{}
1667 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1670 \begin_layout Plain Layout
1676 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1679 \begin_layout Plain Layout
1681 \begin_inset space \thinspace{}
1685 \begin_inset space \thinspace{}
1695 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1698 \begin_layout Plain Layout
1704 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1707 \begin_layout Plain Layout
1708 % of original image width
1715 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1718 \begin_layout Plain Layout
1724 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1727 \begin_layout Plain Layout
1735 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1738 \begin_layout Plain Layout
1744 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1747 \begin_layout Plain Layout
1755 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1758 \begin_layout Plain Layout
1764 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1767 \begin_layout Plain Layout
1775 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1778 \begin_layout Plain Layout
1784 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1787 \begin_layout Plain Layout
1795 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1798 \begin_layout Plain Layout
1804 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1807 \begin_layout Plain Layout
1815 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1818 \begin_layout Plain Layout
1824 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1827 \begin_layout Plain Layout
1835 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1838 \begin_layout Plain Layout
1844 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1847 \begin_layout Plain Layout
1859 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1862 \begin_layout Plain Layout
1868 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1871 \begin_layout Plain Layout
1883 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1886 \begin_layout Plain Layout
1892 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1895 \begin_layout Plain Layout
1897 \begin_inset space \thinspace{}
1901 \begin_inset space \thinspace{}
1922 \begin_layout Subsection
1926 \begin_layout Standard
1927 The following list describes the contents of the basic documentation files
1928 that you find in the
1935 \begin_layout Description
1936 Introduction This file.
1939 \begin_layout Description
1940 Tutorial If you are new to \SpecialChar LyX
1941 , and have never used \SpecialChar LaTeX
1942 before, you should start
1944 If you have used \SpecialChar LaTeX
1945 before, you should still read the
1949 , starting with the section on
1950 \begin_inset Quotes eld
1954 for \SpecialChar LaTeX
1956 \begin_inset Quotes erd
1959 (Skimming through the rest of the document wouldn't hurt, either.)
1962 \begin_layout Description
1964 \begin_inset space ~
1967 Guide The primary documentation.
1972 of the basic operation and available features of \SpecialChar LyX
1974 The main manual assumes that you have read the
1981 \begin_layout Description
1983 \begin_inset space ~
1986 Objects Extension of the
1991 Documents in detail how to use tables, graphics, floats, notes, program
1993 It also includes many tricks of the \SpecialChar LaTeX
1997 \begin_layout Description
1998 Math Extension of the
2003 Documents in detail how to typeset any kind of formula.
2006 \begin_layout Description
2008 \begin_inset space ~
2011 Features Extension of the
2016 Documents how to use raw \SpecialChar LaTeX
2017 commands, additional layouts and special-purpose
2021 \begin_layout Description
2022 Customization A description of advanced \SpecialChar LyX
2023 features, including how to customize
2024 the overall behavior of \SpecialChar LyX
2025 \SpecialChar endofsentence
2026 This includes such things as keybindings, internationa
2027 lization and configuration files.
2028 It also includes information about layout files, which are needed to get
2030 to support \SpecialChar LaTeX
2031 classes or packages.
2034 \begin_layout Description
2035 Shortcuts Tables of the currently defined \SpecialChar LyX
2039 \begin_layout Description
2042 \begin_inset space ~
2045 Configuration A report produced by \SpecialChar LyX
2047 This file contains information on what \SpecialChar LyX
2048 learned about your installation.
2049 Check it to see if you're missing something you might like to have.
2052 \begin_layout Standard
2053 These files will reference one another as necessary.
2062 information on installation and customization, but refers the reader to
2065 Customization Manual
2067 for more information.
2070 \begin_layout Standard
2071 We'll state again an important point:
2074 \begin_layout Standard
2075 \begin_inset VSpace bigskip
2081 \begin_layout Standard
2083 If you are new to \SpecialChar LyX
2089 Now\SpecialChar endofsentence
2093 \begin_layout Standard
2094 \begin_inset VSpace bigskip
2100 \begin_layout Standard
2101 Otherwise, you could needlessly frustrate yourself.
2104 \begin_layout Section
2105 Contributing to the \SpecialChar LyX
2107 \begin_inset CommandInset label
2116 \begin_layout Subsection
2117 Contributing to \SpecialChar LyX
2121 \begin_layout Standard
2123 is mostly written in C++ (the \SpecialChar LaTeX
2124 importer is written in Python).
2125 It is a large project, and as a result it is not free from bugs, or the
2126 need for improvements in the source code.
2129 \begin_layout Subsubsection
2133 \begin_layout Standard
2134 While using \SpecialChar LyX
2135 , you may find behavior which you consider a bug.
2136 Crashes, though rare, can happen.
2137 User interface problems are considered major bugs by the \SpecialChar LyX
2139 helpful are indications of parts of the \SpecialChar LyX
2140 interface you find confusing,
2144 \begin_layout Standard
2146 has a bug tracking system, which you can find at
2149 \begin_inset Flex URL
2152 \begin_layout Plain Layout
2154 http://www.lyx.org/trac/wiki/BugTrackerHome
2162 You should check the bug tracker before reporting any bugs, in case it
2163 has already been reported.
2164 If you have a comment on an existing bug, or wish to report a new bug,
2165 you may either use the bug tracker, or send an e-mail to the development
2167 \begin_inset CommandInset href
2169 target "lyx-devel@lists.lyx.org"
2176 Archives of this list are linked from the main \SpecialChar LyX
2180 \begin_inset Flex URL
2183 \begin_layout Plain Layout
2195 \begin_layout Standard
2196 A useful bug report will at a minimum include the version of \SpecialChar LyX
2199 Accurate, detailed descriptions are preferred - the more time developers
2200 have to spend to pinpoint the source of a bug, the less time they have
2201 for other improvements.
2202 Mention the system and system version on which you are running \SpecialChar LyX
2204 Give the versions of the libraries you have installed on your system, and,
2205 if relevant, the versions of external programs that \SpecialChar LyX
2207 If it's a compilation or configuration problem, include the file
2211 , and mention which compiler you are using.
2214 \begin_layout Subsubsection
2215 Contributing fixes and new features
2218 \begin_layout Standard
2219 If you have made changes to \SpecialChar LyX
2220 's source that you think should become part
2222 , send your changes as a diff file (in unified format) to the development
2223 list referenced above, along with a change log, and a description of what
2227 \begin_layout Subsection
2228 Contributing to the Documentation
2231 \begin_layout Standard
2233 's documentation is extensive; however \SpecialChar LyX
2234 is under constant development, and
2235 each new release adds new features.
2236 You may find some documentation needs improvement.
2237 This section describes what to do if you find an error, or have some suggestion
2238 s for improving the documentation.
2241 \begin_layout Subsubsection
2242 Reporting Errors in the Manuals
2245 \begin_layout Standard
2246 If you find a problem with the documentation, send a message to the mailing
2248 \begin_inset CommandInset href
2250 target "lyx-docs@lists.lyx.org"
2257 The documentation team will make any necessary fixes.
2260 \begin_layout Subsubsection
2261 Joining the Documentation Team.
2264 \begin_layout Standard
2265 The \SpecialChar LyX
2266 Documentation Project, like anything else in the \SpecialChar LyX
2268 use assistance! If you're interested in contributing to the Documentation
2269 Project, you need to do the following:
2272 \begin_layout Enumerate
2273 Get the latest \SpecialChar LyX
2275 \begin_inset Newline newline
2279 \begin_inset Flex URL
2282 \begin_layout Plain Layout
2284 http://www.lyx.org/trac/browser/lyxgit/lib/doc?rev=master
2292 \begin_layout Enumerate
2302 \begin_inset Newline newline
2305 The point of this exercise is to give you ideas.
2314 are likely to be the most up-to-date of all of the documentation.
2315 You should be able to glean some insights into how we want the manuals
2316 to read and to look.
2319 \begin_layout Enumerate
2320 Contact the team at:
2321 \begin_inset Newline newline
2325 \begin_inset CommandInset href
2327 target "lyx-docs@lists.lyx.org"
2334 \begin_inset Newline newline
2337 to discuss your intended changes and to get some feedback on them.
2340 \begin_layout Standard
2341 The changes you wish to make may range from improving clarity of the text,
2342 to doing major re-structuring of the documentation.
2343 Any and all improvements are gladly received.