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