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
42 \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
108 \tracking_changes false
109 \postpone_fragile_content false
110 \output_changes false
113 \html_be_strict false
119 Introduction to \SpecialChar LyX
124 by the \SpecialChar LyX
129 \begin_layout Plain Layout
131 If you have comments on or corrections to this documentation, please send
132 them to the \SpecialChar LyX
133 Documentation mailing list:
134 \begin_inset CommandInset href
136 target "lyx-docs@lists.lyx.org"
150 \begin_layout Standard
151 \begin_inset CommandInset toc
152 LatexCommand tableofcontents
159 \begin_layout Section
160 The Philosophy of \SpecialChar LyX
164 \begin_layout Subsection
165 What is \SpecialChar LyX
169 \begin_layout Standard
171 is a document preparation system.
172 It excels at letting you create complex technical and scientific articles
173 with mathematics, cross-references, bibliographies, indexes, etc.
174 It is very good for working with documents of any length in which the usual
175 processing abilities are required: automatic sectioning and pagination,
176 spell checking and so forth.
177 It can also be used to write a letter to your mom, though granted, there
178 are probably simpler programs available for that.
179 It is definitely not the best tool for creating banners, flyers, or advertiseme
180 nts (we'll explain why later), though with some effort all these can be
182 Here are some examples of what it is used for: memos, letters, dissertations
183 and theses, lecture notes, seminar notebooks, conference proceedings, software
184 documentation, books, articles in refereed scientific journals, scripts
185 for plays and movies, business proposals, presentations \SpecialChar ldots
189 \begin_layout Standard
191 is a program that provides a modern approach to writing documents with
192 a computer by using a markup language paradigm, an approach that breaks
193 with the obsolete tradition of the
194 \begin_inset Quotes eld
198 \begin_inset Quotes erd
202 It is designed for authors who want professional output quickly with a
203 minimum of effort and without becoming specialists in typesetting.
204 The job of typesetting is done mostly by the computer, not the author;
205 with \SpecialChar LyX
206 , the author can concentrate on the contents of his writing.
209 \begin_layout Standard
210 Part of the initial challenge of using \SpecialChar LyX
211 comes from the change in thinking
212 that you, the user, must make.
213 At one time, all we had for creating documents were typewriters, so we
214 all learned certain tricks to get around their limitations.
215 Underlining, which is little more than overstriking with the
216 \begin_inset Quotes eld
220 \begin_inset Quotes erd
223 character, became a way to emphasize text.
224 You were forced to figure out column sizes and tab stops, and set them,
225 before creating a table.
226 The same applied for letters and other right justified text.
227 Hyphenation at the end of a line required a careful eye and a lot of foresight.
230 \begin_layout Standard
231 In other words, we've all been trained to worry about the little details
232 of which character goes where.
233 Consequently, almost all word processors have this mentality.
234 They still use tab stops for adding whitespace.
235 You still need to worry about exactly where on the page something will
237 Emphasizing text means changing a font, similar to changing the typewriter
239 This is the underlying philosophy of a WYSIWYG word processor:
240 \begin_inset Quotes eld
243 What You See Is What You Get
244 \begin_inset Quotes erd
248 Unfortunately, that paradigm often results in
249 \begin_inset Quotes eld
252 What You See Is All You Get
253 \begin_inset Quotes erd
259 \begin_layout Standard
260 This is where \SpecialChar LyX
261 differs from an ordinary word processor.
262 You don't concern yourself with what character goes where.
263 You tell \SpecialChar LyX
269 takes care of the rest, following a set of rules called a
277 \begin_layout Plain Layout
278 To be fair, most recent versions of the most popular office suites now have
279 some sort of style sheets which follow a similar markup method.
280 However, our experience is that they are still rarely used in practice.
285 Let's look at a little example:
288 \begin_layout Standard
289 Suppose you are writing a report.
290 To begin your report, you want a section called
291 \begin_inset Quotes eld
294 Introduction\SpecialChar endofsentence
296 \begin_inset Quotes erd
299 So, you go into whatever menu it is in your word processor that changes
300 font sizes and decide on a new font size.
301 Then you turn on bold face.
303 \begin_inset Quotes eld
315 \begin_inset Quotes erd
319 Of course, if you later decide that this section belongs someplace else
320 in the document or if you insert a new section before it, you need to change
321 the numbering for this and all following sections, as well as any entry
322 in the table of contents.
325 \begin_layout Standard
327 , you go to the pull-down on the far left of the button bar and select
333 \begin_inset Quotes eld
337 \begin_inset Quotes erd
343 \begin_layout Standard
345 If you cut and paste the section, it will automatically be renumbered —
347 And if you enter references to that section correctly (by inserting cross-refer
348 ence tags), \SpecialChar LyX
349 will automatically update them all throughout the file so that
350 you never, ever type a section number.
353 \begin_layout Standard
354 Now let's look at the problem of consistency.
355 Five days later, you reopen your report and start Section
360 However, you forget that you were using 18
361 \begin_inset space \thinspace{}
364 pt bold instead of 16
365 \begin_inset space \thinspace{}
368 pt, so you type in the heading for Section
372 4 in a different font from the one you used for Section
377 That problem doesn't even exist in \SpecialChar LyX
379 The computer takes care of all that silly bookkeeping about which thing
380 has what size font, not you.
381 After all, that's what a computer is good at.
384 \begin_layout Standard
385 Here's another example.
386 Suppose you're making a list.
387 In other word processors, a list is just a bunch of tab stops and newlines.
388 You need to figure out where to put the label for each list item, what
389 that label should be, how many blank lines to put between each item, and
391 Under \SpecialChar LyX
392 , you have only two concerns: what kind of list is this, and what
393 do I want to put in it? That is it.
396 \begin_layout Standard
397 So, the basic idea behind \SpecialChar LyX
408 \begin_inset Quotes eld
411 What You See Is What You Get,
412 \begin_inset Quotes erd
417 \begin_inset Quotes eld
420 What You See Is What You
425 \begin_inset Quotes erd
429 \begin_inset Quotes eld
433 \begin_inset Quotes erd
436 It's a powerful idea that greatly simplifies the mechanics of writing documents.
437 This is also why \SpecialChar LyX
438 isn't so good for creating posters and flyers.
443 want to specify exactly where everything goes, because there are no functional
444 units like paragraphs, sections, etc.
445 This doesn't mean \SpecialChar LyX
446 is missing some cool function.
447 It simply means that it isn't the right tool for the job — you don't use
448 a screwdriver to drive in nails.
451 \begin_layout Subsection
452 Differences between \SpecialChar LyX
453 and Other Word Processors
456 \begin_layout Standard
457 Here's a list of things you won't find in \SpecialChar LyX
461 \begin_layout Itemize
465 \begin_layout Itemize
469 \begin_layout Itemize
471 \begin_inset space \thinspace{}
475 \begin_inset space \space{}
489 \begin_layout Standard
490 Tab stops, along with a ruler showing you the position of things on the
491 page, are useless in \SpecialChar LyX
493 The program worries about where things go on the page, not you.
494 Extra whitespace is similar; \SpecialChar LyX
495 adds it where necessary, depending on context.
496 Not being able to type two blank lines in a row will be annoying at first,
497 but it makes more sense once you're thinking in WYSIWYM terms.
500 \begin_layout Standard
501 Here are some things that exist in \SpecialChar LyX
502 , but aren't used as you might think:
505 \begin_layout Itemize
509 \begin_layout Itemize
513 \begin_layout Itemize
515 \begin_inset space \thinspace{}
519 \begin_inset space \space{}
522 single spaced, double spaced, etc.)
525 \begin_layout Itemize
526 Whitespace, horizontal and vertical
529 \begin_layout Itemize
533 \begin_layout Itemize
534 Typefaces (bold, italic, underline, etc.)
537 \begin_layout Standard
538 Although they exist in \SpecialChar LyX
539 , you generally don't need them.
541 will take care of these things for you, depending on what you're doing.
542 Different parts of the document are automatically set in a different typeface
544 Paragraph indenting is context dependent; different types of paragraphs
545 get indented differently.
546 Page breaks get handled automatically, as well.
547 In general, the space between lines, between words, and between paragraphs
548 is variable, set by \SpecialChar LyX
553 \begin_layout Plain Layout
554 There are ways to adjust all of these (only some of which require knowledge
555 of \SpecialChar LaTeX
556 ), either for a whole document or for a specific location in a document.
573 \begin_layout Standard
574 Lastly, there are a few areas where we believe \SpecialChar LyX
575 (and \SpecialChar LaTeX
576 ) surpasses many word
580 \begin_layout Itemize
584 \begin_layout Itemize
588 \begin_layout Itemize
592 \begin_layout Itemize
596 \begin_layout Itemize
600 \begin_layout Standard
601 Granted, many modern word processors can handle mathematical symbols, tables,
602 and hyphenation, and many have moved towards style definitions and the
604 However, they've only recently been able to do so, whereas \SpecialChar LyX
606 the \SpecialChar LaTeX
607 document preparation system.
609 has been around since 1985, and
616 \begin_layout Subsection
617 What is \SpecialChar LaTeX
621 \begin_layout Standard
623 is a document preparation system designed by Leslie Lamport in 1985.
627 \begin_layout Plain Layout
628 The source for the info in this section is
630 A Guide to \SpecialChar LaTeX2e
633 , by Helmut Kopka and Patrick Daly, which has an entry in the bibliography
638 \SpecialChar endofsentence
644 It was built up from a typesetting language called \SpecialChar TeX
648 takes a sequence of typesetting commands, written in a script in an ASCII
649 file, and executes them.
651 \begin_inset Quotes eld
655 \begin_inset Quotes erd
658 of the printing trade were modeled by Knuth as computer algorithms and
659 incorporated into \SpecialChar TeX
660 , hence its excellent printed appearance.
661 What comes directly out of \SpecialChar TeX
662 is the portable document format
667 \begin_inset Quotes eld
671 \begin_inset Quotes erd
679 The dvi format is often used for previews and can later be converted to
680 other formats like PostScript.
684 \begin_layout Standard
686 isn't only a typesetting engine; it also allows you to define macros.
687 Most people who use \SpecialChar TeX
688 are actually using a macro package which Knuth created
689 to hide a lot of the typesetting details.
690 This is where Leslie Lamport enters our story.
691 He wanted a macro package that was more user- and less typesetter-oriented,
692 with a set of commands that consistently typeset things like sections,
693 tables or math formulas in a uniform, consistent fashion.
694 This is how \SpecialChar LaTeX
698 \begin_layout Standard
699 Now, in parallel with the development and growth of \SpecialChar LaTeX
700 , other folks were creating
701 their own custom macro packages for \SpecialChar TeX
702 , ones to make slides or articles for
703 math journals and so on.
704 Some used the raw \SpecialChar TeX
705 facilities to do this, others began modifying \SpecialChar LaTeX
707 To try and unify this mess, a team of \SpecialChar LaTeX
708 -nicians began to work on \SpecialChar LaTeX2e
710 version of \SpecialChar LaTeX
711 , during the late 1980's.
712 This new version of \SpecialChar LaTeX
713 has commands which provide an easier-to-use interface
715 's macro-creating commands, aid in the use of new fonts, and so on.
716 In fact, \SpecialChar LaTeX
717 is quite an extensive language in its own right! Users around
718 the world have been creating their own add-ons for \SpecialChar LaTeX
723 \begin_layout Standard
724 There are two ways to extend \SpecialChar LaTeX
725 : classes and styles.
730 is a set of \SpecialChar LaTeX
731 macros describing a new type of document, like a book, or
733 There are classes for slides, for physics and math journals\SpecialChar ldots
735 even have a class for their thesis format.
740 differs from a class in that it doesn't define a new type of document,
741 but a different type of
745 that any document can use.
746 For example, \SpecialChar LyX
747 controls page margins and line spacing using two different
749 style-files designed for these purposes.
750 There are style-files for a whole slew of things: printing labels or envelopes,
751 changing indentation behavior, adding new fonts, manipulating graphics,
752 designing fancy page headings, customizing bibliographies, altering the
753 location and appearance of footnotes, tables, and figures, customizing
757 \begin_layout Standard
761 \begin_layout Description
763 : Typesetting language with macro capability.
766 \begin_layout Description
768 : Macro package built upon \SpecialChar TeX
769 \SpecialChar endofsentence
773 \begin_layout Description
774 classes: Descriptions of types of document used with \SpecialChar LaTeX
775 \SpecialChar endofsentence
779 \begin_layout Description
780 styles: Descriptions of the default behavior of particular elements of \SpecialChar LaTeX
784 \begin_layout Description
786 : Visual, WYSIWYM document processor that uses \SpecialChar LaTeX
787 to do its typesetting.
790 \begin_layout Standard
791 This section attempts to explain the difference between \SpecialChar LyX
792 and a word processor.
793 Simply put, \SpecialChar LaTeX
795 By using \SpecialChar LaTeX
796 as its backend, \SpecialChar LyX
797 helps you to think more about
806 The computer then handles
813 \begin_layout Section
814 Navigating the Documentation
817 \begin_layout Standard
818 To make it easier to answer your questions and describe all of the features
820 , the documentation has been split up into several different files.
821 Each one has its own purpose, as described below.
822 Before you go ploughing into any of those files, however, you should read
823 this chapter thoroughly, since it contains a lot of useful information
824 and commentary that can save you some time.
827 \begin_layout Standard
828 Hopefully, the development of \SpecialChar LyX
829 will never stop; so some of the documentation
830 may be incomplete or a bit out of date, though we try to keep up-to-date.
831 Like the rest of \SpecialChar LyX
832 , the manuals are the work of a group of volunteers who
834 \begin_inset Quotes eld
838 \begin_inset Quotes erd
841 , families, dishes to clean,
846 If you want to help out, be sure to read Section
851 \begin_inset CommandInset ref
853 reference "sec:Contrib"
857 in addition to the rest of this document.
860 \begin_layout Standard
861 Also, please do us a favor – if anything in these manuals confuses you,
862 is unclear, or wrong, don't hesitate to let us know! You can reach the
863 current document maintainers by emailing
864 \begin_inset CommandInset href
866 target "lyx-docs@lists.lyx.org"
873 If you have questions that are not obviously answered in the documentation,
874 and need help fast, there is an active users' mailing list which you can
876 \begin_inset CommandInset href
878 target "lyx-users@lists.lyx.org"
887 \begin_layout Subsection
888 The Format of the Manuals
891 \begin_layout Standard
892 Some of you may have printed out the manuals.
893 Others may be reading them within \SpecialChar LyX
895 There are some differences between the \SpecialChar LyX
896 -file and the printed version.
898 , the title is simply at the top of the document, not formatted on a
899 separate page as in some of the printed versions.
900 Nor are any of the footnotes or the Table of Contents fully visible.
901 To open a footnote, which looks like this:
902 \begin_inset Graphics
903 filename clipart/footnote.png
908 , click on it with the left mouse button.
909 For the Table of Contents, either click on the grey box or click on the
914 menu, where the contents are displayed automatically\SpecialChar endofsentence
918 \begin_layout Standard
919 In the printed manuals, all cross-references appear as the actual numbers
920 for a chapter, section, subsection, and so on.
921 In the \SpecialChar LyX
922 -file, however, all cross-references appear as light-grey boxes
924 \begin_inset Graphics
925 filename clipart/reference.png
931 If you click on such a box with the left mouse button, a dialog box will
932 appear containing a list of all the cross-references in the document.
933 You can go to the referenced section by right-clicking on the box or by
946 in the opened dialog.
947 Going back to where you came from is just as easy.
956 to go back to your earlier location.
959 \begin_layout Standard
960 Now that we've cleared up some of the differences between the printed and
962 -file versions of this file, we can start looking at the format of this
964 You'll occasionally notice things in different fonts:
967 \begin_layout Itemize
972 is used for general emphasis, generic arguments, book titles, names of
973 sections of other manuals, and notes from the authors.
976 \begin_layout Itemize
981 is used for program and file names, \SpecialChar LyX
985 \begin_layout Itemize
990 is used for menu, button, or dialog box names, and the names of keyboard
994 \begin_layout Itemize
999 is used for people's names.
1002 \begin_layout Itemize
1007 is used for \SpecialChar LaTeX
1011 \begin_layout Standard
1012 When we do need to reference keys, we'll use the following prefixing convention:
1015 \begin_layout Itemize
1016 \begin_inset Quotes eld
1024 \begin_inset Quotes erd
1034 \begin_layout Itemize
1035 \begin_inset Quotes eld
1043 \begin_inset Quotes erd
1053 \begin_layout Itemize
1054 \begin_inset Quotes eld
1062 \begin_inset Quotes erd
1076 \begin_layout Itemize
1077 \begin_inset Quotes eld
1085 \begin_inset Quotes erd
1090 \begin_inset Quotes eld
1098 \begin_inset Quotes erd
1101 are the function keys.
1104 \begin_layout Itemize
1105 \begin_inset Quotes eld
1113 \begin_inset Quotes erd
1119 \begin_layout Itemize
1120 \begin_inset Quotes eld
1128 \begin_inset Quotes erd
1132 \begin_inset Quotes eld
1140 \begin_inset Quotes erd
1144 \begin_inset Quotes eld
1152 \begin_inset Quotes erd
1156 \begin_inset Quotes eld
1164 \begin_inset Quotes erd
1170 \begin_layout Itemize
1173 \begin_inset Quotes eld
1179 \begin_inset Quotes erd
1183 \begin_inset Quotes eld
1191 \begin_inset Quotes erd
1195 \begin_inset Quotes eld
1203 \begin_inset Quotes erd
1207 \begin_inset Quotes eld
1215 \begin_inset Quotes erd
1219 \begin_inset Quotes eld
1227 \begin_inset Quotes erd
1231 \begin_inset Quotes eld
1239 \begin_inset Quotes erd
1243 \begin_inset space ~
1246 keys that appear above the cursor keys on many PC keyboards.
1248 \begin_inset Quotes eld
1256 \begin_inset Quotes erd
1260 \begin_inset Quotes eld
1268 \begin_inset Quotes erd
1272 \begin_inset Quotes eld
1280 \begin_inset Quotes erd
1284 \begin_inset Quotes eld
1292 \begin_inset Quotes erd
1298 \begin_layout Itemize
1307 both refer to the same key.
1308 Some keyboards label the
1313 \begin_inset Quotes eld
1317 \begin_inset Quotes erd
1321 \begin_inset Quotes eld
1325 \begin_inset Quotes erd
1328 still others have two keys.
1330 treats all of them as the same key, so we'll use
1341 \begin_layout Standard
1342 The list with the currently set shortcuts can be found in the
1353 \begin_layout Subsection
1354 Units used in the Manuals
1357 \begin_layout Standard
1358 To understand the units described in this documentation, Table
1359 \begin_inset space ~
1363 \begin_inset CommandInset ref
1365 reference "tab:Units"
1369 explains all units available in \SpecialChar LyX
1373 \begin_layout Standard
1374 \begin_inset Float table
1379 \begin_layout Plain Layout
1380 \begin_inset Caption Standard
1382 \begin_layout Plain Layout
1383 \begin_inset CommandInset label
1397 \begin_layout Plain Layout
1398 \begin_inset VSpace medskip
1404 \begin_layout Plain Layout
1406 \begin_inset Tabular
1407 <lyxtabular version="3" rows="20" columns="2">
1408 <features booktabs="true" tabularvalignment="middle">
1409 <column alignment="center" valignment="top" width="0pt">
1410 <column alignment="center" valignment="top">
1412 <cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
1415 \begin_layout Plain Layout
1421 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1424 \begin_layout Plain Layout
1432 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1435 \begin_layout Plain Layout
1441 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1444 \begin_layout Plain Layout
1452 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1455 \begin_layout Plain Layout
1461 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1464 \begin_layout Plain Layout
1472 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1475 \begin_layout Plain Layout
1481 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1484 \begin_layout Plain Layout
1486 \begin_inset space \thinspace{}
1490 \begin_inset space \thinspace{}
1500 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1503 \begin_layout Plain Layout
1509 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1512 \begin_layout Plain Layout
1514 \begin_inset space \thinspace{}
1518 \begin_inset space \thinspace{}
1528 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1531 \begin_layout Plain Layout
1537 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1540 \begin_layout Plain Layout
1542 \begin_inset space \thinspace{}
1546 \begin_inset space \thinspace{}
1556 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1559 \begin_layout Plain Layout
1565 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1568 \begin_layout Plain Layout
1570 \begin_inset space \thinspace{}
1574 \begin_inset space \thinspace{}
1584 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1587 \begin_layout Plain Layout
1593 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1596 \begin_layout Plain Layout
1598 \begin_inset space \thinspace{}
1602 \begin_inset space \thinspace{}
1612 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1615 \begin_layout Plain Layout
1621 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1624 \begin_layout Plain Layout
1626 \begin_inset space \thinspace{}
1630 \begin_inset Formula $\approx$
1634 \begin_inset space \thinspace{}
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
1658 \begin_inset space \thinspace{}
1662 \begin_inset space \thinspace{}
1672 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1675 \begin_layout Plain Layout
1681 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1684 \begin_layout Plain Layout
1685 % of original image width
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
1712 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1715 \begin_layout Plain Layout
1721 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1724 \begin_layout Plain Layout
1732 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1735 \begin_layout Plain Layout
1741 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1744 \begin_layout Plain Layout
1752 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1755 \begin_layout Plain Layout
1761 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1764 \begin_layout Plain Layout
1772 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1775 \begin_layout Plain Layout
1781 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1784 \begin_layout Plain Layout
1792 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1795 \begin_layout Plain Layout
1801 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1804 \begin_layout Plain Layout
1812 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1815 \begin_layout Plain Layout
1821 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1824 \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
1860 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1863 \begin_layout Plain Layout
1869 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1872 \begin_layout Plain Layout
1874 \begin_inset space \thinspace{}
1878 \begin_inset space \thinspace{}
1899 \begin_layout Subsection
1903 \begin_layout Standard
1904 The following list describes the contents of the basic documentation files
1905 that you find in the
1912 \begin_layout Description
1913 Introduction This file.
1916 \begin_layout Description
1917 Tutorial If you are new to \SpecialChar LyX
1918 , and have never used \SpecialChar LaTeX
1919 before, you should start
1921 If you have used \SpecialChar LaTeX
1922 before, you should still read the
1926 , starting with the section on
1927 \begin_inset Quotes eld
1931 for \SpecialChar LaTeX
1933 \begin_inset Quotes erd
1936 (Skimming through the rest of the document wouldn't hurt, either.)
1939 \begin_layout Description
1941 \begin_inset space ~
1944 Guide The primary documentation.
1949 of the basic operation and available features of \SpecialChar LyX
1951 The main manual assumes that you have read the
1958 \begin_layout Description
1960 \begin_inset space ~
1963 Objects Extension of the
1968 Documents in detail how to use tables, graphics, floats, notes, program
1970 It also includes many tricks of the \SpecialChar LaTeX
1974 \begin_layout Description
1975 Math Extension of the
1980 Documents in detail how to typeset any kind of formula.
1983 \begin_layout Description
1985 \begin_inset space ~
1988 Features Extension of the
1993 Documents how to use raw \SpecialChar LaTeX
1994 commands, additional layouts and special-purpose
1998 \begin_layout Description
1999 Customization A description of advanced \SpecialChar LyX
2000 features, including how to customize
2001 the overall behavior of \SpecialChar LyX
2002 \SpecialChar endofsentence
2003 This includes such things as keybindings, internationa
2004 lization and configuration files.
2005 It also includes information about layout files, which are needed to get
2007 to support \SpecialChar LaTeX
2008 classes or packages.
2011 \begin_layout Description
2012 Shortcuts Tables of the currently defined \SpecialChar LyX
2016 \begin_layout Description
2019 \begin_inset space ~
2022 Configuration A report produced by \SpecialChar LyX
2024 This file contains information on what \SpecialChar LyX
2025 learned about your installation.
2026 Check it to see if you're missing something you might like to have.
2029 \begin_layout Standard
2030 These files will reference one another as necessary.
2039 information on installation and customization, but refers the reader to
2042 Customization Manual
2044 for more information.
2047 \begin_layout Standard
2048 We'll state again an important point:
2051 \begin_layout Standard
2052 \begin_inset VSpace bigskip
2058 \begin_layout Standard
2060 If you are new to \SpecialChar LyX
2066 Now\SpecialChar endofsentence
2070 \begin_layout Standard
2071 \begin_inset VSpace bigskip
2077 \begin_layout Standard
2078 Otherwise, you could needlessly frustrate yourself.
2081 \begin_layout Section
2082 Contributing to the \SpecialChar LyX
2084 \begin_inset CommandInset label
2093 \begin_layout Subsection
2094 Contributing to \SpecialChar LyX
2098 \begin_layout Standard
2100 is mostly written in C++ (the \SpecialChar LaTeX
2101 importer is written in Python).
2102 It is a large project, and as a result it is not free from bugs, or the
2103 need for improvements in the source code.
2106 \begin_layout Subsubsection
2110 \begin_layout Standard
2111 While using \SpecialChar LyX
2112 , you may find behavior which you consider a bug.
2113 Crashes, though rare, can happen.
2114 User interface problems are considered major bugs by the \SpecialChar LyX
2116 helpful are indications of parts of the \SpecialChar LyX
2117 interface you find confusing,
2121 \begin_layout Standard
2123 has a bug tracking system, which you can find at
2124 \begin_inset Newline newline
2128 \begin_inset CommandInset href
2130 target "https://www.lyx.org/trac/wiki/BugTrackerHome"
2135 You should check the bug tracker before reporting any bugs, in case it
2136 has already been reported.
2137 If you have a comment on an existing bug, or wish to report a new bug,
2138 you may either use the bug tracker, or send an e-mail to the development
2140 \begin_inset CommandInset href
2142 target "lyx-devel@lists.lyx.org"
2149 Archives of this list are linked from the main \SpecialChar LyX
2151 \begin_inset CommandInset href
2153 target "http://www.lyx.org"
2160 \begin_layout Standard
2161 A useful bug report will at a minimum include the version of \SpecialChar LyX
2164 Accurate, detailed descriptions are preferred — the more time developers
2165 have to spend to pinpoint the source of a bug, the less time they have
2166 for other improvements.
2167 Mention the system and system version on which you are running \SpecialChar LyX
2169 Give the versions of the libraries you have installed on your system, and,
2170 if relevant, the versions of external programs that \SpecialChar LyX
2172 If it's a compilation or configuration problem, include the file
2176 , and mention which compiler you are using.
2179 \begin_layout Subsubsection
2180 Contributing fixes and new features
2183 \begin_layout Standard
2184 If you have made changes to \SpecialChar LyX
2185 's source that you think should become part
2187 , send your changes as a diff file (in unified format) to the development
2188 list referenced above, along with a change log, and a description of what
2192 \begin_layout Subsection
2193 Contributing to the Documentation
2196 \begin_layout Standard
2198 's documentation is extensive; however \SpecialChar LyX
2199 is under constant development, and
2200 each new release adds new features.
2201 You may find some documentation needs improvement.
2202 This section describes what to do if you find an error, or have some suggestion
2203 s for improving the documentation.
2206 \begin_layout Subsubsection
2207 Reporting Errors in the Manuals
2210 \begin_layout Standard
2211 If you find a problem with the documentation, send a message to the mailing
2213 \begin_inset CommandInset href
2215 target "lyx-docs@lists.lyx.org"
2222 The documentation team will make any necessary fixes.
2225 \begin_layout Subsubsection
2226 Joining the Documentation Team.
2229 \begin_layout Standard
2230 The \SpecialChar LyX
2231 Documentation Project, like anything else in the \SpecialChar LyX
2233 use assistance! If you're interested in contributing to the Documentation
2234 Project, you need to do the following:
2237 \begin_layout Enumerate
2238 Get the latest \SpecialChar LyX
2240 \begin_inset Newline newline
2244 \begin_inset CommandInset href
2246 target "https://www.lyx.org/trac/browser/lyxgit/lib/doc?rev=master "
2253 \begin_layout Enumerate
2263 \begin_inset Newline newline
2266 The point of this exercise is to give you ideas.
2275 are likely to be the most up-to-date of all of the documentation.
2276 You should be able to glean some insights into how we want the manuals
2277 to read and to look.
2280 \begin_layout Enumerate
2281 Contact the team at:
2282 \begin_inset Newline newline
2286 \begin_inset CommandInset href
2288 target "lyx-docs@lists.lyx.org"
2295 \begin_inset Newline newline
2298 to discuss your intended changes and to get some feedback on them.
2301 \begin_layout Standard
2302 The changes you wish to make may range from improving clarity of the text,
2303 to doing major re-structuring of the documentation.
2304 Any and all improvements are gladly received.