1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
5 \save_transient_properties true
9 % DO NOT ALTER THIS PREAMBLE!!!
11 %This preamble is designed to ensure that the document prints
12 % out as advertised. If you mess with this preamble,
13 % parts of the document may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC is numbered roman
19 % and a pdf-bookmark for the TOC is added
21 \let\myTOC\tableofcontents
22 \renewcommand\tableofcontents{%
23 \pdfbookmark[1]{\contentsname}{}
26 \pagenumbering{arabic} }
28 \use_default_options false
29 \maintain_unincluded_children no
31 \language_package default
34 \font_roman "palatino" "default"
35 \font_sans "helvet" "default"
36 \font_typewriter "courier" "default"
37 \font_math "auto" "auto"
38 \font_default_family default
39 \use_non_tex_fonts false
43 \font_typewriter_osf false
44 \font_sf_scale 100 100
45 \font_tt_scale 100 100
47 \use_dash_ligatures false
49 \default_output_format pdf2
51 \bibtex_command default
52 \index_command default
56 \pdf_title "Introduction to LyX"
57 \pdf_author "LyX Team"
58 \pdf_subject "LyX-documentation Intro"
59 \pdf_keywords "LyX, documentation"
61 \pdf_bookmarksnumbered true
62 \pdf_bookmarksopen true
63 \pdf_bookmarksopenlevel 2
68 \pdf_pdfusetitle false
69 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
72 \use_package amsmath 1
73 \use_package amssymb 1
76 \use_package mathdots 1
77 \use_package mathtools 1
79 \use_package stackrel 1
80 \use_package stmaryrd 1
81 \use_package undertilde 1
83 \cite_engine_type default
87 \paperorientation portrait
99 \paragraph_separation indent
100 \paragraph_indentation default
102 \math_numbering_side default
103 \quotes_style english
107 \paperpagestyle default
109 \tracking_changes true
112 \postpone_fragile_content false
115 \html_be_strict false
116 \docbook_table_output 0
117 \docbook_mathml_prefix 1
118 \author 1660427103 "Document Comparison"
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 \change_deleted 1660427103 1670920569
214 is a program that provides a modern approach to writing documents with a computer by using a markup language paradigm,
215 an approach that breaks with the obsolete tradition of the
216 \begin_inset Quotes eld
220 \begin_inset Quotes erd
224 It is designed for authors who want professional output quickly with a minimum of effort and without becoming specialists in typesetting.
225 The job of typesetting is done mostly by the computer,
227 with \SpecialChar LyX
229 the author can concentrate on the contents of his writing.
232 \begin_layout Standard
233 Part of the initial challenge of using \SpecialChar LyX
234 comes from the change in thinking that you,
238 all we had for creating documents were typewriters,
239 so we all learned certain tricks to get around their limitations.
241 which is little more than overstriking with the
242 \begin_inset Quotes eld
246 \begin_inset Quotes erd
250 became a way to emphasize text.
251 You were forced to figure out column sizes and tab stops,
253 before creating a table.
254 The same applied for letters and other right justified text.
255 Hyphenation at the end of a line required a careful eye and a lot of foresight.
258 \begin_layout Standard
260 we've all been trained to worry about the little details of which character goes where.
262 almost all word processors have this mentality.
263 They still use tab stops for adding whitespace.
264 You still need to worry about exactly where on the page something will appear.
265 Emphasizing text means changing a font,
266 similar to changing the typewriter wheel.
267 This is the underlying philosophy of a WYSIWYG word processor:
269 \begin_inset Quotes eld
272 What You See Is What You Get
273 \begin_inset Quotes erd
278 that paradigm often results in
279 \begin_inset Quotes eld
282 What You See Is All You Get
283 \begin_inset Quotes erd
289 \begin_layout Standard
290 This is where \SpecialChar LyX
291 differs from an ordinary word processor.
292 You don't concern yourself with what character goes where.
293 You tell \SpecialChar LyX
299 takes care of the rest,
300 following a set of rules called a
305 \change_deleted 1660427103 1670920570
310 \begin_layout Plain Layout
312 most recent versions of the most popular office suites now have some sort of style sheets which follow a similar markup method.
314 our experience is that they are still rarely used in practice.
321 Let's look at a little example:
324 \begin_layout Standard
325 Suppose you are writing a report.
326 To begin your report,
327 you want a section called
328 \begin_inset Quotes eld
331 Introduction\SpecialChar endofsentence
333 \begin_inset Quotes erd
337 you go into whatever menu it is in your word processor that changes font sizes and decide on a new font size.
338 Then you turn on bold face.
341 \begin_inset Quotes eld
353 \begin_inset Quotes erd
358 if you later decide that this section belongs someplace else in the document or if you insert a new section before it,
359 you need to change the numbering for this and all following sections,
360 as well as any entry in the table of contents.
363 \begin_layout Standard
366 you go to the pull-down on the far left of the button bar and select
372 \begin_inset Quotes eld
376 \begin_inset Quotes erd
382 \begin_layout Standard
385 If you cut and paste the section,
386 it will automatically be renumbered —
388 And if you enter references to that section correctly (by inserting cross-reference tags),
390 will automatically update them all throughout the file so that you never,
391 ever type a section number.
394 \begin_layout Standard
395 Now let's look at the problem of consistency.
397 you reopen your report and start Section
403 you forget that you were using 18
404 \begin_inset space \thinspace{}
407 pt bold instead of 16
408 \begin_inset space \thinspace{}
412 so you type in the heading for Section
416 4 in a different font from the one you used for Section
421 That problem doesn't even exist in \SpecialChar LyX
423 The computer takes care of all that silly bookkeeping about which thing has what size font,
426 that's what a computer is good at.
429 \begin_layout Standard
430 Here's another example.
431 Suppose you're making a list.
432 In other word processors,
433 a list is just a bunch of tab stops and newlines.
434 You need to figure out where to put the label for each list item,
435 what that label should be,
436 how many blank lines to put between each item,
438 Under \SpecialChar LyX
440 you have only two concerns:
441 what kind of list is this,
442 and what do I want to put in it?
446 \begin_layout Standard
448 the basic idea behind \SpecialChar LyX
461 \begin_inset Quotes eld
464 What You See Is What You Get,
465 \begin_inset Quotes erd
470 \begin_inset Quotes eld
473 What You See Is What You
478 \begin_inset Quotes erd
482 \begin_inset Quotes eld
486 \begin_inset Quotes erd
489 It's a powerful idea that greatly simplifies the mechanics of writing documents.
490 This is also why \SpecialChar LyX
491 isn't so good for creating posters and flyers.
497 want to specify exactly where everything goes,
498 because there are no functional units like paragraphs,
501 This doesn't mean \SpecialChar LyX
502 is missing some cool function.
503 It simply means that it isn't the right tool for the job —
504 you don't use a screwdriver to dr
505 \change_inserted 1660427103 1670920570
509 \begin_layout Standard
511 \change_inserted 1660427103 1670920570
514 If you cut and paste the section,
518 \change_inserted 1660427103 1670920570
519 cally be renumbered —
523 \change_inserted 1660427103 1670920570
525 And if you enter references to that section corr
528 \change_inserted 1660427103 1670920570
532 \change_inserted 1660427103 1670920570
536 \change_inserted 1660427103 1670920570
540 \change_inserted 1660427103 1670920570
544 \change_inserted 1660427103 1670920570
547 will automatically update them all throughout the f
550 \change_inserted 1660427103 1670920570
554 \change_inserted 1660427103 1670920570
556 ever type a section number
561 \begin_layout Subsection
562 Differences between \SpecialChar LyX
564 \change_inserted 1660427103 1670920570
570 \begin_layout Standard
571 Here's a list of things you won't find in \SpecialChar LyX
575 \begin_layout Itemize
579 \begin_layout Itemize
583 \begin_layout Itemize
585 \begin_inset space \thinspace{}
589 \begin_inset space \space{}
603 \begin_layout Standard
605 along with a ruler showing you the position of things on the page,
606 are useless in \SpecialChar LyX
608 The program worries about where things go on the page,
610 Extra whitespace is similar;
612 adds it where necessary,
613 depending on context.
614 Not being able to type two blank lines in a row will be annoying at first,
615 but it makes more sense once you're thinking in WYSIWYM terms.
618 \begin_layout Standard
619 Here are some things that exist in \SpecialChar LyX
621 but aren't used as you might think:
624 \begin_layout Itemize
628 \begin_layout Itemize
632 \begin_layout Itemize
634 \begin_inset space \thinspace{}
638 \begin_inset space \space{}
646 \begin_layout Itemize
648 horizontal and vertical
651 \begin_layout Itemize
655 \begin_layout Itemize
662 \begin_layout Standard
663 Although they exist in \SpecialChar LyX
665 you generally don't need them.
667 will take care of these things for you,
668 depending on what you're doing.
669 Different parts of the document are automatically set in a different typeface and font size.
670 Paragraph indenting is context dependent;
671 different types of paragraphs get indented differently.
672 Page breaks get handled automatically,
675 the space between lines,
677 and between paragraphs is variable,
678 set by \SpecialChar LyX
683 \begin_layout Plain Layout
684 There are ways to adjust all of these (only some of which require knowledge of \SpecialChar LaTeX
686 either for a whole document or for a specific location in a document.
703 \begin_layout Standard
705 there are a few areas where we believe \SpecialChar LyX
706 (and \SpecialChar LaTeX
707 ) surpasses many word processors:
710 \begin_layout Itemize
714 \begin_layout Itemize
718 \begin_layout Itemize
722 \begin_layout Itemize
726 \begin_layout Itemize
730 \begin_layout Standard
732 many modern word processors can handle mathematical symbols,
735 and many have moved towards style definitions and the WYSIWYM concept.
737 they've only recently been able to do so,
738 whereas \SpecialChar LyX
739 is built upon the \SpecialChar LaTeX
740 document preparation system.
742 has been around since 1985,
750 \begin_layout Subsection
751 What is \SpecialChar LaTeX
755 \begin_layout Standard
757 is a document preparation system designed by Leslie Lamport in 1985.
761 \begin_layout Plain Layout
762 The source for the info in this section is
764 A Guide to \SpecialChar LaTeX2e
768 by Helmut Kopka and Patrick Daly,
769 which has an entry in the bibliography of the
773 \SpecialChar endofsentence
779 It was built up from a typesetting language called \SpecialChar TeX
781 created by Donald Knuth in 1984.
783 takes a sequence of typesetting commands,
784 written in a script in an ASCII file,
787 \begin_inset Quotes eld
791 \begin_inset Quotes erd
794 of the printing trade were modeled by Knuth as computer algorithms and incorporated into \SpecialChar TeX
796 hence its excellent printed appearance.
797 What comes directly out of \SpecialChar TeX
798 is the portable document format
803 \begin_inset Quotes eld
807 \begin_inset Quotes erd
815 The dvi format is often used for previews and can later be converted to other formats like PostScript.
819 \begin_layout Standard
821 isn't only a typesetting engine;
822 it also allows you to define macros.
823 Most people who use \SpecialChar TeX
824 are actually using a macro package which Knuth created to hide a lot of the typesetting details.
825 This is where Leslie Lamport enters our story.
826 He wanted a macro package that was more user- and less typesetter-oriented,
827 with a set of commands that consistently typeset things like sections,
828 tables or math formulas in a uniform,
830 This is how \SpecialChar LaTeX
834 \begin_layout Standard
836 in parallel with the development and growth of \SpecialChar LaTeX
838 other folks were creating their own custom macro packages for \SpecialChar TeX
840 ones to make slides or articles for math journals and so on.
841 Some used the raw \SpecialChar TeX
842 facilities to do this,
843 others began modifying \SpecialChar LaTeX
845 To try and unify this mess,
846 a team of \SpecialChar LaTeX
847 -nicians began to work on \SpecialChar LaTeX2e
849 the current version of \SpecialChar LaTeX
851 during the late 1980's.
852 This new version of \SpecialChar LaTeX
853 has commands which provide an easier-to-use interface to \SpecialChar TeX
854 's macro-creating commands,
855 aid in the use of new fonts,
859 is quite an extensive language in its own right!
860 Users around the world have been creating their own add-ons for \SpecialChar LaTeX
861 beyond the standard ones.
864 \begin_layout Standard
865 There are two ways to extend \SpecialChar LaTeX
872 is a set of \SpecialChar LaTeX
873 macros describing a new type of document,
876 There are classes for slides,
877 for physics and math journals\SpecialChar ldots
878 many universities even have a class for their thesis format.
883 differs from a class in that it doesn't define a new type of document,
884 but a different type of
888 that any document can use.
891 controls page margins and line spacing using two different \SpecialChar LaTeX
892 style-files designed for these purposes.
893 There are style-files for a whole slew of things:
894 printing labels or envelopes,
895 changing indentation behavior,
897 manipulating graphics,
898 designing fancy page headings,
899 customizing bibliographies,
900 altering the location and appearance of footnotes,
907 \begin_layout Standard
911 \begin_layout Description
914 Typesetting language with macro capability.
917 \begin_layout Description
920 Macro package built upon \SpecialChar TeX
921 \SpecialChar endofsentence
925 \begin_layout Description
927 Descriptions of types of document used with \SpecialChar LaTeX
928 \SpecialChar endofsentence
932 \begin_layout Description
934 Descriptions of the default behavior of particular elements of \SpecialChar LaTeX
938 \begin_layout Description
942 WYSIWYM document processor that uses \SpecialChar LaTeX
943 to do its typesetting.
946 \begin_layout Standard
947 This section attempts to explain the difference between \SpecialChar LyX
948 and a word processor.
952 By using \SpecialChar LaTeX
955 helps you to think more about
964 The computer then handles
971 \begin_layout Section
972 Navigating the Documentation
975 \begin_layout Standard
976 To make it easier to answer your questions and describe all of the features of \SpecialChar LyX
978 the documentation has been split up into several different files.
979 Each one has its own purpose,
981 Before you go ploughing into any of those files,
983 you should read this chapter thoroughly,
984 since it contains a lot of useful information and commentary that can save you some time.
987 \begin_layout Standard
989 the development of \SpecialChar LyX
991 so some of the documentation may be incomplete or a bit out of date,
992 though we try to keep up-to-date.
993 Like the rest of \SpecialChar LyX
995 the manuals are the work of a group of volunteers who have
996 \begin_inset Quotes eld
1000 \begin_inset Quotes erd
1011 If you want to help out,
1012 be sure to read Section
1013 \begin_inset space ~
1017 \begin_inset CommandInset ref
1019 reference "sec:Contrib"
1024 in addition to the rest of this document.
1027 \begin_layout Standard
1029 please do us a favor – if anything in these manuals confuses you,
1032 don't hesitate to let us know!
1033 You can reach the current document maintainers by emailing
1034 \begin_inset CommandInset href
1036 target "lyx-docs@lists.lyx.org"
1043 If you have questions that are not obviously answered in the documentation,
1045 there is an active users' mailing list which you can reach at
1046 \begin_inset CommandInset href
1048 target "lyx-users@lists.lyx.org"
1057 \begin_layout Subsection
1058 The Format of the Manuals
1061 \begin_layout Standard
1062 Some of you may have printed out the manuals.
1063 Others may be reading them within \SpecialChar LyX
1065 There are some differences between the \SpecialChar LyX
1066 -file and the printed version.
1069 the title is simply at the top of the document,
1070 not formatted on a separate page as in some of the printed versions.
1071 Nor are any of the footnotes or the Table of Contents fully visible.
1073 which looks like this:
1075 \begin_inset Graphics
1076 filename ../../../../lib/doc/clipart/footnote.png
1082 click on it with the left mouse button.
1083 For the Table of Contents,
1084 either click on the grey box or click on the
1089 where the contents are displayed automatically\SpecialChar endofsentence
1093 \begin_layout Standard
1094 In the printed manuals,
1095 all cross-references appear as the actual numbers for a chapter,
1099 In the \SpecialChar LyX
1102 all cross-references appear as light-grey boxes like the following:
1104 \begin_inset Graphics
1105 filename ../../../../lib/doc/clipart/reference.png
1111 If you click on such a box with the left mouse button,
1112 a dialog box will appear containing a list of all the cross-references in the document.
1113 You can go to the referenced section by right-clicking on the box or by clicking the button
1116 \begin_inset space ~
1120 \begin_inset space ~
1125 in the opened dialog.
1126 Going back to where you came from is just as easy.
1130 \begin_inset space ~
1135 to go back to your earlier location.
1138 \begin_layout Standard
1139 Now that we've cleared up some of the differences between the printed and \SpecialChar LyX
1140 -file versions of this file,
1141 we can start looking at the format of this document.
1142 You'll occasionally notice things in different fonts:
1145 \begin_layout Itemize
1150 is used for general emphasis,
1153 names of sections of other manuals,
1154 and notes from the authors.
1157 \begin_layout Itemize
1162 is used for program and file names,
1167 \begin_layout Itemize
1174 or dialog box names,
1175 and the names of keyboard keys.
1178 \begin_layout Itemize
1183 is used for people's names.
1186 \begin_layout Itemize
1191 is used for \SpecialChar LaTeX
1195 \begin_layout Standard
1196 When we do need to reference keys,
1197 we'll use the following prefixing convention:
1200 \begin_layout Itemize
1201 \begin_inset Quotes eld
1209 \begin_inset Quotes erd
1219 \begin_layout Itemize
1220 \begin_inset Quotes eld
1228 \begin_inset Quotes erd
1238 \begin_layout Itemize
1239 \begin_inset Quotes eld
1247 \begin_inset Quotes erd
1261 \begin_layout Itemize
1262 \begin_inset Quotes eld
1270 \begin_inset Quotes erd
1275 \begin_inset Quotes eld
1283 \begin_inset Quotes erd
1286 are the function keys.
1289 \begin_layout Itemize
1290 \begin_inset Quotes eld
1298 \begin_inset Quotes erd
1304 \begin_layout Itemize
1305 \begin_inset Quotes eld
1313 \begin_inset Quotes erd
1317 \begin_inset Quotes eld
1325 \begin_inset Quotes erd
1329 \begin_inset Quotes eld
1337 \begin_inset Quotes erd
1341 \begin_inset Quotes eld
1349 \begin_inset Quotes erd
1356 \begin_layout Itemize
1359 \begin_inset Quotes eld
1365 \begin_inset Quotes erd
1369 \begin_inset Quotes eld
1377 \begin_inset Quotes erd
1381 \begin_inset Quotes eld
1389 \begin_inset Quotes erd
1393 \begin_inset Quotes eld
1401 \begin_inset Quotes erd
1405 \begin_inset Quotes eld
1413 \begin_inset Quotes erd
1417 \begin_inset Quotes eld
1425 \begin_inset Quotes erd
1430 \begin_inset space ~
1433 keys that appear above the cursor keys on many PC keyboards.
1435 \begin_inset Quotes eld
1443 \begin_inset Quotes erd
1447 \begin_inset Quotes eld
1455 \begin_inset Quotes erd
1459 \begin_inset Quotes eld
1467 \begin_inset Quotes erd
1471 \begin_inset Quotes eld
1479 \begin_inset Quotes erd
1485 \begin_layout Itemize
1494 both refer to the same key.
1495 Some keyboards label the
1500 \begin_inset Quotes eld
1504 \begin_inset Quotes erd
1508 \begin_inset Quotes eld
1512 \begin_inset Quotes erd
1515 still others have two keys.
1517 treats all of them as the same key,
1529 \begin_layout Standard
1530 The list with the currently set shortcuts can be found in the
1541 \begin_layout Subsection
1542 Units used in the Manuals
1545 \begin_layout Standard
1546 To understand the units described in this documentation,
1548 \begin_inset space ~
1552 \begin_inset CommandInset ref
1554 reference "tab:Units"
1559 explains all units available in \SpecialChar LyX
1563 \begin_layout Standard
1564 \begin_inset Float table
1571 \begin_layout Plain Layout
1572 \begin_inset Caption Standard
1574 \begin_layout Plain Layout
1575 \begin_inset CommandInset label
1589 \begin_layout Plain Layout
1590 \begin_inset VSpace medskip
1596 \begin_layout Plain Layout
1598 \begin_inset Tabular
1599 <lyxtabular version="3" rows="20" columns="2">
1600 <features booktabs="true" tabularvalignment="middle">
1601 <column alignment="center" valignment="top" width="0pt">
1602 <column alignment="center" valignment="top">
1604 <cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
1607 \begin_layout Plain Layout
1613 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1616 \begin_layout Plain Layout
1624 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1627 \begin_layout Plain Layout
1633 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1636 \begin_layout Plain Layout
1644 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1647 \begin_layout Plain Layout
1653 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1656 \begin_layout Plain Layout
1664 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1667 \begin_layout Plain Layout
1673 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1676 \begin_layout Plain Layout
1678 \begin_inset space \thinspace{}
1682 \begin_inset space \thinspace{}
1692 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1695 \begin_layout Plain Layout
1701 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1704 \begin_layout Plain Layout
1706 \begin_inset space \thinspace{}
1710 \begin_inset space \thinspace{}
1720 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1723 \begin_layout Plain Layout
1729 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1732 \begin_layout Plain Layout
1734 \begin_inset space \thinspace{}
1738 \begin_inset space \thinspace{}
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
1762 \begin_inset space \thinspace{}
1766 \begin_inset space \thinspace{}
1776 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1779 \begin_layout Plain Layout
1785 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1788 \begin_layout Plain Layout
1790 \begin_inset space \thinspace{}
1794 \begin_inset space \thinspace{}
1804 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1807 \begin_layout Plain Layout
1813 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1816 \begin_layout Plain Layout
1818 \begin_inset space \thinspace{}
1822 \begin_inset Formula $\approx$
1826 \begin_inset space \thinspace{}
1836 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1839 \begin_layout Plain Layout
1845 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1848 \begin_layout Plain Layout
1850 \begin_inset space \thinspace{}
1854 \begin_inset space \thinspace{}
1864 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1867 \begin_layout Plain Layout
1873 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1876 \begin_layout Plain Layout
1877 % of original image width
1884 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1887 \begin_layout Plain Layout
1893 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1896 \begin_layout Plain Layout
1904 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1907 \begin_layout Plain Layout
1913 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1916 \begin_layout Plain Layout
1924 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1927 \begin_layout Plain Layout
1933 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1936 \begin_layout Plain Layout
1944 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1947 \begin_layout Plain Layout
1953 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1956 \begin_layout Plain Layout
1964 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1967 \begin_layout Plain Layout
1973 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1976 \begin_layout Plain Layout
1984 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1987 \begin_layout Plain Layout
1993 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1996 \begin_layout Plain Layout
2004 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2007 \begin_layout Plain Layout
2013 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2016 \begin_layout Plain Layout
2028 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2031 \begin_layout Plain Layout
2037 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2040 \begin_layout Plain Layout
2052 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2055 \begin_layout Plain Layout
2061 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
2064 \begin_layout Plain Layout
2066 \begin_inset space \thinspace{}
2070 \begin_inset space \thinspace{}
2091 \begin_layout Subsection
2095 \begin_layout Standard
2096 The following list describes the contents of the basic documentation files that you find in the
2103 \begin_layout Description
2104 Introduction This file.
2107 \begin_layout Description
2108 Tutorial If you are new to \SpecialChar LyX
2110 and have never used \SpecialChar LaTeX
2112 you should start here.
2113 If you have used \SpecialChar LaTeX
2115 you should still read the
2120 starting with the section on
2121 \begin_inset Quotes eld
2125 for \SpecialChar LaTeX
2127 \begin_inset Quotes erd
2130 (Skimming through the rest of the document wouldn't hurt,
2134 \begin_layout Description
2136 \begin_inset space ~
2139 Guide The primary documentation.
2144 of the basic operation and available features of \SpecialChar LyX
2146 The main manual assumes that you have read the
2153 \begin_layout Description
2155 \begin_inset space ~
2158 Objects Extension of the
2163 Documents in detail how to use tables,
2167 program listings and boxes.
2168 It also includes many tricks of the \SpecialChar LaTeX
2172 \begin_layout Description
2173 Math Extension of the
2178 Documents in detail how to typeset any kind of formula.
2181 \begin_layout Description
2183 \begin_inset space ~
2186 Features Extension of the
2191 Documents how to use raw \SpecialChar LaTeX
2193 additional layouts and special-purpose editing features.
2196 \begin_layout Description
2197 Customization A description of advanced \SpecialChar LyX
2199 including how to customize the overall behavior of \SpecialChar LyX
2200 \SpecialChar endofsentence
2201 This includes such things as keybindings,
2202 internationalization and configuration files.
2203 It also includes information about layout files,
2204 which are needed to get \SpecialChar LyX
2205 to support \SpecialChar LaTeX
2206 classes or packages.
2209 \begin_layout Description
2210 Shortcuts Tables of the currently defined \SpecialChar LyX
2214 \begin_layout Description
2217 \begin_inset space ~
2220 Configuration A report produced by \SpecialChar LyX
2222 This file contains information on what \SpecialChar LyX
2223 learned about your installation.
2224 Check it to see if you're missing something you might like to have.
2227 \begin_layout Standard
2228 These files will reference one another as necessary.
2238 information on installation and customization,
2239 but refers the reader to the
2241 Customization Manual
2243 for more information.
2246 \begin_layout Standard
2247 We'll state again an important point:
2250 \begin_layout Standard
2251 \begin_inset VSpace bigskip
2257 \begin_layout Standard
2259 If you are new to \SpecialChar LyX
2266 Now\SpecialChar endofsentence
2270 \begin_layout Standard
2271 \begin_inset VSpace bigskip
2277 \begin_layout Standard
2279 you could needlessly frustrate yourself.
2282 \begin_layout Section
2283 Contributing to the \SpecialChar LyX
2285 \begin_inset CommandInset label
2294 \begin_layout Subsection
2295 Contributing to \SpecialChar LyX
2299 \begin_layout Standard
2301 is mostly written in C++ (the \SpecialChar LaTeX
2302 importer is written in Python).
2303 It is a large project,
2304 and as a result it is not free from bugs,
2305 or the need for improvements in the source code.
2308 \begin_layout Subsubsection
2312 \begin_layout Standard
2313 While using \SpecialChar LyX
2315 you may find behavior which you consider a bug.
2319 User interface problems are considered major bugs by the \SpecialChar LyX
2321 especially helpful are indications of parts of the \SpecialChar LyX
2322 interface you find confusing,
2326 \begin_layout Standard
2328 has a bug tracking system,
2329 which you can find at
2330 \begin_inset Newline newline
2334 \begin_inset CommandInset href
2336 target "https://www.lyx.org/trac/wiki/BugTrackerHome"
2341 You should check the bug tracker before reporting any bugs,
2342 in case it has already been reported.
2343 If you have a comment on an existing bug,
2344 or wish to report a new bug,
2345 you may either use the bug tracker,
2346 or send an e-mail to the development mailing list,
2348 \begin_inset CommandInset href
2350 target "lyx-devel@lists.lyx.org"
2357 Archives of this list are linked from the main \SpecialChar LyX
2360 \begin_inset CommandInset href
2362 target "http://www.lyx.org"
2369 \begin_layout Standard
2370 A useful bug report will at a minimum include the version of \SpecialChar LyX
2371 you are having the problem with.
2373 detailed descriptions are preferred —
2374 the more time developers have to spend to pinpoint the source of a bug,
2375 the less time they have for other improvements.
2376 Mention the system and system version on which you are running \SpecialChar LyX
2378 Give the versions of the libraries you have installed on your system,
2381 the versions of external programs that \SpecialChar LyX
2383 If it's a compilation or configuration problem,
2389 and mention which compiler you are using.
2392 \begin_layout Subsubsection
2393 Contributing fixes and new features
2396 \begin_layout Standard
2397 If you have made changes to \SpecialChar LyX
2398 's source that you think should become part of \SpecialChar LyX
2400 send your changes as a diff file (in unified format) to the development list referenced above,
2401 along with a change log,
2402 and a description of what your patch does.
2405 \begin_layout Subsection
2406 Contributing to the Documentation
2409 \begin_layout Standard
2411 's documentation is extensive;
2412 however \SpecialChar LyX
2413 is under constant development,
2414 and each new release adds new features.
2415 You may find some documentation needs improvement.
2416 This section describes what to do if you find an error,
2417 or have some suggestions for improving the documentation.
2420 \begin_layout Subsubsection
2421 Reporting Errors in the Manuals
2424 \begin_layout Standard
2425 If you find a problem with the documentation,
2426 send a message to the mailing list
2427 \begin_inset CommandInset href
2429 target "lyx-docs@lists.lyx.org"
2436 The documentation team will make any necessary fixes.
2439 \begin_layout Subsubsection
2440 Joining the Documentation Team.
2443 \begin_layout Standard
2444 The \SpecialChar LyX
2445 Documentation Project,
2446 like anything else in the \SpecialChar LyX
2448 can always use assistance!
2449 If you're interested in contributing to the Documentation Project,
2450 you need to do the following:
2453 \begin_layout Enumerate
2454 Get the latest \SpecialChar LyX
2456 \begin_inset Newline newline
2460 \begin_inset CommandInset href
2462 target "https://www.lyx.org/trac/browser/lyxgit/lib/doc?rev=master "
2469 \begin_layout Enumerate
2480 \begin_inset Newline newline
2483 The point of this exercise is to give you ideas.
2492 are likely to be the most up-to-date of all of the documentation.
2493 You should be able to glean some insights into how we want the manuals to read and to look.
2496 \begin_layout Enumerate
2497 Contact the team at:
2498 \begin_inset Newline newline
2502 \begin_inset CommandInset href
2504 target "lyx-docs@lists.lyx.org"
2511 \begin_inset Newline newline
2514 to discuss your intended changes and to get some feedback on them.
2517 \begin_layout Standard
2518 The changes you wish to make may range from improving clarity of the text,
2519 to doing major re-structuring of the documentation.
2520 Any and all improvements are gladly received.