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
98 \math_numbering_side default
103 \paperpagestyle default
104 \tracking_changes false
105 \output_changes false
108 \html_be_strict false
114 Introduction to \SpecialChar LyX
119 by the \SpecialChar LyX
124 \begin_layout Plain Layout
126 If you have comments on or corrections to this documentation, please send
127 them to the \SpecialChar LyX
128 Documentation mailing list:
129 \begin_inset CommandInset href
131 target "lyx-docs@lists.lyx.org"
145 \begin_layout Standard
146 \begin_inset CommandInset toc
147 LatexCommand tableofcontents
154 \begin_layout Section
155 The Philosophy of \SpecialChar LyX
159 \begin_layout Subsection
160 What is \SpecialChar LyX
164 \begin_layout Standard
166 is a document preparation system.
167 It excels at letting you create complex technical and scientific articles
168 with mathematics, cross-references, bibliographies, indexes, etc.
169 It is very good for working with documents of any length in which the usual
170 processing abilities are required: automatic sectioning and pagination,
171 spell checking and so forth.
172 It can also be used to write a letter to your mom, though granted, there
173 are probably simpler programs available for that.
174 It is definitely not the best tool for creating banners, flyers, or advertiseme
175 nts (we'll explain why later), though with some effort all these can be
177 Here are some examples of what it is used for: memos, letters, dissertations
178 and theses, lecture notes, seminar notebooks, conference proceedings, software
179 documentation, books, articles in refereed scientific journals, scripts
180 for plays and movies, business proposals, presentations \SpecialChar ldots
184 \begin_layout Standard
186 is a program that provides a modern approach to writing documents with
187 a computer by using a markup language paradigm, an approach that breaks
188 with the obsolete tradition of the
189 \begin_inset Quotes eld
193 \begin_inset Quotes erd
197 It is designed for authors who want professional output quickly with a
198 minimum of effort and without becoming specialists in typesetting.
199 The job of typesetting is done mostly by the computer, not the author;
200 with \SpecialChar LyX
201 , the author can concentrate on the contents of his writing.
204 \begin_layout Standard
205 Part of the initial challenge of using \SpecialChar LyX
206 comes from the change in thinking
207 that you, the user, must make.
208 At one time, all we had for creating documents were typewriters, so we
209 all learned certain tricks to get around their limitations.
210 Underlining, which is little more than overstriking with the
211 \begin_inset Quotes eld
215 \begin_inset Quotes erd
218 character, became a way to emphasize text.
219 You were forced to figure out column sizes and tab stops, and set them,
220 before creating a table.
221 The same applied for letters and other right justified text.
222 Hyphenation at the end of a line required a careful eye and a lot of foresight.
225 \begin_layout Standard
226 In other words, we've all been trained to worry about the little details
227 of which character goes where.
228 Consequently, almost all word processors have this mentality.
229 They still use tab stops for adding whitespace.
230 You still need to worry about exactly where on the page something will
232 Emphasizing text means changing a font, similar to changing the typewriter
234 This is the underlying philosophy of a WYSIWYG word processor:
235 \begin_inset Quotes eld
238 What You See Is What You Get
239 \begin_inset Quotes erd
243 Unfortunately, that paradigm often results in
244 \begin_inset Quotes eld
247 What You See Is All You Get
248 \begin_inset Quotes erd
254 \begin_layout Standard
255 This is where \SpecialChar LyX
256 differs from an ordinary word processor.
257 You don't concern yourself with what character goes where.
258 You tell \SpecialChar LyX
264 takes care of the rest, following a set of rules called a
272 \begin_layout Plain Layout
273 To be fair, most recent versions of the most popular office suites now have
274 some sort of style sheets which follow a similar markup method.
275 However, our experience is that they are still rarely used in practice.
280 Let's look at a little example:
283 \begin_layout Standard
284 Suppose you are writing a report.
285 To begin your report, you want a section called
286 \begin_inset Quotes eld
289 Introduction\SpecialChar endofsentence
291 \begin_inset Quotes erd
294 So, you go into whatever menu it is in your word processor that changes
295 font sizes and decide on a new font size.
296 Then you turn on bold face.
298 \begin_inset Quotes eld
310 \begin_inset Quotes erd
314 Of course, if you later decide that this section belongs someplace else
315 in the document or if you insert a new section before it, you need to change
316 the numbering for this and all following sections, as well as any entry
317 in the table of contents.
320 \begin_layout Standard
322 , you go to the pull-down on the far left of the button bar and select
328 \begin_inset Quotes eld
332 \begin_inset Quotes erd
338 \begin_layout Standard
340 If you cut and paste the section, it will automatically be renumbered —
342 And if you enter references to that section correctly (by inserting cross-refer
343 ence tags), \SpecialChar LyX
344 will automatically update them all throughout the file so that
345 you never, ever type a section number.
348 \begin_layout Standard
349 Now let's look at the problem of consistency.
350 Five days later, you reopen your report and start Section
355 However, you forget that you were using 18
356 \begin_inset space \thinspace{}
359 pt bold instead of 16
360 \begin_inset space \thinspace{}
363 pt, so you type in the heading for Section
367 4 in a different font from the one you used for Section
372 That problem doesn't even exist in \SpecialChar LyX
374 The computer takes care of all that silly bookkeeping about which thing
375 has what size font, not you.
376 After all, that's what a computer is good at.
379 \begin_layout Standard
380 Here's another example.
381 Suppose you're making a list.
382 In other word processors, a list is just a bunch of tab stops and newlines.
383 You need to figure out where to put the label for each list item, what
384 that label should be, how many blank lines to put between each item, and
386 Under \SpecialChar LyX
387 , you have only two concerns: what kind of list is this, and what
388 do I want to put in it? That is it.
391 \begin_layout Standard
392 So, the basic idea behind \SpecialChar LyX
403 \begin_inset Quotes eld
406 What You See Is What You Get,
407 \begin_inset Quotes erd
412 \begin_inset Quotes eld
415 What You See Is What You
420 \begin_inset Quotes erd
424 \begin_inset Quotes eld
428 \begin_inset Quotes erd
431 It's a powerful idea that greatly simplifies the mechanics of writing documents.
432 This is also why \SpecialChar LyX
433 isn't so good for creating posters and flyers.
438 want to specify exactly where everything goes, because there are no functional
439 units like paragraphs, sections, etc.
440 This doesn't mean \SpecialChar LyX
441 is missing some cool function.
442 It simply means that it isn't the right tool for the job — you don't use
443 a screwdriver to drive in nails.
446 \begin_layout Subsection
447 Differences between \SpecialChar LyX
448 and Other Word Processors
449 \begin_inset Argument 1
452 \begin_layout Plain Layout
456 \begin_layout Plain Layout
470 \begin_layout Plain Layout
477 and Other Word Processors
485 \begin_layout Standard
486 Here's a list of things you won't find in \SpecialChar LyX
490 \begin_layout Itemize
494 \begin_layout Itemize
498 \begin_layout Itemize
500 \begin_inset space \thinspace{}
504 \begin_inset space \space{}
518 \begin_layout Standard
519 Tab stops, along with a ruler showing you the position of things on the
520 page, are useless in \SpecialChar LyX
522 The program worries about where things go on the page, not you.
523 Extra whitespace is similar; \SpecialChar LyX
524 adds it where necessary, depending on context.
525 Not being able to type two blank lines in a row will be annoying at first,
526 but it makes more sense once you're thinking in WYSIWYM terms.
529 \begin_layout Standard
530 Here are some things that exist in \SpecialChar LyX
531 , but aren't used as you might think:
534 \begin_layout Itemize
538 \begin_layout Itemize
542 \begin_layout Itemize
544 \begin_inset space \thinspace{}
548 \begin_inset space \space{}
551 single spaced, double spaced, etc.)
554 \begin_layout Itemize
555 Whitespace, horizontal and vertical
558 \begin_layout Itemize
562 \begin_layout Itemize
563 Typefaces (bold, italic, underline, etc.)
566 \begin_layout Standard
567 Although they exist in \SpecialChar LyX
568 , you generally don't need them.
570 will take care of these things for you, depending on what you're doing.
571 Different parts of the document are automatically set in a different typeface
573 Paragraph indenting is context dependent; different types of paragraphs
574 get indented differently.
575 Page breaks get handled automatically, as well.
576 In general, the space between lines, between words, and between paragraphs
577 is variable, set by \SpecialChar LyX
582 \begin_layout Plain Layout
583 There are ways to adjust all of these (only some of which require knowledge
584 of \SpecialChar LaTeX
585 ), either for a whole document or for a specific location in a document.
602 \begin_layout Standard
603 Lastly, there are a few areas where we believe \SpecialChar LyX
604 (and \SpecialChar LaTeX
605 ) surpasses many word
609 \begin_layout Itemize
613 \begin_layout Itemize
617 \begin_layout Itemize
621 \begin_layout Itemize
625 \begin_layout Itemize
629 \begin_layout Standard
630 Granted, many modern word processors can handle mathematical symbols, tables,
631 and hyphenation, and many have moved towards style definitions and the
633 However, they've only recently been able to do so, whereas \SpecialChar LyX
635 the \SpecialChar LaTeX
636 document preparation system.
638 has been around since 1985, and
645 \begin_layout Subsection
646 What is \SpecialChar LaTeX
650 \begin_layout Standard
652 is a document preparation system designed by Leslie Lamport in 1985.
656 \begin_layout Plain Layout
657 The source for the info in this section is
659 A Guide to \SpecialChar LaTeX2e
662 , by Helmut Kopka and Patrick Daly, which has an entry in the bibliography
667 \SpecialChar endofsentence
673 It was built up from a typesetting language called \SpecialChar TeX
677 takes a sequence of typesetting commands, written in a script in an ASCII
678 file, and executes them.
680 \begin_inset Quotes eld
684 \begin_inset Quotes erd
687 of the printing trade were modeled by Knuth as computer algorithms and
688 incorporated into \SpecialChar TeX
689 , hence its excellent printed appearance.
690 What comes directly out of \SpecialChar TeX
691 is the portable document format
696 \begin_inset Quotes eld
700 \begin_inset Quotes erd
708 The dvi format is often used for previews and can later be converted to
709 other formats like PostScript.
713 \begin_layout Standard
715 isn't only a typesetting engine; it also allows you to define macros.
716 Most people who use \SpecialChar TeX
717 are actually using a macro package which Knuth created
718 to hide a lot of the typesetting details.
719 This is where Leslie Lamport enters our story.
720 He wanted a macro package that was more user- and less typesetter-oriented,
721 with a set of commands that consistently typeset things like sections,
722 tables or math formulas in a uniform, consistent fashion.
723 This is how \SpecialChar LaTeX
727 \begin_layout Standard
728 Now, in parallel with the development and growth of \SpecialChar LaTeX
729 , other folks were creating
730 their own custom macro packages for \SpecialChar TeX
731 , ones to make slides or articles for
732 math journals and so on.
733 Some used the raw \SpecialChar TeX
734 facilities to do this, others began modifying \SpecialChar LaTeX
736 To try and unify this mess, a team of \SpecialChar LaTeX
737 -nicians began to work on \SpecialChar LaTeX2e
739 version of \SpecialChar LaTeX
740 , during the late 1980's.
741 This new version of \SpecialChar LaTeX
742 has commands which provide an easier-to-use interface
744 's macro-creating commands, aid in the use of new fonts, and so on.
745 In fact, \SpecialChar LaTeX
746 is quite an extensive language in its own right! Users around
747 the world have been creating their own add-ons for \SpecialChar LaTeX
752 \begin_layout Standard
753 There are two ways to extend \SpecialChar LaTeX
754 : classes and styles.
759 is a set of \SpecialChar LaTeX
760 macros describing a new type of document, like a book, or
762 There are classes for slides, for physics and math journals\SpecialChar ldots
764 even have a class for their thesis format.
769 differs from a class in that it doesn't define a new type of document,
770 but a different type of
774 that any document can use.
775 For example, \SpecialChar LyX
776 controls page margins and line spacing using two different
778 style-files designed for these purposes.
779 There are style-files for a whole slew of things: printing labels or envelopes,
780 changing indentation behavior, adding new fonts, manipulating graphics,
781 designing fancy page headings, customizing bibliographies, altering the
782 location and appearance of footnotes, tables, and figures, customizing
786 \begin_layout Standard
790 \begin_layout Description
792 : Typesetting language with macro capability.
795 \begin_layout Description
797 : Macro package built upon \SpecialChar TeX
798 \SpecialChar endofsentence
802 \begin_layout Description
803 classes: Descriptions of types of document used with \SpecialChar LaTeX
804 \SpecialChar endofsentence
808 \begin_layout Description
809 styles: Descriptions of the default behavior of particular elements of \SpecialChar LaTeX
813 \begin_layout Description
815 : Visual, WYSIWYM document processor that uses \SpecialChar LaTeX
816 to do its typesetting.
819 \begin_layout Standard
820 This section attempts to explain the difference between \SpecialChar LyX
821 and a word processor.
822 Simply put, \SpecialChar LaTeX
824 By using \SpecialChar LaTeX
825 as its backend, \SpecialChar LyX
826 helps you to think more about
835 The computer then handles
842 \begin_layout Section
843 Navigating the Documentation
846 \begin_layout Standard
847 To make it easier to answer your questions and describe all of the features
849 , the documentation has been split up into several different files.
850 Each one has its own purpose, as described below.
851 Before you go ploughing into any of those files, however, you should read
852 this chapter thoroughly, since it contains a lot of useful information
853 and commentary that can save you some time.
856 \begin_layout Standard
857 Hopefully, the development of \SpecialChar LyX
858 will never stop; so some of the documentation
859 may be incomplete or a bit out of date, though we try to keep up-to-date.
860 Like the rest of \SpecialChar LyX
861 , the manuals are the work of a group of volunteers who
863 \begin_inset Quotes eld
867 \begin_inset Quotes erd
870 , families, dishes to clean,
875 If you want to help out, be sure to read Section
880 \begin_inset CommandInset ref
882 reference "sec:Contrib"
886 in addition to the rest of this document.
889 \begin_layout Standard
890 Also, please do us a favor – if anything in these manuals confuses you,
891 is unclear, or wrong, don't hesitate to let us know! You can reach the
892 current document maintainers by emailing
893 \begin_inset CommandInset href
895 target "lyx-docs@lists.lyx.org"
902 If you have questions that are not obviously answered in the documentation,
903 and need help fast, there is an active users' mailing list which you can
905 \begin_inset CommandInset href
907 target "lyx-users@lists.lyx.org"
916 \begin_layout Subsection
917 The Format of the Manuals
920 \begin_layout Standard
921 Some of you may have printed out the manuals.
922 Others may be reading them within \SpecialChar LyX
924 There are some differences between the \SpecialChar LyX
925 -file and the printed version.
927 , the title is simply at the top of the document, not formatted on a
928 separate page as in some of the printed versions.
929 Nor are any of the footnotes or the Table of Contents fully visible.
930 To open a footnote, which looks like this:
931 \begin_inset Graphics
932 filename clipart/footnote.png
937 , click on it with the left mouse button.
938 For the Table of Contents, either click on the grey box or click on the
943 menu, where the contents are displayed automatically\SpecialChar endofsentence
947 \begin_layout Standard
948 In the printed manuals, all cross-references appear as the actual numbers
949 for a chapter, section, subsection, and so on.
950 In the \SpecialChar LyX
951 -file, however, all cross-references appear as light-grey boxes
953 \begin_inset Graphics
954 filename clipart/reference.png
960 If you click on such a box with the left mouse button, a dialog box will
961 appear containing a list of all the cross-references in the document.
962 You can go to the referenced section by right-clicking on the box or by
975 in the opened dialog.
976 Going back to where you came from is just as easy.
985 to go back to your earlier location.
988 \begin_layout Standard
989 Now that we've cleared up some of the differences between the printed and
991 -file versions of this file, we can start looking at the format of this
993 You'll occasionally notice things in different fonts:
996 \begin_layout Itemize
1001 is used for general emphasis, generic arguments, book titles, names of
1002 sections of other manuals, and notes from the authors.
1005 \begin_layout Itemize
1010 is used for program and file names, \SpecialChar LyX
1014 \begin_layout Itemize
1019 is used for menu, button, or dialog box names, and the names of keyboard
1023 \begin_layout Itemize
1028 is used for people's names.
1031 \begin_layout Itemize
1036 is used for \SpecialChar LaTeX
1040 \begin_layout Standard
1041 When we do need to reference keys, we'll use the following prefixing convention:
1044 \begin_layout Itemize
1045 \begin_inset Quotes eld
1053 \begin_inset Quotes erd
1063 \begin_layout Itemize
1064 \begin_inset Quotes eld
1072 \begin_inset Quotes erd
1082 \begin_layout Itemize
1083 \begin_inset Quotes eld
1091 \begin_inset Quotes erd
1105 \begin_layout Itemize
1106 \begin_inset Quotes eld
1114 \begin_inset Quotes erd
1119 \begin_inset Quotes eld
1127 \begin_inset Quotes erd
1130 are the function keys.
1133 \begin_layout Itemize
1134 \begin_inset Quotes eld
1142 \begin_inset Quotes erd
1148 \begin_layout Itemize
1149 \begin_inset Quotes eld
1157 \begin_inset Quotes erd
1161 \begin_inset Quotes eld
1169 \begin_inset Quotes erd
1173 \begin_inset Quotes eld
1181 \begin_inset Quotes erd
1185 \begin_inset Quotes eld
1193 \begin_inset Quotes erd
1199 \begin_layout Itemize
1202 \begin_inset Quotes eld
1208 \begin_inset Quotes erd
1212 \begin_inset Quotes eld
1220 \begin_inset Quotes erd
1224 \begin_inset Quotes eld
1232 \begin_inset Quotes erd
1236 \begin_inset Quotes eld
1244 \begin_inset Quotes erd
1248 \begin_inset Quotes eld
1256 \begin_inset Quotes erd
1260 \begin_inset Quotes eld
1268 \begin_inset Quotes erd
1272 \begin_inset space ~
1275 keys that appear above the cursor keys on many PC keyboards.
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
1313 \begin_inset Quotes eld
1321 \begin_inset Quotes erd
1327 \begin_layout Itemize
1336 both refer to the same key.
1337 Some keyboards label the
1342 \begin_inset Quotes eld
1346 \begin_inset Quotes erd
1350 \begin_inset Quotes eld
1354 \begin_inset Quotes erd
1357 still others have two keys.
1359 treats all of them as the same key, so we'll use
1370 \begin_layout Standard
1371 The list with the currently set shortcuts can be found in the
1382 \begin_layout Subsection
1383 Units used in the Manuals
1386 \begin_layout Standard
1387 To understand the units described in this documentation, Table
1388 \begin_inset space ~
1392 \begin_inset CommandInset ref
1394 reference "tab:Units"
1398 explains all units available in \SpecialChar LyX
1402 \begin_layout Standard
1403 \begin_inset Float table
1408 \begin_layout Plain Layout
1409 \begin_inset Caption Standard
1411 \begin_layout Plain Layout
1412 \begin_inset CommandInset label
1426 \begin_layout Plain Layout
1427 \begin_inset VSpace medskip
1433 \begin_layout Plain Layout
1435 \begin_inset Tabular
1436 <lyxtabular version="3" rows="20" columns="2">
1437 <features booktabs="true" tabularvalignment="middle">
1438 <column alignment="center" valignment="top" width="0pt">
1439 <column alignment="center" valignment="top">
1441 <cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
1444 \begin_layout Plain Layout
1450 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1453 \begin_layout Plain Layout
1461 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1464 \begin_layout Plain Layout
1470 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1473 \begin_layout Plain Layout
1481 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1484 \begin_layout Plain Layout
1490 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1493 \begin_layout Plain Layout
1501 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1504 \begin_layout Plain Layout
1510 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1513 \begin_layout Plain Layout
1515 \begin_inset space \thinspace{}
1519 \begin_inset space \thinspace{}
1529 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1532 \begin_layout Plain Layout
1538 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1541 \begin_layout Plain Layout
1543 \begin_inset space \thinspace{}
1547 \begin_inset space \thinspace{}
1557 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1560 \begin_layout Plain Layout
1566 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1569 \begin_layout Plain Layout
1571 \begin_inset space \thinspace{}
1575 \begin_inset space \thinspace{}
1585 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1588 \begin_layout Plain Layout
1594 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1597 \begin_layout Plain Layout
1599 \begin_inset space \thinspace{}
1603 \begin_inset space \thinspace{}
1613 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1616 \begin_layout Plain Layout
1622 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1625 \begin_layout Plain Layout
1627 \begin_inset space \thinspace{}
1631 \begin_inset space \thinspace{}
1641 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1644 \begin_layout Plain Layout
1650 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1653 \begin_layout Plain Layout
1655 \begin_inset space \thinspace{}
1659 \begin_inset Formula $\approx$
1663 \begin_inset space \thinspace{}
1673 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1676 \begin_layout Plain Layout
1682 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1685 \begin_layout Plain Layout
1687 \begin_inset space \thinspace{}
1691 \begin_inset space \thinspace{}
1701 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1704 \begin_layout Plain Layout
1710 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1713 \begin_layout Plain Layout
1714 % of original image width
1721 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1724 \begin_layout Plain Layout
1730 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1733 \begin_layout Plain Layout
1741 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1744 \begin_layout Plain Layout
1750 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1753 \begin_layout Plain Layout
1761 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1764 \begin_layout Plain Layout
1770 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1773 \begin_layout Plain Layout
1781 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1784 \begin_layout Plain Layout
1790 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1793 \begin_layout Plain Layout
1801 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1804 \begin_layout Plain Layout
1810 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1813 \begin_layout Plain Layout
1821 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1824 \begin_layout Plain Layout
1830 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1833 \begin_layout Plain Layout
1841 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1844 \begin_layout Plain Layout
1850 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1853 \begin_layout Plain Layout
1865 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1868 \begin_layout Plain Layout
1874 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1877 \begin_layout Plain Layout
1889 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1892 \begin_layout Plain Layout
1898 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1901 \begin_layout Plain Layout
1903 \begin_inset space \thinspace{}
1907 \begin_inset space \thinspace{}
1928 \begin_layout Subsection
1932 \begin_layout Standard
1933 The following list describes the contents of the basic documentation files
1934 that you find in the
1941 \begin_layout Description
1942 Introduction This file.
1945 \begin_layout Description
1946 Tutorial If you are new to \SpecialChar LyX
1947 , and have never used \SpecialChar LaTeX
1948 before, you should start
1950 If you have used \SpecialChar LaTeX
1951 before, you should still read the
1955 , starting with the section on
1956 \begin_inset Quotes eld
1960 for \SpecialChar LaTeX
1962 \begin_inset Quotes erd
1965 (Skimming through the rest of the document wouldn't hurt, either.)
1968 \begin_layout Description
1970 \begin_inset space ~
1973 Guide The primary documentation.
1978 of the basic operation and available features of \SpecialChar LyX
1980 The main manual assumes that you have read the
1987 \begin_layout Description
1989 \begin_inset space ~
1992 Objects Extension of the
1997 Documents in detail how to use tables, graphics, floats, notes, program
1999 It also includes many tricks of the \SpecialChar LaTeX
2003 \begin_layout Description
2004 Math Extension of the
2009 Documents in detail how to typeset any kind of formula.
2012 \begin_layout Description
2014 \begin_inset space ~
2017 Features Extension of the
2022 Documents how to use raw \SpecialChar LaTeX
2023 commands, additional layouts and special-purpose
2027 \begin_layout Description
2028 Customization A description of advanced \SpecialChar LyX
2029 features, including how to customize
2030 the overall behavior of \SpecialChar LyX
2031 \SpecialChar endofsentence
2032 This includes such things as keybindings, internationa
2033 lization and configuration files.
2034 It also includes information about layout files, which are needed to get
2036 to support \SpecialChar LaTeX
2037 classes or packages.
2040 \begin_layout Description
2041 Shortcuts Tables of the currently defined \SpecialChar LyX
2045 \begin_layout Description
2048 \begin_inset space ~
2051 Configuration A report produced by \SpecialChar LyX
2053 This file contains information on what \SpecialChar LyX
2054 learned about your installation.
2055 Check it to see if you're missing something you might like to have.
2058 \begin_layout Standard
2059 These files will reference one another as necessary.
2068 information on installation and customization, but refers the reader to
2071 Customization Manual
2073 for more information.
2076 \begin_layout Standard
2077 We'll state again an important point:
2080 \begin_layout Standard
2081 \begin_inset VSpace bigskip
2087 \begin_layout Standard
2089 If you are new to \SpecialChar LyX
2095 Now\SpecialChar endofsentence
2099 \begin_layout Standard
2100 \begin_inset VSpace bigskip
2106 \begin_layout Standard
2107 Otherwise, you could needlessly frustrate yourself.
2110 \begin_layout Section
2111 Contributing to the \SpecialChar LyX
2113 \begin_inset CommandInset label
2122 \begin_layout Subsection
2123 Contributing to \SpecialChar LyX
2127 \begin_layout Standard
2129 is mostly written in C++ (the \SpecialChar LaTeX
2130 importer is written in Python).
2131 It is a large project, and as a result it is not free from bugs, or the
2132 need for improvements in the source code.
2135 \begin_layout Subsubsection
2139 \begin_layout Standard
2140 While using \SpecialChar LyX
2141 , you may find behavior which you consider a bug.
2142 Crashes, though rare, can happen.
2143 User interface problems are considered major bugs by the \SpecialChar LyX
2145 helpful are indications of parts of the \SpecialChar LyX
2146 interface you find confusing,
2150 \begin_layout Standard
2152 has a bug tracking system, which you can find at
2153 \begin_inset Newline newline
2157 \begin_inset CommandInset href
2159 target "http://www.lyx.org/trac/wiki/BugTrackerHome"
2164 You should check the bug tracker before reporting any bugs, in case it
2165 has already been reported.
2166 If you have a comment on an existing bug, or wish to report a new bug,
2167 you may either use the bug tracker, or send an e-mail to the development
2169 \begin_inset CommandInset href
2171 target "lyx-devel@lists.lyx.org"
2178 Archives of this list are linked from the main \SpecialChar LyX
2180 \begin_inset CommandInset href
2182 target "http://www.lyx.org"
2189 \begin_layout Standard
2190 A useful bug report will at a minimum include the version of \SpecialChar LyX
2193 Accurate, detailed descriptions are preferred — the more time developers
2194 have to spend to pinpoint the source of a bug, the less time they have
2195 for other improvements.
2196 Mention the system and system version on which you are running \SpecialChar LyX
2198 Give the versions of the libraries you have installed on your system, and,
2199 if relevant, the versions of external programs that \SpecialChar LyX
2201 If it's a compilation or configuration problem, include the file
2205 , and mention which compiler you are using.
2208 \begin_layout Subsubsection
2209 Contributing fixes and new features
2212 \begin_layout Standard
2213 If you have made changes to \SpecialChar LyX
2214 's source that you think should become part
2216 , send your changes as a diff file (in unified format) to the development
2217 list referenced above, along with a change log, and a description of what
2221 \begin_layout Subsection
2222 Contributing to the Documentation
2225 \begin_layout Standard
2227 's documentation is extensive; however \SpecialChar LyX
2228 is under constant development, and
2229 each new release adds new features.
2230 You may find some documentation needs improvement.
2231 This section describes what to do if you find an error, or have some suggestion
2232 s for improving the documentation.
2235 \begin_layout Subsubsection
2236 Reporting Errors in the Manuals
2239 \begin_layout Standard
2240 If you find a problem with the documentation, send a message to the mailing
2242 \begin_inset CommandInset href
2244 target "lyx-docs@lists.lyx.org"
2251 The documentation team will make any necessary fixes.
2254 \begin_layout Subsubsection
2255 Joining the Documentation Team.
2258 \begin_layout Standard
2259 The \SpecialChar LyX
2260 Documentation Project, like anything else in the \SpecialChar LyX
2262 use assistance! If you're interested in contributing to the Documentation
2263 Project, you need to do the following:
2266 \begin_layout Enumerate
2267 Get the latest \SpecialChar LyX
2269 \begin_inset Newline newline
2273 \begin_inset CommandInset href
2275 target "http://www.lyx.org/trac/browser/lyxgit/lib/doc?rev=master "
2282 \begin_layout Enumerate
2292 \begin_inset Newline newline
2295 The point of this exercise is to give you ideas.
2304 are likely to be the most up-to-date of all of the documentation.
2305 You should be able to glean some insights into how we want the manuals
2306 to read and to look.
2309 \begin_layout Enumerate
2310 Contact the team at:
2311 \begin_inset Newline newline
2315 \begin_inset CommandInset href
2317 target "lyx-docs@lists.lyx.org"
2324 \begin_inset Newline newline
2327 to discuss your intended changes and to get some feedback on them.
2330 \begin_layout Standard
2331 The changes you wish to make may range from improving clarity of the text,
2332 to doing major re-structuring of the documentation.
2333 Any and all improvements are gladly received.