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 false
110 \output_changes false
112 \postpone_fragile_content false
115 \html_be_strict false
116 \docbook_table_output 0
122 Introduction to \SpecialChar LyX
127 by the \SpecialChar LyX
132 \begin_layout Plain Layout
134 If you have comments on or corrections to this documentation, please send
135 them to the \SpecialChar LyX
136 Documentation mailing list:
137 \begin_inset CommandInset href
139 target "lyx-docs@lists.lyx.org"
153 \begin_layout Standard
154 \begin_inset CommandInset toc
155 LatexCommand tableofcontents
162 \begin_layout Section
163 The Philosophy of \SpecialChar LyX
167 \begin_layout Subsection
168 What is \SpecialChar LyX
172 \begin_layout Standard
174 is a document preparation system.
175 It excels at letting you create complex technical and scientific articles
176 with mathematics, cross-references, bibliographies, indexes, etc.
177 It is very good for working with documents of any length in which the usual
178 processing abilities are required: automatic sectioning and pagination,
179 spell checking and so forth.
180 It can also be used to write a letter to your mom, though granted, there
181 are probably simpler programs available for that.
182 It is definitely not the best tool for creating banners, flyers, or advertiseme
183 nts (we'll explain why later), though with some effort all these can be
185 Here are some examples of what it is used for: memos, letters, dissertations
186 and theses, lecture notes, seminar notebooks, conference proceedings, software
187 documentation, books, articles in refereed scientific journals, scripts
188 for plays and movies, business proposals, presentations \SpecialChar ldots
192 \begin_layout Standard
194 is a program that provides a modern approach to writing documents with
195 a computer by using a markup language paradigm, an approach that breaks
196 with the obsolete tradition of the
197 \begin_inset Quotes eld
201 \begin_inset Quotes erd
205 It is designed for authors who want professional output quickly with a
206 minimum of effort and without becoming specialists in typesetting.
207 The job of typesetting is done mostly by the computer, not the author;
208 with \SpecialChar LyX
209 , the author can concentrate on the contents of his writing.
212 \begin_layout Standard
213 Part of the initial challenge of using \SpecialChar LyX
214 comes from the change in thinking
215 that you, the user, must make.
216 At one time, all we had for creating documents were typewriters, so we
217 all learned certain tricks to get around their limitations.
218 Underlining, which is little more than overstriking with the
219 \begin_inset Quotes eld
223 \begin_inset Quotes erd
226 character, became a way to emphasize text.
227 You were forced to figure out column sizes and tab stops, and set them,
228 before creating a table.
229 The same applied for letters and other right justified text.
230 Hyphenation at the end of a line required a careful eye and a lot of foresight.
233 \begin_layout Standard
234 In other words, we've all been trained to worry about the little details
235 of which character goes where.
236 Consequently, almost all word processors have this mentality.
237 They still use tab stops for adding whitespace.
238 You still need to worry about exactly where on the page something will
240 Emphasizing text means changing a font, similar to changing the typewriter
242 This is the underlying philosophy of a WYSIWYG word processor:
243 \begin_inset Quotes eld
246 What You See Is What You Get
247 \begin_inset Quotes erd
251 Unfortunately, that paradigm often results in
252 \begin_inset Quotes eld
255 What You See Is All You Get
256 \begin_inset Quotes erd
262 \begin_layout Standard
263 This is where \SpecialChar LyX
264 differs from an ordinary word processor.
265 You don't concern yourself with what character goes where.
266 You tell \SpecialChar LyX
272 takes care of the rest, following a set of rules called a
280 \begin_layout Plain Layout
281 To be fair, most recent versions of the most popular office suites now have
282 some sort of style sheets which follow a similar markup method.
283 However, our experience is that they are still rarely used in practice.
288 Let's look at a little example:
291 \begin_layout Standard
292 Suppose you are writing a report.
293 To begin your report, you want a section called
294 \begin_inset Quotes eld
297 Introduction\SpecialChar endofsentence
299 \begin_inset Quotes erd
302 So, you go into whatever menu it is in your word processor that changes
303 font sizes and decide on a new font size.
304 Then you turn on bold face.
306 \begin_inset Quotes eld
318 \begin_inset Quotes erd
322 Of course, if you later decide that this section belongs someplace else
323 in the document or if you insert a new section before it, you need to change
324 the numbering for this and all following sections, as well as any entry
325 in the table of contents.
328 \begin_layout Standard
330 , you go to the pull-down on the far left of the button bar and select
336 \begin_inset Quotes eld
340 \begin_inset Quotes erd
346 \begin_layout Standard
348 If you cut and paste the section, it will automatically be renumbered —
350 And if you enter references to that section correctly (by inserting cross-refer
351 ence tags), \SpecialChar LyX
352 will automatically update them all throughout the file so that
353 you never, ever type a section number.
356 \begin_layout Standard
357 Now let's look at the problem of consistency.
358 Five days later, you reopen your report and start Section
363 However, you forget that you were using 18
364 \begin_inset space \thinspace{}
367 pt bold instead of 16
368 \begin_inset space \thinspace{}
371 pt, so you type in the heading for Section
375 4 in a different font from the one you used for Section
380 That problem doesn't even exist in \SpecialChar LyX
382 The computer takes care of all that silly bookkeeping about which thing
383 has what size font, not you.
384 After all, that's what a computer is good at.
387 \begin_layout Standard
388 Here's another example.
389 Suppose you're making a list.
390 In other word processors, a list is just a bunch of tab stops and newlines.
391 You need to figure out where to put the label for each list item, what
392 that label should be, how many blank lines to put between each item, and
394 Under \SpecialChar LyX
395 , you have only two concerns: what kind of list is this, and what
396 do I want to put in it? That is it.
399 \begin_layout Standard
400 So, the basic idea behind \SpecialChar LyX
411 \begin_inset Quotes eld
414 What You See Is What You Get,
415 \begin_inset Quotes erd
420 \begin_inset Quotes eld
423 What You See Is What You
428 \begin_inset Quotes erd
432 \begin_inset Quotes eld
436 \begin_inset Quotes erd
439 It's a powerful idea that greatly simplifies the mechanics of writing documents.
440 This is also why \SpecialChar LyX
441 isn't so good for creating posters and flyers.
446 want to specify exactly where everything goes, because there are no functional
447 units like paragraphs, sections, etc.
448 This doesn't mean \SpecialChar LyX
449 is missing some cool function.
450 It simply means that it isn't the right tool for the job — you don't use
451 a screwdriver to drive in nails.
454 \begin_layout Subsection
455 Differences between \SpecialChar LyX
456 and Other Word Processors
459 \begin_layout Standard
460 Here's a list of things you won't find in \SpecialChar LyX
464 \begin_layout Itemize
468 \begin_layout Itemize
472 \begin_layout Itemize
474 \begin_inset space \thinspace{}
478 \begin_inset space \space{}
492 \begin_layout Standard
493 Tab stops, along with a ruler showing you the position of things on the
494 page, are useless in \SpecialChar LyX
496 The program worries about where things go on the page, not you.
497 Extra whitespace is similar; \SpecialChar LyX
498 adds it where necessary, depending on context.
499 Not being able to type two blank lines in a row will be annoying at first,
500 but it makes more sense once you're thinking in WYSIWYM terms.
503 \begin_layout Standard
504 Here are some things that exist in \SpecialChar LyX
505 , but aren't used as you might think:
508 \begin_layout Itemize
512 \begin_layout Itemize
516 \begin_layout Itemize
518 \begin_inset space \thinspace{}
522 \begin_inset space \space{}
525 single spaced, double spaced, etc.)
528 \begin_layout Itemize
529 Whitespace, horizontal and vertical
532 \begin_layout Itemize
536 \begin_layout Itemize
537 Typefaces (bold, italic, underline, etc.)
540 \begin_layout Standard
541 Although they exist in \SpecialChar LyX
542 , you generally don't need them.
544 will take care of these things for you, depending on what you're doing.
545 Different parts of the document are automatically set in a different typeface
547 Paragraph indenting is context dependent; different types of paragraphs
548 get indented differently.
549 Page breaks get handled automatically, as well.
550 In general, the space between lines, between words, and between paragraphs
551 is variable, set by \SpecialChar LyX
556 \begin_layout Plain Layout
557 There are ways to adjust all of these (only some of which require knowledge
558 of \SpecialChar LaTeX
559 ), either for a whole document or for a specific location in a document.
576 \begin_layout Standard
577 Lastly, there are a few areas where we believe \SpecialChar LyX
578 (and \SpecialChar LaTeX
579 ) surpasses many word
583 \begin_layout Itemize
587 \begin_layout Itemize
591 \begin_layout Itemize
595 \begin_layout Itemize
599 \begin_layout Itemize
603 \begin_layout Standard
604 Granted, many modern word processors can handle mathematical symbols, tables,
605 and hyphenation, and many have moved towards style definitions and the
607 However, they've only recently been able to do so, whereas \SpecialChar LyX
609 the \SpecialChar LaTeX
610 document preparation system.
612 has been around since 1985, and
619 \begin_layout Subsection
620 What is \SpecialChar LaTeX
624 \begin_layout Standard
626 is a document preparation system designed by Leslie Lamport in 1985.
630 \begin_layout Plain Layout
631 The source for the info in this section is
633 A Guide to \SpecialChar LaTeX2e
636 , by Helmut Kopka and Patrick Daly, which has an entry in the bibliography
641 \SpecialChar endofsentence
647 It was built up from a typesetting language called \SpecialChar TeX
651 takes a sequence of typesetting commands, written in a script in an ASCII
652 file, and executes them.
654 \begin_inset Quotes eld
658 \begin_inset Quotes erd
661 of the printing trade were modeled by Knuth as computer algorithms and
662 incorporated into \SpecialChar TeX
663 , hence its excellent printed appearance.
664 What comes directly out of \SpecialChar TeX
665 is the portable document format
670 \begin_inset Quotes eld
674 \begin_inset Quotes erd
682 The dvi format is often used for previews and can later be converted to
683 other formats like PostScript.
687 \begin_layout Standard
689 isn't only a typesetting engine; it also allows you to define macros.
690 Most people who use \SpecialChar TeX
691 are actually using a macro package which Knuth created
692 to hide a lot of the typesetting details.
693 This is where Leslie Lamport enters our story.
694 He wanted a macro package that was more user- and less typesetter-oriented,
695 with a set of commands that consistently typeset things like sections,
696 tables or math formulas in a uniform, consistent fashion.
697 This is how \SpecialChar LaTeX
701 \begin_layout Standard
702 Now, in parallel with the development and growth of \SpecialChar LaTeX
703 , other folks were creating
704 their own custom macro packages for \SpecialChar TeX
705 , ones to make slides or articles for
706 math journals and so on.
707 Some used the raw \SpecialChar TeX
708 facilities to do this, others began modifying \SpecialChar LaTeX
710 To try and unify this mess, a team of \SpecialChar LaTeX
711 -nicians began to work on \SpecialChar LaTeX2e
713 version of \SpecialChar LaTeX
714 , during the late 1980's.
715 This new version of \SpecialChar LaTeX
716 has commands which provide an easier-to-use interface
718 's macro-creating commands, aid in the use of new fonts, and so on.
719 In fact, \SpecialChar LaTeX
720 is quite an extensive language in its own right! Users around
721 the world have been creating their own add-ons for \SpecialChar LaTeX
726 \begin_layout Standard
727 There are two ways to extend \SpecialChar LaTeX
728 : classes and styles.
733 is a set of \SpecialChar LaTeX
734 macros describing a new type of document, like a book, or
736 There are classes for slides, for physics and math journals\SpecialChar ldots
738 even have a class for their thesis format.
743 differs from a class in that it doesn't define a new type of document,
744 but a different type of
748 that any document can use.
749 For example, \SpecialChar LyX
750 controls page margins and line spacing using two different
752 style-files designed for these purposes.
753 There are style-files for a whole slew of things: printing labels or envelopes,
754 changing indentation behavior, adding new fonts, manipulating graphics,
755 designing fancy page headings, customizing bibliographies, altering the
756 location and appearance of footnotes, tables, and figures, customizing
760 \begin_layout Standard
764 \begin_layout Description
766 : Typesetting language with macro capability.
769 \begin_layout Description
771 : Macro package built upon \SpecialChar TeX
772 \SpecialChar endofsentence
776 \begin_layout Description
777 classes: Descriptions of types of document used with \SpecialChar LaTeX
778 \SpecialChar endofsentence
782 \begin_layout Description
783 styles: Descriptions of the default behavior of particular elements of \SpecialChar LaTeX
787 \begin_layout Description
789 : Visual, WYSIWYM document processor that uses \SpecialChar LaTeX
790 to do its typesetting.
793 \begin_layout Standard
794 This section attempts to explain the difference between \SpecialChar LyX
795 and a word processor.
796 Simply put, \SpecialChar LaTeX
798 By using \SpecialChar LaTeX
799 as its backend, \SpecialChar LyX
800 helps you to think more about
809 The computer then handles
816 \begin_layout Section
817 Navigating the Documentation
820 \begin_layout Standard
821 To make it easier to answer your questions and describe all of the features
823 , the documentation has been split up into several different files.
824 Each one has its own purpose, as described below.
825 Before you go ploughing into any of those files, however, you should read
826 this chapter thoroughly, since it contains a lot of useful information
827 and commentary that can save you some time.
830 \begin_layout Standard
831 Hopefully, the development of \SpecialChar LyX
832 will never stop; so some of the documentation
833 may be incomplete or a bit out of date, though we try to keep up-to-date.
834 Like the rest of \SpecialChar LyX
835 , the manuals are the work of a group of volunteers who
837 \begin_inset Quotes eld
841 \begin_inset Quotes erd
844 , families, dishes to clean,
849 If you want to help out, be sure to read Section
854 \begin_inset CommandInset ref
856 reference "sec:Contrib"
860 in addition to the rest of this document.
863 \begin_layout Standard
864 Also, please do us a favor – if anything in these manuals confuses you,
865 is unclear, or wrong, don't hesitate to let us know! You can reach the
866 current document maintainers by emailing
867 \begin_inset CommandInset href
869 target "lyx-docs@lists.lyx.org"
876 If you have questions that are not obviously answered in the documentation,
877 and need help fast, there is an active users' mailing list which you can
879 \begin_inset CommandInset href
881 target "lyx-users@lists.lyx.org"
890 \begin_layout Subsection
891 The Format of the Manuals
894 \begin_layout Standard
895 Some of you may have printed out the manuals.
896 Others may be reading them within \SpecialChar LyX
898 There are some differences between the \SpecialChar LyX
899 -file and the printed version.
901 , the title is simply at the top of the document, not formatted on a
902 separate page as in some of the printed versions.
903 Nor are any of the footnotes or the Table of Contents fully visible.
904 To open a footnote, which looks like this:
905 \begin_inset Graphics
906 filename ../../../../lib/doc/clipart/footnote.png
911 , click on it with the left mouse button.
912 For the Table of Contents, either click on the grey box or click on the
917 menu, where the contents are displayed automatically\SpecialChar endofsentence
921 \begin_layout Standard
922 In the printed manuals, all cross-references appear as the actual numbers
923 for a chapter, section, subsection, and so on.
924 In the \SpecialChar LyX
925 -file, however, all cross-references appear as light-grey boxes
927 \begin_inset Graphics
928 filename ../../../../lib/doc/clipart/reference.png
934 If you click on such a box with the left mouse button, a dialog box will
935 appear containing a list of all the cross-references in the document.
936 You can go to the referenced section by right-clicking on the box or by
949 in the opened dialog.
950 Going back to where you came from is just as easy.
959 to go back to your earlier location.
962 \begin_layout Standard
963 Now that we've cleared up some of the differences between the printed and
965 -file versions of this file, we can start looking at the format of this
967 You'll occasionally notice things in different fonts:
970 \begin_layout Itemize
975 is used for general emphasis, generic arguments, book titles, names of
976 sections of other manuals, and notes from the authors.
979 \begin_layout Itemize
984 is used for program and file names, \SpecialChar LyX
988 \begin_layout Itemize
993 is used for menu, button, or dialog box names, and the names of keyboard
997 \begin_layout Itemize
1002 is used for people's names.
1005 \begin_layout Itemize
1010 is used for \SpecialChar LaTeX
1014 \begin_layout Standard
1015 When we do need to reference keys, we'll use the following prefixing convention:
1018 \begin_layout Itemize
1019 \begin_inset Quotes eld
1027 \begin_inset Quotes erd
1037 \begin_layout Itemize
1038 \begin_inset Quotes eld
1046 \begin_inset Quotes erd
1056 \begin_layout Itemize
1057 \begin_inset Quotes eld
1065 \begin_inset Quotes erd
1079 \begin_layout Itemize
1080 \begin_inset Quotes eld
1088 \begin_inset Quotes erd
1093 \begin_inset Quotes eld
1101 \begin_inset Quotes erd
1104 are the function keys.
1107 \begin_layout Itemize
1108 \begin_inset Quotes eld
1116 \begin_inset Quotes erd
1122 \begin_layout Itemize
1123 \begin_inset Quotes eld
1131 \begin_inset Quotes erd
1135 \begin_inset Quotes eld
1143 \begin_inset Quotes erd
1147 \begin_inset Quotes eld
1155 \begin_inset Quotes erd
1159 \begin_inset Quotes eld
1167 \begin_inset Quotes erd
1173 \begin_layout Itemize
1176 \begin_inset Quotes eld
1182 \begin_inset Quotes erd
1186 \begin_inset Quotes eld
1194 \begin_inset Quotes erd
1198 \begin_inset Quotes eld
1206 \begin_inset Quotes erd
1210 \begin_inset Quotes eld
1218 \begin_inset Quotes erd
1222 \begin_inset Quotes eld
1230 \begin_inset Quotes erd
1234 \begin_inset Quotes eld
1242 \begin_inset Quotes erd
1246 \begin_inset space ~
1249 keys that appear above the cursor keys on many PC keyboards.
1251 \begin_inset Quotes eld
1259 \begin_inset Quotes erd
1263 \begin_inset Quotes eld
1271 \begin_inset Quotes erd
1275 \begin_inset Quotes eld
1283 \begin_inset Quotes erd
1287 \begin_inset Quotes eld
1295 \begin_inset Quotes erd
1301 \begin_layout Itemize
1310 both refer to the same key.
1311 Some keyboards label the
1316 \begin_inset Quotes eld
1320 \begin_inset Quotes erd
1324 \begin_inset Quotes eld
1328 \begin_inset Quotes erd
1331 still others have two keys.
1333 treats all of them as the same key, so we'll use
1344 \begin_layout Standard
1345 The list with the currently set shortcuts can be found in the
1356 \begin_layout Subsection
1357 Units used in the Manuals
1360 \begin_layout Standard
1361 To understand the units described in this documentation, Table
1362 \begin_inset space ~
1366 \begin_inset CommandInset ref
1368 reference "tab:Units"
1372 explains all units available in \SpecialChar LyX
1376 \begin_layout Standard
1377 \begin_inset Float table
1384 \begin_layout Plain Layout
1385 \begin_inset Caption Standard
1387 \begin_layout Plain Layout
1388 \begin_inset CommandInset label
1402 \begin_layout Plain Layout
1403 \begin_inset VSpace medskip
1409 \begin_layout Plain Layout
1411 \begin_inset Tabular
1412 <lyxtabular version="3" rows="20" columns="2">
1413 <features booktabs="true" tabularvalignment="middle">
1414 <column alignment="center" valignment="top" width="0pt">
1415 <column alignment="center" valignment="top">
1417 <cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
1420 \begin_layout Plain Layout
1426 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1429 \begin_layout Plain Layout
1437 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1440 \begin_layout Plain Layout
1446 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1449 \begin_layout Plain Layout
1457 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1460 \begin_layout Plain Layout
1466 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1469 \begin_layout Plain Layout
1477 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1480 \begin_layout Plain Layout
1486 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1489 \begin_layout Plain Layout
1491 \begin_inset space \thinspace{}
1495 \begin_inset space \thinspace{}
1505 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1508 \begin_layout Plain Layout
1514 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1517 \begin_layout Plain Layout
1519 \begin_inset space \thinspace{}
1523 \begin_inset space \thinspace{}
1533 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1536 \begin_layout Plain Layout
1542 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1545 \begin_layout Plain Layout
1547 \begin_inset space \thinspace{}
1551 \begin_inset space \thinspace{}
1561 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1564 \begin_layout Plain Layout
1570 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1573 \begin_layout Plain Layout
1575 \begin_inset space \thinspace{}
1579 \begin_inset space \thinspace{}
1589 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1592 \begin_layout Plain Layout
1598 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1601 \begin_layout Plain Layout
1603 \begin_inset space \thinspace{}
1607 \begin_inset space \thinspace{}
1617 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1620 \begin_layout Plain Layout
1626 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1629 \begin_layout Plain Layout
1631 \begin_inset space \thinspace{}
1635 \begin_inset Formula $\approx$
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
1690 % of original image width
1697 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1700 \begin_layout Plain Layout
1706 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1709 \begin_layout Plain Layout
1717 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1720 \begin_layout Plain Layout
1726 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1729 \begin_layout Plain Layout
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
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
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" bottomline="true" leftline="true" usebox="none">
1868 \begin_layout Plain Layout
1874 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1877 \begin_layout Plain Layout
1879 \begin_inset space \thinspace{}
1883 \begin_inset space \thinspace{}
1904 \begin_layout Subsection
1908 \begin_layout Standard
1909 The following list describes the contents of the basic documentation files
1910 that you find in the
1917 \begin_layout Description
1918 Introduction This file.
1921 \begin_layout Description
1922 Tutorial If you are new to \SpecialChar LyX
1923 , and have never used \SpecialChar LaTeX
1924 before, you should start
1926 If you have used \SpecialChar LaTeX
1927 before, you should still read the
1931 , starting with the section on
1932 \begin_inset Quotes eld
1936 for \SpecialChar LaTeX
1938 \begin_inset Quotes erd
1941 (Skimming through the rest of the document wouldn't hurt, either.)
1944 \begin_layout Description
1946 \begin_inset space ~
1949 Guide The primary documentation.
1954 of the basic operation and available features of \SpecialChar LyX
1956 The main manual assumes that you have read the
1963 \begin_layout Description
1965 \begin_inset space ~
1968 Objects Extension of the
1973 Documents in detail how to use tables, graphics, floats, notes, program
1975 It also includes many tricks of the \SpecialChar LaTeX
1979 \begin_layout Description
1980 Math Extension of the
1985 Documents in detail how to typeset any kind of formula.
1988 \begin_layout Description
1990 \begin_inset space ~
1993 Features Extension of the
1998 Documents how to use raw \SpecialChar LaTeX
1999 commands, additional layouts and special-purpose
2003 \begin_layout Description
2004 Customization A description of advanced \SpecialChar LyX
2005 features, including how to customize
2006 the overall behavior of \SpecialChar LyX
2007 \SpecialChar endofsentence
2008 This includes such things as keybindings, internationa
2009 lization and configuration files.
2010 It also includes information about layout files, which are needed to get
2012 to support \SpecialChar LaTeX
2013 classes or packages.
2016 \begin_layout Description
2017 Shortcuts Tables of the currently defined \SpecialChar LyX
2021 \begin_layout Description
2024 \begin_inset space ~
2027 Configuration A report produced by \SpecialChar LyX
2029 This file contains information on what \SpecialChar LyX
2030 learned about your installation.
2031 Check it to see if you're missing something you might like to have.
2034 \begin_layout Standard
2035 These files will reference one another as necessary.
2044 information on installation and customization, but refers the reader to
2047 Customization Manual
2049 for more information.
2052 \begin_layout Standard
2053 We'll state again an important point:
2056 \begin_layout Standard
2057 \begin_inset VSpace bigskip
2063 \begin_layout Standard
2065 If you are new to \SpecialChar LyX
2071 Now\SpecialChar endofsentence
2075 \begin_layout Standard
2076 \begin_inset VSpace bigskip
2082 \begin_layout Standard
2083 Otherwise, you could needlessly frustrate yourself.
2086 \begin_layout Section
2087 Contributing to the \SpecialChar LyX
2089 \begin_inset CommandInset label
2098 \begin_layout Subsection
2099 Contributing to \SpecialChar LyX
2103 \begin_layout Standard
2105 is mostly written in C++ (the \SpecialChar LaTeX
2106 importer is written in Python).
2107 It is a large project, and as a result it is not free from bugs, or the
2108 need for improvements in the source code.
2111 \begin_layout Subsubsection
2115 \begin_layout Standard
2116 While using \SpecialChar LyX
2117 , you may find behavior which you consider a bug.
2118 Crashes, though rare, can happen.
2119 User interface problems are considered major bugs by the \SpecialChar LyX
2121 helpful are indications of parts of the \SpecialChar LyX
2122 interface you find confusing,
2126 \begin_layout Standard
2128 has a bug tracking system, which you can find at
2129 \begin_inset Newline newline
2133 \begin_inset CommandInset href
2135 target "https://www.lyx.org/trac/wiki/BugTrackerHome"
2140 You should check the bug tracker before reporting any bugs, in case it
2141 has already been reported.
2142 If you have a comment on an existing bug, or wish to report a new bug,
2143 you may either use the bug tracker, or send an e-mail to the development
2145 \begin_inset CommandInset href
2147 target "lyx-devel@lists.lyx.org"
2154 Archives of this list are linked from the main \SpecialChar LyX
2156 \begin_inset CommandInset href
2158 target "http://www.lyx.org"
2165 \begin_layout Standard
2166 A useful bug report will at a minimum include the version of \SpecialChar LyX
2169 Accurate, detailed descriptions are preferred — the more time developers
2170 have to spend to pinpoint the source of a bug, the less time they have
2171 for other improvements.
2172 Mention the system and system version on which you are running \SpecialChar LyX
2174 Give the versions of the libraries you have installed on your system, and,
2175 if relevant, the versions of external programs that \SpecialChar LyX
2177 If it's a compilation or configuration problem, include the file
2181 , and mention which compiler you are using.
2184 \begin_layout Subsubsection
2185 Contributing fixes and new features
2188 \begin_layout Standard
2189 If you have made changes to \SpecialChar LyX
2190 's source that you think should become part
2192 , send your changes as a diff file (in unified format) to the development
2193 list referenced above, along with a change log, and a description of what
2197 \begin_layout Subsection
2198 Contributing to the Documentation
2201 \begin_layout Standard
2203 's documentation is extensive; however \SpecialChar LyX
2204 is under constant development, and
2205 each new release adds new features.
2206 You may find some documentation needs improvement.
2207 This section describes what to do if you find an error, or have some suggestion
2208 s for improving the documentation.
2211 \begin_layout Subsubsection
2212 Reporting Errors in the Manuals
2215 \begin_layout Standard
2216 If you find a problem with the documentation, send a message to the mailing
2218 \begin_inset CommandInset href
2220 target "lyx-docs@lists.lyx.org"
2227 The documentation team will make any necessary fixes.
2230 \begin_layout Subsubsection
2231 Joining the Documentation Team.
2234 \begin_layout Standard
2235 The \SpecialChar LyX
2236 Documentation Project, like anything else in the \SpecialChar LyX
2238 use assistance! If you're interested in contributing to the Documentation
2239 Project, you need to do the following:
2242 \begin_layout Enumerate
2243 Get the latest \SpecialChar LyX
2245 \begin_inset Newline newline
2249 \begin_inset CommandInset href
2251 target "https://www.lyx.org/trac/browser/lyxgit/lib/doc?rev=master "
2258 \begin_layout Enumerate
2268 \begin_inset Newline newline
2271 The point of this exercise is to give you ideas.
2280 are likely to be the most up-to-date of all of the documentation.
2281 You should be able to glean some insights into how we want the manuals
2282 to read and to look.
2285 \begin_layout Enumerate
2286 Contact the team at:
2287 \begin_inset Newline newline
2291 \begin_inset CommandInset href
2293 target "lyx-docs@lists.lyx.org"
2300 \begin_inset Newline newline
2303 to discuss your intended changes and to get some feedback on them.
2306 \begin_layout Standard
2307 The changes you wish to make may range from improving clarity of the text,
2308 to doing major re-structuring of the documentation.
2309 Any and all improvements are gladly received.