1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
5 \save_transient_properties true
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 no
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
43 \font_typewriter_osf false
44 \font_sf_scale 100 100
45 \font_tt_scale 100 100
47 \use_dash_ligatures false
49 \default_output_format pdf2
51 \bibtex_command default
52 \index_command default
56 \pdf_title "Introduction to LyX"
57 \pdf_author "LyX Team"
58 \pdf_subject "LyX-documentation Intro"
59 \pdf_keywords "LyX, documentation"
61 \pdf_bookmarksnumbered true
62 \pdf_bookmarksopen true
63 \pdf_bookmarksopenlevel 2
68 \pdf_pdfusetitle false
69 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
72 \use_package amsmath 1
73 \use_package amssymb 1
76 \use_package mathdots 1
77 \use_package mathtools 1
79 \use_package stackrel 1
80 \use_package stmaryrd 1
81 \use_package undertilde 1
83 \cite_engine_type default
87 \paperorientation portrait
99 \paragraph_separation indent
100 \paragraph_indentation default
102 \math_numbering_side default
103 \quotes_style english
107 \paperpagestyle default
109 \tracking_changes true
112 \postpone_fragile_content false
115 \html_be_strict false
116 \docbook_table_output 0
117 \author 193470694 "Sam"
123 Introduction to \SpecialChar LyX
128 by the \SpecialChar LyX
133 \begin_layout Plain Layout
135 If you have comments on or corrections to this documentation, please send
136 them to the \SpecialChar LyX
137 Documentation mailing list:
138 \begin_inset CommandInset href
140 target "lyx-docs@lists.lyx.org"
154 \begin_layout Standard
155 \begin_inset CommandInset toc
156 LatexCommand tableofcontents
163 \begin_layout Section
164 The Philosophy of \SpecialChar LyX
168 \begin_layout Subsection
169 What is \SpecialChar LyX
173 \begin_layout Standard
175 is a document preparation system.
176 It excels at letting you create complex technical and scientific articles
177 with mathematics, cross-references, bibliographies, indexes, etc.
178 It is very good for working with documents of any length in which the usual
179 processing abilities are required: automatic sectioning and pagination,
180 spell checking and so forth.
181 It can also be used to write a letter to your mom, though granted, there
182 are probably simpler programs available for that.
183 It is definitely not the best tool for creating banners, flyers, or advertiseme
184 nts (we'll explain why later), though with some effort all these can be
186 Here are some examples of what it is used for: memos, letters, dissertations
187 and theses, lecture notes, seminar notebooks, conference proceedings, software
188 documentation, books, articles in refereed scientific journals, scripts
189 for plays and movies, business proposals, presentations \SpecialChar ldots
193 \begin_layout Standard
195 \change_deleted 193470694 1604722085
197 is a program that provides a modern approach to writing documents with
198 a computer by using a markup language paradigm, an approach that breaks
199 with the obsolete tradition of the
200 \begin_inset Quotes eld
204 \begin_inset Quotes erd
208 It is designed for authors who want professional output quickly with a
209 minimum of effort and without becoming specialists in typesetting.
210 The job of typesetting is done mostly by the computer, not the author;
211 with \SpecialChar LyX
212 , the author can concentrate on the contents of his writing.
215 \begin_layout Standard
216 Part of the initial challenge of using \SpecialChar LyX
217 comes from the change in thinking
218 that you, the user, must make.
219 At one time, all we had for creating documents were typewriters, so we
220 all learned certain tricks to get around their limitations.
221 Underlining, which is little more than overstriking with the
222 \begin_inset Quotes eld
226 \begin_inset Quotes erd
229 character, became a way to emphasize text.
230 You were forced to figure out column sizes and tab stops, and set them,
231 before creating a table.
232 The same applied for letters and other right justified text.
233 Hyphenation at the end of a line required a careful eye and a lot of foresight.
236 \begin_layout Standard
237 In other words, we've all been trained to worry about the little details
238 of which character goes where.
239 Consequently, almost all word processors have this mentality.
240 They still use tab stops for adding whitespace.
241 You still need to worry about exactly where on the page something will
243 Emphasizing text means changing a font, similar to changing the typewriter
245 This is the underlying philosophy of a WYSIWYG word processor:
246 \begin_inset Quotes eld
249 What You See Is What You Get
250 \begin_inset Quotes erd
254 Unfortunately, that paradigm often results in
255 \begin_inset Quotes eld
258 What You See Is All You Get
259 \begin_inset Quotes erd
265 \begin_layout Standard
266 This is where \SpecialChar LyX
267 differs from an ordinary word processor.
268 You don't concern yourself with what character goes where.
269 You tell \SpecialChar LyX
275 takes care of the rest, following a set of rules called a
280 \change_deleted 193470694 1604722085
285 \begin_layout Plain Layout
286 To be fair, most recent versions of the most popular office suites now have
287 some sort of style sheets which follow a similar markup method.
288 However, our experience is that they are still rarely used in practice.
295 Let's look at a little example:
298 \begin_layout Standard
299 Suppose you are writing a report.
300 To begin your report, you want a section called
301 \begin_inset Quotes eld
304 Introduction\SpecialChar endofsentence
306 \begin_inset Quotes erd
309 So, you go into whatever menu it is in your word processor that changes
310 font sizes and decide on a new font size.
311 Then you turn on bold face.
313 \begin_inset Quotes eld
325 \begin_inset Quotes erd
329 Of course, if you later decide that this section belongs someplace else
330 in the document or if you insert a new section before it, you need to change
331 the numbering for this and all following sections, as well as any entry
332 in the table of contents.
335 \begin_layout Standard
337 , you go to the pull-down on the far left of the button bar and select
343 \begin_inset Quotes eld
347 \begin_inset Quotes erd
353 \begin_layout Standard
355 If you cut and paste the section, it will automatically be renumbered —
357 And if you enter references to that section correctly (by inserting cross-refer
358 ence tags), \SpecialChar LyX
359 will automatically update them all throughout the file so that
360 you never, ever type a section number.
363 \begin_layout Standard
364 Now let's look at the problem of consistency.
365 Five days later, you reopen your report and start Section
370 However, you forget that you were using 18
371 \begin_inset space \thinspace{}
374 pt bold instead of 16
375 \begin_inset space \thinspace{}
378 pt, so you type in the heading for Section
382 4 in a different font from the one you used for Section
387 That problem doesn't even exist in \SpecialChar LyX
389 The computer takes care of all that silly bookkeeping about which thing
390 has what size font, not you.
391 After all, that's what a computer is good at.
394 \begin_layout Standard
395 Here's another example.
396 Suppose you're making a list.
397 In other word processors, a list is just a bunch of tab stops and newlines.
398 You need to figure out where to put the label for each list item, what
399 that label should be, how many blank lines to put between each item, and
401 Under \SpecialChar LyX
402 , you have only two concerns: what kind of list is this, and what
403 do I want to put in it? That is it.
406 \begin_layout Standard
407 So, the basic idea behind \SpecialChar LyX
418 \begin_inset Quotes eld
421 What You See Is What You Get,
422 \begin_inset Quotes erd
427 \begin_inset Quotes eld
430 What You See Is What You
435 \begin_inset Quotes erd
439 \begin_inset Quotes eld
443 \begin_inset Quotes erd
446 It's a powerful idea that greatly simplifies the mechanics of writing documents.
447 This is also why \SpecialChar LyX
448 isn't so good for creating posters and flyers.
453 want to specify exactly where everything goes, because there are no functional
454 units like paragraphs, sections, etc.
455 This doesn't mean \SpecialChar LyX
456 is missing some cool function.
457 It simply means that it isn't the right tool for the job — you don't use
459 \change_inserted 193470694 1604722085
463 \begin_layout Standard
465 \change_inserted 193470694 1604722085
467 If you cut and paste the section, it will automat
470 \change_inserted 193470694 1604722085
471 cally be renumbered — e
474 \change_inserted 193470694 1604722085
476 And if you enter references to that section corr
479 \change_inserted 193470694 1604722085
483 \change_inserted 193470694 1604722085
487 \change_inserted 193470694 1604722085
491 \change_inserted 193470694 1604722085
495 \change_inserted 193470694 1604722085
496 gs), \SpecialChar LyX
497 will automatically update them all throughout the f
500 \change_inserted 193470694 1604722085
504 \change_inserted 193470694 1604722085
505 o that you never, ever type a section number
510 \begin_layout Subsection
511 Differences between \SpecialChar LyX
513 \change_inserted 193470694 1604722085
519 \begin_layout Standard
520 Here's a list of things you won't find in \SpecialChar LyX
524 \begin_layout Itemize
528 \begin_layout Itemize
532 \begin_layout Itemize
534 \begin_inset space \thinspace{}
538 \begin_inset space \space{}
552 \begin_layout Standard
553 Tab stops, along with a ruler showing you the position of things on the
554 page, are useless in \SpecialChar LyX
556 The program worries about where things go on the page, not you.
557 Extra whitespace is similar; \SpecialChar LyX
558 adds it where necessary, depending on context.
559 Not being able to type two blank lines in a row will be annoying at first,
560 but it makes more sense once you're thinking in WYSIWYM terms.
563 \begin_layout Standard
564 Here are some things that exist in \SpecialChar LyX
565 , but aren't used as you might think:
568 \begin_layout Itemize
572 \begin_layout Itemize
576 \begin_layout Itemize
578 \begin_inset space \thinspace{}
582 \begin_inset space \space{}
585 single spaced, double spaced, etc.)
588 \begin_layout Itemize
589 Whitespace, horizontal and vertical
592 \begin_layout Itemize
596 \begin_layout Itemize
597 Typefaces (bold, italic, underline, etc.)
600 \begin_layout Standard
601 Although they exist in \SpecialChar LyX
602 , you generally don't need them.
604 will take care of these things for you, depending on what you're doing.
605 Different parts of the document are automatically set in a different typeface
607 Paragraph indenting is context dependent; different types of paragraphs
608 get indented differently.
609 Page breaks get handled automatically, as well.
610 In general, the space between lines, between words, and between paragraphs
611 is variable, set by \SpecialChar LyX
616 \begin_layout Plain Layout
617 There are ways to adjust all of these (only some of which require knowledge
618 of \SpecialChar LaTeX
619 ), either for a whole document or for a specific location in a document.
636 \begin_layout Standard
637 Lastly, there are a few areas where we believe \SpecialChar LyX
638 (and \SpecialChar LaTeX
639 ) surpasses many word
643 \begin_layout Itemize
647 \begin_layout Itemize
651 \begin_layout Itemize
655 \begin_layout Itemize
659 \begin_layout Itemize
663 \begin_layout Standard
664 Granted, many modern word processors can handle mathematical symbols, tables,
665 and hyphenation, and many have moved towards style definitions and the
667 However, they've only recently been able to do so, whereas \SpecialChar LyX
669 the \SpecialChar LaTeX
670 document preparation system.
672 has been around since 1985, and
679 \begin_layout Subsection
680 What is \SpecialChar LaTeX
684 \begin_layout Standard
686 is a document preparation system designed by Leslie Lamport in 1985.
690 \begin_layout Plain Layout
691 The source for the info in this section is
693 A Guide to \SpecialChar LaTeX2e
696 , by Helmut Kopka and Patrick Daly, which has an entry in the bibliography
701 \SpecialChar endofsentence
707 It was built up from a typesetting language called \SpecialChar TeX
711 takes a sequence of typesetting commands, written in a script in an ASCII
712 file, and executes them.
714 \begin_inset Quotes eld
718 \begin_inset Quotes erd
721 of the printing trade were modeled by Knuth as computer algorithms and
722 incorporated into \SpecialChar TeX
723 , hence its excellent printed appearance.
724 What comes directly out of \SpecialChar TeX
725 is the portable document format
730 \begin_inset Quotes eld
734 \begin_inset Quotes erd
742 The dvi format is often used for previews and can later be converted to
743 other formats like PostScript.
747 \begin_layout Standard
749 isn't only a typesetting engine; it also allows you to define macros.
750 Most people who use \SpecialChar TeX
751 are actually using a macro package which Knuth created
752 to hide a lot of the typesetting details.
753 This is where Leslie Lamport enters our story.
754 He wanted a macro package that was more user- and less typesetter-oriented,
755 with a set of commands that consistently typeset things like sections,
756 tables or math formulas in a uniform, consistent fashion.
757 This is how \SpecialChar LaTeX
761 \begin_layout Standard
762 Now, in parallel with the development and growth of \SpecialChar LaTeX
763 , other folks were creating
764 their own custom macro packages for \SpecialChar TeX
765 , ones to make slides or articles for
766 math journals and so on.
767 Some used the raw \SpecialChar TeX
768 facilities to do this, others began modifying \SpecialChar LaTeX
770 To try and unify this mess, a team of \SpecialChar LaTeX
771 -nicians began to work on \SpecialChar LaTeX2e
773 version of \SpecialChar LaTeX
774 , during the late 1980's.
775 This new version of \SpecialChar LaTeX
776 has commands which provide an easier-to-use interface
778 's macro-creating commands, aid in the use of new fonts, and so on.
779 In fact, \SpecialChar LaTeX
780 is quite an extensive language in its own right! Users around
781 the world have been creating their own add-ons for \SpecialChar LaTeX
786 \begin_layout Standard
787 There are two ways to extend \SpecialChar LaTeX
788 : classes and styles.
793 is a set of \SpecialChar LaTeX
794 macros describing a new type of document, like a book, or
796 There are classes for slides, for physics and math journals\SpecialChar ldots
798 even have a class for their thesis format.
803 differs from a class in that it doesn't define a new type of document,
804 but a different type of
808 that any document can use.
809 For example, \SpecialChar LyX
810 controls page margins and line spacing using two different
812 style-files designed for these purposes.
813 There are style-files for a whole slew of things: printing labels or envelopes,
814 changing indentation behavior, adding new fonts, manipulating graphics,
815 designing fancy page headings, customizing bibliographies, altering the
816 location and appearance of footnotes, tables, and figures, customizing
820 \begin_layout Standard
824 \begin_layout Description
826 : Typesetting language with macro capability.
829 \begin_layout Description
831 : Macro package built upon \SpecialChar TeX
832 \SpecialChar endofsentence
836 \begin_layout Description
837 classes: Descriptions of types of document used with \SpecialChar LaTeX
838 \SpecialChar endofsentence
842 \begin_layout Description
843 styles: Descriptions of the default behavior of particular elements of \SpecialChar LaTeX
847 \begin_layout Description
849 : Visual, WYSIWYM document processor that uses \SpecialChar LaTeX
850 to do its typesetting.
853 \begin_layout Standard
854 This section attempts to explain the difference between \SpecialChar LyX
855 and a word processor.
856 Simply put, \SpecialChar LaTeX
858 By using \SpecialChar LaTeX
859 as its backend, \SpecialChar LyX
860 helps you to think more about
869 The computer then handles
876 \begin_layout Section
877 Navigating the Documentation
880 \begin_layout Standard
881 To make it easier to answer your questions and describe all of the features
883 , the documentation has been split up into several different files.
884 Each one has its own purpose, as described below.
885 Before you go ploughing into any of those files, however, you should read
886 this chapter thoroughly, since it contains a lot of useful information
887 and commentary that can save you some time.
890 \begin_layout Standard
891 Hopefully, the development of \SpecialChar LyX
892 will never stop; so some of the documentation
893 may be incomplete or a bit out of date, though we try to keep up-to-date.
894 Like the rest of \SpecialChar LyX
895 , the manuals are the work of a group of volunteers who
897 \begin_inset Quotes eld
901 \begin_inset Quotes erd
904 , families, dishes to clean,
909 If you want to help out, be sure to read Section
914 \begin_inset CommandInset ref
916 reference "sec:Contrib"
920 in addition to the rest of this document.
923 \begin_layout Standard
924 Also, please do us a favor – if anything in these manuals confuses you,
925 is unclear, or wrong, don't hesitate to let us know! You can reach the
926 current document maintainers by emailing
927 \begin_inset CommandInset href
929 target "lyx-docs@lists.lyx.org"
936 If you have questions that are not obviously answered in the documentation,
937 and need help fast, there is an active users' mailing list which you can
939 \begin_inset CommandInset href
941 target "lyx-users@lists.lyx.org"
950 \begin_layout Subsection
951 The Format of the Manuals
954 \begin_layout Standard
955 Some of you may have printed out the manuals.
956 Others may be reading them within \SpecialChar LyX
958 There are some differences between the \SpecialChar LyX
959 -file and the printed version.
961 , the title is simply at the top of the document, not formatted on a
962 separate page as in some of the printed versions.
963 Nor are any of the footnotes or the Table of Contents fully visible.
964 To open a footnote, which looks like this:
965 \begin_inset Graphics
966 filename ../../../../lib/doc/clipart/footnote.png
971 , click on it with the left mouse button.
972 For the Table of Contents, either click on the grey box or click on the
977 menu, where the contents are displayed automatically\SpecialChar endofsentence
981 \begin_layout Standard
982 In the printed manuals, all cross-references appear as the actual numbers
983 for a chapter, section, subsection, and so on.
984 In the \SpecialChar LyX
985 -file, however, all cross-references appear as light-grey boxes
987 \begin_inset Graphics
988 filename ../../../../lib/doc/clipart/reference.png
994 If you click on such a box with the left mouse button, a dialog box will
995 appear containing a list of all the cross-references in the document.
996 You can go to the referenced section by right-clicking on the box or by
1000 \begin_inset space ~
1004 \begin_inset space ~
1009 in the opened dialog.
1010 Going back to where you came from is just as easy.
1014 \begin_inset space ~
1019 to go back to your earlier location.
1022 \begin_layout Standard
1023 Now that we've cleared up some of the differences between the printed and
1025 -file versions of this file, we can start looking at the format of this
1027 You'll occasionally notice things in different fonts:
1030 \begin_layout Itemize
1035 is used for general emphasis, generic arguments, book titles, names of
1036 sections of other manuals, and notes from the authors.
1039 \begin_layout Itemize
1044 is used for program and file names, \SpecialChar LyX
1048 \begin_layout Itemize
1053 is used for menu, button, or dialog box names, and the names of keyboard
1057 \begin_layout Itemize
1062 is used for people's names.
1065 \begin_layout Itemize
1070 is used for \SpecialChar LaTeX
1074 \begin_layout Standard
1075 When we do need to reference keys, we'll use the following prefixing convention:
1078 \begin_layout Itemize
1079 \begin_inset Quotes eld
1087 \begin_inset Quotes erd
1097 \begin_layout Itemize
1098 \begin_inset Quotes eld
1106 \begin_inset Quotes erd
1116 \begin_layout Itemize
1117 \begin_inset Quotes eld
1125 \begin_inset Quotes erd
1139 \begin_layout Itemize
1140 \begin_inset Quotes eld
1148 \begin_inset Quotes erd
1153 \begin_inset Quotes eld
1161 \begin_inset Quotes erd
1164 are the function keys.
1167 \begin_layout Itemize
1168 \begin_inset Quotes eld
1176 \begin_inset Quotes erd
1182 \begin_layout Itemize
1183 \begin_inset Quotes eld
1191 \begin_inset Quotes erd
1195 \begin_inset Quotes eld
1203 \begin_inset Quotes erd
1207 \begin_inset Quotes eld
1215 \begin_inset Quotes erd
1219 \begin_inset Quotes eld
1227 \begin_inset Quotes erd
1233 \begin_layout Itemize
1236 \begin_inset Quotes eld
1242 \begin_inset Quotes erd
1246 \begin_inset Quotes eld
1254 \begin_inset Quotes erd
1258 \begin_inset Quotes eld
1266 \begin_inset Quotes erd
1270 \begin_inset Quotes eld
1278 \begin_inset Quotes erd
1282 \begin_inset Quotes eld
1290 \begin_inset Quotes erd
1294 \begin_inset Quotes eld
1302 \begin_inset Quotes erd
1306 \begin_inset space ~
1309 keys that appear above the cursor keys on many PC keyboards.
1311 \begin_inset Quotes eld
1319 \begin_inset Quotes erd
1323 \begin_inset Quotes eld
1331 \begin_inset Quotes erd
1335 \begin_inset Quotes eld
1343 \begin_inset Quotes erd
1347 \begin_inset Quotes eld
1355 \begin_inset Quotes erd
1361 \begin_layout Itemize
1370 both refer to the same key.
1371 Some keyboards label the
1376 \begin_inset Quotes eld
1380 \begin_inset Quotes erd
1384 \begin_inset Quotes eld
1388 \begin_inset Quotes erd
1391 still others have two keys.
1393 treats all of them as the same key, so we'll use
1404 \begin_layout Standard
1405 The list with the currently set shortcuts can be found in the
1416 \begin_layout Subsection
1417 Units used in the Manuals
1420 \begin_layout Standard
1421 To understand the units described in this documentation, Table
1422 \begin_inset space ~
1426 \begin_inset CommandInset ref
1428 reference "tab:Units"
1432 explains all units available in \SpecialChar LyX
1436 \begin_layout Standard
1437 \begin_inset Float table
1444 \begin_layout Plain Layout
1445 \begin_inset Caption Standard
1447 \begin_layout Plain Layout
1448 \begin_inset CommandInset label
1462 \begin_layout Plain Layout
1463 \begin_inset VSpace medskip
1469 \begin_layout Plain Layout
1471 \begin_inset Tabular
1472 <lyxtabular version="3" rows="20" columns="2">
1473 <features booktabs="true" tabularvalignment="middle">
1474 <column alignment="center" valignment="top" width="0pt">
1475 <column alignment="center" valignment="top">
1477 <cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
1480 \begin_layout Plain Layout
1486 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1489 \begin_layout Plain Layout
1497 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1500 \begin_layout Plain Layout
1506 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1509 \begin_layout Plain Layout
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
1537 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1540 \begin_layout Plain Layout
1546 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1549 \begin_layout Plain Layout
1551 \begin_inset space \thinspace{}
1555 \begin_inset space \thinspace{}
1565 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1568 \begin_layout Plain Layout
1574 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1577 \begin_layout Plain Layout
1579 \begin_inset space \thinspace{}
1583 \begin_inset space \thinspace{}
1593 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1596 \begin_layout Plain Layout
1602 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1605 \begin_layout Plain Layout
1607 \begin_inset space \thinspace{}
1611 \begin_inset space \thinspace{}
1621 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1624 \begin_layout Plain Layout
1630 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1633 \begin_layout Plain Layout
1635 \begin_inset space \thinspace{}
1639 \begin_inset space \thinspace{}
1649 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1652 \begin_layout Plain Layout
1658 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1661 \begin_layout Plain Layout
1663 \begin_inset space \thinspace{}
1667 \begin_inset space \thinspace{}
1677 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1680 \begin_layout Plain Layout
1686 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1689 \begin_layout Plain Layout
1691 \begin_inset space \thinspace{}
1695 \begin_inset Formula $\approx$
1699 \begin_inset space \thinspace{}
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
1723 \begin_inset space \thinspace{}
1727 \begin_inset space \thinspace{}
1737 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1740 \begin_layout Plain Layout
1746 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1749 \begin_layout Plain Layout
1750 % of original image width
1757 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1760 \begin_layout Plain Layout
1766 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1769 \begin_layout Plain Layout
1777 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1780 \begin_layout Plain Layout
1786 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1789 \begin_layout Plain Layout
1797 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1800 \begin_layout Plain Layout
1806 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1809 \begin_layout Plain Layout
1817 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1820 \begin_layout Plain Layout
1826 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1829 \begin_layout Plain Layout
1837 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1840 \begin_layout Plain Layout
1846 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1849 \begin_layout Plain Layout
1857 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1860 \begin_layout Plain Layout
1866 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1869 \begin_layout Plain Layout
1877 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1880 \begin_layout Plain Layout
1886 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1889 \begin_layout Plain Layout
1901 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1904 \begin_layout Plain Layout
1910 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1913 \begin_layout Plain Layout
1925 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1928 \begin_layout Plain Layout
1934 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1937 \begin_layout Plain Layout
1939 \begin_inset space \thinspace{}
1943 \begin_inset space \thinspace{}
1964 \begin_layout Subsection
1968 \begin_layout Standard
1969 The following list describes the contents of the basic documentation files
1970 that you find in the
1977 \begin_layout Description
1978 Introduction This file.
1981 \begin_layout Description
1982 Tutorial If you are new to \SpecialChar LyX
1983 , and have never used \SpecialChar LaTeX
1984 before, you should start
1986 If you have used \SpecialChar LaTeX
1987 before, you should still read the
1991 , starting with the section on
1992 \begin_inset Quotes eld
1996 for \SpecialChar LaTeX
1998 \begin_inset Quotes erd
2001 (Skimming through the rest of the document wouldn't hurt, either.)
2004 \begin_layout Description
2006 \begin_inset space ~
2009 Guide The primary documentation.
2014 of the basic operation and available features of \SpecialChar LyX
2016 The main manual assumes that you have read the
2023 \begin_layout Description
2025 \begin_inset space ~
2028 Objects Extension of the
2033 Documents in detail how to use tables, graphics, floats, notes, program
2035 It also includes many tricks of the \SpecialChar LaTeX
2039 \begin_layout Description
2040 Math Extension of the
2045 Documents in detail how to typeset any kind of formula.
2048 \begin_layout Description
2050 \begin_inset space ~
2053 Features Extension of the
2058 Documents how to use raw \SpecialChar LaTeX
2059 commands, additional layouts and special-purpose
2063 \begin_layout Description
2064 Customization A description of advanced \SpecialChar LyX
2065 features, including how to customize
2066 the overall behavior of \SpecialChar LyX
2067 \SpecialChar endofsentence
2068 This includes such things as keybindings, internationa
2069 lization and configuration files.
2070 It also includes information about layout files, which are needed to get
2072 to support \SpecialChar LaTeX
2073 classes or packages.
2076 \begin_layout Description
2077 Shortcuts Tables of the currently defined \SpecialChar LyX
2081 \begin_layout Description
2084 \begin_inset space ~
2087 Configuration A report produced by \SpecialChar LyX
2089 This file contains information on what \SpecialChar LyX
2090 learned about your installation.
2091 Check it to see if you're missing something you might like to have.
2094 \begin_layout Standard
2095 These files will reference one another as necessary.
2104 information on installation and customization, but refers the reader to
2107 Customization Manual
2109 for more information.
2112 \begin_layout Standard
2113 We'll state again an important point:
2116 \begin_layout Standard
2117 \begin_inset VSpace bigskip
2123 \begin_layout Standard
2125 If you are new to \SpecialChar LyX
2131 Now\SpecialChar endofsentence
2135 \begin_layout Standard
2136 \begin_inset VSpace bigskip
2142 \begin_layout Standard
2143 Otherwise, you could needlessly frustrate yourself.
2146 \begin_layout Section
2147 Contributing to the \SpecialChar LyX
2149 \begin_inset CommandInset label
2158 \begin_layout Subsection
2159 Contributing to \SpecialChar LyX
2163 \begin_layout Standard
2165 is mostly written in C++ (the \SpecialChar LaTeX
2166 importer is written in Python).
2167 It is a large project, and as a result it is not free from bugs, or the
2168 need for improvements in the source code.
2171 \begin_layout Subsubsection
2175 \begin_layout Standard
2176 While using \SpecialChar LyX
2177 , you may find behavior which you consider a bug.
2178 Crashes, though rare, can happen.
2179 User interface problems are considered major bugs by the \SpecialChar LyX
2181 helpful are indications of parts of the \SpecialChar LyX
2182 interface you find confusing,
2186 \begin_layout Standard
2188 has a bug tracking system, which you can find at
2189 \begin_inset Newline newline
2193 \begin_inset CommandInset href
2195 target "https://www.lyx.org/trac/wiki/BugTrackerHome"
2200 You should check the bug tracker before reporting any bugs, in case it
2201 has already been reported.
2202 If you have a comment on an existing bug, or wish to report a new bug,
2203 you may either use the bug tracker, or send an e-mail to the development
2205 \begin_inset CommandInset href
2207 target "lyx-devel@lists.lyx.org"
2214 Archives of this list are linked from the main \SpecialChar LyX
2216 \begin_inset CommandInset href
2218 target "http://www.lyx.org"
2225 \begin_layout Standard
2226 A useful bug report will at a minimum include the version of \SpecialChar LyX
2229 Accurate, detailed descriptions are preferred — the more time developers
2230 have to spend to pinpoint the source of a bug, the less time they have
2231 for other improvements.
2232 Mention the system and system version on which you are running \SpecialChar LyX
2234 Give the versions of the libraries you have installed on your system, and,
2235 if relevant, the versions of external programs that \SpecialChar LyX
2237 If it's a compilation or configuration problem, include the file
2241 , and mention which compiler you are using.
2244 \begin_layout Subsubsection
2245 Contributing fixes and new features
2248 \begin_layout Standard
2249 If you have made changes to \SpecialChar LyX
2250 's source that you think should become part
2252 , send your changes as a diff file (in unified format) to the development
2253 list referenced above, along with a change log, and a description of what
2257 \begin_layout Subsection
2258 Contributing to the Documentation
2261 \begin_layout Standard
2263 's documentation is extensive; however \SpecialChar LyX
2264 is under constant development, and
2265 each new release adds new features.
2266 You may find some documentation needs improvement.
2267 This section describes what to do if you find an error, or have some suggestion
2268 s for improving the documentation.
2271 \begin_layout Subsubsection
2272 Reporting Errors in the Manuals
2275 \begin_layout Standard
2276 If you find a problem with the documentation, send a message to the mailing
2278 \begin_inset CommandInset href
2280 target "lyx-docs@lists.lyx.org"
2287 The documentation team will make any necessary fixes.
2290 \begin_layout Subsubsection
2291 Joining the Documentation Team.
2294 \begin_layout Standard
2295 The \SpecialChar LyX
2296 Documentation Project, like anything else in the \SpecialChar LyX
2298 use assistance! If you're interested in contributing to the Documentation
2299 Project, you need to do the following:
2302 \begin_layout Enumerate
2303 Get the latest \SpecialChar LyX
2305 \begin_inset Newline newline
2309 \begin_inset CommandInset href
2311 target "https://www.lyx.org/trac/browser/lyxgit/lib/doc?rev=master "
2318 \begin_layout Enumerate
2328 \begin_inset Newline newline
2331 The point of this exercise is to give you ideas.
2340 are likely to be the most up-to-date of all of the documentation.
2341 You should be able to glean some insights into how we want the manuals
2342 to read and to look.
2345 \begin_layout Enumerate
2346 Contact the team at:
2347 \begin_inset Newline newline
2351 \begin_inset CommandInset href
2353 target "lyx-docs@lists.lyx.org"
2360 \begin_inset Newline newline
2363 to discuss your intended changes and to get some feedback on them.
2366 \begin_layout Standard
2367 The changes you wish to make may range from improving clarity of the text,
2368 to doing major re-structuring of the documentation.
2369 Any and all improvements are gladly received.