1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 %This preamble is designed to ensure that the document prints
12 % out as advertised. If you mess with this preamble,
13 % parts of the document may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC is numbered roman
19 % and a pdf-bookmark for the TOC is added
21 \let\myTOC\tableofcontents
22 \renewcommand\tableofcontents{%
23 \pdfbookmark[1]{\contentsname}{}
26 \pagenumbering{arabic} }
28 \use_default_options false
29 \maintain_unincluded_children 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
110 \output_changes false
112 \postpone_fragile_content false
115 \html_be_strict false
116 \docbook_table_output 0
117 \author -584632292 "Richard Kimberly Heck"
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 is a program that provides a modern approach to writing documents with
196 a computer by using a markup language paradigm, an approach that breaks
197 with the obsolete tradition of the
198 \begin_inset Quotes eld
202 \begin_inset Quotes erd
206 It is designed for authors who want professional output quickly with a
207 minimum of effort and without becoming specialists in typesetting.
208 The job of typesetting is done mostly by the computer, not the author;
209 with \SpecialChar LyX
210 , the author can concentrate on the contents of his writing.
213 \begin_layout Standard
214 Part of the initial challenge of using \SpecialChar LyX
215 comes from the change in thinking
216 that you, the user, must make.
217 At one time, all we had for creating documents were typewriters, so we
218 all learned certain tricks to get around their limitations.
219 Underlining, which is little more than overstriking with the
220 \begin_inset Quotes eld
224 \begin_inset Quotes erd
227 character, became a way to emphasize text.
228 You were forced to figure out column sizes and tab stops, and set them,
229 before creating a table.
230 The same applied for letters and other right justified text.
231 Hyphenation at the end of a line required a careful eye and a lot of foresight.
234 \begin_layout Standard
235 In other words, we've all been trained to worry about the little details
236 of which character goes where.
237 Consequently, almost all word processors have this mentality.
238 They still use tab stops for adding whitespace.
239 You still need to worry about exactly where on the page something will
241 Emphasizing text means changing a font, similar to changing the typewriter
243 This is the underlying philosophy of a WYSIWYG word processor:
244 \begin_inset Quotes eld
247 What You See Is What You Get
248 \begin_inset Quotes erd
252 Unfortunately, that paradigm often results in
253 \begin_inset Quotes eld
256 What You See Is All You Get
257 \begin_inset Quotes erd
263 \begin_layout Standard
264 This is where \SpecialChar LyX
265 differs from an ordinary word processor.
266 You don't concern yourself with what character goes where.
267 You tell \SpecialChar LyX
273 takes care of the rest, following a set of rules called a
281 \begin_layout Plain Layout
282 To be fair, most recent versions of the most popular office suites now have
283 some sort of style sheets which follow a similar markup method.
284 However, our experience is that they are still rarely used in practice.
289 Let's look at a little example:
292 \begin_layout Standard
293 Suppose you are writing a report.
294 To begin your report, you want a section called
295 \begin_inset Quotes eld
298 Introduction\SpecialChar endofsentence
300 \begin_inset Quotes erd
303 So, you go into whatever menu it is in your word processor that changes
304 font sizes and decide on a new font size.
305 Then you turn on bold face.
307 \begin_inset Quotes eld
319 \begin_inset Quotes erd
323 Of course, if you later decide that this section belongs someplace else
324 in the document or if you insert a new section before it, you need to change
325 the numbering for this and all following sections, as well as any entry
326 in the table of contents.
329 \begin_layout Standard
331 , you go to the pull-down on the far left of the button bar and select
337 \begin_inset Quotes eld
341 \begin_inset Quotes erd
347 \begin_layout Standard
349 If you cut and paste the section, it will automatically be renumbered —
351 And if you enter references to that section correctly (by inserting cross-refer
352 ence tags), \SpecialChar LyX
353 will automatically update them all throughout the file so that
354 you never, ever type a section number.
357 \begin_layout Standard
358 Now let's look at the problem of consistency.
359 Five days later, you reopen your report and start Section
364 However, you forget that you were using 18
365 \begin_inset space \thinspace{}
368 pt bold instead of 16
369 \begin_inset space \thinspace{}
372 pt, so you type in the heading for Section
376 4 in a different font from the one you used for Section
381 That problem doesn't even exist in \SpecialChar LyX
383 The computer takes care of all that silly bookkeeping about which thing
384 has what size font, not you.
385 After all, that's what a computer is good at.
388 \begin_layout Standard
389 Here's another example.
390 Suppose you're making a list.
391 In other word processors, a list is just a bunch of tab stops and newlines.
392 You need to figure out where to put the label for each list item, what
393 that label should be, how many blank lines to put between each item, and
395 Under \SpecialChar LyX
396 , you have only two concerns: what kind of list is this, and what
397 do I want to put in it? That is it.
400 \begin_layout Standard
401 So, the basic idea behind \SpecialChar LyX
412 \begin_inset Quotes eld
415 What You See Is What You Get,
416 \begin_inset Quotes erd
421 \begin_inset Quotes eld
424 What You See Is What You
429 \begin_inset Quotes erd
433 \begin_inset Quotes eld
437 \begin_inset Quotes erd
440 It's a powerful idea that greatly simplifies the mechanics of writing documents.
441 This is also why \SpecialChar LyX
442 isn't so good for creating posters and flyers.
447 want to specify exactly where everything goes, because there are no functional
448 units like paragraphs, sections, etc.
449 This doesn't mean \SpecialChar LyX
450 is missing some cool function.
451 It simply means that it isn't the right tool for the job — you don't use
452 a screwdriver to drive in nails.
455 \begin_layout Subsection
456 Differences between \SpecialChar LyX
457 and Other Word Processors
460 \begin_layout Standard
461 Here's a list of things you won't find in \SpecialChar LyX
465 \begin_layout Itemize
469 \begin_layout Itemize
473 \begin_layout Itemize
475 \begin_inset space \thinspace{}
479 \begin_inset space \space{}
493 \begin_layout Standard
494 Tab stops, along with a ruler showing you the position of things on the
495 page, are useless in \SpecialChar LyX
497 The program worries about where things go on the page, not you.
498 Extra whitespace is similar; \SpecialChar LyX
499 adds it where necessary, depending on context.
500 Not being able to type two blank lines in a row will be annoying at first,
501 but it makes more sense once you're thinking in WYSIWYM terms.
504 \begin_layout Standard
505 Here are some things that exist in \SpecialChar LyX
506 , but aren't used as you might think:
509 \begin_layout Itemize
513 \begin_layout Itemize
517 \begin_layout Itemize
519 \begin_inset space \thinspace{}
523 \begin_inset space \space{}
526 single spaced, double spaced, etc.)
529 \begin_layout Itemize
530 Whitespace, horizontal and vertical
533 \begin_layout Itemize
537 \begin_layout Itemize
538 Typefaces (bold, italic, underline, etc.)
541 \begin_layout Standard
542 Although they exist in \SpecialChar LyX
543 , you generally don't need them.
545 will take care of these things for you, depending on what you're doing.
546 Different parts of the document are automatically set in a different typeface
548 Paragraph indenting is context dependent; different types of paragraphs
549 get indented differently.
550 Page breaks get handled automatically, as well.
551 In general, the space between lines, between words, and between paragraphs
552 is variable, set by \SpecialChar LyX
557 \begin_layout Plain Layout
558 There are ways to adjust all of these (only some of which require knowledge
559 of \SpecialChar LaTeX
560 ), either for a whole document or for a specific location in a document.
577 \begin_layout Standard
578 Lastly, there are a few areas where we believe \SpecialChar LyX
579 (and \SpecialChar LaTeX
580 ) surpasses many word
584 \begin_layout Itemize
588 \begin_layout Itemize
592 \begin_layout Itemize
596 \begin_layout Itemize
600 \begin_layout Itemize
604 \begin_layout Standard
605 Granted, many modern word processors can handle mathematical symbols, tables,
606 and hyphenation, and many have moved towards style definitions and the
608 However, they've only recently been able to do so, whereas \SpecialChar LyX
610 the \SpecialChar LaTeX
611 document preparation system.
613 has been around since 1985, and
620 \begin_layout Subsection
621 What is \SpecialChar LaTeX
625 \begin_layout Standard
627 is a document preparation system designed by Leslie Lamport in 1985.
631 \begin_layout Plain Layout
632 The source for the info in this section is
634 A Guide to \SpecialChar LaTeX2e
637 , by Helmut Kopka and Patrick Daly, which has an entry in the bibliography
642 \SpecialChar endofsentence
648 It was built up from a typesetting language called \SpecialChar TeX
652 takes a sequence of typesetting commands, written in a script in an ASCII
653 file, and executes them.
655 \begin_inset Quotes eld
659 \begin_inset Quotes erd
662 of the printing trade were modeled by Knuth as computer algorithms and
663 incorporated into \SpecialChar TeX
664 , hence its excellent printed appearance.
665 What comes directly out of \SpecialChar TeX
666 is the portable document format
671 \begin_inset Quotes eld
675 \begin_inset Quotes erd
683 The dvi format is often used for previews and can later be converted to
684 other formats like PostScript.
688 \begin_layout Standard
690 isn't only a typesetting engine; it also allows you to define macros.
691 Most people who use \SpecialChar TeX
692 are actually using a macro package which Knuth created
693 to hide a lot of the typesetting details.
694 This is where Leslie Lamport enters our story.
695 He wanted a macro package that was more user- and less typesetter-oriented,
696 with a set of commands that consistently typeset things like sections,
697 tables or math formulas in a uniform, consistent fashion.
698 This is how \SpecialChar LaTeX
702 \begin_layout Standard
703 Now, in parallel with the development and growth of \SpecialChar LaTeX
704 , other folks were creating
705 their own custom macro packages for \SpecialChar TeX
706 , ones to make slides or articles for
707 math journals and so on.
708 Some used the raw \SpecialChar TeX
709 facilities to do this, others began modifying \SpecialChar LaTeX
711 To try and unify this mess, a team of \SpecialChar LaTeX
712 -nicians began to work on \SpecialChar LaTeX2e
714 version of \SpecialChar LaTeX
715 , during the late 1980's.
716 This new version of \SpecialChar LaTeX
717 has commands which provide an easier-to-use interface
719 's macro-creating commands, aid in the use of new fonts, and so on.
720 In fact, \SpecialChar LaTeX
721 is quite an extensive language in its own right! Users around
722 the world have been creating their own add-ons for \SpecialChar LaTeX
727 \begin_layout Standard
728 There are two ways to extend \SpecialChar LaTeX
729 : classes and styles.
734 is a set of \SpecialChar LaTeX
735 macros describing a new type of document, like a book, or
737 There are classes for slides, for physics and math journals\SpecialChar ldots
739 even have a class for their thesis format.
744 differs from a class in that it doesn't define a new type of document,
745 but a different type of
749 that any document can use.
750 For example, \SpecialChar LyX
751 controls page margins and line spacing using two different
753 style-files designed for these purposes.
754 There are style-files for a whole slew of things: printing labels or envelopes,
755 changing indentation behavior, adding new fonts, manipulating graphics,
756 designing fancy page headings, customizing bibliographies, altering the
757 location and appearance of footnotes, tables, and figures, customizing
761 \begin_layout Standard
765 \begin_layout Description
767 : Typesetting language with macro capability.
770 \begin_layout Description
772 : Macro package built upon \SpecialChar TeX
773 \SpecialChar endofsentence
777 \begin_layout Description
778 classes: Descriptions of types of document used with \SpecialChar LaTeX
779 \SpecialChar endofsentence
783 \begin_layout Description
784 styles: Descriptions of the default behavior of particular elements of \SpecialChar LaTeX
788 \begin_layout Description
790 : Visual, WYSIWYM document processor that uses \SpecialChar LaTeX
791 to do its typesetting.
794 \begin_layout Standard
795 This section attempts to explain the difference between \SpecialChar LyX
796 and a word processor.
797 Simply put, \SpecialChar LaTeX
799 By using \SpecialChar LaTeX
800 as its backend, \SpecialChar LyX
801 helps you to think more about
810 The computer then handles
817 \begin_layout Section
818 Navigating the Documentation
821 \begin_layout Standard
822 To make it easier to answer your questions and describe all of the features
824 , the documentation has been split up into several different files.
825 Each one has its own purpose, as described below.
826 Before you go ploughing into any of those files, however, you should read
827 this chapter thoroughly, since it contains a lot of useful information
828 and commentary that can save you some time.
831 \begin_layout Standard
832 Hopefully, the development of \SpecialChar LyX
833 will never stop; so some of the documentation
834 may be incomplete or a bit out of date, though we try to keep up-to-date.
835 Like the rest of \SpecialChar LyX
836 , the manuals are the work of a group of volunteers who
838 \begin_inset Quotes eld
842 \begin_inset Quotes erd
845 , families, dishes to clean,
850 If you want to help out, be sure to read Section
855 \begin_inset CommandInset ref
857 reference "sec:Contrib"
861 in addition to the rest of this document.
864 \begin_layout Standard
865 Also, please do us a favor: if anything in these manuals confuses you, is
866 unclear, or wrong, don't hesitate to let us know! You can reach the current
867 document maintainers by emailing
868 \begin_inset CommandInset href
870 target "lyx-docs@lists.lyx.org"
878 \change_inserted -584632292 1610248366
882 \begin_layout Subsection
884 \change_inserted -584632292 1610248375
888 \begin_layout Standard
889 If you have questions that are not obviously answered in the documentation
890 and need help fast, there is an active users' mailing list which you can
892 \begin_inset CommandInset href
894 target "lyx-users@lists.lyx.org"
902 \change_inserted -584632292 1610248524
903 You do not have to register to post, but you may wish to do so.
905 \begin_inset CommandInset href
907 name "the LyX website"
908 target "https://www.lyx.org/MailingLists"
913 for further information.
915 \begin_inset CommandInset href
917 target "http://wiki.lyx.org/"
922 that will answer many questions about how to get LyX to do various things.
927 \begin_layout Subsection
928 The Format of the Manuals
931 \begin_layout Standard
932 Some of you may have printed out the manuals.
933 Others may be reading them within \SpecialChar LyX
935 There are some differences between the \SpecialChar LyX
936 -file and the printed version.
938 , the title is simply at the top of the document, not formatted on a
939 separate page as in some of the printed versions.
940 Nor are any of the footnotes or the Table of Contents fully visible.
941 To open a footnote, which looks like this:
942 \begin_inset Graphics
943 filename clipart/footnote.png
948 , click on it with the left mouse button.
949 For the Table of Contents, either click on the grey box or click on the
954 menu, where the contents are displayed automatically\SpecialChar endofsentence
958 \begin_layout Standard
959 In the printed manuals, all cross-references appear as the actual numbers
960 for a chapter, section, subsection, and so on.
961 In the \SpecialChar LyX
962 -file, however, all cross-references appear as light-grey boxes
964 \begin_inset Graphics
965 filename clipart/reference.png
971 If you click on such a box with the left mouse button, a dialog box will
972 appear containing a list of all the cross-references in the document.
973 You can go to the referenced section by right-clicking on the box or by
986 in the opened dialog.
987 Going back to where you came from is just as easy.
996 to go back to your earlier location.
999 \begin_layout Standard
1000 Now that we've cleared up some of the differences between the printed and
1002 -file versions of this file, we can start looking at the format of this
1004 You'll occasionally notice things in different fonts:
1007 \begin_layout Itemize
1012 is used for general emphasis, generic arguments, book titles, names of
1013 sections of other manuals, and notes from the authors.
1016 \begin_layout Itemize
1021 is used for program and file names, \SpecialChar LyX
1025 \begin_layout Itemize
1030 is used for menu, button, or dialog box names, and the names of keyboard
1034 \begin_layout Itemize
1039 is used for people's names.
1042 \begin_layout Itemize
1047 is used for \SpecialChar LaTeX
1051 \begin_layout Standard
1052 When we do need to reference keys, we'll use the following prefixing convention:
1055 \begin_layout Itemize
1056 \begin_inset Quotes eld
1064 \begin_inset Quotes erd
1074 \begin_layout Itemize
1075 \begin_inset Quotes eld
1083 \begin_inset Quotes erd
1093 \begin_layout Itemize
1094 \begin_inset Quotes eld
1102 \begin_inset Quotes erd
1116 \begin_layout Itemize
1117 \begin_inset Quotes eld
1125 \begin_inset Quotes erd
1130 \begin_inset Quotes eld
1138 \begin_inset Quotes erd
1141 are the function keys.
1144 \begin_layout Itemize
1145 \begin_inset Quotes eld
1153 \begin_inset Quotes erd
1159 \begin_layout Itemize
1160 \begin_inset Quotes eld
1168 \begin_inset Quotes erd
1172 \begin_inset Quotes eld
1180 \begin_inset Quotes erd
1184 \begin_inset Quotes eld
1192 \begin_inset Quotes erd
1196 \begin_inset Quotes eld
1204 \begin_inset Quotes erd
1210 \begin_layout Itemize
1213 \begin_inset Quotes eld
1219 \begin_inset Quotes erd
1223 \begin_inset Quotes eld
1231 \begin_inset Quotes erd
1235 \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 space ~
1286 keys that appear above the cursor keys on many PC keyboards.
1288 \begin_inset Quotes eld
1296 \begin_inset Quotes erd
1300 \begin_inset Quotes eld
1308 \begin_inset Quotes erd
1312 \begin_inset Quotes eld
1320 \begin_inset Quotes erd
1324 \begin_inset Quotes eld
1332 \begin_inset Quotes erd
1338 \begin_layout Itemize
1347 both refer to the same key.
1348 Some keyboards label the
1353 \begin_inset Quotes eld
1357 \begin_inset Quotes erd
1361 \begin_inset Quotes eld
1365 \begin_inset Quotes erd
1368 still others have two keys.
1370 treats all of them as the same key, so we'll use
1381 \begin_layout Standard
1382 The list with the currently set shortcuts can be found in the
1393 \begin_layout Subsection
1394 Units used in the Manuals
1397 \begin_layout Standard
1398 To understand the units described in this documentation, Table
1399 \begin_inset space ~
1403 \begin_inset CommandInset ref
1405 reference "tab:Units"
1409 explains all units available in \SpecialChar LyX
1413 \begin_layout Standard
1414 \begin_inset Float table
1421 \begin_layout Plain Layout
1422 \begin_inset Caption Standard
1424 \begin_layout Plain Layout
1425 \begin_inset CommandInset label
1439 \begin_layout Plain Layout
1440 \begin_inset VSpace medskip
1446 \begin_layout Plain Layout
1448 \begin_inset Tabular
1449 <lyxtabular version="3" rows="20" columns="2">
1450 <features booktabs="true" tabularvalignment="middle">
1451 <column alignment="center" valignment="top" width="0pt">
1452 <column alignment="center" valignment="top">
1454 <cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
1457 \begin_layout Plain Layout
1463 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1466 \begin_layout Plain Layout
1474 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1477 \begin_layout Plain Layout
1483 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1486 \begin_layout Plain Layout
1494 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1497 \begin_layout Plain Layout
1503 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1506 \begin_layout Plain Layout
1514 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1517 \begin_layout Plain Layout
1523 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1526 \begin_layout Plain Layout
1528 \begin_inset space \thinspace{}
1532 \begin_inset space \thinspace{}
1542 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1545 \begin_layout Plain Layout
1551 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1554 \begin_layout Plain Layout
1556 \begin_inset space \thinspace{}
1560 \begin_inset space \thinspace{}
1570 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1573 \begin_layout Plain Layout
1579 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1582 \begin_layout Plain Layout
1584 \begin_inset space \thinspace{}
1588 \begin_inset space \thinspace{}
1598 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1601 \begin_layout Plain Layout
1607 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1610 \begin_layout Plain Layout
1612 \begin_inset space \thinspace{}
1616 \begin_inset space \thinspace{}
1626 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1629 \begin_layout Plain Layout
1635 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1638 \begin_layout Plain Layout
1640 \begin_inset space \thinspace{}
1644 \begin_inset space \thinspace{}
1654 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1657 \begin_layout Plain Layout
1663 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1666 \begin_layout Plain Layout
1668 \begin_inset space \thinspace{}
1672 \begin_inset Formula $\approx$
1676 \begin_inset space \thinspace{}
1686 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1689 \begin_layout Plain Layout
1695 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1698 \begin_layout Plain Layout
1700 \begin_inset space \thinspace{}
1704 \begin_inset space \thinspace{}
1714 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1717 \begin_layout Plain Layout
1723 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1726 \begin_layout Plain Layout
1727 % of original image width
1734 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1737 \begin_layout Plain Layout
1743 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1746 \begin_layout Plain Layout
1754 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1757 \begin_layout Plain Layout
1763 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1766 \begin_layout Plain Layout
1774 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1777 \begin_layout Plain Layout
1783 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1786 \begin_layout Plain Layout
1794 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1797 \begin_layout Plain Layout
1803 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1806 \begin_layout Plain Layout
1814 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1817 \begin_layout Plain Layout
1823 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1826 \begin_layout Plain Layout
1834 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1837 \begin_layout Plain Layout
1843 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1846 \begin_layout Plain Layout
1854 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1857 \begin_layout Plain Layout
1863 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1866 \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" bottomline="true" leftline="true" usebox="none">
1905 \begin_layout Plain Layout
1911 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1914 \begin_layout Plain Layout
1916 \begin_inset space \thinspace{}
1920 \begin_inset space \thinspace{}
1941 \begin_layout Subsection
1945 \begin_layout Standard
1946 The following list describes the contents of the basic documentation files
1947 that you find in the
1954 \begin_layout Description
1955 Introduction This file.
1958 \begin_layout Description
1959 Tutorial If you are new to \SpecialChar LyX
1960 , and have never used \SpecialChar LaTeX
1961 before, you should start
1963 If you have used \SpecialChar LaTeX
1964 before, you should still read the
1968 , starting with the section on
1969 \begin_inset Quotes eld
1973 for \SpecialChar LaTeX
1975 \begin_inset Quotes erd
1978 (Skimming through the rest of the document wouldn't hurt, either.)
1981 \begin_layout Description
1983 \begin_inset space ~
1986 Guide The primary documentation.
1991 of the basic operation and available features of \SpecialChar LyX
1993 The main manual assumes that you have read the
2000 \begin_layout Description
2002 \begin_inset space ~
2005 Objects Extension of the
2010 Documents in detail how to use tables, graphics, floats, notes, program
2012 It also includes many tricks of the \SpecialChar LaTeX
2016 \begin_layout Description
2017 Math Extension of the
2022 Documents in detail how to typeset any kind of formula.
2025 \begin_layout Description
2027 \begin_inset space ~
2030 Features Extension of the
2035 Documents how to use raw \SpecialChar LaTeX
2036 commands, additional layouts and special-purpose
2040 \begin_layout Description
2041 Customization A description of advanced \SpecialChar LyX
2042 features, including how to customize
2043 the overall behavior of \SpecialChar LyX
2044 \SpecialChar endofsentence
2045 This includes such things as keybindings, internationa
2046 lization and configuration files.
2047 It also includes information about layout files, which are needed to get
2049 to support \SpecialChar LaTeX
2050 classes or packages.
2053 \begin_layout Description
2054 Shortcuts Tables of the currently defined \SpecialChar LyX
2058 \begin_layout Description
2061 \begin_inset space ~
2064 Configuration A report produced by \SpecialChar LyX
2066 This file contains information on what \SpecialChar LyX
2067 learned about your installation.
2068 Check it to see if you're missing something you might like to have.
2071 \begin_layout Standard
2072 These files will reference one another as necessary.
2081 information on installation and customization, but refers the reader to
2084 Customization Manual
2086 for more information.
2089 \begin_layout Standard
2090 We'll state again an important point:
2093 \begin_layout Standard
2094 \begin_inset VSpace bigskip
2100 \begin_layout Standard
2102 If you are new to \SpecialChar LyX
2108 Now\SpecialChar endofsentence
2112 \begin_layout Standard
2113 \begin_inset VSpace bigskip
2119 \begin_layout Standard
2120 Otherwise, you could needlessly frustrate yourself.
2123 \begin_layout Section
2124 Contributing to the \SpecialChar LyX
2126 \begin_inset CommandInset label
2135 \begin_layout Subsection
2136 Contributing to \SpecialChar LyX
2140 \begin_layout Standard
2142 is mostly written in C++ (the \SpecialChar LaTeX
2143 importer is written in Python).
2144 It is a large project, and as a result it is not free from bugs, or the
2145 need for improvements in the source code.
2148 \begin_layout Subsubsection
2152 \begin_layout Standard
2153 While using \SpecialChar LyX
2154 , you may find behavior which you consider a bug.
2155 Crashes, though rare, can happen.
2156 User interface problems are considered major bugs by the \SpecialChar LyX
2158 helpful are indications of parts of the \SpecialChar LyX
2159 interface you find confusing,
2163 \begin_layout Standard
2165 has a bug tracking system, which you can find at
2166 \begin_inset Newline newline
2170 \begin_inset CommandInset href
2172 target "https://www.lyx.org/trac/wiki/BugTrackerHome"
2177 You should check the bug tracker before reporting any bugs, in case it
2178 has already been reported.
2179 If you have a comment on an existing bug, or wish to report a new bug,
2180 you may either use the bug tracker, or send an e-mail to the development
2182 \begin_inset CommandInset href
2184 target "lyx-devel@lists.lyx.org"
2191 Archives of this list are linked from the main \SpecialChar LyX
2193 \begin_inset CommandInset href
2195 target "http://www.lyx.org"
2202 \begin_layout Standard
2203 A useful bug report will at a minimum include the version of \SpecialChar LyX
2206 Accurate, detailed descriptions are preferred — the more time developers
2207 have to spend to pinpoint the source of a bug, the less time they have
2208 for other improvements.
2209 Mention the system and system version on which you are running \SpecialChar LyX
2211 Give the versions of the libraries you have installed on your system, and,
2212 if relevant, the versions of external programs that \SpecialChar LyX
2214 If it's a compilation or configuration problem, include the file
2218 , and mention which compiler you are using.
2221 \begin_layout Subsubsection
2222 Contributing fixes and new features
2225 \begin_layout Standard
2226 If you have made changes to \SpecialChar LyX
2227 's source that you think should become part
2229 , send your changes as a diff file (in unified format) to the development
2230 list referenced above, along with a change log, and a description of what
2234 \begin_layout Subsection
2235 Contributing to the Documentation
2238 \begin_layout Standard
2240 's documentation is extensive; however \SpecialChar LyX
2241 is under constant development, and
2242 each new release adds new features.
2243 You may find some documentation needs improvement.
2244 This section describes what to do if you find an error, or have some suggestion
2245 s for improving the documentation.
2248 \begin_layout Subsubsection
2249 Reporting Errors in the Manuals
2252 \begin_layout Standard
2253 If you find a problem with the documentation, send a message to the mailing
2255 \begin_inset CommandInset href
2257 target "lyx-docs@lists.lyx.org"
2264 The documentation team will make any necessary fixes.
2267 \begin_layout Subsubsection
2268 Joining the Documentation Team.
2271 \begin_layout Standard
2272 The \SpecialChar LyX
2273 Documentation Project, like anything else in the \SpecialChar LyX
2275 use assistance! If you're interested in contributing to the Documentation
2276 Project, you need to do the following:
2279 \begin_layout Enumerate
2280 Get the latest \SpecialChar LyX
2282 \begin_inset Newline newline
2286 \begin_inset CommandInset href
2288 target "https://www.lyx.org/trac/browser/lyxgit/lib/doc?rev=master "
2295 \begin_layout Enumerate
2305 \begin_inset Newline newline
2308 The point of this exercise is to give you ideas.
2317 are likely to be the most up-to-date of all of the documentation.
2318 You should be able to glean some insights into how we want the manuals
2319 to read and to look.
2322 \begin_layout Enumerate
2323 Contact the team at:
2324 \begin_inset Newline newline
2328 \begin_inset CommandInset href
2330 target "lyx-docs@lists.lyx.org"
2337 \begin_inset Newline newline
2340 to discuss your intended changes and to get some feedback on them.
2343 \begin_layout Standard
2344 The changes you wish to make may range from improving clarity of the text,
2345 to doing major re-structuring of the documentation.
2346 Any and all improvements are gladly received.