LyX/Manuals/2.4/en/Intro.lyx

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