1 #LyX 2.3 created this file. For more info see http://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 %This preamble is designed to ensure that the document prints
12 % out as advertised. If you mess with this preamble,
13 % parts of the document may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC is numbered roman
19 % and a pdf-bookmark for the TOC is added
21 \let\myTOC\tableofcontents
22 \renewcommand\tableofcontents{%
23 \pdfbookmark[1]{\contentsname}{}
26 \pagenumbering{arabic} }
28 \use_default_options false
29 \maintain_unincluded_children false
31 \language_package default
34 \font_roman "palatino" "default"
35 \font_sans "helvet" "default"
36 \font_typewriter "courier" "default"
37 \font_math "auto" "auto"
38 \font_default_family default
39 \use_non_tex_fonts false
42 \font_sf_scale 100 100
43 \font_tt_scale 100 100
45 \use_dash_ligatures false
47 \default_output_format pdf2
49 \bibtex_command default
50 \index_command default
54 \pdf_title "Introduction to LyX"
55 \pdf_author "LyX Team"
56 \pdf_subject "LyX-documentation Intro"
57 \pdf_keywords "LyX, documentation"
59 \pdf_bookmarksnumbered true
60 \pdf_bookmarksopen true
61 \pdf_bookmarksopenlevel 2
66 \pdf_pdfusetitle false
67 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
70 \use_package amsmath 1
71 \use_package amssymb 1
74 \use_package mathdots 1
75 \use_package mathtools 1
77 \use_package stackrel 1
78 \use_package stmaryrd 1
79 \use_package undertilde 1
81 \cite_engine_type default
85 \paperorientation portrait
96 \paragraph_separation indent
97 \paragraph_indentation default
99 \math_numbering_side default
100 \quotes_style english
104 \paperpagestyle default
105 \tracking_changes false
106 \output_changes false
109 \html_be_strict false
115 Introduction to \SpecialChar LyX
120 by the \SpecialChar LyX
125 \begin_layout Plain Layout
127 If you have comments on or corrections to this documentation, please send
128 them to the \SpecialChar LyX
129 Documentation mailing list:
130 \begin_inset CommandInset href
132 target "lyx-docs@lists.lyx.org"
146 \begin_layout Standard
147 \begin_inset CommandInset toc
148 LatexCommand tableofcontents
155 \begin_layout Section
156 The Philosophy of \SpecialChar LyX
160 \begin_layout Subsection
161 What is \SpecialChar LyX
165 \begin_layout Standard
167 is a document preparation system.
168 It excels at letting you create complex technical and scientific articles
169 with mathematics, cross-references, bibliographies, indexes, etc.
170 It is very good for working with documents of any length in which the usual
171 processing abilities are required: automatic sectioning and pagination,
172 spell checking and so forth.
173 It can also be used to write a letter to your mom, though granted, there
174 are probably simpler programs available for that.
175 It is definitely not the best tool for creating banners, flyers, or advertiseme
176 nts (we'll explain why later), though with some effort all these can be
178 Here are some examples of what it is used for: memos, letters, dissertations
179 and theses, lecture notes, seminar notebooks, conference proceedings, software
180 documentation, books, articles in refereed scientific journals, scripts
181 for plays and movies, business proposals, presentations \SpecialChar ldots
185 \begin_layout Standard
187 is a program that provides a modern approach to writing documents with
188 a computer by using a markup language paradigm, an approach that breaks
189 with the obsolete tradition of the
190 \begin_inset Quotes eld
194 \begin_inset Quotes erd
198 It is designed for authors who want professional output quickly with a
199 minimum of effort and without becoming specialists in typesetting.
200 The job of typesetting is done mostly by the computer, not the author;
201 with \SpecialChar LyX
202 , the author can concentrate on the contents of his writing.
205 \begin_layout Standard
206 Part of the initial challenge of using \SpecialChar LyX
207 comes from the change in thinking
208 that you, the user, must make.
209 At one time, all we had for creating documents were typewriters, so we
210 all learned certain tricks to get around their limitations.
211 Underlining, which is little more than overstriking with the
212 \begin_inset Quotes eld
216 \begin_inset Quotes erd
219 character, became a way to emphasize text.
220 You were forced to figure out column sizes and tab stops, and set them,
221 before creating a table.
222 The same applied for letters and other right justified text.
223 Hyphenation at the end of a line required a careful eye and a lot of foresight.
226 \begin_layout Standard
227 In other words, we've all been trained to worry about the little details
228 of which character goes where.
229 Consequently, almost all word processors have this mentality.
230 They still use tab stops for adding whitespace.
231 You still need to worry about exactly where on the page something will
233 Emphasizing text means changing a font, similar to changing the typewriter
235 This is the underlying philosophy of a WYSIWYG word processor:
236 \begin_inset Quotes eld
239 What You See Is What You Get
240 \begin_inset Quotes erd
244 Unfortunately, that paradigm often results in
245 \begin_inset Quotes eld
248 What You See Is All You Get
249 \begin_inset Quotes erd
255 \begin_layout Standard
256 This is where \SpecialChar LyX
257 differs from an ordinary word processor.
258 You don't concern yourself with what character goes where.
259 You tell \SpecialChar LyX
265 takes care of the rest, following a set of rules called a
273 \begin_layout Plain Layout
274 To be fair, most recent versions of the most popular office suites now have
275 some sort of style sheets which follow a similar markup method.
276 However, our experience is that they are still rarely used in practice.
281 Let's look at a little example:
284 \begin_layout Standard
285 Suppose you are writing a report.
286 To begin your report, you want a section called
287 \begin_inset Quotes eld
290 Introduction\SpecialChar endofsentence
292 \begin_inset Quotes erd
295 So, you go into whatever menu it is in your word processor that changes
296 font sizes and decide on a new font size.
297 Then you turn on bold face.
299 \begin_inset Quotes eld
311 \begin_inset Quotes erd
315 Of course, if you later decide that this section belongs someplace else
316 in the document or if you insert a new section before it, you need to change
317 the numbering for this and all following sections, as well as any entry
318 in the table of contents.
321 \begin_layout Standard
323 , you go to the pull-down on the far left of the button bar and select
329 \begin_inset Quotes eld
333 \begin_inset Quotes erd
339 \begin_layout Standard
341 If you cut and paste the section, it will automatically be renumbered —
343 And if you enter references to that section correctly (by inserting cross-refer
344 ence tags), \SpecialChar LyX
345 will automatically update them all throughout the file so that
346 you never, ever type a section number.
349 \begin_layout Standard
350 Now let's look at the problem of consistency.
351 Five days later, you reopen your report and start Section
356 However, you forget that you were using 18
357 \begin_inset space \thinspace{}
360 pt bold instead of 16
361 \begin_inset space \thinspace{}
364 pt, so you type in the heading for Section
368 4 in a different font from the one you used for Section
373 That problem doesn't even exist in \SpecialChar LyX
375 The computer takes care of all that silly bookkeeping about which thing
376 has what size font, not you.
377 After all, that's what a computer is good at.
380 \begin_layout Standard
381 Here's another example.
382 Suppose you're making a list.
383 In other word processors, a list is just a bunch of tab stops and newlines.
384 You need to figure out where to put the label for each list item, what
385 that label should be, how many blank lines to put between each item, and
387 Under \SpecialChar LyX
388 , you have only two concerns: what kind of list is this, and what
389 do I want to put in it? That is it.
392 \begin_layout Standard
393 So, the basic idea behind \SpecialChar LyX
404 \begin_inset Quotes eld
407 What You See Is What You Get,
408 \begin_inset Quotes erd
413 \begin_inset Quotes eld
416 What You See Is What You
421 \begin_inset Quotes erd
425 \begin_inset Quotes eld
429 \begin_inset Quotes erd
432 It's a powerful idea that greatly simplifies the mechanics of writing documents.
433 This is also why \SpecialChar LyX
434 isn't so good for creating posters and flyers.
439 want to specify exactly where everything goes, because there are no functional
440 units like paragraphs, sections, etc.
441 This doesn't mean \SpecialChar LyX
442 is missing some cool function.
443 It simply means that it isn't the right tool for the job — you don't use
444 a screwdriver to drive in nails.
447 \begin_layout Subsection
448 Differences between \SpecialChar LyX
449 and Other Word Processors
452 \begin_layout Standard
453 Here's a list of things you won't find in \SpecialChar LyX
457 \begin_layout Itemize
461 \begin_layout Itemize
465 \begin_layout Itemize
467 \begin_inset space \thinspace{}
471 \begin_inset space \space{}
485 \begin_layout Standard
486 Tab stops, along with a ruler showing you the position of things on the
487 page, are useless in \SpecialChar LyX
489 The program worries about where things go on the page, not you.
490 Extra whitespace is similar; \SpecialChar LyX
491 adds it where necessary, depending on context.
492 Not being able to type two blank lines in a row will be annoying at first,
493 but it makes more sense once you're thinking in WYSIWYM terms.
496 \begin_layout Standard
497 Here are some things that exist in \SpecialChar LyX
498 , but aren't used as you might think:
501 \begin_layout Itemize
505 \begin_layout Itemize
509 \begin_layout Itemize
511 \begin_inset space \thinspace{}
515 \begin_inset space \space{}
518 single spaced, double spaced, etc.)
521 \begin_layout Itemize
522 Whitespace, horizontal and vertical
525 \begin_layout Itemize
529 \begin_layout Itemize
530 Typefaces (bold, italic, underline, etc.)
533 \begin_layout Standard
534 Although they exist in \SpecialChar LyX
535 , you generally don't need them.
537 will take care of these things for you, depending on what you're doing.
538 Different parts of the document are automatically set in a different typeface
540 Paragraph indenting is context dependent; different types of paragraphs
541 get indented differently.
542 Page breaks get handled automatically, as well.
543 In general, the space between lines, between words, and between paragraphs
544 is variable, set by \SpecialChar LyX
549 \begin_layout Plain Layout
550 There are ways to adjust all of these (only some of which require knowledge
551 of \SpecialChar LaTeX
552 ), either for a whole document or for a specific location in a document.
569 \begin_layout Standard
570 Lastly, there are a few areas where we believe \SpecialChar LyX
571 (and \SpecialChar LaTeX
572 ) surpasses many word
576 \begin_layout Itemize
580 \begin_layout Itemize
584 \begin_layout Itemize
588 \begin_layout Itemize
592 \begin_layout Itemize
596 \begin_layout Standard
597 Granted, many modern word processors can handle mathematical symbols, tables,
598 and hyphenation, and many have moved towards style definitions and the
600 However, they've only recently been able to do so, whereas \SpecialChar LyX
602 the \SpecialChar LaTeX
603 document preparation system.
605 has been around since 1985, and
612 \begin_layout Subsection
613 What is \SpecialChar LaTeX
617 \begin_layout Standard
619 is a document preparation system designed by Leslie Lamport in 1985.
623 \begin_layout Plain Layout
624 The source for the info in this section is
626 A Guide to \SpecialChar LaTeX2e
629 , by Helmut Kopka and Patrick Daly, which has an entry in the bibliography
634 \SpecialChar endofsentence
640 It was built up from a typesetting language called \SpecialChar TeX
644 takes a sequence of typesetting commands, written in a script in an ASCII
645 file, and executes them.
647 \begin_inset Quotes eld
651 \begin_inset Quotes erd
654 of the printing trade were modeled by Knuth as computer algorithms and
655 incorporated into \SpecialChar TeX
656 , hence its excellent printed appearance.
657 What comes directly out of \SpecialChar TeX
658 is the portable document format
663 \begin_inset Quotes eld
667 \begin_inset Quotes erd
675 The dvi format is often used for previews and can later be converted to
676 other formats like PostScript.
680 \begin_layout Standard
682 isn't only a typesetting engine; it also allows you to define macros.
683 Most people who use \SpecialChar TeX
684 are actually using a macro package which Knuth created
685 to hide a lot of the typesetting details.
686 This is where Leslie Lamport enters our story.
687 He wanted a macro package that was more user- and less typesetter-oriented,
688 with a set of commands that consistently typeset things like sections,
689 tables or math formulas in a uniform, consistent fashion.
690 This is how \SpecialChar LaTeX
694 \begin_layout Standard
695 Now, in parallel with the development and growth of \SpecialChar LaTeX
696 , other folks were creating
697 their own custom macro packages for \SpecialChar TeX
698 , ones to make slides or articles for
699 math journals and so on.
700 Some used the raw \SpecialChar TeX
701 facilities to do this, others began modifying \SpecialChar LaTeX
703 To try and unify this mess, a team of \SpecialChar LaTeX
704 -nicians began to work on \SpecialChar LaTeX2e
706 version of \SpecialChar LaTeX
707 , during the late 1980's.
708 This new version of \SpecialChar LaTeX
709 has commands which provide an easier-to-use interface
711 's macro-creating commands, aid in the use of new fonts, and so on.
712 In fact, \SpecialChar LaTeX
713 is quite an extensive language in its own right! Users around
714 the world have been creating their own add-ons for \SpecialChar LaTeX
719 \begin_layout Standard
720 There are two ways to extend \SpecialChar LaTeX
721 : classes and styles.
726 is a set of \SpecialChar LaTeX
727 macros describing a new type of document, like a book, or
729 There are classes for slides, for physics and math journals\SpecialChar ldots
731 even have a class for their thesis format.
736 differs from a class in that it doesn't define a new type of document,
737 but a different type of
741 that any document can use.
742 For example, \SpecialChar LyX
743 controls page margins and line spacing using two different
745 style-files designed for these purposes.
746 There are style-files for a whole slew of things: printing labels or envelopes,
747 changing indentation behavior, adding new fonts, manipulating graphics,
748 designing fancy page headings, customizing bibliographies, altering the
749 location and appearance of footnotes, tables, and figures, customizing
753 \begin_layout Standard
757 \begin_layout Description
759 : Typesetting language with macro capability.
762 \begin_layout Description
764 : Macro package built upon \SpecialChar TeX
765 \SpecialChar endofsentence
769 \begin_layout Description
770 classes: Descriptions of types of document used with \SpecialChar LaTeX
771 \SpecialChar endofsentence
775 \begin_layout Description
776 styles: Descriptions of the default behavior of particular elements of \SpecialChar LaTeX
780 \begin_layout Description
782 : Visual, WYSIWYM document processor that uses \SpecialChar LaTeX
783 to do its typesetting.
786 \begin_layout Standard
787 This section attempts to explain the difference between \SpecialChar LyX
788 and a word processor.
789 Simply put, \SpecialChar LaTeX
791 By using \SpecialChar LaTeX
792 as its backend, \SpecialChar LyX
793 helps you to think more about
802 The computer then handles
809 \begin_layout Section
810 Navigating the Documentation
813 \begin_layout Standard
814 To make it easier to answer your questions and describe all of the features
816 , the documentation has been split up into several different files.
817 Each one has its own purpose, as described below.
818 Before you go ploughing into any of those files, however, you should read
819 this chapter thoroughly, since it contains a lot of useful information
820 and commentary that can save you some time.
823 \begin_layout Standard
824 Hopefully, the development of \SpecialChar LyX
825 will never stop; so some of the documentation
826 may be incomplete or a bit out of date, though we try to keep up-to-date.
827 Like the rest of \SpecialChar LyX
828 , the manuals are the work of a group of volunteers who
830 \begin_inset Quotes eld
834 \begin_inset Quotes erd
837 , families, dishes to clean,
842 If you want to help out, be sure to read Section
847 \begin_inset CommandInset ref
849 reference "sec:Contrib"
853 in addition to the rest of this document.
856 \begin_layout Standard
857 Also, please do us a favor – if anything in these manuals confuses you,
858 is unclear, or wrong, don't hesitate to let us know! You can reach the
859 current document maintainers by emailing
860 \begin_inset CommandInset href
862 target "lyx-docs@lists.lyx.org"
869 If you have questions that are not obviously answered in the documentation,
870 and need help fast, there is an active users' mailing list which you can
872 \begin_inset CommandInset href
874 target "lyx-users@lists.lyx.org"
883 \begin_layout Subsection
884 The Format of the Manuals
887 \begin_layout Standard
888 Some of you may have printed out the manuals.
889 Others may be reading them within \SpecialChar LyX
891 There are some differences between the \SpecialChar LyX
892 -file and the printed version.
894 , the title is simply at the top of the document, not formatted on a
895 separate page as in some of the printed versions.
896 Nor are any of the footnotes or the Table of Contents fully visible.
897 To open a footnote, which looks like this:
898 \begin_inset Graphics
899 filename clipart/footnote.png
904 , click on it with the left mouse button.
905 For the Table of Contents, either click on the grey box or click on the
910 menu, where the contents are displayed automatically\SpecialChar endofsentence
914 \begin_layout Standard
915 In the printed manuals, all cross-references appear as the actual numbers
916 for a chapter, section, subsection, and so on.
917 In the \SpecialChar LyX
918 -file, however, all cross-references appear as light-grey boxes
920 \begin_inset Graphics
921 filename clipart/reference.png
927 If you click on such a box with the left mouse button, a dialog box will
928 appear containing a list of all the cross-references in the document.
929 You can go to the referenced section by right-clicking on the box or by
942 in the opened dialog.
943 Going back to where you came from is just as easy.
952 to go back to your earlier location.
955 \begin_layout Standard
956 Now that we've cleared up some of the differences between the printed and
958 -file versions of this file, we can start looking at the format of this
960 You'll occasionally notice things in different fonts:
963 \begin_layout Itemize
968 is used for general emphasis, generic arguments, book titles, names of
969 sections of other manuals, and notes from the authors.
972 \begin_layout Itemize
977 is used for program and file names, \SpecialChar LyX
981 \begin_layout Itemize
986 is used for menu, button, or dialog box names, and the names of keyboard
990 \begin_layout Itemize
995 is used for people's names.
998 \begin_layout Itemize
1003 is used for \SpecialChar LaTeX
1007 \begin_layout Standard
1008 When we do need to reference keys, we'll use the following prefixing convention:
1011 \begin_layout Itemize
1012 \begin_inset Quotes eld
1020 \begin_inset Quotes erd
1030 \begin_layout Itemize
1031 \begin_inset Quotes eld
1039 \begin_inset Quotes erd
1049 \begin_layout Itemize
1050 \begin_inset Quotes eld
1058 \begin_inset Quotes erd
1072 \begin_layout Itemize
1073 \begin_inset Quotes eld
1081 \begin_inset Quotes erd
1086 \begin_inset Quotes eld
1094 \begin_inset Quotes erd
1097 are the function keys.
1100 \begin_layout Itemize
1101 \begin_inset Quotes eld
1109 \begin_inset Quotes erd
1115 \begin_layout Itemize
1116 \begin_inset Quotes eld
1124 \begin_inset Quotes erd
1128 \begin_inset Quotes eld
1136 \begin_inset Quotes erd
1140 \begin_inset Quotes eld
1148 \begin_inset Quotes erd
1152 \begin_inset Quotes eld
1160 \begin_inset Quotes erd
1166 \begin_layout Itemize
1169 \begin_inset Quotes eld
1175 \begin_inset Quotes erd
1179 \begin_inset Quotes eld
1187 \begin_inset Quotes erd
1191 \begin_inset Quotes eld
1199 \begin_inset Quotes erd
1203 \begin_inset Quotes eld
1211 \begin_inset Quotes erd
1215 \begin_inset Quotes eld
1223 \begin_inset Quotes erd
1227 \begin_inset Quotes eld
1235 \begin_inset Quotes erd
1239 \begin_inset space ~
1242 keys that appear above the cursor keys on many PC keyboards.
1244 \begin_inset Quotes eld
1252 \begin_inset Quotes erd
1256 \begin_inset Quotes eld
1264 \begin_inset Quotes erd
1268 \begin_inset Quotes eld
1276 \begin_inset Quotes erd
1280 \begin_inset Quotes eld
1288 \begin_inset Quotes erd
1294 \begin_layout Itemize
1303 both refer to the same key.
1304 Some keyboards label the
1309 \begin_inset Quotes eld
1313 \begin_inset Quotes erd
1317 \begin_inset Quotes eld
1321 \begin_inset Quotes erd
1324 still others have two keys.
1326 treats all of them as the same key, so we'll use
1337 \begin_layout Standard
1338 The list with the currently set shortcuts can be found in the
1349 \begin_layout Subsection
1350 Units used in the Manuals
1353 \begin_layout Standard
1354 To understand the units described in this documentation, Table
1355 \begin_inset space ~
1359 \begin_inset CommandInset ref
1361 reference "tab:Units"
1365 explains all units available in \SpecialChar LyX
1369 \begin_layout Standard
1370 \begin_inset Float table
1375 \begin_layout Plain Layout
1376 \begin_inset Caption Standard
1378 \begin_layout Plain Layout
1379 \begin_inset CommandInset label
1393 \begin_layout Plain Layout
1394 \begin_inset VSpace medskip
1400 \begin_layout Plain Layout
1402 \begin_inset Tabular
1403 <lyxtabular version="3" rows="20" columns="2">
1404 <features booktabs="true" tabularvalignment="middle">
1405 <column alignment="center" valignment="top" width="0pt">
1406 <column alignment="center" valignment="top">
1408 <cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
1411 \begin_layout Plain Layout
1417 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1420 \begin_layout Plain Layout
1428 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1431 \begin_layout Plain Layout
1437 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1440 \begin_layout Plain Layout
1448 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1451 \begin_layout Plain Layout
1457 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1460 \begin_layout Plain Layout
1468 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1471 \begin_layout Plain Layout
1477 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1480 \begin_layout Plain Layout
1482 \begin_inset space \thinspace{}
1486 \begin_inset space \thinspace{}
1496 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1499 \begin_layout Plain Layout
1505 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1508 \begin_layout Plain Layout
1510 \begin_inset space \thinspace{}
1514 \begin_inset space \thinspace{}
1524 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1527 \begin_layout Plain Layout
1533 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1536 \begin_layout Plain Layout
1538 \begin_inset space \thinspace{}
1542 \begin_inset space \thinspace{}
1552 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1555 \begin_layout Plain Layout
1561 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1564 \begin_layout Plain Layout
1566 \begin_inset space \thinspace{}
1570 \begin_inset space \thinspace{}
1580 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1583 \begin_layout Plain Layout
1589 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1592 \begin_layout Plain Layout
1594 \begin_inset space \thinspace{}
1598 \begin_inset space \thinspace{}
1608 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1611 \begin_layout Plain Layout
1617 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1620 \begin_layout Plain Layout
1622 \begin_inset space \thinspace{}
1626 \begin_inset Formula $\approx$
1630 \begin_inset space \thinspace{}
1640 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1643 \begin_layout Plain Layout
1649 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1652 \begin_layout Plain Layout
1654 \begin_inset space \thinspace{}
1658 \begin_inset space \thinspace{}
1668 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1671 \begin_layout Plain Layout
1677 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1680 \begin_layout Plain Layout
1681 % of original image width
1688 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1691 \begin_layout Plain Layout
1697 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1700 \begin_layout Plain Layout
1708 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1711 \begin_layout Plain Layout
1717 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1720 \begin_layout Plain Layout
1728 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1731 \begin_layout Plain Layout
1737 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1740 \begin_layout Plain Layout
1748 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1751 \begin_layout Plain Layout
1757 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1760 \begin_layout Plain Layout
1768 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1771 \begin_layout Plain Layout
1777 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1780 \begin_layout Plain Layout
1788 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1791 \begin_layout Plain Layout
1797 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1800 \begin_layout Plain Layout
1808 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1811 \begin_layout Plain Layout
1817 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1820 \begin_layout Plain Layout
1832 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1835 \begin_layout Plain Layout
1841 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1844 \begin_layout Plain Layout
1856 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1859 \begin_layout Plain Layout
1865 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1868 \begin_layout Plain Layout
1870 \begin_inset space \thinspace{}
1874 \begin_inset space \thinspace{}
1895 \begin_layout Subsection
1899 \begin_layout Standard
1900 The following list describes the contents of the basic documentation files
1901 that you find in the
1908 \begin_layout Description
1909 Introduction This file.
1912 \begin_layout Description
1913 Tutorial If you are new to \SpecialChar LyX
1914 , and have never used \SpecialChar LaTeX
1915 before, you should start
1917 If you have used \SpecialChar LaTeX
1918 before, you should still read the
1922 , starting with the section on
1923 \begin_inset Quotes eld
1927 for \SpecialChar LaTeX
1929 \begin_inset Quotes erd
1932 (Skimming through the rest of the document wouldn't hurt, either.)
1935 \begin_layout Description
1937 \begin_inset space ~
1940 Guide The primary documentation.
1945 of the basic operation and available features of \SpecialChar LyX
1947 The main manual assumes that you have read the
1954 \begin_layout Description
1956 \begin_inset space ~
1959 Objects Extension of the
1964 Documents in detail how to use tables, graphics, floats, notes, program
1966 It also includes many tricks of the \SpecialChar LaTeX
1970 \begin_layout Description
1971 Math Extension of the
1976 Documents in detail how to typeset any kind of formula.
1979 \begin_layout Description
1981 \begin_inset space ~
1984 Features Extension of the
1989 Documents how to use raw \SpecialChar LaTeX
1990 commands, additional layouts and special-purpose
1994 \begin_layout Description
1995 Customization A description of advanced \SpecialChar LyX
1996 features, including how to customize
1997 the overall behavior of \SpecialChar LyX
1998 \SpecialChar endofsentence
1999 This includes such things as keybindings, internationa
2000 lization and configuration files.
2001 It also includes information about layout files, which are needed to get
2003 to support \SpecialChar LaTeX
2004 classes or packages.
2007 \begin_layout Description
2008 Shortcuts Tables of the currently defined \SpecialChar LyX
2012 \begin_layout Description
2015 \begin_inset space ~
2018 Configuration A report produced by \SpecialChar LyX
2020 This file contains information on what \SpecialChar LyX
2021 learned about your installation.
2022 Check it to see if you're missing something you might like to have.
2025 \begin_layout Standard
2026 These files will reference one another as necessary.
2035 information on installation and customization, but refers the reader to
2038 Customization Manual
2040 for more information.
2043 \begin_layout Standard
2044 We'll state again an important point:
2047 \begin_layout Standard
2048 \begin_inset VSpace bigskip
2054 \begin_layout Standard
2056 If you are new to \SpecialChar LyX
2062 Now\SpecialChar endofsentence
2066 \begin_layout Standard
2067 \begin_inset VSpace bigskip
2073 \begin_layout Standard
2074 Otherwise, you could needlessly frustrate yourself.
2077 \begin_layout Section
2078 Contributing to the \SpecialChar LyX
2080 \begin_inset CommandInset label
2089 \begin_layout Subsection
2090 Contributing to \SpecialChar LyX
2094 \begin_layout Standard
2096 is mostly written in C++ (the \SpecialChar LaTeX
2097 importer is written in Python).
2098 It is a large project, and as a result it is not free from bugs, or the
2099 need for improvements in the source code.
2102 \begin_layout Subsubsection
2106 \begin_layout Standard
2107 While using \SpecialChar LyX
2108 , you may find behavior which you consider a bug.
2109 Crashes, though rare, can happen.
2110 User interface problems are considered major bugs by the \SpecialChar LyX
2112 helpful are indications of parts of the \SpecialChar LyX
2113 interface you find confusing,
2117 \begin_layout Standard
2119 has a bug tracking system, which you can find at
2120 \begin_inset Newline newline
2124 \begin_inset CommandInset href
2126 target "https://www.lyx.org/trac/wiki/BugTrackerHome"
2131 You should check the bug tracker before reporting any bugs, in case it
2132 has already been reported.
2133 If you have a comment on an existing bug, or wish to report a new bug,
2134 you may either use the bug tracker, or send an e-mail to the development
2136 \begin_inset CommandInset href
2138 target "lyx-devel@lists.lyx.org"
2145 Archives of this list are linked from the main \SpecialChar LyX
2147 \begin_inset CommandInset href
2149 target "http://www.lyx.org"
2156 \begin_layout Standard
2157 A useful bug report will at a minimum include the version of \SpecialChar LyX
2160 Accurate, detailed descriptions are preferred — the more time developers
2161 have to spend to pinpoint the source of a bug, the less time they have
2162 for other improvements.
2163 Mention the system and system version on which you are running \SpecialChar LyX
2165 Give the versions of the libraries you have installed on your system, and,
2166 if relevant, the versions of external programs that \SpecialChar LyX
2168 If it's a compilation or configuration problem, include the file
2172 , and mention which compiler you are using.
2175 \begin_layout Subsubsection
2176 Contributing fixes and new features
2179 \begin_layout Standard
2180 If you have made changes to \SpecialChar LyX
2181 's source that you think should become part
2183 , send your changes as a diff file (in unified format) to the development
2184 list referenced above, along with a change log, and a description of what
2188 \begin_layout Subsection
2189 Contributing to the Documentation
2192 \begin_layout Standard
2194 's documentation is extensive; however \SpecialChar LyX
2195 is under constant development, and
2196 each new release adds new features.
2197 You may find some documentation needs improvement.
2198 This section describes what to do if you find an error, or have some suggestion
2199 s for improving the documentation.
2202 \begin_layout Subsubsection
2203 Reporting Errors in the Manuals
2206 \begin_layout Standard
2207 If you find a problem with the documentation, send a message to the mailing
2209 \begin_inset CommandInset href
2211 target "lyx-docs@lists.lyx.org"
2218 The documentation team will make any necessary fixes.
2221 \begin_layout Subsubsection
2222 Joining the Documentation Team.
2225 \begin_layout Standard
2226 The \SpecialChar LyX
2227 Documentation Project, like anything else in the \SpecialChar LyX
2229 use assistance! If you're interested in contributing to the Documentation
2230 Project, you need to do the following:
2233 \begin_layout Enumerate
2234 Get the latest \SpecialChar LyX
2236 \begin_inset Newline newline
2240 \begin_inset CommandInset href
2242 target "https://www.lyx.org/trac/browser/lyxgit/lib/doc?rev=master "
2249 \begin_layout Enumerate
2259 \begin_inset Newline newline
2262 The point of this exercise is to give you ideas.
2271 are likely to be the most up-to-date of all of the documentation.
2272 You should be able to glean some insights into how we want the manuals
2273 to read and to look.
2276 \begin_layout Enumerate
2277 Contact the team at:
2278 \begin_inset Newline newline
2282 \begin_inset CommandInset href
2284 target "lyx-docs@lists.lyx.org"
2291 \begin_inset Newline newline
2294 to discuss your intended changes and to get some feedback on them.
2297 \begin_layout Standard
2298 The changes you wish to make may range from improving clarity of the text,
2299 to doing major re-structuring of the documentation.
2300 Any and all improvements are gladly received.