]> git.lyx.org Git - lyx.git/blob - development/batchtests/compare_tests/long_doc/diffs.expected.lyx
Cmake tests: Correct BATCH_compare-test test.
[lyx.git] / development / batchtests / compare_tests / long_doc / diffs.expected.lyx
1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
2 \lyxformat 608
3 \begin_document
4 \begin_header
5 \save_transient_properties true
6 \origin unavailable
7 \textclass article
8 \begin_preamble
9 % DO NOT ALTER THIS PREAMBLE!!!
10 %
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
17
18 % the pages of the TOC is numbered roman
19 % and a pdf-bookmark for the TOC is added
20 \pagenumbering{roman}
21 \let\myTOC\tableofcontents
22 \renewcommand\tableofcontents{%
23   \pdfbookmark[1]{\contentsname}{}
24   \myTOC
25   \cleardoublepage
26   \pagenumbering{arabic} }
27 \end_preamble
28 \use_default_options false
29 \maintain_unincluded_children no
30 \language english
31 \language_package default
32 \inputencoding utf8
33 \fontencoding auto
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
40 \font_sc true
41 \font_roman_osf false
42 \font_sans_osf false
43 \font_typewriter_osf false
44 \font_sf_scale 100 100
45 \font_tt_scale 100 100
46 \use_microtype false
47 \use_dash_ligatures false
48 \graphics default
49 \default_output_format pdf2
50 \output_sync 0
51 \bibtex_command default
52 \index_command default
53 \paperfontsize 12
54 \spacing single
55 \use_hyperref true
56 \pdf_title "Introduction to LyX"
57 \pdf_author "LyX Team"
58 \pdf_subject "LyX-documentation Intro"
59 \pdf_keywords "LyX, documentation"
60 \pdf_bookmarks true
61 \pdf_bookmarksnumbered true
62 \pdf_bookmarksopen true
63 \pdf_bookmarksopenlevel 2
64 \pdf_breaklinks true
65 \pdf_pdfborder false
66 \pdf_colorlinks true
67 \pdf_backref false
68 \pdf_pdfusetitle false
69 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
70 \papersize a4
71 \use_geometry false
72 \use_package amsmath 1
73 \use_package amssymb 1
74 \use_package cancel 1
75 \use_package esint 1
76 \use_package mathdots 1
77 \use_package mathtools 1
78 \use_package mhchem 1
79 \use_package stackrel 1
80 \use_package stmaryrd 1
81 \use_package undertilde 1
82 \cite_engine basic
83 \cite_engine_type default
84 \biblio_style plain
85 \use_bibtopic false
86 \use_indices false
87 \paperorientation portrait
88 \suppress_date false
89 \justification true
90 \use_refstyle 0
91 \use_minted 0
92 \use_lineno 0
93 \index Index
94 \shortcut idx
95 \color #008000
96 \end_index
97 \secnumdepth 3
98 \tocdepth 2
99 \paragraph_separation indent
100 \paragraph_indentation default
101 \is_math_indent 0
102 \math_numbering_side default
103 \quotes_style english
104 \dynamic_quotes 0
105 \papercolumns 1
106 \papersides 1
107 \paperpagestyle default
108 \tablestyle default
109 \tracking_changes true
110 \output_changes true
111 \change_bars false
112 \postpone_fragile_content false
113 \html_math_output 0
114 \html_css_as_file 0
115 \html_be_strict false
116 \docbook_table_output 0
117 \docbook_mathml_prefix 1
118 \author 193470694 "Sam"
119 \end_header
120
121 \begin_body
122
123 \begin_layout Title
124 Introduction to \SpecialChar LyX
125
126 \end_layout
127
128 \begin_layout Author
129 by the \SpecialChar LyX
130  Team
131 \begin_inset Foot
132 status collapsed
133
134 \begin_layout Plain Layout
135 \noindent
136 If you have comments on or corrections to this documentation, please send
137  them to the \SpecialChar LyX
138  Documentation mailing list: 
139 \begin_inset CommandInset href
140 LatexCommand href
141 target "lyx-docs@lists.lyx.org"
142 type "mailto:"
143 literal "false"
144
145 \end_inset
146
147
148 \end_layout
149
150 \end_inset
151
152
153 \end_layout
154
155 \begin_layout Standard
156 \begin_inset CommandInset toc
157 LatexCommand tableofcontents
158
159 \end_inset
160
161
162 \end_layout
163
164 \begin_layout Section
165 The Philosophy of \SpecialChar LyX
166
167 \end_layout
168
169 \begin_layout Subsection
170 What is \SpecialChar LyX
171 ?
172 \end_layout
173
174 \begin_layout Standard
175 \SpecialChar LyX
176  is a document preparation system.
177  It excels at letting you create complex technical and scientific articles
178  with mathematics, cross-references, bibliographies, indexes, etc.
179  It is very good for working with documents of any length in which the usual
180  processing abilities are required: automatic sectioning and pagination,
181  spell checking and so forth.
182  It can also be used to write a letter to your mom, though granted, there
183  are probably simpler programs available for that.
184  It is definitely not the best tool for creating banners, flyers, or advertiseme
185 nts (we'll explain why later), though with some effort all these can be
186  done, too.
187  Here are some examples of what it is used for: memos, letters, dissertations
188  and theses, lecture notes, seminar notebooks, conference proceedings, software
189  documentation, books, articles in refereed scientific journals, scripts
190  for plays and movies, business proposals, presentations \SpecialChar ldots
191
192 \end_layout
193
194 \begin_layout Standard
195
196 \change_deleted 1549938239 1623600899
197 \SpecialChar LyX
198  is a program that provides a modern approach to writing documents with
199  a computer by using a markup language paradigm, an approach that breaks
200  with the obsolete tradition of the 
201 \begin_inset Quotes eld
202 \end_inset
203
204 typewriter concept
205 \begin_inset Quotes erd
206 \end_inset
207
208 .
209  It is designed for authors who want professional output quickly with a
210  minimum of effort and without becoming specialists in typesetting.
211  The job of typesetting is done mostly by the computer, not the author;
212  with \SpecialChar LyX
213 , the author can concentrate on the contents of his writing.
214 \end_layout
215
216 \begin_layout Standard
217 Part of the initial challenge of using \SpecialChar LyX
218  comes from the change in thinking
219  that you, the user, must make.
220  At one time, all we had for creating documents were typewriters, so we
221  all learned certain tricks to get around their limitations.
222  Underlining, which is little more than overstriking with the 
223 \begin_inset Quotes eld
224 \end_inset
225
226 _
227 \begin_inset Quotes erd
228 \end_inset
229
230  character, became a way to emphasize text.
231  You were forced to figure out column sizes and tab stops, and set them,
232  before creating a table.
233  The same applied for letters and other right justified text.
234  Hyphenation at the end of a line required a careful eye and a lot of foresight.
235 \end_layout
236
237 \begin_layout Standard
238 In other words, we've all been trained to worry about the little details
239  of which character goes where.
240  Consequently, almost all word processors have this mentality.
241  They still use tab stops for adding whitespace.
242  You still need to worry about exactly where on the page something will
243  appear.
244  Emphasizing text means changing a font, similar to changing the typewriter
245  wheel.
246  This is the underlying philosophy of a WYSIWYG word processor: 
247 \begin_inset Quotes eld
248 \end_inset
249
250 What You See Is What You Get
251 \begin_inset Quotes erd
252 \end_inset
253
254 .
255  Unfortunately, that paradigm often results in 
256 \begin_inset Quotes eld
257 \end_inset
258
259 What You See Is All You Get
260 \begin_inset Quotes erd
261 \end_inset
262
263 .
264 \end_layout
265
266 \begin_layout Standard
267 This is where \SpecialChar LyX
268  differs from an ordinary word processor.
269  You don't concern yourself with what character goes where.
270  You tell \SpecialChar LyX
271  
272 \emph on
273 what you're doing
274 \emph default
275  and \SpecialChar LyX
276  takes care of the rest, following a set of rules called a 
277 \emph on
278 style
279 \emph default
280 .
281 \change_deleted 1549938239 1623600899
282
283 \begin_inset Foot
284 status collapsed
285
286 \begin_layout Plain Layout
287 To be fair, most recent versions of the most popular office suites now have
288  some sort of style sheets which follow a similar markup method.
289  However, our experience is that they are still rarely used in practice.
290 \end_layout
291
292 \end_inset
293
294
295 \change_unchanged
296  Let's look at a little example:
297 \end_layout
298
299 \begin_layout Standard
300 Suppose you are writing a report.
301  To begin your report, you want a section called 
302 \begin_inset Quotes eld
303 \end_inset
304
305 Introduction\SpecialChar endofsentence
306
307 \begin_inset Quotes erd
308 \end_inset
309
310  So, you go into whatever menu it is in your word processor that changes
311  font sizes and decide on a new font size.
312  Then you turn on bold face.
313  Then you type, 
314 \begin_inset Quotes eld
315 \end_inset
316
317 1.
318 \begin_inset space ~
319 \end_inset
320
321
322 \begin_inset space ~
323 \end_inset
324
325 Introduction
326 \begin_inset Quotes erd
327 \end_inset
328
329 .
330  Of course, if you later decide that this section belongs someplace else
331  in the document or if you insert a new section before it, you need to change
332  the numbering for this and all following sections, as well as any entry
333  in the table of contents.
334 \end_layout
335
336 \begin_layout Standard
337 In \SpecialChar LyX
338 , you go to the pull-down on the far left of the button bar and select
339  
340 \family sans
341 Section
342 \family default
343 , and type 
344 \begin_inset Quotes eld
345 \end_inset
346
347 Introduction
348 \begin_inset Quotes erd
349 \end_inset
350
351 .
352 \end_layout
353
354 \begin_layout Standard
355 Yes, that's all.
356  If you cut and paste the section, it will automatically be renumbered —
357  everywhere.
358  And if you enter references to that section correctly (by inserting cross-refer
359 ence tags), \SpecialChar LyX
360  will automatically update them all throughout the file so that
361  you never, ever type a section number.
362 \end_layout
363
364 \begin_layout Standard
365 Now let's look at the problem of consistency.
366  Five days later, you reopen your report and start Section
367 \begin_inset space ~
368 \end_inset
369
370 4.
371  However, you forget that you were using 18
372 \begin_inset space \thinspace{}
373 \end_inset
374
375 pt bold instead of 16
376 \begin_inset space \thinspace{}
377 \end_inset
378
379 pt, so you type in the heading for Section
380 \begin_inset space ~
381 \end_inset
382
383 4 in a different font from the one you used for Section
384 \begin_inset space ~
385 \end_inset
386
387 1.
388  That problem doesn't even exist in \SpecialChar LyX
389 .
390  The computer takes care of all that silly bookkeeping about which thing
391  has what size font, not you.
392  After all, that's what a computer is good at.
393 \end_layout
394
395 \begin_layout Standard
396 Here's another example.
397  Suppose you're making a list.
398  In other word processors, a list is just a bunch of tab stops and newlines.
399  You need to figure out where to put the label for each list item, what
400  that label should be, how many blank lines to put between each item, and
401  so on.
402  Under \SpecialChar LyX
403 , you have only two concerns: what kind of list is this, and what
404  do I want to put in it? That is it.
405 \end_layout
406
407 \begin_layout Standard
408 So, the basic idea behind \SpecialChar LyX
409  is: specify 
410 \emph on
411 what
412 \emph default
413  you're doing, not 
414 \emph on
415 how
416 \emph default
417  to do it.
418  Instead of 
419 \begin_inset Quotes eld
420 \end_inset
421
422 What You See Is What You Get,
423 \begin_inset Quotes erd
424 \end_inset
425
426  the \SpecialChar LyX
427  model is 
428 \begin_inset Quotes eld
429 \end_inset
430
431 What You See Is What You 
432 \emph on
433 Mean
434 \emph default
435
436 \begin_inset Quotes erd
437 \end_inset
438
439  or 
440 \begin_inset Quotes eld
441 \end_inset
442
443 WYSIWYM.
444 \begin_inset Quotes erd
445 \end_inset
446
447  It's a powerful idea that greatly simplifies the mechanics of writing documents.
448  This is also why \SpecialChar LyX
449  isn't so good for creating posters and flyers.
450  In this case, you 
451 \emph on
452 do
453 \emph default
454  want to specify exactly where everything goes, because there are no functional
455  units like paragraphs, sections, etc.
456  This doesn't mean \SpecialChar LyX
457  is missing some cool function.
458  It simply means that it isn't the right tool for the job — you don't use
459  a screwdriver to dr
460 \change_inserted 1549938239 1623600899
461 ive in nails.
462 \end_layout
463
464 \begin_layout Standard
465
466 \change_inserted 1549938239 1623600899
467 Yes, that's all.
468  If you cut and paste the section, it will automat
469 \change_unchanged
470 i
471 \change_inserted 1549938239 1623600899
472 cally be renumbered — e
473 \change_unchanged
474 v
475 \change_inserted 1549938239 1623600899
476 erywhere.
477  And if you enter references to that section corr
478 \change_unchanged
479 e
480 \change_inserted 1549938239 1623600899
481 ctly (by
482 \change_unchanged
483  in
484 \change_inserted 1549938239 1623600899
485 serting
486 \change_unchanged
487  
488 \change_inserted 1549938239 1623600899
489 cross-refere
490 \change_unchanged
491 n
492 \change_inserted 1549938239 1623600899
493 ce t
494 \change_unchanged
495 a
496 \change_inserted 1549938239 1623600899
497 gs), \SpecialChar LyX
498  will automatically update them all throughout the f
499 \change_unchanged
500 il
501 \change_inserted 1549938239 1623600899
502
503 \change_unchanged
504 s
505 \change_inserted 1549938239 1623600899
506 o that you never, ever type a section number
507 \change_unchanged
508 .
509 \end_layout
510
511 \begin_layout Subsection
512 Differences between \SpecialChar LyX
513  and Other 
514 \change_inserted 1549938239 1623600899
515 (Crappy) 
516 \change_unchanged
517 Word Processors
518 \end_layout
519
520 \begin_layout Standard
521 Here's a list of things you won't find in \SpecialChar LyX
522 :
523 \end_layout
524
525 \begin_layout Itemize
526 The document ruler
527 \end_layout
528
529 \begin_layout Itemize
530 Tab stops
531 \end_layout
532
533 \begin_layout Itemize
534 Extra whitespace (e.
535 \begin_inset space \thinspace{}
536 \end_inset
537
538 g.
539 \begin_inset space \space{}
540 \end_inset
541
542 hitting 
543 \family sans
544 Enter
545 \family default
546  or 
547 \family sans
548 Space
549 \family default
550  two or more times)
551 \end_layout
552
553 \begin_layout Standard
554 Tab stops, along with a ruler showing you the position of things on the
555  page, are useless in \SpecialChar LyX
556 .
557  The program worries about where things go on the page, not you.
558  Extra whitespace is similar; \SpecialChar LyX
559  adds it where necessary, depending on context.
560  Not being able to type two blank lines in a row will be annoying at first,
561  but it makes more sense once you're thinking in WYSIWYM terms.
562 \end_layout
563
564 \begin_layout Standard
565 Here are some things that exist in \SpecialChar LyX
566 , but aren't used as you might think:
567 \end_layout
568
569 \begin_layout Itemize
570 Indenting controls
571 \end_layout
572
573 \begin_layout Itemize
574 Page breaks
575 \end_layout
576
577 \begin_layout Itemize
578 Line spacing (e.
579 \begin_inset space \thinspace{}
580 \end_inset
581
582 g.
583 \begin_inset space \space{}
584 \end_inset
585
586 single spaced, double spaced, etc.)
587 \end_layout
588
589 \begin_layout Itemize
590 Whitespace, horizontal and vertical
591 \end_layout
592
593 \begin_layout Itemize
594 Fonts and font sizes
595 \end_layout
596
597 \begin_layout Itemize
598 Typefaces (bold, italic, underline, etc.)
599 \end_layout
600
601 \begin_layout Standard
602 Although they exist in \SpecialChar LyX
603 , you generally don't need them.
604  \SpecialChar LyX
605  will take care of these things for you, depending on what you're doing.
606  Different parts of the document are automatically set in a different typeface
607  and font size.
608  Paragraph indenting is context dependent; different types of paragraphs
609  get indented differently.
610  Page breaks get handled automatically, as well.
611  In general, the space between lines, between words, and between paragraphs
612  is variable, set by \SpecialChar LyX
613 .
614 \begin_inset Foot
615 status collapsed
616
617 \begin_layout Plain Layout
618 There are ways to adjust all of these (only some of which require knowledge
619  of \SpecialChar LaTeX
620 ), either for a whole document or for a specific location in a document.
621  See the 
622 \emph on
623 User's Guide
624 \emph default
625  and/or the 
626 \emph on
627 Additional Features
628 \emph default
629  manual for details.
630 \end_layout
631
632 \end_inset
633
634
635 \end_layout
636
637 \begin_layout Standard
638 Lastly, there are a few areas where we believe \SpecialChar LyX
639  (and \SpecialChar LaTeX
640 ) surpasses many word
641  processors:
642 \end_layout
643
644 \begin_layout Itemize
645 Hyphenation
646 \end_layout
647
648 \begin_layout Itemize
649 Lists of any type
650 \end_layout
651
652 \begin_layout Itemize
653 Mathematics
654 \end_layout
655
656 \begin_layout Itemize
657 Tables
658 \end_layout
659
660 \begin_layout Itemize
661 Cross-referencing
662 \end_layout
663
664 \begin_layout Standard
665 Granted, many modern word processors can handle mathematical symbols, tables,
666  and hyphenation, and many have moved towards style definitions and the
667  WYSIWYM concept.
668  However, they've only recently been able to do so, whereas \SpecialChar LyX
669  is built upon
670  the \SpecialChar LaTeX
671  document preparation system.
672  \SpecialChar LaTeX
673  has been around since 1985, and 
674 \emph on
675 works
676 \emph default
677 .
678 \end_layout
679
680 \begin_layout Subsection
681 What is \SpecialChar LaTeX
682 ?
683 \end_layout
684
685 \begin_layout Standard
686 \SpecialChar LaTeX
687  is a document preparation system designed by Leslie Lamport in 1985.
688 \begin_inset Foot
689 status collapsed
690
691 \begin_layout Plain Layout
692 The source for the info in this section is 
693 \emph on
694 A Guide to \SpecialChar LaTeX2e
695
696 \emph default
697 , by Helmut Kopka and Patrick Daly, which has an entry in the bibliography
698  of the 
699 \emph on
700 User's Guide
701 \emph default
702 \SpecialChar endofsentence
703
704 \end_layout
705
706 \end_inset
707
708  It was built up from a typesetting language called \SpecialChar TeX
709 , created by Donald
710  Knuth in 1984.
711  \SpecialChar TeX
712  takes a sequence of typesetting commands, written in a script in an ASCII
713  file, and executes them.
714  Many of the 
715 \begin_inset Quotes eld
716 \end_inset
717
718 tricks
719 \begin_inset Quotes erd
720 \end_inset
721
722  of the printing trade were modeled by Knuth as computer algorithms and
723  incorporated into \SpecialChar TeX
724 , hence its excellent printed appearance.
725  What comes directly out of \SpecialChar TeX
726  is the portable document format 
727 \emph on
728 pdf
729 \emph default
730  or the so-called 
731 \begin_inset Quotes eld
732 \end_inset
733
734 device independent
735 \begin_inset Quotes erd
736 \end_inset
737
738  format file 
739 \emph on
740 dvi
741 \emph default
742 .
743  The dvi format is often used for previews and can later be converted to
744  other formats like PostScript.
745  
746 \end_layout
747
748 \begin_layout Standard
749 \SpecialChar TeX
750  isn't only a typesetting engine; it also allows you to define macros.
751  Most people who use \SpecialChar TeX
752  are actually using a macro package which Knuth created
753  to hide a lot of the typesetting details.
754  This is where Leslie Lamport enters our story.
755  He wanted a macro package that was more user- and less typesetter-oriented,
756  with a set of commands that consistently typeset things like sections,
757  tables or math formulas in a uniform, consistent fashion.
758  This is how \SpecialChar LaTeX
759  was born.
760 \end_layout
761
762 \begin_layout Standard
763 Now, in parallel with the development and growth of \SpecialChar LaTeX
764 , other folks were creating
765  their own custom macro packages for \SpecialChar TeX
766 , ones to make slides or articles for
767  math journals and so on.
768  Some used the raw \SpecialChar TeX
769  facilities to do this, others began modifying \SpecialChar LaTeX
770 .
771  To try and unify this mess, a team of \SpecialChar LaTeX
772 -nicians began to work on \SpecialChar LaTeX2e
773 , the current
774  version of \SpecialChar LaTeX
775 , during the late 1980's.
776  This new version of \SpecialChar LaTeX
777  has commands which provide an easier-to-use interface
778  to \SpecialChar TeX
779 's macro-creating commands, aid in the use of new fonts, and so on.
780  In fact, \SpecialChar LaTeX
781  is quite an extensive language in its own right! Users around
782  the world have been creating their own add-ons for \SpecialChar LaTeX
783  beyond the standard
784  ones.
785 \end_layout
786
787 \begin_layout Standard
788 There are two ways to extend \SpecialChar LaTeX
789 : classes and styles.
790  A 
791 \emph on
792 class
793 \emph default
794  is a set of \SpecialChar LaTeX
795  macros describing a new type of document, like a book, or
796  an article.
797  There are classes for slides, for physics and math journals\SpecialChar ldots
798  many universities
799  even have a class for their thesis format.
800  A 
801 \emph on
802 style
803 \emph default
804  differs from a class in that it doesn't define a new type of document,
805  but a different type of 
806 \emph on
807 behavior
808 \emph default
809  that any document can use.
810  For example, \SpecialChar LyX
811  controls page margins and line spacing using two different
812  \SpecialChar LaTeX
813  style-files designed for these purposes.
814  There are style-files for a whole slew of things: printing labels or envelopes,
815  changing indentation behavior, adding new fonts, manipulating graphics,
816  designing fancy page headings, customizing bibliographies, altering the
817  location and appearance of footnotes, tables, and figures, customizing
818  lists, etc.
819 \end_layout
820
821 \begin_layout Standard
822 Here is a summary:
823 \end_layout
824
825 \begin_layout Description
826 \SpecialChar TeX
827 : Typesetting language with macro capability.
828 \end_layout
829
830 \begin_layout Description
831 \SpecialChar LaTeX
832 : Macro package built upon \SpecialChar TeX
833 \SpecialChar endofsentence
834
835 \end_layout
836
837 \begin_layout Description
838 classes: Descriptions of types of document used with \SpecialChar LaTeX
839 \SpecialChar endofsentence
840
841 \end_layout
842
843 \begin_layout Description
844 styles: Descriptions of the default behavior of particular elements of \SpecialChar LaTeX
845 .
846 \end_layout
847
848 \begin_layout Description
849 \SpecialChar LyX
850 : Visual, WYSIWYM document processor that uses \SpecialChar LaTeX
851  to do its typesetting.
852 \end_layout
853
854 \begin_layout Standard
855 This section attempts to explain the difference between \SpecialChar LyX
856  and a word processor.
857  Simply put, \SpecialChar LaTeX
858  is the difference.
859  By using \SpecialChar LaTeX
860  as its backend, \SpecialChar LyX
861  helps you to think more about
862 \emph on
863  what
864 \emph default
865  (as in the 
866 \emph on
867 words
868 \emph default
869 ) you write.
870  The computer then handles 
871 \emph on
872 how
873 \emph default
874  they should look.
875 \end_layout
876
877 \begin_layout Section
878 Navigating the Documentation
879 \end_layout
880
881 \begin_layout Standard
882 To make it easier to answer your questions and describe all of the features
883  of \SpecialChar LyX
884 , the documentation has been split up into several different files.
885  Each one has its own purpose, as described below.
886  Before you go ploughing into any of those files, however, you should read
887  this chapter thoroughly, since it contains a lot of useful information
888  and commentary that can save you some time.
889 \end_layout
890
891 \begin_layout Standard
892 Hopefully, the development of \SpecialChar LyX
893  will never stop; so some of the documentation
894  may be incomplete or a bit out of date, though we try to keep up-to-date.
895  Like the rest of \SpecialChar LyX
896 , the manuals are the work of a group of volunteers who
897  have 
898 \begin_inset Quotes eld
899 \end_inset
900
901 Real Jobs
902 \begin_inset Quotes erd
903 \end_inset
904
905 , families, dishes to clean, 
906 \emph on
907 et cetera
908 \emph default
909 .
910  If you want to help out, be sure to read Section
911 \begin_inset space ~
912 \end_inset
913
914
915 \begin_inset CommandInset ref
916 LatexCommand ref
917 reference "sec:Contrib"
918
919 \end_inset
920
921  in addition to the rest of this document.
922 \end_layout
923
924 \begin_layout Standard
925 Also, please do us a favor – if anything in these manuals confuses you,
926  is unclear, or wrong, don't hesitate to let us know! You can reach the
927  current document maintainers by emailing 
928 \begin_inset CommandInset href
929 LatexCommand href
930 target "lyx-docs@lists.lyx.org"
931 type "mailto:"
932 literal "false"
933
934 \end_inset
935
936 .
937  If you have questions that are not obviously answered in the documentation,
938  and need help fast, there is an active users' mailing list which you can
939  reach at 
940 \begin_inset CommandInset href
941 LatexCommand href
942 target "lyx-users@lists.lyx.org"
943 type "mailto:"
944 literal "false"
945
946 \end_inset
947
948 .
949 \end_layout
950
951 \begin_layout Subsection
952 The Format of the Manuals
953 \end_layout
954
955 \begin_layout Standard
956 Some of you may have printed out the manuals.
957  Others may be reading them within \SpecialChar LyX
958 .
959  There are some differences between the \SpecialChar LyX
960 -file and the printed version.
961  In \SpecialChar LyX
962 , the title is simply at the top of the document, not formatted on a
963  separate page as in some of the printed versions.
964  Nor are any of the footnotes or the Table of Contents fully visible.
965  To open a footnote, which looks like this: 
966 \begin_inset Graphics
967         filename ../../../../lib/doc/clipart/footnote.png
968         scale 95
969
970 \end_inset
971
972 , click on it with the left mouse button.
973  For the Table of Contents, either click on the grey box or click on the
974  
975 \family sans
976 Navigate
977 \family default
978  menu, where the contents are displayed automatically\SpecialChar endofsentence
979
980 \end_layout
981
982 \begin_layout Standard
983 In the printed manuals, all cross-references appear as the actual numbers
984  for a chapter, section, subsection, and so on.
985  In the \SpecialChar LyX
986 -file, however, all cross-references appear as light-grey boxes
987  like the following: 
988 \begin_inset Graphics
989         filename ../../../../lib/doc/clipart/reference.png
990         scale 95
991
992 \end_inset
993
994 .
995  If you click on such a box with the left mouse button, a dialog box will
996  appear containing a list of all the cross-references in the document.
997  You can go to the referenced section by right-clicking on the box or by
998  clicking the button 
999 \family sans
1000 Go
1001 \begin_inset space ~
1002 \end_inset
1003
1004 to
1005 \begin_inset space ~
1006 \end_inset
1007
1008 Label
1009 \family default
1010  in the opened dialog.
1011  Going back to where you came from is just as easy.
1012  Click on 
1013 \family sans
1014 Go
1015 \begin_inset space ~
1016 \end_inset
1017
1018 Back
1019 \family default
1020  to go back to your earlier location.
1021 \end_layout
1022
1023 \begin_layout Standard
1024 Now that we've cleared up some of the differences between the printed and
1025  \SpecialChar LyX
1026 -file versions of this file, we can start looking at the format of this
1027  document.
1028  You'll occasionally notice things in different fonts:
1029 \end_layout
1030
1031 \begin_layout Itemize
1032
1033 \emph on
1034 Emphasized Style
1035 \emph default
1036  is used for general emphasis, generic arguments, book titles, names of
1037  sections of other manuals, and notes from the authors.
1038 \end_layout
1039
1040 \begin_layout Itemize
1041
1042 \family typewriter
1043 Typewriter
1044 \family default
1045  is used for program and file names, \SpecialChar LyX
1046  code and functions.
1047 \end_layout
1048
1049 \begin_layout Itemize
1050
1051 \family sans
1052 Sans Serif
1053 \family default
1054  is used for menu, button, or dialog box names, and the names of keyboard
1055  keys.
1056 \end_layout
1057
1058 \begin_layout Itemize
1059
1060 \noun on
1061 Noun Style
1062 \noun default
1063  is used for people's names.
1064 \end_layout
1065
1066 \begin_layout Itemize
1067
1068 \series bold
1069 Bold
1070 \series default
1071  is used for \SpecialChar LaTeX
1072  code
1073 \end_layout
1074
1075 \begin_layout Standard
1076 When we do need to reference keys, we'll use the following prefixing convention:
1077 \end_layout
1078
1079 \begin_layout Itemize
1080 \begin_inset Quotes eld
1081 \end_inset
1082
1083
1084 \family sans
1085 Ctrl+
1086 \family default
1087
1088 \begin_inset Quotes erd
1089 \end_inset
1090
1091  indicates the 
1092 \family sans
1093 Control
1094 \family default
1095  key.
1096 \end_layout
1097
1098 \begin_layout Itemize
1099 \begin_inset Quotes eld
1100 \end_inset
1101
1102
1103 \family sans
1104 Shift+
1105 \family default
1106
1107 \begin_inset Quotes erd
1108 \end_inset
1109
1110  indicates the 
1111 \family sans
1112 Shift
1113 \family default
1114  key.
1115 \end_layout
1116
1117 \begin_layout Itemize
1118 \begin_inset Quotes eld
1119 \end_inset
1120
1121
1122 \family sans
1123 Alt+
1124 \family default
1125
1126 \begin_inset Quotes erd
1127 \end_inset
1128
1129  indicates the 
1130 \family sans
1131 Alt
1132 \family default
1133  (
1134 \family sans
1135 Meta
1136 \family default
1137 ) key.
1138 \end_layout
1139
1140 \begin_layout Itemize
1141 \begin_inset Quotes eld
1142 \end_inset
1143
1144
1145 \family sans
1146 F1
1147 \family default
1148
1149 \begin_inset Quotes erd
1150 \end_inset
1151
1152  \SpecialChar ldots
1153  
1154 \begin_inset Quotes eld
1155 \end_inset
1156
1157
1158 \family sans
1159 F12
1160 \family default
1161
1162 \begin_inset Quotes erd
1163 \end_inset
1164
1165  are the function keys.
1166 \end_layout
1167
1168 \begin_layout Itemize
1169 \begin_inset Quotes eld
1170 \end_inset
1171
1172
1173 \family sans
1174 Esc
1175 \family default
1176
1177 \begin_inset Quotes erd
1178 \end_inset
1179
1180  is the escape key.
1181 \end_layout
1182
1183 \begin_layout Itemize
1184 \begin_inset Quotes eld
1185 \end_inset
1186
1187
1188 \family sans
1189 Left
1190 \family default
1191
1192 \begin_inset Quotes erd
1193 \end_inset
1194
1195  
1196 \begin_inset Quotes eld
1197 \end_inset
1198
1199
1200 \family sans
1201 Right
1202 \family default
1203
1204 \begin_inset Quotes erd
1205 \end_inset
1206
1207  
1208 \begin_inset Quotes eld
1209 \end_inset
1210
1211
1212 \family sans
1213 Up
1214 \family default
1215
1216 \begin_inset Quotes erd
1217 \end_inset
1218
1219  
1220 \begin_inset Quotes eld
1221 \end_inset
1222
1223
1224 \family sans
1225 Down
1226 \family default
1227
1228 \begin_inset Quotes erd
1229 \end_inset
1230
1231 : self-explanatory.
1232 \end_layout
1233
1234 \begin_layout Itemize
1235
1236 \family sans
1237 \begin_inset Quotes eld
1238 \end_inset
1239
1240 Insert
1241 \family default
1242
1243 \begin_inset Quotes erd
1244 \end_inset
1245
1246  
1247 \begin_inset Quotes eld
1248 \end_inset
1249
1250
1251 \family sans
1252 Delete
1253 \family default
1254
1255 \begin_inset Quotes erd
1256 \end_inset
1257
1258  
1259 \begin_inset Quotes eld
1260 \end_inset
1261
1262
1263 \family sans
1264 Home
1265 \family default
1266
1267 \begin_inset Quotes erd
1268 \end_inset
1269
1270  
1271 \begin_inset Quotes eld
1272 \end_inset
1273
1274
1275 \family sans
1276 End
1277 \family default
1278
1279 \begin_inset Quotes erd
1280 \end_inset
1281
1282  
1283 \begin_inset Quotes eld
1284 \end_inset
1285
1286
1287 \family sans
1288 PageUp
1289 \family default
1290
1291 \begin_inset Quotes erd
1292 \end_inset
1293
1294  
1295 \begin_inset Quotes eld
1296 \end_inset
1297
1298
1299 \family sans
1300 PageDown
1301 \family default
1302
1303 \begin_inset Quotes erd
1304 \end_inset
1305
1306 : these are the 6
1307 \begin_inset space ~
1308 \end_inset
1309
1310 keys that appear above the cursor keys on many PC keyboards.
1311  
1312 \begin_inset Quotes eld
1313 \end_inset
1314
1315
1316 \family sans
1317 PageUp
1318 \family default
1319
1320 \begin_inset Quotes erd
1321 \end_inset
1322
1323  and 
1324 \begin_inset Quotes eld
1325 \end_inset
1326
1327
1328 \family sans
1329 PageDown
1330 \family default
1331
1332 \begin_inset Quotes erd
1333 \end_inset
1334
1335  are called 
1336 \begin_inset Quotes eld
1337 \end_inset
1338
1339
1340 \family sans
1341 Prior
1342 \family default
1343
1344 \begin_inset Quotes erd
1345 \end_inset
1346
1347  and 
1348 \begin_inset Quotes eld
1349 \end_inset
1350
1351
1352 \family sans
1353 Next
1354 \family default
1355
1356 \begin_inset Quotes erd
1357 \end_inset
1358
1359  on some keyboards.
1360 \end_layout
1361
1362 \begin_layout Itemize
1363
1364 \family sans
1365 Return
1366 \family default
1367  and 
1368 \family sans
1369 Enter
1370 \family default
1371  both refer to the same key.
1372  Some keyboards label the 
1373 \family sans
1374 Return
1375 \family default
1376  key as 
1377 \begin_inset Quotes eld
1378 \end_inset
1379
1380 Return,
1381 \begin_inset Quotes erd
1382 \end_inset
1383
1384  others as 
1385 \begin_inset Quotes eld
1386 \end_inset
1387
1388 Enter,
1389 \begin_inset Quotes erd
1390 \end_inset
1391
1392  still others have two keys.
1393  \SpecialChar LyX
1394  treats all of them as the same key, so we'll use 
1395 \family sans
1396 Return
1397 \family default
1398  and 
1399 \family sans
1400 Enter
1401 \family default
1402  interchangeably.
1403 \end_layout
1404
1405 \begin_layout Standard
1406 The list with the currently set shortcuts can be found in the 
1407 \family sans
1408 Help
1409 \family default
1410  menu under 
1411 \family sans
1412 Shortcuts
1413 \family default
1414 .
1415 \end_layout
1416
1417 \begin_layout Subsection
1418 Units used in the Manuals
1419 \end_layout
1420
1421 \begin_layout Standard
1422 To understand the units described in this documentation, Table
1423 \begin_inset space ~
1424 \end_inset
1425
1426
1427 \begin_inset CommandInset ref
1428 LatexCommand ref
1429 reference "tab:Units"
1430
1431 \end_inset
1432
1433  explains all units available in \SpecialChar LyX
1434 .
1435 \end_layout
1436
1437 \begin_layout Standard
1438 \begin_inset Float table
1439 placement document
1440 alignment document
1441 wide false
1442 sideways false
1443 status open
1444
1445 \begin_layout Plain Layout
1446 \begin_inset Caption Standard
1447
1448 \begin_layout Plain Layout
1449 \begin_inset CommandInset label
1450 LatexCommand label
1451 name "tab:Units"
1452
1453 \end_inset
1454
1455 Units
1456 \end_layout
1457
1458 \end_inset
1459
1460
1461 \end_layout
1462
1463 \begin_layout Plain Layout
1464 \begin_inset VSpace medskip
1465 \end_inset
1466
1467
1468 \end_layout
1469
1470 \begin_layout Plain Layout
1471 \align center
1472 \begin_inset Tabular
1473 <lyxtabular version="3" rows="20" columns="2">
1474 <features booktabs="true" tabularvalignment="middle">
1475 <column alignment="center" valignment="top" width="0pt">
1476 <column alignment="center" valignment="top">
1477 <row>
1478 <cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
1479 \begin_inset Text
1480
1481 \begin_layout Plain Layout
1482 unit
1483 \end_layout
1484
1485 \end_inset
1486 </cell>
1487 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1488 \begin_inset Text
1489
1490 \begin_layout Plain Layout
1491 name/description
1492 \end_layout
1493
1494 \end_inset
1495 </cell>
1496 </row>
1497 <row>
1498 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1499 \begin_inset Text
1500
1501 \begin_layout Plain Layout
1502 mm
1503 \end_layout
1504
1505 \end_inset
1506 </cell>
1507 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1508 \begin_inset Text
1509
1510 \begin_layout Plain Layout
1511 millimeter
1512 \end_layout
1513
1514 \end_inset
1515 </cell>
1516 </row>
1517 <row>
1518 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1519 \begin_inset Text
1520
1521 \begin_layout Plain Layout
1522 cm
1523 \end_layout
1524
1525 \end_inset
1526 </cell>
1527 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1528 \begin_inset Text
1529
1530 \begin_layout Plain Layout
1531 centimeter
1532 \end_layout
1533
1534 \end_inset
1535 </cell>
1536 </row>
1537 <row>
1538 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1539 \begin_inset Text
1540
1541 \begin_layout Plain Layout
1542 in
1543 \end_layout
1544
1545 \end_inset
1546 </cell>
1547 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1548 \begin_inset Text
1549
1550 \begin_layout Plain Layout
1551 inch (1
1552 \begin_inset space \thinspace{}
1553 \end_inset
1554
1555 in = 2.54
1556 \begin_inset space \thinspace{}
1557 \end_inset
1558
1559 cm)
1560 \end_layout
1561
1562 \end_inset
1563 </cell>
1564 </row>
1565 <row>
1566 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1567 \begin_inset Text
1568
1569 \begin_layout Plain Layout
1570 pt
1571 \end_layout
1572
1573 \end_inset
1574 </cell>
1575 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1576 \begin_inset Text
1577
1578 \begin_layout Plain Layout
1579 point (72.27
1580 \begin_inset space \thinspace{}
1581 \end_inset
1582
1583 pt = 1
1584 \begin_inset space \thinspace{}
1585 \end_inset
1586
1587 in)
1588 \end_layout
1589
1590 \end_inset
1591 </cell>
1592 </row>
1593 <row>
1594 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1595 \begin_inset Text
1596
1597 \begin_layout Plain Layout
1598 pc
1599 \end_layout
1600
1601 \end_inset
1602 </cell>
1603 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1604 \begin_inset Text
1605
1606 \begin_layout Plain Layout
1607 pica (1
1608 \begin_inset space \thinspace{}
1609 \end_inset
1610
1611 pc = 12
1612 \begin_inset space \thinspace{}
1613 \end_inset
1614
1615 pt)
1616 \end_layout
1617
1618 \end_inset
1619 </cell>
1620 </row>
1621 <row>
1622 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1623 \begin_inset Text
1624
1625 \begin_layout Plain Layout
1626 sp
1627 \end_layout
1628
1629 \end_inset
1630 </cell>
1631 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1632 \begin_inset Text
1633
1634 \begin_layout Plain Layout
1635 scaled point (65536
1636 \begin_inset space \thinspace{}
1637 \end_inset
1638
1639 sp = 1
1640 \begin_inset space \thinspace{}
1641 \end_inset
1642
1643 pt)
1644 \end_layout
1645
1646 \end_inset
1647 </cell>
1648 </row>
1649 <row>
1650 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1651 \begin_inset Text
1652
1653 \begin_layout Plain Layout
1654 bp
1655 \end_layout
1656
1657 \end_inset
1658 </cell>
1659 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1660 \begin_inset Text
1661
1662 \begin_layout Plain Layout
1663 big point (72
1664 \begin_inset space \thinspace{}
1665 \end_inset
1666
1667 bp = 1
1668 \begin_inset space \thinspace{}
1669 \end_inset
1670
1671 in)
1672 \end_layout
1673
1674 \end_inset
1675 </cell>
1676 </row>
1677 <row>
1678 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1679 \begin_inset Text
1680
1681 \begin_layout Plain Layout
1682 dd
1683 \end_layout
1684
1685 \end_inset
1686 </cell>
1687 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1688 \begin_inset Text
1689
1690 \begin_layout Plain Layout
1691 didot (72
1692 \begin_inset space \thinspace{}
1693 \end_inset
1694
1695 dd 
1696 \begin_inset Formula $\approx$
1697 \end_inset
1698
1699  37.6
1700 \begin_inset space \thinspace{}
1701 \end_inset
1702
1703 mm)
1704 \end_layout
1705
1706 \end_inset
1707 </cell>
1708 </row>
1709 <row>
1710 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1711 \begin_inset Text
1712
1713 \begin_layout Plain Layout
1714 cc
1715 \end_layout
1716
1717 \end_inset
1718 </cell>
1719 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1720 \begin_inset Text
1721
1722 \begin_layout Plain Layout
1723 cicero (1
1724 \begin_inset space \thinspace{}
1725 \end_inset
1726
1727 cc = 12
1728 \begin_inset space \thinspace{}
1729 \end_inset
1730
1731 dd)
1732 \end_layout
1733
1734 \end_inset
1735 </cell>
1736 </row>
1737 <row>
1738 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1739 \begin_inset Text
1740
1741 \begin_layout Plain Layout
1742 Scale%
1743 \end_layout
1744
1745 \end_inset
1746 </cell>
1747 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1748 \begin_inset Text
1749
1750 \begin_layout Plain Layout
1751 % of original image width
1752 \end_layout
1753
1754 \end_inset
1755 </cell>
1756 </row>
1757 <row>
1758 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1759 \begin_inset Text
1760
1761 \begin_layout Plain Layout
1762 text%
1763 \end_layout
1764
1765 \end_inset
1766 </cell>
1767 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1768 \begin_inset Text
1769
1770 \begin_layout Plain Layout
1771 % of text width
1772 \end_layout
1773
1774 \end_inset
1775 </cell>
1776 </row>
1777 <row>
1778 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1779 \begin_inset Text
1780
1781 \begin_layout Plain Layout
1782 col%
1783 \end_layout
1784
1785 \end_inset
1786 </cell>
1787 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1788 \begin_inset Text
1789
1790 \begin_layout Plain Layout
1791 % of column width
1792 \end_layout
1793
1794 \end_inset
1795 </cell>
1796 </row>
1797 <row>
1798 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1799 \begin_inset Text
1800
1801 \begin_layout Plain Layout
1802 page%
1803 \end_layout
1804
1805 \end_inset
1806 </cell>
1807 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1808 \begin_inset Text
1809
1810 \begin_layout Plain Layout
1811 % of paper width
1812 \end_layout
1813
1814 \end_inset
1815 </cell>
1816 </row>
1817 <row>
1818 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1819 \begin_inset Text
1820
1821 \begin_layout Plain Layout
1822 line%
1823 \end_layout
1824
1825 \end_inset
1826 </cell>
1827 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1828 \begin_inset Text
1829
1830 \begin_layout Plain Layout
1831 % of line width
1832 \end_layout
1833
1834 \end_inset
1835 </cell>
1836 </row>
1837 <row>
1838 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1839 \begin_inset Text
1840
1841 \begin_layout Plain Layout
1842 theight%
1843 \end_layout
1844
1845 \end_inset
1846 </cell>
1847 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1848 \begin_inset Text
1849
1850 \begin_layout Plain Layout
1851 % of text height
1852 \end_layout
1853
1854 \end_inset
1855 </cell>
1856 </row>
1857 <row>
1858 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1859 \begin_inset Text
1860
1861 \begin_layout Plain Layout
1862 pheight%
1863 \end_layout
1864
1865 \end_inset
1866 </cell>
1867 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1868 \begin_inset Text
1869
1870 \begin_layout Plain Layout
1871 % of paper height
1872 \end_layout
1873
1874 \end_inset
1875 </cell>
1876 </row>
1877 <row>
1878 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1879 \begin_inset Text
1880
1881 \begin_layout Plain Layout
1882 ex
1883 \end_layout
1884
1885 \end_inset
1886 </cell>
1887 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1888 \begin_inset Text
1889
1890 \begin_layout Plain Layout
1891 height of letter 
1892 \emph on
1893 x
1894 \emph default
1895  in current font
1896 \end_layout
1897
1898 \end_inset
1899 </cell>
1900 </row>
1901 <row>
1902 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1903 \begin_inset Text
1904
1905 \begin_layout Plain Layout
1906 em
1907 \end_layout
1908
1909 \end_inset
1910 </cell>
1911 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1912 \begin_inset Text
1913
1914 \begin_layout Plain Layout
1915 width of letter 
1916 \emph on
1917 M
1918 \emph default
1919  in current font
1920 \end_layout
1921
1922 \end_inset
1923 </cell>
1924 </row>
1925 <row>
1926 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1927 \begin_inset Text
1928
1929 \begin_layout Plain Layout
1930 mu
1931 \end_layout
1932
1933 \end_inset
1934 </cell>
1935 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1936 \begin_inset Text
1937
1938 \begin_layout Plain Layout
1939 math unit (1
1940 \begin_inset space \thinspace{}
1941 \end_inset
1942
1943 mu = 1/18
1944 \begin_inset space \thinspace{}
1945 \end_inset
1946
1947 em)
1948 \end_layout
1949
1950 \end_inset
1951 </cell>
1952 </row>
1953 </lyxtabular>
1954
1955 \end_inset
1956
1957
1958 \end_layout
1959
1960 \end_inset
1961
1962
1963 \end_layout
1964
1965 \begin_layout Subsection
1966 The Manuals
1967 \end_layout
1968
1969 \begin_layout Standard
1970 The following list describes the contents of the basic documentation files
1971  that you find in the 
1972 \family sans
1973 Help
1974 \family default
1975  menu:
1976 \end_layout
1977
1978 \begin_layout Description
1979 Introduction This file.
1980 \end_layout
1981
1982 \begin_layout Description
1983 Tutorial If you are new to \SpecialChar LyX
1984 , and have never used \SpecialChar LaTeX
1985  before, you should start
1986  here.
1987  If you have used \SpecialChar LaTeX
1988  before, you should still read the 
1989 \emph on
1990 Tutorial
1991 \emph default
1992 , starting with the section on 
1993 \begin_inset Quotes eld
1994 \end_inset
1995
1996 \SpecialChar LyX
1997  for \SpecialChar LaTeX
1998  users.
1999 \begin_inset Quotes erd
2000 \end_inset
2001
2002  (Skimming through the rest of the document wouldn't hurt, either.)
2003 \end_layout
2004
2005 \begin_layout Description
2006 User's
2007 \begin_inset space ~
2008 \end_inset
2009
2010 Guide The primary documentation.
2011  We'll cover 
2012 \emph on
2013 most
2014 \emph default
2015  of the basic operation and available features of \SpecialChar LyX
2016  here.
2017  The main manual assumes that you have read the 
2018 \emph on
2019 Tutorial
2020 \emph default
2021 .
2022 \end_layout
2023
2024 \begin_layout Description
2025 Embedded
2026 \begin_inset space ~
2027 \end_inset
2028
2029 Objects Extension of the 
2030 \emph on
2031 User's Guide
2032 \emph default
2033 .
2034  Documents in detail how to use tables, graphics, floats, notes, program
2035  listings and boxes.
2036  It also includes many tricks of the \SpecialChar LaTeX
2037  masters.
2038 \end_layout
2039
2040 \begin_layout Description
2041 Math Extension of the 
2042 \emph on
2043 User's Guide
2044 \emph default
2045 .
2046  Documents in detail how to typeset any kind of formula.
2047 \end_layout
2048
2049 \begin_layout Description
2050 Additional
2051 \begin_inset space ~
2052 \end_inset
2053
2054 Features Extension of the 
2055 \emph on
2056 User's Guide
2057 \emph default
2058 .
2059  Documents how to use raw \SpecialChar LaTeX
2060  commands, additional layouts and special-purpose
2061  editing features.
2062 \end_layout
2063
2064 \begin_layout Description
2065 Customization A description of advanced \SpecialChar LyX
2066  features, including how to customize
2067  the overall behavior of \SpecialChar LyX
2068 \SpecialChar endofsentence
2069  This includes such things as keybindings, internationa
2070 lization and configuration files.
2071  It also includes information about layout files, which are needed to get
2072  \SpecialChar LyX
2073  to support \SpecialChar LaTeX
2074  classes or packages.
2075 \end_layout
2076
2077 \begin_layout Description
2078 Shortcuts Tables of the currently defined \SpecialChar LyX
2079  shortcuts.
2080 \end_layout
2081
2082 \begin_layout Description
2083 \SpecialChar LaTeX
2084
2085 \begin_inset space ~
2086 \end_inset
2087
2088 Configuration A report produced by \SpecialChar LyX
2089  about your system.
2090  This file contains information on what \SpecialChar LyX
2091  learned about your installation.
2092  Check it to see if you're missing something you might like to have.
2093 \end_layout
2094
2095 \begin_layout Standard
2096 These files will reference one another as necessary.
2097  For example, the 
2098 \emph on
2099 User's Guide
2100 \emph default
2101  contains 
2102 \emph on
2103 some
2104 \emph default
2105  information on installation and customization, but refers the reader to
2106  the 
2107 \emph on
2108 Customization Manual
2109 \emph default
2110  for more information.
2111 \end_layout
2112
2113 \begin_layout Standard
2114 We'll state again an important point:
2115 \end_layout
2116
2117 \begin_layout Standard
2118 \begin_inset VSpace bigskip
2119 \end_inset
2120
2121
2122 \end_layout
2123
2124 \begin_layout Standard
2125 \align center
2126 If you are new to \SpecialChar LyX
2127 , read the 
2128 \emph on
2129 Tutorial
2130 \emph default
2131 .
2132  Now\SpecialChar endofsentence
2133
2134 \end_layout
2135
2136 \begin_layout Standard
2137 \begin_inset VSpace bigskip
2138 \end_inset
2139
2140
2141 \end_layout
2142
2143 \begin_layout Standard
2144 Otherwise, you could needlessly frustrate yourself.
2145 \end_layout
2146
2147 \begin_layout Section
2148 Contributing to the \SpecialChar LyX
2149  Project
2150 \begin_inset CommandInset label
2151 LatexCommand label
2152 name "sec:Contrib"
2153
2154 \end_inset
2155
2156
2157 \end_layout
2158
2159 \begin_layout Subsection
2160 Contributing to \SpecialChar LyX
2161
2162 \end_layout
2163
2164 \begin_layout Standard
2165 \SpecialChar LyX
2166  is mostly written in C++ (the \SpecialChar LaTeX
2167  importer is written in Python).
2168  It is a large project, and as a result it is not free from bugs, or the
2169  need for improvements in the source code.
2170 \end_layout
2171
2172 \begin_layout Subsubsection
2173 Reporting a bug
2174 \end_layout
2175
2176 \begin_layout Standard
2177 While using \SpecialChar LyX
2178 , you may find behavior which you consider a bug.
2179  Crashes, though rare, can happen.
2180  User interface problems are considered major bugs by the \SpecialChar LyX
2181  team: especially
2182  helpful are indications of parts of the \SpecialChar LyX
2183  interface you find confusing,
2184  or unclear.
2185 \end_layout
2186
2187 \begin_layout Standard
2188 \SpecialChar LyX
2189  has a bug tracking system, which you can find at
2190 \begin_inset Newline newline
2191 \end_inset
2192
2193
2194 \begin_inset CommandInset href
2195 LatexCommand href
2196 target "https://www.lyx.org/trac/wiki/BugTrackerHome"
2197
2198 \end_inset
2199
2200 .
2201  You should check the bug tracker before reporting any bugs, in case it
2202  has already been reported.
2203  If you have a comment on an existing bug, or wish to report a new bug,
2204  you may either use the bug tracker, or send an e-mail to the development
2205  mailing list, 
2206 \begin_inset CommandInset href
2207 LatexCommand href
2208 target "lyx-devel@lists.lyx.org"
2209 type "mailto:"
2210 literal "false"
2211
2212 \end_inset
2213
2214 .
2215  Archives of this list are linked from the main \SpecialChar LyX
2216  website, 
2217 \begin_inset CommandInset href
2218 LatexCommand href
2219 target "http://www.lyx.org"
2220
2221 \end_inset
2222
2223 .
2224 \end_layout
2225
2226 \begin_layout Standard
2227 A useful bug report will at a minimum include the version of \SpecialChar LyX
2228  you are having
2229  the problem with.
2230  Accurate, detailed descriptions are preferred — the more time developers
2231  have to spend to pinpoint the source of a bug, the less time they have
2232  for other improvements.
2233  Mention the system and system version on which you are running \SpecialChar LyX
2234 .
2235  Give the versions of the libraries you have installed on your system, and,
2236  if relevant, the versions of external programs that \SpecialChar LyX
2237  uses.
2238  If it's a compilation or configuration problem, include the file 
2239 \family typewriter
2240 config.log
2241 \family default
2242 , and mention which compiler you are using.
2243 \end_layout
2244
2245 \begin_layout Subsubsection
2246 Contributing fixes and new features
2247 \end_layout
2248
2249 \begin_layout Standard
2250 If you have made changes to \SpecialChar LyX
2251 's source that you think should become part
2252  of \SpecialChar LyX
2253 , send your changes as a diff file (in unified format) to the development
2254  list referenced above, along with a change log, and a description of what
2255  your patch does.
2256 \end_layout
2257
2258 \begin_layout Subsection
2259 Contributing to the Documentation
2260 \end_layout
2261
2262 \begin_layout Standard
2263 \SpecialChar LyX
2264 's documentation is extensive; however \SpecialChar LyX
2265  is under constant development, and
2266  each new release adds new features.
2267  You may find some documentation needs improvement.
2268  This section describes what to do if you find an error, or have some suggestion
2269 s for improving the documentation.
2270 \end_layout
2271
2272 \begin_layout Subsubsection
2273 Reporting Errors in the Manuals
2274 \end_layout
2275
2276 \begin_layout Standard
2277 If you find a problem with the documentation, send a message to the mailing
2278  list 
2279 \begin_inset CommandInset href
2280 LatexCommand href
2281 target "lyx-docs@lists.lyx.org"
2282 type "mailto:"
2283 literal "false"
2284
2285 \end_inset
2286
2287 .
2288  The documentation team will make any necessary fixes.
2289 \end_layout
2290
2291 \begin_layout Subsubsection
2292 Joining the Documentation Team.
2293 \end_layout
2294
2295 \begin_layout Standard
2296 The \SpecialChar LyX
2297  Documentation Project, like anything else in the \SpecialChar LyX
2298  project, can always
2299  use assistance! If you're interested in contributing to the Documentation
2300  Project, you need to do the following:
2301 \end_layout
2302
2303 \begin_layout Enumerate
2304 Get the latest \SpecialChar LyX
2305  source code from 
2306 \begin_inset Newline newline
2307 \end_inset
2308
2309
2310 \begin_inset CommandInset href
2311 LatexCommand href
2312 target "https://www.lyx.org/trac/browser/lyxgit/lib/doc?rev=master "
2313
2314 \end_inset
2315
2316
2317 \end_layout
2318
2319 \begin_layout Enumerate
2320 Next, read the 
2321 \emph on
2322 User's Guide
2323 \emph default
2324  and the 
2325 \emph on
2326 Tutorial
2327 \emph default
2328
2329 \begin_inset Newline newline
2330 \end_inset
2331
2332 The point of this exercise is to give you ideas.
2333  The 
2334 \emph on
2335 Tutorial
2336 \emph default
2337  and 
2338 \emph on
2339 User's Guide
2340 \emph default
2341  are likely to be the most up-to-date of all of the documentation.
2342  You should be able to glean some insights into how we want the manuals
2343  to read and to look.
2344 \end_layout
2345
2346 \begin_layout Enumerate
2347 Contact the team at:
2348 \begin_inset Newline newline
2349 \end_inset
2350
2351
2352 \begin_inset CommandInset href
2353 LatexCommand href
2354 target "lyx-docs@lists.lyx.org"
2355 type "mailto:"
2356 literal "false"
2357
2358 \end_inset
2359
2360
2361 \begin_inset Newline newline
2362 \end_inset
2363
2364 to discuss your intended changes and to get some feedback on them.
2365 \end_layout
2366
2367 \begin_layout Standard
2368 The changes you wish to make may range from improving clarity of the text,
2369  to doing major re-structuring of the documentation.
2370  Any and all improvements are gladly received.
2371 \end_layout
2372
2373 \end_body
2374 \end_document