1 #LyX 2.2 created this file. For more info see http://www.lyx.org/
5 \origin /systemlyxdir/doc/
8 % DO NOT ALTER THIS PREAMBLE!!!
10 %This preamble is designed to ensure that the document prints
11 % out as advertised. If you mess with this preamble,
12 % parts of the document may not print out as expected. If you
13 % have problems LaTeXing this file, please contact
14 % the documentation team
15 % email: lyx-docs@lists.lyx.org
17 \usepackage{ifpdf} % part of the hyperref bundle
18 \ifpdf % if pdflatex is used
20 % set fonts for nicer pdf view
21 \IfFileExists{lmodern.sty}{\usepackage{lmodern}}{}
23 \fi % end if pdflatex is used
25 % the pages of the TOC is numbered roman
26 % and a pdf-bookmark for the TOC is added
28 \let\myTOC\tableofcontents
29 \renewcommand\tableofcontents{%
30 \pdfbookmark[1]{\contentsname}{}
33 \pagenumbering{arabic} }
35 \use_default_options false
36 \maintain_unincluded_children false
38 \language_package default
41 \font_roman "default" "default"
42 \font_sans "default" "default"
43 \font_typewriter "default" "default"
44 \font_math "auto" "auto"
45 \font_default_family default
46 \use_non_tex_fonts false
49 \font_sf_scale 100 100
50 \font_tt_scale 100 100
52 \default_output_format default
54 \bibtex_command default
55 \index_command default
59 \pdf_title "Introduction to LyX"
60 \pdf_author "LyX Team"
61 \pdf_subject "LyX-documentation Intro"
62 \pdf_keywords "LyX, documentation"
64 \pdf_bookmarksnumbered true
65 \pdf_bookmarksopen true
66 \pdf_bookmarksopenlevel 2
71 \pdf_pdfusetitle false
72 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
75 \use_package amsmath 1
76 \use_package amssymb 1
79 \use_package mathdots 1
80 \use_package mathtools 0
82 \use_package stackrel 0
83 \use_package stmaryrd 0
84 \use_package undertilde 0
86 \cite_engine_type default
90 \paperorientation portrait
100 \paragraph_separation indent
101 \paragraph_indentation default
102 \quotes_language english
105 \paperpagestyle default
106 \tracking_changes false
107 \output_changes false
110 \html_be_strict false
116 Introduction to \SpecialCharNoPassThru LyX
120 by the \SpecialCharNoPassThru LyX
125 \begin_layout Plain Layout
127 If you have comments on or corrections to this documentation, please send
128 them to the \SpecialCharNoPassThru LyX
129 Documentation mailing list:
130 \begin_inset CommandInset href
132 target "lyx-docs@lists.lyx.org"
145 \begin_layout Standard
146 \begin_inset CommandInset toc
147 LatexCommand tableofcontents
154 \begin_layout Section
155 The Philosophy of \SpecialCharNoPassThru LyX
158 \begin_layout Subsection
159 What is \SpecialCharNoPassThru LyX
163 \begin_layout Standard
164 \SpecialCharNoPassThru LyX
165 is a document preparation system.
166 It excels at letting you create complex technical and scientific articles
167 with mathematics, cross-references, bibliographies, indexes, etc.
168 It is very good for working with documents of any length in which the usual
169 processing abilities are required: automatic sectioning and pagination,
170 spell checking and so forth.
171 It can also be used to write a letter to your mom, though granted, there
172 are probably simpler programs available for that.
173 It is definitely not the best tool for creating banners, flyers, or advertiseme
174 nts (we'll explain why later), though with some effort all these can be
176 Here are some examples of what it is used for: memos, letters, dissertations
177 and theses, lecture notes, seminar notebooks, conference proceedings, software
178 documentation, books, articles in refereed scientific journals, scripts
179 for plays and movies, business proposals, presentations \SpecialChar ldots
183 \begin_layout Standard
184 \SpecialCharNoPassThru LyX
185 is a program that provides a modern approach to writing documents with
186 a computer by using a markup language paradigm, an approach that breaks
187 with the obsolete tradition of the
188 \begin_inset Quotes eld
192 \begin_inset Quotes erd
196 It is designed for authors who want professional output quickly with a
197 minimum of effort and without becoming specialists in typesetting.
198 The job of typesetting is done mostly by the computer, not the author;
199 with \SpecialCharNoPassThru LyX
200 , the author can concentrate on the contents of his writing.
203 \begin_layout Standard
204 Part of the initial challenge of using \SpecialCharNoPassThru LyX
205 comes from the change in thinking
206 that you, the user, must make.
207 At one time, all we had for creating documents were typewriters, so we
208 all learned certain tricks to get around their limitations.
209 Underlining, which is little more than overstriking with the
210 \begin_inset Quotes eld
214 \begin_inset Quotes erd
217 character, became a way to emphasize text.
218 You were forced to figure out column sizes and tab stops, and set them,
219 before creating a table.
220 The same applied for letters and other right justified text.
221 Hyphenation at the end of a line required a careful eye and a lot of foresight.
224 \begin_layout Standard
225 In other words, we've all been trained to worry about the little details
226 of which character goes where.
227 Consequently, almost all word processors have this mentality.
228 They still use tab stops for adding whitespace.
229 You still need to worry about exactly where on the page something will
231 Emphasizing text means changing a font, similar to changing the typewriter
233 This is the underlying philosophy of a WYSIWYG word processor:
234 \begin_inset Quotes eld
237 What You See Is What You Get
238 \begin_inset Quotes erd
242 Unfortunately, that paradigm often results in
243 \begin_inset Quotes eld
246 What You See Is All You Get
247 \begin_inset Quotes erd
253 \begin_layout Standard
254 This is where \SpecialCharNoPassThru LyX
255 differs from an ordinary word processor.
256 You don't concern yourself with what character goes where.
257 You tell \SpecialCharNoPassThru LyX
262 and \SpecialCharNoPassThru LyX
263 takes care of the rest, following a set of rules called a
271 \begin_layout Plain Layout
272 To be fair, most recent versions of the most popular office suites now have
273 some sort of style sheets which follow a similar markup method.
274 However, our experience is that they are still rarely used in practice.
279 Let's look at a little example:
282 \begin_layout Standard
283 Suppose you are writing a report.
284 To begin your report, you want a section called
285 \begin_inset Quotes eld
288 Introduction\SpecialChar endofsentence
290 \begin_inset Quotes erd
293 So, you go into whatever menu it is in your word processor that changes
294 font sizes and decide on a new font size.
295 Then you turn on bold face.
297 \begin_inset Quotes eld
309 \begin_inset Quotes erd
313 Of course, if you later decide that this section belongs someplace else
314 in the document or if you insert a new section before it, you need to change
315 the numbering for this and all following sections, as well as any entry
316 in the table of contents.
319 \begin_layout Standard
320 In \SpecialCharNoPassThru LyX
321 , you go to the pull-down on the far left of the button bar and select
327 \begin_inset Quotes eld
331 \begin_inset Quotes erd
337 \begin_layout Standard
339 If you cut and paste the section, it will automatically be renumbered —
341 And if you enter references to that section correctly (by inserting cross-refer
342 ence tags), \SpecialCharNoPassThru LyX
343 will automatically update them all throughout the file so
344 that you never, ever type a section number.
347 \begin_layout Standard
348 Now let's look at the problem of consistency.
349 Five days later, you reopen your report and start Section
354 However, you forget that you were using 18
355 \begin_inset space \thinspace{}
358 pt bold instead of 16
359 \begin_inset space \thinspace{}
362 pt, so you type in the heading for Section
366 4 in a different font from the one you used for Section
371 That problem doesn't even exist in \SpecialCharNoPassThru LyX
373 The computer takes care of all that silly bookkeeping about which thing
374 has what size font, not you.
375 After all, that's what a computer is good at.
378 \begin_layout Standard
379 Here's another example.
380 Suppose you're making a list.
381 In other word processors, a list is just a bunch of tab stops and newlines.
382 You need to figure out where to put the label for each list item, what
383 that label should be, how many blank lines to put between each item, and
385 Under \SpecialCharNoPassThru LyX
386 , you have only two concerns: what kind of list is this, and what
387 do I want to put in it? That is it.
390 \begin_layout Standard
391 So, the basic idea behind \SpecialCharNoPassThru LyX
402 \begin_inset Quotes eld
405 What You See Is What You Get,
406 \begin_inset Quotes erd
409 the \SpecialCharNoPassThru LyX
411 \begin_inset Quotes eld
414 What You See Is What You
419 \begin_inset Quotes erd
423 \begin_inset Quotes eld
427 \begin_inset Quotes erd
430 It's a powerful idea that greatly simplifies the mechanics of writing documents.
431 This is also why \SpecialCharNoPassThru LyX
432 isn't so good for creating posters and flyers.
437 want to specify exactly where everything goes, because there are no functional
438 units like paragraphs, sections, etc.
439 This doesn't mean \SpecialCharNoPassThru LyX
440 is missing some cool function.
441 It simply means that it isn't the right tool for the job — you don't use
442 a screwdriver to drive in nails.
445 \begin_layout Subsection
446 Differences between \SpecialCharNoPassThru LyX
447 and Other Word Processors
448 \begin_inset Argument 1
451 \begin_layout Plain Layout
455 \begin_layout Plain Layout
464 \SpecialCharNoPassThru LyX
468 \begin_layout Plain Layout
470 }{\SpecialCharNoPassThru LyX
476 and Other Word Processors
484 \begin_layout Standard
485 Here's a list of things you won't find in \SpecialCharNoPassThru LyX
489 \begin_layout Itemize
493 \begin_layout Itemize
497 \begin_layout Itemize
499 \begin_inset space \thinspace{}
503 \begin_inset space \space{}
517 \begin_layout Standard
518 Tab stops, along with a ruler showing you the position of things on the
519 page, are useless in \SpecialCharNoPassThru LyX
521 The program worries about where things go on the page, not you.
522 Extra whitespace is similar; \SpecialCharNoPassThru LyX
523 adds it where necessary, depending on
525 Not being able to type two blank lines in a row will be annoying at first,
526 but it makes more sense once you're thinking in WYSIWYM terms.
529 \begin_layout Standard
530 Here are some things that exist in \SpecialCharNoPassThru LyX
531 , but aren't used as you might think:
534 \begin_layout Itemize
538 \begin_layout Itemize
542 \begin_layout Itemize
544 \begin_inset space \thinspace{}
548 \begin_inset space \space{}
551 single spaced, double spaced, etc.)
554 \begin_layout Itemize
555 Whitespace, horizontal and vertical
558 \begin_layout Itemize
562 \begin_layout Itemize
563 Typefaces (bold, italic, underline, etc.)
566 \begin_layout Standard
567 Although they exist in \SpecialCharNoPassThru LyX
568 , you generally don't need them.
569 \SpecialCharNoPassThru LyX
570 will take care of these things for you, depending on what you're doing.
571 Different parts of the document are automatically set in a different typeface
573 Paragraph indenting is context dependent; different types of paragraphs
574 get indented differently.
575 Page breaks get handled automatically, as well.
576 In general, the space between lines, between words, and between paragraphs
577 is variable, set by \SpecialCharNoPassThru LyX
582 \begin_layout Plain Layout
583 There are ways to adjust all of these (only some of which require knowledge
584 of \SpecialCharNoPassThru LaTeX
585 ), either for a whole document or for a specific location in a
603 \begin_layout Standard
604 Lastly, there are a few areas where we believe \SpecialCharNoPassThru LyX
605 (and \SpecialCharNoPassThru LaTeX
607 many word processors:
610 \begin_layout Itemize
614 \begin_layout Itemize
618 \begin_layout Itemize
622 \begin_layout Itemize
626 \begin_layout Itemize
630 \begin_layout Standard
631 Granted, many modern word processors can handle mathematical symbols, tables,
632 and hyphenation, and many have moved towards style definitions and the
634 However, they've only recently been able to do so, whereas \SpecialCharNoPassThru LyX
636 upon the \SpecialCharNoPassThru LaTeX
637 document preparation system.
638 \SpecialCharNoPassThru LaTeX
639 has been around since 1985, and
646 \begin_layout Subsection
647 What is \SpecialCharNoPassThru LaTeX
651 \begin_layout Standard
652 \SpecialCharNoPassThru LaTeX
653 is a document preparation system designed by Leslie Lamport in 1985.
657 \begin_layout Plain Layout
658 The source for the info in this section is
660 A Guide to \SpecialCharNoPassThru LaTeX2e
662 , by Helmut Kopka and Patrick Daly, which has an entry in the bibliography
667 \SpecialChar endofsentence
673 It was built up from a typesetting language called \SpecialCharNoPassThru TeX
676 \SpecialCharNoPassThru TeX
677 takes a sequence of typesetting commands, written in a script in an
678 ASCII file, and executes them.
680 \begin_inset Quotes eld
684 \begin_inset Quotes erd
687 of the printing trade were modeled by Knuth as computer algorithms and
688 incorporated into \SpecialCharNoPassThru TeX
689 , hence its excellent printed appearance.
690 What comes directly out of \SpecialCharNoPassThru TeX
691 is the portable document format
696 \begin_inset Quotes eld
700 \begin_inset Quotes erd
708 The dvi format is often used for previews and can later be converted to
709 other formats like PostScript.
713 \begin_layout Standard
714 \SpecialCharNoPassThru TeX
715 isn't only a typesetting engine; it also allows you to define macros.
716 Most people who use \SpecialCharNoPassThru TeX
717 are actually using a macro package which Knuth
718 created to hide a lot of the typesetting details.
719 This is where Leslie Lamport enters our story.
720 He wanted a macro package that was more user- and less typesetter-oriented,
721 with a set of commands that consistently typeset things like sections,
722 tables or math formulas in a uniform, consistent fashion.
723 This is how \SpecialCharNoPassThru LaTeX
727 \begin_layout Standard
728 Now, in parallel with the development and growth of \SpecialCharNoPassThru LaTeX
730 creating their own custom macro packages for \SpecialCharNoPassThru TeX
731 , ones to make slides or
732 articles for math journals and so on.
733 Some used the raw \SpecialCharNoPassThru TeX
734 facilities to do this, others began modifying \SpecialCharNoPassThru LaTeX
736 To try and unify this mess, a team of \SpecialCharNoPassThru LaTeX
737 -nicians began to work on \SpecialCharNoPassThru LaTeX2e
739 the current version of \SpecialCharNoPassThru LaTeX
740 , during the late 1980's.
741 This new version of \SpecialCharNoPassThru LaTeX
742 has commands which provide an easier-to-use interface
743 to \SpecialCharNoPassThru TeX
744 's macro-creating commands, aid in the use of new fonts, and so on.
745 In fact, \SpecialCharNoPassThru LaTeX
746 is quite an extensive language in its own right! Users around
747 the world have been creating their own add-ons for \SpecialCharNoPassThru LaTeX
752 \begin_layout Standard
753 There are two ways to extend \SpecialCharNoPassThru LaTeX
754 : classes and styles.
759 is a set of \SpecialCharNoPassThru LaTeX
760 macros describing a new type of document, like a book,
762 There are classes for slides, for physics and math journals\SpecialChar ldots
764 even have a class for their thesis format.
769 differs from a class in that it doesn't define a new type of document,
770 but a different type of
774 that any document can use.
775 For example, \SpecialCharNoPassThru LyX
776 controls page margins and line spacing using two different
777 \SpecialCharNoPassThru LaTeX
778 style-files designed for these purposes.
779 There are style-files for a whole slew of things: printing labels or envelopes,
780 changing indentation behavior, adding new fonts, manipulating graphics,
781 designing fancy page headings, customizing bibliographies, altering the
782 location and appearance of footnotes, tables, and figures, customizing
786 \begin_layout Standard
790 \begin_layout Description
791 \SpecialCharNoPassThru TeX
792 : Typesetting language with macro capability.
795 \begin_layout Description
796 \SpecialCharNoPassThru LaTeX
797 : Macro package built upon \SpecialCharNoPassThru TeX
798 \SpecialChar endofsentence
802 \begin_layout Description
803 classes: Descriptions of types of document used with \SpecialCharNoPassThru LaTeX
804 \SpecialChar endofsentence
808 \begin_layout Description
809 styles: Descriptions of the default behavior of particular elements of \SpecialCharNoPassThru LaTeX
813 \begin_layout Description
814 \SpecialCharNoPassThru LyX
815 : Visual, WYSIWYM document processor that uses \SpecialCharNoPassThru LaTeX
816 to do its typesetting.
819 \begin_layout Standard
820 This section attempts to explain the difference between \SpecialCharNoPassThru LyX
821 and a word processor.
822 Simply put, \SpecialCharNoPassThru LaTeX
824 By using \SpecialCharNoPassThru LaTeX
825 as its backend, \SpecialCharNoPassThru LyX
826 helps you to think more about
835 The computer then handles
842 \begin_layout Section
843 Navigating the Documentation
846 \begin_layout Standard
847 To make it easier to answer your questions and describe all of the features
848 of \SpecialCharNoPassThru LyX
849 , the documentation has been split up into several different files.
850 Each one has its own purpose, as described below.
851 Before you go ploughing into any of those files, however, you should read
852 this chapter thoroughly, since it contains a lot of useful information
853 and commentary that can save you some time.
856 \begin_layout Standard
857 Hopefully, the development of \SpecialCharNoPassThru LyX
858 will never stop; so some of the documentation
859 may be incomplete or a bit out of date, though we try to keep up-to-date.
860 Like the rest of \SpecialCharNoPassThru LyX
861 , the manuals are the work of a group of volunteers
863 \begin_inset Quotes eld
867 \begin_inset Quotes erd
870 , families, dishes to clean,
875 If you want to help out, be sure to read Section
880 \begin_inset CommandInset ref
882 reference "sec:Contrib"
886 in addition to the rest of this document.
889 \begin_layout Standard
890 Also, please do us a favor – if anything in these manuals confuses you,
891 is unclear, or wrong, don't hesitate to let us know! You can reach the
892 current document maintainers by emailing
893 \begin_inset CommandInset href
895 target "lyx-docs@lists.lyx.org"
901 If you have questions that are not obviously answered in the documentation,
902 and need help fast, there is an active users' mailing list which you can
904 \begin_inset CommandInset href
906 target "lyx-users@lists.lyx.org"
914 \begin_layout Subsection
915 The Format of the Manuals
918 \begin_layout Standard
919 Some of you may have printed out the manuals.
920 Others may be reading them within \SpecialCharNoPassThru LyX
922 There are some differences between the \SpecialCharNoPassThru LyX
923 -file and the printed version.
924 In \SpecialCharNoPassThru LyX
925 , the title is simply at the top of the document, not formatted on
926 a separate page as in some of the printed versions.
927 Nor are any of the footnotes or the Table of Contents fully visible.
928 To open a footnote, which looks like this:
929 \begin_inset Graphics
930 filename clipart/footnoteQt4.png
935 , click on it with the left mouse button.
936 For the Table of Contents, either click on the grey box or click on the
941 menu, where the contents are displayed automatically\SpecialChar endofsentence
945 \begin_layout Standard
946 In the printed manuals, all cross-references appear as the actual numbers
947 for a chapter, section, subsection, and so on.
948 In the \SpecialCharNoPassThru LyX
949 -file, however, all cross-references appear as light-grey boxes
951 \begin_inset Graphics
952 filename clipart/referenceQt4.png
958 If you click on such a box with the left mouse button, a dialog box will
959 appear containing a list of all the cross-references in the document.
960 You can go to the referenced section by right-clicking on the box or by
973 in the opened dialog.
974 Going back to where you came from is just as easy.
983 to go back to your earlier location.
986 \begin_layout Standard
987 Now that we've cleared up some of the differences between the printed and
988 \SpecialCharNoPassThru LyX
989 -file versions of this file, we can start looking at the format of this
991 You'll occasionally notice things in different fonts:
994 \begin_layout Itemize
999 is used for general emphasis, generic arguments, book titles, names of
1000 sections of other manuals, and notes from the authors.
1003 \begin_layout Itemize
1008 is used for program and file names, \SpecialCharNoPassThru LyX
1012 \begin_layout Itemize
1017 is used for menu, button, or dialog box names, and the names of keyboard
1021 \begin_layout Itemize
1026 is used for people's names.
1029 \begin_layout Itemize
1034 is used for \SpecialCharNoPassThru LaTeX
1038 \begin_layout Standard
1039 When we do need to reference keys, we'll use the following prefixing convention:
1042 \begin_layout Itemize
1043 \begin_inset Quotes eld
1051 \begin_inset Quotes erd
1061 \begin_layout Itemize
1062 \begin_inset Quotes eld
1070 \begin_inset Quotes erd
1080 \begin_layout Itemize
1081 \begin_inset Quotes eld
1089 \begin_inset Quotes erd
1103 \begin_layout Itemize
1104 \begin_inset Quotes eld
1112 \begin_inset Quotes erd
1117 \begin_inset Quotes eld
1125 \begin_inset Quotes erd
1128 are the function keys.
1131 \begin_layout Itemize
1132 \begin_inset Quotes eld
1140 \begin_inset Quotes erd
1146 \begin_layout Itemize
1147 \begin_inset Quotes eld
1155 \begin_inset Quotes erd
1159 \begin_inset Quotes eld
1167 \begin_inset Quotes erd
1171 \begin_inset Quotes eld
1179 \begin_inset Quotes erd
1183 \begin_inset Quotes eld
1191 \begin_inset Quotes erd
1197 \begin_layout Itemize
1200 \begin_inset Quotes eld
1206 \begin_inset Quotes erd
1210 \begin_inset Quotes eld
1218 \begin_inset Quotes erd
1222 \begin_inset Quotes eld
1230 \begin_inset Quotes erd
1234 \begin_inset Quotes eld
1242 \begin_inset Quotes erd
1246 \begin_inset Quotes eld
1254 \begin_inset Quotes erd
1258 \begin_inset Quotes eld
1266 \begin_inset Quotes erd
1269 : these are the 6 keys that appear above the cursor keys on many PC keyboards.
1271 \begin_inset Quotes eld
1279 \begin_inset Quotes erd
1283 \begin_inset Quotes eld
1291 \begin_inset Quotes erd
1295 \begin_inset Quotes eld
1303 \begin_inset Quotes erd
1307 \begin_inset Quotes eld
1315 \begin_inset Quotes erd
1321 \begin_layout Itemize
1330 both refer to the same key.
1331 Some keyboards label the
1336 \begin_inset Quotes eld
1340 \begin_inset Quotes erd
1344 \begin_inset Quotes eld
1348 \begin_inset Quotes erd
1351 still others have two keys.
1352 \SpecialCharNoPassThru LyX
1353 treats all of them as the same key, so we'll use
1364 \begin_layout Standard
1365 The list with the currently set shortcuts can be found in the
1376 \begin_layout Subsection
1377 Units used in the Manuals
1380 \begin_layout Standard
1381 To understand the units described in this documentation, Table
1382 \begin_inset space ~
1386 \begin_inset CommandInset ref
1388 reference "tab:Units"
1392 explains all units available in \SpecialCharNoPassThru LyX
1396 \begin_layout Standard
1397 \begin_inset Float table
1402 \begin_layout Plain Layout
1403 \begin_inset Caption Standard
1405 \begin_layout Plain Layout
1406 \begin_inset CommandInset label
1420 \begin_layout Plain Layout
1421 \begin_inset VSpace medskip
1427 \begin_layout Plain Layout
1429 \begin_inset Tabular
1430 <lyxtabular version="3" rows="20" columns="2">
1431 <features rotate="0" booktabs="true" tabularvalignment="middle">
1432 <column alignment="center" valignment="top" width="0pt">
1433 <column alignment="center" valignment="top">
1435 <cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
1438 \begin_layout Plain Layout
1444 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1447 \begin_layout Plain Layout
1455 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1458 \begin_layout Plain Layout
1464 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1467 \begin_layout Plain Layout
1475 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1478 \begin_layout Plain Layout
1484 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1487 \begin_layout Plain Layout
1495 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1498 \begin_layout Plain Layout
1504 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1507 \begin_layout Plain Layout
1509 \begin_inset space \thinspace{}
1513 \begin_inset space \thinspace{}
1523 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1526 \begin_layout Plain Layout
1532 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1535 \begin_layout Plain Layout
1537 \begin_inset space \thinspace{}
1541 \begin_inset space \thinspace{}
1551 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1554 \begin_layout Plain Layout
1560 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1563 \begin_layout Plain Layout
1565 \begin_inset space \thinspace{}
1569 \begin_inset space \thinspace{}
1579 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1582 \begin_layout Plain Layout
1588 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1591 \begin_layout Plain Layout
1593 \begin_inset space \thinspace{}
1597 \begin_inset space \thinspace{}
1607 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1610 \begin_layout Plain Layout
1616 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1619 \begin_layout Plain Layout
1621 \begin_inset space \thinspace{}
1625 \begin_inset space \thinspace{}
1635 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1638 \begin_layout Plain Layout
1644 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1647 \begin_layout Plain Layout
1649 \begin_inset space \thinspace{}
1653 \begin_inset Formula $\approx$
1657 \begin_inset space \thinspace{}
1667 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1670 \begin_layout Plain Layout
1676 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1679 \begin_layout Plain Layout
1681 \begin_inset space \thinspace{}
1685 \begin_inset space \thinspace{}
1695 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1698 \begin_layout Plain Layout
1704 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1707 \begin_layout Plain Layout
1708 % of original image width
1715 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1718 \begin_layout Plain Layout
1724 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1727 \begin_layout Plain Layout
1735 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1738 \begin_layout Plain Layout
1744 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1747 \begin_layout Plain Layout
1755 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1758 \begin_layout Plain Layout
1764 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1767 \begin_layout Plain Layout
1775 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1778 \begin_layout Plain Layout
1784 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1787 \begin_layout Plain Layout
1795 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1798 \begin_layout Plain Layout
1804 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1807 \begin_layout Plain Layout
1815 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1818 \begin_layout Plain Layout
1824 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1827 \begin_layout Plain Layout
1835 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1838 \begin_layout Plain Layout
1844 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1847 \begin_layout Plain Layout
1859 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1862 \begin_layout Plain Layout
1868 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1871 \begin_layout Plain Layout
1883 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1886 \begin_layout Plain Layout
1892 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1895 \begin_layout Plain Layout
1897 \begin_inset space \thinspace{}
1901 \begin_inset space \thinspace{}
1922 \begin_layout Subsection
1926 \begin_layout Standard
1927 The following list describes the contents of the basic documentation files
1928 that you find in the
1935 \begin_layout Description
1936 Introduction This file.
1939 \begin_layout Description
1940 Tutorial If you are new to \SpecialCharNoPassThru LyX
1941 , and have never used \SpecialCharNoPassThru LaTeX
1944 If you have used \SpecialCharNoPassThru LaTeX
1945 before, you should still read the
1949 , starting with the section on
1950 \begin_inset Quotes eld
1953 \SpecialCharNoPassThru LyX
1954 for \SpecialCharNoPassThru LaTeX
1956 \begin_inset Quotes erd
1959 (Skimming through the rest of the document wouldn't hurt, either.)
1962 \begin_layout Description
1964 \begin_inset space ~
1967 Guide The primary documentation.
1972 of the basic operation and available features of \SpecialCharNoPassThru LyX
1974 The main manual assumes that you have read the
1981 \begin_layout Description
1983 \begin_inset space ~
1986 Objects Extension of the
1991 Documents in detail how to use tables, graphics, floats, notes, program
1993 It also includes many tricks of the \SpecialCharNoPassThru LaTeX
1997 \begin_layout Description
1998 Math Extension of the
2003 Documents in detail how to typeset any kind of formula.
2006 \begin_layout Description
2008 \begin_inset space ~
2011 Features Extension of the
2016 Documents how to use raw \SpecialCharNoPassThru LaTeX
2017 commands, additional layouts and special-purpose
2021 \begin_layout Description
2022 Customization A description of advanced \SpecialCharNoPassThru LyX
2023 features, including how to customize
2024 the overall behavior of \SpecialCharNoPassThru LyX
2025 \SpecialChar endofsentence
2026 This includes such things as keybindings, internati
2027 onalization and configuration files.
2028 It also includes information about layout files, which are needed to get
2029 \SpecialCharNoPassThru LyX
2030 to support \SpecialCharNoPassThru LaTeX
2031 classes or packages.
2034 \begin_layout Description
2035 Shortcuts Tables of the currently defined \SpecialCharNoPassThru LyX
2039 \begin_layout Description
2040 \SpecialCharNoPassThru LaTeX
2041 \begin_inset space ~
2044 Configuration A report produced by \SpecialCharNoPassThru LyX
2046 This file contains information on what \SpecialCharNoPassThru LyX
2047 learned about your installation.
2048 Check it to see if you're missing something you might like to have.
2051 \begin_layout Standard
2052 These files will reference one another as necessary.
2061 information on installation and customization, but refers the reader to
2064 Customization Manual
2066 for more information.
2069 \begin_layout Standard
2070 We'll state again an important point:
2073 \begin_layout Standard
2074 \begin_inset VSpace bigskip
2080 \begin_layout Standard
2082 If you are new to \SpecialCharNoPassThru LyX
2088 Now\SpecialChar endofsentence
2092 \begin_layout Standard
2093 \begin_inset VSpace bigskip
2099 \begin_layout Standard
2100 Otherwise, you could needlessly frustrate yourself.
2103 \begin_layout Section
2104 Contributing to the \SpecialCharNoPassThru LyX
2106 \begin_inset CommandInset label
2115 \begin_layout Subsection
2116 Contributing to \SpecialCharNoPassThru LyX
2119 \begin_layout Standard
2120 \SpecialCharNoPassThru LyX
2121 is mostly written in C++ (the \SpecialCharNoPassThru LaTeX
2122 importer is written in Python).
2123 It is a large project, and as a result it is not free from bugs, or the
2124 need for improvements in the source code.
2127 \begin_layout Subsubsection
2131 \begin_layout Standard
2132 While using \SpecialCharNoPassThru LyX
2133 , you may find behavior which you consider a bug.
2134 Crashes, though rare, can happen.
2135 User interface problems are considered major bugs by the \SpecialCharNoPassThru LyX
2137 helpful are indications of parts of the \SpecialCharNoPassThru LyX
2138 interface you find confusing,
2142 \begin_layout Standard
2143 \SpecialCharNoPassThru LyX
2144 has a bug tracking system, which you can find at
2147 \begin_inset Flex URL
2150 \begin_layout Plain Layout
2152 http://www.lyx.org/trac/wiki/BugTrackerHome
2160 You should check the bug tracker before reporting any bugs, in case it
2161 has already been reported.
2162 If you have a comment on an existing bug, or wish to report a new bug,
2163 you may either use the bug tracker, or send an e-mail to the development
2165 \begin_inset CommandInset href
2167 target "lyx-devel@lists.lyx.org"
2173 Archives of this list are linked from the main \SpecialCharNoPassThru LyX
2177 \begin_inset Flex URL
2180 \begin_layout Plain Layout
2192 \begin_layout Standard
2193 A useful bug report will at a minimum include the version of \SpecialCharNoPassThru LyX
2195 having the problem with.
2196 Accurate, detailed descriptions are preferred - the more time developers
2197 have to spend to pinpoint the source of a bug, the less time they have
2198 for other improvements.
2199 Mention the system and system version on which you are running \SpecialCharNoPassThru LyX
2201 Give the versions of the libraries you have installed on your system, and,
2202 if relevant, the versions of external programs that \SpecialCharNoPassThru LyX
2204 If it's a compilation or configuration problem, include the file
2208 , and mention which compiler you are using.
2211 \begin_layout Subsubsection
2212 Contributing fixes and new features
2215 \begin_layout Standard
2216 If you have made changes to \SpecialCharNoPassThru LyX
2217 's source that you think should become part
2218 of \SpecialCharNoPassThru LyX
2219 , send your changes as a diff file (in unified format) to the development
2220 list referenced above, along with a change log, and a description of what
2224 \begin_layout Subsection
2225 Contributing to the Documentation
2228 \begin_layout Standard
2229 \SpecialCharNoPassThru LyX
2230 's documentation is extensive; however \SpecialCharNoPassThru LyX
2231 is under constant development,
2232 and each new release adds new features.
2233 You may find some documentation needs improvement.
2234 This section describes what to do if you find an error, or have some suggestion
2235 s for improving the documentation.
2238 \begin_layout Subsubsection
2239 Reporting Errors in the Manuals
2242 \begin_layout Standard
2243 If you find a problem with the documentation, send a message to the mailing
2245 \begin_inset CommandInset href
2247 target "lyx-docs@lists.lyx.org"
2253 The documentation team will make any necessary fixes.
2256 \begin_layout Subsubsection
2257 Joining the Documentation Team.
2260 \begin_layout Standard
2261 The \SpecialCharNoPassThru LyX
2262 Documentation Project, like anything else in the \SpecialCharNoPassThru LyX
2264 always use assistance! If you're interested in contributing to the Documentatio
2265 n Project, you need to do the following:
2268 \begin_layout Enumerate
2269 Get the latest \SpecialCharNoPassThru LyX
2271 \begin_inset Newline newline
2275 \begin_inset Flex URL
2278 \begin_layout Plain Layout
2280 http://www.lyx.org/trac/browser/lyxgit/lib/doc?rev=master
2288 \begin_layout Enumerate
2298 \begin_inset Newline newline
2301 The point of this exercise is to give you ideas.
2310 are likely to be the most up-to-date of all of the documentation.
2311 You should be able to glean some insights into how we want the manuals
2312 to read and to look.
2315 \begin_layout Enumerate
2316 Contact the team at:
2317 \begin_inset Newline newline
2321 \begin_inset CommandInset href
2323 target "lyx-docs@lists.lyx.org"
2329 \begin_inset Newline newline
2332 to discuss your intended changes and to get some feedback on them.
2335 \begin_layout Standard
2336 The changes you wish to make may range from improving clarity of the text,
2337 to doing major re-structuring of the documentation.
2338 Any and all improvements are gladly received.