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 \docbook_mathml_prefix 1
118 \author -584632292 "Richard Kimberly Heck"
124 Introduction to \SpecialChar LyX
129 by the \SpecialChar LyX
134 \begin_layout Plain Layout
136 If you have comments on or corrections to this documentation,
137 please send them to the \SpecialChar LyX
138 Documentation mailing list:
140 \begin_inset CommandInset href
142 target "lyx-docs@lists.lyx.org"
156 \begin_layout Standard
157 \begin_inset CommandInset toc
158 LatexCommand tableofcontents
165 \begin_layout Section
166 The Philosophy of \SpecialChar LyX
170 \begin_layout Subsection
171 What is \SpecialChar LyX
175 \begin_layout Standard
177 is a document preparation system.
178 It excels at letting you create complex technical and scientific articles with mathematics,
183 It is very good for working with documents of any length in which the usual processing abilities are required:
184 automatic sectioning and pagination,
185 spell checking and so forth.
186 It can also be used to write a letter to your mom,
188 there are probably simpler programs available for that.
189 It is definitely not the best tool for creating banners,
191 or advertisements (we'll explain why later),
192 though with some effort all these can be done,
194 Here are some examples of what it is used for:
197 dissertations and theses,
200 conference proceedings,
201 software documentation,
203 articles in refereed scientific journals,
204 scripts for plays and movies,
206 presentations \SpecialChar ldots
210 \begin_layout Standard
212 is a program that provides a modern approach to writing documents with a computer by using a markup language paradigm,
213 an approach that breaks with the obsolete tradition of the
214 \begin_inset Quotes eld
218 \begin_inset Quotes erd
222 It is designed for authors who want professional output quickly with a minimum of effort and without becoming specialists in typesetting.
223 The job of typesetting is done mostly by the computer,
225 with \SpecialChar LyX
227 the author can concentrate on the contents of his writing.
230 \begin_layout Standard
231 Part of the initial challenge of using \SpecialChar LyX
232 comes from the change in thinking that you,
236 all we had for creating documents were typewriters,
237 so we all learned certain tricks to get around their limitations.
239 which is little more than overstriking with the
240 \begin_inset Quotes eld
244 \begin_inset Quotes erd
248 became a way to emphasize text.
249 You were forced to figure out column sizes and tab stops,
251 before creating a table.
252 The same applied for letters and other right justified text.
253 Hyphenation at the end of a line required a careful eye and a lot of foresight.
256 \begin_layout Standard
258 we've all been trained to worry about the little details of which character goes where.
260 almost all word processors have this mentality.
261 They still use tab stops for adding whitespace.
262 You still need to worry about exactly where on the page something will appear.
263 Emphasizing text means changing a font,
264 similar to changing the typewriter wheel.
265 This is the underlying philosophy of a WYSIWYG word processor:
267 \begin_inset Quotes eld
270 What You See Is What You Get
271 \begin_inset Quotes erd
276 that paradigm often results in
277 \begin_inset Quotes eld
280 What You See Is All You Get
281 \begin_inset Quotes erd
287 \begin_layout Standard
288 This is where \SpecialChar LyX
289 differs from an ordinary word processor.
290 You don't concern yourself with what character goes where.
291 You tell \SpecialChar LyX
297 takes care of the rest,
298 following a set of rules called a
306 \begin_layout Plain Layout
308 most recent versions of the most popular office suites now have some sort of style sheets which follow a similar markup method.
310 our experience is that they are still rarely used in practice.
315 Let's look at a little example:
318 \begin_layout Standard
319 Suppose you are writing a report.
320 To begin your report,
321 you want a section called
322 \begin_inset Quotes eld
325 Introduction\SpecialChar endofsentence
327 \begin_inset Quotes erd
331 you go into whatever menu it is in your word processor that changes font sizes and decide on a new font size.
332 Then you turn on bold face.
335 \begin_inset Quotes eld
347 \begin_inset Quotes erd
352 if you later decide that this section belongs someplace else in the document or if you insert a new section before it,
353 you need to change the numbering for this and all following sections,
354 as well as any entry in the table of contents.
357 \begin_layout Standard
360 you go to the pull-down on the far left of the button bar and select
366 \begin_inset Quotes eld
370 \begin_inset Quotes erd
376 \begin_layout Standard
379 If you cut and paste the section,
380 it will automatically be renumbered —
382 And if you enter references to that section correctly (by inserting cross-reference tags),
384 will automatically update them all throughout the file so that you never,
385 ever type a section number.
388 \begin_layout Standard
389 Now let's look at the problem of consistency.
391 you reopen your report and start Section
397 you forget that you were using 18
398 \begin_inset space \thinspace{}
401 pt bold instead of 16
402 \begin_inset space \thinspace{}
406 so you type in the heading for Section
410 4 in a different font from the one you used for Section
415 That problem doesn't even exist in \SpecialChar LyX
417 The computer takes care of all that silly bookkeeping about which thing has what size font,
420 that's what a computer is good at.
423 \begin_layout Standard
424 Here's another example.
425 Suppose you're making a list.
426 In other word processors,
427 a list is just a bunch of tab stops and newlines.
428 You need to figure out where to put the label for each list item,
429 what that label should be,
430 how many blank lines to put between each item,
432 Under \SpecialChar LyX
434 you have only two concerns:
435 what kind of list is this,
436 and what do I want to put in it?
440 \begin_layout Standard
442 the basic idea behind \SpecialChar LyX
455 \begin_inset Quotes eld
458 What You See Is What You Get,
459 \begin_inset Quotes erd
464 \begin_inset Quotes eld
467 What You See Is What You
472 \begin_inset Quotes erd
476 \begin_inset Quotes eld
480 \begin_inset Quotes erd
483 It's a powerful idea that greatly simplifies the mechanics of writing documents.
484 This is also why \SpecialChar LyX
485 isn't so good for creating posters and flyers.
491 want to specify exactly where everything goes,
492 because there are no functional units like paragraphs,
495 This doesn't mean \SpecialChar LyX
496 is missing some cool function.
497 It simply means that it isn't the right tool for the job —
498 you don't use a screwdriver to drive in nails.
501 \begin_layout Subsection
502 Differences between \SpecialChar LyX
503 and Other Word Processors
506 \begin_layout Standard
507 Here's a list of things you won't find in \SpecialChar LyX
511 \begin_layout Itemize
515 \begin_layout Itemize
519 \begin_layout Itemize
521 \begin_inset space \thinspace{}
525 \begin_inset space \space{}
539 \begin_layout Standard
541 along with a ruler showing you the position of things on the page,
542 are useless in \SpecialChar LyX
544 The program worries about where things go on the page,
546 Extra whitespace is similar;
548 adds it where necessary,
549 depending on context.
550 Not being able to type two blank lines in a row will be annoying at first,
551 but it makes more sense once you're thinking in WYSIWYM terms.
554 \begin_layout Standard
555 Here are some things that exist in \SpecialChar LyX
557 but aren't used as you might think:
560 \begin_layout Itemize
564 \begin_layout Itemize
568 \begin_layout Itemize
570 \begin_inset space \thinspace{}
574 \begin_inset space \space{}
582 \begin_layout Itemize
584 horizontal and vertical
587 \begin_layout Itemize
591 \begin_layout Itemize
598 \begin_layout Standard
599 Although they exist in \SpecialChar LyX
601 you generally don't need them.
603 will take care of these things for you,
604 depending on what you're doing.
605 Different parts of the document are automatically set in a different typeface and font size.
606 Paragraph indenting is context dependent;
607 different types of paragraphs get indented differently.
608 Page breaks get handled automatically,
611 the space between lines,
613 and between paragraphs is variable,
614 set by \SpecialChar LyX
619 \begin_layout Plain Layout
620 There are ways to adjust all of these (only some of which require knowledge of \SpecialChar LaTeX
622 either for a whole document or for a specific location in a document.
639 \begin_layout Standard
641 there are a few areas where we believe \SpecialChar LyX
642 (and \SpecialChar LaTeX
643 ) surpasses many word processors:
646 \begin_layout Itemize
650 \begin_layout Itemize
654 \begin_layout Itemize
658 \begin_layout Itemize
662 \begin_layout Itemize
666 \begin_layout Standard
668 many modern word processors can handle mathematical symbols,
671 and many have moved towards style definitions and the WYSIWYM concept.
673 they've only recently been able to do so,
674 whereas \SpecialChar LyX
675 is built upon the \SpecialChar LaTeX
676 document preparation system.
678 has been around since 1985,
686 \begin_layout Subsection
687 What is \SpecialChar LaTeX
691 \begin_layout Standard
693 is a document preparation system designed by Leslie Lamport in 1985.
697 \begin_layout Plain Layout
698 The source for the info in this section is
700 A Guide to \SpecialChar LaTeX2e
704 by Helmut Kopka and Patrick Daly,
705 which has an entry in the bibliography of the
709 \SpecialChar endofsentence
715 It was built up from a typesetting language called \SpecialChar TeX
717 created by Donald Knuth in 1984.
719 takes a sequence of typesetting commands,
720 written in a script in an ASCII file,
723 \begin_inset Quotes eld
727 \begin_inset Quotes erd
730 of the printing trade were modeled by Knuth as computer algorithms and incorporated into \SpecialChar TeX
732 hence its excellent printed appearance.
733 What comes directly out of \SpecialChar TeX
734 is the portable document format
739 \begin_inset Quotes eld
743 \begin_inset Quotes erd
751 The dvi format is often used for previews and can later be converted to other formats like PostScript.
755 \begin_layout Standard
757 isn't only a typesetting engine;
758 it also allows you to define macros.
759 Most people who use \SpecialChar TeX
760 are actually using a macro package which Knuth created to hide a lot of the typesetting details.
761 This is where Leslie Lamport enters our story.
762 He wanted a macro package that was more user- and less typesetter-oriented,
763 with a set of commands that consistently typeset things like sections,
764 tables or math formulas in a uniform,
766 This is how \SpecialChar LaTeX
770 \begin_layout Standard
772 in parallel with the development and growth of \SpecialChar LaTeX
774 other folks were creating their own custom macro packages for \SpecialChar TeX
776 ones to make slides or articles for math journals and so on.
777 Some used the raw \SpecialChar TeX
778 facilities to do this,
779 others began modifying \SpecialChar LaTeX
781 To try and unify this mess,
782 a team of \SpecialChar LaTeX
783 -nicians began to work on \SpecialChar LaTeX2e
785 the current version of \SpecialChar LaTeX
787 during the late 1980's.
788 This new version of \SpecialChar LaTeX
789 has commands which provide an easier-to-use interface to \SpecialChar TeX
790 's macro-creating commands,
791 aid in the use of new fonts,
795 is quite an extensive language in its own right!
796 Users around the world have been creating their own add-ons for \SpecialChar LaTeX
797 beyond the standard ones.
800 \begin_layout Standard
801 There are two ways to extend \SpecialChar LaTeX
808 is a set of \SpecialChar LaTeX
809 macros describing a new type of document,
812 There are classes for slides,
813 for physics and math journals\SpecialChar ldots
814 many universities even have a class for their thesis format.
819 differs from a class in that it doesn't define a new type of document,
820 but a different type of
824 that any document can use.
827 controls page margins and line spacing using two different \SpecialChar LaTeX
828 style-files designed for these purposes.
829 There are style-files for a whole slew of things:
830 printing labels or envelopes,
831 changing indentation behavior,
833 manipulating graphics,
834 designing fancy page headings,
835 customizing bibliographies,
836 altering the location and appearance of footnotes,
843 \begin_layout Standard
847 \begin_layout Description
850 Typesetting language with macro capability.
853 \begin_layout Description
856 Macro package built upon \SpecialChar TeX
857 \SpecialChar endofsentence
861 \begin_layout Description
863 Descriptions of types of document used with \SpecialChar LaTeX
864 \SpecialChar endofsentence
868 \begin_layout Description
870 Descriptions of the default behavior of particular elements of \SpecialChar LaTeX
874 \begin_layout Description
878 WYSIWYM document processor that uses \SpecialChar LaTeX
879 to do its typesetting.
882 \begin_layout Standard
883 This section attempts to explain the difference between \SpecialChar LyX
884 and a word processor.
888 By using \SpecialChar LaTeX
891 helps you to think more about
900 The computer then handles
907 \begin_layout Section
908 Navigating the Documentation
911 \begin_layout Standard
912 To make it easier to answer your questions and describe all of the features of \SpecialChar LyX
914 the documentation has been split up into several different files.
915 Each one has its own purpose,
917 Before you go ploughing into any of those files,
919 you should read this chapter thoroughly,
920 since it contains a lot of useful information and commentary that can save you some time.
923 \begin_layout Standard
925 the development of \SpecialChar LyX
927 so some of the documentation may be incomplete or a bit out of date,
928 though we try to keep up-to-date.
929 Like the rest of \SpecialChar LyX
931 the manuals are the work of a group of volunteers who have
932 \begin_inset Quotes eld
936 \begin_inset Quotes erd
947 If you want to help out,
948 be sure to read Section
953 \begin_inset CommandInset ref
955 reference "sec:Contrib"
960 in addition to the rest of this document.
963 \begin_layout Standard
965 please do us a favor:
966 if anything in these manuals confuses you,
969 don't hesitate to let us know!
970 You can reach the current document maintainers by emailing
971 \begin_inset CommandInset href
973 target "lyx-docs@lists.lyx.org"
981 \change_inserted -584632292 1610248366
985 \begin_layout Subsection
987 \change_inserted -584632292 1610248375
991 \begin_layout Standard
992 If you have questions that are not obviously answered in the documentation and need help fast,
993 there is an active users' mailing list which you can reach at
994 \begin_inset CommandInset href
996 target "lyx-users@lists.lyx.org"
1004 \change_inserted -584632292 1610248524
1005 You do not have to register to post,
1006 but you may wish to do so.
1008 \begin_inset CommandInset href
1010 name "the LyX website"
1011 target "https://www.lyx.org/MailingLists"
1016 for further information.
1018 \begin_inset CommandInset href
1020 target "http://wiki.lyx.org/"
1025 that will answer many questions about how to get LyX to do various things.
1030 \begin_layout Subsection
1031 The Format of the Manuals
1034 \begin_layout Standard
1035 Some of you may have printed out the manuals.
1036 Others may be reading them within \SpecialChar LyX
1038 There are some differences between the \SpecialChar LyX
1039 -file and the printed version.
1042 the title is simply at the top of the document,
1043 not formatted on a separate page as in some of the printed versions.
1044 Nor are any of the footnotes or the Table of Contents fully visible.
1046 which looks like this:
1048 \begin_inset Graphics
1049 filename clipart/footnote.png
1055 click on it with the left mouse button.
1056 For the Table of Contents,
1057 either click on the grey box or click on the
1062 where the contents are displayed automatically\SpecialChar endofsentence
1066 \begin_layout Standard
1067 In the printed manuals,
1068 all cross-references appear as the actual numbers for a chapter,
1072 In the \SpecialChar LyX
1075 all cross-references appear as light-grey boxes like the following:
1077 \begin_inset Graphics
1078 filename clipart/reference.png
1084 If you click on such a box with the left mouse button,
1085 a dialog box will appear containing a list of all the cross-references in the document.
1086 You can go to the referenced section by right-clicking on the box or by clicking the button
1089 \begin_inset space ~
1093 \begin_inset space ~
1098 in the opened dialog.
1099 Going back to where you came from is just as easy.
1103 \begin_inset space ~
1108 to go back to your earlier location.
1111 \begin_layout Standard
1112 Now that we've cleared up some of the differences between the printed and \SpecialChar LyX
1113 -file versions of this file,
1114 we can start looking at the format of this document.
1115 You'll occasionally notice things in different fonts:
1118 \begin_layout Itemize
1123 is used for general emphasis,
1126 names of sections of other manuals,
1127 and notes from the authors.
1130 \begin_layout Itemize
1135 is used for program and file names,
1140 \begin_layout Itemize
1147 or dialog box names,
1148 and the names of keyboard keys.
1151 \begin_layout Itemize
1156 is used for people's names.
1159 \begin_layout Itemize
1164 is used for \SpecialChar LaTeX
1168 \begin_layout Standard
1169 When we do need to reference keys,
1170 we'll use the following prefixing convention:
1173 \begin_layout Itemize
1174 \begin_inset Quotes eld
1182 \begin_inset Quotes erd
1192 \begin_layout Itemize
1193 \begin_inset Quotes eld
1201 \begin_inset Quotes erd
1211 \begin_layout Itemize
1212 \begin_inset Quotes eld
1220 \begin_inset Quotes erd
1234 \begin_layout Itemize
1235 \begin_inset Quotes eld
1243 \begin_inset Quotes erd
1248 \begin_inset Quotes eld
1256 \begin_inset Quotes erd
1259 are the function keys.
1262 \begin_layout Itemize
1263 \begin_inset Quotes eld
1271 \begin_inset Quotes erd
1277 \begin_layout Itemize
1278 \begin_inset Quotes eld
1286 \begin_inset Quotes erd
1290 \begin_inset Quotes eld
1298 \begin_inset Quotes erd
1302 \begin_inset Quotes eld
1310 \begin_inset Quotes erd
1314 \begin_inset Quotes eld
1322 \begin_inset Quotes erd
1329 \begin_layout Itemize
1332 \begin_inset Quotes eld
1338 \begin_inset Quotes erd
1342 \begin_inset Quotes eld
1350 \begin_inset Quotes erd
1354 \begin_inset Quotes eld
1362 \begin_inset Quotes erd
1366 \begin_inset Quotes eld
1374 \begin_inset Quotes erd
1378 \begin_inset Quotes eld
1386 \begin_inset Quotes erd
1390 \begin_inset Quotes eld
1398 \begin_inset Quotes erd
1403 \begin_inset space ~
1406 keys that appear above the cursor keys on many PC keyboards.
1408 \begin_inset Quotes eld
1416 \begin_inset Quotes erd
1420 \begin_inset Quotes eld
1428 \begin_inset Quotes erd
1432 \begin_inset Quotes eld
1440 \begin_inset Quotes erd
1444 \begin_inset Quotes eld
1452 \begin_inset Quotes erd
1458 \begin_layout Itemize
1467 both refer to the same key.
1468 Some keyboards label the
1473 \begin_inset Quotes eld
1477 \begin_inset Quotes erd
1481 \begin_inset Quotes eld
1485 \begin_inset Quotes erd
1488 still others have two keys.
1490 treats all of them as the same key,
1502 \begin_layout Standard
1503 The list with the currently set shortcuts can be found in the
1514 \begin_layout Subsection
1515 Units used in the Manuals
1518 \begin_layout Standard
1519 To understand the units described in this documentation,
1521 \begin_inset space ~
1525 \begin_inset CommandInset ref
1527 reference "tab:Units"
1532 explains all units available in \SpecialChar LyX
1536 \begin_layout Standard
1537 \begin_inset Float table
1544 \begin_layout Plain Layout
1545 \begin_inset Caption Standard
1547 \begin_layout Plain Layout
1548 \begin_inset CommandInset label
1562 \begin_layout Plain Layout
1563 \begin_inset VSpace medskip
1569 \begin_layout Plain Layout
1571 \begin_inset Tabular
1572 <lyxtabular version="3" rows="20" columns="2">
1573 <features booktabs="true" tabularvalignment="middle">
1574 <column alignment="center" valignment="top" width="0pt">
1575 <column alignment="center" valignment="top">
1577 <cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
1580 \begin_layout Plain Layout
1586 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1589 \begin_layout Plain Layout
1597 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1600 \begin_layout Plain Layout
1606 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1609 \begin_layout Plain Layout
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
1637 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1640 \begin_layout Plain Layout
1646 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1649 \begin_layout Plain Layout
1651 \begin_inset space \thinspace{}
1655 \begin_inset space \thinspace{}
1665 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1668 \begin_layout Plain Layout
1674 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1677 \begin_layout Plain Layout
1679 \begin_inset space \thinspace{}
1683 \begin_inset space \thinspace{}
1693 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1696 \begin_layout Plain Layout
1702 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1705 \begin_layout Plain Layout
1707 \begin_inset space \thinspace{}
1711 \begin_inset space \thinspace{}
1721 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1724 \begin_layout Plain Layout
1730 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1733 \begin_layout Plain Layout
1735 \begin_inset space \thinspace{}
1739 \begin_inset space \thinspace{}
1749 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1752 \begin_layout Plain Layout
1758 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1761 \begin_layout Plain Layout
1763 \begin_inset space \thinspace{}
1767 \begin_inset space \thinspace{}
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
1791 \begin_inset space \thinspace{}
1795 \begin_inset Formula $\approx$
1799 \begin_inset space \thinspace{}
1809 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1812 \begin_layout Plain Layout
1818 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1821 \begin_layout Plain Layout
1823 \begin_inset space \thinspace{}
1827 \begin_inset space \thinspace{}
1837 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1840 \begin_layout Plain Layout
1846 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1849 \begin_layout Plain Layout
1850 % of original image width
1857 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1860 \begin_layout Plain Layout
1866 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1869 \begin_layout Plain Layout
1877 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1880 \begin_layout Plain Layout
1886 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1889 \begin_layout Plain Layout
1897 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1900 \begin_layout Plain Layout
1906 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1909 \begin_layout Plain Layout
1917 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1920 \begin_layout Plain Layout
1926 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1929 \begin_layout Plain Layout
1937 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1940 \begin_layout Plain Layout
1946 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1949 \begin_layout Plain Layout
1957 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1960 \begin_layout Plain Layout
1966 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1969 \begin_layout Plain Layout
1977 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1980 \begin_layout Plain Layout
1986 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1989 \begin_layout Plain Layout
2001 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2004 \begin_layout Plain Layout
2010 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2013 \begin_layout Plain Layout
2025 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2028 \begin_layout Plain Layout
2034 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
2037 \begin_layout Plain Layout
2039 \begin_inset space \thinspace{}
2043 \begin_inset space \thinspace{}
2064 \begin_layout Subsection
2068 \begin_layout Standard
2069 The following list describes the contents of the basic documentation files that you find in the
2076 \begin_layout Description
2077 Introduction This file.
2080 \begin_layout Description
2081 Tutorial If you are new to \SpecialChar LyX
2083 and have never used \SpecialChar LaTeX
2085 you should start here.
2086 If you have used \SpecialChar LaTeX
2088 you should still read the
2093 starting with the section on
2094 \begin_inset Quotes eld
2098 for \SpecialChar LaTeX
2100 \begin_inset Quotes erd
2103 (Skimming through the rest of the document wouldn't hurt,
2107 \begin_layout Description
2109 \begin_inset space ~
2112 Guide The primary documentation.
2117 of the basic operation and available features of \SpecialChar LyX
2119 The main manual assumes that you have read the
2126 \begin_layout Description
2128 \begin_inset space ~
2131 Objects Extension of the
2136 Documents in detail how to use tables,
2140 program listings and boxes.
2141 It also includes many tricks of the \SpecialChar LaTeX
2145 \begin_layout Description
2146 Math Extension of the
2151 Documents in detail how to typeset any kind of formula.
2154 \begin_layout Description
2156 \begin_inset space ~
2159 Features Extension of the
2164 Documents how to use raw \SpecialChar LaTeX
2166 additional layouts and special-purpose editing features.
2169 \begin_layout Description
2170 Customization A description of advanced \SpecialChar LyX
2172 including how to customize the overall behavior of \SpecialChar LyX
2173 \SpecialChar endofsentence
2174 This includes such things as keybindings,
2175 internationalization and configuration files.
2176 It also includes information about layout files,
2177 which are needed to get \SpecialChar LyX
2178 to support \SpecialChar LaTeX
2179 classes or packages.
2182 \begin_layout Description
2183 Shortcuts Tables of the currently defined \SpecialChar LyX
2187 \begin_layout Description
2190 \begin_inset space ~
2193 Configuration A report produced by \SpecialChar LyX
2195 This file contains information on what \SpecialChar LyX
2196 learned about your installation.
2197 Check it to see if you're missing something you might like to have.
2200 \begin_layout Standard
2201 These files will reference one another as necessary.
2211 information on installation and customization,
2212 but refers the reader to the
2214 Customization Manual
2216 for more information.
2219 \begin_layout Standard
2220 We'll state again an important point:
2223 \begin_layout Standard
2224 \begin_inset VSpace bigskip
2230 \begin_layout Standard
2232 If you are new to \SpecialChar LyX
2239 Now\SpecialChar endofsentence
2243 \begin_layout Standard
2244 \begin_inset VSpace bigskip
2250 \begin_layout Standard
2252 you could needlessly frustrate yourself.
2255 \begin_layout Section
2256 Contributing to the \SpecialChar LyX
2258 \begin_inset CommandInset label
2267 \begin_layout Subsection
2268 Contributing to \SpecialChar LyX
2272 \begin_layout Standard
2274 is mostly written in C++ (the \SpecialChar LaTeX
2275 importer is written in Python).
2276 It is a large project,
2277 and as a result it is not free from bugs,
2278 or the need for improvements in the source code.
2281 \begin_layout Subsubsection
2285 \begin_layout Standard
2286 While using \SpecialChar LyX
2288 you may find behavior which you consider a bug.
2292 User interface problems are considered major bugs by the \SpecialChar LyX
2294 especially helpful are indications of parts of the \SpecialChar LyX
2295 interface you find confusing,
2299 \begin_layout Standard
2301 has a bug tracking system,
2302 which you can find at
2303 \begin_inset Newline newline
2307 \begin_inset CommandInset href
2309 target "https://www.lyx.org/trac/wiki/BugTrackerHome"
2314 You should check the bug tracker before reporting any bugs,
2315 in case it has already been reported.
2316 If you have a comment on an existing bug,
2317 or wish to report a new bug,
2318 you may either use the bug tracker,
2319 or send an e-mail to the development mailing list,
2321 \begin_inset CommandInset href
2323 target "lyx-devel@lists.lyx.org"
2330 Archives of this list are linked from the main \SpecialChar LyX
2333 \begin_inset CommandInset href
2335 target "http://www.lyx.org"
2342 \begin_layout Standard
2343 A useful bug report will at a minimum include the version of \SpecialChar LyX
2344 you are having the problem with.
2346 detailed descriptions are preferred —
2347 the more time developers have to spend to pinpoint the source of a bug,
2348 the less time they have for other improvements.
2349 Mention the system and system version on which you are running \SpecialChar LyX
2351 Give the versions of the libraries you have installed on your system,
2354 the versions of external programs that \SpecialChar LyX
2356 If it's a compilation or configuration problem,
2362 and mention which compiler you are using.
2365 \begin_layout Subsubsection
2366 Contributing fixes and new features
2369 \begin_layout Standard
2370 If you have made changes to \SpecialChar LyX
2371 's source that you think should become part of \SpecialChar LyX
2373 send your changes as a diff file (in unified format) to the development list referenced above,
2374 along with a change log,
2375 and a description of what your patch does.
2378 \begin_layout Subsection
2379 Contributing to the Documentation
2382 \begin_layout Standard
2384 's documentation is extensive;
2385 however \SpecialChar LyX
2386 is under constant development,
2387 and each new release adds new features.
2388 You may find some documentation needs improvement.
2389 This section describes what to do if you find an error,
2390 or have some suggestions for improving the documentation.
2393 \begin_layout Subsubsection
2394 Reporting Errors in the Manuals
2397 \begin_layout Standard
2398 If you find a problem with the documentation,
2399 send a message to the mailing list
2400 \begin_inset CommandInset href
2402 target "lyx-docs@lists.lyx.org"
2409 The documentation team will make any necessary fixes.
2412 \begin_layout Subsubsection
2413 Joining the Documentation Team.
2416 \begin_layout Standard
2417 The \SpecialChar LyX
2418 Documentation Project,
2419 like anything else in the \SpecialChar LyX
2421 can always use assistance!
2422 If you're interested in contributing to the Documentation Project,
2423 you need to do the following:
2426 \begin_layout Enumerate
2427 Get the latest \SpecialChar LyX
2429 \begin_inset Newline newline
2433 \begin_inset CommandInset href
2435 target "https://www.lyx.org/trac/browser/lyxgit/lib/doc?rev=master "
2442 \begin_layout Enumerate
2453 \begin_inset Newline newline
2456 The point of this exercise is to give you ideas.
2465 are likely to be the most up-to-date of all of the documentation.
2466 You should be able to glean some insights into how we want the manuals to read and to look.
2469 \begin_layout Enumerate
2470 Contact the team at:
2471 \begin_inset Newline newline
2475 \begin_inset CommandInset href
2477 target "lyx-docs@lists.lyx.org"
2484 \begin_inset Newline newline
2487 to discuss your intended changes and to get some feedback on them.
2490 \begin_layout Standard
2491 The changes you wish to make may range from improving clarity of the text,
2492 to doing major re-structuring of the documentation.
2493 Any and all improvements are gladly received.