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
100 \paragraph_separation indent
101 \paragraph_indentation default
103 \math_numbering_side default
104 \quotes_style english
108 \paperpagestyle default
110 \tracking_changes true
111 \output_changes false
113 \postpone_fragile_content false
116 \html_be_strict false
117 \docbook_table_output 0
118 \docbook_mathml_prefix 1
119 \author -1463541724 "Daniel" d3vf4n@tutanota.com
120 \author -584632292 "Richard Kimberly Heck"
127 Introduction to \SpecialChar LyX
132 by the \SpecialChar LyX
137 \begin_layout Plain Layout
139 If you have comments on or corrections to this documentation,
140 please send them to the \SpecialChar LyX
141 Documentation mailing list:
143 \begin_inset CommandInset href
145 target "lyx-docs@lists.lyx.org"
159 \begin_layout Standard
160 \begin_inset CommandInset toc
161 LatexCommand tableofcontents
168 \begin_layout Section
169 The Philosophy of \SpecialChar LyX
173 \begin_layout Subsection
174 What is \SpecialChar LyX
178 \begin_layout Standard
180 is a document preparation system.
181 It excels at letting you create complex technical and scientific articles with mathematics,
186 It is very good for working with documents of any length in which the usual processing abilities are required:
187 automatic sectioning and pagination,
188 spell checking and so forth.
189 It can also be used to write a letter to your mom,
191 there are probably simpler programs available for that.
192 It is definitely not the best tool for creating banners,
194 or advertisements (we'll explain why later),
195 though with some effort all these can be done,
197 Here are some examples of what it is used for:
200 dissertations and theses,
203 conference proceedings,
204 software documentation,
206 articles in refereed scientific journals,
207 scripts for plays and movies,
210 \change_deleted -1463541724 1692922495
217 \begin_layout Standard
219 is a program that provides a modern approach to writing documents with a computer by using a markup language paradigm,
220 an approach that breaks with the obsolete tradition of the
221 \begin_inset Quotes eld
225 \begin_inset Quotes erd
229 It is designed for authors who want professional output quickly with a minimum of effort and without becoming specialists in typesetting.
230 The job of typesetting is done mostly by the computer,
232 with \SpecialChar LyX
234 the author can concentrate on the contents of his writing.
237 \begin_layout Standard
238 Part of the initial challenge of using \SpecialChar LyX
239 comes from the change in thinking that you,
243 all we had for creating documents were typewriters,
244 so we all learned certain tricks to get around their limitations.
246 which is little more than overstriking with the
247 \begin_inset Quotes eld
251 \begin_inset Quotes erd
255 became a way to emphasize text.
256 You were forced to figure out column sizes and tab stops,
258 before creating a table.
259 The same applied for letters and other right justified text.
260 Hyphenation at the end of a line required a careful eye and a lot of foresight.
263 \begin_layout Standard
265 we've all been trained to worry about the little details of which character goes where.
267 almost all word processors have this mentality.
268 They still use tab stops for adding whitespace.
269 You still need to worry about exactly where on the page something will appear.
270 Emphasizing text means changing a font,
271 similar to changing the typewriter wheel.
272 This is the underlying philosophy of a WYSIWYG word processor:
274 \begin_inset Quotes eld
277 What You See Is What You Get
278 \begin_inset Quotes erd
283 that paradigm often results in
284 \begin_inset Quotes eld
287 What You See Is All You Get
288 \begin_inset Quotes erd
294 \begin_layout Standard
295 This is where \SpecialChar LyX
296 differs from an ordinary word processor.
297 You don't concern yourself with what character goes where.
298 You tell \SpecialChar LyX
304 takes care of the rest,
305 following a set of rules called a
313 \begin_layout Plain Layout
315 most recent versions of the most popular office suites now have some sort of style sheets which follow a similar markup method.
317 our experience is that they are still rarely used in practice.
322 Let's look at a little example:
325 \begin_layout Standard
326 Suppose you are writing a report.
327 To begin your report,
328 you want a section called
329 \begin_inset Quotes eld
333 \change_deleted -1463541724 1692922782
334 \SpecialChar endofsentence
338 \begin_inset Quotes erd
342 \change_inserted -1463541724 1692922792
343 \SpecialChar endofsentence
347 you go into whatever menu it is in your word processor that changes font sizes and decide on a new font size.
348 Then you turn on bold face.
351 \begin_inset Quotes eld
363 \begin_inset Quotes erd
368 if you later decide that this section belongs someplace else in the document or if you insert a new section before it,
369 you need to change the numbering for this and all following sections,
370 as well as any entry in the table of contents.
373 \begin_layout Standard
376 you go to the pull-down on the far left of the button bar and select
382 \begin_inset Quotes eld
386 \begin_inset Quotes erd
392 \begin_layout Standard
395 If you cut and paste the section,
396 it will automatically be renumbered —
398 And if you enter references to that section correctly (by inserting cross-reference tags),
400 will automatically update them all throughout the file so that you never,
401 ever type a section number.
404 \begin_layout Standard
405 Now let's look at the problem of consistency.
407 you reopen your report and start Section
413 you forget that you were using 18
414 \begin_inset space \thinspace{}
417 pt bold instead of 16
418 \begin_inset space \thinspace{}
422 so you type in the heading for Section
426 4 in a different font from the one you used for Section
431 That problem doesn't even exist in \SpecialChar LyX
433 The computer takes care of all that silly bookkeeping about which thing has what size font,
436 that's what a computer is good at.
439 \begin_layout Standard
440 Here's another example.
441 Suppose you're making a list.
442 In other word processors,
443 a list is just a bunch of tab stops and newlines.
444 You need to figure out where to put the label for each list item,
445 what that label should be,
446 how many blank lines to put between each item,
448 Under \SpecialChar LyX
450 you have only two concerns:
451 what kind of list is this,
452 and what do I want to put in it?
456 \begin_layout Standard
458 the basic idea behind \SpecialChar LyX
471 \begin_inset Quotes eld
474 What You See Is What You Get
475 \change_deleted -1463541724 1692922450
479 \begin_inset Quotes erd
483 \change_inserted -1463541724 1692923936
489 \begin_inset Quotes eld
492 What You See Is What You
497 \begin_inset Quotes erd
501 \change_deleted -1463541724 1692923839
503 \begin_inset Quotes eld
509 \change_deleted -1463541724 1692923836
511 \begin_inset Quotes erd
515 \change_inserted -1463541724 1692923925
519 It's a powerful idea that greatly simplifies the mechanics of writing documents.
520 This is also why \SpecialChar LyX
521 isn't so good for creating posters and flyers.
527 want to specify exactly where everything goes,
528 because there are no functional units like paragraphs,
531 This doesn't mean \SpecialChar LyX
532 is missing some cool function.
533 It simply means that it isn't the right tool for the job —
534 you don't use a screwdriver to drive in nails.
537 \begin_layout Subsection
538 Differences between \SpecialChar LyX
539 and Other Word Processors
542 \begin_layout Standard
543 Here's a list of things you won't find in \SpecialChar LyX
547 \begin_layout Itemize
551 \begin_layout Itemize
555 \begin_layout Itemize
557 \begin_inset space \thinspace{}
561 \begin_inset space \space{}
575 \begin_layout Standard
577 along with a ruler showing you the position of things on the page,
578 are useless in \SpecialChar LyX
580 The program worries about where things go on the page,
582 Extra whitespace is similar;
584 adds it where necessary,
585 depending on context.
586 Not being able to type two blank lines in a row will be annoying at first,
587 but it makes more sense once you're thinking in WYSIWYM terms.
590 \begin_layout Standard
591 Here are some things that exist in \SpecialChar LyX
593 but aren't used as you might think:
596 \begin_layout Itemize
600 \begin_layout Itemize
604 \begin_layout Itemize
606 \begin_inset space \thinspace{}
610 \begin_inset space \space{}
618 \begin_layout Itemize
620 horizontal and vertical
623 \begin_layout Itemize
627 \begin_layout Itemize
634 \begin_layout Standard
635 Although they exist in \SpecialChar LyX
637 you generally don't need them.
639 will take care of these things for you,
640 depending on what you're doing.
641 Different parts of the document are automatically set in a different typeface and font size.
642 Paragraph indenting is context dependent;
643 different types of paragraphs get indented differently.
644 Page breaks get handled automatically,
647 the space between lines,
649 and between paragraphs is variable,
650 set by \SpecialChar LyX
655 \begin_layout Plain Layout
656 There are ways to adjust all of these (only some of which require knowledge of \SpecialChar LaTeX
658 either for a whole document or for a specific location in a document.
675 \begin_layout Standard
677 there are a few areas where we believe \SpecialChar LyX
678 (and \SpecialChar LaTeX
679 ) surpasses many word processors:
682 \begin_layout Itemize
686 \begin_layout Itemize
690 \begin_layout Itemize
694 \begin_layout Itemize
698 \begin_layout Itemize
702 \begin_layout Standard
704 many modern word processors can handle mathematical symbols,
707 and many have moved towards style definitions and the WYSIWYM concept.
709 they've only recently been able to do so,
710 whereas \SpecialChar LyX
711 is built upon the \SpecialChar LaTeX
712 document preparation system.
714 has been around since 1985,
722 \begin_layout Subsection
723 What is \SpecialChar LaTeX
727 \begin_layout Standard
729 is a document preparation system designed by
737 \begin_layout Plain Layout
738 The source for the info in this section is
740 A Guide to \SpecialChar LaTeX2e
744 by Helmut Kopka and Patrick Daly,
745 which has an entry in the bibliography of the
749 \SpecialChar endofsentence
755 It was built up from a typesetting language called \SpecialChar TeX
763 takes a sequence of typesetting commands,
764 written in a script in an ASCII file,
767 \begin_inset Quotes eld
771 \begin_inset Quotes erd
774 of the printing trade were modeled by
778 as computer algorithms and incorporated into \SpecialChar TeX
780 hence its excellent printed appearance.
781 What comes directly out of \SpecialChar TeX
783 \change_inserted -1463541724 1692922633
785 \begin_inset Quotes eld
790 portable document format
791 \change_inserted -1463541724 1692922640
793 \begin_inset Quotes erd
803 \begin_inset Quotes eld
807 \begin_inset Quotes erd
819 format is often used for previews and can later be converted to other formats like PostScript.
823 \begin_layout Standard
825 isn't only a typesetting engine;
826 it also allows you to define macros.
827 Most people who use \SpecialChar TeX
828 are actually using a macro package which
832 created to hide a lot of the typesetting details.
838 He wanted a macro package that was more user- and less typesetter-oriented,
839 with a set of commands that consistently typeset things like sections,
840 tables or math formulas in a uniform,
842 This is how \SpecialChar LaTeX
846 \begin_layout Standard
848 in parallel with the development and growth of \SpecialChar LaTeX
850 other folks were creating their own custom macro packages for \SpecialChar TeX
852 ones to make slides or articles for math journals and so on.
853 Some used the raw \SpecialChar TeX
854 facilities to do this,
855 others began modifying \SpecialChar LaTeX
857 To try and unify this mess,
858 a team of \SpecialChar LaTeX
859 -nicians began to work on \SpecialChar LaTeX2e
861 the current version of \SpecialChar LaTeX
863 during the late 1980's.
864 This new version of \SpecialChar LaTeX
865 has commands which provide an easier-to-use interface to \SpecialChar TeX
866 's macro-creating commands,
867 aid in the use of new fonts,
871 is quite an extensive language in its own right!
872 Users around the world have been creating their own add-ons for \SpecialChar LaTeX
873 beyond the standard ones.
876 \begin_layout Standard
877 There are two ways to extend \SpecialChar LaTeX
884 is a set of \SpecialChar LaTeX
885 macros describing a new type of document,
888 There are classes for slides,
889 for physics and math journals\SpecialChar ldots
890 many universities even have a class for their thesis format.
895 differs from a class in that it doesn't define a new type of document,
896 but a different type of
900 that any document can use.
903 controls page margins and line spacing using two different \SpecialChar LaTeX
904 style-files designed for these purposes.
905 There are style-files for a whole slew of things:
906 printing labels or envelopes,
907 changing indentation behavior,
909 manipulating graphics,
910 designing fancy page headings,
911 customizing bibliographies,
912 altering the location and appearance of footnotes,
919 \begin_layout Standard
923 \begin_layout Description
926 Typesetting language with macro capability.
929 \begin_layout Description
932 Macro package built upon \SpecialChar TeX
933 \SpecialChar endofsentence
937 \begin_layout Description
939 Descriptions of types of document used with \SpecialChar LaTeX
940 \SpecialChar endofsentence
944 \begin_layout Description
946 Descriptions of the default behavior of particular elements of \SpecialChar LaTeX
950 \begin_layout Description
954 WYSIWYM document processor that uses \SpecialChar LaTeX
955 to do its typesetting.
958 \begin_layout Standard
959 This section attempts to explain the difference between \SpecialChar LyX
960 and a word processor.
964 By using \SpecialChar LaTeX
967 helps you to think more about
976 The computer then handles
983 \begin_layout Section
984 Navigating the Documentation
987 \begin_layout Standard
988 To make it easier to answer your questions and describe all of the features of \SpecialChar LyX
990 the documentation has been split up into several different files.
991 Each one has its own purpose,
993 Before you go ploughing into any of those files,
995 you should read this chapter thoroughly,
996 since it contains a lot of useful information and commentary that can save you some time.
999 \begin_layout Standard
1001 the development of \SpecialChar LyX
1003 so some of the documentation may be incomplete or a bit out of date,
1004 though we try to keep up-to-date.
1005 Like the rest of \SpecialChar LyX
1007 the manuals are the work of a group of volunteers who have
1008 \begin_inset Quotes eld
1012 \change_inserted -1463541724 1692917953
1014 \change_deleted -1463541724 1692917953
1018 \change_inserted -1463541724 1692963264
1020 \change_deleted -1463541724 1692963263
1024 \begin_inset Quotes erd
1035 If you want to help out,
1036 be sure to read Section
1037 \begin_inset space ~
1041 \begin_inset CommandInset ref
1043 reference "sec:Contrib"
1048 in addition to the rest of this document.
1051 \begin_layout Standard
1053 please do us a favor:
1054 if anything in these manuals confuses you,
1057 don't hesitate to let us know!
1058 You can reach the current document
1059 \change_inserted -1463541724 1692963407
1062 maintainers by emailing
1063 \begin_inset CommandInset href
1065 target "lyx-docs@lists.lyx.org"
1073 \change_deleted -1463541724 1692922571
1075 \change_inserted -584632292 1610248366
1079 \begin_layout Subsection
1081 \change_inserted -584632292 1610248375
1085 \begin_layout Standard
1086 If you have questions that are not obviously answered in the documentation and need help fast,
1087 there is an active users' mailing list which you can reach at
1088 \begin_inset CommandInset href
1090 target "lyx-users@lists.lyx.org"
1098 \change_inserted -584632292 1610248524
1099 You do not have to register to post,
1100 but you may wish to do so.
1102 \begin_inset CommandInset href
1104 name "the LyX website"
1105 target "https://www.lyx.org/MailingLists"
1110 for further information.
1112 \begin_inset CommandInset href
1114 target "http://wiki.lyx.org/"
1119 that will answer many questions about how to get LyX to do various things.
1124 \begin_layout Subsection
1125 The Format of the Manuals
1128 \begin_layout Standard
1129 Some of you may have printed out the manuals.
1130 Others may be reading them within \SpecialChar LyX
1132 There are some differences between the \SpecialChar LyX
1133 -file and the printed version.
1136 the title is simply at the top of the document,
1137 not formatted on a separate page as in some of the printed versions.
1138 Nor are any of the footnotes or the Table of Contents fully visible.
1140 which looks like this:
1142 \begin_inset Graphics
1143 filename clipart/footnote.png
1149 click on it with the left mouse button.
1150 For the Table of Contents,
1151 either click on the grey box or click on the
1156 where the contents are displayed automatically\SpecialChar endofsentence
1160 \begin_layout Standard
1161 In the printed manuals,
1162 all cross-references appear as the actual numbers for a chapter,
1166 In the \SpecialChar LyX
1169 all cross-references appear as light-grey boxes like the following:
1171 \begin_inset Graphics
1172 filename clipart/reference.png
1178 If you click on such a box with the left mouse button,
1179 a dialog box will appear containing a list of all the cross-references in the document.
1180 You can go to the referenced section by right-clicking on the box or by clicking the button
1183 \begin_inset space ~
1187 \begin_inset space ~
1192 in the opened dialog.
1193 Going back to where you came from is just as easy.
1197 \begin_inset space ~
1202 to go back to your earlier location.
1205 \begin_layout Standard
1206 Now that we've cleared up some of the differences between the printed and \SpecialChar LyX
1207 -file versions of this file,
1208 we can start looking at the format of this document.
1209 You'll occasionally notice things in different fonts:
1212 \begin_layout Itemize
1217 is used for general emphasis,
1220 \change_inserted -1463541724 1692964248
1224 names of sections of other manuals,
1225 and notes from the authors.
1228 \begin_layout Itemize
1233 is used for program and file names,
1238 \begin_layout Itemize
1245 \change_deleted -1463541724 1692964370
1249 or dialog box names,
1250 and the names of keyboard keys.
1253 \begin_layout Itemize
1258 is used for people's names.
1259 \change_deleted 5863208 1692989367
1261 \begin_inset Note Note
1264 \begin_layout Plain Layout
1266 \change_inserted -1463541724 1692964472
1267 This document has some person names (Leslie Lamport,
1268 Donald Knuth) and none of them is typ
1269 \change_inserted 5863208 1692989355
1271 \change_inserted -1463541724 1692964472
1272 set with this font face.
1273 Shall we change them?
1274 \change_inserted 5863208 1692989346
1278 \begin_layout Plain Layout
1280 \change_inserted 5863208 1692989349
1293 \begin_layout Itemize
1298 is used for \SpecialChar LaTeX
1300 \change_inserted -1463541724 1692842469
1306 \begin_layout Standard
1307 When we do need to reference keys,
1308 we'll use the following prefixing convention:
1309 \change_deleted 5863208 1692989463
1311 \begin_inset Note Note
1314 \begin_layout Plain Layout
1316 \change_inserted -1463541724 1692842873
1317 Do not think quotation marks are necessary when already using a different font face to differentiate the text.
1329 \begin_layout Itemize
1331 \change_deleted -1463541724 1692842633
1332 \begin_inset Quotes eld
1340 \change_deleted -1463541724 1692842626
1344 \begin_inset Quotes erd
1356 \begin_layout Itemize
1358 \change_deleted -1463541724 1692842634
1359 \begin_inset Quotes eld
1367 \change_deleted -1463541724 1692842636
1371 \begin_inset Quotes erd
1383 \begin_layout Itemize
1385 \change_deleted -1463541724 1692842640
1386 \begin_inset Quotes eld
1394 \change_deleted -1463541724 1692842639
1398 \begin_inset Quotes erd
1414 \begin_layout Itemize
1416 \change_deleted -1463541724 1692842642
1417 \begin_inset Quotes eld
1425 \change_deleted -1463541724 1692842642
1429 \begin_inset Quotes erd
1436 \change_deleted -1463541724 1692842644
1438 \begin_inset Quotes eld
1446 \change_deleted -1463541724 1692842646
1450 \begin_inset Quotes erd
1455 are the function keys.
1458 \begin_layout Itemize
1460 \change_deleted -1463541724 1692842662
1461 \begin_inset Quotes eld
1469 \change_deleted -1463541724 1692842663
1473 \begin_inset Quotes erd
1481 \begin_layout Itemize
1483 \change_deleted -1463541724 1692842660
1484 \begin_inset Quotes eld
1492 \change_deleted -1463541724 1692842658
1496 \begin_inset Quotes erd
1500 \change_inserted -1463541724 1692964502
1505 \change_deleted -1463541724 1692842658
1507 \begin_inset Quotes eld
1515 \change_deleted -1463541724 1692842648
1519 \begin_inset Quotes erd
1523 \change_inserted -1463541724 1692964504
1528 \change_deleted -1463541724 1692842649
1530 \begin_inset Quotes eld
1538 \change_deleted -1463541724 1692842651
1542 \begin_inset Quotes erd
1546 \change_inserted -1463541724 1692964516
1550 \change_deleted -1463541724 1692842650
1552 \begin_inset Quotes eld
1560 \change_deleted -1463541724 1692842655
1564 \begin_inset Quotes erd
1573 \begin_layout Itemize
1575 \change_deleted -1463541724 1692842666
1578 \begin_inset Quotes eld
1584 \change_deleted -1463541724 1692842664
1588 \begin_inset Quotes erd
1592 \change_inserted -1463541724 1692964521
1597 \change_deleted -1463541724 1692842665
1599 \begin_inset Quotes eld
1607 \change_deleted -1463541724 1692842667
1611 \begin_inset Quotes erd
1615 \change_inserted -1463541724 1692964524
1620 \change_deleted -1463541724 1692842668
1622 \begin_inset Quotes eld
1630 \change_deleted -1463541724 1692842670
1634 \begin_inset Quotes erd
1638 \change_inserted -1463541724 1692964525
1643 \change_deleted -1463541724 1692842671
1645 \begin_inset Quotes eld
1653 \change_deleted -1463541724 1692842672
1657 \begin_inset Quotes erd
1661 \change_inserted -1463541724 1692964527
1666 \change_deleted -1463541724 1692842673
1668 \begin_inset Quotes eld
1676 \change_deleted -1463541724 1692842674
1680 \begin_inset Quotes erd
1684 \change_inserted -1463541724 1692964535
1688 \change_deleted -1463541724 1692842675
1690 \begin_inset Quotes eld
1698 \change_deleted -1463541724 1692842677
1702 \begin_inset Quotes erd
1709 \begin_inset space ~
1712 keys that appear above the cursor keys on many PC keyboards.
1714 \change_deleted -1463541724 1692842683
1716 \begin_inset Quotes eld
1724 \change_deleted -1463541724 1692842681
1728 \begin_inset Quotes erd
1734 \change_deleted -1463541724 1692842756
1736 \begin_inset Quotes eld
1744 \change_deleted -1463541724 1692842758
1748 \begin_inset Quotes erd
1754 \change_deleted -1463541724 1692842752
1756 \begin_inset Quotes eld
1764 \change_deleted -1463541724 1692842750
1768 \begin_inset Quotes erd
1774 \change_deleted -1463541724 1692842754
1776 \begin_inset Quotes eld
1784 \change_deleted -1463541724 1692842755
1788 \begin_inset Quotes erd
1796 \begin_layout Itemize
1805 both refer to the same key.
1806 Some keyboards label the
1811 \begin_inset Quotes eld
1815 \change_deleted -1463541724 1692842976
1819 \begin_inset Quotes erd
1823 \change_inserted -1463541724 1692842978
1828 \begin_inset Quotes eld
1832 \change_deleted -1463541724 1692842982
1836 \begin_inset Quotes erd
1840 \change_inserted -1463541724 1692842991
1842 \change_deleted 5863208 1692989468
1844 \begin_inset Note Note
1847 \begin_layout Plain Layout
1849 \change_inserted -1463541724 1692966623
1851 so punctuation goes out of the quoted text.
1853 \begin_inset CommandInset href
1855 name "Cambridge grammar (punctuation)"
1856 target "https://dictionary.cambridge.org/grammar/british-grammar/punctuation"
1871 still others have two keys.
1873 treats all of them as the same key,
1885 \begin_layout Standard
1886 The list with the currently set shortcuts can be found in the
1897 \begin_layout Subsection
1898 Units used in the Manuals
1901 \begin_layout Standard
1902 To understand the units described in this documentation,
1904 \begin_inset space ~
1908 \begin_inset CommandInset ref
1910 reference "tab:Units"
1915 explains all units available in \SpecialChar LyX
1919 \begin_layout Standard
1920 \begin_inset Float table
1927 \begin_layout Plain Layout
1928 \begin_inset Caption Standard
1930 \begin_layout Plain Layout
1931 \begin_inset CommandInset label
1945 \begin_layout Plain Layout
1946 \begin_inset VSpace medskip
1952 \begin_layout Plain Layout
1954 \begin_inset Tabular
1955 <lyxtabular version="3" rows="20" columns="2">
1956 <features booktabs="true" tabularvalignment="middle">
1957 <column alignment="center" valignment="top" width="0pt">
1958 <column alignment="center" valignment="top">
1960 <cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
1963 \begin_layout Plain Layout
1969 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1972 \begin_layout Plain Layout
1980 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1983 \begin_layout Plain Layout
1989 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1992 \begin_layout Plain Layout
2000 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2003 \begin_layout Plain Layout
2009 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2012 \begin_layout Plain Layout
2020 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2023 \begin_layout Plain Layout
2029 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2032 \begin_layout Plain Layout
2034 \begin_inset space \thinspace{}
2038 \begin_inset space \thinspace{}
2048 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2051 \begin_layout Plain Layout
2057 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2060 \begin_layout Plain Layout
2062 \begin_inset space \thinspace{}
2066 \begin_inset space \thinspace{}
2076 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2079 \begin_layout Plain Layout
2085 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2088 \begin_layout Plain Layout
2090 \begin_inset space \thinspace{}
2094 \begin_inset space \thinspace{}
2104 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2107 \begin_layout Plain Layout
2113 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2116 \begin_layout Plain Layout
2118 \begin_inset space \thinspace{}
2122 \begin_inset space \thinspace{}
2132 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2135 \begin_layout Plain Layout
2141 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2144 \begin_layout Plain Layout
2146 \begin_inset space \thinspace{}
2150 \begin_inset space \thinspace{}
2160 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2163 \begin_layout Plain Layout
2169 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2172 \begin_layout Plain Layout
2174 \begin_inset space \thinspace{}
2178 \begin_inset Formula $\approx$
2182 \begin_inset space \thinspace{}
2192 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2195 \begin_layout Plain Layout
2201 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2204 \begin_layout Plain Layout
2206 \begin_inset space \thinspace{}
2210 \begin_inset space \thinspace{}
2220 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2223 \begin_layout Plain Layout
2229 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2232 \begin_layout Plain Layout
2233 % of original image width
2240 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2243 \begin_layout Plain Layout
2249 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2252 \begin_layout Plain Layout
2260 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2263 \begin_layout Plain Layout
2269 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2272 \begin_layout Plain Layout
2280 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2283 \begin_layout Plain Layout
2289 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2292 \begin_layout Plain Layout
2300 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2303 \begin_layout Plain Layout
2309 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2312 \begin_layout Plain Layout
2320 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2323 \begin_layout Plain Layout
2329 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2332 \begin_layout Plain Layout
2340 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2343 \begin_layout Plain Layout
2349 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2352 \begin_layout Plain Layout
2360 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2363 \begin_layout Plain Layout
2369 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2372 \begin_layout Plain Layout
2384 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2387 \begin_layout Plain Layout
2393 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2396 \begin_layout Plain Layout
2408 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2411 \begin_layout Plain Layout
2417 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
2420 \begin_layout Plain Layout
2422 \begin_inset space \thinspace{}
2426 \begin_inset space \thinspace{}
2447 \begin_layout Subsection
2451 \begin_layout Standard
2452 The following list describes the contents of the basic documentation files that you find in the
2459 \begin_layout Description
2460 Introduction This file.
2463 \begin_layout Description
2464 Tutorial If you are new to \SpecialChar LyX
2466 and have never used \SpecialChar LaTeX
2468 you should start here.
2469 If you have used \SpecialChar LaTeX
2471 you should still read the
2476 starting with the section on
2477 \change_deleted -1463541724 1692917771
2479 \begin_inset Quotes eld
2487 for \SpecialChar LaTeX
2489 \change_deleted -1463541724 1692917763
2493 \begin_inset Quotes erd
2497 \change_inserted -1463541724 1692917775
2499 \change_deleted 5863208 1692989483
2501 \begin_inset Note Note
2504 \begin_layout Plain Layout
2506 \change_inserted -1463541724 1692918131
2508 don't see the point in quoting text already using a different font face.
2510 was not complying to the use of font faces in the manuals stated in section 2.2.
2519 (Skimming through the rest of the document wouldn't hurt,
2523 \begin_layout Description
2525 \begin_inset space ~
2528 Guide The primary documentation.
2533 of the basic operation and available features of \SpecialChar LyX
2535 The main manual assumes that you have read the
2542 \begin_layout Description
2544 \begin_inset space ~
2547 Objects Extension of the
2552 Documents in detail how to use tables,
2556 program listings and boxes.
2557 It also includes many tricks of the \SpecialChar LaTeX
2561 \begin_layout Description
2562 Math Extension of the
2567 Documents in detail how to typeset any kind of formula.
2570 \begin_layout Description
2572 \begin_inset space ~
2575 Features Extension of the
2580 Documents how to use raw \SpecialChar LaTeX
2582 additional layouts and special-purpose editing features.
2585 \begin_layout Description
2586 Customization A description of advanced \SpecialChar LyX
2588 including how to customize the overall behavior of \SpecialChar LyX
2589 \SpecialChar endofsentence
2590 This includes such things as keybindings,
2591 internationalization and configuration files.
2592 It also includes information about layout files,
2593 which are needed to get \SpecialChar LyX
2594 to support \SpecialChar LaTeX
2595 classes or packages.
2598 \begin_layout Description
2599 Shortcuts Tables of the currently defined \SpecialChar LyX
2603 \begin_layout Description
2606 \begin_inset space ~
2609 Configuration A report produced by \SpecialChar LyX
2611 This file contains information on what \SpecialChar LyX
2612 learned about your installation.
2613 Check it to see if you're missing something you might like to have.
2616 \begin_layout Standard
2617 These files will reference one another as necessary.
2627 information on installation and customization,
2628 but refers the reader to the
2633 \change_deleted -1463541724 1692964787
2635 \change_inserted -1463541724 1692964788
2638 anual for more information.
2641 \begin_layout Standard
2642 We'll state again an important point:
2645 \begin_layout Standard
2646 \begin_inset VSpace bigskip
2652 \begin_layout Standard
2654 If you are new to \SpecialChar LyX
2661 Now\SpecialChar endofsentence
2665 \begin_layout Standard
2666 \begin_inset VSpace bigskip
2672 \begin_layout Standard
2674 you could needlessly frustrate yourself.
2677 \begin_layout Section
2678 Contributing to the \SpecialChar LyX
2680 \begin_inset CommandInset label
2689 \begin_layout Subsection
2690 Contributing to \SpecialChar LyX
2694 \begin_layout Standard
2696 is mostly written in C++ (the \SpecialChar LaTeX
2697 importer is written in Python).
2698 It is a large project,
2699 and as a result it is not free from bugs,
2700 or the need for improvements in the source code.
2703 \begin_layout Subsubsection
2707 \begin_layout Standard
2708 While using \SpecialChar LyX
2710 you may find behavior which you consider a bug.
2714 User interface problems are considered major bugs by the \SpecialChar LyX
2716 especially helpful are indications of parts of the \SpecialChar LyX
2717 interface you find confusing,
2721 \begin_layout Standard
2723 has a bug tracking system,
2724 which you can find at
2725 \begin_inset Newline newline
2729 \begin_inset CommandInset href
2731 target "https://www.lyx.org/trac/wiki/BugTrackerHome"
2736 You should check the bug tracker before reporting any bugs,
2737 in case it has already been reported.
2738 If you have a comment on an existing bug,
2739 or wish to report a new bug,
2740 you may either use the bug tracker,
2741 or send an e-mail to the development mailing list,
2743 \begin_inset CommandInset href
2745 target "lyx-devel@lists.lyx.org"
2752 Archives of this list are linked from the main \SpecialChar LyX
2755 \change_deleted 5863208 1692989524
2757 \begin_inset CommandInset href
2759 target "http://www.lyx.org"
2764 \change_inserted 5863208 1692989534
2766 \begin_inset CommandInset href
2768 target "https://www.lyx.org/MailingLists"
2774 \change_deleted 5863208 1692989524
2776 \begin_inset Note Note
2779 \begin_layout Plain Layout
2781 \change_inserted -1463541724 1692966662
2782 Substitute this link for the more specific
2783 \begin_inset CommandInset href
2785 target "https://www.lyx.org/MailingLists#toc3"
2790 \change_deleted 5863208 1692989514
2792 \begin_inset CommandInset href
2794 target "https://www.lyx.org/MailingLists"
2800 \change_inserted -1463541724 1692966662
2813 \begin_layout Standard
2814 A useful bug report will at a minimum include the version of \SpecialChar LyX
2815 you are having the problem with.
2817 detailed descriptions are preferred —
2818 the more time developers have to spend to pinpoint the source of a bug,
2819 the less time they have for other improvements.
2820 Mention the system and system version on which you are running \SpecialChar LyX
2822 Give the versions of the libraries you have installed on your system,
2825 the versions of external programs that \SpecialChar LyX
2827 If it's a compilation or configuration problem,
2833 and mention which compiler you are using.
2835 \change_inserted 5863208 1692989585
2837 \begin_inset Quotes eld
2840 Part of this information can be found in
2842 Help\SpecialChar menuseparator
2846 \begin_inset Quotes erd
2850 \change_deleted 5863208 1692989598
2852 \begin_inset Note Note
2855 \begin_layout Plain Layout
2857 \change_inserted -1463541724 1692957260
2858 Shall we mention this information can be found in
2860 Help\SpecialChar menuseparator
2867 \begin_layout Plain Layout
2869 \change_inserted -1463541724 1692966675
2870 \begin_inset Quotes eld
2873 Most of this information can be found in
2875 Help\SpecialChar menuseparator
2879 \begin_inset Quotes erd
2885 \begin_layout Plain Layout
2887 \change_inserted -1463541724 1692966688
2888 \begin_inset Quotes eld
2891 Part of this information can be found in
2893 Help\SpecialChar menuseparator
2897 \begin_inset Quotes erd
2912 \begin_layout Subsubsection
2913 Contributing fixes and new features
2916 \begin_layout Standard
2917 If you have made changes to \SpecialChar LyX
2918 's source that you think should become part of \SpecialChar LyX
2920 send your changes as a diff file (in unified format) to the development list referenced above,
2921 along with a change log,
2922 and a description of what your patch does.
2925 \begin_layout Subsection
2926 Contributing to the Documentation
2929 \begin_layout Standard
2931 's documentation is extensive;
2932 however \SpecialChar LyX
2933 is under constant development,
2934 and each new release adds new features.
2935 You may find some documentation needs improvement.
2936 This section describes what to do if you find an error,
2937 or have some suggestions for improving the documentation.
2940 \begin_layout Subsubsection
2941 Reporting Errors in the Manuals
2944 \begin_layout Standard
2945 If you find a problem with the documentation,
2946 send a message to the mailing list
2947 \begin_inset CommandInset href
2949 target "lyx-docs@lists.lyx.org"
2956 The documentation team will make any necessary fixes.
2959 \begin_layout Subsubsection
2960 Joining the Documentation Team.
2963 \begin_layout Standard
2964 The \SpecialChar LyX
2965 Documentation Project,
2966 like anything else in the \SpecialChar LyX
2968 can always use assistance!
2969 If you're interested in contributing to the Documentation Project,
2970 you need to do the following:
2973 \begin_layout Enumerate
2974 Get the latest \SpecialChar LyX
2976 \begin_inset Newline newline
2980 \begin_inset CommandInset href
2982 target "https://www.lyx.org/trac/browser/lyxgit/lib/doc?rev=master "
2989 \begin_layout Enumerate
2998 \change_inserted -1463541724 1692966436
3001 \SpecialChar endofsentence
3005 \begin_inset Newline newline
3008 The point of this exercise is to give you ideas.
3017 are likely to be the most up-to-date of all of the documentation.
3018 You should be able to glean some insights into how we want the manuals to read and to look.
3021 \begin_layout Enumerate
3022 Contact the team at:
3023 \begin_inset Newline newline
3027 \begin_inset CommandInset href
3029 target "lyx-docs@lists.lyx.org"
3036 \begin_inset Newline newline
3039 to discuss your intended changes and to get some feedback on them.
3042 \begin_layout Standard
3043 The changes you wish to make may range from improving clarity of the text,
3044 to doing major re-structuring of the documentation.
3045 Any and all improvements are gladly received.