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 \docbook_mathml_prefix 1
118 \author 193470694 "Sam"
124 Introduction to \SpecialChar LyX
129 by the \SpecialChar LyX
134 \begin_layout Plain Layout
136 If you have comments on or corrections to this documentation, please send
137 them to the \SpecialChar LyX
138 Documentation mailing list:
139 \begin_inset CommandInset href
141 target "lyx-docs@lists.lyx.org"
155 \begin_layout Standard
156 \begin_inset CommandInset toc
157 LatexCommand tableofcontents
164 \begin_layout Section
165 The Philosophy of \SpecialChar LyX
169 \begin_layout Subsection
170 What is \SpecialChar LyX
174 \begin_layout Standard
176 is a document preparation system.
177 It excels at letting you create complex technical and scientific articles
178 with mathematics, cross-references, bibliographies, indexes, etc.
179 It is very good for working with documents of any length in which the usual
180 processing abilities are required: automatic sectioning and pagination,
181 spell checking and so forth.
182 It can also be used to write a letter to your mom, though granted, there
183 are probably simpler programs available for that.
184 It is definitely not the best tool for creating banners, flyers, or advertiseme
185 nts (we'll explain why later), though with some effort all these can be
187 Here are some examples of what it is used for: memos, letters, dissertations
188 and theses, lecture notes, seminar notebooks, conference proceedings, software
189 documentation, books, articles in refereed scientific journals, scripts
190 for plays and movies, business proposals, presentations \SpecialChar ldots
194 \begin_layout Standard
196 \change_deleted 1549938239 1623600899
198 is a program that provides a modern approach to writing documents with
199 a computer by using a markup language paradigm, an approach that breaks
200 with the obsolete tradition of the
201 \begin_inset Quotes eld
205 \begin_inset Quotes erd
209 It is designed for authors who want professional output quickly with a
210 minimum of effort and without becoming specialists in typesetting.
211 The job of typesetting is done mostly by the computer, not the author;
212 with \SpecialChar LyX
213 , the author can concentrate on the contents of his writing.
216 \begin_layout Standard
217 Part of the initial challenge of using \SpecialChar LyX
218 comes from the change in thinking
219 that you, the user, must make.
220 At one time, all we had for creating documents were typewriters, so we
221 all learned certain tricks to get around their limitations.
222 Underlining, which is little more than overstriking with the
223 \begin_inset Quotes eld
227 \begin_inset Quotes erd
230 character, became a way to emphasize text.
231 You were forced to figure out column sizes and tab stops, and set them,
232 before creating a table.
233 The same applied for letters and other right justified text.
234 Hyphenation at the end of a line required a careful eye and a lot of foresight.
237 \begin_layout Standard
238 In other words, we've all been trained to worry about the little details
239 of which character goes where.
240 Consequently, almost all word processors have this mentality.
241 They still use tab stops for adding whitespace.
242 You still need to worry about exactly where on the page something will
244 Emphasizing text means changing a font, similar to changing the typewriter
246 This is the underlying philosophy of a WYSIWYG word processor:
247 \begin_inset Quotes eld
250 What You See Is What You Get
251 \begin_inset Quotes erd
255 Unfortunately, that paradigm often results in
256 \begin_inset Quotes eld
259 What You See Is All You Get
260 \begin_inset Quotes erd
266 \begin_layout Standard
267 This is where \SpecialChar LyX
268 differs from an ordinary word processor.
269 You don't concern yourself with what character goes where.
270 You tell \SpecialChar LyX
276 takes care of the rest, following a set of rules called a
281 \change_deleted 1549938239 1623600899
286 \begin_layout Plain Layout
287 To be fair, most recent versions of the most popular office suites now have
288 some sort of style sheets which follow a similar markup method.
289 However, our experience is that they are still rarely used in practice.
296 Let's look at a little example:
299 \begin_layout Standard
300 Suppose you are writing a report.
301 To begin your report, you want a section called
302 \begin_inset Quotes eld
305 Introduction\SpecialChar endofsentence
307 \begin_inset Quotes erd
310 So, you go into whatever menu it is in your word processor that changes
311 font sizes and decide on a new font size.
312 Then you turn on bold face.
314 \begin_inset Quotes eld
326 \begin_inset Quotes erd
330 Of course, if you later decide that this section belongs someplace else
331 in the document or if you insert a new section before it, you need to change
332 the numbering for this and all following sections, as well as any entry
333 in the table of contents.
336 \begin_layout Standard
338 , you go to the pull-down on the far left of the button bar and select
344 \begin_inset Quotes eld
348 \begin_inset Quotes erd
354 \begin_layout Standard
356 If you cut and paste the section, it will automatically be renumbered —
358 And if you enter references to that section correctly (by inserting cross-refer
359 ence tags), \SpecialChar LyX
360 will automatically update them all throughout the file so that
361 you never, ever type a section number.
364 \begin_layout Standard
365 Now let's look at the problem of consistency.
366 Five days later, you reopen your report and start Section
371 However, you forget that you were using 18
372 \begin_inset space \thinspace{}
375 pt bold instead of 16
376 \begin_inset space \thinspace{}
379 pt, so you type in the heading for Section
383 4 in a different font from the one you used for Section
388 That problem doesn't even exist in \SpecialChar LyX
390 The computer takes care of all that silly bookkeeping about which thing
391 has what size font, not you.
392 After all, that's what a computer is good at.
395 \begin_layout Standard
396 Here's another example.
397 Suppose you're making a list.
398 In other word processors, a list is just a bunch of tab stops and newlines.
399 You need to figure out where to put the label for each list item, what
400 that label should be, how many blank lines to put between each item, and
402 Under \SpecialChar LyX
403 , you have only two concerns: what kind of list is this, and what
404 do I want to put in it? That is it.
407 \begin_layout Standard
408 So, the basic idea behind \SpecialChar LyX
419 \begin_inset Quotes eld
422 What You See Is What You Get,
423 \begin_inset Quotes erd
428 \begin_inset Quotes eld
431 What You See Is What You
436 \begin_inset Quotes erd
440 \begin_inset Quotes eld
444 \begin_inset Quotes erd
447 It's a powerful idea that greatly simplifies the mechanics of writing documents.
448 This is also why \SpecialChar LyX
449 isn't so good for creating posters and flyers.
454 want to specify exactly where everything goes, because there are no functional
455 units like paragraphs, sections, etc.
456 This doesn't mean \SpecialChar LyX
457 is missing some cool function.
458 It simply means that it isn't the right tool for the job — you don't use
460 \change_inserted 1549938239 1623600899
464 \begin_layout Standard
466 \change_inserted 1549938239 1623600899
468 If you cut and paste the section, it will automat
471 \change_inserted 1549938239 1623600899
472 cally be renumbered — e
475 \change_inserted 1549938239 1623600899
477 And if you enter references to that section corr
480 \change_inserted 1549938239 1623600899
484 \change_inserted 1549938239 1623600899
488 \change_inserted 1549938239 1623600899
492 \change_inserted 1549938239 1623600899
496 \change_inserted 1549938239 1623600899
497 gs), \SpecialChar LyX
498 will automatically update them all throughout the f
501 \change_inserted 1549938239 1623600899
505 \change_inserted 1549938239 1623600899
506 o that you never, ever type a section number
511 \begin_layout Subsection
512 Differences between \SpecialChar LyX
514 \change_inserted 1549938239 1623600899
520 \begin_layout Standard
521 Here's a list of things you won't find in \SpecialChar LyX
525 \begin_layout Itemize
529 \begin_layout Itemize
533 \begin_layout Itemize
535 \begin_inset space \thinspace{}
539 \begin_inset space \space{}
553 \begin_layout Standard
554 Tab stops, along with a ruler showing you the position of things on the
555 page, are useless in \SpecialChar LyX
557 The program worries about where things go on the page, not you.
558 Extra whitespace is similar; \SpecialChar LyX
559 adds it where necessary, depending on context.
560 Not being able to type two blank lines in a row will be annoying at first,
561 but it makes more sense once you're thinking in WYSIWYM terms.
564 \begin_layout Standard
565 Here are some things that exist in \SpecialChar LyX
566 , but aren't used as you might think:
569 \begin_layout Itemize
573 \begin_layout Itemize
577 \begin_layout Itemize
579 \begin_inset space \thinspace{}
583 \begin_inset space \space{}
586 single spaced, double spaced, etc.)
589 \begin_layout Itemize
590 Whitespace, horizontal and vertical
593 \begin_layout Itemize
597 \begin_layout Itemize
598 Typefaces (bold, italic, underline, etc.)
601 \begin_layout Standard
602 Although they exist in \SpecialChar LyX
603 , you generally don't need them.
605 will take care of these things for you, depending on what you're doing.
606 Different parts of the document are automatically set in a different typeface
608 Paragraph indenting is context dependent; different types of paragraphs
609 get indented differently.
610 Page breaks get handled automatically, as well.
611 In general, the space between lines, between words, and between paragraphs
612 is variable, set by \SpecialChar LyX
617 \begin_layout Plain Layout
618 There are ways to adjust all of these (only some of which require knowledge
619 of \SpecialChar LaTeX
620 ), either for a whole document or for a specific location in a document.
637 \begin_layout Standard
638 Lastly, there are a few areas where we believe \SpecialChar LyX
639 (and \SpecialChar LaTeX
640 ) surpasses many word
644 \begin_layout Itemize
648 \begin_layout Itemize
652 \begin_layout Itemize
656 \begin_layout Itemize
660 \begin_layout Itemize
664 \begin_layout Standard
665 Granted, many modern word processors can handle mathematical symbols, tables,
666 and hyphenation, and many have moved towards style definitions and the
668 However, they've only recently been able to do so, whereas \SpecialChar LyX
670 the \SpecialChar LaTeX
671 document preparation system.
673 has been around since 1985, and
680 \begin_layout Subsection
681 What is \SpecialChar LaTeX
685 \begin_layout Standard
687 is a document preparation system designed by Leslie Lamport in 1985.
691 \begin_layout Plain Layout
692 The source for the info in this section is
694 A Guide to \SpecialChar LaTeX2e
697 , by Helmut Kopka and Patrick Daly, which has an entry in the bibliography
702 \SpecialChar endofsentence
708 It was built up from a typesetting language called \SpecialChar TeX
712 takes a sequence of typesetting commands, written in a script in an ASCII
713 file, and executes them.
715 \begin_inset Quotes eld
719 \begin_inset Quotes erd
722 of the printing trade were modeled by Knuth as computer algorithms and
723 incorporated into \SpecialChar TeX
724 , hence its excellent printed appearance.
725 What comes directly out of \SpecialChar TeX
726 is the portable document format
731 \begin_inset Quotes eld
735 \begin_inset Quotes erd
743 The dvi format is often used for previews and can later be converted to
744 other formats like PostScript.
748 \begin_layout Standard
750 isn't only a typesetting engine; it also allows you to define macros.
751 Most people who use \SpecialChar TeX
752 are actually using a macro package which Knuth created
753 to hide a lot of the typesetting details.
754 This is where Leslie Lamport enters our story.
755 He wanted a macro package that was more user- and less typesetter-oriented,
756 with a set of commands that consistently typeset things like sections,
757 tables or math formulas in a uniform, consistent fashion.
758 This is how \SpecialChar LaTeX
762 \begin_layout Standard
763 Now, in parallel with the development and growth of \SpecialChar LaTeX
764 , other folks were creating
765 their own custom macro packages for \SpecialChar TeX
766 , ones to make slides or articles for
767 math journals and so on.
768 Some used the raw \SpecialChar TeX
769 facilities to do this, others began modifying \SpecialChar LaTeX
771 To try and unify this mess, a team of \SpecialChar LaTeX
772 -nicians began to work on \SpecialChar LaTeX2e
774 version of \SpecialChar LaTeX
775 , during the late 1980's.
776 This new version of \SpecialChar LaTeX
777 has commands which provide an easier-to-use interface
779 's macro-creating commands, aid in the use of new fonts, and so on.
780 In fact, \SpecialChar LaTeX
781 is quite an extensive language in its own right! Users around
782 the world have been creating their own add-ons for \SpecialChar LaTeX
787 \begin_layout Standard
788 There are two ways to extend \SpecialChar LaTeX
789 : classes and styles.
794 is a set of \SpecialChar LaTeX
795 macros describing a new type of document, like a book, or
797 There are classes for slides, for physics and math journals\SpecialChar ldots
799 even have a class for their thesis format.
804 differs from a class in that it doesn't define a new type of document,
805 but a different type of
809 that any document can use.
810 For example, \SpecialChar LyX
811 controls page margins and line spacing using two different
813 style-files designed for these purposes.
814 There are style-files for a whole slew of things: printing labels or envelopes,
815 changing indentation behavior, adding new fonts, manipulating graphics,
816 designing fancy page headings, customizing bibliographies, altering the
817 location and appearance of footnotes, tables, and figures, customizing
821 \begin_layout Standard
825 \begin_layout Description
827 : Typesetting language with macro capability.
830 \begin_layout Description
832 : Macro package built upon \SpecialChar TeX
833 \SpecialChar endofsentence
837 \begin_layout Description
838 classes: Descriptions of types of document used with \SpecialChar LaTeX
839 \SpecialChar endofsentence
843 \begin_layout Description
844 styles: Descriptions of the default behavior of particular elements of \SpecialChar LaTeX
848 \begin_layout Description
850 : Visual, WYSIWYM document processor that uses \SpecialChar LaTeX
851 to do its typesetting.
854 \begin_layout Standard
855 This section attempts to explain the difference between \SpecialChar LyX
856 and a word processor.
857 Simply put, \SpecialChar LaTeX
859 By using \SpecialChar LaTeX
860 as its backend, \SpecialChar LyX
861 helps you to think more about
870 The computer then handles
877 \begin_layout Section
878 Navigating the Documentation
881 \begin_layout Standard
882 To make it easier to answer your questions and describe all of the features
884 , the documentation has been split up into several different files.
885 Each one has its own purpose, as described below.
886 Before you go ploughing into any of those files, however, you should read
887 this chapter thoroughly, since it contains a lot of useful information
888 and commentary that can save you some time.
891 \begin_layout Standard
892 Hopefully, the development of \SpecialChar LyX
893 will never stop; so some of the documentation
894 may be incomplete or a bit out of date, though we try to keep up-to-date.
895 Like the rest of \SpecialChar LyX
896 , the manuals are the work of a group of volunteers who
898 \begin_inset Quotes eld
902 \begin_inset Quotes erd
905 , families, dishes to clean,
910 If you want to help out, be sure to read Section
915 \begin_inset CommandInset ref
917 reference "sec:Contrib"
921 in addition to the rest of this document.
924 \begin_layout Standard
925 Also, please do us a favor – if anything in these manuals confuses you,
926 is unclear, or wrong, don't hesitate to let us know! You can reach the
927 current document maintainers by emailing
928 \begin_inset CommandInset href
930 target "lyx-docs@lists.lyx.org"
937 If you have questions that are not obviously answered in the documentation,
938 and need help fast, there is an active users' mailing list which you can
940 \begin_inset CommandInset href
942 target "lyx-users@lists.lyx.org"
951 \begin_layout Subsection
952 The Format of the Manuals
955 \begin_layout Standard
956 Some of you may have printed out the manuals.
957 Others may be reading them within \SpecialChar LyX
959 There are some differences between the \SpecialChar LyX
960 -file and the printed version.
962 , the title is simply at the top of the document, not formatted on a
963 separate page as in some of the printed versions.
964 Nor are any of the footnotes or the Table of Contents fully visible.
965 To open a footnote, which looks like this:
966 \begin_inset Graphics
967 filename ../../../../lib/doc/clipart/footnote.png
972 , click on it with the left mouse button.
973 For the Table of Contents, either click on the grey box or click on the
978 menu, where the contents are displayed automatically\SpecialChar endofsentence
982 \begin_layout Standard
983 In the printed manuals, all cross-references appear as the actual numbers
984 for a chapter, section, subsection, and so on.
985 In the \SpecialChar LyX
986 -file, however, all cross-references appear as light-grey boxes
988 \begin_inset Graphics
989 filename ../../../../lib/doc/clipart/reference.png
995 If you click on such a box with the left mouse button, a dialog box will
996 appear containing a list of all the cross-references in the document.
997 You can go to the referenced section by right-clicking on the box or by
1001 \begin_inset space ~
1005 \begin_inset space ~
1010 in the opened dialog.
1011 Going back to where you came from is just as easy.
1015 \begin_inset space ~
1020 to go back to your earlier location.
1023 \begin_layout Standard
1024 Now that we've cleared up some of the differences between the printed and
1026 -file versions of this file, we can start looking at the format of this
1028 You'll occasionally notice things in different fonts:
1031 \begin_layout Itemize
1036 is used for general emphasis, generic arguments, book titles, names of
1037 sections of other manuals, and notes from the authors.
1040 \begin_layout Itemize
1045 is used for program and file names, \SpecialChar LyX
1049 \begin_layout Itemize
1054 is used for menu, button, or dialog box names, and the names of keyboard
1058 \begin_layout Itemize
1063 is used for people's names.
1066 \begin_layout Itemize
1071 is used for \SpecialChar LaTeX
1075 \begin_layout Standard
1076 When we do need to reference keys, we'll use the following prefixing convention:
1079 \begin_layout Itemize
1080 \begin_inset Quotes eld
1088 \begin_inset Quotes erd
1098 \begin_layout Itemize
1099 \begin_inset Quotes eld
1107 \begin_inset Quotes erd
1117 \begin_layout Itemize
1118 \begin_inset Quotes eld
1126 \begin_inset Quotes erd
1140 \begin_layout Itemize
1141 \begin_inset Quotes eld
1149 \begin_inset Quotes erd
1154 \begin_inset Quotes eld
1162 \begin_inset Quotes erd
1165 are the function keys.
1168 \begin_layout Itemize
1169 \begin_inset Quotes eld
1177 \begin_inset Quotes erd
1183 \begin_layout Itemize
1184 \begin_inset Quotes eld
1192 \begin_inset Quotes erd
1196 \begin_inset Quotes eld
1204 \begin_inset Quotes erd
1208 \begin_inset Quotes eld
1216 \begin_inset Quotes erd
1220 \begin_inset Quotes eld
1228 \begin_inset Quotes erd
1234 \begin_layout Itemize
1237 \begin_inset Quotes eld
1243 \begin_inset Quotes erd
1247 \begin_inset Quotes eld
1255 \begin_inset Quotes erd
1259 \begin_inset Quotes eld
1267 \begin_inset Quotes erd
1271 \begin_inset Quotes eld
1279 \begin_inset Quotes erd
1283 \begin_inset Quotes eld
1291 \begin_inset Quotes erd
1295 \begin_inset Quotes eld
1303 \begin_inset Quotes erd
1307 \begin_inset space ~
1310 keys that appear above the cursor keys on many PC keyboards.
1312 \begin_inset Quotes eld
1320 \begin_inset Quotes erd
1324 \begin_inset Quotes eld
1332 \begin_inset Quotes erd
1336 \begin_inset Quotes eld
1344 \begin_inset Quotes erd
1348 \begin_inset Quotes eld
1356 \begin_inset Quotes erd
1362 \begin_layout Itemize
1371 both refer to the same key.
1372 Some keyboards label the
1377 \begin_inset Quotes eld
1381 \begin_inset Quotes erd
1385 \begin_inset Quotes eld
1389 \begin_inset Quotes erd
1392 still others have two keys.
1394 treats all of them as the same key, so we'll use
1405 \begin_layout Standard
1406 The list with the currently set shortcuts can be found in the
1417 \begin_layout Subsection
1418 Units used in the Manuals
1421 \begin_layout Standard
1422 To understand the units described in this documentation, Table
1423 \begin_inset space ~
1427 \begin_inset CommandInset ref
1429 reference "tab:Units"
1433 explains all units available in \SpecialChar LyX
1437 \begin_layout Standard
1438 \begin_inset Float table
1445 \begin_layout Plain Layout
1446 \begin_inset Caption Standard
1448 \begin_layout Plain Layout
1449 \begin_inset CommandInset label
1463 \begin_layout Plain Layout
1464 \begin_inset VSpace medskip
1470 \begin_layout Plain Layout
1472 \begin_inset Tabular
1473 <lyxtabular version="3" rows="20" columns="2">
1474 <features booktabs="true" tabularvalignment="middle">
1475 <column alignment="center" valignment="top" width="0pt">
1476 <column alignment="center" valignment="top">
1478 <cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
1481 \begin_layout Plain Layout
1487 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1490 \begin_layout Plain Layout
1498 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1501 \begin_layout Plain Layout
1507 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1510 \begin_layout Plain Layout
1518 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1521 \begin_layout Plain Layout
1527 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1530 \begin_layout Plain Layout
1538 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1541 \begin_layout Plain Layout
1547 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1550 \begin_layout Plain Layout
1552 \begin_inset space \thinspace{}
1556 \begin_inset space \thinspace{}
1566 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1569 \begin_layout Plain Layout
1575 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1578 \begin_layout Plain Layout
1580 \begin_inset space \thinspace{}
1584 \begin_inset space \thinspace{}
1594 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1597 \begin_layout Plain Layout
1603 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1606 \begin_layout Plain Layout
1608 \begin_inset space \thinspace{}
1612 \begin_inset space \thinspace{}
1622 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1625 \begin_layout Plain Layout
1631 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1634 \begin_layout Plain Layout
1636 \begin_inset space \thinspace{}
1640 \begin_inset space \thinspace{}
1650 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1653 \begin_layout Plain Layout
1659 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1662 \begin_layout Plain Layout
1664 \begin_inset space \thinspace{}
1668 \begin_inset space \thinspace{}
1678 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1681 \begin_layout Plain Layout
1687 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1690 \begin_layout Plain Layout
1692 \begin_inset space \thinspace{}
1696 \begin_inset Formula $\approx$
1700 \begin_inset space \thinspace{}
1710 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1713 \begin_layout Plain Layout
1719 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1722 \begin_layout Plain Layout
1724 \begin_inset space \thinspace{}
1728 \begin_inset space \thinspace{}
1738 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1741 \begin_layout Plain Layout
1747 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1750 \begin_layout Plain Layout
1751 % of original image width
1758 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1761 \begin_layout Plain Layout
1767 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1770 \begin_layout Plain Layout
1778 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1781 \begin_layout Plain Layout
1787 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1790 \begin_layout Plain Layout
1798 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1801 \begin_layout Plain Layout
1807 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1810 \begin_layout Plain Layout
1818 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1821 \begin_layout Plain Layout
1827 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1830 \begin_layout Plain Layout
1838 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1841 \begin_layout Plain Layout
1847 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1850 \begin_layout Plain Layout
1858 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1861 \begin_layout Plain Layout
1867 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1870 \begin_layout Plain Layout
1878 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1881 \begin_layout Plain Layout
1887 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1890 \begin_layout Plain Layout
1902 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1905 \begin_layout Plain Layout
1911 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1914 \begin_layout Plain Layout
1926 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1929 \begin_layout Plain Layout
1935 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1938 \begin_layout Plain Layout
1940 \begin_inset space \thinspace{}
1944 \begin_inset space \thinspace{}
1965 \begin_layout Subsection
1969 \begin_layout Standard
1970 The following list describes the contents of the basic documentation files
1971 that you find in the
1978 \begin_layout Description
1979 Introduction This file.
1982 \begin_layout Description
1983 Tutorial If you are new to \SpecialChar LyX
1984 , and have never used \SpecialChar LaTeX
1985 before, you should start
1987 If you have used \SpecialChar LaTeX
1988 before, you should still read the
1992 , starting with the section on
1993 \begin_inset Quotes eld
1997 for \SpecialChar LaTeX
1999 \begin_inset Quotes erd
2002 (Skimming through the rest of the document wouldn't hurt, either.)
2005 \begin_layout Description
2007 \begin_inset space ~
2010 Guide The primary documentation.
2015 of the basic operation and available features of \SpecialChar LyX
2017 The main manual assumes that you have read the
2024 \begin_layout Description
2026 \begin_inset space ~
2029 Objects Extension of the
2034 Documents in detail how to use tables, graphics, floats, notes, program
2036 It also includes many tricks of the \SpecialChar LaTeX
2040 \begin_layout Description
2041 Math Extension of the
2046 Documents in detail how to typeset any kind of formula.
2049 \begin_layout Description
2051 \begin_inset space ~
2054 Features Extension of the
2059 Documents how to use raw \SpecialChar LaTeX
2060 commands, additional layouts and special-purpose
2064 \begin_layout Description
2065 Customization A description of advanced \SpecialChar LyX
2066 features, including how to customize
2067 the overall behavior of \SpecialChar LyX
2068 \SpecialChar endofsentence
2069 This includes such things as keybindings, internationa
2070 lization and configuration files.
2071 It also includes information about layout files, which are needed to get
2073 to support \SpecialChar LaTeX
2074 classes or packages.
2077 \begin_layout Description
2078 Shortcuts Tables of the currently defined \SpecialChar LyX
2082 \begin_layout Description
2085 \begin_inset space ~
2088 Configuration A report produced by \SpecialChar LyX
2090 This file contains information on what \SpecialChar LyX
2091 learned about your installation.
2092 Check it to see if you're missing something you might like to have.
2095 \begin_layout Standard
2096 These files will reference one another as necessary.
2105 information on installation and customization, but refers the reader to
2108 Customization Manual
2110 for more information.
2113 \begin_layout Standard
2114 We'll state again an important point:
2117 \begin_layout Standard
2118 \begin_inset VSpace bigskip
2124 \begin_layout Standard
2126 If you are new to \SpecialChar LyX
2132 Now\SpecialChar endofsentence
2136 \begin_layout Standard
2137 \begin_inset VSpace bigskip
2143 \begin_layout Standard
2144 Otherwise, you could needlessly frustrate yourself.
2147 \begin_layout Section
2148 Contributing to the \SpecialChar LyX
2150 \begin_inset CommandInset label
2159 \begin_layout Subsection
2160 Contributing to \SpecialChar LyX
2164 \begin_layout Standard
2166 is mostly written in C++ (the \SpecialChar LaTeX
2167 importer is written in Python).
2168 It is a large project, and as a result it is not free from bugs, or the
2169 need for improvements in the source code.
2172 \begin_layout Subsubsection
2176 \begin_layout Standard
2177 While using \SpecialChar LyX
2178 , you may find behavior which you consider a bug.
2179 Crashes, though rare, can happen.
2180 User interface problems are considered major bugs by the \SpecialChar LyX
2182 helpful are indications of parts of the \SpecialChar LyX
2183 interface you find confusing,
2187 \begin_layout Standard
2189 has a bug tracking system, which you can find at
2190 \begin_inset Newline newline
2194 \begin_inset CommandInset href
2196 target "https://www.lyx.org/trac/wiki/BugTrackerHome"
2201 You should check the bug tracker before reporting any bugs, in case it
2202 has already been reported.
2203 If you have a comment on an existing bug, or wish to report a new bug,
2204 you may either use the bug tracker, or send an e-mail to the development
2206 \begin_inset CommandInset href
2208 target "lyx-devel@lists.lyx.org"
2215 Archives of this list are linked from the main \SpecialChar LyX
2217 \begin_inset CommandInset href
2219 target "http://www.lyx.org"
2226 \begin_layout Standard
2227 A useful bug report will at a minimum include the version of \SpecialChar LyX
2230 Accurate, detailed descriptions are preferred — the more time developers
2231 have to spend to pinpoint the source of a bug, the less time they have
2232 for other improvements.
2233 Mention the system and system version on which you are running \SpecialChar LyX
2235 Give the versions of the libraries you have installed on your system, and,
2236 if relevant, the versions of external programs that \SpecialChar LyX
2238 If it's a compilation or configuration problem, include the file
2242 , and mention which compiler you are using.
2245 \begin_layout Subsubsection
2246 Contributing fixes and new features
2249 \begin_layout Standard
2250 If you have made changes to \SpecialChar LyX
2251 's source that you think should become part
2253 , send your changes as a diff file (in unified format) to the development
2254 list referenced above, along with a change log, and a description of what
2258 \begin_layout Subsection
2259 Contributing to the Documentation
2262 \begin_layout Standard
2264 's documentation is extensive; however \SpecialChar LyX
2265 is under constant development, and
2266 each new release adds new features.
2267 You may find some documentation needs improvement.
2268 This section describes what to do if you find an error, or have some suggestion
2269 s for improving the documentation.
2272 \begin_layout Subsubsection
2273 Reporting Errors in the Manuals
2276 \begin_layout Standard
2277 If you find a problem with the documentation, send a message to the mailing
2279 \begin_inset CommandInset href
2281 target "lyx-docs@lists.lyx.org"
2288 The documentation team will make any necessary fixes.
2291 \begin_layout Subsubsection
2292 Joining the Documentation Team.
2295 \begin_layout Standard
2296 The \SpecialChar LyX
2297 Documentation Project, like anything else in the \SpecialChar LyX
2299 use assistance! If you're interested in contributing to the Documentation
2300 Project, you need to do the following:
2303 \begin_layout Enumerate
2304 Get the latest \SpecialChar LyX
2306 \begin_inset Newline newline
2310 \begin_inset CommandInset href
2312 target "https://www.lyx.org/trac/browser/lyxgit/lib/doc?rev=master "
2319 \begin_layout Enumerate
2329 \begin_inset Newline newline
2332 The point of this exercise is to give you ideas.
2341 are likely to be the most up-to-date of all of the documentation.
2342 You should be able to glean some insights into how we want the manuals
2343 to read and to look.
2346 \begin_layout Enumerate
2347 Contact the team at:
2348 \begin_inset Newline newline
2352 \begin_inset CommandInset href
2354 target "lyx-docs@lists.lyx.org"
2361 \begin_inset Newline newline
2364 to discuss your intended changes and to get some feedback on them.
2367 \begin_layout Standard
2368 The changes you wish to make may range from improving clarity of the text,
2369 to doing major re-structuring of the documentation.
2370 Any and all improvements are gladly received.