1 #LyX 2.2 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 \default_output_format pdf2
47 \bibtex_command default
48 \index_command default
52 \pdf_title "Introduction to LyX"
53 \pdf_author "LyX Team"
54 \pdf_subject "LyX-documentation Intro"
55 \pdf_keywords "LyX, documentation"
57 \pdf_bookmarksnumbered true
58 \pdf_bookmarksopen true
59 \pdf_bookmarksopenlevel 2
64 \pdf_pdfusetitle false
65 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
68 \use_package amsmath 1
69 \use_package amssymb 1
72 \use_package mathdots 1
73 \use_package mathtools 1
75 \use_package stackrel 1
76 \use_package stmaryrd 1
77 \use_package undertilde 1
79 \cite_engine_type default
83 \paperorientation portrait
93 \paragraph_separation indent
94 \paragraph_indentation default
95 \quotes_language english
98 \paperpagestyle default
99 \tracking_changes false
100 \output_changes false
103 \html_be_strict false
109 Introduction to \SpecialChar LyX
114 by the \SpecialChar LyX
119 \begin_layout Plain Layout
121 If you have comments on or corrections to this documentation, please send
122 them to the \SpecialChar LyX
123 Documentation mailing list:
124 \begin_inset CommandInset href
126 target "lyx-docs@lists.lyx.org"
139 \begin_layout Standard
140 \begin_inset CommandInset toc
141 LatexCommand tableofcontents
148 \begin_layout Section
149 The Philosophy of \SpecialChar LyX
153 \begin_layout Subsection
154 What is \SpecialChar LyX
158 \begin_layout Standard
160 is a document preparation system.
161 It excels at letting you create complex technical and scientific articles
162 with mathematics, cross-references, bibliographies, indexes, etc.
163 It is very good for working with documents of any length in which the usual
164 processing abilities are required: automatic sectioning and pagination,
165 spell checking and so forth.
166 It can also be used to write a letter to your mom, though granted, there
167 are probably simpler programs available for that.
168 It is definitely not the best tool for creating banners, flyers, or advertiseme
169 nts (we'll explain why later), though with some effort all these can be
171 Here are some examples of what it is used for: memos, letters, dissertations
172 and theses, lecture notes, seminar notebooks, conference proceedings, software
173 documentation, books, articles in refereed scientific journals, scripts
174 for plays and movies, business proposals, presentations \SpecialChar ldots
178 \begin_layout Standard
180 is a program that provides a modern approach to writing documents with
181 a computer by using a markup language paradigm, an approach that breaks
182 with the obsolete tradition of the
183 \begin_inset Quotes eld
187 \begin_inset Quotes erd
191 It is designed for authors who want professional output quickly with a
192 minimum of effort and without becoming specialists in typesetting.
193 The job of typesetting is done mostly by the computer, not the author;
194 with \SpecialChar LyX
195 , the author can concentrate on the contents of his writing.
198 \begin_layout Standard
199 Part of the initial challenge of using \SpecialChar LyX
200 comes from the change in thinking
201 that you, the user, must make.
202 At one time, all we had for creating documents were typewriters, so we
203 all learned certain tricks to get around their limitations.
204 Underlining, which is little more than overstriking with the
205 \begin_inset Quotes eld
209 \begin_inset Quotes erd
212 character, became a way to emphasize text.
213 You were forced to figure out column sizes and tab stops, and set them,
214 before creating a table.
215 The same applied for letters and other right justified text.
216 Hyphenation at the end of a line required a careful eye and a lot of foresight.
219 \begin_layout Standard
220 In other words, we've all been trained to worry about the little details
221 of which character goes where.
222 Consequently, almost all word processors have this mentality.
223 They still use tab stops for adding whitespace.
224 You still need to worry about exactly where on the page something will
226 Emphasizing text means changing a font, similar to changing the typewriter
228 This is the underlying philosophy of a WYSIWYG word processor:
229 \begin_inset Quotes eld
232 What You See Is What You Get
233 \begin_inset Quotes erd
237 Unfortunately, that paradigm often results in
238 \begin_inset Quotes eld
241 What You See Is All You Get
242 \begin_inset Quotes erd
248 \begin_layout Standard
249 This is where \SpecialChar LyX
250 differs from an ordinary word processor.
251 You don't concern yourself with what character goes where.
252 You tell \SpecialChar LyX
258 takes care of the rest, following a set of rules called a
266 \begin_layout Plain Layout
267 To be fair, most recent versions of the most popular office suites now have
268 some sort of style sheets which follow a similar markup method.
269 However, our experience is that they are still rarely used in practice.
274 Let's look at a little example:
277 \begin_layout Standard
278 Suppose you are writing a report.
279 To begin your report, you want a section called
280 \begin_inset Quotes eld
283 Introduction\SpecialChar endofsentence
285 \begin_inset Quotes erd
288 So, you go into whatever menu it is in your word processor that changes
289 font sizes and decide on a new font size.
290 Then you turn on bold face.
292 \begin_inset Quotes eld
304 \begin_inset Quotes erd
308 Of course, if you later decide that this section belongs someplace else
309 in the document or if you insert a new section before it, you need to change
310 the numbering for this and all following sections, as well as any entry
311 in the table of contents.
314 \begin_layout Standard
316 , you go to the pull-down on the far left of the button bar and select
322 \begin_inset Quotes eld
326 \begin_inset Quotes erd
332 \begin_layout Standard
334 If you cut and paste the section, it will automatically be renumbered —
336 And if you enter references to that section correctly (by inserting cross-refer
337 ence tags), \SpecialChar LyX
338 will automatically update them all throughout the file so that
339 you never, ever type a section number.
342 \begin_layout Standard
343 Now let's look at the problem of consistency.
344 Five days later, you reopen your report and start Section
349 However, you forget that you were using 18
350 \begin_inset space \thinspace{}
353 pt bold instead of 16
354 \begin_inset space \thinspace{}
357 pt, so you type in the heading for Section
361 4 in a different font from the one you used for Section
366 That problem doesn't even exist in \SpecialChar LyX
368 The computer takes care of all that silly bookkeeping about which thing
369 has what size font, not you.
370 After all, that's what a computer is good at.
373 \begin_layout Standard
374 Here's another example.
375 Suppose you're making a list.
376 In other word processors, a list is just a bunch of tab stops and newlines.
377 You need to figure out where to put the label for each list item, what
378 that label should be, how many blank lines to put between each item, and
380 Under \SpecialChar LyX
381 , you have only two concerns: what kind of list is this, and what
382 do I want to put in it? That is it.
385 \begin_layout Standard
386 So, the basic idea behind \SpecialChar LyX
397 \begin_inset Quotes eld
400 What You See Is What You Get,
401 \begin_inset Quotes erd
406 \begin_inset Quotes eld
409 What You See Is What You
414 \begin_inset Quotes erd
418 \begin_inset Quotes eld
422 \begin_inset Quotes erd
425 It's a powerful idea that greatly simplifies the mechanics of writing documents.
426 This is also why \SpecialChar LyX
427 isn't so good for creating posters and flyers.
432 want to specify exactly where everything goes, because there are no functional
433 units like paragraphs, sections, etc.
434 This doesn't mean \SpecialChar LyX
435 is missing some cool function.
436 It simply means that it isn't the right tool for the job — you don't use
437 a screwdriver to drive in nails.
440 \begin_layout Subsection
441 Differences between \SpecialChar LyX
442 and Other Word Processors
443 \begin_inset Argument 1
446 \begin_layout Plain Layout
450 \begin_layout Plain Layout
464 \begin_layout Plain Layout
471 and Other Word Processors
479 \begin_layout Standard
480 Here's a list of things you won't find in \SpecialChar LyX
484 \begin_layout Itemize
488 \begin_layout Itemize
492 \begin_layout Itemize
494 \begin_inset space \thinspace{}
498 \begin_inset space \space{}
512 \begin_layout Standard
513 Tab stops, along with a ruler showing you the position of things on the
514 page, are useless in \SpecialChar LyX
516 The program worries about where things go on the page, not you.
517 Extra whitespace is similar; \SpecialChar LyX
518 adds it where necessary, depending on context.
519 Not being able to type two blank lines in a row will be annoying at first,
520 but it makes more sense once you're thinking in WYSIWYM terms.
523 \begin_layout Standard
524 Here are some things that exist in \SpecialChar LyX
525 , but aren't used as you might think:
528 \begin_layout Itemize
532 \begin_layout Itemize
536 \begin_layout Itemize
538 \begin_inset space \thinspace{}
542 \begin_inset space \space{}
545 single spaced, double spaced, etc.)
548 \begin_layout Itemize
549 Whitespace, horizontal and vertical
552 \begin_layout Itemize
556 \begin_layout Itemize
557 Typefaces (bold, italic, underline, etc.)
560 \begin_layout Standard
561 Although they exist in \SpecialChar LyX
562 , you generally don't need them.
564 will take care of these things for you, depending on what you're doing.
565 Different parts of the document are automatically set in a different typeface
567 Paragraph indenting is context dependent; different types of paragraphs
568 get indented differently.
569 Page breaks get handled automatically, as well.
570 In general, the space between lines, between words, and between paragraphs
571 is variable, set by \SpecialChar LyX
576 \begin_layout Plain Layout
577 There are ways to adjust all of these (only some of which require knowledge
578 of \SpecialChar LaTeX
579 ), either for a whole document or for a specific location in a document.
596 \begin_layout Standard
597 Lastly, there are a few areas where we believe \SpecialChar LyX
598 (and \SpecialChar LaTeX
599 ) surpasses many word
603 \begin_layout Itemize
607 \begin_layout Itemize
611 \begin_layout Itemize
615 \begin_layout Itemize
619 \begin_layout Itemize
623 \begin_layout Standard
624 Granted, many modern word processors can handle mathematical symbols, tables,
625 and hyphenation, and many have moved towards style definitions and the
627 However, they've only recently been able to do so, whereas \SpecialChar LyX
629 the \SpecialChar LaTeX
630 document preparation system.
632 has been around since 1985, and
639 \begin_layout Subsection
640 What is \SpecialChar LaTeX
644 \begin_layout Standard
646 is a document preparation system designed by Leslie Lamport in 1985.
650 \begin_layout Plain Layout
651 The source for the info in this section is
653 A Guide to \SpecialChar LaTeX2e
656 , by Helmut Kopka and Patrick Daly, which has an entry in the bibliography
661 \SpecialChar endofsentence
667 It was built up from a typesetting language called \SpecialChar TeX
671 takes a sequence of typesetting commands, written in a script in an ASCII
672 file, and executes them.
674 \begin_inset Quotes eld
678 \begin_inset Quotes erd
681 of the printing trade were modeled by Knuth as computer algorithms and
682 incorporated into \SpecialChar TeX
683 , hence its excellent printed appearance.
684 What comes directly out of \SpecialChar TeX
685 is the portable document format
690 \begin_inset Quotes eld
694 \begin_inset Quotes erd
702 The dvi format is often used for previews and can later be converted to
703 other formats like PostScript.
707 \begin_layout Standard
709 isn't only a typesetting engine; it also allows you to define macros.
710 Most people who use \SpecialChar TeX
711 are actually using a macro package which Knuth created
712 to hide a lot of the typesetting details.
713 This is where Leslie Lamport enters our story.
714 He wanted a macro package that was more user- and less typesetter-oriented,
715 with a set of commands that consistently typeset things like sections,
716 tables or math formulas in a uniform, consistent fashion.
717 This is how \SpecialChar LaTeX
721 \begin_layout Standard
722 Now, in parallel with the development and growth of \SpecialChar LaTeX
723 , other folks were creating
724 their own custom macro packages for \SpecialChar TeX
725 , ones to make slides or articles for
726 math journals and so on.
727 Some used the raw \SpecialChar TeX
728 facilities to do this, others began modifying \SpecialChar LaTeX
730 To try and unify this mess, a team of \SpecialChar LaTeX
731 -nicians began to work on \SpecialChar LaTeX2e
733 version of \SpecialChar LaTeX
734 , during the late 1980's.
735 This new version of \SpecialChar LaTeX
736 has commands which provide an easier-to-use interface
738 's macro-creating commands, aid in the use of new fonts, and so on.
739 In fact, \SpecialChar LaTeX
740 is quite an extensive language in its own right! Users around
741 the world have been creating their own add-ons for \SpecialChar LaTeX
746 \begin_layout Standard
747 There are two ways to extend \SpecialChar LaTeX
748 : classes and styles.
753 is a set of \SpecialChar LaTeX
754 macros describing a new type of document, like a book, or
756 There are classes for slides, for physics and math journals\SpecialChar ldots
758 even have a class for their thesis format.
763 differs from a class in that it doesn't define a new type of document,
764 but a different type of
768 that any document can use.
769 For example, \SpecialChar LyX
770 controls page margins and line spacing using two different
772 style-files designed for these purposes.
773 There are style-files for a whole slew of things: printing labels or envelopes,
774 changing indentation behavior, adding new fonts, manipulating graphics,
775 designing fancy page headings, customizing bibliographies, altering the
776 location and appearance of footnotes, tables, and figures, customizing
780 \begin_layout Standard
784 \begin_layout Description
786 : Typesetting language with macro capability.
789 \begin_layout Description
791 : Macro package built upon \SpecialChar TeX
792 \SpecialChar endofsentence
796 \begin_layout Description
797 classes: Descriptions of types of document used with \SpecialChar LaTeX
798 \SpecialChar endofsentence
802 \begin_layout Description
803 styles: Descriptions of the default behavior of particular elements of \SpecialChar LaTeX
807 \begin_layout Description
809 : Visual, WYSIWYM document processor that uses \SpecialChar LaTeX
810 to do its typesetting.
813 \begin_layout Standard
814 This section attempts to explain the difference between \SpecialChar LyX
815 and a word processor.
816 Simply put, \SpecialChar LaTeX
818 By using \SpecialChar LaTeX
819 as its backend, \SpecialChar LyX
820 helps you to think more about
829 The computer then handles
836 \begin_layout Section
837 Navigating the Documentation
840 \begin_layout Standard
841 To make it easier to answer your questions and describe all of the features
843 , the documentation has been split up into several different files.
844 Each one has its own purpose, as described below.
845 Before you go ploughing into any of those files, however, you should read
846 this chapter thoroughly, since it contains a lot of useful information
847 and commentary that can save you some time.
850 \begin_layout Standard
851 Hopefully, the development of \SpecialChar LyX
852 will never stop; so some of the documentation
853 may be incomplete or a bit out of date, though we try to keep up-to-date.
854 Like the rest of \SpecialChar LyX
855 , the manuals are the work of a group of volunteers who
857 \begin_inset Quotes eld
861 \begin_inset Quotes erd
864 , families, dishes to clean,
869 If you want to help out, be sure to read Section
874 \begin_inset CommandInset ref
876 reference "sec:Contrib"
880 in addition to the rest of this document.
883 \begin_layout Standard
884 Also, please do us a favor – if anything in these manuals confuses you,
885 is unclear, or wrong, don't hesitate to let us know! You can reach the
886 current document maintainers by emailing
887 \begin_inset CommandInset href
889 target "lyx-docs@lists.lyx.org"
895 If you have questions that are not obviously answered in the documentation,
896 and need help fast, there is an active users' mailing list which you can
898 \begin_inset CommandInset href
900 target "lyx-users@lists.lyx.org"
908 \begin_layout Subsection
909 The Format of the Manuals
912 \begin_layout Standard
913 Some of you may have printed out the manuals.
914 Others may be reading them within \SpecialChar LyX
916 There are some differences between the \SpecialChar LyX
917 -file and the printed version.
919 , the title is simply at the top of the document, not formatted on a
920 separate page as in some of the printed versions.
921 Nor are any of the footnotes or the Table of Contents fully visible.
922 To open a footnote, which looks like this:
923 \begin_inset Graphics
924 filename clipart/footnote.png
929 , click on it with the left mouse button.
930 For the Table of Contents, either click on the grey box or click on the
935 menu, where the contents are displayed automatically\SpecialChar endofsentence
939 \begin_layout Standard
940 In the printed manuals, all cross-references appear as the actual numbers
941 for a chapter, section, subsection, and so on.
942 In the \SpecialChar LyX
943 -file, however, all cross-references appear as light-grey boxes
945 \begin_inset Graphics
946 filename clipart/reference.png
952 If you click on such a box with the left mouse button, a dialog box will
953 appear containing a list of all the cross-references in the document.
954 You can go to the referenced section by right-clicking on the box or by
967 in the opened dialog.
968 Going back to where you came from is just as easy.
977 to go back to your earlier location.
980 \begin_layout Standard
981 Now that we've cleared up some of the differences between the printed and
983 -file versions of this file, we can start looking at the format of this
985 You'll occasionally notice things in different fonts:
988 \begin_layout Itemize
993 is used for general emphasis, generic arguments, book titles, names of
994 sections of other manuals, and notes from the authors.
997 \begin_layout Itemize
1002 is used for program and file names, \SpecialChar LyX
1006 \begin_layout Itemize
1011 is used for menu, button, or dialog box names, and the names of keyboard
1015 \begin_layout Itemize
1020 is used for people's names.
1023 \begin_layout Itemize
1028 is used for \SpecialChar LaTeX
1032 \begin_layout Standard
1033 When we do need to reference keys, we'll use the following prefixing convention:
1036 \begin_layout Itemize
1037 \begin_inset Quotes eld
1045 \begin_inset Quotes erd
1055 \begin_layout Itemize
1056 \begin_inset Quotes eld
1064 \begin_inset Quotes erd
1074 \begin_layout Itemize
1075 \begin_inset Quotes eld
1083 \begin_inset Quotes erd
1097 \begin_layout Itemize
1098 \begin_inset Quotes eld
1106 \begin_inset Quotes erd
1111 \begin_inset Quotes eld
1119 \begin_inset Quotes erd
1122 are the function keys.
1125 \begin_layout Itemize
1126 \begin_inset Quotes eld
1134 \begin_inset Quotes erd
1140 \begin_layout Itemize
1141 \begin_inset Quotes eld
1149 \begin_inset Quotes erd
1153 \begin_inset Quotes eld
1161 \begin_inset Quotes erd
1165 \begin_inset Quotes eld
1173 \begin_inset Quotes erd
1177 \begin_inset Quotes eld
1185 \begin_inset Quotes erd
1191 \begin_layout Itemize
1194 \begin_inset Quotes eld
1200 \begin_inset Quotes erd
1204 \begin_inset Quotes eld
1212 \begin_inset Quotes erd
1216 \begin_inset Quotes eld
1224 \begin_inset Quotes erd
1228 \begin_inset Quotes eld
1236 \begin_inset Quotes erd
1240 \begin_inset Quotes eld
1248 \begin_inset Quotes erd
1252 \begin_inset Quotes eld
1260 \begin_inset Quotes erd
1263 : these are the 6 keys that appear above the cursor keys on many PC keyboards.
1265 \begin_inset Quotes eld
1273 \begin_inset Quotes erd
1277 \begin_inset Quotes eld
1285 \begin_inset Quotes erd
1289 \begin_inset Quotes eld
1297 \begin_inset Quotes erd
1301 \begin_inset Quotes eld
1309 \begin_inset Quotes erd
1315 \begin_layout Itemize
1324 both refer to the same key.
1325 Some keyboards label the
1330 \begin_inset Quotes eld
1334 \begin_inset Quotes erd
1338 \begin_inset Quotes eld
1342 \begin_inset Quotes erd
1345 still others have two keys.
1347 treats all of them as the same key, so we'll use
1358 \begin_layout Standard
1359 The list with the currently set shortcuts can be found in the
1370 \begin_layout Subsection
1371 Units used in the Manuals
1374 \begin_layout Standard
1375 To understand the units described in this documentation, Table
1376 \begin_inset space ~
1380 \begin_inset CommandInset ref
1382 reference "tab:Units"
1386 explains all units available in \SpecialChar LyX
1390 \begin_layout Standard
1391 \begin_inset Float table
1396 \begin_layout Plain Layout
1397 \begin_inset Caption Standard
1399 \begin_layout Plain Layout
1400 \begin_inset CommandInset label
1414 \begin_layout Plain Layout
1415 \begin_inset VSpace medskip
1421 \begin_layout Plain Layout
1423 \begin_inset Tabular
1424 <lyxtabular version="3" rows="20" columns="2">
1425 <features booktabs="true" tabularvalignment="middle">
1426 <column alignment="center" valignment="top" width="0pt">
1427 <column alignment="center" valignment="top">
1429 <cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
1432 \begin_layout Plain Layout
1438 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1441 \begin_layout Plain Layout
1449 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1452 \begin_layout Plain Layout
1458 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1461 \begin_layout Plain Layout
1469 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1472 \begin_layout Plain Layout
1478 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1481 \begin_layout Plain Layout
1489 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1492 \begin_layout Plain Layout
1498 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1501 \begin_layout Plain Layout
1503 \begin_inset space \thinspace{}
1507 \begin_inset space \thinspace{}
1517 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1520 \begin_layout Plain Layout
1526 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1529 \begin_layout Plain Layout
1531 \begin_inset space \thinspace{}
1535 \begin_inset space \thinspace{}
1545 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1548 \begin_layout Plain Layout
1554 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1557 \begin_layout Plain Layout
1559 \begin_inset space \thinspace{}
1563 \begin_inset space \thinspace{}
1573 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1576 \begin_layout Plain Layout
1582 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1585 \begin_layout Plain Layout
1587 \begin_inset space \thinspace{}
1591 \begin_inset space \thinspace{}
1601 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1604 \begin_layout Plain Layout
1610 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1613 \begin_layout Plain Layout
1615 \begin_inset space \thinspace{}
1619 \begin_inset space \thinspace{}
1629 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1632 \begin_layout Plain Layout
1638 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1641 \begin_layout Plain Layout
1643 \begin_inset space \thinspace{}
1647 \begin_inset Formula $\approx$
1651 \begin_inset space \thinspace{}
1661 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1664 \begin_layout Plain Layout
1670 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1673 \begin_layout Plain Layout
1675 \begin_inset space \thinspace{}
1679 \begin_inset space \thinspace{}
1689 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1692 \begin_layout Plain Layout
1698 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1701 \begin_layout Plain Layout
1702 % of original image width
1709 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1712 \begin_layout Plain Layout
1718 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1721 \begin_layout Plain Layout
1729 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1732 \begin_layout Plain Layout
1738 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1741 \begin_layout Plain Layout
1749 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1752 \begin_layout Plain Layout
1758 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1761 \begin_layout Plain Layout
1769 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1772 \begin_layout Plain Layout
1778 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1781 \begin_layout Plain Layout
1789 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1792 \begin_layout Plain Layout
1798 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1801 \begin_layout Plain Layout
1809 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1812 \begin_layout Plain Layout
1818 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1821 \begin_layout Plain Layout
1829 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1832 \begin_layout Plain Layout
1838 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1841 \begin_layout Plain Layout
1853 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1856 \begin_layout Plain Layout
1862 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1865 \begin_layout Plain Layout
1877 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1880 \begin_layout Plain Layout
1886 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1889 \begin_layout Plain Layout
1891 \begin_inset space \thinspace{}
1895 \begin_inset space \thinspace{}
1916 \begin_layout Subsection
1920 \begin_layout Standard
1921 The following list describes the contents of the basic documentation files
1922 that you find in the
1929 \begin_layout Description
1930 Introduction This file.
1933 \begin_layout Description
1934 Tutorial If you are new to \SpecialChar LyX
1935 , and have never used \SpecialChar LaTeX
1936 before, you should start
1938 If you have used \SpecialChar LaTeX
1939 before, you should still read the
1943 , starting with the section on
1944 \begin_inset Quotes eld
1948 for \SpecialChar LaTeX
1950 \begin_inset Quotes erd
1953 (Skimming through the rest of the document wouldn't hurt, either.)
1956 \begin_layout Description
1958 \begin_inset space ~
1961 Guide The primary documentation.
1966 of the basic operation and available features of \SpecialChar LyX
1968 The main manual assumes that you have read the
1975 \begin_layout Description
1977 \begin_inset space ~
1980 Objects Extension of the
1985 Documents in detail how to use tables, graphics, floats, notes, program
1987 It also includes many tricks of the \SpecialChar LaTeX
1991 \begin_layout Description
1992 Math Extension of the
1997 Documents in detail how to typeset any kind of formula.
2000 \begin_layout Description
2002 \begin_inset space ~
2005 Features Extension of the
2010 Documents how to use raw \SpecialChar LaTeX
2011 commands, additional layouts and special-purpose
2015 \begin_layout Description
2016 Customization A description of advanced \SpecialChar LyX
2017 features, including how to customize
2018 the overall behavior of \SpecialChar LyX
2019 \SpecialChar endofsentence
2020 This includes such things as keybindings, internationa
2021 lization and configuration files.
2022 It also includes information about layout files, which are needed to get
2024 to support \SpecialChar LaTeX
2025 classes or packages.
2028 \begin_layout Description
2029 Shortcuts Tables of the currently defined \SpecialChar LyX
2033 \begin_layout Description
2036 \begin_inset space ~
2039 Configuration A report produced by \SpecialChar LyX
2041 This file contains information on what \SpecialChar LyX
2042 learned about your installation.
2043 Check it to see if you're missing something you might like to have.
2046 \begin_layout Standard
2047 These files will reference one another as necessary.
2056 information on installation and customization, but refers the reader to
2059 Customization Manual
2061 for more information.
2064 \begin_layout Standard
2065 We'll state again an important point:
2068 \begin_layout Standard
2069 \begin_inset VSpace bigskip
2075 \begin_layout Standard
2077 If you are new to \SpecialChar LyX
2083 Now\SpecialChar endofsentence
2087 \begin_layout Standard
2088 \begin_inset VSpace bigskip
2094 \begin_layout Standard
2095 Otherwise, you could needlessly frustrate yourself.
2098 \begin_layout Section
2099 Contributing to the \SpecialChar LyX
2101 \begin_inset CommandInset label
2110 \begin_layout Subsection
2111 Contributing to \SpecialChar LyX
2115 \begin_layout Standard
2117 is mostly written in C++ (the \SpecialChar LaTeX
2118 importer is written in Python).
2119 It is a large project, and as a result it is not free from bugs, or the
2120 need for improvements in the source code.
2123 \begin_layout Subsubsection
2127 \begin_layout Standard
2128 While using \SpecialChar LyX
2129 , you may find behavior which you consider a bug.
2130 Crashes, though rare, can happen.
2131 User interface problems are considered major bugs by the \SpecialChar LyX
2133 helpful are indications of parts of the \SpecialChar LyX
2134 interface you find confusing,
2138 \begin_layout Standard
2140 has a bug tracking system, which you can find at
2143 \begin_inset Flex URL
2146 \begin_layout Plain Layout
2148 http://www.lyx.org/trac/wiki/BugTrackerHome
2156 You should check the bug tracker before reporting any bugs, in case it
2157 has already been reported.
2158 If you have a comment on an existing bug, or wish to report a new bug,
2159 you may either use the bug tracker, or send an e-mail to the development
2161 \begin_inset CommandInset href
2163 target "lyx-devel@lists.lyx.org"
2169 Archives of this list are linked from the main \SpecialChar LyX
2173 \begin_inset Flex URL
2176 \begin_layout Plain Layout
2188 \begin_layout Standard
2189 A useful bug report will at a minimum include the version of \SpecialChar LyX
2192 Accurate, detailed descriptions are preferred - the more time developers
2193 have to spend to pinpoint the source of a bug, the less time they have
2194 for other improvements.
2195 Mention the system and system version on which you are running \SpecialChar LyX
2197 Give the versions of the libraries you have installed on your system, and,
2198 if relevant, the versions of external programs that \SpecialChar LyX
2200 If it's a compilation or configuration problem, include the file
2204 , and mention which compiler you are using.
2207 \begin_layout Subsubsection
2208 Contributing fixes and new features
2211 \begin_layout Standard
2212 If you have made changes to \SpecialChar LyX
2213 's source that you think should become part
2215 , send your changes as a diff file (in unified format) to the development
2216 list referenced above, along with a change log, and a description of what
2220 \begin_layout Subsection
2221 Contributing to the Documentation
2224 \begin_layout Standard
2226 's documentation is extensive; however \SpecialChar LyX
2227 is under constant development, and
2228 each new release adds new features.
2229 You may find some documentation needs improvement.
2230 This section describes what to do if you find an error, or have some suggestion
2231 s for improving the documentation.
2234 \begin_layout Subsubsection
2235 Reporting Errors in the Manuals
2238 \begin_layout Standard
2239 If you find a problem with the documentation, send a message to the mailing
2241 \begin_inset CommandInset href
2243 target "lyx-docs@lists.lyx.org"
2249 The documentation team will make any necessary fixes.
2252 \begin_layout Subsubsection
2253 Joining the Documentation Team.
2256 \begin_layout Standard
2257 The \SpecialChar LyX
2258 Documentation Project, like anything else in the \SpecialChar LyX
2260 use assistance! If you're interested in contributing to the Documentation
2261 Project, you need to do the following:
2264 \begin_layout Enumerate
2265 Get the latest \SpecialChar LyX
2267 \begin_inset Newline newline
2271 \begin_inset Flex URL
2274 \begin_layout Plain Layout
2276 http://www.lyx.org/trac/browser/lyxgit/lib/doc?rev=master
2284 \begin_layout Enumerate
2294 \begin_inset Newline newline
2297 The point of this exercise is to give you ideas.
2306 are likely to be the most up-to-date of all of the documentation.
2307 You should be able to glean some insights into how we want the manuals
2308 to read and to look.
2311 \begin_layout Enumerate
2312 Contact the team at:
2313 \begin_inset Newline newline
2317 \begin_inset CommandInset href
2319 target "lyx-docs@lists.lyx.org"
2325 \begin_inset Newline newline
2328 to discuss your intended changes and to get some feedback on them.
2331 \begin_layout Standard
2332 The changes you wish to make may range from improving clarity of the text,
2333 to doing major re-structuring of the documentation.
2334 Any and all improvements are gladly received.