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