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 false
111 \output_changes false
113 \postpone_fragile_content false
116 \html_be_strict false
117 \docbook_table_output 0
118 \docbook_mathml_prefix 1
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
326 \begin_inset Quotes erd
329 \SpecialChar endofsentence
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
465 \begin_inset Quotes eld
468 What You See Is What You
473 \begin_inset Quotes erd
477 It's a powerful idea that greatly simplifies the mechanics of writing documents.
478 This is also why \SpecialChar LyX
479 isn't so good for creating posters and flyers.
485 want to specify exactly where everything goes,
486 because there are no functional units like paragraphs,
489 This doesn't mean \SpecialChar LyX
490 is missing some cool function.
491 It simply means that it isn't the right tool for the job —
492 you don't use a screwdriver to drive in nails.
495 \begin_layout Subsection
496 Differences between \SpecialChar LyX
497 and Other Word Processors
500 \begin_layout Standard
501 Here's a list of things you won't find in \SpecialChar LyX
505 \begin_layout Itemize
509 \begin_layout Itemize
513 \begin_layout Itemize
515 \begin_inset space \thinspace{}
519 \begin_inset space \space{}
533 \begin_layout Standard
535 along with a ruler showing you the position of things on the page,
536 are useless in \SpecialChar LyX
538 The program worries about where things go on the page,
540 Extra whitespace is similar;
542 adds it where necessary,
543 depending on context.
544 Not being able to type two blank lines in a row will be annoying at first,
545 but it makes more sense once you're thinking in WYSIWYM terms.
548 \begin_layout Standard
549 Here are some things that exist in \SpecialChar LyX
551 but aren't used as you might think:
554 \begin_layout Itemize
558 \begin_layout Itemize
562 \begin_layout Itemize
564 \begin_inset space \thinspace{}
568 \begin_inset space \space{}
576 \begin_layout Itemize
578 horizontal and vertical
581 \begin_layout Itemize
585 \begin_layout Itemize
592 \begin_layout Standard
593 Although they exist in \SpecialChar LyX
595 you generally don't need them.
597 will take care of these things for you,
598 depending on what you're doing.
599 Different parts of the document are automatically set in a different typeface and font size.
600 Paragraph indenting is context dependent;
601 different types of paragraphs get indented differently.
602 Page breaks get handled automatically,
605 the space between lines,
607 and between paragraphs is variable,
608 set by \SpecialChar LyX
613 \begin_layout Plain Layout
614 There are ways to adjust all of these (only some of which require knowledge of \SpecialChar LaTeX
616 either for a whole document or for a specific location in a document.
633 \begin_layout Standard
635 there are a few areas where we believe \SpecialChar LyX
636 (and \SpecialChar LaTeX
637 ) surpasses many word processors:
640 \begin_layout Itemize
644 \begin_layout Itemize
648 \begin_layout Itemize
652 \begin_layout Itemize
656 \begin_layout Itemize
660 \begin_layout Standard
662 many modern word processors can handle mathematical symbols,
665 and many have moved towards style definitions and the WYSIWYM concept.
667 they've only recently been able to do so,
668 whereas \SpecialChar LyX
669 is built upon the \SpecialChar LaTeX
670 document preparation system.
672 has been around since 1985,
680 \begin_layout Subsection
681 What is \SpecialChar LaTeX
685 \begin_layout Standard
687 is a document preparation system designed by
695 \begin_layout Plain Layout
696 The source for the info in this section is
698 A Guide to \SpecialChar LaTeX2e
711 which has an entry in the bibliography of the
715 \SpecialChar endofsentence
721 It was built up from a typesetting language called \SpecialChar TeX
729 takes a sequence of typesetting commands,
730 written in a script in an ASCII file,
733 \begin_inset Quotes eld
737 \begin_inset Quotes erd
740 of the printing trade were modeled by
744 as computer algorithms and incorporated into \SpecialChar TeX
746 hence its excellent printed appearance.
747 What comes directly out of \SpecialChar TeX
749 \begin_inset Quotes eld
752 portable document format
753 \begin_inset Quotes erd
761 \begin_inset Quotes eld
765 \begin_inset Quotes erd
777 format is often used for previews and can later be converted to other formats like PostScript.
781 \begin_layout Standard
783 isn't only a typesetting engine;
784 it also allows you to define macros.
785 Most people who use \SpecialChar TeX
786 are actually using a macro package which
790 created to hide a lot of the typesetting details.
796 He wanted a macro package that was more user- and less typesetter-oriented,
797 with a set of commands that consistently typeset things like sections,
798 tables or math formulas in a uniform,
800 This is how \SpecialChar LaTeX
804 \begin_layout Standard
806 in parallel with the development and growth of \SpecialChar LaTeX
808 other folks were creating their own custom macro packages for \SpecialChar TeX
810 ones to make slides or articles for math journals and so on.
811 Some used the raw \SpecialChar TeX
812 facilities to do this,
813 others began modifying \SpecialChar LaTeX
815 To try and unify this mess,
816 a team of \SpecialChar LaTeX
817 -nicians began to work on \SpecialChar LaTeX2e
819 the current version of \SpecialChar LaTeX
821 during the late 1980's.
822 This new version of \SpecialChar LaTeX
823 has commands which provide an easier-to-use interface to \SpecialChar TeX
824 's macro-creating commands,
825 aid in the use of new fonts,
829 is quite an extensive language in its own right!
830 Users around the world have been creating their own add-ons for \SpecialChar LaTeX
831 beyond the standard ones.
834 \begin_layout Standard
835 There are two ways to extend \SpecialChar LaTeX
842 is a set of \SpecialChar LaTeX
843 macros describing a new type of document,
846 There are classes for slides,
847 for physics and math journals\SpecialChar ldots
848 many universities even have a class for their thesis format.
853 differs from a class in that it doesn't define a new type of document,
854 but a different type of
858 that any document can use.
861 controls page margins and line spacing using two different \SpecialChar LaTeX
862 style-files designed for these purposes.
863 There are style-files for a whole slew of things:
864 printing labels or envelopes,
865 changing indentation behavior,
867 manipulating graphics,
868 designing fancy page headings,
869 customizing bibliographies,
870 altering the location and appearance of footnotes,
877 \begin_layout Standard
881 \begin_layout Description
884 Typesetting language with macro capability.
887 \begin_layout Description
890 Macro package built upon \SpecialChar TeX
891 \SpecialChar endofsentence
895 \begin_layout Description
897 Descriptions of types of document used with \SpecialChar LaTeX
898 \SpecialChar endofsentence
902 \begin_layout Description
904 Descriptions of the default behavior of particular elements of \SpecialChar LaTeX
908 \begin_layout Description
912 WYSIWYM document processor that uses \SpecialChar LaTeX
913 to do its typesetting.
916 \begin_layout Standard
917 This section attempts to explain the difference between \SpecialChar LyX
918 and a word processor.
922 By using \SpecialChar LaTeX
925 helps you to think more about
934 The computer then handles
941 \begin_layout Section
942 Navigating the Documentation
945 \begin_layout Standard
946 To make it easier to answer your questions and describe all of the features of \SpecialChar LyX
948 the documentation has been split up into several different files.
949 Each one has its own purpose,
951 Before you go ploughing into any of those files,
953 you should read this section thoroughly,
954 since it contains a lot of useful information and commentary that can save you some time.
957 \begin_layout Standard
959 the development of \SpecialChar LyX
961 so some of the documentation may be incomplete or a bit out of date,
962 though we try to keep up-to-date.
963 Like the rest of \SpecialChar LyX
965 the manuals are the work of a group of volunteers who have
966 \begin_inset Quotes eld
970 \begin_inset Quotes erd
981 If you want to help out,
982 be sure to read Section
987 \begin_inset CommandInset ref
989 reference "sec:Contrib"
994 in addition to the rest of this document.
997 \begin_layout Standard
999 please do us a favor:
1000 if anything in these manuals confuses you,
1003 don't hesitate to let us know!
1004 You can reach the current documentation maintainers by emailing
1005 \begin_inset CommandInset href
1007 target "lyx-docs@lists.lyx.org"
1016 \begin_layout Subsection
1020 \begin_layout Standard
1021 If you have questions that are not obviously answered in the documentation and need help fast,
1022 there is an active users' mailing list which you can reach at
1023 \begin_inset CommandInset href
1025 target "lyx-users@lists.lyx.org"
1032 You do not have to register to post,
1033 but you may wish to do so.
1035 \begin_inset CommandInset href
1037 name "the LyX website"
1038 target "https://www.lyx.org/MailingLists"
1043 for further information.
1045 \begin_inset CommandInset href
1047 target "http://wiki.lyx.org/"
1052 that will answer many questions about how to get LyX to do various things.
1055 \begin_layout Subsection
1056 The Format of the Manuals
1059 \begin_layout Standard
1060 Some of you may have printed out the manuals.
1061 Others may be reading them within \SpecialChar LyX
1063 There are some differences between the \SpecialChar LyX
1064 -file and the printed version.
1067 the title is simply at the top of the document,
1068 not formatted on a separate page as in some of the printed versions.
1069 Nor are any of the footnotes or the Table of Contents fully visible.
1071 which looks like this:
1073 \begin_inset Graphics
1074 filename clipart/footnote.png
1080 click on it with the left mouse button.
1081 For the Table of Contents,
1082 either click on the grey box or click on the
1087 where the contents are displayed automatically\SpecialChar endofsentence
1091 \begin_layout Standard
1092 In the printed manuals,
1093 all cross-references appear as the actual numbers for a chapter,
1097 In the \SpecialChar LyX
1100 all cross-references appear as light-grey boxes like the following:
1102 \begin_inset Graphics
1103 filename clipart/reference.png
1109 If you click on such a box with the left mouse button,
1110 a dialog box will appear containing a list of all the cross-references in the document.
1111 You can go to the referenced element by right-clicking on the box or by clicking the button
1114 \begin_inset space ~
1118 \begin_inset space ~
1123 in the opened dialog.
1124 Going back to where you came from is just as easy.
1128 \begin_inset space ~
1133 to go back to your earlier location.
1136 \begin_layout Standard
1137 Now that we've cleared up some of the differences between the printed and \SpecialChar LyX
1138 -file versions of this file,
1139 we can start looking at the format of this document.
1140 You'll occasionally notice things in different fonts:
1143 \begin_layout Itemize
1148 is used for general emphasis,
1150 book and manual titles,
1151 names of sections of other manuals,
1152 and notes from the authors.
1155 \begin_layout Itemize
1160 is used for program and file names,
1165 \begin_layout Itemize
1171 button or dialog box names,
1172 and the names of keyboard keys.
1175 \begin_layout Itemize
1180 is used for people's names.
1183 \begin_layout Itemize
1188 is used for \SpecialChar LaTeX
1192 \begin_layout Standard
1193 When we do need to reference keys,
1194 we'll use the following prefixing convention:
1197 \begin_layout Itemize
1209 \begin_layout Itemize
1221 \begin_layout Itemize
1237 \begin_layout Itemize
1247 are the function keys.
1250 \begin_layout Itemize
1258 \begin_layout Itemize
1281 \begin_layout Itemize
1312 \begin_inset space ~
1315 keys that appear above the cursor keys on many PC keyboards.
1335 \begin_layout Itemize
1344 both refer to the same key.
1345 Some keyboards label the
1350 \begin_inset Quotes eld
1354 \begin_inset Quotes erd
1359 \begin_inset Quotes eld
1363 \begin_inset Quotes erd
1367 still others have two keys.
1369 treats all of them as the same key,
1381 \begin_layout Standard
1382 The list with the currently set shortcuts can be found in the
1393 \begin_layout Subsection
1394 Units used in the Manuals
1397 \begin_layout Standard
1398 To understand the units described in this documentation,
1400 \begin_inset space ~
1404 \begin_inset CommandInset ref
1406 reference "tab:Units"
1411 explains all units available in \SpecialChar LyX
1415 \begin_layout Standard
1416 \begin_inset Float table
1423 \begin_layout Plain Layout
1424 \begin_inset Caption Standard
1426 \begin_layout Plain Layout
1427 \begin_inset CommandInset label
1441 \begin_layout Plain Layout
1442 \begin_inset VSpace medskip
1448 \begin_layout Plain Layout
1450 \begin_inset Tabular
1451 <lyxtabular version="3" rows="20" columns="2">
1452 <features booktabs="true" tabularvalignment="middle">
1453 <column alignment="center" valignment="top" width="0pt">
1454 <column alignment="center" valignment="top">
1456 <cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
1459 \begin_layout Plain Layout
1465 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1468 \begin_layout Plain Layout
1476 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1479 \begin_layout Plain Layout
1485 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1488 \begin_layout Plain Layout
1496 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1499 \begin_layout Plain Layout
1505 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1508 \begin_layout Plain Layout
1516 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1519 \begin_layout Plain Layout
1525 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1528 \begin_layout Plain Layout
1530 \begin_inset space \thinspace{}
1534 \begin_inset space \thinspace{}
1544 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1547 \begin_layout Plain Layout
1553 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1556 \begin_layout Plain Layout
1558 \begin_inset space \thinspace{}
1562 \begin_inset space \thinspace{}
1572 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1575 \begin_layout Plain Layout
1581 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1584 \begin_layout Plain Layout
1586 \begin_inset space \thinspace{}
1590 \begin_inset space \thinspace{}
1600 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1603 \begin_layout Plain Layout
1609 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1612 \begin_layout Plain Layout
1614 \begin_inset space \thinspace{}
1618 \begin_inset space \thinspace{}
1628 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1631 \begin_layout Plain Layout
1637 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1640 \begin_layout Plain Layout
1642 \begin_inset space \thinspace{}
1646 \begin_inset space \thinspace{}
1656 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1659 \begin_layout Plain Layout
1665 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1668 \begin_layout Plain Layout
1670 \begin_inset space \thinspace{}
1674 \begin_inset Formula $\approx$
1678 \begin_inset space \thinspace{}
1688 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1691 \begin_layout Plain Layout
1697 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1700 \begin_layout Plain Layout
1702 \begin_inset space \thinspace{}
1706 \begin_inset space \thinspace{}
1716 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1719 \begin_layout Plain Layout
1725 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1728 \begin_layout Plain Layout
1729 % of original image width
1736 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1739 \begin_layout Plain Layout
1745 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1748 \begin_layout Plain Layout
1756 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1759 \begin_layout Plain Layout
1765 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1768 \begin_layout Plain Layout
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
1796 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1799 \begin_layout Plain Layout
1805 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1808 \begin_layout Plain Layout
1816 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1819 \begin_layout Plain Layout
1825 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1828 \begin_layout Plain Layout
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
1856 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1859 \begin_layout Plain Layout
1865 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1868 \begin_layout Plain Layout
1880 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1883 \begin_layout Plain Layout
1889 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1892 \begin_layout Plain Layout
1904 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1907 \begin_layout Plain Layout
1913 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1916 \begin_layout Plain Layout
1918 \begin_inset space \thinspace{}
1922 \begin_inset space \thinspace{}
1943 \begin_layout Subsection
1947 \begin_layout Standard
1948 The following list describes the contents of the basic documentation files that you find in the
1955 \begin_layout Description
1956 Introduction This file.
1959 \begin_layout Description
1960 Tutorial If you are new to \SpecialChar LyX
1962 and have never used \SpecialChar LaTeX
1964 you should start here.
1965 If you have used \SpecialChar LaTeX
1967 you should still read the
1972 starting with the section on
1975 for \SpecialChar LaTeX
1979 (Skimming through the rest of the document wouldn't hurt,
1983 \begin_layout Description
1985 \begin_inset space ~
1988 Guide The primary documentation.
1993 of the basic operation and available features of \SpecialChar LyX
1995 The main manual assumes that you have read the
2002 \begin_layout Description
2004 \begin_inset space ~
2007 Objects Extension of the
2012 Documents in detail how to use tables,
2016 program listings and boxes.
2017 It also includes many tricks of the \SpecialChar LaTeX
2021 \begin_layout Description
2022 Math Extension of the
2027 Documents in detail how to typeset any kind of formula.
2030 \begin_layout Description
2032 \begin_inset space ~
2035 Features Extension of the
2040 Documents how to use raw \SpecialChar LaTeX
2042 additional layouts and special-purpose editing features.
2045 \begin_layout Description
2046 Customization A description of advanced \SpecialChar LyX
2048 including how to customize the overall behavior of \SpecialChar LyX
2049 \SpecialChar endofsentence
2050 This includes such things as keybindings,
2051 internationalization and configuration files.
2052 It also includes information about layout files,
2053 which are needed to get \SpecialChar LyX
2054 to support \SpecialChar LaTeX
2055 classes or packages.
2058 \begin_layout Description
2059 Shortcuts Tables of the currently defined \SpecialChar LyX
2063 \begin_layout Description
2066 \begin_inset space ~
2069 Configuration A report produced by \SpecialChar LyX
2071 This file contains information on what \SpecialChar LyX
2072 learned about your installation.
2073 Check it to see if you're missing something you might like to have.
2076 \begin_layout Standard
2077 These files will reference one another as necessary.
2087 information on installation and customization,
2088 but refers the reader to the
2092 manual for more information.
2095 \begin_layout Standard
2096 We'll state again an important point:
2099 \begin_layout Standard
2100 \begin_inset VSpace bigskip
2106 \begin_layout Standard
2108 If you are new to \SpecialChar LyX
2115 Now\SpecialChar endofsentence
2119 \begin_layout Standard
2120 \begin_inset VSpace bigskip
2126 \begin_layout Standard
2128 you could needlessly frustrate yourself.
2131 \begin_layout Section
2132 Contributing to the \SpecialChar LyX
2134 \begin_inset CommandInset label
2143 \begin_layout Subsection
2144 Contributing to \SpecialChar LyX
2148 \begin_layout Standard
2150 is mostly written in C++ (the \SpecialChar LaTeX
2151 importer is written in Python).
2152 It is a large project,
2153 and as a result it is not free from bugs,
2154 or the need for improvements in the source code.
2157 \begin_layout Subsubsection
2161 \begin_layout Standard
2162 While using \SpecialChar LyX
2164 you may find behavior which you consider a bug.
2168 User interface problems are considered major bugs by the \SpecialChar LyX
2170 especially helpful are indications of parts of the \SpecialChar LyX
2171 interface you find confusing,
2175 \begin_layout Standard
2177 has a bug tracking system,
2178 which you can find at
2179 \begin_inset Newline newline
2183 \begin_inset CommandInset href
2185 target "https://www.lyx.org/trac/wiki/BugTrackerHome"
2190 You should check the bug tracker before reporting any bugs,
2191 in case it has already been reported.
2192 If you have a comment on an existing bug,
2193 or wish to report a new bug,
2194 you may either use the bug tracker,
2195 or send an e-mail to the development mailing list,
2197 \begin_inset CommandInset href
2199 target "lyx-devel@lists.lyx.org"
2206 Archives of this list are linked from the main \SpecialChar LyX
2209 \begin_inset CommandInset href
2211 target "https://www.lyx.org/MailingLists"
2219 \begin_layout Standard
2220 A useful bug report will at a minimum include the version of \SpecialChar LyX
2221 you are having the problem with.
2223 detailed descriptions are preferred —
2224 the more time developers have to spend to pinpoint the source of a bug,
2225 the less time they have for other improvements.
2226 Mention the system and system version on which you are running \SpecialChar LyX
2228 Give the versions of the libraries you have installed on your system,
2231 the versions of external programs that \SpecialChar LyX
2233 If it's a compilation or configuration problem,
2239 and mention which compiler you are using.
2240 Part of this information can be found in
2242 Help\SpecialChar menuseparator
2248 \begin_layout Subsubsection
2249 Contributing fixes and new features
2252 \begin_layout Standard
2253 If you have made changes to \SpecialChar LyX
2254 's source that you think should become part of \SpecialChar LyX
2256 send your changes as a diff file (in unified format) to the development list referenced above,
2257 along with a change log,
2258 and a description of what your patch does.
2261 \begin_layout Subsection
2262 Contributing to the Documentation
2265 \begin_layout Standard
2267 's documentation is extensive;
2268 however \SpecialChar LyX
2269 is under constant development,
2270 and each new release adds new features.
2271 You may find some documentation needs improvement.
2272 This section describes what to do if you find an error,
2273 or have some suggestions for improving the documentation.
2276 \begin_layout Subsubsection
2277 Reporting Errors in the Manuals
2280 \begin_layout Standard
2281 If you find a problem with the documentation,
2282 send a message to the mailing list
2283 \begin_inset CommandInset href
2285 target "lyx-docs@lists.lyx.org"
2292 The documentation team will make any necessary fixes.
2295 \begin_layout Subsubsection
2296 Joining the Documentation Team.
2299 \begin_layout Standard
2300 The \SpecialChar LyX
2301 Documentation Project,
2302 like anything else in the \SpecialChar LyX
2304 can always use assistance!
2305 If you're interested in contributing to the Documentation Project,
2306 you need to do the following:
2309 \begin_layout Enumerate
2310 Get the latest \SpecialChar LyX
2312 \begin_inset Newline newline
2316 \begin_inset CommandInset href
2318 target "https://www.lyx.org/trac/browser/lyxgit/lib/doc?rev=master "
2325 \begin_layout Enumerate
2335 \SpecialChar endofsentence
2337 \begin_inset Newline newline
2340 The point of this exercise is to give you ideas.
2349 are likely to be the most up-to-date of all of the documentation.
2350 You should be able to glean some insights into how we want the manuals to read and to look.
2353 \begin_layout Enumerate
2354 Contact the team at:
2355 \begin_inset Newline newline
2359 \begin_inset CommandInset href
2361 target "lyx-docs@lists.lyx.org"
2368 \begin_inset Newline newline
2371 to discuss your intended changes and to get some feedback on them.
2374 \begin_layout Standard
2375 The changes you wish to make may range from improving clarity of the text,
2376 to doing major re-structuring of the documentation.
2377 Any and all improvements are gladly received.