lib/doc/Additional.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 scrbook
   8 \begin_preamble
   9 % DO NOT ALTER THIS PREAMBLE!!!
  10 %
  11 % This preamble is designed to ensure that the manual prints
  12 % out as advertised. If you mess with this preamble,
  13 % parts of the manual 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 are 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
  28 % extra space for tables
  29 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
  30 \end_preamble
  31 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
  32 \use_default_options false
  33 \begin_modules
  34 logicalmkup
  35 theorems-ams
  36 theorems-ams-extended
  37 multicol
  38 shapepar
  39 graphicboxes
  40 enumitem
  41 hanging
  42 initials
  43 \end_modules
  44 \maintain_unincluded_children no
  45 \language english
  46 \language_package default
  47 \inputencoding utf8
  48 \fontencoding auto
  49 \font_roman "lmodern" "default"
  50 \font_sans "lmss" "default"
  51 \font_typewriter "lmtt" "default"
  52 \font_math "auto" "auto"
  53 \font_default_family default
  54 \use_non_tex_fonts false
  55 \font_sc false
  56 \font_roman_osf false
  57 \font_sans_osf false
  58 \font_typewriter_osf false
  59 \font_sf_scale 100 100
  60 \font_tt_scale 100 100
  61 \use_microtype false
  62 \use_dash_ligatures true
  63 \graphics default
  64 \default_output_format pdf2
  65 \output_sync 0
  66 \bibtex_command default
  67 \index_command default
  68 \float_placement class
  69 \float_alignment class
  70 \paperfontsize 12
  71 \spacing single
  72 \use_hyperref true
  73 \pdf_title "LyX's Additional Features manual"
  74 \pdf_author "LyX Team"
  75 \pdf_subject "LyX's additional features documentation"
  76 \pdf_keywords "LyX, Documentation, Additional"
  77 \pdf_bookmarks true
  78 \pdf_bookmarksnumbered true
  79 \pdf_bookmarksopen false
  80 \pdf_bookmarksopenlevel 1
  81 \pdf_breaklinks false
  82 \pdf_pdfborder false
  83 \pdf_colorlinks true
  84 \pdf_backref false
  85 \pdf_pdfusetitle false
  86 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
  87 \papersize a4
  88 \use_geometry false
  89 \use_package amsmath 1
  90 \use_package amssymb 1
  91 \use_package cancel 1
  92 \use_package esint 1
  93 \use_package mathdots 1
  94 \use_package mathtools 1
  95 \use_package mhchem 1
  96 \use_package stackrel 1
  97 \use_package stmaryrd 1
  98 \use_package undertilde 1
  99 \cite_engine basic
 100 \cite_engine_type default
 101 \biblio_style plain
 102 \use_bibtopic false
 103 \use_indices false
 104 \paperorientation portrait
 105 \suppress_date false
 106 \justification true
 107 \use_refstyle 0
 108 \use_minted 0
 109 \use_lineno 0
 110 \notefontcolor #0000ff
 111 \index Index
 112 \shortcut idx
 113 \color #008000
 114 \end_index
 115 \secnumdepth 3
 116 \tocdepth 3
 117 \paragraph_separation indent
 118 \paragraph_indentation default
 119 \is_math_indent 1
 120 \math_indentation default
 121 \math_numbering_side default
 122 \quotes_style english
 123 \dynamic_quotes 0
 124 \papercolumns 1
 125 \papersides 2
 126 \paperpagestyle headings
 127 \tablestyle default
 128 \tracking_changes true
 129 \output_changes false
 130 \change_bars false
 131 \postpone_fragile_content false
 132 \html_math_output 0
 133 \html_css_as_file 0
 134 \html_be_strict true
 135 \docbook_table_output 0
 136 \docbook_mathml_prefix 1
 137 \author -712698321 "Jürgen Spitzmüller"
 138 \author 177693 "x"
 139 \author 5863208 "ab"
 140 \author 244031559 "Yuriy"
 141 \author 274215730 "scott"
 142 \author 564990737 "John Lyx"
 143 \author 630872221 "Jean-Pierre Chrétien" jeanpierre.chretien@free.fr
 144 \author 1075283030 "Thibaut"
 145 \author 1119979965 "Joel A. Kulesza"
 146 \end_header
 147
 148 \begin_body
 149
 150 \begin_layout Title
 151 Additional \SpecialChar LyX
 152  Features
 153 \end_layout
 154
 155 \begin_layout Subtitle
 156 Version 2.
 157 \change_deleted 630872221 1622909155
 158 3
 159 \change_inserted 630872221 1622909155
 160 4
 161 \change_unchanged
 162 .x
 163 \end_layout
 164
 165 \begin_layout Author
 166 by the \SpecialChar LyX
 167  Team
 168 \begin_inset Foot
 169 status collapsed
 170
 171 \begin_layout Plain Layout
 172 \noindent
 173 Principal maintainer of this file is
 174 \noun on
 175  Richard Kimberly Heck
 176 \noun default
 177 .
 178  If you have comments or error corrections,
 179  please send them to the \SpecialChar LyX
 180  Documentation mailing list,
 181
 182 \begin_inset Flex Code
 183 status collapsed
 184
 185 \begin_layout Plain Layout
 186 <lyx-docs@lists.lyx.org>
 187 \end_layout
 188
 189 \end_inset
 190
 191 .
 192 \end_layout
 193
 194 \end_inset
 195
 196
 197 \end_layout
 198
 199 \begin_layout Standard
 200 \begin_inset CommandInset toc
 201 LatexCommand tableofcontents
 202
 203 \end_inset
 204
 205
 206 \end_layout
 207
 208 \begin_layout Standard
 209
 210 \change_inserted 5863208 1672865652
 211 \begin_inset Note Note
 212 status open
 213
 214 \begin_layout Plain Layout
 215
 216 \change_inserted 5863208 1672865674
 217 Note to all translators:
 218 \end_layout
 219
 220 \begin_layout Plain Layout
 221
 222 \change_inserted 5863208 1672865817
 223 This manual was restructured for LyX 2.4.
 224  Attached are notes for translators to help them to find their way round the new structure of Additional.lyx.
 225  This note itself will be deleted in the final 2.4 release.
 226 \begin_inset Newline newline
 227 \end_inset
 228
 229
 230 \end_layout
 231
 232 \begin_layout Plain Layout
 233
 234 \change_inserted 5863208 1672865801
 235
 236 \series bold
 237 Additional.lyx 2.4 Changes
 238 \end_layout
 239
 240 \begin_layout Itemize
 241
 242 \change_inserted 5863208 1672865801
 243 Chapter 1:
 244  none
 245 \end_layout
 246
 247 \begin_layout Itemize
 248
 249 \change_inserted 5863208 1672865801
 250 Chapter 2:
 251  none
 252 \end_layout
 253
 254 \begin_layout Itemize
 255
 256 \change_inserted 5863208 1672865801
 257 Chapter 3:
 258  Document classes:
 259  new chapter
 260 \end_layout
 261
 262 \begin_deeper
 263 \begin_layout Itemize
 264
 265 \change_inserted 5863208 1672865801
 266 AMS LaTeX:
 267  moved and minor edits
 268 \end_layout
 269
 270 \begin_layout Itemize
 271
 272 \change_inserted 5863208 1672865801
 273 Extra font styles:
 274  new
 275 \end_layout
 276
 277 \begin_layout Itemize
 278
 279 \change_inserted 5863208 1672865801
 280 Hebrew:
 281  new
 282 \end_layout
 283
 284 \begin_layout Itemize
 285
 286 \change_inserted 5863208 1672865801
 287 Japanese:
 288  new
 289 \end_layout
 290
 291 \begin_layout Itemize
 292
 293 \change_inserted 5863208 1672865801
 294 KOMA-Script:
 295  moved and significant edits
 296 \end_layout
 297
 298 \begin_layout Itemize
 299
 300 \change_inserted 5863208 1672865801
 301 Polish:
 302  moved and minor edit
 303 \end_layout
 304
 305 \begin_layout Itemize
 306
 307 \change_inserted 5863208 1672865801
 308 Tufte:
 309  new
 310 \end_layout
 311
 312 \begin_layout Itemize
 313
 314 \change_inserted 5863208 1672865801
 315 A&A Paper:
 316  moved and minor edits
 317 \end_layout
 318
 319 \begin_layout Itemize
 320
 321 \change_inserted 5863208 1672865801
 322 AASTeX:
 323  moved
 324 \end_layout
 325
 326 \begin_layout Itemize
 327
 328 \change_inserted 5863208 1672865801
 329 Chess:
 330  new
 331 \end_layout
 332
 333 \begin_layout Itemize
 334
 335 \change_inserted 5863208 1672865801
 336 Elsevier:
 337  new
 338 \end_layout
 339
 340 \begin_layout Itemize
 341
 342 \change_inserted 5863208 1672865801
 343 Paper:
 344  new
 345 \end_layout
 346
 347 \begin_layout Itemize
 348
 349 \change_inserted 5863208 1672865824
 350 RevTeX:
 351  moved
 352 \end_layout
 353
 354 \begin_layout Itemize
 355
 356 \change_inserted 5863208 1672865831
 357 Springer:
 358  new
 359 \end_layout
 360
 361 \begin_layout Itemize
 362
 363 \change_inserted 5863208 1672865831
 364 Memoir:
 365  moved
 366 \end_layout
 367
 368 \begin_layout Itemize
 369
 370 \change_inserted 5863208 1672865831
 371 Recipe Book:
 372  new
 373 \end_layout
 374
 375 \begin_layout Itemize
 376
 377 \change_inserted 5863208 1672865831
 378 Curricula vitae:
 379  all new
 380 \end_layout
 381
 382 \begin_layout Itemize
 383
 384 \change_inserted 5863208 1672865831
 385 Letters:
 386  all new
 387 \end_layout
 388
 389 \begin_layout Itemize
 390
 391 \change_inserted 5863208 1672865831
 392 Beamer:
 393  new
 394 \end_layout
 395
 396 \begin_layout Itemize
 397
 398 \change_inserted 5863208 1672865831
 399 Foils:
 400  moved with minor edits
 401 \end_layout
 402
 403 \begin_layout Itemize
 404
 405 \change_inserted 5863208 1672865831
 406 Powerdot:
 407  new
 408 \end_layout
 409
 410 \begin_layout Itemize
 411
 412 \change_inserted 5863208 1672865831
 413 Seminar:
 414  new
 415 \end_layout
 416
 417 \begin_layout Itemize
 418
 419 \change_inserted 5863208 1672865831
 420 Slides:
 421  moved with minor edits
 422 \end_layout
 423
 424 \begin_layout Itemize
 425
 426 \change_inserted 5863208 1672865831
 427 Reports:
 428  new
 429 \end_layout
 430
 431 \begin_layout Itemize
 432
 433 \change_inserted 5863208 1672865831
 434 Broadway:
 435  moved
 436 \end_layout
 437
 438 \begin_layout Itemize
 439
 440 \change_inserted 5863208 1672865831
 441 Hollywood:
 442  moved
 443 \end_layout
 444
 445 \begin_layout Itemize
 446
 447 \change_inserted 5863208 1672865831
 448 (Note that document classes which appeared in 2.3 but do not appear in 2.4 were either removed previously or have been removed during this revision because they are no longer available anywhere.)
 449 \end_layout
 450
 451 \end_deeper
 452 \begin_layout Itemize
 453
 454 \change_inserted 5863208 1672865831
 455 Chapter 4:
 456  Modules:
 457  new chapter
 458 \end_layout
 459
 460 \begin_deeper
 461 \begin_layout Itemize
 462
 463 \change_inserted 5863208 1672865831
 464 All module descriptions new except:
 465 \end_layout
 466
 467 \begin_layout Itemize
 468
 469 \change_inserted 5863208 1672865831
 470 Customizable lists:
 471  moved with minor edits
 472 \end_layout
 473
 474 \begin_layout Itemize
 475
 476 \change_inserted 5863208 1672865831
 477 Custom header/footer text:
 478  moved with minor edits
 479 \end_layout
 480
 481 \begin_layout Itemize
 482
 483 \change_inserted 5863208 1672865831
 484 Multiple columns:
 485  moved with minor edits
 486 \end_layout
 487
 488 \begin_layout Itemize
 489
 490 \change_inserted 5863208 1672865831
 491 Custom paragraph shapes:
 492  moved with minor edits
 493 \end_layout
 494
 495 \begin_layout Itemize
 496
 497 \change_inserted 5863208 1672865831
 498 Initials:
 499  moved with minor edits
 500 \end_layout
 501
 502 \end_deeper
 503 \begin_layout Itemize
 504
 505 \change_inserted 5863208 1672865831
 506 Chapter 5:
 507  Bibliography:
 508  new chapter
 509 \end_layout
 510
 511 \begin_deeper
 512 \begin_layout Itemize
 513
 514 \change_inserted 5863208 1672865831
 515 Content moved but unchanged
 516 \end_layout
 517
 518 \end_deeper
 519 \begin_layout Itemize
 520
 521 \change_inserted 5863208 1672865831
 522 Chapter 6:
 523  Bullets:
 524  new chapter
 525 \end_layout
 526
 527 \begin_deeper
 528 \begin_layout Itemize
 529
 530 \change_inserted 5863208 1672865845
 531 Content moved but unchanged
 532 \end_layout
 533
 534 \end_deeper
 535 \begin_layout Itemize
 536
 537 \change_inserted 5863208 1672865845
 538 Chapter 9:
 539  DocBook output:
 540  new chapter and content
 541 \end_layout
 542
 543 \begin_layout Itemize
 544
 545 \change_inserted 5863208 1672865845
 546 All other chapters unchanged but renumbered except:
 547 \end_layout
 548
 549 \begin_layout Itemize
 550
 551 \change_inserted 5863208 1672865845
 552 section 11.3 Literate programming:
 553  minor edits
 554 \change_unchanged
 555
 556 \end_layout
 557
 558 \end_inset
 559
 560
 561 \end_layout
 562
 563 \begin_layout Chapter
 564 Introduction
 565 \end_layout
 566
 567 \begin_layout Standard
 568 This manual is essentially Part II of the
 569 \emph on
 570 User's Guide\SpecialChar endofsentence
 571
 572 \emph default
 573  The reason for separating the two documents is simple:
 574  the
 575 \emph on
 576 User's Guide
 577 \emph default
 578  is already quite lengthy,
 579  and it contains information on all of the basic features one needs to know in order to prepare most documents.
 580  However,
 581  the \SpecialChar LyX
 582  Team has worked to make \SpecialChar LyX
 583  extensible through various configuration files and external packages.
 584  That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
 585  package,
 586  you can create a layout file (or module) for it without having to alter \SpecialChar LyX
 587  itself.
 588  We've already had contributions of several new features this way,
 589  and some of them are documented here.
 590  There are also some more `advanced' features,
 591  such as how to control the presentation of bibliographies and how to work with multi-part documents,
 592  that are not covered in the
 593 \emph on
 594 User's Guide
 595 \emph default
 596  and are discussed here.
 597 \end_layout
 598
 599 \begin_layout Standard
 600 This manual also documents some special features,
 601  like fax support
 602 \change_deleted 244031559 1603802929
 603 ,
 604
 605 \change_inserted 244031559 1603802931
 606  and
 607 \change_unchanged
 608  version control
 609 \change_deleted 244031559 1603802954
 610 ,
 611  and SGML support
 612 \change_unchanged
 613 ,
 614  which require additional software to work properly.
 615  There is also a chapter on \SpecialChar LyX
 616 's support for HTML.
 617  And lastly,
 618  there's a chapter of \SpecialChar LaTeX
 619  tools and tips,
 620  things you can use to spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
 621 .
 622  After all,
 623  \SpecialChar LyX
 624
 625 \emph on
 626 is
 627 \emph default
 628  only WYSIWYM and will only ever interface to some,
 629  not all,
 630  \SpecialChar LaTeX
 631  features.
 632 \end_layout
 633
 634 \begin_layout Standard
 635 If you haven't read the
 636 \emph on
 637 Introduction
 638 \emph default
 639  yet,
 640  you are definitely in the wrong manual.
 641  The
 642 \emph on
 643 Introduction
 644 \emph default
 645  is the first place to go,
 646  since it describes the notation and format of all of the manuals.
 647  You should also be thoroughly familiar with the
 648 \emph on
 649 User's Guide
 650 \emph default
 651  and all of the basic features of \SpecialChar LyX
 652  before attempting to read this one.
 653 \end_layout
 654
 655 \begin_layout Standard
 656 Since many of the topics in this manual depend heavily on \SpecialChar LyX
 657 's interaction with \SpecialChar LaTeX
 658 ,
 659  this first chapter covers the inner workings of \SpecialChar LyX
 660  and how to direct \SpecialChar LyX
 661  to generate exactly the \SpecialChar LaTeX
 662  code you want.
 663  It is obviously for more seasoned \SpecialChar LyX
 664  users.
 665 \end_layout
 666
 667 \begin_layout Chapter
 668 \SpecialChar LyX
 669  and \SpecialChar LaTeX
 670
 671 \end_layout
 672
 673 \begin_layout Section
 674 How \SpecialChar LyX
 675  Uses \SpecialChar LaTeX
 676
 677 \end_layout
 678
 679 \begin_layout Standard
 680 This chapter is for both \SpecialChar TeX
 681 -nicians and the \SpecialChar LaTeX
 682 -curious.
 683  In it,
 684  we'll explain how \SpecialChar LyX
 685  and \SpecialChar LaTeX
 686  work together to produce printable output.
 687  This is the only place in any of the manuals where we assume you know something about \SpecialChar LaTeX
 688 .
 689 \end_layout
 690
 691 \begin_layout Standard
 692 At one time,
 693  \SpecialChar LyX
 694  was called a
 695 \begin_inset Quotes eld
 696 \end_inset
 697
 698 WYSIWYM frontend to \SpecialChar LaTeX
 699 ,
 700 \begin_inset Quotes erd
 701 \end_inset
 702
 703  but that's no longer true.
 704  There are frontends to \SpecialChar LaTeX
 705  out there.
 706 \begin_inset Foot
 707 status collapsed
 708
 709 \begin_layout Plain Layout
 710 Some familar ones are \SpecialChar TeX
 711 maker and kile,
 712  on Linux,
 713  and \SpecialChar TeX
 714 shop,
 715  OSX.
 716  There are also the \SpecialChar LaTeX
 717  modes for vi and emacs,
 718  of course.
 719 \end_layout
 720
 721 \end_inset
 722
 723  These are basically text editors with the ability to run \SpecialChar LaTeX
 724  and mark any errors in the file you're editing.
 725  Although \SpecialChar LyX
 726
 727 \emph on
 728 is
 729 \emph default
 730  an editor,
 731  and it
 732 \emph on
 733 does
 734 \emph default
 735  run \SpecialChar LaTeX
 736 ,
 737  and it also indicates errors in the file,
 738  it also does much,
 739  much more.
 740  For one thing,
 741  you don't need to know \SpecialChar LaTeX
 742  to use \SpecialChar LyX
 743  effectively.
 744  And \SpecialChar LyX
 745  has added its own extensions to \SpecialChar LaTeX
 746 .
 747  Try the following sometime:
 748  select
 749 \begin_inset Flex Noun
 750 status collapsed
 751
 752 \begin_layout Plain Layout
 753 Export\SpecialChar menuseparator
 754 LaTeX
 755 \end_layout
 756
 757 \end_inset
 758
 759  from the
 760 \begin_inset Flex Noun
 761 status collapsed
 762
 763 \begin_layout Plain Layout
 764 File
 765 \end_layout
 766
 767 \end_inset
 768
 769  menu (or
 770 \begin_inset Flex Noun
 771 status collapsed
 772
 773 \begin_layout Plain Layout
 774 View\SpecialChar menuseparator
 775 Source
 776 \begin_inset space ~
 777 \end_inset
 778
 779 Pane
 780 \end_layout
 781
 782 \end_inset
 783
 784 ),
 785  then look at the preamble of the resulting
 786 \begin_inset Flex Code
 787 status collapsed
 788
 789 \begin_layout Plain Layout
 790 .tex
 791 \end_layout
 792
 793 \end_inset
 794
 795  file.
 796  You'll notice a variety of new macros defined specifically by \SpecialChar LyX
 797 .
 798  These macros are defined automatically,
 799  according to the features you use in the document.
 800 \end_layout
 801
 802 \begin_layout Standard
 803 There are several commands that automatically invoke \SpecialChar LaTeX
 804 .
 805  They are:
 806 \end_layout
 807
 808 \begin_layout Itemize
 809 \begin_inset Flex Noun
 810 status collapsed
 811
 812 \begin_layout Plain Layout
 813 Document\SpecialChar menuseparator
 814 View
 815 \end_layout
 816
 817 \end_inset
 818
 819
 820 \end_layout
 821
 822 \begin_layout Itemize
 823 \begin_inset Flex Noun
 824 status collapsed
 825
 826 \begin_layout Plain Layout
 827 Document\SpecialChar menuseparator
 828 Update
 829 \end_layout
 830
 831 \end_inset
 832
 833
 834 \end_layout
 835
 836 \begin_layout Standard
 837 They will only invoke \SpecialChar LaTeX
 838  if the file has changed since the last time \SpecialChar LaTeX
 839  was run.
 840
 841 \end_layout
 842
 843 \begin_layout Standard
 844 When \SpecialChar LyX
 845  runs \SpecialChar LaTeX
 846  on the file you're editing,
 847  it performs these steps:
 848 \end_layout
 849
 850 \begin_layout Enumerate
 851 Convert the document to \SpecialChar LaTeX
 852  and save to a file with the extension
 853 \begin_inset Flex Code
 854 status collapsed
 855
 856 \begin_layout Plain Layout
 857 .tex
 858 \end_layout
 859
 860 \end_inset
 861
 862  in place of
 863 \begin_inset Flex Code
 864 status collapsed
 865
 866 \begin_layout Plain Layout
 867 .lyx
 868 \end_layout
 869
 870 \end_inset
 871
 872 .
 873 \end_layout
 874
 875 \begin_layout Enumerate
 876 Run \SpecialChar LaTeX
 877  on the
 878 \begin_inset Flex Code
 879 status collapsed
 880
 881 \begin_layout Plain Layout
 882 .tex
 883 \end_layout
 884
 885 \end_inset
 886
 887  file (maybe several times),
 888  and run any other commands (such as
 889 \begin_inset Flex Code
 890 status collapsed
 891
 892 \begin_layout Plain Layout
 893 bibtex
 894 \end_layout
 895
 896 \end_inset
 897
 898  or
 899 \begin_inset Flex Code
 900 status collapsed
 901
 902 \begin_layout Plain Layout
 903 makeindex
 904 \end_layout
 905
 906 \end_inset
 907
 908 ) needed to compile the \SpecialChar LaTeX
 909  file.
 910 \end_layout
 911
 912 \begin_layout Enumerate
 913 If there are any errors,
 914  show the error log.
 915 \end_layout
 916
 917 \begin_layout Standard
 918 If you have run \SpecialChar LaTeX
 919  using
 920 \begin_inset Flex Noun
 921 status collapsed
 922
 923 \begin_layout Plain Layout
 924 View\SpecialChar menuseparator
 925 DVI
 926 \end_layout
 927
 928 \end_inset
 929
 930 ,
 931  \SpecialChar LyX
 932  then runs a DVI viewer to display the DVI-file.
 933  If you have used
 934 \begin_inset Flex Noun
 935 status collapsed
 936
 937 \begin_layout Plain Layout
 938 View\SpecialChar menuseparator
 939 PostScript
 940 \end_layout
 941
 942 \end_inset
 943
 944 ,
 945  \SpecialChar LyX
 946  performs further steps:
 947 \end_layout
 948
 949 \begin_layout Enumerate
 950 Run
 951 \begin_inset Flex Code
 952 status collapsed
 953
 954 \begin_layout Plain Layout
 955 dvips
 956 \end_layout
 957
 958 \end_inset
 959
 960  to convert the DVI file to PostScript.
 961 \end_layout
 962
 963 \begin_layout Enumerate
 964 Run a PostScript viewer,
 965  such as
 966 \begin_inset Flex Code
 967 status collapsed
 968
 969 \begin_layout Plain Layout
 970 ghostview
 971 \end_layout
 972
 973 \end_inset
 974
 975 ,
 976  to display the PostScript file.
 977 \end_layout
 978
 979 \begin_layout Standard
 980 \SpecialChar LyX
 981  does similar things when viewing,
 982  or exporting,
 983  other formats.
 984 \end_layout
 985
 986 \begin_layout Section
 987 Translating \SpecialChar LaTeX
 988  files into \SpecialChar LyX
 989
 990 \end_layout
 991
 992 \begin_layout Standard
 993 You can import a \SpecialChar LaTeX
 994  file into \SpecialChar LyX
 995  by using the
 996 \begin_inset Flex Noun
 997 status collapsed
 998
 999 \begin_layout Plain Layout
1000 File\SpecialChar menuseparator
1001 Import\SpecialChar menuseparator
1002 LaTeX
1003 \end_layout
1004
1005 \end_inset
1006
1007  command in \SpecialChar LyX
1008 .
1009  This will call a program named
1010 \begin_inset Flex Code
1011 status collapsed
1012
1013 \begin_layout Plain Layout
1014 tex2lyx
1015 \end_layout
1016
1017 \end_inset
1018
1019  which will create a file
1020 \begin_inset Flex Code
1021 status collapsed
1022
1023 \begin_layout Plain Layout
1024 foo.lyx
1025 \end_layout
1026
1027 \end_inset
1028
1029  from the file
1030 \begin_inset Flex Code
1031 status collapsed
1032
1033 \begin_layout Plain Layout
1034 foo.tex
1035 \end_layout
1036
1037 \end_inset
1038
1039 .
1040  \SpecialChar LyX
1041  will then open that file.
1042 \begin_inset Foot
1043 status collapsed
1044
1045 \begin_layout Plain Layout
1046 \begin_inset Flex Code
1047 status collapsed
1048
1049 \begin_layout Plain Layout
1050 tex2lyx
1051 \end_layout
1052
1053 \end_inset
1054
1055  can also be run from the command line,
1056  of course.
1057 \end_layout
1058
1059 \end_inset
1060
1061
1062 \end_layout
1063
1064 \begin_layout Standard
1065 \begin_inset Flex Code
1066 status collapsed
1067
1068 \begin_layout Plain Layout
1069 tex2lyx
1070 \end_layout
1071
1072 \end_inset
1073
1074  will translate most legal \SpecialChar LaTeX
1075 ,
1076  but not everything.
1077  It will put things it doesn't understand into \SpecialChar TeX
1078  code,
1079  so after translating a file with
1080 \begin_inset Flex Code
1081 status collapsed
1082
1083 \begin_layout Plain Layout
1084 tex2lyx
1085 \end_layout
1086
1087 \end_inset
1088
1089 ,
1090  you can look for \SpecialChar TeX
1091  code and hand-edit it until it looks right.
1092 \end_layout
1093
1094 \begin_layout Standard
1095 If you don't know what \SpecialChar TeX
1096  code is,
1097  read the next section.
1098 \end_layout
1099
1100 \begin_layout Section
1101 \begin_inset CommandInset label
1102 LatexCommand label
1103 name "sec:Inserting-TeX-Code"
1104
1105 \end_inset
1106
1107 Inserting \SpecialChar TeX
1108  Code into \SpecialChar LyX
1109  Documents
1110 \end_layout
1111
1112 \begin_layout Standard
1113 Anything you can do in \SpecialChar LaTeX
1114  you can do in \SpecialChar LyX
1115 ,
1116  for a very simple reason:
1117  You can always insert \SpecialChar TeX
1118  code into any \SpecialChar LyX
1119  document.
1120  \SpecialChar LyX
1121  cannot,
1122  and will never be able to,
1123  display every possible \SpecialChar LaTeX
1124  construct.
1125  If ever you need to insert \SpecialChar LaTeX
1126  commands into your \SpecialChar LyX
1127  document,
1128  you can use the
1129 \begin_inset Flex Code
1130 status collapsed
1131
1132 \begin_layout Plain Layout
1133 \SpecialChar TeX
1134  Code
1135 \end_layout
1136
1137 \end_inset
1138
1139  box,
1140  which you can insert into your document with
1141 \begin_inset Flex Noun
1142 status collapsed
1143
1144 \begin_layout Plain Layout
1145 Insert\SpecialChar menuseparator
1146
1147 \family sans
1148 TeX
1149 \family default
1150  Code
1151 \end_layout
1152
1153 \end_inset
1154
1155  or the keyboard shortcut
1156 \begin_inset Info
1157 type  "shortcut"
1158 arg   "ert-insert"
1159 \end_inset
1160
1161 .
1162 \end_layout
1163
1164 \begin_layout Standard
1165 Here's an example of inserting \SpecialChar LaTeX
1166  commands in a \SpecialChar LyX
1167  document.
1168  The code looks like this:
1169 \end_layout
1170
1171 \begin_layout LyX-Code
1172
1173 \backslash
1174 begin{tabular}{ll}
1175 \begin_inset Newline newline
1176 \end_inset
1177
1178
1179 \backslash
1180 begin{minipage}{5cm}
1181 \begin_inset Newline newline
1182 \end_inset
1183
1184 This is an example of a minipage environment.
1185  You
1186 \begin_inset Newline newline
1187 \end_inset
1188
1189 can put nearly everything in it,
1190  even (non-floating)
1191 \begin_inset Newline newline
1192 \end_inset
1193
1194 figures and tables.
1195
1196 \begin_inset Newline newline
1197 \end_inset
1198
1199
1200 \backslash
1201 end{minipage}
1202 \begin_inset Newline newline
1203 \end_inset
1204
1205 &
1206 \begin_inset Newline newline
1207 \end_inset
1208
1209
1210 \backslash
1211 begin{minipage}{5cm}
1212 \begin_inset Newline newline
1213 \end_inset
1214
1215
1216 \backslash
1217 begin{verbatim}
1218 \begin_inset Newline newline
1219 \end_inset
1220
1221
1222 \backslash
1223 begin{minipage}{5cm}
1224 \begin_inset Newline newline
1225 \end_inset
1226
1227 This ...
1228
1229 \begin_inset Newline newline
1230 \end_inset
1231
1232
1233 \backslash
1234 end{minipage}
1235 \begin_inset Newline newline
1236 \end_inset
1237
1238
1239 \backslash
1240 end{verbatim}
1241 \begin_inset Newline newline
1242 \end_inset
1243
1244
1245 \backslash
1246 end{minipage}
1247 \begin_inset Newline newline
1248 \end_inset
1249
1250
1251 \backslash
1252 end{tabular}
1253 \end_layout
1254
1255 \begin_layout LyX-Code
1256
1257 \end_layout
1258
1259 \begin_layout Standard
1260 The
1261 \begin_inset Flex Code
1262 status collapsed
1263
1264 \begin_layout Plain Layout
1265 \SpecialChar TeX
1266  Code
1267 \end_layout
1268
1269 \end_inset
1270
1271  box containing this text is directly after this paragraph.
1272  Those of you reading the manual in \SpecialChar LyX
1273  will only see the \SpecialChar TeX
1274  code inset.
1275  Those reading a printed version of the manuals will see the actual results:
1276 \begin_inset VSpace bigskip
1277 \end_inset
1278
1279
1280 \end_layout
1281
1282 \begin_layout Standard
1283 \begin_inset ERT
1284 status open
1285
1286 \begin_layout Plain Layout
1287
1288
1289 \backslash
1290 begin{tabular}{ll}
1291 \end_layout
1292
1293 \begin_layout Plain Layout
1294
1295
1296 \backslash
1297 begin{minipage}{5cm}
1298 \end_layout
1299
1300 \begin_layout Plain Layout
1301
1302 This is an example of a minipage environment.
1303  You can put nearly everything in it,
1304  even (non-floating) figures and tables.
1305
1306 \end_layout
1307
1308 \begin_layout Plain Layout
1309
1310
1311 \backslash
1312 end{minipage}
1313 \end_layout
1314
1315 \begin_layout Plain Layout
1316
1317 &
1318 \end_layout
1319
1320 \begin_layout Plain Layout
1321
1322
1323 \backslash
1324 begin{minipage}{5cm}
1325 \end_layout
1326
1327 \begin_layout Plain Layout
1328
1329
1330 \backslash
1331 begin{verbatim}
1332 \end_layout
1333
1334 \begin_layout Plain Layout
1335
1336
1337 \backslash
1338 begin{minipage}{5cm}
1339 \end_layout
1340
1341 \begin_layout Plain Layout
1342
1343 This ...
1344
1345 \end_layout
1346
1347 \begin_layout Plain Layout
1348
1349
1350 \backslash
1351 end{minipage}
1352 \end_layout
1353
1354 \begin_layout Plain Layout
1355
1356
1357 \backslash
1358 end{verbatim}
1359 \end_layout
1360
1361 \begin_layout Plain Layout
1362
1363
1364 \backslash
1365 end{minipage}
1366 \end_layout
1367
1368 \begin_layout Plain Layout
1369
1370
1371 \backslash
1372 end{tabular}
1373 \end_layout
1374
1375 \end_inset
1376
1377
1378 \begin_inset VSpace bigskip
1379 \end_inset
1380
1381
1382 \end_layout
1383
1384 \begin_layout Standard
1385 In addition to using \SpecialChar TeX
1386  code,
1387  you can also create a separate file containing some complex \SpecialChar LaTeX
1388  structure and then use
1389 \begin_inset Flex Noun
1390 status collapsed
1391
1392 \begin_layout Plain Layout
1393 Insert\SpecialChar menuseparator
1394 Child
1395 \begin_inset space ~
1396 \end_inset
1397
1398 Document
1399 \end_layout
1400
1401 \end_inset
1402
1403  to include your file (you should select the type
1404 \begin_inset Flex Code
1405 status collapsed
1406
1407 \begin_layout Plain Layout
1408 Input
1409 \end_layout
1410
1411 \end_inset
1412
1413 ).
1414  We recommend that you only do this if you have a
1415 \begin_inset Flex Code
1416 status collapsed
1417
1418 \begin_layout Plain Layout
1419 .tex
1420 \end_layout
1421
1422 \end_inset
1423
1424  file which you
1425 \emph on
1426 know
1427 \emph default
1428  works already.
1429  Otherwise,
1430  you'll have a big job tracking down \SpecialChar LaTeX
1431  errors.
1432 \end_layout
1433
1434 \begin_layout Standard
1435 There are a few last points to emphasize:
1436 \end_layout
1437
1438 \begin_layout Itemize
1439 \SpecialChar LyX
1440
1441 \emph on
1442 does not
1443 \emph default
1444  check if your \SpecialChar LaTeX
1445  code is correct.
1446 \end_layout
1447
1448 \begin_layout Itemize
1449 Beware of reinventing the wheel.
1450 \end_layout
1451
1452 \begin_layout Standard
1453 On that last point,
1454  \SpecialChar LyX
1455  does have quite a few features tucked into it,
1456  and more are coming.
1457  Be sure to check the manuals to make sure that \SpecialChar LyX
1458  doesn't have such-and-such feature before you decide you have to do it by hand.
1459  Moreover,
1460  there are numerous \SpecialChar LaTeX
1461  packages out there to do all sorts of things,
1462  from labels to envelopes to fancy multipage tables.
1463  Check out
1464 \change_inserted 244031559 1603815732
1465
1466 \begin_inset CommandInset href
1467 LatexCommand href
1468 name "CTAN"
1469 target "https://www.ctan.org/"
1470 literal "false"
1471
1472 \end_inset
1473
1474
1475 \change_deleted 244031559 1603815732
1476
1477 \begin_inset CommandInset href
1478 LatexCommand href
1479 name "CTAN"
1480 target "http://www.ctan.org/"
1481 literal "false"
1482
1483 \end_inset
1484
1485
1486 \change_unchanged
1487  for details.
1488 \end_layout
1489
1490 \begin_layout Standard
1491 If you do need to do some wild and fancy things within your document,
1492  be sure to check out a good \SpecialChar LaTeX
1493  book for assistance.
1494  There are a number of them listed in the bibliography of the
1495 \emph on
1496 User's Guide
1497 \emph default
1498 .
1499 \end_layout
1500
1501 \begin_layout Section
1502 \SpecialChar LyX
1503  and the \SpecialChar LaTeX
1504  Preamble
1505 \end_layout
1506
1507 \begin_layout Subsection
1508 About the \SpecialChar LaTeX
1509  Preamble
1510 \end_layout
1511
1512 \begin_layout Standard
1513 If you already know \SpecialChar LaTeX
1514 ,
1515  there is no need to explain here what the preamble is good for.
1516  If you don't,
1517  the following will give you some ideas—
1518 we recommend again that you consult a \SpecialChar LaTeX
1519  book for further information.
1520  In any case,
1521  you should read the points below,
1522  because they explain what you can do and what you don't need to do in the \SpecialChar LaTeX
1523  preamble of a \SpecialChar LyX
1524  document.
1525 \end_layout
1526
1527 \begin_layout Standard
1528 The \SpecialChar LaTeX
1529  preamble comes at the very beginning of a document,
1530
1531 \emph on
1532 before
1533 \emph default
1534  the text.
1535  It serves to:
1536 \end_layout
1537
1538 \begin_layout Itemize
1539 Declare the document class.
1540
1541 \begin_inset Newline newline
1542 \end_inset
1543
1544 \SpecialChar LyX
1545  already does this for you.
1546  If you're a seasoned \SpecialChar LaTeX
1547 -nician,
1548  and you have a custom document class you want to use,
1549  check out the
1550 \emph on
1551 Customization Manual
1552 \emph default
1553  for information on how to make \SpecialChar LyX
1554  interface to it.
1555 \end_layout
1556
1557 \begin_layout Itemize
1558 Declare the usage of packages.
1559
1560 \begin_inset Newline newline
1561 \end_inset
1562
1563 \SpecialChar LaTeX
1564  packages provide special commands,
1565  which are only available within a document when the package has been declared in the preamble.
1566  In addition to providing special commands,
1567  the inclusion of a package can change the document.
1568  For example,
1569  the package
1570 \begin_inset Flex Code
1571 status collapsed
1572
1573 \begin_layout Plain Layout
1574 indentfirst
1575 \end_layout
1576
1577 \end_inset
1578
1579  forces all paragraphs to be indented.
1580  There are other packages for labels,
1581  envelopes,
1582  margins,
1583  etc.
1584
1585 \end_layout
1586
1587 \begin_layout Itemize
1588 Set counters,
1589  variables,
1590  lengths and widths.
1591
1592 \begin_inset Newline newline
1593 \end_inset
1594
1595 There are several \SpecialChar LaTeX
1596  counters and variables that
1597 \emph on
1598 must
1599 \emph default
1600  be set globally from within the preamble in order to have the desired effect.
1601  (There are variables that you can set and reset inside the document,
1602  too.) Margins are a good example of something that must be set in the preamble.
1603  Another example is the label format for lists.
1604  You can actually set these just about anywhere,
1605  but it's best to do it just once,
1606  inside the preamble.
1607 \end_layout
1608
1609 \begin_layout Itemize
1610 Declare user defined commands (with
1611 \begin_inset Flex Code
1612 status collapsed
1613
1614 \begin_layout Plain Layout
1615
1616 \backslash
1617 newcommand
1618 \end_layout
1619
1620 \end_inset
1621
1622  or
1623 \begin_inset Flex Code
1624 status collapsed
1625
1626 \begin_layout Plain Layout
1627
1628 \backslash
1629 renewcommand
1630 \end_layout
1631
1632 \end_inset
1633
1634 ).
1635 \begin_inset Newline newline
1636 \end_inset
1637
1638 These are abbreviations for \SpecialChar LaTeX
1639  commands which appear very often inside a document.
1640  Although the preamble is a good place to declare such commands,
1641  they
1642 \emph on
1643 can
1644 \emph default
1645  be declared anywhere (before they are used for the first time,
1646  of course).
1647  This can be useful if there is a lot of raw \SpecialChar LaTeX
1648  code in your document,
1649  which normally should not be the case.
1650 \end_layout
1651
1652 \begin_layout Standard
1653 \SpecialChar LyX
1654  adds its own set of definitions to the preamble of the
1655 \begin_inset Flex Code
1656 status collapsed
1657
1658 \begin_layout Plain Layout
1659 .tex
1660 \end_layout
1661
1662 \end_inset
1663
1664  file it produces.
1665  This makes \SpecialChar LaTeX
1666  files generated by \SpecialChar LyX
1667  portable.
1668 \end_layout
1669
1670 \begin_layout Subsection
1671 Changing the Preamble
1672 \end_layout
1673
1674 \begin_layout Standard
1675 The commands which \SpecialChar LyX
1676  adds to the preamble of a \SpecialChar LaTeX
1677  file are fixed;
1678  you can't change them without patching \SpecialChar LyX
1679  itself.
1680  You can,
1681  however,
1682  add your own stuff to the preamble by selecting
1683 \begin_inset Flex Noun
1684 status collapsed
1685
1686 \begin_layout Plain Layout
1687 \SpecialChar LaTeX
1688
1689 \begin_inset space ~
1690 \end_inset
1691
1692 Preamble
1693 \end_layout
1694
1695 \end_inset
1696
1697  in the
1698 \begin_inset Flex Noun
1699 status collapsed
1700
1701 \begin_layout Plain Layout
1702 Document\SpecialChar menuseparator
1703 Settings
1704 \end_layout
1705
1706 \end_inset
1707
1708  dialog.
1709  \SpecialChar LyX
1710  adds anything in the
1711 \begin_inset Flex Noun
1712 status collapsed
1713
1714 \begin_layout Plain Layout
1715 Preamble
1716 \end_layout
1717
1718 \end_inset
1719
1720  dialog to its own built-in preamble.
1721  Before adding your own declarations in the preamble,
1722  you should make sure that \SpecialChar LyX
1723  doesn't already support what you want to do.
1724  (Remember what we said about reinventing the wheel?) Also,
1725
1726 \emph on
1727 make sure your preamble code is correct
1728 \emph default
1729 .
1730  \SpecialChar LyX
1731  doesn't check it for you.
1732  If there is an error,
1733  you're likely to get an error like
1734 \begin_inset Quotes eld
1735 \end_inset
1736
1737
1738 \begin_inset Flex Code
1739 status collapsed
1740
1741 \begin_layout Plain Layout
1742 Missing
1743 \backslash
1744 begin{document}
1745 \end_layout
1746
1747 \end_inset
1748
1749
1750 \begin_inset Quotes erd
1751 \end_inset
1752
1753 .
1754  If you see this error,
1755  check your preamble.
1756 \end_layout
1757
1758 \begin_layout Subsection
1759 Examples
1760 \end_layout
1761
1762 \begin_layout Standard
1763 Here are some examples of what you can add to a preamble,
1764  and what they do.
1765 \end_layout
1766
1767 \begin_layout Subsubsection
1768 Example #1:
1769  Offsets
1770 \end_layout
1771
1772 \begin_layout Standard
1773 There are two variables under \SpecialChar LaTeX
1774  that control page position:
1775
1776 \begin_inset Flex Code
1777 status collapsed
1778
1779 \begin_layout Plain Layout
1780
1781 \backslash
1782 hoffset
1783 \end_layout
1784
1785 \end_inset
1786
1787  and
1788 \begin_inset Flex Code
1789 status collapsed
1790
1791 \begin_layout Plain Layout
1792
1793 \backslash
1794 voffset
1795 \end_layout
1796
1797 \end_inset
1798
1799 .
1800  Their names should be self-explanatory.
1801  These variables are useful if you think for a moment about computer labels.
1802  Sometimes,
1803  the size of a print medium and the area of the medium that you can actually print on aren't the same.
1804  This is where
1805 \begin_inset Flex Code
1806 status collapsed
1807
1808 \begin_layout Plain Layout
1809
1810 \backslash
1811 hoffset
1812 \end_layout
1813
1814 \end_inset
1815
1816  and
1817 \begin_inset Flex Code
1818 status collapsed
1819
1820 \begin_layout Plain Layout
1821
1822 \backslash
1823 voffset
1824 \end_layout
1825
1826 \end_inset
1827
1828  come in.
1829 \end_layout
1830
1831 \begin_layout Standard
1832 The default values for
1833 \begin_inset Flex Code
1834 status collapsed
1835
1836 \begin_layout Plain Layout
1837
1838 \backslash
1839 hoffset
1840 \end_layout
1841
1842 \end_inset
1843
1844  and
1845 \begin_inset Flex Code
1846 status collapsed
1847
1848 \begin_layout Plain Layout
1849
1850 \backslash
1851 voffset
1852 \end_layout
1853
1854 \end_inset
1855
1856  are both 0
1857 \begin_inset space \thinspace{}
1858 \end_inset
1859
1860 points,
1861  i.
1862 \begin_inset space \thinspace{}
1863 \end_inset
1864
1865 e.
1866 \begin_inset space \space{}
1867 \end_inset
1868
1869 the page isn't shifted.
1870  Unfortunately,
1871  some DVI drivers always seem to shift the page.
1872  We have no idea why,
1873  or why the sysadmin hasn't fixed such behavior.
1874  If you're using \SpecialChar LyX
1875  on a system that you don't personally maintain,
1876  and your sysadmin is a doofus,
1877
1878 \begin_inset Flex Code
1879 status collapsed
1880
1881 \begin_layout Plain Layout
1882
1883 \backslash
1884 hoffset
1885 \end_layout
1886
1887 \end_inset
1888
1889  and
1890 \begin_inset Flex Code
1891 status collapsed
1892
1893 \begin_layout Plain Layout
1894
1895 \backslash
1896 voffset
1897 \end_layout
1898
1899 \end_inset
1900
1901  can save the day.
1902  Suppose your left and top margins are always 0.5
1903 \begin_inset space \thinspace{}
1904 \end_inset
1905
1906 inches too big.
1907  You can add this to the preamble:
1908 \end_layout
1909
1910 \begin_layout LyX-Code
1911
1912 \backslash
1913 setlength{
1914 \backslash
1915 hoffset}{-0.5 in}
1916 \end_layout
1917
1918 \begin_layout LyX-Code
1919
1920 \backslash
1921 setlength{
1922 \backslash
1923 voffset}{-0.5 in}
1924 \end_layout
1925
1926 \begin_layout Standard
1927 and your margins should now be correct.
1928 \end_layout
1929
1930 \begin_layout Subsubsection
1931 Example #2:
1932  Labels
1933 \end_layout
1934
1935 \begin_layout Standard
1936 Speaking of labels,
1937  suppose you wanted to print out a bunch of address labels.
1938  There's a rather nice package,
1939  available at your nearest CTAN archive,
1940  for printing sheets of labels:
1941
1942 \begin_inset Flex Code
1943 status collapsed
1944
1945 \begin_layout Plain Layout
1946 labels.sty
1947 \end_layout
1948
1949 \end_inset
1950
1951 .
1952  Now,
1953  your system may not have this package installed by default.
1954  We leave that up to you to check.
1955  You'll also want to read the documentation for it;
1956  we're not going to do that for you.
1957  Since this is an example,
1958  however,
1959  we'll give you an example of how you use this package.
1960 \end_layout
1961
1962 \begin_layout Standard
1963 First,
1964  make sure you're using the
1965 \begin_inset Flex Code
1966 status collapsed
1967
1968 \begin_layout Plain Layout
1969 article
1970 \end_layout
1971
1972 \end_inset
1973
1974  document class.
1975  Next,
1976  you need to put the following in your preamble:
1977 \end_layout
1978
1979 \begin_layout LyX-Code
1980
1981 \backslash
1982 usepackage{labels}
1983 \end_layout
1984
1985 \begin_layout LyX-Code
1986
1987 \backslash
1988 LabelCols=3
1989 \end_layout
1990
1991 \begin_layout LyX-Code
1992
1993 \backslash
1994 LabelRows=7
1995 \end_layout
1996
1997 \begin_layout LyX-Code
1998
1999 \backslash
2000 LeftBorder=8mm
2001 \end_layout
2002
2003 \begin_layout LyX-Code
2004
2005 \backslash
2006 RightBorder=8mm
2007 \end_layout
2008
2009 \begin_layout LyX-Code
2010
2011 \backslash
2012 TopBorder=9mm
2013 \end_layout
2014
2015 \begin_layout LyX-Code
2016
2017 \backslash
2018 BottomBorder=2mm
2019 \end_layout
2020
2021 \begin_layout Standard
2022 This sets things up for Avery label sheets,
2023  stock #5360.
2024  You're now ready to print labels,
2025  but you'll need to insert \SpecialChar LaTeX
2026  code,
2027  placing the commands
2028 \begin_inset Flex Code
2029 status collapsed
2030
2031 \begin_layout Plain Layout
2032
2033 \backslash
2034 begin{labels}
2035 \end_layout
2036
2037 \end_inset
2038
2039  and
2040 \begin_inset Flex Code
2041 status collapsed
2042
2043 \begin_layout Plain Layout
2044
2045 \backslash
2046 end{labels}
2047 \end_layout
2048
2049 \end_inset
2050
2051  around each label text.
2052  This and other special features of
2053 \begin_inset Flex Code
2054 status collapsed
2055
2056 \begin_layout Plain Layout
2057 labels.sty
2058 \end_layout
2059
2060 \end_inset
2061
2062  are explained in its documentation.
2063 \end_layout
2064
2065 \begin_layout Standard
2066 Someday,
2067  someone may write a \SpecialChar LyX
2068  layout file to support this package directly.
2069  Maybe that someone is you.
2070 \end_layout
2071
2072 \begin_layout Subsubsection
2073 Example #3:
2074  Paragraph Indentation
2075 \end_layout
2076
2077 \begin_layout Standard
2078 Americans are trained to indent the first line of
2079 \emph on
2080 every
2081 \emph default
2082  paragraph.
2083  As with all of their other weird quirks,
2084  most Americans will whine and moan until they can have their way and indent the first line of all paragraphs.
2085  (Yes,
2086  we're joking.
2087  (We are?)
2088 \emph on
2089 Yeah
2090 \emph default
2091 ,
2092  we are.)
2093 \end_layout
2094
2095 \begin_layout Standard
2096 Of course,
2097  this behavior isn't standard typography.
2098  In books,
2099  you typically only indent the first line of a paragraph
2100 \emph on
2101 if
2102 \emph default
2103  it follows another one.
2104  The idea behind indenting the first line of a paragraph is to distinguish neighboring paragraphs from one another.
2105  If there is no previous paragraph—
2106 for example,
2107  if it follows a figure or is the first paragraph in a section—
2108 then there is no need for indentation.
2109
2110 \end_layout
2111
2112 \begin_layout Standard
2113 If you're a typical American (we're still joking!),
2114  though,
2115  you don't care about such esoteric things;
2116  you want your indentation!
2117  Add this to the preamble:
2118 \end_layout
2119
2120 \begin_layout LyX-Code
2121
2122 \backslash
2123 usepackage{indentfirst}
2124 \end_layout
2125
2126 \begin_layout Standard
2127 If your \SpecialChar TeX
2128  distribution isn't braindead,
2129  you'll have this package,
2130  and all of your paragraphs will get the indentation the Founding Fathers intended they should have.
2131 \end_layout
2132
2133 \begin_layout Subsubsection
2134 Example #4:
2135  This Document
2136 \end_layout
2137
2138 \begin_layout Standard
2139 You can also check out the preamble of this document to get an idea of some of the advanced things you can do.
2140 \end_layout
2141
2142 \begin_layout Section
2143 \SpecialChar LyX
2144  and \SpecialChar LaTeX
2145  Errors
2146 \end_layout
2147
2148 \begin_layout Standard
2149 When \SpecialChar LyX
2150  calls \SpecialChar LaTeX
2151 ,
2152  it tells \SpecialChar LaTeX
2153  to blithely ignore any errors and keep going.
2154  It then uses the logfile from the \SpecialChar LaTeX
2155  run to do a post-mortem.
2156  After analyzing the logfile,
2157  \SpecialChar LyX
2158  displays a dialog listing the errors.
2159  Clicking on any one of them will take you to the position in your \SpecialChar LyX
2160  file where the error occurred.
2161 \begin_inset Foot
2162 status collapsed
2163
2164 \begin_layout Plain Layout
2165 Well,
2166  usually.
2167  Analyzing the logfile is a tough job,
2168  and \SpecialChar LyX
2169  doesn't always go to the right line.
2170  There are also cases where \SpecialChar LaTeX
2171  reports the error on one line,
2172  but the actual error is earlier.
2173  This is not unlike forgetting a closing brace in a program:
2174  You'll get an error,
2175  but only later.
2176 \end_layout
2177
2178 \end_inset
2179
2180
2181 \end_layout
2182
2183 \begin_layout Standard
2184 Some folks also like to look at the log file directly:
2185  It is available from
2186 \begin_inset Flex Noun
2187 status collapsed
2188
2189 \begin_layout Plain Layout
2190 Document\SpecialChar menuseparator
2191 LaTeX
2192 \begin_inset space ~
2193 \end_inset
2194
2195 Log
2196 \end_layout
2197
2198 \end_inset
2199
2200 .
2201  There are some fairly common error messages and warnings.
2202  We'll cover those here.
2203  You should look at a good \SpecialChar LaTeX
2204  book for a complete listing.
2205 \end_layout
2206
2207 \begin_layout Itemize
2208 \begin_inset Flex Code
2209 status collapsed
2210
2211 \begin_layout Plain Layout
2212 LaTeX Warning
2213 \end_layout
2214
2215 \end_inset
2216
2217
2218 \begin_inset Newline newline
2219 \end_inset
2220
2221 Anything beginning with these words is a warning message for the purpose of
2222 \begin_inset Quotes eld
2223 \end_inset
2224
2225 debugging
2226 \begin_inset Quotes erd
2227 \end_inset
2228
2229  the \SpecialChar LaTeX
2230  code itself.
2231  You'll get messages like this if you added or changed cross-references or bibliography entries,
2232  in which case,
2233  \SpecialChar LaTeX
2234  is trying to tell you that you need to make another run.
2235  You can by-and-large ignore these.
2236 \end_layout
2237
2238 \begin_layout Itemize
2239 \begin_inset Flex Code
2240 status collapsed
2241
2242 \begin_layout Plain Layout
2243 LaTeX Font Warning
2244 \end_layout
2245
2246 \end_inset
2247
2248
2249 \begin_inset Newline newline
2250 \end_inset
2251
2252 Another warning message,
2253  this time about fonts which \SpecialChar LaTeX
2254  couldn't find.
2255  The rest of the message will often say something about a replacement font that \SpecialChar LaTeX
2256  used.
2257  You can safely ignore these,
2258  too.
2259 \end_layout
2260
2261 \begin_layout Itemize
2262 \begin_inset Flex Code
2263 status collapsed
2264
2265 \begin_layout Plain Layout
2266 Overfull
2267 \backslash
2268 hbox
2269 \end_layout
2270
2271 \end_inset
2272
2273
2274 \begin_inset Newline newline
2275 \end_inset
2276
2277 \SpecialChar LaTeX
2278  absolutely
2279 \emph on
2280 loves
2281 \emph default
2282  to spew these out.
2283  It seems to generate at least one of these messages for just about any document you write.
2284  They are warnings about lines that were too long and run past the right margin.
2285  This happens if \SpecialChar LaTeX
2286  does not find a reasonable way to break the lines (notoriously often with typewriter font,
2287  since this does not allow for automatic break points).
2288  In many cases,
2289  this is unnoticeable in the final output.
2290  (It can be just a point or two.) Sometimes,
2291  however,
2292  the lines run rather visibly into the margin;
2293  something you will not want to have in your final print.
2294
2295 \begin_inset Newline newline
2296 \end_inset
2297
2298 There are several global ways to try to minimize the overfull lines.
2299  Clicking
2300 \family sans
2301 Enable micro-typographic extensions
2302 \family default
2303  in
2304 \family sans
2305 Document\SpecialChar menuseparator
2306 Settings\SpecialChar menuseparator
2307 Fonts
2308 \family default
2309  might already improve things a lot.
2310  Furthermore,
2311  \SpecialChar LaTeX
2312  code such as the following in
2313 \family sans
2314 Document\SpecialChar menuseparator
2315 Settings\SpecialChar menuseparator
2316 Preamble
2317 \family default
2318  usually reduces the overfull lines drastically (we use this in the preamble of this document):
2319 \end_layout
2320
2321 \begin_deeper
2322 \begin_layout LyX-Code
2323
2324 \backslash
2325 tolerance 1414
2326 \begin_inset Newline newline
2327 \end_inset
2328
2329
2330 \backslash
2331 hbadness 1414
2332 \begin_inset Newline newline
2333 \end_inset
2334
2335
2336 \backslash
2337 emergencystretch 1.5em
2338 \begin_inset Newline newline
2339 \end_inset
2340
2341
2342 \backslash
2343 hfuzz 0.3pt
2344 \end_layout
2345
2346 \begin_layout Standard
2347 In some cases,
2348  however,
2349  you eventually have to rewrite the text to get the line breaking right.
2350 \begin_inset Foot
2351 status collapsed
2352
2353 \begin_layout Plain Layout
2354 For more information,
2355  see
2356 \begin_inset Flex URL
2357 status open
2358
2359 \begin_layout Plain Layout
2360
2361 http://www.tex.ac.uk/FAQ-overfull.html
2362 \end_layout
2363
2364 \end_inset
2365
2366
2367 \end_layout
2368
2369 \end_inset
2370
2371
2372 \end_layout
2373
2374 \begin_layout Standard
2375 In any case,
2376  you should check the respective lines,
2377  at least for the final version of your document.
2378  Your eyes will tell you if there's a problem with something that's too wide.
2379 \begin_inset Foot
2380 status collapsed
2381
2382 \begin_layout Plain Layout
2383 You can also enable the `draft' option in
2384 \begin_inset Flex Noun
2385 status collapsed
2386
2387 \begin_layout Plain Layout
2388 Document\SpecialChar menuseparator
2389 Settings
2390 \end_layout
2391
2392 \end_inset
2393
2394 ,
2395  and then \SpecialChar LaTeX
2396  will draw a black box in the margin of lines that are overfull.
2397 \end_layout
2398
2399 \end_inset
2400
2401
2402 \end_layout
2403
2404 \end_deeper
2405 \begin_layout Itemize
2406 \begin_inset Flex Code
2407 status collapsed
2408
2409 \begin_layout Plain Layout
2410 Underfull
2411 \backslash
2412 hbox
2413 \end_layout
2414
2415 \end_inset
2416
2417
2418 \begin_inset Newline newline
2419 \end_inset
2420
2421 Not quite as common as its cousin.
2422  This happens again if \SpecialChar LaTeX
2423  does not find a reasonable break point and consequently generates too loose lines.
2424  As with the overfull lines,
2425  you should check if this is a visible problem.
2426 \end_layout
2427
2428 \begin_layout Itemize
2429 \begin_inset Flex Code
2430 status collapsed
2431
2432 \begin_layout Plain Layout
2433 Overfull
2434 \backslash
2435 vbox
2436 \end_layout
2437
2438 \end_inset
2439
2440  and
2441 \begin_inset Flex Code
2442 status collapsed
2443
2444 \begin_layout Plain Layout
2445 Underfull
2446 \backslash
2447 vbox
2448 \end_layout
2449
2450 \end_inset
2451
2452
2453 \begin_inset Newline newline
2454 \end_inset
2455
2456 Warnings about troubles breaking the page.
2457  Once again,
2458  just look at the output.
2459  Your eyes will tell you where something has gone wrong.
2460 \end_layout
2461
2462 \begin_layout Itemize
2463 \begin_inset Flex Code
2464 status collapsed
2465
2466 \begin_layout Plain Layout
2467 LaTeX Error:
2468  File
2469 \begin_inset Quotes els
2470 \end_inset
2471
2472 Xxxx
2473 \begin_inset Quotes ers
2474 \end_inset
2475
2476  not found
2477 \end_layout
2478
2479 \end_inset
2480
2481
2482 \begin_inset Newline newline
2483 \end_inset
2484
2485 The file
2486 \begin_inset Quotes eld
2487 \end_inset
2488
2489 Xxxx
2490 \begin_inset Quotes erd
2491 \end_inset
2492
2493  isn't installed on this system.
2494  This usually appears because some package your document needs isn't installed.
2495  If you didn't touch the preamble or didn't use the
2496 \begin_inset Flex Code
2497 status collapsed
2498
2499 \begin_layout Plain Layout
2500
2501 \backslash
2502 usepackage{}
2503 \end_layout
2504
2505 \end_inset
2506
2507  command,
2508  then one of the packages \SpecialChar LyX
2509  tried to load is missing.
2510  Use
2511 \begin_inset Flex Noun
2512 status collapsed
2513
2514 \begin_layout Plain Layout
2515 Help\SpecialChar menuseparator
2516 \SpecialChar LaTeX
2517  Configuration
2518 \end_layout
2519
2520 \end_inset
2521
2522  to get a list of packages that \SpecialChar LyX
2523  knows about.
2524  This file is updated whenever you reconfigure \SpecialChar LyX
2525  (using
2526 \begin_inset Flex Noun
2527 status collapsed
2528
2529 \begin_layout Plain Layout
2530 Tools\SpecialChar menuseparator
2531 Reconfigure
2532 \end_layout
2533
2534 \end_inset
2535
2536 ) and tells you which packages have been detected and what they do.
2537 \begin_inset Newline newline
2538 \end_inset
2539
2540 If you did use the
2541 \begin_inset Flex Code
2542 status collapsed
2543
2544 \begin_layout Plain Layout
2545
2546 \backslash
2547 usepackage{}
2548 \end_layout
2549
2550 \end_inset
2551
2552  command and the package in question isn't installed,
2553  then you'll need to install it yourself.
2554 \end_layout
2555
2556 \begin_layout Itemize
2557 \begin_inset Flex Code
2558 status collapsed
2559
2560 \begin_layout Plain Layout
2561 LaTeX Error:
2562  Unknown option
2563 \end_layout
2564
2565 \end_inset
2566
2567
2568 \begin_inset Newline newline
2569 \end_inset
2570
2571 Error messages beginning with this are trying to tell you that you specified a bad or undefined option to a package.
2572  Check the package's documentation.
2573 \end_layout
2574
2575 \begin_layout Itemize
2576 \begin_inset Flex Code
2577 status collapsed
2578
2579 \begin_layout Plain Layout
2580 Undefined control sequence
2581 \end_layout
2582
2583 \end_inset
2584
2585
2586 \begin_inset Newline newline
2587 \end_inset
2588
2589 If you've inserted \SpecialChar LaTeX
2590  code into your document,
2591  but made a typo,
2592  you'll get one of these.
2593  You may have forgotten to load a package.
2594  In any case,
2595  this error message usually means that you used an undefined command.
2596
2597 \end_layout
2598
2599 \begin_layout Standard
2600 There are other error and warning messages.
2601  Some are self-explanatory.
2602  These are usually \SpecialChar LaTeX
2603  messages.
2604  Others are downright cryptic.
2605  These are usually \SpecialChar TeX
2606  error messages,
2607  and we really have
2608 \emph on
2609 no clue
2610 \emph default
2611  what they mean or how to decipher them.
2612  No-one does.
2613 \end_layout
2614
2615 \begin_layout Standard
2616 There's a general sequence you should follow if you get error messages:
2617 \end_layout
2618
2619 \begin_layout Enumerate
2620 Look at the \SpecialChar LaTeX
2621  code you inserted for typos.
2622 \end_layout
2623
2624 \begin_layout Enumerate
2625 If there are no typos,
2626  check that you used the command(s) correctly.
2627 \end_layout
2628
2629 \begin_layout Enumerate
2630 If you get a bunch of error boxes piled up at the very top of the document—
2631 and especially if you see a
2632 \begin_inset Quotes eld
2633 \end_inset
2634
2635
2636 \begin_inset Flex Code
2637 status collapsed
2638
2639 \begin_layout Plain Layout
2640 Missing
2641 \backslash
2642 begin{document}
2643 \end_layout
2644
2645 \end_inset
2646
2647
2648 \begin_inset Quotes erd
2649 \end_inset
2650
2651  error—
2652 it means that there are errors in the preamble.
2653  Start debugging your preamble.
2654 \end_layout
2655
2656 \begin_layout Enumerate
2657 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2658  code to the document,
2659  the first suspect is your \SpecialChar LaTeX
2660  distribution itself.
2661  Check for missing packages and install them.
2662 \end_layout
2663
2664 \begin_layout Enumerate
2665 Okay,
2666  so there are no missing packages.
2667  Did you use any of the fine-tuning options in \SpecialChar LyX
2668 ?
2669  Specifically,
2670  did you
2671 \emph on
2672 misuse
2673 \emph default
2674  any of them,
2675  like trying to manually insert lots of
2676 \begin_inset Flex Code
2677 status collapsed
2678
2679 \begin_layout Plain Layout
2680
2681 \change_deleted 177693 1654669036
2682 Protected
2683 \change_inserted 177693 1654669038
2684 Non-Breaking
2685 \change_unchanged
2686
2687 \begin_inset space ~
2688 \end_inset
2689
2690
2691 \change_deleted 177693 1654669040
2692 Blanks
2693 \change_inserted 177693 1654669041
2694 Spaces
2695 \change_unchanged
2696
2697 \end_layout
2698
2699 \end_inset
2700
2701 ,
2702
2703 \begin_inset Flex Code
2704 status collapsed
2705
2706 \begin_layout Plain Layout
2707 Linebreaks
2708 \end_layout
2709
2710 \end_inset
2711
2712 ,
2713  or
2714 \begin_inset Flex Code
2715 status collapsed
2716
2717 \begin_layout Plain Layout
2718 Pagebreaks
2719 \end_layout
2720
2721 \end_inset
2722
2723 ?
2724  Did you try to kludge something together with these instead of using the appropriate paragraph environment?
2725 \end_layout
2726
2727 \begin_layout Enumerate
2728 All right,
2729  you didn't use any of the fine-tuning options,
2730  you played by the rules.
2731  Did you try to pull a fancy maneuver?
2732  Did you do something funky inside a table or an equation,
2733  like inserting a graphic into a table cell?
2734 \end_layout
2735
2736 \begin_layout Enumerate
2737 Do you have long sections of text where \SpecialChar LaTeX
2738  cannot find a place to break a line?
2739  By default,
2740  \SpecialChar LaTeX
2741  is rather strict about how much extra inter-word spacing it will add in order to break a line.
2742  Preferably,
2743  you should rework the paragraph to avoid the problem.
2744 \end_layout
2745
2746 \begin_layout Enumerate
2747 Did you go overboard with the nesting?
2748  \SpecialChar LyX
2749  (currently) doesn't check to make sure you're in the limits for nesting environments.
2750  If you nested a bunch of environments to the
2751 \begin_inset Formula $17^{\mathrm{th}}$
2752 \end_inset
2753
2754  level,
2755  that's the problem.
2756  (The limit in \SpecialChar LaTeX
2757  is five.)
2758 \end_layout
2759
2760 \begin_layout Enumerate
2761 Okay,
2762  you didn't get any error messages,
2763  but your output looks awful.
2764  If you have a table or figure that's too wide or long for the page,
2765  you need to:
2766 \end_layout
2767
2768 \begin_deeper
2769 \begin_layout Enumerate
2770 rescale the figure so it fits.
2771 \end_layout
2772
2773 \begin_layout Enumerate
2774 trim down the table so it fits.
2775 \end_layout
2776
2777 \end_deeper
2778 \begin_layout Enumerate
2779 If something else is wrong with the output,
2780  and you didn't try to pull anything fancy or kludge the fine-tuning options,
2781  we're not sure what's wrong.
2782 \end_layout
2783
2784 \begin_layout Standard
2785 If all this doesn't help—
2786 well,
2787  then
2788 \emph on
2789 perhaps
2790 \emph default
2791  you might have found a bug in \SpecialChar LyX
2792 \SpecialChar ldots
2793 .
2794 \end_layout
2795
2796 \begin_layout Chapter
2797
2798 \change_inserted 564990737 1672345271
2799 Document classes
2800 \end_layout
2801
2802 \begin_layout Standard
2803
2804 \change_inserted 564990737 1672345272
2805 As explained in the
2806 \emph on
2807 User's Guide
2808 \emph default
2809 ,
2810  \SpecialChar LaTeX
2811  originally offered four standard document classes,
2812  article,
2813  report,
2814  book and letter,
2815  but individuals and organizations,
2816  most notably the American Mathematical Society in the early days,
2817  have made many contributions to extending the range of document classes.
2818  In this chapter we summarize the main externally maintained classes,
2819  some of which are marked “Unavailable:” in the pull-down
2820 \family sans
2821 Document
2822 \begin_inset space ~
2823 \end_inset
2824
2825
2826 \bar under
2827 c
2828 \bar default
2829 lass
2830 \family default
2831  list in the
2832 \family sans
2833 \bar under
2834 D
2835 \bar default
2836 ocument\SpecialChar menuseparator
2837
2838 \bar under
2839 S
2840 \bar default
2841 ettings\SpecialChar menuseparator
2842 Document
2843 \begin_inset space ~
2844 \end_inset
2845
2846 class
2847 \family default
2848  dialog and which you will need to install as described in the
2849 \emph on
2850 Installing New Document Classes
2851 \emph default
2852  chapter of the
2853 \emph on
2854 Customization
2855 \emph default
2856  manual if you want to use them.
2857
2858 \end_layout
2859
2860 \begin_layout Section
2861
2862 \change_inserted 564990737 1670439533
2863 \begin_inset CommandInset label
2864 LatexCommand label
2865 name "sec:Collections"
2866
2867 \end_inset
2868
2869 Collections
2870 \end_layout
2871
2872 \begin_layout Subsection
2873
2874 \change_inserted 564990737 1672345298
2875 \begin_inset CommandInset label
2876 LatexCommand label
2877 name "subsec:AMS-LaTeX-(American-Mathematical"
2878
2879 \end_inset
2880
2881 AMS-\SpecialChar LaTeX
2882  (American Mathematical Society)
2883 \end_layout
2884
2885 \begin_layout Standard
2886
2887 \change_inserted 564990737 1672345298
2888 The \SpecialChar LyX
2889  supported document classes
2890 \family sans
2891 article (AMS)
2892 \family default
2893  and
2894 \family sans
2895 book (AMS)
2896 \family default
2897  are maintained by the Society;
2898  use of their features is described in the Math manual and on their website
2899 \begin_inset Flex URL
2900 status collapsed
2901
2902 \begin_layout Plain Layout
2903
2904 \change_inserted 564990737 1672345298
2905
2906 http://www.ams.org/publications/authors/tex/amslatex
2907 \change_unchanged
2908
2909 \end_layout
2910
2911 \end_inset
2912
2913 .
2914  The following summary was originally provided by
2915 \noun on
2916 David Johnson
2917 \noun default
2918  and updated by
2919 \noun on
2920 Richard
2921 \change_inserted -712698321 1673082716
2922 Kimberly
2923 \change_inserted 564990737 1672345298
2924 Heck
2925 \noun default
2926  and the \SpecialChar LyX
2927  Team
2928 \noun on
2929 .
2930 \change_deleted 564990737 1672345297
2931
2932 \noun default
2933 AMS \SpecialChar LaTeX
2934
2935 \end_layout
2936
2937 \begin_layout Standard
2938
2939 \change_deleted 564990737 1672345297
2940 by
2941 \noun on
2942 David Johnson
2943 \noun default
2944 ;
2945  updated by
2946 \noun on
2947 Richard Kimberly Heck
2948 \change_unchanged
2949
2950 \end_layout
2951
2952 \begin_layout Standard
2953 \begin_inset VSpace bigskip
2954 \end_inset
2955
2956
2957 \end_layout
2958
2959 \begin_layout Standard
2960 \noindent
2961 The AMS \SpecialChar LaTeX
2962  layouts are set up to conform to suggested styles for mathematical papers to be submitted to American Mathematical Society publications.
2963  The layouts are not tailored to a specific journal,
2964  but easily can be.
2965  You should refer to the AMS documentation for specific instructions for each journal (usually it will entail only changing a single line in the \SpecialChar TeX
2966  output).
2967  That documentation is available on the Web at
2968 \begin_inset Flex URL
2969 status open
2970
2971 \begin_layout Plain Layout
2972
2973 http://www.ams.org
2974 \end_layout
2975
2976 \end_inset
2977
2978  or by ftp at
2979 \begin_inset Flex URL
2980 status open
2981
2982 \begin_layout Plain Layout
2983
2984 ftp://ftp.ams.org/pub/tex/amslatex/
2985 \end_layout
2986
2987 \end_inset
2988
2989 .
2990  These layouts are appropriate,
2991  and useful,
2992  for any mathematical writing.
2993
2994 \end_layout
2995
2996 \begin_layout Standard
2997 There are
2998 \change_deleted -712698321 1673083001
2999 two
3000 \change_inserted -712698321 1673083002
3001 three
3002 \change_unchanged
3003  basic AMS \SpecialChar LaTeX
3004  layouts:
3005
3006 \end_layout
3007
3008 \begin_layout Itemize
3009 amsart:
3010  The standard AMS article format
3011 \change_inserted 564990737 1672345333
3012 ;
3013  see
3014 \family sans
3015 File\SpecialChar menuseparator
3016 Open Example\SpecialChar menuseparator
3017 Articles\SpecialChar menuseparator
3018 American Mathematical Society (AMS)
3019 \change_unchanged
3020
3021 \family default
3022 .
3023 \end_layout
3024
3025 \begin_layout Itemize
3026 amsbook:
3027  the standard AMS book (really,
3028  monograph) format
3029 \change_inserted 564990737 1672345366
3030 ;
3031  see
3032 \family sans
3033 File\SpecialChar menuseparator
3034 Open Example\SpecialChar menuseparator
3035 Books\SpecialChar menuseparator
3036 American Mathematical Society (AMS)
3037 \change_unchanged
3038
3039 \family default
3040 .
3041 \change_inserted 564990737 1672345369
3042
3043 \end_layout
3044
3045 \begin_layout Itemize
3046
3047 \change_inserted 564990737 1672345383
3048 amsproc:
3049  the standard AMS proceedings format.
3050 \end_layout
3051
3052 \begin_layout Standard
3053
3054 \change_inserted 564990737 1672345383
3055 \SpecialChar LyX
3056  only supports the first two natively;
3057  see the
3058 \emph on
3059 Installing New Document Classes
3060 \emph default
3061  chapter of the
3062 \emph on
3063 Customization
3064 \emph default
3065  manual if you want to use
3066 \family sans
3067 amsproc
3068 \family default
3069 .
3070 \end_layout
3071
3072 \begin_layout Standard
3073 The layouts themselves contain only the minimum necessary to use the AMS classes.
3074  They do not,
3075  in particular,
3076  contain any of the `theorem' environments used for setting theorems,
3077  lemmas,
3078  and the like.
3079  These are contained,
3080  instead,
3081  in the
3082 \change_deleted 564990737 1672345416
3083
3084 \begin_inset Flex Code
3085 status collapsed
3086
3087 \begin_layout Plain Layout
3088 Theorems (AMS)
3089 \end_layout
3090
3091 \end_inset
3092
3093
3094 \change_inserted 564990737 1672345416
3095
3096 \family sans
3097 AMS Theorems
3098 \change_unchanged
3099
3100 \family default
3101  module,
3102  which is loaded by default when you select one of the AMS classes.
3103  (It can also be used with other classes and can be removed,
3104  if you would rather use something else.) Less commonly used environments are in the
3105 \change_deleted 564990737 1672345436
3106
3107 \begin_inset Flex Code
3108 status collapsed
3109
3110 \begin_layout Plain Layout
3111 Theorems (AMS-Extended)
3112 \end_layout
3113
3114 \end_inset
3115
3116
3117 \change_inserted 564990737 1672345436
3118
3119 \family sans
3120 AMS Theorems (Extended)
3121 \change_unchanged
3122
3123 \family default
3124  module,
3125  which must be loaded manually.
3126 \end_layout
3127
3128 \begin_layout Standard
3129 By default,
3130  theorems and the like are numbered consecutively throughout the document,
3131  but this may be modified by loading the module
3132 \change_deleted 564990737 1672345461
3133
3134 \begin_inset Flex Code
3135 status collapsed
3136
3137 \begin_layout Plain Layout
3138 Theorems (Order by Section)
3139 \end_layout
3140
3141 \end_inset
3142
3143
3144 \change_inserted 564990737 1672345461
3145
3146 \family sans
3147 Standard Theorems (Numbered by Section)
3148 \change_unchanged
3149
3150 \family default
3151  or,
3152  if you are using
3153 \begin_inset Flex Code
3154 status collapsed
3155
3156 \begin_layout Plain Layout
3157 book (AMS)
3158 \end_layout
3159
3160 \end_inset
3161
3162 ,
3163  the module
3164 \change_deleted 564990737 1672345479
3165
3166 \begin_inset Flex Code
3167 status collapsed
3168
3169 \begin_layout Plain Layout
3170 Theorems (Order by Chapter)
3171 \end_layout
3172
3173 \end_inset
3174
3175
3176 \change_inserted 564990737 1672345480
3177
3178 \family sans
3179 Standard Theorems (Numbered by Chapter)
3180 \change_unchanged
3181
3182 \family default
3183 .
3184  These will number the results as
3185 \begin_inset Formula $n.m$
3186 \end_inset
3187
3188 ,
3189  where the first number refers to the section (or chapter) and the second refers to the total number of results so far in that section (or chapter).
3190  Many environments are also available unnumbered.
3191  These are indicated by an asterisk at the end.
3192  If you happen to want
3193 \emph on
3194 only
3195 \emph default
3196  unnumbered results,
3197  the module
3198 \change_deleted 564990737 1672345498
3199
3200 \begin_inset Flex Code
3201 status collapsed
3202
3203 \begin_layout Plain Layout
3204 Theorems (Starred)
3205 \end_layout
3206
3207 \end_inset
3208
3209
3210 \change_inserted 564990737 1672345498
3211
3212 \family sans
3213 Standard Theorems (Unnumbered)
3214 \change_unchanged
3215
3216 \family default
3217  provides that option.
3218 \end_layout
3219
3220 \begin_layout Standard
3221 Note that these modules do not
3222 \emph on
3223 have
3224 \emph default
3225  to be used with the AMS classes.
3226  It is perfectly possible to use the
3227 \change_deleted 564990737 1672345520
3228
3229 \begin_inset Flex Code
3230 status collapsed
3231
3232 \begin_layout Plain Layout
3233 Theorems (AMS)
3234 \end_layout
3235
3236 \end_inset
3237
3238
3239 \change_inserted 564990737 1672345520
3240
3241 \family sans
3242 AMS Theorems
3243 \change_unchanged
3244
3245 \family default
3246  module,
3247  and the others mentioned,
3248  with other classes,
3249  such as
3250 \begin_inset Flex Code
3251 status collapsed
3252
3253 \begin_layout Plain Layout
3254
3255 \change_deleted -712698321 1673083855
3256 article
3257 \change_inserted -712698321 1673083855
3258 Article (Standard Class)
3259 \change_unchanged
3260
3261 \end_layout
3262
3263 \end_inset
3264
3265 ,
3266
3267 \begin_inset Flex Code
3268 status collapsed
3269
3270 \begin_layout Plain Layout
3271
3272 \change_deleted -712698321 1673083858
3273 report
3274 \change_inserted -712698321 1673083862
3275 Report (Standard Class)
3276 \change_unchanged
3277
3278 \end_layout
3279
3280 \end_inset
3281
3282 ,
3283
3284 \begin_inset Flex Code
3285 status collapsed
3286
3287 \begin_layout Plain Layout
3288
3289 \change_deleted -712698321 1673083819
3290 book (KOMA-script)
3291 \change_inserted -712698321 1673083822
3292 KOMA-Script Book
3293 \change_unchanged
3294
3295 \end_layout
3296
3297 \end_inset
3298
3299 ,
3300  and so forth.
3301 \end_layout
3302
3303 \begin_layout Subsubsection
3304 What these layouts provide
3305 \end_layout
3306
3307 \begin_layout Standard
3308 There is a long list of included environments provided by these layouts.
3309  In AMS-\SpecialChar LaTeX
3310 ,
3311  there is,
3312  in fact,
3313  an opportunity to define an unlimited variety of `theorem' environments.
3314  However,
3315  the AMS recommends the environments that are available in \SpecialChar LyX
3316 .
3317
3318 \end_layout
3319
3320 \begin_layout Standard
3321 The following environments—
3322 as well as the standard environments,
3323  such as
3324 \begin_inset Flex Noun
3325 status collapsed
3326
3327 \begin_layout Plain Layout
3328 section
3329 \end_layout
3330
3331 \end_inset
3332
3333 ,
3334
3335 \begin_inset Flex Noun
3336 status collapsed
3337
3338 \begin_layout Plain Layout
3339 bibliography
3340 \end_layout
3341
3342 \end_inset
3343
3344 ,
3345
3346 \begin_inset Flex Noun
3347 status collapsed
3348
3349 \begin_layout Plain Layout
3350 title
3351 \end_layout
3352
3353 \end_inset
3354
3355 ,
3356
3357 \begin_inset Flex Noun
3358 status collapsed
3359
3360 \begin_layout Plain Layout
3361 author
3362 \end_layout
3363
3364 \end_inset
3365
3366 ,
3367  and
3368 \begin_inset Flex Noun
3369 status collapsed
3370
3371 \begin_layout Plain Layout
3372 date
3373 \end_layout
3374
3375 \end_inset
3376
3377 —
3378 are provided by
3379 \begin_inset Flex Code
3380 status collapsed
3381
3382 \begin_layout Plain Layout
3383 article (AMS)
3384 \end_layout
3385
3386 \end_inset
3387
3388  and
3389 \begin_inset Flex Code
3390 status collapsed
3391
3392 \begin_layout Plain Layout
3393 book (AMS)
3394 \end_layout
3395
3396 \end_inset
3397
3398 :
3399 \end_layout
3400
3401 \begin_layout Description
3402 Address This should be the author's permanent address.
3403 \end_layout
3404
3405 \begin_layout Description
3406 Current
3407 \begin_inset space ~
3408 \end_inset
3409
3410 Address This should be the author's temporary address at the time of submission,
3411  if different from the Address.
3412 \end_layout
3413
3414 \begin_layout Description
3415 Email Author's e-mail address
3416 \end_layout
3417
3418 \begin_layout Description
3419 URL Author's Web address,
3420  if desired.
3421 \end_layout
3422
3423 \begin_layout Description
3424 Keywords Key words or phrases used to identify specific topics discussed in the paper.
3425 \end_layout
3426
3427 \begin_layout Description
3428 Subjectclass These refer to the AMS Subject Classifications,
3429  published and described in
3430 \emph on
3431 Mathematical Reviews
3432 \emph default
3433 .
3434  These are also available online at the AMS cites listed above.
3435 \end_layout
3436
3437 \begin_layout Description
3438 Thanks
3439 \end_layout
3440
3441 \begin_layout Description
3442 Dedicatory
3443 \end_layout
3444
3445 \begin_layout Description
3446 Translator
3447 \end_layout
3448
3449 \begin_layout Standard
3450 The following environments are provided by both the
3451 \change_deleted 564990737 1672345566
3452
3453 \begin_inset Flex Code
3454 status collapsed
3455
3456 \begin_layout Plain Layout
3457 Theorems
3458 \end_layout
3459
3460 \end_inset
3461
3462
3463 \change_inserted 564990737 1672345566
3464
3465 \family sans
3466 Standard Theorems
3467 \change_unchanged
3468
3469 \family default
3470  and
3471 \change_deleted 564990737 1672345580
3472
3473 \begin_inset Flex Code
3474 status collapsed
3475
3476 \begin_layout Plain Layout
3477 Theorems (AMS)
3478 \end_layout
3479
3480 \end_inset
3481
3482
3483 \change_inserted 564990737 1672345580
3484
3485 \family sans
3486 AMS Theorems
3487 \change_unchanged
3488
3489 \family default
3490  modules,
3491  in the latter case in both
3492 \change_deleted -712698321 1673084072
3493 starred (
3494 \change_unchanged
3495 unnumbered
3496 \change_deleted -712698321 1673084073
3497 )
3498 \change_unchanged
3499  and
3500 \change_deleted -712698321 1673084075
3501 unstarred (
3502 \change_unchanged
3503 numbered
3504 \change_deleted -712698321 1673084077
3505 )
3506 \change_unchanged
3507  versions.
3508  These same environments are provided only in the starred versions by the
3509 \change_deleted 564990737 1672345596
3510
3511 \begin_inset Flex Code
3512 status collapsed
3513
3514 \begin_layout Plain Layout
3515 Theorems (Starred)
3516 \end_layout
3517
3518 \end_inset
3519
3520
3521 \change_inserted 564990737 1672345596
3522
3523 \family sans
3524 Standard Theorems
3525 \change_inserted -712698321 1673084060
3526  (Unnumbered)
3527 \change_unchanged
3528
3529 \family default
3530  module:
3531 \end_layout
3532
3533 \begin_layout Theorem
3534 This is typically used for the statements of major results.
3535
3536 \end_layout
3537
3538 \begin_layout Corollary*
3539 This is used for statements which follow fairly directly from previous statements.
3540  Again,
3541  these can be major results.
3542
3543 \end_layout
3544
3545 \begin_layout Lemma
3546 These are smaller results needed to prove other statements.
3547 \end_layout
3548
3549 \begin_layout Proposition
3550 These are less major results which (hopefully) add to the general theory being discussed.
3551 \end_layout
3552
3553 \begin_layout Conjecture
3554 These are statements provided without justification,
3555  which the author does not know how to prove,
3556  but which seem to be true (to the author,
3557  at least).
3558 \end_layout
3559
3560 \begin_layout Definition*
3561 Guess what this is for.
3562  The font is different for this environment than for the previous ones.
3563
3564 \end_layout
3565
3566 \begin_layout Example*
3567 Used for examples illustrating proven results.
3568 \end_layout
3569
3570 \begin_layout Problem
3571 It's not really known what this is for.
3572  You should figure it out.
3573 \end_layout
3574
3575 \begin_layout Exercise*
3576 Write a description for this one.
3577 \end_layout
3578
3579 \begin_layout Remark
3580 This environment is also a type of theorem,
3581  usually a lesser sort of observation.
3582 \end_layout
3583
3584 \begin_layout Claim*
3585 Often used in the course of giving a proof of a larger result.
3586 \end_layout
3587
3588 \begin_layout Case
3589 Generally,
3590  these are used to break up long arguments,
3591  using specific instances of some condition.
3592
3593 \end_layout
3594
3595 \begin_layout Case
3596 The numbering scheme for cases is on its own,
3597  not together with other numbered statements.
3598
3599 \end_layout
3600
3601 \begin_layout Proof
3602 At the end of this environment,
3603  a QED symbol (usually a square,
3604  but it can vary with different styles) is placed.
3605  If you want to have other environments within this one—
3606 for example,
3607  Case environments—
3608 and have the QED symbol appear only after them,
3609  then the other environments need to be nested within the proof environment.
3610  See the section
3611 \emph on
3612 Nesting Environments
3613 \emph default
3614  of the
3615 \emph on
3616 User's Guide
3617 \emph default
3618  for information on nesting.
3619 \end_layout
3620
3621 \begin_layout Fact
3622
3623 \change_inserted 564990737 1672345651
3624 Used in a way similar to Proposition,
3625  though perhaps lower on the scale.
3626 \end_layout
3627
3628 \begin_layout Standard
3629 And these environments are provided by
3630 \change_deleted 564990737 1672345684
3631
3632 \begin_inset Flex Code
3633 status collapsed
3634
3635 \begin_layout Plain Layout
3636 Theorems (AMS-Extended)
3637 \end_layout
3638
3639 \end_inset
3640
3641
3642 \change_inserted 564990737 1672345689
3643
3644 \family sans
3645 AMS Theorems (Extended
3646 \family default
3647 )
3648 \change_unchanged
3649 :
3650 \end_layout
3651
3652 \begin_layout Criterion*
3653 A required condition.
3654 \end_layout
3655
3656 \begin_layout Algorithm*
3657 A general procedure to be used.
3658 \end_layout
3659
3660 \begin_layout Axiom*
3661 This is a property or statement taken as true within the system being discussed.
3662 \end_layout
3663
3664 \begin_layout Condition*
3665 Sometimes used to state a condition assumed within the present context of discussion.
3666 \end_layout
3667
3668 \begin_layout Note*
3669 Similar to a Remark.
3670 \end_layout
3671
3672 \begin_layout Notation*
3673 Used for the explanation of,
3674  yes,
3675  notation.
3676 \end_layout
3677
3678 \begin_layout Summary
3679 Do we really need to tell you?
3680
3681 \end_layout
3682
3683 \begin_layout Acknowledgement*
3684 Acknowledgement.
3685 \end_layout
3686
3687 \begin_layout Conclusion*
3688 Sometimes used at the end of a long train of argument.
3689 \change_deleted 564990737 1672345729
3690
3691 \end_layout
3692
3693 \begin_layout Fact
3694
3695 \change_deleted 564990737 1672345638
3696 Used in a way similar to Proposition,
3697  though perhaps lower on the scale.
3698 \change_inserted 564990737 1672345720
3699
3700 \end_layout
3701
3702 \begin_layout Assumption*
3703
3704 \change_inserted 564990737 1672345721
3705 Assumption
3706 \end_layout
3707
3708 \begin_layout Question*
3709
3710 \change_inserted 564990737 1672345721
3711 Question
3712 \end_layout
3713
3714 \begin_layout Standard
3715
3716 \change_inserted 564990737 1672345721
3717 There are ten more Maths modules available including several offering options ordered on
3718 \family sans
3719 (Numbered by Type \SpecialChar ldots
3720 )
3721 \family default
3722 .
3723 \change_unchanged
3724
3725 \end_layout
3726
3727 \begin_layout Standard
3728 In addition,
3729  the AMS classes automatically provide the AMS \SpecialChar LaTeX
3730  and AMS fonts packages.
3731  They need to be available on your system in order to use these environments.
3732 \end_layout
3733
3734 \begin_layout Subsection
3735
3736 \change_inserted 564990737 1671383236
3737 \begin_inset CommandInset label
3738 LatexCommand label
3739 name "subsec:Extra-font-sizes"
3740
3741 \end_inset
3742
3743 Extra font sizes
3744 \end_layout
3745
3746 \begin_layout Standard
3747
3748 \change_inserted 564990737 1671383236
3749 The “Extra font sizes” collection provides the document classes
3750 \family sans
3751 article
3752 \begin_inset space \thinspace{}
3753 \end_inset
3754
3755 (with extra font sizes)
3756 \family default
3757 ,
3758
3759 \family sans
3760 book
3761 \begin_inset space \thinspace{}
3762 \end_inset
3763
3764 (with extra font sizes)
3765 \family default
3766 ,
3767
3768 \family sans
3769 letter
3770 \begin_inset space \thinspace{}
3771 \end_inset
3772
3773 (with extra font sizes)
3774 \family default
3775  and
3776 \family sans
3777 report
3778 \begin_inset space \thinspace{}
3779 \end_inset
3780
3781 (with extra font sizes)
3782 \family default
3783  which use the
3784 \family typewriter
3785 article.cls
3786 \family default
3787 ,
3788
3789 \family typewriter
3790 book.cls
3791 \family default
3792 ,
3793
3794 \family typewriter
3795 letter.cls
3796 \family default
3797  and
3798 \family typewriter
3799 report.cls
3800 \family default
3801  document classes respectively but offer the additional
3802 \family sans
3803 \bar under
3804 B
3805 \bar default
3806 ase
3807 \begin_inset space ~
3808 \end_inset
3809
3810 Size
3811 \family default
3812  options 8,
3813  9,
3814  14,
3815  17 and 20 in the
3816 \family sans
3817 \bar under
3818 D
3819 \bar default
3820 ocument\SpecialChar menuseparator
3821
3822 \bar under
3823 S
3824 \bar default
3825 ettings\SpecialChar menuseparator
3826 Fonts
3827 \family default
3828  dialog.
3829 \end_layout
3830
3831 \begin_layout Subsection
3832
3833 \change_inserted 564990737 1671383236
3834 Hebrew
3835 \end_layout
3836
3837 \begin_layout Standard
3838
3839 \change_inserted 564990737 1671383236
3840 The document classes
3841 \family sans
3842 article
3843 \begin_inset space \thinspace{}
3844 \end_inset
3845
3846 (Hebrew)
3847 \family default
3848  and
3849 \family sans
3850 letter
3851 \begin_inset space \thinspace{}
3852 \end_inset
3853
3854 (Hebrew)
3855 \family default
3856  use the
3857 \family typewriter
3858 article.cl
3859 \family sans
3860 s
3861 \family default
3862  and
3863 \family typewriter
3864 letter.cls
3865 \family default
3866  document classes to facilitate the use of Hebrew in \SpecialChar LyX
3867 .
3868 \end_layout
3869
3870 \begin_layout Subsection
3871
3872 \change_inserted 564990737 1671383236
3873 \begin_inset CommandInset label
3874 LatexCommand label
3875 name "subsec:Japanese"
3876
3877 \end_inset
3878
3879 Japanese
3880 \end_layout
3881
3882 \begin_layout Standard
3883
3884 \change_inserted 564990737 1671383236
3885 The document classes
3886 \change_inserted -712698321 1673089024
3887
3888 \family sans
3889 Japanese
3890 \change_deleted -712698321 1673089025
3891 a
3892 \change_inserted -712698321 1673089025
3893 A
3894 \change_inserted 564990737 1671383236
3895 rticle
3896 \begin_inset space \thinspace{}
3897 \end_inset
3898
3899 (
3900 \change_deleted -712698321 1673089027
3901 Japanese
3902 \change_inserted 564990737 1671383236
3903 JS Class)
3904 \family default
3905 ,
3906
3907 \family sans
3908
3909 \change_deleted -712698321 1673089041
3910 article
3911 \change_inserted -712698321 1673089041
3912 Japanese Article
3913 \change_inserted 564990737 1671383236
3914
3915 \begin_inset space \thinspace{}
3916 \end_inset
3917
3918 (
3919 \change_deleted -712698321 1673089044
3920 Japanese
3921 \change_inserted 564990737 1671383236
3922 Standard Class Vertical Writing)
3923 \family default
3924 ,
3925
3926 \change_deleted -712698321 1673089041
3927
3928 \family sans
3929 article
3930 \begin_inset space \thinspace{}
3931 \end_inset
3932
3933 (Japanese Standard Class)
3934 \change_inserted -712698321 1673088992
3935 Japanese Article (Standard Class)
3936 \change_inserted 564990737 1671383236
3937
3938 \family default
3939 ,
3940
3941 \change_inserted -712698321 1673089053
3942
3943 \family sans
3944 Japanese
3945 \change_deleted -712698321 1673089053
3946 b
3947 \change_inserted -712698321 1673089064
3948 B
3949 \change_inserted 564990737 1671383236
3950 ook
3951 \begin_inset space \thinspace{}
3952 \end_inset
3953
3954 (
3955 \change_deleted -712698321 1673089067
3956 Japanese
3957 \change_inserted 564990737 1671383236
3958 JS Class)
3959 \family default
3960 ,
3961
3962 \family sans
3963
3964 \change_inserted -712698321 1673089073
3965 Japanese B
3966 \change_deleted -712698321 1673089270
3967 b
3968 \change_inserted 564990737 1671383236
3969 ook
3970 \begin_inset space \thinspace{}
3971 \end_inset
3972
3973 (
3974 \change_deleted -712698321 1673089077
3975 Japanese
3976 \change_inserted 564990737 1671383236
3977 Standard Class Vertical Writing)
3978 \family default
3979 ,
3980
3981 \change_deleted -712698321 1673089083
3982
3983 \family sans
3984 b
3985 \change_inserted -712698321 1673089083
3986 Japanese B
3987 \change_inserted 564990737 1671383236
3988 ook
3989 \begin_inset space \thinspace{}
3990 \end_inset
3991
3992 (
3993 \change_deleted -712698321 1673089087
3994 Japanese
3995 \change_inserted 564990737 1671383236
3996 Standard Class)
3997 \family default
3998 ,
3999
4000 \change_inserted -712698321 1673089094
4001
4002 \family sans
4003 Japanese
4004 \change_deleted -712698321 1673089094
4005 r
4006 \change_inserted -712698321 1673089094
4007 R
4008 \change_inserted 564990737 1671383236
4009 eport
4010 \begin_inset space \thinspace{}
4011 \end_inset
4012
4013 (
4014 \change_deleted -712698321 1673089097
4015 Japanese
4016 \change_inserted 564990737 1671383236
4017 Vertical Writing)
4018 \family default
4019  and
4020 \change_deleted -712698321 1673089104
4021
4022 \family sans
4023 r
4024 \change_inserted -712698321 1673089104
4025 Japanese R
4026 \change_inserted 564990737 1671383236
4027 eport
4028 \begin_inset space \thinspace{}
4029 \end_inset
4030
4031 (
4032 \change_deleted -712698321 1673089107
4033 Japanese
4034 \change_inserted 564990737 1671383236
4035 Standard Class)
4036 \family default
4037  provide document classes for the Japanese language.
4038 \end_layout
4039
4040 \begin_layout Subsection
4041
4042 \change_inserted 564990737 1672429136
4043 \begin_inset CommandInset label
4044 LatexCommand label
4045 name "subsec:KOMA-Script"
4046
4047 \end_inset
4048
4049 KOMA-Script
4050 \end_layout
4051
4052 \begin_layout Standard
4053
4054 \change_inserted 564990737 1672429136
4055 Original by
4056 \noun on
4057 Bernd Rellermeyer
4058 \noun default
4059 ;
4060  updated by
4061 \noun on
4062 Jürgen Spitzmüller
4063 \noun default
4064  and the \SpecialChar LyX
4065  Team
4066 \change_deleted 564990737 1672429136
4067 Koma-Script
4068 \end_layout
4069
4070 \begin_layout Standard
4071
4072 \change_deleted 564990737 1672429136
4073 by
4074 \noun on
4075 Bernd Rellermeyer
4076 \change_unchanged
4077
4078 \end_layout
4079
4080 \begin_layout Subsubsection
4081 Overview
4082 \change_inserted 564990737 1672429161
4083
4084 \end_layout
4085
4086 \begin_layout Standard
4087
4088 \change_inserted 564990737 1672429162
4089 The KOMA-Script collection of document classes is a development of the Script classes created by Frank Neukam in the early 1990s;
4090  it was formally launched with the addition of a letter class in 1994.
4091  Since then,
4092  a second letter class has been added.
4093  Frank Neukam's classes were inspired by the principles of typography and this has been fully integrated into the design of the KOMA-Script classes.
4094
4095 \change_unchanged
4096
4097 \end_layout
4098
4099 \begin_layout Standard
4100 The \SpecialChar LyX
4101  document classes
4102 \change_deleted -712698321 1673089779
4103
4104 \emph on
4105 article (koma-script)
4106 \change_inserted -712698321 1673089784
4107 KOMA-Script Article
4108 \change_unchanged
4109
4110 \emph default
4111 ,
4112
4113 \change_deleted -712698321 1673089790
4114
4115 \emph on
4116 report (koma-script)
4117 \change_inserted -712698321 1673089794
4118 KOMA-Script Report
4119 \change_unchanged
4120
4121 \emph default
4122 ,
4123
4124 \change_deleted -712698321 1673089790
4125
4126 \emph on
4127 book
4128 \emph default
4129
4130 \emph on
4131 (koma-script)
4132 \change_inserted -712698321 1673089771
4133 KOMA-Script Book
4134 \change_unchanged
4135
4136 \emph default
4137 ,
4138  and
4139 \change_inserted -712698321 1673089799
4140
4141 \emph on
4142 KOMA-Script
4143 \change_deleted -712698321 1673089802
4144 l
4145 \change_inserted -712698321 1673089802
4146 L
4147 \change_unchanged
4148 etter
4149 \change_deleted -712698321 1673089811
4150
4151 \emph default
4152
4153 \emph on
4154 (koma-script)
4155 \change_unchanged
4156
4157 \emph default
4158  correspond to the \SpecialChar LaTeX
4159  document classes
4160 \family typewriter
4161 scrartcl.cls
4162 \family default
4163 ,
4164
4165 \family typewriter
4166 scrreprt.cls
4167 \family default
4168 ,
4169
4170 \family typewriter
4171 scrbook.cls
4172 \family default
4173 ,
4174  and
4175 \family typewriter
4176 scrlettr.cls
4177 \family default
4178 ,
4179  resp.
4180 \begin_inset space ~
4181 \end_inset
4182
4183 of the Koma-Script family.
4184  They are replacements for the standard document classes
4185 \family typewriter
4186 article.cls
4187 \family default
4188 ,
4189
4190 \family typewriter
4191 report.cls
4192 \family default
4193 ,
4194
4195 \family typewriter
4196 book.cls
4197 \family default
4198  and
4199 \family typewriter
4200 letter.cls
4201 \family default
4202 ,
4203  resp.,
4204  and fit better to European typography conventions in a number of points.
4205 \end_layout
4206
4207 \begin_layout Itemize
4208
4209 \change_deleted 564990737 1672429262
4210 Standard character size is
4211 \change_inserted 564990737 1672429263
4212 The base character sizes when you select a KOMA-Script class are
4213 \change_unchanged
4214  11pt in
4215 \change_deleted -712698321 1673089877
4216
4217 \emph on
4218 article (koma-script)
4219 \change_inserted -712698321 1673089877
4220 KOMA-Script Article
4221 \change_unchanged
4222
4223 \emph default
4224 ,
4225
4226 \change_deleted -712698321 1673089886
4227
4228 \emph on
4229 report (koma-script)
4230 \change_inserted -712698321 1673089886
4231 KOMA-Script Report
4232 \change_unchanged
4233
4234 \emph default
4235 ,
4236  and
4237 \change_deleted -712698321 1673089893
4238
4239 \emph on
4240 book (koma-script)
4241 \change_inserted -712698321 1673089893
4242 KOMA-Script Book
4243 \change_deleted 564990737 1672429267
4244
4245 \emph default
4246 ,
4247
4248 \change_unchanged
4249  and 12pt in
4250 \change_deleted -712698321 1673089903
4251
4252 \emph on
4253 letter (koma-script)
4254 \change_inserted -712698321 1673089903
4255 KOMA-Script Letter
4256 \change_unchanged
4257
4258 \emph default
4259 .
4260 \end_layout
4261
4262 \begin_layout Itemize
4263 Headings,
4264  labels of the description environment,
4265  and a number of elements of the
4266 \change_deleted -712698321 1673089925
4267
4268 \emph on
4269 letter (koma-script)
4270 \change_inserted -712698321 1673089925
4271 KOMA-Script Letter
4272 \change_unchanged
4273
4274 \emph default
4275  document class are set in a bold sans serif font.
4276 \begin_inset Foot
4277 status collapsed
4278
4279 \begin_layout Plain Layout
4280 There is a big difference between the bold sans serif old cm fonts and new ec fonts,
4281  especially in the appearance of headings.
4282  In comparison,
4283  the ec bold sans serif fonts look a bit thin.
4284  Here the \SpecialChar LaTeX
4285  package
4286 \family typewriter
4287 cmsd.sty by
4288 \family default
4289
4290 \shape smallcaps
4291 Walter Schmidt
4292 \shape default
4293  helps to produce the
4294 \begin_inset Quotes eld
4295 \end_inset
4296
4297 usual
4298 \begin_inset Quotes erd
4299 \end_inset
4300
4301  appearance when using the ec fonts.
4302 \end_layout
4303
4304 \end_inset
4305
4306  The numbering of chapter headings is made in the same way as the numbering of section headings,
4307  that is without the extra line
4308 \begin_inset Quotes eld
4309 \end_inset
4310
4311 Chapter\SpecialChar ldots
4312
4313 \begin_inset Quotes erd
4314 \end_inset
4315
4316 .
4317  In addition,
4318  the appearance of the headings can be modified by using a number of options (in \SpecialChar LyX
4319  to be entered in the field
4320 \family sans
4321 Extra
4322 \begin_inset space ~
4323 \end_inset
4324
4325 Options
4326 \family default
4327  of the dialog
4328 \family sans
4329 Layout\SpecialChar menuseparator
4330 Document
4331 \family default
4332 ).
4333
4334 \end_layout
4335
4336 \begin_layout Itemize
4337
4338 \change_deleted 564990737 1672429310
4339 The main means in the Koma-Script document classes to design the type area are the options
4340 \family sans
4341 BCOR
4342 \family default
4343  and
4344 \family sans
4345 DIV
4346 \family default
4347  (in \SpecialChar LyX
4348  to be entered in the extra class options field in the dialog
4349 \family sans
4350 Document\SpecialChar menuseparator
4351 Settings
4352 \family default
4353 ).
4354  They make a clearer modification of page margins possible as do the options of the dialog
4355 \family sans
4356 Document\SpecialChar menuseparator
4357 Settings
4358 \family default
4359 .
4360
4361 \change_inserted 564990737 1672429310
4362 The layout of a KOMA-Script page follows one of two traditional typesetting conventions based on dividing the page into strips or drawing a circle.
4363  The default is to imagine that a page is divided horizontally and vertically into strips and allocate strips to the margins leaving the unused strips for the text area.
4364  You can change the sizes of the margins by changing the factor by which the page is divided into strips;
4365  the default for an A4 page is 9 and increasing this factor will produce increasingly narrower strips and therefore narrower margins.
4366
4367 \end_layout
4368
4369 \begin_deeper
4370 \begin_layout Standard
4371
4372 \change_inserted 564990737 1672429310
4373 Whatever the factor,
4374  two strips are allocated to the outer and bottom margins of a two-sided document and one strip to the inner and top margins,
4375  leaving a text area occupying around half the page.
4376  Since most two-sided documents have a binding,
4377  this can make the inner margins appear too narrow;
4378  so you can apply a binding correction to the page which is deducted before the size of the strips is calculated.
4379
4380 \end_layout
4381
4382 \begin_layout Standard
4383
4384 \change_inserted 564990737 1672429310
4385 The main means in the Koma-Script document classes to design the type area are the options
4386 \family sans
4387 BCOR
4388 \family default
4389  and
4390 \family sans
4391 DIV
4392 \family default
4393  entered in
4394 \family sans
4395 Document\SpecialChar menuseparator
4396 Settings\SpecialChar menuseparator
4397 Document Class\SpecialChar menuseparator
4398 Class Options\SpecialChar menuseparator
4399 Custom
4400 \family default
4401 .
4402
4403 \end_layout
4404
4405 \begin_layout Standard
4406
4407 \change_inserted 564990737 1672429310
4408 In this document,
4409  the binding correction is 7.5mm which is added in the form
4410 \family typewriter
4411 BCOR7.5mm
4412 \family default
4413  to
4414 \family sans
4415 Class
4416 \begin_inset space ~
4417 \end_inset
4418
4419 options\SpecialChar menuseparator
4420 Cus
4421 \bar under
4422 t
4423 \bar default
4424 om
4425 \family default
4426  dialog.
4427  To change the factor to 11,
4428  for example,
4429  add the entry
4430 \family typewriter
4431 DIV=11
4432 \family default
4433  to the comma separated list of entries in the
4434 \family sans
4435 Cus
4436 \bar under
4437 t
4438 \bar default
4439 om
4440 \family default
4441
4442 \family sans
4443 Class
4444 \begin_inset space ~
4445 \end_inset
4446
4447 options
4448 \family default
4449 .
4450  If you want the default value of this factor for a page size other than A4,
4451  add the entry
4452 \family typewriter
4453 DIV=calc
4454 \family default
4455 .
4456 \end_layout
4457
4458 \begin_layout Standard
4459
4460 \change_inserted 564990737 1672429310
4461 To use the circle method of calculating the page layout,
4462  use
4463 \family typewriter
4464 DIV=classic
4465 \family default
4466  instead.
4467 \change_unchanged
4468
4469 \end_layout
4470
4471 \end_deeper
4472 \begin_layout Itemize
4473 The \SpecialChar LaTeX
4474  document classes of the Koma-Script family define a number of additional commands.
4475  Those part of it which makes sense in \SpecialChar LyX
4476  is implemented in corresponding paragraph types.
4477 \end_layout
4478
4479 \begin_layout Standard
4480 Detailed descriptions of the \SpecialChar LaTeX
4481  document classes of the Koma-Script family can be found in the Koma-Script documentation
4482 \emph on
4483 scrguide
4484 \emph default
4485  (German) and
4486 \emph on
4487 scrguien
4488 \emph default
4489  (English).
4490 \end_layout
4491
4492 \begin_layout Subsubsection
4493
4494 \change_inserted 564990737 1672429358
4495
4496 \series bold
4497 \begin_inset CommandInset label
4498 LatexCommand label
4499 name "subsec:article-(KOMA-Script),-report"
4500
4501 \end_inset
4502
4503
4504 \change_deleted -712698321 1673090826
4505
4506 \series default
4507 article (KOMA-Script)
4508 \change_inserted -712698321 1673090826
4509
4510 \emph on
4511 KOMA-Script Article
4512 \change_inserted 564990737 1672429358
4513
4514 \emph default
4515 ,
4516
4517 \change_deleted -712698321 1673090830
4518 report (KOMA-Script)
4519 \change_inserted -712698321 1673090840
4520
4521 \emph on
4522 KOMA-Script Report
4523 \change_inserted 564990737 1672429358
4524
4525 \emph default
4526 ,
4527  and
4528 \change_deleted -712698321 1673090835
4529 book (KOMA-Script)
4530 \change_inserted -712698321 1673090844
4531
4532 \emph on
4533 KOMA-Script Book
4534 \change_deleted 564990737 1672429367
4535
4536 \emph default
4537 article (koma-script),
4538  report (koma-script),
4539  and book (koma-script)
4540 \change_unchanged
4541
4542 \end_layout
4543
4544 \begin_layout Standard
4545 The document classes
4546 \change_deleted -712698321 1673090858
4547
4548 \emph on
4549 article (koma-script)
4550 \change_inserted -712698321 1673090858
4551 KOMA-Script Article
4552 \change_unchanged
4553
4554 \emph default
4555 ,
4556
4557 \change_deleted -712698321 1673090862
4558
4559 \emph on
4560 report (koma-script)
4561 \change_inserted -712698321 1673090869
4562 KOMA-Script Report
4563 \change_unchanged
4564
4565 \emph default
4566 ,
4567  and
4568 \change_deleted -712698321 1673090866
4569
4570 \emph on
4571 book
4572 \emph default
4573
4574 \emph on
4575 (koma-script)
4576 \change_inserted -712698321 1673090874
4577 KOMA-Script Book
4578 \change_unchanged
4579
4580 \emph default
4581  are implemented in the layout files
4582 \family typewriter
4583 scrartcl.layout
4584 \family default
4585 ,
4586
4587 \family typewriter
4588 scrreprt.layout
4589 \family default
4590 ,
4591  and
4592 \family typewriter
4593 scrbook.layout
4594 \family default
4595 ,
4596  resp.
4597  They contain all the paragraph types of the corresponding standard document classes
4598 \emph on
4599 article
4600 \emph default
4601 ,
4602
4603 \emph on
4604 report
4605 \emph default
4606 ,
4607  and
4608 \emph on
4609 book
4610 \emph default
4611 ,
4612  resp.,
4613  partly modified,
4614  with the exception of the \SpecialChar LyX
4615  specific
4616 \family sans
4617 List
4618 \family default
4619 -type,
4620  which is replaced by the new
4621 \family sans
4622 Labeling
4623 \family default
4624 -type having the same functionality.
4625  Beside the
4626 \family sans
4627 Labeling
4628 \family default
4629 -Type there is a number of new paragraph types added.
4630  They are
4631 \emph on
4632 not
4633 \emph default
4634  part of
4635 \emph on
4636 letter (koma-script)
4637 \emph default
4638 .
4639 \end_layout
4640
4641 \begin_layout Itemize
4642
4643 \family sans
4644 Addpart,
4645  Addchap
4646 \family default
4647 ,
4648
4649 \family sans
4650 Addsec
4651 \family default
4652 :
4653  are equivalents to
4654 \family sans
4655 Part*,
4656  Chapter*
4657 \family default
4658  and
4659 \family sans
4660 Section*
4661 \family default
4662 ,
4663  resp.,
4664  additionally inserting an entry in the table of contents.
4665
4666 \family sans
4667 Addpart
4668 \family default
4669  and
4670 \family sans
4671 Addchap
4672 \family default
4673  are not contained in
4674 \emph on
4675 article (koma-script)
4676 \emph default
4677 .
4678 \end_layout
4679
4680 \begin_layout Itemize
4681
4682 \family sans
4683 Addchap*
4684 \family default
4685 ,
4686
4687 \family sans
4688 Addsec*
4689 \family default
4690 :
4691  behave exactly as
4692 \family sans
4693 Addchap
4694 \family default
4695  and
4696 \family sans
4697 Addsec
4698 \family default
4699 ,
4700  resp.,
4701  additionally clearing running heads.
4702
4703 \family sans
4704 Addchap*
4705 \family default
4706  is not contained in
4707 \emph on
4708 article (koma-script)
4709 \emph default
4710 .
4711 \begin_inset Foot
4712 status collapsed
4713
4714 \begin_layout Plain Layout
4715 There is also an
4716 \family typewriter
4717
4718 \backslash
4719 addpart*
4720 \family default
4721  command in
4722 \emph on
4723 book (koma-script)
4724 \emph default
4725  and in
4726 \emph on
4727 report (koma-script)
4728 \emph default
4729 ,
4730  but since this is identical to
4731 \family sans
4732 Part*
4733 \family default
4734 ,
4735  is has not been implemented in \SpecialChar LyX
4736 .
4737 \end_layout
4738
4739 \end_inset
4740
4741
4742 \end_layout
4743
4744 \begin_layout Itemize
4745
4746 \family sans
4747 Minisec
4748 \family default
4749 :
4750  generates a heading directly above the following paragraph in the standard character size without affecting the structure of the document.
4751 \end_layout
4752
4753 \begin_layout Itemize
4754
4755 \family sans
4756 Captionabove
4757 \family default
4758  and
4759 \family sans
4760 Captionbelow
4761 \family default
4762  are special captions which respect the different space settings needed for captions placed above or below an element (if you follow strict typographic rules,
4763  you might want to place table captions always above the table).
4764  You can also use the class option
4765 \family typewriter
4766 tablecaptionsabove
4767 \family default
4768 ,
4769  which will switch
4770 \family sans
4771 caption
4772 \family default
4773  to
4774 \family sans
4775 captionabove
4776 \family default
4777  for tables and
4778 \family sans
4779 captionbelow
4780 \family default
4781  for figures.
4782  You need at least Koma-Script version 2.8q to use this.
4783 \end_layout
4784
4785 \begin_layout Itemize
4786
4787 \family sans
4788 Dictum
4789 \family default
4790 :
4791  can be used to set a bonmot,
4792  e.
4793 \begin_inset space \thinspace{}
4794 \end_inset
4795
4796 g.
4797 \begin_inset space \space{}
4798 \end_inset
4799
4800 at the beginning of a chapter.
4801  If you use the optional argument (
4802 \family sans
4803 Insert\SpecialChar menuseparator
4804 Dictum
4805 \begin_inset space ~
4806 \end_inset
4807
4808 Author
4809 \family default
4810 ),
4811  you can insert the dictum's author there.
4812  Dictum and author are separated by a line.
4813  You need at least Koma-Script version 2.8q to use this.
4814
4815 \family sans
4816 Dictum
4817 \family default
4818  is not contained in
4819 \emph on
4820 article (koma-script)
4821 \emph default
4822 .
4823 \end_layout
4824
4825 \begin_layout Standard
4826 The following types,
4827  together with the standard types
4828 \family sans
4829 Title
4830 \family default
4831 ,
4832
4833 \family sans
4834 Author
4835 \family default
4836 ,
4837  and
4838 \family sans
4839 Date
4840 \family default
4841 ,
4842  form the title area of the document.
4843  They must be entered ahead of the first
4844 \begin_inset Quotes eld
4845 \end_inset
4846
4847 ordinary
4848 \begin_inset Quotes erd
4849 \end_inset
4850
4851  paragraph.
4852 \begin_inset Foot
4853 status collapsed
4854
4855 \begin_layout Plain Layout
4856 The corresponding \SpecialChar LaTeX
4857  commands must appear before the
4858 \family typewriter
4859
4860 \backslash
4861 maketitle
4862 \family default
4863  command.
4864 \end_layout
4865
4866 \end_inset
4867
4868  When such a type is used more than once,
4869  the latter usage overwrites the former one,
4870  that means,
4871  for every type only the latest usage is valid.
4872  The order of the different types however has,
4873  like
4874 \family sans
4875 Title
4876 \family default
4877 ,
4878
4879 \family sans
4880 Author
4881 \family default
4882 ,
4883  and
4884 \family sans
4885 Date
4886 \family default
4887 ,
4888  no effect on the appearance of the produced document.
4889 \end_layout
4890
4891 \begin_layout Itemize
4892
4893 \family sans
4894 Subject
4895 \family default
4896 :
4897  produces a centered paragraph above the ordinary title (
4898 \family sans
4899 Title
4900 \family default
4901 ,
4902
4903 \family sans
4904 Author
4905 \family default
4906 ,
4907
4908 \family sans
4909 Date
4910 \family default
4911 ) for the subject of the document.
4912 \end_layout
4913
4914 \begin_layout Itemize
4915
4916 \family sans
4917 Publishers
4918 \family default
4919 :
4920  produces a centered paragraph below the ordinary title (
4921 \family sans
4922 Title
4923 \family default
4924 ,
4925
4926 \family sans
4927 Author
4928 \family default
4929 ,
4930
4931 \family sans
4932 Date
4933 \family default
4934 ) for the publishers' name.
4935 \end_layout
4936
4937 \begin_layout Itemize
4938
4939 \family sans
4940 Dedication
4941 \family default
4942 :
4943  in
4944 \emph on
4945 report (koma-script)
4946 \emph default
4947  and
4948 \emph on
4949 book (koma-script)
4950 \emph default
4951  produces a centered paragraph on its own page behind the title page,
4952  or in
4953 \emph on
4954 article (koma-script)
4955 \emph default
4956  produces a centered paragraph below the ordinary title (
4957 \family sans
4958 Title
4959 \family default
4960 ,
4961
4962 \family sans
4963 Author
4964 \family default
4965 ,
4966
4967 \family sans
4968 Date
4969 \family default
4970 ,
4971
4972 \family sans
4973 Publishers
4974 \family default
4975 ) for a dedication.
4976 \end_layout
4977
4978 \begin_layout Itemize
4979
4980 \family sans
4981 Titlehead
4982 \family default
4983 :
4984  produces a left aligned paragraph above the ordinary title (
4985 \family sans
4986 Title
4987 \family default
4988 ,
4989
4990 \family sans
4991 Author
4992 \family default
4993 ,
4994
4995 \family sans
4996 Date
4997 \family default
4998 ,
4999
5000 \family sans
5001 Subject
5002 \family default
5003 ) for a document`s head.
5004 \end_layout
5005
5006 \begin_layout Itemize
5007
5008 \family sans
5009 Uppertitleback
5010 \family default
5011 :
5012  produces in a double-sided print in
5013 \emph on
5014 report (koma-script)
5015 \emph default
5016  and
5017 \emph on
5018 book (koma-script)
5019 \emph default
5020  a left-aligned paragraph at the top of the title page`s back or has no effect in a single-sided print or in
5021 \emph on
5022 article (koma-script)
5023 \emph default
5024 .
5025 \end_layout
5026
5027 \begin_layout Itemize
5028
5029 \family sans
5030 Lowertitleback
5031 \family default
5032 :
5033  produces in a double-sided print in
5034 \emph on
5035 report (koma-script)
5036 \emph default
5037  and
5038 \emph on
5039 book (koma-script)
5040 \emph default
5041  a left-aligned paragraph at the bottom of the title page`s back or has no effect in a single-sided print or in
5042 \emph on
5043 article (koma-script)
5044 \emph default
5045 .
5046 \end_layout
5047
5048 \begin_layout Itemize
5049
5050 \family sans
5051 Extratitle
5052 \family default
5053 :
5054  produces a special
5055 \begin_inset Quotes eld
5056 \end_inset
5057
5058 dirty
5059 \begin_inset Quotes erd
5060 \end_inset
5061
5062  page ahead of the actual document containing a paragraph without special formatting.
5063 \end_layout
5064
5065 \begin_layout Standard
5066
5067 \change_inserted 564990737 1672429680
5068 KOMA-Script offers a wide range of
5069 \family sans
5070 Cus
5071 \bar under
5072 t
5073 \bar default
5074 om Class
5075 \begin_inset space ~
5076 \end_inset
5077
5078 options
5079 \family default
5080  for the
5081 \family sans
5082 \bar under
5083 D
5084 \bar default
5085 ocument\SpecialChar menuseparator
5086
5087 \bar under
5088 S
5089 \bar default
5090 ettings\SpecialChar menuseparator
5091 Document
5092 \begin_inset space ~
5093 \end_inset
5094
5095 class
5096 \family default
5097  dialog which you can apply to the whole document,
5098  among them
5099 \end_layout
5100
5101 \begin_layout Description
5102
5103 \change_inserted 564990737 1672429680
5104
5105 \family typewriter
5106 \series medium
5107 draft=true
5108 \family default
5109 \series default
5110  which produces a PDF with a small black box at the end any line in which a formatting error occurs;
5111  the default setting is
5112 \family typewriter
5113 false
5114 \end_layout
5115
5116 \begin_layout Description
5117
5118 \change_inserted 564990737 1672429680
5119
5120 \family typewriter
5121 \series medium
5122 headings=
5123 \family default
5124 \series default
5125  which may take the values
5126 \family typewriter
5127 big
5128 \family default
5129 ,
5130
5131 \family typewriter
5132 normal
5133 \family default
5134  or
5135 \family typewriter
5136 small
5137 \family default
5138 ;
5139  the first and last adjust the sizes of the headings to take account of page sizes where the default values may not be suitable
5140 \end_layout
5141
5142 \begin_layout Description
5143
5144 \change_inserted 564990737 1672429680
5145
5146 \family typewriter
5147 \series medium
5148 numbers=
5149 \family default
5150 \series default
5151  which may take the values
5152 \family typewriter
5153 auto
5154 \family default
5155  (the default),
5156
5157 \family typewriter
5158 enddot
5159 \family default
5160  or
5161 \family typewriter
5162 noenddot
5163 \family default
5164 ;
5165  the first leaves it up to KOMA-Script to add periods after chapter,
5166  section numbers,
5167  etc.;
5168  the second forces the addition of periods and third suppresses them
5169 \end_layout
5170
5171 \begin_layout Standard
5172
5173 \change_inserted 564990737 1672429680
5174 and the math options:
5175 \end_layout
5176
5177 \begin_layout Description
5178
5179 \change_inserted 564990737 1672429680
5180
5181 \family typewriter
5182 \series medium
5183 leqno
5184 \family default
5185 \series default
5186  which causes equations to be numbered on the left rather than on the right,
5187  and
5188 \end_layout
5189
5190 \begin_layout Description
5191
5192 \change_inserted 564990737 1672429680
5193
5194 \family typewriter
5195 \series medium
5196 fleqn
5197 \family default
5198 \series default
5199  which causes equations to be left justified rather than centered.
5200 \end_layout
5201
5202 \begin_layout Standard
5203
5204 \change_inserted 564990737 1672429680
5205 It also provides commands to affect the output of the document independently of the standard \SpecialChar LaTeX
5206  commands and packages;
5207  for example,
5208  if you want your captions in bold add
5209 \end_layout
5210
5211 \begin_layout Standard
5212
5213 \change_inserted 564990737 1672429680
5214
5215 \family typewriter
5216
5217 \backslash
5218 setkomafont{captionlabel}{
5219 \backslash
5220 bfseries}
5221 \end_layout
5222
5223 \begin_layout Standard
5224
5225 \change_inserted 564990737 1672429680
5226 to
5227 \family sans
5228 \bar under
5229 D
5230 \bar default
5231 ocument\SpecialChar menuseparator
5232
5233 \bar under
5234 S
5235 \bar default
5236 ettings
5237 \family default
5238 \SpecialChar menuseparator
5239
5240 \family sans
5241 \SpecialChar LaTeX
5242
5243 \begin_inset space ~
5244 \end_inset
5245
5246 Preamble
5247 \family default
5248 ) and the problem is solved.
5249 \end_layout
5250
5251 \begin_layout Standard
5252
5253 \change_inserted 564990737 1672429680
5254 If you are writing a book,
5255  it is normal to have the preliminary pages numbered in Roman numerals and the Chapters in this part unnumbered.
5256  If you use the Chapter* environment,
5257  your Foreword and Preface will not appear in the Table of Contents;
5258  to make them to appear in the Table of contents,
5259  you need to use Chapter environments and add the \SpecialChar TeX
5260  code
5261 \end_layout
5262
5263 \begin_layout Standard
5264
5265 \change_inserted 564990737 1672429680
5266
5267 \family typewriter
5268
5269 \backslash
5270 frontmatter
5271 \end_layout
5272
5273 \begin_layout Standard
5274
5275 \change_inserted 564990737 1672429680
5276 at the very start of the book (not in the \SpecialChar LaTeX
5277  Preamble) and
5278 \end_layout
5279
5280 \begin_layout Standard
5281
5282 \change_inserted 564990737 1672429680
5283
5284 \family typewriter
5285
5286 \backslash
5287 mainmatter
5288 \end_layout
5289
5290 \begin_layout Standard
5291
5292 \change_inserted 564990737 1672429680
5293 before the first chapter of the body of the text.
5294
5295 \change_inserted -712698321 1673092640
5296 Alternatively,
5297  you might also use
5298 \family sans
5299 Chapter* (TOC)
5300 \family default
5301 .
5302 \end_layout
5303
5304 \begin_layout Standard
5305
5306 \change_inserted 564990737 1672429680
5307 You may also want to have some unnumbered Chapter environments at the end of the book after the Appendices,
5308  if any.
5309 \begin_inset Foot
5310 status open
5311
5312 \begin_layout Plain Layout
5313
5314 \change_inserted 564990737 1672429680
5315 Appendices are normally “numbered” with letters.
5316 \end_layout
5317
5318 \end_inset
5319
5320  If you use the Chapter* environment,
5321  they will not appear in the Table of Contents;
5322  so add the \SpecialChar TeX
5323  code
5324 \end_layout
5325
5326 \begin_layout Standard
5327
5328 \change_inserted 564990737 1672429680
5329
5330 \family typewriter
5331
5332 \backslash
5333 backmatter
5334 \end_layout
5335
5336 \begin_layout Standard
5337
5338 \change_inserted 564990737 1672429682
5339 before the first of these headings and use the Chapter environment.
5340  These commands will have no effect on the numbering in \SpecialChar LyX
5341 ,
5342  only on the PDF output where the headings will be unnumbered and appear in the Table of Contents.
5343 \end_layout
5344
5345 \begin_layout Standard
5346 The layout files for the document classes
5347 \emph on
5348 article (koma-script)
5349 \emph default
5350 ,
5351
5352 \emph on
5353 report (koma-script)
5354 \emph default
5355 ,
5356  and
5357 \emph on
5358 book (koma-script)
5359 \emph default
5360  do include the file
5361 \family typewriter
5362 scrmacros.inc
5363 \family default
5364 .
5365  This is thought of as a place to define your own types.
5366  Copy scrmacros
5367 \family typewriter
5368 .inc
5369 \family default
5370  in your personal layout directory and edit the file!
5371 \change_deleted 564990737 1672430255
5372
5373 \end_layout
5374
5375 \begin_layout Standard
5376
5377 \change_deleted 564990737 1672430255
5378 letter (koma-script)
5379 \end_layout
5380
5381 \begin_layout Description
5382
5383 \change_deleted 564990737 1672429749
5384 Note:
5385  This section discusses the obsolete
5386 \family sans
5387 KOMA-Script-Letter (v.
5388 \begin_inset space ~
5389 \end_inset
5390
5391 1)
5392 \family default
5393 ,
5394  which is not even included anymore in recent KOMA releases.
5395  Please refer to the next section for the current KOMA-Script-Letter class (v.
5396 \begin_inset space ~
5397 \end_inset
5398
5399 2)!
5400 \end_layout
5401
5402 \begin_layout Standard
5403 \noindent
5404
5405 \change_deleted 564990737 1672429749
5406 The document class
5407 \emph on
5408 letter (koma-script)
5409 \emph default
5410  is implemented in the layout file
5411 \family typewriter
5412 scrlettr.layout
5413 \family default
5414 .
5415  It contains all the paragraph types of the corresponding standard document class
5416 \emph on
5417 letter
5418 \emph default
5419 ,
5420  partly modified,
5421  with the exception of the \SpecialChar LyX
5422  specific types
5423 \family sans
5424 \SpecialChar LyX
5425 -Code
5426 \family default
5427  and
5428 \family sans
5429 Comment
5430 \family default
5431  and the
5432 \family sans
5433 List
5434 \family default
5435  type,
5436  which is replaced by the new
5437 \family sans
5438 Labeling
5439 \family default
5440  type.
5441  In addition,
5442  it contains,
5443  in contrast to the standard document class,
5444  the standard types
5445 \family sans
5446 \SpecialChar LaTeX
5447
5448 \family default
5449 ,
5450
5451 \family sans
5452 Quotation
5453 \family default
5454 ,
5455
5456 \family sans
5457 Quote
5458 \family default
5459 ,
5460  and
5461 \family sans
5462 Verse
5463 \family default
5464 .
5465  Furthermore,
5466  there are a number of new letter specific types.
5467 \end_layout
5468
5469 \begin_layout Standard
5470
5471 \change_deleted 564990737 1672429749
5472 The appearance of the letter produced by this document class can be controlled by a number of \SpecialChar LaTeX
5473  commands,
5474  which you can put in the \SpecialChar LaTeX
5475  preamble.
5476 \begin_inset Foot
5477 status collapsed
5478
5479 \begin_layout Plain Layout
5480 For example,
5481  the standard appearance of the letter`s heading,
5482  consisting of name and address,
5483  is quite self-willed.
5484  An
5485 \begin_inset Quotes eld
5486 \end_inset
5487
5488 ordinary
5489 \begin_inset Quotes erd
5490 \end_inset
5491
5492  heading is produced by the following \SpecialChar LaTeX
5493  commands in the preamble:
5494 \end_layout
5495
5496 \begin_layout LyX-Code
5497
5498 \backslash
5499 firsthead{
5500 \backslash
5501 parbox[b]{
5502 \backslash
5503 textwidth}
5504 \end_layout
5505
5506 \begin_layout LyX-Code
5507   {
5508 \backslash
5509 ignorespaces
5510 \backslash
5511 fromname
5512 \backslash
5513
5514 \backslash
5515
5516 \backslash
5517 ignorespaces
5518 \backslash
5519 fromaddress}}
5520 \end_layout
5521
5522 \begin_layout LyX-Code
5523
5524 \backslash
5525 nexthead{
5526 \backslash
5527 parbox[b]{
5528 \backslash
5529 textwidth}
5530 \end_layout
5531
5532 \begin_layout LyX-Code
5533   {
5534 \backslash
5535 ignorespaces
5536 \backslash
5537 fromname
5538 \backslash
5539 hfill
5540 \backslash
5541 ignorespaces
5542 \backslash
5543 pagename
5544 \backslash
5545
5546 \backslash
5547 thepage}}
5548 \end_layout
5549
5550 \end_inset
5551
5552  A detailed German description of such \SpecialChar LaTeX
5553  commands can be found in the Koma-Script documentation
5554 \emph on
5555 scrguide
5556 \emph default
5557 .
5558  With it,
5559  the letter's author can produce his personal letter layout.
5560 \end_layout
5561
5562 \begin_layout Standard
5563
5564 \change_deleted 564990737 1672429749
5565 The types
5566 \family sans
5567 Letter
5568 \family default
5569  and
5570 \family sans
5571 Opening
5572 \family default
5573  define the beginning of the letter and must be used in every letter.
5574  To emphasize them in the \SpecialChar LyX
5575  document class,
5576  they are marked with the letter
5577 \shape italic
5578 L
5579 \shape default
5580  or
5581 \shape italic
5582 O
5583 \shape default
5584 ,
5585  resp.
5586 \begin_inset space ~
5587 \end_inset
5588
5589 in the left margin.
5590  It is possible to write any number of letters in one file.
5591  An
5592 \family sans
5593 Opening
5594 \family default
5595  type produces a new letter using the same addressee and a
5596 \family sans
5597 Letter
5598 \family default
5599  type produces a new addressee.
5600  The types
5601 \family sans
5602 Closing
5603 \family default
5604 ,
5605
5606 \family sans
5607 PS
5608 \family default
5609 ,
5610
5611 \family sans
5612 CC
5613 \family default
5614 ,
5615  and
5616 \family sans
5617 Encl
5618 \family default
5619  are ordinary paragraph types and can also be used several times in one and the same letter.
5620 \end_layout
5621
5622 \begin_layout Itemize
5623
5624 \change_deleted 564990737 1672429749
5625
5626 \family sans
5627 Letter
5628 \family default
5629 :
5630  produces a paragraph for the addressee and implicitly defines the beginning of the letter.
5631 \end_layout
5632
5633 \begin_layout Itemize
5634
5635 \change_deleted 564990737 1672429749
5636
5637 \family sans
5638 Opening
5639 \family default
5640 :
5641  produces a paragraph for the form of address and implicitly produces a new letter.
5642 \end_layout
5643
5644 \begin_layout Itemize
5645
5646 \change_deleted 564990737 1672429749
5647
5648 \family sans
5649 Closing
5650 \family default
5651 :
5652  produces a paragraph for a close.
5653 \end_layout
5654
5655 \begin_layout Itemize
5656
5657 \change_deleted 564990737 1672429749
5658
5659 \family sans
5660 PS
5661 \family default
5662 :
5663  produces a paragraph for a postscript.
5664 \end_layout
5665
5666 \begin_layout Itemize
5667
5668 \change_deleted 564990737 1672429749
5669
5670 \family sans
5671 CC
5672 \family default
5673 :
5674  produces a paragraph for a distribution list.
5675 \end_layout
5676
5677 \begin_layout Itemize
5678
5679 \change_deleted 564990737 1672429749
5680
5681 \family sans
5682 Encl
5683 \family default
5684 :
5685  produces a paragraph for enclosures.
5686 \end_layout
5687
5688 \begin_layout Standard
5689
5690 \change_deleted 564990737 1672429749
5691 The types
5692 \family sans
5693 Name
5694 \family default
5695 ,
5696
5697 \family sans
5698 Signature
5699 \family default
5700 ,
5701
5702 \family sans
5703 Address
5704 \family default
5705 ,
5706
5707 \family sans
5708 Telephone
5709 \family default
5710 ,
5711
5712 \family sans
5713 Place
5714 \family default
5715 ,
5716
5717 \family sans
5718 Backaddress
5719 \family default
5720 ,
5721
5722 \family sans
5723 Specialmail
5724 \family default
5725 ,
5726
5727 \family sans
5728 Location
5729 \family default
5730 ,
5731
5732 \family sans
5733 Title
5734 \family default
5735 ,
5736  and
5737 \family sans
5738 Subject
5739 \family default
5740  are input types provided with a label to enter information,
5741  which will be processed by the document class.
5742 \begin_inset Foot
5743 status collapsed
5744
5745 \begin_layout Plain Layout
5746 It could be seen as a matter of inconsequence,
5747  that the types
5748 \family sans
5749 Letter
5750 \family default
5751  and
5752 \family sans
5753 Opening
5754 \family default
5755  described above are not such input types as well.
5756  Because of the special meaning of those types,
5757  however,
5758  I have implemented them as ordinary paragraph types with a one letter mark in the left margin.
5759  Moreover,
5760  it would affect my feeling of symmetry,
5761  if the
5762 \family sans
5763 Opening
5764 \family default
5765  type and the
5766 \family sans
5767 Closing
5768 \family default
5769  type had such a serious different appearance.
5770 \end_layout
5771
5772 \end_inset
5773
5774  The types must be used ahead of the corresponding
5775 \family sans
5776 Opening
5777 \family default
5778  type.
5779 \end_layout
5780
5781 \begin_layout Standard
5782
5783 \change_deleted 564990737 1672429749
5784 An implementation of these types in a WYSIWYG fashion does not seem to make sense,
5785  because the real appearance of the produced letter does not only depend on the usage of the particular type,
5786  but also on other factors.
5787  For example,
5788  a signature entered in the
5789 \family sans
5790 Signature
5791 \family default
5792  type will in the standard behavior appear in the produced letter only,
5793  when in the same letter also a
5794 \family sans
5795 Closing
5796 \family default
5797  type is used.
5798  The entered value of the
5799 \family sans
5800 Telephone
5801 \family default
5802  type will in the standard behavior not appear in the produced letter at all.
5803  The possibility to design the letter`s heading freely is already indicated in a footnote above.
5804 \end_layout
5805
5806 \begin_layout Standard
5807
5808 \change_deleted 564990737 1672429749
5809 The input types can also be used as empty paragraphs.
5810  This makes sense e.
5811 \begin_inset space \thinspace{}
5812 \end_inset
5813
5814 g.
5815 \begin_inset space \space{}
5816 \end_inset
5817
5818 for the
5819 \family sans
5820 Signature
5821 \family default
5822  type.
5823  If the
5824 \family sans
5825 Signature
5826 \family default
5827  type is not used at all,
5828  in the standard behavior the value of the
5829 \family sans
5830 Name
5831 \family default
5832  type is used as signature,
5833  whereas if an empty
5834 \family sans
5835 Signature
5836 \family default
5837  type is used,
5838  no signature value is defined.
5839 \end_layout
5840
5841 \begin_layout Standard
5842
5843 \change_deleted 564990737 1672429749
5844 By using the input types it is possible to write a letter template,
5845  containing filled input types with your personal dates (name,
5846  address,
5847  etc.) and empty input types for other dates you want to enter.
5848 \end_layout
5849
5850 \begin_layout Itemize
5851
5852 \change_deleted 564990737 1672429749
5853
5854 \family sans
5855 Name
5856 \family default
5857 :
5858  sender's name,
5859  in the standard behavior appears as a centered paragraph in small caps in the letter`s heading.
5860 \end_layout
5861
5862 \begin_layout Itemize
5863
5864 \change_deleted 564990737 1672429749
5865
5866 \family sans
5867 Signature
5868 \family default
5869 :
5870  sender's signature,
5871  in the standard behavior appears below the
5872 \family sans
5873 Closing
5874 \family default
5875  type.
5876  If no
5877 \family sans
5878 Signature
5879 \family default
5880  type is used,
5881  the value of the
5882 \family sans
5883 Name
5884 \family default
5885  type appears instead.
5886 \end_layout
5887
5888 \begin_layout Itemize
5889
5890 \change_deleted 564990737 1672429749
5891
5892 \family sans
5893 Address
5894 \family default
5895 :
5896  sender's address,
5897  in the standard behavior appears in a centered paragraph in the letter`s heading below the sender's name.
5898 \end_layout
5899
5900 \begin_layout Itemize
5901
5902 \change_deleted 564990737 1672429749
5903
5904 \family sans
5905 Telephone
5906 \family default
5907 :
5908  sender's telephone number,
5909  in the standard behavior only sets the \SpecialChar LaTeX
5910  variable
5911 \family typewriter
5912
5913 \backslash
5914 telephonenum
5915 \family default
5916 .
5917 \end_layout
5918
5919 \begin_layout Itemize
5920
5921 \change_deleted 564990737 1672429749
5922
5923 \family sans
5924 Place
5925 \family default
5926 :
5927  place of the letter`s making.
5928 \end_layout
5929
5930 \begin_layout Itemize
5931
5932 \change_deleted 564990737 1672429749
5933
5934 \family sans
5935 Date
5936 \family default
5937 :
5938  date of the letter`s making.
5939
5940 \family sans
5941 Place
5942 \family default
5943  and
5944 \family sans
5945 Date
5946 \family default
5947 ,
5948  in the standard behavior,
5949  produce the place and the date in a right-aligned line below the addressee's field.
5950  If an empty
5951 \family sans
5952 Date
5953 \family default
5954  type is used,
5955  neither place nor date appear,
5956  independent of the value of the
5957 \family sans
5958 Place
5959 \family default
5960  type.
5961  If no
5962 \family sans
5963 Date
5964 \family default
5965  type is used,
5966  the date of the letter `s production is used.
5967 \end_layout
5968
5969 \begin_layout Itemize
5970
5971 \change_deleted 564990737 1672429749
5972
5973 \family sans
5974 Backaddress
5975 \family default
5976 :
5977  sender`s back address,
5978  in the standard behavior appears above the addressee's field in a small sans serif font.
5979 \end_layout
5980
5981 \begin_layout Itemize
5982
5983 \change_deleted 564990737 1672429749
5984
5985 \family sans
5986 Specialmail
5987 \family default
5988 :
5989  special mail information,
5990  in the standard behavior appears underlined above the addressee's field below the back address.
5991 \end_layout
5992
5993 \begin_layout Itemize
5994
5995 \change_deleted 564990737 1672429749
5996
5997 \family sans
5998 Location
5999 \family default
6000 :
6001  additional information,
6002  in the standard behavior appears on right side below the addressee`s field.
6003 \end_layout
6004
6005 \begin_layout Itemize
6006
6007 \change_deleted 564990737 1672429749
6008
6009 \family sans
6010 Title
6011 \family default
6012 :
6013  the letter's title,
6014  in the standard behavior appears in a big,
6015  bold,
6016  sans serif font above the subject.
6017 \end_layout
6018
6019 \begin_layout Itemize
6020
6021 \change_deleted 564990737 1672429749
6022
6023 \family sans
6024 Subject
6025 \family default
6026 :
6027  the letter's subject,
6028  in the standard behavior appears in a bold font above the
6029 \family sans
6030 Opening
6031 \family default
6032  paragraph.
6033 \end_layout
6034
6035 \begin_layout Standard
6036
6037 \change_deleted 564990737 1672429749
6038 The types
6039 \family sans
6040 Yourref
6041 \family default
6042 ,
6043
6044 \family sans
6045 Yourmail
6046 \family default
6047 ,
6048
6049 \family sans
6050 Myref
6051 \family default
6052 ,
6053
6054 \family sans
6055 Customer
6056 \family default
6057 ,
6058  and
6059 \family sans
6060 Invoice
6061 \family default
6062  produce a business letter like line above the
6063 \family sans
6064 Title
6065 \family default
6066  line containing the fields
6067 \begin_inset Quotes eld
6068 \end_inset
6069
6070 Your ref.
6071 \begin_inset Quotes erd
6072 \end_inset
6073
6074 ,
6075
6076 \begin_inset Quotes eld
6077 \end_inset
6078
6079 Your letter of
6080 \begin_inset Quotes erd
6081 \end_inset
6082
6083 ,
6084
6085 \begin_inset Quotes eld
6086 \end_inset
6087
6088 Our ref.
6089 \begin_inset Quotes erd
6090 \end_inset
6091
6092 ,
6093
6094 \begin_inset Quotes eld
6095 \end_inset
6096
6097 Customer no.
6098 \begin_inset Quotes erd
6099 \end_inset
6100
6101 ,
6102
6103 \begin_inset Quotes eld
6104 \end_inset
6105
6106 Invoice no.
6107 \begin_inset Quotes erd
6108 \end_inset
6109
6110 ,
6111  and
6112 \begin_inset Quotes eld
6113 \end_inset
6114
6115 Date
6116 \begin_inset Quotes erd
6117 \end_inset
6118
6119 .
6120  For the date field,
6121  the value of the
6122 \family sans
6123 Date
6124 \family default
6125  type is used.
6126  If one of these
6127 \begin_inset Quotes eld
6128 \end_inset
6129
6130 business letter types
6131 \begin_inset Quotes erd
6132 \end_inset
6133
6134  is used,
6135  the value of the
6136 \family sans
6137 Place
6138 \family default
6139  type however does not appear,
6140  but only the \SpecialChar LaTeX
6141  variable
6142 \family typewriter
6143
6144 \backslash
6145 fromplace
6146 \family default
6147  is set.
6148  The ordinary output of place and date in a right-aligned line below the addressee`s field is suppressed.
6149  The types are implemented as input types provided with a label and must be used ahead of the corresponding
6150 \family sans
6151 Opening
6152 \family default
6153  type.
6154 \end_layout
6155
6156 \begin_layout Itemize
6157
6158 \change_deleted 564990737 1672429749
6159
6160 \family sans
6161 Yourref
6162 \family default
6163 :
6164  Your ref.
6165 \end_layout
6166
6167 \begin_layout Itemize
6168
6169 \change_deleted 564990737 1672429749
6170
6171 \family sans
6172 Yourmail
6173 \family default
6174 :
6175  Your letter of.
6176 \end_layout
6177
6178 \begin_layout Itemize
6179
6180 \change_deleted 564990737 1672429749
6181
6182 \family sans
6183 Myref
6184 \family default
6185 :
6186  Our ref.
6187 \end_layout
6188
6189 \begin_layout Itemize
6190
6191 \change_deleted 564990737 1672429749
6192
6193 \family sans
6194 Customer
6195 \family default
6196 :
6197  Customer no.
6198 \end_layout
6199
6200 \begin_layout Itemize
6201
6202 \change_deleted 564990737 1672429749
6203
6204 \family sans
6205 Invoice
6206 \family default
6207 :
6208  Invoice no.
6209 \change_unchanged
6210
6211 \end_layout
6212
6213 \begin_layout Subsubsection
6214
6215 \change_deleted 564990737 1672429773
6216 The new letter class:
6217  letter (koma-script v.2)
6218 \change_inserted 564990737 1672429774
6219
6220 \begin_inset CommandInset label
6221 LatexCommand label
6222 name "subsec:The-new-letter"
6223
6224 \end_inset
6225
6226 The new letter class:
6227
6228 \change_inserted -712698321 1673092709
6229 KOMA-Script
6230 \change_deleted -712698321 1673092710
6231 l
6232 \change_inserted -712698321 1673092710
6233 L
6234 \change_inserted 564990737 1672429774
6235 etter (
6236 \change_deleted -712698321 1673092713
6237 KOMA-Script v
6238 \change_inserted -712698321 1673092714
6239 V
6240 \change_inserted 564990737 1672429774
6241 .
6242
6243 \change_inserted -712698321 1673092715
6244
6245 \change_inserted 564990737 1672429774
6246 2)
6247 \change_unchanged
6248
6249 \end_layout
6250
6251 \begin_layout Standard
6252 by
6253 \noun on
6254 Jürgen Spitzmüller
6255 \end_layout
6256
6257 \begin_layout Standard
6258 \begin_inset VSpace medskip
6259 \end_inset
6260
6261
6262 \end_layout
6263
6264 \begin_layout Standard
6265 \noindent
6266 Koma-Script version 2.8 has introduced a new letter class
6267 \family typewriter
6268 scrlttr2
6269 \family default
6270  which supersedes the now unsupported
6271 \family typewriter
6272 scrlettr
6273 \family default
6274 .
6275  It has —
6276  on the \SpecialChar LaTeX
6277  side —
6278  a completely new interface and is not compatible with the old class.
6279  Therefore,
6280  \SpecialChar LyX
6281  supports both,
6282  though it is recommended you use the new class.
6283 \end_layout
6284
6285 \begin_layout Standard
6286 This class covers the same functionality as
6287 \emph on
6288 letter (koma-script),
6289
6290 \emph default
6291  and a few more.
6292  The basic items are
6293 \family sans
6294 Address
6295 \family default
6296  (receiver's address,
6297  same as
6298 \family sans
6299 Letter
6300 \family default
6301  in the old layout),
6302
6303 \family sans
6304 Opening
6305 \family default
6306 ,
6307  and
6308 \family sans
6309 Closing
6310 \family default
6311 .
6312
6313 \family sans
6314 NextAddress
6315 \family default
6316  will start a new letter (i.
6317 \begin_inset space \thinspace{}
6318 \end_inset
6319
6320 e.
6321 \begin_inset space \space{}
6322 \end_inset
6323
6324 you can write several letters per document).
6325  New elements are sender's
6326 \family sans
6327 E-Mail
6328 \family default
6329 ,
6330
6331 \family sans
6332 URL
6333 \family default
6334 ,
6335
6336 \family sans
6337 Fax
6338 \family default
6339 ,
6340
6341 \family sans
6342 Bank
6343 \family default
6344  and the possibility to use a
6345 \family sans
6346 Logo
6347 \family default
6348  (via
6349 \family sans
6350 Insert\SpecialChar menuseparator
6351 Graphics
6352 \family default
6353 ) in the header.
6354 \end_layout
6355
6356 \begin_layout Standard
6357 The biggest improvement is,
6358  though,
6359  that the letter's layout is configurable to meet almost any needs.
6360  This can be done via the preamble or with a special style file (Letter Class Option,
6361  extension
6362 \family typewriter
6363 *.lco
6364 \family default
6365 ),
6366  that will be read in as a class option.
6367 \begin_inset Foot
6368 status collapsed
6369
6370 \begin_layout Plain Layout
6371 The KOMA package comes with some default
6372 \family typewriter
6373 *.lco
6374 \family default
6375  files.
6376  There is,
6377  for instance,
6378  a
6379 \family typewriter
6380 DIN.lco
6381 \family default
6382  file that follows german typesetting rules,
6383  or a
6384 \family typewriter
6385 KOMAold.lco
6386 \family default
6387  that provides the default layout of the old
6388 \family typewriter
6389 scrlettr
6390 \family default
6391  class.
6392  The latter can be loaded with the class option
6393 \family typewriter
6394 KOMAold
6395 \family default
6396 ,
6397  inserted via the
6398 \family sans
6399 Layout\SpecialChar menuseparator
6400 Document\SpecialChar menuseparator
6401 Extra Options
6402 \family default
6403  field.
6404 \end_layout
6405
6406 \end_inset
6407
6408  Have a look at the
6409 \change_deleted 564990737 1671617922
6410
6411 \emph on
6412 koma-letter2
6413 \change_unchanged
6414
6415 \emph default
6416  template
6417 \change_deleted 564990737 1671617938
6418 that is included in \SpecialChar LyX
6419  for examples
6420 \change_inserted 564990737 1671617997
6421  in
6422 \family sans
6423 \bar under
6424 F
6425 \bar default
6426 ile\SpecialChar menuseparator
6427 New
6428 \begin_inset space ~
6429 \end_inset
6430
6431 fro
6432 \bar under
6433 m
6434 \bar default
6435
6436 \begin_inset space ~
6437 \end_inset
6438
6439 Template\SpecialChar menuseparator
6440 Letters\SpecialChar menuseparator
6441 KOMA-Script Letter (V.2)
6442 \change_unchanged
6443
6444 \family default
6445 .
6446  A detailed description is to be found in the Koma-Script documentation (
6447 \emph on
6448 scrguide
6449 \emph default
6450 ).
6451 \end_layout
6452
6453 \begin_layout Subsubsection
6454 Problems
6455 \end_layout
6456
6457 \begin_layout Standard
6458 Visualizing the Koma-Script document classes in \SpecialChar LyX
6459 ,
6460  the \SpecialChar LyX
6461  internals cause some problems.
6462 \end_layout
6463
6464 \begin_layout Itemize
6465 The chapter number of a
6466 \family sans
6467 Chapter
6468 \family default
6469  type appears on a line of its own above the chapter heading instead of appearing in the same line ahead of it.
6470  The cause for that is the \SpecialChar LyX
6471  internal behavior for the labeltype
6472 \family sans
6473 Counter_Chapter
6474 \family default
6475  in the layout file.
6476 \end_layout
6477
6478 \begin_layout Itemize
6479 The headings of the types
6480 \family sans
6481 Addchap
6482 \family default
6483  and
6484 \family sans
6485 Addsec
6486 \family default
6487  are only put in the
6488 \begin_inset Quotes eld
6489 \end_inset
6490
6491 true
6492 \begin_inset Quotes erd
6493 \end_inset
6494
6495  \SpecialChar LaTeX
6496  table of contents,
6497  but not in the \SpecialChar LyX
6498  table of contents (
6499 \family sans
6500 Document\SpecialChar menuseparator
6501 Table
6502 \begin_inset space ~
6503 \end_inset
6504
6505 of
6506 \begin_inset space ~
6507 \end_inset
6508
6509 Contents
6510 \family default
6511 ).
6512 \end_layout
6513
6514 \begin_layout Itemize
6515 The paragraphs in a
6516 \emph on
6517 letter
6518 \emph default
6519  document class appear in a skip separation mode,
6520  not indented.
6521  This is the standard behavior,
6522  no special \SpecialChar LaTeX
6523  commands are needed for that.
6524  But in the
6525 \family sans
6526 Document\SpecialChar menuseparator
6527 Settings
6528 \family default
6529  dialog the corresponding radio button indicates
6530 \family sans
6531 Indent
6532 \family default
6533 .
6534  A
6535 \family sans
6536 Skip
6537 \family default
6538  value always has the effect that extra \SpecialChar LaTeX
6539  commands are inserted in the document to produce the gap,
6540  which is not what is wanted in this case.
6541 \end_layout
6542
6543 \begin_layout Subsection
6544
6545 \change_inserted 564990737 1672743555
6546 \begin_inset CommandInset label
6547 LatexCommand label
6548 name "subsec:Polish-M.W.collection"
6549
6550 \end_inset
6551
6552 Polish M.
6553 \begin_inset space \thinspace{}
6554 \end_inset
6555
6556 W.
6557 \begin_inset space \space{}
6558 \end_inset
6559
6560 collection
6561 \change_deleted 564990737 1670924933
6562 Article (mwart),
6563  book (mwbk) and report (mwrep)
6564 \begin_inset Argument status
6565 status collapsed
6566
6567 \begin_layout Plain Layout
6568 The
6569 \family typewriter
6570 mw
6571 \family default
6572  Classes
6573 \end_layout
6574
6575 \end_inset
6576
6577
6578 \change_unchanged
6579
6580 \end_layout
6581
6582 \begin_layout Standard
6583 by
6584 \noun on
6585 Tomasz Luczak
6586 \end_layout
6587
6588 \begin_layout Standard
6589 The \SpecialChar LyX
6590  document classes
6591 \change_deleted -712698321 1673094342
6592
6593 \emph on
6594 article (mwart)
6595 \change_inserted -712698321 1673094343
6596 Polish Article (MW Bundle)
6597 \change_unchanged
6598
6599 \emph default
6600 ,
6601
6602 \change_deleted -712698321 1673094349
6603
6604 \emph on
6605 report (mwrep)
6606 \change_inserted -712698321 1673094356
6607 Polish Report (MW Bundle)
6608 \change_unchanged
6609
6610 \emph default
6611  and
6612 \change_deleted -712698321 1673094352
6613
6614 \emph on
6615 book
6616 \emph default
6617
6618 \emph on
6619 (mwbk)
6620 \change_inserted -712698321 1673094359
6621 Polish Book (MW Bundle)
6622 \change_unchanged
6623
6624 \emph default
6625  correspond to the \SpecialChar LaTeX
6626  document classes
6627 \family typewriter
6628 mwart.cls
6629 \family default
6630 ,
6631
6632 \family typewriter
6633 mwrep.cls
6634 \family default
6635  and
6636 \family typewriter
6637 mwbk.cls
6638 \family default
6639 ,
6640  resp.
6641  They are replacements for the standard document classes
6642 \family typewriter
6643 article.cls
6644 \family default
6645 ,
6646
6647 \family typewriter
6648 report.cls
6649 \family default
6650  and
6651 \family typewriter
6652 book.cls
6653 \family default
6654 ,
6655  resp.,
6656  and fit better to Polish typography conventions in a number of points.
6657
6658 \end_layout
6659
6660 \begin_layout Standard
6661 Basic differences:
6662 \end_layout
6663
6664 \begin_layout Itemize
6665 Unnumbered titles (with star,
6666  e.
6667 \begin_inset space \thinspace{}
6668 \end_inset
6669
6670 g.
6671 \begin_inset space \space{}
6672 \end_inset
6673
6674
6675 \family sans
6676 Section*
6677 \family default
6678 ) are added into table of contents,
6679 \end_layout
6680
6681 \begin_layout Itemize
6682 Additional page styles:
6683 \end_layout
6684
6685 \begin_deeper
6686 \begin_layout Description
6687 uheadings header with separated lines,
6688 \end_layout
6689
6690 \begin_layout Description
6691 myheadings custom header,
6692  contents headers via commands:
6693
6694 \family typewriter
6695
6696 \backslash
6697 markright
6698 \family default
6699  and
6700 \family typewriter
6701
6702 \backslash
6703 markboth
6704 \family default
6705 ,
6706 \end_layout
6707
6708 \begin_layout Description
6709 myuheadings custom header with separated lines,
6710 \end_layout
6711
6712 \begin_layout Description
6713 outer page number is placed on outer side of page
6714 \end_layout
6715
6716 \end_deeper
6717 \begin_layout Itemize
6718 Options
6719 \end_layout
6720
6721 \begin_deeper
6722 \begin_layout Description
6723 rmheadings serif titles —
6724  default,
6725 \end_layout
6726
6727 \begin_layout Description
6728 sfheadings sansserif titles,
6729 \end_layout
6730
6731 \begin_layout Description
6732 authortitle on title page first placed is author next title —
6733  default,
6734 \end_layout
6735
6736 \begin_layout Description
6737 titleauthor on title page first placed is title next author,
6738 \end_layout
6739
6740 \begin_layout Description
6741 withmarginpar reserve place on page for margins.
6742 \end_layout
6743
6744 \end_deeper
6745 \begin_layout Subsection
6746
6747 \change_inserted 564990737 1672652245
6748 Tufte Collection
6749 \end_layout
6750
6751 \begin_layout Standard
6752
6753 \change_inserted 564990737 1672652245
6754 The document classes
6755 \change_deleted -712698321 1673094404
6756
6757 \family sans
6758 book
6759 \begin_inset space \thinspace{}
6760 \end_inset
6761
6762 (Tufte)
6763 \change_inserted -712698321 1673094404
6764 Tufte Book
6765 \change_inserted 564990737 1672652245
6766
6767 \family default
6768  and
6769 \change_deleted -712698321 1673094408
6770
6771 \family sans
6772 handout
6773 \begin_inset space \thinspace{}
6774 \end_inset
6775
6776 (Tufte)
6777 \change_inserted -712698321 1673094411
6778 Tufte Handout
6779 \change_inserted 564990737 1672652245
6780
6781 \family default
6782  use the
6783 \family typewriter
6784 tufte-book.cls
6785 \family default
6786  and
6787 \family typewriter
6788 tufte-handout.cls
6789 \family default
6790  document classes.
6791  Detailed information about these document classes can be found in
6792 \family sans
6793 File\SpecialChar menuseparator
6794 Open Example\SpecialChar menuseparator
6795 Books\SpecialChar menuseparator
6796 Tufte Book
6797 \family default
6798  and
6799 \family sans
6800 File\SpecialChar menuseparator
6801 Open Example\SpecialChar menuseparator
6802 Handouts\SpecialChar menuseparator
6803 Tufte Handout
6804 \family default
6805 .
6806 \end_layout
6807
6808 \begin_layout Section
6809
6810 \change_inserted 564990737 1670439534
6811 Articles
6812 \end_layout
6813
6814 \begin_layout Standard
6815
6816 \change_inserted 564990737 1670794710
6817 See also the document classes in the Collections (section
6818 \begin_inset space ~
6819 \end_inset
6820
6821
6822 \begin_inset CommandInset ref
6823 LatexCommand ref
6824 reference "sec:Collections"
6825 nolink "false"
6826
6827 \end_inset
6828
6829 ).
6830 \end_layout
6831
6832 \begin_layout Subsection
6833
6834 \change_deleted -712698321 1673095198
6835 A&A Paper
6836 \change_inserted -712698321 1673095198
6837 Astronomy & Astrophysics
6838 \change_inserted 564990737 1670794716
6839
6840 \end_layout
6841
6842 \begin_layout Standard
6843
6844 \change_inserted 564990737 1670794716
6845 Original by
6846 \noun on
6847 Peter Sütterlin
6848 \noun default
6849 ;
6850  updated by the \SpecialChar LyX
6851  Team
6852 \end_layout
6853
6854 \begin_layout Subsubsection
6855
6856 \change_inserted 564990737 1670794716
6857 Introduction
6858 \end_layout
6859
6860 \begin_layout Standard
6861
6862 \change_inserted 564990737 1670794716
6863 This section describes how \SpecialChar LyX
6864  can be used to write articles for submission to the scientific journal
6865 \emph on
6866 Astronomy
6867 \change_deleted -712698321 1673095254
6868 and
6869 \change_inserted -712698321 1673095254
6870 &
6871 \change_inserted 564990737 1670794716
6872  Astrophysics
6873 \emph default
6874  (
6875 \begin_inset CommandInset href
6876 LatexCommand href
6877 name "aa-package"
6878 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
6879 literal "false"
6880
6881 \end_inset
6882
6883 ) using Version 9.1 of the document class
6884 \family typewriter
6885 aa.cls
6886 \family default
6887 ;
6888  information about it is available at
6889 \begin_inset Flex URL
6890 status collapsed
6891
6892 \begin_layout Plain Layout
6893
6894 \change_inserted 564990737 1670794716
6895
6896 https://www.aanda.org/for-authors/latex-issues/texnical-background-information
6897 \change_unchanged
6898
6899 \end_layout
6900
6901 \end_inset
6902
6903 .
6904 \end_layout
6905
6906 \begin_layout Standard
6907
6908 \change_inserted 564990737 1670794716
6909 A manual comes together with the package and should be consulted before installing this document class as described in the
6910 \emph on
6911 Installing New Document Classe
6912 \emph default
6913 s section of the
6914 \emph on
6915 Customization
6916 \emph default
6917  manual.
6918
6919 \end_layout
6920
6921 \begin_layout Standard
6922
6923 \change_inserted 564990737 1670794716
6924 \begin_inset Note Greyedout
6925 status open
6926
6927 \begin_layout Plain Layout
6928
6929 \change_inserted 564990737 1670794716
6930 Please note that the publisher of the journal was changed from Springer to EDP Sciences starting January 1,
6931  2001.
6932  That change also involved some slight changes to the style files,
6933  namely the removal of the thesaurus command.
6934  If you have an older version installed,
6935  please upgrade.
6936  For information about compatibility with the old (version 4) layout,
6937  please refer to the comments in
6938 \family typewriter
6939 \SpecialChar LyX
6940 Dir/layouts/aapaper.layout
6941 \family default
6942 .
6943 \end_layout
6944
6945 \end_inset
6946
6947
6948 \end_layout
6949
6950 \begin_layout Subsubsection
6951
6952 \change_inserted 564990737 1670794716
6953 Getting started
6954 \end_layout
6955
6956 \begin_layout Standard
6957
6958 \change_inserted 564990737 1671617129
6959 It is recommended you start from the template in the menu
6960 \family sans
6961 \bar under
6962 F
6963 \bar default
6964 ile\SpecialChar menuseparator
6965 New
6966 \begin_inset space ~
6967 \end_inset
6968
6969 fro
6970 \bar under
6971 m
6972 \bar default
6973
6974 \begin_inset space ~
6975 \end_inset
6976
6977 Template\SpecialChar menuseparator
6978 Articles\SpecialChar menuseparator
6979 Astronomy & Astrophysics
6980 \family default
6981 .
6982  If you are not using the template,
6983  note the following settings:
6984 \end_layout
6985
6986 \begin_layout Itemize
6987
6988 \change_inserted 564990737 1670794716
6989 Select
6990 \change_deleted -712698321 1673095619
6991
6992 \family sans
6993 article (A&A)
6994 \change_inserted -712698321 1673095619
6995 Astronomy & Astrophysics
6996 \change_inserted 564990737 1670794716
6997
6998 \family default
6999  in the
7000 \family sans
7001 \bar under
7002 D
7003 \bar default
7004 ocument\SpecialChar menuseparator
7005
7006 \bar under
7007 S
7008 \bar default
7009 ettings\SpecialChar menuseparator
7010 Document
7011 \begin_inset space ~
7012 \end_inset
7013
7014 Class
7015 \family default
7016  dialog (OK,
7017  that one was obvious).
7018 \end_layout
7019
7020 \begin_layout Itemize
7021
7022 \change_inserted 564990737 1670794716
7023 Don't change the
7024 \family sans
7025 Headings
7026 \begin_inset space ~
7027 \end_inset
7028
7029
7030 \bar under
7031 s
7032 \bar default
7033 tyle
7034 \family default
7035  in the
7036 \family sans
7037 Page
7038 \begin_inset space ~
7039 \end_inset
7040
7041 Layout
7042 \family default
7043  dialog:
7044  leave it set to
7045 \family sans
7046 Default
7047 \family default
7048 .
7049  The whole layout is done by the macros,
7050  you shouldn't change anything.
7051 \end_layout
7052
7053 \begin_layout Subsubsection
7054
7055 \change_inserted 564990737 1670794716
7056 The header block
7057 \end_layout
7058
7059 \begin_layout Standard
7060
7061 \change_inserted 564990737 1670794716
7062 First thing to enter is the header information.
7063  It consists of
7064 \change_deleted -712698321 1673167006
7065 five
7066 \change_inserted -712698321 1673167007
7067 seven
7068 \change_inserted 564990737 1670794716
7069  entries,
7070  of which one is optional.
7071  They are
7072 \end_layout
7073
7074 \begin_layout Itemize
7075
7076 \change_inserted 564990737 1670794716
7077
7078 \family sans
7079 Title
7080 \family default
7081 :
7082  [required]
7083 \end_layout
7084
7085 \begin_layout Itemize
7086
7087 \change_inserted 564990737 1670794716
7088
7089 \family sans
7090 Subtitle
7091 \family default
7092 :
7093  [optional]
7094 \end_layout
7095
7096 \begin_layout Itemize
7097
7098 \change_inserted 564990737 1670794716
7099
7100 \family sans
7101 Author
7102 \family default
7103 :
7104  [required]
7105 \end_layout
7106
7107 \begin_layout Itemize
7108
7109 \change_deleted -712698321 1673167065
7110
7111 \family sans
7112 Institute
7113 \change_inserted -712698321 1673167065
7114 Address
7115 \change_inserted 564990737 1670794716
7116
7117 \family default
7118 :
7119  [required]
7120 \change_inserted -712698321 1673167087
7121
7122 \end_layout
7123
7124 \begin_layout Itemize
7125
7126 \change_inserted -712698321 1673168577
7127
7128 \family sans
7129 Offprints
7130 \family default
7131  [optional].
7132  Determines to whom correspondence and reprints are to be sent.
7133 \end_layout
7134
7135 \begin_layout Itemize
7136
7137 \change_inserted -712698321 1673168590
7138
7139 \family sans
7140 Mail
7141 \family default
7142  [optional] Snail mail address for contacts.
7143 \change_inserted 564990737 1670794716
7144
7145 \end_layout
7146
7147 \begin_layout Itemize
7148
7149 \change_inserted 564990737 1670794716
7150
7151 \family sans
7152 Date
7153 \family default
7154 :
7155  [required].
7156  Suggested format is
7157 \family typewriter
7158 Received:
7159  <date>;
7160  Accepted <date>
7161 \end_layout
7162
7163 \begin_layout Standard
7164
7165 \change_inserted -712698321 1673168612
7166 There is no need to issue the
7167 \family typewriter
7168
7169 \backslash
7170 maketitle
7171 \family default
7172  command,
7173  this is done automatically by \SpecialChar LyX
7174  when the header is finished.
7175
7176 \change_inserted 564990737 1670794716
7177 Although the order of the single header entries doesn't matter it is advised to keep the above sequence,
7178  just to get the best optics and meets the layout of the real document.
7179 \end_layout
7180
7181 \begin_layout Standard
7182
7183 \change_inserted 564990737 1670794716
7184 If you want to place footnotes in the header block,
7185  e.
7186 \begin_inset space \thinspace{}
7187 \end_inset
7188
7189 g.
7190 \begin_inset space \space{}
7191 \end_inset
7192
7193 to state your present address,
7194  just use the standard footnote via the menu
7195 \family sans
7196 \bar under
7197 I
7198 \bar default
7199 nsert\SpecialChar menuseparator
7200
7201 \bar under
7202 F
7203 \bar default
7204 ootnote.
7205
7206 \family default
7207  \SpecialChar LyX
7208  will automagically use the term
7209 \family typewriter
7210
7211 \backslash
7212 thanks{}
7213 \family default
7214  in that case.
7215 \change_inserted -712698321 1673168649
7216
7217 \end_layout
7218
7219 \begin_layout Standard
7220
7221 \change_inserted -712698321 1673168649
7222 Under
7223 \family sans
7224 Edit\SpecialChar menuseparator
7225 Text Style
7226 \family default
7227 ,
7228  you'll find two insets which are relevant for the titling:
7229 \end_layout
7230
7231 \begin_layout Itemize
7232
7233 \change_inserted -712698321 1673168649
7234
7235 \family sans
7236 Institute
7237 \family typewriter
7238
7239 \family default
7240 to mark corresponding author\SpecialChar breakableslash
7241 institute pairs.
7242  The institutes are numbered sequentially as they appear in the
7243 \family sans
7244 Address
7245 \family default
7246  field,
7247  so you have to put a marker to each author.
7248 \end_layout
7249
7250 \begin_layout Itemize
7251
7252 \change_inserted -712698321 1673168649
7253
7254 \family sans
7255 Email
7256 \family default
7257  to supply an email address for fast contact.
7258 \change_inserted 564990737 1670794716
7259
7260 \end_layout
7261
7262 \begin_layout Standard
7263
7264 \change_inserted 564990737 1670794716
7265 In addition to these topics,
7266  the macros use three additional \SpecialChar LaTeX
7267  commands that have no counterpart in \SpecialChar LyX
7268 :
7269 \end_layout
7270
7271 \begin_layout Itemize
7272
7273 \change_inserted 564990737 1670794716
7274
7275 \family typewriter
7276
7277 \backslash
7278 and
7279 \family default
7280  to separate different names for more than one author and institute,
7281  respectively.
7282 \end_layout
7283
7284 \begin_layout Itemize
7285
7286 \change_deleted -712698321 1673168671
7287
7288 \family typewriter
7289
7290 \backslash
7291 inst{<nr>}
7292 \family default
7293  to mark corresponding author/institute pairs.
7294  The institutes are numbered sequentially as they appear in the
7295 \family sans
7296 Institute
7297 \family default
7298  field,
7299  so you have to put a marker to each author.
7300 \end_layout
7301
7302 \begin_layout Itemize
7303
7304 \change_deleted -712698321 1673168671
7305
7306 \family typewriter
7307
7308 \backslash
7309 email{address}
7310 \family default
7311  to supply an email address for fast contact.
7312 \change_inserted 564990737 1670794716
7313
7314 \end_layout
7315
7316 \begin_layout Standard
7317
7318 \change_deleted -712698321 1673168684
7319 In all cases,
7320  t
7321 \change_inserted -712698321 1673168684
7322 T
7323 \change_inserted 564990737 1671642374
7324 he appropriate command has to be entered as \SpecialChar TeX
7325  code in \SpecialChar LyX
7326 .
7327  See the examples in the template and in
7328 \family sans
7329 File\SpecialChar menuseparator
7330 Open Example\SpecialChar menuseparator
7331 Articles\SpecialChar menuseparator
7332 Astronomy & Astrophysics
7333 \family default
7334 .
7335 \change_unchanged
7336
7337 \end_layout
7338
7339 \begin_layout Subsubsection
7340
7341 \change_inserted 564990737 1670794716
7342 The abstract
7343 \end_layout
7344
7345 \begin_layout Standard
7346
7347 \change_inserted -712698321 1673168754
7348 The abstract should immediately follow the header block.
7349  With version 5 the abstract environment was changed to a command,
7350  and there is now a restriction to only one paragraph.
7351  In addition,
7352  it should contain an entry with the keywords.
7353  This is done via the paragraph style
7354 \family sans
7355 Keywords
7356 \family default
7357 .
7358  Refer to the example paper.
7359 \change_deleted -712698321 1673168754
7360 The abstract should immediately follow the header block and must contain five tokens:
7361
7362 \family typewriter
7363
7364 \backslash
7365 abstract{}{}{}{}{}
7366 \family default
7367
7368 \end_layout
7369
7370 \begin_layout Enumerate
7371
7372 \change_deleted -712698321 1673168754
7373
7374 \family typewriter
7375 context heading
7376 \family default
7377  (optional) {} leave it empty if necessary
7378 \end_layout
7379
7380 \begin_layout Enumerate
7381
7382 \change_deleted -712698321 1673168754
7383
7384 \family typewriter
7385 aims heading
7386 \family default
7387  (mandatory) {}
7388 \end_layout
7389
7390 \begin_layout Enumerate
7391
7392 \change_deleted -712698321 1673168754
7393
7394 \family typewriter
7395 methods heading
7396 \family default
7397  (mandatory) {}
7398 \end_layout
7399
7400 \begin_layout Enumerate
7401
7402 \change_deleted -712698321 1673168754
7403
7404 \family typewriter
7405 results heading
7406 \family default
7407  (mandatory) {}
7408 \end_layout
7409
7410 \begin_layout Enumerate
7411
7412 \change_deleted -712698321 1673168754
7413
7414 \family typewriter
7415 conclusions heading
7416 \family default
7417  (optional) {} leave it empty if necessary
7418 \end_layout
7419
7420 \begin_layout Standard
7421
7422 \change_deleted -712698321 1673168754
7423 (NB.
7424  This structure not shown in
7425 \emph on
7426 aa_sample.lyx.
7427 \emph default
7428 )
7429 \change_inserted 564990737 1670794716
7430
7431 \end_layout
7432
7433 \begin_layout Subsubsection
7434
7435 \change_inserted 564990737 1670794716
7436 Supported environments
7437 \end_layout
7438
7439 \begin_layout Standard
7440
7441 \change_inserted 564990737 1670794716
7442 The A&A paper layout supports the following environments for structuring your text:
7443 \end_layout
7444
7445 \begin_layout Standard
7446
7447 \change_inserted -712698321 1673169058
7448
7449 \family sans
7450 \begin_inset Flex Multiple Columns
7451 status open
7452
7453 \begin_layout Itemize
7454
7455 \change_inserted -712698321 1673169058
7456
7457 \family sans
7458 Standard
7459 \end_layout
7460
7461 \begin_layout Itemize
7462
7463 \change_inserted -712698321 1673169058
7464
7465 \family sans
7466 Section
7467 \end_layout
7468
7469 \begin_layout Itemize
7470
7471 \change_inserted -712698321 1673169058
7472
7473 \family sans
7474 Subsection
7475 \end_layout
7476
7477 \begin_layout Itemize
7478
7479 \change_inserted -712698321 1673169058
7480
7481 \family sans
7482 Subsubsection
7483 \end_layout
7484
7485 \begin_layout Itemize
7486
7487 \change_inserted -712698321 1673169058
7488
7489 \family sans
7490 Itemize
7491 \end_layout
7492
7493 \begin_layout Itemize
7494
7495 \change_inserted -712698321 1673169058
7496
7497 \family sans
7498 Enumerate
7499 \end_layout
7500
7501 \begin_layout Itemize
7502
7503 \change_inserted -712698321 1673169058
7504
7505 \family sans
7506 Description
7507 \end_layout
7508
7509 \begin_layout Itemize
7510
7511 \change_inserted -712698321 1673169058
7512
7513 \family sans
7514 Caption
7515 \end_layout
7516
7517 \begin_layout Itemize
7518
7519 \change_inserted -712698321 1673169058
7520
7521 \family sans
7522 Abstract
7523 \end_layout
7524
7525 \begin_layout Itemize
7526
7527 \change_inserted -712698321 1673169058
7528
7529 \family sans
7530 Acknowledgment
7531 \end_layout
7532
7533 \begin_layout Itemize
7534
7535 \change_inserted -712698321 1673169058
7536
7537 \family sans
7538 Bibliography
7539 \end_layout
7540
7541 \begin_layout Itemize
7542
7543 \change_inserted -712698321 1673169078
7544 LaTeX
7545 \change_unchanged
7546
7547 \end_layout
7548
7549 \end_inset
7550
7551
7552 \change_deleted -712698321 1673169058
7553 Standard
7554 \end_layout
7555
7556 \begin_layout Itemize
7557
7558 \change_deleted -712698321 1673169058
7559
7560 \family sans
7561 Section
7562 \end_layout
7563
7564 \begin_layout Itemize
7565
7566 \change_deleted -712698321 1673169058
7567
7568 \family sans
7569 Subsection
7570 \end_layout
7571
7572 \begin_layout Itemize
7573
7574 \change_deleted -712698321 1673169058
7575
7576 \family sans
7577 Subsubsection
7578 \end_layout
7579
7580 \begin_layout Itemize
7581
7582 \change_deleted -712698321 1673169058
7583
7584 \family sans
7585 Itemize
7586 \end_layout
7587
7588 \begin_layout Itemize
7589
7590 \change_deleted -712698321 1673169058
7591
7592 \family sans
7593 Enumerate
7594 \end_layout
7595
7596 \begin_layout Itemize
7597
7598 \change_deleted -712698321 1673169058
7599
7600 \family sans
7601 Description
7602 \end_layout
7603
7604 \begin_layout Itemize
7605
7606 \change_deleted -712698321 1673169058
7607
7608 \family sans
7609 Caption
7610 \end_layout
7611
7612 \begin_layout Itemize
7613
7614 \change_deleted -712698321 1673169058
7615
7616 \family sans
7617 Abstract
7618 \end_layout
7619
7620 \begin_layout Itemize
7621
7622 \change_deleted -712698321 1673169058
7623
7624 \family sans
7625 Acknowledgment
7626 \end_layout
7627
7628 \begin_layout Itemize
7629
7630 \change_deleted -712698321 1673169058
7631
7632 \family sans
7633 Bibliography
7634 \end_layout
7635
7636 \begin_layout Itemize
7637
7638 \change_deleted -712698321 1673169058
7639
7640 \family sans
7641 \SpecialChar LaTeX
7642
7643 \change_inserted 564990737 1670794716
7644
7645 \end_layout
7646
7647 \begin_layout Subsubsection
7648
7649 \change_inserted 564990737 1670794716
7650 Commands not supported by \SpecialChar LyX
7651
7652 \end_layout
7653
7654 \begin_layout Standard
7655
7656 \change_inserted 564990737 1670794716
7657 Some commands are not yet supported by the
7658 \change_deleted -712698321 1673169117
7659
7660 \family sans
7661 paper (A&A)
7662 \change_inserted -712698321 1673169117
7663 Astronomy & Astrophysics
7664 \change_inserted 564990737 1670794716
7665
7666 \family default
7667  layout for \SpecialChar LyX
7668 .
7669  Some have already been mentioned.
7670  For the sake of completeness,
7671  they are listed all together here:
7672 \end_layout
7673
7674 \begin_layout Itemize
7675
7676 \change_inserted 564990737 1670794716
7677
7678 \family typewriter
7679
7680 \backslash
7681 and
7682 \end_layout
7683
7684 \begin_layout Itemize
7685
7686 \change_inserted -712698321 1673168793
7687
7688 \family typewriter
7689
7690 \backslash
7691 authorrunning
7692 \end_layout
7693
7694 \begin_layout Itemize
7695
7696 \change_inserted -712698321 1673168793
7697
7698 \family typewriter
7699
7700 \backslash
7701 object{}
7702 \end_layout
7703
7704 \begin_layout Itemize
7705
7706 \change_inserted -712698321 1673168793
7707
7708 \family typewriter
7709
7710 \backslash
7711 titlerunning{}
7712 \change_deleted -712698321 1673168793
7713
7714 \backslash
7715 email
7716 \end_layout
7717
7718 \begin_layout Itemize
7719
7720 \change_deleted -712698321 1673168793
7721
7722 \family typewriter
7723
7724 \backslash
7725 inst{}
7726 \end_layout
7727
7728 \begin_layout Itemize
7729
7730 \change_deleted -712698321 1673168793
7731
7732 \family typewriter
7733
7734 \backslash
7735 keywords{}
7736 \end_layout
7737
7738 \begin_layout Itemize
7739
7740 \change_deleted -712698321 1673168793
7741
7742 \family typewriter
7743
7744 \backslash
7745 object{}
7746 \change_inserted 564990737 1670794716
7747
7748 \end_layout
7749
7750 \begin_layout Standard
7751
7752 \change_inserted 564990737 1670794716
7753 If you want to use any of these commands,
7754  you have to enter them yourself.
7755  Do not forget to use
7756 \family sans
7757
7758 \bar under
7759 I
7760 \bar default
7761 nsert\SpecialChar menuseparator
7762 \SpecialChar TeX
7763
7764 \begin_inset space ~
7765 \end_inset
7766
7767 Code
7768 \family default
7769 !
7770 \end_layout
7771
7772 \begin_layout Subsubsection
7773
7774 \change_inserted 564990737 1670794716
7775 Figure and Table Floats
7776 \end_layout
7777
7778 \begin_layout Standard
7779
7780 \change_inserted 564990737 1670794716
7781 \SpecialChar LyX
7782  provides support for the necessary float environments
7783 \family sans
7784 figure,
7785  figure*,
7786  table
7787 \family default
7788  and
7789 \family sans
7790 table*
7791 \family default
7792 ,
7793  therefore we won't tell much about it here.
7794  Refer to the
7795 \emph on
7796 User's
7797 \begin_inset space ~
7798 \end_inset
7799
7800 Guide
7801 \emph default
7802 .
7803  Just remember that tables should be left-aligned.
7804  For that,
7805  select the table and change the alignment in
7806 \family sans
7807 \bar under
7808 E
7809 \bar default
7810 dit\SpecialChar menuseparator
7811
7812 \bar under
7813 P
7814 \bar default
7815 aragraph
7816 \begin_inset space ~
7817 \end_inset
7818
7819 Settings
7820 \change_inserted -712698321 1673169201
7821
7822 \family default
7823  (
7824 \begin_inset Info
7825 type  "icon"
7826 arg   "layout-paragraph"
7827 \end_inset
7828
7829 )
7830 \change_inserted 564990737 1670794716
7831
7832 \family sans
7833 .
7834 \end_layout
7835
7836 \begin_layout Standard
7837
7838 \change_inserted 564990737 1670794716
7839 There is only one special thing:
7840  the figures with a caption beside the figure.
7841  To create such a figure,
7842  you have to do the following:
7843 \end_layout
7844
7845 \begin_layout Enumerate
7846
7847 \change_inserted 564990737 1670794716
7848 Create a wide figure float:
7849
7850 \family sans
7851 \bar under
7852 I
7853 \bar default
7854 nsert\SpecialChar menuseparator
7855 Flo
7856 \bar under
7857 a
7858 \bar default
7859 t\SpecialChar menuseparator
7860 Figure
7861 \family default
7862 ,
7863  then,
7864  from within the float,
7865  use the menu
7866 \family sans
7867 \bar under
7868 E
7869 \bar default
7870 dit\SpecialChar menuseparator
7871 Flo
7872 \bar under
7873 a
7874 \bar default
7875 t
7876 \begin_inset space ~
7877 \end_inset
7878
7879 Settings
7880 \family default
7881  and check
7882 \family sans
7883 \bar under
7884 S
7885 \bar default
7886 pan
7887 \begin_inset space ~
7888 \end_inset
7889
7890 columns
7891 \family default
7892  in the
7893 \family sans
7894 float
7895 \family default
7896  dialog.
7897 \end_layout
7898
7899 \begin_layout Enumerate
7900
7901 \change_inserted 564990737 1670794716
7902 Enter your caption text.
7903 \end_layout
7904
7905 \begin_layout Enumerate
7906
7907 \change_inserted 564990737 1670794716
7908 Press
7909 \family sans
7910 Return
7911 \family default
7912  to move the cursor above the caption.
7913 \end_layout
7914
7915 \begin_layout Enumerate
7916
7917 \change_inserted 564990737 1670794716
7918 Insert your figure
7919 \end_layout
7920
7921 \begin_layout Enumerate
7922
7923 \change_inserted 564990737 1670794716
7924 Position the cursor after the figure and insert a horizontal fill by using the menu:
7925
7926 \family sans
7927 \bar under
7928 I
7929 \bar default
7930 nsert\SpecialChar menuseparator
7931 F
7932 \bar under
7933 o
7934 \bar default
7935 rmatting\SpecialChar menuseparator
7936 H
7937 \bar under
7938 o
7939 \bar default
7940 rizontal
7941 \begin_inset space ~
7942 \end_inset
7943
7944 Space
7945 \family default
7946  to open the
7947 \family sans
7948 space
7949 \family default
7950  dialog and select the
7951 \family sans
7952 Horizontal fill
7953 \family default
7954  option from the
7955 \family sans
7956 \bar under
7957 S
7958 \bar default
7959 pacing
7960 \family default
7961
7962 \change_deleted -712698321 1673169720
7963 pull-down
7964 \change_inserted -712698321 1673169724
7965 context
7966 \change_inserted 564990737 1670794716
7967  menu.
7968 \end_layout
7969
7970 \begin_layout Enumerate
7971
7972 \change_inserted 564990737 1670794716
7973 Switch to \SpecialChar LaTeX
7974  mode:
7975
7976 \family sans
7977 M-c
7978 \begin_inset space ~
7979 \end_inset
7980
7981 t
7982 \family default
7983 .
7984 \end_layout
7985
7986 \begin_layout Enumerate
7987
7988 \change_inserted 564990737 1670794716
7989 Enter
7990 \family typewriter
7991
7992 \backslash
7993 parbox[b]{55mm}{
7994 \family default
7995
7996 \emph on
7997 Do not close the brace!
7998 \end_layout
7999
8000 \begin_layout Enumerate
8001
8002 \change_inserted 564990737 1670794716
8003 Position the cursor behind the caption text,
8004  switch to \SpecialChar LaTeX
8005  mode and insert the closing brace:
8006
8007 \family sans
8008 M-c
8009 \begin_inset space ~
8010 \end_inset
8011
8012 t
8013 \family default
8014
8015 \family typewriter
8016 }
8017 \family default
8018 .
8019 \end_layout
8020
8021 \begin_layout Standard
8022
8023 \change_inserted 564990737 1671642458
8024 Also,
8025  refer to the figures in the file in
8026 \family sans
8027 File\SpecialChar menuseparator
8028 Open Example\SpecialChar menuseparator
8029 Articles\SpecialChar menuseparator
8030 Astronomy & Astrophysics
8031 \family default
8032 .
8033 \end_layout
8034
8035 \begin_layout Subsubsection
8036
8037 \change_inserted 564990737 1670794716
8038 Referee layout
8039 \end_layout
8040
8041 \begin_layout Standard
8042
8043 \change_inserted 564990737 1670794716
8044 For submission,
8045  the paper has to be formatted in a special double-spacing layout.
8046  For this purpose,
8047  you have to add the option
8048 \family typewriter
8049 referee
8050 \family default
8051  to the
8052 \family sans
8053 Cus
8054 \bar under
8055 t
8056 \bar default
8057 om Class
8058 \begin_inset space ~
8059 \end_inset
8060
8061 options
8062 \family default
8063  in the
8064 \family sans
8065 \bar under
8066 D
8067 \bar default
8068 ocument\SpecialChar menuseparator
8069
8070 \bar under
8071 S
8072 \bar default
8073 ettings\SpecialChar menuseparator
8074 Document
8075 \begin_inset space ~
8076 \end_inset
8077
8078 Class
8079 \family default
8080  dialog.
8081
8082 \end_layout
8083
8084 \begin_layout Subsubsection
8085
8086 \change_inserted 564990737 1670794716
8087 The example paper
8088 \end_layout
8089
8090 \begin_layout Standard
8091
8092 \change_inserted 564990737 1671642520
8093 The example in
8094 \family sans
8095 File\SpecialChar menuseparator
8096 Open Example\SpecialChar menuseparator
8097 Articles\SpecialChar menuseparator
8098 Astronomy & Astrophysics
8099 \family default
8100  was written with \SpecialChar LyX
8101 .
8102  It is the example paper from the original macro package,
8103
8104 \family typewriter
8105 aa.dem
8106 \family default
8107  in the
8108 \begin_inset CommandInset href
8109 LatexCommand href
8110 name "aa-package"
8111 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
8112 literal "false"
8113
8114 \end_inset
8115
8116 ,
8117  but translated to \SpecialChar LyX
8118  using the older unstructured abstract type.
8119  Use it for inspiration,
8120  and compare the \SpecialChar LaTeX
8121  code in
8122 \family typewriter
8123 aa.dem
8124 \family default
8125  with the \SpecialChar LyX
8126  way of writing.
8127 \end_layout
8128
8129 \begin_layout Subsection
8130 AAS\SpecialChar TeX
8131
8132 \end_layout
8133
8134 \begin_layout Standard
8135 by
8136 \noun on
8137 Mike Ressler
8138 \end_layout
8139
8140 \begin_layout Subsubsection
8141 Introduction
8142 \end_layout
8143
8144 \begin_layout Standard
8145 AAS\SpecialChar TeX
8146  is a set of macros produced by the American Astronomical Society to facilitate electronic manuscript submission to the three journals they publish:
8147  the Astrophysical Journal (including the Letters and Supplement),
8148  the Astronomical Journal,
8149  and the Publications of the Astronomical Society of the Pacific.
8150  \SpecialChar LyX
8151  has proven to be an excellent tool for generating these documents,
8152  especially given its equation,
8153  citation,
8154  and figure handling capabilities.
8155  \SpecialChar LyX
8156  requires version 5.0 (or higher) of these macros;
8157  preferably 6.0,
8158  which is the version described here,
8159  or higher.
8160  Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
8161 2.09 and are fundamentally incompatible with \SpecialChar LyX
8162 .
8163  The AAS\SpecialChar TeX
8164  package may be downloaded from the AAS\SpecialChar TeX
8165  Web site
8166 \end_layout
8167
8168 \begin_layout Standard
8169 \begin_inset VSpace medskip
8170 \end_inset
8171
8172
8173 \end_layout
8174
8175 \begin_layout Standard
8176 \align center
8177 \begin_inset Flex URL
8178 status collapsed
8179
8180 \begin_layout Plain Layout
8181
8182 https://aas.org/aastex/aastex-downloads
8183 \end_layout
8184
8185 \end_inset
8186
8187
8188 \end_layout
8189
8190 \begin_layout Standard
8191 \begin_inset VSpace medskip
8192 \end_inset
8193
8194
8195 \end_layout
8196
8197 \begin_layout Standard
8198 A complete user guide is contained in that package and you should familiarize yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
8199 .
8200  \SpecialChar LyX
8201  will not reduce the need to figure out all the AAS\SpecialChar TeX
8202  commands,
8203  it will only reduce the drudgery of typing everything in.
8204  It is your responsibility to ensure that the final exported \SpecialChar LaTeX
8205  document conforms completely to the requirements of the journal to which you are submitting your paper.
8206 \end_layout
8207
8208 \begin_layout Subsubsection
8209 Starting a New Paper
8210 \end_layout
8211
8212 \begin_layout Standard
8213 I strongly suggest that you start with the AAS\SpecialChar TeX
8214  template file.
8215  Click on
8216 \family sans
8217 File\SpecialChar menuseparator
8218 New from
8219 \family default
8220
8221 \family sans
8222 Template
8223 \change_inserted 564990737 1671617265
8224 \SpecialChar menuseparator
8225 Articles\SpecialChar menuseparator
8226 American Astronomical Society
8227 \change_deleted 564990737 1671617310
8228
8229 \family default
8230 ,
8231  enter the new file name,
8232  then choose the
8233 \family typewriter
8234 aastex6.lyx
8235 \family default
8236  template
8237 \change_unchanged
8238 .
8239  This will show the most common fields found in a manuscript.
8240  Simply overwrite the existing text (including the brackets,
8241
8242 \family typewriter
8243 <>
8244 \family default
8245 ) with the correct information.
8246  Many of the AAS\SpecialChar TeX
8247  commands and environments can be implemented directly in \SpecialChar LyX
8248 ,
8249  but some cannot.
8250  For commands such as these,
8251  the \SpecialChar LaTeX
8252  code must be entered directly and marked as such.
8253  Such commands are referred to as \SpecialChar TeX
8254  code,
8255  or Evil Red Text.
8256  I tried to minimize the amount of \SpecialChar TeX
8257  code needed in an AAS\SpecialChar TeX
8258  document.
8259 \end_layout
8260
8261 \begin_layout Subsubsection
8262 Finishing Your Paper
8263 \end_layout
8264
8265 \begin_layout Standard
8266 When the paper is finished to your satisfaction and previews/prints correctly,
8267  there are a few
8268 \begin_inset Quotes eld
8269 \end_inset
8270
8271 postprocessing
8272 \begin_inset Quotes erd
8273 \end_inset
8274
8275  actions which need to be done before you submit it to the journals.
8276
8277 \end_layout
8278
8279 \begin_layout Enumerate
8280 Export your paper as a \SpecialChar LaTeX
8281  file (
8282 \family sans
8283 File\SpecialChar menuseparator
8284 Export\SpecialChar menuseparator
8285 \SpecialChar LaTeX
8286
8287 \family default
8288 ).
8289
8290 \end_layout
8291
8292 \begin_layout Enumerate
8293 Edit the resulting
8294 \family typewriter
8295 .tex
8296 \family default
8297  file with your favorite text editor
8298 \end_layout
8299
8300 \begin_deeper
8301 \begin_layout Enumerate
8302 remove the comment lines before the
8303 \family typewriter
8304
8305 \backslash
8306 documentclass
8307 \family default
8308  command
8309 \end_layout
8310
8311 \begin_layout Enumerate
8312 remove the
8313 \family typewriter
8314
8315 \backslash
8316 usepackage...{fontenc}
8317 \family default
8318  line if it appears (usually just after
8319 \family typewriter
8320
8321 \backslash
8322 documentclass
8323 \family default
8324 };
8325  also remove the
8326 \family typewriter
8327
8328 \backslash
8329 secnumdepth
8330 \family default
8331  line if it appears.
8332 \end_layout
8333
8334 \begin_layout Enumerate
8335 remove everything between (and including) the
8336 \family typewriter
8337
8338 \backslash
8339 makeatletter
8340 \family default
8341  and
8342 \family typewriter
8343
8344 \backslash
8345 makeatother
8346 \family default
8347  commands,
8348  except for any commands you specifically put into the \SpecialChar LaTeX
8349  preamble (which should appear immediately after the
8350 \begin_inset Quotes eld
8351 \end_inset
8352
8353 User specified \SpecialChar LaTeX
8354  commands
8355 \begin_inset Quotes erd
8356 \end_inset
8357
8358  comment in the
8359 \family typewriter
8360 .tex
8361 \family default
8362  file).
8363 \end_layout
8364
8365 \end_deeper
8366 \begin_layout Enumerate
8367 Run the resulting file through \SpecialChar LaTeX
8368  to make sure it still processes correctly.
8369 \end_layout
8370
8371 \begin_layout Enumerate
8372 Reread the journal requirements to make sure your filenames and formats are correct.
8373 \end_layout
8374
8375 \begin_layout Enumerate
8376 Submit it.
8377 \end_layout
8378
8379 \begin_layout Subsubsection
8380 Comments On Specific Commands
8381 \end_layout
8382
8383 \begin_layout Standard
8384 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
8385  commands:
8386  the AAS\SpecialChar TeX
8387  User Guide (
8388 \family typewriter
8389 aasguide.tex
8390 \family default
8391 ) gives a good description of each.
8392  Thus it's probably easiest for me to go down the list as found in the guide and offer comments where necessary.
8393  So let's begin \SpecialChar ldots
8394
8395 \end_layout
8396
8397 \begin_layout Paragraph
8398 Things that work as expected
8399 \end_layout
8400
8401 \begin_layout Standard
8402 Because they work as you might expect,
8403  I simply list them and the section they are found in:
8404
8405 \family typewriter
8406
8407 \backslash
8408 documentclass
8409 \family default
8410  (2.1.1),
8411
8412 \family typewriter
8413
8414 \backslash
8415 begin{document}
8416 \family default
8417  (2.2),
8418
8419 \family typewriter
8420
8421 \backslash
8422 title
8423 \family default
8424  (2.3),
8425
8426 \family typewriter
8427
8428 \backslash
8429 author
8430 \family default
8431  (2.3),
8432
8433 \family typewriter
8434
8435 \backslash
8436 affil
8437 \family default
8438  (2.3),
8439
8440 \family typewriter
8441
8442 \backslash
8443 abstract
8444 \family default
8445  (2.4),
8446
8447 \family typewriter
8448
8449 \backslash
8450 keywords
8451 \family default
8452  (2.5),
8453
8454 \family typewriter
8455
8456 \backslash
8457 section
8458 \family default
8459  (2.7),
8460
8461 \family typewriter
8462
8463 \backslash
8464 subsection
8465 \family default
8466  (2.7),
8467
8468 \family typewriter
8469
8470 \backslash
8471 subsubsection
8472 \family default
8473  (2.7),
8474
8475 \family typewriter
8476
8477 \backslash
8478 paragraph
8479 \family default
8480  (2.7),
8481
8482 \family typewriter
8483
8484 \backslash
8485 facility
8486 \family default
8487  (2.10),
8488
8489 \family typewriter
8490
8491 \backslash
8492 begin{displaymath}
8493 \family default
8494  (2.12),
8495
8496 \family typewriter
8497
8498 \backslash
8499 begin{equation}
8500 \family default
8501  (2.12),
8502
8503 \family typewriter
8504
8505 \backslash
8506 begin{eqnarray}
8507 \family default
8508  (2.12),
8509
8510 \family typewriter
8511
8512 \backslash
8513 begin{mathletters}
8514 \family default
8515  (2.12),
8516
8517 \family typewriter
8518
8519 \backslash
8520 begin{thebibliography}
8521 \family default
8522  (2.13.1),
8523
8524 \family typewriter
8525
8526 \backslash
8527 bibitem
8528 \family default
8529  (2.13.2),
8530  all the cite commands and their variations (2.13.2),
8531  the generic graphicx figure commands (2.14.1),
8532
8533 \family typewriter
8534
8535 \backslash
8536 begin{table}
8537 \family default
8538  (2.15.4),
8539
8540 \family typewriter
8541
8542 \backslash
8543 begin{tabular}
8544 \family default
8545  (2.15.4),
8546
8547 \family typewriter
8548
8549 \backslash
8550 caption
8551 \family default
8552  (2.15.4),
8553
8554 \family typewriter
8555
8556 \backslash
8557 label
8558 \family default
8559  (2.15.4,
8560  amongst other places),
8561
8562 \family typewriter
8563
8564 \backslash
8565 tablerefs
8566 \family default
8567  (2.15.5),
8568
8569 \family typewriter
8570
8571 \backslash
8572 tablecomments
8573 \family default
8574  (2.15.5),
8575
8576 \family typewriter
8577
8578 \backslash
8579 url
8580 \family default
8581  (2.17.4),
8582
8583 \family typewriter
8584
8585 \backslash
8586 end{document}
8587 \family default
8588  (2.18).
8589 \end_layout
8590
8591 \begin_layout Standard
8592 The following style options also work correctly:
8593
8594 \family typewriter
8595 longabstract
8596 \family default
8597  (2.4),
8598
8599 \family typewriter
8600 preprint
8601 \family default
8602  (3.2.1),
8603
8604 \family typewriter
8605 preprint2
8606 \family default
8607  (3.2.2),
8608
8609 \family typewriter
8610 eqsecnum
8611 \family default
8612  (3.3),
8613
8614 \family typewriter
8615 flushrt
8616 \family default
8617  (3.4).
8618  Simply put them in the
8619 \family sans
8620 Options
8621 \family default
8622  box in
8623 \family sans
8624 Layout\SpecialChar menuseparator
8625 Document
8626 \family default
8627 .
8628 \end_layout
8629
8630 \begin_layout Paragraph
8631 Things that work,
8632  but require more comment
8633 \end_layout
8634
8635 \begin_layout Standard
8636 The following items work,
8637  but require a little more discussion:
8638 \end_layout
8639
8640 \begin_layout Itemize
8641 These items are reserved for use by the journal editors,
8642  but you can put them into the \SpecialChar LaTeX
8643  preamble if you feel compelled to do so:
8644
8645 \family typewriter
8646
8647 \backslash
8648 received
8649 \family default
8650 ,
8651
8652 \family typewriter
8653
8654 \backslash
8655 revised
8656 \family default
8657 ,
8658
8659 \family typewriter
8660
8661 \backslash
8662 accepted
8663 \family default
8664 ,
8665
8666 \family typewriter
8667
8668 \backslash
8669 ccc
8670 \family default
8671 ,
8672
8673 \family typewriter
8674
8675 \backslash
8676 cpright
8677 \family default
8678  (all from 2.1.3)
8679 \end_layout
8680
8681 \begin_layout Itemize
8682 These items may be placed in the \SpecialChar LaTeX
8683  preamble,
8684  and are included as blanks in the template file:
8685
8686 \family typewriter
8687
8688 \backslash
8689 slugcomment
8690 \family default
8691  (2.1.4),
8692
8693 \family typewriter
8694
8695 \backslash
8696 shorttitle
8697 \family default
8698  (2.1.5),
8699
8700 \family typewriter
8701
8702 \backslash
8703 shortauthors
8704 \family default
8705  (2.1.5)
8706 \end_layout
8707
8708 \begin_layout Itemize
8709
8710 \family typewriter
8711
8712 \backslash
8713 email
8714 \family default
8715  (2.3) – can only be used
8716 \begin_inset Quotes eld
8717 \end_inset
8718
8719 standalone
8720 \begin_inset Quotes erd
8721 \end_inset
8722
8723 ,
8724  not in the middle of a paragraph.
8725  Use \SpecialChar TeX
8726  code if you need to embed it.
8727 \end_layout
8728
8729 \begin_layout Itemize
8730
8731 \family typewriter
8732
8733 \backslash
8734 and
8735 \family default
8736  (2.3) – will have extra {} after it.
8737  This should not cause an error.
8738 \end_layout
8739
8740 \begin_layout Itemize
8741
8742 \family typewriter
8743
8744 \backslash
8745 notetoeditor
8746 \family default
8747  (2.6) – can only be used
8748 \begin_inset Quotes eld
8749 \end_inset
8750
8751 standalone
8752 \begin_inset Quotes erd
8753 \end_inset
8754
8755 ,
8756  not in the middle of a paragraph.
8757  Use \SpecialChar TeX
8758  code if you need to embed it.
8759 \end_layout
8760
8761 \begin_layout Itemize
8762
8763 \family typewriter
8764
8765 \backslash
8766 placetable
8767 \family default
8768  (2.8) – can't insert a cross-reference tag,
8769  you must type the tag name by hand
8770 \end_layout
8771
8772 \begin_layout Itemize
8773
8774 \family typewriter
8775
8776 \backslash
8777 placefigure
8778 \family default
8779  (2.8) – same as for
8780 \family typewriter
8781
8782 \backslash
8783 placetable
8784 \end_layout
8785
8786 \begin_layout Itemize
8787
8788 \family typewriter
8789
8790 \backslash
8791 acknowledgements
8792 \family default
8793  (2.9) – will have extra {} after it.
8794  This should not cause an error.
8795 \end_layout
8796
8797 \begin_layout Itemize
8798
8799 \family typewriter
8800
8801 \backslash
8802 appendix
8803 \family default
8804  (2.11) – will have extra {} after it.
8805  This should not cause an error.
8806 \end_layout
8807
8808 \begin_layout Itemize
8809
8810 \family typewriter
8811
8812 \backslash
8813 figcaption
8814 \family default
8815  (2.14.2) – you can insert an optional filename argument by placing the cursor at the beginning of the text and selecting
8816 \family sans
8817 Insert\SpecialChar menuseparator
8818 Short Title
8819 \family default
8820 .
8821
8822 \begin_inset Quotes eld
8823 \end_inset
8824
8825 Short Title
8826 \begin_inset Quotes erd
8827 \end_inset
8828
8829  inserts an optional argument of the type needed by
8830 \family typewriter
8831
8832 \backslash
8833 figcaption
8834 \family default
8835 .
8836  Hopefully it will be renamed someday.
8837 \end_layout
8838
8839 \begin_layout Itemize
8840
8841 \family typewriter
8842
8843 \backslash
8844 objectname
8845 \family default
8846  (2.17.1) – same as
8847 \family typewriter
8848
8849 \backslash
8850 figcaption
8851 \family default
8852  for the catalog ID optional parameter
8853 \end_layout
8854
8855 \begin_layout Itemize
8856
8857 \family typewriter
8858
8859 \backslash
8860 dataset
8861 \family default
8862  (2.17.1) – same as
8863 \family typewriter
8864
8865 \backslash
8866 figcaption
8867 \family default
8868  for the catalog ID optional parameter
8869 \end_layout
8870
8871 \begin_layout Paragraph
8872 Things not implemented,
8873  use \SpecialChar TeX
8874  code
8875 \end_layout
8876
8877 \begin_layout Standard
8878
8879 \family typewriter
8880
8881 \backslash
8882 eqnum
8883 \family default
8884  (2.12),
8885
8886 \family typewriter
8887
8888 \backslash
8889 setcounter{equation}
8890 \family default
8891  (2.12),
8892  Journal name abbreviations (2.13.4),
8893
8894 \family typewriter
8895
8896 \backslash
8897 figurenum
8898 \family default
8899  (2.14.1),
8900
8901 \family typewriter
8902
8903 \backslash
8904 epsscale
8905 \family default
8906  (2.14.1),
8907
8908 \family typewriter
8909
8910 \backslash
8911 plotone
8912 \family default
8913  (2.14.1),
8914
8915 \family typewriter
8916
8917 \backslash
8918 plottwo
8919 \family default
8920  (2.14.1),
8921
8922 \family typewriter
8923
8924 \backslash
8925 tablenum
8926 \family default
8927  (2.15.4),
8928
8929 \family typewriter
8930
8931 \backslash
8932 tableline
8933 \family default
8934  (2.15.4,
8935  insert it as the first element in the lefthand cell after where you want it.
8936  Don't use any of \SpecialChar LyX
8937 's rules in the table),
8938
8939 \family typewriter
8940
8941 \backslash
8942 tablenotemark
8943 \family default
8944  (2.15.5),
8945
8946 \family typewriter
8947
8948 \backslash
8949 tablenotetext
8950 \family default
8951  (2.15.5),
8952  much of Misc (2.17,
8953  except
8954 \family typewriter
8955
8956 \backslash
8957 objectname
8958 \family default
8959 ,
8960
8961 \family typewriter
8962
8963 \backslash
8964 dataset
8965 \family default
8966 ,
8967
8968 \family typewriter
8969
8970 \backslash
8971 url
8972 \family default
8973 ,
8974  and
8975 \family typewriter
8976
8977 \backslash
8978 email
8979 \family default
8980 ;
8981  see above),
8982
8983 \family typewriter
8984
8985 \backslash
8986 singlespace
8987 \family default
8988  (3.1),
8989
8990 \family typewriter
8991
8992 \backslash
8993 doublespace
8994 \family default
8995  (3.1),
8996
8997 \family typewriter
8998
8999 \backslash
9000 onecolumn
9001 \family default
9002  (3.2),
9003
9004 \family typewriter
9005
9006 \backslash
9007 twocolumn
9008 \family default
9009  (3.2)
9010 \end_layout
9011
9012 \begin_layout Paragraph
9013 Things that cannot be implemented
9014 \end_layout
9015
9016 \begin_layout Standard
9017 \SpecialChar ldots
9018  at least in any meaningful sort of way,
9019  so I suggest ignoring them.
9020  They are the references environment (2.13.3),
9021  and the deluxetable environment (2.15).
9022  If you really,
9023  really need to use deluxetable,
9024  I suggest editing it in a separate file with a text editor,
9025  then using
9026 \family sans
9027 Insert\SpecialChar menuseparator
9028 Child
9029 \begin_inset space ~
9030 \end_inset
9031
9032 Document
9033 \family default
9034  to include it in your \SpecialChar LyX
9035  document.
9036  See
9037 \change_deleted 564990737 1671642564
9038 the
9039 \family typewriter
9040 aas_sample.lyx
9041 \family default
9042  file to see
9043 \change_inserted 564990737 1671642618
9044
9045 \family sans
9046 File\SpecialChar menuseparator
9047 Open Example\SpecialChar menuseparator
9048 Articles\SpecialChar menuseparator
9049 American Astronomical Society
9050 \change_unchanged
9051
9052 \family default
9053
9054 \change_inserted 564990737 1671642621
9055 for
9056 \change_unchanged
9057 an example of this.
9058 \end_layout
9059
9060 \begin_layout Subsubsection
9061 FAQs,
9062  Tips,
9063  Tricks,
9064  and Other Ruminations
9065 \end_layout
9066
9067 \begin_layout Paragraph
9068 Getting \SpecialChar LyX
9069  and AAS\SpecialChar TeX
9070  to cooperate
9071 \end_layout
9072
9073 \begin_layout Standard
9074 It can be a bit tricky to get \SpecialChar LyX
9075  to recognize a new layout and document class.
9076  When all else fails,
9077  do this:
9078 \end_layout
9079
9080 \begin_layout Enumerate
9081 Make certain that \SpecialChar LaTeX
9082  can find AAS\SpecialChar TeX
9083 .
9084  Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9085  distribution into a directory completely unrelated to \SpecialChar LaTeX
9086  or AAS\SpecialChar TeX
9087  and run \SpecialChar LaTeX
9088  on
9089 \family typewriter
9090 sample.tex
9091 \family default
9092 .
9093 \end_layout
9094
9095 \begin_layout Enumerate
9096 Make certain that
9097 \family typewriter
9098 aastex.layout
9099 \family default
9100  appears in \SpecialChar LyX
9101 's
9102 \family typewriter
9103 layouts
9104 \family default
9105  folder
9106 \end_layout
9107
9108 \begin_layout Enumerate
9109 Rerun
9110 \family sans
9111 Tools\SpecialChar menuseparator
9112 Reconfigure
9113 \family default
9114  in \SpecialChar LyX
9115 ,
9116  then restart \SpecialChar LyX
9117 .
9118 \end_layout
9119
9120 \begin_layout Enumerate
9121 Open a regular new file,
9122  not from a template.
9123  Does
9124 \change_deleted -712698321 1673170671
9125 AAS\SpecialChar TeX
9126
9127 \change_inserted -712698321 1673170671
9128
9129 \family sans
9130 American Astronomical Society (AASTeX V.
9131 \begin_inset space \thinspace{}
9132 \end_inset
9133
9134 6)
9135 \change_unchanged
9136
9137 \family default
9138  appear in the class list in
9139 \family sans
9140 Document\SpecialChar menuseparator
9141 Settings
9142 \family default
9143 ?
9144 \end_layout
9145
9146 \begin_layout Standard
9147 If you get a warning from an existing AAS\SpecialChar TeX
9148  document about not being able to find the AAS\SpecialChar TeX
9149  layout or a message about
9150 \begin_inset Quotes eld
9151 \end_inset
9152
9153 You should not mix title layouts with normal ones
9154 \begin_inset Quotes erd
9155 \end_inset
9156
9157 ,
9158  things haven't been installed correctly.
9159 \end_layout
9160
9161 \begin_layout Paragraph
9162 \SpecialChar LaTeX
9163  error processing a table
9164 \end_layout
9165
9166 \begin_layout Standard
9167 \SpecialChar LyX
9168 ,
9169  by default,
9170  attempts to center the table caption/title.
9171  This seems to produce a bad interaction in AAS\SpecialChar TeX
9172  so you should click somewhere in the caption/title,
9173  then select
9174 \family sans
9175 Edit\SpecialChar menuseparator
9176 Paragraph
9177 \begin_inset space ~
9178 \end_inset
9179
9180 Settings
9181 \family default
9182 ,
9183  then set the
9184 \family sans
9185 Alignment
9186 \family default
9187  to
9188 \family sans
9189 Block
9190 \family default
9191 .
9192  This took care of it for me.
9193 \end_layout
9194
9195 \begin_layout Paragraph
9196 References
9197 \end_layout
9198
9199 \begin_layout Standard
9200 A couple of things:
9201
9202 \change_inserted -712698321 1673170733
9203
9204 \end_layout
9205
9206 \begin_layout Enumerate
9207
9208 \change_deleted -712698321 1673170736
9209 1)
9210 \change_unchanged
9211 I have noticed some funny spacing in the reference entries in the text.
9212  When you enter the bibliography item data,
9213  make sure their is
9214 \emph on
9215 no
9216 \emph default
9217  space between the last author and the parenthesis setting off the year;
9218
9219 \emph on
9220 e.
9221 \begin_inset space \thinspace{}
9222 \end_inset
9223
9224 g.
9225 \begin_inset space \space{}
9226 \end_inset
9227
9228
9229 \emph default
9230 type
9231 \family typewriter
9232 Ressler(1992)
9233 \family default
9234 ,
9235  not
9236 \family typewriter
9237 Ressler (1992)
9238 \family default
9239 .
9240
9241 \change_deleted -712698321 1673170741
9242 2)
9243 \change_inserted -712698321 1673170741
9244
9245 \end_layout
9246
9247 \begin_layout Enumerate
9248 Entering the references at all is not obvious.
9249  The easiest thing is to start typing your first reference at the end of the document,
9250  then mark it as type
9251 \family sans
9252 References
9253 \family default
9254 .
9255  That will put a small gray box in front of what you just typed.
9256  Click on the box to fill in the rest of the information.
9257  For new references,
9258  go to the end of an existing reference and press return.
9259  That will create a new line with its own box,
9260  etc.
9261 \end_layout
9262
9263 \begin_layout Paragraph
9264 Including EPS files
9265 \end_layout
9266
9267 \begin_layout Standard
9268 Even though AAS\SpecialChar TeX
9269  provides its own figure commands (
9270 \family typewriter
9271
9272 \backslash
9273 plotone
9274 \family default
9275 ,
9276  for example),
9277  I much prefer \SpecialChar LaTeX
9278 's standard figure commands (with the default graphicx).
9279  You can insert the
9280 \family typewriter
9281
9282 \backslash
9283 plotone
9284 \family default
9285 ,
9286  etc.
9287 \begin_inset space ~
9288 \end_inset
9289
9290 commands as \SpecialChar TeX
9291  code into a Figure Float box if you desire,
9292  but I never have much luck getting the layout right.
9293  With the standard graphics,
9294  \SpecialChar LyX
9295  will insert a
9296 \family typewriter
9297
9298 \backslash
9299 usepackage{graphicx}
9300 \family default
9301  command into the \SpecialChar LaTeX
9302  preamble and handle the figures in the standard \SpecialChar LaTeX2e
9303  way,
9304  interspersing the figures in the text.
9305  I believe ApJ accepts figures exactly this way now;
9306  AJ might still use the
9307 \begin_inset Quotes eld
9308 \end_inset
9309
9310 stack everything at the end
9311 \begin_inset Quotes erd
9312 \end_inset
9313
9314  technique.
9315 \end_layout
9316
9317 \begin_layout Paragraph
9318 Things I could have done,
9319  but didn't
9320 \end_layout
9321
9322 \begin_layout Standard
9323 There are a few
9324 \begin_inset Quotes eld
9325 \end_inset
9326
9327 pretty
9328 \begin_inset Quotes erd
9329 \end_inset
9330
9331  things I could have implemented,
9332  but chose not to.
9333  For instance,
9334  I saw no point in double-spacing the text in the \SpecialChar LyX
9335  window,
9336  even though it is double-spaced in the paper manuscript.
9337  Also,
9338  I chose not to make separate layouts for the preprint and preprint2 styles.
9339  Since I assume you will spend most of your time in the plain manuscript mode anyway,
9340  I decided not to chew up more disk space with this.
9341
9342 \end_layout
9343
9344 \begin_layout Subsubsection
9345 Final Caveat
9346 \end_layout
9347
9348 \begin_layout Standard
9349 Your mileage may vary.
9350  I've now had papers published by both ApJ and AJ that have had 98% of the effort done in \SpecialChar LyX
9351 ;
9352  the last 2% was the \SpecialChar LaTeX
9353  post-processing and a few cleanups.
9354  I have had no trouble with the submission process,
9355  and I'm sure the journals were never aware that there might be a difference.
9356  So,
9357  go forth and publish!
9358 \end_layout
9359
9360 \begin_layout Subsection
9361
9362 \change_inserted 564990737 1671442131
9363 Chess
9364 \end_layout
9365
9366 \begin_layout Standard
9367
9368 \change_inserted 564990737 1671642768
9369 The document class
9370 \change_deleted -712698321 1673171415
9371
9372 \family sans
9373 article
9374 \begin_inset space \thinspace{}
9375 \end_inset
9376
9377 (
9378 \change_inserted 564990737 1671642768
9379 Chess
9380 \change_deleted -712698321 1673171417
9381 )
9382 \change_inserted 564990737 1671642768
9383
9384 \family default
9385  uses the
9386 \change_deleted -712698321 1673171421
9387
9388 \family typewriter
9389 article.cls
9390 \family default
9391
9392 \change_inserted -712698321 1673171424
9393 standard article
9394 \change_inserted 564990737 1671642768
9395 document class together with the
9396 \change_deleted -712698321 1673171428
9397 style
9398 \change_inserted -712698321 1673171429
9399 package
9400 \change_inserted 564990737 1671642768
9401
9402 \family sans
9403 lyxskak
9404 \change_deleted -712698321 1673171431
9405 .sty
9406 \change_inserted 564990737 1671642768
9407
9408 \family default
9409  to facilitate the description of chess games.
9410  See
9411 \family sans
9412 File\SpecialChar menuseparator
9413 Open Example\SpecialChar menuseparator
9414 Articles\SpecialChar menuseparator
9415 Chess
9416 \family default
9417  where you will find
9418 \family sans
9419 Game 1
9420 \family default
9421  and
9422 \family sans
9423 Game 2
9424 \family default
9425 .
9426 \end_layout
9427
9428 \begin_layout Subsection
9429
9430 \change_inserted 564990737 1671042028
9431 Elsevier
9432 \end_layout
9433
9434 \begin_layout Standard
9435
9436 \change_inserted 564990737 1671617396
9437 The document class
9438 \change_deleted -712698321 1673171640
9439
9440 \family sans
9441 article
9442 \begin_inset space \thinspace{}
9443 \end_inset
9444
9445 (
9446 \change_inserted 564990737 1671617396
9447 Elsevier
9448 \change_deleted -712698321 1673171643
9449 )
9450 \change_inserted 564990737 1671617396
9451
9452 \family default
9453  provides
9454 \change_inserted -712698321 1673171717
9455 support for
9456 \change_inserted 564990737 1671617396
9457 the
9458 \family typewriter
9459 elsarticle
9460 \change_deleted -712698321 1673171720
9461 .cls
9462 \change_inserted 564990737 1671617396
9463
9464 \family default
9465
9466 \change_deleted -712698321 1673171728
9467 document
9468 \change_inserted -712698321 1673171728
9469 \SpecialChar LaTeX
9470
9471 \change_inserted 564990737 1671617396
9472  class
9473 \change_inserted -712698321 1673171744
9474  for journals in the Elsevier publishing house
9475 \change_inserted 564990737 1671617396
9476 .
9477  This provides the following additional environments:
9478
9479 \family sans
9480 Title
9481 \begin_inset space ~
9482 \end_inset
9483
9484 footnote
9485 \family default
9486 ,
9487
9488 \family sans
9489 Author
9490 \begin_inset space ~
9491 \end_inset
9492
9493 footnote
9494 \family default
9495 ,
9496
9497 \family sans
9498 Corresponding
9499 \begin_inset space ~
9500 \end_inset
9501
9502 author
9503 \family default
9504 ,
9505
9506 \family sans
9507 Address
9508 \family default
9509 ,
9510
9511 \family sans
9512 Email
9513 \family default
9514  and
9515 \family sans
9516 Keywords
9517 \family default
9518 .
9519
9520 \change_inserted -712698321 1673172045
9521
9522 \end_layout
9523
9524 \begin_layout Standard
9525
9526 \change_inserted 564990737 1671617396
9527 A template is available in the menu
9528 \family sans
9529 \bar under
9530 F
9531 \bar default
9532 ile\SpecialChar menuseparator
9533 New
9534 \begin_inset space ~
9535 \end_inset
9536
9537 fro
9538 \bar under
9539 m
9540 \bar default
9541
9542 \begin_inset space ~
9543 \end_inset
9544
9545 Template\SpecialChar menuseparator
9546 Articles\SpecialChar menuseparator
9547 Elsevier
9548 \family default
9549 .
9550  It has been customized with further environments and contains all the information you may need.
9551  However,
9552  the documentation is also available from
9553 \begin_inset CommandInset href
9554 LatexCommand href
9555 name "CTAN"
9556 target "http://mirrors.ctan.org/macros/latex/contrib/elsarticle/doc/elsdoc.pdf"
9557 literal "false"
9558
9559 \end_inset
9560
9561 .
9562 \end_layout
9563
9564 \begin_layout Subsection
9565
9566 \change_inserted 564990737 1671042046
9567 Paper
9568 \end_layout
9569
9570 \begin_layout Standard
9571
9572 \change_inserted 564990737 1671042046
9573 The document class
9574 \change_deleted -712698321 1673172423
9575
9576 \family sans
9577 article
9578 \begin_inset space \thinspace{}
9579 \end_inset
9580
9581 (paper
9582 \change_inserted -712698321 1673172423
9583 Paper (Standard Class)
9584 \change_deleted -712698321 1673172423
9585 )
9586 \change_inserted 564990737 1671042046
9587
9588 \family default
9589  provides an alternative to the
9590 \change_deleted -712698321 1673172092
9591
9592 \family typewriter
9593 article.cls
9594 \change_inserted -712698321 1673172435
9595
9596 \family sans
9597 Article (Standard Class)
9598 \change_inserted 564990737 1671042046
9599
9600 \family default
9601  document class.
9602  It provides similar functionality,
9603  but you might prefer this layout with sans serif sections,
9604  headings,
9605  and more.
9606 \end_layout
9607
9608 \begin_layout Subsection
9609 Rev\SpecialChar TeX
9610 4
9611 \end_layout
9612
9613 \begin_layout Standard
9614 by
9615 \noun on
9616 Amir Karger
9617 \end_layout
9618
9619 \begin_layout Standard
9620 \begin_inset VSpace bigskip
9621 \end_inset
9622
9623
9624 \end_layout
9625
9626 \begin_layout Standard
9627 \noindent
9628 The
9629 \family sans
9630 Rev
9631 \change_deleted -712698321 1673172482
9632 tex
9633 \begin_inset space ~
9634 \end_inset
9635
9636 4
9637 \change_inserted -712698321 1673172487
9638 TeX (V.
9639 \begin_inset space \thinspace{}
9640 \end_inset
9641
9642 4)
9643 \change_unchanged
9644
9645 \family default
9646  textclass works with the American Physical Sociey's Rev\SpecialChar TeX
9647  4.0 (the
9648 \begin_inset Formula $\beta$
9649 \end_inset
9650
9651  release of May,
9652  1999) class.
9653 \end_layout
9654
9655 \begin_layout Standard
9656 \SpecialChar LyX
9657  has a
9658 \family sans
9659 R
9660 \change_deleted -712698321 1673172511
9661 evtex
9662 \change_inserted -712698321 1673172517
9663 EVTeX (obsolete)
9664 \change_unchanged
9665
9666 \family default
9667  textclass,
9668  which works with Rev\SpecialChar TeX
9669  3.1.
9670  However,
9671  v3.1 is basically obsolete,
9672  as it works with \SpecialChar LaTeX
9673  2.09.
9674  That means that it doesn't interact very well with \SpecialChar LyX
9675 ,
9676  which requires \SpecialChar LaTeX2e
9677 ,
9678  although it has been kludged to work.
9679  Since Rev\SpecialChar TeX
9680  4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
9681 ,
9682  \SpecialChar LyX
9683  with the
9684 \change_deleted -712698321 1673172538
9685
9686 \family sans
9687 Rev\SpecialChar TeX
9688
9689 \begin_inset space ~
9690 \end_inset
9691
9692 4
9693 \change_inserted -712698321 1673172538
9694 Revtex
9695 \begin_inset space ~
9696 \end_inset
9697
9698 4TeX (V.
9699 \begin_inset space \thinspace{}
9700 \end_inset
9701
9702 4)
9703 \change_unchanged
9704
9705 \family default
9706  textclass should also be pretty easy to use.
9707 \end_layout
9708
9709 \begin_layout Standard
9710 These documents are supposed to be used in
9711 \emph on
9712 addition
9713 \emph default
9714  to the Rev\SpecialChar TeX
9715  4.0 documents,
9716  so we don't describe any of the special Rev\SpecialChar TeX
9717  macros,
9718  and assume you'll know what to put in the preamble if necessary.
9719 \end_layout
9720
9721 \begin_layout Subsubsection
9722 Installation
9723 \end_layout
9724
9725 \begin_layout Standard
9726 All you need to do is install Rev\SpecialChar TeX
9727  4,
9728  as described in the package's README file.
9729  The package can be found at The Rev\SpecialChar TeX
9730  4 Web Site
9731 \begin_inset Flex URL
9732 status collapsed
9733
9734 \begin_layout Plain Layout
9735
9736 http://publish.aps.org/revtex4/
9737 \end_layout
9738
9739 \end_inset
9740
9741 .
9742  Install it somewhere that \SpecialChar LaTeX
9743  can see it.
9744  Test it by trying to \SpecialChar LaTeX
9745  a short Rev\SpecialChar TeX
9746  4 document in some random directory (i.
9747 \begin_inset space \thinspace{}
9748 \end_inset
9749
9750 e.
9751 \begin_inset space \space{}
9752 \end_inset
9753
9754 not the directory where you installed the class file.) Then,
9755  if you reconfigure \SpecialChar LyX
9756 ,
9757  it will find the class file and let you use the Rev\SpecialChar TeX
9758 4 textclass.
9759 \end_layout
9760
9761 \begin_layout Standard
9762 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
9763  4 document using
9764 \family typewriter
9765 tex2lyx
9766 \family default
9767 ,
9768  or to use the
9769 \family sans
9770 Revtex
9771 \begin_inset space ~
9772 \end_inset
9773
9774 4
9775 \family default
9776  template,
9777  found in
9778 \change_deleted -712698321 1673172641
9779 the templates directory
9780 \change_inserted -712698321 1673172687
9781
9782 \family sans
9783 File\SpecialChar menuseparator
9784 New From Templates\SpecialChar menuseparator
9785 Articles
9786 \change_unchanged
9787
9788 \family default
9789 .
9790 \end_layout
9791
9792 \begin_layout Subsubsection
9793 Preamble Matter
9794 \end_layout
9795
9796 \begin_layout Standard
9797 Optional arguments to
9798 \family typewriter
9799
9800 \backslash
9801 documentclass
9802 \family default
9803 ,
9804  like
9805 \begin_inset Quotes eld
9806 \end_inset
9807
9808 preprint
9809 \begin_inset Quotes erd
9810 \end_inset
9811
9812  and
9813 \begin_inset Quotes eld
9814 \end_inset
9815
9816 aps
9817 \begin_inset Quotes erd
9818 \end_inset
9819
9820 ,
9821  go in the
9822 \family sans
9823 Extra
9824 \begin_inset space ~
9825 \end_inset
9826
9827 Options
9828 \family default
9829  field in the
9830 \family sans
9831 Document
9832 \begin_inset space ~
9833 \end_inset
9834
9835 Layout
9836 \family default
9837  dialog,
9838  as usual.
9839  Remember that in Rev\SpecialChar TeX
9840 ,
9841  at least one optional argument is required!
9842
9843 \end_layout
9844
9845 \begin_layout Standard
9846 Other preamble matter,
9847  like
9848 \family typewriter
9849
9850 \backslash
9851 draft
9852 \family default
9853  etc.
9854 \begin_inset space ~
9855 \end_inset
9856
9857 goes in the
9858 \family sans
9859 \SpecialChar LaTeX
9860
9861 \begin_inset space ~
9862 \end_inset
9863
9864 Preamble
9865 \family default
9866  dialog,
9867  also as usual.
9868 \end_layout
9869
9870 \begin_layout Subsubsection
9871 Layouts
9872 \end_layout
9873
9874 \begin_layout Standard
9875 The layouts basically correspond to the commands in Rev\SpecialChar TeX
9876 4.0.
9877  For example,
9878  the Email layout corresponds to
9879 \family typewriter
9880
9881 \backslash
9882 email{}
9883 \family default
9884 .
9885  Note that (at least as of Rev\SpecialChar TeX
9886  4.0 Beta),
9887  the
9888 \family sans
9889 Address
9890 \family default
9891  and
9892 \family sans
9893 Affiliation
9894 \family default
9895  layouts are exactly equivalent,
9896  so you shouldn't need to use both.
9897 \begin_inset Foot
9898 status collapsed
9899
9900 \begin_layout Plain Layout
9901 In case you're curious,
9902  both were included so that
9903 \family typewriter
9904 tex2lyx
9905 \family default
9906  would be able to translate both
9907 \family typewriter
9908
9909 \backslash
9910 address
9911 \family default
9912  and
9913 \family typewriter
9914
9915 \backslash
9916 affiliation
9917 \family default
9918 .
9919 \end_layout
9920
9921 \end_inset
9922
9923
9924 \end_layout
9925
9926 \begin_layout Subsubsection
9927 Important Notes
9928 \end_layout
9929
9930 \begin_layout Standard
9931 There are a couple of important unique aspects of Rev\SpecialChar TeX
9932  4 which might cause bugs that will be even more confusing in \SpecialChar LyX
9933 .
9934 \end_layout
9935
9936 \begin_layout Standard
9937 In Rev\SpecialChar TeX
9938 ,
9939  the
9940 \family typewriter
9941
9942 \backslash
9943 thanks
9944 \family default
9945  command goes
9946 \emph on
9947 outside
9948 \emph default
9949  the
9950 \family typewriter
9951
9952 \backslash
9953 author
9954 \family default
9955  command.
9956  The \SpecialChar LyX
9957  equivalent is that there is a separate Thanks layout.
9958  Do
9959 \emph on
9960 not
9961 \emph default
9962  write footnotes in the
9963 \family sans
9964 Author
9965 \family default
9966  layout,
9967  or weird things may happen.
9968  See the Rev\SpecialChar TeX
9969  4 documentation for more details.
9970 \end_layout
9971
9972 \begin_layout Standard
9973 Also,
9974  the
9975 \family sans
9976 Author
9977 \begin_inset space ~
9978 \end_inset
9979
9980 Email
9981 \family default
9982 ,
9983
9984 \family sans
9985 Author
9986 \begin_inset space ~
9987 \end_inset
9988
9989 URL
9990 \family default
9991 ,
9992  and
9993 \family sans
9994 Thanks
9995 \family default
9996  layouts must be placed
9997 \emph on
9998 in between
9999 \emph default
10000  the
10001 \family sans
10002 Author
10003 \family default
10004  layout and the corresponding
10005 \family sans
10006 Address
10007 \family default
10008  (or equivalent
10009 \family sans
10010 Affiliation
10011 \family default
10012 ) layout.
10013  If you put the
10014 \family sans
10015 Thanks
10016 \family default
10017  after the
10018 \family sans
10019 Address
10020 \family default
10021 ,
10022  the \SpecialChar LaTeX
10023  won't compile.
10024 \end_layout
10025
10026 \begin_layout Subsection
10027
10028 \change_inserted 564990737 1671042072
10029 Springer Journals
10030 \end_layout
10031
10032 \begin_layout Standard
10033
10034 \change_inserted 564990737 1671042072
10035 All the
10036 \family sans
10037 svj*
10038 \family default
10039  classes were replaced
10040 \change_deleted -712698321 1673176131
10041 in 2013
10042 \change_inserted 564990737 1671042072
10043 with a completely new
10044 \change_deleted -712698321 1673175919
10045
10046 \family sans
10047 sr-vorl.cls
10048 \family default
10049 .
10050  This package provides a \SpecialChar LaTeX
10051  class and templates for books to be published at Springer Gabler Research,
10052  Springer Vieweg Research,
10053  Springer Spektrum Research,
10054  Springer VS Research,
10055  or Springer VS Forschung.
10056  The documentation is available in German from
10057 \begin_inset CommandInset href
10058 LatexCommand href
10059 name "CTAN"
10060 target "http://mirrors.ctan.org/macros/latex/contrib/springer/sr-vorl/sr-vorl.pdf"
10061 literal "false"
10062
10063 \end_inset
10064
10065 .
10066
10067 \change_inserted -712698321 1673176125
10068  class,
10069
10070 \family sans
10071 sn-jnl.cls
10072 \family default
10073 .
10074  Please find information at
10075 \begin_inset Flex URL
10076 status collapsed
10077
10078 \begin_layout Plain Layout
10079
10080 \change_inserted -712698321 1673176047
10081
10082 https://www.springernature.com/gp/authors/campaigns/latex-author-support
10083 \change_unchanged
10084
10085 \end_layout
10086
10087 \end_inset
10088
10089 .
10090  Native \SpecialChar LyX
10091  support is not available yet.
10092 \change_inserted 564990737 1671042072
10093
10094 \end_layout
10095
10096 \begin_layout Section
10097
10098 \change_inserted 564990737 1670439560
10099 Books
10100 \end_layout
10101
10102 \begin_layout Standard
10103
10104 \change_inserted 564990737 1670439581
10105 See also the document classes in the Collections (section
10106 \begin_inset space ~
10107 \end_inset
10108
10109
10110 \begin_inset CommandInset ref
10111 LatexCommand ref
10112 reference "sec:Collections"
10113 nolink "false"
10114
10115 \end_inset
10116
10117 ).
10118 \end_layout
10119
10120 \begin_layout Subsection
10121 Memoir
10122 \end_layout
10123
10124 \begin_layout Standard
10125 By
10126 \noun on
10127 Jürgen Spitzmüller
10128 \end_layout
10129
10130 \begin_layout Subsubsection
10131 Overview
10132 \end_layout
10133
10134 \begin_layout Standard
10135 Memoir is a very powerful and constantly evolving class.
10136  It has been designed with regard to fictional and non-fictional literature.
10137  Its aim is to let the user have maximum control over the typesetting of his document.
10138  Memoir is based on the standard book class,
10139  but it can also emulate the article class (see below).
10140 \end_layout
10141
10142 \begin_layout Standard
10143 Peter Wilson,
10144  the developer of Memoir,
10145  is known as the author of lots of useful packages in the \SpecialChar LaTeX
10146  world.
10147  Most of them have been merged with Memoir.
10148  Therefore,
10149  it is much easier to layout the table of contents,
10150  appendices,
10151  chapter designs and such.
10152  \SpecialChar LyX
10153 ,
10154  though,
10155  does not support all of these goodies natively.
10156  Some of them might be added to forthcoming releases
10157 \begin_inset Foot
10158 status collapsed
10159
10160 \begin_layout Plain Layout
10161 You are invited to send suggestions to
10162 \begin_inset Flex URL
10163 status collapsed
10164
10165 \begin_layout Plain Layout
10166
10167 lyx-devel@lists.lyx.org
10168 \end_layout
10169
10170 \end_inset
10171
10172 .
10173 \end_layout
10174
10175 \end_inset
10176
10177 ,
10178  lots will probably never be supported,
10179  due to the limitations of \SpecialChar LyX
10180 's framework.
10181  Of course you can still use all features with the help of some native \SpecialChar LaTeX
10182  commands (\SpecialChar TeX
10183  code
10184 \begin_inset Foot
10185 status collapsed
10186
10187 \begin_layout Plain Layout
10188 Cf.
10189 \begin_inset ERT
10190 status collapsed
10191
10192 \begin_layout Plain Layout
10193
10194
10195 \backslash
10196
10197 \end_layout
10198
10199 \end_inset
10200
10201 section
10202 \begin_inset space ~
10203 \end_inset
10204
10205
10206 \begin_inset CommandInset ref
10207 LatexCommand ref
10208 reference "sec:Inserting-TeX-Code"
10209 nolink "false"
10210
10211 \end_inset
10212
10213  for details.
10214 \end_layout
10215
10216 \end_inset
10217
10218 ).
10219  In this section,
10220  we can only list those features that are natively supported by \SpecialChar LyX
10221 .
10222  For detailed descriptions (and for the rest of features) we recommend you have a look at the detailed manual of the Memoir class
10223 \begin_inset Foot
10224 status collapsed
10225
10226 \begin_layout Plain Layout
10227 Cf.
10228 \begin_inset ERT
10229 status collapsed
10230
10231 \begin_layout Plain Layout
10232
10233
10234 \backslash
10235
10236 \end_layout
10237
10238 \end_inset
10239
10240
10241 \begin_inset Flex URL
10242 status collapsed
10243
10244 \begin_layout Plain Layout
10245
10246 CTAN:/macros/latex/memoir/memman.pdf
10247 \end_layout
10248
10249 \end_inset
10250
10251 .
10252 \end_layout
10253
10254 \end_inset
10255
10256 ,
10257  which is not only a user guide for the class,
10258  but also both a comprehensive description on good typesetting and a superb example for good typesetting itself.
10259 \end_layout
10260
10261 \begin_layout Subsubsection
10262 Basic features and restrictions
10263 \end_layout
10264
10265 \begin_layout Standard
10266 Memoir supports basically all features of the standard book classes.
10267  There are,
10268  however,
10269  some differences,
10270  as follows:
10271 \end_layout
10272
10273 \begin_layout Description
10274 Font
10275 \begin_inset space ~
10276 \end_inset
10277
10278 sizes:
10279  Memoir has a broader range of font sizes:
10280  9,
10281  10,
10282  11,
10283  12,
10284  14,
10285  17
10286 \end_layout
10287
10288 \begin_layout Description
10289 Page
10290 \begin_inset space ~
10291 \end_inset
10292
10293 style:
10294  The fancy page style is not supported,
10295  due to a command clash between Memoir and the fancyhdr package (they both define a command with the same name,
10296  which confuses \SpecialChar LaTeX
10297 ).
10298  Instead,
10299  Memoir comes with a number of its own page styles (see
10300 \family sans
10301 Document\SpecialChar menuseparator
10302 Settings\SpecialChar menuseparator
10303 Page
10304 \begin_inset space ~
10305 \end_inset
10306
10307 Style
10308 \family default
10309 ).
10310  If you want to use these for the chapter pages,
10311  you have to use the command
10312 \family typewriter
10313
10314 \backslash
10315 chapterstyle
10316 \family default
10317  in the main text or in preamble (e.
10318 \begin_inset space \thinspace{}
10319 \end_inset
10320
10321 g.
10322 \begin_inset space \space{}
10323 \end_inset
10324
10325
10326 \family typewriter
10327
10328 \backslash
10329 chapterstyle{companion}
10330 \family default
10331 ).
10332 \end_layout
10333
10334 \begin_layout Description
10335 Sectioning:
10336  Sectionings (chapter,
10337  section,
10338  subsection etc.) come with an optional argument in the standard classes.
10339  With this,
10340  you can specify an alternative version of the title for the table of contents and the headers (for instance,
10341  if the title is too long).
10342  In \SpecialChar LyX
10343 ,
10344  you can do this via
10345 \family sans
10346 Insert\SpecialChar menuseparator
10347 Short
10348 \begin_inset space ~
10349 \end_inset
10350
10351 Title
10352 \family default
10353  at the beginning of a chapter/section.
10354  Memoir features a second optional argument and thus separates the table of contents from the header.
10355  You can define three variants of a title with this:
10356  one for the main text,
10357  one for the table of contents,
10358  and one for the headers.
10359  \SpecialChar LyX
10360  makes these available in form of specific
10361 \family sans
10362 Short Title
10363 \family default
10364  variants in the
10365 \family sans
10366 Insert
10367 \family default
10368  menu.
10369 \end_layout
10370
10371 \begin_layout Description
10372 TOC/LOT/LOF:
10373  In the standard classes (and in many other classes),
10374  the table of contents,
10375  the list of figures and the list of table start a new page automatically.
10376  Memoir does not follow this route.
10377  You have to insert a page break yourself,
10378  if you want to have one.
10379 \end_layout
10380
10381 \begin_layout Description
10382 Titlepage:
10383  For some unknown reason,
10384  Memoir uses pagination on the title page (in the standard classes,
10385  title pages are
10386 \begin_inset Quotes eld
10387 \end_inset
10388
10389 empty
10390 \begin_inset Quotes erd
10391 \end_inset
10392
10393 ).
10394  If you want an empty title page,
10395  type
10396 \family typewriter
10397
10398 \backslash
10399 aliaspagestyle{title}{empty}
10400 \family default
10401  in the preamble.
10402 \end_layout
10403
10404 \begin_layout Description
10405 Article:
10406  With the class option
10407 \emph on
10408 article
10409 \emph default
10410  (to be inserted in
10411 \family sans
10412 Document\SpecialChar menuseparator
10413 Settings\SpecialChar menuseparator
10414 Class Settings\SpecialChar menuseparator
10415 Custom
10416 \begin_inset space ~
10417 \end_inset
10418
10419 Options
10420 \family default
10421 ),
10422  you can emulate article style.
10423  That is,
10424  counters (footnotes,
10425  figures,
10426  tables etc.) will not be reset on new chapters,
10427  chapters don't start a new page (but are—
10428 in contrary to
10429 \begin_inset Quotes eld
10430 \end_inset
10431
10432 real
10433 \begin_inset Quotes erd
10434 \end_inset
10435
10436  article classes—
10437 still allowed),
10438  parts,
10439  though,
10440  use their own page,
10441  as in book.
10442 \end_layout
10443
10444 \begin_layout Description
10445 Oldfontcommands:
10446  By default,
10447  Memoir does not allow the use of the deprecated font commands,
10448  which have been used in the old \SpecialChar LaTeX
10449  version 2.09 (e.
10450 \begin_inset space \thinspace{}
10451 \end_inset
10452
10453 g.
10454 \begin_inset space \space{}
10455 \end_inset
10456
10457
10458 \family typewriter
10459
10460 \backslash
10461 rm
10462 \family default
10463 ,
10464
10465 \family typewriter
10466
10467 \backslash
10468 it
10469 \family default
10470 ).
10471  It produces an error and stops \SpecialChar LaTeX
10472  whenever such a command appears.
10473  The class option
10474 \emph on
10475 oldfontcommands
10476 \emph default
10477  reallows the commands and spits out warnings instead (which does at least not stop \SpecialChar LaTeX
10478 ).
10479  Since a lot of packages and particularly Bib\SpecialChar TeX
10480  style files are still using those commands,
10481  we have decided to use this option by default.
10482 \end_layout
10483
10484 \begin_layout Subsubsection
10485 Extra features
10486 \end_layout
10487
10488 \begin_layout Standard
10489 We will only describe the features supported by \SpecialChar LyX
10490  (which is not much currently).
10491  Please consult the Memoir manual
10492 \begin_inset Foot
10493 status collapsed
10494
10495 \begin_layout Plain Layout
10496 Cf.
10497 \begin_inset ERT
10498 status collapsed
10499
10500 \begin_layout Plain Layout
10501
10502
10503 \backslash
10504
10505 \end_layout
10506
10507 \end_inset
10508
10509
10510 \begin_inset Flex URL
10511 status collapsed
10512
10513 \begin_layout Plain Layout
10514
10515 CTAN:/macros/latex/memoir/memman.pdf
10516 \end_layout
10517
10518 \end_inset
10519
10520 .
10521 \end_layout
10522
10523 \end_inset
10524
10525  for details.
10526 \end_layout
10527
10528 \begin_layout Description
10529 Abstract:
10530  You may wonder why an abstract is an extra feature.
10531  Well,
10532  it is in book class.
10533  Usually books don't have abstracts.
10534  Memoir,
10535  however,
10536  has.
10537  You can use it wherever and how often you like.
10538 \end_layout
10539
10540 \begin_layout Description
10541 Chapterprecis:
10542  You may know this older typesetting style:
10543  The contents of a chapter are summarized below the title and also in the table of contents (e.
10544 \begin_inset space \thinspace{}
10545 \end_inset
10546
10547 g.
10548 \begin_inset space \space{}
10549 \end_inset
10550
10551
10552 \emph on
10553 Our hero arrives in Troia;
10554  he loses some friends;
10555  he finds others
10556 \emph default
10557 ).
10558  Chapterprecis does exactly this.
10559  It is therefore only sensible below a chapter.
10560 \end_layout
10561
10562 \begin_layout Description
10563 Epigraph:
10564  An epigraph is a smart slogan or motto at the beginning of a chapter.
10565  The epigraph environment provides an elegant way of typesetting such a motto.
10566  The motto itself (text) and its (optional) author (source) are divided by a short line.
10567  The author (source) can be inserted via
10568 \family sans
10569 Insert\SpecialChar menuseparator
10570 Epigraph Source
10571 \family default
10572 \emph on
10573 .
10574 \end_layout
10575
10576 \begin_layout Description
10577 Poemtitle:
10578  Memoir has lots of possibilities to typeset poetry (up to very complex figurative poems).
10579  \SpecialChar LyX
10580  can only support a few of them.
10581  One is poemtitle,
10582  which is a centered title for poems,
10583  which will also be added to the table of contents (verse is the standard environment for poems.
10584  Memoir has some enhanced versions of verse,
10585  but you need to use \SpecialChar TeX
10586  code,
10587  because they have to be nested inside regular verse environments,
10588  which is not possible with \SpecialChar LyX
10589 ).
10590 \end_layout
10591
10592 \begin_layout Description
10593 Poemtitle*:
10594  Same as poemtitle,
10595  but it adds no entry to the table of contents.
10596 \end_layout
10597
10598 \begin_layout Subsection
10599
10600 \change_inserted 564990737 1671442175
10601 Recipe Book
10602 \end_layout
10603
10604 \begin_layout Standard
10605
10606 \change_inserted 564990737 1671442175
10607 The document class
10608 \family typewriter
10609 RecipeBook.cls
10610 \family default
10611  uses the
10612 \family sans
10613 book
10614 \begin_inset space \thinspace{}
10615 \end_inset
10616
10617 (KOMA-Script)
10618 \family default
10619  document class but adds two environments:
10620 \end_layout
10621
10622 \begin_layout Description
10623
10624 \change_inserted 564990737 1671442175
10625 Recipe a numbered section environment at the
10626 \family typewriter
10627 Subsubsection
10628 \family default
10629  level which generates a bold centered heading above a double horizontal rule
10630 \end_layout
10631
10632 \begin_layout Description
10633
10634 \change_inserted 564990737 1671442175
10635 Ingredients a
10636 \family typewriter
10637 Description
10638 \family default
10639  environment where
10640 \series bold
10641 \emph on
10642 Ingredients
10643 \series default
10644 \emph default
10645  are what are being described and the environment ends with a horizontal rule.
10646 \end_layout
10647
10648 \begin_layout Standard
10649
10650 \change_inserted 564990737 1671642866
10651
10652 \family sans
10653 File\SpecialChar menuseparator
10654 Open Example\SpecialChar menuseparator
10655 Books\SpecialChar menuseparator
10656 Recipe Book
10657 \family default
10658  illustrates its use.
10659 \end_layout
10660
10661 \begin_layout Standard
10662
10663 \change_inserted 564990737 1671442175
10664 It is designed for typesetting one or two recipes per page,
10665  with dimensions of 5.5
10666 \begin_inset Quotes qrd
10667 \end_inset
10668
10669  x 8.5
10670 \begin_inset Quotes qrd
10671 \end_inset
10672
10673 .
10674  The hyperlinked table of contents (ToC) and page numbers make browsing recipes convenient,
10675  and the pages can be joined together or printed 2 per page to normal letterpaper easily.
10676  The size was chosen to work in half-page 3-ring binder cover sheets,
10677  because un-laminated paper just doesn't last in the kitchen.
10678 \end_layout
10679
10680 \begin_layout Standard
10681
10682 \change_inserted 564990737 1671442175
10683 The half-letter pages can be printed two per page using your printer driver,
10684  or bound together using
10685 \family typewriter
10686 pdfjam --nup 2x1 --papersize '{11in,8.5in}'
10687 \family default
10688
10689 \family typewriter
10690 Recipes.pdf
10691 \family default
10692  where
10693 \family typewriter
10694 Recipes.pdf
10695 \family default
10696  is the compiled version of your recipes.
10697 \change_inserted -712698321 1673175424
10698
10699 \end_layout
10700
10701 \begin_layout Section
10702
10703 \change_inserted 564990737 1671442207
10704 Curricula vitarum
10705 \end_layout
10706
10707 \begin_layout Subsection
10708
10709 \change_inserted 564990737 1671442208
10710 Europass
10711 \end_layout
10712
10713 \begin_layout Standard
10714
10715 \change_inserted 564990737 1671642942
10716 The document class
10717 \family sans
10718 curriculum
10719 \begin_inset space \space{}
10720 \end_inset
10721
10722 vitae
10723 \begin_inset space \thinspace{}
10724 \end_inset
10725
10726 (Europass)
10727 \family default
10728  provides the
10729 \family typewriter
10730 europasscv.cls
10731 \family default
10732  document class,
10733  an unofficial implementation of the ‘Europass CV’ recommended by the European Commission in 2013.
10734
10735 \family sans
10736 File\SpecialChar menuseparator
10737 Open Example\SpecialChar menuseparator
10738 Curricula Vitae\SpecialChar menuseparator
10739 Europass CV (2013)
10740 \family default
10741  offers guidance on its use.
10742  Its documentation is available from
10743 \begin_inset CommandInset href
10744 LatexCommand href
10745 name "CTAN"
10746 target "http://mirrors.ctan.org/macros/latex/contrib/europasscv/europasscv.pdf"
10747 literal "false"
10748
10749 \end_inset
10750
10751 .
10752 \end_layout
10753
10754 \begin_layout Subsection
10755
10756 \change_inserted 564990737 1671442208
10757 European
10758 \end_layout
10759
10760 \begin_layout Standard
10761
10762 \change_inserted 564990737 1671642984
10763 The document class
10764 \family sans
10765 curriculum
10766 \begin_inset space \space{}
10767 \end_inset
10768
10769 vitae
10770 \begin_inset space \thinspace{}
10771 \end_inset
10772
10773 (Europe)
10774 \family default
10775  provides the
10776 \family typewriter
10777 europecv.cls
10778 \family default
10779  document class,
10780  an unofficial implementation of the “Europass CV” recommended by the European Commission in 2002.
10781
10782 \family sans
10783 File\SpecialChar menuseparator
10784 Open Example\SpecialChar menuseparator
10785 Curricula Vitae\SpecialChar menuseparator
10786 Europe CV
10787 \family default
10788  offers guidance on its use.
10789  Its documentation is available from
10790 \begin_inset CommandInset href
10791 LatexCommand href
10792 name "CTAN"
10793 target "http://mirrors.ctan.org/macros/latex/contrib/europecv/europecv.pdf"
10794 literal "false"
10795
10796 \end_inset
10797
10798 .
10799 \end_layout
10800
10801 \begin_layout Subsection
10802
10803 \change_inserted 564990737 1671442208
10804 Modern
10805 \end_layout
10806
10807 \begin_layout Standard
10808
10809 \change_inserted 564990737 1671643003
10810 The document class
10811 \family sans
10812 curriculum
10813 \begin_inset space \space{}
10814 \end_inset
10815
10816 vitae
10817 \begin_inset space \thinspace{}
10818 \end_inset
10819
10820 (modern)
10821 \family default
10822  provides the
10823 \family typewriter
10824 moderncv.cls
10825 \family default
10826  document class.
10827  This allows the creation of customizable CVs.
10828
10829 \family sans
10830 File\SpecialChar menuseparator
10831 Open Example\SpecialChar menuseparator
10832 Curricula Vitae\SpecialChar menuseparator
10833 Modern CV
10834 \family default
10835  offers guidance on its use.
10836  Its documentation is available from
10837 \begin_inset CommandInset href
10838 LatexCommand href
10839 name "CTAN"
10840 target "http://mirrors.ctan.org/macros/latex/contrib/moderncv/manual/moderncv_userguide.pdf"
10841 literal "false"
10842
10843 \end_inset
10844
10845 .
10846 \end_layout
10847
10848 \begin_layout Subsection
10849
10850 \change_inserted 564990737 1671442208
10851 Simple
10852 \end_layout
10853
10854 \begin_layout Standard
10855
10856 \change_inserted 564990737 1671643024
10857 The document class
10858 \family sans
10859 curriculum
10860 \begin_inset space \space{}
10861 \end_inset
10862
10863 vitae
10864 \begin_inset space \thinspace{}
10865 \end_inset
10866
10867 (simple)
10868 \family default
10869  provides the
10870 \family typewriter
10871 simplecv.cls
10872 \family default
10873  document class,
10874  originally developed for use with \SpecialChar LyX
10875 .
10876
10877 \family sans
10878 File\SpecialChar menuseparator
10879 Open Example\SpecialChar menuseparator
10880 Curricula Vitae\SpecialChar menuseparator
10881 Simple CV
10882 \family default
10883  offers guidance on its use.
10884  Its documentation is available from
10885 \begin_inset CommandInset href
10886 LatexCommand href
10887 name "CTAN"
10888 target "http://mirrors.ctan.org/macros/latex/contrib/simplecv/simplecv.pdf"
10889 literal "false"
10890
10891 \end_inset
10892
10893
10894 \end_layout
10895
10896 \begin_layout Section
10897
10898 \change_inserted 564990737 1672652454
10899 Letters
10900 \end_layout
10901
10902 \begin_layout Standard
10903
10904 \change_inserted 564990737 1672652455
10905 See also the
10906 \family typewriter
10907 letter
10908 \begin_inset space \space{}
10909 \end_inset
10910
10911 (KOMA-Script v.2)
10912 \family default
10913  (section
10914 \begin_inset space ~
10915 \end_inset
10916
10917
10918 \begin_inset CommandInset ref
10919 LatexCommand ref
10920 reference "subsec:The-new-letter"
10921 nolink "false"
10922
10923 \end_inset
10924
10925 ) and
10926 \family typewriter
10927 letter
10928 \begin_inset space \space{}
10929 \end_inset
10930
10931 (with extra font sizes)
10932 \family default
10933  (section
10934 \begin_inset space ~
10935 \end_inset
10936
10937
10938 \begin_inset CommandInset ref
10939 LatexCommand ref
10940 reference "subsec:Extra-font-sizes"
10941 nolink "false"
10942
10943 \end_inset
10944
10945 ) document classes .
10946 \end_layout
10947
10948 \begin_layout Subsection
10949
10950 \change_inserted 564990737 1671041970
10951 Din-Brief
10952 \end_layout
10953
10954 \begin_layout Standard
10955
10956 \change_inserted 564990737 1671617528
10957 The document class
10958 \family sans
10959 Din-Brief
10960 \family default
10961  provides the
10962 \family typewriter
10963 dinbrief.cls
10964 \family default
10965  document class for writing letters according to the
10966 \emph on
10967 Deutsches Institut für Normung
10968 \emph default
10969  conventions.
10970  The file in the menu
10971 \family sans
10972 \bar under
10973 F
10974 \bar default
10975 ile\SpecialChar menuseparator
10976 New
10977 \begin_inset space ~
10978 \end_inset
10979
10980 fro
10981 \bar under
10982 m
10983 \bar default
10984
10985 \begin_inset space ~
10986 \end_inset
10987
10988 Template\SpecialChar menuseparator
10989 Letters\SpecialChar menuseparator
10990 DIN-Brief
10991 \family default
10992  offers guidance on its use.
10993  The documentation is available from
10994 \begin_inset CommandInset href
10995 LatexCommand href
10996 name "CTAN"
10997 target "http://mirrors.ctan.org/macros/latex/contrib/dinbrief/liesmich"
10998 literal "false"
10999
11000 \end_inset
11001
11002 .
11003 \end_layout
11004
11005 \begin_layout Subsection
11006
11007 \change_inserted 564990737 1672652499
11008 frletter
11009 \end_layout
11010
11011 \begin_layout Standard
11012
11013 \change_inserted 564990737 1672652499
11014 The document class
11015 \family sans
11016 French letter
11017 \begin_inset space \space{}
11018 \end_inset
11019
11020 (frletter)
11021 \family default
11022  provides the
11023 \family typewriter
11024 frletter.cls
11025 \family default
11026  document class for writing letters according to French conventions.
11027  The file in the menu
11028 \family sans
11029 \bar under
11030 F
11031 \bar default
11032 ile\SpecialChar menuseparator
11033 New
11034 \begin_inset space ~
11035 \end_inset
11036
11037 fro
11038 \bar under
11039 m
11040 \bar default
11041
11042 \begin_inset space ~
11043 \end_inset
11044
11045 Template\SpecialChar menuseparator
11046 Letters\SpecialChar menuseparator
11047 French letter
11048 \begin_inset space \space{}
11049 \end_inset
11050
11051 (frletter)
11052 \family default
11053  offers guidance on its use.
11054 \end_layout
11055
11056 \begin_layout Subsection
11057
11058 \change_inserted 564990737 1672652499
11059 G-Brief
11060 \end_layout
11061
11062 \begin_layout Standard
11063
11064 \change_inserted 564990737 1672652499
11065 The document class
11066 \family sans
11067 G-Brief (V.
11068 \begin_inset space \thinspace{}
11069 \end_inset
11070
11071 2)
11072 \family default
11073  provides the newer
11074 \family typewriter
11075 g-brief2.cls
11076 \family default
11077  document class for writing letters in German.
11078  The file in the menu
11079 \family sans
11080 \bar under
11081 F
11082 \bar default
11083 ile\SpecialChar menuseparator
11084 New
11085 \begin_inset space ~
11086 \end_inset
11087
11088 fro
11089 \bar under
11090 m
11091 \bar default
11092
11093 \begin_inset space ~
11094 \end_inset
11095
11096 Template\SpecialChar menuseparator
11097 Letters\SpecialChar menuseparator
11098 G-Brief (V.
11099 \begin_inset space \thinspace{}
11100 \end_inset
11101
11102 2)
11103 \family default
11104  offers guidance on its use.
11105  The documentation is available from
11106 \begin_inset CommandInset href
11107 LatexCommand href
11108 name "CTAN"
11109 target "http://mirrors.ctan.org/macros/latex/contrib/g-brief/g-brief.pdf"
11110 literal "false"
11111
11112 \end_inset
11113
11114 .
11115 \end_layout
11116
11117 \begin_layout Subsection
11118
11119 \change_inserted 564990737 1671458835
11120 letter
11121 \end_layout
11122
11123 \begin_layout Standard
11124
11125 \change_inserted 564990737 1671617591
11126 The document class
11127 \family sans
11128 letter
11129 \family default
11130  provides the
11131 \family sans
11132 letter.cls
11133 \family default
11134  document class for English letters and to create mailing labels.
11135  The file in the menu
11136 \family sans
11137 \bar under
11138 F
11139 \bar default
11140 ile\SpecialChar menuseparator
11141 New
11142 \begin_inset space ~
11143 \end_inset
11144
11145 fro
11146 \bar under
11147 m
11148 \bar default
11149
11150 \begin_inset space ~
11151 \end_inset
11152
11153 Template\SpecialChar menuseparator
11154 Letters\SpecialChar menuseparator
11155 Letter (Standard Class)
11156 \family default
11157  offers guidance on its use.
11158 \end_layout
11159
11160 \begin_layout Subsection
11161
11162 \change_inserted 564990737 1672652527
11163 lettre
11164 \end_layout
11165
11166 \begin_layout Standard
11167
11168 \change_inserted 564990737 1672652527
11169 The document class
11170 \family sans
11171 French letter
11172 \begin_inset space \space{}
11173 \end_inset
11174
11175 (lettre)
11176 \family default
11177  provides the
11178 \family typewriter
11179 lettre.cls
11180 \family default
11181  document class for writing letters,
11182  faxes and envelopes in French.
11183  The file in the menu
11184 \family sans
11185 \bar under
11186 F
11187 \bar default
11188 ile\SpecialChar menuseparator
11189 New
11190 \begin_inset space ~
11191 \end_inset
11192
11193 fro
11194 \bar under
11195 m
11196 \bar default
11197
11198 \begin_inset space ~
11199 \end_inset
11200
11201 Template\SpecialChar menuseparator
11202 Letters\SpecialChar menuseparator
11203 French letter
11204 \begin_inset space \space{}
11205 \end_inset
11206
11207 (lettre)
11208 \family default
11209  offers guidance on its use.
11210  The documentation is available from
11211 \begin_inset CommandInset href
11212 LatexCommand href
11213 name "CTAN"
11214 target "http://mirrors.ctan.org/macros/latex/contrib/lettre/lettre.pdf"
11215 literal "false"
11216
11217 \end_inset
11218
11219 .
11220 \end_layout
11221
11222 \begin_layout Section
11223
11224 \change_inserted 564990737 1670439660
11225 Presentations
11226 \end_layout
11227
11228 \begin_layout Subsection
11229
11230 \change_inserted 564990737 1671458922
11231 Beamer
11232 \end_layout
11233
11234 \begin_layout Standard
11235
11236 \change_inserted 564990737 1671617655
11237 The document class
11238 \family sans
11239 presentation
11240 \begin_inset space \thinspace{}
11241 \end_inset
11242
11243 (beamer)
11244 \family default
11245  uses the
11246 \family typewriter
11247 beamer.cls
11248 \family default
11249  document class for creating presentations.
11250  The file in the menu
11251 \family sans
11252 \bar under
11253 F
11254 \bar default
11255 ile\SpecialChar menuseparator
11256 New
11257 \begin_inset space ~
11258 \end_inset
11259
11260 fro
11261 \bar under
11262 m
11263 \bar default
11264
11265 \begin_inset space ~
11266 \end_inset
11267
11268 Template\SpecialChar menuseparator
11269 Presentations\SpecialChar menuseparator
11270 Beamer
11271 \family default
11272  offers guidance on its use.
11273  The documentation is available from
11274 \begin_inset CommandInset href
11275 LatexCommand href
11276 name "CTAN"
11277 target "http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf"
11278 literal "false"
11279
11280 \end_inset
11281
11282 .
11283 \end_layout
11284
11285 \begin_layout Subsection
11286 Foils [aka
11287 \family sans
11288 Foil\SpecialChar TeX
11289
11290 \family default
11291 ]
11292 \begin_inset CommandInset label
11293 LatexCommand label
11294 name "sec:foiltex"
11295
11296 \end_inset
11297
11298
11299 \end_layout
11300
11301 \begin_layout Standard
11302
11303 \change_inserted 564990737 1672743383
11304 Original by
11305 \noun on
11306 Allan Rae
11307 \noun default
11308 ;
11309  updated by the \SpecialChar LyX
11310  Team
11311 \end_layout
11312
11313 \begin_layout Subsubsection
11314
11315 \change_inserted 564990737 1672743383
11316 Introduction
11317 \end_layout
11318
11319 \begin_layout Standard
11320
11321 \change_inserted 564990737 1672743396
11322 The document class
11323 \family sans
11324 presentation
11325 \begin_inset space \thinspace{}
11326 \end_inset
11327
11328 (Foil\SpecialChar TeX
11329 )
11330 \family default
11331  uses the
11332 \family typewriter
11333 foils.cls
11334 \family default
11335  document class to make slides for overhead projectors.
11336  There are two document classes that can do this:
11337  the
11338 \family sans
11339 presentations
11340 \begin_inset space \thinspace{}
11341 \end_inset
11342
11343 (slides)
11344 \family default
11345  document class (section
11346 \begin_inset space ~
11347 \end_inset
11348
11349
11350 \begin_inset CommandInset ref
11351 LatexCommand ref
11352 reference "sec:slitex"
11353 plural "false"
11354 caps "false"
11355 noprefix "false"
11356 nolink "false"
11357
11358 \end_inset
11359
11360 ) and the
11361 \family sans
11362 Foil\SpecialChar TeX
11363
11364 \family default
11365  slides class.
11366  As of 2023 the former has continued to be maintained whereas
11367 \family sans
11368 Foil\SpecialChar TeX
11369
11370 \family default
11371  has not been maintained since 2008.
11372  This section documents the latter.
11373  If your machine doesn’t have the
11374 \family sans
11375 presentation
11376 \begin_inset space \thinspace{}
11377 \end_inset
11378
11379 (Foil\SpecialChar TeX
11380 )
11381 \family default
11382  document class installed,
11383  you’ll probably have to use the
11384 \family sans
11385 presentations
11386 \begin_inset space \thinspace{}
11387 \end_inset
11388
11389 (slides)
11390 \family default
11391  document class.
11392  If you want to install the
11393 \family typewriter
11394 foils.cls
11395 \family default
11396  document class,
11397  it is available from
11398 \begin_inset CommandInset href
11399 LatexCommand href
11400 name "CTAN"
11401 target "https://www.ctan.org/pkg/foiltex"
11402 literal "false"
11403
11404 \end_inset
11405
11406 .
11407  You should also read the
11408 \emph on
11409 Installing New Document Classes
11410 \emph default
11411  chapter of the
11412 \emph on
11413 Customization
11414 \emph default
11415  manual.
11416 \change_deleted 564990737 1672743436
11417 by
11418 \noun on
11419 Allan Rae
11420 \end_layout
11421
11422 \begin_layout Standard
11423
11424 \change_deleted 564990737 1672743383
11425 Introduction
11426 \end_layout
11427
11428 \begin_layout Standard
11429
11430 \change_deleted 564990737 1672743383
11431 This section describes how to use \SpecialChar LyX
11432  to make slides for overhead projectors.
11433  There are two document classes that can do this:
11434  the default slides class and the
11435 \family sans
11436 Foil\SpecialChar TeX
11437
11438 \family default
11439  slides class.
11440  This section documents the latter.
11441 \end_layout
11442
11443 \begin_layout Standard
11444
11445 \change_deleted 564990737 1672743383
11446 I'm going to say this again,
11447  nice and clear,
11448  so that there's no misunderstanding:
11449 \end_layout
11450
11451 \begin_layout Standard
11452
11453 \change_deleted 564990737 1672743383
11454 \begin_inset VSpace bigskip
11455 \end_inset
11456
11457
11458 \end_layout
11459
11460 \begin_layout Standard
11461 \align center
11462
11463 \change_deleted 564990737 1672743383
11464
11465 \size large
11466 This section documents the class
11467 \begin_inset Quotes eld
11468 \end_inset
11469
11470
11471 \family sans
11472 FoilTeX
11473 \family default
11474
11475 \begin_inset Quotes erd
11476 \end_inset
11477
11478
11479 \emph on
11480 only.
11481 \end_layout
11482
11483 \begin_layout Standard
11484
11485 \change_deleted 564990737 1672743383
11486 \begin_inset VSpace bigskip
11487 \end_inset
11488
11489
11490 \end_layout
11491
11492 \begin_layout Standard
11493
11494 \change_deleted 564990737 1672743383
11495 If you're looking for the documentation for
11496 \begin_inset Quotes eld
11497 \end_inset
11498
11499
11500 \family sans
11501 slides (default)
11502 \family default
11503
11504 \begin_inset Quotes erd
11505 \end_inset
11506
11507 ,
11508  check out section
11509 \begin_inset space ~
11510 \end_inset
11511
11512
11513 \begin_inset CommandInset ref
11514 LatexCommand ref
11515 reference "sec:slitex"
11516 nolink "false"
11517
11518 \end_inset
11519
11520 .
11521  If your machine doesn't have the
11522 \family sans
11523 foils
11524 \family default
11525  class
11526 \family sans
11527 FoilTeX
11528 \family default
11529  installed,
11530  you'll probably have to use the default
11531 \family sans
11532 slides
11533 \family default
11534  class,
11535  which isn't quite as good as
11536 \family sans
11537 foils.
11538 \end_layout
11539
11540 \begin_layout Standard
11541
11542 \change_deleted 564990737 1672743383
11543 The
11544 \family sans
11545 foils
11546 \family default
11547  class is designed for use with version
11548 \begin_inset space ~
11549 \end_inset
11550
11551 2.1 of the
11552 \family sans
11553 foils.cls
11554 \family default
11555  \SpecialChar LaTeX
11556  class file which is now an integral part of \SpecialChar LaTeX2e
11557 .
11558 \change_unchanged
11559
11560 \end_layout
11561
11562 \begin_layout Subsubsection
11563 Getting Started
11564 \end_layout
11565
11566 \begin_layout Standard
11567 Obviously,
11568  to use this document class,
11569  you need to select
11570 \family sans
11571 FoilTeX
11572 \family default
11573  from the
11574 \family sans
11575 Class
11576 \family default
11577  entry in the
11578 \family sans
11579 Document
11580 \begin_inset space ~
11581 \end_inset
11582
11583 Layout
11584 \family default
11585  dialog.
11586  There are some settings in the
11587 \family sans
11588 Document
11589 \begin_inset space ~
11590 \end_inset
11591
11592 Layout
11593 \family default
11594  dialog that you should know about that are specific to this class:
11595 \end_layout
11596
11597 \begin_layout Itemize
11598 Don't change the options
11599 \family sans
11600 Sides
11601 \family default
11602  and
11603 \family sans
11604 Columns
11605 \family default
11606  on the
11607 \family sans
11608 Document
11609 \begin_inset space ~
11610 \end_inset
11611
11612 Layout
11613 \family default
11614  dialog.
11615  They're ignored by the
11616 \family sans
11617 foils
11618 \family default
11619  class.
11620 \end_layout
11621
11622 \begin_layout Itemize
11623 The default font size is 20
11624 \begin_inset space \thinspace{}
11625 \end_inset
11626
11627 pt with the other options being 17
11628 \begin_inset space \thinspace{}
11629 \end_inset
11630
11631 pt,
11632  25
11633 \begin_inset space \thinspace{}
11634 \end_inset
11635
11636 pt and 30
11637 \begin_inset space \thinspace{}
11638 \end_inset
11639
11640 pt.
11641 \end_layout
11642
11643 \begin_layout Itemize
11644 The default font is
11645 \family sans
11646 sans
11647 \family default
11648
11649 \family sans
11650 serif
11651 \family default
11652  but all math equations are still typeset in the usual roman font.
11653 \end_layout
11654
11655 \begin_layout Itemize
11656
11657 \family sans
11658 Foil\SpecialChar TeX
11659
11660 \family default
11661  supports A4 and Letter paper sizes as well as a special size for working with 35
11662 \begin_inset space \thinspace{}
11663 \end_inset
11664
11665 mm slides.
11666  It doesn't support A5,
11667  B5,
11668  legal or executive paper sizes.
11669 \end_layout
11670
11671 \begin_layout Itemize
11672 Don't bother changing the
11673 \family sans
11674 Float Placement
11675 \family default
11676  settings because they are ignored anyway.
11677  All floats appear where they are defined in the text.
11678 \end_layout
11679
11680 \begin_layout Itemize
11681 The
11682 \family sans
11683 Pagestyle
11684 \family default
11685  setting behaves a bit differently for this class.
11686
11687 \family sans
11688 Foil\SpecialChar TeX
11689
11690 \family default
11691  provides extensive footer and header capabilities including a user-defined logo.
11692  See section
11693 \begin_inset space ~
11694 \end_inset
11695
11696
11697 \begin_inset CommandInset ref
11698 LatexCommand ref
11699 reference "sec:foilfoot"
11700 nolink "false"
11701
11702 \end_inset
11703
11704  for more details.
11705  The title page is treated differently to all other pages in the document and is
11706 \emph on
11707 always
11708 \emph default
11709  unnumbered and
11710 \emph on
11711 always
11712 \emph default
11713  has the logo centered at the bottom of the page (if one is defined).
11714  The possible page style choices and what they do are as follows:
11715 \end_layout
11716
11717 \begin_deeper
11718 \begin_layout Labeling
11719 \labelwidthstring MMMMMMM
11720
11721 \family sans
11722 \series bold
11723 empty
11724 \family default
11725 \series default
11726  The final output contains no page numbers,
11727  or other headers or footers (except footnotes of course).
11728
11729 \end_layout
11730
11731 \begin_layout Labeling
11732 \labelwidthstring MMMMMMM
11733
11734 \family sans
11735 \series bold
11736 plain
11737 \family default
11738 \series default
11739  The final output contains page numbers centered at the bottom of the page.
11740  No other headings or footers (other than footnotes).
11741 \end_layout
11742
11743 \begin_layout Labeling
11744 \labelwidthstring MMMMMMM
11745
11746 \series bold
11747 foilheadings
11748 \series default
11749  Page numbers in lower right corner.
11750  Additional headers and footers are also shown.
11751  This is also the default.
11752 \end_layout
11753
11754 \begin_layout Labeling
11755 \labelwidthstring MMMMMMM
11756
11757 \series bold
11758 fancy
11759 \series default
11760  Gives you access to the
11761 \family sans
11762 fancyheadings
11763 \family default
11764  package although its use with
11765 \family sans
11766 Foil\SpecialChar TeX
11767
11768 \family default
11769  is discouraged by the writer of the
11770 \family sans
11771 Foil\SpecialChar TeX
11772
11773 \family default
11774  package because of some potential page layout clashes.
11775 \end_layout
11776
11777 \end_deeper
11778 \begin_layout Paragraph
11779 Extra Options
11780 \end_layout
11781
11782 \begin_layout Standard
11783 The following options may be used in the extra class options in the
11784 \family sans
11785 Document\SpecialChar menuseparator
11786 Settings
11787 \family default
11788  dialog.
11789 \end_layout
11790
11791 \begin_layout Labeling
11792 \labelwidthstring MMMMMMx
11793
11794 \series bold
11795 35mmSlide
11796 \series default
11797  This sets up the page layout for 7.33
11798 \begin_inset space \thinspace{}
11799 \end_inset
11800
11801 in by 11
11802 \begin_inset space \thinspace{}
11803 \end_inset
11804
11805 in paper,
11806  which is about the same aspect ratio as a 35
11807 \begin_inset space \thinspace{}
11808 \end_inset
11809
11810 mm slide,
11811  making it a bit easier to work with this medium.
11812 \end_layout
11813
11814 \begin_layout Labeling
11815 \labelwidthstring MMMMMMx
11816
11817 \series bold
11818 headrule
11819 \series default
11820  Places a rule across the page below the header on every page except the title page.
11821 \end_layout
11822
11823 \begin_layout Labeling
11824 \labelwidthstring MMMMMMx
11825
11826 \series bold
11827 footrule
11828 \series default
11829  Places a rule across the page above the footer on every page except the title page.
11830 \end_layout
11831
11832 \begin_layout Labeling
11833 \labelwidthstring MMMMMMx
11834
11835 \series bold
11836 dvips
11837 \series default
11838  This is automatically set each time you create a new
11839 \family sans
11840 foils
11841 \family default
11842  document.
11843  This option tells
11844 \family sans
11845 Foil\SpecialChar TeX
11846
11847 \family default
11848  to use the dvips driver to rotate those pages that are set as landscape foils.
11849 \end_layout
11850
11851 \begin_layout Labeling
11852 \labelwidthstring MMMMMMx
11853
11854 \series bold
11855 landscape
11856 \series default
11857  Simply changes the page dimensions to those of a landscape page but doesn't do any rotation.
11858  Thus if you use this option you need to use an external program to rotate each page or feed your paper through your printer as landscape.
11859  Note that this option effectively reverses the roles of the
11860 \family sans
11861 Foilhead
11862 \family default
11863  and
11864 \family sans
11865 Rotatefoilhead
11866 \family default
11867  environments (don't worry these are described in the next section).
11868 \end_layout
11869
11870 \begin_layout Labeling
11871 \labelwidthstring MMMMMMx
11872
11873 \series bold
11874 leqno
11875 \series default
11876  Equation numbers on the left.
11877 \end_layout
11878
11879 \begin_layout Labeling
11880 \labelwidthstring MMMMMMx
11881
11882 \series bold
11883 fleqn
11884 \series default
11885  Flush-left equations.
11886 \end_layout
11887
11888 \begin_layout Subsubsection
11889 Supported Environments
11890 \end_layout
11891
11892 \begin_layout Standard
11893 Most of the environments commonly supported in other classes are also supported by the
11894 \family sans
11895 foils
11896 \family default
11897  class.
11898  There are several additional environments provided by
11899 \family sans
11900 Foil\SpecialChar TeX
11901
11902 \family default
11903  as well as a couple added by \SpecialChar LyX
11904 .
11905  The following environments are shared with other classes:
11906 \end_layout
11907
11908 \begin_layout Standard
11909 \begin_inset Flex Multiple Columns
11910 status open
11911
11912 \begin_layout Itemize
11913
11914 \family sans
11915 Standard
11916 \end_layout
11917
11918 \begin_layout Itemize
11919
11920 \family sans
11921 Itemize
11922 \end_layout
11923
11924 \begin_layout Itemize
11925
11926 \family sans
11927 Enumerate
11928 \end_layout
11929
11930 \begin_layout Itemize
11931
11932 \family sans
11933 Description
11934 \end_layout
11935
11936 \begin_layout Itemize
11937
11938 \family sans
11939 List
11940 \end_layout
11941
11942 \begin_layout Itemize
11943
11944 \family sans
11945 \SpecialChar LyX
11946 -Code
11947 \end_layout
11948
11949 \begin_layout Itemize
11950
11951 \family sans
11952 Verse
11953 \end_layout
11954
11955 \begin_layout Itemize
11956
11957 \family sans
11958 Quote
11959 \end_layout
11960
11961 \begin_layout Itemize
11962
11963 \family sans
11964 Quotation
11965 \end_layout
11966
11967 \begin_layout Itemize
11968
11969 \family sans
11970 TitleAuthor
11971 \end_layout
11972
11973 \begin_layout Itemize
11974
11975 \family sans
11976 Date
11977 \end_layout
11978
11979 \begin_layout Itemize
11980
11981 \family sans
11982 Abstract
11983 \end_layout
11984
11985 \begin_layout Itemize
11986
11987 \family sans
11988 Bibliography
11989 \end_layout
11990
11991 \begin_layout Itemize
11992
11993 \family sans
11994 Address
11995 \end_layout
11996
11997 \begin_layout Itemize
11998
11999 \family sans
12000 RightAddress
12001 \end_layout
12002
12003 \end_inset
12004
12005
12006 \end_layout
12007
12008 \begin_layout Standard
12009 That is,
12010  all the major environments apart from the sectioning environments.
12011  Since foils are essentially self-contained sections,
12012  with a title and body,
12013
12014 \family sans
12015 Foil\SpecialChar TeX
12016
12017 \family default
12018  provides specific commands for starting new foils and these are:
12019 \end_layout
12020
12021 \begin_layout Itemize
12022
12023 \family sans
12024 Foilhead
12025 \end_layout
12026
12027 \begin_layout Itemize
12028
12029 \family sans
12030 Rotatefoilhead
12031 \end_layout
12032
12033 \begin_layout Standard
12034 \SpecialChar LyX
12035  also provides slightly modified versions of these two environments called:
12036 \end_layout
12037
12038 \begin_layout Itemize
12039
12040 \family sans
12041 ShortFoilhead
12042 \end_layout
12043
12044 \begin_layout Itemize
12045
12046 \family sans
12047 ShortRotatefoilhead
12048 \end_layout
12049
12050 \begin_layout Standard
12051 and the differences will be explained in the next section.
12052 \end_layout
12053
12054 \begin_layout Standard
12055 Since foils are often used in presenting ideas or new theorems and such
12056 \family sans
12057 Foil\SpecialChar TeX
12058
12059 \family default
12060  also provides a comprehensive box of goodies for presenting them:
12061 \end_layout
12062
12063 \begin_layout Standard
12064 \begin_inset Flex Multiple Columns
12065 status open
12066
12067 \begin_layout Itemize
12068
12069 \family sans
12070 Theorem
12071 \end_layout
12072
12073 \begin_layout Itemize
12074
12075 \family sans
12076 Lemma
12077 \end_layout
12078
12079 \begin_layout Itemize
12080
12081 \family sans
12082 Corollary
12083 \end_layout
12084
12085 \begin_layout Itemize
12086
12087 \family sans
12088 Proposition
12089 \end_layout
12090
12091 \begin_layout Itemize
12092
12093 \family sans
12094 Definition
12095 \end_layout
12096
12097 \begin_layout Itemize
12098
12099 \family sans
12100 Proof
12101 \end_layout
12102
12103 \begin_layout Itemize
12104
12105 \family sans
12106 Theorem*
12107 \end_layout
12108
12109 \begin_layout Itemize
12110
12111 \family sans
12112 Lemma*
12113 \end_layout
12114
12115 \begin_layout Itemize
12116
12117 \family sans
12118 Corollary*
12119 \end_layout
12120
12121 \begin_layout Itemize
12122
12123 \family sans
12124 Proposition*
12125 \end_layout
12126
12127 \begin_layout Itemize
12128
12129 \family sans
12130 Definition*
12131 \end_layout
12132
12133 \end_inset
12134
12135
12136 \end_layout
12137
12138 \begin_layout Standard
12139 The starred versions are unnumbered while the unstarred versions are numbered.
12140  There are also two list environments added by \SpecialChar LyX
12141  and these are:
12142 \end_layout
12143
12144 \begin_layout Itemize
12145
12146 \family sans
12147 TickList
12148 \end_layout
12149
12150 \begin_layout Itemize
12151
12152 \family sans
12153 CrossList
12154 \end_layout
12155
12156 \begin_layout Standard
12157
12158 \family sans
12159 Foil\SpecialChar TeX
12160
12161 \family default
12162  provides some powerful header and footer capabilities that are best set in the preamble although they may be set at any point in a document.
12163  If you want to change these settings in your document the best place to do so is at the very top of a foil,
12164  i.
12165 \begin_inset space \thinspace{}
12166 \end_inset
12167
12168 e.
12169 \emph on
12170
12171 \begin_inset space \space{}
12172 \end_inset
12173
12174
12175 \emph default
12176 straight after the foilhead.
12177 \end_layout
12178
12179 \begin_layout Standard
12180 For this purpose,
12181  the following command styles are provided [
12182 \shape smallcaps
12183 Martin Vermeer
12184 \shape default
12185 ]:
12186 \end_layout
12187
12188 \begin_layout Standard
12189 \begin_inset Flex Multiple Columns
12190 status open
12191
12192 \begin_layout Itemize
12193
12194 \family sans
12195 My
12196 \begin_inset space ~
12197 \end_inset
12198
12199 Logo
12200 \end_layout
12201
12202 \begin_layout Itemize
12203
12204 \family sans
12205 Restriction
12206 \end_layout
12207
12208 \begin_layout Itemize
12209
12210 \family sans
12211 Right
12212 \begin_inset space ~
12213 \end_inset
12214
12215 Footer
12216 \end_layout
12217
12218 \begin_layout Itemize
12219
12220 \family sans
12221 Right
12222 \begin_inset space ~
12223 \end_inset
12224
12225 Header
12226 \end_layout
12227
12228 \begin_layout Itemize
12229
12230 \family sans
12231 Left
12232 \begin_inset space ~
12233 \end_inset
12234
12235 Header
12236 \end_layout
12237
12238 \begin_deeper
12239 \begin_layout Plain Layout
12240 \begin_inset space ~
12241 \end_inset
12242
12243
12244 \end_layout
12245
12246 \end_deeper
12247 \end_inset
12248
12249
12250 \end_layout
12251
12252 \begin_layout Standard
12253 There are also a few commands provided by
12254 \family sans
12255 Foil\SpecialChar TeX
12256
12257 \family default
12258  that aren't directly supported by \SpecialChar LyX
12259  but I'll tell you what they do and how to use them in section
12260 \begin_inset space ~
12261 \end_inset
12262
12263
12264 \begin_inset CommandInset ref
12265 LatexCommand ref
12266 reference "sec:unsuppfoils"
12267 nolink "false"
12268
12269 \end_inset
12270
12271 .
12272 \end_layout
12273
12274 \begin_layout Subsubsection
12275 Building a Set of Foils
12276 \end_layout
12277
12278 \begin_layout Standard
12279 This section will give a simple introduction to using the different environments to build a set of foils.
12280  If you want to see an example set of foils,
12281  take a look at
12282 \change_deleted 564990737 1671643085
12283 the
12284 \family typewriter
12285 Foils.lyx
12286 \family default
12287  file you find in \SpecialChar LyX
12288 's
12289 \family typewriter
12290 examples
12291 \family default
12292  folder
12293 \change_inserted 564990737 1671643099
12294
12295 \family sans
12296 File\SpecialChar menuseparator
12297 Open Example\SpecialChar menuseparator
12298 Presentations\SpecialChar menuseparator
12299 Foils
12300 \change_unchanged
12301
12302 \family default
12303 .
12304 \end_layout
12305
12306 \begin_layout Paragraph
12307 Give It a Title Page
12308 \end_layout
12309
12310 \begin_layout Standard
12311 Unlike other classes that provide
12312 \family sans
12313 Title
12314 \family default
12315 ,
12316
12317 \family sans
12318 Author
12319 \family default
12320 ,
12321
12322 \family sans
12323 Date
12324 \family default
12325  and
12326 \family sans
12327 Abstract
12328 \family default
12329  environments,
12330
12331 \family sans
12332 foils
12333 \family default
12334  creates the title on a page of its own.
12335  If you leave out the
12336 \family sans
12337 Date
12338 \family default
12339  environment \SpecialChar LaTeX
12340  will substitute the current date (every time you regenerate the output).
12341 \end_layout
12342
12343 \begin_layout Paragraph
12344 Start a New Foil
12345 \end_layout
12346
12347 \begin_layout Standard
12348 As I mentioned earlier,
12349  there are four ways of starting a new foil.
12350  For portrait foils you should use
12351 \family sans
12352 Foilhead
12353 \family default
12354  or
12355 \family sans
12356 ShortFoilhead.
12357
12358 \family default
12359  The difference between these two environments is the amount of space between the title of the foil (the foilhead) and the body of the foil.
12360 \end_layout
12361
12362 \begin_layout Standard
12363 Landscape foils are generated using the
12364 \family sans
12365 Rotatefoilhead
12366 \family default
12367  and
12368 \family sans
12369 ShortRotatefoilhead
12370 \family default
12371  environments.
12372  Again the only difference is the spacing between foilhead and body.
12373  Both of the short versions have 0.5
12374 \begin_inset space ~
12375 \end_inset
12376
12377 inches less separation between the foilhead and the body.
12378
12379 \end_layout
12380
12381 \begin_layout Standard
12382 One problem with the support for landscape foils is the requirement that you have to use the
12383 \family typewriter
12384 dvips
12385 \family default
12386  driver to generate the PostScript output otherwise the foils won't be rotated.
12387  It is possible to get landscape foils even if you haven't got the
12388 \family typewriter
12389 dvips
12390 \family default
12391  driver provided you can feed your foils sideways through your printer ;-)
12392 \end_layout
12393
12394 \begin_layout Paragraph
12395 Theorems,
12396  Lemmas,
12397  Proofs and more
12398 \end_layout
12399
12400 \begin_layout Standard
12401 You can't have two of the same type of these environments directly following each other.
12402  If you use a normal paragraph break,
12403  ,
12404  you will just be extending the previous environment as if you had merged the two environments together.
12405  Rather than that,
12406  you need to insert a so-called separator.
12407  Please refer to the section entitled
12408 \emph on
12409 Separate Nestings
12410 \emph default
12411  in the
12412 \emph on
12413 User's Guide
12414 \emph default
12415 .
12416 \end_layout
12417
12418 \begin_layout Paragraph
12419 Lists
12420 \end_layout
12421
12422 \begin_layout Standard
12423 You get all the commonly supported list styles found in other classes as well as two new ones.
12424  I'll only describe the new ones here.
12425  If you want to find out more about the other list environments check out the
12426 \emph on
12427 User's Guide.
12428
12429 \emph default
12430  If you intend to use itemized lists you might also want to read about the
12431 \family sans
12432 Itemize
12433 \begin_inset space ~
12434 \end_inset
12435
12436 Bullet
12437 \begin_inset space ~
12438 \end_inset
12439
12440 Selection
12441 \family default
12442  dialog described above in section
12443 \begin_inset space ~
12444 \end_inset
12445
12446
12447 \change_inserted 564990737 1671355684
12448
12449 \begin_inset CommandInset ref
12450 LatexCommand ref
12451 reference "chap:bullets"
12452 nolink "false"
12453
12454 \end_inset
12455
12456
12457 \change_deleted 564990737 1671355684
12458
12459 \begin_inset CommandInset ref
12460 LatexCommand ref
12461 reference "sec:bullet"
12462 nolink "false"
12463
12464 \end_inset
12465
12466
12467 \change_unchanged
12468 .
12469 \end_layout
12470
12471 \begin_layout Standard
12472 The two new list styles,
12473
12474 \family sans
12475 TickList
12476 \family default
12477  and
12478 \family sans
12479 CrossList
12480 \family default
12481 ,
12482  are designed to make it easier for you to create lists of do's and don'ts or right and wrong by providing dedicated environments that use a tick or a cross as the label of the list.
12483  These lists are in fact dedicated variants of the
12484 \family sans
12485 Itemize
12486 \family default
12487  environment.
12488  They do however require that you have the
12489 \family typewriter
12490 psnfss
12491 \family default
12492  packages installed.
12493 \end_layout
12494
12495 \begin_layout Paragraph
12496 Figures and Tables
12497 \end_layout
12498
12499 \begin_layout Standard
12500
12501 \family sans
12502 Foil\SpecialChar TeX
12503
12504 \family default
12505  redefines the floating tables and figures so that they appear exactly where they are in the text rather than pushing them to the top of the page or to some user specified location.
12506  In fact if you change the float placement settings they are simply ignored.
12507 \end_layout
12508
12509 \begin_layout Paragraph
12510 Page Headers and Footers
12511 \begin_inset CommandInset label
12512 LatexCommand label
12513 name "sec:foilfoot"
12514
12515 \end_inset
12516
12517
12518 \end_layout
12519
12520 \begin_layout Standard
12521
12522 \family sans
12523 My
12524 \begin_inset space ~
12525 \end_inset
12526
12527 Logo
12528 \family default
12529  and
12530 \family sans
12531 Restriction
12532 \family default
12533  are two commands used to control the left-footer text string.
12534  The first is meant to allow you to include a graphic logo on your foils and defaults to
12535 \begin_inset Quotes eld
12536 \end_inset
12537
12538 -Typeset by
12539 \family sans
12540 Foil\SpecialChar TeX
12541
12542 \family default
12543 -
12544 \begin_inset Quotes erd
12545 \end_inset
12546
12547 .
12548  While the second is meant to provide a classification for the audience,
12549
12550 \emph on
12551 e.
12552 \begin_inset space \thinspace{}
12553 \end_inset
12554
12555 g.
12556 \emph default
12557
12558 \begin_inset space \space{}
12559 \end_inset
12560
12561 Confidential.
12562  It is empty by default.
12563 \end_layout
12564
12565 \begin_layout Standard
12566 The remaining page corners can be filled by
12567 \family sans
12568 Right
12569 \begin_inset space ~
12570 \end_inset
12571
12572 Footer
12573 \family default
12574  (which defaults to page numbers),
12575
12576 \family sans
12577 Right
12578 \begin_inset space ~
12579 \end_inset
12580
12581 Header
12582 \family default
12583  (top right) and
12584 \family sans
12585 Left
12586 \begin_inset space ~
12587 \end_inset
12588
12589 Header
12590 \family default
12591  (top left).
12592 \end_layout
12593
12594 \begin_layout Subsubsection
12595 Unsupported
12596 \family sans
12597 Foil\SpecialChar TeX
12598
12599 \family default
12600  Goodies
12601 \begin_inset CommandInset label
12602 LatexCommand label
12603 name "sec:unsuppfoils"
12604
12605 \end_inset
12606
12607
12608 \end_layout
12609
12610 \begin_layout Standard
12611 All the commands mentioned below need to be set in a
12612 \family sans
12613 \SpecialChar LaTeX
12614
12615 \family default
12616  environment or as
12617 \family sans
12618 \SpecialChar TeX
12619
12620 \family default
12621  within another environment.
12622 \end_layout
12623
12624 \begin_layout Paragraph
12625 Lengths
12626 \end_layout
12627
12628 \begin_layout Standard
12629 All lengths are adjusted using the
12630 \family typewriter
12631
12632 \backslash
12633 setlength{
12634 \family default
12635 \emph on
12636 lengthname
12637 \family typewriter
12638 \emph default
12639 }{
12640 \family default
12641 \emph on
12642 newlength
12643 \family typewriter
12644 \emph default
12645 }
12646 \family default
12647  command.
12648  Where
12649 \emph on
12650 lengthname
12651 \emph default
12652  should be replaced by the name given to the length you want to change and
12653 \emph on
12654 newlength
12655 \emph default
12656  is the length value.
12657  All lengths should be specified in units of length such as inches (
12658 \family typewriter
12659 in
12660 \family default
12661 ),
12662  millimeters (
12663 \family typewriter
12664 mm
12665 \family default
12666 ) or points (
12667 \family typewriter
12668 pt
12669 \family default
12670 ) or relative to some document or font-based length such as
12671 \family typewriter
12672
12673 \backslash
12674 textwidth
12675 \family default
12676 .
12677
12678 \end_layout
12679
12680 \begin_layout Standard
12681 It's possible to change the spacing between a foilhead and the body of the foil by adjusting the length specified by
12682 \family typewriter
12683
12684 \backslash
12685 foilheadskip
12686 \family default
12687 .
12688  For example,
12689  to make
12690 \emph on
12691 all
12692 \emph default
12693  foilheads 0.5
12694 \begin_inset space \space{}
12695 \end_inset
12696
12697 in closer to their bodies put the following in the preamble:
12698
12699 \family typewriter
12700
12701 \backslash
12702 setlength{
12703 \backslash
12704 foilheadskip}{-0.5in}
12705 \end_layout
12706
12707 \begin_layout Standard
12708 The spacings around floats can be adjusted by setting these lengths:
12709 \end_layout
12710
12711 \begin_layout Labeling
12712 \labelwidthstring MMMMMMMMMMM
12713
12714 \family typewriter
12715
12716 \backslash
12717 abovefloatskip
12718 \family default
12719  Separation between the text and the top of the float
12720 \end_layout
12721
12722 \begin_layout Labeling
12723 \labelwidthstring MMMMMMMMMMM
12724
12725 \family typewriter
12726
12727 \backslash
12728 abovecaptionskip
12729 \family default
12730  Separation between the float and the caption
12731 \end_layout
12732
12733 \begin_layout Labeling
12734 \labelwidthstring MMMMMMMMMMM
12735
12736 \family typewriter
12737
12738 \backslash
12739 belowcaptionskip
12740 \family default
12741  Separation between the caption and the following text
12742 \end_layout
12743
12744 \begin_layout Labeling
12745 \labelwidthstring MMMMMMMMMMM
12746
12747 \family typewriter
12748
12749 \backslash
12750 captionwidth
12751 \family default
12752  You can make the captions narrower than the surrounding text by adjusting this length.
12753  Best done relative to
12754 \family typewriter
12755
12756 \backslash
12757 textwidth
12758 \family default
12759 .
12760 \end_layout
12761
12762 \begin_layout Standard
12763 There are also several title page related lengths that you may find useful if you have a long title or several authors:
12764 \end_layout
12765
12766 \begin_layout Labeling
12767 \labelwidthstring MMMMMMMMMMM
12768
12769 \family typewriter
12770
12771 \backslash
12772 abovetitleskip
12773 \family default
12774  Separation from headers to
12775 \family sans
12776 Title
12777 \end_layout
12778
12779 \begin_layout Labeling
12780 \labelwidthstring MMMMMMMMMMM
12781
12782 \family typewriter
12783
12784 \backslash
12785 titleauthorskip
12786 \family default
12787  between
12788 \family sans
12789 Title
12790 \family default
12791  and
12792 \family sans
12793 Author
12794 \family default
12795  environments
12796 \end_layout
12797
12798 \begin_layout Labeling
12799 \labelwidthstring MMMMMMMMMMM
12800
12801 \family typewriter
12802
12803 \backslash
12804 authorauthorskip
12805 \family default
12806  between multiple
12807 \family sans
12808 Author
12809 \family default
12810  lines
12811 \end_layout
12812
12813 \begin_layout Labeling
12814 \labelwidthstring MMMMMMMMMMM
12815
12816 \family typewriter
12817
12818 \backslash
12819 authordateskip
12820 \family default
12821  between the
12822 \family sans
12823 Author
12824 \family default
12825  and the
12826 \family sans
12827 Date
12828 \end_layout
12829
12830 \begin_layout Labeling
12831 \labelwidthstring MMMMMMMMMMM
12832
12833 \family typewriter
12834
12835 \backslash
12836 dateabstractskip
12837 \family default
12838  between the
12839 \family sans
12840 Date
12841 \family default
12842  and the
12843 \family sans
12844 Abstract
12845 \end_layout
12846
12847 \begin_layout Standard
12848 The last length related command affects all the list environments.
12849  If you place
12850 \family typewriter
12851
12852 \backslash
12853 zerolistvertdimens
12854 \family default
12855
12856 \emph on
12857 inside
12858 \emph default
12859  a list environment then all the vertical spacing between the list items is removed.
12860  Note that this is a command not a length so it doesn't require
12861 \family typewriter
12862
12863 \backslash
12864 setlength
12865 \family default
12866  like the stuff mentioned above.
12867 \end_layout
12868
12869 \begin_layout Paragraph
12870 Headers and Footers
12871 \end_layout
12872
12873 \begin_layout Standard
12874 The
12875 \family typewriter
12876
12877 \backslash
12878 LogoOn
12879 \family default
12880  and
12881 \family typewriter
12882
12883 \backslash
12884 LogoOff
12885 \family default
12886  commands control whether the logo in the
12887 \family sans
12888 MyLogo
12889 \family default
12890  definition appear on a given page.
12891  If you put
12892 \family typewriter
12893
12894 \backslash
12895 LogoOff
12896 \family default
12897  in the preamble then none of the foils will have the logo on them.
12898  If you don't want the logo on a particular page place the
12899 \family typewriter
12900
12901 \backslash
12902 LogoOff
12903 \family default
12904  directly after the foilhead of that page and the
12905 \family typewriter
12906
12907 \backslash
12908 LogoOn
12909 \family default
12910  directly after the next foilhead.
12911 \end_layout
12912
12913 \begin_layout Standard
12914 If you decide to use the
12915 \family sans
12916 fancy
12917 \family default
12918  page style setting in the
12919 \family sans
12920 Document
12921 \begin_inset space ~
12922 \end_inset
12923
12924 Layout
12925 \family default
12926  dialog you should probably add
12927 \family typewriter
12928
12929 \backslash
12930 let
12931 \backslash
12932 headwidth
12933 \backslash
12934 textwidth
12935 \family default
12936  to your preamble so headers and footers on landscape pages are correctly placed when rotated.
12937  This is due to some clashes between the page layouts provided by the
12938 \family sans
12939 fancyheadings
12940 \family default
12941  package and the
12942 \family sans
12943 foils
12944 \family default
12945  class.
12946 \end_layout
12947
12948 \begin_layout Subsection
12949
12950 \change_inserted 564990737 1671459032
12951 Powerdot
12952 \end_layout
12953
12954 \begin_layout Standard
12955
12956 \change_inserted 564990737 1671643165
12957 The document class
12958 \family sans
12959 presentation
12960 \begin_inset space \thinspace{}
12961 \end_inset
12962
12963 (powerdot)
12964 \family default
12965  uses the
12966 \family typewriter
12967 powerdot.cls
12968 \family default
12969  document class for creating presentations.
12970
12971 \family sans
12972 File\SpecialChar menuseparator
12973 Open Example\SpecialChar menuseparator
12974 Presentations\SpecialChar menuseparator
12975 Powerdot
12976 \family default
12977  offers guidance on its use.
12978  The documentation is available from
12979 \begin_inset CommandInset href
12980 LatexCommand href
12981 name "CTAN"
12982 target "http://mirrors.ctan.org/macros/latex/contrib/powerdot/doc/powerdot.pdf"
12983 literal "false"
12984
12985 \end_inset
12986
12987 .
12988 \end_layout
12989
12990 \begin_layout Subsection
12991
12992 \change_inserted 564990737 1671459032
12993 \begin_inset CommandInset label
12994 LatexCommand label
12995 name "subsec:Seminar"
12996
12997 \end_inset
12998
12999
13000 \family sans
13001 Seminar
13002 \end_layout
13003
13004 \begin_layout Standard
13005
13006 \change_inserted 564990737 1671643194
13007 The document class
13008 \family sans
13009 presentations
13010 \begin_inset space \thinspace{}
13011 \end_inset
13012
13013 (seminar)
13014 \family default
13015  uses the
13016 \family typewriter
13017 seminar.cls
13018 \family default
13019  document class for creating presentations.
13020
13021 \family sans
13022 File\SpecialChar menuseparator
13023 Open Example\SpecialChar menuseparator
13024 Presentations\SpecialChar menuseparator
13025 Seminar
13026 \family default
13027  offers guidance on its use.
13028  The documentation is available from
13029 \begin_inset CommandInset href
13030 LatexCommand href
13031 name "CTAN"
13032 target "http://mirrors.ctan.org/macros/latex/contrib/seminar/doc/seminar-doc.pdf"
13033 literal "false"
13034
13035 \end_inset
13036
13037 .
13038 \end_layout
13039
13040 \begin_layout Subsection
13041 Slides [aka
13042 \noun on
13043 Sli\SpecialChar TeX
13044
13045 \noun default
13046 ]
13047 \begin_inset CommandInset label
13048 LatexCommand label
13049 name "sec:slitex"
13050
13051 \end_inset
13052
13053
13054 \end_layout
13055
13056 \begin_layout Standard
13057
13058 \change_inserted 564990737 1672743492
13059 Original by
13060 \noun on
13061 John Weiss
13062 \noun default
13063 ;
13064  updated by the \SpecialChar LyX
13065  Team
13066 \end_layout
13067
13068 \begin_layout Subsubsection
13069
13070 \change_inserted 564990737 1672743492
13071 Introduction
13072 \end_layout
13073
13074 \begin_layout Standard
13075
13076 \change_inserted 564990737 1672743492
13077 This section describes how to use \SpecialChar LyX
13078  to make slides for overhead projectors.
13079  There are two document classes that can do this:
13080  the
13081 \family typewriter
13082 presentations
13083 \begin_inset space \thinspace{}
13084 \end_inset
13085
13086 (slides)
13087 \family default
13088  document class and the
13089 \family sans
13090 presentation
13091 \begin_inset space \thinspace{}
13092 \end_inset
13093
13094 (Foil\SpecialChar TeX
13095 )
13096 \family default
13097  document class.
13098  This section documents the former.
13099  If you’re looking for the documentation for
13100 \family sans
13101 presentation
13102 \begin_inset space \thinspace{}
13103 \end_inset
13104
13105 (Foil\SpecialChar TeX
13106 )
13107 \family default
13108 ,
13109  check out section
13110 \begin_inset space ~
13111 \end_inset
13112
13113
13114 \begin_inset CommandInset ref
13115 LatexCommand ref
13116 reference "sec:Foiltex"
13117 nolink "false"
13118
13119 \end_inset
13120
13121 .
13122  As of 2023 the former has continued to be maintained whereas
13123 \family sans
13124 Foil\SpecialChar TeX
13125
13126 \family default
13127  has not been maintained since 2008.
13128
13129 \change_deleted 564990737 1672743492
13130 by
13131 \noun on
13132 John Weiss
13133 \noun default
13134
13135 \end_layout
13136
13137 \begin_layout Standard
13138
13139 \change_deleted 564990737 1672743492
13140 Introduction
13141 \end_layout
13142
13143 \begin_layout Standard
13144
13145 \change_deleted 564990737 1672743492
13146 This section describes how to use \SpecialChar LyX
13147  to make slides for overhead projectors.
13148  There are two document classes that can do this:
13149  the default slides class and the
13150 \family sans
13151 Foil\SpecialChar TeX
13152
13153 \family default
13154  slides class.
13155  This section documents the former.
13156 \end_layout
13157
13158 \begin_layout Standard
13159
13160 \change_deleted 564990737 1672743492
13161 I'm going to say this again,
13162  nice and clear,
13163  so that there's no misunderstanding:
13164 \end_layout
13165
13166 \begin_layout Standard
13167
13168 \change_deleted 564990737 1672743492
13169 \begin_inset VSpace bigskip
13170 \end_inset
13171
13172
13173 \end_layout
13174
13175 \begin_layout Standard
13176 \align center
13177
13178 \change_deleted 564990737 1672743492
13179
13180 \size large
13181 This section documents the class
13182 \begin_inset Quotes eld
13183 \end_inset
13184
13185
13186 \family sans
13187 slides (default)
13188 \family default
13189
13190 \begin_inset Quotes erd
13191 \end_inset
13192
13193
13194 \emph on
13195 only.
13196 \end_layout
13197
13198 \begin_layout Standard
13199
13200 \change_deleted 564990737 1672743492
13201 \begin_inset VSpace bigskip
13202 \end_inset
13203
13204
13205 \end_layout
13206
13207 \begin_layout Standard
13208
13209 \change_deleted 564990737 1672743492
13210 If you're looking for the documentation for
13211 \begin_inset Quotes eld
13212 \end_inset
13213
13214
13215 \family sans
13216 slides (Foil\SpecialChar TeX
13217 )
13218 \family default
13219
13220 \begin_inset Quotes erd
13221 \end_inset
13222
13223 ,
13224  check out section
13225 \begin_inset space ~
13226 \end_inset
13227
13228
13229 \begin_inset CommandInset ref
13230 LatexCommand ref
13231 reference "sec:foiltex"
13232 nolink "false"
13233
13234 \end_inset
13235
13236 .
13237  The
13238 \family sans
13239 foils
13240 \family default
13241  class [
13242 \begin_inset Quotes eld
13243 \end_inset
13244
13245
13246 \family sans
13247 slides (Foil\SpecialChar TeX
13248 )
13249 \family default
13250
13251 \begin_inset Quotes erd
13252 \end_inset
13253
13254 ] is actually somewhat better than the default
13255 \family sans
13256 slides
13257 \family default
13258  class,
13259 \begin_inset Foot
13260 status collapsed
13261
13262 \begin_layout Plain Layout
13263 \SpecialChar ldots
13264 or so I've been told repeatedly by its advocates.
13265  Having never used it,
13266  I have no idea if this claim is true or not.
13267 \end_layout
13268
13269 \end_inset
13270
13271  which this section documents.
13272 \end_layout
13273
13274 \begin_layout Standard
13275
13276 \change_deleted 564990737 1672743492
13277 This class is the \SpecialChar LaTeX2e
13278  improvement of the old
13279 \noun on
13280 Sli\SpecialChar TeX
13281
13282 \noun default
13283  package.
13284  Every \SpecialChar LaTeX2e
13285  distribution includes this class [which I'll just refer to as
13286 \begin_inset Quotes eld
13287 \end_inset
13288
13289
13290 \family sans
13291 slides
13292 \family default
13293
13294 \begin_inset Quotes erd
13295 \end_inset
13296
13297  from now on],
13298  so you're bound to have it.
13299  As I noted earlier,
13300  there are other classes,
13301  such as
13302 \family sans
13303 foils
13304 \family default
13305 ,
13306  which also produce slides for overhead projectors and do a better job at it.
13307  However,
13308  there are some things which
13309 \family sans
13310 slides
13311 \family default
13312  can do which the others can't,
13313  such as generate overlays.
13314  Read on to learn more!
13315 \change_unchanged
13316
13317 \end_layout
13318
13319 \begin_layout Subsubsection
13320 Getting Started
13321 \begin_inset CommandInset label
13322 LatexCommand label
13323 name "sec:slidesetup"
13324
13325 \end_inset
13326
13327
13328 \end_layout
13329
13330 \begin_layout Standard
13331 Obviously,
13332  to use this document class,
13333  you need to select
13334 \begin_inset Quotes eld
13335 \end_inset
13336
13337
13338 \family sans
13339 slides (default)
13340 \family default
13341
13342 \begin_inset Quotes erd
13343 \end_inset
13344
13345  from the class list in the
13346 \family sans
13347 Document\SpecialChar menuseparator
13348 Settings
13349 \family default
13350  dialog.
13351  There are some other special things you should know about this class:
13352 \end_layout
13353
13354 \begin_layout Itemize
13355 Don't bother changing the options
13356 \family sans
13357 Sides and Columns
13358 \family default
13359 .
13360  They're not supported by the
13361 \family sans
13362 slides
13363 \family default
13364  class,
13365  anyways.
13366 \end_layout
13367
13368 \begin_layout Itemize
13369 The option
13370 \family sans
13371 Page
13372 \begin_inset space ~
13373 \end_inset
13374
13375 style
13376 \family default
13377  behaves a bit differently for this class.
13378  The possible choices and what they do are as follows:
13379 \end_layout
13380
13381 \begin_deeper
13382 \begin_layout Description
13383
13384 \family sans
13385 plain
13386 \family default
13387  The final output contains page numbers in the lower right corner.
13388 \end_layout
13389
13390 \begin_layout Description
13391
13392 \family sans
13393 headings
13394 \family default
13395  Like
13396 \family sans
13397 plain
13398 \family default
13399 ,
13400  but also prints out any time markers you've put in.
13401  This is the default.
13402 \end_layout
13403
13404 \begin_layout Description
13405
13406 \family sans
13407 empty
13408 \family default
13409  The final output contains no page numbers,
13410  time markers,
13411  or alignment markers.
13412 \end_layout
13413
13414 \end_deeper
13415 \begin_layout Itemize
13416 The
13417 \family sans
13418 slides
13419 \family default
13420  class has an extra option:
13421
13422 \family typewriter
13423 clock
13424 \family default
13425 .
13426  To use it,
13427  put
13428 \begin_inset Quotes eld
13429 \end_inset
13430
13431
13432 \family typewriter
13433 clock
13434 \family default
13435
13436 \begin_inset Quotes erd
13437 \end_inset
13438
13439  in the extra class options.
13440 \end_layout
13441
13442 \begin_deeper
13443 \begin_layout Standard
13444 Using this options allows you to add time markers to
13445 \family sans
13446 Note
13447 \family default
13448 s.
13449  See section
13450 \begin_inset space ~
13451 \end_inset
13452
13453
13454 \begin_inset CommandInset ref
13455 LatexCommand ref
13456 reference "sec:slideNote"
13457 nolink "false"
13458
13459 \end_inset
13460
13461  for more details.
13462 \end_layout
13463
13464 \end_deeper
13465 \begin_layout Standard
13466 You can also use the template file
13467 \change_deleted 564990737 1671617694
13468
13469 \begin_inset Quotes eld
13470 \end_inset
13471
13472
13473 \family typewriter
13474 slides.lyx
13475 \family default
13476
13477 \begin_inset Quotes erd
13478 \end_inset
13479
13480
13481 \change_unchanged
13482  to automatically set up a document to use the
13483 \family sans
13484 slides
13485 \family default
13486  class
13487 \change_deleted 564990737 1671617699
13488 [
13489 \change_unchanged
13490 using
13491 \family sans
13492 File\SpecialChar menuseparator
13493 New
13494 \begin_inset space ~
13495 \end_inset
13496
13497 from
13498 \begin_inset space ~
13499 \end_inset
13500
13501 Template
13502 \change_inserted 564990737 1671617723
13503 \SpecialChar menuseparator
13504 Presentations\SpecialChar menuseparator
13505 Slides
13506 \change_unchanged
13507
13508 \family default
13509  to open your new document
13510 \change_deleted 564990737 1671617728
13511 ]
13512 \change_unchanged
13513 .
13514  The template file also contains some examples of the special paragraph environments used by this class.
13515  I'll describe those next.
13516 \end_layout
13517
13518 \begin_layout Subsubsection
13519 Paragraph Environments
13520 \end_layout
13521
13522 \begin_layout Paragraph
13523 Supported Environments
13524 \end_layout
13525
13526 \begin_layout Standard
13527 The first thing you'll notice when you start up a new
13528 \family sans
13529 slides
13530 \family default
13531  document is the font size and type:
13532  it's the equivalent of the size
13533 \begin_inset Quotes eld
13534 \end_inset
13535
13536
13537 \family sans
13538 Largest
13539 \family default
13540
13541 \begin_inset Quotes erd
13542 \end_inset
13543
13544  in the
13545 \family sans
13546 Sans
13547 \begin_inset space ~
13548 \end_inset
13549
13550 Serif
13551 \family default
13552  font.
13553  This is also what's used in the output.
13554  Think of this as a
13555 \begin_inset Quotes eld
13556 \end_inset
13557
13558 visual cue
13559 \begin_inset Quotes erd
13560 \end_inset
13561
13562  to remind you that this is a slide.
13563  Your final slides will use a larger font;
13564  ergo,
13565  you'll have less space.
13566  Of course,
13567  the larger default screen font isn't WYSIWYG,
13568  only a reminder.
13569 \end_layout
13570
13571 \begin_layout Standard
13572 The next thing that becomes obvious is the changes to the paragraph environment pull-down box [at the far-left end of the toolbar].
13573  Most of the paragraph environments you're used to seeing are missing.
13574  There are also five new ones.
13575  That's because the
13576 \family sans
13577 slides
13578 \family default
13579  class itself only supports certain paragraph environments:
13580 \end_layout
13581
13582 \begin_layout Itemize
13583
13584 \family sans
13585 Standard
13586 \end_layout
13587
13588 \begin_layout Itemize
13589
13590 \family sans
13591 Itemize
13592 \end_layout
13593
13594 \begin_layout Itemize
13595
13596 \family sans
13597 Enumerate
13598 \end_layout
13599
13600 \begin_layout Itemize
13601
13602 \family sans
13603 Description
13604 \end_layout
13605
13606 \begin_layout Itemize
13607
13608 \family sans
13609 List
13610 \end_layout
13611
13612 \begin_layout Itemize
13613
13614 \family sans
13615 Quotation
13616 \end_layout
13617
13618 \begin_layout Itemize
13619
13620 \family sans
13621 Quote
13622 \end_layout
13623
13624 \begin_layout Itemize
13625
13626 \family sans
13627 Verse
13628 \end_layout
13629
13630 \begin_layout Itemize
13631
13632 \family sans
13633 Caption
13634 \end_layout
13635
13636 \begin_layout Itemize
13637
13638 \family sans
13639 \SpecialChar LyX
13640 -Code
13641 \end_layout
13642
13643 \begin_layout Standard
13644 All of the other standard environments,
13645  including the section-heading environments,
13646  aren't used in the
13647 \family sans
13648 slides
13649 \family default
13650  class.
13651 \end_layout
13652
13653 \begin_layout Standard
13654 On the other hand,
13655  you'll notice the following new environments:
13656 \end_layout
13657
13658 \begin_layout Itemize
13659
13660 \family sans
13661 Slide
13662 \end_layout
13663
13664 \begin_layout Itemize
13665
13666 \family sans
13667 Overlay
13668 \end_layout
13669
13670 \begin_layout Itemize
13671
13672 \family sans
13673 Note
13674 \end_layout
13675
13676 \begin_layout Itemize
13677
13678 \family sans
13679 InvisibleText
13680 \end_layout
13681
13682 \begin_layout Itemize
13683
13684 \family sans
13685 VisibleText
13686 \end_layout
13687
13688 \begin_layout Standard
13689 These five are kind of quirky,
13690  due to a
13691 \begin_inset Quotes eld
13692 \end_inset
13693
13694 feature
13695 \begin_inset Quotes erd
13696 \end_inset
13697
13698  in \SpecialChar LyX
13699 .
13700  You see,
13701  \SpecialChar LyX
13702  doesn't permit you to nest any other paragraph environment into an empty environment.
13703  Now,
13704  that's fine and dandy,
13705  but it means that you wouldn't be able to start a slide with anything except plain text.
13706  To deal with this,
13707  I've performed a little
13708 \begin_inset Quotes eld
13709 \end_inset
13710
13711 \SpecialChar LaTeX
13712  magic.
13713 \begin_inset Quotes erd
13714 \end_inset
13715
13716
13717 \end_layout
13718
13719 \begin_layout Paragraph
13720 Quirks of the New Environments
13721 \begin_inset CommandInset label
13722 LatexCommand label
13723 name "sec:slideQuirk"
13724
13725 \end_inset
13726
13727
13728 \end_layout
13729
13730 \begin_layout Standard
13731 All five of the new paragraph environments are somewhat quirky due to inherent limitiations in the current version of \SpecialChar LyX
13732 .
13733  As I just mentioned,
13734  \SpecialChar LyX
13735  forbids environments that begin with another environment.
13736  To get around this,
13737  the
13738 \family sans
13739 Slide
13740 \family default
13741  environment isn't a paragraph environment as described in the
13742 \emph on
13743 User's Guide
13744 \emph default
13745 .
13746
13747 \end_layout
13748
13749 \begin_layout Standard
13750 You should consider
13751 \family sans
13752 Slide
13753 \family default
13754 ,
13755
13756 \family sans
13757 Overlay
13758 \family default
13759 ,
13760  and
13761 \family sans
13762 Note
13763 \family default
13764  to be
13765 \begin_inset Quotes eld
13766 \end_inset
13767
13768 pseudo-environments.
13769 \begin_inset Quotes erd
13770 \end_inset
13771
13772  They look like a section heading or a
13773 \begin_inset Quotes eld
13774 \end_inset
13775
13776
13777 \family sans
13778 Caption
13779 \family default
13780 ,
13781 \begin_inset Quotes erd
13782 \end_inset
13783
13784  but really begin a [and,
13785  if necessary,
13786  end the previous] paragraph environment.
13787  Likewise,
13788  treat
13789 \family sans
13790 InvisibleText
13791 \family default
13792  and
13793 \family sans
13794 VisibleText
13795 \family default
13796  as
13797 \begin_inset Quotes eld
13798 \end_inset
13799
13800 pseudo-commands.
13801 \begin_inset Quotes erd
13802 \end_inset
13803
13804  These two perform some action.
13805 \end_layout
13806
13807 \begin_layout Standard
13808 A common feature of all five environments,
13809
13810 \family sans
13811 Slide
13812 \family default
13813 ,
13814
13815 \family sans
13816 Overlay
13817 \family default
13818 ,
13819
13820 \family sans
13821 Note
13822 \family default
13823 ,
13824
13825 \family sans
13826 InvisibleText
13827 \family default
13828  and
13829 \family sans
13830 VisibleText
13831 \family default
13832 ,
13833  is a rather long-ish label.
13834  The text following this label —
13835  ordinarily the contents of the paragraph environment —
13836  is utterly irrelevant for
13837 \family sans
13838 Slide
13839 \family default
13840 ,
13841
13842 \family sans
13843 Overlay
13844 \family default
13845 ,
13846
13847 \family sans
13848 Note
13849 \family default
13850 ,
13851
13852 \family sans
13853 InvisibleText
13854 \family default
13855  and
13856 \family sans
13857 VisibleText
13858 \family default
13859 .
13860  \SpecialChar LyX
13861  completely ignores it.
13862  In fact,
13863  you can leave these five environments completely empty.
13864
13865 \end_layout
13866
13867 \begin_layout Standard
13868 While you don't
13869 \emph on
13870 have
13871 \emph default
13872  to put any text after the rather long-ish label,
13873  you might want to.
13874  This could be a short description of the contents of the
13875 \family sans
13876 Slide
13877 \family default
13878 ,
13879  for example.
13880  In that case,
13881  enter your descriptive comment and hit
13882 \family sans
13883 Return
13884 \family default
13885  as you normally would.
13886 \end_layout
13887
13888 \begin_layout Standard
13889 If,
13890  on the other hand,
13891  you don't want to enter any descriptive text,
13892  you'll hit another \SpecialChar LyX
13893  quirk.
13894  \SpecialChar LyX
13895 ,
13896  like nature,
13897  abhors a vacuum,
13898  and will not let you start a new paragraph environment until you put something in the old one.
13899  So,
13900  do this:
13901 \end_layout
13902
13903 \begin_layout Itemize
13904 Start entering the text that will
13905 \emph on
13906 follow
13907 \emph default
13908  the new
13909 \family sans
13910 Slide
13911 \family default
13912 ,
13913
13914 \family sans
13915 Overlay
13916 \family default
13917 ,
13918
13919 \family sans
13920 Note
13921 \family default
13922 ,
13923
13924 \family sans
13925 InvisibleText
13926 \family default
13927  or
13928 \family sans
13929 VisibleText
13930 \family default
13931 .
13932
13933 \end_layout
13934
13935 \begin_layout Itemize
13936 Now move to the beginning of that paragraph.
13937
13938 \end_layout
13939
13940 \begin_layout Itemize
13941 Next,
13942  hit
13943 \family sans
13944 Return
13945 \family default
13946 .
13947
13948 \end_layout
13949
13950 \begin_layout Itemize
13951 Finally,
13952  change this new,
13953  empty paragraph to a
13954 \family sans
13955 Slide
13956 \family default
13957 ,
13958
13959 \family sans
13960 Overlay
13961 \family default
13962 ,
13963
13964 \family sans
13965 Note
13966 \family default
13967 ,
13968
13969 \family sans
13970 InvisibleText
13971 \family default
13972  or
13973 \family sans
13974 VisibleText
13975 \family default
13976 .
13977
13978 \end_layout
13979
13980 \begin_layout Standard
13981 Some future version of \SpecialChar LyX
13982  will,
13983  hopefully,
13984  resolve this quirkiness\SpecialChar ldots
13985
13986 \end_layout
13987
13988 \begin_layout Subsubsection
13989 Making a Presentation with
13990 \family sans
13991 Slide
13992 \family default
13993 ,
13994
13995 \family sans
13996 Overlay
13997 \family default
13998  and
13999 \family sans
14000 Note
14001 \end_layout
14002
14003 \begin_layout Paragraph
14004 Using the
14005 \family sans
14006 Slide
14007 \family default
14008  Environment
14009 \end_layout
14010
14011 \begin_layout Standard
14012 If you're expecting this section to teach you how to actually make a presentation,
14013  you'll be sorely disappointed.
14014  Naturally,
14015  I'll describe all of the ways the
14016 \family sans
14017 slides
14018 \family default
14019  class can assist you in preparing the materials for a presentation.
14020  Filling in the contents,
14021  however,
14022  is up to you.
14023  [Then again,
14024  that
14025 \emph on
14026 is
14027 \emph default
14028  the \SpecialChar LyX
14029  philosophy.]
14030 \end_layout
14031
14032 \begin_layout Standard
14033 Choosing the
14034 \family sans
14035 Slide
14036 \family default
14037  environment [in the manner described in section
14038 \begin_inset space ~
14039 \end_inset
14040
14041
14042 \begin_inset CommandInset ref
14043 LatexCommand ref
14044 reference "sec:slideQuirk"
14045 nolink "false"
14046
14047 \end_inset
14048
14049 ] tells \SpecialChar LyX
14050  to begin a new slide [duh].
14051  The label for this environment/
14052 \begin_inset Quotes erd
14053 \end_inset
14054
14055 pseudo-command
14056 \begin_inset Quotes erd
14057 \end_inset
14058
14059  is an
14060 \begin_inset Quotes eld
14061 \end_inset
14062
14063 ASCII line,
14064 \begin_inset Quotes erd
14065 \end_inset
14066
14067  in cool blue,
14068  followed by the label,
14069
14070 \begin_inset Quotes eld
14071 \end_inset
14072
14073 NewSlide:
14074 \begin_inset Quotes erd
14075 \end_inset
14076
14077 .
14078  Any text or paragraph environments that follow this one go on the new slide.
14079  It's that simple.
14080 \end_layout
14081
14082 \begin_layout Standard
14083 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
14084  (this can be specified in the
14085 \family sans
14086 Paragraph Layout
14087 \family default
14088  dialog).
14089  In fact,
14090  you'll want to,
14091  once you finish entering the contents of one slide.
14092  If you've entered more text than can physically fit on a slide,
14093  the extra overflows onto a new slide.
14094  I don't recommend doing this,
14095  however,
14096  since the overflow slide won't have any page number on it.
14097  Furthermore,
14098  it may interfere with any
14099 \family sans
14100 Overlay
14101 \family default
14102  you've made to accompany the oversized
14103 \family sans
14104 Slide
14105 \family default
14106 .
14107 \end_layout
14108
14109 \begin_layout Standard
14110 The
14111 \family sans
14112 Overlay
14113 \family default
14114  and
14115 \family sans
14116 Note
14117 \family default
14118  environments work the same way as the
14119 \family sans
14120 Slide
14121 \family default
14122  environment.
14123  They both create an
14124 \begin_inset Quotes eld
14125 \end_inset
14126
14127 ASCII line
14128 \begin_inset Quotes erd
14129 \end_inset
14130
14131  followed by a label [
14132 \begin_inset Quotes eld
14133 \end_inset
14134
14135 NewOverlay:
14136 \begin_inset Quotes erd
14137 \end_inset
14138
14139  and
14140 \begin_inset Quotes eld
14141 \end_inset
14142
14143 NewNote:
14144 \begin_inset Quotes erd
14145 \end_inset
14146
14147 ,
14148  respectively].
14149  The color is a stunning magenta instead of blue,
14150  and the
14151 \begin_inset Quotes eld
14152 \end_inset
14153
14154 ASCII line
14155 \begin_inset Quotes erd
14156 \end_inset
14157
14158  will look different,
14159  in style and in length.
14160  The label fonts of all three also differ from one another.
14161 \end_layout
14162
14163 \begin_layout Standard
14164 As with a
14165 \family sans
14166 Slide
14167 \family default
14168 ,
14169  if the contents of a
14170 \family sans
14171 Note
14172 \family default
14173  or
14174 \family sans
14175 Overlay
14176 \family default
14177  exceed the physical size of a slide or sheet of paper,
14178  the extra will overflow onto a new sheet.
14179  Again,
14180  you should avoid this.
14181  It defeats the whole purpose of
14182 \family sans
14183 Note
14184 \family default
14185 s and
14186 \family sans
14187 Overlay
14188 \family default
14189 s.
14190 \end_layout
14191
14192 \begin_layout Paragraph
14193 Using
14194 \family sans
14195 Overlay
14196 \family default
14197  with
14198 \family sans
14199 Slide
14200 \end_layout
14201
14202 \begin_layout Standard
14203 The idea behind an
14204 \family sans
14205 Overlay
14206 \family default
14207  is a slide that sits atop another slide.
14208  Perhaps you wish to discuss a figure on the main
14209 \family sans
14210 Slide
14211 \family default
14212  before displaying the text associated with it.
14213  One way to accomplish this is tape a flap of dark paper over the part of the
14214 \family sans
14215 Slide
14216 \family default
14217  you want to display later.
14218  This method fails,
14219  however,
14220  if you wish to overlap one graph with another,
14221  for example.
14222  You would then have to fumble while speaking to align the two separate,
14223  overlapping
14224 \family sans
14225 Slide
14226 \family default
14227 s to align the two graphs.
14228  The use of an
14229 \family sans
14230 Overlay
14231 \family default
14232  environment in both cases makes life much easier.
14233 \end_layout
14234
14235 \begin_layout Standard
14236 Each
14237 \family sans
14238 Overlay
14239 \family default
14240  receives the page number of its
14241 \begin_inset Quotes eld
14242 \end_inset
14243
14244 parent
14245 \begin_inset Quotes erd
14246 \end_inset
14247
14248
14249 \family sans
14250 Slide
14251 \family default
14252 ,
14253  appended by
14254 \begin_inset Quotes eld
14255 \end_inset
14256
14257
14258 \family typewriter
14259 -a
14260 \family default
14261
14262 \begin_inset Quotes erd
14263 \end_inset
14264
14265 .
14266 \begin_inset Foot
14267 status collapsed
14268
14269 \begin_layout Plain Layout
14270 Presumably,
14271  mutliple
14272 \family sans
14273 Overlay
14274 \family default
14275 s would have
14276 \begin_inset Quotes eld
14277 \end_inset
14278
14279
14280 \family typewriter
14281 -a
14282 \family default
14283
14284 \begin_inset Quotes erd
14285 \end_inset
14286
14287 ,
14288
14289 \begin_inset Quotes eld
14290 \end_inset
14291
14292
14293 \family typewriter
14294 -b
14295 \family default
14296
14297 \begin_inset Quotes erd
14298 \end_inset
14299
14300 ,
14301
14302 \begin_inset Quotes eld
14303 \end_inset
14304
14305
14306 \family typewriter
14307 -c
14308 \family default
14309
14310 \begin_inset Quotes erd
14311 \end_inset
14312
14313 ,
14314  etc.
14315 \begin_inset space ~
14316 \end_inset
14317
14318 appended to the page number of the parent
14319 \family sans
14320 Slide
14321 \family default
14322 .
14323
14324 \end_layout
14325
14326 \end_inset
14327
14328  Clearly,
14329  you want the contents of both the
14330 \family sans
14331 Slide
14332 \family default
14333  and the
14334 \family sans
14335 Overlay
14336 \family default
14337  to each fit on a single physical slide!
14338  You should probably consider an
14339 \family sans
14340 Overlay
14341 \family default
14342  as
14343 \begin_inset Quotes eld
14344 \end_inset
14345
14346 part of
14347 \begin_inset Quotes erd
14348 \end_inset
14349
14350  a
14351 \family sans
14352 Slide
14353 \family default
14354 .
14355  Indeed,
14356  the \SpecialChar LyX
14357
14358 \family sans
14359 slides
14360 \family default
14361  class provides a visual cue for this:
14362  the label at the start of an
14363 \family sans
14364 Overlay
14365 \family default
14366  is shorter than that at the start of a
14367 \family sans
14368 Slide
14369 \family default
14370 .
14371  Lastly,
14372  when you generate printable output,
14373  you'll find alignment markers in all four corners of both the
14374 \family sans
14375 Overlay
14376 \family default
14377  page and its parent
14378 \family sans
14379 Slide
14380 \family default
14381 .
14382  These will assist you in lining up the two physical slides.
14383 \end_layout
14384
14385 \begin_layout Standard
14386 The major problem in overlaying two slides is aligning the contents of the two transparencies.
14387  How much space should you leave for that graph on the second slide?
14388  Worse still,
14389  what if you want a graph and a sentence on second slide,
14390  but there is text on the main transparency that goes in between them?
14391  You could try and insert vertical space of the right size.
14392  The better way is to use
14393 \family sans
14394 InvisibleText
14395 \family default
14396  and
14397 \family sans
14398 VisibleText
14399 \family default
14400 .
14401 \end_layout
14402
14403 \begin_layout Standard
14404 As their names imply,
14405
14406 \family sans
14407 InvisibleText
14408 \family default
14409  and
14410 \family sans
14411 VisibleText
14412 \family default
14413  are two command-like paragraph environments that make all subsequent text invisible and visible,
14414  respectively.
14415  Note from section
14416 \begin_inset space ~
14417 \end_inset
14418
14419
14420 \begin_inset CommandInset ref
14421 LatexCommand ref
14422 reference "sec:slideQuirk"
14423 nolink "false"
14424
14425 \end_inset
14426
14427  that you don't place anything
14428 \emph on
14429 into
14430 \emph default
14431  these two environments,
14432  however.
14433  When you create an
14434 \family sans
14435 InvisibleText
14436 \family default
14437 ,
14438  it inserts a centered,
14439  sky-blue label into the page reading
14440 \begin_inset Quotes eld
14441 \end_inset
14442
14443 <Invisible Text Follows>
14444 \begin_inset Quotes erd
14445 \end_inset
14446
14447 .
14448  For paragraphs following this label,
14449  the parts of the
14450 \family sans
14451 Slide
14452 \family default
14453  [or
14454 \family sans
14455 Overlay
14456 \family default
14457 ;
14458  it doesn't matter which] where they would be contain instead blank space.
14459
14460 \end_layout
14461
14462 \begin_layout Standard
14463 For
14464 \family sans
14465 VisibleText
14466 \family default
14467 ,
14468  the corresponding centered label is
14469 \begin_inset Quotes eld
14470 \end_inset
14471
14472 <Visible Text Follows>
14473 \begin_inset Quotes erd
14474 \end_inset
14475
14476  in blazing green.
14477  Paragraphs following this label behave normally.
14478  Note that the beginning of a new
14479 \family sans
14480 Slide
14481 \family default
14482 ,
14483
14484 \family sans
14485 Overlay
14486 \family default
14487 ,
14488  or
14489 \family sans
14490 Note
14491 \family default
14492  automatically shuts off an
14493 \family sans
14494 InvisibleText
14495 \family default
14496 .
14497  It's therefore not necessary to use
14498 \family sans
14499 VisibleText
14500 \family default
14501  at the end of a
14502 \family sans
14503 Slide
14504 \family default
14505 .
14506 \end_layout
14507
14508 \begin_layout Standard
14509 By now,
14510  it should be obvious how to create overlay transparencies using the proper combination of
14511 \family sans
14512 InvisibleText
14513 \family default
14514  and
14515 \family sans
14516 VisibleText
14517 \family default
14518  on a
14519 \family sans
14520 Slide
14521 \family default
14522  and
14523 \family sans
14524 Overlay
14525 \family default
14526 :
14527 \end_layout
14528
14529 \begin_layout Enumerate
14530 Create a
14531 \family sans
14532 Slide
14533 \family default
14534 ,
14535  including everything that will appear on it,
14536  whether on the main slide or on the
14537 \family sans
14538 Overlay
14539 \family default
14540 .
14541 \end_layout
14542
14543 \begin_layout Enumerate
14544 Before each figure or paragraph that will appear only on the
14545 \family sans
14546 Overlay
14547 \family default
14548 ,
14549  insert an
14550 \family sans
14551 InvisibleText
14552 \family default
14553  environment.
14554  If necessary,
14555  insert a
14556 \family sans
14557 VisibleText
14558 \family default
14559  environment after the
14560 \family sans
14561 Overlay
14562 \family default
14563 -only text.
14564 \end_layout
14565
14566 \begin_layout Enumerate
14567 Start an
14568 \family sans
14569 Overlay
14570 \family default
14571  immediately following the
14572 \family sans
14573 Slide
14574 \family default
14575 .
14576 \end_layout
14577
14578 \begin_layout Enumerate
14579 Copy the contents of this
14580 \family sans
14581 Slide
14582 \family default
14583  into the
14584 \family sans
14585 Overlay
14586 \family default
14587 .
14588 \end_layout
14589
14590 \begin_layout Enumerate
14591 Within the
14592 \family sans
14593 Overlay
14594 \family default
14595 ,
14596  change all of the
14597 \family sans
14598 InvisibleText
14599 \family default
14600  lines to
14601 \family sans
14602 VisibleText
14603 \family default
14604  and vice-versa.
14605 \end_layout
14606
14607 \begin_layout Standard
14608 That's it.
14609  You've just made an
14610 \family sans
14611 Overlay
14612 \family default
14613 .
14614 \end_layout
14615
14616 \begin_layout Standard
14617 There's one problem with the way I've designed the \SpecialChar LyX
14618
14619 \family sans
14620 slides
14621 \family default
14622  class:
14623  you can't make text in the middle of a paragraph invisible,
14624  nor make text in the middle of an invisible paragraph visible again.
14625  To accomplish this feat,
14626  you'll need to use some inlined \SpecialChar LaTeX
14627  codes.
14628 \begin_inset Foot
14629 status collapsed
14630
14631 \begin_layout Plain Layout
14632 The commands of interest are:
14633
14634 \end_layout
14635
14636 \begin_layout Itemize
14637
14638 \family typewriter
14639 {
14640 \backslash
14641 invisible \SpecialChar ldots
14642  }
14643 \end_layout
14644
14645 \begin_layout Itemize
14646
14647 \family typewriter
14648 {
14649 \backslash
14650 visible \SpecialChar ldots
14651  }
14652 \end_layout
14653
14654 \begin_layout Plain Layout
14655 \SpecialChar ldots
14656 and need to be marked as \SpecialChar TeX
14657 .
14658  The text whose
14659 \begin_inset Quotes eld
14660 \end_inset
14661
14662 visibility
14663 \begin_inset Quotes erd
14664 \end_inset
14665
14666  you wish to change goes in between the brackets [and after the
14667 \family typewriter
14668
14669 \backslash
14670 invisible
14671 \family default
14672  or
14673 \family typewriter
14674
14675 \backslash
14676 visible
14677 \family default
14678  command].
14679  If you don't know how to mark text as \SpecialChar TeX
14680 ,
14681  see the appropriate section of the
14682 \emph on
14683 User's Guide
14684 \emph default
14685 .
14686 \end_layout
14687
14688 \end_inset
14689
14690
14691 \end_layout
14692
14693 \begin_layout Paragraph
14694 Using
14695 \family sans
14696 Note
14697 \family default
14698  with
14699 \family sans
14700 Slide
14701 \family default
14702
14703 \begin_inset CommandInset label
14704 LatexCommand label
14705 name "sec:slideNote"
14706
14707 \end_inset
14708
14709
14710 \end_layout
14711
14712 \begin_layout Standard
14713 Like an
14714 \family sans
14715 Overlay
14716 \family default
14717 ,
14718  a
14719 \family sans
14720 Note
14721 \family default
14722  is associated with a
14723 \begin_inset Quotes eld
14724 \end_inset
14725
14726 parent
14727 \begin_inset Quotes erd
14728 \end_inset
14729
14730
14731 \family sans
14732 Slide
14733 \family default
14734 .
14735  Here,
14736  too,
14737  the \SpecialChar LyX
14738
14739 \family sans
14740 slides
14741 \family default
14742  class provides visual cues.
14743  The label for a
14744 \family sans
14745 Note
14746 \family default
14747  is shorter than that of a
14748 \family sans
14749 Slide
14750 \family default
14751  [yet longer than that of an
14752 \family sans
14753 Overlay
14754 \family default
14755 ] and,
14756  like the label of an
14757 \family sans
14758 Overlay
14759 \family default
14760  is shockingly magenta.
14761  Additionally,
14762  the printed
14763 \family sans
14764 Note
14765 \family default
14766  has the page number of its
14767 \begin_inset Quotes eld
14768 \end_inset
14769
14770 parent
14771 \begin_inset Quotes erd
14772 \end_inset
14773
14774
14775 \family sans
14776 Slide
14777 \family default
14778 ,
14779  appended by
14780 \begin_inset Quotes eld
14781 \end_inset
14782
14783
14784 \family typewriter
14785 -
14786 \family default
14787 1
14788 \begin_inset Quotes erd
14789 \end_inset
14790
14791 ,
14792
14793 \begin_inset Quotes eld
14794 \end_inset
14795
14796
14797 \family typewriter
14798 -
14799 \family default
14800 2
14801 \begin_inset Quotes erd
14802 \end_inset
14803
14804 ,
14805
14806 \begin_inset Quotes eld
14807 \end_inset
14808
14809
14810 \family typewriter
14811 -
14812 \family default
14813 3
14814 \begin_inset Quotes erd
14815 \end_inset
14816
14817 ,
14818  etc.
14819  You can have multiple
14820 \family sans
14821 Note
14822 \family default
14823 s associated with a single
14824 \family sans
14825 Slide
14826 \family default
14827 ,
14828  and,
14829  as with
14830 \family sans
14831 Slide
14832 \family default
14833  and
14834 \family sans
14835 Overlay
14836 \family default
14837 ,
14838  you'll probably want to break up long
14839 \family sans
14840 Note
14841 \family default
14842 s so that they fit on a single sheet of paper.
14843 \end_layout
14844
14845 \begin_layout Standard
14846 The purpose of a
14847 \family sans
14848 Note
14849 \family default
14850  is obvious:
14851  it contains anything additional you might want to say about a
14852 \family sans
14853 Slide
14854 \family default
14855 .
14856  It could also be used as a sheet of reminders for a particular
14857 \family sans
14858 Slide
14859 \family default
14860 .
14861  In the case of the latter,
14862  you might want to make use of time markers.
14863  Currently,
14864  the \SpecialChar LyX
14865
14866 \family sans
14867 slides
14868 \family default
14869  class has no
14870 \begin_inset Quotes eld
14871 \end_inset
14872
14873 native
14874 \begin_inset Quotes erd
14875 \end_inset
14876
14877  support for time markers,
14878  a
14879 \noun on
14880 Sli\SpecialChar TeX
14881
14882 \noun default
14883  feature.
14884  So,
14885  you'll have to resort to using the \SpecialChar LaTeX
14886  codes.
14887 \end_layout
14888
14889 \begin_layout Standard
14890 To use time markers,
14891  you'll need to specify the extra class option
14892 \begin_inset Quotes eld
14893 \end_inset
14894
14895
14896 \family typewriter
14897 clock
14898 \family default
14899
14900 \begin_inset Quotes erd
14901 \end_inset
14902
14903  [see section
14904 \begin_inset space ~
14905 \end_inset
14906
14907
14908 \begin_inset CommandInset ref
14909 LatexCommand ref
14910 reference "sec:slidesetup"
14911 nolink "false"
14912
14913 \end_inset
14914
14915 ].
14916  This option turns on timing marks,
14917  which will appear in the lower-left-hand corner of every
14918 \family sans
14919 Note
14920 \family default
14921  you generate.
14922  To set what appears in the time marker,
14923  you use the \SpecialChar LaTeX
14924  commands
14925 \begin_inset Quotes eld
14926 \end_inset
14927
14928
14929 \family typewriter
14930
14931 \backslash
14932 settime{}
14933 \family default
14934
14935 \begin_inset Quotes erd
14936 \end_inset
14937
14938  and
14939 \begin_inset Quotes eld
14940 \end_inset
14941
14942
14943 \family typewriter
14944
14945 \backslash
14946 addtime{}
14947 \family default
14948
14949 \begin_inset Quotes erd
14950 \end_inset
14951
14952 .
14953  The arguments of both commands are time measured in seconds.
14954
14955 \begin_inset Quotes eld
14956 \end_inset
14957
14958
14959 \family typewriter
14960
14961 \backslash
14962 settime{}
14963 \family default
14964
14965 \begin_inset Quotes erd
14966 \end_inset
14967
14968  sets the time marker to a given time.
14969
14970 \begin_inset Quotes eld
14971 \end_inset
14972
14973
14974 \family typewriter
14975
14976 \backslash
14977 addtime{}
14978 \family default
14979
14980 \begin_inset Quotes erd
14981 \end_inset
14982
14983  increments the time marker by the specified amount.
14984  Using time markers and
14985 \family sans
14986 Note
14987 \family default
14988 s in this fashion,
14989  you can remind yourself how much time to spend on a particular
14990 \family sans
14991 Slide
14992 \family default
14993 .
14994 \end_layout
14995
14996 \begin_layout Standard
14997 There's one last feature to describe.
14998  Clearly,
14999  you'd like to print out all of your
15000 \family sans
15001 Slide
15002 \family default
15003 s and
15004 \family sans
15005 Overlay
15006 \family default
15007 s on transparencies while printing all of your
15008 \family sans
15009 Note
15010 \family default
15011 s on plain paper.
15012  However,
15013  a
15014 \family sans
15015 Note
15016 \family default
15017
15018 \emph on
15019 must
15020 \emph default
15021  follow the
15022 \family sans
15023 Slide
15024 \family default
15025  with which it is associated.
15026  What's a person to do?
15027 \end_layout
15028
15029 \begin_layout Standard
15030 Luckily,
15031  there are two \SpecialChar LaTeX
15032  commands that allow you to select what to print out.
15033  Both must be placed into the preamble of your document.
15034  The command
15035 \begin_inset Quotes eld
15036 \end_inset
15037
15038
15039 \family typewriter
15040
15041 \backslash
15042 onlyslides{
15043 \backslash
15044 slides}
15045 \family default
15046
15047 \begin_inset Quotes erd
15048 \end_inset
15049
15050  will cause the output to contain only the
15051 \family sans
15052 Slide
15053 \family default
15054 s and
15055 \family sans
15056 Overlay
15057 \family default
15058 s.
15059  Correspondingly,
15060  the command
15061 \begin_inset Quotes eld
15062 \end_inset
15063
15064
15065 \family typewriter
15066
15067 \backslash
15068 onlynotes{
15069 \backslash
15070 notes}
15071 \family default
15072
15073 \begin_inset Quotes erd
15074 \end_inset
15075
15076  prevents the output of anything but
15077 \family sans
15078 Note
15079 \family default
15080 s.
15081  I'd advise placing both commands in the preamble and initially comment both out.
15082  You can then preview your entire presentation as you write.
15083  When you're done writing,
15084  you can then uncomment one of the two to select what you want to print.
15085  I like to uncomment
15086 \begin_inset Quotes eld
15087 \end_inset
15088
15089
15090 \family typewriter
15091
15092 \backslash
15093 onlyslides{
15094 \backslash
15095 slides}
15096 \family default
15097
15098 \begin_inset Quotes erd
15099 \end_inset
15100
15101  ,
15102  print to a file with
15103 \begin_inset Quotes eld
15104 \end_inset
15105
15106
15107 \family typewriter
15108 -slides
15109 \family default
15110
15111 \begin_inset Quotes erd
15112 \end_inset
15113
15114  in its name,
15115  comment it back out,
15116  then uncomment
15117 \begin_inset Quotes eld
15118 \end_inset
15119
15120
15121 \family typewriter
15122
15123 \backslash
15124 onlynotes{
15125 \backslash
15126 notes}
15127 \family default
15128
15129 \begin_inset Quotes erd
15130 \end_inset
15131
15132  and print to a
15133 \begin_inset Quotes eld
15134 \end_inset
15135
15136
15137 \family typewriter
15138 *-notes.ps
15139 \family default
15140
15141 \begin_inset Quotes erd
15142 \end_inset
15143
15144  file.
15145  I can then send either file to a printer,
15146  loading transparencies or plain paper as appropriate.
15147 \end_layout
15148
15149 \begin_layout Standard
15150 You can also provide other arguments to the
15151 \begin_inset Quotes eld
15152 \end_inset
15153
15154
15155 \family typewriter
15156
15157 \backslash
15158 onlyslides{}
15159 \family default
15160
15161 \begin_inset Quotes erd
15162 \end_inset
15163
15164  and
15165 \begin_inset Quotes eld
15166 \end_inset
15167
15168
15169 \family typewriter
15170
15171 \backslash
15172 onlynotes{}
15173 \family default
15174
15175 \begin_inset Quotes erd
15176 \end_inset
15177
15178  commands.
15179  See a good \SpecialChar LaTeX
15180  book for details.
15181 \end_layout
15182
15183 \begin_layout Subsubsection
15184 The
15185 \family sans
15186 slides
15187 \family default
15188  Class Template File
15189 \end_layout
15190
15191 \begin_layout Standard
15192 I have also provided a template file
15193 \change_deleted 564990737 1671617750
15194 ,
15195
15196 \begin_inset Quotes eld
15197 \end_inset
15198
15199
15200 \family typewriter
15201 slides.lyx
15202 \family default
15203
15204 \begin_inset Quotes erd
15205 \end_inset
15206
15207 ,
15208
15209 \change_unchanged
15210  with the
15211 \family sans
15212 slides
15213 \family default
15214  class.
15215  To use it,
15216  begin your new presentation with
15217 \family sans
15218 File\SpecialChar menuseparator
15219 New
15220 \begin_inset space ~
15221 \end_inset
15222
15223 from
15224 \begin_inset space ~
15225 \end_inset
15226
15227 Template
15228 \change_inserted 564990737 1671616988
15229 \SpecialChar menuseparator
15230 Presentations\SpecialChar menuseparator
15231 Slides
15232 \change_unchanged
15233
15234 \family default
15235 .
15236  Your new \SpecialChar LyX
15237  presentation file will contain an example
15238 \family sans
15239 Slide
15240 \family default
15241  –
15242 \family sans
15243 Overlay
15244 \family default
15245  –
15246 \family sans
15247 Note
15248 \family default
15249  triplet.
15250  The
15251 \family sans
15252 Slide
15253 \family default
15254  and
15255 \family sans
15256 Overlay
15257 \family default
15258  additionally contain an example of the use of
15259 \family sans
15260 InvisibleText
15261 \family default
15262  and
15263 \family sans
15264 VisibleText
15265 \family default
15266 .
15267  Lastly,
15268  the preamble will contain:
15269 \end_layout
15270
15271 \begin_layout LyX-Code
15272 % Uncomment to print out only slides and overlays
15273 \end_layout
15274
15275 \begin_layout LyX-Code
15276 %
15277 \end_layout
15278
15279 \begin_layout LyX-Code
15280 %
15281 \backslash
15282 onlyslides{
15283 \backslash
15284 slides}
15285 \begin_inset Newline newline
15286 \end_inset
15287
15288
15289 \end_layout
15290
15291 \begin_layout LyX-Code
15292 % Uncomment to print out only notes
15293 \end_layout
15294
15295 \begin_layout LyX-Code
15296 %
15297 \end_layout
15298
15299 \begin_layout LyX-Code
15300 %
15301 \backslash
15302 onlynotes{
15303 \backslash
15304 notes}
15305 \end_layout
15306
15307 \begin_layout Standard
15308 One final thing:
15309  I created this class to support the \SpecialChar LaTeX2e
15310
15311 \begin_inset Quotes eld
15312 \end_inset
15313
15314
15315 \noun on
15316 Sli\SpecialChar TeX
15317
15318 \noun default
15319  emulation
15320 \begin_inset Quotes erd
15321 \end_inset
15322
15323  class,
15324  one of the built-in \SpecialChar LaTeX2e
15325  classes.
15326  Neither I nor the rest of the \SpecialChar LyX
15327  Team endorse or oppose the use of this built-in slide class.
15328  It's here if you want it or need it.
15329  There exist other \SpecialChar LaTeX2e
15330  classes for creating presentations,
15331  such as the
15332 \family sans
15333 Foils
15334 \family default
15335  class [see section
15336 \begin_inset space ~
15337 \end_inset
15338
15339
15340 \begin_inset CommandInset ref
15341 LatexCommand ref
15342 reference "sec:foiltex"
15343 nolink "false"
15344
15345 \end_inset
15346
15347 ] or the
15348 \begin_inset Quotes eld
15349 \end_inset
15350
15351
15352 \family typewriter
15353 seminar
15354 \family default
15355
15356 \begin_inset Quotes erd
15357 \end_inset
15358
15359  package [present on some \SpecialChar TeX
15360  distributions].
15361  The latter is not yet supported under \SpecialChar LyX
15362 .
15363 \begin_inset Foot
15364 status collapsed
15365
15366 \begin_layout Plain Layout
15367 Perhaps you can take on the task\SpecialChar ldots
15368
15369 \end_layout
15370
15371 \end_inset
15372
15373  I know nothing about these other classes.
15374  Try them out to see what sort of alternative they provide.
15375 \end_layout
15376
15377 \begin_layout Section
15378
15379 \change_inserted 564990737 1670439661
15380 Reports
15381 \end_layout
15382
15383 \begin_layout Subsection
15384
15385 \change_inserted 564990737 1670439661
15386 report
15387 \end_layout
15388
15389 \begin_layout Standard
15390
15391 \change_inserted 564990737 1670439661
15392 The document class
15393 \family sans
15394 report
15395 \family default
15396  provides the
15397 \family sans
15398 report.cls
15399 \family default
15400  document class for preparing reports.
15401  Like the
15402 \family sans
15403 book
15404 \family default
15405  document class,
15406  this provides parts,
15407  chapters and sections but does not provide the paragraph styles needed for a book;
15408  like the
15409 \family sans
15410 article
15411 \family default
15412  document class,
15413  it provides the abstract paragraph style.
15414  In two-sided mode,
15415  it does not start a new chapter on the right hand page.
15416 \end_layout
15417
15418 \begin_layout Standard
15419
15420 \change_inserted 564990737 1672743528
15421 The remaining
15422 \family sans
15423 report
15424 \family default
15425  document classes are described in the Collections (section
15426 \begin_inset space ~
15427 \end_inset
15428
15429
15430 \begin_inset CommandInset ref
15431 LatexCommand ref
15432 reference "sec:Collections"
15433 nolink "false"
15434
15435 \end_inset
15436
15437 ).
15438 \end_layout
15439
15440 \begin_layout Standard
15441
15442 \change_inserted 564990737 1672743530
15443 For
15444 \family sans
15445 report
15446 \begin_inset space \thinspace{}
15447 \end_inset
15448
15449 (Japanese in vertical writing)
15450 \family default
15451  and
15452 \family sans
15453 report
15454 \begin_inset space \thinspace{}
15455 \end_inset
15456
15457 (Japanese)
15458 \family default
15459 ,
15460  see section
15461 \begin_inset space ~
15462 \end_inset
15463
15464
15465 \begin_inset CommandInset ref
15466 LatexCommand ref
15467 reference "subsec:Japanese"
15468 nolink "false"
15469
15470 \end_inset
15471
15472 .
15473 \end_layout
15474
15475 \begin_layout Standard
15476
15477 \change_inserted 564990737 1672743530
15478 For
15479 \family sans
15480 report
15481 \begin_inset space \thinspace{}
15482 \end_inset
15483
15484 (KOMA-Script)
15485 \family default
15486 ,
15487  see section
15488 \begin_inset space ~
15489 \end_inset
15490
15491
15492 \begin_inset CommandInset ref
15493 LatexCommand ref
15494 reference "subsec:KOMA-Script"
15495 nolink "false"
15496
15497 \end_inset
15498
15499 .
15500 \end_layout
15501
15502 \begin_layout Standard
15503
15504 \change_inserted 564990737 1672743530
15505 For
15506 \family sans
15507 report
15508 \begin_inset space \thinspace{}
15509 \end_inset
15510
15511 (with extra font sizes)
15512 \family default
15513 ,
15514  see section
15515 \begin_inset space ~
15516 \end_inset
15517
15518
15519 \begin_inset CommandInset ref
15520 LatexCommand ref
15521 reference "subsec:Extra-font-sizes"
15522 nolink "false"
15523
15524 \end_inset
15525
15526 .
15527 \end_layout
15528
15529 \begin_layout Standard
15530
15531 \change_inserted 564990737 1672743569
15532 For
15533 \family sans
15534 report
15535 \begin_inset space \thinspace{}
15536 \end_inset
15537
15538 (Polish version by M.
15539 \begin_inset space \thinspace{}
15540 \end_inset
15541
15542 W.)
15543 \family default
15544 ,
15545  see section
15546 \begin_inset space ~
15547 \end_inset
15548
15549
15550 \begin_inset CommandInset ref
15551 LatexCommand ref
15552 reference "subsec:Polish-M.W.collection"
15553 plural "false"
15554 caps "false"
15555 noprefix "false"
15556 nolink "false"
15557
15558 \end_inset
15559
15560 .
15561 \end_layout
15562
15563 \begin_layout Section
15564
15565 \change_inserted 564990737 1670439674
15566 Scripts (drama)
15567 \end_layout
15568
15569 \begin_layout Subsection
15570 Broadway
15571 \end_layout
15572
15573 \begin_layout Standard
15574 by
15575 \shape smallcaps
15576 Garst Reese
15577 \end_layout
15578
15579 \begin_layout Subsubsection
15580 Introduction
15581 \end_layout
15582
15583 \begin_layout Standard
15584 Broadway is for writing plays.
15585  The format is more decorative than Hollywood,
15586  and much less standardized.
15587  This format should be suitable for workshops.
15588 \end_layout
15589
15590 \begin_layout Subsubsection
15591 Special problems
15592 \end_layout
15593
15594 \begin_layout Standard
15595 The same as in Hollywood.
15596 \end_layout
15597
15598 \begin_layout Subsubsection
15599 Special features
15600 \end_layout
15601
15602 \begin_layout Standard
15603 Insert the
15604 \family sans
15605 Speaker
15606 \family default
15607  names as labels then cross-reference the label to insert the name.
15608  The cross-reference dialog will show the current cast of characters.
15609 \end_layout
15610
15611 \begin_layout Subsubsection
15612 Paper size and Margins
15613 \end_layout
15614
15615 \begin_layout Standard
15616 USLetter,
15617  left 1.6in,
15618  right 0.75in,
15619  top 0.5in,
15620  bottom 0.75in
15621 \end_layout
15622
15623 \begin_layout Subsubsection
15624 Environments
15625 \end_layout
15626
15627 \begin_layout Standard
15628 The following environments are available.
15629  You can use broadway.bind to get the bind keys shown at the right.
15630 \end_layout
15631
15632 \begin_layout Itemize
15633
15634 \family sans
15635 Standard
15636 \begin_inset Newline newline
15637 \end_inset
15638
15639
15640 \family default
15641 You should not have to use this,
15642  but it is here for anything that does not fit otherwise.
15643 \end_layout
15644
15645 \begin_layout Itemize
15646
15647 \family sans
15648 Narrative
15649 \begin_inset space \hfill{}
15650 \end_inset
15651
15652 M-z n
15653 \begin_inset Newline newline
15654 \end_inset
15655
15656
15657 \family default
15658 Used to describe stage setting and the action.
15659  First use of speaker names in all CAPs.
15660 \end_layout
15661
15662 \begin_layout Itemize
15663
15664 \family sans
15665 ACT
15666 \begin_inset space \hfill{}
15667 \end_inset
15668
15669 M-z a
15670 \begin_inset Newline newline
15671 \end_inset
15672
15673
15674 \family default
15675 Automatically numbered.
15676  On screen it will be arabic,
15677  but will print as Roman.
15678 \end_layout
15679
15680 \begin_layout Itemize
15681
15682 \family sans
15683 ACT*
15684 \begin_inset space \hfill{}
15685 \end_inset
15686
15687 M-z S at
15688 \begin_inset Newline newline
15689 \end_inset
15690
15691
15692 \family default
15693 Subtitle for
15694 \family sans
15695 ACT.
15696
15697 \family default
15698  It is just centered text.
15699 \end_layout
15700
15701 \begin_layout Itemize
15702
15703 \family sans
15704 SCENE
15705 \begin_inset space \hfill{}
15706 \end_inset
15707
15708 M-z S-S
15709 \begin_inset Newline newline
15710 \end_inset
15711
15712
15713 \family default
15714 Not automatically numbered.
15715  You supply the number.
15716  This is because I couldn't figure out how.
15717 \end_layout
15718
15719 \begin_layout Itemize
15720
15721 \family sans
15722 AT_RISE:
15723 \begin_inset space \hfill{}
15724 \end_inset
15725
15726 M-z S-R
15727 \begin_inset Newline newline
15728 \end_inset
15729
15730
15731 \family default
15732 A special case of Narrative to describe the setting and action as the curtain rises.
15733 \end_layout
15734
15735 \begin_layout Itemize
15736
15737 \family sans
15738 Speaker
15739 \begin_inset space \hfill{}
15740 \end_inset
15741
15742 M-z s
15743 \begin_inset Newline newline
15744 \end_inset
15745
15746
15747 \family default
15748 The speaker's (actor's) title,
15749  centered in all CAPS.
15750 \end_layout
15751
15752 \begin_layout Itemize
15753
15754 \family sans
15755 Parenthetical
15756 \begin_inset space \hfill{}
15757 \end_inset
15758
15759 M-z p
15760 \begin_inset Newline newline
15761 \end_inset
15762
15763
15764 \family default
15765 Instructions to the speaker.
15766  The parentheses are automatically inserted.
15767  The ( will appear on screen,
15768  but both will be in the printed play.
15769  This environment is only used within
15770 \family sans
15771 Dialogue
15772 \family default
15773 .
15774 \end_layout
15775
15776 \begin_layout Itemize
15777
15778 \family sans
15779 Dialogue
15780 \begin_inset space \hfill{}
15781 \end_inset
15782
15783 M-z d
15784 \begin_inset Newline newline
15785 \end_inset
15786
15787
15788 \family default
15789 What the Speaker says.
15790 \end_layout
15791
15792 \begin_layout Itemize
15793
15794 \family sans
15795 CURTAIN
15796 \begin_inset space \hfill{}
15797 \end_inset
15798
15799 M-z S-C
15800 \begin_inset Newline newline
15801 \end_inset
15802
15803
15804 \family default
15805 The curtain comes down.
15806 \end_layout
15807
15808 \begin_layout Itemize
15809
15810 \family sans
15811 Title
15812 \begin_inset space \hfill{}
15813 \end_inset
15814
15815 M-z S-T
15816 \end_layout
15817
15818 \begin_layout Itemize
15819
15820 \family sans
15821 Author
15822 \begin_inset space \hfill{}
15823 \end_inset
15824
15825 M-z S-A
15826 \end_layout
15827
15828 \begin_layout Itemize
15829
15830 \family sans
15831 Right_Address
15832 \begin_inset space \hfill{}
15833 \end_inset
15834
15835 M-z r
15836 \end_layout
15837
15838 \begin_layout Standard
15839 Hello there.
15840 \end_layout
15841
15842 \begin_layout Subsection
15843 Hollywood (Hollywood spec scripts)
15844 \end_layout
15845
15846 \begin_layout Standard
15847 by
15848 \shape smallcaps
15849 Garst Reese
15850 \end_layout
15851
15852 \begin_layout Subsubsection
15853 Introduction
15854 \end_layout
15855
15856 \begin_layout Standard
15857 Getting the format of a Hollywood script right is a
15858 \begin_inset Quotes eld
15859 \end_inset
15860
15861 rite of passage.
15862 \begin_inset Quotes erd
15863 \end_inset
15864
15865  It is designed to make the readers focus on content and to be easy and familiar for the actors to read.
15866  Each page of a script should be one minute of film.
15867  Nothing goes in a script that you cannot see or hear on screen.
15868  The courier 12 pt font should be used throughout.
15869  No italics.
15870 \end_layout
15871
15872 \begin_layout Subsubsection
15873 Special problems
15874 \end_layout
15875
15876 \begin_layout Standard
15877 Speakers' lines should NEVER break in mid-sentence.
15878  If a speaker's lines continue over a page break,
15879  repeat the
15880 \family sans
15881 Speaker
15882 \family default
15883  title followed by (Cont'd).
15884 \end_layout
15885
15886 \begin_layout Subsubsection
15887 Special features
15888 \end_layout
15889
15890 \begin_layout Standard
15891 Insert the
15892 \family sans
15893 Speaker
15894 \family default
15895  names as labels then cross-reference the label to insert the name.
15896  The cross-reference dialog will show the current cast of characters.
15897  You can use this to insert the speaker name in narratives also.
15898 \end_layout
15899
15900 \begin_layout Subsubsection
15901 Paper size and Margins
15902 \end_layout
15903
15904 \begin_layout Standard
15905 USLetter,
15906  left 1.6in,
15907  right 0.75in,
15908  top 0.5in,
15909  bottom 0.75in
15910 \end_layout
15911
15912 \begin_layout Subsubsection
15913 Environments
15914 \end_layout
15915
15916 \begin_layout Standard
15917 The following environments are available.
15918  You can use hollywood.bind to get the bind keys shown at the right.
15919 \end_layout
15920
15921 \begin_layout Itemize
15922
15923 \family sans
15924 Standard
15925 \begin_inset Newline newline
15926 \end_inset
15927
15928
15929 \family default
15930 Used where nothing else works.
15931  Try to avoid it.
15932 \end_layout
15933
15934 \begin_layout Itemize
15935
15936 \family sans
15937 FADE_IN
15938 \family default
15939 :
15940 \begin_inset space \hfill{}
15941 \end_inset
15942
15943
15944 \family sans
15945 M-z S-I
15946 \family default
15947
15948 \begin_inset Newline newline
15949 \end_inset
15950
15951 Usually followed by something like
15952 \begin_inset Quotes eld
15953 \end_inset
15954
15955 on Sally waking up.
15956 \begin_inset Quotes erd
15957 \end_inset
15958
15959
15960 \end_layout
15961
15962 \begin_layout Itemize
15963
15964 \family sans
15965 INT:
15966 \begin_inset space \hfill{}
15967 \end_inset
15968
15969 M-z i
15970 \begin_inset Newline newline
15971 \end_inset
15972
15973
15974 \family default
15975 Introduces a new INTERIOR camera set-up.
15976  Always followed by DAY or NIGHT,
15977  or something similar to define the lighting required.
15978  Everthing on this line in CAPS.
15979 \end_layout
15980
15981 \begin_layout Itemize
15982
15983 \family sans
15984 EXT:
15985 \begin_inset space \hfill{}
15986 \end_inset
15987
15988 M-z e
15989 \begin_inset Newline newline
15990 \end_inset
15991
15992
15993 \family default
15994 Introduces a new EXTERIOR camera set-up.
15995  Everthing on this line in CAPS.
15996 \end_layout
15997
15998 \begin_layout Itemize
15999
16000 \family sans
16001 Speaker
16002 \begin_inset space \hfill{}
16003 \end_inset
16004
16005 M-z s
16006 \begin_inset Newline newline
16007 \end_inset
16008
16009
16010 \family default
16011 The character speaking.
16012 \end_layout
16013
16014 \begin_layout Itemize
16015
16016 \family sans
16017 Parenthetical
16018 \begin_inset space \hfill{}
16019 \end_inset
16020
16021 M-z p
16022 \begin_inset Newline newline
16023 \end_inset
16024
16025
16026 \family default
16027 Instructions to the speaker.
16028  The () are automatically inserted.
16029 \end_layout
16030
16031 \begin_layout Itemize
16032
16033 \family sans
16034 Dialogue
16035 \begin_inset space \hfill{}
16036 \end_inset
16037
16038 M-z d
16039 \begin_inset Newline newline
16040 \end_inset
16041
16042
16043 \family default
16044 What the
16045 \family sans
16046 Speaker
16047 \family default
16048  says.
16049 \end_layout
16050
16051 \begin_layout Itemize
16052
16053 \family sans
16054 Transition
16055 \begin_inset space \hfill{}
16056 \end_inset
16057
16058 M-z t
16059 \begin_inset Newline newline
16060 \end_inset
16061
16062
16063 \family default
16064 Camera movement instruction.
16065  e.
16066 \begin_inset space \thinspace{}
16067 \end_inset
16068
16069 g.
16070 \begin_inset space \space{}
16071 \end_inset
16072
16073 CUT TO:
16074 \end_layout
16075
16076 \begin_layout Itemize
16077
16078 \family sans
16079 FADE OUT:
16080 \begin_inset space \hfill{}
16081 \end_inset
16082
16083 M-z S-I
16084 \end_layout
16085
16086 \begin_layout Itemize
16087
16088 \family sans
16089 Author
16090 \begin_inset space \hfill{}
16091 \end_inset
16092
16093 M-z S-A
16094 \end_layout
16095
16096 \begin_layout Itemize
16097
16098 \family sans
16099 Title
16100 \begin_inset space \hfill{}
16101 \end_inset
16102
16103 M-z S-T
16104 \end_layout
16105
16106 \begin_layout Itemize
16107
16108 \family sans
16109 Right_Address
16110 \begin_inset space \hfill{}
16111 \end_inset
16112
16113 M-z r
16114 \end_layout
16115
16116 \begin_layout Subsubsection
16117 Script jargon
16118 \end_layout
16119
16120 \begin_layout Itemize
16121 (O.S) —
16122  off screen
16123 \end_layout
16124
16125 \begin_layout Itemize
16126 (V.0) —
16127  voice over
16128 \end_layout
16129
16130 \begin_layout Itemize
16131 b.
16132 \begin_inset space \thinspace{}
16133 \end_inset
16134
16135 g.
16136  —
16137  background
16138 \end_layout
16139
16140 \begin_layout Itemize
16141 C.U.
16142  —
16143  close-up
16144 \end_layout
16145
16146 \begin_layout Itemize
16147 PAN —
16148  camera movement
16149 \end_layout
16150
16151 \begin_layout Itemize
16152 INSERT —
16153  cut to close-up of
16154 \end_layout
16155
16156 \begin_layout Chapter
16157
16158 \change_inserted 564990737 1671185876
16159 Modules
16160 \end_layout
16161
16162 \begin_layout Section
16163
16164 \change_inserted 564990737 1671716212
16165 Academic Field Specifics
16166 \end_layout
16167
16168 \begin_layout Subsection
16169
16170 \change_inserted 564990737 1671716212
16171 Chemistry:
16172  Hazard and Precautionary Statements
16173 \end_layout
16174
16175 \begin_layout Standard
16176
16177 \change_inserted 564990737 1671716212
16178 This module provides two insets to typeset numbers and phrases of chemical hazard and precautionary statements.
16179  For a description see
16180 \family sans
16181 File\SpecialChar menuseparator
16182 Open Example\SpecialChar menuseparator
16183 Modules\SpecialChar menuseparator
16184 Hazard and Precautionary Statements
16185 \family default
16186  and
16187 \family sans
16188 Help\SpecialChar menuseparator
16189 Specific Manuals\SpecialChar menuseparator
16190 Hazard and Precautionary Statements
16191 \family default
16192 .
16193 \end_layout
16194
16195 \begin_layout Subsection
16196
16197 \change_inserted 564990737 1671716212
16198
16199 \series bold
16200 Chemistry:
16201  Risk and Safety Statements
16202 \end_layout
16203
16204 \begin_layout Standard
16205
16206 \change_inserted 564990737 1671716212
16207 This module provides two insets,
16208
16209 \family sans
16210 R-S number
16211 \family default
16212  and
16213 \family sans
16214 R-S phrase
16215 \family default
16216 ,
16217  accessible via the menu
16218 \family sans
16219 \bar under
16220 I
16221 \bar default
16222 nsert\SpecialChar menuseparator
16223 Custom
16224 \begin_inset space ~
16225 \end_inset
16226
16227 Insets
16228 \family default
16229  and an environment to typeset numbers and phrases of chemical risk and safety statements.
16230 \end_layout
16231
16232 \begin_layout Subsection
16233
16234 \change_inserted 564990737 1671716212
16235 Linguistics
16236 \end_layout
16237
16238 \begin_layout Standard
16239
16240 \change_inserted 564990737 1671716212
16241 This module uses the
16242 \family sans
16243 covington.sty
16244 \family default
16245  package to add environments useful for linguistics (numbered examples,
16246  glosses,
16247  semantic markup,
16248  tableau floats).
16249  You can obtain information about this module in
16250 \family sans
16251 \bar under
16252 H
16253 \bar default
16254 elp\SpecialChar menuseparator
16255 S
16256 \bar under
16257 p
16258 \bar default
16259 ecific
16260 \begin_inset space ~
16261 \end_inset
16262
16263 Manuals\SpecialChar menuseparator
16264
16265 \bar under
16266 L
16267 \bar default
16268 inguistics
16269 \family default
16270  and
16271 \family sans
16272 File\SpecialChar menuseparator
16273 Open Example\SpecialChar menuseparator
16274 Modules\SpecialChar menuseparator
16275 Linguistics
16276 \family default
16277 .
16278 \end_layout
16279
16280 \begin_layout Section
16281
16282 \change_inserted 564990737 1671788778
16283 Accessibility
16284 \end_layout
16285
16286 \begin_layout Subsection
16287
16288 \change_inserted 564990737 1671788778
16289 Braille
16290 \end_layout
16291
16292 \begin_layout Standard
16293
16294 \change_inserted 564990737 1671788778
16295 This module supports the Braille writing system.
16296  It requires the \SpecialChar LaTeX
16297  package
16298 \family typewriter
16299 braille.sty
16300 \family default
16301 .
16302  This and its documentation can be obtained from
16303 \begin_inset CommandInset href
16304 LatexCommand href
16305 name "CTAN"
16306 target "https://www.ctan.org/pkg/braille"
16307 literal "false"
16308
16309 \end_inset
16310
16311 .
16312  You do not have to reconfigure your system after installing it.
16313  See
16314 \family sans
16315 \bar under
16316 H
16317 \bar default
16318 elp\SpecialChar menuseparator
16319 S
16320 \bar under
16321 p
16322 \bar default
16323 ecific
16324 \begin_inset space ~
16325 \end_inset
16326
16327 Manuals\SpecialChar menuseparator
16328
16329 \bar under
16330 B
16331 \bar default
16332 raille
16333 \family default
16334  and
16335 \family sans
16336 File\SpecialChar menuseparator
16337 Open Example\SpecialChar menuseparator
16338 Modules\SpecialChar menuseparator
16339 Braille
16340 \family default
16341 .
16342 \end_layout
16343
16344 \begin_layout Section
16345
16346 \change_inserted 564990737 1671788778
16347 Annotation & Revision
16348 \end_layout
16349
16350 \begin_layout Subsection
16351
16352 \change_inserted 564990737 1671788778
16353 FiXme Notes
16354 \end_layout
16355
16356 \begin_layout Standard
16357
16358 \change_inserted 564990737 1671788778
16359 This module provides “FiXme” (marginal) annotations for document revision purposes.
16360  A list of annotations can be produced by using the “List of FIXMEs” paragraph style.
16361  The annotations are customizable via the LaTeX preamble.
16362  See the FiXme documentation which can be obtained from
16363 \begin_inset CommandInset href
16364 LatexCommand href
16365 name "CTAN"
16366 target "http://mirrors.ctan.org/macros/latex/contrib/fixme/fixme.pdf"
16367 literal "false"
16368
16369 \end_inset
16370
16371 .
16372
16373 \end_layout
16374
16375 \begin_layout Paragraph
16376
16377 \change_inserted 564990737 1671788778
16378 Note:
16379 \end_layout
16380
16381 \begin_layout Standard
16382
16383 \change_inserted 564990737 1671788778
16384 by default,
16385  the notes are only displayed in “draft” mode (if the option “draft” has been inserted in
16386 \family sans
16387 Document\SpecialChar menuseparator
16388 Settings\SpecialChar menuseparator
16389 Document Class\SpecialChar menuseparator
16390 Class Options\SpecialChar menuseparator
16391 Custom
16392 \family default
16393 ).
16394  To display them always,
16395  insert
16396 \family typewriter
16397
16398 \backslash
16399 fxsetup{draft}
16400 \family default
16401  in
16402 \family sans
16403 Document\SpecialChar menuseparator
16404 Settings\SpecialChar menuseparator
16405 \SpecialChar LaTeX
16406  Preamble
16407 \family default
16408 .
16409
16410 \end_layout
16411
16412 \begin_layout Subsection
16413
16414 \change_inserted 564990737 1671788778
16415 PDF Comments
16416 \end_layout
16417
16418 \begin_layout Standard
16419
16420 \change_inserted 564990737 1671788778
16421 This module provides various kinds of annotations for PDF output.
16422  See
16423 \family sans
16424 Help\SpecialChar menuseparator
16425 Specific Manuals\SpecialChar menuseparator
16426 PDF comments and File\SpecialChar menuseparator
16427 Open Example\SpecialChar menuseparator
16428 Modules\SpecialChar menuseparator
16429 PDF Comments
16430 \family default
16431 .
16432 \end_layout
16433
16434 \begin_layout Subsection
16435
16436 \change_inserted 564990737 1671788778
16437
16438 \series bold
16439 PDF Form
16440 \end_layout
16441
16442 \begin_layout Standard
16443
16444 \change_inserted 564990737 1671788778
16445 This module provides fields and buttons for PDF forms.
16446  See the
16447 \begin_inset CommandInset href
16448 LatexCommand href
16449 name "hyperref documentation"
16450 target "http://mirrors.ctan.org/macros/latex/contrib/hyperref/doc/hyperref-doc.pdf"
16451 literal "false"
16452
16453 \end_inset
16454
16455 ,
16456
16457 \family sans
16458 Help\SpecialChar menuseparator
16459 Specific Manuals\SpecialChar menuseparator
16460 PDF forms and File\SpecialChar menuseparator
16461 Open Example\SpecialChar menuseparator
16462 Modules\SpecialChar menuseparator
16463 PDF Form
16464 \family default
16465 .
16466 \end_layout
16467
16468 \begin_layout Subsection
16469
16470 \change_inserted 564990737 1671788778
16471
16472 \series bold
16473 Ruby (Furigana)
16474 \end_layout
16475
16476 \begin_layout Standard
16477
16478 \change_inserted 564990737 1671788778
16479 This module defines an inset to typeset reading aids (ruby,
16480  furigana) to Chinese characters.
16481  It uses the “okumakro,” “luatexja-ruby” or “ruby” package (depending on the TeX engine) or a fallback definition.
16482
16483 \end_layout
16484
16485 \begin_layout Subsection
16486
16487 \change_inserted 564990737 1671788778
16488
16489 \series bold
16490 TODO notes
16491 \end_layout
16492
16493 \begin_layout Standard
16494
16495 \change_inserted 564990737 1671788778
16496 This module provides custom insets to insert TODO items in your document.
16497  In order to generate a “List of TODOs,” the module provides a paragraph style.
16498  Inserting “final” in
16499 \family sans
16500 Document\SpecialChar menuseparator
16501 Settings\SpecialChar menuseparator
16502 Document Class\SpecialChar menuseparator
16503 Class Options\SpecialChar menuseparator
16504 Custom
16505 \family default
16506 ) suppresses the output of TODO notes.
16507  See the
16508 \begin_inset CommandInset href
16509 LatexCommand href
16510 name "todonotes documentation"
16511 target "http://mirrors.ctan.org/macros/latex/contrib/todonotes/todonotes.pdf"
16512 literal "false"
16513
16514 \end_inset
16515
16516 .
16517 \end_layout
16518
16519 \begin_layout Section
16520
16521 \change_inserted 564990737 1671829045
16522 Bibliography
16523 \end_layout
16524
16525 \begin_layout Subsection
16526
16527 \change_inserted 564990737 1671829045
16528 APA Style with NatBib
16529 \end_layout
16530
16531 \begin_layout Standard
16532
16533 \change_inserted 564990737 1671829045
16534 This module adds support for using natbib together with apacite (the bibliography style need not be apacite —
16535  it could be apacite,
16536  apacitex,
16537  or any bibliography that works with both the natbib and apacite packages.)
16538 \end_layout
16539
16540 \begin_layout Section
16541
16542 \change_inserted 564990737 1671829045
16543 Boxes
16544 \end_layout
16545
16546 \begin_layout Subsection
16547
16548 \change_inserted 564990737 1671829045
16549 Fancy Colored Boxes
16550 \end_layout
16551
16552 \begin_layout Standard
16553
16554 \change_inserted 564990737 1671829045
16555 This module adds ten custom insets that support colored boxes via the tcolorbox package.
16556  See
16557 \family sans
16558 Help\SpecialChar menuseparator
16559 Specific Manuals\SpecialChar menuseparator
16560 Colored boxes
16561 \family default
16562 ,
16563
16564 \family sans
16565 File\SpecialChar menuseparator
16566 Open Example\SpecialChar menuseparator
16567 Modules\SpecialChar menuseparator
16568 Fancy Color Boxes
16569 \family default
16570  the
16571 \begin_inset CommandInset href
16572 LatexCommand href
16573 name "tcolorbox documentation"
16574 target "http://mirrors.ctan.org/macros/latex/contrib/tcolorbox/tcolorbox.pdf"
16575 literal "false"
16576
16577 \end_inset
16578
16579  for details.
16580
16581 \end_layout
16582
16583 \begin_layout Subsection
16584
16585 \change_inserted 564990737 1671829045
16586 Graphic boxes
16587 \end_layout
16588
16589 \begin_layout Standard
16590
16591 \change_inserted 564990737 1671829045
16592 This provides the custom insets
16593 \family sans
16594 Reflectbox
16595 \family default
16596 ,
16597
16598 \family sans
16599 Resizebox
16600 \family default
16601 ,
16602
16603 \family sans
16604 Rotatebox
16605 \family default
16606  and
16607 \family sans
16608 Scalebox
16609 \family default
16610  to scale and rotate its content.
16611 \end_layout
16612
16613 \begin_layout Standard
16614
16615 \change_inserted 564990737 1671829045
16616
16617 \family sans
16618 Reflectbox
16619 \family default
16620  is a simple way of reversing text without any other enhancement:
16621 \end_layout
16622
16623 \begin_layout Standard
16624
16625 \change_inserted 564990737 1671829045
16626 \begin_inset Flex Reflectbox
16627 status open
16628
16629 \begin_layout Plain Layout
16630
16631 \change_inserted 564990737 1671829045
16632 Great Western Railway
16633 \change_unchanged
16634
16635 \end_layout
16636
16637 \end_inset
16638
16639
16640 \end_layout
16641
16642 \begin_layout Standard
16643
16644 \change_inserted 564990737 1671829045
16645 (You will need to use Ctrl-R to see any of these examples.)
16646 \end_layout
16647
16648 \begin_layout Standard
16649
16650 \change_inserted 564990737 1671829045
16651
16652 \family sans
16653 Resizebox
16654 \family default
16655  allows you to specify the dimensions of the text or image;
16656  permissible units are em,
16657  ex,
16658  in,
16659  pt,
16660  pc,
16661  cm,
16662  mm,
16663  dd,
16664  cc,
16665  nd,
16666  nc,
16667  bp,
16668  or sp;
16669  if you enter
16670 \family typewriter
16671 !
16672
16673 \family default
16674  for
16675 \family typewriter
16676 Height
16677 \family default
16678  it scales by the width factor:
16679 \end_layout
16680
16681 \begin_layout Standard
16682
16683 \change_inserted 564990737 1671829045
16684 \begin_inset Flex Resizebox
16685 status open
16686
16687 \begin_layout Plain Layout
16688
16689 \change_inserted 564990737 1671829045
16690 \begin_inset Argument 1
16691 status open
16692
16693 \begin_layout Plain Layout
16694
16695 \change_inserted 564990737 1671829045
16696 48mm
16697 \change_unchanged
16698
16699 \end_layout
16700
16701 \end_inset
16702
16703
16704 \begin_inset Argument 2
16705 status open
16706
16707 \begin_layout Plain Layout
16708
16709 \change_inserted 564990737 1671829045
16710 !
16711 \change_unchanged
16712
16713 \end_layout
16714
16715 \end_inset
16716
16717 Great Western Railway
16718 \change_unchanged
16719
16720 \end_layout
16721
16722 \end_inset
16723
16724
16725 \end_layout
16726
16727 \begin_layout Standard
16728
16729 \change_inserted 564990737 1671829045
16730
16731 \family sans
16732 Rotatebox
16733 \family default
16734  allows you to rotate text around the reference point of the box.
16735  If you wish to rotate the box around a different origin,
16736  place the cursor inside the box and select Insert\SpecialChar menuseparator
16737 Origin;
16738  o
16739 \family typewriter
16740 rigin
16741 \family default
16742  is specified as
16743 \family typewriter
16744 c
16745 \family default
16746 ,
16747
16748 \family typewriter
16749  l
16750 \family default
16751 ,
16752
16753 \family typewriter
16754  r
16755 \family default
16756 ,
16757
16758 \family typewriter
16759  b
16760 \family default
16761 ,
16762
16763 \family typewriter
16764  t
16765 \family default
16766  or meaningful combinations of these and the counterclockwise rotation angle is expressed in degrees.
16767  For example:
16768 \end_layout
16769
16770 \begin_layout Standard
16771
16772 \change_inserted 564990737 1671829045
16773 \begin_inset Flex Rotatebox
16774 status open
16775
16776 \begin_layout Plain Layout
16777
16778 \change_inserted 564990737 1671829045
16779 \begin_inset Argument 1
16780 status open
16781
16782 \begin_layout Plain Layout
16783
16784 \change_inserted 274215730 1672888693
16785 origin
16786 \change_inserted 564990737 1671829045
16787 =c
16788 \change_unchanged
16789
16790 \end_layout
16791
16792 \end_inset
16793
16794
16795 \begin_inset Argument 2
16796 status open
16797
16798 \begin_layout Plain Layout
16799
16800 \change_inserted 564990737 1671829045
16801 30
16802 \change_unchanged
16803
16804 \end_layout
16805
16806 \end_inset
16807
16808 Great Western Railway
16809 \change_unchanged
16810
16811 \end_layout
16812
16813 \end_inset
16814
16815
16816 \end_layout
16817
16818 \begin_layout Standard
16819
16820 \change_inserted 564990737 1671829045
16821 You can combine boxes as in:
16822 \end_layout
16823
16824 \begin_layout Standard
16825
16826 \change_inserted 564990737 1671829045
16827 \begin_inset Flex Rotatebox
16828 status open
16829
16830 \begin_layout Plain Layout
16831
16832 \change_inserted 564990737 1671829045
16833 \begin_inset Argument 1
16834 status open
16835
16836 \begin_layout Plain Layout
16837
16838 \change_inserted 274215730 1672888702
16839 origin
16840 \change_inserted 564990737 1671829045
16841 =c
16842 \change_unchanged
16843
16844 \end_layout
16845
16846 \end_inset
16847
16848
16849 \begin_inset Argument 2
16850 status open
16851
16852 \begin_layout Plain Layout
16853
16854 \change_inserted 564990737 1671829045
16855 -15
16856 \change_unchanged
16857
16858 \end_layout
16859
16860 \end_inset
16861
16862
16863 \begin_inset Flex Resizebox
16864 status open
16865
16866 \begin_layout Plain Layout
16867
16868 \change_inserted 564990737 1671829045
16869 \begin_inset Argument 1
16870 status open
16871
16872 \begin_layout Plain Layout
16873
16874 \change_inserted 564990737 1671829045
16875 48mm
16876 \change_unchanged
16877
16878 \end_layout
16879
16880 \end_inset
16881
16882
16883 \begin_inset Argument 2
16884 status open
16885
16886 \begin_layout Plain Layout
16887
16888 \change_inserted 564990737 1671829045
16889 !
16890 \change_unchanged
16891
16892 \end_layout
16893
16894 \end_inset
16895
16896
16897 \begin_inset Flex Reflectbox
16898 status open
16899
16900 \begin_layout Plain Layout
16901
16902 \change_inserted 564990737 1671829045
16903 Great Western Railway
16904 \change_unchanged
16905
16906 \end_layout
16907
16908 \end_inset
16909
16910
16911 \change_unchanged
16912
16913 \end_layout
16914
16915 \end_inset
16916
16917
16918 \change_unchanged
16919
16920 \end_layout
16921
16922 \end_inset
16923
16924
16925 \end_layout
16926
16927 \begin_layout Standard
16928
16929 \change_inserted 564990737 1671829045
16930
16931 \family sans
16932 Scalebox
16933 \family default
16934  scales text;
16935  select Insert\SpecialChar menuseparator
16936 V-Factor to add a vertical factor.
16937  If the vertical factor is omitted,
16938  the horizontal is used.
16939  Adding different horizontal and vertical values creates distortion as in
16940 \end_layout
16941
16942 \begin_layout Standard
16943
16944 \change_inserted 564990737 1671829045
16945
16946 \family typewriter
16947 \begin_inset Flex Scalebox
16948 status open
16949
16950 \begin_layout Plain Layout
16951
16952 \change_inserted 564990737 1671829045
16953 \begin_inset Argument 1
16954 status open
16955
16956 \begin_layout Plain Layout
16957
16958 \change_inserted 564990737 1671829045
16959 2
16960 \change_unchanged
16961
16962 \end_layout
16963
16964 \end_inset
16965
16966
16967 \begin_inset Argument 2
16968 status open
16969
16970 \begin_layout Plain Layout
16971
16972 \change_inserted 564990737 1671829045
16973 1.5
16974 \change_unchanged
16975
16976 \end_layout
16977
16978 \end_inset
16979
16980
16981 \family roman
16982 Great Western Railway
16983 \change_unchanged
16984
16985 \end_layout
16986
16987 \end_inset
16988
16989 .
16990 \end_layout
16991
16992 \begin_layout Standard
16993
16994 \change_inserted 564990737 1671829045
16995 A negative horizontal value reverses the text and a negative vertical value inverts it so that you get
16996 \end_layout
16997
16998 \begin_layout Standard
16999
17000 \change_inserted 564990737 1671829045
17001 \begin_inset Flex Scalebox
17002 status open
17003
17004 \begin_layout Plain Layout
17005
17006 \change_inserted 564990737 1671829045
17007 \begin_inset Argument 1
17008 status open
17009
17010 \begin_layout Plain Layout
17011
17012 \change_inserted 564990737 1671829045
17013 -1
17014 \change_unchanged
17015
17016 \end_layout
17017
17018 \end_inset
17019
17020
17021 \begin_inset Argument 2
17022 status open
17023
17024 \begin_layout Plain Layout
17025
17026 \change_inserted 564990737 1671829045
17027 1
17028 \change_unchanged
17029
17030 \end_layout
17031
17032 \end_inset
17033
17034 Great Western Railway
17035 \change_unchanged
17036
17037 \end_layout
17038
17039 \end_inset
17040
17041  and
17042 \begin_inset Flex Scalebox
17043 status open
17044
17045 \begin_layout Plain Layout
17046
17047 \change_inserted 564990737 1671829045
17048 \begin_inset Argument 1
17049 status open
17050
17051 \begin_layout Plain Layout
17052
17053 \change_inserted 564990737 1671829045
17054 1
17055 \change_unchanged
17056
17057 \end_layout
17058
17059 \end_inset
17060
17061
17062 \begin_inset Argument 2
17063 status open
17064
17065 \begin_layout Plain Layout
17066
17067 \change_inserted 564990737 1671829045
17068 -1
17069 \change_unchanged
17070
17071 \end_layout
17072
17073 \end_inset
17074
17075 Great Western Railway
17076 \change_unchanged
17077
17078 \end_layout
17079
17080 \end_inset
17081
17082 .
17083 \end_layout
17084
17085 \begin_layout Subsection
17086
17087 \change_inserted 564990737 1671884699
17088 Section Boxes
17089 \end_layout
17090
17091 \begin_layout Standard
17092
17093 \change_inserted 564990737 1671884699
17094 This module defines Boxes with section header.
17095  It is mainly intended for the SciPoster Document class.
17096
17097 \end_layout
17098
17099 \begin_layout Subsection
17100
17101 \change_inserted 564990737 1671884699
17102 Variable-width Minipages
17103 \end_layout
17104
17105 \begin_layout Standard
17106
17107 \change_inserted 564990737 1671884699
17108 This module adds a
17109 \family sans
17110 Minipage (Var.
17111 \begin_inset space \thinspace{}
17112 \end_inset
17113
17114 Width)
17115 \family default
17116  inset to
17117 \family sans
17118 Insert\SpecialChar menuseparator
17119 Custom Inset
17120 \family default
17121  using the
17122 \family sans
17123 varwidth
17124 \family default
17125  LaTeX package.
17126  The
17127 \family sans
17128 varwidth
17129 \family default
17130  package provides a variable-width minipage,
17131  whose resulting width is the width of its contents (if this does not exceed the specified maximum width).
17132  The inset has two optional arguments which can be added by placing the cursor inside the minipage and entering
17133 \family sans
17134 Insert\SpecialChar menuseparator
17135 Vert.
17136 \begin_inset space \thinspace{}
17137 \end_inset
17138
17139 Adjustment
17140 \family default
17141  (
17142 \family typewriter
17143 c|t|b
17144 \family default
17145 ) or
17146 \family sans
17147 Insert\SpecialChar menuseparator
17148 Max.
17149 \begin_inset space \thinspace{}
17150 \end_inset
17151
17152 Width
17153 \family default
17154  (defaults to
17155 \family typewriter
17156
17157 \backslash
17158 linewidth
17159 \family default
17160 ).
17161  See
17162 \family sans
17163 File\SpecialChar menuseparator
17164 Open Example\SpecialChar menuseparator
17165 Variable-width Minipages
17166 \family default
17167 .
17168
17169 \end_layout
17170
17171 \begin_layout Section
17172
17173 \change_inserted 564990737 1671884699
17174 Fixes & Hacks
17175 \end_layout
17176
17177 \begin_layout Subsection
17178
17179 \change_inserted 564990737 1671884699
17180 Fix Computer Modern Fonts
17181 \end_layout
17182
17183 \begin_layout Standard
17184
17185 \change_inserted 564990737 1671884699
17186 This module uses the
17187 \family sans
17188 fix-cm
17189 \family default
17190  package to improve the appearance of Computer Modern fonts and make them available with arbitrary sizes.
17191  See the
17192 \begin_inset CommandInset href
17193 LatexCommand href
17194 name "fix-cm documentation"
17195 target "http://mirrors.ctan.org/macros/latex/base/fix-cm.pdf"
17196 literal "false"
17197
17198 \end_inset
17199
17200 .
17201
17202 \end_layout
17203
17204 \begin_layout Subsection
17205
17206 \change_inserted 564990737 1671884699
17207 \SpecialChar LaTeX
17208  Kernel Fixes (Obsolete)
17209 \end_layout
17210
17211 \begin_layout Standard
17212
17213 \change_inserted 564990737 1671884699
17214 This module loads the \SpecialChar LaTeX
17215  package
17216 \family sans
17217 fixltx2e
17218 \family default
17219  which contains some bug fixes for \SpecialChar LaTeX
17220 .
17221  If you use this module your typeset document may look different when you process it,
17222  depending on the respective version of
17223 \family sans
17224 fixltx2e
17225 \family default
17226 .
17227
17228 \end_layout
17229
17230 \begin_layout Paragraph
17231
17232 \change_inserted 564990737 1671884699
17233 Note:
17234 \end_layout
17235
17236 \begin_layout Standard
17237
17238 \change_inserted 564990737 1671884699
17239 recent \SpecialChar LaTeX
17240  kernels (as of 2015/01/01) include the functionality of
17241 \family sans
17242 fixltx2e
17243 \family default
17244 ,
17245  so the
17246 \family sans
17247 fixltx2e
17248 \family default
17249  module is obsolete with newer \SpecialChar LaTeX
17250  distributions.
17251
17252 \end_layout
17253
17254 \begin_layout Subsection
17255
17256 \change_inserted 564990737 1671884699
17257 Minimalistic Insets
17258 \end_layout
17259
17260 \begin_layout Standard
17261
17262 \change_inserted 564990737 1671884699
17263 This module redefines several insets (Index,
17264  Branch,
17265  URL) as being Minimalistic.
17266 \end_layout
17267
17268 \begin_layout Subsection
17269
17270 \change_inserted 564990737 1671884699
17271 Title and Preamble Hacks
17272 \end_layout
17273
17274 \begin_layout Standard
17275
17276 \change_inserted 564990737 1671884699
17277 This module provides two new paragraph styles:
17278
17279 \end_layout
17280
17281 \begin_layout Enumerate
17282
17283 \change_inserted 564990737 1671884699
17284
17285 \family sans
17286 In Preamble
17287 \family default
17288  which puts whatever is entered into it into the preamble.
17289  This can be used,
17290  if one wishes,
17291  to include preamble code in the body of a LyX document.
17292
17293 \end_layout
17294
17295 \begin_layout Enumerate
17296
17297 \change_inserted 564990737 1671884699
17298
17299 \family sans
17300 In Title
17301 \family default
17302  which that will put its contents into the body of the LaTeX document,
17303  but before
17304 \family typewriter
17305
17306 \backslash
17307 maketitle
17308 \family default
17309  is issued.
17310  This is useful for making branches and notes in title-related material.
17311  (However,
17312  if you put these in a Standard layout,
17313  this signals to LyX to output
17314 \family typewriter
17315
17316 \backslash
17317 maketitle
17318 \family default
17319 ,
17320  which may then come too early.)
17321 \end_layout
17322
17323 \begin_layout Section
17324
17325 \change_inserted 564990737 1672081439
17326 Floats & captions
17327 \end_layout
17328
17329 \begin_layout Subsection
17330
17331 \change_inserted 564990737 1672081439
17332 Algorithm2e Float
17333 \end_layout
17334
17335 \begin_layout Standard
17336
17337 \change_inserted 564990737 1672081439
17338 This module uses the
17339 \family sans
17340 algorithm2e
17341 \family default
17342  package for algorithm floats rather than LyX’s home-brewed algorithm floats.
17343  Use the Algorithm paragraph style to enter and indent the algorithm.
17344  See the
17345 \begin_inset CommandInset href
17346 LatexCommand href
17347 name "algorithm2e documentation"
17348 target "http://mirrors.ctan.org/macros/latex/contrib/algorithm2e/doc/algorithm2e.pdf"
17349 literal "false"
17350
17351 \end_inset
17352
17353 .
17354 \end_layout
17355
17356 \begin_layout Subsection
17357
17358 \change_inserted 564990737 1672081439
17359 Bilingual Captions AKA Multilingual Captions
17360 \end_layout
17361
17362 \begin_layout Standard
17363
17364 \change_inserted 564990737 1672081439
17365 This module provides the paragraph style
17366 \family sans
17367 Caption
17368 \begin_inset space ~
17369 \end_inset
17370
17371 setup
17372 \family default
17373  with which to typeset multilingual captions.
17374  Within this paragraph style
17375 \family sans
17376 Insert\SpecialChar menuseparator
17377 Language
17378 \family default
17379  allows you to enter the desired language using one of the babel names.
17380  See
17381 \family sans
17382 File\SpecialChar menuseparator
17383 Open Example\SpecialChar menuseparator
17384 Multilingual Captions
17385 \family default
17386  and
17387 \family sans
17388 Help\SpecialChar menuseparator
17389 Specific Manuals\SpecialChar menuseparator
17390 Multilingual Captions
17391 \family default
17392  further information on its use.
17393 \end_layout
17394
17395 \begin_layout Subsection
17396
17397 \change_inserted 564990737 1672081439
17398 Number Figures by Section
17399 \end_layout
17400
17401 \begin_layout Standard
17402
17403 \change_inserted 564990737 1672081439
17404 This module resets the figure number at section start and prepends the section number to the figure number,
17405  as in “Figure 2.1.” (By default book and report document classes number by Chapter and article document classes have a single sequence.)
17406 \end_layout
17407
17408 \begin_layout Subsection
17409
17410 \change_inserted 564990737 1672081439
17411 Number Tables by Section
17412 \end_layout
17413
17414 \begin_layout Standard
17415
17416 \change_inserted 564990737 1672081439
17417 This module resets the table number at section start and prepends the section number to the table number,
17418  as in “Table 2.1.” (By default book and report document classes number by Chapter and article document classes have a single sequence.)
17419 \end_layout
17420
17421 \begin_layout Section
17422
17423 \change_inserted 564990737 1672081439
17424 Foot- and Endnotes
17425 \end_layout
17426
17427 \begin_layout Subsection
17428
17429 \change_inserted 564990737 1672081439
17430 Endnotes (Basic)
17431 \end_layout
17432
17433 \begin_layout Standard
17434
17435 \change_inserted 564990737 1672081439
17436 This module adds an endnote inset,
17437  in addition to footnotes.
17438  This uses the
17439 \family sans
17440 endnotes
17441 \family default
17442  package,
17443  which has some limitations but works with older LaTeX distributions as well.
17444  Use
17445 \family sans
17446 Insert\SpecialChar menuseparator
17447 Custom Inset\SpecialChar menuseparator
17448 Endnote
17449 \family default
17450  to insert an endnote and
17451 \family sans
17452 Insert\SpecialChar menuseparator
17453 List/Contents/References\SpecialChar menuseparator
17454 Endnotes
17455 \family default
17456  to insert the endnotes list where you want the endnotes to appear.
17457  See also
17458 \family sans
17459 Help\SpecialChar menuseparator
17460 Embedded\SpecialChar menuseparator
17461  Objects\SpecialChar menuseparator
17462 Notes\SpecialChar menuseparator
17463 Footnotes
17464 \family default
17465 .
17466 \end_layout
17467
17468 \begin_layout Subsection
17469
17470 \change_inserted 564990737 1672081439
17471 Endnotes (Extended)
17472 \end_layout
17473
17474 \begin_layout Standard
17475
17476 \change_inserted 564990737 1672081439
17477 This module adds an endnote inset,
17478  in addition to footnotes.
17479  This uses the
17480 \family sans
17481 enotez
17482 \family default
17483  package which is more powerful and customizable than the
17484 \family sans
17485 endnotes
17486 \family default
17487  package,
17488  but requires a fairly modern LaTeX distribution (with LaTeX3).
17489  Use
17490 \family sans
17491 Insert\SpecialChar menuseparator
17492 Custom Inset\SpecialChar menuseparator
17493 Endnote
17494 \family default
17495  to insert an endnote and
17496 \family sans
17497 Insert\SpecialChar menuseparator
17498 List/Contents/References\SpecialChar menuseparator
17499 Endnotes
17500 \family default
17501  to insert the endnotes list where you want the endnotes to appear.
17502  See also
17503 \family sans
17504 Help\SpecialChar menuseparator
17505 Embedded\SpecialChar menuseparator
17506  Objects\SpecialChar menuseparator
17507 Notes\SpecialChar menuseparator
17508 Footnotes
17509 \family default
17510 .
17511 \end_layout
17512
17513 \begin_layout Subsection
17514
17515 \change_inserted 564990737 1672081439
17516 Footnotes as Endnotes (Basic)
17517 \end_layout
17518
17519 \begin_layout Standard
17520
17521 \change_inserted 564990737 1672081439
17522 This module sets all footnotes as endnotes.
17523  This uses the
17524 \family sans
17525 endnotes
17526 \family default
17527  package,
17528  which has some limitations but works with older LaTeX distributions as well.
17529  Use
17530 \family sans
17531 Insert\SpecialChar menuseparator
17532 List/Contents/References\SpecialChar menuseparator
17533 Endnotes
17534 \family default
17535  to insert the endnotes list where you want the endnotes to appear.
17536  See also
17537 \family sans
17538 Help\SpecialChar menuseparator
17539 Embedded\SpecialChar menuseparator
17540  Objects\SpecialChar menuseparator
17541 Notes\SpecialChar menuseparator
17542 Footnotes
17543 \family default
17544 .
17545 \end_layout
17546
17547 \begin_layout Subsection
17548
17549 \change_inserted 564990737 1672081439
17550 Footnotes as Endnotes (Extended)
17551 \end_layout
17552
17553 \begin_layout Standard
17554
17555 \change_inserted 564990737 1672081439
17556 This module sets all footnotes as endnotes.
17557  This uses the
17558 \family sans
17559 enotez
17560 \family default
17561  package which is more powerful and customizable than then
17562 \family sans
17563 endnotes
17564 \family default
17565  package,
17566  but requires a fairly modern LaTeX distribution (with LaTeX3).
17567  Use
17568 \family sans
17569 Insert\SpecialChar menuseparator
17570 List/Contents/References\SpecialChar menuseparator
17571 Endnotes
17572 \family default
17573  to insert the endnotes list where you want the endnotes to appear.
17574  See also
17575 \family sans
17576 Help\SpecialChar menuseparator
17577 Embedded\SpecialChar menuseparator
17578  Objects\SpecialChar menuseparator
17579 Notes\SpecialChar menuseparator
17580 Footnotes
17581 \family default
17582 .
17583 \end_layout
17584
17585 \begin_layout Section
17586
17587 \change_inserted 564990737 1672081439
17588 Leisure,
17589  Sports and Music
17590 \end_layout
17591
17592 \begin_layout Subsection
17593
17594 \change_inserted 564990737 1672081439
17595 Chess Board
17596 \end_layout
17597
17598 \begin_layout Standard
17599
17600 \change_inserted 564990737 1672081439
17601 This module provides support for the
17602 \family sans
17603 chessboard
17604 \family default
17605  package to print chess games.
17606  See
17607 \family sans
17608 File\SpecialChar menuseparator
17609 Open Example\SpecialChar menuseparator
17610 Articles\SpecialChar menuseparator
17611 Chess
17612 \family default
17613  where you will find
17614 \family sans
17615 Game 1
17616 \family default
17617  and
17618 \family sans
17619 Game 2
17620 \family default
17621  and the
17622 \begin_inset CommandInset href
17623 LatexCommand href
17624 name "chessboard documentation"
17625 target "http://mirrors.ctan.org/macros/latex/contrib/chessboard/chessboard.pdf"
17626 literal "false"
17627
17628 \end_inset
17629
17630 .
17631 \end_layout
17632
17633 \begin_layout Subsection
17634
17635 \change_inserted 564990737 1672081439
17636 Lilypond Music Notation
17637 \end_layout
17638
17639 \begin_layout Standard
17640
17641 \change_inserted 564990737 1672081439
17642 This module provides an inset via
17643 \family sans
17644 \bar under
17645 I
17646 \bar default
17647 nsert\SpecialChar menuseparator
17648 Custom Inset\SpecialChar menuseparator
17649 Lilypond
17650 \family default
17651  in which to enter code for the LilyPond music editor.
17652  It will then be processed in the output.
17653  See
17654 \family sans
17655 Help\SpecialChar menuseparator
17656 Specific Manuals\SpecialChar menuseparator
17657 Lilypond
17658 \family default
17659  and
17660 \family sans
17661 File\SpecialChar menuseparator
17662 Open Example\SpecialChar menuseparator
17663 Modules\SpecialChar menuseparator
17664 Lilypond Book
17665 \family default
17666 .
17667  It cannot be used if the modules
17668 \family sans
17669 Rnw
17670 \begin_inset space \thinspace{}
17671 \end_inset
17672
17673 (knitr) or Sweave
17674 \family default
17675  have been loaded.
17676 \end_layout
17677
17678 \begin_layout Section
17679
17680 \change_inserted 564990737 1672138150
17681 List enhancements
17682 \end_layout
17683
17684 \begin_layout Subsection
17685
17686 \change_inserted 564990737 1672138150
17687 Customizable Lists
17688 \begin_inset CommandInset label
17689 LatexCommand label
17690 name "subsec:Customizable-Lists"
17691
17692 \end_inset
17693
17694
17695 \end_layout
17696
17697 \begin_layout Standard
17698
17699 \change_inserted 564990737 1672138150
17700 This module uses the
17701 \family sans
17702  enumitem
17703 \family default
17704  package to enable the customization of various list environments.
17705 \end_layout
17706
17707 \begin_layout Subsubsection
17708
17709 \change_inserted 564990737 1672138150
17710 Custom Enumerate Lists
17711 \end_layout
17712
17713 \begin_layout Standard
17714 \noindent
17715
17716 \change_inserted 564990737 1672138150
17717 The default numbering of numbered lists can be changed by adding an optional argument (menu
17718 \family sans
17719 \bar under
17720 I
17721 \bar default
17722 nsert\SpecialChar menuseparator
17723
17724 \bar under
17725 S
17726 \bar default
17727 hort Title
17728 \family default
17729 ) to the first item of each level in the list.
17730  There you add the command
17731 \end_layout
17732
17733 \begin_layout Standard
17734
17735 \change_inserted 564990737 1672138150
17736
17737 \family sans
17738 label=
17739 \backslash
17740 roman{enumi}
17741 \end_layout
17742
17743 \begin_layout Standard
17744
17745 \change_inserted 564990737 1672138150
17746 in \SpecialChar TeX
17747  Code (shortcut
17748 \begin_inset Info
17749 type  "shortcut"
17750 arg   "ert-insert"
17751 \end_inset
17752
17753 ).
17754 \end_layout
17755
17756 \begin_layout Standard
17757
17758 \change_inserted 564990737 1672138150
17759
17760 \family sans
17761 enumi
17762 \family default
17763  is the first level counter of the enumeration.
17764  To change the numbering for the list sublevels,
17765  replace the “
17766 \family sans
17767 i
17768 \family default
17769 ” in the command by the small Roman numeral of the level (
17770 \family sans
17771 enumi
17772 \family default
17773 ,
17774
17775 \family sans
17776 enumii
17777 \family default
17778 ,
17779
17780 \family sans
17781 enumiii
17782 \family default
17783 ,
17784
17785 \family sans
17786 enumiv
17787 \family default
17788 ).
17789 \end_layout
17790
17791 \begin_layout Standard
17792
17793 \change_inserted 564990737 1672138150
17794 The command
17795 \family sans
17796
17797 \backslash
17798 roman
17799 \family default
17800  outputs the counter as a small Roman numeral.
17801  For capital Roman numerals replace
17802 \family sans
17803
17804 \backslash
17805 roman
17806 \family default
17807  with
17808 \family sans
17809
17810 \backslash
17811 Roman
17812 \family default
17813  in the command above.
17814  For Arabic numerals use
17815 \family sans
17816
17817 \backslash
17818 arabic
17819 \family default
17820 .
17821  To
17822 \begin_inset Quotes eld
17823 \end_inset
17824
17825 number
17826 \begin_inset Quotes erd
17827 \end_inset
17828
17829  items with capital or small Latin letters use
17830 \family sans
17831
17832 \backslash
17833 Alph
17834 \family default
17835  or
17836 \family sans
17837
17838 \backslash
17839 alph
17840 \family default
17841 ,
17842  respectively.
17843 \end_layout
17844
17845 \begin_layout Standard
17846 \noindent
17847
17848 \change_inserted 564990737 1672138150
17849 \begin_inset Note Greyedout
17850 status collapsed
17851
17852 \begin_layout Plain Layout
17853
17854 \change_inserted 564990737 1672138150
17855
17856 \series bold
17857 Note:
17858
17859 \series default
17860  You can only number 26
17861 \begin_inset space ~
17862 \end_inset
17863
17864 items with Latin letters,
17865  because this numbering is limited to single letters.
17866 \end_layout
17867
17868 \end_inset
17869
17870
17871 \end_layout
17872
17873 \begin_layout Standard
17874
17875 \change_inserted 564990737 1672138150
17876 Here is a list with custom numbering:
17877 \end_layout
17878
17879 \begin_layout Enumerate
17880
17881 \change_inserted 564990737 1672138150
17882 \begin_inset Argument 1
17883 status collapsed
17884
17885 \begin_layout Plain Layout
17886
17887 \change_inserted 564990737 1672138150
17888 \begin_inset ERT
17889 status collapsed
17890
17891 \begin_layout Plain Layout
17892
17893 \change_inserted 564990737 1672138150
17894
17895 label=
17896 \backslash
17897 #
17898 \backslash
17899 Alph{enumi}
17900 \backslash
17901 #
17902 \end_layout
17903
17904 \end_inset
17905
17906
17907 \change_unchanged
17908
17909 \end_layout
17910
17911 \end_inset
17912
17913 Level 1
17914 \begin_inset Separator latexpar
17915 \end_inset
17916
17917
17918 \end_layout
17919
17920 \begin_deeper
17921 \begin_layout Enumerate
17922
17923 \change_inserted 564990737 1672138150
17924 \begin_inset Argument 1
17925 status collapsed
17926
17927 \begin_layout Plain Layout
17928
17929 \change_inserted 564990737 1672138150
17930 \begin_inset ERT
17931 status collapsed
17932
17933 \begin_layout Plain Layout
17934
17935 \change_inserted 564990737 1672138150
17936
17937 label=
17938 \backslash
17939 Alph{enumi}.
17940 \backslash
17941 arabic{enumii}
17942 \end_layout
17943
17944 \end_inset
17945
17946
17947 \change_unchanged
17948
17949 \end_layout
17950
17951 \end_inset
17952
17953 Level 2
17954 \end_layout
17955
17956 \begin_layout Enumerate
17957
17958 \change_inserted 564990737 1672138150
17959 Level 2
17960 \begin_inset Separator latexpar
17961 \end_inset
17962
17963
17964 \end_layout
17965
17966 \begin_deeper
17967 \begin_layout Enumerate
17968
17969 \change_inserted 564990737 1672138150
17970 \begin_inset Argument 1
17971 status collapsed
17972
17973 \begin_layout Plain Layout
17974
17975 \change_inserted 564990737 1672138150
17976 \begin_inset ERT
17977 status collapsed
17978
17979 \begin_layout Plain Layout
17980
17981 \change_inserted 564990737 1672138150
17982
17983 label=
17984 \change_deleted 274215730 1672889016
17985
17986 \backslash
17987 bf
17988 \change_inserted 274215730 1672889016
17989
17990 \backslash
17991 bfseries
17992 \change_inserted 564990737 1672138150
17993 {
17994 \backslash
17995 arabic{enumiii}}
17996 \end_layout
17997
17998 \end_inset
17999
18000
18001 \change_unchanged
18002
18003 \end_layout
18004
18005 \end_inset
18006
18007 Level 3
18008 \begin_inset Separator latexpar
18009 \end_inset
18010
18011
18012 \end_layout
18013
18014 \begin_deeper
18015 \begin_layout Enumerate
18016
18017 \change_inserted 564990737 1672138150
18018 \begin_inset Argument 1
18019 status collapsed
18020
18021 \begin_layout Plain Layout
18022
18023 \change_inserted 564990737 1672138150
18024 \begin_inset ERT
18025 status collapsed
18026
18027 \begin_layout Plain Layout
18028
18029 \change_inserted 564990737 1672138150
18030
18031 label=
18032 \backslash
18033 emph{
18034 \backslash
18035 roman{enumiv})}
18036 \end_layout
18037
18038 \end_inset
18039
18040
18041 \change_unchanged
18042
18043 \end_layout
18044
18045 \end_inset
18046
18047 Level 4
18048 \end_layout
18049
18050 \end_deeper
18051 \end_deeper
18052 \end_deeper
18053 \begin_layout Standard
18054
18055 \change_inserted 564990737 1672138150
18056 For this list these commands were used:
18057 \end_layout
18058
18059 \begin_layout Standard
18060 \noindent
18061
18062 \change_inserted 564990737 1672138150
18063
18064 \family sans
18065 label=
18066 \backslash
18067 #
18068 \backslash
18069 Alph{enumi}
18070 \backslash
18071 #
18072 \begin_inset Newline newline
18073 \end_inset
18074
18075 label=
18076 \backslash
18077 Alph{enumi}.
18078 \backslash
18079 arabic{enumii}
18080 \begin_inset Newline newline
18081 \end_inset
18082
18083 label=
18084 \change_deleted 274215730 1672889037
18085
18086 \backslash
18087 bf
18088 \change_inserted 274215730 1672889037
18089
18090 \backslash
18091 bfseries
18092 \change_inserted 564990737 1672138150
18093 {
18094 \backslash
18095 arabic{enumiii}}
18096 \begin_inset Newline newline
18097 \end_inset
18098
18099 label=
18100 \backslash
18101 emph{
18102 \backslash
18103 roman{enumiv})}
18104 \end_layout
18105
18106 \begin_layout Standard
18107
18108 \change_inserted 564990737 1672138150
18109 where the command
18110 \family sans
18111
18112 \backslash
18113 emph{}
18114 \family default
18115  makes the label emphasized and
18116 \change_deleted 274215730 1672889045
18117
18118 \family sans
18119
18120 \backslash
18121 bf{}
18122 \change_inserted 274215730 1672889046
18123
18124 \backslash
18125 bfseries{}
18126 \change_inserted 564990737 1672138150
18127
18128 \family default
18129  makes it bold.
18130 \end_layout
18131
18132 \begin_layout Standard
18133
18134 \change_inserted 564990737 1672138150
18135 \begin_inset Note Greyedout
18136 status collapsed
18137
18138 \begin_layout Plain Layout
18139
18140 \change_inserted 564990737 1672138150
18141
18142 \series bold
18143 Note:
18144
18145 \series default
18146  When you change the label of a list level,
18147  it will be used for all following lists until you change the definition.
18148 \end_layout
18149
18150 \end_inset
18151
18152
18153 \end_layout
18154
18155 \begin_layout Standard
18156
18157 \change_inserted 564990737 1672138150
18158 \begin_inset ERT
18159 status open
18160
18161 \begin_layout Plain Layout
18162
18163 \change_inserted 564990737 1672138150
18164
18165
18166 \backslash
18167 renewcommand{
18168 \backslash
18169 labelenumi}{
18170 \backslash
18171 thesection.
18172 \backslash
18173 arabic{enumi}}
18174 \end_layout
18175
18176 \end_inset
18177
18178
18179 \end_layout
18180
18181 \begin_layout Subsubsection
18182
18183 \change_inserted 564990737 1672138150
18184 Numbered Paragraphs in Reports
18185 \end_layout
18186
18187 \begin_layout Enumerate
18188
18189 \change_inserted 564990737 1672138213
18190 Official reports often include numbered paragraphs;
18191  you can achieve this with a variation on the approach outlined in the footnote
18192 \begin_inset space ~
18193 \end_inset
18194
18195
18196 \begin_inset CommandInset ref
18197 LatexCommand ref
18198 reference "fn:If-you-really"
18199 plural "false"
18200 caps "false"
18201 noprefix "false"
18202 nolink "false"
18203
18204 \end_inset
18205
18206 .
18207  Replace
18208 \family sans
18209 item
18210 \family default
18211  in each command with
18212 \family sans
18213 enum
18214 \family default
18215 .
18216 \end_layout
18217
18218 \begin_layout Enumerate
18219
18220 \change_inserted 564990737 1672138150
18221 These numbered paragraphs were generated by inserting the \SpecialChar TeX
18222  Code
18223 \begin_inset Separator latexpar
18224 \end_inset
18225
18226
18227 \end_layout
18228
18229 \begin_deeper
18230 \begin_layout Standard
18231
18232 \change_inserted 564990737 1672138150
18233
18234 \family sans
18235
18236 \backslash
18237 renewcommand{
18238 \backslash
18239 labelenumi}{
18240 \backslash
18241 thesection.
18242 \backslash
18243 arabic{enumi}}
18244 \end_layout
18245
18246 \begin_layout Standard
18247
18248 \change_inserted 564990737 1672138150
18249 before the start of the section;
18250
18251 \family sans
18252
18253 \backslash
18254 thesection
18255 \family default
18256  uses the \SpecialChar LaTeX
18257  section counter to generate the first part of the number.
18258 \end_layout
18259
18260 \end_deeper
18261 \begin_layout Enumerate
18262
18263 \change_inserted 564990737 1672138150
18264 I have ignored the subsection heading in this example because,
18265  with paragraphs numbered in this way,
18266  subsections are less likely to be used.
18267 \end_layout
18268
18269 \begin_layout Subsubsection
18270
18271 \change_inserted 564990737 1672138150
18272 Resumed Enumeration
18273 \end_layout
18274
18275 \begin_layout Standard
18276
18277 \change_inserted 564990737 1672138150
18278 \begin_inset ERT
18279 status open
18280
18281 \begin_layout Plain Layout
18282
18283 \change_inserted 564990737 1672138150
18284
18285
18286 \backslash
18287 renewcommand{
18288 \backslash
18289 labelenumi}{
18290 \backslash
18291 arabic{enumi}}
18292 \end_layout
18293
18294 \end_inset
18295
18296
18297 \end_layout
18298
18299 \begin_layout Standard
18300
18301 \change_inserted 564990737 1672138150
18302 Enumerations can be resumed after intermediate paragraphs:
18303 \end_layout
18304
18305 \begin_layout Enumerate
18306
18307 \change_inserted 564990737 1672138150
18308 \begin_inset Argument 1
18309 status collapsed
18310
18311 \begin_layout Plain Layout
18312
18313 \change_inserted 564990737 1672138150
18314 \begin_inset ERT
18315 status collapsed
18316
18317 \begin_layout Plain Layout
18318
18319 \change_inserted 564990737 1672138150
18320
18321 label=
18322 \backslash
18323 arabic{enumi}.
18324 \end_layout
18325
18326 \end_inset
18327
18328
18329 \change_unchanged
18330
18331 \end_layout
18332
18333 \end_inset
18334
18335 first
18336 \begin_inset Note Note
18337 status collapsed
18338
18339 \begin_layout Plain Layout
18340
18341 \change_inserted 564990737 1672138150
18342 goes back to default numbering
18343 \end_layout
18344
18345 \end_inset
18346
18347
18348 \end_layout
18349
18350 \begin_layout Enumerate
18351
18352 \change_inserted 564990737 1672138150
18353 second
18354 \end_layout
18355
18356 \begin_layout Standard
18357
18358 \change_inserted 564990737 1672138150
18359 regular text
18360 \end_layout
18361
18362 \begin_layout Enumerate-Resume
18363
18364 \change_inserted 564990737 1672138150
18365 resumed
18366 \end_layout
18367
18368 \begin_layout Standard
18369
18370 \change_inserted 564990737 1672138150
18371 To resume an enumeration,
18372  use the style
18373 \family sans
18374 Enumerate-Resume
18375 \family default
18376 .
18377  Its numbering appears in blue within \SpecialChar LyX
18378  to indicate that it is a resumed list and that the numbering will not be correct in \SpecialChar LyX
18379 ,
18380  but in the output.
18381 \end_layout
18382
18383 \begin_layout Standard
18384
18385 \change_inserted 564990737 1672138150
18386 \begin_inset Note Greyedout
18387 status collapsed
18388
18389 \begin_layout Plain Layout
18390
18391 \change_inserted 564990737 1672138150
18392
18393 \series bold
18394 Note:
18395
18396 \series default
18397  If there is no previous enumeration to resume,
18398  you will get a \SpecialChar LaTeX
18399  error.
18400 \end_layout
18401
18402 \end_inset
18403
18404
18405 \end_layout
18406
18407 \begin_layout Standard
18408
18409 \change_inserted 564990737 1672138150
18410 Perhaps you might want to resume the list with a different number from the next one.
18411  Or you want to start a new enumeration with a defined number.
18412  This is possible by adding an optional argument to the first list item of a normal enumeration.
18413  There,
18414  insert the command
18415 \end_layout
18416
18417 \begin_layout Standard
18418
18419 \change_inserted 564990737 1672138150
18420
18421 \family sans
18422 start=number
18423 \end_layout
18424
18425 \begin_layout Standard
18426
18427 \change_inserted 564990737 1672138150
18428 where
18429 \family sans
18430 number
18431 \family default
18432  is the number with which you want to resume the list.
18433  An example:
18434 \end_layout
18435
18436 \begin_layout Enumerate
18437
18438 \change_inserted 564990737 1672138150
18439 first item
18440 \end_layout
18441
18442 \begin_layout Enumerate
18443
18444 \change_inserted 564990737 1672138150
18445 second item
18446 \end_layout
18447
18448 \begin_layout Standard
18449
18450 \change_inserted 564990737 1672138150
18451 Enumeration starting at a given value:
18452 \end_layout
18453
18454 \begin_layout Enumerate
18455
18456 \change_inserted 564990737 1672138150
18457 \begin_inset Argument 1
18458 status open
18459
18460 \begin_layout Plain Layout
18461
18462 \change_inserted 564990737 1672138150
18463 \begin_inset ERT
18464 status collapsed
18465
18466 \begin_layout Plain Layout
18467
18468 \change_inserted 564990737 1672138150
18469
18470 start=4
18471 \end_layout
18472
18473 \end_inset
18474
18475
18476 \change_unchanged
18477
18478 \end_layout
18479
18480 \end_inset
18481
18482 This enumeration starts at 4
18483 \end_layout
18484
18485 \begin_layout Subsubsection
18486
18487 \change_inserted 564990737 1672138150
18488 List Spacing
18489 \begin_inset Index idx
18490 range none
18491 pageformat default
18492 status collapsed
18493
18494 \begin_layout Plain Layout
18495
18496 \change_inserted 564990737 1672138150
18497 Lists !
18498  Spacing
18499 \change_unchanged
18500
18501 \end_layout
18502
18503 \end_inset
18504
18505
18506 \end_layout
18507
18508 \begin_layout Standard
18509
18510 \change_inserted 564990737 1672138150
18511 In some cases you might want less or more vertical space between the items of a list.
18512  For example if the default space is too much in your opinion in this case:
18513 \end_layout
18514
18515 \begin_layout Itemize
18516
18517 \change_inserted 564990737 1672138150
18518 A bullet list
18519 \end_layout
18520
18521 \begin_layout Itemize
18522
18523 \change_inserted 564990737 1672138150
18524 with standard spacing
18525 \end_layout
18526
18527 \begin_layout Standard
18528
18529 \change_inserted 564990737 1672138150
18530 You can decrease the space by adding an optional argument to the first item of the list.
18531  Add there the command
18532 \family sans
18533 nolistsep
18534 \family default
18535  to get no additional list space like in this example:
18536 \end_layout
18537
18538 \begin_layout Itemize
18539
18540 \change_inserted 564990737 1672138150
18541 \begin_inset Argument 1
18542 status open
18543
18544 \begin_layout Plain Layout
18545
18546 \change_inserted 564990737 1672138150
18547 \begin_inset ERT
18548 status collapsed
18549
18550 \begin_layout Plain Layout
18551
18552 \change_inserted 564990737 1672138150
18553
18554 nolistsep
18555 \end_layout
18556
18557 \end_inset
18558
18559
18560 \change_unchanged
18561
18562 \end_layout
18563
18564 \end_inset
18565
18566 A bullet list
18567 \end_layout
18568
18569 \begin_layout Itemize
18570
18571 \change_inserted 564990737 1672138150
18572 without additional
18573 \end_layout
18574
18575 \begin_layout Itemize
18576
18577 \change_inserted 564990737 1672138150
18578 vertical space
18579 \end_layout
18580
18581 \begin_layout Standard
18582
18583 \change_inserted 564990737 1672138150
18584 To add space you can use several other commands provided by the
18585 \family sans
18586 enumitem
18587 \family default
18588
18589 \begin_inset Index idx
18590 range none
18591 pageformat default
18592 status collapsed
18593
18594 \begin_layout Plain Layout
18595
18596 \change_inserted 564990737 1672138150
18597 \SpecialChar LaTeX
18598 -packages !
18599  enumitem
18600 \change_unchanged
18601
18602 \end_layout
18603
18604 \end_inset
18605
18606  package.
18607  For more information see the
18608 \begin_inset CommandInset href
18609 LatexCommand href
18610 name "enumitem documentation"
18611 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
18612 literal "false"
18613
18614 \end_inset
18615
18616 .
18617 \end_layout
18618
18619 \begin_layout Standard
18620
18621 \change_inserted 564990737 1672138150
18622 There are also many commands available to change the horizontal spacing and indentation.
18623  Here is an example where the indentation was changed to that of the paragraphs in the document and the label separation was set to 2
18624 \begin_inset space \thinspace{}
18625 \end_inset
18626
18627 cm so that the number is in the page margin:
18628 \end_layout
18629
18630 \begin_layout Enumerate
18631
18632 \change_inserted 564990737 1672138150
18633 \begin_inset Argument 1
18634 status open
18635
18636 \begin_layout Plain Layout
18637
18638 \change_inserted 564990737 1672138150
18639 \begin_inset ERT
18640 status collapsed
18641
18642 \begin_layout Plain Layout
18643
18644 \change_inserted 564990737 1672138150
18645
18646 labelindent=
18647 \backslash
18648 parindent,
18649  labelsep=2cm
18650 \end_layout
18651
18652 \end_inset
18653
18654
18655 \change_unchanged
18656
18657 \end_layout
18658
18659 \end_inset
18660
18661 An enumeration
18662 \end_layout
18663
18664 \begin_layout Enumerate
18665
18666 \change_inserted 564990737 1672138150
18667 with negative indentation
18668 \end_layout
18669
18670 \begin_layout Subsubsection
18671
18672 \change_inserted 564990737 1672138150
18673 Further Customization
18674 \begin_inset Index idx
18675 range none
18676 pageformat default
18677 status collapsed
18678
18679 \begin_layout Plain Layout
18680
18681 \change_inserted 564990737 1672138150
18682 Lists !
18683  Customization
18684 \change_unchanged
18685
18686 \end_layout
18687
18688 \end_inset
18689
18690
18691 \end_layout
18692
18693 \begin_layout Standard
18694
18695 \change_inserted 564990737 1672138150
18696 You can also change the style of description lists.
18697  The command
18698 \end_layout
18699
18700 \begin_layout Standard
18701
18702 \change_inserted 564990737 1672138150
18703
18704 \family sans
18705 font=definition
18706 \end_layout
18707
18708 \begin_layout Standard
18709
18710 \change_inserted 564990737 1672138150
18711 changes the description label font,
18712  the command
18713 \end_layout
18714
18715 \begin_layout Standard
18716
18717 \change_inserted 564990737 1672138150
18718
18719 \family sans
18720 style=definitio
18721 \family default
18722 \series bold
18723 n
18724 \end_layout
18725
18726 \begin_layout Standard
18727
18728 \change_inserted 564990737 1672138150
18729 sets the list style.
18730 \end_layout
18731
18732 \begin_layout Standard
18733
18734 \change_inserted 564990737 1672138150
18735 An example where the command
18736 \end_layout
18737
18738 \begin_layout Standard
18739
18740 \change_inserted 564990737 1672138150
18741
18742 \family sans
18743 font=
18744 \backslash
18745 itshape,
18746  style=nextline
18747 \end_layout
18748
18749 \begin_layout Standard
18750
18751 \change_inserted 564990737 1672138150
18752 is used:
18753 \end_layout
18754
18755 \begin_layout Description
18756
18757 \change_inserted 564990737 1672138150
18758 Ionizing
18759 \begin_inset space ~
18760 \end_inset
18761
18762 radiation:
18763
18764 \begin_inset Argument 1
18765 status collapsed
18766
18767 \begin_layout Plain Layout
18768
18769 \change_inserted 564990737 1672138150
18770 \begin_inset ERT
18771 status collapsed
18772
18773 \begin_layout Plain Layout
18774
18775 \change_inserted 564990737 1672138150
18776
18777 labelindent=0pt,
18778  labelsep=1cm,
18779  font=
18780 \backslash
18781 itshape,
18782  style=nextline
18783 \end_layout
18784
18785 \end_inset
18786
18787
18788 \change_unchanged
18789
18790 \end_layout
18791
18792 \end_inset
18793
18794 Ionizing radiation consists of particles or electromagnetic waves that are energetic enough to detach electrons from atoms or molecules,
18795  therefore ionizing them.
18796 \end_layout
18797
18798 \begin_layout Description
18799
18800 \change_inserted 564990737 1672138150
18801 Reference
18802 \begin_inset space ~
18803 \end_inset
18804
18805 counting:
18806  In computer science,
18807  reference counting is a technique of storing the number of references,
18808  pointers,
18809  or handles to a resource such as an object,
18810  block of memory,
18811  disk space or other resource.
18812 \end_layout
18813
18814 \begin_layout Standard
18815
18816 \change_inserted 564990737 1672138150
18817 There are many more commands and features provided by the
18818 \family sans
18819 enumitem
18820 \family default
18821
18822 \begin_inset Index idx
18823 range none
18824 pageformat default
18825 status collapsed
18826
18827 \begin_layout Plain Layout
18828
18829 \change_inserted 564990737 1672138150
18830 \SpecialChar LaTeX
18831 -packages !
18832  enumitem
18833 \change_unchanged
18834
18835 \end_layout
18836
18837 \end_inset
18838
18839  package.
18840  For more information see the
18841 \begin_inset CommandInset href
18842 LatexCommand href
18843 name "enumitem documentation"
18844 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
18845 literal "false"
18846
18847 \end_inset
18848
18849 .
18850 \end_layout
18851
18852 \begin_layout Subsection
18853
18854 \change_inserted 564990737 1672138150
18855
18856 \series bold
18857 Paragraph Lists
18858 \end_layout
18859
18860 \begin_layout Standard
18861
18862 \change_inserted 564990737 1672138150
18863 This module uses the package
18864 \family sans
18865 paralist
18866 \family default
18867  to provide nine new list environments.
18868  Itemized and enumerated lists can be typeset within paragraphs,
18869  as paragraphs and in a compact version.
18870  Most environments have optional arguments to format the labels.
18871  Additionally,
18872  the \SpecialChar LaTeX
18873  list environments itemize and enumerate are extended to use a similar optional argument.
18874  For further details see
18875 \family sans
18876 File\SpecialChar menuseparator
18877 Open Example\SpecialChar menuseparator
18878 Modules\SpecialChar menuseparator
18879 Paragraph Lists (paralist)
18880 \family default
18881 ,
18882
18883 \family sans
18884 Help\SpecialChar menuseparator
18885 Specific Manuals\SpecialChar menuseparator
18886 Paralist
18887 \family default
18888  and the
18889 \begin_inset CommandInset href
18890 LatexCommand href
18891 name "paralist documentation"
18892 target "http://mirrors.ctan.org/macros/latex/contrib/paralist/paralist.pdf"
18893 literal "false"
18894
18895 \end_inset
18896
18897 .
18898 \end_layout
18899
18900 \begin_layout Section
18901
18902 \change_inserted 564990737 1672161542
18903 Literate Programming
18904 \end_layout
18905
18906 \begin_layout Subsection
18907
18908 \change_inserted 564990737 1672161542
18909 Noweb
18910 \end_layout
18911
18912 \begin_layout Standard
18913
18914 \change_inserted 564990737 1672161542
18915 This module allows the use of Noweb as a literate programming tool.
18916  The files and the documentation for Noweb can be obtained from
18917 \begin_inset CommandInset href
18918 LatexCommand href
18919 name "CTAN"
18920 target "https://www.ctan.org/pkg/noweb"
18921 literal "false"
18922
18923 \end_inset
18924
18925 .
18926  Literate programming is described in section
18927 \begin_inset space ~
18928 \end_inset
18929
18930
18931 \begin_inset CommandInset ref
18932 LatexCommand ref
18933 reference "sec:Literate-Programming"
18934 nolink "false"
18935
18936 \end_inset
18937
18938  and there are three example files:
18939
18940 \family sans
18941 File\SpecialChar menuseparator
18942 Open Example\SpecialChar menuseparator
18943 Modules\SpecialChar menuseparator
18944 Noweb
18945 \family default
18946 ,
18947
18948 \family sans
18949 File\SpecialChar menuseparator
18950 Open Example\SpecialChar menuseparator
18951 Modules\SpecialChar menuseparator
18952 Noweb Listerrors
18953 \family default
18954  and
18955 \family sans
18956 File\SpecialChar menuseparator
18957 Open Example\SpecialChar menuseparator
18958 Modules\SpecialChar menuseparator
18959 Noweb2\SpecialChar LyX
18960
18961 \family default
18962 .
18963 \end_layout
18964
18965 \begin_layout Subsection
18966
18967 \change_inserted 564990737 1672161542
18968 Rnw (knitr)
18969 \end_layout
18970
18971 \begin_layout Standard
18972
18973 \change_inserted 564990737 1672161542
18974 This module uses the
18975 \family typewriter
18976 knitr
18977 \family default
18978  and
18979 \family sans
18980 includernw
18981 \family default
18982  packages.
18983  The
18984 \begin_inset Flex Code
18985 status collapsed
18986
18987 \begin_layout Plain Layout
18988
18989 \change_inserted 564990737 1672161542
18990 knitr
18991 \change_unchanged
18992
18993 \end_layout
18994
18995 \end_inset
18996
18997  package in R for dynamic report generation has to be installed for this module to work:
18998
18999 \begin_inset Flex Code
19000 status collapsed
19001
19002 \begin_layout Plain Layout
19003
19004 \change_inserted 564990737 1672161542
19005 install.packages(“knitr”)
19006 \change_unchanged
19007
19008 \end_layout
19009
19010 \end_inset
19011
19012 .
19013
19014 \end_layout
19015
19016 \begin_layout Paragraph
19017
19018 \change_inserted 564990737 1672161542
19019 Note
19020 \end_layout
19021
19022 \begin_layout Standard
19023
19024 \change_inserted 564990737 1672161542
19025 it depends on R >= 2.14.1.
19026  For more info see
19027 \begin_inset Flex URL
19028 status collapsed
19029
19030 \begin_layout Plain Layout
19031
19032 \change_inserted 564990737 1672161542
19033
19034 http://yihui.name/knitr
19035 \change_unchanged
19036
19037 \end_layout
19038
19039 \end_inset
19040
19041 .
19042
19043 \end_layout
19044
19045 \begin_layout Standard
19046
19047 \change_inserted 564990737 1672161542
19048 The package
19049 \family sans
19050 includernw
19051 \family default
19052  also has to be installed.
19053  It cannot be used if the modules
19054 \family sans
19055 LilyPond
19056 \begin_inset space ~
19057 \end_inset
19058
19059 Book
19060 \family default
19061  or
19062 \family sans
19063 Sweave
19064 \family default
19065  are loaded.
19066  See
19067 \family sans
19068 Help\SpecialChar menuseparator
19069 Specific Manuals\SpecialChar menuseparator
19070 Knitr
19071 \family default
19072 ,
19073
19074 \family sans
19075 File\SpecialChar menuseparator
19076 Open Example\SpecialChar menuseparator
19077 Modules\SpecialChar menuseparator
19078 Rnw (knitr)
19079 \family default
19080  and section
19081 \begin_inset space ~
19082 \end_inset
19083
19084
19085 \begin_inset CommandInset ref
19086 LatexCommand ref
19087 reference "sec:Literate-Programming"
19088 nolink "false"
19089
19090 \end_inset
19091
19092  for information about literate programming.
19093 \end_layout
19094
19095 \begin_layout Subsection
19096
19097 \change_inserted 564990737 1672161542
19098 Sweave
19099 \end_layout
19100
19101 \begin_layout Standard
19102
19103 \change_inserted 564990737 1672161542
19104 This module allows the use of the statistical language S/R as a literate programming tool.
19105  It requires the
19106 \family sans
19107 includernw
19108 \family default
19109  and
19110 \family sans
19111 fancyvrb
19112 \family default
19113  packages.
19114  Both
19115 \begin_inset CommandInset href
19116 LatexCommand href
19117 name "includernw"
19118 target "https://www.ctan.org/pkg/includernw"
19119 literal "false"
19120
19121 \end_inset
19122
19123  and
19124 \begin_inset CommandInset href
19125 LatexCommand href
19126 name "fancyvrb"
19127 target "https://www.ctan.org/pkg/fancyvrb"
19128 literal "false"
19129
19130 \end_inset
19131
19132  are available from CTAN.
19133  It cannot be used if the module
19134 \family sans
19135 LilyPond
19136 \begin_inset space ~
19137 \end_inset
19138
19139 Book
19140 \family default
19141  has been loaded.
19142  See
19143 \family sans
19144 Help\SpecialChar menuseparator
19145 Specific Manuals\SpecialChar menuseparator
19146 Sweave,
19147
19148 \family default
19149
19150 \family sans
19151 File\SpecialChar menuseparator
19152 Open Example\SpecialChar menuseparator
19153 Modules\SpecialChar menuseparator
19154 Sweave
19155 \family default
19156  and section
19157 \begin_inset space ~
19158 \end_inset
19159
19160
19161 \begin_inset CommandInset ref
19162 LatexCommand ref
19163 reference "sec:Literate-Programming"
19164 nolink "false"
19165
19166 \end_inset
19167
19168  for information about literate programming.
19169 \end_layout
19170
19171 \begin_layout Section
19172
19173 \change_inserted 564990737 1672224959
19174 Maths
19175 \end_layout
19176
19177 \begin_layout Subsection
19178
19179 \change_inserted 564990737 1672224959
19180 AMS Theorems
19181 \end_layout
19182
19183 \begin_layout Standard
19184
19185 \change_inserted 564990737 1672224959
19186 This modules defines theorem environments and the proof environment using the extended AMS machinery.
19187  Both numbered and unnumbered types are provided.
19188  By default,
19189  the theorems are numbered consecutively throughout the document.
19190  This can be changed by loading one of the
19191 \family sans
19192 AMS Theorems (Numbered by \SpecialChar ldots
19193 )
19194 \family default
19195  modules.
19196  It cannot be used if the modules
19197 \family sans
19198 Standard Theorems
19199 \family default
19200  or
19201 \family sans
19202 Standard Theorems (Unnumbered)
19203 \family default
19204  have been loaded.
19205 \end_layout
19206
19207 \begin_layout Subsection
19208
19209 \change_inserted 564990737 1672224959
19210 AMS Theorems (Extended)
19211 \end_layout
19212
19213 \begin_layout Standard
19214
19215 \change_inserted 564990737 1672224959
19216 This module defines some additional theorem environments for use with the
19217 \family sans
19218 AMS Theorems
19219 \family default
19220  package (which must be loaded).
19221  It includes Criterion,
19222  Algorithm,
19223  Axiom,
19224  Condition,
19225  Note,
19226  Notation,
19227  Summary,
19228  Acknowledgement,
19229  Conclusion,
19230  Fact,
19231  Assumption,
19232  Case and Question in both numbered and unnumbered forms.
19233 \end_layout
19234
19235 \begin_layout Subsection
19236
19237 \change_inserted 564990737 1672224959
19238 AMS Theorems (Extended,
19239  Numbered by Type within Chapters)
19240 \end_layout
19241
19242 \begin_layout Standard
19243
19244 \change_inserted 564990737 1672224959
19245 This module defines some additional theorem environments for use with the
19246 \family sans
19247 AMS Theorems (Numbered by Type within Chapters)
19248 \family default
19249  package (which must be loaded).
19250  It includes Criterion,
19251  Algorithm,
19252  Axiom,
19253  Condition,
19254  Note,
19255  Notation,
19256  Summary,
19257  Acknowledgement,
19258  Conclusion,
19259  Assumption and Case in both numbered and unnumbered forms.
19260  Unlike the
19261 \family sans
19262 AMS Theorems (Extended)
19263 \family default
19264  module,
19265  the different theorem types provided here each have a separate counter,
19266  restarted with each new chapter (e.g.,
19267  criterion 1.1,
19268  criterion 1.2,
19269  axiom 1.1,
19270  assumption 1.1,
19271  criterion 2.1,
19272  criterion 2.2,
19273  axiom 2.1\SpecialChar ldots
19274 ,
19275  as opposed to criterion 1,
19276  criterion 2,
19277  axiom 3,
19278  assumption 4...).
19279 \end_layout
19280
19281 \begin_layout Subsection
19282
19283 \change_inserted 564990737 1672224959
19284 AMS Theorems (Extended,
19285  Numbered by Type)
19286 \end_layout
19287
19288 \begin_layout Standard
19289
19290 \change_inserted 564990737 1672224959
19291 This module defines some additional theorem environments for use with the
19292 \family sans
19293 AMS Theorems (Numbered by Type)
19294 \family default
19295  package (which must be loaded).
19296  It includes Criterion,
19297  Algorithm,
19298  Axiom,
19299  Condition,
19300  Note,
19301  Notation,
19302  Summary,
19303  Acknowledgement,
19304  Conclusion,
19305  Assumption and Case in both numbered and unnumbered forms.
19306  Unlike the
19307 \family sans
19308 AMS Theorems (Extended)
19309 \family default
19310  module,
19311  the different theorem types provided here each have a separate counter (e.g.,
19312  criterion 1,
19313  criterion 2,
19314  axiom 1,
19315  assumption 1,
19316  criterion 3,
19317  \SpecialChar ldots
19318 ,
19319  as opposed to criterion 1,
19320  criterion 2,
19321  axiom 3,
19322  assumption 4,
19323  \SpecialChar ldots
19324 ).
19325 \end_layout
19326
19327 \begin_layout Subsection
19328
19329 \change_inserted 564990737 1672224959
19330 AMS Theorems (Numbered by Type within Chapters)
19331 \end_layout
19332
19333 \begin_layout Standard
19334
19335 \change_inserted 564990737 1672224959
19336 This module defines theorem environments and the proof environment using the extended AMS machinery.
19337  Both numbered and unnumbered types are provided.
19338  Unlike the
19339 \family sans
19340 AMS Theorems
19341 \family default
19342  module,
19343  the different theorem types provided here each have a separate counter (e.g.,
19344  theorem 1.1,
19345  theorem 1.2,
19346  lemma 1.1,
19347  proposition 1.1,
19348  theorem 1.3,
19349  lemma 1.2,
19350  \SpecialChar ldots
19351 ,
19352  as opposed to theorem 1,
19353  theorem 2,
19354  lemma 3,
19355  proposition 4,
19356  \SpecialChar ldots
19357 ).
19358  The numbering restarts for each chapter:
19359  theorem 1.1,
19360  theorem 2.1,
19361  \SpecialChar ldots
19362  It cannot be used if the modules
19363 \family sans
19364 AMS Theorems
19365 \family default
19366 ,
19367
19368 \family sans
19369 Standard Theorems
19370 \family default
19371 ,
19372
19373 \family sans
19374  Standard Theorems (Numbered by Type)
19375 \family default
19376  or
19377 \family sans
19378  Standard Theorems (Unnumbered)
19379 \family default
19380  have been loaded.
19381 \end_layout
19382
19383 \begin_layout Subsection
19384
19385 \change_inserted 564990737 1672224959
19386 AMS Theorems (Numbered by Type)
19387 \end_layout
19388
19389 \begin_layout Standard
19390
19391 \change_inserted 564990737 1672224959
19392 This module defines theorem environments and the proof environment using the extended AMS machinery.
19393  Both numbered and unnumbered types are provided.
19394  Unlike the
19395 \family sans
19396 AMS Theorems
19397 \family default
19398  module,
19399  the different theorem types provided here each have a separate counter (e.g.,
19400  theorem 1,
19401  theorem 2,
19402  lemma 1,
19403  proposition 1,
19404  theorem 3,
19405  lemma 2,
19406  \SpecialChar ldots
19407 ,
19408  as opposed to theorem 1,
19409  theorem 2,
19410  lemma 3,
19411  proposition 4,
19412  \SpecialChar ldots
19413 ).
19414  The numbering’s scope is the whole document.
19415  For chapter- and section-wide numbering,
19416  use one of the ‘within Sections’/‘within Chapters’ modules,
19417  respectively.
19418  It cannot be used if the modules
19419 \family sans
19420 AMS Theorems
19421 \family default
19422 ,
19423
19424 \family sans
19425 Standard Theorems
19426 \family default
19427 ,
19428
19429 \family sans
19430  Standard Theorems (Numbered by Type)
19431 \family default
19432  or
19433 \family sans
19434  Standard Theorems (Unnumbered)
19435 \family default
19436  have been loaded.
19437 \end_layout
19438
19439 \begin_layout Subsection
19440
19441 \change_inserted 564990737 1672224959
19442 Number Equations by Section
19443 \end_layout
19444
19445 \begin_layout Standard
19446
19447 \change_inserted 564990737 1672224959
19448 This module resets the equation number at section start and prepends the section number to the equation number,
19449  as in “(2.1).”
19450 \end_layout
19451
19452 \begin_layout Subsection
19453
19454 \change_inserted 564990737 1672224959
19455 Standard Theorems
19456 \end_layout
19457
19458 \begin_layout Standard
19459
19460 \change_inserted 564990737 1672224959
19461 This module defines some theorem environments for use with non-AMS classes.
19462  By default,
19463  the theorems are numbered consecutively throughout the document.
19464  This can be changed by loading one of the
19465 \family sans
19466 Standard Theorems (Numbered by \SpecialChar ldots
19467 )
19468 \family default
19469  modules.
19470  It cannot be used if the modules
19471 \family sans
19472 AMS Theorems
19473 \family default
19474  or
19475 \family sans
19476  Standard Theorems (Unnumbered)
19477 \family default
19478  have been loaded.
19479
19480 \end_layout
19481
19482 \begin_layout Subsection
19483
19484 \change_inserted 564990737 1672224959
19485 Standard Theorems (Nameable)
19486 \end_layout
19487
19488 \begin_layout Standard
19489
19490 \change_inserted 564990737 1672224959
19491 This module facilitates the use of named theorems.
19492  The name of the theorem goes into the “Additional Theorem Text” argument.
19493
19494 \end_layout
19495
19496 \begin_layout Subsection
19497
19498 \change_inserted 564990737 1672224959
19499 Standard Theorems (Numbered by Chapter)
19500 \end_layout
19501
19502 \begin_layout Standard
19503
19504 \change_inserted 564990737 1672224959
19505 This module numbers theorems and the like by chapter (i.e.,
19506  the counter is reset at each chapter start).
19507  Use this module only with document classes that provide a chapter environment.
19508  One of the modules
19509 \family sans
19510 AMS Theorems
19511 \family default
19512  or
19513 \family sans
19514 Standard Theorems
19515 \family default
19516  must be loaded.
19517  It cannot be used if the module
19518 \family sans
19519  Standard Theorems (Numbered by Section)
19520 \family default
19521  has been loaded.
19522 \end_layout
19523
19524 \begin_layout Subsection
19525
19526 \change_inserted 564990737 1672224959
19527 Standard Theorems (Numbered by Section)
19528 \end_layout
19529
19530 \begin_layout Standard
19531
19532 \change_inserted 564990737 1672224959
19533 This module numbers theorems and the like by section (i.e.,
19534  the counter is reset at each section start).
19535  One of the modules
19536 \family sans
19537 AMS Theorems
19538 \family default
19539  or
19540 \family sans
19541 Standard Theorems
19542 \family default
19543  must be loaded.
19544  It cannot be used if the module
19545 \family sans
19546  Standard Theorems (Numbered by Chapter)
19547 \family default
19548  has been loaded.
19549 \end_layout
19550
19551 \begin_layout Subsection
19552
19553 \change_inserted 564990737 1672224959
19554 Standard Theorems (Numbered by Type within Chapters)
19555 \end_layout
19556
19557 \begin_layout Standard
19558
19559 \change_inserted 564990737 1672224959
19560 This module defines some theorem environments for use with non-AMS classes.
19561  Unlike the
19562 \family sans
19563  AMS Theorems
19564 \family default
19565  and
19566 \family sans
19567 Standard Theorems
19568 \family default
19569  modules,
19570  the different theorem types provided here each have a separate counter (e.g.,
19571  theorem 1,
19572  theorem 2,
19573  lemma 1,
19574  proposition 1,
19575  theorem 3,
19576  lemma 2,
19577  \SpecialChar ldots
19578 ,
19579  as opposed to theorem 1,
19580  theorem 2,
19581  lemma 3,
19582  proposition 4,
19583  \SpecialChar ldots
19584 ).
19585  The numbering is reset at each chapter start.
19586  One of the modules
19587 \family sans
19588 AMS Theorems (Numbered by Type)
19589 \family default
19590  or
19591 \family sans
19592 Standard Theorems (Numbered by Type)
19593 \family default
19594  must be loaded.
19595  It cannot be used if any of the modules
19596 \family sans
19597  AMS Theorems
19598 \family default
19599 ,
19600
19601 \family sans
19602 Standard Theorems
19603 \family default
19604 ,
19605
19606 \family sans
19607 Standard Theorems (Unnumbered)
19608 \family default
19609 ,
19610
19611 \family sans
19612  Standard Theorems (Numbered by Sections)
19613 \family default
19614  or
19615 \family sans
19616 Standard Theorems (Numbered by Type within Sections)
19617 \family default
19618  have been loaded.
19619 \end_layout
19620
19621 \begin_layout Subsection
19622
19623 \change_inserted 564990737 1672224959
19624 Standard Theorems (Numbered by Type within Sections)
19625 \end_layout
19626
19627 \begin_layout Standard
19628
19629 \change_inserted 564990737 1672224959
19630 This module defines some theorem environments for use with non-AMS classes.
19631  Unlike the
19632 \family sans
19633  AMS Theorems
19634 \family default
19635  and
19636 \family sans
19637 Standard Theorems
19638 \family default
19639  modules,
19640  the different theorem types provided here each have a separate counter (e.g.,
19641  theorem 1,
19642  theorem 2,
19643  lemma 1,
19644  proposition 1,
19645  theorem 3,
19646  lemma 2,
19647  \SpecialChar ldots
19648 ,
19649  as opposed to theorem 1,
19650  theorem 2,
19651  lemma 3,
19652  proposition 4,
19653  \SpecialChar ldots
19654 ).
19655  The numbering is reset at each section start.
19656  One of the modules
19657 \family sans
19658 AMS Theorems (Numbered by Type)
19659 \family default
19660  or
19661 \family sans
19662 Standard Theorems (Numbered by Type)
19663 \family default
19664  must be loaded.
19665  It cannot be used if any of the modules
19666 \family sans
19667  AMS Theorems
19668 \family default
19669 ,
19670
19671 \family sans
19672 Standard Theorems
19673 \family default
19674 ,
19675
19676 \family sans
19677 Standard Theorems (Unnumbered)
19678 \family default
19679 ,
19680
19681 \family sans
19682  Standard Theorems (Numbered by Chapters)
19683 \family default
19684  or
19685 \family sans
19686 Standard Theorems (Numbered by Type within Chapters)
19687 \family default
19688  have been loaded.
19689 \end_layout
19690
19691 \begin_layout Subsection
19692
19693 \change_inserted 564990737 1672224959
19694 Standard Theorems (Numbered by Type)
19695 \end_layout
19696
19697 \begin_layout Standard
19698
19699 \change_inserted 564990737 1672224959
19700 This module defines some theorem environments for use with non-AMS classes.
19701  Unlike the
19702 \family sans
19703 AMS Theorems
19704 \family default
19705  and
19706 \family sans
19707 Standard Theorems
19708 \family default
19709  modules,
19710  the different theorem types provided here each have a separate counter (e.g.,
19711  theorem 1,
19712  theorem 2,
19713  lemma 1,
19714  proposition 1,
19715  theorem 3,
19716  lemma 2,
19717  \SpecialChar ldots
19718 ,
19719  as opposed to theorem 1,
19720  theorem 2,
19721  lemma 3,
19722  proposition 4,
19723  \SpecialChar ldots
19724 ).
19725  The numbering’s scope is the whole document.
19726  For chapter- and section-wide numbering,
19727  use one of the “within Chapters”/“within Sections” modules,
19728  respectively.
19729  It cannot be used if any of the modules
19730 \family sans
19731  AMS Theorems
19732 \family default
19733 ,
19734
19735 \family sans
19736 Standard Theorems
19737 \family default
19738 ,
19739
19740 \family sans
19741 Standard Theorems (Unnumbered)
19742 \family default
19743  or
19744 \family sans
19745  AMS Theorems (Numbered by Type)
19746 \family default
19747  have been loaded.
19748 \end_layout
19749
19750 \begin_layout Subsection
19751
19752 \change_inserted 564990737 1672224959
19753 Standard Theorems (Unnumbered)
19754 \end_layout
19755
19756 \begin_layout Standard
19757
19758 \change_inserted 564990737 1672224959
19759 This module defines only unnumbered theorem environments and the proof environment,
19760  using the extended AMS machinery.
19761  It cannot be used if either of the modules
19762 \family sans
19763  AMS Theorems
19764 \family default
19765  or
19766 \family sans
19767  Standard Theorems
19768 \family default
19769  have been loaded.
19770 \end_layout
19771
19772 \begin_layout Subsection
19773
19774 \change_inserted 564990737 1672224959
19775 Subequations
19776 \end_layout
19777
19778 \begin_layout Standard
19779
19780 \change_inserted 564990737 1672224959
19781 This module provides a straightforward way to segregate subequations in LyX.
19782  See
19783 \family sans
19784 Help\SpecialChar menuseparator
19785 Math\SpecialChar menuseparator
19786 Subnumbering
19787 \family default
19788 .
19789
19790 \end_layout
19791
19792 \begin_layout Section
19793
19794 \change_inserted 564990737 1672236008
19795 Page Layout
19796 \end_layout
19797
19798 \begin_layout Subsection
19799
19800 \change_inserted 564990737 1672236008
19801 Custom Header/Footer Text
19802 \end_layout
19803
19804 \begin_layout Standard
19805
19806 \change_inserted 564990737 1672236008
19807 This module requires the
19808 \family sans
19809 Page
19810 \begin_inset space ~
19811 \end_inset
19812
19813
19814 \bar under
19815 s
19816 \bar default
19817 tyle
19818 \family default
19819  option in the
19820 \family sans
19821 \bar under
19822 D
19823 \bar default
19824 ocument\SpecialChar menuseparator
19825
19826 \bar under
19827 S
19828 \bar default
19829 ettings\SpecialChar menuseparator
19830 Page
19831 \begin_inset space ~
19832 \end_inset
19833
19834 Layout
19835 \family default
19836  dialog to be set to
19837 \family typewriter
19838 fancy
19839 \family default
19840 .
19841  It adds six environments to document classes which support the
19842 \family typewriter
19843 fancyhdr
19844 \family default
19845  package:
19846 \end_layout
19847
19848 \begin_layout Itemize
19849
19850 \change_inserted 564990737 1672236008
19851
19852 \family sans
19853 Left Header
19854 \end_layout
19855
19856 \begin_layout Itemize
19857
19858 \change_inserted 564990737 1672236008
19859
19860 \family sans
19861 Center Header
19862 \end_layout
19863
19864 \begin_layout Itemize
19865
19866 \change_inserted 564990737 1672236008
19867
19868 \family sans
19869 Right Header
19870 \end_layout
19871
19872 \begin_layout Itemize
19873
19874 \change_inserted 564990737 1672236008
19875
19876 \family sans
19877 Left Footer
19878 \end_layout
19879
19880 \begin_layout Itemize
19881
19882 \change_inserted 564990737 1672236008
19883
19884 \family sans
19885 Center Footer
19886 \end_layout
19887
19888 \begin_layout Itemize
19889
19890 \change_inserted 564990737 1672236008
19891
19892 \family sans
19893 Right Footer
19894 \end_layout
19895
19896 \begin_layout Subsubsection
19897
19898 \change_inserted 564990737 1672236008
19899 Fancy Headers and Footers
19900 \end_layout
19901
19902 \begin_layout Standard
19903
19904 \change_inserted 564990737 1672236008
19905 The default page layout is rather plain;
19906  for an
19907 \begin_inset Flex Code
19908 status collapsed
19909
19910 \begin_layout Plain Layout
19911
19912 \change_inserted 564990737 1672236008
19913 article
19914 \change_unchanged
19915
19916 \end_layout
19917
19918 \end_inset
19919
19920  document class,
19921  all you get is a centered page number at the bottom of the page.
19922  This document uses KOMA-script’s book class;
19923  so it appears to be a bit fancier.
19924  Once the
19925 \family sans
19926 Page
19927 \begin_inset space ~
19928 \end_inset
19929
19930
19931 \bar under
19932 s
19933 \bar default
19934 tyle
19935 \family default
19936  in
19937 \family sans
19938 \bar under
19939 D
19940 \bar default
19941 ocument\SpecialChar menuseparator
19942
19943 \bar under
19944 S
19945 \bar default
19946 ettings\SpecialChar menuseparator
19947 Page Layout
19948 \family default
19949  is set to
19950 \begin_inset Quotes eld
19951 \end_inset
19952
19953 fancy
19954 \begin_inset Quotes erd
19955 \end_inset
19956
19957 ,
19958  you will find that the page header is divided into three fields,
19959  not surprisingly labeled
19960 \begin_inset Quotes eld
19961 \end_inset
19962
19963 left
19964 \begin_inset Quotes erd
19965 \end_inset
19966
19967 ,
19968
19969 \begin_inset Quotes eld
19970 \end_inset
19971
19972 center
19973 \begin_inset Quotes erd
19974 \end_inset
19975
19976 ,
19977  and
19978 \begin_inset Quotes eld
19979 \end_inset
19980
19981 right
19982 \begin_inset Quotes erd
19983 \end_inset
19984
19985 .
19986  The footer is also divided into these three fields.
19987  The \SpecialChar LaTeX
19988  commands to set these fields in the simplest manner are
19989 \family sans
19990
19991 \backslash
19992 lhead
19993 \family default
19994 ,
19995
19996 \family sans
19997
19998 \backslash
19999 chead
20000 \family default
20001 ,
20002
20003 \family sans
20004
20005 \backslash
20006 rhead
20007 \family default
20008 ,
20009
20010 \family sans
20011
20012 \backslash
20013 lfoot
20014 \family default
20015 ,
20016  etc.
20017  Suppose you wish to put your name in the upper left hand corner of each page.
20018  Simply insert the following command in the preamble:
20019
20020 \end_layout
20021
20022 \begin_layout Standard
20023
20024 \change_inserted 564990737 1672236008
20025
20026 \family sans
20027
20028 \backslash
20029 lhead
20030 \family default
20031 \series bold
20032 {
20033 \series default
20034 John Q.
20035  DocWriter
20036 \series bold
20037 }
20038 \end_layout
20039
20040 \begin_layout Standard
20041
20042 \change_inserted 564990737 1672236008
20043 You will now see your name in the upper left.
20044  If a field has a default entry that you would like to get rid of (often the page number appears in the central footer) simply include a command with a blank argument,
20045  e.
20046 \begin_inset space \thinspace{}
20047 \end_inset
20048
20049 g.:
20050 \end_layout
20051
20052 \begin_layout Standard
20053
20054 \change_inserted 564990737 1672236008
20055
20056 \family sans
20057
20058 \backslash
20059 cfoot{}
20060 \end_layout
20061
20062 \begin_layout Standard
20063
20064 \change_inserted 564990737 1672236008
20065 There is,
20066  however,
20067  an easier way to make simple changes.
20068  If you load the
20069 \family sans
20070 \bar under
20071 D
20072 \bar default
20073 ocument\SpecialChar menuseparator
20074
20075 \bar under
20076 S
20077 \bar default
20078 ettings\SpecialChar menuseparator
20079 Modules\SpecialChar menuseparator
20080 Page Layout\SpecialChar menuseparator
20081 Custom Header/Footer Text
20082 \family default
20083  module,
20084  you will find you have six new environments corresponding to the six fields described above.
20085 \end_layout
20086
20087 \begin_layout Standard
20088
20089 \change_inserted 564990737 1672236008
20090 Let's get really fancy:
20091  lets put the section number with the word
20092 \begin_inset Quotes eld
20093 \end_inset
20094
20095 Section
20096 \begin_inset Quotes erd
20097 \end_inset
20098
20099  (e.
20100 \begin_inset space \thinspace{}
20101 \end_inset
20102
20103 g.
20104 \begin_inset space \space{}
20105 \end_inset
20106
20107 Section 3) in the upper left,
20108  the page number (e.
20109 \begin_inset space \thinspace{}
20110 \end_inset
20111
20112 g.
20113 \begin_inset space \space{}
20114 \end_inset
20115
20116 Page 4) in the upper right,
20117  your name in the lower left,
20118  and the date in the lower right.
20119  Use your newly enabled environments to add these entries:
20120 \end_layout
20121
20122 \begin_layout Standard
20123
20124 \change_inserted 564990737 1672236008
20125 \begin_inset VSpace defskip
20126 \end_inset
20127
20128
20129 \end_layout
20130
20131 \begin_layout Standard
20132
20133 \change_inserted 564990737 1672236008
20134
20135 \color green
20136 Left
20137 \begin_inset space ~
20138 \end_inset
20139
20140 header:
20141
20142 \series bold
20143 \color inherit
20144
20145 \series default
20146 Section
20147 \family typewriter
20148
20149 \family sans
20150
20151 \backslash
20152 thesection
20153 \end_layout
20154
20155 \begin_layout Standard
20156
20157 \change_inserted 564990737 1672236008
20158
20159 \color green
20160 Center header:
20161 \end_layout
20162
20163 \begin_layout Standard
20164
20165 \change_inserted 564990737 1672236008
20166
20167 \color green
20168 Right header:
20169
20170 \color inherit
20171  Page
20172 \family typewriter
20173
20174 \family sans
20175
20176 \backslash
20177 thepage
20178 \end_layout
20179
20180 \begin_layout Standard
20181
20182 \change_inserted 564990737 1672236008
20183
20184 \color green
20185 Left footer:
20186
20187 \color inherit
20188  John Q.
20189  DocWriter
20190 \end_layout
20191
20192 \begin_layout Standard
20193
20194 \change_inserted 564990737 1672236008
20195
20196 \color green
20197 Center footer:
20198 \end_layout
20199
20200 \begin_layout Standard
20201
20202 \change_inserted 564990737 1672236008
20203
20204 \color green
20205 Right footer:
20206
20207 \series bold
20208 \color inherit
20209
20210 \family sans
20211 \series default
20212
20213 \backslash
20214 today
20215 \end_layout
20216
20217 \begin_layout Standard
20218
20219 \change_inserted 564990737 1672236008
20220 \begin_inset VSpace defskip
20221 \end_inset
20222
20223
20224 \end_layout
20225
20226 \begin_layout Standard
20227
20228 \change_inserted 564990737 1672236008
20229 Make sure you enter the commands
20230 \family sans
20231
20232 \backslash
20233 thesection
20234 \family default
20235 ,
20236
20237 \family sans
20238
20239 \backslash
20240 thepage
20241 \family default
20242  and
20243 \family sans
20244
20245 \backslash
20246 today
20247 \family default
20248  as \SpecialChar TeX
20249  Code commands
20250 \series bold
20251 .
20252
20253 \series default
20254  The commands
20255 \family sans
20256
20257 \backslash
20258 thesection
20259 \family default
20260  and
20261 \family sans
20262
20263 \backslash
20264 thepage
20265 \family default
20266  access \SpecialChar LaTeX
20267 ’s section and page counters,
20268  and so print out the current section and page numbers.
20269
20270 \family sans
20271
20272 \backslash
20273 today
20274 \family default
20275  simply prints out today’s date.
20276 \end_layout
20277
20278 \begin_layout Standard
20279
20280 \change_inserted 564990737 1672236008
20281 The thicknesses of the horizontal rules drawn beneath the header and above the footer can also be modified.
20282  If you don't want one of the rules,
20283  set its thickness to 0.
20284  The header rule has a default thickness of 0.4pt,
20285  the footer rule is 0pt.
20286  For this you will need to use \SpecialChar TeX
20287  Code commands like
20288 \end_layout
20289
20290 \begin_layout Standard
20291
20292 \change_inserted 564990737 1672236008
20293
20294 \family sans
20295
20296 \backslash
20297 renewcommand{
20298 \backslash
20299 headrulewidth}{0.4pt}
20300 \family default
20301  and
20302 \end_layout
20303
20304 \begin_layout Standard
20305
20306 \change_inserted 564990737 1672236008
20307
20308 \family sans
20309
20310 \backslash
20311 renewcommand{
20312 \backslash
20313 footrulewidth}{0.4pt}
20314 \family default
20315  to set the thicknesses.
20316 \end_layout
20317
20318 \begin_layout Standard
20319
20320 \change_inserted 564990737 1672236008
20321 You can switch the header/footer settings on and off for individual pages using \SpecialChar TeX
20322  Code commands like
20323 \family sans
20324
20325 \backslash
20326 thispagestyle{empty}
20327 \family default
20328 ,
20329
20330 \family sans
20331
20332 \backslash
20333 thispagestyle{plain}
20334 \family default
20335 ,
20336  and
20337 \family sans
20338
20339 \backslash
20340 thispagestyle{fancy}
20341 \family default
20342 .
20343  Simply insert them in the text on the page you want changed and mark them as \SpecialChar TeX
20344  code.
20345  In fact,
20346  title pages are marked as plain by default,
20347  while following pages are marked fancy when using the global fancy setting.
20348
20349 \end_layout
20350
20351 \begin_layout Standard
20352
20353 \change_inserted 564990737 1672236008
20354 If you want a header or footer to be on the outer side of a two sided document,
20355  you need to use something like:
20356 \end_layout
20357
20358 \begin_layout Standard
20359
20360 \change_inserted 564990737 1672236008
20361
20362 \family sans
20363 \begin_inset Flex Strong
20364 status collapsed
20365
20366 \begin_layout Plain Layout
20367
20368 \change_inserted 564990737 1672236008
20369
20370 \family sans
20371 \series medium
20372
20373 \backslash
20374 fancyfoot{}
20375 \change_unchanged
20376
20377 \end_layout
20378
20379 \end_inset
20380
20381
20382 \end_layout
20383
20384 \begin_layout Standard
20385
20386 \change_inserted 564990737 1672236008
20387
20388 \family sans
20389 \begin_inset Flex Strong
20390 status collapsed
20391
20392 \begin_layout Plain Layout
20393
20394 \change_inserted 564990737 1672236008
20395
20396 \family sans
20397 \series medium
20398
20399 \backslash
20400 fancyfoot[LE,RO]{
20401 \backslash
20402 thepage}
20403 \change_unchanged
20404
20405 \end_layout
20406
20407 \end_inset
20408
20409
20410 \end_layout
20411
20412 \begin_layout Standard
20413
20414 \change_inserted 564990737 1672236008
20415 The first command clears all existing footers avoiding any conflicts with your new command.
20416 \end_layout
20417
20418 \begin_layout Standard
20419
20420 \change_inserted 564990737 1672236008
20421 You can enter any of these commands,
20422  the simpler ones in any of your new environments,
20423  the more complex ones as \SpecialChar TeX
20424  Code commands,
20425  at any point in your document and they will take effect on the next page.
20426 \end_layout
20427
20428 \begin_layout Standard
20429
20430 \change_inserted 564990737 1672236008
20431 As a final example,
20432  it is possible to include an image in the header or footer.
20433  Suppose you want to put a company logo in the upper left hand corner.
20434  You might try something like
20435 \end_layout
20436
20437 \begin_layout Standard
20438
20439 \change_inserted 564990737 1672236008
20440
20441 \family sans
20442
20443 \backslash
20444 lhead{
20445 \backslash
20446 resizebox{1in}{!}{
20447 \backslash
20448 includegraphics{logo.eps}}}
20449 \end_layout
20450
20451 \begin_layout Standard
20452 \noindent
20453
20454 \change_inserted 564990737 1672236008
20455 (you may need to preface this with
20456 \family sans
20457
20458 \backslash
20459 usepackage{graphics}
20460 \family default
20461  if you don't include graphics elsewhere in your document).
20462 \end_layout
20463
20464 \begin_layout Standard
20465
20466 \change_inserted 564990737 1672236008
20467 For more information on fancy headers,
20468  you can get the
20469 \begin_inset Flex Code
20470 status collapsed
20471
20472 \begin_layout Plain Layout
20473
20474 \change_inserted 564990737 1672236008
20475 fancyhdr
20476 \change_unchanged
20477
20478 \end_layout
20479
20480 \end_inset
20481
20482  documentation from
20483 \begin_inset CommandInset href
20484 LatexCommand href
20485 name "CTAN"
20486 target "http://www.ctan.org/pkg/fancyhdr"
20487 literal "false"
20488
20489 \end_inset
20490
20491 .
20492
20493 \end_layout
20494
20495 \begin_layout Subsection
20496
20497 \change_inserted 564990737 1672236008
20498 Landscape Document Parts
20499 \end_layout
20500
20501 \begin_layout Standard
20502
20503 \change_inserted 564990737 1672236008
20504 This module outputs parts of the document in landscape mode using
20505 \family sans
20506 Insert\SpecialChar menuseparator
20507 Custom Insets\SpecialChar menuseparator
20508 Landscape
20509 \family default
20510  or
20511 \family sans
20512 Insert\SpecialChar menuseparator
20513 Custom Insets\SpecialChar menuseparator
20514 Landscape (Floating)
20515 \family default
20516 .
20517 \end_layout
20518
20519 \begin_layout Subsection
20520
20521 \change_inserted 564990737 1672236008
20522 \begin_inset CommandInset label
20523 LatexCommand label
20524 name "sec:Multiple-Columns"
20525
20526 \end_inset
20527
20528 Multiple Columns
20529 \end_layout
20530
20531 \begin_layout Standard
20532
20533 \change_inserted 564990737 1672236008
20534 This module uses the
20535 \family sans
20536 multicol
20537 \family default
20538
20539 \begin_inset Index idx
20540 range none
20541 pageformat default
20542 status collapsed
20543
20544 \begin_layout Plain Layout
20545
20546 \change_inserted 564990737 1672236008
20547 \SpecialChar LaTeX
20548 -packages !
20549  multicol
20550 \change_unchanged
20551
20552 \end_layout
20553
20554 \end_inset
20555
20556  package and is independent of the option
20557 \family sans
20558 Two-
20559 \bar under
20560 c
20561 \bar default
20562 olumn document
20563 \family default
20564  in the
20565 \family sans
20566 \bar under
20567 D
20568 \bar default
20569 ocument\SpecialChar menuseparator
20570
20571 \bar under
20572 S
20573 \bar default
20574 ettings\SpecialChar menuseparator
20575 Text
20576 \begin_inset space ~
20577 \end_inset
20578
20579 Layout
20580 \family default
20581  dialog.
20582  If you want to have two columns for the whole document,
20583  you are recommended to use the
20584 \family sans
20585 Two-
20586 \bar under
20587 c
20588 \bar default
20589 olumn document
20590 \family default
20591  option.
20592  For all other cases use this module.
20593 \change_deleted 564990737 1672236008
20594 Multiple Text Columns
20595 \end_layout
20596
20597 \begin_layout Standard
20598
20599 \change_deleted 564990737 1672236008
20600 This feature is independent of the option
20601 \family sans
20602 Two-column document
20603 \family default
20604  in the document settings under
20605 \family sans
20606 Text Layout
20607 \family default
20608 .
20609  If you want to have 2
20610 \begin_inset space ~
20611 \end_inset
20612
20613 columns for the whole document,
20614  it is recommended to use the
20615 \family sans
20616 Two-column document
20617 \family default
20618  option.
20619  For all other cases use this feature.
20620 \end_layout
20621
20622 \begin_layout Standard
20623
20624 \change_deleted 564990737 1672236008
20625 To use multiple text columns in your document,
20626  you have to load the module
20627 \family sans
20628 Multiple Columns
20629 \family default
20630  (menu
20631 \family sans
20632 Document\SpecialChar menuseparator
20633 Settings\SpecialChar menuseparator
20634 Modules
20635 \family default
20636 ) and must have the \SpecialChar LaTeX
20637 -package
20638 \begin_inset Flex Code
20639 status collapsed
20640
20641 \begin_layout Plain Layout
20642 multicol
20643 \end_layout
20644
20645 \end_inset
20646
20647  installed.
20648 \change_unchanged
20649
20650 \end_layout
20651
20652 \begin_layout Standard
20653 Footnotes within multiple columns will be placed at the bottom of the page and not under each column.
20654  Within the different columns you can use everything,
20655  with the limitation that for floats you need to
20656 \change_deleted 564990737 1672236179
20657 use the float option
20658 \family sans
20659 Span columns
20660 \change_inserted 564990737 1672236179
20661
20662 \family default
20663 check the option
20664 \family sans
20665 \bar under
20666 S
20667 \bar default
20668 pan
20669 \begin_inset space ~
20670 \end_inset
20671
20672 columns
20673 \family default
20674  in
20675 \family sans
20676 \bar under
20677 E
20678 \bar default
20679 dit\SpecialChar menuseparator
20680 Flo
20681 \bar under
20682 a
20683 \bar default
20684 t
20685 \begin_inset space ~
20686 \end_inset
20687
20688 Settings
20689 \change_unchanged
20690
20691 \family default
20692 .
20693 \end_layout
20694
20695 \begin_layout Subsubsection
20696 Basics
20697 \end_layout
20698
20699 \begin_layout Standard
20700 If you want to have 2
20701 \begin_inset space ~
20702 \end_inset
20703
20704 columns in your text,
20705  insert a multicolumn inset via the menu
20706 \family sans
20707 Insert\SpecialChar menuseparator
20708 Custom
20709 \begin_inset space ~
20710 \end_inset
20711
20712 Insets\SpecialChar menuseparator
20713 Multiple
20714 \begin_inset space ~
20715 \end_inset
20716
20717 Columns
20718 \family default
20719  where the columns should start.
20720  Write all text that should be printed in 2
20721 \begin_inset space ~
20722 \end_inset
20723
20724 columns into this inset.
20725 \end_layout
20726
20727 \begin_layout Standard
20728 Here is an example:
20729 \end_layout
20730
20731 \begin_layout Standard
20732 \noindent
20733 \begin_inset Flex Multiple Columns
20734 status open
20735
20736 \begin_layout Plain Layout
20737 \noindent
20738
20739 \series bold
20740 \size small
20741 The Adventure of the Empty House
20742 \series default
20743
20744 \begin_inset Newline newline
20745 \end_inset
20746
20747 by Sir Arthur Conan Doyle
20748 \end_layout
20749
20750 \begin_layout Plain Layout
20751
20752 \size small
20753 It was in the spring of the year 1894 that all London was interested,
20754  and the fashionable world dismayed,
20755  by the murder of the Honourable Ronald Adair under most unusual and inexplicable circumstances.
20756  The public has already learned those particulars of the crime which came out in the police investigation,
20757  but a good deal was suppressed upon that occasion,
20758  since the case for the prosecution was so overwhelmingly strong that it was not necessary to bring forward all the facts.
20759  Only now,
20760  at the end of nearly ten years,
20761  am I allowed to supply those missing links which make up the whole of that remarkable chain.
20762  The crime was of interest in itself,
20763  but that interest was as nothing to me compared to the inconceivable sequel,
20764  which afforded me the greatest shock and surprise of any event in my adventurous life.
20765  Even now,
20766  after this long interval,
20767  I find myself thrilling as I think of it,
20768  and feeling once more that sudden flood of joy,
20769  amazement,
20770  and incredulity which utterly submerged my mind.
20771  Let me say to that public,
20772  which has shown some interest in those glimpses which I have occasionally given them of the thoughts and actions of a very remarkable man,
20773  that they are not to blame me if I have not shared my knowledge with them,
20774  for I should have considered it my first duty to do so,
20775  had I not been barred by a positive prohibition from his own lips,
20776  which was only withdrawn upon the third of last month.
20777 \end_layout
20778
20779 \end_inset
20780
20781
20782 \end_layout
20783
20784 \begin_layout Standard
20785 To get 3 or more columns,
20786  set the cursor into the multicolumn inset and use the menu
20787 \family sans
20788 Insert\SpecialChar menuseparator
20789 Number
20790 \begin_inset space ~
20791 \end_inset
20792
20793 of
20794 \begin_inset space ~
20795 \end_inset
20796
20797 Columns
20798 \family default
20799 .
20800  The number of the desired columns is written into that inset (for 3
20801 \begin_inset space ~
20802 \end_inset
20803
20804 columns write
20805 \begin_inset Quotes eld
20806 \end_inset
20807
20808 3
20809 \begin_inset Quotes erd
20810 \end_inset
20811
20812 ).
20813 \begin_inset Newline newline
20814 \end_inset
20815
20816 Here is an example with 3
20817 \begin_inset space ~
20818 \end_inset
20819
20820 columns:
20821 \end_layout
20822
20823 \begin_layout Standard
20824 \begin_inset Flex Multiple Columns
20825 status open
20826
20827 \begin_layout Plain Layout
20828
20829 \size footnotesize
20830 \begin_inset Argument 1
20831 status open
20832
20833 \begin_layout Plain Layout
20834
20835 3
20836 \end_layout
20837
20838 \end_inset
20839
20840 It can be imagined that my close intimacy with Sherlock Holmes had interested me deeply in crime,
20841  and that after his disappearance I never failed to read with care the various problems which came before the public.
20842  And I even attempted,
20843  more than once,
20844  for my own private satisfaction,
20845  to employ his methods in their solution,
20846  though with indifferent success.
20847  There was none,
20848  however,
20849  which appealed to me like this tragedy of Ronald Adair.
20850  As I read the evidence at the inquest,
20851  which led up to a verdict of willful murder against some person or persons unknown,
20852  I realized more clearly than I had ever done the loss which the community had sustained by the death of Sherlock Holmes.
20853  There were points about this strange business which would,
20854  I was sure,
20855  have specially appealed to him,
20856  and the efforts of the police would have been supplemented,
20857  or more probably anticipated,
20858  by the trained observation and the alert mind of the first criminal agent in Europe.
20859  All day,
20860  as I drove upon my round,
20861  I turned over the case in my mind and found no explanation which appeared to me to be adequate.
20862  At the risk of telling a twice-told tale,
20863  I will recapitulate the facts as they were known to the public at the conclusion of the inquest.
20864 \end_layout
20865
20866 \end_inset
20867
20868
20869 \end_layout
20870
20871 \begin_layout Standard
20872 You can have up to 10
20873 \begin_inset space ~
20874 \end_inset
20875
20876 columns if you want to,
20877  but that might not be very pleasant for the readers of your document.
20878 \end_layout
20879
20880 \begin_layout Standard
20881
20882 \change_deleted 564990737 1672236245
20883 \begin_inset Newpage newpage
20884 \end_inset
20885
20886
20887 \change_unchanged
20888
20889 \end_layout
20890
20891 \begin_layout Subsubsection
20892 Columns inside Columns
20893 \end_layout
20894
20895 \begin_layout Standard
20896 You can also have columns inside columns:
20897 \end_layout
20898
20899 \begin_layout Standard
20900 \begin_inset Flex Multiple Columns
20901 status open
20902
20903 \begin_layout Plain Layout
20904
20905 \size footnotesize
20906 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
20907  at that time governor of one of the Australian colonies.
20908  Adair's mother had returned from Australia to undergo the operation for cataract,
20909  and she,
20910  her son Ronald,
20911  and her daughter Hilda were living together at 427 Park Lane.
20912 \end_layout
20913
20914 \begin_layout Plain Layout
20915 \begin_inset Flex Multiple Columns
20916 status open
20917
20918 \begin_layout Plain Layout
20919
20920 \size footnotesize
20921 The youth moved in the best society
20922 \begin_inset space ~
20923 \end_inset
20924
20925 – had,
20926  so far as was known,
20927  no enemies and no particular vices.
20928  He had been engaged to Miss Edith Woodley,
20929  of Carstairs,
20930  but the engagement had been broken off by mutual consent some months before,
20931  and there was no sign that it had left any very profound feeling behind it.
20932  For the rest {sic} the man's life moved in a narrow and conventional circle,
20933  for his habits were quiet and his nature unemotional.
20934  Yet it was upon this easy-going young aristocrat that death came,
20935  in most strange and unexpected form,
20936  between the hours of ten and eleven-twenty on the night of March 30,
20937  1894.
20938 \end_layout
20939
20940 \end_inset
20941
20942
20943 \end_layout
20944
20945 \begin_layout Plain Layout
20946
20947 \size footnotesize
20948 Ronald Adair was fond of cards
20949 \begin_inset space ~
20950 \end_inset
20951
20952 – playing continually,
20953  but never for such stakes as would hurt him.
20954  He was a member of the Baldwin,
20955  the Cavendish,
20956  and the Bagatelle card clubs.
20957  It was shown that,
20958  after dinner on the day of his death,
20959  he had played a rubber of whist at the latter club.
20960  He had also played there in the afternoon.
20961
20962 \size default
20963
20964 \size footnotesize
20965 The evidence of those who had played with him
20966 \begin_inset space ~
20967 \end_inset
20968
20969 – Mr.
20970  Murray,
20971  Sir John Hardy,
20972  and Colonel Moran
20973 \begin_inset space ~
20974 \end_inset
20975
20976 – showed that the game was whist,
20977  and that there was a fairly equal fall of the cards.
20978  Adair might have lost five pounds,
20979  but not more.
20980  His fortune was a considerable one,
20981  and such a loss could not in any way affect him.
20982  He had played nearly every day at one club or other,
20983  but he was a cautious player,
20984  and usually rose a winner.
20985  It came out in evidence that,
20986  in partnership with Colonel Moran,
20987  he had actually won as much as four hundred and twenty pounds in a sitting,
20988  some weeks before,
20989  from Godfrey Milner and Lord Balmoral.
20990  So much for his recent history as it came out at the inquest.
20991 \end_layout
20992
20993 \end_inset
20994
20995
20996 \end_layout
20997
20998 \begin_layout Subsubsection
20999 Advanced Examples
21000 \end_layout
21001
21002 \begin_layout Standard
21003 The examples in this section show some more special features of multiple columns.
21004 \end_layout
21005
21006 \begin_layout Standard
21007 For more features of multiple columns,
21008  have a look at the
21009 \begin_inset CommandInset href
21010 LatexCommand href
21011 name "documentation"
21012 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
21013 literal "false"
21014
21015 \end_inset
21016
21017  of the \SpecialChar LaTeX
21018 -package
21019 \begin_inset Flex Code
21020 status collapsed
21021
21022 \begin_layout Plain Layout
21023 multicol
21024 \end_layout
21025
21026 \end_inset
21027
21028 .
21029 \end_layout
21030
21031 \begin_layout Paragraph
21032 Preface
21033 \end_layout
21034
21035 \begin_layout Standard
21036 To add a preface text for multiple columns,
21037  set the cursor into the multicolumn inset and use the menu
21038 \family sans
21039 Insert\SpecialChar menuseparator
21040 Preface
21041 \family default
21042 .
21043  Write your preface text into that inset.
21044 \begin_inset Newline newline
21045 \end_inset
21046
21047 This is an example with some preface text:
21048 \end_layout
21049
21050 \begin_layout Standard
21051 \begin_inset VSpace bigskip
21052 \end_inset
21053
21054
21055 \end_layout
21056
21057 \begin_layout Standard
21058 \begin_inset Flex Multiple Columns
21059 status open
21060
21061 \begin_layout Plain Layout
21062 \begin_inset Argument 2
21063 status open
21064
21065 \begin_layout Plain Layout
21066 And the story continues and continues and continues and continues\SpecialChar ldots
21067
21068 \end_layout
21069
21070 \end_inset
21071
21072
21073 \size small
21074 On the evening of the crime,
21075  he returned from the club exactly at ten.
21076  His mother and sister were out spending the evening with a relation.
21077  The servant deposed that she heard him enter the front room on the second floor,
21078  generally used as his sitting-room.
21079  She had lit a fire there,
21080  and as it smoked she had opened the window.
21081  No sound was heard from the room until eleven-twenty,
21082  the hour of the return of Lady Maynooth and her daughter.
21083  Desiring to say good-night,
21084  she attempted to enter her son's room.
21085  The door was locked on the inside,
21086  and no answer could be got to their cries and knocking.
21087  Help was obtained,
21088  and the door forced.
21089  The unfortunate young man was found lying near the table.
21090  His head had been horribly mutilated by an expanding revolver bullet,
21091  but no weapon of any sort was to be found in the room.
21092 \end_layout
21093
21094 \end_inset
21095
21096
21097 \end_layout
21098
21099 \begin_layout Standard
21100 You can also use a section heading as the preface if you use a section command as \SpecialChar TeX
21101  Code.
21102  For example the command
21103 \end_layout
21104
21105 \begin_layout LyX-Code
21106
21107 \backslash
21108 subsection{subsection title}
21109 \end_layout
21110
21111 \begin_layout Standard
21112 creates a subsection.
21113  In this example the preface is a subsubsection:
21114 \end_layout
21115
21116 \begin_layout Standard
21117 \begin_inset Flex Multiple Columns
21118 status open
21119
21120 \begin_layout Plain Layout
21121 \begin_inset Argument 2
21122 status open
21123
21124 \begin_layout Plain Layout
21125 \begin_inset ERT
21126 status collapsed
21127
21128 \begin_layout Plain Layout
21129
21130
21131 \backslash
21132 subsubsection{
21133 \end_layout
21134
21135 \end_inset
21136
21137 This is a subsubsection heading as a preface
21138 \begin_inset ERT
21139 status collapsed
21140
21141 \begin_layout Plain Layout
21142
21143 }
21144 \end_layout
21145
21146 \end_inset
21147
21148
21149 \end_layout
21150
21151 \end_inset
21152
21153
21154 \size small
21155 A minute examination of the circumstances served only to make the case more complex.
21156  In the first place,
21157  no reason could be given why the young man should have fastened the door upon the inside.
21158  There was the possibility that the murderer had done this,
21159  and had afterwards escaped by the window.
21160  The drop was at least twenty feet,
21161  however,
21162  and a bed of crocuses in full bloom lay beneath.
21163  Neither the flowers nor the earth showed any sign of having been disturbed,
21164  nor were there any marks upon the narrow strip of grass which separated the house from the road.
21165  Apparently,
21166  therefore,
21167  it was the young man himself who had fastened the door.
21168  But how did he come by his death?
21169  No one could have climbed up to the window without leaving traces.
21170  Suppose a man had fired through the window,
21171  he would indeed be a remarkable shot who could with a revolver inflict so deadly a wound.
21172  Again,
21173  Park Lane is a frequented thoroughfare;
21174  there is a cab stand within a hundred yards of the house.
21175  No one had heard a shot.
21176 \end_layout
21177
21178 \end_inset
21179
21180
21181 \end_layout
21182
21183 \begin_layout Standard
21184 If there is less vertical space than 6
21185 \begin_inset space ~
21186 \end_inset
21187
21188 text lines is left on the page at the beginning of the multiple columns,
21189  a page break will be inserted before the multiple columns.
21190  Depending on the number of lines of the preface text,
21191  you might want to change this space.
21192  This is done by setting the cursor into the mulitcolumn inset behind the preface (if there is any) and using the menu
21193 \family sans
21194 Insert\SpecialChar menuseparator
21195 Space
21196 \begin_inset space ~
21197 \end_inset
21198
21199 Before
21200 \begin_inset space ~
21201 \end_inset
21202
21203 Page
21204 \begin_inset space ~
21205 \end_inset
21206
21207 Break
21208 \family default
21209 .
21210  Insert into that inset the amount of space like e.
21211 \begin_inset space \thinspace{}
21212 \end_inset
21213
21214 g.
21215 \begin_inset space \space{}
21216 \end_inset
21217
21218
21219 \begin_inset Quotes eld
21220 \end_inset
21221
21222 5cm
21223 \begin_inset Quotes erd
21224 \end_inset
21225
21226 .
21227 \begin_inset Newline newline
21228 \end_inset
21229
21230 In this example the space is set to 7
21231 \begin_inset space ~
21232 \end_inset
21233
21234 text lines by using
21235 \begin_inset Flex Code
21236 status collapsed
21237
21238 \begin_layout Plain Layout
21239 7
21240 \backslash
21241 baselineskip
21242 \end_layout
21243
21244 \end_inset
21245
21246  (where the command
21247 \begin_inset Flex Code
21248 status collapsed
21249
21250 \begin_layout Plain Layout
21251
21252 \backslash
21253 baselineskip
21254 \end_layout
21255
21256 \end_inset
21257
21258  needs to be inserted as \SpecialChar TeX
21259  code):
21260 \end_layout
21261
21262 \begin_layout Standard
21263 \begin_inset Flex Multiple Columns
21264 status open
21265
21266 \begin_layout Plain Layout
21267 \begin_inset Argument 3
21268 status open
21269
21270 \begin_layout Plain Layout
21271 7
21272 \begin_inset ERT
21273 status collapsed
21274
21275 \begin_layout Plain Layout
21276
21277
21278 \backslash
21279 baselineskip
21280 \end_layout
21281
21282 \end_inset
21283
21284
21285 \end_layout
21286
21287 \end_inset
21288
21289
21290 \size small
21291 On the evening of the crime,
21292  he returned from the club exactly at ten.
21293  His mother and sister were out spending the evening with a relation.
21294  The servant deposed that she heard him enter the front room on the second floor,
21295  generally used as his sitting-room.
21296  She had lit a fire there,
21297  and as it smoked she had opened the window.
21298  No sound was heard from the room until eleven-twenty,
21299  the hour of the return of Lady Maynooth and her daughter.
21300  Desiring to say good-night,
21301  she attempted to enter her son's room.
21302  The door was locked on the inside,
21303  and no answer could be got to their cries and knocking.
21304  Help was obtained,
21305  and the door forced.
21306  The unfortunate young man was found lying near the table.
21307  His head had been horribly mutilated by an expanding revolver bullet,
21308  but no weapon of any sort was to be found in the room.
21309 \end_layout
21310
21311 \end_inset
21312
21313
21314 \end_layout
21315
21316 \begin_layout Paragraph
21317 Surrounding Space
21318 \end_layout
21319
21320 \begin_layout Standard
21321 The amount of space before and after multiple columns can be changed by changing the length
21322 \begin_inset Flex Code
21323 status collapsed
21324
21325 \begin_layout Plain Layout
21326
21327 \backslash
21328 multicolsep
21329 \end_layout
21330
21331 \end_inset
21332
21333 .
21334  For example the command
21335 \end_layout
21336
21337 \begin_layout LyX-Code
21338
21339 \backslash
21340 setlength{
21341 \backslash
21342 multicolsep}{3cm}
21343 \end_layout
21344
21345 \begin_layout Standard
21346 in \SpecialChar TeX
21347  Code changes its value to 3
21348 \begin_inset space \thinspace{}
21349 \end_inset
21350
21351 cm.
21352  The change must be made before the multiple columns' start.
21353  The predefined value is 13
21354 \begin_inset space \thinspace{}
21355 \end_inset
21356
21357 pt.
21358 \end_layout
21359
21360 \begin_layout Standard
21361 For this example
21362 \begin_inset Flex Code
21363 status collapsed
21364
21365 \begin_layout Plain Layout
21366
21367 \backslash
21368 multicolsep
21369 \end_layout
21370
21371 \end_inset
21372
21373  was set to 2.5
21374 \begin_inset space \thinspace{}
21375 \end_inset
21376
21377 cm:
21378 \end_layout
21379
21380 \begin_layout Standard
21381 \begin_inset ERT
21382 status open
21383
21384 \begin_layout Plain Layout
21385
21386
21387 \backslash
21388 setlength{
21389 \backslash
21390 multicolsep}{2.5cm}
21391 \end_layout
21392
21393 \end_inset
21394
21395
21396 \end_layout
21397
21398 \begin_layout Standard
21399 \begin_inset Flex Multiple Columns
21400 status open
21401
21402 \begin_layout Plain Layout
21403
21404 \size small
21405 All day I turned these facts over in my mind,
21406  endeavouring to hit upon some theory which could reconcile them all,
21407  and to find that line of least resistance which my poor friend had declared to be the starting-point of every investigation.
21408  I confess that I made little progress.
21409  In the evening I strolled across the Park,
21410  and found myself about six o'clock at the Oxford Street end of Park Lane.
21411  A group of loafers upon the pavements,
21412  all staring up at a particular window,
21413  directed me to the house which I had come to see.
21414  A tall,
21415  thin man with coloured glasses,
21416  whom I strongly suspected of being a plain-clothes detective,
21417  was pointing out some theory of his own,
21418  while the others crowded round to listen to what he said.
21419  I got as near him as I could,
21420  but his observations seemed to me to be absurd,
21421  so I withdrew again in some disgust.
21422  As I did so I struck against an elderly,
21423  deformed man,
21424  who had been behind me,
21425  and I knocked down several books which he was carrying.
21426 \end_layout
21427
21428 \end_inset
21429
21430
21431 \end_layout
21432
21433 \begin_layout Standard
21434 \begin_inset Note Greyedout
21435 status open
21436
21437 \begin_layout Plain Layout
21438
21439 \series bold
21440 Note:
21441
21442 \series default
21443  The values you set with
21444 \begin_inset Flex Code
21445 status collapsed
21446
21447 \begin_layout Plain Layout
21448
21449 \backslash
21450 setlength
21451 \end_layout
21452
21453 \end_inset
21454
21455  will be used for all following multiple columns until you change them again.
21456 \end_layout
21457
21458 \end_inset
21459
21460
21461 \end_layout
21462
21463 \begin_layout Standard
21464 \begin_inset ERT
21465 status collapsed
21466
21467 \begin_layout Plain Layout
21468
21469
21470 \backslash
21471 setlength{
21472 \backslash
21473 multicolsep}{13pt}
21474 \end_layout
21475
21476 \end_inset
21477
21478
21479 \begin_inset Note Note
21480 status collapsed
21481
21482 \begin_layout Plain Layout
21483 go back to the default
21484 \end_layout
21485
21486 \end_inset
21487
21488
21489 \end_layout
21490
21491 \begin_layout Standard
21492
21493 \change_deleted 564990737 1672236355
21494 \begin_inset Newpage newpage
21495 \end_inset
21496
21497
21498 \change_unchanged
21499
21500 \end_layout
21501
21502 \begin_layout Paragraph
21503 Column Breaks
21504 \end_layout
21505
21506 \begin_layout Standard
21507 A column break can be forced by inserting the command
21508 \begin_inset Flex Code
21509 status collapsed
21510
21511 \begin_layout Plain Layout
21512
21513 \backslash
21514 columnbreak{}
21515 \end_layout
21516
21517 \end_inset
21518
21519  as \SpecialChar TeX
21520  Code to that position in the text where the column should be broken.
21521  Note that this leads in most cases to whitespace in the text.
21522 \begin_inset Newline newline
21523 \end_inset
21524
21525 Here is an example:
21526 \end_layout
21527
21528 \begin_layout Standard
21529 \begin_inset Flex Multiple Columns
21530 status open
21531
21532 \begin_layout Plain Layout
21533
21534 \size small
21535 \begin_inset Quotes eld
21536 \end_inset
21537
21538 You're surprised to see me,
21539  sir,
21540 \begin_inset Quotes erd
21541 \end_inset
21542
21543  said he,
21544  in a strange,
21545  croaking voice.
21546 \end_layout
21547
21548 \begin_layout Plain Layout
21549
21550 \size small
21551 I acknowledged that I was.
21552 \end_layout
21553
21554 \begin_layout Plain Layout
21555
21556 \size small
21557 \begin_inset Quotes eld
21558 \end_inset
21559
21560 Well,
21561  I've a conscience,
21562  sir,
21563  and when I chanced to see you go into this house,
21564  as I came hobbling after you,
21565  I thought to myself,
21566  I'll just step in and see that kind gentleman,
21567  and tell him that if I was a bit gruff in my manner there was not any harm meant,
21568  and that I am much obliged to him for picking up my books.
21569 \begin_inset Quotes erd
21570 \end_inset
21571
21572
21573 \end_layout
21574
21575 \begin_layout Plain Layout
21576
21577 \size small
21578 \begin_inset Quotes eld
21579 \end_inset
21580
21581 You make too much of a trifle,
21582 \begin_inset Quotes erd
21583 \end_inset
21584
21585  said I.
21586
21587 \begin_inset Quotes eld
21588 \end_inset
21589
21590 May I ask how you knew who I was?
21591 \begin_inset Quotes erd
21592 \end_inset
21593
21594  AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
21595 \begin_inset ERT
21596 status collapsed
21597
21598 \begin_layout Plain Layout
21599
21600
21601 \backslash
21602 columnbreak{}
21603 \end_layout
21604
21605 \end_inset
21606
21607
21608 \end_layout
21609
21610 \begin_layout Plain Layout
21611
21612 \size small
21613 \begin_inset Quotes eld
21614 \end_inset
21615
21616 Well,
21617  sir,
21618  if it isn't too great a liberty,
21619  I am a neighbour of yours,
21620  for you'll find my little bookshop at the corner of Church Street,
21621  and very happy to see you,
21622  I am sure.
21623  Maybe you collect yourself,
21624  sir.
21625  Here's
21626 \noun on
21627 British
21628 \begin_inset space ~
21629 \end_inset
21630
21631 Birds
21632 \noun default
21633 ,
21634  and
21635 \noun on
21636 Catullus
21637 \noun default
21638 ,
21639  and
21640 \noun on
21641 The Holy War
21642 \noun default
21643
21644 \begin_inset space ~
21645 \end_inset
21646
21647 – a bargain,
21648  every one of them.
21649  With five volumes you could just fill that gap on that second shelf.
21650  It looks untidy,
21651  does it not,
21652  sir?
21653 \begin_inset Quotes erd
21654 \end_inset
21655
21656
21657 \end_layout
21658
21659 \end_inset
21660
21661
21662 \end_layout
21663
21664 \begin_layout Paragraph
21665 Column Separation
21666 \end_layout
21667
21668 \begin_layout Standard
21669 The width of the columns is automatically calculated,
21670  but you can modify the space between the columns.
21671  This is done by changing the length
21672 \begin_inset Flex Code
21673 status collapsed
21674
21675 \begin_layout Plain Layout
21676
21677 \backslash
21678 columnsep
21679 \end_layout
21680
21681 \end_inset
21682
21683 .
21684  Its predefined value is 10
21685 \begin_inset space \thinspace{}
21686 \end_inset
21687
21688 pt.
21689  Here is an example where
21690 \begin_inset Flex Code
21691 status collapsed
21692
21693 \begin_layout Plain Layout
21694
21695 \backslash
21696 columnsep
21697 \end_layout
21698
21699 \end_inset
21700
21701  is set to 3
21702 \begin_inset space \thinspace{}
21703 \end_inset
21704
21705 cm:
21706 \end_layout
21707
21708 \begin_layout Standard
21709 \begin_inset ERT
21710 status open
21711
21712 \begin_layout Plain Layout
21713
21714
21715 \backslash
21716 setlength{
21717 \backslash
21718 columnsep}{3cm}
21719 \end_layout
21720
21721 \end_inset
21722
21723
21724 \end_layout
21725
21726 \begin_layout Standard
21727 \begin_inset Flex Multiple Columns
21728 status open
21729
21730 \begin_layout Plain Layout
21731
21732 \size small
21733 My observations of No.
21734 \begin_inset space \space{}
21735 \end_inset
21736
21737 427 Park Lane did little to clear up the problem in which I was interested.
21738  The house was separated from the street by a low wall and railing,
21739  the whole not more than five feet high.
21740  It was perfectly easy,
21741  therefore,
21742  for anyone to get into the garden,
21743  but the window was entirely inaccessible,
21744  since there was no water pipe or anything which could help the most active man to climb it.
21745  More puzzled than ever,
21746  I retraced my steps to Kensington.
21747  I had not been in my study five minutes when the maid entered to say that a person desired to see me.
21748  To my astonishment it was none other than my strange old book collector,
21749  his sharp,
21750  wizened face peering out from a frame of white hair,
21751  and his precious volumes,
21752  a dozen of them at least,
21753  wedged under his right arm.
21754 \end_layout
21755
21756 \end_inset
21757
21758
21759 \end_layout
21760
21761 \begin_layout Standard
21762 \begin_inset ERT
21763 status collapsed
21764
21765 \begin_layout Plain Layout
21766
21767
21768 \backslash
21769 setlength{
21770 \backslash
21771 columnsep}{10pt}
21772 \end_layout
21773
21774 \end_inset
21775
21776
21777 \begin_inset Note Note
21778 status collapsed
21779
21780 \begin_layout Plain Layout
21781 go back to the default
21782 \end_layout
21783
21784 \end_inset
21785
21786
21787 \end_layout
21788
21789 \begin_layout Paragraph
21790 Vertical Lines
21791 \end_layout
21792
21793 \begin_layout Standard
21794 Between the columns a rule with a width of the length
21795 \begin_inset Flex Code
21796 status collapsed
21797
21798 \begin_layout Plain Layout
21799
21800 \backslash
21801 columnseprule
21802 \end_layout
21803
21804 \end_inset
21805
21806  is placed.
21807  If this rule width is set to 0
21808 \begin_inset space \thinspace{}
21809 \end_inset
21810
21811 pt (this is the default),
21812  the rule is suppressed.
21813  In the following example the rule is 2
21814 \begin_inset space \thinspace{}
21815 \end_inset
21816
21817 pt wide:
21818 \end_layout
21819
21820 \begin_layout Standard
21821 \begin_inset ERT
21822 status open
21823
21824 \begin_layout Plain Layout
21825
21826
21827 \backslash
21828 setlength{
21829 \backslash
21830 columnseprule}{2pt}
21831 \end_layout
21832
21833 \end_inset
21834
21835
21836 \end_layout
21837
21838 \begin_layout Standard
21839 \begin_inset Flex Multiple Columns
21840 status open
21841
21842 \begin_layout Plain Layout
21843
21844 \size small
21845 \begin_inset Quotes eld
21846 \end_inset
21847
21848 You're surprised to see me,
21849  sir,
21850 \begin_inset Quotes erd
21851 \end_inset
21852
21853  said he,
21854  in a strange,
21855  croaking voice.
21856 \end_layout
21857
21858 \begin_layout Plain Layout
21859
21860 \size small
21861 I acknowledged that I was.
21862 \end_layout
21863
21864 \begin_layout Plain Layout
21865
21866 \size small
21867 \begin_inset Quotes eld
21868 \end_inset
21869
21870 Well,
21871  I've a conscience,
21872  sir,
21873  and when I chanced to see you go into this house,
21874  as I came hobbling after you,
21875  I thought to myself,
21876  I'll just step in and see that kind gentleman,
21877  and tell him that if I was a bit gruff in my manner there was not any harm meant,
21878  and that I am much obliged to him for picking up my books.
21879 \begin_inset Quotes erd
21880 \end_inset
21881
21882
21883 \end_layout
21884
21885 \begin_layout Plain Layout
21886
21887 \size small
21888 \begin_inset Quotes eld
21889 \end_inset
21890
21891 You make too much of a trifle,
21892 \begin_inset Quotes erd
21893 \end_inset
21894
21895  said I.
21896
21897 \begin_inset Quotes eld
21898 \end_inset
21899
21900 May I ask how you knew who I was?
21901 \begin_inset Quotes erd
21902 \end_inset
21903
21904
21905 \end_layout
21906
21907 \begin_layout Plain Layout
21908
21909 \size small
21910 \begin_inset Quotes eld
21911 \end_inset
21912
21913 Well,
21914  sir,
21915  if it isn't too great a liberty,
21916  I am a neighbour of yours,
21917  for you'll find my little bookshop at the corner of Church Street,
21918  and very happy to see you,
21919  I am sure.
21920  Maybe you collect yourself,
21921  sir.
21922  Here's
21923 \noun on
21924 British
21925 \begin_inset space ~
21926 \end_inset
21927
21928 Birds
21929 \noun default
21930 ,
21931  and
21932 \noun on
21933 Catullus
21934 \noun default
21935 ,
21936  and
21937 \noun on
21938 The Holy War
21939 \noun default
21940
21941 \begin_inset space ~
21942 \end_inset
21943
21944 – a bargain,
21945  every one of them.
21946  With five volumes you could just fill that gap on that second shelf.
21947  It looks untidy,
21948  does it not,
21949  sir?
21950 \begin_inset Quotes erd
21951 \end_inset
21952
21953
21954 \end_layout
21955
21956 \end_inset
21957
21958
21959 \end_layout
21960
21961 \begin_layout Standard
21962 \begin_inset VSpace defskip
21963 \end_inset
21964
21965
21966 \end_layout
21967
21968 \begin_layout Standard
21969 The rule can be colored by redefining the command
21970 \begin_inset Flex Code
21971 status collapsed
21972
21973 \begin_layout Plain Layout
21974
21975 \backslash
21976 columnseprulecolor
21977 \end_layout
21978
21979 \end_inset
21980
21981 .
21982  This is done by inserting the command
21983 \end_layout
21984
21985 \begin_layout LyX-Code
21986
21987 \backslash
21988 renewcommand{
21989 \backslash
21990 columnseprulecolor}{
21991 \backslash
21992 color{red}}
21993 \end_layout
21994
21995 \begin_layout Standard
21996 as \SpecialChar TeX
21997  Code before the multicolumn inset.
21998  Replace
21999 \begin_inset Flex Code
22000 status collapsed
22001
22002 \begin_layout Plain Layout
22003 red
22004 \end_layout
22005
22006 \end_inset
22007
22008  in this command by a color of your choice.
22009  You can use all pre- and self-defined colors.
22010  See the
22011 \emph on
22012 EmbeddedObjects
22013 \emph default
22014  manual,
22015  section
22016 \emph on
22017 Colored
22018 \begin_inset space ~
22019 \end_inset
22020
22021 Tables
22022 \emph default
22023  for more information about pre- and self-defined colors.
22024  To go back to the default color insert the command
22025 \end_layout
22026
22027 \begin_layout LyX-Code
22028
22029 \backslash
22030 renewcommand{
22031 \backslash
22032 columnseprulecolor}{
22033 \backslash
22034 normalcolor}
22035 \end_layout
22036
22037 \begin_layout Standard
22038 Here is the example with a cyan rule and 1
22039 \begin_inset space \thinspace{}
22040 \end_inset
22041
22042 cm column separation:
22043 \end_layout
22044
22045 \begin_layout Standard
22046 \begin_inset ERT
22047 status open
22048
22049 \begin_layout Plain Layout
22050
22051
22052 \backslash
22053 setlength{
22054 \backslash
22055 columnsep}{1cm}
22056 \end_layout
22057
22058 \begin_layout Plain Layout
22059
22060
22061 \backslash
22062 renewcommand{
22063 \backslash
22064 columnseprulecolor}{
22065 \backslash
22066 color{cyan}}
22067 \end_layout
22068
22069 \end_inset
22070
22071
22072 \end_layout
22073
22074 \begin_layout Standard
22075 \begin_inset Flex Multiple Columns
22076 status open
22077
22078 \begin_layout Plain Layout
22079
22080 \size small
22081 \begin_inset Quotes eld
22082 \end_inset
22083
22084 You're surprised to see me,
22085  sir,
22086 \begin_inset Quotes erd
22087 \end_inset
22088
22089  said he,
22090  in a strange,
22091  croaking voice.
22092 \end_layout
22093
22094 \begin_layout Plain Layout
22095
22096 \size small
22097 I acknowledged that I was.
22098 \end_layout
22099
22100 \begin_layout Plain Layout
22101
22102 \size small
22103 \begin_inset Quotes eld
22104 \end_inset
22105
22106 Well,
22107  I've a conscience,
22108  sir,
22109  and when I chanced to see you go into this house,
22110  as I came hobbling after you,
22111  I thought to myself,
22112  I'll just step in and see that kind gentleman,
22113  and tell him that if I was a bit gruff in my manner there was not any harm meant,
22114  and that I am much obliged to him for picking up my books.
22115 \begin_inset Quotes erd
22116 \end_inset
22117
22118
22119 \end_layout
22120
22121 \begin_layout Plain Layout
22122
22123 \size small
22124 \begin_inset Quotes eld
22125 \end_inset
22126
22127 You make too much of a trifle,
22128 \begin_inset Quotes erd
22129 \end_inset
22130
22131  said I.
22132
22133 \begin_inset Quotes eld
22134 \end_inset
22135
22136 May I ask how you knew who I was?
22137 \begin_inset Quotes erd
22138 \end_inset
22139
22140
22141 \end_layout
22142
22143 \begin_layout Plain Layout
22144
22145 \size small
22146 \begin_inset Quotes eld
22147 \end_inset
22148
22149 Well,
22150  sir,
22151  if it isn't too great a liberty,
22152  I am a neighbour of yours,
22153  for you'll find my little bookshop at the corner of Church Street,
22154  and very happy to see you,
22155  I am sure.
22156  Maybe you collect yourself,
22157  sir.
22158  Here's
22159 \noun on
22160 British
22161 \begin_inset space ~
22162 \end_inset
22163
22164 Birds
22165 \noun default
22166 ,
22167  and
22168 \noun on
22169 Catullus
22170 \noun default
22171 ,
22172  and
22173 \noun on
22174 The Holy War
22175 \noun default
22176
22177 \begin_inset space ~
22178 \end_inset
22179
22180 – a bargain,
22181  every one of them.
22182  With five volumes you could just fill that gap on that second shelf.
22183  It looks untidy,
22184  does it not,
22185  sir?
22186 \begin_inset Quotes erd
22187 \end_inset
22188
22189
22190 \end_layout
22191
22192 \end_inset
22193
22194
22195 \end_layout
22196
22197 \begin_layout Standard
22198 \begin_inset ERT
22199 status collapsed
22200
22201 \begin_layout Plain Layout
22202
22203
22204 \backslash
22205 setlength{
22206 \backslash
22207 columnseprule}{0pt}
22208 \end_layout
22209
22210 \begin_layout Plain Layout
22211
22212
22213 \backslash
22214 renewcommand{
22215 \backslash
22216 columnseprulecolor}{
22217 \backslash
22218 normalcolor}
22219 \end_layout
22220
22221 \end_inset
22222
22223
22224 \begin_inset Note Note
22225 status collapsed
22226
22227 \begin_layout Plain Layout
22228 go back to the default
22229 \end_layout
22230
22231 \end_inset
22232
22233
22234 \end_layout
22235
22236 \begin_layout Section
22237
22238 \change_inserted 564990737 1671270380
22239 Paragraph Styles
22240 \end_layout
22241
22242 \begin_layout Subsection
22243
22244 \change_inserted 564990737 1671270398
22245 Custom
22246 \change_deleted 564990737 1671270396
22247 Non-standard
22248 \change_unchanged
22249  Paragraph Shapes
22250 \end_layout
22251
22252 \begin_layout Standard
22253 \noindent
22254 \SpecialChar LaTeX
22255  as well as any other text processor uses by default rectangular paragraphs.
22256  For special cases like for example posters,
22257  invitation cards or poems you can modify the paragraph shape to one of your choice.
22258
22259 \change_deleted 564990737 1672311802
22260 This can be done by using the \SpecialChar LaTeX
22261 -package
22262 \begin_inset Flex Code
22263 status collapsed
22264
22265 \begin_layout Plain Layout
22266 shapepar
22267 \end_layout
22268
22269 \end_inset
22270
22271  which is loaded by using in the document settings the module
22272 \family sans
22273 Custom paragraph shapes
22274 \family default
22275 .
22276 \change_inserted 564990737 1672311802
22277 This module uses the
22278 \family sans
22279 shapepar
22280 \family default
22281  package to provide over a dozen paragraph shapes as well as commands to define custom shapes.
22282
22283 \change_unchanged
22284
22285 \end_layout
22286
22287 \begin_layout Subsubsection
22288 Predefined shapes
22289 \end_layout
22290
22291 \begin_layout Standard
22292
22293 \series bold
22294 shapepar
22295 \series default
22296  provides the following shapes:
22297 \end_layout
22298
22299 \begin_layout Standard
22300 \begin_inset Tabular
22301 <lyxtabular version="3" rows="13" columns="3">
22302 <features booktabs="true" islongtable="true" longtabularalignment="center">
22303 <column alignment="left" valignment="middle" width="16col%">
22304 <column alignment="left" valignment="middle" width="40col%">
22305 <column alignment="left" valignment="middle" width="35col%">
22306 <row endhead="true">
22307 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22308 \begin_inset Text
22309
22310 \begin_layout Plain Layout
22311
22312 \series bold
22313 \size small
22314 Name
22315 \end_layout
22316
22317 \end_inset
22318 </cell>
22319 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22320 \begin_inset Text
22321
22322 \begin_layout Plain Layout
22323
22324 \series bold
22325 \size small
22326 Description
22327 \end_layout
22328
22329 \end_inset
22330 </cell>
22331 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22332 \begin_inset Text
22333
22334 \begin_layout Plain Layout
22335
22336 \series bold
22337 \size small
22338 Annotation
22339 \end_layout
22340
22341 \end_inset
22342 </cell>
22343 </row>
22344 <row interlinespace="default">
22345 <cell alignment="left" valignment="top" usebox="none">
22346 \begin_inset Text
22347
22348 \begin_layout Plain Layout
22349
22350 \size small
22351 CDlabel
22352 \end_layout
22353
22354 \end_inset
22355 </cell>
22356 <cell alignment="left" valignment="top" usebox="none">
22357 \begin_inset Text
22358
22359 \begin_layout Plain Layout
22360
22361 \size small
22362 Circle with circular hole (in the size of a CD/DVD)
22363 \end_layout
22364
22365 \end_inset
22366 </cell>
22367 <cell alignment="left" valignment="top" usebox="none">
22368 \begin_inset Text
22369
22370 \begin_layout Plain Layout
22371
22372 \size small
22373 Cannot be scaled,
22374  take care there is not too much text
22375 \end_layout
22376
22377 \end_inset
22378 </cell>
22379 </row>
22380 <row interlinespace="default">
22381 <cell alignment="left" valignment="top" usebox="none">
22382 \begin_inset Text
22383
22384 \begin_layout Plain Layout
22385
22386 \size small
22387 Circle
22388 \end_layout
22389
22390 \end_inset
22391 </cell>
22392 <cell alignment="left" valignment="top" usebox="none">
22393 \begin_inset Text
22394
22395 \begin_layout Plain Layout
22396
22397 \size small
22398 Circle
22399 \end_layout
22400
22401 \end_inset
22402 </cell>
22403 <cell alignment="left" valignment="top" usebox="none">
22404 \begin_inset Text
22405
22406 \begin_layout Plain Layout
22407
22408 \size small
22409 Fragile,
22410  calculation might fail
22411 \end_layout
22412
22413 \end_inset
22414 </cell>
22415 </row>
22416 <row interlinespace="default">
22417 <cell alignment="left" valignment="top" usebox="none">
22418 \begin_inset Text
22419
22420 \begin_layout Plain Layout
22421
22422 \size small
22423 Diamond
22424 \end_layout
22425
22426 \end_inset
22427 </cell>
22428 <cell alignment="left" valignment="top" usebox="none">
22429 \begin_inset Text
22430
22431 \begin_layout Plain Layout
22432
22433 \size small
22434 Rhomboid (symbolizing a
22435 \begin_inset Quotes eld
22436 \end_inset
22437
22438 diamond
22439 \begin_inset Quotes erd
22440 \end_inset
22441
22442 )
22443 \end_layout
22444
22445 \end_inset
22446 </cell>
22447 <cell alignment="left" valignment="top" usebox="none">
22448 \begin_inset Text
22449
22450 \begin_layout Plain Layout
22451
22452 \size small
22453 -
22454 \end_layout
22455
22456 \end_inset
22457 </cell>
22458 </row>
22459 <row interlinespace="default">
22460 <cell alignment="left" valignment="top" usebox="none">
22461 \begin_inset Text
22462
22463 \begin_layout Plain Layout
22464
22465 \size small
22466 Heart
22467 \end_layout
22468
22469 \end_inset
22470 </cell>
22471 <cell alignment="left" valignment="top" usebox="none">
22472 \begin_inset Text
22473
22474 \begin_layout Plain Layout
22475
22476 \size small
22477 Heart-like shape
22478 \end_layout
22479
22480 \end_inset
22481 </cell>
22482 <cell alignment="left" valignment="top" usebox="none">
22483 \begin_inset Text
22484
22485 \begin_layout Plain Layout
22486
22487 \size small
22488 -
22489 \end_layout
22490
22491 \end_inset
22492 </cell>
22493 </row>
22494 <row interlinespace="default">
22495 <cell alignment="left" valignment="top" usebox="none">
22496 \begin_inset Text
22497
22498 \begin_layout Plain Layout
22499
22500 \size small
22501 Hexagon
22502 \end_layout
22503
22504 \end_inset
22505 </cell>
22506 <cell alignment="left" valignment="top" usebox="none">
22507 \begin_inset Text
22508
22509 \begin_layout Plain Layout
22510
22511 \size small
22512 Hexagon
22513 \end_layout
22514
22515 \end_inset
22516 </cell>
22517 <cell alignment="left" valignment="top" usebox="none">
22518 \begin_inset Text
22519
22520 \begin_layout Plain Layout
22521
22522 \size small
22523 -
22524 \end_layout
22525
22526 \end_inset
22527 </cell>
22528 </row>
22529 <row interlinespace="default">
22530 <cell alignment="left" valignment="top" usebox="none">
22531 \begin_inset Text
22532
22533 \begin_layout Plain Layout
22534
22535 \size small
22536 Nut
22537 \end_layout
22538
22539 \end_inset
22540 </cell>
22541 <cell alignment="left" valignment="top" usebox="none">
22542 \begin_inset Text
22543
22544 \begin_layout Plain Layout
22545
22546 \size small
22547 Nut for bolt (hexagon with circular hole)
22548 \end_layout
22549
22550 \end_inset
22551 </cell>
22552 <cell alignment="left" valignment="top" usebox="none">
22553 \begin_inset Text
22554
22555 \begin_layout Plain Layout
22556
22557 \size small
22558 -
22559 \end_layout
22560
22561 \end_inset
22562 </cell>
22563 </row>
22564 <row interlinespace="default">
22565 <cell alignment="left" valignment="top" usebox="none">
22566 \begin_inset Text
22567
22568 \begin_layout Plain Layout
22569
22570 \size small
22571 Square
22572 \end_layout
22573
22574 \end_inset
22575 </cell>
22576 <cell alignment="left" valignment="top" usebox="none">
22577 \begin_inset Text
22578
22579 \begin_layout Plain Layout
22580
22581 \size small
22582 Square
22583 \end_layout
22584
22585 \end_inset
22586 </cell>
22587 <cell alignment="left" valignment="top" usebox="none">
22588 \begin_inset Text
22589
22590 \begin_layout Plain Layout
22591
22592 \size small
22593 -
22594 \end_layout
22595
22596 \end_inset
22597 </cell>
22598 </row>
22599 <row interlinespace="default">
22600 <cell alignment="left" valignment="top" usebox="none">
22601 \begin_inset Text
22602
22603 \begin_layout Plain Layout
22604
22605 \size small
22606 Star
22607 \end_layout
22608
22609 \end_inset
22610 </cell>
22611 <cell alignment="left" valignment="top" usebox="none">
22612 \begin_inset Text
22613
22614 \begin_layout Plain Layout
22615
22616 \size small
22617 Five-point star
22618 \end_layout
22619
22620 \end_inset
22621 </cell>
22622 <cell alignment="left" valignment="top" usebox="none">
22623 \begin_inset Text
22624
22625 \begin_layout Plain Layout
22626
22627 \size small
22628 -
22629 \end_layout
22630
22631 \end_inset
22632 </cell>
22633 </row>
22634 <row interlinespace="default">
22635 <cell alignment="left" valignment="top" usebox="none">
22636 \begin_inset Text
22637
22638 \begin_layout Plain Layout
22639
22640 \size small
22641 Candle
22642 \end_layout
22643
22644 \end_inset
22645 </cell>
22646 <cell alignment="left" valignment="top" usebox="none">
22647 \begin_inset Text
22648
22649 \begin_layout Plain Layout
22650
22651 \size small
22652 Burning candle
22653 \end_layout
22654
22655 \end_inset
22656 </cell>
22657 <cell alignment="left" valignment="top" usebox="none">
22658 \begin_inset Text
22659
22660 \begin_layout Plain Layout
22661
22662 \size small
22663 -
22664 \end_layout
22665
22666 \end_inset
22667 </cell>
22668 </row>
22669 <row interlinespace="default">
22670 <cell alignment="left" valignment="top" usebox="none">
22671 \begin_inset Text
22672
22673 \begin_layout Plain Layout
22674
22675 \size small
22676 Drop down/up
22677 \end_layout
22678
22679 \end_inset
22680 </cell>
22681 <cell alignment="left" valignment="top" usebox="none">
22682 \begin_inset Text
22683
22684 \begin_layout Plain Layout
22685
22686 \size small
22687 Normal/reversed rain drop
22688 \end_layout
22689
22690 \end_inset
22691 </cell>
22692 <cell alignment="left" valignment="top" usebox="none">
22693 \begin_inset Text
22694
22695 \begin_layout Plain Layout
22696
22697 \size small
22698 Fragile,
22699  calculation might fail
22700 \end_layout
22701
22702 \end_inset
22703 </cell>
22704 </row>
22705 <row interlinespace="default">
22706 <cell alignment="left" valignment="top" usebox="none">
22707 \begin_inset Text
22708
22709 \begin_layout Plain Layout
22710
22711 \size small
22712 \SpecialChar TeX
22713
22714 \end_layout
22715
22716 \end_inset
22717 </cell>
22718 <cell alignment="left" valignment="top" usebox="none">
22719 \begin_inset Text
22720
22721 \begin_layout Plain Layout
22722
22723 \size small
22724 The \SpecialChar TeX
22725  logo
22726 \end_layout
22727
22728 \end_inset
22729 </cell>
22730 <cell alignment="left" valignment="top" usebox="none">
22731 \begin_inset Text
22732
22733 \begin_layout Plain Layout
22734
22735 \size small
22736 -
22737 \end_layout
22738
22739 \end_inset
22740 </cell>
22741 </row>
22742 <row interlinespace="default">
22743 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
22744 \begin_inset Text
22745
22746 \begin_layout Plain Layout
22747
22748 \size small
22749 Triangle up/down/
22750 \begin_inset Newline newline
22751 \end_inset
22752
22753 left/right
22754 \end_layout
22755
22756 \end_inset
22757 </cell>
22758 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
22759 \begin_inset Text
22760
22761 \begin_layout Plain Layout
22762
22763 \size small
22764 Triangles in different orientations
22765 \end_layout
22766
22767 \end_inset
22768 </cell>
22769 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
22770 \begin_inset Text
22771
22772 \begin_layout Plain Layout
22773
22774 \size small
22775 -
22776 \end_layout
22777
22778 \end_inset
22779 </cell>
22780 </row>
22781 </lyxtabular>
22782
22783 \end_inset
22784
22785
22786 \end_layout
22787
22788 \begin_layout Standard
22789 To use a shape for your paragraph,
22790  simply select it in \SpecialChar LyX
22791 's pull-down box for environments in the toolbar.
22792 \end_layout
22793
22794 \begin_layout Standard
22795 \begin_inset Newpage newpage
22796 \end_inset
22797
22798
22799 \end_layout
22800
22801 \begin_layout Standard
22802 Here is an example paragraph in the shape of a nut:
22803 \end_layout
22804
22805 \begin_layout Standard
22806 \begin_inset VSpace bigskip
22807 \end_inset
22808
22809
22810 \end_layout
22811
22812 \begin_layout Nut
22813
22814 \lang latin
22815 Lorem ipsum dolor sit amet,
22816  consetetur sadipscing elitr,
22817  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22818  sed diam voluptua.
22819  At vero eos et accusam et justo duo dolores et ea rebum.
22820  Stet clita kasd gubergren,
22821  no sea takimata sanctus est Lorem ipsum dolor sit amet.
22822  Lorem ipsum dolor sit amet,
22823  consetetur sadipscing elitr,
22824  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22825  sed diam voluptua.
22826 \end_layout
22827
22828 \begin_layout Standard
22829 \begin_inset VSpace bigskip
22830 \end_inset
22831
22832
22833 \end_layout
22834
22835 \begin_layout Standard
22836 \begin_inset Note Greyedout
22837 status open
22838
22839 \begin_layout Plain Layout
22840
22841 \series bold
22842 Note
22843 \series default
22844 :
22845
22846 \family sans
22847 shapepar
22848 \family default
22849  paragraphs cannot run over a page break.
22850 \end_layout
22851
22852 \end_inset
22853
22854
22855 \end_layout
22856
22857 \begin_layout Standard
22858 \begin_inset VSpace bigskip
22859 \end_inset
22860
22861
22862 \end_layout
22863
22864 \begin_layout Standard
22865 The package
22866 \begin_inset Flex Code
22867 status collapsed
22868
22869 \begin_layout Plain Layout
22870 shapepar
22871 \end_layout
22872
22873 \end_inset
22874
22875  takes care that the shape will always be preserved,
22876  no matter how much text is in the paragraph.
22877  Therefore the paragraph size changes with the amount of contained text.
22878  This can lead to paragraph sizes exceeding the page margins.
22879  To demonstrate the size scaling,
22880  here is the same example paragraph but with twice as much text:
22881 \end_layout
22882
22883 \begin_layout Standard
22884 \begin_inset Newpage newpage
22885 \end_inset
22886
22887
22888 \end_layout
22889
22890 \begin_layout Nut
22891
22892 \lang latin
22893 Lorem ipsum dolor sit amet,
22894  consetetur sadipscing elitr,
22895  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22896  sed diam voluptua.
22897  At vero eos et accusam et justo duo dolores et ea rebum.
22898  Stet clita kasd gubergren,
22899  no sea takimata sanctus est Lorem ipsum dolor sit amet.
22900  Lorem ipsum dolor sit amet,
22901  consetetur sadipscing elitr,
22902  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22903  sed diam voluptua.
22904  Lorem ipsum dolor sit amet,
22905  consetetur sadipscing elitr,
22906  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22907  sed diam voluptua.
22908  At vero eos et accusam et justo duo dolores et ea rebum.
22909  Stet clita kasd gubergren,
22910  no sea takimata sanctus est Lorem ipsum dolor sit amet.
22911  Lorem ipsum dolor sit amet,
22912  consetetur sadipscing elitr,
22913  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22914  sed diam voluptua.
22915 \end_layout
22916
22917 \begin_layout Standard
22918 \begin_inset VSpace bigskip
22919 \end_inset
22920
22921
22922 \end_layout
22923
22924 \begin_layout Standard
22925 An exception is the shape
22926 \family sans
22927 CDlabel
22928 \family default
22929 .
22930  It cannot be scaled because it must fit the size of a CD/DVD.
22931  Therefore the amount of text that fits into the shape is limited.
22932 \begin_inset Newline newline
22933 \end_inset
22934
22935 The
22936 \family sans
22937 drop
22938 \family default
22939  shapes and the
22940 \family sans
22941 circle
22942 \family default
22943  shape are fragile,
22944  meaning that the calculation of their size can fail,
22945  depending on the amount of text.
22946  You will then get the \SpecialChar LaTeX
22947  error
22948 \begin_inset Quotes eld
22949 \end_inset
22950
22951 Arithmetic overflow
22952 \begin_inset Quotes erd
22953 \end_inset
22954
22955 .
22956  In this case one can try to remove or add some text;
22957  if nothing works one has to use another shape.
22958 \end_layout
22959
22960 \begin_layout Standard
22961 \begin_inset VSpace bigskip
22962 \end_inset
22963
22964
22965 \end_layout
22966
22967 \begin_layout Standard
22968 For shapes with tips you will maybe see that \SpecialChar LaTeX
22969 's hyphenation routine fails for text in the tips.
22970  Therefore it is often necessary to add hyphenation points
22971 \family sans
22972 (
22973 \begin_inset Info
22974 type  "shortcut"
22975 arg   "specialchar-insert hyphenation"
22976 \end_inset
22977
22978
22979 \family default
22980 ) to the corresponding text parts.
22981 \end_layout
22982
22983 \begin_layout Standard
22984 \begin_inset VSpace bigskip
22985 \end_inset
22986
22987
22988 \end_layout
22989
22990 \begin_layout Standard
22991 Shapepar paragraphs are either always centered or placed on the page so that their left border touches the left page margin.
22992  You can therefore not use the paragraph dialog to align such paragraphs.
22993  A solution is to put the paragraph into a minipage or parbox and align the box.
22994  The problem is hereby to find the right width for the box.
22995  Because if it is too wide and you center the box,
22996  the paragraph is not centered too because it sticks at the left side of the box.
22997  So you might have to play a bit with the width until it fits.
22998  Here are two heart-shaped paragraphs,
22999  the first one is not aligned,
23000  the second one is right-aligned:
23001 \end_layout
23002
23003 \begin_layout Standard
23004 \begin_inset Newpage newpage
23005 \end_inset
23006
23007
23008 \end_layout
23009
23010 \begin_layout Heart
23011 \noindent
23012
23013 \lang latin
23014 Lo\SpecialChar softhyphen
23015 rem ipsum dolor sit amet,
23016  consetetur sadipscing elitr,
23017  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
23018  sed diam voluptua.
23019  At vero eos et accusam et justo duo dolores et ea rebum.
23020  Stet clita kasd gubergren,
23021  no sea takimata sanctus est Lorem ipsum dolor sit amet.
23022 \end_layout
23023
23024 \begin_layout Standard
23025 \begin_inset VSpace bigskip
23026 \end_inset
23027
23028
23029 \end_layout
23030
23031 \begin_layout Standard
23032 \noindent
23033 \align right
23034 \begin_inset Box Frameless
23035 position "t"
23036 hor_pos "c"
23037 has_inner_box 1
23038 inner_pos "t"
23039 use_parbox 1
23040 use_makebox 0
23041 width "42col%"
23042 special "none"
23043 height "1in"
23044 height_special "totalheight"
23045 thickness "0.4pt"
23046 separation "3pt"
23047 shadowsize "4pt"
23048 framecolor "black"
23049 backgroundcolor "none"
23050 status open
23051
23052 \begin_layout Heart
23053 \noindent
23054
23055 \lang latin
23056 Lo\SpecialChar softhyphen
23057 rem ipsum dolor sit amet,
23058  consetetur sadipscing elitr,
23059  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
23060  sed diam voluptua.
23061  At vero eos et accusam et justo duo dolores et ea rebum.
23062  Stet clita kasd gubergren,
23063  no sea takimata sanctus est Lorem ipsum dolor sit amet.
23064 \end_layout
23065
23066 \end_inset
23067
23068
23069 \end_layout
23070
23071 \begin_layout Subsubsection
23072 Custom shapes
23073 \end_layout
23074
23075 \begin_layout Standard
23076 You can define any shape you want.
23077  Doing this manually is a lot of work because every coordinate must be specified.
23078  But there is a way to let the computer calculate the coordinates:
23079 \end_layout
23080
23081 \begin_layout Enumerate
23082 Install the program
23083 \begin_inset CommandInset href
23084 LatexCommand href
23085 name "Jpgfdraw"
23086 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
23087 literal "false"
23088
23089 \end_inset
23090
23091 .
23092 \end_layout
23093
23094 \begin_layout Enumerate
23095 In
23096 \family sans
23097 Jpgfdraw
23098 \family default
23099  go to the menu
23100 \family sans
23101 TeX/LaTeX\SpecialChar menuseparator
23102 Settings\SpecialChar menuseparator
23103 Set Normal Size
23104 \family default
23105  and select the font size you are using in your document.
23106  For example this document uses the size 12
23107 \begin_inset space \thinspace{}
23108 \end_inset
23109
23110 pt.
23111 \end_layout
23112
23113 \begin_layout Enumerate
23114 Draw a shape.
23115 \end_layout
23116
23117 \begin_layout Enumerate
23118 Use the menu
23119 \family sans
23120 TeX/LaTeX\SpecialChar menuseparator
23121 Shapepar
23122 \family default
23123  to export the shape to coordinates.
23124  In the appearing dialog use either the outline of your shape for the coordinates or the path itself.
23125 \begin_inset Foot
23126 status collapsed
23127
23128 \begin_layout Plain Layout
23129 For more information see
23130 \begin_inset CommandInset href
23131 LatexCommand href
23132 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
23133 literal "false"
23134
23135 \end_inset
23136
23137
23138 \end_layout
23139
23140 \end_inset
23141
23142
23143 \end_layout
23144
23145 \begin_layout Standard
23146 The coordinates are written into a \SpecialChar TeX
23147  file.
23148  To use it for your \SpecialChar LyX
23149  document
23150 \end_layout
23151
23152 \begin_layout Enumerate
23153 Place the cursor before the first character of your paragraph (or into a new empty one).
23154 \end_layout
23155
23156 \begin_layout Enumerate
23157 Open in \SpecialChar LyX
23158  the menu
23159 \family sans
23160 Insert\SpecialChar menuseparator
23161 File\SpecialChar menuseparator
23162 Child
23163 \begin_inset space ~
23164 \end_inset
23165
23166 Document
23167 \family default
23168 ,
23169  select the file and use
23170 \family sans
23171 Input
23172 \family default
23173  as
23174 \family sans
23175 Include Type.
23176 \end_layout
23177
23178 \begin_layout Standard
23179 \begin_inset VSpace defskip
23180 \end_inset
23181
23182
23183 \end_layout
23184
23185 \begin_layout Standard
23186 \begin_inset Note Greyedout
23187 status open
23188
23189 \begin_layout Plain Layout
23190
23191 \series bold
23192 Note
23193 \series default
23194 :
23195  The changed shape only applies to the current paragraph;
23196  everything is reset to normal for the next paragraph.
23197  Therefore the shape definition file must be input into every paragraph with the desired shape.
23198 \end_layout
23199
23200 \end_inset
23201
23202
23203 \end_layout
23204
23205 \begin_layout Standard
23206 \begin_inset VSpace bigskip
23207 \end_inset
23208
23209
23210 \end_layout
23211
23212 \begin_layout Standard
23213 Here is an example:
23214 \end_layout
23215
23216 \begin_layout Standard
23217 \begin_inset VSpace bigskip
23218 \end_inset
23219
23220
23221 \end_layout
23222
23223 \begin_layout Standard
23224 \begin_inset CommandInset include
23225 LatexCommand input
23226 filename "SpecialParagraphShape.tex"
23227 literal "true"
23228
23229 \end_inset
23230
23231
23232 \lang latin
23233 Lorem ipsum dolor sit amet,
23234  consetetur sadipscing elitr,
23235  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
23236  sed diam voluptua.
23237  At vero eos et accusam et justo duo dolores et ea rebum.
23238  Stet clita kasd gubergren,
23239  no sea takimata sanctus est Lorem ipsum dolor sit amet.
23240  Lorem ipsum dolor sit amet,
23241  consetetur sadipscing elitr,
23242  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
23243  sed diam voluptua.
23244 \end_layout
23245
23246 \begin_layout Standard
23247 \begin_inset VSpace bigskip
23248 \end_inset
23249
23250
23251 \end_layout
23252
23253 \begin_layout Standard
23254
23255 \series bold
23256 A tip:
23257
23258 \series default
23259  to draw complexer shapes in
23260 \family sans
23261 Jpgfdraw
23262 \family default
23263  you can draw the shape in a program of your choice and import the resulting image to
23264 \family sans
23265 Jpgfdraw
23266 \family default
23267 .
23268  Then you only need to draw a line or spline along the outline of the image.
23269 \end_layout
23270
23271 \begin_layout Standard
23272 \begin_inset VSpace bigskip
23273 \end_inset
23274
23275
23276 \end_layout
23277
23278 \begin_layout Standard
23279 The module
23280 \family sans
23281 Custom paragraph shapes
23282 \family default
23283  also provides the two commands
23284 \family sans
23285 shapepar
23286 \family default
23287  and
23288 \family sans
23289 Shapepar
23290 \family default
23291  which can be used to define custom shapes coordinate by coordinate.
23292 \begin_inset Foot
23293 status collapsed
23294
23295 \begin_layout Plain Layout
23296 These commands are internally used for all shapes described here.
23297 \end_layout
23298
23299 \end_inset
23300
23301  For information how these styles are used and about further customization possibilities,
23302  have a look at the
23303 \begin_inset CommandInset href
23304 LatexCommand href
23305 name "documentation"
23306 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
23307 literal "false"
23308
23309 \end_inset
23310
23311  of the package
23312 \begin_inset Flex Code
23313 status collapsed
23314
23315 \begin_layout Plain Layout
23316 shapepar
23317 \end_layout
23318
23319 \end_inset
23320
23321 .
23322 \end_layout
23323
23324 \begin_layout Subsection
23325
23326 \change_inserted 564990737 1672311925
23327 Hanging Paragraphs
23328 \end_layout
23329
23330 \begin_layout Hanging
23331
23332 \change_inserted 564990737 1672311925
23333 This module adds the
23334 \family sans
23335 Hanging
23336 \family default
23337  paragraph style,
23338  that is,
23339  one where all but the first line of the paragraph is indented.
23340  This may not appear in your \SpecialChar LyX
23341  document but will appear in the final output.
23342 \end_layout
23343
23344 \begin_layout Subsection
23345
23346 \change_inserted 564990737 1672311925
23347 \begin_inset CommandInset label
23348 LatexCommand label
23349 name "subsec:Initials"
23350
23351 \end_inset
23352
23353 Initials (Drop Caps)
23354 \end_layout
23355
23356 \begin_layout Initial
23357
23358 \change_inserted 564990737 1672311925
23359 \begin_inset Argument 2
23360 status open
23361
23362 \begin_layout Plain Layout
23363
23364 \change_inserted 564990737 1672311925
23365 T
23366 \change_unchanged
23367
23368 \end_layout
23369
23370 \end_inset
23371
23372
23373 \begin_inset Argument 3
23374 status open
23375
23376 \begin_layout Plain Layout
23377
23378 \change_inserted 564990737 1672311925
23379 his
23380 \change_unchanged
23381
23382 \end_layout
23383
23384 \end_inset
23385
23386  module adds a drop capitals paragraph style
23387 \family sans
23388 Initials
23389 \family default
23390  for paragraph environments which you can use wherever you want to have drop capitals.
23391  You then have three more items in the
23392 \family sans
23393 Insert
23394 \family default
23395  menu:
23396 \end_layout
23397
23398 \begin_layout Itemize
23399
23400 \change_inserted 564990737 1672311925
23401
23402 \family sans
23403 Initial
23404 \family default
23405  which creates an inset for the drop capital
23406 \end_layout
23407
23408 \begin_layout Itemize
23409
23410 \change_inserted 564990737 1672311925
23411
23412 \family sans
23413 Rest of initial
23414 \family default
23415  which creates an inset for the rest of the word
23416 \end_layout
23417
23418 \begin_layout Itemize
23419
23420 \change_inserted 564990737 1672311925
23421
23422 \family sans
23423 Options
23424 \family default
23425  which allow you configure the formatting of the drop capital.
23426 \end_layout
23427
23428 \begin_layout Standard
23429
23430 \change_inserted 564990737 1672311925
23431 To customize the appearance of the style,
23432  see
23433 \family sans
23434 Help\SpecialChar menuseparator
23435 Embedded Objects\SpecialChar menuseparator
23436 Objects Surrounded by Text\SpecialChar menuseparator
23437 Initials
23438 \family default
23439 .
23440 \end_layout
23441
23442 \begin_layout Section
23443
23444 \change_inserted 564990737 1672312011
23445 Text Markup
23446 \end_layout
23447
23448 \begin_layout Subsection
23449
23450 \change_inserted 564990737 1672312011
23451 Hyphenatable Text Markup
23452 \end_layout
23453
23454 \begin_layout Standard
23455
23456 \change_inserted 564990737 1672312011
23457 This package defines text styles to highlight,
23458  space-out,
23459  strike-through,
23460  underline and capitalize/small-cap text by means of the
23461 \family sans
23462 soul
23463 \family default
23464  package.
23465  As opposed to the markup provided by the Text Properties dialog,
23466  words marked-up with
23467 \family sans
23468 soul
23469 \family default
23470  are hyphenated.
23471  See the
23472 \begin_inset CommandInset href
23473 LatexCommand href
23474 name "soul documentation"
23475 target "http://mirrors.ctan.org/macros/generic/soul/soul.pdf"
23476 literal "false"
23477
23478 \end_inset
23479
23480 .
23481 \end_layout
23482
23483 \begin_layout Subsection
23484
23485 \change_inserted 564990737 1672312011
23486 Logical Markup
23487 \end_layout
23488
23489 \begin_layout Standard
23490
23491 \change_inserted 564990737 1672312011
23492 This module defines some character styles for logical markup:
23493
23494 \noun on
23495
23496 \begin_inset Flex Noun
23497 status collapsed
23498
23499 \begin_layout Plain Layout
23500
23501 \change_inserted 564990737 1672312011
23502
23503 \noun on
23504 noun
23505 \change_unchanged
23506
23507 \end_layout
23508
23509 \end_inset
23510
23511
23512 \noun default
23513 ,
23514
23515 \emph on
23516
23517 \begin_inset Flex Emph
23518 status collapsed
23519
23520 \begin_layout Plain Layout
23521
23522 \change_inserted 564990737 1672312011
23523
23524 \emph on
23525 emph
23526 \change_unchanged
23527
23528 \end_layout
23529
23530 \end_inset
23531
23532
23533 \emph default
23534 ,
23535
23536 \begin_inset Flex Strong
23537 status collapsed
23538
23539 \begin_layout Plain Layout
23540
23541 \change_inserted 564990737 1672312011
23542 strong
23543 \change_unchanged
23544
23545 \end_layout
23546
23547 \end_inset
23548
23549 ,
23550  and
23551 \begin_inset Flex Code
23552 status collapsed
23553
23554 \begin_layout Plain Layout
23555
23556 \change_inserted 564990737 1672312011
23557 code
23558 \change_unchanged
23559
23560 \end_layout
23561
23562 \end_inset
23563
23564  which are accessed via the
23565 \family sans
23566 \bar under
23567 E
23568 \bar default
23569 dit\SpecialChar menuseparator
23570 Custom
23571 \begin_inset space ~
23572 \end_inset
23573
23574 Text
23575 \begin_inset space ~
23576 \end_inset
23577
23578
23579 \bar under
23580 S
23581 \bar default
23582 tyles
23583 \family default
23584  menu.
23585 \end_layout
23586
23587 \begin_layout Chapter
23588
23589 \change_deleted 564990737 1671304317
23590 Customizing
23591 \change_unchanged
23592 Bibliograph
23593 \change_inserted 564990737 1671304322
23594 y
23595 \change_deleted 564990737 1671304331
23596 ies with Bib\SpecialChar TeX
23597  or Biblatex
23598 \change_unchanged
23599
23600 \end_layout
23601
23602 \begin_layout Standard
23603 The most basic information about how to use Bib\SpecialChar TeX
23604  or
23605 \family sans
23606 Biblatex
23607 \family default
23608  with \SpecialChar LyX
23609  is contained in the section
23610 \emph on
23611 Bibliography databases
23612 \emph default
23613  of the
23614 \emph on
23615 User's Guide
23616 \emph default
23617 .
23618  The following subsections explain special bibliography features supported by \SpecialChar LyX
23619 .
23620 \end_layout
23621
23622 \begin_layout Section
23623 Alternative Citation Styles
23624 \end_layout
23625
23626 \begin_layout Standard
23627 Standard Bib\SpecialChar TeX
23628  uses numbers (e.
23629 \begin_inset space \thinspace{}
23630 \end_inset
23631
23632 g.
23633 \begin_inset space \space{}
23634 \end_inset
23635
23636
23637 \begin_inset Quotes eld
23638 \end_inset
23639
23640 [12]
23641 \begin_inset Quotes erd
23642 \end_inset
23643
23644 ) to refer to a cited work.
23645  However,
23646  in many scientific disciplines,
23647  other citation styles are in use.
23648  The most common one is the author-year style (e.
23649 \begin_inset space \thinspace{}
23650 \end_inset
23651
23652 g.
23653 \begin_inset space \space{}
23654 \end_inset
23655
23656
23657 \begin_inset Quotes eld
23658 \end_inset
23659
23660 Knuth 1984a
23661 \begin_inset Quotes erd
23662 \end_inset
23663
23664 ).
23665  \SpecialChar LyX
23666  supports three packages that provide this style,
23667
23668 \begin_inset Flex Code
23669 status collapsed
23670
23671 \begin_layout Plain Layout
23672 biblatex
23673 \end_layout
23674
23675 \end_inset
23676
23677 ,
23678
23679 \begin_inset Flex Code
23680 status collapsed
23681
23682 \begin_layout Plain Layout
23683 natbib
23684 \end_layout
23685
23686 \end_inset
23687
23688 ,
23689  and
23690 \begin_inset Flex Code
23691 status collapsed
23692
23693 \begin_layout Plain Layout
23694 jurabib
23695 \end_layout
23696
23697 \end_inset
23698
23699 .
23700  Each of these packages has their pros and cons,
23701  which cannot be listed in detail.
23702  If you only want to have simple author-year (or author-numerical) style,
23703  or if you want to use one of the countless style files for
23704 \begin_inset Flex Code
23705 status collapsed
23706
23707 \begin_layout Plain Layout
23708 natbib
23709 \end_layout
23710
23711 \end_inset
23712
23713 ,
23714  then the established
23715 \begin_inset Flex Code
23716 status collapsed
23717
23718 \begin_layout Plain Layout
23719 natbib
23720 \end_layout
23721
23722 \end_inset
23723
23724  package is probably your choice.
23725  If you look for specific citation styles common in law studies,
23726  you might consider the
23727 \begin_inset Flex Code
23728 status collapsed
23729
23730 \begin_layout Plain Layout
23731 jurabib
23732 \end_layout
23733
23734 \end_inset
23735
23736  package.
23737  If you want to have full control over the formatting or look for advanced features such as ibidem,
23738  footnote citations,
23739  full title citations,
23740  advanced date formats (such as 400 BC) or full localization to other languages than English,
23741  you should definitely consider
23742 \begin_inset Flex Code
23743 status collapsed
23744
23745 \begin_layout Plain Layout
23746 biblatex
23747 \end_layout
23748
23749 \end_inset
23750
23751 ,
23752  which exceeds all other packages in terms of features,
23753  but is also quite heavy and more resource-hungry.
23754 \end_layout
23755
23756 \begin_layout Standard
23757 The handling of these packages in \SpecialChar LyX
23758  is basically the same.
23759  Go to
23760 \begin_inset Flex Noun
23761 status collapsed
23762
23763 \begin_layout Plain Layout
23764 Document\SpecialChar menuseparator
23765 Settings
23766 \end_layout
23767
23768 \end_inset
23769
23770  and select under
23771 \begin_inset Flex Noun
23772 status collapsed
23773
23774 \begin_layout Plain Layout
23775 Bibliography
23776 \end_layout
23777
23778 \end_inset
23779
23780  the
23781 \begin_inset Flex Noun
23782 status collapsed
23783
23784 \begin_layout Plain Layout
23785 Style Format
23786 \end_layout
23787
23788 \end_inset
23789
23790
23791 \begin_inset Flex Noun
23792 status collapsed
23793
23794 \begin_layout Plain Layout
23795 Basic (BibTeX)
23796 \end_layout
23797
23798 \end_inset
23799
23800 ,
23801
23802 \begin_inset Flex Noun
23803 status collapsed
23804
23805 \begin_layout Plain Layout
23806 Biblatex
23807 \end_layout
23808
23809 \end_inset
23810
23811 ,
23812
23813 \begin_inset Flex Noun
23814 status collapsed
23815
23816 \begin_layout Plain Layout
23817 Biblatex (Natbib mode)
23818 \end_layout
23819
23820 \end_inset
23821
23822 ,
23823
23824 \begin_inset Flex Noun
23825 status collapsed
23826
23827 \begin_layout Plain Layout
23828 Natbib (BibTeX)
23829 \end_layout
23830
23831 \end_inset
23832
23833  or
23834 \begin_inset Flex Noun
23835 status collapsed
23836
23837 \begin_layout Plain Layout
23838 Jurabib (BibTeX)
23839 \end_layout
23840
23841 \end_inset
23842
23843  (see sec.
23844 \begin_inset space ~
23845 \end_inset
23846
23847 6.5.3 in the User's Guide for more information on these choices).
23848  With all these packages,
23849  you will get some extra features in the citation dialog and you can select the style of the reference (
23850 \begin_inset Quotes eld
23851 \end_inset
23852
23853 Knuth 1984
23854 \begin_inset Quotes erd
23855 \end_inset
23856
23857 ,
23858
23859 \begin_inset Quotes eld
23860 \end_inset
23861
23862 Knuth (1984)
23863 \begin_inset Quotes erd
23864 \end_inset
23865
23866 ,
23867
23868 \begin_inset Quotes eld
23869 \end_inset
23870
23871 Knuth,
23872  1984
23873 \begin_inset Quotes erd
23874 \end_inset
23875
23876 ,
23877
23878 \begin_inset Quotes eld
23879 \end_inset
23880
23881 1984
23882 \begin_inset Quotes erd
23883 \end_inset
23884
23885  etc.).
23886  Note that either package needs specifically designed style files.
23887  They all ship their own,
23888  but there are lots of additional style files,
23889  and there is even an interactive style file builder
23890 \begin_inset Foot
23891 status collapsed
23892
23893 \begin_layout Plain Layout
23894 See
23895 \begin_inset Flex URL
23896 status open
23897
23898 \begin_layout Plain Layout
23899
23900 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
23901 \end_layout
23902
23903 \end_inset
23904
23905
23906 \end_layout
23907
23908 \end_inset
23909
23910  for
23911 \begin_inset Flex Code
23912 status collapsed
23913
23914 \begin_layout Plain Layout
23915 natbib
23916 \end_layout
23917
23918 \end_inset
23919
23920 .
23921 \end_layout
23922
23923 \begin_layout Section
23924 Subdivided Bibliographies
23925 \end_layout
23926
23927 \begin_layout Standard
23928 Sometimes you might need to divide your bibliography into several sections.
23929  If you are for instance a historian,
23930  the possibility to separate sources and scientific works is most likely a
23931 \begin_inset Quotes eld
23932 \end_inset
23933
23934 must have
23935 \begin_inset Quotes erd
23936 \end_inset
23937
23938 .
23939  Unfortunately,
23940  Bib\SpecialChar TeX
23941  itself does not allow you to do this.
23942  But with the help of some \SpecialChar LaTeX
23943  packages,
23944  Bib\SpecialChar TeX
23945  can be extended to fit your needs.
23946 \end_layout
23947
23948 \begin_layout Standard
23949 \SpecialChar LyX
23950  provides native support for one of these packages,
23951
23952 \family typewriter
23953 bibtopic
23954 \family default
23955 .
23956 \begin_inset Foot
23957 status collapsed
23958
23959 \begin_layout Plain Layout
23960 Available from
23961 \begin_inset Flex URL
23962 status open
23963
23964 \begin_layout Plain Layout
23965
23966 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
23967 \end_layout
23968
23969 \end_inset
23970
23971
23972 \end_layout
23973
23974 \end_inset
23975
23976  The advantage of this package (compared to other packages such as
23977 \family typewriter
23978 multibib
23979 \family default
23980 ) is that you don't need to define new citation commands.
23981  Instead,
23982  you need to prepare different bibliographic databases which include the entries for the different sections of the bibliography.
23983  For example:
23984  If you want to divide your bibliography into the sections
23985 \begin_inset Quotes eld
23986 \end_inset
23987
23988 Sources
23989 \begin_inset Quotes erd
23990 \end_inset
23991
23992  and
23993 \begin_inset Quotes eld
23994 \end_inset
23995
23996 Scientific works
23997 \begin_inset Quotes erd
23998 \end_inset
23999
24000 ,
24001  you first need to create two bibliographic databases,
24002  e.
24003 \begin_inset space \thinspace{}
24004 \end_inset
24005
24006 g.
24007 \begin_inset space \space{}
24008 \end_inset
24009
24010
24011 \begin_inset Flex Code
24012 status collapsed
24013
24014 \begin_layout Plain Layout
24015 sources.bib
24016 \end_layout
24017
24018 \end_inset
24019
24020  and
24021 \begin_inset Flex Code
24022 status collapsed
24023
24024 \begin_layout Plain Layout
24025 scientific.bib
24026 \end_layout
24027
24028 \end_inset
24029
24030 .
24031
24032 \end_layout
24033
24034 \begin_layout Standard
24035 Go to
24036 \begin_inset Flex Noun
24037 status collapsed
24038
24039 \begin_layout Plain Layout
24040 Document\SpecialChar menuseparator
24041 Settings
24042 \end_layout
24043
24044 \end_inset
24045
24046  and check under
24047 \begin_inset Flex Noun
24048 status collapsed
24049
24050 \begin_layout Plain Layout
24051 Bibliography
24052 \end_layout
24053
24054 \end_inset
24055
24056  the option
24057 \begin_inset Flex Noun
24058 status collapsed
24059
24060 \begin_layout Plain Layout
24061 Subdivided bibliography
24062 \end_layout
24063
24064 \end_inset
24065
24066 .
24067  Now you can insert multiple Bib\SpecialChar TeX
24068  bibliographies,
24069  one for each section of your bibliography.
24070  Returning to our example:
24071  Insert the Bib\SpecialChar TeX
24072  bibliography
24073 \begin_inset Flex Code
24074 status collapsed
24075
24076 \begin_layout Plain Layout
24077 sources.bib
24078 \end_layout
24079
24080 \end_inset
24081
24082  and a second one for the database
24083 \begin_inset Flex Code
24084 status collapsed
24085
24086 \begin_layout Plain Layout
24087 scientific.bib
24088 \end_layout
24089
24090 \end_inset
24091
24092 .
24093  You are free to use the same or different styles for each section.
24094  Additionally,
24095  you can choose if the bibliography section should contain
24096 \begin_inset Quotes eld
24097 \end_inset
24098
24099 all cited references
24100 \begin_inset Quotes erd
24101 \end_inset
24102
24103  of the specified database(s) (which is the default),
24104
24105 \begin_inset Quotes eld
24106 \end_inset
24107
24108 all uncited references
24109 \begin_inset Quotes erd
24110 \end_inset
24111
24112  or even
24113 \begin_inset Quotes eld
24114 \end_inset
24115
24116 all references
24117 \begin_inset Quotes erd
24118 \end_inset
24119
24120 .
24121  This might be useful if you would like to separate your bibliography into three sections:
24122
24123 \begin_inset Quotes eld
24124 \end_inset
24125
24126 Cited sources
24127 \begin_inset Quotes erd
24128 \end_inset
24129
24130 ,
24131
24132 \begin_inset Quotes eld
24133 \end_inset
24134
24135 Uncited sources
24136 \begin_inset Quotes erd
24137 \end_inset
24138
24139 ,
24140  and
24141 \begin_inset Quotes eld
24142 \end_inset
24143
24144 Scientific works
24145 \begin_inset Quotes erd
24146 \end_inset
24147
24148 .
24149  The titles for the sections can be added as ordinary sections or subsections.
24150  Since
24151 \begin_inset Flex Code
24152 status collapsed
24153
24154 \begin_layout Plain Layout
24155 bibtopic
24156 \end_layout
24157
24158 \end_inset
24159
24160  removes the bibliography title,
24161  you have to manually re-add that,
24162  too (as a chapter* or section*,
24163  for instance).
24164 \end_layout
24165
24166 \begin_layout Standard
24167 With
24168 \family sans
24169 Biblatex
24170 \family default
24171 ,
24172  the procedure is a bit different.
24173  Since
24174 \family typewriter
24175 bibtopic
24176 \family default
24177  does not work with
24178 \family sans
24179 Biblatex
24180 \family default
24181 ,
24182  the aforementioned
24183 \begin_inset Flex Noun
24184 status collapsed
24185
24186 \begin_layout Plain Layout
24187 Subdivided bibliography
24188 \end_layout
24189
24190 \end_inset
24191
24192  option is disabled if you use
24193 \family sans
24194 Biblatex
24195 \family default
24196 .
24197  However,
24198
24199 \family sans
24200 Biblatex
24201 \family default
24202  provides its own means to generate subdivided bibliographies.
24203  You can either add keywords to bibliography entries via the
24204 \begin_inset Flex Code
24205 status collapsed
24206
24207 \begin_layout Plain Layout
24208 keywords
24209 \end_layout
24210
24211 \end_inset
24212
24213  entry option and then filter bibliography sections by keyword (by adding
24214 \begin_inset Flex Code
24215 status collapsed
24216
24217 \begin_layout Plain Layout
24218 keyword=mykeyword
24219 \end_layout
24220
24221 \end_inset
24222
24223  to the
24224 \begin_inset Flex Noun
24225 status collapsed
24226
24227 \begin_layout Plain Layout
24228 Options
24229 \end_layout
24230
24231 \end_inset
24232
24233  field of the dialog that opens if you left-click on the
24234 \begin_inset Flex Noun
24235 status collapsed
24236
24237 \begin_layout Plain Layout
24238 Biblatex Generated Bibliography
24239 \end_layout
24240
24241 \end_inset
24242
24243  button),
24244  or you can filter by entry types (such as
24245 \emph on
24246 book
24247 \emph default
24248  or
24249 \emph on
24250 article
24251 \emph default
24252 ) by entering e.
24253 \begin_inset space \thinspace{}
24254 \end_inset
24255
24256 g.
24257
24258 \begin_inset Flex Code
24259 status collapsed
24260
24261 \begin_layout Plain Layout
24262 type=book
24263 \end_layout
24264
24265 \end_inset
24266
24267  or
24268 \begin_inset Flex Code
24269 status collapsed
24270
24271 \begin_layout Plain Layout
24272 nottype=collection
24273 \end_layout
24274
24275 \end_inset
24276
24277  to the mentioned
24278 \begin_inset Flex Noun
24279 status collapsed
24280
24281 \begin_layout Plain Layout
24282 Options
24283 \end_layout
24284
24285 \end_inset
24286
24287  field,
24288  or you can create so-called
24289 \begin_inset Quotes eld
24290 \end_inset
24291
24292 Bibliography Categories
24293 \begin_inset Quotes erd
24294 \end_inset
24295
24296  to which you can assign individual entries.
24297  Please refer to the Biblatex manual,
24298  section
24299 \emph on
24300 Subdivided Bibliographies
24301 \emph default
24302 ,
24303  for details.
24304 \end_layout
24305
24306 \begin_layout Section
24307 Multiple Bibliographies
24308 \begin_inset CommandInset label
24309 LatexCommand label
24310 name "subsec:Multiple-Bibliographies"
24311
24312 \end_inset
24313
24314
24315 \end_layout
24316
24317 \begin_layout Standard
24318 Multiple bibliographies,
24319  e.
24320 \begin_inset space \thinspace{}
24321 \end_inset
24322
24323 g.
24324 \begin_inset space \space{}
24325 \end_inset
24326
24327 a bibliography for each part,
24328  chapter,
24329  section,
24330  subsection or child (sub-document) of the document,
24331  are also supported by \SpecialChar LyX
24332 .
24333  In order to enable it,
24334  go to
24335 \begin_inset Flex Noun
24336 status collapsed
24337
24338 \begin_layout Plain Layout
24339 Document\SpecialChar menuseparator
24340 Settings\SpecialChar menuseparator
24341 Bibliography
24342 \end_layout
24343
24344 \end_inset
24345
24346  and select the relevant unit (e.
24347 \begin_inset space \thinspace{}
24348 \end_inset
24349
24350 g.,
24351
24352 \begin_inset Quotes eld
24353 \end_inset
24354
24355 per section
24356 \begin_inset Quotes erd
24357 \end_inset
24358
24359 ) in the
24360 \begin_inset Flex Noun
24361 status collapsed
24362
24363 \begin_layout Plain Layout
24364 Multiple Bibliographies
24365 \end_layout
24366
24367 \end_inset
24368
24369  combo box.
24370  Then add a Bib(la)\SpecialChar TeX
24371  bibliography to each unit (e.
24372 \begin_inset space \thinspace{}
24373 \end_inset
24374
24375 g.,
24376  section) of your document.
24377  In the output,
24378  a separate bibliography,
24379  containing only the references done in the current unit is generated.
24380 \end_layout
24381
24382 \begin_layout Standard
24383 If you use Bib\SpecialChar TeX
24384 ,
24385  either the
24386 \begin_inset Flex Code
24387 status collapsed
24388
24389 \begin_layout Plain Layout
24390 chapterbib
24391 \end_layout
24392
24393 \end_inset
24394
24395  or the
24396 \begin_inset Flex Code
24397 status collapsed
24398
24399 \begin_layout Plain Layout
24400 bibtopic
24401 \end_layout
24402
24403 \end_inset
24404
24405  package is used to create multiple bibliographies.
24406  The former package is used if you select
24407 \begin_inset Quotes eld
24408 \end_inset
24409
24410 per child document
24411 \begin_inset Quotes erd
24412 \end_inset
24413
24414  and do
24415 \emph on
24416 not
24417 \emph default
24418  check
24419 \begin_inset Flex Noun
24420 status collapsed
24421
24422 \begin_layout Plain Layout
24423 Sectioned Bibliography
24424 \end_layout
24425
24426 \end_inset
24427
24428 .
24429  In all other cases,
24430
24431 \begin_inset Flex Code
24432 status collapsed
24433
24434 \begin_layout Plain Layout
24435 bibtopic
24436 \end_layout
24437
24438 \end_inset
24439
24440  is used.
24441 \begin_inset Foot
24442 status collapsed
24443
24444 \begin_layout Plain Layout
24445 An alternative approach,
24446  if you are willing to use some
24447 \begin_inset Flex Noun
24448 status collapsed
24449
24450 \begin_layout Plain Layout
24451 \SpecialChar TeX
24452  Code
24453 \end_layout
24454
24455 \end_inset
24456
24457  (see section
24458 \begin_inset space ~
24459 \end_inset
24460
24461
24462 \begin_inset CommandInset ref
24463 LatexCommand ref
24464 reference "sec:Inserting-TeX-Code"
24465 nolink "false"
24466
24467 \end_inset
24468
24469 ),
24470  is to use the
24471 \begin_inset Flex Code
24472 status collapsed
24473
24474 \begin_layout Plain Layout
24475 bibunits
24476 \end_layout
24477
24478 \end_inset
24479
24480  package.
24481 \end_layout
24482
24483 \end_inset
24484
24485  If
24486 \begin_inset Flex Code
24487 status collapsed
24488
24489 \begin_layout Plain Layout
24490 bibtopic
24491 \end_layout
24492
24493 \end_inset
24494
24495  is used,
24496  \SpecialChar LyX
24497  encloses the specified units in
24498 \begin_inset Flex Code
24499 status collapsed
24500
24501 \begin_layout Plain Layout
24502 bibtopic
24503 \end_layout
24504
24505 \end_inset
24506
24507 's
24508 \begin_inset Flex Code
24509 status collapsed
24510
24511 \begin_layout Plain Layout
24512
24513 \backslash
24514 begin{btUnit}
24515 \end_layout
24516
24517 \end_inset
24518
24519  and
24520 \begin_inset Flex Code
24521 status collapsed
24522
24523 \begin_layout Plain Layout
24524
24525 \backslash
24526 end{btUnit}
24527 \end_layout
24528
24529 \end_inset
24530
24531  in order to create the units.
24532  Note that this approach has some limitations.
24533  First,
24534  every citation reference has to be inside some
24535 \begin_inset Flex Code
24536 status collapsed
24537
24538 \begin_layout Plain Layout
24539 btUnit
24540 \end_layout
24541
24542 \end_inset
24543
24544 .
24545  So citations outside a defined unit (e.
24546 \begin_inset space \thinspace{}
24547 \end_inset
24548
24549 g.,
24550  before the first section if you use
24551 \begin_inset Quotes eld
24552 \end_inset
24553
24554 by section
24555 \begin_inset Quotes erd
24556 \end_inset
24557
24558 ) will appear as
24559 \begin_inset Quotes eld
24560 \end_inset
24561
24562 ???
24563 \begin_inset Quotes erd
24564 \end_inset
24565
24566 .
24567  You can also create your own units by entering
24568 \begin_inset Flex Code
24569 status collapsed
24570
24571 \begin_layout Plain Layout
24572
24573 \backslash
24574 begin{btUnit}
24575 \end_layout
24576
24577 \end_inset
24578
24579  and
24580 \begin_inset Flex Code
24581 status collapsed
24582
24583 \begin_layout Plain Layout
24584
24585 \backslash
24586 end{btUnit}
24587 \end_layout
24588
24589 \end_inset
24590
24591  as \SpecialChar TeX
24592  code (for instance to work around the mentioned limitation).
24593  Note,
24594  though,
24595  that
24596 \begin_inset Flex Code
24597 status collapsed
24598
24599 \begin_layout Plain Layout
24600 btUnit
24601 \end_layout
24602
24603 \end_inset
24604
24605 s cannot be nested.
24606  A second limitation is that
24607 \begin_inset Flex Code
24608 status collapsed
24609
24610 \begin_layout Plain Layout
24611 bibtopic
24612 \end_layout
24613
24614 \end_inset
24615
24616  always processes all references of a bibliography database,
24617  even if they are not cited.
24618  This can result in odd labels (e.
24619 \begin_inset space \thinspace{}
24620 \end_inset
24621
24622 g.
24623
24624 \begin_inset Quotes eld
24625 \end_inset
24626
24627 Miller 2014b
24628 \begin_inset Quotes erd
24629 \end_inset
24630
24631  if two works of this author from 2014 are in the database,
24632  even if only one is cited).
24633 \end_layout
24634
24635 \begin_layout Standard
24636 If you use
24637 \family sans
24638 Biblatex
24639 \family default
24640 ,
24641  the
24642 \begin_inset Flex Code
24643 status collapsed
24644
24645 \begin_layout Plain Layout
24646 refsection
24647 \end_layout
24648
24649 \end_inset
24650
24651  option is used instead.
24652  If you need specific units,
24653  you can start them with the \SpecialChar TeX
24654  code
24655 \begin_inset Flex Code
24656 status collapsed
24657
24658 \begin_layout Plain Layout
24659
24660 \backslash
24661 newrefsection
24662 \end_layout
24663
24664 \end_inset
24665
24666  or
24667 \begin_inset Flex Code
24668 status collapsed
24669
24670 \begin_layout Plain Layout
24671
24672 \backslash
24673 newrefsegment
24674 \end_layout
24675
24676 \end_inset
24677
24678 ,
24679  respectively.
24680  If you also want to control the end of the unit,
24681  use the environment
24682 \begin_inset Flex Code
24683 status collapsed
24684
24685 \begin_layout Plain Layout
24686
24687 \backslash
24688 begin{refsection}
24689 \end_layout
24690
24691 \end_inset
24692
24693  \SpecialChar ldots
24694
24695 \begin_inset Flex Code
24696 status collapsed
24697
24698 \begin_layout Plain Layout
24699
24700 \backslash
24701 end{refsection}
24702 \end_layout
24703
24704 \end_inset
24705
24706  instead.
24707  Note,
24708  though,
24709  that
24710 \begin_inset Flex Code
24711 status collapsed
24712
24713 \begin_layout Plain Layout
24714 refsection
24715 \end_layout
24716
24717 \end_inset
24718
24719 s cannot be nested.
24720  In addition to the individual bibliography of the current unit,
24721
24722 \family sans
24723 Biblatex
24724 \family default
24725  also provides an easy way to output all bibliographies,
24726  subsequently,
24727  at one place (e.
24728 \begin_inset space \thinspace{}
24729 \end_inset
24730
24731 g.,
24732  at the end of the document).
24733  Select
24734 \begin_inset Quotes eld
24735 \end_inset
24736
24737 all reference units
24738 \begin_inset Quotes erd
24739 \end_inset
24740
24741  from the Content combo box of the Bib(la)TeX inset dialog in order to achieve this.
24742  Please refer to the
24743 \family sans
24744 Biblatex
24745 \family default
24746  manual for more information on this topic.
24747 \end_layout
24748
24749 \begin_layout Chapter
24750
24751 \change_deleted 564990737 1671355654
24752 Itemize
24753 \change_unchanged
24754 Bullet
24755 \change_inserted 564990737 1671355667
24756 s
24757 \change_deleted 564990737 1671355661
24758  Selection
24759 \change_inserted 564990737 1671355684
24760
24761 \begin_inset CommandInset label
24762 LatexCommand label
24763 name "chap:bullets"
24764
24765 \end_inset
24766
24767
24768 \change_deleted 564990737 1671355684
24769
24770 \begin_inset CommandInset label
24771 LatexCommand label
24772 name "sec:bullet"
24773
24774 \end_inset
24775
24776
24777 \change_unchanged
24778
24779 \end_layout
24780
24781 \begin_layout Standard
24782 by
24783 \noun on
24784  Allan Rae
24785 \end_layout
24786
24787 \begin_layout Section
24788 Introduction
24789 \end_layout
24790
24791 \begin_layout Standard
24792 \SpecialChar LyX
24793  provides 216 bullet shapes that can be accessed from a simple dialog.
24794  Using this dialog you can easily specify what bullet shape to use at each level of an itemized list.
24795  These settings are document-wide so you won't be able to specify different sets of bullets for different paragraphs.
24796 \begin_inset Foot
24797 status collapsed
24798
24799 \begin_layout Plain Layout
24800 Well,
24801  actually you can but you'll have to do it by hand.
24802 \end_layout
24803
24804 \end_inset
24805
24806
24807 \end_layout
24808
24809 \begin_layout Section
24810 How it looks
24811 \end_layout
24812
24813 \begin_layout Standard
24814 Open the dialog by selecting the
24815 \begin_inset Flex Noun
24816 status collapsed
24817
24818 \begin_layout Plain Layout
24819 Document\SpecialChar menuseparator
24820 Settings
24821 \end_layout
24822
24823 \end_inset
24824
24825  menu item and then select the
24826 \begin_inset Flex Noun
24827 status collapsed
24828
24829 \begin_layout Plain Layout
24830 Bullets
24831 \end_layout
24832
24833 \end_inset
24834
24835  tab.
24836 \end_layout
24837
24838 \begin_layout Standard
24839 The dialog provides you with a table of bullet shapes.
24840  A column of buttons on the left of the table provides access to the six different panels of bullet shapes.
24841  The row of buttons across the top is used to select which bullet depth you are changing.
24842
24843 \change_deleted 244031559 1603875981
24844  A text entry under the table shows the currently selected bullet shape's \SpecialChar LaTeX
24845  equivalent and this can be edited if desired.
24846  If you do modify the text you will also need to specify any needed packages in the \SpecialChar LaTeX
24847  preamble.
24848 \change_unchanged
24849
24850 \end_layout
24851
24852 \begin_layout Standard
24853 The six panels are divided up by the packages they require.
24854  The following table shows the mappings from button name to \SpecialChar LaTeX
24855  package.
24856 \end_layout
24857
24858 \begin_layout Standard
24859 \align center
24860 \begin_inset Tabular
24861 <lyxtabular version="3" rows="7" columns="2">
24862 <features tabularvalignment="middle">
24863 <column alignment="center" valignment="top" width="0pt">
24864 <column alignment="center" valignment="top" width="0pt">
24865 <row>
24866 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
24867 \begin_inset Text
24868
24869 \begin_layout Plain Layout
24870
24871 \family roman
24872 \series medium
24873 \shape up
24874 \size normal
24875 \emph off
24876 \bar no
24877 \noun off
24878 \color none
24879 Button
24880 \end_layout
24881
24882 \end_inset
24883 </cell>
24884 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
24885 \begin_inset Text
24886
24887 \begin_layout Plain Layout
24888
24889 \family roman
24890 \series medium
24891 \shape up
24892 \size normal
24893 \emph off
24894 \bar no
24895 \noun off
24896 \color none
24897 Packages Required
24898 \end_layout
24899
24900 \end_inset
24901 </cell>
24902 </row>
24903 <row>
24904 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
24905 \begin_inset Text
24906
24907 \begin_layout Plain Layout
24908
24909 \family sans
24910 \series medium
24911 \shape up
24912 \size normal
24913 \emph off
24914 \bar no
24915 \noun off
24916 \color none
24917 Standard
24918 \end_layout
24919
24920 \end_inset
24921 </cell>
24922 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
24923 \begin_inset Text
24924
24925 \begin_layout Plain Layout
24926
24927 \series medium
24928 \shape up
24929 \size normal
24930 \emph off
24931 \bar no
24932 \noun off
24933 \color none
24934 base \SpecialChar LaTeX
24935
24936 \end_layout
24937
24938 \end_inset
24939 </cell>
24940 </row>
24941 <row>
24942 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
24943 \begin_inset Text
24944
24945 \begin_layout Plain Layout
24946
24947 \family sans
24948 \series medium
24949 \shape up
24950 \size normal
24951 \emph off
24952 \bar no
24953 \noun off
24954 \color none
24955 Maths
24956 \end_layout
24957
24958 \end_inset
24959 </cell>
24960 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
24961 \begin_inset Text
24962
24963 \begin_layout Plain Layout
24964
24965 \family typewriter
24966 \series medium
24967 \shape up
24968 \size normal
24969 \emph off
24970 \bar no
24971 \noun off
24972 \color none
24973 amssymb.sty
24974 \end_layout
24975
24976 \end_inset
24977 </cell>
24978 </row>
24979 <row>
24980 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
24981 \begin_inset Text
24982
24983 \begin_layout Plain Layout
24984
24985 \family sans
24986 \series medium
24987 \shape up
24988 \size normal
24989 \emph off
24990 \bar no
24991 \noun off
24992 \color none
24993 Ding1
24994 \end_layout
24995
24996 \end_inset
24997 </cell>
24998 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
24999 \begin_inset Text
25000
25001 \begin_layout Plain Layout
25002
25003 \family typewriter
25004 \series medium
25005 \shape up
25006 \size normal
25007 \emph off
25008 \bar no
25009 \noun off
25010 \color none
25011 pifont.sty
25012 \end_layout
25013
25014 \end_inset
25015 </cell>
25016 </row>
25017 <row>
25018 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25019 \begin_inset Text
25020
25021 \begin_layout Plain Layout
25022
25023 \family sans
25024 \series medium
25025 \shape up
25026 \size normal
25027 \emph off
25028 \bar no
25029 \noun off
25030 \color none
25031 Ding2
25032 \end_layout
25033
25034 \end_inset
25035 </cell>
25036 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25037 \begin_inset Text
25038
25039 \begin_layout Plain Layout
25040
25041 \family typewriter
25042 \series medium
25043 \shape up
25044 \size normal
25045 \emph off
25046 \bar no
25047 \noun off
25048 \color none
25049 pifont.sty
25050 \end_layout
25051
25052 \end_inset
25053 </cell>
25054 </row>
25055 <row>
25056 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25057 \begin_inset Text
25058
25059 \begin_layout Plain Layout
25060
25061 \family sans
25062 \series medium
25063 \shape up
25064 \size normal
25065 \emph off
25066 \bar no
25067 \noun off
25068 \color none
25069 Ding3
25070 \end_layout
25071
25072 \end_inset
25073 </cell>
25074 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25075 \begin_inset Text
25076
25077 \begin_layout Plain Layout
25078
25079 \family typewriter
25080 \series medium
25081 \shape up
25082 \size normal
25083 \emph off
25084 \bar no
25085 \noun off
25086 \color none
25087 pifont.sty
25088 \end_layout
25089
25090 \end_inset
25091 </cell>
25092 </row>
25093 <row>
25094 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25095 \begin_inset Text
25096
25097 \begin_layout Plain Layout
25098
25099 \family sans
25100 \series medium
25101 \shape up
25102 \size normal
25103 \emph off
25104 \bar no
25105 \noun off
25106 \color none
25107 Ding4
25108 \end_layout
25109
25110 \end_inset
25111 </cell>
25112 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25113 \begin_inset Text
25114
25115 \begin_layout Plain Layout
25116
25117 \family typewriter
25118 \series medium
25119 \shape up
25120 \size normal
25121 \emph off
25122 \bar no
25123 \noun off
25124 \color none
25125 pifont.sty
25126 \end_layout
25127
25128 \end_inset
25129 </cell>
25130 </row>
25131 </lyxtabular>
25132
25133 \end_inset
25134
25135
25136 \end_layout
25137
25138 \begin_layout Standard
25139 \SpecialChar LyX
25140  doesn't stop you using bullets from packages you don't have.
25141  If you get errors from \SpecialChar LaTeX
25142  when you try to view or print the file,
25143  then it is likely you are missing a package.
25144 \begin_inset Foot
25145 status collapsed
25146
25147 \begin_layout Plain Layout
25148 \SpecialChar LyX
25149  doesn't restrict your use since you may be editing locally and exporting elsewhere.
25150 \end_layout
25151
25152 \end_inset
25153
25154
25155 \end_layout
25156
25157 \begin_layout Section
25158 How to use it
25159 \end_layout
25160
25161 \begin_layout Standard
25162 Select which bullet depth you want to change then select the bullet shape and size.
25163  Any changes will not be visible in \SpecialChar LyX
25164 ,
25165  but are visible when viewing the document.
25166 \end_layout
25167
25168 \begin_layout Standard
25169 You can reset a bullet shape to the default simply by clicking your right mouse button on the appropriate bullet depth button.
25170 \begin_inset Foot
25171 status open
25172
25173 \begin_layout Plain Layout
25174
25175 \change_inserted 564990737 1672138075
25176 \begin_inset CommandInset label
25177 LatexCommand label
25178 name "fn:If-you-really"
25179
25180 \end_inset
25181
25182
25183 \change_unchanged
25184 If you
25185 \emph on
25186 really
25187 \emph default
25188  want to have multiple sets of paragraphs with different sets of bullets in each,
25189  then you're going to have to get your hands dirty with \SpecialChar TeX
25190  code.
25191  The bullet selection dialog can help though because it provides you with the \SpecialChar LaTeX
25192  code for a wide range of bullet shapes.
25193  To make your own custom paragraphs you have the following options:
25194 \end_layout
25195
25196 \begin_layout Plain Layout
25197 \begin_inset ERT
25198 status open
25199
25200 \begin_layout Plain Layout
25201
25202
25203 \backslash
25204 let
25205 \backslash
25206 savelabelitemi=
25207 \backslash
25208 labelitemi
25209 \end_layout
25210
25211 \end_inset
25212
25213
25214 \end_layout
25215
25216 \begin_layout Plain Layout
25217 \begin_inset ERT
25218 status open
25219
25220 \begin_layout Plain Layout
25221
25222
25223 \backslash
25224 renewcommand
25225 \backslash
25226 labelitemi[0]{
25227 \backslash
25228 small
25229 \backslash
25230 (
25231 \backslash
25232 sharp
25233 \backslash
25234 )}
25235 \end_layout
25236
25237 \end_inset
25238
25239
25240 \end_layout
25241
25242 \begin_layout Itemize
25243 Use the \SpecialChar LaTeX
25244  command
25245 \begin_inset Flex Code
25246 status collapsed
25247
25248 \begin_layout Plain Layout
25249
25250 \backslash
25251 renewcommand{}{}
25252 \end_layout
25253
25254 \end_inset
25255
25256  to specify a new bullet shape for a given depth.
25257  You'll also need to save the current bullet shape so you can restore it again afterwards.
25258  In this itemized list the following \SpecialChar LaTeX
25259  code was used to change the bullet used for the first depth.
25260 \end_layout
25261
25262 \begin_deeper
25263 \begin_layout LyX-Code
25264
25265 \backslash
25266 let
25267 \backslash
25268 savelabelitemi=
25269 \backslash
25270 labelitemi
25271 \end_layout
25272
25273 \begin_layout LyX-Code
25274
25275 \backslash
25276 renewcommand
25277 \backslash
25278 labelitemi[0]{
25279 \backslash
25280 small
25281 \backslash
25282 (
25283 \backslash
25284 sharp
25285 \backslash
25286 )}
25287 \end_layout
25288
25289 \end_deeper
25290 \begin_layout Itemize
25291 Note that the itemize depth is specified in Roman numerals as part of the
25292 \family typewriter
25293
25294 \backslash
25295 labelitem
25296 \family default
25297  command.
25298 \end_layout
25299
25300 \begin_layout Itemize
25301 \begin_inset Argument item:1
25302 status open
25303
25304 \begin_layout Plain Layout
25305 \begin_inset ERT
25306 status open
25307
25308 \begin_layout Plain Layout
25309
25310
25311 \backslash
25312 (
25313 \backslash
25314 star
25315 \backslash
25316 )
25317 \end_layout
25318
25319 \end_inset
25320
25321
25322 \end_layout
25323
25324 \end_inset
25325
25326  Specify each individual entry by starting each item with the bullet shape enclosed in a
25327 \begin_inset Quotes eld
25328 \end_inset
25329
25330 Custom Item
25331 \begin_inset Quotes erd
25332 \end_inset
25333
25334  inset (available at
25335 \family sans
25336 Insert\SpecialChar menuseparator
25337 Custom Item
25338 \family default
25339 ) and set as
25340 \begin_inset Flex Noun
25341 status collapsed
25342
25343 \begin_layout Plain Layout
25344 \SpecialChar TeX
25345  Code
25346 \end_layout
25347
25348 \end_inset
25349
25350 .
25351  For example,
25352  this item was started with
25353 \begin_inset Flex Code
25354 status collapsed
25355
25356 \begin_layout Plain Layout
25357
25358 \backslash
25359 (
25360 \backslash
25361 star
25362 \backslash
25363 )
25364 \end_layout
25365
25366 \end_inset
25367
25368 .
25369 \end_layout
25370
25371 \begin_layout Plain Layout
25372 \begin_inset ERT
25373 status open
25374
25375 \begin_layout Plain Layout
25376
25377
25378 \backslash
25379 renewcommand
25380 \backslash
25381 labelitemi[0]{
25382 \backslash
25383 savelabelitemi}
25384 \end_layout
25385
25386 \end_inset
25387
25388
25389 \end_layout
25390
25391 \begin_layout Plain Layout
25392 You'll also need to revert the labelitem back to its previous setting for the global bullet shape settings to remain in effect.
25393  The way used here was:
25394 \end_layout
25395
25396 \begin_layout LyX-Code
25397
25398 \backslash
25399 renewcommand
25400 \backslash
25401 labelitemi[0]{
25402 \backslash
25403 savelabelitemi}
25404 \end_layout
25405
25406 \end_inset
25407
25408
25409 \end_layout
25410
25411 \begin_layout Chapter
25412 Supplemental Tools
25413 \end_layout
25414
25415 \begin_layout Section
25416 Multipart Documents
25417 \end_layout
25418
25419 \begin_layout Subsection
25420 General Operation
25421 \end_layout
25422
25423 \begin_layout Standard
25424 When you are working on a large file with many sections,
25425  it is often convenient to break up the document into several files,
25426  or perhaps you have something where a table may change from time to time,
25427  but the preceding text does not.
25428  In these cases,
25429  you should seriously consider using multipart documents.
25430  For example,
25431  scientific papers often have five major sections:
25432  the introduction,
25433  observations,
25434  results,
25435  discussion,
25436  and conclusion.
25437  Each of these could be its own separate \SpecialChar LyX
25438  file,
25439  with one
25440 \begin_inset Quotes eld
25441 \end_inset
25442
25443 master
25444 \begin_inset Quotes erd
25445 \end_inset
25446
25447  file which contains the title,
25448  authors,
25449  abstract,
25450  references,
25451  etc.,
25452  plus the five included files.
25453  It is important to note that each of these files is a full \SpecialChar LyX
25454  file which can be formatted and printed on its own,
25455  as well as included in a master file.
25456  Each of these files must have the same document class,
25457  however—
25458 don't attempt to mix book classes with article classes.
25459  You may also include \SpecialChar LaTeX
25460  files;
25461  however,
25462  these files must not have their own preamble (i.
25463 \begin_inset space \thinspace{}
25464 \end_inset
25465
25466 e.
25467 \begin_inset space \space{}
25468 \end_inset
25469
25470 everything up to and including the
25471 \begin_inset Flex Code
25472 status collapsed
25473
25474 \begin_layout Plain Layout
25475
25476 \backslash
25477 begin{document}
25478 \end_layout
25479
25480 \end_inset
25481
25482  line as well as the
25483 \begin_inset Flex Code
25484 status collapsed
25485
25486 \begin_layout Plain Layout
25487
25488 \backslash
25489 end{document}
25490 \end_layout
25491
25492 \end_inset
25493
25494  line must be deleted) or else errors will be generated when you try to make a DVI file.
25495 \end_layout
25496
25497 \begin_layout Standard
25498 \SpecialChar LyX
25499  allows you to include files quite easily with
25500 \begin_inset Flex Noun
25501 status collapsed
25502
25503 \begin_layout Plain Layout
25504 Insert\SpecialChar menuseparator
25505 Child
25506 \begin_inset space ~
25507 \end_inset
25508
25509 Document
25510 \end_layout
25511
25512 \end_inset
25513
25514 .
25515  When you click on this selection a small box is inserted into the file at the current cursor location.
25516  Clicking on the box raises a dialog which allows you to select the file to be included,
25517  and the method of its inclusion.
25518
25519 \end_layout
25520
25521 \begin_layout Standard
25522 The file selection box should by now be obvious.
25523  The three inclusion methods are
25524 \begin_inset Quotes eld
25525 \end_inset
25526
25527 include
25528 \begin_inset Quotes erd
25529 \end_inset
25530
25531 ,
25532
25533 \begin_inset Quotes eld
25534 \end_inset
25535
25536 input
25537 \begin_inset Quotes erd
25538 \end_inset
25539
25540 ,
25541  and
25542 \begin_inset Quotes eld
25543 \end_inset
25544
25545 verbatim
25546 \begin_inset Quotes erd
25547 \end_inset
25548
25549 .
25550  The methods
25551 \begin_inset Quotes eld
25552 \end_inset
25553
25554 include
25555 \begin_inset Quotes erd
25556 \end_inset
25557
25558  and
25559 \begin_inset Quotes eld
25560 \end_inset
25561
25562 input
25563 \begin_inset Quotes erd
25564 \end_inset
25565
25566  are similar in many ways,
25567  but there are also some notable differences:
25568 \end_layout
25569
25570 \begin_layout Enumerate
25571 Files that are
25572 \begin_inset Quotes eld
25573 \end_inset
25574
25575 included
25576 \begin_inset Quotes erd
25577 \end_inset
25578
25579  are typeset beginning on a new page,
25580  while files that are
25581 \begin_inset Quotes eld
25582 \end_inset
25583
25584 inputted
25585 \begin_inset Quotes erd
25586 \end_inset
25587
25588  are typeset starting on the current page.
25589 \end_layout
25590
25591 \begin_layout Enumerate
25592 \begin_inset Quotes eld
25593 \end_inset
25594
25595 Included
25596 \begin_inset Quotes erd
25597 \end_inset
25598
25599  files cannot themselves
25600 \begin_inset Quotes eld
25601 \end_inset
25602
25603 include
25604 \begin_inset Quotes erd
25605 \end_inset
25606
25607  further files (
25608 \begin_inset Quotes eld
25609 \end_inset
25610
25611 grandchilds
25612 \begin_inset Quotes erd
25613 \end_inset
25614
25615 ).
25616  With
25617 \begin_inset Quotes eld
25618 \end_inset
25619
25620 input
25621 \begin_inset Quotes erd
25622 \end_inset
25623
25624 ,
25625  on the other hand,
25626  infinite sub-inputting is possible.
25627 \end_layout
25628
25629 \begin_layout Enumerate
25630 \begin_inset Quotes eld
25631 \end_inset
25632
25633 Include
25634 \begin_inset Quotes erd
25635 \end_inset
25636
25637  allow for the output of only selected
25638 \begin_inset Quotes eld
25639 \end_inset
25640
25641 included
25642 \begin_inset Quotes erd
25643 \end_inset
25644
25645  files,
25646  while maintaining the actual counters (pagination etc.) and references (please refer to the section
25647 \emph on
25648 Child
25649 \begin_inset space ~
25650 \end_inset
25651
25652 Documents
25653 \emph default
25654  of the
25655 \emph on
25656 Embedded
25657 \begin_inset space ~
25658 \end_inset
25659
25660 Objects
25661 \emph default
25662  manual for details).
25663 \end_layout
25664
25665 \begin_layout Standard
25666 Hence,
25667
25668 \begin_inset Quotes eld
25669 \end_inset
25670
25671 include
25672 \begin_inset Quotes erd
25673 \end_inset
25674
25675  is the preferred method for chapters that are outsourced to child documents,
25676  while
25677 \begin_inset Quotes eld
25678 \end_inset
25679
25680 input
25681 \begin_inset Quotes erd
25682 \end_inset
25683
25684  is more suitable for arbitrary file inheritance.
25685 \end_layout
25686
25687 \begin_layout Standard
25688 A
25689 \begin_inset Quotes eld
25690 \end_inset
25691
25692 verbatim
25693 \begin_inset Quotes erd
25694 \end_inset
25695
25696  included file allows you to include a file typeset exactly as it appears in the file,
25697  i.
25698 \begin_inset space \thinspace{}
25699 \end_inset
25700
25701 e.
25702 \begin_inset space \space{}
25703 \end_inset
25704
25705 in
25706 \begin_inset Flex Code
25707 status collapsed
25708
25709 \begin_layout Plain Layout
25710 verbatim
25711 \end_layout
25712
25713 \end_inset
25714
25715  mode,
25716  with the characters set in a fixed-width typewriter font.
25717  Normally,
25718  spaces in this file are invisible,
25719  though two consecutive spaces are conserved,
25720  unlike \SpecialChar LyX
25721 's normal treatment of spaces.
25722  However,
25723  setting the
25724 \begin_inset Flex Noun
25725 status collapsed
25726
25727 \begin_layout Plain Layout
25728 Mark
25729 \begin_inset space ~
25730 \end_inset
25731
25732 spaces
25733 \begin_inset space ~
25734 \end_inset
25735
25736 in
25737 \begin_inset space ~
25738 \end_inset
25739
25740 output
25741 \end_layout
25742
25743 \end_inset
25744
25745  checkbox typesets a mark to unambiguously define the presence of a space.
25746
25747 \end_layout
25748
25749 \begin_layout Standard
25750 Generally,
25751  the master file is converted into a full \SpecialChar LaTeX
25752  file before typesetting,
25753  while the included files are converted to \SpecialChar LaTeX
25754  files that do not have all the preamble information.
25755 \end_layout
25756
25757 \begin_layout Subsection
25758 Cross-References Between Files
25759 \end_layout
25760
25761 \begin_layout Standard
25762 \begin_inset Box Shadowbox
25763 position "t"
25764 hor_pos "c"
25765 has_inner_box 1
25766 inner_pos "t"
25767 use_parbox 0
25768 use_makebox 0
25769 width "100col%"
25770 special "none"
25771 height "1in"
25772 height_special "totalheight"
25773 thickness "0.4pt"
25774 separation "3pt"
25775 shadowsize "4pt"
25776 framecolor "black"
25777 backgroundcolor "none"
25778 status open
25779
25780 \begin_layout Plain Layout
25781 This section is somewhat out of date.
25782  Need to describe default master documents and how children are opened when the master is.
25783  [[FIXME]]
25784 \end_layout
25785
25786 \end_inset
25787
25788
25789 \end_layout
25790
25791 \begin_layout Standard
25792 It is possible to set up cross-references between the different files.
25793  First,
25794  open all the files in question:
25795  let's call them A and B in a two file example,
25796  where B is included in A.
25797  Let's say you insert a label in A,
25798  then want to reference it in B.
25799  Open the cross-reference dialog whilst in document B,
25800  and you can select the
25801 \begin_inset Quotes eld
25802 \end_inset
25803
25804 buffer
25805 \begin_inset Quotes erd
25806 \end_inset
25807
25808  to use.
25809 \end_layout
25810
25811 \begin_layout Subsection
25812 Bibliography Lists in all Subdocuments
25813 \end_layout
25814
25815 \begin_layout Standard
25816 If you work with child documents,
25817  you might want to have only one main bibliography at the end,
25818  but still be able to have a selected bibliography for the child if you output it on its own.
25819  Here is how to achieve this.
25820 \end_layout
25821
25822 \begin_layout Standard
25823 For the main document,
25824  you just insert a bibliography inset at the place where the main bibliography has to appear (within the master file or within a child).
25825  If the bibliography inset is in the master file,
25826  the references will be inherited by all children,
25827  so they are available in the citation dialog within each child.
25828 \end_layout
25829
25830 \begin_layout Standard
25831 For child-specific bibliographies,
25832  insert bibliography insets within the child documents,
25833  at the place where the bibliography should appear when the child is compiled separately.
25834  However,
25835  the trick is to insert them into a branch (
25836 \family sans
25837 Insert\SpecialChar menuseparator
25838 Branch\SpecialChar menuseparator
25839 Insert New Branch...
25840 \family default
25841 ),
25842  e.
25843 \begin_inset space \thinspace{}
25844 \end_inset
25845
25846 g.
25847  called
25848 \begin_inset Quotes eld
25849 \end_inset
25850
25851 Childonly
25852 \begin_inset Quotes erd
25853 \end_inset
25854
25855 .
25856  Within the children,
25857  activate the branch (
25858 \family sans
25859 Document\SpecialChar menuseparator
25860 Settings...\SpecialChar menuseparator
25861 Branches
25862 \family default
25863 ).
25864  Within the master,
25865  deactivate the branch (
25866 \family sans
25867 Document\SpecialChar menuseparator
25868 Settings...\SpecialChar menuseparator
25869 Branches
25870 \family default
25871 ).
25872  Now the child's bibliography will be ignored by the master,
25873  but considered by the child.
25874 \end_layout
25875
25876 \begin_layout Standard
25877 If you need multiple bibliographies (e.
25878 \begin_inset space \thinspace{}
25879 \end_inset
25880
25881 g.,
25882  one per child in the
25883 \emph on
25884 main document
25885 \emph default
25886 ),
25887  please refer to sec.
25888 \begin_inset space ~
25889 \end_inset
25890
25891
25892 \begin_inset CommandInset ref
25893 LatexCommand ref
25894 reference "subsec:Multiple-Bibliographies"
25895 nolink "false"
25896
25897 \end_inset
25898
25899 .
25900 \end_layout
25901
25902 \begin_layout Section
25903 \SpecialChar LyX
25904  Archives
25905 \end_layout
25906
25907 \begin_layout Standard
25908 Users sometimes need to be able to
25909 \begin_inset Quotes eld
25910 \end_inset
25911
25912 bundle
25913 \begin_inset Quotes erd
25914 \end_inset
25915
25916  a \SpecialChar LyX
25917  file together with all the images (and other files) on which it depends,
25918  either for sending to a publisher or for sharing with a co-author.
25919  \SpecialChar LyX
25920  includes a Python script (
25921 \begin_inset Flex Code
25922 status collapsed
25923
25924 \begin_layout Plain Layout
25925 lyxpak.py
25926 \end_layout
25927
25928 \end_inset
25929
25930 ) that automates this process.
25931  To use it,
25932  you must have either the
25933 \begin_inset Flex Code
25934 status collapsed
25935
25936 \begin_layout Plain Layout
25937 zipfile
25938 \end_layout
25939
25940 \end_inset
25941
25942  or
25943 \begin_inset Flex Code
25944 status collapsed
25945
25946 \begin_layout Plain Layout
25947 tarfile
25948 \end_layout
25949
25950 \end_inset
25951
25952  python modules installed on your system.
25953  By default,
25954  the script prefers the
25955 \begin_inset Flex Code
25956 status collapsed
25957
25958 \begin_layout Plain Layout
25959 gzip
25960 \end_layout
25961
25962 \end_inset
25963
25964 -compressed
25965 \begin_inset Flex Code
25966 status collapsed
25967
25968 \begin_layout Plain Layout
25969 tar
25970 \end_layout
25971
25972 \end_inset
25973
25974  format on Unix-like systems and the
25975 \begin_inset Flex Code
25976 status collapsed
25977
25978 \begin_layout Plain Layout
25979 zip
25980 \end_layout
25981
25982 \end_inset
25983
25984  format on Windows.
25985 \end_layout
25986
25987 \begin_layout Standard
25988 \SpecialChar LyX
25989 's configuration process will set the script up to export a `\SpecialChar LyX
25990  Archive',
25991  and this format will then be available under
25992 \begin_inset Flex Code
25993 status collapsed
25994
25995 \begin_layout Plain Layout
25996 File\SpecialChar menuseparator
25997 Export
25998 \end_layout
25999
26000 \end_inset
26001
26002 .
26003 \end_layout
26004
26005 \begin_layout Standard
26006 Independently of the platform,
26007  the generation of a particular archive format can be forced by adding either the
26008 \begin_inset Flex Code
26009 status collapsed
26010
26011 \begin_layout Plain Layout
26012 -t
26013 \end_layout
26014
26015 \end_inset
26016
26017  (for the
26018 \begin_inset Flex Code
26019 status collapsed
26020
26021 \begin_layout Plain Layout
26022 tar
26023 \end_layout
26024
26025 \end_inset
26026
26027  format) or
26028 \begin_inset Flex Code
26029 status collapsed
26030
26031 \begin_layout Plain Layout
26032 -z
26033 \end_layout
26034
26035 \end_inset
26036
26037  (for the
26038 \begin_inset Flex Code
26039 status collapsed
26040
26041 \begin_layout Plain Layout
26042 zip
26043 \end_layout
26044
26045 \end_inset
26046
26047  format) switch to the
26048 \begin_inset Flex Code
26049 status collapsed
26050
26051 \begin_layout Plain Layout
26052 \SpecialChar LyX
26053 \SpecialChar menuseparator
26054 \SpecialChar LyX
26055  Archive
26056 \end_layout
26057
26058 \end_inset
26059
26060  converter in
26061 \begin_inset Flex Code
26062 status collapsed
26063
26064 \begin_layout Plain Layout
26065 Tools\SpecialChar menuseparator
26066 Preferences\SpecialChar menuseparator
26067 File Handling\SpecialChar menuseparator
26068 Converters
26069 \end_layout
26070
26071 \end_inset
26072
26073 .
26074  (Make sure you add the switch after the script name,
26075  not before it.)
26076 \end_layout
26077
26078 \begin_layout Section
26079 Fancy Headers and Footers
26080 \end_layout
26081
26082 \begin_layout Standard
26083 The default page layout is rather plain;
26084  for an
26085 \begin_inset Flex Code
26086 status collapsed
26087
26088 \begin_layout Plain Layout
26089 article
26090 \end_layout
26091
26092 \end_inset
26093
26094  document class,
26095  all you get is a centered page number at the bottom of the page.
26096  This document uses KOMA-script's book class,
26097  so it appears to be a bit fancier.
26098  But to really put on a show,
26099  you need to set the document page style to
26100 \begin_inset Quotes eld
26101 \end_inset
26102
26103 fancy
26104 \begin_inset Quotes erd
26105 \end_inset
26106
26107 ,
26108  as mentioned in the
26109 \emph on
26110 User Guide
26111 \emph default
26112 .
26113  This section describes the \SpecialChar LaTeX
26114  code you need to insert in your \SpecialChar LaTeX
26115  preamble in order to get the desired effects.
26116 \end_layout
26117
26118 \begin_layout Standard
26119 For more information on fancy headers,
26120  see the
26121 \begin_inset Flex Code
26122 status collapsed
26123
26124 \begin_layout Plain Layout
26125 fancyhdr
26126 \end_layout
26127
26128 \end_inset
26129
26130  package documentation.
26131  (
26132 \begin_inset Flex URL
26133 status collapsed
26134
26135 \begin_layout Plain Layout
26136
26137 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
26138 \end_layout
26139
26140 \end_inset
26141
26142 )
26143 \end_layout
26144
26145 \begin_layout Standard
26146 The page header is divided into three fields,
26147  not surprisingly labeled
26148 \begin_inset Quotes eld
26149 \end_inset
26150
26151 left
26152 \begin_inset Quotes erd
26153 \end_inset
26154
26155 ,
26156
26157 \begin_inset Quotes eld
26158 \end_inset
26159
26160 center
26161 \begin_inset Quotes erd
26162 \end_inset
26163
26164 ,
26165  and
26166 \begin_inset Quotes eld
26167 \end_inset
26168
26169 right
26170 \begin_inset Quotes erd
26171 \end_inset
26172
26173 .
26174  The footer is also divided into these three fields.
26175  The \SpecialChar LaTeX
26176  commands to set these fields in the simplest manner are
26177 \begin_inset Flex Code
26178 status collapsed
26179
26180 \begin_layout Plain Layout
26181
26182 \backslash
26183 lhead
26184 \end_layout
26185
26186 \end_inset
26187
26188 ,
26189
26190 \begin_inset Flex Code
26191 status collapsed
26192
26193 \begin_layout Plain Layout
26194
26195 \backslash
26196 chead
26197 \end_layout
26198
26199 \end_inset
26200
26201 ,
26202
26203 \begin_inset Flex Code
26204 status collapsed
26205
26206 \begin_layout Plain Layout
26207
26208 \backslash
26209 rhead
26210 \end_layout
26211
26212 \end_inset
26213
26214 ,
26215
26216 \begin_inset Flex Code
26217 status collapsed
26218
26219 \begin_layout Plain Layout
26220
26221 \backslash
26222 lfoot
26223 \end_layout
26224
26225 \end_inset
26226
26227 ,
26228  etc.
26229  Suppose you wish to put your name in the upper left hand corner of each page.
26230  Simply insert the following command in the preamble:
26231
26232 \end_layout
26233
26234 \begin_layout Standard
26235
26236 \family typewriter
26237
26238 \backslash
26239 lhead{John Q.
26240  DocWriter}
26241 \end_layout
26242
26243 \begin_layout Standard
26244 You will now see your name in the upper left.
26245  If a field has a default entry that you would like to get rid of (often the page number appears in the central footer) simply include a command with a blank argument,
26246  e.
26247 \begin_inset space \thinspace{}
26248 \end_inset
26249
26250 g.:
26251 \end_layout
26252
26253 \begin_layout Standard
26254
26255 \family typewriter
26256
26257 \backslash
26258 cfoot{}
26259 \end_layout
26260
26261 \begin_layout Standard
26262 Let's get really fancy:
26263  lets put the section number with the word
26264 \begin_inset Quotes eld
26265 \end_inset
26266
26267 Section
26268 \begin_inset Quotes erd
26269 \end_inset
26270
26271  (e.
26272 \begin_inset space \thinspace{}
26273 \end_inset
26274
26275 g.
26276 \begin_inset space \space{}
26277 \end_inset
26278
26279 Section 3) in the upper left,
26280  the page number (e.
26281 \begin_inset space \thinspace{}
26282 \end_inset
26283
26284 g.
26285 \begin_inset space \space{}
26286 \end_inset
26287
26288 Page 4) in the upper right,
26289  your name in the lower left,
26290  and the date in the lower right.
26291  The following commands should now appear in the preamble:
26292 \end_layout
26293
26294 \begin_layout Standard
26295
26296 \family typewriter
26297
26298 \backslash
26299 lhead{Section
26300 \backslash
26301 thesection}
26302 \end_layout
26303
26304 \begin_layout Standard
26305
26306 \family typewriter
26307
26308 \backslash
26309 chead{}
26310 \end_layout
26311
26312 \begin_layout Standard
26313
26314 \family typewriter
26315
26316 \backslash
26317 rhead{Page
26318 \backslash
26319 thepage}
26320 \end_layout
26321
26322 \begin_layout Standard
26323
26324 \family typewriter
26325
26326 \backslash
26327 lfoot{John Q.
26328  DocWriter}
26329 \end_layout
26330
26331 \begin_layout Standard
26332
26333 \family typewriter
26334
26335 \backslash
26336 cfoot{}
26337 \end_layout
26338
26339 \begin_layout Standard
26340
26341 \family typewriter
26342
26343 \backslash
26344 rfoot{
26345 \backslash
26346 today}
26347 \end_layout
26348
26349 \begin_layout Standard
26350 The commands
26351 \begin_inset Flex Code
26352 status collapsed
26353
26354 \begin_layout Plain Layout
26355
26356 \backslash
26357 thesection
26358 \end_layout
26359
26360 \end_inset
26361
26362  and
26363 \begin_inset Flex Code
26364 status collapsed
26365
26366 \begin_layout Plain Layout
26367
26368 \backslash
26369 thepage
26370 \end_layout
26371
26372 \end_inset
26373
26374  access \SpecialChar LaTeX
26375 's section and page counters,
26376  and so print out the current section and page number.
26377
26378 \begin_inset Flex Code
26379 status collapsed
26380
26381 \begin_layout Plain Layout
26382
26383 \backslash
26384 today
26385 \end_layout
26386
26387 \end_inset
26388
26389  simply prints out today's date.
26390 \end_layout
26391
26392 \begin_layout Standard
26393 The thicknesses of the horizontal rules drawn beneath the header and above the footer can also be modified.
26394  If you don't want one of the rules,
26395  set its thickness to 0.
26396  The header rule has a default thickness of 0.4pt,
26397  the footer rule is 0pt.
26398  Use commands
26399 \family typewriter
26400
26401 \family default
26402 like
26403 \begin_inset Flex Code
26404 status collapsed
26405
26406 \begin_layout Plain Layout
26407
26408 \backslash
26409 renewcommand{
26410 \backslash
26411 headrulewidth}{0.4pt}
26412 \end_layout
26413
26414 \end_inset
26415
26416  and
26417 \begin_inset Flex Code
26418 status collapsed
26419
26420 \begin_layout Plain Layout
26421
26422 \backslash
26423 renewcommand{
26424 \backslash
26425 footrulewidth}{0.4pt}
26426 \end_layout
26427
26428 \end_inset
26429
26430  to set the thicknesses.
26431 \end_layout
26432
26433 \begin_layout Standard
26434 You can switch the header/footer settings on and off for individual pages using commands like
26435 \begin_inset Flex Code
26436 status collapsed
26437
26438 \begin_layout Plain Layout
26439
26440 \backslash
26441 thispagestyle{empty}
26442 \end_layout
26443
26444 \end_inset
26445
26446 ,
26447
26448 \begin_inset Flex Code
26449 status collapsed
26450
26451 \begin_layout Plain Layout
26452
26453 \backslash
26454 thispagestyle{plain}
26455 \end_layout
26456
26457 \end_inset
26458
26459 ,
26460  and
26461 \begin_inset Flex Code
26462 status collapsed
26463
26464 \begin_layout Plain Layout
26465
26466 \backslash
26467 thispagestyle{fancy}
26468 \end_layout
26469
26470 \end_inset
26471
26472 .
26473  Simply insert them in the text on the page you want changed and mark them as \SpecialChar TeX
26474  code.
26475  In fact,
26476  title pages are marked as plain by default,
26477  while following pages are marked fancy when using the global fancy setting.
26478 \end_layout
26479
26480 \begin_layout Standard
26481 As a final example,
26482  it is possible to include an image in the header or footer.
26483  Suppose you want to put a company logo in the upper lefthand corner.
26484  You might try something like
26485 \end_layout
26486
26487 \begin_layout Standard
26488
26489 \family typewriter
26490
26491 \backslash
26492 lhead{
26493 \backslash
26494 resizebox{1in}{!}{
26495 \backslash
26496 includegraphics{logo.eps}}}
26497 \end_layout
26498
26499 \begin_layout Standard
26500 \noindent
26501 (you may need to preface this with
26502 \begin_inset Flex Code
26503 status collapsed
26504
26505 \begin_layout Plain Layout
26506
26507 \backslash
26508 usepackage{graphics}
26509 \end_layout
26510
26511 \end_inset
26512
26513  if you don't include graphics elsewhere in your document).
26514 \end_layout
26515
26516 \begin_layout Chapter
26517 \SpecialChar LyX
26518  and the World Wide Web
26519 \end_layout
26520
26521 \begin_layout Standard
26522 \SpecialChar LyX
26523  has long supported the export of documents to various web-friendly formats,
26524  such as HTML.
26525  Before version 2.0,
26526  however,
26527  HTML export was always accomplished by the use of external converters.
26528 \begin_inset Foot
26529 status collapsed
26530
26531 \begin_layout Plain Layout
26532 For details on the use of external converters with \SpecialChar LyX
26533 ,
26534  see the
26535 \emph on
26536 Converters
26537 \emph default
26538  section of the Customization manual.
26539 \end_layout
26540
26541 \end_inset
26542
26543  These fall into two large groups:
26544  there are converters that use \SpecialChar LaTeX
26545  as an intermediate format,
26546  such as
26547 \begin_inset Flex Code
26548 status collapsed
26549
26550 \begin_layout Plain Layout
26551 htlatex
26552 \end_layout
26553
26554 \end_inset
26555
26556 ,
26557
26558 \begin_inset Flex Code
26559 status collapsed
26560
26561 \begin_layout Plain Layout
26562 html2latex
26563 \end_layout
26564
26565 \end_inset
26566
26567 ,
26568  and
26569 \begin_inset Flex Code
26570 status collapsed
26571
26572 \begin_layout Plain Layout
26573 plastex
26574 \end_layout
26575
26576 \end_inset
26577
26578 ,
26579  relying upon \SpecialChar LyX
26580  to produce the \SpecialChar LaTeX
26581 ;
26582  and there is a converter that works directly on \SpecialChar LyX
26583  files,
26584
26585 \begin_inset Flex Code
26586 status collapsed
26587
26588 \begin_layout Plain Layout
26589 e\SpecialChar LyX
26590 er
26591 \end_layout
26592
26593 \end_inset
26594
26595 .
26596  All of these have different advantages and disadvantages.
26597
26598 \end_layout
26599
26600 \begin_layout Standard
26601 The \SpecialChar LaTeX
26602 -based converters have the advantage that,
26603  in principle,
26604  they know everything about the exported document that \SpecialChar LaTeX
26605  does.
26606  Such converters do not care,
26607  for example,
26608  if a certain block of code was produced by \SpecialChar LyX
26609  or was Evil Red Text.
26610  These converters know about
26611 \begin_inset Flex Code
26612 status collapsed
26613
26614 \begin_layout Plain Layout
26615 aux
26616 \end_layout
26617
26618 \end_inset
26619
26620  files,
26621  counters,
26622  and references,
26623  and can often make use of the
26624 \begin_inset Flex Code
26625 status collapsed
26626
26627 \begin_layout Plain Layout
26628 bbl
26629 \end_layout
26630
26631 \end_inset
26632
26633  files generated by Bib\SpecialChar TeX
26634 .
26635  On the other hand,
26636  \SpecialChar LaTeX
26637  is a very hard language to parse—
26638 it is sometimes said that only \SpecialChar TeX
26639  itself understands \SpecialChar TeX
26640 —
26641 and \SpecialChar LaTeX
26642 -based converters will often choke on what seem to be quite simple constructs;
26643  complex ones can throw them completely,
26644  and as of this writing,
26645  for example,
26646  the
26647 \emph on
26648 Embedded Objects
26649 \emph default
26650  manual will not export with
26651 \begin_inset Flex Code
26652 status collapsed
26653
26654 \begin_layout Plain Layout
26655 htlatex
26656 \end_layout
26657
26658 \end_inset
26659
26660 ,
26661  though the others will.
26662  The other issue concerns how math is handled.
26663  These converters typically convert the formulae into little pictures that are then linked from the HTML document.
26664  Since these are actually generated by \SpecialChar LaTeX
26665 ,
26666  they are accurate.
26667  But they do not scale well,
26668  and just getting them to look as if they are actually meant to be in your document—
26669 so that the font sizes seem to be roughly the same—
26670 can be a challenge.
26671 \end_layout
26672
26673 \begin_layout Standard
26674 Alex Fernandez's
26675 \begin_inset Flex Code
26676 status collapsed
26677
26678 \begin_layout Plain Layout
26679 e\SpecialChar LyX
26680 er
26681 \end_layout
26682
26683 \end_inset
26684
26685  (
26686 \begin_inset CommandInset href
26687 LatexCommand href
26688 name "http://pinchito.es/elyxer/"
26689 target "http://pinchito.es/elyxer/"
26690 literal "false"
26691
26692 \end_inset
26693
26694 ) solves some of these problems.
26695  In particular,
26696  the formulae it produces scale perfectly,
26697  since it renders math using a combination of HTML and CSS rather than converting the formulae to images.
26698  But even moderately complex formula are rendered less well than with
26699 \begin_inset Flex Code
26700 status collapsed
26701
26702 \begin_layout Plain Layout
26703 htlatex
26704 \end_layout
26705
26706 \end_inset
26707
26708 ;
26709  this reflects the limitations of HTML.
26710 \begin_inset Foot
26711 status collapsed
26712
26713 \begin_layout Plain Layout
26714 That said,
26715
26716 \begin_inset Flex Code
26717 status collapsed
26718
26719 \begin_layout Plain Layout
26720 e\SpecialChar LyX
26721 er
26722 \end_layout
26723
26724 \end_inset
26725
26726  can also use jsMath and MathJax for equations,
26727  but this setting is only available globally and requires one to have access to a server that runs the backend.
26728 \end_layout
26729
26730 \end_inset
26731
26732  More importantly (as of version 1.1.1,
26733  at least),
26734
26735 \begin_inset Flex Code
26736 status collapsed
26737
26738 \begin_layout Plain Layout
26739 e\SpecialChar LyX
26740 er
26741 \end_layout
26742
26743 \end_inset
26744
26745  has limited support for math macros and no support for user-defined paragraph or character styles.
26746  These limitations make
26747 \begin_inset Flex Code
26748 status collapsed
26749
26750 \begin_layout Plain Layout
26751 e\SpecialChar LyX
26752 er
26753 \end_layout
26754
26755 \end_inset
26756
26757  unsuitable for many of the documents \SpecialChar LyX
26758  users produce.
26759  In principle,
26760  of course,
26761  these problems could be solved,
26762  but the \SpecialChar LyX
26763  developers have decided to follow a different path and have made \SpecialChar LyX
26764  itself capable of writing XHTML,
26765  just as it is capable of writing \SpecialChar LaTeX
26766 ,
26767  DocBook,
26768  and plaintext.
26769 \end_layout
26770
26771 \begin_layout Standard
26772 As of this writing,
26773  XHTML output remains under development and should probably be regarded as
26774 \begin_inset Quotes eld
26775 \end_inset
26776
26777 experimental
26778 \begin_inset Quotes erd
26779 \end_inset
26780
26781 .
26782 \begin_inset Foot
26783 status collapsed
26784
26785 \begin_layout Plain Layout
26786 The file
26787 \begin_inset Flex Code
26788 status collapsed
26789
26790 \begin_layout Plain Layout
26791 development/HTML/HTML.notes
26792 \end_layout
26793
26794 \end_inset
26795
26796 ,
26797  which can be found in the \SpecialChar LyX
26798  source tree or
26799 \begin_inset CommandInset href
26800 LatexCommand href
26801 name "accessed online"
26802 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
26803 literal "false"
26804
26805 \end_inset
26806
26807 ,
26808  usually contains up-to-date information about the state of XHTML output.
26809  See also the list of XHTML bugs on
26810 \begin_inset CommandInset href
26811 LatexCommand href
26812 name "the bug tracker"
26813 target "https://www.lyx.org/trac/query?status=reopened&status=assigned&status=new&max=0&component=xhtml+export&order=id&col=id&col=summary&col=reporter&col=keywords&keywords=%21%7Efixedintrunk&desc=1"
26814 literal "false"
26815
26816 \end_inset
26817
26818 .
26819 \end_layout
26820
26821 \end_inset
26822
26823  Still,
26824  the developers have chosen this approach because it has several potential advantages over the other two.
26825 \end_layout
26826
26827 \begin_layout Standard
26828 These advantages are primarily due to the fact that the XHTML output routines,
26829  since they are part of \SpecialChar LyX
26830 ,
26831  know everything \SpecialChar LyX
26832  knows about the document being exported.
26833 \begin_inset Foot
26834 status collapsed
26835
26836 \begin_layout Plain Layout
26837 Another advantage is that,
26838  since these routines are internal to \SpecialChar LyX
26839 ,
26840  they are immune to changes in \SpecialChar LyX
26841 's file format,
26842  or to changes in the semantics of existing insets.
26843 \end_layout
26844
26845 \end_inset
26846
26847  So they know about the table of contents (as displayed in the outline),
26848  about the counters associated with different paragraph styles,
26849  and about user-defined styles.
26850  The XHTML output routines know what \SpecialChar LyX
26851  knows about internationalization,
26852  too,
26853  so they will output
26854 \begin_inset Quotes eld
26855 \end_inset
26856
26857 Chapter 1
26858 \begin_inset Quotes erd
26859 \end_inset
26860
26861  or
26862 \begin_inset Quotes eld
26863 \end_inset
26864
26865
26866 \lang ngerman
26867 Kapitel
26868 \lang english
26869  1
26870 \begin_inset Quotes erd
26871 \end_inset
26872
26873 ,
26874  depending upon the language in effect at the time.
26875
26876 \end_layout
26877
26878 \begin_layout Standard
26879 Quite generally,
26880  the output routines know what \SpecialChar LyX
26881  knows about document layout,
26882  that is,
26883  about how the document is to be rendered on screen.
26884  We use this information when we output the document as XHTML.
26885  In particular,
26886  \SpecialChar LyX
26887
26888 \emph on
26889 automatically
26890 \emph default
26891  generates CSS style information corresponding to the layout information it uses to render the document on screen:
26892  if section headings are supposed to be sans-serif and bold as seen in \SpecialChar LyX
26893 ,
26894  then (by default) they will be sans-serif and bold when viewed in a web browser,
26895  too.
26896  And this is true not just for pre-defined styles,
26897  like Section,
26898  but for any style,
26899  including user-defined styles.
26900  Indeed,
26901  the XHTML output routines make no distinction between user-defined paragraph and
26902 \change_deleted 244031559 1603876931
26903 character
26904 \change_inserted 244031559 1603876940
26905 text
26906 \change_unchanged
26907  styles and \SpecialChar LyX
26908 's own pre-defined styles:
26909  in each case,
26910  everything \SpecialChar LyX
26911  knows about the styles is contained in the layout files.
26912  And much the same is true as regards pre-defined textual insets,
26913  such as footnotes,
26914  and various custom insets.
26915
26916 \end_layout
26917
26918 \begin_layout Standard
26919 The result is that XHTML output can be customized and extended in exactly the same way \SpecialChar LaTeX
26920  output can be customized and extended:
26921  through layout files and modules.
26922  See chapter five of the
26923 \emph on
26924 Customization
26925 \emph default
26926 manual for the details.
26927 \end_layout
26928
26929 \begin_layout Standard
26930 The remainder of this chapter contains more detailed information on XHTML output,
26931  its limitations,
26932  and ways to work around those limitations.
26933 \end_layout
26934
26935 \begin_layout Section
26936 Math Output in XHTML
26937 \end_layout
26938
26939 \begin_layout Standard
26940 \SpecialChar LyX
26941  offers four choices for how math is rendered.
26942  These have various advantages and disadvantages:
26943 \end_layout
26944
26945 \begin_layout Itemize
26946 MathML
26947 \begin_inset Newline newline
26948 \end_inset
26949
26950 MathML is a dialect of XML designed specifically for mathematics on the web,
26951  and it typically renders very well in browsers that support it.
26952  The disadvantage is that not all browsers support MathML,
26953  and support is not complete even in the Gecko-based browsers,
26954  such as Firefox.
26955 \begin_inset Newline newline
26956 \end_inset
26957
26958 If \SpecialChar LyX
26959  is unable to render a formula as MathML—
26960 for example,
26961  if the formula uses the
26962 \begin_inset Flex Code
26963 status collapsed
26964
26965 \begin_layout Plain Layout
26966 xymatrix
26967 \end_layout
26968
26969 \end_inset
26970
26971  package or ERT—
26972 then it will instead output the formula as an image.
26973
26974 \end_layout
26975
26976 \begin_layout Itemize
26977 HTML
26978 \begin_inset Newline newline
26979 \end_inset
26980
26981 As mentioned above,
26982
26983 \begin_inset Flex Code
26984 status collapsed
26985
26986 \begin_layout Plain Layout
26987 elyxer
26988 \end_layout
26989
26990 \end_inset
26991
26992  outputs math as HTML,
26993  styled by CSS.
26994 \begin_inset Foot
26995 status collapsed
26996
26997 \begin_layout Plain Layout
26998 \SpecialChar LyX
26999  has borrowed some of the CSS for its HTML output from
27000 \begin_inset Flex Code
27001 status collapsed
27002
27003 \begin_layout Plain Layout
27004 elyxer
27005 \end_layout
27006
27007 \end_inset
27008
27009 .
27010 \end_layout
27011
27012 \end_inset
27013
27014  For simple formulae,
27015  this can work quite well,
27016  though with more complicated formulae it tends to break down.
27017  Still,
27018  this method has the advantage that it is very widely supported and so it may be appropriate for documents that contain only a little,
27019  fairly simple math.
27020 \begin_inset Newline newline
27021 \end_inset
27022
27023 If Lyx is unable to render a formula as HTML—
27024 for example,
27025  if the formula uses the
27026 \begin_inset Flex Code
27027 status collapsed
27028
27029 \begin_layout Plain Layout
27030 xymatrix
27031 \end_layout
27032
27033 \end_inset
27034
27035  package or ERT—
27036 then it will instead output the formula as an image.
27037
27038 \end_layout
27039
27040 \begin_layout Itemize
27041 Images
27042 \begin_inset Newline newline
27043 \end_inset
27044
27045 Like
27046 \begin_inset Flex Code
27047 status collapsed
27048
27049 \begin_layout Plain Layout
27050 htlatex
27051 \end_layout
27052
27053 \end_inset
27054
27055 ,
27056  \SpecialChar LyX
27057  will output formulae as images,
27058  the very same images,
27059  in fact,
27060  that are used for instant preview.
27061 \begin_inset Foot
27062 status collapsed
27063
27064 \begin_layout Plain Layout
27065 Instant preview does
27066 \emph on
27067 not
27068 \emph default
27069 have to be on for images to be output,
27070  however.
27071 \end_layout
27072
27073 \end_inset
27074
27075  The advantage to this method is that the images are simply generated by \SpecialChar LaTeX
27076 ,
27077  so they are very accurate.
27078  The disadvantage,
27079  as mentioned earlier,
27080  is that these are bitmapped images,
27081  so they do not scale terribly well,
27082  and one cannot copy them,
27083  etc.
27084 \begin_inset Newline newline
27085 \end_inset
27086
27087 The size of the images can be controlled by setting the
27088 \begin_inset Quotes eld
27089 \end_inset
27090
27091 Math Images Scaling
27092 \begin_inset Quotes erd
27093 \end_inset
27094
27095  parameter under
27096 \begin_inset Flex Noun
27097 status collapsed
27098
27099 \begin_layout Plain Layout
27100 Document\SpecialChar menuseparator
27101 Settings\SpecialChar menuseparator
27102 Formats
27103 \end_layout
27104
27105 \end_inset
27106
27107 .
27108 \begin_inset Foot
27109 status collapsed
27110
27111 \begin_layout Plain Layout
27112 For those who want to know,
27113  this controls the resolution of the image in dots per inch and is based upon a default of 75 dpi.
27114 \end_layout
27115
27116 \end_inset
27117
27118
27119 \begin_inset Newline newline
27120 \end_inset
27121
27122 If \SpecialChar LyX
27123  for some reason fails to create an image for a formula (e.g.,
27124  if a required \SpecialChar LaTeX
27125  package is not installed),
27126  then it will fall back to outputing the raw \SpecialChar LaTeX
27127 .
27128 \end_layout
27129
27130 \begin_layout Itemize
27131 \SpecialChar LaTeX
27132
27133 \begin_inset Newline newline
27134 \end_inset
27135
27136 Finally,
27137  \SpecialChar LyX
27138  will happily output math as \SpecialChar LaTeX
27139 .
27140  As well as being the output of last resort,
27141  this method can be used with such tools as
27142 \begin_inset CommandInset href
27143 LatexCommand href
27144 name "jsMath"
27145 target "http://www.math.union.edu/~dpvc/jsMath/"
27146 literal "false"
27147
27148 \end_inset
27149
27150 ,
27151  which uses JavaScript to render \SpecialChar LaTeX
27152  embedded in HTML documents.
27153  \SpecialChar LyX
27154  wraps the \SpecialChar LaTeX
27155  in either a
27156 \begin_inset Flex Code
27157 status collapsed
27158
27159 \begin_layout Plain Layout
27160 span
27161 \end_layout
27162
27163 \end_inset
27164
27165  (for inline formulas) or
27166 \begin_inset Flex Code
27167 status collapsed
27168
27169 \begin_layout Plain Layout
27170 div
27171 \end_layout
27172
27173 \end_inset
27174
27175  (for displayed formulas) with
27176 \begin_inset Flex Code
27177 status collapsed
27178
27179 \begin_layout Plain Layout
27180 class='math'
27181 \end_layout
27182
27183 \end_inset
27184
27185 ,
27186  as is required for jsMath.
27187 \end_layout
27188
27189 \begin_layout Standard
27190 One of these output methods must be selected under
27191 \begin_inset Flex Noun
27192 status collapsed
27193
27194 \begin_layout Plain Layout
27195 Document\SpecialChar menuseparator
27196 Settings\SpecialChar menuseparator
27197 Formats
27198 \end_layout
27199
27200 \end_inset
27201
27202 .
27203  By default,
27204  \SpecialChar LyX
27205  outputs MathML.
27206  This is a document-wide setting,
27207  therefore.
27208 \end_layout
27209
27210 \begin_layout Standard
27211 Eventually,
27212  \SpecialChar LyX
27213  will offer the user the option to select an alternate output method for a particular inset,
27214  say,
27215  one that isn't being rendered very well by MathML.
27216 \begin_inset Foot
27217 status collapsed
27218
27219 \begin_layout Plain Layout
27220 That said,
27221  since \SpecialChar LyX
27222  falls back to images if the inset contains ERT,
27223  then one can force output as an image by putting some harmless ERT into the math,
27224  for example:
27225
27226 \begin_inset Formula $a=b\relax$
27227 \end_inset
27228
27229 .
27230 \end_layout
27231
27232 \end_inset
27233
27234
27235 \end_layout
27236
27237 \begin_layout Section
27238 Bibliography and Citations
27239 \end_layout
27240
27241 \begin_layout Standard
27242 XHTML output fully supports bibliographies and citations.
27243
27244 \end_layout
27245
27246 \begin_layout Standard
27247 Citation labels are generated by the same machinery that generates \SpecialChar LyX
27248 's on-screen labels,
27249  so the labels will look in the output much as they do in \SpecialChar LyX
27250 ,
27251  though better.
27252  If you are using numerical citations,
27253  then \SpecialChar LyX
27254  will output numerical labels,
27255  such as [1] or [17],
27256  rather than simply showing the citation key in square brackets,
27257  as it does on-screen.
27258  If you are using author-year citations,
27259  then \SpecialChar LyX
27260  will add lowercase letters to the years,
27261  just as Bib\SpecialChar TeX
27262  does,
27263  if it finds more than one citation for a given author-year combination.
27264  The labels will be printed with the bibliography entries.
27265  Note that there is,
27266  at present,
27267  no way to customize the appearance of the labels,
27268  for example,
27269  to choose between square brackets and parentheses.
27270 \end_layout
27271
27272 \begin_layout Standard
27273 Bibliography output is handled by the same machinery that handles the presentation of reference information in the citation dialog,
27274  so you will see in the XHTML output pretty much what you would see if you were to look at a given entry in the citation dialog.
27275  The formatting can be customized in your layout file or,
27276  preferably,
27277  in a module.
27278  See the
27279 \emph on
27280 Customization
27281 \emph default
27282  manual for the details.
27283 \end_layout
27284
27285 \begin_layout Standard
27286 The main defect at present is that cross-referenced information is printed with every entry with which it is associated.
27287  So you can see things like this:
27288 \end_layout
27289
27290 \begin_layout Quote
27291 Jason Stanley,
27292
27293 \begin_inset Quotes eld
27294 \end_inset
27295
27296 Context and Logical Form
27297 \begin_inset Quotes erd
27298 \end_inset
27299
27300 ,
27301  in
27302 \emph on
27303 Language in Context:
27304  Selected Essays
27305 \emph default
27306  (Oxford:
27307  Oxford University Press,
27308  2007),
27309  pp.
27310  30–68.
27311 \end_layout
27312
27313 \begin_layout Quote
27314 Jason Stanley,
27315
27316 \begin_inset Quotes eld
27317 \end_inset
27318
27319 Semantics in Context
27320 \begin_inset Quotes erd
27321 \end_inset
27322
27323 ,
27324  in
27325 \emph on
27326 Language in Context:
27327  Selected Essays
27328 \emph default
27329  (Oxford:
27330  Oxford University Press,
27331  2007),
27332  pp.
27333  201–30.
27334 \end_layout
27335
27336 \begin_layout Standard
27337 This should be fixed before long.
27338 \end_layout
27339
27340 \begin_layout Standard
27341 There is no support at present for sectioned bibliographies.
27342  If you have multiple bibliographies,
27343  then \SpecialChar LyX
27344  will print the same bibliography over and over.
27345 \end_layout
27346
27347 \begin_layout Section
27348 Indexes
27349 \end_layout
27350
27351 \begin_layout Standard
27352 \SpecialChar LyX
27353  will happily export indexes as XHTML,
27354  but with certain limitations at the moment.
27355 \end_layout
27356
27357 \begin_layout Standard
27358 Index export will be most reliable when you do not attempt to use the fancy constructs that are described in the section on indexes in the
27359 \emph on
27360 User's Guide
27361 \emph default
27362 .
27363 \begin_inset Foot
27364 status collapsed
27365
27366 \begin_layout Plain Layout
27367 The main issue here is that \SpecialChar LyX
27368  itself does not really handle these.
27369  It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
27370 .
27371 \end_layout
27372
27373 \end_inset
27374
27375  We'll describe how they are handled using the subsection headings from that section.
27376 \end_layout
27377
27378 \begin_layout Itemize
27379 Grouping Index Entries (aka,
27380  sub-entries):
27381  \SpecialChar LyX
27382  makes an effort to support these,
27383  but the entries must be separated by
27384 \begin_inset Quotes eld
27385 \end_inset
27386
27387  !
27388
27389 \begin_inset Quotes erd
27390 \end_inset
27391
27392 ,
27393  that is,
27394  there must be spaces around the exclamation point.
27395  This is because it is otherwise too difficult to check for escaped exclamation points,
27396  ones in math,
27397  and so forth.
27398 \end_layout
27399
27400 \begin_layout Itemize
27401 Page Ranges:
27402  There is no support at all for page ranges,
27403  since these make no sense with XHMTL.
27404  Instead,
27405  you will just get two index entries,
27406  one at either end.
27407 \end_layout
27408
27409 \begin_layout Itemize
27410 Cross-referencing:
27411  There is no support for cross-referencing.
27412  If \SpecialChar LyX
27413  finds an entry containing the
27414 \begin_inset Quotes eld
27415 \end_inset
27416
27417 |see\SpecialChar ldots
27418
27419 \begin_inset Quotes erd
27420 \end_inset
27421
27422  construct,
27423  it is just dropped,
27424  and the rest is treated as an ordinary index entry.
27425 \end_layout
27426
27427 \begin_layout Itemize
27428 Index Entry Order:
27429  \SpecialChar LyX
27430  does support attempts to fix the sorting order.
27431  It will take what is before the first `@' it finds and use that for sorting,
27432  taking what follows the first `@' to be the actual entry.
27433  At present,
27434  \SpecialChar LyX
27435  does not check for escaped `@',
27436  so do not try to index email addresses.
27437 \end_layout
27438
27439 \begin_layout Itemize
27440 Index Entry Layout:
27441  You can format entries by using the text style dialog,
27442  or by using any other method available within \SpecialChar LyX
27443  itself.
27444  There is no support for constructs like:
27445
27446 \begin_inset Quotes eld
27447 \end_inset
27448
27449 entry|textbf
27450 \begin_inset Quotes erd
27451 \end_inset
27452
27453 .
27454  Indeed,
27455  if \SpecialChar LyX
27456  finds a pipe symbol,
27457  `|',
27458  in an entry,
27459  it will delete it and everything that follows it.
27460 \end_layout
27461
27462 \begin_layout Itemize
27463 Multiple Indexes:
27464  There is no support for multiple indexes.
27465  Rather,
27466  all index entries will be printed as one large index.
27467  To avoid our printing several versions of the index,
27468  we print only the main index,
27469  so make sure you have one.
27470 \end_layout
27471
27472 \begin_layout Section
27473 Nomenclature and Glossary
27474 \end_layout
27475
27476 \begin_layout Standard
27477 There is at present no support for glossaries.
27478  Adding it would be fairly trivial,
27479  and welcome.
27480 \end_layout
27481
27482 \begin_layout Chapter
27483
27484 \change_inserted 1075283030 1616534180
27485 DocBook Output
27486 \end_layout
27487
27488 \begin_layout Standard
27489
27490 \change_inserted 1075283030 1616534386
27491 Apart from HTML,
27492  \SpecialChar LyX
27493  can generate documents in the DocBook XML vocabulary.
27494  With versions 2.3 and before,
27495  only select templates could be used to generate DocBook documents (only version 4).
27496  Starting with \SpecialChar LyX
27497  2.4,
27498  most \SpecialChar LyX
27499  layouts can generate valid DocBook documents (only version 5).
27500  This feature is built into \SpecialChar LyX
27501  and does not require the use of external tools.
27502 \end_layout
27503
27504 \begin_layout Standard
27505
27506 \change_inserted 1075283030 1616534437
27507 The result is that the DocBook output can be customized and extended in exactly the same way \SpecialChar LaTeX
27508  output can be customized and extended:
27509  through layout files and modules.
27510  See chapter five of the
27511 \emph on
27512 Customization
27513 \emph default
27514 manual for the details.
27515 \end_layout
27516
27517 \begin_layout Standard
27518
27519 \change_inserted 1075283030 1616534475
27520 Most \SpecialChar LyX
27521  features are supported with DocBook,
27522  like math output.
27523 \end_layout
27524
27525 \begin_layout Itemize
27526
27527 \change_inserted 1075283030 1616534741
27528 Math output is performed mostly in MathML (the major exception being constructions not supported by \SpecialChar LyX
27529 ,
27530  i.e.
27531  ERTs).
27532  All formulae are also available in raw \SpecialChar TeX
27533  in the DocBook output for further processing.
27534 \end_layout
27535
27536 \begin_layout Itemize
27537
27538 \change_inserted 1075283030 1616534852
27539 Bibliographies and citations are implemented,
27540  including with an external BibTeX file.
27541  Bibliography entries are not prerendered when the detailed information are available,
27542  but rather output with the standard DocBook constructs.
27543  The external DocBook processor is expected to handle the rendering of entries.
27544 \end_layout
27545
27546 \begin_layout Itemize
27547
27548 \change_inserted 1075283030 1616534863
27549 Indexes are supported,
27550  including multiple indices.
27551  Grouping (with
27552 \family typewriter
27553 !
27554 \family default
27555 ),
27556  page ranges,
27557  and cross-references (
27558 \family typewriter
27559 |see
27560 \family default
27561 ) are supported,
27562  with the exception of the same symbols escaped.
27563  Entry order (
27564 \family typewriter
27565 @
27566 \family default
27567 ) and layout (
27568 \family typewriter
27569 |mathbf
27570 \family default
27571 ) are not supported.
27572  There is no support for escaping of index entries.
27573 \end_layout
27574
27575 \begin_layout Itemize
27576
27577 \change_inserted 1075283030 1616534884
27578 Glossaries are implemented.
27579 \end_layout
27580
27581 \begin_layout Standard
27582
27583 \change_inserted 1075283030 1616534894
27584 Two major parameters can be set at the document level.
27585 \end_layout
27586
27587 \begin_layout Itemize
27588
27589 \change_inserted 1075283030 1616534948
27590 Format for tables:
27591  \SpecialChar LyX
27592  can generate tables either as HTML (default value) or CALS,
27593  depending on the user's requirements.
27594  Most DocBook processors accept both formats.
27595 \end_layout
27596
27597 \begin_layout Itemize
27598
27599 \change_inserted 1075283030 1616535006
27600 MathML prefix:
27601  in DocBook,
27602  MathML is included within its own name space,
27603  unlike HTML.
27604  The implication is that there must be an indication of the tags belonging to the MathML standard.
27605  Three choices are offered:
27606
27607 \end_layout
27608
27609 \begin_deeper
27610 \begin_layout Itemize
27611
27612 \change_inserted 1075283030 1616535044
27613 Inline:
27614  the MathML name space is defined for each formula (using the
27615 \family typewriter
27616 xmlns
27617 \family default
27618  attribute on each formula)
27619 \end_layout
27620
27621 \begin_layout Itemize
27622
27623 \change_inserted 1075283030 1616535090
27624 With the
27625 \family typewriter
27626 m
27627 \family default
27628  prefix (default):
27629  the MathML name space is defined at the document level (using the
27630 \family typewriter
27631 xmlns:m
27632 \family default
27633  attribute on the root element).
27634  Each MathML is prefixed with
27635 \family typewriter
27636 m
27637 \family default
27638 :
27639  for instance,
27640
27641 \family typewriter
27642 m:math
27643 \end_layout
27644
27645 \begin_layout Itemize
27646
27647 \change_inserted 1075283030 1616620405
27648 With the
27649 \family typewriter
27650 mml
27651 \family default
27652  prefix:
27653  similar to the
27654 \family typewriter
27655 m
27656 \family default
27657  option,
27658  but with
27659 \family typewriter
27660 mml
27661 \end_layout
27662
27663 \begin_layout Standard
27664
27665 \change_inserted 1075283030 1616620470
27666 This option is especially useful if you want \SpecialChar LyX
27667  to match your personal style or to work with buggy software that only accepts one prefix for MathML.
27668 \change_unchanged
27669
27670 \end_layout
27671
27672 \end_deeper
27673 \begin_layout Chapter
27674 The \SpecialChar LyX
27675  Server
27676 \end_layout
27677
27678 \begin_layout Section
27679 Introduction
27680 \end_layout
27681
27682 \begin_layout Standard
27683 The `\SpecialChar LyX
27684  server' allows other programs to talk to \SpecialChar LyX
27685 ,
27686  invoke \SpecialChar LyX
27687  commands,
27688  and retrieve information about the \SpecialChar LyX
27689  internal state.
27690  This is only intended for advanced users,
27691  but they should find it useful.
27692  It is by writing to the \SpecialChar LyX
27693  server,
27694  for example,
27695  that bibliography managers,
27696  such as JabRef,
27697  are able to
27698 \begin_inset Quotes eld
27699 \end_inset
27700
27701 push
27702 \begin_inset Quotes erd
27703 \end_inset
27704
27705  citations to \SpecialChar LyX
27706 .
27707 \end_layout
27708
27709 \begin_layout Section
27710 Starting the \SpecialChar LyX
27711  Server
27712 \begin_inset CommandInset label
27713 LatexCommand label
27714 name "sec:Starting-the-Server"
27715
27716 \end_inset
27717
27718
27719 \end_layout
27720
27721 \begin_layout Standard
27722 The \SpecialChar LyX
27723  server works through the use of a pair of named pipes.
27724  These are usually located in
27725 \begin_inset Flex Code
27726 status collapsed
27727
27728 \begin_layout Plain Layout
27729 UserDir
27730 \end_layout
27731
27732 \end_inset
27733
27734 ,
27735  (except on Windows,
27736  where
27737 \emph on
27738 local
27739 \emph default
27740  named pipes are special objects located in
27741 \begin_inset Flex Code
27742 status collapsed
27743
27744 \begin_layout Plain Layout
27745
27746 \backslash
27747
27748 \backslash
27749 .
27750 \backslash
27751 pipe
27752 \end_layout
27753
27754 \end_inset
27755
27756 ) and have the names
27757 \begin_inset Quotes eld
27758 \end_inset
27759
27760
27761 \begin_inset Flex Code
27762 status collapsed
27763
27764 \begin_layout Plain Layout
27765 lyxpipe.in
27766 \end_layout
27767
27768 \end_inset
27769
27770
27771 \begin_inset Quotes erd
27772 \end_inset
27773
27774  and
27775 \begin_inset Quotes eld
27776 \end_inset
27777
27778
27779 \begin_inset Flex Code
27780 status collapsed
27781
27782 \begin_layout Plain Layout
27783 lyxpipe.out
27784 \end_layout
27785
27786 \end_inset
27787
27788
27789 \begin_inset Quotes erd
27790 \end_inset
27791
27792 .
27793  External programs write into
27794 \begin_inset Flex Code
27795 status collapsed
27796
27797 \begin_layout Plain Layout
27798 lyxpipe.in
27799 \end_layout
27800
27801 \end_inset
27802
27803  and read back data from
27804 \begin_inset Flex Code
27805 status collapsed
27806
27807 \begin_layout Plain Layout
27808 lyxpipe.out
27809 \end_layout
27810
27811 \end_inset
27812
27813 .
27814  The stem of the pipe names can be defined in the
27815 \begin_inset Flex Noun
27816 status collapsed
27817
27818 \begin_layout Plain Layout
27819 Tools\SpecialChar menuseparator
27820 Preferences
27821 \end_layout
27822
27823 \end_inset
27824
27825  dialog,
27826  for example
27827 \begin_inset Flex Code
27828 status collapsed
27829
27830 \begin_layout Plain Layout
27831 "/home/myhome/lyxpipe"
27832 \end_layout
27833
27834 \end_inset
27835
27836 ,
27837  or
27838 \begin_inset Flex Code
27839 status collapsed
27840
27841 \begin_layout Plain Layout
27842 "
27843 \backslash
27844
27845 \backslash
27846 .
27847 \backslash
27848 pipe
27849 \backslash
27850 lyxpipe"
27851 \end_layout
27852
27853 \end_inset
27854
27855  on Windows (where any working path instead of lyxpipe can be used,
27856  for example
27857 \begin_inset Flex Code
27858 status collapsed
27859
27860 \begin_layout Plain Layout
27861 "
27862 \backslash
27863
27864 \backslash
27865 .
27866 \backslash
27867 pipe
27868 \backslash
27869 my
27870 \backslash
27871 lyx
27872 \backslash
27873 pipe"
27874 \end_layout
27875
27876 \end_inset
27877
27878  would also work).
27879  You
27880 \emph on
27881 must
27882 \emph default
27883  configure this manually in order for the server to start.
27884 \end_layout
27885
27886 \begin_layout Standard
27887 \SpecialChar LyX
27888  will add the '
27889 \begin_inset Flex Code
27890 status collapsed
27891
27892 \begin_layout Plain Layout
27893 .in
27894 \end_layout
27895
27896 \end_inset
27897
27898 ' and '
27899 \begin_inset Flex Code
27900 status collapsed
27901
27902 \begin_layout Plain Layout
27903 .out
27904 \end_layout
27905
27906 \end_inset
27907
27908 ' to create the pipes.
27909  If one of the pipes already exists,
27910  \SpecialChar LyX
27911  will assume that another \SpecialChar LyX
27912  process is already running and will not start the server.
27913  On POSIX (Unix like) systems,
27914  if for some other reason,
27915  an unused
27916 \begin_inset Quotes eld
27917 \end_inset
27918
27919 stale
27920 \begin_inset Quotes erd
27921 \end_inset
27922
27923  pipe is left in existence when \SpecialChar LyX
27924  closes,
27925  then \SpecialChar LyX
27926  will try to delete it.
27927  If this fails for some reason,
27928  you will need to delete the pipes manually and then restart \SpecialChar LyX
27929 .
27930  On Windows,
27931  pipes are deleted by the OS on program termination or crash,
27932  so
27933 \begin_inset Quotes eld
27934 \end_inset
27935
27936 stale
27937 \begin_inset Quotes erd
27938 \end_inset
27939
27940  pipes should not be possible.
27941 \end_layout
27942
27943 \begin_layout Standard
27944 To have several \SpecialChar LyX
27945  processes with servers at the same time,
27946  you have to use different configurations,
27947  perhaps by using separate user directories,
27948  each with its own
27949 \begin_inset Flex Code
27950 status collapsed
27951
27952 \begin_layout Plain Layout
27953 preferences
27954 \end_layout
27955
27956 \end_inset
27957
27958  file,
27959  for each process.
27960 \end_layout
27961
27962 \begin_layout Standard
27963 If you are developing a client program,
27964  you might find it useful to enable debugging information from the \SpecialChar LyX
27965  server.
27966  Do this by starting \SpecialChar LyX
27967  as
27968 \begin_inset Flex Code
27969 status collapsed
27970
27971 \begin_layout Plain Layout
27972 lyx -dbg lyxserver
27973 \end_layout
27974
27975 \end_inset
27976
27977 .
27978 \end_layout
27979
27980 \begin_layout Standard
27981 You can find a complete example client written in C++ in the source distribution as
27982 \begin_inset Flex Code
27983 status collapsed
27984
27985 \begin_layout Plain Layout
27986 development/lyxserver/server_monitor.cpp
27987 \end_layout
27988
27989 \end_inset
27990
27991 .
27992 \end_layout
27993
27994 \begin_layout Standard
27995 Another useful tool is the command-line based client found in
27996 \begin_inset Flex Code
27997 status collapsed
27998
27999 \begin_layout Plain Layout
28000 src/client/lyxclient
28001 \end_layout
28002
28003 \end_inset
28004
28005 .
28006 \end_layout
28007
28008 \begin_layout Section
28009 Normal communication
28010 \end_layout
28011
28012 \begin_layout Standard
28013 To issue a \SpecialChar LyX
28014  call,
28015  the client writes a line of ASCII text into the input pipe.
28016  This line has the following format:
28017 \end_layout
28018
28019 \begin_layout Quote
28020 LYXCMD:
28021 \emph on
28022 clientname
28023 \emph default
28024 :
28025 \emph on
28026 function
28027 \emph default
28028 :
28029 \emph on
28030 argument
28031 \end_layout
28032
28033 \begin_layout Description
28034 clientname is a name that the client can choose arbitrarily.
28035  Its only use is that \SpecialChar LyX
28036  will echo it if it sends an answer—
28037 so a client can dispatch results from different requesters.
28038 \end_layout
28039
28040 \begin_layout Description
28041 function is the function you want \SpecialChar LyX
28042  to perform.
28043  It is the same as the commands you'd use in the minibuffer.
28044 \end_layout
28045
28046 \begin_layout Description
28047 argument is an optional argument which is meaningful only to some functions (for instance,
28048  the
28049 \begin_inset Quotes eld
28050 \end_inset
28051
28052 self-insert
28053 \begin_inset Quotes erd
28054 \end_inset
28055
28056  LFUN will insert the argument as text at the cursor position).
28057 \end_layout
28058
28059 \begin_layout Standard
28060 The answer from \SpecialChar LyX
28061  will arrive in the output pipe and be of the form
28062 \end_layout
28063
28064 \begin_layout Quote
28065 INFO:
28066 \emph on
28067 clientname
28068 \emph default
28069 :
28070 \emph on
28071 function
28072 \emph default
28073 :
28074 \emph on
28075 data
28076 \end_layout
28077
28078 \begin_layout Standard
28079 where
28080 \emph on
28081 clientname
28082 \emph default
28083  and
28084 \emph on
28085 function
28086 \emph default
28087  are just echoed from the command request,
28088  while
28089 \emph on
28090 data
28091 \emph default
28092  is more or less useful information filled according to how the command execution worked out.
28093  Some commands,
28094  such as
28095 \begin_inset Quotes eld
28096 \end_inset
28097
28098 font-state
28099 \begin_inset Quotes erd
28100 \end_inset
28101
28102 ,
28103  will return information about the internal state of \SpecialChar LyX
28104 ,
28105  while other will return an empty data-response.
28106  This means that the command execution went fine.
28107 \end_layout
28108
28109 \begin_layout Standard
28110 In case of errors,
28111  the response from \SpecialChar LyX
28112  will have this form
28113 \end_layout
28114
28115 \begin_layout Quote
28116 ERROR:
28117 \emph on
28118 clientname
28119 \emph default
28120 :
28121 \emph on
28122 function
28123 \emph default
28124 :
28125 \emph on
28126 error message
28127 \end_layout
28128
28129 \begin_layout Standard
28130 where the
28131 \emph on
28132 error message
28133 \emph default
28134  should contain an explanation of why the command failed.
28135 \end_layout
28136
28137 \begin_layout Standard
28138 Examples:
28139 \end_layout
28140
28141 \begin_layout LyX-Code
28142 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
28143 \begin_inset Newline newline
28144 \end_inset
28145
28146 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
28147 \begin_inset Newline newline
28148 \end_inset
28149
28150 read a <~/.lyxpipe.out
28151 \begin_inset Newline newline
28152 \end_inset
28153
28154 echo $a
28155 \end_layout
28156
28157 \begin_layout Subsection
28158 AppleScript (Mac OS X)
28159 \end_layout
28160
28161 \begin_layout Standard
28162 Since \SpecialChar LyX
28163  2.1,
28164  \SpecialChar LyX
28165  supports basic interactions with AppleScript for normal communication through the command run.
28166  This command takes a direct argument (the
28167 \series bold
28168 function
28169 \series default
28170  to perform) and an optional argument.
28171  It either returns the output of the function or triggers an error with the error message and code.
28172 \end_layout
28173
28174 \begin_layout Standard
28175 Example:
28176 \end_layout
28177
28178 \begin_layout LyX-Code
28179 tell application "\SpecialChar LyX
28180 "
28181 \end_layout
28182
28183 \begin_layout LyX-Code
28184   try
28185 \end_layout
28186
28187 \begin_layout LyX-Code
28188     -- Stores the current file name into f
28189 \end_layout
28190
28191 \begin_layout LyX-Code
28192     set f to (run "server-get-filename" with argument "")
28193 \end_layout
28194
28195 \begin_layout LyX-Code
28196     on error the error_message number the error_number
28197 \end_layout
28198
28199 \begin_layout LyX-Code
28200       display dialog "Error:
28201  " & the error_number & ".
28202  " ¬
28203 \end_layout
28204
28205 \begin_layout LyX-Code
28206               & the error_message buttons {"OK"} default button 1
28207 \end_layout
28208
28209 \begin_layout LyX-Code
28210   end try
28211 \end_layout
28212
28213 \begin_layout LyX-Code
28214 end tell
28215 \end_layout
28216
28217 \begin_layout Section
28218 Notification
28219 \end_layout
28220
28221 \begin_layout Standard
28222 \SpecialChar LyX
28223  can notify clients of events going on asynchronously.
28224  Currently it will only do this if the user binds a key sequence with the function
28225 \begin_inset Quotes eld
28226 \end_inset
28227
28228 notify
28229 \begin_inset Quotes erd
28230 \end_inset
28231
28232 .
28233  The format of the string \SpecialChar LyX
28234  sends is as follows:
28235 \end_layout
28236
28237 \begin_layout Quote
28238 \begin_inset Flex Code
28239 status collapsed
28240
28241 \begin_layout Plain Layout
28242 NOTIFY:
28243 \end_layout
28244
28245 \end_inset
28246
28247
28248 \emph on
28249 key-sequence
28250 \end_layout
28251
28252 \begin_layout Standard
28253 where
28254 \emph on
28255 key-sequence
28256 \emph default
28257  is the printed representation of the key sequence that was actually typed by the user.
28258 \end_layout
28259
28260 \begin_layout Standard
28261 This mechanism can be used to extend \SpecialChar LyX
28262 's command set and implement macros.
28263  Bind some key sequence to
28264 \begin_inset Quotes eld
28265 \end_inset
28266
28267 notify
28268 \begin_inset Quotes erd
28269 \end_inset
28270
28271 .
28272  Then start a client that listens on the output pipe,
28273  dispatches the command according to the sequence,
28274  and starts a function that may use \SpecialChar LyX
28275  calls and \SpecialChar LyX
28276  requests to issue a command or a series of commands to \SpecialChar LyX
28277 .
28278 \end_layout
28279
28280 \begin_layout Section
28281 The simple \SpecialChar LyX
28282  Server Protocol
28283 \end_layout
28284
28285 \begin_layout Standard
28286 \SpecialChar LyX
28287  implements a simple protocol that can be used for session management.
28288  All messages are of the form
28289 \end_layout
28290
28291 \begin_layout Quote
28292 LYXSRV:
28293 \emph on
28294 clientname
28295 \emph default
28296 :
28297 \emph on
28298 protocol message
28299 \end_layout
28300
28301 \begin_layout Standard
28302 where
28303 \emph on
28304 protocol message
28305 \emph default
28306  can be
28307 \begin_inset Quotes eld
28308 \end_inset
28309
28310 hello
28311 \begin_inset Quotes erd
28312 \end_inset
28313
28314  or
28315 \begin_inset Quotes eld
28316 \end_inset
28317
28318 bye
28319 \begin_inset Quotes erd
28320 \end_inset
28321
28322 .
28323  If
28324 \begin_inset Quotes eld
28325 \end_inset
28326
28327 hello
28328 \begin_inset Quotes erd
28329 \end_inset
28330
28331  is received from a client,
28332  \SpecialChar LyX
28333  will report back to inform the client that it's listening to it's messages,
28334  while
28335 \begin_inset Quotes eld
28336 \end_inset
28337
28338 bye
28339 \begin_inset Quotes erd
28340 \end_inset
28341
28342  sent from \SpecialChar LyX
28343  will inform clients that \SpecialChar LyX
28344  is closing.
28345 \end_layout
28346
28347 \begin_layout Section
28348 Reverse DVI/PDF search
28349 \end_layout
28350
28351 \begin_layout Standard
28352 Some DVI/PDF viewers
28353 \begin_inset Foot
28354 status collapsed
28355
28356 \begin_layout Plain Layout
28357 The following viewers offer the reverse PDF search feature:
28358  Okular on KDE/Linux,
28359  Qpdfview on Unix,
28360  Skim on Mac OSX and SumatraPDF on Windows.
28361 \end_layout
28362
28363 \end_inset
28364
28365  provide
28366 \emph on
28367 reverse search
28368 \emph default
28369  facility (also called
28370 \emph on
28371 inverse search
28372 \emph default
28373 ).
28374  This means that you can tell \SpecialChar LyX
28375  to put the cursor to a specific line in the document by clicking at the respective position in the DVI/PDF output.
28376  To achieve this,
28377  the viewer must be able to communicate with \SpecialChar LyX
28378 .
28379  This is done via the \SpecialChar LyX
28380  server either by using the named pipe (
28381 \emph on
28382 lyxpipe
28383 \emph default
28384 ),
28385  or the UNIX domain socket (
28386 \emph on
28387 lyxsocket
28388 \emph default
28389 ) that \SpecialChar LyX
28390  creates in its temporary directory (this is the way the
28391 \begin_inset Flex Code
28392 status collapsed
28393
28394 \begin_layout Plain Layout
28395 lyxclient
28396 \end_layout
28397
28398 \end_inset
28399
28400  program communicates with \SpecialChar LyX
28401 ).
28402  In some cases,
28403  you need a helper script that mediates between the viewer and \SpecialChar LyX
28404 ,
28405  in others,
28406  the viewer can communicate with \SpecialChar LyX
28407  directly.
28408  This depends on the selected viewer and on your operating system.
28409  The same applies to the way viewers need to be configured and the way the reverse search is actually performed.
28410  In what follows,
28411  we will thus describe how to setup reverse search for specific viewers.
28412  Before we turn to this,
28413  though,
28414  we will explain what needs to be done generally to enable reverse search in the DVI/PDF output.
28415 \end_layout
28416
28417 \begin_layout Subsection
28418 Automatic setup
28419 \begin_inset CommandInset label
28420 LatexCommand label
28421 name "subsec:rev-search"
28422
28423 \end_inset
28424
28425
28426 \end_layout
28427
28428 \begin_layout Standard
28429 In most cases \SpecialChar LyX
28430  will do the work for you by pressing the following button in the toolbar:
28431
28432 \begin_inset Info
28433 type  "icon"
28434 arg   "buffer-toggle-output-sync"
28435 \end_inset
28436
28437 .
28438  Alternatively,
28439  you can also enable the feature by checking
28440 \family sans
28441 Synchronize with Output
28442 \family default
28443  in
28444 \begin_inset Flex Noun
28445 status collapsed
28446
28447 \begin_layout Plain Layout
28448 Document\SpecialChar menuseparator
28449 Settings\SpecialChar menuseparator
28450 Formats
28451 \end_layout
28452
28453 \end_inset
28454
28455 .
28456  In such a case \SpecialChar LyX
28457  will automatically insert the necessary Sync\SpecialChar TeX
28458  macro (for PDF) or load the srcltx package (for DVI) respectively.
28459  This option can be easily reached also on
28460 \begin_inset Flex Code
28461 status collapsed
28462
28463 \begin_layout Plain Layout
28464 View/Update
28465 \end_layout
28466
28467 \end_inset
28468
28469  Toolbar.
28470 \end_layout
28471
28472 \begin_layout Standard
28473 If you need a different setting,
28474  you can select or input a custom macro from the drop down box just below
28475 \begin_inset Flex Noun
28476 status collapsed
28477
28478 \begin_layout Plain Layout
28479 Document\SpecialChar menuseparator
28480 Settings\SpecialChar menuseparator
28481 Output\SpecialChar menuseparator
28482 Synchronize with Output
28483 \end_layout
28484
28485 \end_inset
28486
28487 .
28488 \end_layout
28489
28490 \begin_layout Standard
28491 Note that the method
28492 \begin_inset Flex Code
28493 status collapsed
28494
28495 \begin_layout Plain Layout
28496
28497 \backslash
28498 synctex=1
28499 \end_layout
28500
28501 \end_inset
28502
28503  enables gzip compression.
28504  If your viewer does not support it,
28505  you should instead use
28506 \begin_inset Flex Code
28507 status collapsed
28508
28509 \begin_layout Plain Layout
28510
28511 \backslash
28512 synctex=-1
28513 \end_layout
28514
28515 \end_inset
28516
28517 .
28518 \end_layout
28519
28520 \begin_layout Standard
28521 Please also note that including the
28522 \begin_inset Flex Code
28523 status collapsed
28524
28525 \begin_layout Plain Layout
28526 srcltx
28527 \end_layout
28528
28529 \end_inset
28530
28531  package or
28532 \begin_inset Flex Code
28533 status collapsed
28534
28535 \begin_layout Plain Layout
28536 src-specials
28537 \end_layout
28538
28539 \end_inset
28540
28541  sometimes has an undesired impact on the typesetting.
28542  Thus,
28543  you should switch output synchronization off for the final typesetting if you use the
28544 \begin_inset Flex Code
28545 status collapsed
28546
28547 \begin_layout Plain Layout
28548 srcltx
28549 \end_layout
28550
28551 \end_inset
28552
28553  package or
28554 \begin_inset Flex Code
28555 status collapsed
28556
28557 \begin_layout Plain Layout
28558 src-specials
28559 \end_layout
28560
28561 \end_inset
28562
28563 .
28564
28565 \end_layout
28566
28567 \begin_layout Standard
28568 In case you need some more special settings that are not covered by the automatic settings,
28569  read the next section about how to set up output synchronization manually.
28570  If the automatic setup suits your needs,
28571  you can readily jump to section
28572 \begin_inset space ~
28573 \end_inset
28574
28575
28576 \begin_inset CommandInset ref
28577 LatexCommand ref
28578 reference "subsec:configuring-viewers"
28579 nolink "false"
28580
28581 \end_inset
28582
28583 ,
28584  where the necessary configuration steps in your viewer – needed both with the automatic and the manual setup – are described.
28585 \end_layout
28586
28587 \begin_layout Subsection
28588 Manual setup
28589 \end_layout
28590
28591 \begin_layout Standard
28592 \SpecialChar LaTeX
28593  provides several different methods for reverse search.
28594  Some are built-in in the
28595 \begin_inset Flex Code
28596 status collapsed
28597
28598 \begin_layout Plain Layout
28599 latex/pdflatex
28600 \end_layout
28601
28602 \end_inset
28603
28604  program,
28605  some are provided by external packages.
28606  Your choice depends on whether your \SpecialChar LaTeX
28607  distribution already provides a given method (the built-in methods are rather new) and whether your viewer can cope with it.
28608  The available methods are described in the following.
28609 \end_layout
28610
28611 \begin_layout Subsubsection*
28612 Built-in DVI-search via src-specials (DVI only)
28613 \end_layout
28614
28615 \begin_layout Standard
28616 This method provides the DVI file with the necessary information for reverse search.
28617  It is available in \SpecialChar LaTeX
28618  since quite some time (any somewhat recent \SpecialChar LaTeX
28619  distribution should include it),
28620  and it works reliably.
28621  To enable it,
28622  change the
28623 \begin_inset Flex Noun
28624 status collapsed
28625
28626 \begin_layout Plain Layout
28627 La
28628 \family sans
28629 TeX
28630 \family default
28631  (plain)->DVI
28632 \end_layout
28633
28634 \end_inset
28635
28636  or
28637 \begin_inset Flex Noun
28638 status collapsed
28639
28640 \begin_layout Plain Layout
28641 La
28642 \family sans
28643 TeX
28644 \family default
28645  (plain)->DraftDVI
28646 \end_layout
28647
28648 \end_inset
28649
28650  converter in
28651 \begin_inset Flex Noun
28652 status collapsed
28653
28654 \begin_layout Plain Layout
28655 Preferences\SpecialChar menuseparator
28656 File Handling\SpecialChar menuseparator
28657 Converters
28658 \end_layout
28659
28660 \end_inset
28661
28662  to
28663 \begin_inset Flex Code
28664 status collapsed
28665
28666 \begin_layout Plain Layout
28667 latex -src-specials $$i
28668 \end_layout
28669
28670 \end_inset
28671
28672 .
28673  If this doesn't work,
28674  check if your \SpecialChar TeX
28675  engine needs different options (the syntax might differ in some distributions).
28676 \end_layout
28677
28678 \begin_layout Subsubsection*
28679 External Packages (PDFSync and scrltx)
28680 \end_layout
28681
28682 \begin_layout Standard
28683 The packages
28684 \emph on
28685 pdfsync
28686 \emph default
28687  and
28688 \emph on
28689 scrltx
28690 \emph default
28691  provide reverse search facility for PDF output (via pdflatex) and DVI output,
28692  respectively.
28693  In order to enable it,
28694  load the packages in the \SpecialChar LyX
28695  preamble:
28696
28697 \end_layout
28698
28699 \begin_layout Itemize
28700 \begin_inset Flex Code
28701 status collapsed
28702
28703 \begin_layout Plain Layout
28704
28705 \backslash
28706 usepackage{pdfsync}
28707 \end_layout
28708
28709 \end_inset
28710
28711  for reverse PDF search,
28712 \end_layout
28713
28714 \begin_layout Itemize
28715 \begin_inset Flex Code
28716 status collapsed
28717
28718 \begin_layout Plain Layout
28719
28720 \backslash
28721 usepackage[active]{srcltx}
28722 \end_layout
28723
28724 \end_inset
28725
28726  for reverse DVI search.
28727 \end_layout
28728
28729 \begin_layout Standard
28730 If you want to be able to perform both DVI and PDF reverse searches,
28731  you can also insert in the preamble the following lines
28732 \end_layout
28733
28734 \begin_layout LyX-Code
28735
28736 \backslash
28737 usepackage{ifpdf}
28738 \begin_inset Newline newline
28739 \end_inset
28740
28741
28742 \backslash
28743 ifpdf
28744 \begin_inset Newline newline
28745 \end_inset
28746
28747
28748 \backslash
28749 usepackage{pdfsync}
28750 \begin_inset Newline newline
28751 \end_inset
28752
28753
28754 \backslash
28755 else
28756 \begin_inset Newline newline
28757 \end_inset
28758
28759
28760 \backslash
28761 usepackage[active]{srcltx}
28762 \begin_inset Newline newline
28763 \end_inset
28764
28765
28766 \backslash
28767 fi
28768 \end_layout
28769
28770 \begin_layout Standard
28771 This way,
28772  you can preview the file as either DVI or PDF (pdflatex) and the right package will be used.
28773 \end_layout
28774
28775 \begin_layout Standard
28776 Note that PDFSync might affect the output layout of your document.
28777  It is therefore advised to disable PDFsync for final documents.
28778 \end_layout
28779
28780 \begin_layout Subsubsection*
28781 Built-in reverse search via Sync\SpecialChar TeX
28782  (DVI and PDF)
28783 \end_layout
28784
28785 \begin_layout Standard
28786 Recent versions of
28787 \begin_inset Flex Code
28788 status collapsed
28789
28790 \begin_layout Plain Layout
28791 (pdf)latex
28792 \end_layout
28793
28794 \end_inset
28795
28796  have built-in support for both PDF and DVI reverse search.
28797  This so-called
28798 \emph on
28799 Sync\SpecialChar TeX
28800
28801 \emph default
28802  facility is basically the result of the integration of the PDFSync package to the pdftex program and its merge with the
28803 \emph on
28804 scr-specials
28805 \emph default
28806  approach.
28807  You need at least \SpecialChar TeX
28808 Live 2008 or a recent Mik\SpecialChar TeX
28809  distribution in order to use it.
28810 \begin_inset Foot
28811 status collapsed
28812
28813 \begin_layout Plain Layout
28814 For some reason,
28815  Mik\SpecialChar TeX
28816  does not understand/obey the command \SpecialChar LyX
28817  inserts into the preamble when you check the "Enable Forward/Reverse Search" button in the toolbar and does not generate the necessary info.
28818 \end_layout
28819
28820 \begin_layout Plain Layout
28821 The generation of the required info can be forced by changing the converter "\SpecialChar LaTeX
28822  (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e.,
28823  by adding the -synctex=1 switch).
28824 \end_layout
28825
28826 \end_inset
28827
28828  Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
28829  Skim on the Mac,
28830  SumatraPDF on Windows;
28831  see the next section for details) already provide Sync\SpecialChar TeX
28832  support.
28833 \end_layout
28834
28835 \begin_layout Standard
28836 To enable Sync\SpecialChar TeX
28837  for DVI output,
28838  change the
28839 \begin_inset Flex Noun
28840 status collapsed
28841
28842 \begin_layout Plain Layout
28843 La
28844 \family sans
28845 TeX
28846 \family default
28847  (plain) -> DVI
28848 \end_layout
28849
28850 \end_inset
28851
28852  or
28853 \begin_inset Flex Noun
28854 status collapsed
28855
28856 \begin_layout Plain Layout
28857 La
28858 \family sans
28859 TeX
28860 \family default
28861  (plain) -> DraftDVI
28862 \end_layout
28863
28864 \end_inset
28865
28866  converter in
28867 \begin_inset Flex Noun
28868 status collapsed
28869
28870 \begin_layout Plain Layout
28871 Preferences\SpecialChar menuseparator
28872 File Handling\SpecialChar menuseparator
28873 Converters
28874 \end_layout
28875
28876 \end_inset
28877
28878  to
28879 \begin_inset Flex Code
28880 status collapsed
28881
28882 \begin_layout Plain Layout
28883 latex -synctex=1 $$i
28884 \end_layout
28885
28886 \end_inset
28887
28888 ,
28889  and for PDF output,
28890  change the
28891 \begin_inset Flex Noun
28892 status collapsed
28893
28894 \begin_layout Plain Layout
28895 La
28896 \family sans
28897 TeX
28898 \family default
28899  (pdflatex) -> PDF (pdflatex)
28900 \end_layout
28901
28902 \end_inset
28903
28904  converter to
28905 \begin_inset Flex Code
28906 status collapsed
28907
28908 \begin_layout Plain Layout
28909 pdflatex -synctex=1 $$i
28910 \end_layout
28911
28912 \end_inset
28913
28914 .
28915  Should your viewer not be considered in the following description,
28916  or in case of missing success,
28917  please check the documentation of your viewer whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
28918 .
28919 \begin_inset Foot
28920 status collapsed
28921
28922 \begin_layout Plain Layout
28923 Note that the option
28924 \begin_inset Flex Code
28925 status collapsed
28926
28927 \begin_layout Plain Layout
28928 -synctex=1
28929 \end_layout
28930
28931 \end_inset
28932
28933  option enables gzip compression.
28934  If your viewer does not support it,
28935  you should instead use
28936 \begin_inset Flex Code
28937 status collapsed
28938
28939 \begin_layout Plain Layout
28940 -synctex=-1
28941 \end_layout
28942
28943 \end_inset
28944
28945 .
28946 \end_layout
28947
28948 \end_inset
28949
28950
28951 \end_layout
28952
28953 \begin_layout Subsection
28954 Configuring and using specific viewers
28955 \begin_inset CommandInset label
28956 LatexCommand label
28957 name "subsec:configuring-viewers"
28958
28959 \end_inset
28960
28961
28962 \end_layout
28963
28964 \begin_layout Subsubsection*
28965 Xdvi (all platforms)
28966 \end_layout
28967
28968 \begin_layout Standard
28969 If you use
28970 \begin_inset Flex Code
28971 status collapsed
28972
28973 \begin_layout Plain Layout
28974 xdvi
28975 \end_layout
28976
28977 \end_inset
28978
28979 ,
28980  you don't need to do anything else for performing a reverse DVI search,
28981  as \SpecialChar LyX
28982  already provides the necessary hooks for automatically using the
28983 \begin_inset Flex Code
28984 status collapsed
28985
28986 \begin_layout Plain Layout
28987 lyxclient
28988 \end_layout
28989
28990 \end_inset
28991
28992  program.
28993  Just setup your document as described above (reverse search is triggered by Ctrl-click or Alt-click on Mac OSX,
28994  respectively).
28995 \end_layout
28996
28997 \begin_layout Standard
28998 However,
28999  if for whatever reason you want to use the named pipe instead of the socket for communicating with \SpecialChar LyX
29000 ,
29001  simply change the DVI viewer in
29002 \begin_inset Flex Noun
29003 status collapsed
29004
29005 \begin_layout Plain Layout
29006 Preferences\SpecialChar menuseparator
29007 File Handling\SpecialChar menuseparator
29008 File formats
29009 \end_layout
29010
29011 \end_inset
29012
29013  to
29014 \begin_inset Foot
29015 status collapsed
29016
29017 \begin_layout Plain Layout
29018 On Mac OSX you have to use
29019 \begin_inset Flex Code
29020 status collapsed
29021
29022 \begin_layout Plain Layout
29023 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
29024 \end_layout
29025
29026 \end_inset
29027
29028
29029 \end_layout
29030
29031 \end_inset
29032
29033
29034 \begin_inset Flex Code
29035 status collapsed
29036
29037 \begin_layout Plain Layout
29038 xdvi -editor "lyxeditor.sh %f %l"
29039 \end_layout
29040
29041 \end_inset
29042
29043 ,
29044  where
29045 \begin_inset Flex Code
29046 status collapsed
29047
29048 \begin_layout Plain Layout
29049 lyxeditor.sh
29050 \end_layout
29051
29052 \end_inset
29053
29054  is a suitable script.
29055  For example,
29056  a minimal shell script is the following one:
29057 \end_layout
29058
29059 \begin_layout LyX-Code
29060 #!/bin/sh
29061 \begin_inset Newline newline
29062 \end_inset
29063
29064 LYXPIPE="/path/to/lyxpipe"
29065 \begin_inset Newline newline
29066 \end_inset
29067
29068 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
29069 \begin_inset Newline newline
29070 \end_inset
29071
29072 echo "$COMMAND" > "${LYXPIPE}".in || exit
29073 \begin_inset Newline newline
29074 \end_inset
29075
29076 read TMP < "${LYXPIPE}".out || exit
29077 \end_layout
29078
29079 \begin_layout Standard
29080 where
29081 \begin_inset Flex Code
29082 status collapsed
29083
29084 \begin_layout Plain Layout
29085 /path/to/lyxpipe
29086 \end_layout
29087
29088 \end_inset
29089
29090  is the LyXServer pipe path specified in
29091 \begin_inset Flex Noun
29092 status collapsed
29093
29094 \begin_layout Plain Layout
29095 Preferences\SpecialChar menuseparator
29096 Paths
29097 \end_layout
29098
29099 \end_inset
29100
29101 .
29102 \begin_inset Foot
29103 status collapsed
29104
29105 \begin_layout Plain Layout
29106 In the
29107 \begin_inset Flex Code
29108 status collapsed
29109
29110 \begin_layout Plain Layout
29111 development/tools
29112 \end_layout
29113
29114 \end_inset
29115
29116  folder of a source distribution you can find a
29117 \begin_inset Flex Code
29118 status collapsed
29119
29120 \begin_layout Plain Layout
29121 lyxeditor
29122 \end_layout
29123
29124 \end_inset
29125
29126  script which is able to locate the
29127 \emph on
29128 lyxpipe
29129 \emph default
29130  based on your preferences.
29131 \end_layout
29132
29133 \end_inset
29134
29135
29136 \end_layout
29137
29138 \begin_layout Subsubsection*
29139 MacDviX (Mac OSX)
29140 \end_layout
29141
29142 \begin_layout Standard
29143 At the end of
29144 \begin_inset Flex Code
29145 status collapsed
29146
29147 \begin_layout Plain Layout
29148 /Applications/MacDviX_Folder/calleditor.script
29149 \end_layout
29150
29151 \end_inset
29152
29153 ,
29154  add the following lines:
29155 \end_layout
29156
29157 \begin_layout LyX-Code
29158 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
29159 \begin_inset Newline newline
29160 \end_inset
29161
29162 exit 1
29163 \end_layout
29164
29165 \begin_layout Standard
29166 Modify the lines accordingly if you install \SpecialChar LyX
29167  somewhere else than in the Applications folder.
29168 \end_layout
29169
29170 \begin_layout Standard
29171 Reverse search is triggered by Alt-click (OPTION-click).
29172 \end_layout
29173
29174 \begin_layout Subsubsection*
29175 Skim (Mac OSX)
29176 \end_layout
29177
29178 \begin_layout Standard
29179 Enter
29180 \begin_inset Flex Code
29181 status collapsed
29182
29183 \begin_layout Plain Layout
29184 open -a Skim.app $$i
29185 \end_layout
29186
29187 \end_inset
29188
29189  to the viewer setting in
29190 \begin_inset Flex Noun
29191 status collapsed
29192
29193 \begin_layout Plain Layout
29194 Preferences\SpecialChar menuseparator
29195 File Handling\SpecialChar menuseparator
29196 File formats\SpecialChar menuseparator
29197 PDF (pdflatex)
29198 \end_layout
29199
29200 \end_inset
29201
29202 ,
29203  and then in
29204 \begin_inset Flex Noun
29205 status collapsed
29206
29207 \begin_layout Plain Layout
29208 Skim\SpecialChar menuseparator
29209 Preferences\SpecialChar menuseparator
29210 Sync
29211 \end_layout
29212
29213 \end_inset
29214
29215  choose
29216 \begin_inset Flex Noun
29217 status collapsed
29218
29219 \begin_layout Plain Layout
29220 custom
29221 \end_layout
29222
29223 \end_inset
29224
29225  preset and enter command
29226 \begin_inset Flex Noun
29227 status collapsed
29228
29229 \begin_layout Plain Layout
29230 /Applications/\SpecialChar LyX
29231 .app/Contents/MacOS/lyxeditor
29232 \end_layout
29233
29234 \end_inset
29235
29236 .
29237 \end_layout
29238
29239 \begin_layout Standard
29240 Reverse search is triggered by COMMAND-SHIFT-click
29241 \end_layout
29242
29243 \begin_layout Subsubsection*
29244 Evince (GNOME)
29245 \end_layout
29246
29247 \begin_layout Standard
29248 Reverse search with evince does not work out of the box,
29249  but it can be achieved by means of some third party helper scripts.
29250  Please refer to
29251 \begin_inset CommandInset href
29252 LatexCommand href
29253 target "https://wiki.lyx.org/LyX/SyncTeX"
29254 literal "false"
29255
29256 \end_inset
29257
29258  for details.
29259 \end_layout
29260
29261 \begin_layout Subsubsection*
29262 Okular (KDE)
29263 \end_layout
29264
29265 \begin_layout Standard
29266 Go to
29267 \begin_inset Flex Noun
29268 status collapsed
29269
29270 \begin_layout Plain Layout
29271 Settings\SpecialChar menuseparator
29272 Configure Okular\SpecialChar menuseparator
29273 Editor
29274 \end_layout
29275
29276 \end_inset
29277
29278  and select LyX
29279 \begin_inset Quotes erd
29280 \end_inset
29281
29282  as editor.
29283  This inserts the appropriate command (
29284 \begin_inset Flex Code
29285 status collapsed
29286
29287 \begin_layout Plain Layout
29288 lyxclient -g %f %l
29289 \end_layout
29290
29291 \end_inset
29292
29293 ).
29294 \end_layout
29295
29296 \begin_layout Standard
29297 Reverse search is triggered by SHIFT-click.
29298
29299 \change_inserted -712698321 1578211026
29300  Note that this only works if Okular is in
29301 \begin_inset Quotes eld
29302 \end_inset
29303
29304 Browse
29305 \begin_inset Quotes erd
29306 \end_inset
29307
29308  mode (i.
29309 \begin_inset space \thinspace{}
29310 \end_inset
29311
29312 e.,
29313  the hand symbol is clicked).
29314 \change_unchanged
29315
29316 \end_layout
29317
29318 \begin_layout Subsubsection*
29319 Qpdfview (Unix)
29320 \end_layout
29321
29322 \begin_layout Standard
29323 Qpdfview supports Sync\SpecialChar TeX
29324  since version 0.3.5.
29325  Go to
29326 \begin_inset Flex Noun
29327 status collapsed
29328
29329 \begin_layout Plain Layout
29330 Edit\SpecialChar menuseparator
29331 Settings\SpecialChar menuseparator
29332 Behavior
29333 \end_layout
29334
29335 \end_inset
29336
29337 ,
29338  click on the input field of the
29339 \begin_inset Quotes eld
29340 \end_inset
29341
29342 Source editor
29343 \begin_inset Quotes erd
29344 \end_inset
29345
29346  item and add the command
29347 \begin_inset Flex Code
29348 status collapsed
29349
29350 \begin_layout Plain Layout
29351 lyxclient -g %1 %2
29352 \end_layout
29353
29354 \end_inset
29355
29356 .
29357 \end_layout
29358
29359 \begin_layout Standard
29360 Reverse search is triggered by double-click or,
29361  in more recent versions,
29362  by context menu.
29363 \end_layout
29364
29365 \begin_layout Subsubsection*
29366 YAP (Windows)
29367 \end_layout
29368
29369 \begin_layout Standard
29370 Launch yap,
29371  choose its
29372 \begin_inset Flex Noun
29373 status collapsed
29374
29375 \begin_layout Plain Layout
29376 View\SpecialChar menuseparator
29377 Options
29378 \end_layout
29379
29380 \end_inset
29381
29382  menu and select the
29383 \begin_inset Quotes eld
29384 \end_inset
29385
29386 Inverse DVI Search
29387 \begin_inset Quotes erd
29388 \end_inset
29389
29390  tab.
29391  Click on the
29392 \begin_inset Quotes eld
29393 \end_inset
29394
29395 New\SpecialChar ldots
29396
29397 \begin_inset Quotes erd
29398 \end_inset
29399
29400  button and,
29401  in the window that opens,
29402  enter
29403 \begin_inset Quotes eld
29404 \end_inset
29405
29406 \SpecialChar LyX
29407  Editor
29408 \begin_inset Quotes erd
29409 \end_inset
29410
29411  (or any other name you like) in the
29412 \begin_inset Quotes eld
29413 \end_inset
29414
29415 Name:
29416 \begin_inset Quotes erd
29417 \end_inset
29418
29419  field.
29420  Now click on the button labeled
29421 \begin_inset Quotes eld
29422 \end_inset
29423
29424 \SpecialChar ldots
29425
29426 \begin_inset Quotes erd
29427 \end_inset
29428
29429  to open a file dialog and navigate to the directory containing the batch file
29430 \begin_inset Flex Code
29431 status collapsed
29432
29433 \begin_layout Plain Layout
29434 lyxeditor.bat
29435 \end_layout
29436
29437 \end_inset
29438
29439  (see below).
29440  Select
29441 \begin_inset Flex Code
29442 status collapsed
29443
29444 \begin_layout Plain Layout
29445 lyxeditor.bat
29446 \end_layout
29447
29448 \end_inset
29449
29450  and then specify the program arguments as
29451 \begin_inset Flex Code
29452 status collapsed
29453
29454 \begin_layout Plain Layout
29455 %f %l
29456 \end_layout
29457
29458 \end_inset
29459
29460 .
29461  The
29462 \begin_inset Flex Code
29463 status collapsed
29464
29465 \begin_layout Plain Layout
29466 lyxeditor.bat
29467 \end_layout
29468
29469 \end_inset
29470
29471  wrapper is used for communicating with \SpecialChar LyX
29472  through the
29473 \emph on
29474 lyxpipe
29475 \emph default
29476  and is as follows:
29477 \end_layout
29478
29479 \begin_layout LyX-Code
29480 @echo off
29481 \begin_inset Newline newline
29482 \end_inset
29483
29484 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
29485 \backslash
29486
29487 \backslash
29488 .
29489 \backslash
29490 pipe
29491 \backslash
29492 lyxpipe.in
29493 \begin_inset Newline newline
29494 \end_inset
29495
29496 type
29497 \backslash
29498
29499 \backslash
29500 .
29501 \backslash
29502 pipe
29503 \backslash
29504 lyxpipe.out
29505 \end_layout
29506
29507 \begin_layout Standard
29508 Make sure that the \SpecialChar LyX
29509 Server pipe path you specified in \SpecialChar LyX
29510  is
29511 \begin_inset Flex Code
29512 status collapsed
29513
29514 \begin_layout Plain Layout
29515
29516 \backslash
29517
29518 \backslash
29519 .
29520 \backslash
29521 pipe
29522 \backslash
29523 lyxpipe
29524 \end_layout
29525
29526 \end_inset
29527
29528 ,
29529  otherwise change the
29530 \begin_inset Flex Code
29531 status collapsed
29532
29533 \begin_layout Plain Layout
29534 lyxeditor.bat
29535 \end_layout
29536
29537 \end_inset
29538
29539  wrapper accordingly.
29540 \end_layout
29541
29542 \begin_layout Standard
29543 In yap,
29544  reverse search is triggered by double-click.
29545 \end_layout
29546
29547 \begin_layout Subsubsection*
29548 SumatraPDF (Windows)
29549 \end_layout
29550
29551 \begin_layout Standard
29552 In order to use SumatraPDF for inverse search,
29553  enter
29554 \begin_inset Flex Code
29555 status collapsed
29556
29557 \begin_layout Plain Layout
29558 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
29559 \end_layout
29560
29561 \end_inset
29562
29563  in the viewer setting in
29564 \begin_inset Flex Noun
29565 status collapsed
29566
29567 \begin_layout Plain Layout
29568 Preferences\SpecialChar menuseparator
29569 File Handling\SpecialChar menuseparator
29570 File formats\SpecialChar menuseparator
29571 PDF (pdflatex)
29572 \end_layout
29573
29574 \end_inset
29575
29576 ,
29577  where
29578 \begin_inset Flex Code
29579 status collapsed
29580
29581 \begin_layout Plain Layout
29582 lyxeditor.bat
29583 \end_layout
29584
29585 \end_inset
29586
29587  is the previous wrapper.
29588  If SumatraPDF.exe is not in your command PATH,
29589  use its full file name.
29590 \end_layout
29591
29592 \begin_layout Standard
29593 Reverse search is triggered by double-click.
29594 \end_layout
29595
29596 \begin_layout Subsubsection*
29597 YAP (Cygwin)
29598 \end_layout
29599
29600 \begin_layout Standard
29601 First of all,
29602  make sure that yap is your default DVI viewer in the Windows environment,
29603  then launch it,
29604  choose its
29605 \begin_inset Flex Noun
29606 status collapsed
29607
29608 \begin_layout Plain Layout
29609 View\SpecialChar menuseparator
29610 Options
29611 \end_layout
29612
29613 \end_inset
29614
29615  menu and select the
29616 \begin_inset Quotes eld
29617 \end_inset
29618
29619 Inverse DVI Search
29620 \begin_inset Quotes erd
29621 \end_inset
29622
29623  tab.
29624  Click on the
29625 \begin_inset Quotes eld
29626 \end_inset
29627
29628 New\SpecialChar ldots
29629
29630 \begin_inset Quotes erd
29631 \end_inset
29632
29633  button and,
29634  in the window that opens,
29635  enter
29636 \begin_inset Quotes eld
29637 \end_inset
29638
29639 \SpecialChar LyX
29640  Editor
29641 \begin_inset Quotes erd
29642 \end_inset
29643
29644  (or any other name you like) in the
29645 \begin_inset Quotes eld
29646 \end_inset
29647
29648 Name:
29649 \begin_inset Quotes erd
29650 \end_inset
29651
29652  field.
29653  Now click on the button labeled
29654 \begin_inset Quotes eld
29655 \end_inset
29656
29657 \SpecialChar ldots
29658
29659 \begin_inset Quotes erd
29660 \end_inset
29661
29662  to open a file dialog and navigate to the directory containing the
29663 \begin_inset Flex Code
29664 status collapsed
29665
29666 \begin_layout Plain Layout
29667 lyxeditor.exe
29668 \end_layout
29669
29670 \end_inset
29671
29672  program (which is installed by default on Cygwin along with the \SpecialChar LyX
29673  executable).
29674  Select
29675 \begin_inset Flex Code
29676 status collapsed
29677
29678 \begin_layout Plain Layout
29679 lyxeditor.exe
29680 \end_layout
29681
29682 \end_inset
29683
29684  and then specify the program arguments as
29685 \begin_inset Flex Code
29686 status collapsed
29687
29688 \begin_layout Plain Layout
29689 -g %f %l
29690 \end_layout
29691
29692 \end_inset
29693
29694 .
29695  In this way,
29696  you will be using the
29697 \emph on
29698 lyxsocket
29699 \emph default
29700  for communicating with \SpecialChar LyX
29701 .
29702  If,
29703  for whatever reason,
29704  you want to use the
29705 \emph on
29706 lyxpipe
29707 \emph default
29708 ,
29709  omit the
29710 \begin_inset Flex Code
29711 status collapsed
29712
29713 \begin_layout Plain Layout
29714 -g
29715 \end_layout
29716
29717 \end_inset
29718
29719  option and be sure to specify the \SpecialChar LyX
29720 Server pipe path in the \SpecialChar LyX
29721  preferences.
29722 \end_layout
29723
29724 \begin_layout Standard
29725 In yap,
29726  reverse search is triggered by double-click.
29727 \end_layout
29728
29729 \begin_layout Subsubsection*
29730 SumatraPDF (Cygwin)
29731 \end_layout
29732
29733 \begin_layout Standard
29734 In order to use SumatraPDF for inverse search,
29735  enter
29736 \begin_inset Flex Code
29737 status collapsed
29738
29739 \begin_layout Plain Layout
29740 SumatraPDF -inverse-search "lyxeditor -g %f %l"
29741 \end_layout
29742
29743 \end_inset
29744
29745  in the viewer setting in
29746 \begin_inset Flex Noun
29747 status collapsed
29748
29749 \begin_layout Plain Layout
29750 Preferences\SpecialChar menuseparator
29751 File Handling\SpecialChar menuseparator
29752 File formats\SpecialChar menuseparator
29753 PDF (pdflatex)
29754 \end_layout
29755
29756 \end_inset
29757
29758 .
29759  If SumatraPDF.exe is not in your command PATH,
29760  use its full posix path.
29761  The
29762 \begin_inset Flex Code
29763 status collapsed
29764
29765 \begin_layout Plain Layout
29766 -g
29767 \end_layout
29768
29769 \end_inset
29770
29771  enables communication via the
29772 \emph on
29773 lyxsocket
29774 \emph default
29775 .
29776  Again,
29777  omit the
29778 \begin_inset Flex Code
29779 status collapsed
29780
29781 \begin_layout Plain Layout
29782 -g
29783 \end_layout
29784
29785 \end_inset
29786
29787  option if you want to use the
29788 \emph on
29789 lyxpipe
29790 \emph default
29791 ,
29792  and be sure to specify the \SpecialChar LyX
29793 Server pipe path in the \SpecialChar LyX
29794  preferences.
29795 \end_layout
29796
29797 \begin_layout Standard
29798 Reverse search is triggered by double-click.
29799 \end_layout
29800
29801 \begin_layout Section
29802 Forward search
29803 \end_layout
29804
29805 \begin_layout Standard
29806 Forward search is,
29807  as the name implies,
29808  in a sense the
29809 \begin_inset Quotes eld
29810 \end_inset
29811
29812 opposite
29813 \begin_inset Quotes erd
29814 \end_inset
29815
29816  of reverse search.
29817  It allows you to let the viewer jump to a given position from within \SpecialChar LyX
29818 .
29819  If forward search is set up (as described in what follows),
29820  you can put the cursor anywhere in your \SpecialChar LyX
29821  document,
29822  and hit
29823 \begin_inset Flex Noun
29824 status collapsed
29825
29826 \begin_layout Plain Layout
29827 Navigate\SpecialChar menuseparator
29828 Forward search
29829 \end_layout
29830
29831 \end_inset
29832
29833  (or select
29834 \begin_inset Flex Noun
29835 status collapsed
29836
29837 \begin_layout Plain Layout
29838 Forward search
29839 \end_layout
29840
29841 \end_inset
29842
29843  in the context menu via right mouse click),
29844  and then the viewer will jump to that position as well.
29845  This implies,
29846  of course,
29847  that your viewer supports this function.
29848 \end_layout
29849
29850 \begin_layout Standard
29851 To make forward search possible,
29852  you first need to provide the generated output PDF/DVI file with additional information about the \SpecialChar TeX
29853  sources.
29854  This can be done via the methods described in the section
29855 \begin_inset CommandInset ref
29856 LatexCommand ref
29857 reference "subsec:rev-search"
29858 nolink "false"
29859
29860 \end_inset
29861
29862 .
29863 \end_layout
29864
29865 \begin_layout Standard
29866 Additionally,
29867  you need to configure \SpecialChar LyX
29868  for using your viewers in
29869 \begin_inset Flex Noun
29870 status collapsed
29871
29872 \begin_layout Plain Layout
29873 Tools\SpecialChar menuseparator
29874 Preferences\SpecialChar menuseparator
29875 Output\SpecialChar menuseparator
29876 General
29877 \end_layout
29878
29879 \end_inset
29880
29881 .
29882  We provide a range of tested configurations for some viewers,
29883  which you can select from the drop down list.
29884  If none of these configurations suits you,
29885  you have to find out and enter a suitable configuration yourself.
29886  The definition syntax uses the following placeholders:
29887 \end_layout
29888
29889 \begin_layout Itemize
29890 \noindent
29891 \begin_inset Flex Code
29892 status collapsed
29893
29894 \begin_layout Plain Layout
29895 $$n
29896 \end_layout
29897
29898 \end_inset
29899
29900 :
29901  row number
29902 \end_layout
29903
29904 \begin_layout Itemize
29905 \noindent
29906 \begin_inset Flex Code
29907 status collapsed
29908
29909 \begin_layout Plain Layout
29910 $$t
29911 \end_layout
29912
29913 \end_inset
29914
29915 :
29916  name of the (temporary) exported .tex file (without path)
29917 \end_layout
29918
29919 \begin_layout Itemize
29920 \noindent
29921 \begin_inset Flex Code
29922 status collapsed
29923
29924 \begin_layout Plain Layout
29925 $$f
29926 \end_layout
29927
29928 \end_inset
29929
29930 :
29931  name of the (temporary) exported .tex file (including path)
29932 \end_layout
29933
29934 \begin_layout Itemize
29935 \noindent
29936 \begin_inset Flex Code
29937 status collapsed
29938
29939 \begin_layout Plain Layout
29940 $$o
29941 \end_layout
29942
29943 \end_inset
29944
29945 :
29946  name of the exported output file (either dvi or pdf,
29947  depending on which one exists in the temporary directory)
29948 \end_layout
29949
29950 \begin_layout Standard
29951 Note that only some of the viewers provide full and usable forward search functionality out of the box,
29952  among them yap,
29953  xdvi,
29954  okular
29955 \begin_inset Foot
29956 status collapsed
29957
29958 \begin_layout Plain Layout
29959 You might want to set
29960 \begin_inset Flex Code
29961 status collapsed
29962
29963 \begin_layout Plain Layout
29964 okular --unique
29965 \end_layout
29966
29967 \end_inset
29968
29969  in
29970 \begin_inset Flex Noun
29971 status collapsed
29972
29973 \begin_layout Plain Layout
29974 Tools\SpecialChar menuseparator
29975 Preferences\SpecialChar menuseparator
29976 File Handling\SpecialChar menuseparator
29977 File
29978 \begin_inset space ~
29979 \end_inset
29980
29981 Formats
29982 \end_layout
29983
29984 \end_inset
29985
29986
29987 \end_layout
29988
29989 \end_inset
29990
29991 ,
29992  qpdfview,
29993  and SumatraPDF
29994 \begin_inset Foot
29995 status collapsed
29996
29997 \begin_layout Plain Layout
29998 SumatraPDF can also use DDE commands through the external program CMCDDE —
29999  downloadable from
30000 \begin_inset CommandInset href
30001 LatexCommand href
30002 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
30003 literal "false"
30004
30005 \end_inset
30006
30007
30008 \end_layout
30009
30010 \end_inset
30011
30012 .
30013  Others,
30014  such as evince
30015 \begin_inset Foot
30016 status collapsed
30017
30018 \begin_layout Plain Layout
30019 Forward search with evince can be achieved by means of third party helper scripts.
30020  Please refer to
30021 \begin_inset CommandInset href
30022 LatexCommand href
30023 target "https://wiki.lyx.org/LyX/SyncTeX"
30024 literal "false"
30025
30026 \end_inset
30027
30028  for details.
30029 \end_layout
30030
30031 \end_inset
30032
30033 ,
30034  require some extra tools in order to use forward search.
30035  While many of the widespread PDF viewers (most notably Adobe Reader) do not support forward search at all,
30036  some other viewers – e.
30037 \begin_inset space \thinspace{}
30038 \end_inset
30039
30040 g.
30041  xpdf – allow at least to reload the document and jump to a specific page of the file,
30042  so you can at least navigate
30043 \begin_inset Quotes eld
30044 \end_inset
30045
30046 near
30047 \begin_inset Quotes erd
30048 \end_inset
30049
30050 .
30051  This latter functionality is provided by an external call of synctex (see the predefined example configurations).
30052
30053 \end_layout
30054
30055 \begin_layout Standard
30056 Forward search works both with DVI and PDF output.
30057  \SpecialChar LyX
30058  simply checks which preview format you have used before (i.
30059 \begin_inset space \thinspace{}
30060 \end_inset
30061
30062 e.,
30063  which format is already there in the temporary directory) and chooses the appropriate configuration for the respective format.
30064 \change_deleted 564990737 1672743015
30065
30066 \end_layout
30067
30068 \begin_layout Standard
30069
30070 \change_deleted 564990737 1672743015
30071 Special Document Classes
30072 \end_layout
30073
30074 \begin_layout Standard
30075
30076 \change_deleted 564990737 1669742044
30077 A&A Paper
30078 \end_layout
30079
30080 \begin_layout Standard
30081
30082 \change_deleted 564990737 1669742044
30083 by
30084 \noun on
30085 Peter Sütterlin
30086 \end_layout
30087
30088 \begin_layout Standard
30089
30090 \change_deleted 564990737 1669742044
30091 Introduction
30092 \end_layout
30093
30094 \begin_layout Standard
30095
30096 \change_deleted 564990737 1669742044
30097 This section describes how \SpecialChar LyX
30098  can be used to write articles for submission to the scientific journal
30099 \emph on
30100 Astronomy and Astrophysics
30101 \emph default
30102  (
30103 \begin_inset Flex URL
30104 status collapsed
30105
30106 \begin_layout Plain Layout
30107
30108 https://www.aanda.org/
30109 \end_layout
30110
30111 \end_inset
30112
30113 ) using Version 5.01 of the document class
30114 \family typewriter
30115 aa.cls
30116 \family default
30117 .
30118  This package can be downloaded from the ftp site
30119 \end_layout
30120
30121 \begin_layout Standard
30122
30123 \change_deleted 564990737 1669742044
30124 \begin_inset VSpace medskip
30125 \end_inset
30126
30127
30128 \end_layout
30129
30130 \begin_layout Standard
30131 \align center
30132
30133 \change_deleted 564990737 1669742044
30134 \begin_inset Flex URL
30135 status collapsed
30136
30137 \begin_layout Plain Layout
30138
30139 ftp://ftp.edpsciences.org/pub/aa/readme.html
30140 \end_layout
30141
30142 \end_inset
30143
30144
30145 \end_layout
30146
30147 \begin_layout Standard
30148
30149 \change_deleted 564990737 1669742044
30150 \begin_inset VSpace medskip
30151 \end_inset
30152
30153
30154 \end_layout
30155
30156 \begin_layout Standard
30157
30158 \change_deleted 564990737 1669742044
30159 A manual comes together with that package,
30160  and this text is not meant to replace the original manual but is merely a short guide in how to realize the correct form of your paper.
30161
30162 \end_layout
30163
30164 \begin_layout Standard
30165
30166 \change_deleted 564990737 1669742044
30167 Please note that the publisher of the journal was changed from Springer to EDP Sciences starting January 1,
30168  2001.
30169  That change involved also some slight changes to the style files,
30170  namely the removal of the thesaurus command.
30171  The \SpecialChar LyX
30172  class aa supports the newest version of these style files,
30173  V 5.01.
30174  If you have an older version installed,
30175  please upgrade.
30176  For compatibility,
30177  the old (version 4) layout has been kept as
30178 \family sans
30179 article (A&A V4)
30180 \family default
30181 .
30182  Please refer to the comments in
30183 \family typewriter
30184 \SpecialChar LyX
30185 Dir/layouts/aapaper.layout
30186 \family default
30187 .
30188 \end_layout
30189
30190 \begin_layout Standard
30191
30192 \change_deleted 564990737 1669742044
30193 Getting started
30194 \end_layout
30195
30196 \begin_layout Standard
30197
30198 \change_deleted 564990737 1669742044
30199 It is recommended you start from the example template distributed with \SpecialChar LyX
30200 .
30201  If you are not using a template,
30202  note the following settings:
30203 \end_layout
30204
30205 \begin_layout Itemize
30206
30207 \change_deleted 564990737 1669742044
30208 Select
30209 \family sans
30210 article (A&A)
30211 \family default
30212  in the
30213 \family sans
30214 Document\SpecialChar menuseparator
30215 Settings
30216 \family default
30217  dialog (OK,
30218  that one was obvious).
30219 \end_layout
30220
30221 \begin_layout Itemize
30222
30223 \change_deleted 564990737 1669742044
30224 Don't change the option
30225 \family sans
30226 Page
30227 \begin_inset space ~
30228 \end_inset
30229
30230 style
30231 \family default
30232 :
30233  Leave it set to
30234 \family sans
30235 default
30236 \family default
30237 .
30238  The whole layout is done by the macros,
30239  you shouldn't change anything.
30240 \end_layout
30241
30242 \begin_layout Standard
30243
30244 \change_deleted 564990737 1669742044
30245 The header block
30246 \end_layout
30247
30248 \begin_layout Standard
30249
30250 \change_deleted 564990737 1669742044
30251 First thing to enter is the header information.
30252  It consists of seven entries,
30253  of which some are optional.
30254  They are
30255 \end_layout
30256
30257 \begin_layout Itemize
30258
30259 \change_deleted 564990737 1669742044
30260
30261 \family sans
30262 Title
30263 \family default
30264 :
30265  [required]
30266 \end_layout
30267
30268 \begin_layout Itemize
30269
30270 \change_deleted 564990737 1669742044
30271
30272 \family sans
30273 Subtitle
30274 \family default
30275 :
30276  [optional]
30277 \end_layout
30278
30279 \begin_layout Itemize
30280
30281 \change_deleted 564990737 1669742044
30282
30283 \family sans
30284 Author
30285 \family default
30286 :
30287  [required]
30288 \end_layout
30289
30290 \begin_layout Itemize
30291
30292 \change_deleted 564990737 1669742044
30293
30294 \family sans
30295 Address
30296 \family default
30297 :
30298  [required]
30299 \end_layout
30300
30301 \begin_layout Itemize
30302
30303 \change_deleted 564990737 1669742044
30304
30305 \family sans
30306 Offprints
30307 \family default
30308 :
30309  [optional] if more than one author:
30310  whom to contact for offprint requests.
30311 \end_layout
30312
30313 \begin_layout Itemize
30314
30315 \change_deleted 564990737 1669742044
30316
30317 \family sans
30318 Mail
30319 \family default
30320 :
30321  [optional] mail address for contacts.
30322 \end_layout
30323
30324 \begin_layout Itemize
30325
30326 \change_deleted 564990737 1669742044
30327
30328 \family sans
30329 Date
30330 \family default
30331 :
30332  [required].
30333  Suggested format is
30334 \family typewriter
30335 Received:
30336  <date>;
30337  Accepted <date>
30338 \end_layout
30339
30340 \begin_layout Standard
30341
30342 \change_deleted 564990737 1669742044
30343 There is no need to issue the
30344 \family typewriter
30345
30346 \backslash
30347 maketitle
30348 \family default
30349  command,
30350  this is done automatically by \SpecialChar LyX
30351  when the header is finished.
30352  Although the order of the single header entries doesn't matter it is advised to keep the above sequence,
30353  just to get the best optics and meets the layout of the real document.
30354 \end_layout
30355
30356 \begin_layout Standard
30357
30358 \change_deleted 564990737 1669742044
30359 If you want to place footnotes in the header block,
30360  e.
30361 \begin_inset space \thinspace{}
30362 \end_inset
30363
30364 g.
30365 \begin_inset space \space{}
30366 \end_inset
30367
30368 to state your present address,
30369  just use the standard footnote via the menu
30370 \family sans
30371 Insert\SpecialChar menuseparator
30372 Footnote.
30373
30374 \family default
30375  \SpecialChar LyX
30376  will automagically use the term
30377 \family typewriter
30378
30379 \backslash
30380 thanks{}
30381 \family default
30382  in that case.
30383 \end_layout
30384
30385 \begin_layout Standard
30386
30387 \change_deleted 564990737 1669742044
30388 Under
30389 \family sans
30390 Edit\SpecialChar menuseparator
30391 Text Style
30392 \family default
30393 ,
30394  you'll find two insets which are relevant for the titling:
30395 \end_layout
30396
30397 \begin_layout Itemize
30398
30399 \change_deleted 564990737 1669742044
30400
30401 \family sans
30402 Institute
30403 \family typewriter
30404
30405 \family default
30406 to mark corresponding author\SpecialChar breakableslash
30407 institute pairs.
30408  The institutes are numbered sequentially as they appear in the
30409 \family sans
30410 Address
30411 \family default
30412  field,
30413  so you have to put a marker to each author.
30414 \end_layout
30415
30416 \begin_layout Itemize
30417
30418 \change_deleted 564990737 1669742044
30419
30420 \family sans
30421 Email
30422 \family default
30423  to supply an email address for fast contact.
30424 \end_layout
30425
30426 \begin_layout Standard
30427
30428 \change_deleted 564990737 1669742044
30429 In addition to these topics,
30430  the macros use one additional \SpecialChar LaTeX
30431  command that has no counterpart in \SpecialChar LyX
30432 :
30433 \end_layout
30434
30435 \begin_layout Itemize
30436
30437 \change_deleted 564990737 1669742044
30438
30439 \family typewriter
30440
30441 \backslash
30442 and
30443 \family default
30444  to separate different names for more than one author and institute,
30445  respectively.
30446 \end_layout
30447
30448 \begin_layout Standard
30449
30450 \change_deleted 564990737 1669742044
30451 The appropriate command has to be entered in \SpecialChar LyX
30452  and marked as \SpecialChar LaTeX
30453  code.
30454  See the examples.
30455
30456 \end_layout
30457
30458 \begin_layout Standard
30459
30460 \change_deleted 564990737 1669742044
30461 The abstract
30462 \end_layout
30463
30464 \begin_layout Standard
30465
30466 \change_deleted 564990737 1669742044
30467 The abstract should immediately follow the header block.
30468  With version 5 the abstract environment was changed to a command,
30469  and there is now a restriction to only one paragraph.
30470  In addition,
30471  it should contain an entry with the keywords.
30472  This is done via the paragraph style
30473 \family sans
30474 Keywords
30475 \family default
30476 .
30477  Refer to the example paper.
30478 \end_layout
30479
30480 \begin_layout Standard
30481
30482 \change_deleted 564990737 1669742044
30483 Supported environments
30484 \end_layout
30485
30486 \begin_layout Standard
30487
30488 \change_deleted 564990737 1669742044
30489 The A&A paper layout supports the following environments for structuring your text:
30490 \end_layout
30491
30492 \begin_layout Itemize
30493
30494 \change_deleted 564990737 1669742044
30495
30496 \family sans
30497 Standard
30498 \end_layout
30499
30500 \begin_layout Itemize
30501
30502 \change_deleted 564990737 1669742044
30503
30504 \family sans
30505 Section
30506 \end_layout
30507
30508 \begin_layout Itemize
30509
30510 \change_deleted 564990737 1669742044
30511
30512 \family sans
30513 Subsection
30514 \end_layout
30515
30516 \begin_layout Itemize
30517
30518 \change_deleted 564990737 1669742044
30519
30520 \family sans
30521 Subsubsection
30522 \end_layout
30523
30524 \begin_layout Itemize
30525
30526 \change_deleted 564990737 1669742044
30527
30528 \family sans
30529 Itemize
30530 \end_layout
30531
30532 \begin_layout Itemize
30533
30534 \change_deleted 564990737 1669742044
30535
30536 \family sans
30537 Enumerate
30538 \end_layout
30539
30540 \begin_layout Itemize
30541
30542 \change_deleted 564990737 1669742044
30543
30544 \family sans
30545 Description
30546 \end_layout
30547
30548 \begin_layout Itemize
30549
30550 \change_deleted 564990737 1669742044
30551
30552 \family sans
30553 Caption
30554 \end_layout
30555
30556 \begin_layout Itemize
30557
30558 \change_deleted 564990737 1669742044
30559
30560 \family sans
30561 Abstract
30562 \end_layout
30563
30564 \begin_layout Itemize
30565
30566 \change_deleted 564990737 1669742044
30567
30568 \family sans
30569 Acknowledgment
30570 \end_layout
30571
30572 \begin_layout Itemize
30573
30574 \change_deleted 564990737 1669742044
30575
30576 \family sans
30577 Bibliography
30578 \end_layout
30579
30580 \begin_layout Itemize
30581
30582 \change_deleted 564990737 1669742044
30583
30584 \family sans
30585 \SpecialChar LaTeX
30586
30587 \end_layout
30588
30589 \begin_layout Standard
30590
30591 \change_deleted 564990737 1669742044
30592 Commands not supported by \SpecialChar LyX
30593
30594 \end_layout
30595
30596 \begin_layout Standard
30597
30598 \change_deleted 564990737 1669742044
30599 Some commands are not yet supported by the
30600 \family sans
30601 paper (A&A)
30602 \family default
30603  layout for \SpecialChar LyX
30604 .
30605  Some have already been mentioned.
30606  For the sake of completeness,
30607  they are listed all together here:
30608 \end_layout
30609
30610 \begin_layout Itemize
30611
30612 \change_deleted 564990737 1669742044
30613
30614 \family typewriter
30615
30616 \backslash
30617 and
30618 \end_layout
30619
30620 \begin_layout Itemize
30621
30622 \change_deleted 564990737 1669742044
30623
30624 \family typewriter
30625
30626 \backslash
30627 authorrunning
30628 \end_layout
30629
30630 \begin_layout Itemize
30631
30632 \change_deleted 564990737 1669742044
30633
30634 \family typewriter
30635
30636 \backslash
30637 object{}
30638 \end_layout
30639
30640 \begin_layout Itemize
30641
30642 \change_deleted 564990737 1669742044
30643
30644 \family typewriter
30645
30646 \backslash
30647 titlerunning{}
30648 \end_layout
30649
30650 \begin_layout Standard
30651
30652 \change_deleted 564990737 1669742044
30653 If you want to use any of these commands,
30654  you have to enter them yourself.
30655
30656 \series bold
30657 Do not forget to mark them as \SpecialChar LaTeX
30658  code!
30659 \end_layout
30660
30661 \begin_layout Standard
30662
30663 \change_deleted 564990737 1669742044
30664 Figure and Table Floats
30665 \end_layout
30666
30667 \begin_layout Standard
30668
30669 \change_deleted 564990737 1669742044
30670 \SpecialChar LyX
30671  provides support for the necessary float environments
30672 \family sans
30673 figure,
30674  figure*,
30675  table
30676 \family default
30677  and
30678 \family sans
30679 table*
30680 \family default
30681 ,
30682  therefore we won't tell much about it here.
30683  Refer to the
30684 \emph on
30685 User's
30686 \begin_inset space ~
30687 \end_inset
30688
30689 Guide
30690 \emph default
30691 .
30692  Just remember that tables should be left-aligned.
30693  For that,
30694  select the table and change the alignment in
30695 \family sans
30696 Edit\SpecialChar menuseparator
30697 Paragraph
30698 \begin_inset space ~
30699 \end_inset
30700
30701 Settings.
30702 \end_layout
30703
30704 \begin_layout Standard
30705
30706 \change_deleted 564990737 1669742044
30707 There is only one special thing:
30708  the figures with caption besides the figure.
30709  To create such a figure,
30710  you have to do the following:
30711 \end_layout
30712
30713 \begin_layout Enumerate
30714
30715 \change_deleted 564990737 1669742044
30716 Create a wide figure float:
30717
30718 \family sans
30719 Insert\SpecialChar menuseparator
30720 Float\SpecialChar menuseparator
30721 Figure
30722 \family default
30723 ,
30724  then right click in the figure and select
30725 \family sans
30726 Span
30727 \begin_inset space ~
30728 \end_inset
30729
30730 columns
30731 \family default
30732 .
30733 \end_layout
30734
30735 \begin_layout Enumerate
30736
30737 \change_deleted 564990737 1669742044
30738 Enter your caption text.
30739 \end_layout
30740
30741 \begin_layout Enumerate
30742
30743 \change_deleted 564990737 1669742044
30744 Press
30745 \family sans
30746 Return
30747 \family default
30748  to move the cursor above the caption.
30749 \end_layout
30750
30751 \begin_layout Enumerate
30752
30753 \change_deleted 564990737 1669742044
30754 Insert your figure
30755 \end_layout
30756
30757 \begin_layout Enumerate
30758
30759 \change_deleted 564990737 1669742044
30760 Position the cursor behind the figure and insert a horizontal fill:
30761
30762 \family sans
30763 Insert\SpecialChar menuseparator
30764 Special
30765 \begin_inset space ~
30766 \end_inset
30767
30768 Character\SpecialChar menuseparator
30769 Horizontal
30770 \begin_inset space ~
30771 \end_inset
30772
30773 Fill
30774 \family default
30775 .
30776 \end_layout
30777
30778 \begin_layout Enumerate
30779
30780 \change_deleted 564990737 1669742044
30781 Switch to \SpecialChar LaTeX
30782  mode:
30783
30784 \family sans
30785 M-c
30786 \begin_inset space ~
30787 \end_inset
30788
30789 t
30790 \family default
30791 .
30792 \end_layout
30793
30794 \begin_layout Enumerate
30795
30796 \change_deleted 564990737 1669742044
30797 Enter
30798 \family typewriter
30799
30800 \backslash
30801 parbox[b]{55mm}{
30802 \family default
30803 .
30804
30805 \series bold
30806 Do not close the brace!
30807 \end_layout
30808
30809 \begin_layout Enumerate
30810
30811 \change_deleted 564990737 1669742044
30812 Position the cursor behind the caption text,
30813  switch to \SpecialChar LaTeX
30814  mode and insert the closing brace:
30815
30816 \family sans
30817 M-c
30818 \begin_inset space ~
30819 \end_inset
30820
30821 t
30822 \family default
30823
30824 \family typewriter
30825 }
30826 \family default
30827 .
30828 \end_layout
30829
30830 \begin_layout Standard
30831
30832 \change_deleted 564990737 1669742044
30833 Also,
30834  refer to the figures in the example paper.
30835 \end_layout
30836
30837 \begin_layout Standard
30838
30839 \change_deleted 564990737 1669742044
30840 Referee layout
30841 \end_layout
30842
30843 \begin_layout Standard
30844
30845 \change_deleted 564990737 1669742044
30846 For submission,
30847  the paper has to be formated in a special double-spacing layout.
30848  For this purpose,
30849  you have to give the option
30850 \family typewriter
30851 referee
30852 \family default
30853  to the document class.
30854  This must be done using the custom class options field in the
30855 \family sans
30856 Document\SpecialChar menuseparator
30857 Settings
30858 \family default
30859  dialog.
30860  Just enter the string
30861 \family typewriter
30862 referee
30863 \family default
30864  there.
30865 \end_layout
30866
30867 \begin_layout Standard
30868
30869 \change_deleted 564990737 1669742044
30870 The example paper
30871 \end_layout
30872
30873 \begin_layout Standard
30874
30875 \change_deleted 564990737 1669742044
30876 The
30877 \family sans
30878 Examples
30879 \family default
30880  directory contains an example paper written with \SpecialChar LyX
30881 .
30882  It is the example paper from the original macro package,
30883  translated to \SpecialChar LyX
30884 .
30885  Use it for inspiration,
30886  and compare the original \SpecialChar LaTeX
30887  code with \SpecialChar LyX
30888  way of writing.
30889 \end_layout
30890
30891 \begin_layout Standard
30892
30893 \change_deleted 564990737 1671097429
30894 Dinbrief
30895 \end_layout
30896
30897 \begin_layout Standard
30898
30899 \change_deleted 564990737 1671097429
30900 The document class
30901 \family sans
30902 dinbrief
30903 \family default
30904  can be used to type letters according to German conventions.
30905  A template file is included in
30906 \family typewriter
30907 .../lyx/share/templates
30908 \family default
30909  for you to use as a starting point.
30910 \end_layout
30911
30912 \begin_layout Standard
30913
30914 \change_deleted 564990737 1671097429
30915 Elsevier Journals
30916 \end_layout
30917
30918 \begin_layout Standard
30919
30920 \change_deleted 564990737 1671097429
30921 See the \SpecialChar LyX
30922  template file
30923 \family typewriter
30924 elsarticle.lyx
30925 \family default
30926 .
30927  It contains all infos you need.
30928 \end_layout
30929
30930 \begin_layout Standard
30931
30932 \change_deleted 564990737 1669755802
30933 ijmpc and ijmpd
30934 \end_layout
30935
30936 \begin_layout Standard
30937
30938 \change_deleted 564990737 1669755802
30939 by
30940 \noun on
30941 Panayotis Papasotiriou
30942 \end_layout
30943
30944 \begin_layout Standard
30945
30946 \change_deleted 564990737 1669755802
30947 Overview
30948 \end_layout
30949
30950 \begin_layout Standard
30951
30952 \change_deleted 564990737 1669755802
30953 The ijmpc package is a set of macros that facilitates electronic manuscript submission to the
30954 \emph on
30955 International Journal of Modern Physics C
30956 \emph default
30957 .
30958  Similarly,
30959  the ijmpd package is for creating manuscripts to be submitted to the
30960 \emph on
30961 International Journal of Modern Physics D
30962 \emph default
30963 .
30964  Both journals are published by World Scientific.
30965  The corresponding document classes are named
30966 \family typewriter
30967 ws-ijmpc.cls
30968 \family default
30969  and
30970 \family typewriter
30971 ws-ijmpd.cls
30972 \family default
30973 ,
30974  respectively.
30975  These files,
30976  together with instructions for the authors,
30977  can be downloaded from the sites
30978 \begin_inset Flex URL
30979 status collapsed
30980
30981 \begin_layout Plain Layout
30982
30983 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
30984 \end_layout
30985
30986 \end_inset
30987
30988  and
30989 \begin_inset Flex URL
30990 status collapsed
30991
30992 \begin_layout Plain Layout
30993
30994 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
30995 \end_layout
30996
30997 \end_inset
30998
30999 .
31000  Both packages are modified versions of the standard
31001 \begin_inset Quotes eld
31002 \end_inset
31003
31004 article
31005 \begin_inset Quotes erd
31006 \end_inset
31007
31008  package,
31009  and they are almost (but not exactly) identical.
31010  Most of their features are supported by \SpecialChar LyX
31011 .
31012  I have used \SpecialChar LyX
31013  successfully to write articles submitted to both journals without any problem.
31014 \end_layout
31015
31016 \begin_layout Standard
31017
31018 \change_deleted 564990737 1669755802
31019 Writing a paper
31020 \end_layout
31021
31022 \begin_layout Standard
31023
31024 \change_deleted 564990737 1669755802
31025 As usual,
31026  the easiest way to write a paper is to start with a template.
31027  Click on
31028 \family sans
31029 File\SpecialChar menuseparator
31030 New from
31031 \family default
31032
31033 \family sans
31034 Template
31035 \family default
31036 ,
31037  then choose the
31038 \family typewriter
31039 ijmpc.lyx
31040 \family default
31041  or
31042 \family typewriter
31043 ijmpd.lyx
31044 \family default
31045  template.
31046  This will give an (almost) empty document that includes the most common fields found in a manuscript.
31047  Simply overwrite the existing text (including the brackets,
31048
31049 \family typewriter
31050 <>
31051 \family default
31052 ) with your text.
31053  You should keep in mind the following remarks.
31054 \end_layout
31055
31056 \begin_layout Enumerate
31057
31058 \change_deleted 564990737 1669755802
31059 \SpecialChar LyX
31060  won't let you change the font size and the page style of the document,
31061  because such modifications are not allowed by both packages.
31062 \end_layout
31063
31064 \begin_layout Enumerate
31065
31066 \change_deleted 564990737 1669755802
31067 The language of the document should not be changed.
31068  Before previewing your paper,
31069  be sure that the babel package is not used.
31070  To do this,
31071  click on
31072 \begin_inset Info
31073 type  "menu"
31074 arg   "dialog-show document"
31075 \end_inset
31076
31077
31078 \family sans
31079 \SpecialChar menuseparator
31080 Language
31081 \family default
31082 ,
31083  and select
31084 \begin_inset Quotes eld
31085 \end_inset
31086
31087 None
31088 \begin_inset Quotes erd
31089 \end_inset
31090
31091  as
31092 \family sans
31093 Language Package
31094 \family default
31095 .
31096 \end_layout
31097
31098 \begin_layout Enumerate
31099
31100 \change_deleted 564990737 1669755802
31101 The
31102 \begin_inset Quotes eld
31103 \end_inset
31104
31105 Keywords
31106 \begin_inset Quotes erd
31107 \end_inset
31108
31109  style must be used to define keywords.
31110 \end_layout
31111
31112 \begin_layout Enumerate
31113
31114 \change_deleted 564990737 1669755802
31115 The ijmpc package provides a style named
31116 \begin_inset Quotes eld
31117 \end_inset
31118
31119 Classification Codes
31120 \begin_inset Quotes erd
31121 \end_inset
31122
31123 ,
31124  which can be used to define classification codes,
31125  such as PACS numbers.
31126  Note that this facility is not supported by the ijmpd package.
31127 \end_layout
31128
31129 \begin_layout Enumerate
31130
31131 \change_deleted 564990737 1669755802
31132 Several new environments are available:
31133
31134 \begin_inset Quotes eld
31135 \end_inset
31136
31137 Definition
31138 \begin_inset Quotes erd
31139 \end_inset
31140
31141 ,
31142
31143 \begin_inset Quotes eld
31144 \end_inset
31145
31146 Step
31147 \begin_inset Quotes erd
31148 \end_inset
31149
31150 ,
31151
31152 \begin_inset Quotes eld
31153 \end_inset
31154
31155 Example
31156 \begin_inset Quotes erd
31157 \end_inset
31158
31159 ,
31160
31161 \begin_inset Quotes eld
31162 \end_inset
31163
31164 Remark
31165 \begin_inset Quotes erd
31166 \end_inset
31167
31168 ,
31169
31170 \begin_inset Quotes eld
31171 \end_inset
31172
31173 Notation
31174 \begin_inset Quotes erd
31175 \end_inset
31176
31177 ,
31178
31179 \begin_inset Quotes eld
31180 \end_inset
31181
31182 Theorem
31183 \begin_inset Quotes erd
31184 \end_inset
31185
31186 ,
31187
31188 \begin_inset Quotes eld
31189 \end_inset
31190
31191 Proof
31192 \begin_inset Quotes erd
31193 \end_inset
31194
31195 ,
31196
31197 \begin_inset Quotes eld
31198 \end_inset
31199
31200 Corollary
31201 \begin_inset Quotes erd
31202 \end_inset
31203
31204 ,
31205
31206 \begin_inset Quotes eld
31207 \end_inset
31208
31209 Lemma
31210 \begin_inset Quotes erd
31211 \end_inset
31212
31213 ,
31214
31215 \begin_inset Quotes eld
31216 \end_inset
31217
31218 Proposition
31219 \begin_inset Quotes erd
31220 \end_inset
31221
31222 ,
31223
31224 \begin_inset Quotes eld
31225 \end_inset
31226
31227 Prop
31228 \begin_inset Quotes erd
31229 \end_inset
31230
31231 ,
31232
31233 \begin_inset Quotes eld
31234 \end_inset
31235
31236 Question
31237 \begin_inset Quotes erd
31238 \end_inset
31239
31240 ,
31241
31242 \begin_inset Quotes eld
31243 \end_inset
31244
31245 Claim
31246 \begin_inset Quotes erd
31247 \end_inset
31248
31249 ,
31250  and
31251 \begin_inset Quotes eld
31252 \end_inset
31253
31254 Conjecture
31255 \begin_inset Quotes erd
31256 \end_inset
31257
31258 .
31259  Their use is more or less obvious.
31260  \SpecialChar LyX
31261  supports all these environments;
31262  it will use the proper label,
31263  text style,
31264  and numbering scheme for each of them.
31265 \end_layout
31266
31267 \begin_layout Enumerate
31268
31269 \change_deleted 564990737 1669755802
31270 Both packages use basic citations;
31271  the natbib package should not be used.
31272  In \SpecialChar LyX
31273 ,
31274  citation references are shown as usual;
31275  in the output,
31276  citations are shown as superscripts.
31277  If you want to use a citation as normal text,
31278  you should use the
31279 \family typewriter
31280 refcite
31281 \family default
31282  command,
31283  e.
31284 \begin_inset space \thinspace{}
31285 \end_inset
31286
31287 g.
31288 \begin_inset space \space{}
31289 \end_inset
31290
31291
31292 \begin_inset Quotes eld
31293 \end_inset
31294
31295 See Ref.
31296 \begin_inset space \space{}
31297 \end_inset
31298
31299
31300 \family typewriter
31301
31302 \backslash
31303 refcite{key}
31304 \family default
31305
31306 \begin_inset Quotes erd
31307 \end_inset
31308
31309 .
31310 \end_layout
31311
31312 \begin_layout Enumerate
31313
31314 \change_deleted 564990737 1669755802
31315 There is no
31316 \begin_inset Quotes eld
31317 \end_inset
31318
31319 Acknowledgments
31320 \begin_inset Quotes erd
31321 \end_inset
31322
31323  section in both packages.
31324  To put acknowledgments,
31325  just use the
31326 \begin_inset Quotes eld
31327 \end_inset
31328
31329 Section*
31330 \begin_inset Quotes erd
31331 \end_inset
31332
31333  environment.
31334 \end_layout
31335
31336 \begin_layout Enumerate
31337
31338 \change_deleted 564990737 1669755802
31339 Appendices may be added to the paper,
31340
31341 \emph on
31342 after
31343 \emph default
31344  the Acknowledgments and
31345 \shape italic
31346 before
31347 \shape default
31348  the References.
31349  \SpecialChar LyX
31350  provides a special environment,
31351  called
31352 \begin_inset Quotes eld
31353 \end_inset
31354
31355 Appendices Section
31356 \begin_inset Quotes erd
31357 \end_inset
31358
31359  which marks the beginning of the appendices.
31360  This environment should be left blank;
31361  it just sends a \SpecialChar LaTeX
31362  command,
31363  but nothing is really printed.
31364  In \SpecialChar LyX
31365 ,
31366  the word
31367 \begin_inset Quotes eld
31368 \end_inset
31369
31370 Appendix
31371 \begin_inset Quotes erd
31372 \end_inset
31373
31374  is printed with blue letters,
31375  as a signal that all sections after that point are appendices.
31376  To write an appendix,
31377  use the
31378 \begin_inset Quotes eld
31379 \end_inset
31380
31381 Appendix
31382 \begin_inset Quotes erd
31383 \end_inset
31384
31385  environment.
31386  \SpecialChar LyX
31387  will number each appendix with capital letters,
31388  as required by both journals.
31389  Note that
31390 \begin_inset Quotes eld
31391 \end_inset
31392
31393 Appendices Section
31394 \begin_inset Quotes erd
31395 \end_inset
31396
31397
31398 \emph on
31399 must
31400 \emph default
31401  be present before the first appendix;
31402  if not,
31403  all appendices will be numbered as normal sections in the output.
31404 \end_layout
31405
31406 \begin_layout Enumerate
31407
31408 \change_deleted 564990737 1669755802
31409 The ijmpc and the ijmpd packages use the
31410 \family typewriter
31411 tbl
31412 \family default
31413  command to implement table captions.
31414  As a result,
31415  a table created by \SpecialChar LyX
31416  is printed correctly,
31417  but its caption is ignored.
31418  However,
31419  you can use some \SpecialChar TeX
31420  code to overcome this problem,
31421  so that captions are printed as expected.
31422  To do so,
31423  create a float table as usual,
31424  remove the caption,
31425  and replace it with the \SpecialChar TeX
31426  code
31427 \family typewriter
31428
31429 \backslash
31430 tbl{
31431 \emph on
31432 your table caption
31433 \emph default
31434 }{
31435 \family default
31436  (sic);
31437  you must also the \SpecialChar TeX
31438  code
31439 \family typewriter
31440 }
31441 \family default
31442  immediately after the tabular material.
31443  Study the example table included in the template files to see how this trick is implemented.
31444  Alternatively,
31445  If you need table captions,
31446  you should implement the whole table float in a
31447 \family typewriter
31448 .tex
31449 \family default
31450  file,
31451  then include this file to the \SpecialChar LyX
31452  document (
31453 \family sans
31454 Insert\SpecialChar menuseparator
31455 File\SpecialChar menuseparator
31456 Child
31457 \begin_inset space ~
31458 \end_inset
31459
31460 Document
31461 \family default
31462 ).
31463  Details on how to create a table float can be found in the files
31464 \family typewriter
31465 ws-ijmpc.tex
31466 \family default
31467  and
31468 \family typewriter
31469 ws-ijmpd.tex
31470 \family default
31471 ,
31472  included in the corresponding packages.
31473 \end_layout
31474
31475 \begin_layout Standard
31476
31477 \change_deleted 564990737 1669755802
31478 Preparing a paper for submission
31479 \end_layout
31480
31481 \begin_layout Standard
31482
31483 \change_deleted 564990737 1669755802
31484 Before you submit your paper you must export the \SpecialChar LyX
31485  document as a \SpecialChar LaTeX
31486  file (
31487 \family sans
31488 File\SpecialChar menuseparator
31489 Export\SpecialChar menuseparator
31490 \SpecialChar LaTeX
31491
31492 \family default
31493 )
31494 \begin_inset Foot
31495 status open
31496
31497 \begin_layout Plain Layout
31498 Actually you have the choice between \SpecialChar LaTeX
31499  (plain) and pdflatex.
31500  If you intend to use pdflatex to prepare the paper,
31501  you should use the pdflatex option so that included graphics are converted to PDF format,
31502  ready for use by pdflatex.
31503 \end_layout
31504
31505 \end_inset
31506
31507 ,
31508  then make the following changes to the resulting
31509 \family typewriter
31510 .tex
31511 \family default
31512  file.
31513 \end_layout
31514
31515 \begin_layout Enumerate
31516
31517 \change_deleted 564990737 1669755802
31518 Remove the comment lines before the
31519 \family typewriter
31520
31521 \backslash
31522 documentclass
31523 \family default
31524  command.
31525 \end_layout
31526
31527 \begin_layout Enumerate
31528
31529 \change_deleted 564990737 1669755802
31530 Remove everything between (and including) the
31531 \family typewriter
31532
31533 \backslash
31534 makeatletter
31535 \family default
31536  and
31537 \family typewriter
31538
31539 \backslash
31540 makeatother
31541 \family default
31542  commands,
31543  except for any commands you specifically put into the \SpecialChar LaTeX
31544  preamble.
31545 \end_layout
31546
31547 \begin_layout Standard
31548
31549 \change_deleted 564990737 1672743015
31550 The modified
31551 \family typewriter
31552 .tex
31553 \family default
31554  file should be saved and processed through \SpecialChar LaTeX
31555  as many times as necessary.
31556  You may also want to check the resulting
31557 \family typewriter
31558 .dvi
31559 \family default
31560  document.
31561 \end_layout
31562
31563 \begin_layout Standard
31564
31565 \change_deleted 564990737 1669801478
31566 iopart
31567 \end_layout
31568
31569 \begin_layout Standard
31570
31571 \change_deleted 564990737 1669801478
31572 by
31573 \noun on
31574 Uwe Stöhr
31575 \end_layout
31576
31577 \begin_layout Standard
31578
31579 \change_deleted 564990737 1669801478
31580 Overview
31581 \end_layout
31582
31583 \begin_layout Standard
31584
31585 \change_deleted 564990737 1669801478
31586 The iopart package provides a document class to create electronic manuscript submission to the journals published by the Institute of Physics.
31587  Instructions for the authors how to create a paper using the iopart class can be downloaded together with the iopart package from the site
31588 \begin_inset Flex URL
31589 status collapsed
31590
31591 \begin_layout Plain Layout
31592
31593 ftp://ftp.iop.org/pub/journals/latex2e
31594 \end_layout
31595
31596 \end_inset
31597
31598 .
31599 \end_layout
31600
31601 \begin_layout Standard
31602
31603 \change_deleted 564990737 1669801478
31604 Writing a paper
31605 \end_layout
31606
31607 \begin_layout Standard
31608
31609 \change_deleted 564990737 1669801478
31610 The easiest way to write a paper is to start with the template
31611 \emph on
31612 IOP-article.lyx
31613 \emph default
31614  that is available via
31615 \family sans
31616 File\SpecialChar menuseparator
31617 New From Template
31618 \family default
31619  The template explains how to use the special text environments.
31620  Here are the most important advices:
31621 \end_layout
31622
31623 \begin_layout Itemize
31624
31625 \change_deleted 564990737 1669801478
31626 To be able to compile your document to a PDF,
31627  PS,
31628  or DVI,
31629  ensure that the no AMS packages are loaded in
31630 \family sans
31631 Document\SpecialChar menuseparator
31632 Settings\SpecialChar menuseparator
31633 Math Options
31634 \family default
31635 !
31636 \end_layout
31637
31638 \begin_layout Itemize
31639
31640 \change_deleted 564990737 1669801478
31641
31642 \size normal
31643 The title environment defines the kind of your paper.
31644  So use one of the following environments for the title:
31645 \end_layout
31646
31647 \begin_deeper
31648 \begin_layout Itemize
31649
31650 \change_deleted 564990737 1669801478
31651
31652 \family sans
31653 \size normal
31654 Title
31655 \family default
31656  for a Paper
31657 \end_layout
31658
31659 \begin_layout Itemize
31660
31661 \change_deleted 564990737 1669801478
31662
31663 \family sans
31664 \size normal
31665 Review
31666 \family default
31667  for a Review
31668 \end_layout
31669
31670 \begin_layout Itemize
31671
31672 \change_deleted 564990737 1669801478
31673
31674 \family sans
31675 \size normal
31676 Topical
31677 \family default
31678  for a Topical review
31679 \end_layout
31680
31681 \begin_layout Itemize
31682
31683 \change_deleted 564990737 1669801478
31684
31685 \family sans
31686 \size normal
31687 Comment
31688 \family default
31689  for a Comment
31690 \end_layout
31691
31692 \begin_layout Itemize
31693
31694 \change_deleted 564990737 1669801478
31695
31696 \family sans
31697 \size normal
31698 Note
31699 \family default
31700  for a Note
31701 \end_layout
31702
31703 \begin_layout Itemize
31704
31705 \change_deleted 564990737 1669801478
31706
31707 \family sans
31708 \size normal
31709 Paper
31710 \family default
31711  for a Paper (same as Title)
31712 \end_layout
31713
31714 \begin_layout Itemize
31715
31716 \change_deleted 564990737 1669801478
31717
31718 \family sans
31719 \size normal
31720 Prelim
31721 \family default
31722  for a Preliminary communication
31723 \end_layout
31724
31725 \begin_layout Itemize
31726
31727 \change_deleted 564990737 1669801478
31728
31729 \family sans
31730 \size normal
31731 Rapid
31732 \family default
31733  for a Rapid communication
31734 \end_layout
31735
31736 \begin_layout Itemize
31737
31738 \change_deleted 564990737 1669801478
31739
31740 \family sans
31741 \size normal
31742 Letter
31743 \family default
31744  for a Letter to the editor
31745 \end_layout
31746
31747 \end_deeper
31748 \begin_layout Itemize
31749
31750 \change_deleted 564990737 1669801478
31751
31752 \size normal
31753 All title environments except of
31754 \family sans
31755 Letter
31756 \family default
31757  can have an optional short title.
31758 \end_layout
31759
31760 \begin_layout Itemize
31761
31762 \change_deleted 564990737 1669801478
31763 There is a general title environment
31764 \family sans
31765 Article
31766 \family default
31767  which is not directly supported by \SpecialChar LyX
31768 .
31769  This can be used as \SpecialChar TeX
31770  code when your document doesn't fit into one of the other title types.
31771 \end_layout
31772
31773 \begin_layout Standard
31774
31775 \change_deleted 564990737 1672743015
31776 For more informations like hints for special table and formula formatting,
31777  look at the IOP author guidelines.
31778 \end_layout
31779
31780 \begin_layout Standard
31781
31782 \change_deleted 564990737 1670317155
31783 Kluwer
31784 \end_layout
31785
31786 \begin_layout Standard
31787
31788 \change_deleted 564990737 1670317155
31789 by
31790 \noun on
31791 Panayotis Papasotiriou
31792 \end_layout
31793
31794 \begin_layout Standard
31795
31796 \change_deleted 564990737 1670317155
31797 Overview
31798 \end_layout
31799
31800 \begin_layout Standard
31801
31802 \change_deleted 564990737 1670317155
31803 The Kluwer package is a set of macros produced by Kluwer Academic Publishers that facilitates electronic manuscript submission to the journals they publish.
31804  Most known of them (at least in my domain of interest) are
31805 \emph on
31806 Astrophysics and Space Science
31807 \emph default
31808  and
31809 \emph on
31810 Solar Physics
31811 \emph default
31812 ,
31813  but there are many others (see a complete list at
31814 \begin_inset Flex URL
31815 status collapsed
31816
31817 \begin_layout Plain Layout
31818
31819 http://www.wkap.nl/jrnllist.htm/JRNLHOME
31820 \end_layout
31821
31822 \end_inset
31823
31824 ).
31825  The Kluwer package may be downloaded from the site
31826 \begin_inset Flex URL
31827 status collapsed
31828
31829 \begin_layout Plain Layout
31830
31831 http://www.wkap.nl/kaphtml.htm/STYLEFILES
31832 \end_layout
31833
31834 \end_inset
31835
31836 .
31837  A complete user guide is contained in that package (but it can also be downloaded separately).
31838 \end_layout
31839
31840 \begin_layout Standard
31841
31842 \change_deleted 564990737 1670317155
31843 \SpecialChar LyX
31844  supports many features of the package but not everything.
31845  However,
31846  the \SpecialChar TeX
31847  code needed is reduced to some
31848 \begin_inset Quotes eld
31849 \end_inset
31850
31851 peculiar
31852 \begin_inset Quotes erd
31853 \end_inset
31854
31855  commands of the package (see
31856 \begin_inset space ~
31857 \end_inset
31858
31859
31860 \begin_inset CommandInset ref
31861 LatexCommand ref
31862 reference "subsec:kluwer_peculiarities"
31863 nolink "false"
31864
31865 \end_inset
31866
31867 ).
31868  I have recently used \SpecialChar LyX
31869  to write an article submitted to the
31870 \emph on
31871 Astrophysics and Space Science
31872 \emph default
31873  without any problem.
31874 \end_layout
31875
31876 \begin_layout Standard
31877
31878 \change_deleted 564990737 1670317155
31879 Writing a paper
31880 \end_layout
31881
31882 \begin_layout Standard
31883
31884 \change_deleted 564990737 1670317155
31885 The easiest way to write a paper is to start with the Kluwer template file.
31886  Click on
31887 \family sans
31888 File\SpecialChar menuseparator
31889 New from
31890 \family default
31891
31892 \family sans
31893 Template
31894 \family default
31895 ,
31896  then choose the
31897 \family typewriter
31898 kluwer.lyx
31899 \family default
31900  template.
31901  This will give an (almost) empty document that includes the most common fields found in a manuscript and a short description of their use.
31902  As in most templates,
31903  simply overwrite the existing text (including the brackets,
31904
31905 \family typewriter
31906 <>
31907 \family default
31908 ) with the correct information.
31909 \end_layout
31910
31911 \begin_layout Standard
31912
31913 \change_deleted 564990737 1670317155
31914 Preparing a paper for submission
31915 \end_layout
31916
31917 \begin_layout Standard
31918
31919 \change_deleted 564990737 1670317155
31920 As in the AAS\SpecialChar TeX
31921  package,
31922  before you submit your paper to a journal you must
31923 \begin_inset Quotes eld
31924 \end_inset
31925
31926 postprocess
31927 \begin_inset Quotes erd
31928 \end_inset
31929
31930  it as follows.
31931 \end_layout
31932
31933 \begin_layout Enumerate
31934
31935 \change_deleted 564990737 1670317155
31936 Export your paper as a \SpecialChar LaTeX
31937  file.
31938  To do this,
31939  click on
31940 \family sans
31941 File\SpecialChar menuseparator
31942 Export\SpecialChar menuseparator
31943 \SpecialChar LaTeX
31944
31945 \family default
31946 .
31947
31948 \end_layout
31949
31950 \begin_layout Enumerate
31951
31952 \change_deleted 564990737 1670317155
31953 Edit the resulting
31954 \family typewriter
31955 .tex
31956 \family default
31957  file with a text editor and make the following changes
31958 \end_layout
31959
31960 \begin_deeper
31961 \begin_layout Enumerate
31962
31963 \change_deleted 564990737 1670317155
31964 remove the comment lines before the
31965 \family typewriter
31966
31967 \backslash
31968 documentclass
31969 \family default
31970  command,
31971 \end_layout
31972
31973 \begin_layout Enumerate
31974
31975 \change_deleted 564990737 1670317155
31976 remove everything between (and including) the
31977 \family typewriter
31978
31979 \backslash
31980 makeatletter
31981 \family default
31982  and
31983 \family typewriter
31984
31985 \backslash
31986 makeatother
31987 \family default
31988  commands,
31989  except for any commands you specifically put into the \SpecialChar LaTeX
31990  preamble.
31991 \end_layout
31992
31993 \begin_layout Standard
31994
31995 \change_deleted 564990737 1670317155
31996 Save the resulting
31997 \family typewriter
31998 .tex
31999 \family default
32000  file.
32001 \end_layout
32002
32003 \end_deeper
32004 \begin_layout Enumerate
32005
32006 \change_deleted 564990737 1670317155
32007 Run the
32008 \family typewriter
32009 .tex
32010 \family default
32011  file through \SpecialChar LaTeX
32012  as many times as necessary (usually up to three).
32013 \end_layout
32014
32015 \begin_layout Enumerate
32016
32017 \change_deleted 564990737 1670317155
32018 View the resulting
32019 \family typewriter
32020 .dvi
32021 \family default
32022  document using,
32023  e.
32024 \begin_inset space \thinspace{}
32025 \end_inset
32026
32027 g.
32028 \begin_inset space \space{}
32029 \end_inset
32030
32031
32032 \family sans
32033 xdvi
32034 \family default
32035 ,
32036  and check if everything is OK (it should,
32037  if you didn't make any mistake).
32038 \end_layout
32039
32040 \begin_layout Standard
32041
32042 \change_deleted 564990737 1670317155
32043 \begin_inset Quotes eld
32044 \end_inset
32045
32046 Peculiarities
32047 \begin_inset Quotes erd
32048 \end_inset
32049
32050  of the Kluwer package
32051 \begin_inset CommandInset label
32052 LatexCommand label
32053 name "subsec:kluwer_peculiarities"
32054
32055 \end_inset
32056
32057
32058 \end_layout
32059
32060 \begin_layout Standard
32061
32062 \change_deleted 564990737 1670317155
32063 The Kluwer package has the following
32064 \begin_inset Quotes eld
32065 \end_inset
32066
32067 peculiarities
32068 \begin_inset Quotes erd
32069 \end_inset
32070
32071 .
32072 \end_layout
32073
32074 \begin_layout Enumerate
32075
32076 \change_deleted 564990737 1670317155
32077 It is possible to write multiple articles in the same \SpecialChar LaTeX
32078  file
32079 \begin_inset Foot
32080 status collapsed
32081
32082 \begin_layout Plain Layout
32083 I can't imagine any good reason to do this.
32084 \end_layout
32085
32086 \end_inset
32087
32088 .
32089  Each article must be included in the environment
32090 \begin_inset Quotes eld
32091 \end_inset
32092
32093 article
32094 \begin_inset Quotes erd
32095 \end_inset
32096
32097 .
32098  Unfortunately,
32099  this environment cannot be omitted,
32100  even if you write just one article.
32101  Therefore,
32102  each article starts with the command
32103 \family typewriter
32104
32105 \backslash
32106 begin{article}
32107 \family default
32108  and,
32109  obviously,
32110  ends with the command
32111 \family typewriter
32112
32113 \backslash
32114 end{article}
32115 \family default
32116 .
32117  Although this can be implemented in \SpecialChar LyX
32118 ,
32119  I didn't included it,
32120  since it looks ugly and can confuse the novice user.
32121  Therefore,
32122  you need to enter them directly and mark them as \SpecialChar LaTeX
32123  code (the well-known
32124 \begin_inset Quotes eld
32125 \end_inset
32126
32127 \SpecialChar TeX
32128  code
32129 \begin_inset Quotes erd
32130 \end_inset
32131
32132 ).
32133 \end_layout
32134
32135 \begin_layout Enumerate
32136
32137 \change_deleted 564990737 1670317155
32138 Information given at the beginning of the article (i.
32139 \begin_inset space \thinspace{}
32140 \end_inset
32141
32142 e.
32143 \begin_inset space \space{}
32144 \end_inset
32145
32146 title,
32147  subtitle,
32148  author,
32149  institution,
32150  running title,
32151  running author,
32152  abstract and keywords) must be included in an environment called
32153 \begin_inset Quotes eld
32154 \end_inset
32155
32156 opening
32157 \begin_inset Quotes erd
32158 \end_inset
32159
32160 .
32161  This is not implemented in \SpecialChar LyX
32162 ,
32163  so you must enter title,
32164  subtitle etc.
32165 \begin_inset space ~
32166 \end_inset
32167
32168 between two \SpecialChar TeX
32169  code lines (
32170 \family typewriter
32171
32172 \backslash
32173 begin{opening}
32174 \family default
32175  and
32176 \family typewriter
32177
32178 \backslash
32179 end{opening}
32180 \family default
32181 ).
32182 \end_layout
32183
32184 \begin_layout Enumerate
32185
32186 \change_deleted 564990737 1670317155
32187 According to the user manual,
32188  the label of each bibliography item must be written as
32189 \family typewriter
32190
32191 \backslash
32192 protect
32193 \backslash
32194 citeauthoryear{
32195 \family default
32196 \emph on
32197 author(s)
32198 \family typewriter
32199 \emph default
32200 }{
32201 \family default
32202 \emph on
32203 year
32204 \family typewriter
32205 \emph default
32206 }
32207 \family default
32208 .
32209 \end_layout
32210
32211 \begin_layout Standard
32212
32213 \change_deleted 564990737 1670317155
32214 The
32215 \family typewriter
32216 kluwer.lyx
32217 \family default
32218  template takes care of all these
32219 \begin_inset Quotes eld
32220 \end_inset
32221
32222 peculiarities
32223 \begin_inset Quotes erd
32224 \end_inset
32225
32226 .
32227  If you start a new paper using this template you don't need to do anything special.
32228  Just
32229 \end_layout
32230
32231 \begin_layout Enumerate
32232
32233 \change_deleted 564990737 1670317155
32234 don't delete the \SpecialChar TeX
32235  code included in the template,
32236  and
32237 \end_layout
32238
32239 \begin_layout Enumerate
32240
32241 \change_deleted 564990737 1670317155
32242 copy the example bibliography item included in the template and modify it as necessary to enter new bibliography items.
32243 \end_layout
32244
32245 \begin_layout Standard
32246
32247 \change_deleted 564990737 1671097446
32248 Paper
32249 \end_layout
32250
32251 \begin_layout Standard
32252
32253 \change_deleted 564990737 1671097446
32254 The document class
32255 \family sans
32256 paper
32257 \family default
32258  provides an alternative to the standard
32259 \family sans
32260 article
32261 \family default
32262  class.
32263  It provides similar functionality,
32264  but you might prefer this layout with sans serif sections,
32265  headings,
32266  and more.
32267 \end_layout
32268
32269 \begin_layout Standard
32270
32271 \change_deleted 564990737 1671097446
32272 Springer Journals (
32273 \family sans
32274 svjour
32275 \family default
32276 )
32277 \end_layout
32278
32279 \begin_layout Standard
32280
32281 \change_deleted 564990737 1671097446
32282 by
32283 \noun on
32284 Martin Vermeer
32285 \end_layout
32286
32287 \begin_layout Standard
32288
32289 \change_deleted 564990737 1671097446
32290 Description
32291 \end_layout
32292
32293 \begin_layout Standard
32294
32295 \change_deleted 564990737 1671097446
32296 These are the layout files for some of the journal formats used by Springer Verlag and listed on
32297 \begin_inset Flex URL
32298 status collapsed
32299
32300 \begin_layout Plain Layout
32301
32302 http://www.springer.de/author/tex/help-journals.html
32303 \end_layout
32304
32305 \end_inset
32306
32307 ,
32308  where you should also go to fetch the class files (yes,
32309  these are \SpecialChar LaTeX2e
32310  now!).
32311  It is a modular system:
32312  the things common to all journals are implemented in
32313 \family typewriter
32314 svjour.inc
32315 \family default
32316 ,
32317  which journal-specific layout files (such as,
32318  e.
32319 \begin_inset space \thinspace{}
32320 \end_inset
32321
32322 g.
32323 \begin_inset space \space{}
32324 \end_inset
32325
32326
32327 \family typewriter
32328 svjog.layout
32329 \family default
32330  for Journal of Geodesy) can include.
32331 \end_layout
32332
32333 \begin_layout Standard
32334
32335 \change_deleted 564990737 1671097446
32336 This means that implementing support for any other Springer journal on this list is as simple as writing your own
32337 \family typewriter
32338 sv
32339 \family default
32340 <myjournal>
32341 \family typewriter
32342 .layout
32343 \family default
32344  file following the outline given in
32345 \family typewriter
32346 svjog.layout
32347 \family default
32348 .
32349
32350 \end_layout
32351
32352 \begin_layout Standard
32353
32354 \change_deleted 564990737 1671097446
32355 It is reasonably well tested only for the Journal of Geodesy.
32356
32357 \family typewriter
32358 svjour
32359 \family default
32360  and
32361 \family typewriter
32362 svjog
32363 \family default
32364  come with the standard \SpecialChar LyX
32365  distribution.
32366  Install the relevant class file (downloaded from Springer) in a proper directory,
32367  reconfigure \SpecialChar LaTeX
32368  (in the te\SpecialChar TeX
32369  case by running
32370 \family typewriter
32371 texhash
32372 \family default
32373 ,
32374  as root if necessary —
32375  doesn't \SpecialChar LyX
32376  take care of this?),
32377  reconfigure \SpecialChar LyX
32378  and it should work.
32379 \end_layout
32380
32381 \begin_layout Standard
32382
32383 \change_deleted 564990737 1671097446
32384 New styles
32385 \end_layout
32386
32387 \begin_layout Standard
32388
32389 \change_deleted 564990737 1671097446
32390 A large number of theorem-like styles —
32391
32392 \family sans
32393 Claim,
32394  Conjecture,
32395
32396 \family default
32397
32398 \family sans
32399 \SpecialChar ldots
32400 Theorem
32401 \family default
32402 .
32403 \end_layout
32404
32405 \begin_layout Standard
32406
32407 \change_deleted 564990737 1671097446
32408
32409 \family sans
32410 Headnote,
32411  Dedication,
32412  Subtitle,
32413  Running_\SpecialChar LaTeX
32414 _Title,
32415  Author_Running,
32416  Institute,
32417  Mail,
32418  Offprints,
32419  Keywords,
32420  Acknowledgements,
32421  Acknowledgement
32422 \family default
32423 .
32424  See the Springer class file documentation for details.
32425 \end_layout
32426
32427 \begin_layout Standard
32428
32429 \change_deleted 564990737 1671097446
32430 Supported journals
32431 \end_layout
32432
32433 \begin_layout Itemize
32434
32435 \change_deleted 564990737 1671097446
32436
32437 \emph on
32438 Journal of Geodesy
32439 \emph default
32440 :
32441
32442 \family typewriter
32443 svjog.layout
32444 \family default
32445  —
32446  Martin Vermeer
32447 \end_layout
32448
32449 \begin_layout Itemize
32450
32451 \change_deleted 564990737 1671097446
32452
32453 \emph on
32454 Probability Theory and Related Fields
32455 \emph default
32456 :
32457
32458 \family typewriter
32459 svprobth.layout
32460 \family default
32461  —
32462  Jean-Marc Lasgouttes
32463 \end_layout
32464
32465 \begin_layout Standard
32466
32467 \change_deleted 564990737 1671097446
32468 Add your own,
32469  it isn't so hard!
32470 \end_layout
32471
32472 \begin_layout Standard
32473
32474 \change_deleted 564990737 1671097446
32475 Credits
32476 \end_layout
32477
32478 \begin_layout Standard
32479
32480 \change_deleted 564990737 1671097446
32481 These files are partly based on the older
32482 \family typewriter
32483 ejour2.layout
32484 \family default
32485 ,
32486  which was again based on a tinkered-with version of an old \SpecialChar LaTeX
32487  2.09 style file from Springer.
32488  All this,
32489  and the
32490 \family typewriter
32491 ejour2
32492 \family default
32493  layout,
32494  are now defunct.
32495  Jean-Marc Lasgouttes helped out big in making me find my way around the \SpecialChar LyX
32496  layout file mechanism.
32497 \end_layout
32498
32499 \begin_layout Standard
32500
32501 \change_deleted 564990737 1671097446
32502 Bugs
32503 \end_layout
32504
32505 \begin_layout Standard
32506
32507 \change_deleted 564990737 1671097446
32508 Probably.
32509  But probably less than in the old hacked-\SpecialChar LaTeX
32510
32511 \family typewriter
32512 ejour2
32513 \family default
32514 .
32515 \end_layout
32516
32517 \begin_layout Chapter
32518 \SpecialChar LyX
32519  Features needing Extra Software
32520 \end_layout
32521
32522 \begin_layout Section
32523 Checking \SpecialChar TeX
32524
32525 \end_layout
32526
32527 \begin_layout Standard
32528 by
32529 \noun on
32530 Asger Alstrup
32531 \end_layout
32532
32533 \begin_layout Subsection
32534 Introduction
32535 \end_layout
32536
32537 \begin_layout Standard
32538 If you have the
32539 \family typewriter
32540 chktex
32541 \family default
32542  program installed
32543 \begin_inset Foot
32544 status collapsed
32545
32546 \begin_layout Plain Layout
32547
32548 \family typewriter
32549 chktex
32550 \family default
32551  is not yet available when you are using the \SpecialChar LaTeX
32552  distribution MiK\SpecialChar TeX
32553 .
32554 \end_layout
32555
32556 \end_inset
32557
32558 ,
32559  you'll find in the
32560 \family sans
32561 Tools
32562 \family default
32563  menu the entry:
32564
32565 \family sans
32566 Check
32567 \begin_inset space ~
32568 \end_inset
32569
32570 TeX
32571 \family default
32572 .
32573  You can get
32574 \family typewriter
32575 chktex
32576 \family default
32577  from CTAN,
32578 \begin_inset Newline newline
32579 \end_inset
32580
32581
32582 \begin_inset CommandInset href
32583 LatexCommand href
32584 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
32585 literal "false"
32586
32587 \end_inset
32588
32589 .
32590 \end_layout
32591
32592 \begin_layout Standard
32593 The
32594 \family sans
32595 Chk\SpecialChar TeX
32596
32597 \family default
32598  package is a program that was written by
32599 \begin_inset Flex Noun
32600 status collapsed
32601
32602 \begin_layout Plain Layout
32603 Jens T.
32604 \begin_inset space ~
32605 \end_inset
32606
32607 Berger Thielemann
32608 \end_layout
32609
32610 \end_inset
32611
32612  in frustration because some constructs in \SpecialChar LaTeX
32613  are sometimes non-intuitive,
32614  and easy to forget.
32615  The program runs over your \SpecialChar LaTeX
32616  file,
32617  checks the integrity of the file,
32618  and flags some common errors.
32619  In other technical words,
32620  it is
32621 \family typewriter
32622 lint
32623 \family default
32624  for \SpecialChar LaTeX
32625 .
32626 \end_layout
32627
32628 \begin_layout Standard
32629 Well,
32630  what is a syntax checker doing in \SpecialChar LyX
32631  which is supposed to produce correct \SpecialChar LaTeX
32632  anyways?
32633  The answer is simple:
32634  Just as
32635 \family typewriter
32636 Lint
32637 \family default
32638  not only checks the
32639 \emph on
32640 syntax
32641 \emph default
32642  of C programs,
32643  but also does
32644 \emph on
32645 semantic
32646 \emph default
32647  checks for type-errors,
32648
32649 \family sans
32650 Chk\SpecialChar TeX
32651
32652 \family default
32653  catches some common
32654 \emph on
32655 typographic
32656 \emph default
32657  errors,
32658  in addition to the syntactical ones.
32659  Specifically,
32660
32661 \family sans
32662 Chk\SpecialChar TeX
32663
32664 \family default
32665  is capable of detecting several common errors,
32666  such as
32667 \end_layout
32668
32669 \begin_layout Itemize
32670 Ellipsis detection:
32671 \begin_inset Newline newline
32672 \end_inset
32673
32674 Use \SpecialChar ldots
32675  instead of ...
32676 \end_layout
32677
32678 \begin_layout Itemize
32679 No space in front of/after parenthesis:
32680 \begin_inset Newline newline
32681 \end_inset
32682
32683 ( wrong spacing )
32684 \end_layout
32685
32686 \begin_layout Itemize
32687 Enforcement of normal space after common abbreviations:
32688 \begin_inset Newline newline
32689 \end_inset
32690
32691 e.
32692 \begin_inset space \thinspace{}
32693 \end_inset
32694
32695 g.
32696 \begin_inset space \space{}
32697 \end_inset
32698
32699 is too wide spacing.
32700 \end_layout
32701
32702 \begin_layout Itemize
32703 Enforcement of end-of-sentence space when the last sentence ends with a capital letter:
32704 \begin_inset Newline newline
32705 \end_inset
32706
32707 This is a TEST.
32708  And this is wrong spacing.
32709 \end_layout
32710
32711 \begin_layout Itemize
32712 Space in front of labels and similar commands:
32713 \begin_inset Newline newline
32714 \end_inset
32715
32716 The label should stick right up to the text to avoid falling to a wrong page.
32717
32718 \begin_inset CommandInset label
32719 LatexCommand label
32720 name "sec:chktex"
32721
32722 \end_inset
32723
32724
32725 \begin_inset Foot
32726 status collapsed
32727
32728 \begin_layout Plain Layout
32729 This footnote is in danger of falling off to a wrong page
32730 \end_layout
32731
32732 \end_inset
32733
32734  The label is separated too much.
32735 \end_layout
32736
32737 \begin_layout Itemize
32738 Space in front of references,
32739  instead of hard spaces:
32740 \begin_inset Newline newline
32741 \end_inset
32742
32743 If you have bad luck,
32744  the text will break right between the referenced text and reference number,
32745  and that's a pity.
32746  See section
32747 \begin_inset CommandInset ref
32748 LatexCommand ref
32749 reference "sec:chktex"
32750 nolink "false"
32751
32752 \end_inset
32753
32754 .
32755 \end_layout
32756
32757 \begin_layout Itemize
32758 Use of
32759 \begin_inset Quotes eld
32760 \end_inset
32761
32762 x
32763 \begin_inset Quotes erd
32764 \end_inset
32765
32766  instead of
32767 \begin_inset Formula $\times$
32768 \end_inset
32769
32770  between numbers:
32771 \begin_inset Newline newline
32772 \end_inset
32773
32774 2x2 looks cheap compared to
32775 \begin_inset Formula $2\times2$
32776 \end_inset
32777
32778 .
32779 \end_layout
32780
32781 \begin_layout Standard
32782 and more \SpecialChar ldots
32783  It is an invaluable tool when you are
32784 \begin_inset Quotes eld
32785 \end_inset
32786
32787 finishing up
32788 \begin_inset Quotes erd
32789 \end_inset
32790
32791  your document before printing,
32792  and you should run it right after the obligatory spelling check,
32793  and before you go fine tuning the typesetting.
32794 \end_layout
32795
32796 \begin_layout Subsection
32797 How to use it
32798 \end_layout
32799
32800 \begin_layout Standard
32801 If you have the program installed,
32802  usage is as simple as choosing
32803 \family sans
32804 Tools\SpecialChar menuseparator
32805 Check
32806 \begin_inset space ~
32807 \end_inset
32808
32809 TeX
32810 \family default
32811 .
32812  This will make \SpecialChar LyX
32813  generate a \SpecialChar LaTeX
32814  file of your document,
32815  start
32816 \family sans
32817 Chk\SpecialChar TeX
32818
32819 \family default
32820  to check it,
32821  and then make \SpecialChar LyX
32822  insert
32823 \begin_inset Quotes eld
32824 \end_inset
32825
32826 error boxes
32827 \begin_inset Quotes erd
32828 \end_inset
32829
32830  with the warnings from
32831 \family sans
32832 Chk\SpecialChar TeX
32833
32834 \family default
32835 ,
32836  if there were any.
32837  The warnings will be placed close to the point of the mistake,
32838  and you can quickly find them by using the
32839 \family sans
32840 Navigate\SpecialChar menuseparator
32841 Error
32842 \family default
32843  menu item,
32844  or the shortcut key
32845 \family sans
32846 C-g
32847 \family default
32848  from the default
32849 \family typewriter
32850 cua
32851 \family default
32852  bind file.
32853  Open the error boxes by clicking on them with the mouse,
32854  or use the shortcut key
32855 \family sans
32856 C-i
32857 \family default
32858  from
32859 \family typewriter
32860 cua
32861 \family default
32862  bindings,
32863  or the corresponding
32864 \family sans
32865 C-o
32866 \family default
32867  for the alternate
32868 \family typewriter
32869 emacs
32870 \family default
32871  bind file.
32872  Read the warning and correct the mistake,
32873  if it is a mistake.
32874  If you have trouble understanding what the warning is about,
32875  you can safely ignore it.
32876  Remember that there is a hidden layer between the document on screen and the technical details in invoking
32877 \family sans
32878 Chk\SpecialChar TeX
32879
32880 \family default
32881 ,
32882  and this gap can make some warnings seem arcane or just plain silly.
32883 \end_layout
32884
32885 \begin_layout Standard
32886 This document is an excellent testing bed for the feature,
32887  and it should provide quite a few warnings for you to fiddle with.
32888  Since computers are only so smart,
32889  expect most of the warnings to be false alarms,
32890  though.
32891 \end_layout
32892
32893 \begin_layout Subsection
32894 How to fine tune it
32895 \end_layout
32896
32897 \begin_layout Standard
32898 Sometimes,
32899  you'll find that
32900 \family sans
32901 Chk\SpecialChar TeX
32902
32903 \family default
32904  makes more noise than suits your mood.
32905  Then you can choose not to use it,
32906  wait until your mood changes,
32907  or try to customize
32908 \family sans
32909 Chk\SpecialChar TeX
32910
32911 \family default
32912  to get better along with you.
32913 \end_layout
32914
32915 \begin_layout Standard
32916 Although
32917 \family sans
32918 Chk\SpecialChar TeX
32919
32920 \family default
32921
32922 \emph on
32923 is
32924 \emph default
32925  very configurable and extensible,
32926  you should not expect to solve all problems with
32927 \family sans
32928 Chk\SpecialChar TeX
32929
32930 \family default
32931  in \SpecialChar LyX
32932  this way.
32933  Since \SpecialChar LyX
32934  has to generate a somewhat special \SpecialChar LaTeX
32935  file to be able to match the line numbers from the
32936 \family sans
32937 Chk\SpecialChar TeX
32938
32939 \family default
32940  output
32941 \begin_inset Foot
32942 status collapsed
32943
32944 \begin_layout Plain Layout
32945 You can inspect the specific output from
32946 \family sans
32947 chktex
32948 \family default
32949  by using
32950 \family sans
32951 Document\SpecialChar menuseparator
32952 \SpecialChar LaTeX
32953
32954 \begin_inset space ~
32955 \end_inset
32956
32957 Log
32958 \family default
32959  right after a
32960 \family sans
32961 chktex
32962 \family default
32963  run.
32964 \end_layout
32965
32966 \end_inset
32967
32968  to the internal document structure,
32969  some of the warnings will not appear correctly.
32970  There are two things you can do about this:
32971 \end_layout
32972
32973 \begin_layout Itemize
32974 Fine tune the
32975 \family sans
32976 Chk\SpecialChar TeX
32977
32978 \family default
32979  invocation command line in
32980 \begin_inset Flex Noun
32981 status collapsed
32982
32983 \begin_layout Plain Layout
32984 Tools\SpecialChar menuseparator
32985 Preferences\SpecialChar menuseparator
32986 Output\SpecialChar menuseparator
32987 LaTeX\SpecialChar menuseparator
32988 CheckTeX command
32989 \end_layout
32990
32991 \end_inset
32992
32993 ,
32994  or the global
32995 \family sans
32996 Chk\SpecialChar TeX
32997
32998 \family default
32999  installation configuration file (usually with the file
33000 \family typewriter
33001 chktexrc
33002 \family default
33003 ).
33004  See below to learn what warnings can be enabled and disabled on the command line.
33005 \end_layout
33006
33007 \begin_layout Itemize
33008 Export your document as a raw \SpecialChar LaTeX
33009  file using
33010 \family sans
33011 File\SpecialChar menuseparator
33012 Export\SpecialChar menuseparator
33013 \SpecialChar LaTeX
33014
33015 \family default
33016  and run
33017 \family typewriter
33018 chktex
33019 \family default
33020  manually on that.
33021  Invoked in this way,
33022  it can be a hassle to find the corresponding place in the document inside \SpecialChar LyX
33023 ,
33024  but with a little patience,
33025  you should be able to do it.
33026 \end_layout
33027
33028 \begin_layout Standard
33029 Here follows the warning messages that can be enabled and disabled in
33030 \family sans
33031 Preferences
33032 \family default
33033 .
33034  Use
33035 \family typewriter
33036 -n#
33037 \family default
33038  to disable a warning,
33039  and
33040 \family typewriter
33041 -w#
33042 \family default
33043  to enable a warning.
33044  The emphasized entries are disabled by default,
33045  because the default is "
33046 \family typewriter
33047 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
33048 \family default
33049 ".
33050 \end_layout
33051
33052 \begin_layout Standard
33053 Notice that you should only use the options that enable and disable warnings,
33054  because \SpecialChar LyX
33055  relies on some of the other command line parameters to be set in a specific way to have a chance to communicate with
33056 \family typewriter
33057 chktex
33058 \family default
33059 .
33060 \end_layout
33061
33062 \begin_layout Enumerate
33063
33064 \size small
33065 \emph on
33066 Command terminated with space.
33067 \end_layout
33068
33069 \begin_layout Enumerate
33070
33071 \size small
33072 Non-breaking space (
33073 \begin_inset Quotes eld
33074 \end_inset
33075
33076
33077 \family typewriter
33078 ~
33079 \family default
33080
33081 \begin_inset Quotes erd
33082 \end_inset
33083
33084 ) should have been used.
33085 \end_layout
33086
33087 \begin_layout Enumerate
33088
33089 \size small
33090 \emph on
33091 You should enclose the previous parenthesis with
33092 \begin_inset Quotes eld
33093 \end_inset
33094
33095
33096 \family typewriter
33097 {}
33098 \family default
33099
33100 \begin_inset Quotes erd
33101 \end_inset
33102
33103 .
33104 \end_layout
33105
33106 \begin_layout Enumerate
33107
33108 \size small
33109 Italic correction (
33110 \begin_inset Quotes eld
33111 \end_inset
33112
33113
33114 \family typewriter
33115
33116 \backslash
33117 /
33118 \family default
33119
33120 \begin_inset Quotes erd
33121 \end_inset
33122
33123 ) found in non-italic buffer.
33124 \end_layout
33125
33126 \begin_layout Enumerate
33127
33128 \size small
33129 Italic correction (
33130 \begin_inset Quotes eld
33131 \end_inset
33132
33133
33134 \family typewriter
33135
33136 \backslash
33137 /
33138 \family default
33139
33140 \begin_inset Quotes erd
33141 \end_inset
33142
33143 ) found more than once.
33144 \end_layout
33145
33146 \begin_layout Enumerate
33147
33148 \size small
33149 \emph on
33150 No italic correction (
33151 \begin_inset Quotes eld
33152 \end_inset
33153
33154
33155 \family typewriter
33156
33157 \backslash
33158 /
33159 \family default
33160
33161 \begin_inset Quotes erd
33162 \end_inset
33163
33164 ) found.
33165 \end_layout
33166
33167 \begin_layout Enumerate
33168
33169 \size small
33170 Accent command
33171 \begin_inset Quotes eld
33172 \end_inset
33173
33174
33175 \family typewriter
33176 cmd
33177 \family default
33178
33179 \begin_inset Quotes erd
33180 \end_inset
33181
33182  needs use of
33183 \begin_inset Quotes eld
33184 \end_inset
33185
33186
33187 \family typewriter
33188 cmd
33189 \family default
33190
33191 \begin_inset Quotes erd
33192 \end_inset
33193
33194 .
33195 \end_layout
33196
33197 \begin_layout Enumerate
33198
33199 \size small
33200 Wrong length of dash may have been used.
33201 \end_layout
33202
33203 \begin_layout Enumerate
33204
33205 \size small
33206 \emph on
33207 \begin_inset Quotes eld
33208 \end_inset
33209
33210
33211 \family typewriter
33212 %s
33213 \family default
33214
33215 \begin_inset Quotes erd
33216 \end_inset
33217
33218  expected,
33219  found
33220 \begin_inset Quotes eld
33221 \end_inset
33222
33223
33224 \family typewriter
33225 %s
33226 \family default
33227
33228 \begin_inset Quotes erd
33229 \end_inset
33230
33231 .
33232 \end_layout
33233
33234 \begin_layout Enumerate
33235
33236 \size small
33237 Solo
33238 \begin_inset Quotes eld
33239 \end_inset
33240
33241
33242 \family typewriter
33243 %s
33244 \family default
33245
33246 \begin_inset Quotes erd
33247 \end_inset
33248
33249  found.
33250 \end_layout
33251
33252 \begin_layout Enumerate
33253
33254 \size small
33255 You should use
33256 \begin_inset Quotes eld
33257 \end_inset
33258
33259
33260 \family typewriter
33261 %s
33262 \family default
33263
33264 \begin_inset Quotes erd
33265 \end_inset
33266
33267  to achieve an ellipsis.
33268 \end_layout
33269
33270 \begin_layout Enumerate
33271
33272 \size small
33273 Inter-word spacing (
33274 \begin_inset Quotes eld
33275 \end_inset
33276
33277
33278 \family typewriter
33279
33280 \backslash
33281
33282 \family default
33283
33284 \begin_inset Quotes eld
33285 \end_inset
33286
33287 ) should perhaps be used.
33288 \end_layout
33289
33290 \begin_layout Enumerate
33291
33292 \size small
33293 Inter-sentence spacing (
33294 \begin_inset Quotes eld
33295 \end_inset
33296
33297
33298 \family typewriter
33299
33300 \backslash
33301 @
33302 \family default
33303
33304 \begin_inset Quotes erd
33305 \end_inset
33306
33307 ) should perhaps be used.
33308 \end_layout
33309
33310 \begin_layout Enumerate
33311
33312 \size small
33313 Could not find argument for command.
33314 \end_layout
33315
33316 \begin_layout Enumerate
33317
33318 \size small
33319 No match found for
33320 \begin_inset Quotes eld
33321 \end_inset
33322
33323
33324 \family typewriter
33325 %s
33326 \family default
33327
33328 \begin_inset Quotes erd
33329 \end_inset
33330
33331 .
33332 \end_layout
33333
33334 \begin_layout Enumerate
33335
33336 \size small
33337 Math mode still on at end of \SpecialChar LaTeX
33338  file.
33339 \end_layout
33340
33341 \begin_layout Enumerate
33342
33343 \size small
33344 Number of
33345 \begin_inset Quotes eld
33346 \end_inset
33347
33348
33349 \family typewriter
33350 char
33351 \family default
33352
33353 \begin_inset Quotes erd
33354 \end_inset
33355
33356  doesn't match the number of
33357 \begin_inset Quotes eld
33358 \end_inset
33359
33360
33361 \family typewriter
33362 char
33363 \family default
33364
33365 \begin_inset Quotes erd
33366 \end_inset
33367
33368 .
33369 \end_layout
33370
33371 \begin_layout Enumerate
33372
33373 \size small
33374 You should use either
33375 \family typewriter
33376
33377 \begin_inset Quotes eld
33378 \end_inset
33379
33380
33381 \family default
33382  or
33383 \family typewriter
33384
33385 \begin_inset Quotes erd
33386 \end_inset
33387
33388
33389 \family default
33390  as an alternative to
33391 \begin_inset Quotes eld
33392 \end_inset
33393
33394
33395 \family typewriter
33396 "
33397 \family default
33398
33399 \begin_inset Quotes erd
33400 \end_inset
33401
33402 .
33403 \end_layout
33404
33405 \begin_layout Enumerate
33406
33407 \size small
33408 You should use "
33409 \family typewriter
33410 '
33411 \family default
33412 " (ASCII 39) instead of "
33413 \family typewriter
33414 ´
33415 \family default
33416 " (ASCII 180).
33417 \end_layout
33418
33419 \begin_layout Enumerate
33420
33421 \size small
33422 User-specified pattern found.
33423 \end_layout
33424
33425 \begin_layout Enumerate
33426
33427 \size small
33428 This command might not be intended.
33429 \end_layout
33430
33431 \begin_layout Enumerate
33432
33433 \size small
33434 \emph on
33435 Comment displayed.
33436 \end_layout
33437
33438 \begin_layout Enumerate
33439
33440 \size small
33441 Either
33442 \family typewriter
33443 ''
33444 \backslash
33445 ,'
33446 \family default
33447  or
33448 \family typewriter
33449 '
33450 \backslash
33451 ,''
33452 \family default
33453  will look better.
33454 \end_layout
33455
33456 \begin_layout Enumerate
33457
33458 \size small
33459 Delete this space to maintain correct page references.
33460 \end_layout
33461
33462 \begin_layout Enumerate
33463
33464 \size small
33465 \emph on
33466 You might wish to put this between a pair of
33467 \begin_inset Quotes eld
33468 \end_inset
33469
33470
33471 \family typewriter
33472 {}
33473 \family default
33474
33475 \begin_inset Quotes erd
33476 \end_inset
33477
33478 .
33479 \end_layout
33480
33481 \begin_layout Enumerate
33482
33483 \size small
33484 You ought to remove spaces in front of punctuation.
33485 \end_layout
33486
33487 \begin_layout Enumerate
33488
33489 \size small
33490 Could not execute \SpecialChar LaTeX
33491  command.
33492 \end_layout
33493
33494 \begin_layout Enumerate
33495
33496 \size small
33497 Don't use
33498 \family typewriter
33499
33500 \backslash
33501 /
33502 \family default
33503  in front of small punctuation.
33504 \end_layout
33505
33506 \begin_layout Enumerate
33507
33508 \family typewriter
33509 \size small
33510 $
33511 \backslash
33512 times$
33513 \family default
33514  may look prettier here.
33515 \end_layout
33516
33517 \begin_layout Enumerate
33518
33519 \size small
33520 \emph on
33521 Multiple spaces detected in output.
33522 \end_layout
33523
33524 \begin_layout Enumerate
33525
33526 \size small
33527 This text may be ignored.
33528 \end_layout
33529
33530 \begin_layout Enumerate
33531
33532 \size small
33533 Use
33534 \family typewriter
33535
33536 \begin_inset Quotes eld
33537 \end_inset
33538
33539
33540 \family default
33541  to begin quotation,
33542  not
33543 \family typewriter
33544 '
33545 \family default
33546 .
33547 \end_layout
33548
33549 \begin_layout Enumerate
33550
33551 \size small
33552 Use
33553 \family typewriter
33554 '
33555 \family default
33556  to end quotation,
33557  not
33558 \family typewriter
33559
33560 \begin_inset Quotes eld
33561 \end_inset
33562
33563
33564 \family default
33565 .
33566 \end_layout
33567
33568 \begin_layout Enumerate
33569
33570 \size small
33571 Don't mix quotes.
33572 \end_layout
33573
33574 \begin_layout Enumerate
33575
33576 \size small
33577 You should perhaps use
33578 \begin_inset Quotes eld
33579 \end_inset
33580
33581
33582 \family typewriter
33583 cmd
33584 \family default
33585
33586 \begin_inset Quotes erd
33587 \end_inset
33588
33589  instead.
33590 \end_layout
33591
33592 \begin_layout Enumerate
33593
33594 \size small
33595 You should put a space in front of/after parenthesis.
33596 \end_layout
33597
33598 \begin_layout Enumerate
33599
33600 \size small
33601 You should avoid spaces in front of/after parenthesis.
33602 \end_layout
33603
33604 \begin_layout Enumerate
33605
33606 \size small
33607 \emph on
33608 You should not use punctuation in front of/after quotes.
33609 \end_layout
33610
33611 \begin_layout Enumerate
33612
33613 \size small
33614 Double space found.
33615 \end_layout
33616
33617 \begin_layout Enumerate
33618
33619 \size small
33620 You should put punctuation outside inner/inside display math mode.
33621 \end_layout
33622
33623 \begin_layout Enumerate
33624
33625 \size small
33626 You ought to not use primitive \SpecialChar TeX
33627  in \SpecialChar LaTeX
33628  code.
33629 \end_layout
33630
33631 \begin_layout Enumerate
33632
33633 \size small
33634 You should remove spaces in front of
33635 \begin_inset Quotes eld
33636 \end_inset
33637
33638
33639 \family typewriter
33640 %s
33641 \family default
33642
33643 \begin_inset Quotes erd
33644 \end_inset
33645
33646
33647 \end_layout
33648
33649 \begin_layout Enumerate
33650
33651 \size small
33652 \begin_inset Quotes eld
33653 \end_inset
33654
33655
33656 \family typewriter
33657 %s
33658 \family default
33659
33660 \begin_inset Quotes erd
33661 \end_inset
33662
33663  is normally not followed by
33664 \begin_inset Quotes eld
33665 \end_inset
33666
33667
33668 \family typewriter
33669 %c
33670 \family default
33671
33672 \begin_inset Quotes erd
33673 \end_inset
33674
33675 .
33676 \end_layout
33677
33678 \begin_layout Standard
33679 In later versions of \SpecialChar LyX
33680 ,
33681  we hope to provide a more complete interface to this tool (and it's smaller cousin
33682 \family typewriter
33683 lacheck
33684 \family default
33685 ) to exploit the full power of it.
33686  But it's not exactly useless as it is now:
33687  go try it on one of your existing documents of a certain length and be surprised.
33688 \end_layout
33689
33690 \begin_layout Section
33691 Version Control in \SpecialChar LyX
33692
33693 \end_layout
33694
33695 \begin_layout Standard
33696 by
33697 \noun on
33698  Lars Gullik Bjønnes
33699 \noun default
33700 and
33701 \noun on
33702 Pavel Sanda
33703 \end_layout
33704
33705 \begin_layout Subsection
33706 Introduction
33707 \end_layout
33708
33709 \begin_layout Standard
33710 \SpecialChar LyX
33711  supports some of the most basic RCS/CVS/SVN/GIT commands.
33712  If you need something a bit more sophisticated you will have to do that manually in a terminal.
33713 \end_layout
33714
33715 \begin_layout Standard
33716 Also note that CVS support is not as good as subversion support,
33717  so we advise using SVN instead.
33718  A good place to start learning Subversion is the SVN Book
33719 \begin_inset Foot
33720 status collapsed
33721
33722 \begin_layout Plain Layout
33723 \begin_inset CommandInset href
33724 LatexCommand href
33725 target "http://svnbook.red-bean.com/"
33726 literal "false"
33727
33728 \end_inset
33729
33730
33731 \end_layout
33732
33733 \end_inset
33734
33735 .
33736  In the case of RCS you should read
33737 \begin_inset Quotes eld
33738 \end_inset
33739
33740 rcsintro
33741 \begin_inset Quotes erd
33742 \end_inset
33743
33744  (a man file,
33745  read it with
33746 \family typewriter
33747 man rcsintro
33748 \family default
33749 ).
33750  This file describes all the basic features of RCS.
33751  You should especially notice the comment about a RCS directory,
33752  and the notion of a master RCS file (the file ending in
33753 \family typewriter
33754 ,v
33755 \family default
33756 ).
33757 \end_layout
33758
33759 \begin_layout Standard
33760 Before you begin to use the version control features in \SpecialChar LyX
33761 ,
33762  you should be familiar with RCS/CVS/SVN/GIT usage.
33763  The implementation in \SpecialChar LyX
33764  assumes a recent version of the GNU RCS or CVS/SVN package —
33765  no guarantees are made for older versions.
33766  Most of the log messages are not currently displayed after operations —
33767  you can check them in the Messages pane if you are unsure.
33768  Regular users of version control will appreciate the VC toolbar,
33769  which can be enabled via
33770 \family sans
33771 View\SpecialChar menuseparator
33772 Toolbars\SpecialChar menuseparator
33773 Version
33774 \begin_inset space ~
33775 \end_inset
33776
33777 Control
33778 \family default
33779 .
33780 \end_layout
33781
33782 \begin_layout Standard
33783 For introducing your own external commands consult
33784 \begin_inset Flex Code
33785 status collapsed
33786
33787 \begin_layout Plain Layout
33788 vc-command
33789 \end_layout
33790
33791 \end_inset
33792
33793  in the manual
33794 \emph on
33795 \SpecialChar LyX
33796  Functions
33797 \emph default
33798 .
33799 \end_layout
33800
33801 \begin_layout Standard
33802 It is strongly recommended to store documents in uncompressed format if using version control (uncheck
33803 \family sans
33804 Document\SpecialChar menuseparator
33805 Compressed
33806 \family default
33807  if it is checked):
33808  Uncompressed LyX documents are text files and therefore for merging two different versions by version control systems.
33809  Compressed LyX documents are binary files,
33810  which cannot be merged by version control systems.
33811 \end_layout
33812
33813 \begin_layout Subsection
33814 RCS commands in \SpecialChar LyX
33815
33816 \end_layout
33817
33818 \begin_layout Standard
33819 The following sections describe the RCS commands supported by \SpecialChar LyX
33820 .
33821  You can find them in the
33822 \family sans
33823 File\SpecialChar menuseparator
33824 Version
33825 \begin_inset space ~
33826 \end_inset
33827
33828 Control
33829 \family default
33830  submenu.
33831  \SpecialChar LyX
33832  was tested against RCS 5.7/5.8.
33833 \end_layout
33834
33835 \begin_layout Subsubsection
33836
33837 \family sans
33838 Register
33839 \end_layout
33840
33841 \begin_layout Standard
33842 If your document is not under revision control,
33843  this is the only item shown in the menu.
33844  And if it is under revision control,
33845  the
33846 \family sans
33847 Register
33848 \family default
33849  item is not visible.
33850
33851 \end_layout
33852
33853 \begin_layout Standard
33854 This command registers your document with RCS (unless you are under the directory managed by CVS)\SpecialChar endofsentence
33855  You are asked interactively to supply an initial description of the document.
33856  The document is now set in Read-Only mode and you have to
33857 \family sans
33858 Check
33859 \begin_inset space ~
33860 \end_inset
33861
33862 Out
33863 \begin_inset space ~
33864 \end_inset
33865
33866 For
33867 \begin_inset space ~
33868 \end_inset
33869
33870 Edit
33871 \family default
33872 ,
33873  before making any changes to it.
33874  A document under revision control has a
33875 \begin_inset Quotes eld
33876 \end_inset
33877
33878 [RCS:<version> <locker>]
33879 \begin_inset Quotes erd
33880 \end_inset
33881
33882  item tagged to the filename in the minibuffer.
33883 \end_layout
33884
33885 \begin_layout Standard
33886 RCS command that is run:
33887 \end_layout
33888
33889 \begin_layout LyX-Code
33890
33891 \family typewriter
33892 ci -q -u -i -t-"<initial description>" <file-name>
33893 \end_layout
33894
33895 \begin_layout Standard
33896 Read
33897 \family typewriter
33898 man ci
33899 \family default
33900  to understand the switches.
33901
33902 \end_layout
33903
33904 \begin_layout Subsubsection
33905
33906 \family sans
33907 Check In Changes
33908 \end_layout
33909
33910 \begin_layout Standard
33911 When you are finished editing a file,
33912  you check in your changes.
33913  When you do this,
33914  you are asked for a description of the changes.
33915  This is stored in the history log.
33916  The version number is bumped,
33917  your changes are applied to the master RCS file,
33918  the document is unlocked and set to Read-Only mode.
33919 \end_layout
33920
33921 \begin_layout Itemize
33922 RCS command:
33923
33924 \family typewriter
33925 ci -q -u -m"<description>" <file-name>
33926 \end_layout
33927
33928 \begin_layout Subsubsection
33929
33930 \family sans
33931 Check Out For Edit
33932 \end_layout
33933
33934 \begin_layout Standard
33935 By doing this you lock the document so that only you can edit it.
33936  This will also make the document Read-Write only for you.
33937  You will usually continue editing for a while and when you are finished you check in your changes.
33938  The status line is changed to reflect that you have locked the file.
33939 \end_layout
33940
33941 \begin_layout Itemize
33942 RCS command:
33943
33944 \family typewriter
33945 co -q -l <file-name>
33946 \end_layout
33947
33948 \begin_layout Subsubsection
33949
33950 \family sans
33951 Revert To Repository Version
33952 \end_layout
33953
33954 \begin_layout Standard
33955 This will discard all changes made to the document since the last check in.
33956  You get a warning before changes are discarded.
33957 \end_layout
33958
33959 \begin_layout Itemize
33960 RCS command:
33961
33962 \family typewriter
33963 co -f -u<version> <file-name>
33964 \end_layout
33965
33966 \begin_layout Subsubsection
33967
33968 \family sans
33969 Copy
33970 \end_layout
33971
33972 \begin_layout Standard
33973 This will create a copy of the current document.
33974  Since RCS does not support copy operations natively,
33975  the version history is not preserved,
33976  and the copy is added as a new file.
33977  It requires a clean document without any changes since the last checkin.
33978  You are asked for a file name and a description of the copy operation.
33979  After that the copy is created,
33980  both locally and in the repository.
33981  If the parent directories of the copied and original document differ,
33982  all relative paths of included files of the copy are adjusted (like in
33983 \family sans
33984 File\SpecialChar menuseparator
33985 Save As
33986 \family default
33987 \SpecialChar ldots
33988 ).
33989  Finally,
33990  the copy is loaded instead of the original document.
33991 \end_layout
33992
33993 \begin_layout Labeling
33994 \labelwidthstring 00.00.0000
33995 RCS
33996 \begin_inset space ~
33997 \end_inset
33998
33999 commands:
34000
34001 \begin_inset space ~
34002 \end_inset
34003
34004
34005 \begin_inset Newline newline
34006 \end_inset
34007
34008 Copy
34009 \begin_inset Flex Code
34010 status collapsed
34011
34012 \begin_layout Plain Layout
34013
34014 \family typewriter
34015 \begin_inset Quotes qld
34016 \end_inset
34017
34018 <file-name>
34019 \begin_inset Quotes qld
34020 \end_inset
34021
34022
34023 \end_layout
34024
34025 \end_inset
34026
34027  to
34028 \begin_inset Flex Code
34029 status collapsed
34030
34031 \begin_layout Plain Layout
34032
34033 \family typewriter
34034 \begin_inset Quotes qld
34035 \end_inset
34036
34037 <new-file-name>
34038 \begin_inset Quotes qld
34039 \end_inset
34040
34041
34042 \end_layout
34043
34044 \end_inset
34045
34046
34047 \begin_inset Newline newline
34048 \end_inset
34049
34050
34051 \begin_inset Flex Code
34052 status collapsed
34053
34054 \begin_layout Plain Layout
34055 ci -q -u
34056 \family typewriter
34057 -i
34058 \begin_inset Quotes qld
34059 \end_inset
34060
34061 <new-file-name>
34062 \begin_inset Quotes qld
34063 \end_inset
34064
34065
34066 \end_layout
34067
34068 \end_inset
34069
34070
34071 \end_layout
34072
34073 \begin_layout Subsubsection
34074
34075 \family sans
34076 Undo Last Checkin
34077 \end_layout
34078
34079 \begin_layout Standard
34080 This makes as if the last check in never happened.
34081  No changes are made to the document loaded into \SpecialChar LyX
34082 ,
34083  but the last version is removed from the master RCS file.
34084 \end_layout
34085
34086 \begin_layout Itemize
34087 RCS command:
34088
34089 \family typewriter
34090 rcs -o<version> <file-name>
34091 \end_layout
34092
34093 \begin_layout Subsubsection
34094
34095 \family sans
34096 Show History
34097 \end_layout
34098
34099 \begin_layout Standard
34100 This shows the complete history of the RCS document.
34101  The output of
34102 \family typewriter
34103 rlog <file-name>
34104 \family default
34105  is shown in a browser.
34106  See
34107 \family typewriter
34108 man rlog
34109 \family default
34110  for more info.
34111 \end_layout
34112
34113 \begin_layout Subsubsection
34114 Revision info
34115 \end_layout
34116
34117 \begin_layout Standard
34118 \SpecialChar LyX
34119  supports RCS version number,
34120  author name,
34121  date and time of last commit.
34122  All those are extracted from
34123 \family typewriter
34124 rlog -r <file-name>
34125 \family default
34126 .
34127  See
34128 \begin_inset CommandInset ref
34129 LatexCommand ref
34130 reference "subsec:VCS-Revision-Information"
34131 nolink "false"
34132
34133 \end_inset
34134
34135  for details.
34136 \end_layout
34137
34138 \begin_layout Subsection
34139 CVS commands in \SpecialChar LyX
34140
34141 \end_layout
34142
34143 \begin_layout Standard
34144 A subset of CVS operations is supported by \SpecialChar LyX
34145 .
34146  You can find the commands in the
34147 \family sans
34148 File\SpecialChar menuseparator
34149 Version
34150 \begin_inset space ~
34151 \end_inset
34152
34153 Control
34154 \family default
34155  submenu.
34156  The version control system SVN is more powerful,
34157  so please use it instead of CVS if possible.
34158 \end_layout
34159
34160 \begin_layout Subsubsection
34161
34162 \family sans
34163 General CVS usage
34164 \end_layout
34165
34166 \begin_layout Standard
34167 If you start from scratch with CVS you have to create your repository and checkout the working copy with external tools.
34168  If you're using a client-server setup you may need to login before doing the first repository checkout.
34169 \end_layout
34170
34171 \begin_layout Standard
34172 If your documents are under revision control and others are using the same repository problems arise when different changes to the same document at the same location happen.
34173  Standard CVS repositories don't operate with a file locking mechanism.
34174  This may be surprising,
34175  but conflicts only occur if people disagree on the proper content of the same part of a document.
34176  So,
34177  if co-workers are used to communicate regularly,
34178  these conflicts occur rarely.
34179  If they don't communicate they have a fundamental problem anyway.
34180  Nevertheless some people like to work with so called
34181 \begin_inset Quotes eld
34182 \end_inset
34183
34184 reserved checkouts
34185 \begin_inset Quotes erd
34186 \end_inset
34187
34188 .
34189  If they do so the working copy of all files is readonly when checked out first and the user starts editing after using a special command to make the working copy writable.
34190  When the changes are checked in the working copy returns to readonly state.
34191  With \SpecialChar LyX
34192  one has to edit the
34193 \begin_inset Flex Code
34194 status collapsed
34195
34196 \begin_layout Plain Layout
34197 .cvsrc
34198 \end_layout
34199
34200 \end_inset
34201
34202  file and add the line
34203 \begin_inset Flex Code
34204 status collapsed
34205
34206 \begin_layout Plain Layout
34207 cvs -r
34208 \end_layout
34209
34210 \end_inset
34211
34212  to work with reserved checkouts.
34213  The benefit is the possibility to see who is using a writable copy of some document.
34214  It's not guaranteed only one user makes a copy writable.
34215 \end_layout
34216
34217 \begin_layout Standard
34218 \SpecialChar LyX
34219  tries to guess if you're using reserved or non-reserved checkouts.
34220  If your working copy is readonly or it is writable and an additional copy of your document exists in the CVS/Base sub-directory a reserved otherwise a non-reserved checkout is assumed.
34221  When a reserved checkout is detected you have to use
34222 \begin_inset Flex Noun
34223 status collapsed
34224
34225 \begin_layout Plain Layout
34226 Check Out
34227 \end_layout
34228
34229 \end_inset
34230
34231  to make your working copy writable if it's readonly.
34232  After doing so the
34233 \begin_inset Flex Noun
34234 status collapsed
34235
34236 \begin_layout Plain Layout
34237 Check In
34238 \end_layout
34239
34240 \end_inset
34241
34242  operation is possible and that makes your working copy readonly again after transferring your changes to the repository.
34243 \end_layout
34244
34245 \begin_layout Standard
34246 More information about CVS can be found here
34247 \begin_inset Flex URL
34248 status collapsed
34249
34250 \begin_layout Plain Layout
34251
34252 http://www.nongnu.org/cvs
34253 \end_layout
34254
34255 \end_inset
34256
34257  and here
34258 \begin_inset Flex URL
34259 status collapsed
34260
34261 \begin_layout Plain Layout
34262
34263 http://ximbiot.com/cvs
34264 \end_layout
34265
34266 \end_inset
34267
34268 .
34269 \end_layout
34270
34271 \begin_layout Standard
34272 Read
34273 \family typewriter
34274 man cvs
34275 \family default
34276  to understand the sub-commands and the switches mentioned below.
34277 \end_layout
34278
34279 \begin_layout Subsubsection
34280
34281 \family sans
34282 Register
34283 \end_layout
34284
34285 \begin_layout Standard
34286 If your document is not under revision control,
34287  this is the only item shown in the menu.
34288  And if it is under revision control,
34289  the
34290 \family sans
34291 Register
34292 \family default
34293  item is not visible.
34294
34295 \end_layout
34296
34297 \begin_layout Standard
34298 This command registers in CVS your document
34299 \begin_inset Flex Strong
34300 status collapsed
34301
34302 \begin_layout Plain Layout
34303
34304 \emph on
34305 only
34306 \end_layout
34307
34308 \end_inset
34309
34310  in the case you have already the documents directory under CVS control (in particular
34311 \family typewriter
34312 CVS/Entries
34313 \family default
34314  file exists).
34315  This means you have to create or checkout the archive by yourself using external tools.
34316  (In case you forget that step \SpecialChar LyX
34317  registers the document with RCS.)
34318 \end_layout
34319
34320 \begin_layout Standard
34321 Then you are asked interactively to supply an initial description of the document.
34322  Don't forget that registered file is not yet checked in.
34323 \end_layout
34324
34325 \begin_layout Standard
34326 CVS command that is run:
34327
34328 \family typewriter
34329 cvs -q add -m"<entered message>" "<file-name>"
34330 \end_layout
34331
34332 \begin_layout Standard
34333 The term
34334 \family typewriter
34335 "<file-name>"
34336 \family default
34337  above and for all other CVS commands is an abbreviation for
34338 \begin_inset Quotes eld
34339 \end_inset
34340
34341 change the current working directory to file location and use the file name without path component as argument
34342 \begin_inset Quotes erd
34343 \end_inset
34344
34345 .
34346 \end_layout
34347
34348 \begin_layout Subsubsection
34349
34350 \family sans
34351 Check In Changes
34352 \end_layout
34353
34354 \begin_layout Standard
34355 When you are finished editing a file,
34356  you commit your changes.
34357  When you do this and you had changed the document,
34358  you are asked for a description of the changes.
34359  After that changes are written to the repository.
34360  In case you didn't change the document and a reserved checkout is detected the reservation made on
34361 \begin_inset Flex Noun
34362 status collapsed
34363
34364 \begin_layout Plain Layout
34365 Check Out
34366 \end_layout
34367
34368 \end_inset
34369
34370  is undone.
34371 \end_layout
34372
34373 \begin_layout Labeling
34374 \labelwidthstring 00.00.0000
34375 CVS
34376 \begin_inset space ~
34377 \end_inset
34378
34379 command:
34380
34381 \begin_inset space ~
34382 \end_inset
34383
34384
34385 \begin_inset Newline newline
34386 \end_inset
34387
34388
34389 \begin_inset Flex Code
34390 status collapsed
34391
34392 \begin_layout Plain Layout
34393 cvs
34394 \family typewriter
34395 -q commit -m"<description>" "<file-name>"
34396 \end_layout
34397
34398 \end_inset
34399
34400  or
34401 \begin_inset Newline newline
34402 \end_inset
34403
34404
34405 \begin_inset Flex Code
34406 status collapsed
34407
34408 \begin_layout Plain Layout
34409 cvs -q unedit
34410 \family typewriter
34411 "<file-name>"
34412 \end_layout
34413
34414 \end_inset
34415
34416
34417 \end_layout
34418
34419 \begin_layout Subsubsection
34420
34421 \family sans
34422 Check Out Changes
34423 \end_layout
34424
34425 \begin_layout Standard
34426 When you are sharing a repository with others,
34427  you may have to incorporate their changes into your working copy.
34428 \end_layout
34429
34430 \begin_layout Standard
34431 CVS command:
34432
34433 \family typewriter
34434 cvs -q update "<file-name>"
34435 \end_layout
34436
34437 \begin_layout Standard
34438 If a readonly checkout is detected the working copy is made writable and reserved.
34439 \end_layout
34440
34441 \begin_layout Standard
34442 CVS command:
34443
34444 \family typewriter
34445 cvs -q edit "<file-name>"
34446 \end_layout
34447
34448 \begin_layout Subsubsection
34449
34450 \family sans
34451 Revert To Repository Version
34452 \end_layout
34453
34454 \begin_layout Standard
34455 This will discard all changes made to the document since the last check in.
34456  You get a warning before changes are discarded.
34457  Firstly the file is deleted,
34458  secondly CVS update command is run.
34459 \end_layout
34460
34461 \begin_layout Standard
34462 CVS command:
34463
34464 \family typewriter
34465 cvs -q update "<file-name>"
34466 \end_layout
34467
34468 \begin_layout Standard
34469 If a reserved checkout is detected and the working copy has no changes only the reservation is undone.
34470 \end_layout
34471
34472 \begin_layout Standard
34473 CVS command:
34474
34475 \family typewriter
34476 cvs -q unedit "<file-name>"
34477 \end_layout
34478
34479 \begin_layout Subsubsection
34480
34481 \family sans
34482 Copy
34483 \end_layout
34484
34485 \begin_layout Standard
34486 This will create a copy of the current document.
34487  Since CVS does not support copy operations natively,
34488  the version history is not preserved,
34489  and the copy is added as a new file.
34490  It requires a clean document without any changes since the last checkin.
34491  You are asked for a file name and a description of the copy operation.
34492  After that the copy is created,
34493  both locally and in the repository.
34494  If the parent directories of the copied and original document differ,
34495  all relative paths of included files of the copy are adjusted (like in
34496 \family sans
34497 File\SpecialChar menuseparator
34498 Save As
34499 \family default
34500 \SpecialChar ldots
34501 ).
34502  Finally,
34503  the copy is loaded instead of the original document.
34504 \end_layout
34505
34506 \begin_layout Labeling
34507 \labelwidthstring 00.00.0000
34508 CVS
34509 \begin_inset space ~
34510 \end_inset
34511
34512 commands:
34513
34514 \begin_inset space ~
34515 \end_inset
34516
34517
34518 \begin_inset Newline newline
34519 \end_inset
34520
34521 Copy
34522 \begin_inset Flex Code
34523 status collapsed
34524
34525 \begin_layout Plain Layout
34526 "<file-name>"
34527 \end_layout
34528
34529 \end_inset
34530
34531  to
34532 \begin_inset Flex Code
34533 status collapsed
34534
34535 \begin_layout Plain Layout
34536 "<new-file-name>"
34537 \end_layout
34538
34539 \end_inset
34540
34541
34542 \begin_inset Newline newline
34543 \end_inset
34544
34545
34546 \begin_inset Flex Code
34547 status collapsed
34548
34549 \begin_layout Plain Layout
34550 cvs -q add "<new-file-name>"
34551 \end_layout
34552
34553 \end_inset
34554
34555
34556 \end_layout
34557
34558 \begin_layout Subsubsection
34559
34560 \family sans
34561 Rename
34562 \end_layout
34563
34564 \begin_layout Standard
34565 This will rename the current document.
34566  Since CVS does not support rename operations natively,
34567  the version history is not preserved,
34568  the renamed document is added as a new file,
34569  and the original document is deleted.
34570  It requires a clean document without any changes since the last checkin.
34571  You are asked for a file name and a description of the rename operation.
34572  After that the document is renamed,
34573  both locally and in the repository.
34574  If the parent directories of the new and old file names differ,
34575  all relative paths of included files are adjusted (like in
34576 \family sans
34577 File\SpecialChar menuseparator
34578 Save As
34579 \family default
34580 \SpecialChar ldots
34581 ).
34582  Finally,
34583  the document is reloaded using the new name.
34584 \end_layout
34585
34586 \begin_layout Labeling
34587 \labelwidthstring 00.00.0000
34588 CVS
34589 \begin_inset space ~
34590 \end_inset
34591
34592 commands:
34593
34594 \begin_inset space ~
34595 \end_inset
34596
34597
34598 \begin_inset Newline newline
34599 \end_inset
34600
34601 Rename
34602 \begin_inset Flex Code
34603 status collapsed
34604
34605 \begin_layout Plain Layout
34606 "<file-name>"
34607 \end_layout
34608
34609 \end_inset
34610
34611  to
34612 \begin_inset Flex Code
34613 status collapsed
34614
34615 \begin_layout Plain Layout
34616 "<new-file-name>"
34617 \end_layout
34618
34619 \end_inset
34620
34621
34622 \begin_inset Newline newline
34623 \end_inset
34624
34625
34626 \begin_inset Flex Code
34627 status collapsed
34628
34629 \begin_layout Plain Layout
34630 cvs -q add "<new-file-name>"
34631 \end_layout
34632
34633 \end_inset
34634
34635
34636 \begin_inset Newline newline
34637 \end_inset
34638
34639
34640 \begin_inset Flex Code
34641 status collapsed
34642
34643 \begin_layout Plain Layout
34644 cvs -q remove "<file-name>"
34645 \end_layout
34646
34647 \end_inset
34648
34649
34650 \end_layout
34651
34652 \begin_layout Subsubsection
34653 Update of the local directory checkout from repository
34654 \end_layout
34655
34656 \begin_layout Standard
34657 Once your documents gets more complex,
34658  containing sub-documents and pictures,
34659  including external
34660 \begin_inset Flex Code
34661 status collapsed
34662
34663 \begin_layout Plain Layout
34664 .tex
34665 \end_layout
34666
34667 \end_inset
34668
34669  files and so on using version control becomes more complicated.
34670  \SpecialChar LyX
34671  supports updating the whole tree in which resides the document.
34672  This become especially useful once you cooperate with people which neither have detailed knowledge about CVS usage nor they have ambition to commit additional material to the repository.
34673  You have to organize the files structure so that all external files are in the same directory or subdirectories of the document.
34674  It's good practice anyway to store multipart documents in an extra directory.
34675 \end_layout
34676
34677 \begin_layout Standard
34678 The
34679 \begin_inset Flex Code
34680 status collapsed
34681
34682 \begin_layout Plain Layout
34683 Update local directory from repository
34684 \end_layout
34685
34686 \end_inset
34687
34688  command updates the whole directory.
34689  If local changes are detected user is warned before update starts.
34690  In case of merge conflicts both versions of the conflicting document parts are placed in the final document.
34691  You have to review and correct the result of the merge.
34692  You'll find the conflicts enclosed in pairs of
34693 \begin_inset Flex Code
34694 status collapsed
34695
34696 \begin_layout Plain Layout
34697 <<<<<<<
34698 \end_layout
34699
34700 \end_inset
34701
34702  and
34703 \begin_inset Flex Code
34704 status collapsed
34705
34706 \begin_layout Plain Layout
34707 >>>>>>>
34708 \end_layout
34709
34710 \end_inset
34711
34712  separated by
34713 \begin_inset Flex Code
34714 status collapsed
34715
34716 \begin_layout Plain Layout
34717 =======
34718 \end_layout
34719
34720 \end_inset
34721
34722 .
34723  The first part is your version as before the update operation with the document name prepended.
34724  The second one is the repository version with the version number after the sequence of
34725 \begin_inset Flex Code
34726 status collapsed
34727
34728 \begin_layout Plain Layout
34729 >
34730 \end_layout
34731
34732 \end_inset
34733
34734  signs.
34735 \end_layout
34736
34737 \begin_layout Labeling
34738 \labelwidthstring 00.00.0000
34739 CVS
34740 \begin_inset space ~
34741 \end_inset
34742
34743 commands:
34744
34745 \begin_inset space ~
34746 \end_inset
34747
34748
34749 \begin_inset Newline newline
34750 \end_inset
34751
34752
34753 \begin_inset Flex Code
34754 status collapsed
34755
34756 \begin_layout Plain Layout
34757 cd $path;
34758  cvs diff
34759 \family typewriter
34760 "."
34761 \end_layout
34762
34763 \end_inset
34764
34765  (Ask if changes are detected.)
34766 \begin_inset Newline newline
34767 \end_inset
34768
34769
34770 \begin_inset Flex Code
34771 status collapsed
34772
34773 \begin_layout Plain Layout
34774 cd $path;
34775  cvs -q update
34776 \family typewriter
34777 "."
34778 \end_layout
34779
34780 \end_inset
34781
34782
34783 \end_layout
34784
34785 \begin_layout Standard
34786 where
34787 \begin_inset Flex Code
34788 status collapsed
34789
34790 \begin_layout Plain Layout
34791 $path
34792 \end_layout
34793
34794 \end_inset
34795
34796  stands for the path to the document.
34797 \end_layout
34798
34799 \begin_layout Subsubsection
34800
34801 \family sans
34802 Show History
34803 \end_layout
34804
34805 \begin_layout Standard
34806 This shows the complete history of the CVS document.
34807  The output of
34808 \family typewriter
34809 cvs log "<file-name>"
34810 \family default
34811  is shown in a browser.
34812 \end_layout
34813
34814 \begin_layout Subsubsection
34815 Revision info
34816 \end_layout
34817
34818 \begin_layout Standard
34819 \SpecialChar LyX
34820  supports CVS version number,
34821  author name,
34822  date and time of last commit.
34823  All those are extracted from
34824 \family typewriter
34825 cvs log -r <file-name>
34826 \family default
34827 .
34828  See
34829 \begin_inset CommandInset ref
34830 LatexCommand ref
34831 reference "subsec:VCS-Revision-Information"
34832 nolink "false"
34833
34834 \end_inset
34835
34836  for details.
34837 \end_layout
34838
34839 \begin_layout Subsection
34840 SVN commands in \SpecialChar LyX
34841
34842 \end_layout
34843
34844 \begin_layout Standard
34845 SVN is now partially supported by \SpecialChar LyX
34846 .
34847  You can find the commands in the
34848 \family sans
34849 File\SpecialChar menuseparator
34850 Version
34851 \begin_inset space ~
34852 \end_inset
34853
34854 Control
34855 \family default
34856  submenu.
34857  Please note that if you use password protected access to repository via ssh,
34858  you will be asked in terminal window.
34859  \SpecialChar LyX
34860  was tested against SVN 1.5,
34861  1.6,
34862  1.7 and 1.8
34863 \begin_inset Foot
34864 status collapsed
34865
34866 \begin_layout Plain Layout
34867 Most of the commands will work with 1.4 too,
34868  see
34869 \begin_inset CommandInset ref
34870 LatexCommand ref
34871 reference "subsec:SVN-Repo-Update"
34872 nolink "false"
34873
34874 \end_inset
34875
34876 .
34877  There seems to be currently unresolved permissions problem under SVN 1.8 with reverting changes when file is locked.
34878 \end_layout
34879
34880 \end_inset
34881
34882
34883 \end_layout
34884
34885 \begin_layout Subsubsection
34886
34887 \family sans
34888 Register
34889 \end_layout
34890
34891 \begin_layout Standard
34892 If your document is not under revision control,
34893  this is the only item shown in the menu.
34894  And if it is under revision control,
34895  the
34896 \family sans
34897 Register
34898 \family default
34899  item is not visible.
34900 \end_layout
34901
34902 \begin_layout Standard
34903 This command registers in SVN your document ONLY in case you have already the documents directory under SVN control (in particular
34904 \family typewriter
34905 .svn/entries
34906 \family default
34907  file exists).
34908  This means you have to checkout the archive by yourself.
34909 \end_layout
34910
34911 \begin_layout Standard
34912 Then you are asked interactively to supply an initial description of the document.
34913  Don't forget that registered file is not yet commited.
34914 \end_layout
34915
34916 \begin_layout Standard
34917 SVN command that is run:
34918
34919 \family typewriter
34920 svn add -q
34921 \begin_inset Quotes qld
34922 \end_inset
34923
34924 <file-name>
34925 \begin_inset Quotes qld
34926 \end_inset
34927
34928
34929 \end_layout
34930
34931 \begin_layout Standard
34932 Read
34933 \family typewriter
34934 man svn
34935 \family default
34936  to understand the switches.
34937 \end_layout
34938
34939 \begin_layout Subsubsection
34940
34941 \family sans
34942 Check In Changes
34943 \end_layout
34944
34945 \begin_layout Standard
34946 When you are finished editing a file,
34947  you commit your changes.
34948  When you do this,
34949  you are asked for a description of the changes.
34950  After that changes are commited.
34951 \end_layout
34952
34953 \begin_layout Standard
34954 SVN command:
34955 \begin_inset Foot
34956 status collapsed
34957
34958 \begin_layout Plain Layout
34959 In case locking is not enabled.
34960  See Section
34961 \begin_inset CommandInset ref
34962 LatexCommand ref
34963 reference "subsec:SVN-File-Locking"
34964 nolink "false"
34965
34966 \end_inset
34967
34968 .
34969 \end_layout
34970
34971 \end_inset
34972
34973
34974 \family typewriter
34975 svn commit -q -m"<description>" <file-name>
34976 \end_layout
34977
34978 \begin_layout Subsubsection
34979
34980 \family sans
34981 Check Out For Edit
34982 \end_layout
34983
34984 \begin_layout Standard
34985 Updates the changes of this file from the repository.
34986  Be sure you understand SVN merging and conflicts resolving before using this function,
34987  because all conflicts has to be resolved manually by you!
34988 \end_layout
34989
34990 \begin_layout Standard
34991 SVN command:
34992 \begin_inset Foot
34993 status collapsed
34994
34995 \begin_layout Plain Layout
34996 Ditto.
34997 \end_layout
34998
34999 \end_inset
35000
35001
35002 \family typewriter
35003 svn update --non-interactive
35004 \begin_inset Quotes qld
35005 \end_inset
35006
35007 <file-name>
35008 \begin_inset Quotes qld
35009 \end_inset
35010
35011
35012 \end_layout
35013
35014 \begin_layout Subsubsection
35015
35016 \family sans
35017 Revert To Repository Version
35018 \end_layout
35019
35020 \begin_layout Standard
35021 This will discard all changes made to the document since the last check in.
35022  You get a warning before changes are discarded.
35023 \end_layout
35024
35025 \begin_layout Standard
35026 SVN command:
35027
35028 \family typewriter
35029 svn revert -q
35030 \begin_inset Quotes qld
35031 \end_inset
35032
35033 <file-name>
35034 \begin_inset Quotes qld
35035 \end_inset
35036
35037
35038 \end_layout
35039
35040 \begin_layout Subsubsection
35041
35042 \family sans
35043 Copy
35044 \end_layout
35045
35046 \begin_layout Standard
35047 This will create a copy of the current document including the version history.
35048  It requires a clean document without any changes since the last checkin.
35049  You are asked for a file name and a description of the copy operation.
35050  After that the copy is created,
35051  both locally and in the repository.
35052  If the parent directories of the copied and original document differ,
35053  all relative paths of included files of the copy are adjusted (like in
35054 \family sans
35055 File\SpecialChar menuseparator
35056 Save As
35057 \family default
35058 \SpecialChar ldots
35059 ).
35060  Finally,
35061  the copy is loaded instead of the original document.
35062 \end_layout
35063
35064 \begin_layout Labeling
35065 \labelwidthstring 00.00.0000
35066 SVN
35067 \begin_inset space ~
35068 \end_inset
35069
35070 commands:
35071
35072 \begin_inset space ~
35073 \end_inset
35074
35075
35076 \begin_inset Newline newline
35077 \end_inset
35078
35079
35080 \begin_inset Flex Code
35081 status collapsed
35082
35083 \begin_layout Plain Layout
35084 svn copy -q
35085 \family typewriter
35086
35087 \begin_inset Quotes qld
35088 \end_inset
35089
35090 <file-name>
35091 \begin_inset Quotes qld
35092 \end_inset
35093
35094
35095 \begin_inset Quotes qld
35096 \end_inset
35097
35098 <new-file-name>
35099 \begin_inset Quotes qld
35100 \end_inset
35101
35102
35103 \end_layout
35104
35105 \end_inset
35106
35107
35108 \begin_inset Newline newline
35109 \end_inset
35110
35111
35112 \begin_inset Flex Code
35113 status collapsed
35114
35115 \begin_layout Plain Layout
35116 svn commit
35117 \end_layout
35118
35119 \end_inset
35120
35121
35122 \end_layout
35123
35124 \begin_layout Subsubsection
35125
35126 \family sans
35127 Rename
35128 \end_layout
35129
35130 \begin_layout Standard
35131 This will rename the current document including the version history.
35132  It requires a clean document without any changes since the last checkin.
35133  You are asked for a file name and a description of the rename operation.
35134  After that the document is renamed,
35135  both locally and in the repository.
35136  If the parent directories of the new and old file names differ,
35137  all relative paths of included files are adjusted (like in
35138 \family sans
35139 File\SpecialChar menuseparator
35140 Save As
35141 \family default
35142 \SpecialChar ldots
35143 ).
35144  Finally,
35145  the document is reloaded using the new name.
35146 \end_layout
35147
35148 \begin_layout Labeling
35149 \labelwidthstring 00.00.0000
35150 SVN
35151 \begin_inset space ~
35152 \end_inset
35153
35154 commands:
35155
35156 \begin_inset space ~
35157 \end_inset
35158
35159
35160 \begin_inset Newline newline
35161 \end_inset
35162
35163
35164 \begin_inset Flex Code
35165 status collapsed
35166
35167 \begin_layout Plain Layout
35168 svn move -q
35169 \family typewriter
35170
35171 \begin_inset Quotes qld
35172 \end_inset
35173
35174 <file-name>
35175 \begin_inset Quotes qld
35176 \end_inset
35177
35178
35179 \begin_inset Quotes qld
35180 \end_inset
35181
35182 <new-file-name>
35183 \begin_inset Quotes qld
35184 \end_inset
35185
35186
35187 \end_layout
35188
35189 \end_inset
35190
35191
35192 \begin_inset Newline newline
35193 \end_inset
35194
35195
35196 \begin_inset Flex Code
35197 status collapsed
35198
35199 \begin_layout Plain Layout
35200 svn commit
35201 \end_layout
35202
35203 \end_inset
35204
35205
35206 \end_layout
35207
35208 \begin_layout Subsubsection
35209 \begin_inset CommandInset label
35210 LatexCommand label
35211 name "subsec:SVN-Repo-Update"
35212
35213 \end_inset
35214
35215 Update of the local directory checkout from repository
35216 \begin_inset Foot
35217 status collapsed
35218
35219 \begin_layout Plain Layout
35220 Note that this command will work only with subversion
35221 \begin_inset Formula $\geqq1.5$
35222 \end_inset
35223
35224
35225 \end_layout
35226
35227 \end_inset
35228
35229
35230 \end_layout
35231
35232 \begin_layout Standard
35233 All the commands above have one shortcoming – they deal with the current document only.
35234  Once your document contains pictures,
35235  includes external
35236 \begin_inset Flex Code
35237 status collapsed
35238
35239 \begin_layout Plain Layout
35240 .tex
35241 \end_layout
35242
35243 \end_inset
35244
35245  files and so on administration becomes more complicated.
35246  \SpecialChar LyX
35247  now supports updating the whole tree in which resides the document
35248 \begin_inset Foot
35249 status collapsed
35250
35251 \begin_layout Plain Layout
35252 One need to organize the files structure so that all external files are in the same directory or subdirectories of the document.
35253
35254 \end_layout
35255
35256 \end_inset
35257
35258 .
35259  This become especially useful once you cooperate with people which neither know about subversion management nor they have ambition to commit additional material to the repository.
35260
35261 \end_layout
35262
35263 \begin_layout Standard
35264 \begin_inset Flex Code
35265 status collapsed
35266
35267 \begin_layout Plain Layout
35268 Update local directory from repository
35269 \end_layout
35270
35271 \end_inset
35272
35273  command updates the whole directory and in case of merge conflicts local version of the files are left,
35274  so no unintended data loss occurs.
35275  If local changes are detected user is warned before update starts.
35276 \end_layout
35277
35278 \begin_layout Labeling
35279 \labelwidthstring 00.00.0000
35280 SVN
35281 \begin_inset space ~
35282 \end_inset
35283
35284 commands:
35285
35286 \begin_inset space ~
35287 \end_inset
35288
35289
35290 \begin_inset Newline newline
35291 \end_inset
35292
35293
35294 \begin_inset Flex Code
35295 status collapsed
35296
35297 \begin_layout Plain Layout
35298 svn diff $path
35299 \end_layout
35300
35301 \end_inset
35302
35303  (Ask if changes are detected.)
35304 \begin_inset Newline newline
35305 \end_inset
35306
35307
35308 \begin_inset Flex Code
35309 status collapsed
35310
35311 \begin_layout Plain Layout
35312 svn update --accept mine-full $path
35313 \end_layout
35314
35315 \end_inset
35316
35317
35318 \end_layout
35319
35320 \begin_layout Standard
35321 where
35322 \begin_inset Flex Code
35323 status collapsed
35324
35325 \begin_layout Plain Layout
35326 $path
35327 \end_layout
35328
35329 \end_inset
35330
35331  stands for the path to the document.
35332 \end_layout
35333
35334 \begin_layout Subsubsection
35335
35336 \family sans
35337 Show History
35338 \end_layout
35339
35340 \begin_layout Standard
35341 This shows the complete history of the SVN document.
35342  The output of
35343 \family typewriter
35344 svn log
35345 \begin_inset Quotes qld
35346 \end_inset
35347
35348 <file-name>
35349 \begin_inset Quotes qld
35350 \end_inset
35351
35352
35353 \family default
35354  is shown in a browser.
35355 \end_layout
35356
35357 \begin_layout Subsubsection
35358 File Locking
35359 \begin_inset CommandInset label
35360 LatexCommand label
35361 name "subsec:SVN-File-Locking"
35362
35363 \end_inset
35364
35365
35366 \end_layout
35367
35368 \begin_layout Standard
35369 The file exchange through various revision control systems brings the problem of merge conflicts in case two different users try to edit the same (parts of) document.
35370  When such a conflict happens it needs manual resolving and one reasonable alternative is to provide some kind of locking mechanism,
35371  which guarantees that only one user is allowed to edit file at the given time.
35372 \end_layout
35373
35374 \begin_layout Standard
35375 SVN has two such mechanisms to provide mutual exclusivity for file access – locks and automatic setting of write permissions (see sec.
35376
35377 \begin_inset CommandInset ref
35378 LatexCommand ref
35379 reference "subsec:Automatical-Locking-Property"
35380 nolink "false"
35381
35382 \end_inset
35383
35384 ) based on
35385 \begin_inset Flex Code
35386 status collapsed
35387
35388 \begin_layout Plain Layout
35389 svn:needs-lock
35390 \end_layout
35391
35392 \end_inset
35393
35394  file svn property
35395 \begin_inset Foot
35396 status collapsed
35397
35398 \begin_layout Plain Layout
35399 \begin_inset Flex URL
35400 status open
35401
35402 \begin_layout Plain Layout
35403
35404 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
35405 \end_layout
35406
35407 \end_inset
35408
35409
35410 \end_layout
35411
35412 \end_inset
35413
35414 .
35415  If this property is detected for a given document \SpecialChar LyX
35416  starts to use SVN locks for document editing automatically and the whole check-in/out mechanism switches to the same regimen as for RCS.
35417  This in particular means there are two different modes of file use in \SpecialChar LyX
35418 :
35419 \end_layout
35420
35421 \begin_layout Itemize
35422 Unlocked state.
35423  The loaded file is in the read-only mode.
35424  For editing on needs to check-out.
35425
35426 \emph on
35427 Check-out
35428 \emph default
35429  consists of updating from the repository and gaining write lock.
35430  If the lock is not possible to obtain,
35431  we remain in unlocked state.
35432 \end_layout
35433
35434 \begin_layout Itemize
35435 Locked state.
35436  The loaded file is in the
35437 \begin_inset Quotes els
35438 \end_inset
35439
35440 normal
35441 \begin_inset Quotes ers
35442 \end_inset
35443
35444  edit mode.
35445  No other user is allowed to edit the file.
35446
35447 \emph on
35448 Check-in
35449 \emph default
35450  consists of commiting changes and releasing write-lock.
35451  If no changes have been made to the document,
35452  no commit will be produced
35453 \begin_inset Foot
35454 status collapsed
35455
35456 \begin_layout Plain Layout
35457 Don't be puzzled by the fact that you will be asked for commit message anyway.
35458 \end_layout
35459
35460 \end_inset
35461
35462  and only the write-lock will be released.
35463 \end_layout
35464
35465 \begin_layout Standard
35466 SVN commands:
35467 \end_layout
35468
35469 \begin_layout Labeling
35470 \labelwidthstring 00.00.0000
35471 Check-in:
35472
35473 \family typewriter
35474  svn commit -q -m"<description>" "<file-name>"
35475 \begin_inset Newline newline
35476 \end_inset
35477
35478 svn unlock "<file-name>"
35479 \end_layout
35480
35481 \begin_layout Labeling
35482 \labelwidthstring 00.00.0000
35483 Check-out:
35484
35485 \family typewriter
35486 svn update "<file-name>"
35487 \begin_inset Newline newline
35488 \end_inset
35489
35490 svn lock "<file-name>"
35491 \end_layout
35492
35493 \begin_layout Subsubsection
35494
35495 \family typewriter
35496 \begin_inset CommandInset label
35497 LatexCommand label
35498 name "subsec:Automatical-Locking-Property"
35499
35500 \end_inset
35501
35502
35503 \family default
35504 Automatic Locking Property
35505 \end_layout
35506
35507 \begin_layout Standard
35508 The above mentioned automatic setting of write permissions of the .lyx file can be set through
35509 \family sans
35510  File\SpecialChar menuseparator
35511 Version
35512 \begin_inset space ~
35513 \end_inset
35514
35515 Control\SpecialChar menuseparator
35516 Use Locking Property
35517 \family default
35518 .
35519  This command is active only when the file is not locked on the svn server (i.e.
35520  you need to check-out before proceeding).
35521 \end_layout
35522
35523 \begin_layout Labeling
35524 \labelwidthstring 00.00.0000
35525 SVN
35526 \begin_inset space ~
35527 \end_inset
35528
35529 commands:
35530 \end_layout
35531
35532 \begin_layout Labeling
35533 \labelwidthstring 00.00.0000
35534 Set:
35535
35536 \family typewriter
35537  svn propset svn:needs-lock ON "<file-name>"
35538 \end_layout
35539
35540 \begin_layout Labeling
35541 \labelwidthstring 00.00.0000
35542 Unset:
35543
35544 \family typewriter
35545 svn propdel svn:needs-lock "<file-name>"
35546 \end_layout
35547
35548 \begin_layout Subsubsection
35549 \begin_inset CommandInset label
35550 LatexCommand label
35551 name "subsec:VCS-Revision-Information"
35552
35553 \end_inset
35554
35555 Revision Information in Documents
35556 \end_layout
35557
35558 \begin_layout Standard
35559 There are more possibilities how to activate revision information in our document.
35560 \end_layout
35561
35562 \begin_layout Itemize
35563 \SpecialChar LyX
35564  supports directly:
35565 \end_layout
35566
35567 \begin_deeper
35568 \begin_layout Itemize
35569 tree revision information (
35570 \begin_inset Flex Code
35571 status collapsed
35572
35573 \begin_layout Plain Layout
35574 vcs-tree-revision
35575 \end_layout
35576
35577 \end_inset
35578
35579 ).
35580  The result is the output of the
35581 \begin_inset Flex Code
35582 status collapsed
35583
35584 \begin_layout Plain Layout
35585 svnversion
35586 \end_layout
35587
35588 \end_inset
35589
35590  command,
35591  the following table gives you an idea,
35592  how to read the results.
35593 \end_layout
35594
35595 \begin_layout Standard
35596 \align center
35597 \begin_inset Tabular
35598 <lyxtabular version="3" rows="6" columns="2">
35599 <features tabularvalignment="middle">
35600 <column alignment="left" valignment="top">
35601 <column alignment="left" valignment="top">
35602 <row>
35603 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
35604 \begin_inset Text
35605
35606 \begin_layout Plain Layout
35607
35608 \series bold
35609 Output
35610 \end_layout
35611
35612 \end_inset
35613 </cell>
35614 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
35615 \begin_inset Text
35616
35617 \begin_layout Plain Layout
35618
35619 \series bold
35620 Meaning
35621 \end_layout
35622
35623 \end_inset
35624 </cell>
35625 </row>
35626 <row>
35627 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
35628 \begin_inset Text
35629
35630 \begin_layout Plain Layout
35631 4123:4168
35632 \end_layout
35633
35634 \end_inset
35635 </cell>
35636 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
35637 \begin_inset Text
35638
35639 \begin_layout Plain Layout
35640 mixed revision working copy
35641 \end_layout
35642
35643 \end_inset
35644 </cell>
35645 </row>
35646 <row>
35647 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
35648 \begin_inset Text
35649
35650 \begin_layout Plain Layout
35651 4168M
35652 \end_layout
35653
35654 \end_inset
35655 </cell>
35656 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
35657 \begin_inset Text
35658
35659 \begin_layout Plain Layout
35660 modified working copy
35661 \end_layout
35662
35663 \end_inset
35664 </cell>
35665 </row>
35666 <row>
35667 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
35668 \begin_inset Text
35669
35670 \begin_layout Plain Layout
35671 4123S
35672 \end_layout
35673
35674 \end_inset
35675 </cell>
35676 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
35677 \begin_inset Text
35678
35679 \begin_layout Plain Layout
35680 switched working copy
35681 \end_layout
35682
35683 \end_inset
35684 </cell>
35685 </row>
35686 <row>
35687 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
35688 \begin_inset Text
35689
35690 \begin_layout Plain Layout
35691 4123P
35692 \end_layout
35693
35694 \end_inset
35695 </cell>
35696 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
35697 \begin_inset Text
35698
35699 \begin_layout Plain Layout
35700 partial working copy,
35701  from a sparse checkout
35702 \end_layout
35703
35704 \end_inset
35705 </cell>
35706 </row>
35707 <row>
35708 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
35709 \begin_inset Text
35710
35711 \begin_layout Plain Layout
35712 4123:4168MS
35713 \end_layout
35714
35715 \end_inset
35716 </cell>
35717 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
35718 \begin_inset Text
35719
35720 \begin_layout Plain Layout
35721 mixed revision,
35722  modified,
35723  switched working copy
35724 \end_layout
35725
35726 \end_inset
35727 </cell>
35728 </row>
35729 </lyxtabular>
35730
35731 \end_inset
35732
35733
35734 \end_layout
35735
35736 \begin_layout Itemize
35737 file revision information.
35738  The result comes from parsing the output of
35739 \begin_inset Flex Code
35740 status collapsed
35741
35742 \begin_layout Plain Layout
35743 svn
35744 \begin_inset space ~
35745 \end_inset
35746
35747 info
35748 \begin_inset space ~
35749 \end_inset
35750
35751 --xml
35752 \begin_inset space ~
35753 \end_inset
35754
35755 file.lyx
35756 \end_layout
35757
35758 \end_inset
35759
35760 .
35761  Supported flags are:
35762 \end_layout
35763
35764 \begin_deeper
35765 \begin_layout Itemize
35766 version number of the last commit (
35767 \begin_inset Flex Code
35768 status collapsed
35769
35770 \begin_layout Plain Layout
35771 vcs-revision
35772 \end_layout
35773
35774 \end_inset
35775
35776 )
35777 \end_layout
35778
35779 \begin_layout Itemize
35780 author of the last commit (
35781 \begin_inset Flex Code
35782 status collapsed
35783
35784 \begin_layout Plain Layout
35785 vcs-author
35786 \end_layout
35787
35788 \end_inset
35789
35790 )
35791 \end_layout
35792
35793 \begin_layout Itemize
35794 date of the last commit (
35795 \begin_inset Flex Code
35796 status collapsed
35797
35798 \begin_layout Plain Layout
35799 vcs-date
35800 \end_layout
35801
35802 \end_inset
35803
35804 )
35805 \end_layout
35806
35807 \begin_layout Itemize
35808 time of the last commit (
35809 \begin_inset Flex Code
35810 status collapsed
35811
35812 \begin_layout Plain Layout
35813 vcs-time
35814 \end_layout
35815
35816 \end_inset
35817
35818 )
35819 \end_layout
35820
35821 \end_deeper
35822 \begin_layout Standard
35823 You can obtain this info via InsetInfo (
35824 \change_inserted 5863208 1564400022
35825 Insert\SpecialChar menuseparator
35826 Field\SpecialChar menuseparator
35827 Version Control Revision
35828 \change_deleted 5863208 1564399852
35829 e.g.
35830
35831 \begin_inset Flex Code
35832 status collapsed
35833
35834 \begin_layout Plain Layout
35835 info-insert buffer vcs-date
35836 \end_layout
35837
35838 \end_inset
35839
35840
35841 \change_unchanged
35842 ).
35843  The information will be available only when you have the file stored under svn managment (i.e.
35844  the
35845 \begin_inset Flex Code
35846 status collapsed
35847
35848 \begin_layout Plain Layout
35849 .svn
35850 \end_layout
35851
35852 \end_inset
35853
35854  directory is available with your document).
35855 \end_layout
35856
35857 \end_deeper
35858 \begin_layout Itemize
35859 Another—
35860 a hacking one—
35861 possibility is to use svn keywords
35862 \begin_inset Foot
35863 status collapsed
35864
35865 \begin_layout Plain Layout
35866 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
35867 \end_layout
35868
35869 \end_inset
35870
35871 .
35872  In short – you set file keywords property (e.g.
35873
35874 \family sans
35875 svn propset svn:keywords 'Rev' file.lyx
35876 \family default
35877 ) and then paste keyword \SpecialChar TeX
35878  code
35879 \begin_inset Foot
35880 status collapsed
35881
35882 \begin_layout Plain Layout
35883 This is an easy way how to ensure that \SpecialChar LyX
35884  won't break the line in the middle of keyword tag.
35885 \end_layout
35886
35887 \end_inset
35888
35889  tag in your document (e.g.
35890
35891 \begin_inset Flex Code
35892 status collapsed
35893
35894 \begin_layout Plain Layout
35895 $Rev$
35896 \end_layout
35897
35898 \end_inset
35899
35900 ).
35901  This way svn client will automatically substitute revision number (e.g.
35902
35903 \begin_inset Flex Code
35904 status collapsed
35905
35906 \begin_layout Plain Layout
35907 $Rev:
35908  59 $
35909 \end_layout
35910
35911 \end_inset
35912
35913 ) after each update and commit.
35914  There are more problems with this approach.
35915  Firstly,
35916  the '$' character is used in \SpecialChar TeX
35917  world for math equations,
35918  so any occurence of math formula
35919 \begin_inset Formula $Rev$
35920 \end_inset
35921
35922  become
35923 \begin_inset Formula $Rev:59$
35924 \end_inset
35925
35926  in your \SpecialChar LyX
35927  document.
35928  Similarly for other keywords like Id,
35929  Date,
35930  Author,
35931  etc.
35932  Secondly svn output is dependent on your locales,
35933  so its very easy that svn would produce some problematic strings once Date is used.
35934  Thirdly you get the whole 'Rev:
35935  59' string in your document instead of the plain number.
35936  Until subversion implements user's custom keywords it will be hard to use this approach reliably or let \SpecialChar LyX
35937  to support it directly.
35938 \end_layout
35939
35940 \begin_layout Subsection
35941 SVN and Windows Environment
35942 \end_layout
35943
35944 \begin_layout Quote
35945 My inclination is to say that if the user cannot figure out the command line operations on their own fairly quickly,
35946  they would be well advised to use TortoiseSVN.
35947  —
35948 P.
35949  A.
35950  Rubin
35951 \end_layout
35952
35953 \begin_layout Subsubsection
35954 Preparation
35955 \end_layout
35956
35957 \begin_layout Standard
35958 In addition to installing \SpecialChar LyX
35959 ,
35960  and having access to a Subversion repository,
35961  the user will need to install the Subversion client program.
35962  A Windows installer for the client program is available from
35963 \begin_inset CommandInset href
35964 LatexCommand href
35965 name "CollabNet"
35966 target "http://www.collab.net/nonav/downloads/subversion/"
35967 literal "false"
35968
35969 \end_inset
35970
35971 .
35972  The user may also want to install
35973 \begin_inset CommandInset href
35974 LatexCommand href
35975 name "TortoiseSVN"
35976 target "http://tortoisesvn.tigris.org/"
35977 literal "false"
35978
35979 \end_inset
35980
35981 ,
35982  which integrates Subversion operations into the context (rightclick) menu of Windows Explorer.
35983  Operations done outside \SpecialChar LyX
35984  will typically be more convenient using the Explorer context menu.
35985  Note that TortoiseSVN is not a replacement for the client program,
35986  which is what \SpecialChar LyX
35987  itself will use.
35988 \end_layout
35989
35990 \begin_layout Subsubsection
35991 Bringing a document under Subversion control
35992 \end_layout
35993
35994 \begin_layout Standard
35995 Before a \SpecialChar LyX
35996  document can be brought under version control in Subversion,
35997  its parent directory needs to be under version control.
35998  If the document is being added to a project already in the repository,
35999  this is accomplished by checking the project out to the directory where the new document will be placed.
36000  If the project itself is not yet under version control (for instance,
36001  if this document starts a new project),
36002  the directory must be imported into the repository.
36003  This is done outside \SpecialChar LyX
36004 .
36005  Both import and checkout are easily accomplished from the Explorer context menu using TortoiseSVN,
36006  or alternatively can be done using the command line client at a DOS prompt.
36007  The procedure for importing the project using TortoiseSVN is described below,
36008  assuming an existing repository and a new project being started in
36009 \family typewriter
36010 C:
36011 \backslash
36012 new project
36013 \family default
36014 .
36015  For information on using the Subversion client program,
36016  run
36017 \family typewriter
36018 svn --help
36019 \family default
36020 in a DOS shell.
36021 \end_layout
36022
36023 \begin_layout Enumerate
36024 Locate
36025 \family typewriter
36026 C:
36027 \backslash
36028 new project
36029 \family default
36030 in Windows Explorer,
36031  right click it,
36032  and select
36033 \family sans
36034 TortoiseSVN\SpecialChar menuseparator
36035 Repo-browser
36036 \family default
36037 .
36038  If necessary,
36039  adjust the URL for the repository,
36040  then click OK.
36041 \end_layout
36042
36043 \begin_layout Enumerate
36044 Right click the level of the repository under which you want to place the new project folder (typically the top level) and click
36045 \family sans
36046 Create folder
36047 \family default
36048  Supply a name for the project folder and click OK.
36049  Add a message for the log file if desired,
36050  then click OK again.
36051  The new project folder should appear in the repository.
36052  Finally,
36053  click OK again to exit the repository browser.
36054 \end_layout
36055
36056 \begin_layout Enumerate
36057 Once again right click
36058 \family typewriter
36059 C:
36060 \backslash
36061 new project
36062 \family default
36063 ,
36064  this time selecting SVN Checkout\SpecialChar ldots
36065  Select the URL of the project folder you just created in the repository,
36066  and set the checkout directory to
36067 \family typewriter
36068 C:
36069 \backslash
36070 new project.
36071
36072 \family default
36073  Click OK.
36074  You will be warned about a non-empty folder;
36075  click OK to proceed.
36076  You should now have a
36077 \family typewriter
36078 .svn
36079 \family default
36080  directory under
36081 \family typewriter
36082 C:
36083 \backslash
36084 new project.
36085 \end_layout
36086
36087 \begin_layout Enumerate
36088 Create or open your document in \SpecialChar LyX
36089  and click
36090 \family sans
36091 File\SpecialChar menuseparator
36092 Version
36093 \begin_inset space ~
36094 \end_inset
36095
36096 Control\SpecialChar menuseparator
36097 Register.
36098
36099 \family default
36100 Add a log message and click OK to commit the document to version control.
36101 \end_layout
36102
36103 \begin_layout Standard
36104 From this point onward,
36105  you should have full functionality in the
36106 \family sans
36107 File\SpecialChar menuseparator
36108 Version
36109 \begin_inset space ~
36110 \end_inset
36111
36112 Control
36113 \family default
36114  menu.
36115  You also have the option of checking the document in and out,
36116  viewing its history,
36117  etc.
36118  using the TortoiseSVN context menu in Windows Explorer or the Subversion client program from a command prompt.
36119 \end_layout
36120
36121 \begin_layout Subsubsection
36122 SSH tunnel used with SVN under Windows
36123 \end_layout
36124
36125 \begin_layout Standard
36126 Compared with Linux setting up an svn client to communicate over ssh under Windows is a rather troublesome task.
36127  We will at least offer some hints how to setup the client side but prior knowledge about ssh and the Windows command line is needed,
36128  also be prepared for a great deal of frustration\SpecialChar ldots
36129
36130 \end_layout
36131
36132 \begin_layout Enumerate
36133 Get an svn client for windows,
36134  as described in the previous sections.
36135  When it is a fresh install run some svn command (e.g.
36136
36137 \begin_inset Flex Code
36138 status collapsed
36139
36140 \begin_layout Plain Layout
36141 svn --version
36142 \end_layout
36143
36144 \end_inset
36145
36146 ) to create config files,
36147  which you will need to change later on.
36148 \end_layout
36149
36150 \begin_layout Enumerate
36151 Choose an ssh client for Windows.
36152  There are several possibilities,
36153  we will use the one from Putty tools
36154 \begin_inset Foot
36155 status collapsed
36156
36157 \begin_layout Plain Layout
36158 \begin_inset Flex URL
36159 status collapsed
36160
36161 \begin_layout Plain Layout
36162
36163 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
36164 \end_layout
36165
36166 \end_inset
36167
36168
36169 \end_layout
36170
36171 \end_inset
36172
36173 .
36174  You will need to set the connection up so that the client doesn't ask for any password from you.
36175  To keep things easy we will use only keys without any additional password protection etc.
36176 \end_layout
36177
36178 \begin_deeper
36179 \begin_layout Enumerate
36180 Generate keys by
36181 \begin_inset Flex Code
36182 status collapsed
36183
36184 \begin_layout Plain Layout
36185 puttygen
36186 \end_layout
36187
36188 \end_inset
36189
36190 .
36191  Save your private .ppk key file and put the public one on the server side.
36192  If the SVN server runs on Linux,
36193  note that the format of the public key is not compatible with Linux openssh and you will need to direcly copy-paste the key from the
36194 \begin_inset Quotes eld
36195 \end_inset
36196
36197
36198 \emph on
36199 Public key for pasting into OpenSSH authorized_keys file
36200 \emph default
36201 :
36202 \begin_inset Quotes erd
36203 \end_inset
36204
36205  edit field into the server's
36206 \begin_inset Flex Code
36207 status collapsed
36208
36209 \begin_layout Plain Layout
36210 ~/.ssh/authorized_keys
36211 \end_layout
36212
36213 \end_inset
36214
36215  /
36216 \begin_inset Flex Code
36217 status collapsed
36218
36219 \begin_layout Plain Layout
36220 authorized_keys2
36221 \end_layout
36222
36223 \end_inset
36224
36225  file.
36226 \end_layout
36227
36228 \begin_layout Enumerate
36229 Get the Putty's
36230 \begin_inset Flex Code
36231 status collapsed
36232
36233 \begin_layout Plain Layout
36234 plink
36235 \end_layout
36236
36237 \end_inset
36238
36239 .
36240  In the SVN config file
36241 \begin_inset Foot
36242 status collapsed
36243
36244 \begin_layout Plain Layout
36245 Exact path depends on Windows version,
36246  usually somewhere around
36247 \begin_inset Flex Code
36248 status collapsed
36249
36250 \begin_layout Plain Layout
36251 c:
36252 \backslash
36253 Documents and Settings
36254 \backslash
36255 user
36256 \backslash
36257 Application Data
36258 \backslash
36259 Subversion
36260 \backslash
36261 config
36262 \end_layout
36263
36264 \end_inset
36265
36266  /
36267 \begin_inset Flex Code
36268 status collapsed
36269
36270 \begin_layout Plain Layout
36271 AppData
36272 \backslash
36273 Roaming
36274 \backslash
36275 Subversion
36276 \end_layout
36277
36278 \end_inset
36279
36280 .
36281 \end_layout
36282
36283 \end_inset
36284
36285 ,
36286  section [tunnels],
36287  setup ssh command,
36288  e.g.
36289
36290 \begin_inset Flex Code
36291 status collapsed
36292
36293 \begin_layout Plain Layout
36294 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
36295 \end_layout
36296
36297 \end_inset
36298
36299 .
36300 \begin_inset Foot
36301 status collapsed
36302
36303 \begin_layout Plain Layout
36304 It will usually take a lot of time to get exact command right and it depends on many things.
36305  For example do not have some remote server saved as a default session in Putty etc.
36306  If things fail,
36307  try to connect via plink without SVN first.
36308 \end_layout
36309
36310 \end_inset
36311
36312
36313 \end_layout
36314
36315 \end_deeper
36316 \begin_layout Enumerate
36317 Checkout the SVN archive,
36318  e.
36319 \begin_inset space \thinspace{}
36320 \end_inset
36321
36322 g.
36323 \begin_inset Newline newline
36324 \end_inset
36325
36326
36327 \begin_inset Flex Code
36328 status collapsed
36329
36330 \begin_layout Plain Layout
36331 svn co svn+ssh://user@server/repository_path
36332 \end_layout
36333
36334 \end_inset
36335
36336 .
36337 \end_layout
36338
36339 \begin_layout Subsubsection
36340 End-of-Line Conversions
36341 \end_layout
36342
36343 \begin_layout Standard
36344 When the collaborators are mixing Linux and Windows environments,
36345  \SpecialChar LyX
36346  will use different line endings inside the .lyx files.
36347  This is not a problem as far as \SpecialChar LyX
36348  functionality is concerned,
36349  but the commit diffs will be huge and merge-conflicts prone.
36350  Fortunately SVN itself knows
36351 \begin_inset Foot
36352 status collapsed
36353
36354 \begin_layout Plain Layout
36355 \begin_inset Flex URL
36356 status collapsed
36357
36358 \begin_layout Plain Layout
36359
36360 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
36361 \end_layout
36362
36363 \end_inset
36364
36365
36366 \end_layout
36367
36368 \end_inset
36369
36370  how to deal with CR/LF problems when switching .lyx files to the
36371 \begin_inset Flex Code
36372 status collapsed
36373
36374 \begin_layout Plain Layout
36375 native
36376 \end_layout
36377
36378 \end_inset
36379
36380  mode.
36381 \begin_inset Foot
36382 status collapsed
36383
36384 \begin_layout Plain Layout
36385 For the lazy guys:
36386
36387 \begin_inset Flex Code
36388 status collapsed
36389
36390 \begin_layout Plain Layout
36391 svn propset svn:eol-style native FILE_NAME
36392 \end_layout
36393
36394 \end_inset
36395
36396
36397 \end_layout
36398
36399 \end_inset
36400
36401
36402 \end_layout
36403
36404 \begin_layout Subsection
36405 GIT commands in \SpecialChar LyX
36406
36407 \end_layout
36408
36409 \begin_layout Standard
36410 A minimal subset of GIT commands is now supported by \SpecialChar LyX
36411 .
36412  You can find the commands in the
36413 \family sans
36414 File\SpecialChar menuseparator
36415 Version
36416 \begin_inset space ~
36417 \end_inset
36418
36419 Control
36420 \family default
36421  submenu.
36422  Please note that if you use password protected access to repository via ssh,
36423  you will be asked in terminal window.
36424  \SpecialChar LyX
36425  was tested against GIT 1.7.
36426 \begin_inset Foot
36427 status collapsed
36428
36429 \begin_layout Plain Layout
36430 Windows users please note that you need to ensure that git is on the path.
36431  This can be set from within \SpecialChar LyX
36432  at
36433 \family sans
36434 Tools\SpecialChar menuseparator
36435 Preferences\SpecialChar menuseparator
36436 Paths\SpecialChar menuseparator
36437 PATH prefix
36438 \family default
36439 .
36440 \end_layout
36441
36442 \end_inset
36443
36444
36445 \end_layout
36446
36447 \begin_layout Standard
36448 One big difference of GIT and the other supported version control systems is the distributed nature of GIT:
36449  With traditional version control systems there is one central server which hosts the repository.
36450  Users commit their changes to the server,
36451  and get updates made by other users from it.
36452  With GIT,
36453  users commit to a local repository.
36454  The local repository can be synchronized with one or more remote repositories using the
36455 \begin_inset Flex Code
36456 status collapsed
36457
36458 \begin_layout Plain Layout
36459 pull
36460 \end_layout
36461
36462 \end_inset
36463
36464  and
36465 \begin_inset Flex Code
36466 status collapsed
36467
36468 \begin_layout Plain Layout
36469 push
36470 \end_layout
36471
36472 \end_inset
36473
36474  GIT commands.
36475  \SpecialChar LyX
36476  does not interact in any way with remote GIT repositories.
36477  It works exclusively with the local repository in a very similar way as with a central CVS or SVN repository.
36478  If you use remote GIT repositories you need to do the
36479 \begin_inset Flex Code
36480 status collapsed
36481
36482 \begin_layout Plain Layout
36483 pull
36484 \end_layout
36485
36486 \end_inset
36487
36488  and
36489 \begin_inset Flex Code
36490 status collapsed
36491
36492 \begin_layout Plain Layout
36493 push
36494 \end_layout
36495
36496 \end_inset
36497
36498  operations with your favourite GIT client.
36499 \end_layout
36500
36501 \begin_layout Subsubsection
36502
36503 \family sans
36504 Register
36505 \end_layout
36506
36507 \begin_layout Standard
36508 If your document is not under revision control,
36509  this is the only item shown in the menu.
36510  And if it is under revision control,
36511  the
36512 \family sans
36513 Register
36514 \family default
36515  item is not visible.
36516 \end_layout
36517
36518 \begin_layout Standard
36519 This command registers in GIT your document ONLY in case you have already the documents directory under GIT control (in particular
36520 \family typewriter
36521 .git/index
36522 \family default
36523  file exists).
36524  This means you have to checkout the archive by yourself.
36525 \end_layout
36526
36527 \begin_layout Standard
36528 Then you are asked interactively to supply an initial description of the document.
36529  Don't forget that registered file is not yet committed.
36530 \end_layout
36531
36532 \begin_layout Standard
36533 GIT command that is run:
36534
36535 \family typewriter
36536 git add
36537 \begin_inset Quotes qld
36538 \end_inset
36539
36540 <file-name>
36541 \begin_inset Quotes qld
36542 \end_inset
36543
36544
36545 \end_layout
36546
36547 \begin_layout Standard
36548 Read
36549 \family typewriter
36550 man git
36551 \family default
36552  to understand the switches.
36553 \end_layout
36554
36555 \begin_layout Subsubsection
36556
36557 \family sans
36558 Check In Changes
36559 \end_layout
36560
36561 \begin_layout Standard
36562 When you are finished editing a file,
36563  you commit your changes.
36564  When you do this,
36565  you are asked for a description of the changes.
36566  After that changes are committed.
36567 \end_layout
36568
36569 \begin_layout Standard
36570 GIT command:
36571
36572 \family typewriter
36573 git commit -q -m"<description>" <file-name>
36574 \end_layout
36575
36576 \begin_layout Subsubsection
36577
36578 \family sans
36579 Revert To Repository Version
36580 \end_layout
36581
36582 \begin_layout Standard
36583 This will discard all changes made to the document since the last check in.
36584  You get a warning before changes are discarded.
36585 \end_layout
36586
36587 \begin_layout Standard
36588 GIT command:
36589
36590 \family typewriter
36591 git checkout -q
36592 \begin_inset Quotes qld
36593 \end_inset
36594
36595 <file-name>
36596 \begin_inset Quotes qld
36597 \end_inset
36598
36599
36600 \end_layout
36601
36602 \begin_layout Subsubsection
36603
36604 \family sans
36605 Rename
36606 \end_layout
36607
36608 \begin_layout Standard
36609 This will rename the current document including the version history.
36610  It requires a clean document without any changes since the last checkin.
36611  You are asked for a file name and a description of the rename operation.
36612  After that the document is renamed,
36613  both locally and in the repository.
36614  If the parent directories of the new and old file names differ,
36615  all relative paths of included files are adjusted (like in
36616 \family sans
36617 File\SpecialChar menuseparator
36618 Save As
36619 \family default
36620 \SpecialChar ldots
36621 ).
36622  Finally,
36623  the document is reloaded using the new name.
36624 \end_layout
36625
36626 \begin_layout Labeling
36627 \labelwidthstring 00.00.0000
36628 GIT
36629 \begin_inset space ~
36630 \end_inset
36631
36632 commands:
36633
36634 \begin_inset space ~
36635 \end_inset
36636
36637
36638 \begin_inset Newline newline
36639 \end_inset
36640
36641
36642 \begin_inset Flex Code
36643 status collapsed
36644
36645 \begin_layout Plain Layout
36646 git mv
36647 \family typewriter
36648
36649 \begin_inset Quotes qld
36650 \end_inset
36651
36652 <file-name>
36653 \begin_inset Quotes qld
36654 \end_inset
36655
36656
36657 \begin_inset Quotes qld
36658 \end_inset
36659
36660 <new-file-name>
36661 \begin_inset Quotes qld
36662 \end_inset
36663
36664
36665 \end_layout
36666
36667 \end_inset
36668
36669
36670 \begin_inset Newline newline
36671 \end_inset
36672
36673
36674 \begin_inset Flex Code
36675 status collapsed
36676
36677 \begin_layout Plain Layout
36678 git commit
36679 \end_layout
36680
36681 \end_inset
36682
36683
36684 \end_layout
36685
36686 \begin_layout Subsubsection
36687
36688 \family sans
36689 Show History
36690 \end_layout
36691
36692 \begin_layout Standard
36693 This shows the complete history of the GIT document.
36694  The output of
36695 \family typewriter
36696 git log
36697 \begin_inset Quotes qld
36698 \end_inset
36699
36700 <file-name>
36701 \begin_inset Quotes qld
36702 \end_inset
36703
36704
36705 \family default
36706  is shown in a browser.
36707 \end_layout
36708
36709 \begin_layout Subsubsection
36710 Version Info
36711 \end_layout
36712
36713 \begin_layout Standard
36714 \SpecialChar LyX
36715  supports GIT hash number of the last commit to the file,
36716
36717 \change_inserted 1119979965 1564297456
36718 its abbreviated form,
36719
36720 \change_unchanged
36721 author name,
36722  date and time of last commit.
36723  All those are extracted from
36724 \family typewriter
36725 git log -n 1 --pretty=format:%H%n
36726 \change_inserted 1119979965 1564297427
36727 %h%n
36728 \change_unchanged
36729 %an%n%ai
36730 \family default
36731 .
36732  Tree version information is obtained via
36733 \family typewriter
36734 git describe --abbrev --dirty --long
36735 \family default
36736 .
36737  See
36738 \begin_inset CommandInset ref
36739 LatexCommand ref
36740 reference "subsec:VCS-Revision-Information"
36741 nolink "false"
36742
36743 \end_inset
36744
36745  for other details.
36746 \end_layout
36747
36748 \begin_layout Subsection
36749 Further tuning
36750 \end_layout
36751
36752 \begin_layout Standard
36753 With the recent addition of the
36754 \begin_inset Flex Code
36755 status collapsed
36756
36757 \begin_layout Plain Layout
36758 vc-command
36759 \end_layout
36760
36761 \end_inset
36762
36763  function \SpecialChar LyX
36764  power users are allowed to create their own commands for revision control.
36765 \end_layout
36766
36767 \begin_layout Standard
36768 As an example you can see how two TortoiseSVN commands could be integrated directly:
36769 \end_layout
36770
36771 \begin_layout Description
36772 Commit:
36773
36774 \begin_inset Flex Code
36775 status collapsed
36776
36777 \begin_layout Plain Layout
36778 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
36779 \end_layout
36780
36781 \end_inset
36782
36783
36784 \end_layout
36785
36786 \begin_layout Description
36787 Revert:
36788
36789 \begin_inset Flex Code
36790 status collapsed
36791
36792 \begin_layout Plain Layout
36793 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
36794 \end_layout
36795
36796 \end_inset
36797
36798
36799 \end_layout
36800
36801 \begin_layout Subsection
36802 Version control and Document comparison
36803 \end_layout
36804
36805 \begin_layout Standard
36806 One of the typical uses of version control is to inspect the changes between revisions,
36807  usually by creating
36808 \begin_inset Flex Code
36809 status collapsed
36810
36811 \begin_layout Plain Layout
36812 diff
36813 \end_layout
36814
36815 \end_inset
36816
36817  dumps.
36818  While this is useful for plain text files,
36819  it is much less useful in the case of \SpecialChar LyX
36820  files,
36821  which have more a complicated structure.
36822  Hence we provide binding to the Document comparison feature.
36823  There are two ways of calling this feature – either by direct call of
36824 \begin_inset Flex Code
36825 status collapsed
36826
36827 \begin_layout Plain Layout
36828 vc-compare
36829 \end_layout
36830
36831 \end_inset
36832
36833  \SpecialChar LyX
36834  function (for details see \SpecialChar LyX
36835  functions manual) or by the toolbar icon
36836 \begin_inset Info
36837 type  "icon"
36838 arg   "vc-compare"
36839 \end_inset
36840
36841  or the menu item
36842 \begin_inset Info
36843 type  "menu"
36844 arg   "vc-compare"
36845 \end_inset
36846
36847 ,
36848  respectively.
36849  One can either compare two chosen revisions of the document or he can simply compare the current version of edited text with older revisions (where '
36850 \begin_inset Flex Noun
36851 status collapsed
36852
36853 \begin_layout Plain Layout
36854 0
36855 \end_layout
36856
36857 \end_inset
36858
36859 ' revisions back means comparison of the edited file with last commited revision).
36860
36861 \end_layout
36862
36863 \begin_layout Standard
36864 This feature is supported for SVN and RCS though due to the more complicated versioning scheme of RCS there is a constraint – when addressing the revisions in dialog,
36865  numbers always point to the last number in RCS revision number,
36866  i.e.
36867  '35' in '1.2.35'.
36868  We don't currently support GIT addressing of revisions,
36869  one can just compare edited document with its revision X steps backs,
36870  where X is addressed as
36871 \begin_inset Flex Code
36872 status collapsed
36873
36874 \begin_layout Plain Layout
36875 HEAD~X
36876 \end_layout
36877
36878 \end_inset
36879
36880 .
36881 \end_layout
36882
36883 \begin_layout Section
36884
36885 \change_inserted 564990737 1672161575
36886 \begin_inset CommandInset label
36887 LatexCommand label
36888 name "sec:Literate-Programming"
36889
36890 \end_inset
36891
36892
36893 \change_unchanged
36894 Literate Programming
36895 \end_layout
36896
36897 \begin_layout Standard
36898 Updated by
36899 \noun on
36900 Kayvan Sylvan
36901 \noun default
36902 (kayvan@sylvan.com)
36903 \noun on
36904 ,
36905
36906 \noun default
36907 original documentation written by
36908 \noun on
36909 Edmar Wienskoski Jr.
36910
36911 \noun default
36912  (edmar-w-jr@technologist.com)
36913 \end_layout
36914
36915 \begin_layout Subsection
36916 Introduction
36917 \end_layout
36918
36919 \begin_layout Standard
36920 The main purpose of this documentation is to show you how to use \SpecialChar LyX
36921  for literate programming,
36922  where it is assumed that you are familiar with this programming technique,
36923  and know what
36924 \begin_inset Quotes eld
36925 \end_inset
36926
36927 tangling
36928 \begin_inset Quotes erd
36929 \end_inset
36930
36931  and
36932 \begin_inset Quotes eld
36933 \end_inset
36934
36935 weaving
36936 \begin_inset Quotes erd
36937 \end_inset
36938
36939  means.
36940  If that is not the case,
36941  please follow the web links provided in the following sections.
36942  There is a lot of good documentation out there covering old development history to the latest tools tips.
36943 \end_layout
36944
36945 \begin_layout Standard
36946 It is also assumed that you are familiar with \SpecialChar LyX
36947  itself to a point that you are comfortable changing your \SpecialChar LyX
36948  preferences,
36949  and X resources file.
36950  If that is not the case please refer to other \SpecialChar LyX
36951  documentation to cover your specific needs.
36952 \end_layout
36953
36954 \begin_layout Subsection
36955 Literate Programming
36956 \end_layout
36957
36958 \begin_layout Standard
36959 From the Literate Programming FAQ:
36960
36961 \end_layout
36962
36963 \begin_layout Quotation
36964 Literate programming is the combination of documentation and source together in a fashion suited for reading by human beings.
36965  In fact,
36966  literate programs should be enjoyable reading,
36967  even inviting!
36968  (Sorry Bob,
36969  I couldn't resist!) In general,
36970  literate programs combine source and documentation in a single file.
36971  Literate programming tools then parse the file to produce either readable documentation or compilable source.
36972  The WEB style of literate programming was created by D.
36973 \begin_inset space \thinspace{}
36974 \end_inset
36975
36976 E.
36977  Knuth during the development of his \SpecialChar TeX
36978  typesetting software.
36979
36980 \end_layout
36981
36982 \begin_layout Standard
36983 Another excerpt says:
36984 \end_layout
36985
36986 \begin_layout Quotation
36987
36988 \emph on
36989 How is literate programming different from verbose commenting?
36990 \end_layout
36991
36992 \begin_layout Quotation
36993 There are three distinguishing characteristics.
36994  In order of importance,
36995  they are:
36996
36997 \end_layout
36998
36999 \begin_deeper
37000 \begin_layout Itemize
37001 flexible order of elaboration
37002 \end_layout
37003
37004 \begin_layout Itemize
37005 automatic support for browsing
37006 \end_layout
37007
37008 \begin_layout Itemize
37009 typeset documentation,
37010  especially diagrams and mathematics
37011 \end_layout
37012
37013 \end_deeper
37014 \begin_layout Standard
37015 Now that I sparked your curiosity,
37016  take a look in the references.
37017 \end_layout
37018
37019 \begin_layout Subsubsection
37020 References
37021 \end_layout
37022
37023 \begin_layout Standard
37024 The complete Literate Programming FAQ can be found at:
37025 \end_layout
37026
37027 \begin_layout Quote
37028 Literate Programming FAQ
37029 \begin_inset Flex URL
37030 status open
37031
37032 \begin_layout Plain Layout
37033
37034 http://www.literateprogramming.com/lpfaq.pdf
37035 \end_layout
37036
37037 \end_inset
37038
37039
37040 \end_layout
37041
37042 \begin_layout Standard
37043 The FAQ lists 23 (twenty three!) different literate programming tools.
37044  Where some are specialized or
37045 \begin_inset Quotes eld
37046 \end_inset
37047
37048 tailored
37049 \begin_inset Quotes erd
37050 \end_inset
37051
37052  for particular programming languages,
37053  while other have general scope.
37054  I selected
37055 \noun on
37056 Noweb
37057 \noun default
37058  for my own use for several reasons:
37059 \end_layout
37060
37061 \begin_layout Itemize
37062 It can generate the documentation either in \SpecialChar LaTeX
37063  or HTML.
37064 \end_layout
37065
37066 \begin_layout Itemize
37067 It has a open architecture,
37068  i.
37069 \begin_inset space \thinspace{}
37070 \end_inset
37071
37072 e.
37073 \begin_inset space \space{}
37074 \end_inset
37075
37076 it is easy to plug in new filters
37077 \begin_inset Foot
37078 status collapsed
37079
37080 \begin_layout Plain Layout
37081
37082 \emph on
37083 Filters
37084 \emph default
37085 are programs that read a given data stream and output a manipulated data stream.
37086  That way,
37087  a WEB file (consisting of literate code) can be turned into a file consisting only of C program code or \SpecialChar LaTeX
37088  code.
37089 \end_layout
37090
37091 \end_inset
37092
37093  and to perform special processing that you may need.
37094
37095 \end_layout
37096
37097 \begin_layout Itemize
37098 There is a good selection of filters available already (the HTML is one of them).
37099 \end_layout
37100
37101 \begin_layout Itemize
37102 It is free.
37103 \end_layout
37104
37105 \begin_layout Standard
37106 The Noweb web page can be found at:
37107
37108 \end_layout
37109
37110 \begin_layout Quote
37111 Noweb home page
37112 \begin_inset Flex URL
37113 status collapsed
37114
37115 \begin_layout Plain Layout
37116
37117 https://www.cs.tufts.edu/~nr/noweb/
37118 \end_layout
37119
37120 \end_inset
37121
37122
37123 \end_layout
37124
37125 \begin_layout Standard
37126 Starting from there you can reach many other interesting links and even some literate program examples.
37127 \end_layout
37128
37129 \begin_layout Subsection
37130 \SpecialChar LyX
37131  and Literate Programming with Noweb
37132 \end_layout
37133
37134 \begin_layout Standard
37135 The \SpecialChar LyX
37136  support for Literate Programming is provided by using the generic \SpecialChar LyX
37137  converters mechanism.
37138  This support is provided in a
37139 \begin_inset Quotes eld
37140 \end_inset
37141
37142 Noweb independent
37143 \begin_inset Quotes erd
37144 \end_inset
37145
37146  way,
37147  i.
37148 \begin_inset space \thinspace{}
37149 \end_inset
37150
37151 e.
37152 \begin_inset space \space{}
37153 \end_inset
37154
37155 you will be able to use this new \SpecialChar LyX
37156  feature with some other literate programming tool of your choice by just changing your \SpecialChar LyX
37157  preferences.
37158 \end_layout
37159
37160 \begin_layout Subsubsection
37161 Generating documents and code (weaving and tangling)
37162 \end_layout
37163
37164 \begin_layout Paragraph
37165 Using the noweb module
37166 \end_layout
37167
37168 \begin_layout Standard
37169 If you have installed Noweb and \SpecialChar LyX
37170  successfully,
37171  whenever you open a new document,
37172  after you have chosen its document class,
37173  use the
37174 \family sans
37175 Document\SpecialChar menuseparator
37176 Settings
37177 \family default
37178  menu to add the
37179 \begin_inset Quotes eld
37180 \end_inset
37181
37182 noweb
37183 \begin_inset Quotes erd
37184 \end_inset
37185
37186  module.
37187  If Noweb is correctly installed,
37188  when you click on the
37189 \begin_inset Quotes eld
37190 \end_inset
37191
37192 Modules
37193 \begin_inset Quotes erd
37194 \end_inset
37195
37196  link,
37197  you will see the
37198 \begin_inset Quotes eld
37199 \end_inset
37200
37201 noweb
37202 \begin_inset Quotes erd
37203 \end_inset
37204
37205  module in the available list and you can add it to your document.
37206 \end_layout
37207
37208 \begin_layout Paragraph
37209 Typing code in
37210 \end_layout
37211
37212 \begin_layout Standard
37213 \SpecialChar LyX
37214  enables you to write code with a custom inset named
37215 \begin_inset Flex Noun
37216 status collapsed
37217
37218 \begin_layout Plain Layout
37219 Chunk
37220 \end_layout
37221
37222 \end_inset
37223
37224 .
37225  Noweb delimits chunks like this:
37226 \end_layout
37227
37228 \begin_layout LyX-Code
37229 <<My code>>=
37230 \end_layout
37231
37232 \begin_layout LyX-Code
37233   code
37234 \end_layout
37235
37236 \begin_layout LyX-Code
37237   more code
37238 \end_layout
37239
37240 \begin_layout LyX-Code
37241   even more code
37242 \end_layout
37243
37244 \begin_layout LyX-Code
37245   @
37246 \end_layout
37247
37248 \begin_layout Standard
37249 The problem is that whatever is written in between the << and the
37250 \family typewriter
37251 @
37252 \family default
37253  must be taken literally,
37254  i.
37255 \begin_inset space \thinspace{}
37256 \end_inset
37257
37258 e.
37259 \begin_inset space \space{}
37260 \end_inset
37261
37262 \SpecialChar LyX
37263  should be prevented from making any special interpretation of what has been written.
37264  This is also handled by
37265 \begin_inset Flex Noun
37266 status collapsed
37267
37268 \begin_layout Plain Layout
37269 Chunk
37270 \end_layout
37271
37272 \end_inset
37273
37274 ,
37275  that works like a normal text inset but has a free spacing capability.
37276 \end_layout
37277
37278 \begin_layout Standard
37279 As a special note,
37280  you can also use the
37281 \begin_inset Quotes eld
37282 \end_inset
37283
37284 %def
37285 \begin_inset Quotes erd
37286 \end_inset
37287
37288  construct of Noweb in your chunks to add items to Noweb's identifier cross-reference:
37289 \end_layout
37290
37291 \begin_layout LyX-Code
37292 <<My chunk>>=
37293 \end_layout
37294
37295 \begin_layout LyX-Code
37296 def some_function(args):
37297 \end_layout
37298
37299 \begin_layout LyX-Code
37300    "This is the doc string for this function."
37301 \end_layout
37302
37303 \begin_layout LyX-Code
37304    print "My args:
37305  ",
37306  args
37307 \end_layout
37308
37309 \begin_layout LyX-Code
37310 @ %def some_function
37311 \end_layout
37312
37313 \begin_layout Standard
37314 For an example of this usage and the resulting cross-reference output,
37315  look at the Literate python program in
37316 \emph on
37317 LIBDIR/examples/listerrors.lyx
37318 \emph default
37319  which should make this all clear.
37320 \end_layout
37321
37322 \begin_layout Paragraph
37323 Generating the documentation
37324 \end_layout
37325
37326 \begin_layout Standard
37327 At this point you already have a new document file with a proper document class,
37328  and with some code and text on it.
37329  How do I print it?
37330  The answer is simple,
37331  you select
37332 \family sans
37333 View\SpecialChar menuseparator
37334 DVI,
37335
37336 \family default
37337  etc.
37338  Just like you would do for a plain document.
37339  No special procedure is required.
37340 \end_layout
37341
37342 \begin_layout Standard
37343 To help orientate you,
37344  I will now explain what happens inside \SpecialChar LyX
37345 :
37346 \end_layout
37347
37348 \begin_layout Enumerate
37349 When the
37350 \family sans
37351 Update\SpecialChar menuseparator
37352 DVI
37353 \family default
37354  menu option is chosen,
37355  a \SpecialChar LaTeX
37356  file is generated.
37357
37358 \end_layout
37359
37360 \begin_deeper
37361 \begin_layout Standard
37362 If the document is of any literate class the generated file will be named with an extension name defined by the
37363 \begin_inset Quotes eld
37364 \end_inset
37365
37366 literate
37367 \begin_inset Quotes erd
37368 \end_inset
37369
37370  format (defined in the Preferences panel),
37371  otherwise the file will have the usual
37372 \family typewriter
37373 .tex
37374 \family default
37375  extension.
37376 \end_layout
37377
37378 \end_deeper
37379 \begin_layout Enumerate
37380 Note that the only difference so far is in the name of the file,
37381  no special processing is required by \SpecialChar LyX
37382 .
37383  Given that you formatted the code using the
37384 \begin_inset Flex Noun
37385 status collapsed
37386
37387 \begin_layout Plain Layout
37388 Chunk
37389 \end_layout
37390
37391 \end_inset
37392
37393  inset that,
37394  by itself,
37395  takes care of the business.
37396 \end_layout
37397
37398 \begin_layout Enumerate
37399 If the document is of any literate class \SpecialChar LyX
37400  will then use the internal \SpecialChar LyX
37401  to Noweb converter,
37402  followed by the Noweb to \SpecialChar LaTeX
37403  converter
37404 \begin_inset Foot
37405 status collapsed
37406
37407 \begin_layout Plain Layout
37408 The converters are defined in the
37409 \family sans
37410 Tools\SpecialChar menuseparator
37411 Preferences
37412 \family default
37413  panel,
37414  under the
37415 \begin_inset Quotes eld
37416 \end_inset
37417
37418 Conversion
37419 \begin_inset Quotes erd
37420 \end_inset
37421
37422  tab.
37423  See section
37424 \emph on
37425 Converters
37426 \emph default
37427  of the
37428 \emph on
37429 Customization
37430 \emph default
37431  manual for general information about converters.
37432 \end_layout
37433
37434 \end_inset
37435
37436  to generate the \SpecialChar LaTeX
37437  file.
37438 \end_layout
37439
37440 \begin_deeper
37441 \begin_layout Standard
37442 Otherwise it will just skip this step.
37443 \end_layout
37444
37445 \end_deeper
37446 \begin_layout Enumerate
37447 Finally,
37448  \SpecialChar LaTeX
37449  is invoked and the regular post processing continues as in a plain document.
37450 \end_layout
37451
37452 \begin_layout Standard
37453 Independence from a particular
37454 \begin_inset Quotes eld
37455 \end_inset
37456
37457 literate tool
37458 \begin_inset Quotes erd
37459 \end_inset
37460
37461  is easily achieved by changing the commands that are run by the various converters.
37462 \end_layout
37463
37464 \begin_layout Paragraph
37465 Generating the code
37466 \end_layout
37467
37468 \begin_layout Standard
37469 When the build menu option is chosen or the corresponding button in the toolbar is pressed,
37470  a \SpecialChar LaTeX
37471  file is generated just like step 1 above.
37472  Next,
37473  \SpecialChar LyX
37474  invokes the
37475 \family typewriter
37476 Noweb->Program
37477 \family default
37478  converter.
37479  This converter needs to be defined by the user and is not installed by default,
37480  though the Program format is.
37481  This converter (like any other converter) will have two parts:
37482 \end_layout
37483
37484 \begin_layout Enumerate
37485 The converter program itself.
37486  This program performs the conversion from the one format to the other (in this case,
37487  from the Noweb format to the Program pseudo-format).
37488 \end_layout
37489
37490 \begin_layout Enumerate
37491 The error log parser.
37492  This is a program whose sole purpose is to rewrite error messages in a format that \SpecialChar LyX
37493  understands.
37494  This makes it possible for \SpecialChar LyX
37495  to place error boxes in the right places in the file buffer.
37496 \end_layout
37497
37498 \begin_layout Standard
37499 The first part,
37500  the
37501 \begin_inset Quotes eld
37502 \end_inset
37503
37504 Converter
37505 \begin_inset Quotes erd
37506 \end_inset
37507
37508  setting,
37509  should be set to
37510 \end_layout
37511
37512 \begin_layout LyX-Code
37513
37514 \family typewriter
37515 build-script $$i
37516 \family default
37517  $$r
37518 \end_layout
37519
37520 \begin_layout Standard
37521 This basically means that \SpecialChar LyX
37522  will call
37523 \begin_inset Quotes eld
37524 \end_inset
37525
37526 build-script
37527 \begin_inset Quotes erd
37528 \end_inset
37529
37530  (a program or script) with the name of the Noweb file (normally a file in the \SpecialChar LyX
37531  temp directory) and the directory path of the original \SpecialChar LyX
37532  file.
37533
37534 \end_layout
37535
37536 \begin_layout Standard
37537 This is an implementation of
37538 \begin_inset Quotes eld
37539 \end_inset
37540
37541 build-script
37542 \begin_inset Quotes erd
37543 \end_inset
37544
37545  that you can place in a directory on your path:
37546 \end_layout
37547
37548 \begin_layout LyX-Code
37549
37550 \family sans
37551 #!/bin/sh
37552 \end_layout
37553
37554 \begin_layout LyX-Code
37555
37556 \family sans
37557 #
37558 \end_layout
37559
37560 \begin_layout LyX-Code
37561
37562 \family sans
37563 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
37564 \end_layout
37565
37566 \begin_layout Standard
37567 The next part of the converter setting is the
37568 \begin_inset Quotes eld
37569 \end_inset
37570
37571 Flags
37572 \begin_inset Quotes erd
37573 \end_inset
37574
37575  which is to be set to
37576 \end_layout
37577
37578 \begin_layout LyX-Code
37579
37580 \family typewriter
37581 parselog=$$s/scripts/listerrors
37582 \end_layout
37583
37584 \begin_layout Standard
37585 This will run any errors that are generated by the
37586 \begin_inset Quotes eld
37587 \end_inset
37588
37589 build-script
37590 \begin_inset Quotes erd
37591 \end_inset
37592
37593  process through the
37594 \begin_inset Quotes eld
37595 \end_inset
37596
37597 listerrors
37598 \begin_inset Quotes erd
37599 \end_inset
37600
37601  program.
37602 \end_layout
37603
37604 \begin_layout Standard
37605 The build will normally take place in \SpecialChar LyX
37606 's temporary directory,
37607  so the files produced by the conversion will be in that directory.
37608  \SpecialChar LyX
37609  will copy out what it regards as the `main' file,
37610  but the
37611 \family typewriter
37612 Noweb->Program
37613 \family default
37614  conversion may produce several files,
37615  and so most of these would then be deleted when \SpecialChar LyX
37616  was closed.
37617  This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that the build-script chunk can place the generated files in that location.
37618 \end_layout
37619
37620 \begin_layout Paragraph
37621 Build instructions in the document
37622 \end_layout
37623
37624 \begin_layout Standard
37625 The last piece of the integration between \SpecialChar LyX
37626  and noweb is the
37627 \begin_inset Quotes eld
37628 \end_inset
37629
37630 build-script
37631 \begin_inset Quotes erd
37632 \end_inset
37633
37634  chunk.
37635  Generally,
37636  the instructions for building your program should be embedded in a chunk of its own.
37637  The noweb-specific
37638 \begin_inset Quotes eld
37639 \end_inset
37640
37641 build-script
37642 \begin_inset Quotes erd
37643 \end_inset
37644
37645  above uses the notangle command to look for this chunk (called
37646 \begin_inset Quotes eld
37647 \end_inset
37648
37649 build-script
37650 \begin_inset Quotes erd
37651 \end_inset
37652
37653 ) and runs its contents through
37654 \begin_inset Quotes eld
37655 \end_inset
37656
37657 sh
37658 \begin_inset Quotes erd
37659 \end_inset
37660
37661 .
37662 \end_layout
37663
37664 \begin_layout Standard
37665 Typically,
37666  such a chunk would look something like this:
37667 \end_layout
37668
37669 \begin_layout LyX-Code
37670 <<build-script>>=
37671 \end_layout
37672
37673 \begin_layout LyX-Code
37674 #!/bin/sh
37675 \begin_inset Newline newline
37676 \end_inset
37677
37678 if [ -z "${NOWEB_SOURCE}" ]
37679 \begin_inset Newline newline
37680 \end_inset
37681
37682 then
37683 \end_layout
37684
37685 \begin_layout LyX-Code
37686 NOWEB_SOURCE=myfile.nw
37687 \begin_inset Newline newline
37688 \end_inset
37689
37690 fi
37691 \begin_inset Newline newline
37692 \end_inset
37693
37694 [...
37695  code to extract files ...
37696  use NOWEB_OUTPUT_DIR here ...]
37697 \begin_inset Newline newline
37698 \end_inset
37699
37700 [...
37701  code to compile files ...]
37702 \begin_inset Newline newline
37703 \end_inset
37704
37705 @
37706 \end_layout
37707
37708 \begin_layout Standard
37709 Look in
37710 \change_deleted 564990737 1672161716
37711
37712 \emph on
37713 LIBDIR/examples/listerrors.lyx
37714 \emph default
37715  or in
37716 \emph on
37717 LIBDIR/examples/Literate.lyx
37718 \change_inserted 564990737 1672161716
37719
37720 \family sans
37721 \emph default
37722 File\SpecialChar menuseparator
37723 Open Example\SpecialChar menuseparator
37724 Modules\SpecialChar menuseparator
37725 Noweb Listerrors
37726 \change_unchanged
37727
37728 \family default
37729  which implement
37730 \change_deleted 564990737 1672161729
37731 two
37732 \change_unchanged
37733 versions of the
37734 \begin_inset Quotes eld
37735 \end_inset
37736
37737 listerrors
37738 \begin_inset Quotes erd
37739 \end_inset
37740
37741  program for some illustrations of how all of these pieces go together or in
37742 \change_deleted 564990737 1672161756
37743
37744 \emph on
37745 LIBDIR/examples/noweb2lyx.lyx
37746 \change_inserted 564990737 1672161756
37747
37748 \family sans
37749 \emph default
37750 File\SpecialChar menuseparator
37751 Open Example\SpecialChar menuseparator
37752 Modules\SpecialChar menuseparator
37753 Noweb2\SpecialChar LyX
37754
37755 \change_unchanged
37756
37757 \family default
37758 \emph on
37759 .
37760
37761 \emph default
37762  Interestingly,
37763  these
37764 \change_deleted 564990737 1672161767
37765 three
37766 \change_unchanged
37767 files show off the language-indepence of the \SpecialChar LyX
37768  literate programming support since they are written in Python
37769 \change_deleted 564990737 1672161782
37770 ,
37771  C
37772 \change_unchanged
37773  and Perl respectively.
37774 \end_layout
37775
37776 \begin_layout Subsubsection
37777 Configuring \SpecialChar LyX
37778
37779 \end_layout
37780
37781 \begin_layout Standard
37782 All the Literate Programming support is configured by the
37783 \family sans
37784 Tools\SpecialChar menuseparator
37785 Preferences
37786 \family default
37787  panel in the
37788 \begin_inset Quotes eld
37789 \end_inset
37790
37791 File Handling
37792 \begin_inset Quotes erd
37793 \end_inset
37794
37795  tab.
37796  The important parts are:
37797 \end_layout
37798
37799 \begin_layout Description
37800 the
37801 \begin_inset space ~
37802 \end_inset
37803
37804
37805 \begin_inset Quotes eld
37806 \end_inset
37807
37808 NoWeb
37809 \begin_inset Quotes erd
37810 \end_inset
37811
37812
37813 \begin_inset space ~
37814 \end_inset
37815
37816 format Set up via the File Formats tab,
37817  this is where the Noweb-specific pieces are set up.
37818  The
37819 \family sans
37820 GUI Name
37821 \family default
37822  is set to
37823 \family typewriter
37824 NoWeb
37825 \family default
37826 ,
37827  the file extension is set to
37828 \family typewriter
37829 .nw
37830 \family default
37831 .
37832  This tells \SpecialChar LyX
37833  to create a file with a
37834 \family typewriter
37835 .nw
37836 \family default
37837  extension in the first step of the conversion process.
37838 \end_layout
37839
37840 \begin_layout Description
37841 the
37842 \begin_inset space ~
37843 \end_inset
37844
37845
37846 \family sans
37847 Program
37848 \family default
37849
37850 \begin_inset space ~
37851 \end_inset
37852
37853 format This is an empty format whose sole purpose is to be the endpoint of a conversion (which then allows us to set up a converter for it).
37854 \end_layout
37855
37856 \begin_layout Description
37857
37858 \family sans
37859 NoWeb
37860 \family default
37861 ->
37862 \family sans
37863 \SpecialChar LaTeX
37864
37865 \family default
37866  This converter performs the
37867 \begin_inset Quotes eld
37868 \end_inset
37869
37870 weaving
37871 \begin_inset Quotes erd
37872 \end_inset
37873
37874  of the literate document.
37875  For Noweb,
37876  it is set to
37877 \begin_inset Quotes eld
37878 \end_inset
37879
37880
37881 \family typewriter
37882 noweave -delay -index $$i > $$o
37883 \family default
37884
37885 \begin_inset Quotes erd
37886 \end_inset
37887
37888
37889 \end_layout
37890
37891 \begin_layout Description
37892
37893 \family sans
37894 NoWeb
37895 \family default
37896 ->
37897 \family sans
37898 Program
37899 \family default
37900  This performs the
37901 \begin_inset Quotes eld
37902 \end_inset
37903
37904 tangling step
37905 \begin_inset Quotes erd
37906 \end_inset
37907
37908 .
37909  As stated above,
37910  the Converter is set to
37911 \begin_inset Quotes eld
37912 \end_inset
37913
37914
37915 \family typewriter
37916 build-script $$i
37917 \family default
37918  $$r
37919 \begin_inset Quotes erd
37920 \end_inset
37921
37922 ,
37923  with Flags set to
37924 \begin_inset Newline newline
37925 \end_inset
37926
37927
37928 \begin_inset Quotes eld
37929 \end_inset
37930
37931
37932 \family typewriter
37933 parselog=$$s/scripts/listerrors
37934 \family default
37935
37936 \begin_inset Quotes erd
37937 \end_inset
37938
37939 .
37940 \end_layout
37941
37942 \begin_layout Subsubsection
37943 Debug extensions
37944 \end_layout
37945
37946 \begin_layout Standard
37947 There is also a new function implemented in the \SpecialChar LyX
37948  server,
37949  the
37950 \begin_inset Quotes eld
37951 \end_inset
37952
37953 server-goto-file-row" function,
37954  to be used with ddd/gdb or other debugger.
37955
37956 \end_layout
37957
37958 \begin_layout Standard
37959 When debugging code with ddd/gdb,
37960  it is possible to invoke a text editor at the current execution position with a single key stroke.
37961  The default ddd configuration for that is shift-ctrl-V.
37962  It happens that you can define the editor command line invocation in ddd by accessing the
37963 \family sans
37964 Edit\SpecialChar menuseparator
37965 Preferences\SpecialChar menuseparator
37966 Helpers
37967 \family default
37968  dialog and changing the "Edit Sources" entry.
37969 \end_layout
37970
37971 \begin_layout Standard
37972 I take advantage of the newly created \SpecialChar LyX
37973  server function and this ddd feature,
37974  and set
37975 \begin_inset Quotes eld
37976 \end_inset
37977
37978 Edit Sources
37979 \begin_inset Quotes erd
37980 \end_inset
37981
37982  to:
37983 \end_layout
37984
37985 \begin_layout LyX-Code
37986 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
37987 \end_layout
37988
37989 \begin_layout Standard
37990 With this,
37991  whenever you are using ddd and find a point in the program that you want to edit,
37992  you just press shift-ctrl-V (in the ddd window),
37993  and ddd will forward this information to \SpecialChar LyX
37994  through the \SpecialChar LyX
37995  server and then the \SpecialChar LyX
37996  window will show the same file with the cursor at the same position ddd was pointing to.
37997  No more guessing or long scrolling to locate a point in the program back from debugging !
37998 \end_layout
37999
38000 \begin_layout Standard
38001 Note however that you must enable the \SpecialChar LyX
38002  server to get this feature working (it is disabled by default).
38003  Sec.
38004 \begin_inset space ~
38005 \end_inset
38006
38007
38008 \begin_inset CommandInset ref
38009 LatexCommand ref
38010 reference "sec:Starting-the-Server"
38011 nolink "false"
38012
38013 \end_inset
38014
38015  explains how to do that.
38016 \end_layout
38017
38018 \begin_layout Subsubsection
38019 Toolbar extensions
38020 \end_layout
38021
38022 \begin_layout Standard
38023 There are six new buttons that can be added to your \SpecialChar LyX
38024  toolbar.
38025  Four of these buttons are short cuts to layout styles:
38026
38027 \family sans
38028 Standard
38029 \family default
38030 ,
38031
38032 \family sans
38033 Section
38034 \family default
38035 ,
38036
38037 \family sans
38038 \SpecialChar LaTeX
38039
38040 \family default
38041 ,
38042  and
38043 \family sans
38044 \SpecialChar LyX
38045 -Code
38046 \family default
38047 ,
38048  one for the custom inset
38049 \family sans
38050 Chunk
38051 \family default
38052 .
38053  The last one is a short cut to the
38054 \begin_inset Quotes eld
38055 \end_inset
38056
38057 Build Program
38058 \begin_inset Quotes erd
38059 \end_inset
38060
38061  File menu entry.
38062
38063 \end_layout
38064
38065 \begin_layout Standard
38066 \SpecialChar LyX
38067  has a range of buttons that are available for tool bar customization.
38068  In my toolbar I like to combine the six short cuts above with two more:
38069  One for
38070 \family sans
38071 Document
38072 \family default
38073 \SpecialChar menuseparator
38074
38075 \family sans
38076 Update
38077 \family default
38078 \SpecialChar menuseparator
38079
38080 \family sans
38081 DVI
38082 \family default
38083  and the other for
38084 \family sans
38085 Document\SpecialChar menuseparator
38086 View\SpecialChar menuseparator
38087 DVI
38088 \family default
38089  File menu entries.
38090  Here is how it looks like:
38091 \end_layout
38092
38093 \begin_layout LyX-Code
38094 Toolbar
38095 \end_layout
38096
38097 \begin_layout LyX-Code
38098   Layouts
38099 \end_layout
38100
38101 \begin_layout LyX-Code
38102   Icon "layout Standard"
38103 \end_layout
38104
38105 \begin_layout LyX-Code
38106   Icon "layout Section"
38107 \end_layout
38108
38109 \begin_layout LyX-Code
38110   Icon "layout \SpecialChar LaTeX
38111 "
38112 \end_layout
38113
38114 \begin_layout LyX-Code
38115   Icon "layout \SpecialChar LyX
38116 -Code"
38117 \end_layout
38118
38119 \begin_layout LyX-Code
38120   Icon "flex.insert Chunk"
38121 \end_layout
38122
38123 \begin_layout LyX-Code
38124   Separator
38125 \end_layout
38126
38127 \begin_layout LyX-Code
38128   Icon "buffer-view"
38129 \end_layout
38130
38131 \begin_layout LyX-Code
38132   Icon "buffer-typeset"
38133 \end_layout
38134
38135 \begin_layout LyX-Code
38136   Icon "build-program"
38137 \end_layout
38138
38139 \begin_layout LyX-Code
38140   Separator
38141 \end_layout
38142
38143 \begin_layout LyX-Code
38144 .
38145 \end_layout
38146
38147 \begin_layout LyX-Code
38148 .
38149 \end_layout
38150
38151 \begin_layout LyX-Code
38152 .
38153 \end_layout
38154
38155 \begin_layout LyX-Code
38156 End
38157 \end_layout
38158
38159 \begin_layout Subsubsection
38160 Colors customization
38161 \end_layout
38162
38163 \begin_layout Standard
38164 There are a number of colors in \SpecialChar LyX
38165  that can be customized in
38166 \family sans
38167 Preferences
38168 \family default
38169 .
38170  One of the things that bothers people is the \SpecialChar LaTeX
38171  font color.
38172  The default color is red,
38173  since the chunks uses \SpecialChar LaTeX
38174  font,
38175  and there is a lot of chunks in literate documents,
38176  you may get tired of seeing everything in red.
38177  You can change it by going to the tabs
38178 \family sans
38179 Look&Feel
38180 \family default
38181 ,
38182
38183 \family sans
38184 Colors.
38185 \end_layout
38186
38187 \begin_layout Standard
38188 The next thing is the visible presence of the newline character in the screen.
38189  You can choose the color of this particular character and make it blend in the background.
38190  I recommend you choosing a color that is close to the background but not equal,
38191  that way you still can see it is there,
38192  but it is not bothering you anymore.
38193 \end_layout
38194
38195 \begin_layout Subsection
38196 \SpecialChar LyX
38197  and knitr/Sweave
38198 \end_layout
38199
38200 \begin_layout Standard
38201 Support for
38202 \family sans
38203 knitr
38204 \family default
38205  and
38206 \family sans
38207 Sweave
38208 \family default
38209  is documented in
38210 \change_inserted 564990737 1672161863
38211
38212 \family sans
38213 Help\SpecialChar menuseparator
38214 Specific Manuals\SpecialChar menuseparator
38215 Knitr
38216 \family default
38217  and
38218 \change_unchanged
38219
38220 \change_deleted 564990737 1671643409
38221 the
38222 \emph on
38223 knitr.lyx
38224 \emph default
38225  example file
38226 \change_inserted 564990737 1672161856
38227
38228 \family sans
38229 File\SpecialChar menuseparator
38230 Open Example\SpecialChar menuseparator
38231 Modules\SpecialChar menuseparator
38232 Rnw (knitr)
38233 \change_unchanged
38234
38235 \family default
38236  and in
38237 \change_deleted 564990737 1671643461
38238 the Sweave manual (menu
38239 \family sans
38240 Help\SpecialChar menuseparator
38241 Specific Manuals
38242 \family default
38243 )
38244 \change_inserted 564990737 1672161856
38245
38246 \family sans
38247 Help\SpecialChar menuseparator
38248 Specific Manuals\SpecialChar menuseparator
38249 Sweave
38250 \change_deleted 564990737 1672161921
38251
38252 \family default
38253 .
38254
38255 \change_inserted 564990737 1672161917
38256  and
38257 \family sans
38258 File\SpecialChar menuseparator
38259 Open Example\SpecialChar menuseparator
38260 Modules\SpecialChar menuseparator
38261 Sweave
38262 \family default
38263 .
38264 \change_deleted 564990737 1672742969
38265
38266 \end_layout
38267
38268 \begin_layout Standard
38269
38270 \change_deleted 564990737 1671355343
38271 Special features
38272 \end_layout
38273
38274 \begin_layout Standard
38275
38276 \change_deleted 564990737 1671355343
38277 You can do everything with \SpecialChar LyX
38278  that you can do with \SpecialChar LaTeX
38279 .
38280  However,
38281  \SpecialChar LyX
38282  cannot support every \SpecialChar LaTeX
38283  feature directly.
38284  But you can always use \SpecialChar TeX
38285  Code.
38286  This chapter shows you some more special things you might want to use.
38287  For other special things you can do with figures,
38288  tables,
38289  floats,
38290  boxes and notes,
38291  have a look at the
38292 \emph on
38293 Embedded
38294 \begin_inset space ~
38295 \end_inset
38296
38297 Objects
38298 \emph default
38299  manual.
38300 \change_unchanged
38301
38302 \end_layout
38303
38304 \end_body
38305 \end_document