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 1
77 \use_package stackrel 1
78 \use_package stmaryrd 1
79 \use_package undertilde 1
81 \cite_engine_type default
85 \paperorientation portrait
95 \paragraph_separation indent
96 \paragraph_indentation default
98 \math_numbering_side default
103 \paperpagestyle default
104 \tracking_changes false
105 \output_changes false
108 \html_be_strict false
115 Introduction to \SpecialChar LyX
120 by the \SpecialChar LyX
125 \begin_layout Plain Layout
127 If you have comments on or corrections to this documentation, please send
128 them to the \SpecialChar LyX
129 Documentation mailing list:
130 \begin_inset CommandInset href
132 target "lyx-docs@lists.lyx.org"
146 \begin_layout Standard
147 \begin_inset CommandInset toc
148 LatexCommand tableofcontents
155 \begin_layout Section
156 The Philosophy of \SpecialChar LyX
160 \begin_layout Subsection
161 What is \SpecialChar LyX
165 \begin_layout Standard
167 is a document preparation system.
168 It excels at letting you create complex technical and scientific articles
169 with mathematics, cross-references, bibliographies, indexes, etc.
170 It is very good for working with documents of any length in which the usual
171 processing abilities are required: automatic sectioning and pagination,
172 spell checking and so forth.
173 It can also be used to write a letter to your mom, though granted, there
174 are probably simpler programs available for that.
175 It is definitely not the best tool for creating banners, flyers, or advertiseme
176 nts (we'll explain why later), though with some effort all these can be
178 Here are some examples of what it is used for: memos, letters, dissertations
179 and theses, lecture notes, seminar notebooks, conference proceedings, software
180 documentation, books, articles in refereed scientific journals, scripts
181 for plays and movies, business proposals, presentations \SpecialChar ldots
185 \begin_layout Standard
187 is a program that provides a modern approach to writing documents with
188 a computer by using a markup language paradigm, an approach that breaks
189 with the obsolete tradition of the
190 \begin_inset Quotes eld
194 \begin_inset Quotes erd
198 It is designed for authors who want professional output quickly with a
199 minimum of effort and without becoming specialists in typesetting.
200 The job of typesetting is done mostly by the computer, not the author;
201 with \SpecialChar LyX
202 , the author can concentrate on the contents of his writing.
205 \begin_layout Standard
206 Part of the initial challenge of using \SpecialChar LyX
207 comes from the change in thinking
208 that you, the user, must make.
209 At one time, all we had for creating documents were typewriters, so we
210 all learned certain tricks to get around their limitations.
211 Underlining, which is little more than overstriking with the
212 \begin_inset Quotes eld
216 \begin_inset Quotes erd
219 character, became a way to emphasize text.
220 You were forced to figure out column sizes and tab stops, and set them,
221 before creating a table.
222 The same applied for letters and other right justified text.
223 Hyphenation at the end of a line required a careful eye and a lot of foresight.
226 \begin_layout Standard
227 In other words, we've all been trained to worry about the little details
228 of which character goes where.
229 Consequently, almost all word processors have this mentality.
230 They still use tab stops for adding whitespace.
231 You still need to worry about exactly where on the page something will
233 Emphasizing text means changing a font, similar to changing the typewriter
235 This is the underlying philosophy of a WYSIWYG word processor:
236 \begin_inset Quotes eld
239 What You See Is What You Get
240 \begin_inset Quotes erd
244 Unfortunately, that paradigm often results in
245 \begin_inset Quotes eld
248 What You See Is All You Get
249 \begin_inset Quotes erd
255 \begin_layout Standard
256 This is where \SpecialChar LyX
257 differs from an ordinary word processor.
258 You don't concern yourself with what character goes where.
259 You tell \SpecialChar LyX
265 takes care of the rest, following a set of rules called a
273 \begin_layout Plain Layout
274 To be fair, most recent versions of the most popular office suites now have
275 some sort of style sheets which follow a similar markup method.
276 However, our experience is that they are still rarely used in practice.
281 Let's look at a little example:
284 \begin_layout Standard
285 Suppose you are writing a report.
286 To begin your report, you want a section called
287 \begin_inset Quotes eld
290 Introduction\SpecialChar endofsentence
292 \begin_inset Quotes erd
295 So, you go into whatever menu it is in your word processor that changes
296 font sizes and decide on a new font size.
297 Then you turn on bold face.
299 \begin_inset Quotes eld
311 \begin_inset Quotes erd
315 Of course, if you later decide that this section belongs someplace else
316 in the document or if you insert a new section before it, you need to change
317 the numbering for this and all following sections, as well as any entry
318 in the table of contents.
321 \begin_layout Standard
323 , you go to the pull-down on the far left of the button bar and select
329 \begin_inset Quotes eld
333 \begin_inset Quotes erd
339 \begin_layout Standard
341 If you cut and paste the section, it will automatically be renumbered —
343 And if you enter references to that section correctly (by inserting cross-refer
344 ence tags), \SpecialChar LyX
345 will automatically update them all throughout the file so that
346 you never, ever type a section number.
349 \begin_layout Standard
350 Now let's look at the problem of consistency.
351 Five days later, you reopen your report and start Section
356 However, you forget that you were using 18
357 \begin_inset space \thinspace{}
360 pt bold instead of 16
361 \begin_inset space \thinspace{}
364 pt, so you type in the heading for Section
368 4 in a different font from the one you used for Section
373 That problem doesn't even exist in \SpecialChar LyX
375 The computer takes care of all that silly bookkeeping about which thing
376 has what size font, not you.
377 After all, that's what a computer is good at.
380 \begin_layout Standard
381 Here's another example.
382 Suppose you're making a list.
383 In other word processors, a list is just a bunch of tab stops and newlines.
384 You need to figure out where to put the label for each list item, what
385 that label should be, how many blank lines to put between each item, and
387 Under \SpecialChar LyX
388 , you have only two concerns: what kind of list is this, and what
389 do I want to put in it? That is it.
392 \begin_layout Standard
393 So, the basic idea behind \SpecialChar LyX
404 \begin_inset Quotes eld
407 What You See Is What You Get,
408 \begin_inset Quotes erd
413 \begin_inset Quotes eld
416 What You See Is What You
421 \begin_inset Quotes erd
425 \begin_inset Quotes eld
429 \begin_inset Quotes erd
432 It's a powerful idea that greatly simplifies the mechanics of writing documents.
433 This is also why \SpecialChar LyX
434 isn't so good for creating posters and flyers.
439 want to specify exactly where everything goes, because there are no functional
440 units like paragraphs, sections, etc.
441 This doesn't mean \SpecialChar LyX
442 is missing some cool function.
443 It simply means that it isn't the right tool for the job — you don't use
444 a screwdriver to drive in nails.
447 \begin_layout Subsection
448 Differences between \SpecialChar LyX
449 and Other Word Processors
450 \begin_inset Argument 1
453 \begin_layout Plain Layout
457 \begin_layout Plain Layout
471 \begin_layout Plain Layout
478 and Other Word Processors
486 \begin_layout Standard
487 Here's a list of things you won't find in \SpecialChar LyX
491 \begin_layout Itemize
495 \begin_layout Itemize
499 \begin_layout Itemize
501 \begin_inset space \thinspace{}
505 \begin_inset space \space{}
519 \begin_layout Standard
520 Tab stops, along with a ruler showing you the position of things on the
521 page, are useless in \SpecialChar LyX
523 The program worries about where things go on the page, not you.
524 Extra whitespace is similar; \SpecialChar LyX
525 adds it where necessary, depending on context.
526 Not being able to type two blank lines in a row will be annoying at first,
527 but it makes more sense once you're thinking in WYSIWYM terms.
530 \begin_layout Standard
531 Here are some things that exist in \SpecialChar LyX
532 , but aren't used as you might think:
535 \begin_layout Itemize
539 \begin_layout Itemize
543 \begin_layout Itemize
545 \begin_inset space \thinspace{}
549 \begin_inset space \space{}
552 single spaced, double spaced, etc.)
555 \begin_layout Itemize
556 Whitespace, horizontal and vertical
559 \begin_layout Itemize
563 \begin_layout Itemize
564 Typefaces (bold, italic, underline, etc.)
567 \begin_layout Standard
568 Although they exist in \SpecialChar LyX
569 , you generally don't need them.
571 will take care of these things for you, depending on what you're doing.
572 Different parts of the document are automatically set in a different typeface
574 Paragraph indenting is context dependent; different types of paragraphs
575 get indented differently.
576 Page breaks get handled automatically, as well.
577 In general, the space between lines, between words, and between paragraphs
578 is variable, set by \SpecialChar LyX
583 \begin_layout Plain Layout
584 There are ways to adjust all of these (only some of which require knowledge
585 of \SpecialChar LaTeX
586 ), either for a whole document or for a specific location in a document.
603 \begin_layout Standard
604 Lastly, there are a few areas where we believe \SpecialChar LyX
605 (and \SpecialChar LaTeX
606 ) surpasses many word
610 \begin_layout Itemize
614 \begin_layout Itemize
618 \begin_layout Itemize
622 \begin_layout Itemize
626 \begin_layout Itemize
630 \begin_layout Standard
631 Granted, many modern word processors can handle mathematical symbols, tables,
632 and hyphenation, and many have moved towards style definitions and the
634 However, they've only recently been able to do so, whereas \SpecialChar LyX
636 the \SpecialChar LaTeX
637 document preparation system.
639 has been around since 1985, and
646 \begin_layout Subsection
647 What is \SpecialChar LaTeX
651 \begin_layout Standard
653 is a document preparation system designed by Leslie Lamport in 1985.
657 \begin_layout Plain Layout
658 The source for the info in this section is
660 A Guide to \SpecialChar LaTeX2e
663 , by Helmut Kopka and Patrick Daly, which has an entry in the bibliography
668 \SpecialChar endofsentence
674 It was built up from a typesetting language called \SpecialChar TeX
678 takes a sequence of typesetting commands, written in a script in an ASCII
679 file, and executes them.
681 \begin_inset Quotes eld
685 \begin_inset Quotes erd
688 of the printing trade were modeled by Knuth as computer algorithms and
689 incorporated into \SpecialChar TeX
690 , hence its excellent printed appearance.
691 What comes directly out of \SpecialChar TeX
692 is the portable document format
697 \begin_inset Quotes eld
701 \begin_inset Quotes erd
709 The dvi format is often used for previews and can later be converted to
710 other formats like PostScript.
714 \begin_layout Standard
716 isn't only a typesetting engine; it also allows you to define macros.
717 Most people who use \SpecialChar TeX
718 are actually using a macro package which Knuth created
719 to hide a lot of the typesetting details.
720 This is where Leslie Lamport enters our story.
721 He wanted a macro package that was more user- and less typesetter-oriented,
722 with a set of commands that consistently typeset things like sections,
723 tables or math formulas in a uniform, consistent fashion.
724 This is how \SpecialChar LaTeX
728 \begin_layout Standard
729 Now, in parallel with the development and growth of \SpecialChar LaTeX
730 , other folks were creating
731 their own custom macro packages for \SpecialChar TeX
732 , ones to make slides or articles for
733 math journals and so on.
734 Some used the raw \SpecialChar TeX
735 facilities to do this, others began modifying \SpecialChar LaTeX
737 To try and unify this mess, a team of \SpecialChar LaTeX
738 -nicians began to work on \SpecialChar LaTeX2e
740 version of \SpecialChar LaTeX
741 , during the late 1980's.
742 This new version of \SpecialChar LaTeX
743 has commands which provide an easier-to-use interface
745 's macro-creating commands, aid in the use of new fonts, and so on.
746 In fact, \SpecialChar LaTeX
747 is quite an extensive language in its own right! Users around
748 the world have been creating their own add-ons for \SpecialChar LaTeX
753 \begin_layout Standard
754 There are two ways to extend \SpecialChar LaTeX
755 : classes and styles.
760 is a set of \SpecialChar LaTeX
761 macros describing a new type of document, like a book, or
763 There are classes for slides, for physics and math journals\SpecialChar ldots
765 even have a class for their thesis format.
770 differs from a class in that it doesn't define a new type of document,
771 but a different type of
775 that any document can use.
776 For example, \SpecialChar LyX
777 controls page margins and line spacing using two different
779 style-files designed for these purposes.
780 There are style-files for a whole slew of things: printing labels or envelopes,
781 changing indentation behavior, adding new fonts, manipulating graphics,
782 designing fancy page headings, customizing bibliographies, altering the
783 location and appearance of footnotes, tables, and figures, customizing
787 \begin_layout Standard
791 \begin_layout Description
793 : Typesetting language with macro capability.
796 \begin_layout Description
798 : Macro package built upon \SpecialChar TeX
799 \SpecialChar endofsentence
803 \begin_layout Description
804 classes: Descriptions of types of document used with \SpecialChar LaTeX
805 \SpecialChar endofsentence
809 \begin_layout Description
810 styles: Descriptions of the default behavior of particular elements of \SpecialChar LaTeX
814 \begin_layout Description
816 : Visual, WYSIWYM document processor that uses \SpecialChar LaTeX
817 to do its typesetting.
820 \begin_layout Standard
821 This section attempts to explain the difference between \SpecialChar LyX
822 and a word processor.
823 Simply put, \SpecialChar LaTeX
825 By using \SpecialChar LaTeX
826 as its backend, \SpecialChar LyX
827 helps you to think more about
836 The computer then handles
843 \begin_layout Section
844 Navigating the Documentation
847 \begin_layout Standard
848 To make it easier to answer your questions and describe all of the features
850 , the documentation has been split up into several different files.
851 Each one has its own purpose, as described below.
852 Before you go ploughing into any of those files, however, you should read
853 this chapter thoroughly, since it contains a lot of useful information
854 and commentary that can save you some time.
857 \begin_layout Standard
858 Hopefully, the development of \SpecialChar LyX
859 will never stop; so some of the documentation
860 may be incomplete or a bit out of date, though we try to keep up-to-date.
861 Like the rest of \SpecialChar LyX
862 , the manuals are the work of a group of volunteers who
864 \begin_inset Quotes eld
868 \begin_inset Quotes erd
871 , families, dishes to clean,
876 If you want to help out, be sure to read Section
881 \begin_inset CommandInset ref
883 reference "sec:Contrib"
887 in addition to the rest of this document.
890 \begin_layout Standard
891 Also, please do us a favor – if anything in these manuals confuses you,
892 is unclear, or wrong, don't hesitate to let us know! You can reach the
893 current document maintainers by emailing
894 \begin_inset CommandInset href
896 target "lyx-docs@lists.lyx.org"
903 If you have questions that are not obviously answered in the documentation,
904 and need help fast, there is an active users' mailing list which you can
906 \begin_inset CommandInset href
908 target "lyx-users@lists.lyx.org"
917 \begin_layout Subsection
918 The Format of the Manuals
921 \begin_layout Standard
922 Some of you may have printed out the manuals.
923 Others may be reading them within \SpecialChar LyX
925 There are some differences between the \SpecialChar LyX
926 -file and the printed version.
928 , the title is simply at the top of the document, not formatted on a
929 separate page as in some of the printed versions.
930 Nor are any of the footnotes or the Table of Contents fully visible.
931 To open a footnote, which looks like this:
932 \begin_inset Graphics
933 filename clipart/footnote.png
938 , click on it with the left mouse button.
939 For the Table of Contents, either click on the grey box or click on the
944 menu, where the contents are displayed automatically\SpecialChar endofsentence
948 \begin_layout Standard
949 In the printed manuals, all cross-references appear as the actual numbers
950 for a chapter, section, subsection, and so on.
951 In the \SpecialChar LyX
952 -file, however, all cross-references appear as light-grey boxes
954 \begin_inset Graphics
955 filename clipart/reference.png
961 If you click on such a box with the left mouse button, a dialog box will
962 appear containing a list of all the cross-references in the document.
963 You can go to the referenced section by right-clicking on the box or by
976 in the opened dialog.
977 Going back to where you came from is just as easy.
986 to go back to your earlier location.
989 \begin_layout Standard
990 Now that we've cleared up some of the differences between the printed and
992 -file versions of this file, we can start looking at the format of this
994 You'll occasionally notice things in different fonts:
997 \begin_layout Itemize
1002 is used for general emphasis, generic arguments, book titles, names of
1003 sections of other manuals, and notes from the authors.
1006 \begin_layout Itemize
1011 is used for program and file names, \SpecialChar LyX
1015 \begin_layout Itemize
1020 is used for menu, button, or dialog box names, and the names of keyboard
1024 \begin_layout Itemize
1029 is used for people's names.
1032 \begin_layout Itemize
1037 is used for \SpecialChar LaTeX
1041 \begin_layout Standard
1042 When we do need to reference keys, we'll use the following prefixing convention:
1045 \begin_layout Itemize
1046 \begin_inset Quotes eld
1054 \begin_inset Quotes erd
1064 \begin_layout Itemize
1065 \begin_inset Quotes eld
1073 \begin_inset Quotes erd
1083 \begin_layout Itemize
1084 \begin_inset Quotes eld
1092 \begin_inset Quotes erd
1106 \begin_layout Itemize
1107 \begin_inset Quotes eld
1115 \begin_inset Quotes erd
1120 \begin_inset Quotes eld
1128 \begin_inset Quotes erd
1131 are the function keys.
1134 \begin_layout Itemize
1135 \begin_inset Quotes eld
1143 \begin_inset Quotes erd
1149 \begin_layout Itemize
1150 \begin_inset Quotes eld
1158 \begin_inset Quotes erd
1162 \begin_inset Quotes eld
1170 \begin_inset Quotes erd
1174 \begin_inset Quotes eld
1182 \begin_inset Quotes erd
1186 \begin_inset Quotes eld
1194 \begin_inset Quotes erd
1200 \begin_layout Itemize
1203 \begin_inset Quotes eld
1209 \begin_inset Quotes erd
1213 \begin_inset Quotes eld
1221 \begin_inset Quotes erd
1225 \begin_inset Quotes eld
1233 \begin_inset Quotes erd
1237 \begin_inset Quotes eld
1245 \begin_inset Quotes erd
1249 \begin_inset Quotes eld
1257 \begin_inset Quotes erd
1261 \begin_inset Quotes eld
1269 \begin_inset Quotes erd
1273 \begin_inset space ~
1276 keys that appear above the cursor keys on many PC keyboards.
1278 \begin_inset Quotes eld
1286 \begin_inset Quotes erd
1290 \begin_inset Quotes eld
1298 \begin_inset Quotes erd
1302 \begin_inset Quotes eld
1310 \begin_inset Quotes erd
1314 \begin_inset Quotes eld
1322 \begin_inset Quotes erd
1328 \begin_layout Itemize
1337 both refer to the same key.
1338 Some keyboards label the
1343 \begin_inset Quotes eld
1347 \begin_inset Quotes erd
1351 \begin_inset Quotes eld
1355 \begin_inset Quotes erd
1358 still others have two keys.
1360 treats all of them as the same key, so we'll use
1371 \begin_layout Standard
1372 The list with the currently set shortcuts can be found in the
1383 \begin_layout Subsection
1384 Units used in the Manuals
1387 \begin_layout Standard
1388 To understand the units described in this documentation, Table
1389 \begin_inset space ~
1393 \begin_inset CommandInset ref
1395 reference "tab:Units"
1399 explains all units available in \SpecialChar LyX
1403 \begin_layout Standard
1404 \begin_inset Float table
1409 \begin_layout Plain Layout
1410 \begin_inset Caption Standard
1412 \begin_layout Plain Layout
1413 \begin_inset CommandInset label
1427 \begin_layout Plain Layout
1428 \begin_inset VSpace medskip
1434 \begin_layout Plain Layout
1436 \begin_inset Tabular
1437 <lyxtabular version="3" rows="20" columns="2">
1438 <features booktabs="true" tabularvalignment="middle">
1439 <column alignment="center" valignment="top" width="0pt">
1440 <column alignment="center" valignment="top">
1442 <cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
1445 \begin_layout Plain Layout
1451 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1454 \begin_layout Plain Layout
1462 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1465 \begin_layout Plain Layout
1471 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1474 \begin_layout Plain Layout
1482 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1485 \begin_layout Plain Layout
1491 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1494 \begin_layout Plain Layout
1502 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1505 \begin_layout Plain Layout
1511 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1514 \begin_layout Plain Layout
1516 \begin_inset space \thinspace{}
1520 \begin_inset space \thinspace{}
1530 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1533 \begin_layout Plain Layout
1539 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1542 \begin_layout Plain Layout
1544 \begin_inset space \thinspace{}
1548 \begin_inset space \thinspace{}
1558 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1561 \begin_layout Plain Layout
1567 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1570 \begin_layout Plain Layout
1572 \begin_inset space \thinspace{}
1576 \begin_inset space \thinspace{}
1586 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1589 \begin_layout Plain Layout
1595 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1598 \begin_layout Plain Layout
1600 \begin_inset space \thinspace{}
1604 \begin_inset space \thinspace{}
1614 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1617 \begin_layout Plain Layout
1623 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1626 \begin_layout Plain Layout
1628 \begin_inset space \thinspace{}
1632 \begin_inset space \thinspace{}
1642 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1645 \begin_layout Plain Layout
1651 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1654 \begin_layout Plain Layout
1656 \begin_inset space \thinspace{}
1660 \begin_inset Formula $\approx$
1664 \begin_inset space \thinspace{}
1674 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1677 \begin_layout Plain Layout
1683 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1686 \begin_layout Plain Layout
1688 \begin_inset space \thinspace{}
1692 \begin_inset space \thinspace{}
1702 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1705 \begin_layout Plain Layout
1711 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1714 \begin_layout Plain Layout
1715 % of original image width
1722 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1725 \begin_layout Plain Layout
1731 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1734 \begin_layout Plain Layout
1742 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1745 \begin_layout Plain Layout
1751 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1754 \begin_layout Plain Layout
1762 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1765 \begin_layout Plain Layout
1771 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1774 \begin_layout Plain Layout
1782 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1785 \begin_layout Plain Layout
1791 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1794 \begin_layout Plain Layout
1802 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1805 \begin_layout Plain Layout
1811 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1814 \begin_layout Plain Layout
1822 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1825 \begin_layout Plain Layout
1831 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1834 \begin_layout Plain Layout
1842 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1845 \begin_layout Plain Layout
1851 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1854 \begin_layout Plain Layout
1866 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1869 \begin_layout Plain Layout
1875 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1878 \begin_layout Plain Layout
1890 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1893 \begin_layout Plain Layout
1899 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1902 \begin_layout Plain Layout
1904 \begin_inset space \thinspace{}
1908 \begin_inset space \thinspace{}
1929 \begin_layout Subsection
1933 \begin_layout Standard
1934 The following list describes the contents of the basic documentation files
1935 that you find in the
1942 \begin_layout Description
1943 Introduction This file.
1946 \begin_layout Description
1947 Tutorial If you are new to \SpecialChar LyX
1948 , and have never used \SpecialChar LaTeX
1949 before, you should start
1951 If you have used \SpecialChar LaTeX
1952 before, you should still read the
1956 , starting with the section on
1957 \begin_inset Quotes eld
1961 for \SpecialChar LaTeX
1963 \begin_inset Quotes erd
1966 (Skimming through the rest of the document wouldn't hurt, either.)
1969 \begin_layout Description
1971 \begin_inset space ~
1974 Guide The primary documentation.
1979 of the basic operation and available features of \SpecialChar LyX
1981 The main manual assumes that you have read the
1988 \begin_layout Description
1990 \begin_inset space ~
1993 Objects Extension of the
1998 Documents in detail how to use tables, graphics, floats, notes, program
2000 It also includes many tricks of the \SpecialChar LaTeX
2004 \begin_layout Description
2005 Math Extension of the
2010 Documents in detail how to typeset any kind of formula.
2013 \begin_layout Description
2015 \begin_inset space ~
2018 Features Extension of the
2023 Documents how to use raw \SpecialChar LaTeX
2024 commands, additional layouts and special-purpose
2028 \begin_layout Description
2029 Customization A description of advanced \SpecialChar LyX
2030 features, including how to customize
2031 the overall behavior of \SpecialChar LyX
2032 \SpecialChar endofsentence
2033 This includes such things as keybindings, internationa
2034 lization and configuration files.
2035 It also includes information about layout files, which are needed to get
2037 to support \SpecialChar LaTeX
2038 classes or packages.
2041 \begin_layout Description
2042 Shortcuts Tables of the currently defined \SpecialChar LyX
2046 \begin_layout Description
2049 \begin_inset space ~
2052 Configuration A report produced by \SpecialChar LyX
2054 This file contains information on what \SpecialChar LyX
2055 learned about your installation.
2056 Check it to see if you're missing something you might like to have.
2059 \begin_layout Standard
2060 These files will reference one another as necessary.
2069 information on installation and customization, but refers the reader to
2072 Customization Manual
2074 for more information.
2077 \begin_layout Standard
2078 We'll state again an important point:
2081 \begin_layout Standard
2082 \begin_inset VSpace bigskip
2088 \begin_layout Standard
2090 If you are new to \SpecialChar LyX
2096 Now\SpecialChar endofsentence
2100 \begin_layout Standard
2101 \begin_inset VSpace bigskip
2107 \begin_layout Standard
2108 Otherwise, you could needlessly frustrate yourself.
2111 \begin_layout Section
2112 Contributing to the \SpecialChar LyX
2114 \begin_inset CommandInset label
2123 \begin_layout Subsection
2124 Contributing to \SpecialChar LyX
2128 \begin_layout Standard
2130 is mostly written in C++ (the \SpecialChar LaTeX
2131 importer is written in Python).
2132 It is a large project, and as a result it is not free from bugs, or the
2133 need for improvements in the source code.
2136 \begin_layout Subsubsection
2140 \begin_layout Standard
2141 While using \SpecialChar LyX
2142 , you may find behavior which you consider a bug.
2143 Crashes, though rare, can happen.
2144 User interface problems are considered major bugs by the \SpecialChar LyX
2146 helpful are indications of parts of the \SpecialChar LyX
2147 interface you find confusing,
2151 \begin_layout Standard
2153 has a bug tracking system, which you can find at
2154 \begin_inset Newline newline
2158 \begin_inset CommandInset href
2160 target "http://www.lyx.org/trac/wiki/BugTrackerHome"
2165 You should check the bug tracker before reporting any bugs, in case it
2166 has already been reported.
2167 If you have a comment on an existing bug, or wish to report a new bug,
2168 you may either use the bug tracker, or send an e-mail to the development
2170 \begin_inset CommandInset href
2172 target "lyx-devel@lists.lyx.org"
2179 Archives of this list are linked from the main \SpecialChar LyX
2181 \begin_inset CommandInset href
2183 target "http://www.lyx.org"
2190 \begin_layout Standard
2191 A useful bug report will at a minimum include the version of \SpecialChar LyX
2194 Accurate, detailed descriptions are preferred — the more time developers
2195 have to spend to pinpoint the source of a bug, the less time they have
2196 for other improvements.
2197 Mention the system and system version on which you are running \SpecialChar LyX
2199 Give the versions of the libraries you have installed on your system, and,
2200 if relevant, the versions of external programs that \SpecialChar LyX
2202 If it's a compilation or configuration problem, include the file
2206 , and mention which compiler you are using.
2209 \begin_layout Subsubsection
2210 Contributing fixes and new features
2213 \begin_layout Standard
2214 If you have made changes to \SpecialChar LyX
2215 's source that you think should become part
2217 , send your changes as a diff file (in unified format) to the development
2218 list referenced above, along with a change log, and a description of what
2222 \begin_layout Subsection
2223 Contributing to the Documentation
2226 \begin_layout Standard
2228 's documentation is extensive; however \SpecialChar LyX
2229 is under constant development, and
2230 each new release adds new features.
2231 You may find some documentation needs improvement.
2232 This section describes what to do if you find an error, or have some suggestion
2233 s for improving the documentation.
2236 \begin_layout Subsubsection
2237 Reporting Errors in the Manuals
2240 \begin_layout Standard
2241 If you find a problem with the documentation, send a message to the mailing
2243 \begin_inset CommandInset href
2245 target "lyx-docs@lists.lyx.org"
2252 The documentation team will make any necessary fixes.
2255 \begin_layout Subsubsection
2256 Joining the Documentation Team.
2259 \begin_layout Standard
2260 The \SpecialChar LyX
2261 Documentation Project, like anything else in the \SpecialChar LyX
2263 use assistance! If you're interested in contributing to the Documentation
2264 Project, you need to do the following:
2267 \begin_layout Enumerate
2268 Get the latest \SpecialChar LyX
2270 \begin_inset Newline newline
2274 \begin_inset CommandInset href
2276 target "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"
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.