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 sans
10609 Recipe
10610 \change_inserted -712698321 1673182264
10611
10612 \change_inserted 564990737 1671442175
10613 Book
10614 \change_deleted -712698321 1673182266
10615
10616 \family typewriter
10617 .cls
10618 \change_inserted 564990737 1671442175
10619
10620 \family default
10621  uses the
10622 \change_deleted -712698321 1673182282
10623
10624 \family sans
10625 book
10626 \begin_inset space \thinspace{}
10627 \end_inset
10628
10629 (
10630 \change_inserted 564990737 1671442175
10631 KOMA-Script
10632 \change_inserted -712698321 1673182287
10633  Book
10634 \change_deleted -712698321 1673182290
10635 )
10636 \change_inserted 564990737 1671442175
10637
10638 \family default
10639  document class but adds two environments:
10640 \end_layout
10641
10642 \begin_layout Description
10643
10644 \change_inserted 564990737 1671442175
10645 Recipe a numbered section environment at the
10646 \family typewriter
10647 Subsubsection
10648 \family default
10649  level which generates a bold centered heading above a double horizontal rule
10650 \end_layout
10651
10652 \begin_layout Description
10653
10654 \change_inserted 564990737 1671442175
10655 Ingredients a
10656 \family typewriter
10657 Description
10658 \family default
10659  environment where
10660 \series bold
10661 \emph on
10662 Ingredients
10663 \series default
10664 \emph default
10665  are what are being described and the environment ends with a horizontal rule.
10666 \end_layout
10667
10668 \begin_layout Standard
10669
10670 \change_inserted 564990737 1671642866
10671
10672 \family sans
10673 File\SpecialChar menuseparator
10674 Open Example\SpecialChar menuseparator
10675 Books\SpecialChar menuseparator
10676 Recipe Book
10677 \family default
10678  illustrates its use.
10679 \end_layout
10680
10681 \begin_layout Standard
10682
10683 \change_deleted -712698321 1673186391
10684 It
10685 \change_inserted -712698321 1673186393
10686 The class
10687 \change_inserted 564990737 1671442175
10688  is designed for typesetting one or two recipes per page,
10689  with dimensions of 5.5
10690 \begin_inset Quotes qrd
10691 \end_inset
10692
10693
10694 \change_deleted -712698321 1673185652
10695
10696 \change_inserted -712698321 1673185654
10697
10698 \begin_inset Formula $\times$
10699 \end_inset
10700
10701
10702 \change_deleted -712698321 1673185660
10703 x
10704 \change_inserted 564990737 1671442175
10705 8.5
10706 \begin_inset Quotes qrd
10707 \end_inset
10708
10709
10710 \change_inserted -712698321 1673186720
10711  (ideally on US letter paper,
10712  but A4 will work as well if the output is slightly downscaled)
10713 \change_inserted 564990737 1671442175
10714 .
10715  The hyperlinked table of contents (ToC) and page numbers make browsing recipes convenient
10716 \change_inserted -712698321 1673186486
10717 .
10718 \change_deleted -712698321 1673186487
10719 ,
10720
10721 \change_inserted 564990737 1671442175
10722
10723 \change_deleted -712698321 1673186488
10724 and t
10725 \change_inserted -712698321 1673186489
10726 T
10727 \change_inserted 564990737 1671442175
10728 he pages can be joined together or printed 2 per page to
10729 \change_deleted -712698321 1673186516
10730 normal
10731 \change_inserted 564990737 1671442175
10732
10733 \change_inserted -712698321 1673186529
10734 US
10735 \change_inserted 564990737 1671442175
10736 letter
10737 \change_inserted -712698321 1673186520
10738  or A4
10739 \change_inserted 564990737 1671442175
10740 paper easily.
10741  The size was chosen to work in half-page 3-ring binder cover sheets,
10742  because un-laminated paper just doesn't last in the kitchen.
10743 \end_layout
10744
10745 \begin_layout Standard
10746
10747 \change_inserted 564990737 1671442175
10748 The half-letter pages can be printed two per page using your printer driver,
10749  or bound together using
10750 \change_inserted -712698321 1673186305
10751
10752 \end_layout
10753
10754 \begin_layout Quote
10755
10756 \change_inserted 564990737 1671442175
10757
10758 \family typewriter
10759 pdfjam --nup 2x1 --papersize '{11in,8.5in}'
10760 \family default
10761
10762 \family typewriter
10763 Recipes.pdf
10764 \family default
10765
10766 \change_inserted -712698321 1673186310
10767
10768 \end_layout
10769
10770 \begin_layout Standard
10771
10772 \change_inserted 564990737 1671442175
10773 where
10774 \family typewriter
10775 Recipes.pdf
10776 \family default
10777  is the compiled version of your recipes.
10778 \change_inserted -712698321 1673175424
10779
10780 \end_layout
10781
10782 \begin_layout Section
10783
10784 \change_inserted 564990737 1671442207
10785 Curricula vita
10786 \change_deleted -712698321 1673186818
10787 rum
10788 \change_inserted -712698321 1673186818
10789 e
10790 \change_inserted 564990737 1671442207
10791
10792 \end_layout
10793
10794 \begin_layout Subsection
10795
10796 \change_inserted 564990737 1671442208
10797 Europass
10798 \change_inserted -712698321 1673187876
10799  (2013)
10800 \change_inserted 564990737 1671442208
10801
10802 \end_layout
10803
10804 \begin_layout Standard
10805
10806 \change_inserted 564990737 1671642942
10807 The document class
10808 \change_deleted -712698321 1673187623
10809
10810 \family sans
10811 curriculum
10812 \begin_inset space \space{}
10813 \end_inset
10814
10815 vitae
10816 \begin_inset space \thinspace{}
10817 \end_inset
10818
10819 (
10820 \change_inserted 564990737 1671642942
10821 Europass
10822 \change_inserted -712698321 1673187655
10823  (2013)
10824 \change_deleted -712698321 1673187624
10825 )
10826 \change_inserted 564990737 1671642942
10827
10828 \family default
10829  provides the
10830 \family typewriter
10831 europasscv.cls
10832 \family default
10833  document class,
10834  an unofficial implementation of the ‘Europass CV’ recommended by the European Commission in 2013.
10835
10836 \family sans
10837 File\SpecialChar menuseparator
10838 Open Example\SpecialChar menuseparator
10839 Curricula Vitae\SpecialChar menuseparator
10840 Europass
10841 \change_deleted -712698321 1673187728
10842 CV
10843 \change_inserted 564990737 1671642942
10844 (2013)
10845 \family default
10846  offers guidance on its use.
10847  Its documentation is available from
10848 \begin_inset CommandInset href
10849 LatexCommand href
10850 name "CTAN"
10851 target "http://mirrors.ctan.org/macros/latex/contrib/europasscv/europasscv.pdf"
10852 literal "false"
10853
10854 \end_inset
10855
10856 .
10857 \end_layout
10858
10859 \begin_layout Subsection
10860
10861 \change_inserted 564990737 1671442208
10862 Europe
10863 \change_deleted -712698321 1673187829
10864 an
10865 \change_inserted -712698321 1673187829
10866  CV
10867 \change_inserted 564990737 1671442208
10868
10869 \end_layout
10870
10871 \begin_layout Standard
10872
10873 \change_inserted 564990737 1671642984
10874 The document class
10875 \change_deleted -712698321 1673187820
10876
10877 \family sans
10878 curriculum
10879 \begin_inset space \space{}
10880 \end_inset
10881
10882 vitae
10883 \begin_inset space \thinspace{}
10884 \end_inset
10885
10886 (
10887 \change_inserted 564990737 1671642984
10888 Europe
10889 \change_inserted -712698321 1673187823
10890  CV
10891 \change_deleted -712698321 1673187824
10892 )
10893 \change_inserted 564990737 1671642984
10894
10895 \family default
10896  provides the
10897 \family typewriter
10898 europecv.cls
10899 \family default
10900  document class,
10901  an unofficial implementation of the “Europass CV” recommended by the European Commission in 2002.
10902
10903 \family sans
10904 File\SpecialChar menuseparator
10905 Open Example\SpecialChar menuseparator
10906 Curricula Vitae\SpecialChar menuseparator
10907 Europe CV
10908 \family default
10909  offers guidance on its use.
10910  Its documentation is available from
10911 \begin_inset CommandInset href
10912 LatexCommand href
10913 name "CTAN"
10914 target "http://mirrors.ctan.org/macros/latex/contrib/europecv/europecv.pdf"
10915 literal "false"
10916
10917 \end_inset
10918
10919 .
10920 \end_layout
10921
10922 \begin_layout Subsection
10923
10924 \change_inserted 564990737 1671442208
10925 Modern
10926 \change_inserted -712698321 1673187869
10927  CV
10928 \change_inserted 564990737 1671442208
10929
10930 \end_layout
10931
10932 \begin_layout Standard
10933
10934 \change_inserted 564990737 1671643003
10935 The document class
10936 \change_deleted -712698321 1673187880
10937
10938 \family sans
10939 curriculum
10940 \begin_inset space \space{}
10941 \end_inset
10942
10943 vitae
10944 \begin_inset space \thinspace{}
10945 \end_inset
10946
10947 (m
10948 \change_inserted -712698321 1673187880
10949 M
10950 \change_inserted 564990737 1671643003
10951 odern
10952 \change_inserted -712698321 1673187884
10953  CV
10954 \change_deleted -712698321 1673187884
10955 )
10956 \change_inserted 564990737 1671643003
10957
10958 \family default
10959  provides the
10960 \family typewriter
10961 moderncv.cls
10962 \family default
10963  document class.
10964  This allows the creation of customizable CVs.
10965
10966 \family sans
10967 File\SpecialChar menuseparator
10968 Open Example\SpecialChar menuseparator
10969 Curricula Vitae\SpecialChar menuseparator
10970 Modern CV
10971 \family default
10972  offers guidance on its use.
10973  Its documentation is available from
10974 \begin_inset CommandInset href
10975 LatexCommand href
10976 name "CTAN"
10977 target "http://mirrors.ctan.org/macros/latex/contrib/moderncv/manual/moderncv_userguide.pdf"
10978 literal "false"
10979
10980 \end_inset
10981
10982 .
10983 \end_layout
10984
10985 \begin_layout Subsection
10986
10987 \change_inserted 564990737 1671442208
10988 Simple
10989 \change_inserted -712698321 1673187900
10990  CV
10991 \change_inserted 564990737 1671442208
10992
10993 \end_layout
10994
10995 \begin_layout Standard
10996
10997 \change_inserted 564990737 1671643024
10998 The document class
10999 \change_deleted -712698321 1673187895
11000
11001 \family sans
11002 curriculum
11003 \begin_inset space \space{}
11004 \end_inset
11005
11006 vitae
11007 \begin_inset space \thinspace{}
11008 \end_inset
11009
11010 (s
11011 \change_inserted -712698321 1673187895
11012 S
11013 \change_inserted 564990737 1671643024
11014 imple
11015 \change_inserted -712698321 1673187897
11016  CV
11017 \change_deleted -712698321 1673187898
11018 )
11019 \change_inserted 564990737 1671643024
11020
11021 \family default
11022  provides the
11023 \family typewriter
11024 simplecv.cls
11025 \family default
11026  document class,
11027  originally developed for use with \SpecialChar LyX
11028 .
11029
11030 \family sans
11031 File\SpecialChar menuseparator
11032 Open Example\SpecialChar menuseparator
11033 Curricula Vitae\SpecialChar menuseparator
11034 Simple CV
11035 \family default
11036  offers guidance on its use.
11037  Its documentation is available from
11038 \begin_inset CommandInset href
11039 LatexCommand href
11040 name "CTAN"
11041 target "http://mirrors.ctan.org/macros/latex/contrib/simplecv/simplecv.pdf"
11042 literal "false"
11043
11044 \end_inset
11045
11046
11047 \end_layout
11048
11049 \begin_layout Section
11050
11051 \change_inserted 564990737 1672652454
11052 Letters
11053 \end_layout
11054
11055 \begin_layout Standard
11056
11057 \change_inserted 564990737 1672652455
11058 See also the
11059 \family typewriter
11060 letter
11061 \begin_inset space \space{}
11062 \end_inset
11063
11064 (KOMA-Script v.2)
11065 \family default
11066  (section
11067 \begin_inset space ~
11068 \end_inset
11069
11070
11071 \begin_inset CommandInset ref
11072 LatexCommand ref
11073 reference "subsec:The-new-letter"
11074 nolink "false"
11075
11076 \end_inset
11077
11078 ) and
11079 \family typewriter
11080 letter
11081 \begin_inset space \space{}
11082 \end_inset
11083
11084 (with extra font sizes)
11085 \family default
11086  (section
11087 \begin_inset space ~
11088 \end_inset
11089
11090
11091 \begin_inset CommandInset ref
11092 LatexCommand ref
11093 reference "subsec:Extra-font-sizes"
11094 nolink "false"
11095
11096 \end_inset
11097
11098 ) document classes .
11099 \end_layout
11100
11101 \begin_layout Subsection
11102
11103 \change_inserted 564990737 1671041970
11104 Din-Brief
11105 \end_layout
11106
11107 \begin_layout Standard
11108
11109 \change_inserted 564990737 1671617528
11110 The document class
11111 \family sans
11112 Din-Brief
11113 \family default
11114  provides the
11115 \family typewriter
11116 dinbrief.cls
11117 \family default
11118  document class for writing letters according to the
11119 \emph on
11120 Deutsches Institut für Normung
11121 \emph default
11122  conventions.
11123  The file in the menu
11124 \family sans
11125 \bar under
11126 F
11127 \bar default
11128 ile\SpecialChar menuseparator
11129 New
11130 \begin_inset space ~
11131 \end_inset
11132
11133 fro
11134 \bar under
11135 m
11136 \bar default
11137
11138 \begin_inset space ~
11139 \end_inset
11140
11141 Template\SpecialChar menuseparator
11142 Letters\SpecialChar menuseparator
11143 DIN-Brief
11144 \family default
11145  offers guidance on its use.
11146  The documentation is available from
11147 \begin_inset CommandInset href
11148 LatexCommand href
11149 name "CTAN"
11150 target "http://mirrors.ctan.org/macros/latex/contrib/dinbrief/liesmich"
11151 literal "false"
11152
11153 \end_inset
11154
11155 .
11156 \end_layout
11157
11158 \begin_layout Subsection
11159
11160 \change_inserted 564990737 1672652499
11161 frletter
11162 \end_layout
11163
11164 \begin_layout Standard
11165
11166 \change_inserted 564990737 1672652499
11167 The document class
11168 \family sans
11169 French letter
11170 \begin_inset space \space{}
11171 \end_inset
11172
11173 (frletter)
11174 \family default
11175  provides the
11176 \family typewriter
11177 frletter.cls
11178 \family default
11179  document class for writing letters according to French conventions.
11180  The file in the menu
11181 \family sans
11182 \bar under
11183 F
11184 \bar default
11185 ile\SpecialChar menuseparator
11186 New
11187 \begin_inset space ~
11188 \end_inset
11189
11190 fro
11191 \bar under
11192 m
11193 \bar default
11194
11195 \begin_inset space ~
11196 \end_inset
11197
11198 Template\SpecialChar menuseparator
11199 Letters\SpecialChar menuseparator
11200 French letter
11201 \begin_inset space \space{}
11202 \end_inset
11203
11204 (frletter)
11205 \family default
11206  offers guidance on its use.
11207 \end_layout
11208
11209 \begin_layout Subsection
11210
11211 \change_inserted 564990737 1672652499
11212 G-Brief
11213 \end_layout
11214
11215 \begin_layout Standard
11216
11217 \change_inserted 564990737 1672652499
11218 The document class
11219 \family sans
11220 G-Brief (V.
11221 \begin_inset space \thinspace{}
11222 \end_inset
11223
11224 2)
11225 \family default
11226  provides the newer
11227 \family typewriter
11228 g-brief2.cls
11229 \family default
11230  document class for writing letters in German.
11231  The file in the menu
11232 \family sans
11233 \bar under
11234 F
11235 \bar default
11236 ile\SpecialChar menuseparator
11237 New
11238 \begin_inset space ~
11239 \end_inset
11240
11241 fro
11242 \bar under
11243 m
11244 \bar default
11245
11246 \begin_inset space ~
11247 \end_inset
11248
11249 Template\SpecialChar menuseparator
11250 Letters\SpecialChar menuseparator
11251 G-Brief (V.
11252 \begin_inset space \thinspace{}
11253 \end_inset
11254
11255 2)
11256 \family default
11257  offers guidance on its use.
11258  The documentation is available from
11259 \begin_inset CommandInset href
11260 LatexCommand href
11261 name "CTAN"
11262 target "http://mirrors.ctan.org/macros/latex/contrib/g-brief/g-brief.pdf"
11263 literal "false"
11264
11265 \end_inset
11266
11267 .
11268 \end_layout
11269
11270 \begin_layout Subsection
11271
11272 \change_inserted 564990737 1671458835
11273 letter
11274 \end_layout
11275
11276 \begin_layout Standard
11277
11278 \change_inserted 564990737 1671617591
11279 The document class
11280 \family sans
11281 letter
11282 \family default
11283  provides the
11284 \family sans
11285 letter.cls
11286 \family default
11287  document class for English letters and to create mailing labels.
11288  The file in the menu
11289 \family sans
11290 \bar under
11291 F
11292 \bar default
11293 ile\SpecialChar menuseparator
11294 New
11295 \begin_inset space ~
11296 \end_inset
11297
11298 fro
11299 \bar under
11300 m
11301 \bar default
11302
11303 \begin_inset space ~
11304 \end_inset
11305
11306 Template\SpecialChar menuseparator
11307 Letters\SpecialChar menuseparator
11308 Letter (Standard Class)
11309 \family default
11310  offers guidance on its use.
11311 \end_layout
11312
11313 \begin_layout Subsection
11314
11315 \change_inserted 564990737 1672652527
11316 lettre
11317 \end_layout
11318
11319 \begin_layout Standard
11320
11321 \change_inserted 564990737 1672652527
11322 The document class
11323 \family sans
11324 French letter
11325 \begin_inset space \space{}
11326 \end_inset
11327
11328 (lettre)
11329 \family default
11330  provides the
11331 \family typewriter
11332 lettre.cls
11333 \family default
11334  document class for writing letters,
11335  faxes and envelopes in French.
11336  The file in the menu
11337 \family sans
11338 \bar under
11339 F
11340 \bar default
11341 ile\SpecialChar menuseparator
11342 New
11343 \begin_inset space ~
11344 \end_inset
11345
11346 fro
11347 \bar under
11348 m
11349 \bar default
11350
11351 \begin_inset space ~
11352 \end_inset
11353
11354 Template\SpecialChar menuseparator
11355 Letters\SpecialChar menuseparator
11356 French letter
11357 \begin_inset space \space{}
11358 \end_inset
11359
11360 (lettre)
11361 \family default
11362  offers guidance on its use.
11363  The documentation is available from
11364 \begin_inset CommandInset href
11365 LatexCommand href
11366 name "CTAN"
11367 target "http://mirrors.ctan.org/macros/latex/contrib/lettre/lettre.pdf"
11368 literal "false"
11369
11370 \end_inset
11371
11372 .
11373 \end_layout
11374
11375 \begin_layout Section
11376
11377 \change_inserted 564990737 1670439660
11378 Presentations
11379 \end_layout
11380
11381 \begin_layout Subsection
11382
11383 \change_inserted 564990737 1671458922
11384 Beamer
11385 \end_layout
11386
11387 \begin_layout Standard
11388
11389 \change_inserted 564990737 1671617655
11390 The document class
11391 \family sans
11392 presentation
11393 \begin_inset space \thinspace{}
11394 \end_inset
11395
11396 (beamer)
11397 \family default
11398  uses the
11399 \family typewriter
11400 beamer.cls
11401 \family default
11402  document class for creating presentations.
11403  The file in the menu
11404 \family sans
11405 \bar under
11406 F
11407 \bar default
11408 ile\SpecialChar menuseparator
11409 New
11410 \begin_inset space ~
11411 \end_inset
11412
11413 fro
11414 \bar under
11415 m
11416 \bar default
11417
11418 \begin_inset space ~
11419 \end_inset
11420
11421 Template\SpecialChar menuseparator
11422 Presentations\SpecialChar menuseparator
11423 Beamer
11424 \family default
11425  offers guidance on its use.
11426  The documentation is available from
11427 \begin_inset CommandInset href
11428 LatexCommand href
11429 name "CTAN"
11430 target "http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf"
11431 literal "false"
11432
11433 \end_inset
11434
11435 .
11436 \end_layout
11437
11438 \begin_layout Subsection
11439 Foils [aka
11440 \family sans
11441 Foil\SpecialChar TeX
11442
11443 \family default
11444 ]
11445 \begin_inset CommandInset label
11446 LatexCommand label
11447 name "sec:foiltex"
11448
11449 \end_inset
11450
11451
11452 \end_layout
11453
11454 \begin_layout Standard
11455
11456 \change_inserted 564990737 1672743383
11457 Original by
11458 \noun on
11459 Allan Rae
11460 \noun default
11461 ;
11462  updated by the \SpecialChar LyX
11463  Team
11464 \end_layout
11465
11466 \begin_layout Subsubsection
11467
11468 \change_inserted 564990737 1672743383
11469 Introduction
11470 \end_layout
11471
11472 \begin_layout Standard
11473
11474 \change_inserted 564990737 1672743396
11475 The document class
11476 \family sans
11477 presentation
11478 \begin_inset space \thinspace{}
11479 \end_inset
11480
11481 (Foil\SpecialChar TeX
11482 )
11483 \family default
11484  uses the
11485 \family typewriter
11486 foils.cls
11487 \family default
11488  document class to make slides for overhead projectors.
11489  There are two document classes that can do this:
11490  the
11491 \family sans
11492 presentations
11493 \begin_inset space \thinspace{}
11494 \end_inset
11495
11496 (slides)
11497 \family default
11498  document class (section
11499 \begin_inset space ~
11500 \end_inset
11501
11502
11503 \begin_inset CommandInset ref
11504 LatexCommand ref
11505 reference "sec:slitex"
11506 plural "false"
11507 caps "false"
11508 noprefix "false"
11509 nolink "false"
11510
11511 \end_inset
11512
11513 ) and the
11514 \family sans
11515 Foil\SpecialChar TeX
11516
11517 \family default
11518  slides class.
11519  As of 2023 the former has continued to be maintained whereas
11520 \family sans
11521 Foil\SpecialChar TeX
11522
11523 \family default
11524  has not been maintained since 2008.
11525  This section documents the latter.
11526  If your machine doesn’t have the
11527 \family sans
11528 presentation
11529 \begin_inset space \thinspace{}
11530 \end_inset
11531
11532 (Foil\SpecialChar TeX
11533 )
11534 \family default
11535  document class installed,
11536  you’ll probably have to use the
11537 \family sans
11538 presentations
11539 \begin_inset space \thinspace{}
11540 \end_inset
11541
11542 (slides)
11543 \family default
11544  document class.
11545  If you want to install the
11546 \family typewriter
11547 foils.cls
11548 \family default
11549  document class,
11550  it is available from
11551 \begin_inset CommandInset href
11552 LatexCommand href
11553 name "CTAN"
11554 target "https://www.ctan.org/pkg/foiltex"
11555 literal "false"
11556
11557 \end_inset
11558
11559 .
11560  You should also read the
11561 \emph on
11562 Installing New Document Classes
11563 \emph default
11564  chapter of the
11565 \emph on
11566 Customization
11567 \emph default
11568  manual.
11569 \change_deleted 564990737 1672743436
11570 by
11571 \noun on
11572 Allan Rae
11573 \end_layout
11574
11575 \begin_layout Standard
11576
11577 \change_deleted 564990737 1672743383
11578 Introduction
11579 \end_layout
11580
11581 \begin_layout Standard
11582
11583 \change_deleted 564990737 1672743383
11584 This section describes how to use \SpecialChar LyX
11585  to make slides for overhead projectors.
11586  There are two document classes that can do this:
11587  the default slides class and the
11588 \family sans
11589 Foil\SpecialChar TeX
11590
11591 \family default
11592  slides class.
11593  This section documents the latter.
11594 \end_layout
11595
11596 \begin_layout Standard
11597
11598 \change_deleted 564990737 1672743383
11599 I'm going to say this again,
11600  nice and clear,
11601  so that there's no misunderstanding:
11602 \end_layout
11603
11604 \begin_layout Standard
11605
11606 \change_deleted 564990737 1672743383
11607 \begin_inset VSpace bigskip
11608 \end_inset
11609
11610
11611 \end_layout
11612
11613 \begin_layout Standard
11614 \align center
11615
11616 \change_deleted 564990737 1672743383
11617
11618 \size large
11619 This section documents the class
11620 \begin_inset Quotes eld
11621 \end_inset
11622
11623
11624 \family sans
11625 FoilTeX
11626 \family default
11627
11628 \begin_inset Quotes erd
11629 \end_inset
11630
11631
11632 \emph on
11633 only.
11634 \end_layout
11635
11636 \begin_layout Standard
11637
11638 \change_deleted 564990737 1672743383
11639 \begin_inset VSpace bigskip
11640 \end_inset
11641
11642
11643 \end_layout
11644
11645 \begin_layout Standard
11646
11647 \change_deleted 564990737 1672743383
11648 If you're looking for the documentation for
11649 \begin_inset Quotes eld
11650 \end_inset
11651
11652
11653 \family sans
11654 slides (default)
11655 \family default
11656
11657 \begin_inset Quotes erd
11658 \end_inset
11659
11660 ,
11661  check out section
11662 \begin_inset space ~
11663 \end_inset
11664
11665
11666 \begin_inset CommandInset ref
11667 LatexCommand ref
11668 reference "sec:slitex"
11669 nolink "false"
11670
11671 \end_inset
11672
11673 .
11674  If your machine doesn't have the
11675 \family sans
11676 foils
11677 \family default
11678  class
11679 \family sans
11680 FoilTeX
11681 \family default
11682  installed,
11683  you'll probably have to use the default
11684 \family sans
11685 slides
11686 \family default
11687  class,
11688  which isn't quite as good as
11689 \family sans
11690 foils.
11691 \end_layout
11692
11693 \begin_layout Standard
11694
11695 \change_deleted 564990737 1672743383
11696 The
11697 \family sans
11698 foils
11699 \family default
11700  class is designed for use with version
11701 \begin_inset space ~
11702 \end_inset
11703
11704 2.1 of the
11705 \family sans
11706 foils.cls
11707 \family default
11708  \SpecialChar LaTeX
11709  class file which is now an integral part of \SpecialChar LaTeX2e
11710 .
11711 \change_unchanged
11712
11713 \end_layout
11714
11715 \begin_layout Subsubsection
11716 Getting Started
11717 \end_layout
11718
11719 \begin_layout Standard
11720 Obviously,
11721  to use this document class,
11722  you need to select
11723 \family sans
11724 FoilTeX
11725 \family default
11726  from the
11727 \family sans
11728 Class
11729 \family default
11730  entry in the
11731 \family sans
11732 Document
11733 \begin_inset space ~
11734 \end_inset
11735
11736 Layout
11737 \family default
11738  dialog.
11739  There are some settings in the
11740 \family sans
11741 Document
11742 \begin_inset space ~
11743 \end_inset
11744
11745 Layout
11746 \family default
11747  dialog that you should know about that are specific to this class:
11748 \end_layout
11749
11750 \begin_layout Itemize
11751 Don't change the options
11752 \family sans
11753 Sides
11754 \family default
11755  and
11756 \family sans
11757 Columns
11758 \family default
11759  on the
11760 \family sans
11761 Document
11762 \begin_inset space ~
11763 \end_inset
11764
11765 Layout
11766 \family default
11767  dialog.
11768  They're ignored by the
11769 \family sans
11770 foils
11771 \family default
11772  class.
11773 \end_layout
11774
11775 \begin_layout Itemize
11776 The default font size is 20
11777 \begin_inset space \thinspace{}
11778 \end_inset
11779
11780 pt with the other options being 17
11781 \begin_inset space \thinspace{}
11782 \end_inset
11783
11784 pt,
11785  25
11786 \begin_inset space \thinspace{}
11787 \end_inset
11788
11789 pt and 30
11790 \begin_inset space \thinspace{}
11791 \end_inset
11792
11793 pt.
11794 \end_layout
11795
11796 \begin_layout Itemize
11797 The default font is
11798 \family sans
11799 sans
11800 \family default
11801
11802 \family sans
11803 serif
11804 \family default
11805  but all math equations are still typeset in the usual roman font.
11806 \end_layout
11807
11808 \begin_layout Itemize
11809
11810 \family sans
11811 Foil\SpecialChar TeX
11812
11813 \family default
11814  supports A4 and Letter paper sizes as well as a special size for working with 35
11815 \begin_inset space \thinspace{}
11816 \end_inset
11817
11818 mm slides.
11819  It doesn't support A5,
11820  B5,
11821  legal or executive paper sizes.
11822 \end_layout
11823
11824 \begin_layout Itemize
11825 Don't bother changing the
11826 \family sans
11827 Float Placement
11828 \family default
11829  settings because they are ignored anyway.
11830  All floats appear where they are defined in the text.
11831 \end_layout
11832
11833 \begin_layout Itemize
11834 The
11835 \family sans
11836 Pagestyle
11837 \family default
11838  setting behaves a bit differently for this class.
11839
11840 \family sans
11841 Foil\SpecialChar TeX
11842
11843 \family default
11844  provides extensive footer and header capabilities including a user-defined logo.
11845  See section
11846 \begin_inset space ~
11847 \end_inset
11848
11849
11850 \begin_inset CommandInset ref
11851 LatexCommand ref
11852 reference "sec:foilfoot"
11853 nolink "false"
11854
11855 \end_inset
11856
11857  for more details.
11858  The title page is treated differently to all other pages in the document and is
11859 \emph on
11860 always
11861 \emph default
11862  unnumbered and
11863 \emph on
11864 always
11865 \emph default
11866  has the logo centered at the bottom of the page (if one is defined).
11867  The possible page style choices and what they do are as follows:
11868 \end_layout
11869
11870 \begin_deeper
11871 \begin_layout Labeling
11872 \labelwidthstring MMMMMMM
11873
11874 \family sans
11875 \series bold
11876 empty
11877 \family default
11878 \series default
11879  The final output contains no page numbers,
11880  or other headers or footers (except footnotes of course).
11881
11882 \end_layout
11883
11884 \begin_layout Labeling
11885 \labelwidthstring MMMMMMM
11886
11887 \family sans
11888 \series bold
11889 plain
11890 \family default
11891 \series default
11892  The final output contains page numbers centered at the bottom of the page.
11893  No other headings or footers (other than footnotes).
11894 \end_layout
11895
11896 \begin_layout Labeling
11897 \labelwidthstring MMMMMMM
11898
11899 \series bold
11900 foilheadings
11901 \series default
11902  Page numbers in lower right corner.
11903  Additional headers and footers are also shown.
11904  This is also the default.
11905 \end_layout
11906
11907 \begin_layout Labeling
11908 \labelwidthstring MMMMMMM
11909
11910 \series bold
11911 fancy
11912 \series default
11913  Gives you access to the
11914 \family sans
11915 fancyheadings
11916 \family default
11917  package although its use with
11918 \family sans
11919 Foil\SpecialChar TeX
11920
11921 \family default
11922  is discouraged by the writer of the
11923 \family sans
11924 Foil\SpecialChar TeX
11925
11926 \family default
11927  package because of some potential page layout clashes.
11928 \end_layout
11929
11930 \end_deeper
11931 \begin_layout Paragraph
11932 Extra Options
11933 \end_layout
11934
11935 \begin_layout Standard
11936 The following options may be used in the extra class options in the
11937 \family sans
11938 Document\SpecialChar menuseparator
11939 Settings
11940 \family default
11941  dialog.
11942 \end_layout
11943
11944 \begin_layout Labeling
11945 \labelwidthstring MMMMMMx
11946
11947 \series bold
11948 35mmSlide
11949 \series default
11950  This sets up the page layout for 7.33
11951 \begin_inset space \thinspace{}
11952 \end_inset
11953
11954 in by 11
11955 \begin_inset space \thinspace{}
11956 \end_inset
11957
11958 in paper,
11959  which is about the same aspect ratio as a 35
11960 \begin_inset space \thinspace{}
11961 \end_inset
11962
11963 mm slide,
11964  making it a bit easier to work with this medium.
11965 \end_layout
11966
11967 \begin_layout Labeling
11968 \labelwidthstring MMMMMMx
11969
11970 \series bold
11971 headrule
11972 \series default
11973  Places a rule across the page below the header on every page except the title page.
11974 \end_layout
11975
11976 \begin_layout Labeling
11977 \labelwidthstring MMMMMMx
11978
11979 \series bold
11980 footrule
11981 \series default
11982  Places a rule across the page above the footer on every page except the title page.
11983 \end_layout
11984
11985 \begin_layout Labeling
11986 \labelwidthstring MMMMMMx
11987
11988 \series bold
11989 dvips
11990 \series default
11991  This is automatically set each time you create a new
11992 \family sans
11993 foils
11994 \family default
11995  document.
11996  This option tells
11997 \family sans
11998 Foil\SpecialChar TeX
11999
12000 \family default
12001  to use the dvips driver to rotate those pages that are set as landscape foils.
12002 \end_layout
12003
12004 \begin_layout Labeling
12005 \labelwidthstring MMMMMMx
12006
12007 \series bold
12008 landscape
12009 \series default
12010  Simply changes the page dimensions to those of a landscape page but doesn't do any rotation.
12011  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.
12012  Note that this option effectively reverses the roles of the
12013 \family sans
12014 Foilhead
12015 \family default
12016  and
12017 \family sans
12018 Rotatefoilhead
12019 \family default
12020  environments (don't worry these are described in the next section).
12021 \end_layout
12022
12023 \begin_layout Labeling
12024 \labelwidthstring MMMMMMx
12025
12026 \series bold
12027 leqno
12028 \series default
12029  Equation numbers on the left.
12030 \end_layout
12031
12032 \begin_layout Labeling
12033 \labelwidthstring MMMMMMx
12034
12035 \series bold
12036 fleqn
12037 \series default
12038  Flush-left equations.
12039 \end_layout
12040
12041 \begin_layout Subsubsection
12042 Supported Environments
12043 \end_layout
12044
12045 \begin_layout Standard
12046 Most of the environments commonly supported in other classes are also supported by the
12047 \family sans
12048 foils
12049 \family default
12050  class.
12051  There are several additional environments provided by
12052 \family sans
12053 Foil\SpecialChar TeX
12054
12055 \family default
12056  as well as a couple added by \SpecialChar LyX
12057 .
12058  The following environments are shared with other classes:
12059 \end_layout
12060
12061 \begin_layout Standard
12062 \begin_inset Flex Multiple Columns
12063 status open
12064
12065 \begin_layout Itemize
12066
12067 \family sans
12068 Standard
12069 \end_layout
12070
12071 \begin_layout Itemize
12072
12073 \family sans
12074 Itemize
12075 \end_layout
12076
12077 \begin_layout Itemize
12078
12079 \family sans
12080 Enumerate
12081 \end_layout
12082
12083 \begin_layout Itemize
12084
12085 \family sans
12086 Description
12087 \end_layout
12088
12089 \begin_layout Itemize
12090
12091 \family sans
12092 List
12093 \end_layout
12094
12095 \begin_layout Itemize
12096
12097 \family sans
12098 \SpecialChar LyX
12099 -Code
12100 \end_layout
12101
12102 \begin_layout Itemize
12103
12104 \family sans
12105 Verse
12106 \end_layout
12107
12108 \begin_layout Itemize
12109
12110 \family sans
12111 Quote
12112 \end_layout
12113
12114 \begin_layout Itemize
12115
12116 \family sans
12117 Quotation
12118 \end_layout
12119
12120 \begin_layout Itemize
12121
12122 \family sans
12123 TitleAuthor
12124 \end_layout
12125
12126 \begin_layout Itemize
12127
12128 \family sans
12129 Date
12130 \end_layout
12131
12132 \begin_layout Itemize
12133
12134 \family sans
12135 Abstract
12136 \end_layout
12137
12138 \begin_layout Itemize
12139
12140 \family sans
12141 Bibliography
12142 \end_layout
12143
12144 \begin_layout Itemize
12145
12146 \family sans
12147 Address
12148 \end_layout
12149
12150 \begin_layout Itemize
12151
12152 \family sans
12153 RightAddress
12154 \end_layout
12155
12156 \end_inset
12157
12158
12159 \end_layout
12160
12161 \begin_layout Standard
12162 That is,
12163  all the major environments apart from the sectioning environments.
12164  Since foils are essentially self-contained sections,
12165  with a title and body,
12166
12167 \family sans
12168 Foil\SpecialChar TeX
12169
12170 \family default
12171  provides specific commands for starting new foils and these are:
12172 \end_layout
12173
12174 \begin_layout Itemize
12175
12176 \family sans
12177 Foilhead
12178 \end_layout
12179
12180 \begin_layout Itemize
12181
12182 \family sans
12183 Rotatefoilhead
12184 \end_layout
12185
12186 \begin_layout Standard
12187 \SpecialChar LyX
12188  also provides slightly modified versions of these two environments called:
12189 \end_layout
12190
12191 \begin_layout Itemize
12192
12193 \family sans
12194 ShortFoilhead
12195 \end_layout
12196
12197 \begin_layout Itemize
12198
12199 \family sans
12200 ShortRotatefoilhead
12201 \end_layout
12202
12203 \begin_layout Standard
12204 and the differences will be explained in the next section.
12205 \end_layout
12206
12207 \begin_layout Standard
12208 Since foils are often used in presenting ideas or new theorems and such
12209 \family sans
12210 Foil\SpecialChar TeX
12211
12212 \family default
12213  also provides a comprehensive box of goodies for presenting them:
12214 \end_layout
12215
12216 \begin_layout Standard
12217 \begin_inset Flex Multiple Columns
12218 status open
12219
12220 \begin_layout Itemize
12221
12222 \family sans
12223 Theorem
12224 \end_layout
12225
12226 \begin_layout Itemize
12227
12228 \family sans
12229 Lemma
12230 \end_layout
12231
12232 \begin_layout Itemize
12233
12234 \family sans
12235 Corollary
12236 \end_layout
12237
12238 \begin_layout Itemize
12239
12240 \family sans
12241 Proposition
12242 \end_layout
12243
12244 \begin_layout Itemize
12245
12246 \family sans
12247 Definition
12248 \end_layout
12249
12250 \begin_layout Itemize
12251
12252 \family sans
12253 Proof
12254 \end_layout
12255
12256 \begin_layout Itemize
12257
12258 \family sans
12259 Theorem*
12260 \end_layout
12261
12262 \begin_layout Itemize
12263
12264 \family sans
12265 Lemma*
12266 \end_layout
12267
12268 \begin_layout Itemize
12269
12270 \family sans
12271 Corollary*
12272 \end_layout
12273
12274 \begin_layout Itemize
12275
12276 \family sans
12277 Proposition*
12278 \end_layout
12279
12280 \begin_layout Itemize
12281
12282 \family sans
12283 Definition*
12284 \end_layout
12285
12286 \end_inset
12287
12288
12289 \end_layout
12290
12291 \begin_layout Standard
12292 The starred versions are unnumbered while the unstarred versions are numbered.
12293  There are also two list environments added by \SpecialChar LyX
12294  and these are:
12295 \end_layout
12296
12297 \begin_layout Itemize
12298
12299 \family sans
12300 TickList
12301 \end_layout
12302
12303 \begin_layout Itemize
12304
12305 \family sans
12306 CrossList
12307 \end_layout
12308
12309 \begin_layout Standard
12310
12311 \family sans
12312 Foil\SpecialChar TeX
12313
12314 \family default
12315  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.
12316  If you want to change these settings in your document the best place to do so is at the very top of a foil,
12317  i.
12318 \begin_inset space \thinspace{}
12319 \end_inset
12320
12321 e.
12322 \emph on
12323
12324 \begin_inset space \space{}
12325 \end_inset
12326
12327
12328 \emph default
12329 straight after the foilhead.
12330 \end_layout
12331
12332 \begin_layout Standard
12333 For this purpose,
12334  the following command styles are provided [
12335 \shape smallcaps
12336 Martin Vermeer
12337 \shape default
12338 ]:
12339 \end_layout
12340
12341 \begin_layout Standard
12342 \begin_inset Flex Multiple Columns
12343 status open
12344
12345 \begin_layout Itemize
12346
12347 \family sans
12348 My
12349 \begin_inset space ~
12350 \end_inset
12351
12352 Logo
12353 \end_layout
12354
12355 \begin_layout Itemize
12356
12357 \family sans
12358 Restriction
12359 \end_layout
12360
12361 \begin_layout Itemize
12362
12363 \family sans
12364 Right
12365 \begin_inset space ~
12366 \end_inset
12367
12368 Footer
12369 \end_layout
12370
12371 \begin_layout Itemize
12372
12373 \family sans
12374 Right
12375 \begin_inset space ~
12376 \end_inset
12377
12378 Header
12379 \end_layout
12380
12381 \begin_layout Itemize
12382
12383 \family sans
12384 Left
12385 \begin_inset space ~
12386 \end_inset
12387
12388 Header
12389 \end_layout
12390
12391 \begin_deeper
12392 \begin_layout Plain Layout
12393 \begin_inset space ~
12394 \end_inset
12395
12396
12397 \end_layout
12398
12399 \end_deeper
12400 \end_inset
12401
12402
12403 \end_layout
12404
12405 \begin_layout Standard
12406 There are also a few commands provided by
12407 \family sans
12408 Foil\SpecialChar TeX
12409
12410 \family default
12411  that aren't directly supported by \SpecialChar LyX
12412  but I'll tell you what they do and how to use them in section
12413 \begin_inset space ~
12414 \end_inset
12415
12416
12417 \begin_inset CommandInset ref
12418 LatexCommand ref
12419 reference "sec:unsuppfoils"
12420 nolink "false"
12421
12422 \end_inset
12423
12424 .
12425 \end_layout
12426
12427 \begin_layout Subsubsection
12428 Building a Set of Foils
12429 \end_layout
12430
12431 \begin_layout Standard
12432 This section will give a simple introduction to using the different environments to build a set of foils.
12433  If you want to see an example set of foils,
12434  take a look at
12435 \change_deleted 564990737 1671643085
12436 the
12437 \family typewriter
12438 Foils.lyx
12439 \family default
12440  file you find in \SpecialChar LyX
12441 's
12442 \family typewriter
12443 examples
12444 \family default
12445  folder
12446 \change_inserted 564990737 1671643099
12447
12448 \family sans
12449 File\SpecialChar menuseparator
12450 Open Example\SpecialChar menuseparator
12451 Presentations\SpecialChar menuseparator
12452 Foils
12453 \change_unchanged
12454
12455 \family default
12456 .
12457 \end_layout
12458
12459 \begin_layout Paragraph
12460 Give It a Title Page
12461 \end_layout
12462
12463 \begin_layout Standard
12464 Unlike other classes that provide
12465 \family sans
12466 Title
12467 \family default
12468 ,
12469
12470 \family sans
12471 Author
12472 \family default
12473 ,
12474
12475 \family sans
12476 Date
12477 \family default
12478  and
12479 \family sans
12480 Abstract
12481 \family default
12482  environments,
12483
12484 \family sans
12485 foils
12486 \family default
12487  creates the title on a page of its own.
12488  If you leave out the
12489 \family sans
12490 Date
12491 \family default
12492  environment \SpecialChar LaTeX
12493  will substitute the current date (every time you regenerate the output).
12494 \end_layout
12495
12496 \begin_layout Paragraph
12497 Start a New Foil
12498 \end_layout
12499
12500 \begin_layout Standard
12501 As I mentioned earlier,
12502  there are four ways of starting a new foil.
12503  For portrait foils you should use
12504 \family sans
12505 Foilhead
12506 \family default
12507  or
12508 \family sans
12509 ShortFoilhead.
12510
12511 \family default
12512  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.
12513 \end_layout
12514
12515 \begin_layout Standard
12516 Landscape foils are generated using the
12517 \family sans
12518 Rotatefoilhead
12519 \family default
12520  and
12521 \family sans
12522 ShortRotatefoilhead
12523 \family default
12524  environments.
12525  Again the only difference is the spacing between foilhead and body.
12526  Both of the short versions have 0.5
12527 \begin_inset space ~
12528 \end_inset
12529
12530 inches less separation between the foilhead and the body.
12531
12532 \end_layout
12533
12534 \begin_layout Standard
12535 One problem with the support for landscape foils is the requirement that you have to use the
12536 \family typewriter
12537 dvips
12538 \family default
12539  driver to generate the PostScript output otherwise the foils won't be rotated.
12540  It is possible to get landscape foils even if you haven't got the
12541 \family typewriter
12542 dvips
12543 \family default
12544  driver provided you can feed your foils sideways through your printer ;-)
12545 \end_layout
12546
12547 \begin_layout Paragraph
12548 Theorems,
12549  Lemmas,
12550  Proofs and more
12551 \end_layout
12552
12553 \begin_layout Standard
12554 You can't have two of the same type of these environments directly following each other.
12555  If you use a normal paragraph break,
12556  ,
12557  you will just be extending the previous environment as if you had merged the two environments together.
12558  Rather than that,
12559  you need to insert a so-called separator.
12560  Please refer to the section entitled
12561 \emph on
12562 Separate Nestings
12563 \emph default
12564  in the
12565 \emph on
12566 User's Guide
12567 \emph default
12568 .
12569 \end_layout
12570
12571 \begin_layout Paragraph
12572 Lists
12573 \end_layout
12574
12575 \begin_layout Standard
12576 You get all the commonly supported list styles found in other classes as well as two new ones.
12577  I'll only describe the new ones here.
12578  If you want to find out more about the other list environments check out the
12579 \emph on
12580 User's Guide.
12581
12582 \emph default
12583  If you intend to use itemized lists you might also want to read about the
12584 \family sans
12585 Itemize
12586 \begin_inset space ~
12587 \end_inset
12588
12589 Bullet
12590 \begin_inset space ~
12591 \end_inset
12592
12593 Selection
12594 \family default
12595  dialog described above in section
12596 \begin_inset space ~
12597 \end_inset
12598
12599
12600 \change_inserted 564990737 1671355684
12601
12602 \begin_inset CommandInset ref
12603 LatexCommand ref
12604 reference "chap:bullets"
12605 nolink "false"
12606
12607 \end_inset
12608
12609
12610 \change_deleted 564990737 1671355684
12611
12612 \begin_inset CommandInset ref
12613 LatexCommand ref
12614 reference "sec:bullet"
12615 nolink "false"
12616
12617 \end_inset
12618
12619
12620 \change_unchanged
12621 .
12622 \end_layout
12623
12624 \begin_layout Standard
12625 The two new list styles,
12626
12627 \family sans
12628 TickList
12629 \family default
12630  and
12631 \family sans
12632 CrossList
12633 \family default
12634 ,
12635  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.
12636  These lists are in fact dedicated variants of the
12637 \family sans
12638 Itemize
12639 \family default
12640  environment.
12641  They do however require that you have the
12642 \family typewriter
12643 psnfss
12644 \family default
12645  packages installed.
12646 \end_layout
12647
12648 \begin_layout Paragraph
12649 Figures and Tables
12650 \end_layout
12651
12652 \begin_layout Standard
12653
12654 \family sans
12655 Foil\SpecialChar TeX
12656
12657 \family default
12658  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.
12659  In fact if you change the float placement settings they are simply ignored.
12660 \end_layout
12661
12662 \begin_layout Paragraph
12663 Page Headers and Footers
12664 \begin_inset CommandInset label
12665 LatexCommand label
12666 name "sec:foilfoot"
12667
12668 \end_inset
12669
12670
12671 \end_layout
12672
12673 \begin_layout Standard
12674
12675 \family sans
12676 My
12677 \begin_inset space ~
12678 \end_inset
12679
12680 Logo
12681 \family default
12682  and
12683 \family sans
12684 Restriction
12685 \family default
12686  are two commands used to control the left-footer text string.
12687  The first is meant to allow you to include a graphic logo on your foils and defaults to
12688 \begin_inset Quotes eld
12689 \end_inset
12690
12691 -Typeset by
12692 \family sans
12693 Foil\SpecialChar TeX
12694
12695 \family default
12696 -
12697 \begin_inset Quotes erd
12698 \end_inset
12699
12700 .
12701  While the second is meant to provide a classification for the audience,
12702
12703 \emph on
12704 e.
12705 \begin_inset space \thinspace{}
12706 \end_inset
12707
12708 g.
12709 \emph default
12710
12711 \begin_inset space \space{}
12712 \end_inset
12713
12714 Confidential.
12715  It is empty by default.
12716 \end_layout
12717
12718 \begin_layout Standard
12719 The remaining page corners can be filled by
12720 \family sans
12721 Right
12722 \begin_inset space ~
12723 \end_inset
12724
12725 Footer
12726 \family default
12727  (which defaults to page numbers),
12728
12729 \family sans
12730 Right
12731 \begin_inset space ~
12732 \end_inset
12733
12734 Header
12735 \family default
12736  (top right) and
12737 \family sans
12738 Left
12739 \begin_inset space ~
12740 \end_inset
12741
12742 Header
12743 \family default
12744  (top left).
12745 \end_layout
12746
12747 \begin_layout Subsubsection
12748 Unsupported
12749 \family sans
12750 Foil\SpecialChar TeX
12751
12752 \family default
12753  Goodies
12754 \begin_inset CommandInset label
12755 LatexCommand label
12756 name "sec:unsuppfoils"
12757
12758 \end_inset
12759
12760
12761 \end_layout
12762
12763 \begin_layout Standard
12764 All the commands mentioned below need to be set in a
12765 \family sans
12766 \SpecialChar LaTeX
12767
12768 \family default
12769  environment or as
12770 \family sans
12771 \SpecialChar TeX
12772
12773 \family default
12774  within another environment.
12775 \end_layout
12776
12777 \begin_layout Paragraph
12778 Lengths
12779 \end_layout
12780
12781 \begin_layout Standard
12782 All lengths are adjusted using the
12783 \family typewriter
12784
12785 \backslash
12786 setlength{
12787 \family default
12788 \emph on
12789 lengthname
12790 \family typewriter
12791 \emph default
12792 }{
12793 \family default
12794 \emph on
12795 newlength
12796 \family typewriter
12797 \emph default
12798 }
12799 \family default
12800  command.
12801  Where
12802 \emph on
12803 lengthname
12804 \emph default
12805  should be replaced by the name given to the length you want to change and
12806 \emph on
12807 newlength
12808 \emph default
12809  is the length value.
12810  All lengths should be specified in units of length such as inches (
12811 \family typewriter
12812 in
12813 \family default
12814 ),
12815  millimeters (
12816 \family typewriter
12817 mm
12818 \family default
12819 ) or points (
12820 \family typewriter
12821 pt
12822 \family default
12823 ) or relative to some document or font-based length such as
12824 \family typewriter
12825
12826 \backslash
12827 textwidth
12828 \family default
12829 .
12830
12831 \end_layout
12832
12833 \begin_layout Standard
12834 It's possible to change the spacing between a foilhead and the body of the foil by adjusting the length specified by
12835 \family typewriter
12836
12837 \backslash
12838 foilheadskip
12839 \family default
12840 .
12841  For example,
12842  to make
12843 \emph on
12844 all
12845 \emph default
12846  foilheads 0.5
12847 \begin_inset space \space{}
12848 \end_inset
12849
12850 in closer to their bodies put the following in the preamble:
12851
12852 \family typewriter
12853
12854 \backslash
12855 setlength{
12856 \backslash
12857 foilheadskip}{-0.5in}
12858 \end_layout
12859
12860 \begin_layout Standard
12861 The spacings around floats can be adjusted by setting these lengths:
12862 \end_layout
12863
12864 \begin_layout Labeling
12865 \labelwidthstring MMMMMMMMMMM
12866
12867 \family typewriter
12868
12869 \backslash
12870 abovefloatskip
12871 \family default
12872  Separation between the text and the top of the float
12873 \end_layout
12874
12875 \begin_layout Labeling
12876 \labelwidthstring MMMMMMMMMMM
12877
12878 \family typewriter
12879
12880 \backslash
12881 abovecaptionskip
12882 \family default
12883  Separation between the float and the caption
12884 \end_layout
12885
12886 \begin_layout Labeling
12887 \labelwidthstring MMMMMMMMMMM
12888
12889 \family typewriter
12890
12891 \backslash
12892 belowcaptionskip
12893 \family default
12894  Separation between the caption and the following text
12895 \end_layout
12896
12897 \begin_layout Labeling
12898 \labelwidthstring MMMMMMMMMMM
12899
12900 \family typewriter
12901
12902 \backslash
12903 captionwidth
12904 \family default
12905  You can make the captions narrower than the surrounding text by adjusting this length.
12906  Best done relative to
12907 \family typewriter
12908
12909 \backslash
12910 textwidth
12911 \family default
12912 .
12913 \end_layout
12914
12915 \begin_layout Standard
12916 There are also several title page related lengths that you may find useful if you have a long title or several authors:
12917 \end_layout
12918
12919 \begin_layout Labeling
12920 \labelwidthstring MMMMMMMMMMM
12921
12922 \family typewriter
12923
12924 \backslash
12925 abovetitleskip
12926 \family default
12927  Separation from headers to
12928 \family sans
12929 Title
12930 \end_layout
12931
12932 \begin_layout Labeling
12933 \labelwidthstring MMMMMMMMMMM
12934
12935 \family typewriter
12936
12937 \backslash
12938 titleauthorskip
12939 \family default
12940  between
12941 \family sans
12942 Title
12943 \family default
12944  and
12945 \family sans
12946 Author
12947 \family default
12948  environments
12949 \end_layout
12950
12951 \begin_layout Labeling
12952 \labelwidthstring MMMMMMMMMMM
12953
12954 \family typewriter
12955
12956 \backslash
12957 authorauthorskip
12958 \family default
12959  between multiple
12960 \family sans
12961 Author
12962 \family default
12963  lines
12964 \end_layout
12965
12966 \begin_layout Labeling
12967 \labelwidthstring MMMMMMMMMMM
12968
12969 \family typewriter
12970
12971 \backslash
12972 authordateskip
12973 \family default
12974  between the
12975 \family sans
12976 Author
12977 \family default
12978  and the
12979 \family sans
12980 Date
12981 \end_layout
12982
12983 \begin_layout Labeling
12984 \labelwidthstring MMMMMMMMMMM
12985
12986 \family typewriter
12987
12988 \backslash
12989 dateabstractskip
12990 \family default
12991  between the
12992 \family sans
12993 Date
12994 \family default
12995  and the
12996 \family sans
12997 Abstract
12998 \end_layout
12999
13000 \begin_layout Standard
13001 The last length related command affects all the list environments.
13002  If you place
13003 \family typewriter
13004
13005 \backslash
13006 zerolistvertdimens
13007 \family default
13008
13009 \emph on
13010 inside
13011 \emph default
13012  a list environment then all the vertical spacing between the list items is removed.
13013  Note that this is a command not a length so it doesn't require
13014 \family typewriter
13015
13016 \backslash
13017 setlength
13018 \family default
13019  like the stuff mentioned above.
13020 \end_layout
13021
13022 \begin_layout Paragraph
13023 Headers and Footers
13024 \end_layout
13025
13026 \begin_layout Standard
13027 The
13028 \family typewriter
13029
13030 \backslash
13031 LogoOn
13032 \family default
13033  and
13034 \family typewriter
13035
13036 \backslash
13037 LogoOff
13038 \family default
13039  commands control whether the logo in the
13040 \family sans
13041 MyLogo
13042 \family default
13043  definition appear on a given page.
13044  If you put
13045 \family typewriter
13046
13047 \backslash
13048 LogoOff
13049 \family default
13050  in the preamble then none of the foils will have the logo on them.
13051  If you don't want the logo on a particular page place the
13052 \family typewriter
13053
13054 \backslash
13055 LogoOff
13056 \family default
13057  directly after the foilhead of that page and the
13058 \family typewriter
13059
13060 \backslash
13061 LogoOn
13062 \family default
13063  directly after the next foilhead.
13064 \end_layout
13065
13066 \begin_layout Standard
13067 If you decide to use the
13068 \family sans
13069 fancy
13070 \family default
13071  page style setting in the
13072 \family sans
13073 Document
13074 \begin_inset space ~
13075 \end_inset
13076
13077 Layout
13078 \family default
13079  dialog you should probably add
13080 \family typewriter
13081
13082 \backslash
13083 let
13084 \backslash
13085 headwidth
13086 \backslash
13087 textwidth
13088 \family default
13089  to your preamble so headers and footers on landscape pages are correctly placed when rotated.
13090  This is due to some clashes between the page layouts provided by the
13091 \family sans
13092 fancyheadings
13093 \family default
13094  package and the
13095 \family sans
13096 foils
13097 \family default
13098  class.
13099 \end_layout
13100
13101 \begin_layout Subsection
13102
13103 \change_inserted 564990737 1671459032
13104 Powerdot
13105 \end_layout
13106
13107 \begin_layout Standard
13108
13109 \change_inserted 564990737 1671643165
13110 The document class
13111 \family sans
13112 presentation
13113 \begin_inset space \thinspace{}
13114 \end_inset
13115
13116 (powerdot)
13117 \family default
13118  uses the
13119 \family typewriter
13120 powerdot.cls
13121 \family default
13122  document class for creating presentations.
13123
13124 \family sans
13125 File\SpecialChar menuseparator
13126 Open Example\SpecialChar menuseparator
13127 Presentations\SpecialChar menuseparator
13128 Powerdot
13129 \family default
13130  offers guidance on its use.
13131  The documentation is available from
13132 \begin_inset CommandInset href
13133 LatexCommand href
13134 name "CTAN"
13135 target "http://mirrors.ctan.org/macros/latex/contrib/powerdot/doc/powerdot.pdf"
13136 literal "false"
13137
13138 \end_inset
13139
13140 .
13141 \end_layout
13142
13143 \begin_layout Subsection
13144
13145 \change_inserted 564990737 1671459032
13146 \begin_inset CommandInset label
13147 LatexCommand label
13148 name "subsec:Seminar"
13149
13150 \end_inset
13151
13152
13153 \family sans
13154 Seminar
13155 \end_layout
13156
13157 \begin_layout Standard
13158
13159 \change_inserted 564990737 1671643194
13160 The document class
13161 \family sans
13162 presentations
13163 \begin_inset space \thinspace{}
13164 \end_inset
13165
13166 (seminar)
13167 \family default
13168  uses the
13169 \family typewriter
13170 seminar.cls
13171 \family default
13172  document class for creating presentations.
13173
13174 \family sans
13175 File\SpecialChar menuseparator
13176 Open Example\SpecialChar menuseparator
13177 Presentations\SpecialChar menuseparator
13178 Seminar
13179 \family default
13180  offers guidance on its use.
13181  The documentation is available from
13182 \begin_inset CommandInset href
13183 LatexCommand href
13184 name "CTAN"
13185 target "http://mirrors.ctan.org/macros/latex/contrib/seminar/doc/seminar-doc.pdf"
13186 literal "false"
13187
13188 \end_inset
13189
13190 .
13191 \end_layout
13192
13193 \begin_layout Subsection
13194 Slides [aka
13195 \noun on
13196 Sli\SpecialChar TeX
13197
13198 \noun default
13199 ]
13200 \begin_inset CommandInset label
13201 LatexCommand label
13202 name "sec:slitex"
13203
13204 \end_inset
13205
13206
13207 \end_layout
13208
13209 \begin_layout Standard
13210
13211 \change_inserted 564990737 1672743492
13212 Original by
13213 \noun on
13214 John Weiss
13215 \noun default
13216 ;
13217  updated by the \SpecialChar LyX
13218  Team
13219 \end_layout
13220
13221 \begin_layout Subsubsection
13222
13223 \change_inserted 564990737 1672743492
13224 Introduction
13225 \end_layout
13226
13227 \begin_layout Standard
13228
13229 \change_inserted 564990737 1672743492
13230 This section describes how to use \SpecialChar LyX
13231  to make slides for overhead projectors.
13232  There are two document classes that can do this:
13233  the
13234 \family typewriter
13235 presentations
13236 \begin_inset space \thinspace{}
13237 \end_inset
13238
13239 (slides)
13240 \family default
13241  document class and the
13242 \family sans
13243 presentation
13244 \begin_inset space \thinspace{}
13245 \end_inset
13246
13247 (Foil\SpecialChar TeX
13248 )
13249 \family default
13250  document class.
13251  This section documents the former.
13252  If you’re looking for the documentation for
13253 \family sans
13254 presentation
13255 \begin_inset space \thinspace{}
13256 \end_inset
13257
13258 (Foil\SpecialChar TeX
13259 )
13260 \family default
13261 ,
13262  check out section
13263 \begin_inset space ~
13264 \end_inset
13265
13266
13267 \begin_inset CommandInset ref
13268 LatexCommand ref
13269 reference "sec:Foiltex"
13270 nolink "false"
13271
13272 \end_inset
13273
13274 .
13275  As of 2023 the former has continued to be maintained whereas
13276 \family sans
13277 Foil\SpecialChar TeX
13278
13279 \family default
13280  has not been maintained since 2008.
13281
13282 \change_deleted 564990737 1672743492
13283 by
13284 \noun on
13285 John Weiss
13286 \noun default
13287
13288 \end_layout
13289
13290 \begin_layout Standard
13291
13292 \change_deleted 564990737 1672743492
13293 Introduction
13294 \end_layout
13295
13296 \begin_layout Standard
13297
13298 \change_deleted 564990737 1672743492
13299 This section describes how to use \SpecialChar LyX
13300  to make slides for overhead projectors.
13301  There are two document classes that can do this:
13302  the default slides class and the
13303 \family sans
13304 Foil\SpecialChar TeX
13305
13306 \family default
13307  slides class.
13308  This section documents the former.
13309 \end_layout
13310
13311 \begin_layout Standard
13312
13313 \change_deleted 564990737 1672743492
13314 I'm going to say this again,
13315  nice and clear,
13316  so that there's no misunderstanding:
13317 \end_layout
13318
13319 \begin_layout Standard
13320
13321 \change_deleted 564990737 1672743492
13322 \begin_inset VSpace bigskip
13323 \end_inset
13324
13325
13326 \end_layout
13327
13328 \begin_layout Standard
13329 \align center
13330
13331 \change_deleted 564990737 1672743492
13332
13333 \size large
13334 This section documents the class
13335 \begin_inset Quotes eld
13336 \end_inset
13337
13338
13339 \family sans
13340 slides (default)
13341 \family default
13342
13343 \begin_inset Quotes erd
13344 \end_inset
13345
13346
13347 \emph on
13348 only.
13349 \end_layout
13350
13351 \begin_layout Standard
13352
13353 \change_deleted 564990737 1672743492
13354 \begin_inset VSpace bigskip
13355 \end_inset
13356
13357
13358 \end_layout
13359
13360 \begin_layout Standard
13361
13362 \change_deleted 564990737 1672743492
13363 If you're looking for the documentation for
13364 \begin_inset Quotes eld
13365 \end_inset
13366
13367
13368 \family sans
13369 slides (Foil\SpecialChar TeX
13370 )
13371 \family default
13372
13373 \begin_inset Quotes erd
13374 \end_inset
13375
13376 ,
13377  check out section
13378 \begin_inset space ~
13379 \end_inset
13380
13381
13382 \begin_inset CommandInset ref
13383 LatexCommand ref
13384 reference "sec:foiltex"
13385 nolink "false"
13386
13387 \end_inset
13388
13389 .
13390  The
13391 \family sans
13392 foils
13393 \family default
13394  class [
13395 \begin_inset Quotes eld
13396 \end_inset
13397
13398
13399 \family sans
13400 slides (Foil\SpecialChar TeX
13401 )
13402 \family default
13403
13404 \begin_inset Quotes erd
13405 \end_inset
13406
13407 ] is actually somewhat better than the default
13408 \family sans
13409 slides
13410 \family default
13411  class,
13412 \begin_inset Foot
13413 status collapsed
13414
13415 \begin_layout Plain Layout
13416 \SpecialChar ldots
13417 or so I've been told repeatedly by its advocates.
13418  Having never used it,
13419  I have no idea if this claim is true or not.
13420 \end_layout
13421
13422 \end_inset
13423
13424  which this section documents.
13425 \end_layout
13426
13427 \begin_layout Standard
13428
13429 \change_deleted 564990737 1672743492
13430 This class is the \SpecialChar LaTeX2e
13431  improvement of the old
13432 \noun on
13433 Sli\SpecialChar TeX
13434
13435 \noun default
13436  package.
13437  Every \SpecialChar LaTeX2e
13438  distribution includes this class [which I'll just refer to as
13439 \begin_inset Quotes eld
13440 \end_inset
13441
13442
13443 \family sans
13444 slides
13445 \family default
13446
13447 \begin_inset Quotes erd
13448 \end_inset
13449
13450  from now on],
13451  so you're bound to have it.
13452  As I noted earlier,
13453  there are other classes,
13454  such as
13455 \family sans
13456 foils
13457 \family default
13458 ,
13459  which also produce slides for overhead projectors and do a better job at it.
13460  However,
13461  there are some things which
13462 \family sans
13463 slides
13464 \family default
13465  can do which the others can't,
13466  such as generate overlays.
13467  Read on to learn more!
13468 \change_unchanged
13469
13470 \end_layout
13471
13472 \begin_layout Subsubsection
13473 Getting Started
13474 \begin_inset CommandInset label
13475 LatexCommand label
13476 name "sec:slidesetup"
13477
13478 \end_inset
13479
13480
13481 \end_layout
13482
13483 \begin_layout Standard
13484 Obviously,
13485  to use this document class,
13486  you need to select
13487 \begin_inset Quotes eld
13488 \end_inset
13489
13490
13491 \family sans
13492 slides (default)
13493 \family default
13494
13495 \begin_inset Quotes erd
13496 \end_inset
13497
13498  from the class list in the
13499 \family sans
13500 Document\SpecialChar menuseparator
13501 Settings
13502 \family default
13503  dialog.
13504  There are some other special things you should know about this class:
13505 \end_layout
13506
13507 \begin_layout Itemize
13508 Don't bother changing the options
13509 \family sans
13510 Sides and Columns
13511 \family default
13512 .
13513  They're not supported by the
13514 \family sans
13515 slides
13516 \family default
13517  class,
13518  anyways.
13519 \end_layout
13520
13521 \begin_layout Itemize
13522 The option
13523 \family sans
13524 Page
13525 \begin_inset space ~
13526 \end_inset
13527
13528 style
13529 \family default
13530  behaves a bit differently for this class.
13531  The possible choices and what they do are as follows:
13532 \end_layout
13533
13534 \begin_deeper
13535 \begin_layout Description
13536
13537 \family sans
13538 plain
13539 \family default
13540  The final output contains page numbers in the lower right corner.
13541 \end_layout
13542
13543 \begin_layout Description
13544
13545 \family sans
13546 headings
13547 \family default
13548  Like
13549 \family sans
13550 plain
13551 \family default
13552 ,
13553  but also prints out any time markers you've put in.
13554  This is the default.
13555 \end_layout
13556
13557 \begin_layout Description
13558
13559 \family sans
13560 empty
13561 \family default
13562  The final output contains no page numbers,
13563  time markers,
13564  or alignment markers.
13565 \end_layout
13566
13567 \end_deeper
13568 \begin_layout Itemize
13569 The
13570 \family sans
13571 slides
13572 \family default
13573  class has an extra option:
13574
13575 \family typewriter
13576 clock
13577 \family default
13578 .
13579  To use it,
13580  put
13581 \begin_inset Quotes eld
13582 \end_inset
13583
13584
13585 \family typewriter
13586 clock
13587 \family default
13588
13589 \begin_inset Quotes erd
13590 \end_inset
13591
13592  in the extra class options.
13593 \end_layout
13594
13595 \begin_deeper
13596 \begin_layout Standard
13597 Using this options allows you to add time markers to
13598 \family sans
13599 Note
13600 \family default
13601 s.
13602  See section
13603 \begin_inset space ~
13604 \end_inset
13605
13606
13607 \begin_inset CommandInset ref
13608 LatexCommand ref
13609 reference "sec:slideNote"
13610 nolink "false"
13611
13612 \end_inset
13613
13614  for more details.
13615 \end_layout
13616
13617 \end_deeper
13618 \begin_layout Standard
13619 You can also use the template file
13620 \change_deleted 564990737 1671617694
13621
13622 \begin_inset Quotes eld
13623 \end_inset
13624
13625
13626 \family typewriter
13627 slides.lyx
13628 \family default
13629
13630 \begin_inset Quotes erd
13631 \end_inset
13632
13633
13634 \change_unchanged
13635  to automatically set up a document to use the
13636 \family sans
13637 slides
13638 \family default
13639  class
13640 \change_deleted 564990737 1671617699
13641 [
13642 \change_unchanged
13643 using
13644 \family sans
13645 File\SpecialChar menuseparator
13646 New
13647 \begin_inset space ~
13648 \end_inset
13649
13650 from
13651 \begin_inset space ~
13652 \end_inset
13653
13654 Template
13655 \change_inserted 564990737 1671617723
13656 \SpecialChar menuseparator
13657 Presentations\SpecialChar menuseparator
13658 Slides
13659 \change_unchanged
13660
13661 \family default
13662  to open your new document
13663 \change_deleted 564990737 1671617728
13664 ]
13665 \change_unchanged
13666 .
13667  The template file also contains some examples of the special paragraph environments used by this class.
13668  I'll describe those next.
13669 \end_layout
13670
13671 \begin_layout Subsubsection
13672 Paragraph Environments
13673 \end_layout
13674
13675 \begin_layout Paragraph
13676 Supported Environments
13677 \end_layout
13678
13679 \begin_layout Standard
13680 The first thing you'll notice when you start up a new
13681 \family sans
13682 slides
13683 \family default
13684  document is the font size and type:
13685  it's the equivalent of the size
13686 \begin_inset Quotes eld
13687 \end_inset
13688
13689
13690 \family sans
13691 Largest
13692 \family default
13693
13694 \begin_inset Quotes erd
13695 \end_inset
13696
13697  in the
13698 \family sans
13699 Sans
13700 \begin_inset space ~
13701 \end_inset
13702
13703 Serif
13704 \family default
13705  font.
13706  This is also what's used in the output.
13707  Think of this as a
13708 \begin_inset Quotes eld
13709 \end_inset
13710
13711 visual cue
13712 \begin_inset Quotes erd
13713 \end_inset
13714
13715  to remind you that this is a slide.
13716  Your final slides will use a larger font;
13717  ergo,
13718  you'll have less space.
13719  Of course,
13720  the larger default screen font isn't WYSIWYG,
13721  only a reminder.
13722 \end_layout
13723
13724 \begin_layout Standard
13725 The next thing that becomes obvious is the changes to the paragraph environment pull-down box [at the far-left end of the toolbar].
13726  Most of the paragraph environments you're used to seeing are missing.
13727  There are also five new ones.
13728  That's because the
13729 \family sans
13730 slides
13731 \family default
13732  class itself only supports certain paragraph environments:
13733 \end_layout
13734
13735 \begin_layout Itemize
13736
13737 \family sans
13738 Standard
13739 \end_layout
13740
13741 \begin_layout Itemize
13742
13743 \family sans
13744 Itemize
13745 \end_layout
13746
13747 \begin_layout Itemize
13748
13749 \family sans
13750 Enumerate
13751 \end_layout
13752
13753 \begin_layout Itemize
13754
13755 \family sans
13756 Description
13757 \end_layout
13758
13759 \begin_layout Itemize
13760
13761 \family sans
13762 List
13763 \end_layout
13764
13765 \begin_layout Itemize
13766
13767 \family sans
13768 Quotation
13769 \end_layout
13770
13771 \begin_layout Itemize
13772
13773 \family sans
13774 Quote
13775 \end_layout
13776
13777 \begin_layout Itemize
13778
13779 \family sans
13780 Verse
13781 \end_layout
13782
13783 \begin_layout Itemize
13784
13785 \family sans
13786 Caption
13787 \end_layout
13788
13789 \begin_layout Itemize
13790
13791 \family sans
13792 \SpecialChar LyX
13793 -Code
13794 \end_layout
13795
13796 \begin_layout Standard
13797 All of the other standard environments,
13798  including the section-heading environments,
13799  aren't used in the
13800 \family sans
13801 slides
13802 \family default
13803  class.
13804 \end_layout
13805
13806 \begin_layout Standard
13807 On the other hand,
13808  you'll notice the following new environments:
13809 \end_layout
13810
13811 \begin_layout Itemize
13812
13813 \family sans
13814 Slide
13815 \end_layout
13816
13817 \begin_layout Itemize
13818
13819 \family sans
13820 Overlay
13821 \end_layout
13822
13823 \begin_layout Itemize
13824
13825 \family sans
13826 Note
13827 \end_layout
13828
13829 \begin_layout Itemize
13830
13831 \family sans
13832 InvisibleText
13833 \end_layout
13834
13835 \begin_layout Itemize
13836
13837 \family sans
13838 VisibleText
13839 \end_layout
13840
13841 \begin_layout Standard
13842 These five are kind of quirky,
13843  due to a
13844 \begin_inset Quotes eld
13845 \end_inset
13846
13847 feature
13848 \begin_inset Quotes erd
13849 \end_inset
13850
13851  in \SpecialChar LyX
13852 .
13853  You see,
13854  \SpecialChar LyX
13855  doesn't permit you to nest any other paragraph environment into an empty environment.
13856  Now,
13857  that's fine and dandy,
13858  but it means that you wouldn't be able to start a slide with anything except plain text.
13859  To deal with this,
13860  I've performed a little
13861 \begin_inset Quotes eld
13862 \end_inset
13863
13864 \SpecialChar LaTeX
13865  magic.
13866 \begin_inset Quotes erd
13867 \end_inset
13868
13869
13870 \end_layout
13871
13872 \begin_layout Paragraph
13873 Quirks of the New Environments
13874 \begin_inset CommandInset label
13875 LatexCommand label
13876 name "sec:slideQuirk"
13877
13878 \end_inset
13879
13880
13881 \end_layout
13882
13883 \begin_layout Standard
13884 All five of the new paragraph environments are somewhat quirky due to inherent limitiations in the current version of \SpecialChar LyX
13885 .
13886  As I just mentioned,
13887  \SpecialChar LyX
13888  forbids environments that begin with another environment.
13889  To get around this,
13890  the
13891 \family sans
13892 Slide
13893 \family default
13894  environment isn't a paragraph environment as described in the
13895 \emph on
13896 User's Guide
13897 \emph default
13898 .
13899
13900 \end_layout
13901
13902 \begin_layout Standard
13903 You should consider
13904 \family sans
13905 Slide
13906 \family default
13907 ,
13908
13909 \family sans
13910 Overlay
13911 \family default
13912 ,
13913  and
13914 \family sans
13915 Note
13916 \family default
13917  to be
13918 \begin_inset Quotes eld
13919 \end_inset
13920
13921 pseudo-environments.
13922 \begin_inset Quotes erd
13923 \end_inset
13924
13925  They look like a section heading or a
13926 \begin_inset Quotes eld
13927 \end_inset
13928
13929
13930 \family sans
13931 Caption
13932 \family default
13933 ,
13934 \begin_inset Quotes erd
13935 \end_inset
13936
13937  but really begin a [and,
13938  if necessary,
13939  end the previous] paragraph environment.
13940  Likewise,
13941  treat
13942 \family sans
13943 InvisibleText
13944 \family default
13945  and
13946 \family sans
13947 VisibleText
13948 \family default
13949  as
13950 \begin_inset Quotes eld
13951 \end_inset
13952
13953 pseudo-commands.
13954 \begin_inset Quotes erd
13955 \end_inset
13956
13957  These two perform some action.
13958 \end_layout
13959
13960 \begin_layout Standard
13961 A common feature of all five environments,
13962
13963 \family sans
13964 Slide
13965 \family default
13966 ,
13967
13968 \family sans
13969 Overlay
13970 \family default
13971 ,
13972
13973 \family sans
13974 Note
13975 \family default
13976 ,
13977
13978 \family sans
13979 InvisibleText
13980 \family default
13981  and
13982 \family sans
13983 VisibleText
13984 \family default
13985 ,
13986  is a rather long-ish label.
13987  The text following this label —
13988  ordinarily the contents of the paragraph environment —
13989  is utterly irrelevant for
13990 \family sans
13991 Slide
13992 \family default
13993 ,
13994
13995 \family sans
13996 Overlay
13997 \family default
13998 ,
13999
14000 \family sans
14001 Note
14002 \family default
14003 ,
14004
14005 \family sans
14006 InvisibleText
14007 \family default
14008  and
14009 \family sans
14010 VisibleText
14011 \family default
14012 .
14013  \SpecialChar LyX
14014  completely ignores it.
14015  In fact,
14016  you can leave these five environments completely empty.
14017
14018 \end_layout
14019
14020 \begin_layout Standard
14021 While you don't
14022 \emph on
14023 have
14024 \emph default
14025  to put any text after the rather long-ish label,
14026  you might want to.
14027  This could be a short description of the contents of the
14028 \family sans
14029 Slide
14030 \family default
14031 ,
14032  for example.
14033  In that case,
14034  enter your descriptive comment and hit
14035 \family sans
14036 Return
14037 \family default
14038  as you normally would.
14039 \end_layout
14040
14041 \begin_layout Standard
14042 If,
14043  on the other hand,
14044  you don't want to enter any descriptive text,
14045  you'll hit another \SpecialChar LyX
14046  quirk.
14047  \SpecialChar LyX
14048 ,
14049  like nature,
14050  abhors a vacuum,
14051  and will not let you start a new paragraph environment until you put something in the old one.
14052  So,
14053  do this:
14054 \end_layout
14055
14056 \begin_layout Itemize
14057 Start entering the text that will
14058 \emph on
14059 follow
14060 \emph default
14061  the new
14062 \family sans
14063 Slide
14064 \family default
14065 ,
14066
14067 \family sans
14068 Overlay
14069 \family default
14070 ,
14071
14072 \family sans
14073 Note
14074 \family default
14075 ,
14076
14077 \family sans
14078 InvisibleText
14079 \family default
14080  or
14081 \family sans
14082 VisibleText
14083 \family default
14084 .
14085
14086 \end_layout
14087
14088 \begin_layout Itemize
14089 Now move to the beginning of that paragraph.
14090
14091 \end_layout
14092
14093 \begin_layout Itemize
14094 Next,
14095  hit
14096 \family sans
14097 Return
14098 \family default
14099 .
14100
14101 \end_layout
14102
14103 \begin_layout Itemize
14104 Finally,
14105  change this new,
14106  empty paragraph to a
14107 \family sans
14108 Slide
14109 \family default
14110 ,
14111
14112 \family sans
14113 Overlay
14114 \family default
14115 ,
14116
14117 \family sans
14118 Note
14119 \family default
14120 ,
14121
14122 \family sans
14123 InvisibleText
14124 \family default
14125  or
14126 \family sans
14127 VisibleText
14128 \family default
14129 .
14130
14131 \end_layout
14132
14133 \begin_layout Standard
14134 Some future version of \SpecialChar LyX
14135  will,
14136  hopefully,
14137  resolve this quirkiness\SpecialChar ldots
14138
14139 \end_layout
14140
14141 \begin_layout Subsubsection
14142 Making a Presentation with
14143 \family sans
14144 Slide
14145 \family default
14146 ,
14147
14148 \family sans
14149 Overlay
14150 \family default
14151  and
14152 \family sans
14153 Note
14154 \end_layout
14155
14156 \begin_layout Paragraph
14157 Using the
14158 \family sans
14159 Slide
14160 \family default
14161  Environment
14162 \end_layout
14163
14164 \begin_layout Standard
14165 If you're expecting this section to teach you how to actually make a presentation,
14166  you'll be sorely disappointed.
14167  Naturally,
14168  I'll describe all of the ways the
14169 \family sans
14170 slides
14171 \family default
14172  class can assist you in preparing the materials for a presentation.
14173  Filling in the contents,
14174  however,
14175  is up to you.
14176  [Then again,
14177  that
14178 \emph on
14179 is
14180 \emph default
14181  the \SpecialChar LyX
14182  philosophy.]
14183 \end_layout
14184
14185 \begin_layout Standard
14186 Choosing the
14187 \family sans
14188 Slide
14189 \family default
14190  environment [in the manner described in section
14191 \begin_inset space ~
14192 \end_inset
14193
14194
14195 \begin_inset CommandInset ref
14196 LatexCommand ref
14197 reference "sec:slideQuirk"
14198 nolink "false"
14199
14200 \end_inset
14201
14202 ] tells \SpecialChar LyX
14203  to begin a new slide [duh].
14204  The label for this environment/
14205 \begin_inset Quotes erd
14206 \end_inset
14207
14208 pseudo-command
14209 \begin_inset Quotes erd
14210 \end_inset
14211
14212  is an
14213 \begin_inset Quotes eld
14214 \end_inset
14215
14216 ASCII line,
14217 \begin_inset Quotes erd
14218 \end_inset
14219
14220  in cool blue,
14221  followed by the label,
14222
14223 \begin_inset Quotes eld
14224 \end_inset
14225
14226 NewSlide:
14227 \begin_inset Quotes erd
14228 \end_inset
14229
14230 .
14231  Any text or paragraph environments that follow this one go on the new slide.
14232  It's that simple.
14233 \end_layout
14234
14235 \begin_layout Standard
14236 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
14237  (this can be specified in the
14238 \family sans
14239 Paragraph Layout
14240 \family default
14241  dialog).
14242  In fact,
14243  you'll want to,
14244  once you finish entering the contents of one slide.
14245  If you've entered more text than can physically fit on a slide,
14246  the extra overflows onto a new slide.
14247  I don't recommend doing this,
14248  however,
14249  since the overflow slide won't have any page number on it.
14250  Furthermore,
14251  it may interfere with any
14252 \family sans
14253 Overlay
14254 \family default
14255  you've made to accompany the oversized
14256 \family sans
14257 Slide
14258 \family default
14259 .
14260 \end_layout
14261
14262 \begin_layout Standard
14263 The
14264 \family sans
14265 Overlay
14266 \family default
14267  and
14268 \family sans
14269 Note
14270 \family default
14271  environments work the same way as the
14272 \family sans
14273 Slide
14274 \family default
14275  environment.
14276  They both create an
14277 \begin_inset Quotes eld
14278 \end_inset
14279
14280 ASCII line
14281 \begin_inset Quotes erd
14282 \end_inset
14283
14284  followed by a label [
14285 \begin_inset Quotes eld
14286 \end_inset
14287
14288 NewOverlay:
14289 \begin_inset Quotes erd
14290 \end_inset
14291
14292  and
14293 \begin_inset Quotes eld
14294 \end_inset
14295
14296 NewNote:
14297 \begin_inset Quotes erd
14298 \end_inset
14299
14300 ,
14301  respectively].
14302  The color is a stunning magenta instead of blue,
14303  and the
14304 \begin_inset Quotes eld
14305 \end_inset
14306
14307 ASCII line
14308 \begin_inset Quotes erd
14309 \end_inset
14310
14311  will look different,
14312  in style and in length.
14313  The label fonts of all three also differ from one another.
14314 \end_layout
14315
14316 \begin_layout Standard
14317 As with a
14318 \family sans
14319 Slide
14320 \family default
14321 ,
14322  if the contents of a
14323 \family sans
14324 Note
14325 \family default
14326  or
14327 \family sans
14328 Overlay
14329 \family default
14330  exceed the physical size of a slide or sheet of paper,
14331  the extra will overflow onto a new sheet.
14332  Again,
14333  you should avoid this.
14334  It defeats the whole purpose of
14335 \family sans
14336 Note
14337 \family default
14338 s and
14339 \family sans
14340 Overlay
14341 \family default
14342 s.
14343 \end_layout
14344
14345 \begin_layout Paragraph
14346 Using
14347 \family sans
14348 Overlay
14349 \family default
14350  with
14351 \family sans
14352 Slide
14353 \end_layout
14354
14355 \begin_layout Standard
14356 The idea behind an
14357 \family sans
14358 Overlay
14359 \family default
14360  is a slide that sits atop another slide.
14361  Perhaps you wish to discuss a figure on the main
14362 \family sans
14363 Slide
14364 \family default
14365  before displaying the text associated with it.
14366  One way to accomplish this is tape a flap of dark paper over the part of the
14367 \family sans
14368 Slide
14369 \family default
14370  you want to display later.
14371  This method fails,
14372  however,
14373  if you wish to overlap one graph with another,
14374  for example.
14375  You would then have to fumble while speaking to align the two separate,
14376  overlapping
14377 \family sans
14378 Slide
14379 \family default
14380 s to align the two graphs.
14381  The use of an
14382 \family sans
14383 Overlay
14384 \family default
14385  environment in both cases makes life much easier.
14386 \end_layout
14387
14388 \begin_layout Standard
14389 Each
14390 \family sans
14391 Overlay
14392 \family default
14393  receives the page number of its
14394 \begin_inset Quotes eld
14395 \end_inset
14396
14397 parent
14398 \begin_inset Quotes erd
14399 \end_inset
14400
14401
14402 \family sans
14403 Slide
14404 \family default
14405 ,
14406  appended by
14407 \begin_inset Quotes eld
14408 \end_inset
14409
14410
14411 \family typewriter
14412 -a
14413 \family default
14414
14415 \begin_inset Quotes erd
14416 \end_inset
14417
14418 .
14419 \begin_inset Foot
14420 status collapsed
14421
14422 \begin_layout Plain Layout
14423 Presumably,
14424  mutliple
14425 \family sans
14426 Overlay
14427 \family default
14428 s would have
14429 \begin_inset Quotes eld
14430 \end_inset
14431
14432
14433 \family typewriter
14434 -a
14435 \family default
14436
14437 \begin_inset Quotes erd
14438 \end_inset
14439
14440 ,
14441
14442 \begin_inset Quotes eld
14443 \end_inset
14444
14445
14446 \family typewriter
14447 -b
14448 \family default
14449
14450 \begin_inset Quotes erd
14451 \end_inset
14452
14453 ,
14454
14455 \begin_inset Quotes eld
14456 \end_inset
14457
14458
14459 \family typewriter
14460 -c
14461 \family default
14462
14463 \begin_inset Quotes erd
14464 \end_inset
14465
14466 ,
14467  etc.
14468 \begin_inset space ~
14469 \end_inset
14470
14471 appended to the page number of the parent
14472 \family sans
14473 Slide
14474 \family default
14475 .
14476
14477 \end_layout
14478
14479 \end_inset
14480
14481  Clearly,
14482  you want the contents of both the
14483 \family sans
14484 Slide
14485 \family default
14486  and the
14487 \family sans
14488 Overlay
14489 \family default
14490  to each fit on a single physical slide!
14491  You should probably consider an
14492 \family sans
14493 Overlay
14494 \family default
14495  as
14496 \begin_inset Quotes eld
14497 \end_inset
14498
14499 part of
14500 \begin_inset Quotes erd
14501 \end_inset
14502
14503  a
14504 \family sans
14505 Slide
14506 \family default
14507 .
14508  Indeed,
14509  the \SpecialChar LyX
14510
14511 \family sans
14512 slides
14513 \family default
14514  class provides a visual cue for this:
14515  the label at the start of an
14516 \family sans
14517 Overlay
14518 \family default
14519  is shorter than that at the start of a
14520 \family sans
14521 Slide
14522 \family default
14523 .
14524  Lastly,
14525  when you generate printable output,
14526  you'll find alignment markers in all four corners of both the
14527 \family sans
14528 Overlay
14529 \family default
14530  page and its parent
14531 \family sans
14532 Slide
14533 \family default
14534 .
14535  These will assist you in lining up the two physical slides.
14536 \end_layout
14537
14538 \begin_layout Standard
14539 The major problem in overlaying two slides is aligning the contents of the two transparencies.
14540  How much space should you leave for that graph on the second slide?
14541  Worse still,
14542  what if you want a graph and a sentence on second slide,
14543  but there is text on the main transparency that goes in between them?
14544  You could try and insert vertical space of the right size.
14545  The better way is to use
14546 \family sans
14547 InvisibleText
14548 \family default
14549  and
14550 \family sans
14551 VisibleText
14552 \family default
14553 .
14554 \end_layout
14555
14556 \begin_layout Standard
14557 As their names imply,
14558
14559 \family sans
14560 InvisibleText
14561 \family default
14562  and
14563 \family sans
14564 VisibleText
14565 \family default
14566  are two command-like paragraph environments that make all subsequent text invisible and visible,
14567  respectively.
14568  Note from section
14569 \begin_inset space ~
14570 \end_inset
14571
14572
14573 \begin_inset CommandInset ref
14574 LatexCommand ref
14575 reference "sec:slideQuirk"
14576 nolink "false"
14577
14578 \end_inset
14579
14580  that you don't place anything
14581 \emph on
14582 into
14583 \emph default
14584  these two environments,
14585  however.
14586  When you create an
14587 \family sans
14588 InvisibleText
14589 \family default
14590 ,
14591  it inserts a centered,
14592  sky-blue label into the page reading
14593 \begin_inset Quotes eld
14594 \end_inset
14595
14596 <Invisible Text Follows>
14597 \begin_inset Quotes erd
14598 \end_inset
14599
14600 .
14601  For paragraphs following this label,
14602  the parts of the
14603 \family sans
14604 Slide
14605 \family default
14606  [or
14607 \family sans
14608 Overlay
14609 \family default
14610 ;
14611  it doesn't matter which] where they would be contain instead blank space.
14612
14613 \end_layout
14614
14615 \begin_layout Standard
14616 For
14617 \family sans
14618 VisibleText
14619 \family default
14620 ,
14621  the corresponding centered label is
14622 \begin_inset Quotes eld
14623 \end_inset
14624
14625 <Visible Text Follows>
14626 \begin_inset Quotes erd
14627 \end_inset
14628
14629  in blazing green.
14630  Paragraphs following this label behave normally.
14631  Note that the beginning of a new
14632 \family sans
14633 Slide
14634 \family default
14635 ,
14636
14637 \family sans
14638 Overlay
14639 \family default
14640 ,
14641  or
14642 \family sans
14643 Note
14644 \family default
14645  automatically shuts off an
14646 \family sans
14647 InvisibleText
14648 \family default
14649 .
14650  It's therefore not necessary to use
14651 \family sans
14652 VisibleText
14653 \family default
14654  at the end of a
14655 \family sans
14656 Slide
14657 \family default
14658 .
14659 \end_layout
14660
14661 \begin_layout Standard
14662 By now,
14663  it should be obvious how to create overlay transparencies using the proper combination of
14664 \family sans
14665 InvisibleText
14666 \family default
14667  and
14668 \family sans
14669 VisibleText
14670 \family default
14671  on a
14672 \family sans
14673 Slide
14674 \family default
14675  and
14676 \family sans
14677 Overlay
14678 \family default
14679 :
14680 \end_layout
14681
14682 \begin_layout Enumerate
14683 Create a
14684 \family sans
14685 Slide
14686 \family default
14687 ,
14688  including everything that will appear on it,
14689  whether on the main slide or on the
14690 \family sans
14691 Overlay
14692 \family default
14693 .
14694 \end_layout
14695
14696 \begin_layout Enumerate
14697 Before each figure or paragraph that will appear only on the
14698 \family sans
14699 Overlay
14700 \family default
14701 ,
14702  insert an
14703 \family sans
14704 InvisibleText
14705 \family default
14706  environment.
14707  If necessary,
14708  insert a
14709 \family sans
14710 VisibleText
14711 \family default
14712  environment after the
14713 \family sans
14714 Overlay
14715 \family default
14716 -only text.
14717 \end_layout
14718
14719 \begin_layout Enumerate
14720 Start an
14721 \family sans
14722 Overlay
14723 \family default
14724  immediately following the
14725 \family sans
14726 Slide
14727 \family default
14728 .
14729 \end_layout
14730
14731 \begin_layout Enumerate
14732 Copy the contents of this
14733 \family sans
14734 Slide
14735 \family default
14736  into the
14737 \family sans
14738 Overlay
14739 \family default
14740 .
14741 \end_layout
14742
14743 \begin_layout Enumerate
14744 Within the
14745 \family sans
14746 Overlay
14747 \family default
14748 ,
14749  change all of the
14750 \family sans
14751 InvisibleText
14752 \family default
14753  lines to
14754 \family sans
14755 VisibleText
14756 \family default
14757  and vice-versa.
14758 \end_layout
14759
14760 \begin_layout Standard
14761 That's it.
14762  You've just made an
14763 \family sans
14764 Overlay
14765 \family default
14766 .
14767 \end_layout
14768
14769 \begin_layout Standard
14770 There's one problem with the way I've designed the \SpecialChar LyX
14771
14772 \family sans
14773 slides
14774 \family default
14775  class:
14776  you can't make text in the middle of a paragraph invisible,
14777  nor make text in the middle of an invisible paragraph visible again.
14778  To accomplish this feat,
14779  you'll need to use some inlined \SpecialChar LaTeX
14780  codes.
14781 \begin_inset Foot
14782 status collapsed
14783
14784 \begin_layout Plain Layout
14785 The commands of interest are:
14786
14787 \end_layout
14788
14789 \begin_layout Itemize
14790
14791 \family typewriter
14792 {
14793 \backslash
14794 invisible \SpecialChar ldots
14795  }
14796 \end_layout
14797
14798 \begin_layout Itemize
14799
14800 \family typewriter
14801 {
14802 \backslash
14803 visible \SpecialChar ldots
14804  }
14805 \end_layout
14806
14807 \begin_layout Plain Layout
14808 \SpecialChar ldots
14809 and need to be marked as \SpecialChar TeX
14810 .
14811  The text whose
14812 \begin_inset Quotes eld
14813 \end_inset
14814
14815 visibility
14816 \begin_inset Quotes erd
14817 \end_inset
14818
14819  you wish to change goes in between the brackets [and after the
14820 \family typewriter
14821
14822 \backslash
14823 invisible
14824 \family default
14825  or
14826 \family typewriter
14827
14828 \backslash
14829 visible
14830 \family default
14831  command].
14832  If you don't know how to mark text as \SpecialChar TeX
14833 ,
14834  see the appropriate section of the
14835 \emph on
14836 User's Guide
14837 \emph default
14838 .
14839 \end_layout
14840
14841 \end_inset
14842
14843
14844 \end_layout
14845
14846 \begin_layout Paragraph
14847 Using
14848 \family sans
14849 Note
14850 \family default
14851  with
14852 \family sans
14853 Slide
14854 \family default
14855
14856 \begin_inset CommandInset label
14857 LatexCommand label
14858 name "sec:slideNote"
14859
14860 \end_inset
14861
14862
14863 \end_layout
14864
14865 \begin_layout Standard
14866 Like an
14867 \family sans
14868 Overlay
14869 \family default
14870 ,
14871  a
14872 \family sans
14873 Note
14874 \family default
14875  is associated with a
14876 \begin_inset Quotes eld
14877 \end_inset
14878
14879 parent
14880 \begin_inset Quotes erd
14881 \end_inset
14882
14883
14884 \family sans
14885 Slide
14886 \family default
14887 .
14888  Here,
14889  too,
14890  the \SpecialChar LyX
14891
14892 \family sans
14893 slides
14894 \family default
14895  class provides visual cues.
14896  The label for a
14897 \family sans
14898 Note
14899 \family default
14900  is shorter than that of a
14901 \family sans
14902 Slide
14903 \family default
14904  [yet longer than that of an
14905 \family sans
14906 Overlay
14907 \family default
14908 ] and,
14909  like the label of an
14910 \family sans
14911 Overlay
14912 \family default
14913  is shockingly magenta.
14914  Additionally,
14915  the printed
14916 \family sans
14917 Note
14918 \family default
14919  has the page number of its
14920 \begin_inset Quotes eld
14921 \end_inset
14922
14923 parent
14924 \begin_inset Quotes erd
14925 \end_inset
14926
14927
14928 \family sans
14929 Slide
14930 \family default
14931 ,
14932  appended by
14933 \begin_inset Quotes eld
14934 \end_inset
14935
14936
14937 \family typewriter
14938 -
14939 \family default
14940 1
14941 \begin_inset Quotes erd
14942 \end_inset
14943
14944 ,
14945
14946 \begin_inset Quotes eld
14947 \end_inset
14948
14949
14950 \family typewriter
14951 -
14952 \family default
14953 2
14954 \begin_inset Quotes erd
14955 \end_inset
14956
14957 ,
14958
14959 \begin_inset Quotes eld
14960 \end_inset
14961
14962
14963 \family typewriter
14964 -
14965 \family default
14966 3
14967 \begin_inset Quotes erd
14968 \end_inset
14969
14970 ,
14971  etc.
14972  You can have multiple
14973 \family sans
14974 Note
14975 \family default
14976 s associated with a single
14977 \family sans
14978 Slide
14979 \family default
14980 ,
14981  and,
14982  as with
14983 \family sans
14984 Slide
14985 \family default
14986  and
14987 \family sans
14988 Overlay
14989 \family default
14990 ,
14991  you'll probably want to break up long
14992 \family sans
14993 Note
14994 \family default
14995 s so that they fit on a single sheet of paper.
14996 \end_layout
14997
14998 \begin_layout Standard
14999 The purpose of a
15000 \family sans
15001 Note
15002 \family default
15003  is obvious:
15004  it contains anything additional you might want to say about a
15005 \family sans
15006 Slide
15007 \family default
15008 .
15009  It could also be used as a sheet of reminders for a particular
15010 \family sans
15011 Slide
15012 \family default
15013 .
15014  In the case of the latter,
15015  you might want to make use of time markers.
15016  Currently,
15017  the \SpecialChar LyX
15018
15019 \family sans
15020 slides
15021 \family default
15022  class has no
15023 \begin_inset Quotes eld
15024 \end_inset
15025
15026 native
15027 \begin_inset Quotes erd
15028 \end_inset
15029
15030  support for time markers,
15031  a
15032 \noun on
15033 Sli\SpecialChar TeX
15034
15035 \noun default
15036  feature.
15037  So,
15038  you'll have to resort to using the \SpecialChar LaTeX
15039  codes.
15040 \end_layout
15041
15042 \begin_layout Standard
15043 To use time markers,
15044  you'll need to specify the extra class option
15045 \begin_inset Quotes eld
15046 \end_inset
15047
15048
15049 \family typewriter
15050 clock
15051 \family default
15052
15053 \begin_inset Quotes erd
15054 \end_inset
15055
15056  [see section
15057 \begin_inset space ~
15058 \end_inset
15059
15060
15061 \begin_inset CommandInset ref
15062 LatexCommand ref
15063 reference "sec:slidesetup"
15064 nolink "false"
15065
15066 \end_inset
15067
15068 ].
15069  This option turns on timing marks,
15070  which will appear in the lower-left-hand corner of every
15071 \family sans
15072 Note
15073 \family default
15074  you generate.
15075  To set what appears in the time marker,
15076  you use the \SpecialChar LaTeX
15077  commands
15078 \begin_inset Quotes eld
15079 \end_inset
15080
15081
15082 \family typewriter
15083
15084 \backslash
15085 settime{}
15086 \family default
15087
15088 \begin_inset Quotes erd
15089 \end_inset
15090
15091  and
15092 \begin_inset Quotes eld
15093 \end_inset
15094
15095
15096 \family typewriter
15097
15098 \backslash
15099 addtime{}
15100 \family default
15101
15102 \begin_inset Quotes erd
15103 \end_inset
15104
15105 .
15106  The arguments of both commands are time measured in seconds.
15107
15108 \begin_inset Quotes eld
15109 \end_inset
15110
15111
15112 \family typewriter
15113
15114 \backslash
15115 settime{}
15116 \family default
15117
15118 \begin_inset Quotes erd
15119 \end_inset
15120
15121  sets the time marker to a given time.
15122
15123 \begin_inset Quotes eld
15124 \end_inset
15125
15126
15127 \family typewriter
15128
15129 \backslash
15130 addtime{}
15131 \family default
15132
15133 \begin_inset Quotes erd
15134 \end_inset
15135
15136  increments the time marker by the specified amount.
15137  Using time markers and
15138 \family sans
15139 Note
15140 \family default
15141 s in this fashion,
15142  you can remind yourself how much time to spend on a particular
15143 \family sans
15144 Slide
15145 \family default
15146 .
15147 \end_layout
15148
15149 \begin_layout Standard
15150 There's one last feature to describe.
15151  Clearly,
15152  you'd like to print out all of your
15153 \family sans
15154 Slide
15155 \family default
15156 s and
15157 \family sans
15158 Overlay
15159 \family default
15160 s on transparencies while printing all of your
15161 \family sans
15162 Note
15163 \family default
15164 s on plain paper.
15165  However,
15166  a
15167 \family sans
15168 Note
15169 \family default
15170
15171 \emph on
15172 must
15173 \emph default
15174  follow the
15175 \family sans
15176 Slide
15177 \family default
15178  with which it is associated.
15179  What's a person to do?
15180 \end_layout
15181
15182 \begin_layout Standard
15183 Luckily,
15184  there are two \SpecialChar LaTeX
15185  commands that allow you to select what to print out.
15186  Both must be placed into the preamble of your document.
15187  The command
15188 \begin_inset Quotes eld
15189 \end_inset
15190
15191
15192 \family typewriter
15193
15194 \backslash
15195 onlyslides{
15196 \backslash
15197 slides}
15198 \family default
15199
15200 \begin_inset Quotes erd
15201 \end_inset
15202
15203  will cause the output to contain only the
15204 \family sans
15205 Slide
15206 \family default
15207 s and
15208 \family sans
15209 Overlay
15210 \family default
15211 s.
15212  Correspondingly,
15213  the command
15214 \begin_inset Quotes eld
15215 \end_inset
15216
15217
15218 \family typewriter
15219
15220 \backslash
15221 onlynotes{
15222 \backslash
15223 notes}
15224 \family default
15225
15226 \begin_inset Quotes erd
15227 \end_inset
15228
15229  prevents the output of anything but
15230 \family sans
15231 Note
15232 \family default
15233 s.
15234  I'd advise placing both commands in the preamble and initially comment both out.
15235  You can then preview your entire presentation as you write.
15236  When you're done writing,
15237  you can then uncomment one of the two to select what you want to print.
15238  I like to uncomment
15239 \begin_inset Quotes eld
15240 \end_inset
15241
15242
15243 \family typewriter
15244
15245 \backslash
15246 onlyslides{
15247 \backslash
15248 slides}
15249 \family default
15250
15251 \begin_inset Quotes erd
15252 \end_inset
15253
15254  ,
15255  print to a file with
15256 \begin_inset Quotes eld
15257 \end_inset
15258
15259
15260 \family typewriter
15261 -slides
15262 \family default
15263
15264 \begin_inset Quotes erd
15265 \end_inset
15266
15267  in its name,
15268  comment it back out,
15269  then uncomment
15270 \begin_inset Quotes eld
15271 \end_inset
15272
15273
15274 \family typewriter
15275
15276 \backslash
15277 onlynotes{
15278 \backslash
15279 notes}
15280 \family default
15281
15282 \begin_inset Quotes erd
15283 \end_inset
15284
15285  and print to a
15286 \begin_inset Quotes eld
15287 \end_inset
15288
15289
15290 \family typewriter
15291 *-notes.ps
15292 \family default
15293
15294 \begin_inset Quotes erd
15295 \end_inset
15296
15297  file.
15298  I can then send either file to a printer,
15299  loading transparencies or plain paper as appropriate.
15300 \end_layout
15301
15302 \begin_layout Standard
15303 You can also provide other arguments to the
15304 \begin_inset Quotes eld
15305 \end_inset
15306
15307
15308 \family typewriter
15309
15310 \backslash
15311 onlyslides{}
15312 \family default
15313
15314 \begin_inset Quotes erd
15315 \end_inset
15316
15317  and
15318 \begin_inset Quotes eld
15319 \end_inset
15320
15321
15322 \family typewriter
15323
15324 \backslash
15325 onlynotes{}
15326 \family default
15327
15328 \begin_inset Quotes erd
15329 \end_inset
15330
15331  commands.
15332  See a good \SpecialChar LaTeX
15333  book for details.
15334 \end_layout
15335
15336 \begin_layout Subsubsection
15337 The
15338 \family sans
15339 slides
15340 \family default
15341  Class Template File
15342 \end_layout
15343
15344 \begin_layout Standard
15345 I have also provided a template file
15346 \change_deleted 564990737 1671617750
15347 ,
15348
15349 \begin_inset Quotes eld
15350 \end_inset
15351
15352
15353 \family typewriter
15354 slides.lyx
15355 \family default
15356
15357 \begin_inset Quotes erd
15358 \end_inset
15359
15360 ,
15361
15362 \change_unchanged
15363  with the
15364 \family sans
15365 slides
15366 \family default
15367  class.
15368  To use it,
15369  begin your new presentation with
15370 \family sans
15371 File\SpecialChar menuseparator
15372 New
15373 \begin_inset space ~
15374 \end_inset
15375
15376 from
15377 \begin_inset space ~
15378 \end_inset
15379
15380 Template
15381 \change_inserted 564990737 1671616988
15382 \SpecialChar menuseparator
15383 Presentations\SpecialChar menuseparator
15384 Slides
15385 \change_unchanged
15386
15387 \family default
15388 .
15389  Your new \SpecialChar LyX
15390  presentation file will contain an example
15391 \family sans
15392 Slide
15393 \family default
15394  –
15395 \family sans
15396 Overlay
15397 \family default
15398  –
15399 \family sans
15400 Note
15401 \family default
15402  triplet.
15403  The
15404 \family sans
15405 Slide
15406 \family default
15407  and
15408 \family sans
15409 Overlay
15410 \family default
15411  additionally contain an example of the use of
15412 \family sans
15413 InvisibleText
15414 \family default
15415  and
15416 \family sans
15417 VisibleText
15418 \family default
15419 .
15420  Lastly,
15421  the preamble will contain:
15422 \end_layout
15423
15424 \begin_layout LyX-Code
15425 % Uncomment to print out only slides and overlays
15426 \end_layout
15427
15428 \begin_layout LyX-Code
15429 %
15430 \end_layout
15431
15432 \begin_layout LyX-Code
15433 %
15434 \backslash
15435 onlyslides{
15436 \backslash
15437 slides}
15438 \begin_inset Newline newline
15439 \end_inset
15440
15441
15442 \end_layout
15443
15444 \begin_layout LyX-Code
15445 % Uncomment to print out only notes
15446 \end_layout
15447
15448 \begin_layout LyX-Code
15449 %
15450 \end_layout
15451
15452 \begin_layout LyX-Code
15453 %
15454 \backslash
15455 onlynotes{
15456 \backslash
15457 notes}
15458 \end_layout
15459
15460 \begin_layout Standard
15461 One final thing:
15462  I created this class to support the \SpecialChar LaTeX2e
15463
15464 \begin_inset Quotes eld
15465 \end_inset
15466
15467
15468 \noun on
15469 Sli\SpecialChar TeX
15470
15471 \noun default
15472  emulation
15473 \begin_inset Quotes erd
15474 \end_inset
15475
15476  class,
15477  one of the built-in \SpecialChar LaTeX2e
15478  classes.
15479  Neither I nor the rest of the \SpecialChar LyX
15480  Team endorse or oppose the use of this built-in slide class.
15481  It's here if you want it or need it.
15482  There exist other \SpecialChar LaTeX2e
15483  classes for creating presentations,
15484  such as the
15485 \family sans
15486 Foils
15487 \family default
15488  class [see section
15489 \begin_inset space ~
15490 \end_inset
15491
15492
15493 \begin_inset CommandInset ref
15494 LatexCommand ref
15495 reference "sec:foiltex"
15496 nolink "false"
15497
15498 \end_inset
15499
15500 ] or the
15501 \begin_inset Quotes eld
15502 \end_inset
15503
15504
15505 \family typewriter
15506 seminar
15507 \family default
15508
15509 \begin_inset Quotes erd
15510 \end_inset
15511
15512  package [present on some \SpecialChar TeX
15513  distributions].
15514  The latter is not yet supported under \SpecialChar LyX
15515 .
15516 \begin_inset Foot
15517 status collapsed
15518
15519 \begin_layout Plain Layout
15520 Perhaps you can take on the task\SpecialChar ldots
15521
15522 \end_layout
15523
15524 \end_inset
15525
15526  I know nothing about these other classes.
15527  Try them out to see what sort of alternative they provide.
15528 \end_layout
15529
15530 \begin_layout Section
15531
15532 \change_inserted 564990737 1670439661
15533 Reports
15534 \end_layout
15535
15536 \begin_layout Subsection
15537
15538 \change_inserted 564990737 1670439661
15539 report
15540 \end_layout
15541
15542 \begin_layout Standard
15543
15544 \change_inserted 564990737 1670439661
15545 The document class
15546 \family sans
15547 report
15548 \family default
15549  provides the
15550 \family sans
15551 report.cls
15552 \family default
15553  document class for preparing reports.
15554  Like the
15555 \family sans
15556 book
15557 \family default
15558  document class,
15559  this provides parts,
15560  chapters and sections but does not provide the paragraph styles needed for a book;
15561  like the
15562 \family sans
15563 article
15564 \family default
15565  document class,
15566  it provides the abstract paragraph style.
15567  In two-sided mode,
15568  it does not start a new chapter on the right hand page.
15569 \end_layout
15570
15571 \begin_layout Standard
15572
15573 \change_inserted 564990737 1672743528
15574 The remaining
15575 \family sans
15576 report
15577 \family default
15578  document classes are described in the Collections (section
15579 \begin_inset space ~
15580 \end_inset
15581
15582
15583 \begin_inset CommandInset ref
15584 LatexCommand ref
15585 reference "sec:Collections"
15586 nolink "false"
15587
15588 \end_inset
15589
15590 ).
15591 \end_layout
15592
15593 \begin_layout Standard
15594
15595 \change_inserted 564990737 1672743530
15596 For
15597 \family sans
15598 report
15599 \begin_inset space \thinspace{}
15600 \end_inset
15601
15602 (Japanese in vertical writing)
15603 \family default
15604  and
15605 \family sans
15606 report
15607 \begin_inset space \thinspace{}
15608 \end_inset
15609
15610 (Japanese)
15611 \family default
15612 ,
15613  see section
15614 \begin_inset space ~
15615 \end_inset
15616
15617
15618 \begin_inset CommandInset ref
15619 LatexCommand ref
15620 reference "subsec:Japanese"
15621 nolink "false"
15622
15623 \end_inset
15624
15625 .
15626 \end_layout
15627
15628 \begin_layout Standard
15629
15630 \change_inserted 564990737 1672743530
15631 For
15632 \family sans
15633 report
15634 \begin_inset space \thinspace{}
15635 \end_inset
15636
15637 (KOMA-Script)
15638 \family default
15639 ,
15640  see section
15641 \begin_inset space ~
15642 \end_inset
15643
15644
15645 \begin_inset CommandInset ref
15646 LatexCommand ref
15647 reference "subsec:KOMA-Script"
15648 nolink "false"
15649
15650 \end_inset
15651
15652 .
15653 \end_layout
15654
15655 \begin_layout Standard
15656
15657 \change_inserted 564990737 1672743530
15658 For
15659 \family sans
15660 report
15661 \begin_inset space \thinspace{}
15662 \end_inset
15663
15664 (with extra font sizes)
15665 \family default
15666 ,
15667  see section
15668 \begin_inset space ~
15669 \end_inset
15670
15671
15672 \begin_inset CommandInset ref
15673 LatexCommand ref
15674 reference "subsec:Extra-font-sizes"
15675 nolink "false"
15676
15677 \end_inset
15678
15679 .
15680 \end_layout
15681
15682 \begin_layout Standard
15683
15684 \change_inserted 564990737 1672743569
15685 For
15686 \family sans
15687 report
15688 \begin_inset space \thinspace{}
15689 \end_inset
15690
15691 (Polish version by M.
15692 \begin_inset space \thinspace{}
15693 \end_inset
15694
15695 W.)
15696 \family default
15697 ,
15698  see section
15699 \begin_inset space ~
15700 \end_inset
15701
15702
15703 \begin_inset CommandInset ref
15704 LatexCommand ref
15705 reference "subsec:Polish-M.W.collection"
15706 plural "false"
15707 caps "false"
15708 noprefix "false"
15709 nolink "false"
15710
15711 \end_inset
15712
15713 .
15714 \end_layout
15715
15716 \begin_layout Section
15717
15718 \change_inserted 564990737 1670439674
15719 Scripts (drama)
15720 \end_layout
15721
15722 \begin_layout Subsection
15723 Broadway
15724 \end_layout
15725
15726 \begin_layout Standard
15727 by
15728 \shape smallcaps
15729 Garst Reese
15730 \end_layout
15731
15732 \begin_layout Subsubsection
15733 Introduction
15734 \end_layout
15735
15736 \begin_layout Standard
15737 Broadway is for writing plays.
15738  The format is more decorative than Hollywood,
15739  and much less standardized.
15740  This format should be suitable for workshops.
15741 \end_layout
15742
15743 \begin_layout Subsubsection
15744 Special problems
15745 \end_layout
15746
15747 \begin_layout Standard
15748 The same as in Hollywood.
15749 \end_layout
15750
15751 \begin_layout Subsubsection
15752 Special features
15753 \end_layout
15754
15755 \begin_layout Standard
15756 Insert the
15757 \family sans
15758 Speaker
15759 \family default
15760  names as labels then cross-reference the label to insert the name.
15761  The cross-reference dialog will show the current cast of characters.
15762 \end_layout
15763
15764 \begin_layout Subsubsection
15765 Paper size and Margins
15766 \end_layout
15767
15768 \begin_layout Standard
15769 USLetter,
15770  left 1.6in,
15771  right 0.75in,
15772  top 0.5in,
15773  bottom 0.75in
15774 \end_layout
15775
15776 \begin_layout Subsubsection
15777 Environments
15778 \end_layout
15779
15780 \begin_layout Standard
15781 The following environments are available.
15782  You can use broadway.bind to get the bind keys shown at the right.
15783 \end_layout
15784
15785 \begin_layout Itemize
15786
15787 \family sans
15788 Standard
15789 \begin_inset Newline newline
15790 \end_inset
15791
15792
15793 \family default
15794 You should not have to use this,
15795  but it is here for anything that does not fit otherwise.
15796 \end_layout
15797
15798 \begin_layout Itemize
15799
15800 \family sans
15801 Narrative
15802 \begin_inset space \hfill{}
15803 \end_inset
15804
15805 M-z n
15806 \begin_inset Newline newline
15807 \end_inset
15808
15809
15810 \family default
15811 Used to describe stage setting and the action.
15812  First use of speaker names in all CAPs.
15813 \end_layout
15814
15815 \begin_layout Itemize
15816
15817 \family sans
15818 ACT
15819 \begin_inset space \hfill{}
15820 \end_inset
15821
15822 M-z a
15823 \begin_inset Newline newline
15824 \end_inset
15825
15826
15827 \family default
15828 Automatically numbered.
15829  On screen it will be arabic,
15830  but will print as Roman.
15831 \end_layout
15832
15833 \begin_layout Itemize
15834
15835 \family sans
15836 ACT*
15837 \begin_inset space \hfill{}
15838 \end_inset
15839
15840 M-z S at
15841 \begin_inset Newline newline
15842 \end_inset
15843
15844
15845 \family default
15846 Subtitle for
15847 \family sans
15848 ACT.
15849
15850 \family default
15851  It is just centered text.
15852 \end_layout
15853
15854 \begin_layout Itemize
15855
15856 \family sans
15857 SCENE
15858 \begin_inset space \hfill{}
15859 \end_inset
15860
15861 M-z S-S
15862 \begin_inset Newline newline
15863 \end_inset
15864
15865
15866 \family default
15867 Not automatically numbered.
15868  You supply the number.
15869  This is because I couldn't figure out how.
15870 \end_layout
15871
15872 \begin_layout Itemize
15873
15874 \family sans
15875 AT_RISE:
15876 \begin_inset space \hfill{}
15877 \end_inset
15878
15879 M-z S-R
15880 \begin_inset Newline newline
15881 \end_inset
15882
15883
15884 \family default
15885 A special case of Narrative to describe the setting and action as the curtain rises.
15886 \end_layout
15887
15888 \begin_layout Itemize
15889
15890 \family sans
15891 Speaker
15892 \begin_inset space \hfill{}
15893 \end_inset
15894
15895 M-z s
15896 \begin_inset Newline newline
15897 \end_inset
15898
15899
15900 \family default
15901 The speaker's (actor's) title,
15902  centered in all CAPS.
15903 \end_layout
15904
15905 \begin_layout Itemize
15906
15907 \family sans
15908 Parenthetical
15909 \begin_inset space \hfill{}
15910 \end_inset
15911
15912 M-z p
15913 \begin_inset Newline newline
15914 \end_inset
15915
15916
15917 \family default
15918 Instructions to the speaker.
15919  The parentheses are automatically inserted.
15920  The ( will appear on screen,
15921  but both will be in the printed play.
15922  This environment is only used within
15923 \family sans
15924 Dialogue
15925 \family default
15926 .
15927 \end_layout
15928
15929 \begin_layout Itemize
15930
15931 \family sans
15932 Dialogue
15933 \begin_inset space \hfill{}
15934 \end_inset
15935
15936 M-z d
15937 \begin_inset Newline newline
15938 \end_inset
15939
15940
15941 \family default
15942 What the Speaker says.
15943 \end_layout
15944
15945 \begin_layout Itemize
15946
15947 \family sans
15948 CURTAIN
15949 \begin_inset space \hfill{}
15950 \end_inset
15951
15952 M-z S-C
15953 \begin_inset Newline newline
15954 \end_inset
15955
15956
15957 \family default
15958 The curtain comes down.
15959 \end_layout
15960
15961 \begin_layout Itemize
15962
15963 \family sans
15964 Title
15965 \begin_inset space \hfill{}
15966 \end_inset
15967
15968 M-z S-T
15969 \end_layout
15970
15971 \begin_layout Itemize
15972
15973 \family sans
15974 Author
15975 \begin_inset space \hfill{}
15976 \end_inset
15977
15978 M-z S-A
15979 \end_layout
15980
15981 \begin_layout Itemize
15982
15983 \family sans
15984 Right_Address
15985 \begin_inset space \hfill{}
15986 \end_inset
15987
15988 M-z r
15989 \end_layout
15990
15991 \begin_layout Standard
15992 Hello there.
15993 \end_layout
15994
15995 \begin_layout Subsection
15996 Hollywood (Hollywood spec scripts)
15997 \end_layout
15998
15999 \begin_layout Standard
16000 by
16001 \shape smallcaps
16002 Garst Reese
16003 \end_layout
16004
16005 \begin_layout Subsubsection
16006 Introduction
16007 \end_layout
16008
16009 \begin_layout Standard
16010 Getting the format of a Hollywood script right is a
16011 \begin_inset Quotes eld
16012 \end_inset
16013
16014 rite of passage.
16015 \begin_inset Quotes erd
16016 \end_inset
16017
16018  It is designed to make the readers focus on content and to be easy and familiar for the actors to read.
16019  Each page of a script should be one minute of film.
16020  Nothing goes in a script that you cannot see or hear on screen.
16021  The courier 12 pt font should be used throughout.
16022  No italics.
16023 \end_layout
16024
16025 \begin_layout Subsubsection
16026 Special problems
16027 \end_layout
16028
16029 \begin_layout Standard
16030 Speakers' lines should NEVER break in mid-sentence.
16031  If a speaker's lines continue over a page break,
16032  repeat the
16033 \family sans
16034 Speaker
16035 \family default
16036  title followed by (Cont'd).
16037 \end_layout
16038
16039 \begin_layout Subsubsection
16040 Special features
16041 \end_layout
16042
16043 \begin_layout Standard
16044 Insert the
16045 \family sans
16046 Speaker
16047 \family default
16048  names as labels then cross-reference the label to insert the name.
16049  The cross-reference dialog will show the current cast of characters.
16050  You can use this to insert the speaker name in narratives also.
16051 \end_layout
16052
16053 \begin_layout Subsubsection
16054 Paper size and Margins
16055 \end_layout
16056
16057 \begin_layout Standard
16058 USLetter,
16059  left 1.6in,
16060  right 0.75in,
16061  top 0.5in,
16062  bottom 0.75in
16063 \end_layout
16064
16065 \begin_layout Subsubsection
16066 Environments
16067 \end_layout
16068
16069 \begin_layout Standard
16070 The following environments are available.
16071  You can use hollywood.bind to get the bind keys shown at the right.
16072 \end_layout
16073
16074 \begin_layout Itemize
16075
16076 \family sans
16077 Standard
16078 \begin_inset Newline newline
16079 \end_inset
16080
16081
16082 \family default
16083 Used where nothing else works.
16084  Try to avoid it.
16085 \end_layout
16086
16087 \begin_layout Itemize
16088
16089 \family sans
16090 FADE_IN
16091 \family default
16092 :
16093 \begin_inset space \hfill{}
16094 \end_inset
16095
16096
16097 \family sans
16098 M-z S-I
16099 \family default
16100
16101 \begin_inset Newline newline
16102 \end_inset
16103
16104 Usually followed by something like
16105 \begin_inset Quotes eld
16106 \end_inset
16107
16108 on Sally waking up.
16109 \begin_inset Quotes erd
16110 \end_inset
16111
16112
16113 \end_layout
16114
16115 \begin_layout Itemize
16116
16117 \family sans
16118 INT:
16119 \begin_inset space \hfill{}
16120 \end_inset
16121
16122 M-z i
16123 \begin_inset Newline newline
16124 \end_inset
16125
16126
16127 \family default
16128 Introduces a new INTERIOR camera set-up.
16129  Always followed by DAY or NIGHT,
16130  or something similar to define the lighting required.
16131  Everthing on this line in CAPS.
16132 \end_layout
16133
16134 \begin_layout Itemize
16135
16136 \family sans
16137 EXT:
16138 \begin_inset space \hfill{}
16139 \end_inset
16140
16141 M-z e
16142 \begin_inset Newline newline
16143 \end_inset
16144
16145
16146 \family default
16147 Introduces a new EXTERIOR camera set-up.
16148  Everthing on this line in CAPS.
16149 \end_layout
16150
16151 \begin_layout Itemize
16152
16153 \family sans
16154 Speaker
16155 \begin_inset space \hfill{}
16156 \end_inset
16157
16158 M-z s
16159 \begin_inset Newline newline
16160 \end_inset
16161
16162
16163 \family default
16164 The character speaking.
16165 \end_layout
16166
16167 \begin_layout Itemize
16168
16169 \family sans
16170 Parenthetical
16171 \begin_inset space \hfill{}
16172 \end_inset
16173
16174 M-z p
16175 \begin_inset Newline newline
16176 \end_inset
16177
16178
16179 \family default
16180 Instructions to the speaker.
16181  The () are automatically inserted.
16182 \end_layout
16183
16184 \begin_layout Itemize
16185
16186 \family sans
16187 Dialogue
16188 \begin_inset space \hfill{}
16189 \end_inset
16190
16191 M-z d
16192 \begin_inset Newline newline
16193 \end_inset
16194
16195
16196 \family default
16197 What the
16198 \family sans
16199 Speaker
16200 \family default
16201  says.
16202 \end_layout
16203
16204 \begin_layout Itemize
16205
16206 \family sans
16207 Transition
16208 \begin_inset space \hfill{}
16209 \end_inset
16210
16211 M-z t
16212 \begin_inset Newline newline
16213 \end_inset
16214
16215
16216 \family default
16217 Camera movement instruction.
16218  e.
16219 \begin_inset space \thinspace{}
16220 \end_inset
16221
16222 g.
16223 \begin_inset space \space{}
16224 \end_inset
16225
16226 CUT TO:
16227 \end_layout
16228
16229 \begin_layout Itemize
16230
16231 \family sans
16232 FADE OUT:
16233 \begin_inset space \hfill{}
16234 \end_inset
16235
16236 M-z S-I
16237 \end_layout
16238
16239 \begin_layout Itemize
16240
16241 \family sans
16242 Author
16243 \begin_inset space \hfill{}
16244 \end_inset
16245
16246 M-z S-A
16247 \end_layout
16248
16249 \begin_layout Itemize
16250
16251 \family sans
16252 Title
16253 \begin_inset space \hfill{}
16254 \end_inset
16255
16256 M-z S-T
16257 \end_layout
16258
16259 \begin_layout Itemize
16260
16261 \family sans
16262 Right_Address
16263 \begin_inset space \hfill{}
16264 \end_inset
16265
16266 M-z r
16267 \end_layout
16268
16269 \begin_layout Subsubsection
16270 Script jargon
16271 \end_layout
16272
16273 \begin_layout Itemize
16274 (O.S) —
16275  off screen
16276 \end_layout
16277
16278 \begin_layout Itemize
16279 (V.0) —
16280  voice over
16281 \end_layout
16282
16283 \begin_layout Itemize
16284 b.
16285 \begin_inset space \thinspace{}
16286 \end_inset
16287
16288 g.
16289  —
16290  background
16291 \end_layout
16292
16293 \begin_layout Itemize
16294 C.U.
16295  —
16296  close-up
16297 \end_layout
16298
16299 \begin_layout Itemize
16300 PAN —
16301  camera movement
16302 \end_layout
16303
16304 \begin_layout Itemize
16305 INSERT —
16306  cut to close-up of
16307 \end_layout
16308
16309 \begin_layout Chapter
16310
16311 \change_inserted 564990737 1671185876
16312 Modules
16313 \end_layout
16314
16315 \begin_layout Section
16316
16317 \change_inserted 564990737 1671716212
16318 Academic Field Specifics
16319 \end_layout
16320
16321 \begin_layout Subsection
16322
16323 \change_inserted 564990737 1671716212
16324 Chemistry:
16325  Hazard and Precautionary Statements
16326 \end_layout
16327
16328 \begin_layout Standard
16329
16330 \change_inserted 564990737 1671716212
16331 This module provides two insets to typeset numbers and phrases of chemical hazard and precautionary statements.
16332  For a description see
16333 \family sans
16334 File\SpecialChar menuseparator
16335 Open Example\SpecialChar menuseparator
16336 Modules\SpecialChar menuseparator
16337 Hazard and Precautionary Statements
16338 \family default
16339  and
16340 \family sans
16341 Help\SpecialChar menuseparator
16342 Specific Manuals\SpecialChar menuseparator
16343 Hazard and Precautionary Statements
16344 \family default
16345 .
16346 \end_layout
16347
16348 \begin_layout Subsection
16349
16350 \change_inserted 564990737 1671716212
16351
16352 \series bold
16353 Chemistry:
16354  Risk and Safety Statements
16355 \end_layout
16356
16357 \begin_layout Standard
16358
16359 \change_inserted 564990737 1671716212
16360 This module provides two insets,
16361
16362 \family sans
16363 R-S number
16364 \family default
16365  and
16366 \family sans
16367 R-S phrase
16368 \family default
16369 ,
16370  accessible via the menu
16371 \family sans
16372 \bar under
16373 I
16374 \bar default
16375 nsert\SpecialChar menuseparator
16376 Custom
16377 \begin_inset space ~
16378 \end_inset
16379
16380 Insets
16381 \family default
16382  and an environment to typeset numbers and phrases of chemical risk and safety statements.
16383 \end_layout
16384
16385 \begin_layout Subsection
16386
16387 \change_inserted 564990737 1671716212
16388 Linguistics
16389 \end_layout
16390
16391 \begin_layout Standard
16392
16393 \change_inserted 564990737 1671716212
16394 This module uses the
16395 \family sans
16396 covington.sty
16397 \family default
16398  package to add environments useful for linguistics (numbered examples,
16399  glosses,
16400  semantic markup,
16401  tableau floats).
16402  You can obtain information about this module in
16403 \family sans
16404 \bar under
16405 H
16406 \bar default
16407 elp\SpecialChar menuseparator
16408 S
16409 \bar under
16410 p
16411 \bar default
16412 ecific
16413 \begin_inset space ~
16414 \end_inset
16415
16416 Manuals\SpecialChar menuseparator
16417
16418 \bar under
16419 L
16420 \bar default
16421 inguistics
16422 \family default
16423  and
16424 \family sans
16425 File\SpecialChar menuseparator
16426 Open Example\SpecialChar menuseparator
16427 Modules\SpecialChar menuseparator
16428 Linguistics
16429 \family default
16430 .
16431 \end_layout
16432
16433 \begin_layout Section
16434
16435 \change_inserted 564990737 1671788778
16436 Accessibility
16437 \end_layout
16438
16439 \begin_layout Subsection
16440
16441 \change_inserted 564990737 1671788778
16442 Braille
16443 \end_layout
16444
16445 \begin_layout Standard
16446
16447 \change_inserted 564990737 1671788778
16448 This module supports the Braille writing system.
16449  It requires the \SpecialChar LaTeX
16450  package
16451 \family typewriter
16452 braille.sty
16453 \family default
16454 .
16455  This and its documentation can be obtained from
16456 \begin_inset CommandInset href
16457 LatexCommand href
16458 name "CTAN"
16459 target "https://www.ctan.org/pkg/braille"
16460 literal "false"
16461
16462 \end_inset
16463
16464 .
16465  You do not have to reconfigure your system after installing it.
16466  See
16467 \family sans
16468 \bar under
16469 H
16470 \bar default
16471 elp\SpecialChar menuseparator
16472 S
16473 \bar under
16474 p
16475 \bar default
16476 ecific
16477 \begin_inset space ~
16478 \end_inset
16479
16480 Manuals\SpecialChar menuseparator
16481
16482 \bar under
16483 B
16484 \bar default
16485 raille
16486 \family default
16487  and
16488 \family sans
16489 File\SpecialChar menuseparator
16490 Open Example\SpecialChar menuseparator
16491 Modules\SpecialChar menuseparator
16492 Braille
16493 \family default
16494 .
16495 \end_layout
16496
16497 \begin_layout Section
16498
16499 \change_inserted 564990737 1671788778
16500 Annotation & Revision
16501 \end_layout
16502
16503 \begin_layout Subsection
16504
16505 \change_inserted 564990737 1671788778
16506 FiXme Notes
16507 \end_layout
16508
16509 \begin_layout Standard
16510
16511 \change_inserted 564990737 1671788778
16512 This module provides “FiXme” (marginal) annotations for document revision purposes.
16513  A list of annotations can be produced by using the “List of FIXMEs” paragraph style.
16514  The annotations are customizable via the LaTeX preamble.
16515  See the FiXme documentation which can be obtained from
16516 \begin_inset CommandInset href
16517 LatexCommand href
16518 name "CTAN"
16519 target "http://mirrors.ctan.org/macros/latex/contrib/fixme/fixme.pdf"
16520 literal "false"
16521
16522 \end_inset
16523
16524 .
16525
16526 \end_layout
16527
16528 \begin_layout Paragraph
16529
16530 \change_inserted 564990737 1671788778
16531 Note:
16532 \end_layout
16533
16534 \begin_layout Standard
16535
16536 \change_inserted 564990737 1671788778
16537 by default,
16538  the notes are only displayed in “draft” mode (if the option “draft” has been inserted in
16539 \family sans
16540 Document\SpecialChar menuseparator
16541 Settings\SpecialChar menuseparator
16542 Document Class\SpecialChar menuseparator
16543 Class Options\SpecialChar menuseparator
16544 Custom
16545 \family default
16546 ).
16547  To display them always,
16548  insert
16549 \family typewriter
16550
16551 \backslash
16552 fxsetup{draft}
16553 \family default
16554  in
16555 \family sans
16556 Document\SpecialChar menuseparator
16557 Settings\SpecialChar menuseparator
16558 \SpecialChar LaTeX
16559  Preamble
16560 \family default
16561 .
16562
16563 \end_layout
16564
16565 \begin_layout Subsection
16566
16567 \change_inserted 564990737 1671788778
16568 PDF Comments
16569 \end_layout
16570
16571 \begin_layout Standard
16572
16573 \change_inserted 564990737 1671788778
16574 This module provides various kinds of annotations for PDF output.
16575  See
16576 \family sans
16577 Help\SpecialChar menuseparator
16578 Specific Manuals\SpecialChar menuseparator
16579 PDF comments and File\SpecialChar menuseparator
16580 Open Example\SpecialChar menuseparator
16581 Modules\SpecialChar menuseparator
16582 PDF Comments
16583 \family default
16584 .
16585 \end_layout
16586
16587 \begin_layout Subsection
16588
16589 \change_inserted 564990737 1671788778
16590
16591 \series bold
16592 PDF Form
16593 \end_layout
16594
16595 \begin_layout Standard
16596
16597 \change_inserted 564990737 1671788778
16598 This module provides fields and buttons for PDF forms.
16599  See the
16600 \begin_inset CommandInset href
16601 LatexCommand href
16602 name "hyperref documentation"
16603 target "http://mirrors.ctan.org/macros/latex/contrib/hyperref/doc/hyperref-doc.pdf"
16604 literal "false"
16605
16606 \end_inset
16607
16608 ,
16609
16610 \family sans
16611 Help\SpecialChar menuseparator
16612 Specific Manuals\SpecialChar menuseparator
16613 PDF forms and File\SpecialChar menuseparator
16614 Open Example\SpecialChar menuseparator
16615 Modules\SpecialChar menuseparator
16616 PDF Form
16617 \family default
16618 .
16619 \end_layout
16620
16621 \begin_layout Subsection
16622
16623 \change_inserted 564990737 1671788778
16624
16625 \series bold
16626 Ruby (Furigana)
16627 \end_layout
16628
16629 \begin_layout Standard
16630
16631 \change_inserted 564990737 1671788778
16632 This module defines an inset to typeset reading aids (ruby,
16633  furigana) to Chinese characters.
16634  It uses the “okumakro,” “luatexja-ruby” or “ruby” package (depending on the TeX engine) or a fallback definition.
16635
16636 \end_layout
16637
16638 \begin_layout Subsection
16639
16640 \change_inserted 564990737 1671788778
16641
16642 \series bold
16643 TODO notes
16644 \end_layout
16645
16646 \begin_layout Standard
16647
16648 \change_inserted 564990737 1671788778
16649 This module provides custom insets to insert TODO items in your document.
16650  In order to generate a “List of TODOs,” the module provides a paragraph style.
16651  Inserting “final” in
16652 \family sans
16653 Document\SpecialChar menuseparator
16654 Settings\SpecialChar menuseparator
16655 Document Class\SpecialChar menuseparator
16656 Class Options\SpecialChar menuseparator
16657 Custom
16658 \family default
16659 ) suppresses the output of TODO notes.
16660  See the
16661 \begin_inset CommandInset href
16662 LatexCommand href
16663 name "todonotes documentation"
16664 target "http://mirrors.ctan.org/macros/latex/contrib/todonotes/todonotes.pdf"
16665 literal "false"
16666
16667 \end_inset
16668
16669 .
16670 \end_layout
16671
16672 \begin_layout Section
16673
16674 \change_inserted 564990737 1671829045
16675 Bibliography
16676 \end_layout
16677
16678 \begin_layout Subsection
16679
16680 \change_inserted 564990737 1671829045
16681 APA Style with NatBib
16682 \end_layout
16683
16684 \begin_layout Standard
16685
16686 \change_inserted 564990737 1671829045
16687 This module adds support for using natbib together with apacite (the bibliography style need not be apacite —
16688  it could be apacite,
16689  apacitex,
16690  or any bibliography that works with both the natbib and apacite packages.)
16691 \end_layout
16692
16693 \begin_layout Section
16694
16695 \change_inserted 564990737 1671829045
16696 Boxes
16697 \end_layout
16698
16699 \begin_layout Subsection
16700
16701 \change_inserted 564990737 1671829045
16702 Fancy Colored Boxes
16703 \end_layout
16704
16705 \begin_layout Standard
16706
16707 \change_inserted 564990737 1671829045
16708 This module adds ten custom insets that support colored boxes via the tcolorbox package.
16709  See
16710 \family sans
16711 Help\SpecialChar menuseparator
16712 Specific Manuals\SpecialChar menuseparator
16713 Colored boxes
16714 \family default
16715 ,
16716
16717 \family sans
16718 File\SpecialChar menuseparator
16719 Open Example\SpecialChar menuseparator
16720 Modules\SpecialChar menuseparator
16721 Fancy Color Boxes
16722 \family default
16723  the
16724 \begin_inset CommandInset href
16725 LatexCommand href
16726 name "tcolorbox documentation"
16727 target "http://mirrors.ctan.org/macros/latex/contrib/tcolorbox/tcolorbox.pdf"
16728 literal "false"
16729
16730 \end_inset
16731
16732  for details.
16733
16734 \end_layout
16735
16736 \begin_layout Subsection
16737
16738 \change_inserted 564990737 1671829045
16739 Graphic boxes
16740 \end_layout
16741
16742 \begin_layout Standard
16743
16744 \change_inserted 564990737 1671829045
16745 This provides the custom insets
16746 \family sans
16747 Reflectbox
16748 \family default
16749 ,
16750
16751 \family sans
16752 Resizebox
16753 \family default
16754 ,
16755
16756 \family sans
16757 Rotatebox
16758 \family default
16759  and
16760 \family sans
16761 Scalebox
16762 \family default
16763  to scale and rotate its content.
16764 \end_layout
16765
16766 \begin_layout Standard
16767
16768 \change_inserted 564990737 1671829045
16769
16770 \family sans
16771 Reflectbox
16772 \family default
16773  is a simple way of reversing text without any other enhancement:
16774 \end_layout
16775
16776 \begin_layout Standard
16777
16778 \change_inserted 564990737 1671829045
16779 \begin_inset Flex Reflectbox
16780 status open
16781
16782 \begin_layout Plain Layout
16783
16784 \change_inserted 564990737 1671829045
16785 Great Western Railway
16786 \change_unchanged
16787
16788 \end_layout
16789
16790 \end_inset
16791
16792
16793 \end_layout
16794
16795 \begin_layout Standard
16796
16797 \change_inserted 564990737 1671829045
16798 (You will need to use Ctrl-R to see any of these examples.)
16799 \end_layout
16800
16801 \begin_layout Standard
16802
16803 \change_inserted 564990737 1671829045
16804
16805 \family sans
16806 Resizebox
16807 \family default
16808  allows you to specify the dimensions of the text or image;
16809  permissible units are em,
16810  ex,
16811  in,
16812  pt,
16813  pc,
16814  cm,
16815  mm,
16816  dd,
16817  cc,
16818  nd,
16819  nc,
16820  bp,
16821  or sp;
16822  if you enter
16823 \family typewriter
16824 !
16825
16826 \family default
16827  for
16828 \family typewriter
16829 Height
16830 \family default
16831  it scales by the width factor:
16832 \end_layout
16833
16834 \begin_layout Standard
16835
16836 \change_inserted 564990737 1671829045
16837 \begin_inset Flex Resizebox
16838 status open
16839
16840 \begin_layout Plain Layout
16841
16842 \change_inserted 564990737 1671829045
16843 \begin_inset Argument 1
16844 status open
16845
16846 \begin_layout Plain Layout
16847
16848 \change_inserted 564990737 1671829045
16849 48mm
16850 \change_unchanged
16851
16852 \end_layout
16853
16854 \end_inset
16855
16856
16857 \begin_inset Argument 2
16858 status open
16859
16860 \begin_layout Plain Layout
16861
16862 \change_inserted 564990737 1671829045
16863 !
16864 \change_unchanged
16865
16866 \end_layout
16867
16868 \end_inset
16869
16870 Great Western Railway
16871 \change_unchanged
16872
16873 \end_layout
16874
16875 \end_inset
16876
16877
16878 \end_layout
16879
16880 \begin_layout Standard
16881
16882 \change_inserted 564990737 1671829045
16883
16884 \family sans
16885 Rotatebox
16886 \family default
16887  allows you to rotate text around the reference point of the box.
16888  If you wish to rotate the box around a different origin,
16889  place the cursor inside the box and select Insert\SpecialChar menuseparator
16890 Origin;
16891  o
16892 \family typewriter
16893 rigin
16894 \family default
16895  is specified as
16896 \family typewriter
16897 c
16898 \family default
16899 ,
16900
16901 \family typewriter
16902  l
16903 \family default
16904 ,
16905
16906 \family typewriter
16907  r
16908 \family default
16909 ,
16910
16911 \family typewriter
16912  b
16913 \family default
16914 ,
16915
16916 \family typewriter
16917  t
16918 \family default
16919  or meaningful combinations of these and the counterclockwise rotation angle is expressed in degrees.
16920  For example:
16921 \end_layout
16922
16923 \begin_layout Standard
16924
16925 \change_inserted 564990737 1671829045
16926 \begin_inset Flex Rotatebox
16927 status open
16928
16929 \begin_layout Plain Layout
16930
16931 \change_inserted 564990737 1671829045
16932 \begin_inset Argument 1
16933 status open
16934
16935 \begin_layout Plain Layout
16936
16937 \change_inserted 274215730 1672888693
16938 origin
16939 \change_inserted 564990737 1671829045
16940 =c
16941 \change_unchanged
16942
16943 \end_layout
16944
16945 \end_inset
16946
16947
16948 \begin_inset Argument 2
16949 status open
16950
16951 \begin_layout Plain Layout
16952
16953 \change_inserted 564990737 1671829045
16954 30
16955 \change_unchanged
16956
16957 \end_layout
16958
16959 \end_inset
16960
16961 Great Western Railway
16962 \change_unchanged
16963
16964 \end_layout
16965
16966 \end_inset
16967
16968
16969 \end_layout
16970
16971 \begin_layout Standard
16972
16973 \change_inserted 564990737 1671829045
16974 You can combine boxes as in:
16975 \end_layout
16976
16977 \begin_layout Standard
16978
16979 \change_inserted 564990737 1671829045
16980 \begin_inset Flex Rotatebox
16981 status open
16982
16983 \begin_layout Plain Layout
16984
16985 \change_inserted 564990737 1671829045
16986 \begin_inset Argument 1
16987 status open
16988
16989 \begin_layout Plain Layout
16990
16991 \change_inserted 274215730 1672888702
16992 origin
16993 \change_inserted 564990737 1671829045
16994 =c
16995 \change_unchanged
16996
16997 \end_layout
16998
16999 \end_inset
17000
17001
17002 \begin_inset Argument 2
17003 status open
17004
17005 \begin_layout Plain Layout
17006
17007 \change_inserted 564990737 1671829045
17008 -15
17009 \change_unchanged
17010
17011 \end_layout
17012
17013 \end_inset
17014
17015
17016 \begin_inset Flex Resizebox
17017 status open
17018
17019 \begin_layout Plain Layout
17020
17021 \change_inserted 564990737 1671829045
17022 \begin_inset Argument 1
17023 status open
17024
17025 \begin_layout Plain Layout
17026
17027 \change_inserted 564990737 1671829045
17028 48mm
17029 \change_unchanged
17030
17031 \end_layout
17032
17033 \end_inset
17034
17035
17036 \begin_inset Argument 2
17037 status open
17038
17039 \begin_layout Plain Layout
17040
17041 \change_inserted 564990737 1671829045
17042 !
17043 \change_unchanged
17044
17045 \end_layout
17046
17047 \end_inset
17048
17049
17050 \begin_inset Flex Reflectbox
17051 status open
17052
17053 \begin_layout Plain Layout
17054
17055 \change_inserted 564990737 1671829045
17056 Great Western Railway
17057 \change_unchanged
17058
17059 \end_layout
17060
17061 \end_inset
17062
17063
17064 \change_unchanged
17065
17066 \end_layout
17067
17068 \end_inset
17069
17070
17071 \change_unchanged
17072
17073 \end_layout
17074
17075 \end_inset
17076
17077
17078 \end_layout
17079
17080 \begin_layout Standard
17081
17082 \change_inserted 564990737 1671829045
17083
17084 \family sans
17085 Scalebox
17086 \family default
17087  scales text;
17088  select Insert\SpecialChar menuseparator
17089 V-Factor to add a vertical factor.
17090  If the vertical factor is omitted,
17091  the horizontal is used.
17092  Adding different horizontal and vertical values creates distortion as in
17093 \end_layout
17094
17095 \begin_layout Standard
17096
17097 \change_inserted 564990737 1671829045
17098
17099 \family typewriter
17100 \begin_inset Flex Scalebox
17101 status open
17102
17103 \begin_layout Plain Layout
17104
17105 \change_inserted 564990737 1671829045
17106 \begin_inset Argument 1
17107 status open
17108
17109 \begin_layout Plain Layout
17110
17111 \change_inserted 564990737 1671829045
17112 2
17113 \change_unchanged
17114
17115 \end_layout
17116
17117 \end_inset
17118
17119
17120 \begin_inset Argument 2
17121 status open
17122
17123 \begin_layout Plain Layout
17124
17125 \change_inserted 564990737 1671829045
17126 1.5
17127 \change_unchanged
17128
17129 \end_layout
17130
17131 \end_inset
17132
17133
17134 \family roman
17135 Great Western Railway
17136 \change_unchanged
17137
17138 \end_layout
17139
17140 \end_inset
17141
17142 .
17143 \end_layout
17144
17145 \begin_layout Standard
17146
17147 \change_inserted 564990737 1671829045
17148 A negative horizontal value reverses the text and a negative vertical value inverts it so that you get
17149 \end_layout
17150
17151 \begin_layout Standard
17152
17153 \change_inserted 564990737 1671829045
17154 \begin_inset Flex Scalebox
17155 status open
17156
17157 \begin_layout Plain Layout
17158
17159 \change_inserted 564990737 1671829045
17160 \begin_inset Argument 1
17161 status open
17162
17163 \begin_layout Plain Layout
17164
17165 \change_inserted 564990737 1671829045
17166 -1
17167 \change_unchanged
17168
17169 \end_layout
17170
17171 \end_inset
17172
17173
17174 \begin_inset Argument 2
17175 status open
17176
17177 \begin_layout Plain Layout
17178
17179 \change_inserted 564990737 1671829045
17180 1
17181 \change_unchanged
17182
17183 \end_layout
17184
17185 \end_inset
17186
17187 Great Western Railway
17188 \change_unchanged
17189
17190 \end_layout
17191
17192 \end_inset
17193
17194  and
17195 \begin_inset Flex Scalebox
17196 status open
17197
17198 \begin_layout Plain Layout
17199
17200 \change_inserted 564990737 1671829045
17201 \begin_inset Argument 1
17202 status open
17203
17204 \begin_layout Plain Layout
17205
17206 \change_inserted 564990737 1671829045
17207 1
17208 \change_unchanged
17209
17210 \end_layout
17211
17212 \end_inset
17213
17214
17215 \begin_inset Argument 2
17216 status open
17217
17218 \begin_layout Plain Layout
17219
17220 \change_inserted 564990737 1671829045
17221 -1
17222 \change_unchanged
17223
17224 \end_layout
17225
17226 \end_inset
17227
17228 Great Western Railway
17229 \change_unchanged
17230
17231 \end_layout
17232
17233 \end_inset
17234
17235 .
17236 \end_layout
17237
17238 \begin_layout Subsection
17239
17240 \change_inserted 564990737 1671884699
17241 Section Boxes
17242 \end_layout
17243
17244 \begin_layout Standard
17245
17246 \change_inserted 564990737 1671884699
17247 This module defines Boxes with section header.
17248  It is mainly intended for the SciPoster Document class.
17249
17250 \end_layout
17251
17252 \begin_layout Subsection
17253
17254 \change_inserted 564990737 1671884699
17255 Variable-width Minipages
17256 \end_layout
17257
17258 \begin_layout Standard
17259
17260 \change_inserted 564990737 1671884699
17261 This module adds a
17262 \family sans
17263 Minipage (Var.
17264 \begin_inset space \thinspace{}
17265 \end_inset
17266
17267 Width)
17268 \family default
17269  inset to
17270 \family sans
17271 Insert\SpecialChar menuseparator
17272 Custom Inset
17273 \family default
17274  using the
17275 \family sans
17276 varwidth
17277 \family default
17278  LaTeX package.
17279  The
17280 \family sans
17281 varwidth
17282 \family default
17283  package provides a variable-width minipage,
17284  whose resulting width is the width of its contents (if this does not exceed the specified maximum width).
17285  The inset has two optional arguments which can be added by placing the cursor inside the minipage and entering
17286 \family sans
17287 Insert\SpecialChar menuseparator
17288 Vert.
17289 \begin_inset space \thinspace{}
17290 \end_inset
17291
17292 Adjustment
17293 \family default
17294  (
17295 \family typewriter
17296 c|t|b
17297 \family default
17298 ) or
17299 \family sans
17300 Insert\SpecialChar menuseparator
17301 Max.
17302 \begin_inset space \thinspace{}
17303 \end_inset
17304
17305 Width
17306 \family default
17307  (defaults to
17308 \family typewriter
17309
17310 \backslash
17311 linewidth
17312 \family default
17313 ).
17314  See
17315 \family sans
17316 File\SpecialChar menuseparator
17317 Open Example\SpecialChar menuseparator
17318 Variable-width Minipages
17319 \family default
17320 .
17321
17322 \end_layout
17323
17324 \begin_layout Section
17325
17326 \change_inserted 564990737 1671884699
17327 Fixes & Hacks
17328 \end_layout
17329
17330 \begin_layout Subsection
17331
17332 \change_inserted 564990737 1671884699
17333 Fix Computer Modern Fonts
17334 \end_layout
17335
17336 \begin_layout Standard
17337
17338 \change_inserted 564990737 1671884699
17339 This module uses the
17340 \family sans
17341 fix-cm
17342 \family default
17343  package to improve the appearance of Computer Modern fonts and make them available with arbitrary sizes.
17344  See the
17345 \begin_inset CommandInset href
17346 LatexCommand href
17347 name "fix-cm documentation"
17348 target "http://mirrors.ctan.org/macros/latex/base/fix-cm.pdf"
17349 literal "false"
17350
17351 \end_inset
17352
17353 .
17354
17355 \end_layout
17356
17357 \begin_layout Subsection
17358
17359 \change_inserted 564990737 1671884699
17360 \SpecialChar LaTeX
17361  Kernel Fixes (Obsolete)
17362 \end_layout
17363
17364 \begin_layout Standard
17365
17366 \change_inserted 564990737 1671884699
17367 This module loads the \SpecialChar LaTeX
17368  package
17369 \family sans
17370 fixltx2e
17371 \family default
17372  which contains some bug fixes for \SpecialChar LaTeX
17373 .
17374  If you use this module your typeset document may look different when you process it,
17375  depending on the respective version of
17376 \family sans
17377 fixltx2e
17378 \family default
17379 .
17380
17381 \end_layout
17382
17383 \begin_layout Paragraph
17384
17385 \change_inserted 564990737 1671884699
17386 Note:
17387 \end_layout
17388
17389 \begin_layout Standard
17390
17391 \change_inserted 564990737 1671884699
17392 recent \SpecialChar LaTeX
17393  kernels (as of 2015/01/01) include the functionality of
17394 \family sans
17395 fixltx2e
17396 \family default
17397 ,
17398  so the
17399 \family sans
17400 fixltx2e
17401 \family default
17402  module is obsolete with newer \SpecialChar LaTeX
17403  distributions.
17404
17405 \end_layout
17406
17407 \begin_layout Subsection
17408
17409 \change_inserted 564990737 1671884699
17410 Minimalistic Insets
17411 \end_layout
17412
17413 \begin_layout Standard
17414
17415 \change_inserted 564990737 1671884699
17416 This module redefines several insets (Index,
17417  Branch,
17418  URL) as being Minimalistic.
17419 \end_layout
17420
17421 \begin_layout Subsection
17422
17423 \change_inserted 564990737 1671884699
17424 Title and Preamble Hacks
17425 \end_layout
17426
17427 \begin_layout Standard
17428
17429 \change_inserted 564990737 1671884699
17430 This module provides two new paragraph styles:
17431
17432 \end_layout
17433
17434 \begin_layout Enumerate
17435
17436 \change_inserted 564990737 1671884699
17437
17438 \family sans
17439 In Preamble
17440 \family default
17441  which puts whatever is entered into it into the preamble.
17442  This can be used,
17443  if one wishes,
17444  to include preamble code in the body of a LyX document.
17445
17446 \end_layout
17447
17448 \begin_layout Enumerate
17449
17450 \change_inserted 564990737 1671884699
17451
17452 \family sans
17453 In Title
17454 \family default
17455  which that will put its contents into the body of the LaTeX document,
17456  but before
17457 \family typewriter
17458
17459 \backslash
17460 maketitle
17461 \family default
17462  is issued.
17463  This is useful for making branches and notes in title-related material.
17464  (However,
17465  if you put these in a Standard layout,
17466  this signals to LyX to output
17467 \family typewriter
17468
17469 \backslash
17470 maketitle
17471 \family default
17472 ,
17473  which may then come too early.)
17474 \end_layout
17475
17476 \begin_layout Section
17477
17478 \change_inserted 564990737 1672081439
17479 Floats & captions
17480 \end_layout
17481
17482 \begin_layout Subsection
17483
17484 \change_inserted 564990737 1672081439
17485 Algorithm2e Float
17486 \end_layout
17487
17488 \begin_layout Standard
17489
17490 \change_inserted 564990737 1672081439
17491 This module uses the
17492 \family sans
17493 algorithm2e
17494 \family default
17495  package for algorithm floats rather than LyX’s home-brewed algorithm floats.
17496  Use the Algorithm paragraph style to enter and indent the algorithm.
17497  See the
17498 \begin_inset CommandInset href
17499 LatexCommand href
17500 name "algorithm2e documentation"
17501 target "http://mirrors.ctan.org/macros/latex/contrib/algorithm2e/doc/algorithm2e.pdf"
17502 literal "false"
17503
17504 \end_inset
17505
17506 .
17507 \end_layout
17508
17509 \begin_layout Subsection
17510
17511 \change_inserted 564990737 1672081439
17512 Bilingual Captions AKA Multilingual Captions
17513 \end_layout
17514
17515 \begin_layout Standard
17516
17517 \change_inserted 564990737 1672081439
17518 This module provides the paragraph style
17519 \family sans
17520 Caption
17521 \begin_inset space ~
17522 \end_inset
17523
17524 setup
17525 \family default
17526  with which to typeset multilingual captions.
17527  Within this paragraph style
17528 \family sans
17529 Insert\SpecialChar menuseparator
17530 Language
17531 \family default
17532  allows you to enter the desired language using one of the babel names.
17533  See
17534 \family sans
17535 File\SpecialChar menuseparator
17536 Open Example\SpecialChar menuseparator
17537 Multilingual Captions
17538 \family default
17539  and
17540 \family sans
17541 Help\SpecialChar menuseparator
17542 Specific Manuals\SpecialChar menuseparator
17543 Multilingual Captions
17544 \family default
17545  further information on its use.
17546 \end_layout
17547
17548 \begin_layout Subsection
17549
17550 \change_inserted 564990737 1672081439
17551 Number Figures by Section
17552 \end_layout
17553
17554 \begin_layout Standard
17555
17556 \change_inserted 564990737 1672081439
17557 This module resets the figure number at section start and prepends the section number to the figure number,
17558  as in “Figure 2.1.” (By default book and report document classes number by Chapter and article document classes have a single sequence.)
17559 \end_layout
17560
17561 \begin_layout Subsection
17562
17563 \change_inserted 564990737 1672081439
17564 Number Tables by Section
17565 \end_layout
17566
17567 \begin_layout Standard
17568
17569 \change_inserted 564990737 1672081439
17570 This module resets the table number at section start and prepends the section number to the table number,
17571  as in “Table 2.1.” (By default book and report document classes number by Chapter and article document classes have a single sequence.)
17572 \end_layout
17573
17574 \begin_layout Section
17575
17576 \change_inserted 564990737 1672081439
17577 Foot- and Endnotes
17578 \end_layout
17579
17580 \begin_layout Subsection
17581
17582 \change_inserted 564990737 1672081439
17583 Endnotes (Basic)
17584 \end_layout
17585
17586 \begin_layout Standard
17587
17588 \change_inserted 564990737 1672081439
17589 This module adds an endnote inset,
17590  in addition to footnotes.
17591  This uses the
17592 \family sans
17593 endnotes
17594 \family default
17595  package,
17596  which has some limitations but works with older LaTeX distributions as well.
17597  Use
17598 \family sans
17599 Insert\SpecialChar menuseparator
17600 Custom Inset\SpecialChar menuseparator
17601 Endnote
17602 \family default
17603  to insert an endnote and
17604 \family sans
17605 Insert\SpecialChar menuseparator
17606 List/Contents/References\SpecialChar menuseparator
17607 Endnotes
17608 \family default
17609  to insert the endnotes list where you want the endnotes to appear.
17610  See also
17611 \family sans
17612 Help\SpecialChar menuseparator
17613 Embedded\SpecialChar menuseparator
17614  Objects\SpecialChar menuseparator
17615 Notes\SpecialChar menuseparator
17616 Footnotes
17617 \family default
17618 .
17619 \end_layout
17620
17621 \begin_layout Subsection
17622
17623 \change_inserted 564990737 1672081439
17624 Endnotes (Extended)
17625 \end_layout
17626
17627 \begin_layout Standard
17628
17629 \change_inserted 564990737 1672081439
17630 This module adds an endnote inset,
17631  in addition to footnotes.
17632  This uses the
17633 \family sans
17634 enotez
17635 \family default
17636  package which is more powerful and customizable than the
17637 \family sans
17638 endnotes
17639 \family default
17640  package,
17641  but requires a fairly modern LaTeX distribution (with LaTeX3).
17642  Use
17643 \family sans
17644 Insert\SpecialChar menuseparator
17645 Custom Inset\SpecialChar menuseparator
17646 Endnote
17647 \family default
17648  to insert an endnote and
17649 \family sans
17650 Insert\SpecialChar menuseparator
17651 List/Contents/References\SpecialChar menuseparator
17652 Endnotes
17653 \family default
17654  to insert the endnotes list where you want the endnotes to appear.
17655  See also
17656 \family sans
17657 Help\SpecialChar menuseparator
17658 Embedded\SpecialChar menuseparator
17659  Objects\SpecialChar menuseparator
17660 Notes\SpecialChar menuseparator
17661 Footnotes
17662 \family default
17663 .
17664 \end_layout
17665
17666 \begin_layout Subsection
17667
17668 \change_inserted 564990737 1672081439
17669 Footnotes as Endnotes (Basic)
17670 \end_layout
17671
17672 \begin_layout Standard
17673
17674 \change_inserted 564990737 1672081439
17675 This module sets all footnotes as endnotes.
17676  This uses the
17677 \family sans
17678 endnotes
17679 \family default
17680  package,
17681  which has some limitations but works with older LaTeX distributions as well.
17682  Use
17683 \family sans
17684 Insert\SpecialChar menuseparator
17685 List/Contents/References\SpecialChar menuseparator
17686 Endnotes
17687 \family default
17688  to insert the endnotes list where you want the endnotes to appear.
17689  See also
17690 \family sans
17691 Help\SpecialChar menuseparator
17692 Embedded\SpecialChar menuseparator
17693  Objects\SpecialChar menuseparator
17694 Notes\SpecialChar menuseparator
17695 Footnotes
17696 \family default
17697 .
17698 \end_layout
17699
17700 \begin_layout Subsection
17701
17702 \change_inserted 564990737 1672081439
17703 Footnotes as Endnotes (Extended)
17704 \end_layout
17705
17706 \begin_layout Standard
17707
17708 \change_inserted 564990737 1672081439
17709 This module sets all footnotes as endnotes.
17710  This uses the
17711 \family sans
17712 enotez
17713 \family default
17714  package which is more powerful and customizable than then
17715 \family sans
17716 endnotes
17717 \family default
17718  package,
17719  but requires a fairly modern LaTeX distribution (with LaTeX3).
17720  Use
17721 \family sans
17722 Insert\SpecialChar menuseparator
17723 List/Contents/References\SpecialChar menuseparator
17724 Endnotes
17725 \family default
17726  to insert the endnotes list where you want the endnotes to appear.
17727  See also
17728 \family sans
17729 Help\SpecialChar menuseparator
17730 Embedded\SpecialChar menuseparator
17731  Objects\SpecialChar menuseparator
17732 Notes\SpecialChar menuseparator
17733 Footnotes
17734 \family default
17735 .
17736 \end_layout
17737
17738 \begin_layout Section
17739
17740 \change_inserted 564990737 1672081439
17741 Leisure,
17742  Sports and Music
17743 \end_layout
17744
17745 \begin_layout Subsection
17746
17747 \change_inserted 564990737 1672081439
17748 Chess Board
17749 \end_layout
17750
17751 \begin_layout Standard
17752
17753 \change_inserted 564990737 1672081439
17754 This module provides support for the
17755 \family sans
17756 chessboard
17757 \family default
17758  package to print chess games.
17759  See
17760 \family sans
17761 File\SpecialChar menuseparator
17762 Open Example\SpecialChar menuseparator
17763 Articles\SpecialChar menuseparator
17764 Chess
17765 \family default
17766  where you will find
17767 \family sans
17768 Game 1
17769 \family default
17770  and
17771 \family sans
17772 Game 2
17773 \family default
17774  and the
17775 \begin_inset CommandInset href
17776 LatexCommand href
17777 name "chessboard documentation"
17778 target "http://mirrors.ctan.org/macros/latex/contrib/chessboard/chessboard.pdf"
17779 literal "false"
17780
17781 \end_inset
17782
17783 .
17784 \end_layout
17785
17786 \begin_layout Subsection
17787
17788 \change_inserted 564990737 1672081439
17789 Lilypond Music Notation
17790 \end_layout
17791
17792 \begin_layout Standard
17793
17794 \change_inserted 564990737 1672081439
17795 This module provides an inset via
17796 \family sans
17797 \bar under
17798 I
17799 \bar default
17800 nsert\SpecialChar menuseparator
17801 Custom Inset\SpecialChar menuseparator
17802 Lilypond
17803 \family default
17804  in which to enter code for the LilyPond music editor.
17805  It will then be processed in the output.
17806  See
17807 \family sans
17808 Help\SpecialChar menuseparator
17809 Specific Manuals\SpecialChar menuseparator
17810 Lilypond
17811 \family default
17812  and
17813 \family sans
17814 File\SpecialChar menuseparator
17815 Open Example\SpecialChar menuseparator
17816 Modules\SpecialChar menuseparator
17817 Lilypond Book
17818 \family default
17819 .
17820  It cannot be used if the modules
17821 \family sans
17822 Rnw
17823 \begin_inset space \thinspace{}
17824 \end_inset
17825
17826 (knitr) or Sweave
17827 \family default
17828  have been loaded.
17829 \end_layout
17830
17831 \begin_layout Section
17832
17833 \change_inserted 564990737 1672138150
17834 List enhancements
17835 \end_layout
17836
17837 \begin_layout Subsection
17838
17839 \change_inserted 564990737 1672138150
17840 Customizable Lists
17841 \begin_inset CommandInset label
17842 LatexCommand label
17843 name "subsec:Customizable-Lists"
17844
17845 \end_inset
17846
17847
17848 \end_layout
17849
17850 \begin_layout Standard
17851
17852 \change_inserted 564990737 1672138150
17853 This module uses the
17854 \family sans
17855  enumitem
17856 \family default
17857  package to enable the customization of various list environments.
17858 \end_layout
17859
17860 \begin_layout Subsubsection
17861
17862 \change_inserted 564990737 1672138150
17863 Custom Enumerate Lists
17864 \end_layout
17865
17866 \begin_layout Standard
17867 \noindent
17868
17869 \change_inserted 564990737 1672138150
17870 The default numbering of numbered lists can be changed by adding an optional argument (menu
17871 \family sans
17872 \bar under
17873 I
17874 \bar default
17875 nsert\SpecialChar menuseparator
17876
17877 \bar under
17878 S
17879 \bar default
17880 hort Title
17881 \family default
17882 ) to the first item of each level in the list.
17883  There you add the command
17884 \end_layout
17885
17886 \begin_layout Standard
17887
17888 \change_inserted 564990737 1672138150
17889
17890 \family sans
17891 label=
17892 \backslash
17893 roman{enumi}
17894 \end_layout
17895
17896 \begin_layout Standard
17897
17898 \change_inserted 564990737 1672138150
17899 in \SpecialChar TeX
17900  Code (shortcut
17901 \begin_inset Info
17902 type  "shortcut"
17903 arg   "ert-insert"
17904 \end_inset
17905
17906 ).
17907 \end_layout
17908
17909 \begin_layout Standard
17910
17911 \change_inserted 564990737 1672138150
17912
17913 \family sans
17914 enumi
17915 \family default
17916  is the first level counter of the enumeration.
17917  To change the numbering for the list sublevels,
17918  replace the “
17919 \family sans
17920 i
17921 \family default
17922 ” in the command by the small Roman numeral of the level (
17923 \family sans
17924 enumi
17925 \family default
17926 ,
17927
17928 \family sans
17929 enumii
17930 \family default
17931 ,
17932
17933 \family sans
17934 enumiii
17935 \family default
17936 ,
17937
17938 \family sans
17939 enumiv
17940 \family default
17941 ).
17942 \end_layout
17943
17944 \begin_layout Standard
17945
17946 \change_inserted 564990737 1672138150
17947 The command
17948 \family sans
17949
17950 \backslash
17951 roman
17952 \family default
17953  outputs the counter as a small Roman numeral.
17954  For capital Roman numerals replace
17955 \family sans
17956
17957 \backslash
17958 roman
17959 \family default
17960  with
17961 \family sans
17962
17963 \backslash
17964 Roman
17965 \family default
17966  in the command above.
17967  For Arabic numerals use
17968 \family sans
17969
17970 \backslash
17971 arabic
17972 \family default
17973 .
17974  To
17975 \begin_inset Quotes eld
17976 \end_inset
17977
17978 number
17979 \begin_inset Quotes erd
17980 \end_inset
17981
17982  items with capital or small Latin letters use
17983 \family sans
17984
17985 \backslash
17986 Alph
17987 \family default
17988  or
17989 \family sans
17990
17991 \backslash
17992 alph
17993 \family default
17994 ,
17995  respectively.
17996 \end_layout
17997
17998 \begin_layout Standard
17999 \noindent
18000
18001 \change_inserted 564990737 1672138150
18002 \begin_inset Note Greyedout
18003 status collapsed
18004
18005 \begin_layout Plain Layout
18006
18007 \change_inserted 564990737 1672138150
18008
18009 \series bold
18010 Note:
18011
18012 \series default
18013  You can only number 26
18014 \begin_inset space ~
18015 \end_inset
18016
18017 items with Latin letters,
18018  because this numbering is limited to single letters.
18019 \end_layout
18020
18021 \end_inset
18022
18023
18024 \end_layout
18025
18026 \begin_layout Standard
18027
18028 \change_inserted 564990737 1672138150
18029 Here is a list with custom numbering:
18030 \end_layout
18031
18032 \begin_layout Enumerate
18033
18034 \change_inserted 564990737 1672138150
18035 \begin_inset Argument 1
18036 status collapsed
18037
18038 \begin_layout Plain Layout
18039
18040 \change_inserted 564990737 1672138150
18041 \begin_inset ERT
18042 status collapsed
18043
18044 \begin_layout Plain Layout
18045
18046 \change_inserted 564990737 1672138150
18047
18048 label=
18049 \backslash
18050 #
18051 \backslash
18052 Alph{enumi}
18053 \backslash
18054 #
18055 \end_layout
18056
18057 \end_inset
18058
18059
18060 \change_unchanged
18061
18062 \end_layout
18063
18064 \end_inset
18065
18066 Level 1
18067 \begin_inset Separator latexpar
18068 \end_inset
18069
18070
18071 \end_layout
18072
18073 \begin_deeper
18074 \begin_layout Enumerate
18075
18076 \change_inserted 564990737 1672138150
18077 \begin_inset Argument 1
18078 status collapsed
18079
18080 \begin_layout Plain Layout
18081
18082 \change_inserted 564990737 1672138150
18083 \begin_inset ERT
18084 status collapsed
18085
18086 \begin_layout Plain Layout
18087
18088 \change_inserted 564990737 1672138150
18089
18090 label=
18091 \backslash
18092 Alph{enumi}.
18093 \backslash
18094 arabic{enumii}
18095 \end_layout
18096
18097 \end_inset
18098
18099
18100 \change_unchanged
18101
18102 \end_layout
18103
18104 \end_inset
18105
18106 Level 2
18107 \end_layout
18108
18109 \begin_layout Enumerate
18110
18111 \change_inserted 564990737 1672138150
18112 Level 2
18113 \begin_inset Separator latexpar
18114 \end_inset
18115
18116
18117 \end_layout
18118
18119 \begin_deeper
18120 \begin_layout Enumerate
18121
18122 \change_inserted 564990737 1672138150
18123 \begin_inset Argument 1
18124 status collapsed
18125
18126 \begin_layout Plain Layout
18127
18128 \change_inserted 564990737 1672138150
18129 \begin_inset ERT
18130 status collapsed
18131
18132 \begin_layout Plain Layout
18133
18134 \change_inserted 564990737 1672138150
18135
18136 label=
18137 \change_deleted 274215730 1672889016
18138
18139 \backslash
18140 bf
18141 \change_inserted 274215730 1672889016
18142
18143 \backslash
18144 bfseries
18145 \change_inserted 564990737 1672138150
18146 {
18147 \backslash
18148 arabic{enumiii}}
18149 \end_layout
18150
18151 \end_inset
18152
18153
18154 \change_unchanged
18155
18156 \end_layout
18157
18158 \end_inset
18159
18160 Level 3
18161 \begin_inset Separator latexpar
18162 \end_inset
18163
18164
18165 \end_layout
18166
18167 \begin_deeper
18168 \begin_layout Enumerate
18169
18170 \change_inserted 564990737 1672138150
18171 \begin_inset Argument 1
18172 status collapsed
18173
18174 \begin_layout Plain Layout
18175
18176 \change_inserted 564990737 1672138150
18177 \begin_inset ERT
18178 status collapsed
18179
18180 \begin_layout Plain Layout
18181
18182 \change_inserted 564990737 1672138150
18183
18184 label=
18185 \backslash
18186 emph{
18187 \backslash
18188 roman{enumiv})}
18189 \end_layout
18190
18191 \end_inset
18192
18193
18194 \change_unchanged
18195
18196 \end_layout
18197
18198 \end_inset
18199
18200 Level 4
18201 \end_layout
18202
18203 \end_deeper
18204 \end_deeper
18205 \end_deeper
18206 \begin_layout Standard
18207
18208 \change_inserted 564990737 1672138150
18209 For this list these commands were used:
18210 \end_layout
18211
18212 \begin_layout Standard
18213 \noindent
18214
18215 \change_inserted 564990737 1672138150
18216
18217 \family sans
18218 label=
18219 \backslash
18220 #
18221 \backslash
18222 Alph{enumi}
18223 \backslash
18224 #
18225 \begin_inset Newline newline
18226 \end_inset
18227
18228 label=
18229 \backslash
18230 Alph{enumi}.
18231 \backslash
18232 arabic{enumii}
18233 \begin_inset Newline newline
18234 \end_inset
18235
18236 label=
18237 \change_deleted 274215730 1672889037
18238
18239 \backslash
18240 bf
18241 \change_inserted 274215730 1672889037
18242
18243 \backslash
18244 bfseries
18245 \change_inserted 564990737 1672138150
18246 {
18247 \backslash
18248 arabic{enumiii}}
18249 \begin_inset Newline newline
18250 \end_inset
18251
18252 label=
18253 \backslash
18254 emph{
18255 \backslash
18256 roman{enumiv})}
18257 \end_layout
18258
18259 \begin_layout Standard
18260
18261 \change_inserted 564990737 1672138150
18262 where the command
18263 \family sans
18264
18265 \backslash
18266 emph{}
18267 \family default
18268  makes the label emphasized and
18269 \change_deleted 274215730 1672889045
18270
18271 \family sans
18272
18273 \backslash
18274 bf{}
18275 \change_inserted 274215730 1672889046
18276
18277 \backslash
18278 bfseries{}
18279 \change_inserted 564990737 1672138150
18280
18281 \family default
18282  makes it bold.
18283 \end_layout
18284
18285 \begin_layout Standard
18286
18287 \change_inserted 564990737 1672138150
18288 \begin_inset Note Greyedout
18289 status collapsed
18290
18291 \begin_layout Plain Layout
18292
18293 \change_inserted 564990737 1672138150
18294
18295 \series bold
18296 Note:
18297
18298 \series default
18299  When you change the label of a list level,
18300  it will be used for all following lists until you change the definition.
18301 \end_layout
18302
18303 \end_inset
18304
18305
18306 \end_layout
18307
18308 \begin_layout Standard
18309
18310 \change_inserted 564990737 1672138150
18311 \begin_inset ERT
18312 status open
18313
18314 \begin_layout Plain Layout
18315
18316 \change_inserted 564990737 1672138150
18317
18318
18319 \backslash
18320 renewcommand{
18321 \backslash
18322 labelenumi}{
18323 \backslash
18324 thesection.
18325 \backslash
18326 arabic{enumi}}
18327 \end_layout
18328
18329 \end_inset
18330
18331
18332 \end_layout
18333
18334 \begin_layout Subsubsection
18335
18336 \change_inserted 564990737 1672138150
18337 Numbered Paragraphs in Reports
18338 \end_layout
18339
18340 \begin_layout Enumerate
18341
18342 \change_inserted 564990737 1672138213
18343 Official reports often include numbered paragraphs;
18344  you can achieve this with a variation on the approach outlined in the footnote
18345 \begin_inset space ~
18346 \end_inset
18347
18348
18349 \begin_inset CommandInset ref
18350 LatexCommand ref
18351 reference "fn:If-you-really"
18352 plural "false"
18353 caps "false"
18354 noprefix "false"
18355 nolink "false"
18356
18357 \end_inset
18358
18359 .
18360  Replace
18361 \family sans
18362 item
18363 \family default
18364  in each command with
18365 \family sans
18366 enum
18367 \family default
18368 .
18369 \end_layout
18370
18371 \begin_layout Enumerate
18372
18373 \change_inserted 564990737 1672138150
18374 These numbered paragraphs were generated by inserting the \SpecialChar TeX
18375  Code
18376 \begin_inset Separator latexpar
18377 \end_inset
18378
18379
18380 \end_layout
18381
18382 \begin_deeper
18383 \begin_layout Standard
18384
18385 \change_inserted 564990737 1672138150
18386
18387 \family sans
18388
18389 \backslash
18390 renewcommand{
18391 \backslash
18392 labelenumi}{
18393 \backslash
18394 thesection.
18395 \backslash
18396 arabic{enumi}}
18397 \end_layout
18398
18399 \begin_layout Standard
18400
18401 \change_inserted 564990737 1672138150
18402 before the start of the section;
18403
18404 \family sans
18405
18406 \backslash
18407 thesection
18408 \family default
18409  uses the \SpecialChar LaTeX
18410  section counter to generate the first part of the number.
18411 \end_layout
18412
18413 \end_deeper
18414 \begin_layout Enumerate
18415
18416 \change_inserted 564990737 1672138150
18417 I have ignored the subsection heading in this example because,
18418  with paragraphs numbered in this way,
18419  subsections are less likely to be used.
18420 \end_layout
18421
18422 \begin_layout Subsubsection
18423
18424 \change_inserted 564990737 1672138150
18425 Resumed Enumeration
18426 \end_layout
18427
18428 \begin_layout Standard
18429
18430 \change_inserted 564990737 1672138150
18431 \begin_inset ERT
18432 status open
18433
18434 \begin_layout Plain Layout
18435
18436 \change_inserted 564990737 1672138150
18437
18438
18439 \backslash
18440 renewcommand{
18441 \backslash
18442 labelenumi}{
18443 \backslash
18444 arabic{enumi}}
18445 \end_layout
18446
18447 \end_inset
18448
18449
18450 \end_layout
18451
18452 \begin_layout Standard
18453
18454 \change_inserted 564990737 1672138150
18455 Enumerations can be resumed after intermediate paragraphs:
18456 \end_layout
18457
18458 \begin_layout Enumerate
18459
18460 \change_inserted 564990737 1672138150
18461 \begin_inset Argument 1
18462 status collapsed
18463
18464 \begin_layout Plain Layout
18465
18466 \change_inserted 564990737 1672138150
18467 \begin_inset ERT
18468 status collapsed
18469
18470 \begin_layout Plain Layout
18471
18472 \change_inserted 564990737 1672138150
18473
18474 label=
18475 \backslash
18476 arabic{enumi}.
18477 \end_layout
18478
18479 \end_inset
18480
18481
18482 \change_unchanged
18483
18484 \end_layout
18485
18486 \end_inset
18487
18488 first
18489 \begin_inset Note Note
18490 status collapsed
18491
18492 \begin_layout Plain Layout
18493
18494 \change_inserted 564990737 1672138150
18495 goes back to default numbering
18496 \end_layout
18497
18498 \end_inset
18499
18500
18501 \end_layout
18502
18503 \begin_layout Enumerate
18504
18505 \change_inserted 564990737 1672138150
18506 second
18507 \end_layout
18508
18509 \begin_layout Standard
18510
18511 \change_inserted 564990737 1672138150
18512 regular text
18513 \end_layout
18514
18515 \begin_layout Enumerate-Resume
18516
18517 \change_inserted 564990737 1672138150
18518 resumed
18519 \end_layout
18520
18521 \begin_layout Standard
18522
18523 \change_inserted 564990737 1672138150
18524 To resume an enumeration,
18525  use the style
18526 \family sans
18527 Enumerate-Resume
18528 \family default
18529 .
18530  Its numbering appears in blue within \SpecialChar LyX
18531  to indicate that it is a resumed list and that the numbering will not be correct in \SpecialChar LyX
18532 ,
18533  but in the output.
18534 \end_layout
18535
18536 \begin_layout Standard
18537
18538 \change_inserted 564990737 1672138150
18539 \begin_inset Note Greyedout
18540 status collapsed
18541
18542 \begin_layout Plain Layout
18543
18544 \change_inserted 564990737 1672138150
18545
18546 \series bold
18547 Note:
18548
18549 \series default
18550  If there is no previous enumeration to resume,
18551  you will get a \SpecialChar LaTeX
18552  error.
18553 \end_layout
18554
18555 \end_inset
18556
18557
18558 \end_layout
18559
18560 \begin_layout Standard
18561
18562 \change_inserted 564990737 1672138150
18563 Perhaps you might want to resume the list with a different number from the next one.
18564  Or you want to start a new enumeration with a defined number.
18565  This is possible by adding an optional argument to the first list item of a normal enumeration.
18566  There,
18567  insert the command
18568 \end_layout
18569
18570 \begin_layout Standard
18571
18572 \change_inserted 564990737 1672138150
18573
18574 \family sans
18575 start=number
18576 \end_layout
18577
18578 \begin_layout Standard
18579
18580 \change_inserted 564990737 1672138150
18581 where
18582 \family sans
18583 number
18584 \family default
18585  is the number with which you want to resume the list.
18586  An example:
18587 \end_layout
18588
18589 \begin_layout Enumerate
18590
18591 \change_inserted 564990737 1672138150
18592 first item
18593 \end_layout
18594
18595 \begin_layout Enumerate
18596
18597 \change_inserted 564990737 1672138150
18598 second item
18599 \end_layout
18600
18601 \begin_layout Standard
18602
18603 \change_inserted 564990737 1672138150
18604 Enumeration starting at a given value:
18605 \end_layout
18606
18607 \begin_layout Enumerate
18608
18609 \change_inserted 564990737 1672138150
18610 \begin_inset Argument 1
18611 status open
18612
18613 \begin_layout Plain Layout
18614
18615 \change_inserted 564990737 1672138150
18616 \begin_inset ERT
18617 status collapsed
18618
18619 \begin_layout Plain Layout
18620
18621 \change_inserted 564990737 1672138150
18622
18623 start=4
18624 \end_layout
18625
18626 \end_inset
18627
18628
18629 \change_unchanged
18630
18631 \end_layout
18632
18633 \end_inset
18634
18635 This enumeration starts at 4
18636 \end_layout
18637
18638 \begin_layout Subsubsection
18639
18640 \change_inserted 564990737 1672138150
18641 List Spacing
18642 \begin_inset Index idx
18643 range none
18644 pageformat default
18645 status collapsed
18646
18647 \begin_layout Plain Layout
18648
18649 \change_inserted 564990737 1672138150
18650 Lists !
18651  Spacing
18652 \change_unchanged
18653
18654 \end_layout
18655
18656 \end_inset
18657
18658
18659 \end_layout
18660
18661 \begin_layout Standard
18662
18663 \change_inserted 564990737 1672138150
18664 In some cases you might want less or more vertical space between the items of a list.
18665  For example if the default space is too much in your opinion in this case:
18666 \end_layout
18667
18668 \begin_layout Itemize
18669
18670 \change_inserted 564990737 1672138150
18671 A bullet list
18672 \end_layout
18673
18674 \begin_layout Itemize
18675
18676 \change_inserted 564990737 1672138150
18677 with standard spacing
18678 \end_layout
18679
18680 \begin_layout Standard
18681
18682 \change_inserted 564990737 1672138150
18683 You can decrease the space by adding an optional argument to the first item of the list.
18684  Add there the command
18685 \family sans
18686 nolistsep
18687 \family default
18688  to get no additional list space like in this example:
18689 \end_layout
18690
18691 \begin_layout Itemize
18692
18693 \change_inserted 564990737 1672138150
18694 \begin_inset Argument 1
18695 status open
18696
18697 \begin_layout Plain Layout
18698
18699 \change_inserted 564990737 1672138150
18700 \begin_inset ERT
18701 status collapsed
18702
18703 \begin_layout Plain Layout
18704
18705 \change_inserted 564990737 1672138150
18706
18707 nolistsep
18708 \end_layout
18709
18710 \end_inset
18711
18712
18713 \change_unchanged
18714
18715 \end_layout
18716
18717 \end_inset
18718
18719 A bullet list
18720 \end_layout
18721
18722 \begin_layout Itemize
18723
18724 \change_inserted 564990737 1672138150
18725 without additional
18726 \end_layout
18727
18728 \begin_layout Itemize
18729
18730 \change_inserted 564990737 1672138150
18731 vertical space
18732 \end_layout
18733
18734 \begin_layout Standard
18735
18736 \change_inserted 564990737 1672138150
18737 To add space you can use several other commands provided by the
18738 \family sans
18739 enumitem
18740 \family default
18741
18742 \begin_inset Index idx
18743 range none
18744 pageformat default
18745 status collapsed
18746
18747 \begin_layout Plain Layout
18748
18749 \change_inserted 564990737 1672138150
18750 \SpecialChar LaTeX
18751 -packages !
18752  enumitem
18753 \change_unchanged
18754
18755 \end_layout
18756
18757 \end_inset
18758
18759  package.
18760  For more information see the
18761 \begin_inset CommandInset href
18762 LatexCommand href
18763 name "enumitem documentation"
18764 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
18765 literal "false"
18766
18767 \end_inset
18768
18769 .
18770 \end_layout
18771
18772 \begin_layout Standard
18773
18774 \change_inserted 564990737 1672138150
18775 There are also many commands available to change the horizontal spacing and indentation.
18776  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
18777 \begin_inset space \thinspace{}
18778 \end_inset
18779
18780 cm so that the number is in the page margin:
18781 \end_layout
18782
18783 \begin_layout Enumerate
18784
18785 \change_inserted 564990737 1672138150
18786 \begin_inset Argument 1
18787 status open
18788
18789 \begin_layout Plain Layout
18790
18791 \change_inserted 564990737 1672138150
18792 \begin_inset ERT
18793 status collapsed
18794
18795 \begin_layout Plain Layout
18796
18797 \change_inserted 564990737 1672138150
18798
18799 labelindent=
18800 \backslash
18801 parindent,
18802  labelsep=2cm
18803 \end_layout
18804
18805 \end_inset
18806
18807
18808 \change_unchanged
18809
18810 \end_layout
18811
18812 \end_inset
18813
18814 An enumeration
18815 \end_layout
18816
18817 \begin_layout Enumerate
18818
18819 \change_inserted 564990737 1672138150
18820 with negative indentation
18821 \end_layout
18822
18823 \begin_layout Subsubsection
18824
18825 \change_inserted 564990737 1672138150
18826 Further Customization
18827 \begin_inset Index idx
18828 range none
18829 pageformat default
18830 status collapsed
18831
18832 \begin_layout Plain Layout
18833
18834 \change_inserted 564990737 1672138150
18835 Lists !
18836  Customization
18837 \change_unchanged
18838
18839 \end_layout
18840
18841 \end_inset
18842
18843
18844 \end_layout
18845
18846 \begin_layout Standard
18847
18848 \change_inserted 564990737 1672138150
18849 You can also change the style of description lists.
18850  The command
18851 \end_layout
18852
18853 \begin_layout Standard
18854
18855 \change_inserted 564990737 1672138150
18856
18857 \family sans
18858 font=definition
18859 \end_layout
18860
18861 \begin_layout Standard
18862
18863 \change_inserted 564990737 1672138150
18864 changes the description label font,
18865  the command
18866 \end_layout
18867
18868 \begin_layout Standard
18869
18870 \change_inserted 564990737 1672138150
18871
18872 \family sans
18873 style=definitio
18874 \family default
18875 \series bold
18876 n
18877 \end_layout
18878
18879 \begin_layout Standard
18880
18881 \change_inserted 564990737 1672138150
18882 sets the list style.
18883 \end_layout
18884
18885 \begin_layout Standard
18886
18887 \change_inserted 564990737 1672138150
18888 An example where the command
18889 \end_layout
18890
18891 \begin_layout Standard
18892
18893 \change_inserted 564990737 1672138150
18894
18895 \family sans
18896 font=
18897 \backslash
18898 itshape,
18899  style=nextline
18900 \end_layout
18901
18902 \begin_layout Standard
18903
18904 \change_inserted 564990737 1672138150
18905 is used:
18906 \end_layout
18907
18908 \begin_layout Description
18909
18910 \change_inserted 564990737 1672138150
18911 Ionizing
18912 \begin_inset space ~
18913 \end_inset
18914
18915 radiation:
18916
18917 \begin_inset Argument 1
18918 status collapsed
18919
18920 \begin_layout Plain Layout
18921
18922 \change_inserted 564990737 1672138150
18923 \begin_inset ERT
18924 status collapsed
18925
18926 \begin_layout Plain Layout
18927
18928 \change_inserted 564990737 1672138150
18929
18930 labelindent=0pt,
18931  labelsep=1cm,
18932  font=
18933 \backslash
18934 itshape,
18935  style=nextline
18936 \end_layout
18937
18938 \end_inset
18939
18940
18941 \change_unchanged
18942
18943 \end_layout
18944
18945 \end_inset
18946
18947 Ionizing radiation consists of particles or electromagnetic waves that are energetic enough to detach electrons from atoms or molecules,
18948  therefore ionizing them.
18949 \end_layout
18950
18951 \begin_layout Description
18952
18953 \change_inserted 564990737 1672138150
18954 Reference
18955 \begin_inset space ~
18956 \end_inset
18957
18958 counting:
18959  In computer science,
18960  reference counting is a technique of storing the number of references,
18961  pointers,
18962  or handles to a resource such as an object,
18963  block of memory,
18964  disk space or other resource.
18965 \end_layout
18966
18967 \begin_layout Standard
18968
18969 \change_inserted 564990737 1672138150
18970 There are many more commands and features provided by the
18971 \family sans
18972 enumitem
18973 \family default
18974
18975 \begin_inset Index idx
18976 range none
18977 pageformat default
18978 status collapsed
18979
18980 \begin_layout Plain Layout
18981
18982 \change_inserted 564990737 1672138150
18983 \SpecialChar LaTeX
18984 -packages !
18985  enumitem
18986 \change_unchanged
18987
18988 \end_layout
18989
18990 \end_inset
18991
18992  package.
18993  For more information see the
18994 \begin_inset CommandInset href
18995 LatexCommand href
18996 name "enumitem documentation"
18997 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
18998 literal "false"
18999
19000 \end_inset
19001
19002 .
19003 \end_layout
19004
19005 \begin_layout Subsection
19006
19007 \change_inserted 564990737 1672138150
19008
19009 \series bold
19010 Paragraph Lists
19011 \end_layout
19012
19013 \begin_layout Standard
19014
19015 \change_inserted 564990737 1672138150
19016 This module uses the package
19017 \family sans
19018 paralist
19019 \family default
19020  to provide nine new list environments.
19021  Itemized and enumerated lists can be typeset within paragraphs,
19022  as paragraphs and in a compact version.
19023  Most environments have optional arguments to format the labels.
19024  Additionally,
19025  the \SpecialChar LaTeX
19026  list environments itemize and enumerate are extended to use a similar optional argument.
19027  For further details see
19028 \family sans
19029 File\SpecialChar menuseparator
19030 Open Example\SpecialChar menuseparator
19031 Modules\SpecialChar menuseparator
19032 Paragraph Lists (paralist)
19033 \family default
19034 ,
19035
19036 \family sans
19037 Help\SpecialChar menuseparator
19038 Specific Manuals\SpecialChar menuseparator
19039 Paralist
19040 \family default
19041  and the
19042 \begin_inset CommandInset href
19043 LatexCommand href
19044 name "paralist documentation"
19045 target "http://mirrors.ctan.org/macros/latex/contrib/paralist/paralist.pdf"
19046 literal "false"
19047
19048 \end_inset
19049
19050 .
19051 \end_layout
19052
19053 \begin_layout Section
19054
19055 \change_inserted 564990737 1672161542
19056 Literate Programming
19057 \end_layout
19058
19059 \begin_layout Subsection
19060
19061 \change_inserted 564990737 1672161542
19062 Noweb
19063 \end_layout
19064
19065 \begin_layout Standard
19066
19067 \change_inserted 564990737 1672161542
19068 This module allows the use of Noweb as a literate programming tool.
19069  The files and the documentation for Noweb can be obtained from
19070 \begin_inset CommandInset href
19071 LatexCommand href
19072 name "CTAN"
19073 target "https://www.ctan.org/pkg/noweb"
19074 literal "false"
19075
19076 \end_inset
19077
19078 .
19079  Literate programming is described in section
19080 \begin_inset space ~
19081 \end_inset
19082
19083
19084 \begin_inset CommandInset ref
19085 LatexCommand ref
19086 reference "sec:Literate-Programming"
19087 nolink "false"
19088
19089 \end_inset
19090
19091  and there are three example files:
19092
19093 \family sans
19094 File\SpecialChar menuseparator
19095 Open Example\SpecialChar menuseparator
19096 Modules\SpecialChar menuseparator
19097 Noweb
19098 \family default
19099 ,
19100
19101 \family sans
19102 File\SpecialChar menuseparator
19103 Open Example\SpecialChar menuseparator
19104 Modules\SpecialChar menuseparator
19105 Noweb Listerrors
19106 \family default
19107  and
19108 \family sans
19109 File\SpecialChar menuseparator
19110 Open Example\SpecialChar menuseparator
19111 Modules\SpecialChar menuseparator
19112 Noweb2\SpecialChar LyX
19113
19114 \family default
19115 .
19116 \end_layout
19117
19118 \begin_layout Subsection
19119
19120 \change_inserted 564990737 1672161542
19121 Rnw (knitr)
19122 \end_layout
19123
19124 \begin_layout Standard
19125
19126 \change_inserted 564990737 1672161542
19127 This module uses the
19128 \family typewriter
19129 knitr
19130 \family default
19131  and
19132 \family sans
19133 includernw
19134 \family default
19135  packages.
19136  The
19137 \begin_inset Flex Code
19138 status collapsed
19139
19140 \begin_layout Plain Layout
19141
19142 \change_inserted 564990737 1672161542
19143 knitr
19144 \change_unchanged
19145
19146 \end_layout
19147
19148 \end_inset
19149
19150  package in R for dynamic report generation has to be installed for this module to work:
19151
19152 \begin_inset Flex Code
19153 status collapsed
19154
19155 \begin_layout Plain Layout
19156
19157 \change_inserted 564990737 1672161542
19158 install.packages(“knitr”)
19159 \change_unchanged
19160
19161 \end_layout
19162
19163 \end_inset
19164
19165 .
19166
19167 \end_layout
19168
19169 \begin_layout Paragraph
19170
19171 \change_inserted 564990737 1672161542
19172 Note
19173 \end_layout
19174
19175 \begin_layout Standard
19176
19177 \change_inserted 564990737 1672161542
19178 it depends on R >= 2.14.1.
19179  For more info see
19180 \begin_inset Flex URL
19181 status collapsed
19182
19183 \begin_layout Plain Layout
19184
19185 \change_inserted 564990737 1672161542
19186
19187 http://yihui.name/knitr
19188 \change_unchanged
19189
19190 \end_layout
19191
19192 \end_inset
19193
19194 .
19195
19196 \end_layout
19197
19198 \begin_layout Standard
19199
19200 \change_inserted 564990737 1672161542
19201 The package
19202 \family sans
19203 includernw
19204 \family default
19205  also has to be installed.
19206  It cannot be used if the modules
19207 \family sans
19208 LilyPond
19209 \begin_inset space ~
19210 \end_inset
19211
19212 Book
19213 \family default
19214  or
19215 \family sans
19216 Sweave
19217 \family default
19218  are loaded.
19219  See
19220 \family sans
19221 Help\SpecialChar menuseparator
19222 Specific Manuals\SpecialChar menuseparator
19223 Knitr
19224 \family default
19225 ,
19226
19227 \family sans
19228 File\SpecialChar menuseparator
19229 Open Example\SpecialChar menuseparator
19230 Modules\SpecialChar menuseparator
19231 Rnw (knitr)
19232 \family default
19233  and section
19234 \begin_inset space ~
19235 \end_inset
19236
19237
19238 \begin_inset CommandInset ref
19239 LatexCommand ref
19240 reference "sec:Literate-Programming"
19241 nolink "false"
19242
19243 \end_inset
19244
19245  for information about literate programming.
19246 \end_layout
19247
19248 \begin_layout Subsection
19249
19250 \change_inserted 564990737 1672161542
19251 Sweave
19252 \end_layout
19253
19254 \begin_layout Standard
19255
19256 \change_inserted 564990737 1672161542
19257 This module allows the use of the statistical language S/R as a literate programming tool.
19258  It requires the
19259 \family sans
19260 includernw
19261 \family default
19262  and
19263 \family sans
19264 fancyvrb
19265 \family default
19266  packages.
19267  Both
19268 \begin_inset CommandInset href
19269 LatexCommand href
19270 name "includernw"
19271 target "https://www.ctan.org/pkg/includernw"
19272 literal "false"
19273
19274 \end_inset
19275
19276  and
19277 \begin_inset CommandInset href
19278 LatexCommand href
19279 name "fancyvrb"
19280 target "https://www.ctan.org/pkg/fancyvrb"
19281 literal "false"
19282
19283 \end_inset
19284
19285  are available from CTAN.
19286  It cannot be used if the module
19287 \family sans
19288 LilyPond
19289 \begin_inset space ~
19290 \end_inset
19291
19292 Book
19293 \family default
19294  has been loaded.
19295  See
19296 \family sans
19297 Help\SpecialChar menuseparator
19298 Specific Manuals\SpecialChar menuseparator
19299 Sweave,
19300
19301 \family default
19302
19303 \family sans
19304 File\SpecialChar menuseparator
19305 Open Example\SpecialChar menuseparator
19306 Modules\SpecialChar menuseparator
19307 Sweave
19308 \family default
19309  and section
19310 \begin_inset space ~
19311 \end_inset
19312
19313
19314 \begin_inset CommandInset ref
19315 LatexCommand ref
19316 reference "sec:Literate-Programming"
19317 nolink "false"
19318
19319 \end_inset
19320
19321  for information about literate programming.
19322 \end_layout
19323
19324 \begin_layout Section
19325
19326 \change_inserted 564990737 1672224959
19327 Maths
19328 \end_layout
19329
19330 \begin_layout Subsection
19331
19332 \change_inserted 564990737 1672224959
19333 AMS Theorems
19334 \end_layout
19335
19336 \begin_layout Standard
19337
19338 \change_inserted 564990737 1672224959
19339 This modules defines theorem environments and the proof environment using the extended AMS machinery.
19340  Both numbered and unnumbered types are provided.
19341  By default,
19342  the theorems are numbered consecutively throughout the document.
19343  This can be changed by loading one of the
19344 \family sans
19345 AMS Theorems (Numbered by \SpecialChar ldots
19346 )
19347 \family default
19348  modules.
19349  It cannot be used if the modules
19350 \family sans
19351 Standard Theorems
19352 \family default
19353  or
19354 \family sans
19355 Standard Theorems (Unnumbered)
19356 \family default
19357  have been loaded.
19358 \end_layout
19359
19360 \begin_layout Subsection
19361
19362 \change_inserted 564990737 1672224959
19363 AMS Theorems (Extended)
19364 \end_layout
19365
19366 \begin_layout Standard
19367
19368 \change_inserted 564990737 1672224959
19369 This module defines some additional theorem environments for use with the
19370 \family sans
19371 AMS Theorems
19372 \family default
19373  package (which must be loaded).
19374  It includes Criterion,
19375  Algorithm,
19376  Axiom,
19377  Condition,
19378  Note,
19379  Notation,
19380  Summary,
19381  Acknowledgement,
19382  Conclusion,
19383  Fact,
19384  Assumption,
19385  Case and Question in both numbered and unnumbered forms.
19386 \end_layout
19387
19388 \begin_layout Subsection
19389
19390 \change_inserted 564990737 1672224959
19391 AMS Theorems (Extended,
19392  Numbered by Type within Chapters)
19393 \end_layout
19394
19395 \begin_layout Standard
19396
19397 \change_inserted 564990737 1672224959
19398 This module defines some additional theorem environments for use with the
19399 \family sans
19400 AMS Theorems (Numbered by Type within Chapters)
19401 \family default
19402  package (which must be loaded).
19403  It includes Criterion,
19404  Algorithm,
19405  Axiom,
19406  Condition,
19407  Note,
19408  Notation,
19409  Summary,
19410  Acknowledgement,
19411  Conclusion,
19412  Assumption and Case in both numbered and unnumbered forms.
19413  Unlike the
19414 \family sans
19415 AMS Theorems (Extended)
19416 \family default
19417  module,
19418  the different theorem types provided here each have a separate counter,
19419  restarted with each new chapter (e.g.,
19420  criterion 1.1,
19421  criterion 1.2,
19422  axiom 1.1,
19423  assumption 1.1,
19424  criterion 2.1,
19425  criterion 2.2,
19426  axiom 2.1\SpecialChar ldots
19427 ,
19428  as opposed to criterion 1,
19429  criterion 2,
19430  axiom 3,
19431  assumption 4...).
19432 \end_layout
19433
19434 \begin_layout Subsection
19435
19436 \change_inserted 564990737 1672224959
19437 AMS Theorems (Extended,
19438  Numbered by Type)
19439 \end_layout
19440
19441 \begin_layout Standard
19442
19443 \change_inserted 564990737 1672224959
19444 This module defines some additional theorem environments for use with the
19445 \family sans
19446 AMS Theorems (Numbered by Type)
19447 \family default
19448  package (which must be loaded).
19449  It includes Criterion,
19450  Algorithm,
19451  Axiom,
19452  Condition,
19453  Note,
19454  Notation,
19455  Summary,
19456  Acknowledgement,
19457  Conclusion,
19458  Assumption and Case in both numbered and unnumbered forms.
19459  Unlike the
19460 \family sans
19461 AMS Theorems (Extended)
19462 \family default
19463  module,
19464  the different theorem types provided here each have a separate counter (e.g.,
19465  criterion 1,
19466  criterion 2,
19467  axiom 1,
19468  assumption 1,
19469  criterion 3,
19470  \SpecialChar ldots
19471 ,
19472  as opposed to criterion 1,
19473  criterion 2,
19474  axiom 3,
19475  assumption 4,
19476  \SpecialChar ldots
19477 ).
19478 \end_layout
19479
19480 \begin_layout Subsection
19481
19482 \change_inserted 564990737 1672224959
19483 AMS Theorems (Numbered by Type within Chapters)
19484 \end_layout
19485
19486 \begin_layout Standard
19487
19488 \change_inserted 564990737 1672224959
19489 This module defines theorem environments and the proof environment using the extended AMS machinery.
19490  Both numbered and unnumbered types are provided.
19491  Unlike the
19492 \family sans
19493 AMS Theorems
19494 \family default
19495  module,
19496  the different theorem types provided here each have a separate counter (e.g.,
19497  theorem 1.1,
19498  theorem 1.2,
19499  lemma 1.1,
19500  proposition 1.1,
19501  theorem 1.3,
19502  lemma 1.2,
19503  \SpecialChar ldots
19504 ,
19505  as opposed to theorem 1,
19506  theorem 2,
19507  lemma 3,
19508  proposition 4,
19509  \SpecialChar ldots
19510 ).
19511  The numbering restarts for each chapter:
19512  theorem 1.1,
19513  theorem 2.1,
19514  \SpecialChar ldots
19515  It cannot be used if the modules
19516 \family sans
19517 AMS Theorems
19518 \family default
19519 ,
19520
19521 \family sans
19522 Standard Theorems
19523 \family default
19524 ,
19525
19526 \family sans
19527  Standard Theorems (Numbered by Type)
19528 \family default
19529  or
19530 \family sans
19531  Standard Theorems (Unnumbered)
19532 \family default
19533  have been loaded.
19534 \end_layout
19535
19536 \begin_layout Subsection
19537
19538 \change_inserted 564990737 1672224959
19539 AMS Theorems (Numbered by Type)
19540 \end_layout
19541
19542 \begin_layout Standard
19543
19544 \change_inserted 564990737 1672224959
19545 This module defines theorem environments and the proof environment using the extended AMS machinery.
19546  Both numbered and unnumbered types are provided.
19547  Unlike the
19548 \family sans
19549 AMS Theorems
19550 \family default
19551  module,
19552  the different theorem types provided here each have a separate counter (e.g.,
19553  theorem 1,
19554  theorem 2,
19555  lemma 1,
19556  proposition 1,
19557  theorem 3,
19558  lemma 2,
19559  \SpecialChar ldots
19560 ,
19561  as opposed to theorem 1,
19562  theorem 2,
19563  lemma 3,
19564  proposition 4,
19565  \SpecialChar ldots
19566 ).
19567  The numbering’s scope is the whole document.
19568  For chapter- and section-wide numbering,
19569  use one of the ‘within Sections’/‘within Chapters’ modules,
19570  respectively.
19571  It cannot be used if the modules
19572 \family sans
19573 AMS Theorems
19574 \family default
19575 ,
19576
19577 \family sans
19578 Standard Theorems
19579 \family default
19580 ,
19581
19582 \family sans
19583  Standard Theorems (Numbered by Type)
19584 \family default
19585  or
19586 \family sans
19587  Standard Theorems (Unnumbered)
19588 \family default
19589  have been loaded.
19590 \end_layout
19591
19592 \begin_layout Subsection
19593
19594 \change_inserted 564990737 1672224959
19595 Number Equations by Section
19596 \end_layout
19597
19598 \begin_layout Standard
19599
19600 \change_inserted 564990737 1672224959
19601 This module resets the equation number at section start and prepends the section number to the equation number,
19602  as in “(2.1).”
19603 \end_layout
19604
19605 \begin_layout Subsection
19606
19607 \change_inserted 564990737 1672224959
19608 Standard Theorems
19609 \end_layout
19610
19611 \begin_layout Standard
19612
19613 \change_inserted 564990737 1672224959
19614 This module defines some theorem environments for use with non-AMS classes.
19615  By default,
19616  the theorems are numbered consecutively throughout the document.
19617  This can be changed by loading one of the
19618 \family sans
19619 Standard Theorems (Numbered by \SpecialChar ldots
19620 )
19621 \family default
19622  modules.
19623  It cannot be used if the modules
19624 \family sans
19625 AMS Theorems
19626 \family default
19627  or
19628 \family sans
19629  Standard Theorems (Unnumbered)
19630 \family default
19631  have been loaded.
19632
19633 \end_layout
19634
19635 \begin_layout Subsection
19636
19637 \change_inserted 564990737 1672224959
19638 Standard Theorems (Nameable)
19639 \end_layout
19640
19641 \begin_layout Standard
19642
19643 \change_inserted 564990737 1672224959
19644 This module facilitates the use of named theorems.
19645  The name of the theorem goes into the “Additional Theorem Text” argument.
19646
19647 \end_layout
19648
19649 \begin_layout Subsection
19650
19651 \change_inserted 564990737 1672224959
19652 Standard Theorems (Numbered by Chapter)
19653 \end_layout
19654
19655 \begin_layout Standard
19656
19657 \change_inserted 564990737 1672224959
19658 This module numbers theorems and the like by chapter (i.e.,
19659  the counter is reset at each chapter start).
19660  Use this module only with document classes that provide a chapter environment.
19661  One of the modules
19662 \family sans
19663 AMS Theorems
19664 \family default
19665  or
19666 \family sans
19667 Standard Theorems
19668 \family default
19669  must be loaded.
19670  It cannot be used if the module
19671 \family sans
19672  Standard Theorems (Numbered by Section)
19673 \family default
19674  has been loaded.
19675 \end_layout
19676
19677 \begin_layout Subsection
19678
19679 \change_inserted 564990737 1672224959
19680 Standard Theorems (Numbered by Section)
19681 \end_layout
19682
19683 \begin_layout Standard
19684
19685 \change_inserted 564990737 1672224959
19686 This module numbers theorems and the like by section (i.e.,
19687  the counter is reset at each section start).
19688  One of the modules
19689 \family sans
19690 AMS Theorems
19691 \family default
19692  or
19693 \family sans
19694 Standard Theorems
19695 \family default
19696  must be loaded.
19697  It cannot be used if the module
19698 \family sans
19699  Standard Theorems (Numbered by Chapter)
19700 \family default
19701  has been loaded.
19702 \end_layout
19703
19704 \begin_layout Subsection
19705
19706 \change_inserted 564990737 1672224959
19707 Standard Theorems (Numbered by Type within Chapters)
19708 \end_layout
19709
19710 \begin_layout Standard
19711
19712 \change_inserted 564990737 1672224959
19713 This module defines some theorem environments for use with non-AMS classes.
19714  Unlike the
19715 \family sans
19716  AMS Theorems
19717 \family default
19718  and
19719 \family sans
19720 Standard Theorems
19721 \family default
19722  modules,
19723  the different theorem types provided here each have a separate counter (e.g.,
19724  theorem 1,
19725  theorem 2,
19726  lemma 1,
19727  proposition 1,
19728  theorem 3,
19729  lemma 2,
19730  \SpecialChar ldots
19731 ,
19732  as opposed to theorem 1,
19733  theorem 2,
19734  lemma 3,
19735  proposition 4,
19736  \SpecialChar ldots
19737 ).
19738  The numbering is reset at each chapter start.
19739  One of the modules
19740 \family sans
19741 AMS Theorems (Numbered by Type)
19742 \family default
19743  or
19744 \family sans
19745 Standard Theorems (Numbered by Type)
19746 \family default
19747  must be loaded.
19748  It cannot be used if any of the modules
19749 \family sans
19750  AMS Theorems
19751 \family default
19752 ,
19753
19754 \family sans
19755 Standard Theorems
19756 \family default
19757 ,
19758
19759 \family sans
19760 Standard Theorems (Unnumbered)
19761 \family default
19762 ,
19763
19764 \family sans
19765  Standard Theorems (Numbered by Sections)
19766 \family default
19767  or
19768 \family sans
19769 Standard Theorems (Numbered by Type within Sections)
19770 \family default
19771  have been loaded.
19772 \end_layout
19773
19774 \begin_layout Subsection
19775
19776 \change_inserted 564990737 1672224959
19777 Standard Theorems (Numbered by Type within Sections)
19778 \end_layout
19779
19780 \begin_layout Standard
19781
19782 \change_inserted 564990737 1672224959
19783 This module defines some theorem environments for use with non-AMS classes.
19784  Unlike the
19785 \family sans
19786  AMS Theorems
19787 \family default
19788  and
19789 \family sans
19790 Standard Theorems
19791 \family default
19792  modules,
19793  the different theorem types provided here each have a separate counter (e.g.,
19794  theorem 1,
19795  theorem 2,
19796  lemma 1,
19797  proposition 1,
19798  theorem 3,
19799  lemma 2,
19800  \SpecialChar ldots
19801 ,
19802  as opposed to theorem 1,
19803  theorem 2,
19804  lemma 3,
19805  proposition 4,
19806  \SpecialChar ldots
19807 ).
19808  The numbering is reset at each section start.
19809  One of the modules
19810 \family sans
19811 AMS Theorems (Numbered by Type)
19812 \family default
19813  or
19814 \family sans
19815 Standard Theorems (Numbered by Type)
19816 \family default
19817  must be loaded.
19818  It cannot be used if any of the modules
19819 \family sans
19820  AMS Theorems
19821 \family default
19822 ,
19823
19824 \family sans
19825 Standard Theorems
19826 \family default
19827 ,
19828
19829 \family sans
19830 Standard Theorems (Unnumbered)
19831 \family default
19832 ,
19833
19834 \family sans
19835  Standard Theorems (Numbered by Chapters)
19836 \family default
19837  or
19838 \family sans
19839 Standard Theorems (Numbered by Type within Chapters)
19840 \family default
19841  have been loaded.
19842 \end_layout
19843
19844 \begin_layout Subsection
19845
19846 \change_inserted 564990737 1672224959
19847 Standard Theorems (Numbered by Type)
19848 \end_layout
19849
19850 \begin_layout Standard
19851
19852 \change_inserted 564990737 1672224959
19853 This module defines some theorem environments for use with non-AMS classes.
19854  Unlike the
19855 \family sans
19856 AMS Theorems
19857 \family default
19858  and
19859 \family sans
19860 Standard Theorems
19861 \family default
19862  modules,
19863  the different theorem types provided here each have a separate counter (e.g.,
19864  theorem 1,
19865  theorem 2,
19866  lemma 1,
19867  proposition 1,
19868  theorem 3,
19869  lemma 2,
19870  \SpecialChar ldots
19871 ,
19872  as opposed to theorem 1,
19873  theorem 2,
19874  lemma 3,
19875  proposition 4,
19876  \SpecialChar ldots
19877 ).
19878  The numbering’s scope is the whole document.
19879  For chapter- and section-wide numbering,
19880  use one of the “within Chapters”/“within Sections” modules,
19881  respectively.
19882  It cannot be used if any of the modules
19883 \family sans
19884  AMS Theorems
19885 \family default
19886 ,
19887
19888 \family sans
19889 Standard Theorems
19890 \family default
19891 ,
19892
19893 \family sans
19894 Standard Theorems (Unnumbered)
19895 \family default
19896  or
19897 \family sans
19898  AMS Theorems (Numbered by Type)
19899 \family default
19900  have been loaded.
19901 \end_layout
19902
19903 \begin_layout Subsection
19904
19905 \change_inserted 564990737 1672224959
19906 Standard Theorems (Unnumbered)
19907 \end_layout
19908
19909 \begin_layout Standard
19910
19911 \change_inserted 564990737 1672224959
19912 This module defines only unnumbered theorem environments and the proof environment,
19913  using the extended AMS machinery.
19914  It cannot be used if either of the modules
19915 \family sans
19916  AMS Theorems
19917 \family default
19918  or
19919 \family sans
19920  Standard Theorems
19921 \family default
19922  have been loaded.
19923 \end_layout
19924
19925 \begin_layout Subsection
19926
19927 \change_inserted 564990737 1672224959
19928 Subequations
19929 \end_layout
19930
19931 \begin_layout Standard
19932
19933 \change_inserted 564990737 1672224959
19934 This module provides a straightforward way to segregate subequations in LyX.
19935  See
19936 \family sans
19937 Help\SpecialChar menuseparator
19938 Math\SpecialChar menuseparator
19939 Subnumbering
19940 \family default
19941 .
19942
19943 \end_layout
19944
19945 \begin_layout Section
19946
19947 \change_inserted 564990737 1672236008
19948 Page Layout
19949 \end_layout
19950
19951 \begin_layout Subsection
19952
19953 \change_inserted 564990737 1672236008
19954 Custom Header/Footer Text
19955 \end_layout
19956
19957 \begin_layout Standard
19958
19959 \change_inserted 564990737 1672236008
19960 This module requires the
19961 \family sans
19962 Page
19963 \begin_inset space ~
19964 \end_inset
19965
19966
19967 \bar under
19968 s
19969 \bar default
19970 tyle
19971 \family default
19972  option in the
19973 \family sans
19974 \bar under
19975 D
19976 \bar default
19977 ocument\SpecialChar menuseparator
19978
19979 \bar under
19980 S
19981 \bar default
19982 ettings\SpecialChar menuseparator
19983 Page
19984 \begin_inset space ~
19985 \end_inset
19986
19987 Layout
19988 \family default
19989  dialog to be set to
19990 \family typewriter
19991 fancy
19992 \family default
19993 .
19994  It adds six environments to document classes which support the
19995 \family typewriter
19996 fancyhdr
19997 \family default
19998  package:
19999 \end_layout
20000
20001 \begin_layout Itemize
20002
20003 \change_inserted 564990737 1672236008
20004
20005 \family sans
20006 Left Header
20007 \end_layout
20008
20009 \begin_layout Itemize
20010
20011 \change_inserted 564990737 1672236008
20012
20013 \family sans
20014 Center Header
20015 \end_layout
20016
20017 \begin_layout Itemize
20018
20019 \change_inserted 564990737 1672236008
20020
20021 \family sans
20022 Right Header
20023 \end_layout
20024
20025 \begin_layout Itemize
20026
20027 \change_inserted 564990737 1672236008
20028
20029 \family sans
20030 Left Footer
20031 \end_layout
20032
20033 \begin_layout Itemize
20034
20035 \change_inserted 564990737 1672236008
20036
20037 \family sans
20038 Center Footer
20039 \end_layout
20040
20041 \begin_layout Itemize
20042
20043 \change_inserted 564990737 1672236008
20044
20045 \family sans
20046 Right Footer
20047 \end_layout
20048
20049 \begin_layout Subsubsection
20050
20051 \change_inserted 564990737 1672236008
20052 Fancy Headers and Footers
20053 \end_layout
20054
20055 \begin_layout Standard
20056
20057 \change_inserted 564990737 1672236008
20058 The default page layout is rather plain;
20059  for an
20060 \begin_inset Flex Code
20061 status collapsed
20062
20063 \begin_layout Plain Layout
20064
20065 \change_inserted 564990737 1672236008
20066 article
20067 \change_unchanged
20068
20069 \end_layout
20070
20071 \end_inset
20072
20073  document class,
20074  all you get is a centered page number at the bottom of the page.
20075  This document uses KOMA-script’s book class;
20076  so it appears to be a bit fancier.
20077  Once the
20078 \family sans
20079 Page
20080 \begin_inset space ~
20081 \end_inset
20082
20083
20084 \bar under
20085 s
20086 \bar default
20087 tyle
20088 \family default
20089  in
20090 \family sans
20091 \bar under
20092 D
20093 \bar default
20094 ocument\SpecialChar menuseparator
20095
20096 \bar under
20097 S
20098 \bar default
20099 ettings\SpecialChar menuseparator
20100 Page Layout
20101 \family default
20102  is set to
20103 \begin_inset Quotes eld
20104 \end_inset
20105
20106 fancy
20107 \begin_inset Quotes erd
20108 \end_inset
20109
20110 ,
20111  you will find that the page header is divided into three fields,
20112  not surprisingly labeled
20113 \begin_inset Quotes eld
20114 \end_inset
20115
20116 left
20117 \begin_inset Quotes erd
20118 \end_inset
20119
20120 ,
20121
20122 \begin_inset Quotes eld
20123 \end_inset
20124
20125 center
20126 \begin_inset Quotes erd
20127 \end_inset
20128
20129 ,
20130  and
20131 \begin_inset Quotes eld
20132 \end_inset
20133
20134 right
20135 \begin_inset Quotes erd
20136 \end_inset
20137
20138 .
20139  The footer is also divided into these three fields.
20140  The \SpecialChar LaTeX
20141  commands to set these fields in the simplest manner are
20142 \family sans
20143
20144 \backslash
20145 lhead
20146 \family default
20147 ,
20148
20149 \family sans
20150
20151 \backslash
20152 chead
20153 \family default
20154 ,
20155
20156 \family sans
20157
20158 \backslash
20159 rhead
20160 \family default
20161 ,
20162
20163 \family sans
20164
20165 \backslash
20166 lfoot
20167 \family default
20168 ,
20169  etc.
20170  Suppose you wish to put your name in the upper left hand corner of each page.
20171  Simply insert the following command in the preamble:
20172
20173 \end_layout
20174
20175 \begin_layout Standard
20176
20177 \change_inserted 564990737 1672236008
20178
20179 \family sans
20180
20181 \backslash
20182 lhead
20183 \family default
20184 \series bold
20185 {
20186 \series default
20187 John Q.
20188  DocWriter
20189 \series bold
20190 }
20191 \end_layout
20192
20193 \begin_layout Standard
20194
20195 \change_inserted 564990737 1672236008
20196 You will now see your name in the upper left.
20197  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,
20198  e.
20199 \begin_inset space \thinspace{}
20200 \end_inset
20201
20202 g.:
20203 \end_layout
20204
20205 \begin_layout Standard
20206
20207 \change_inserted 564990737 1672236008
20208
20209 \family sans
20210
20211 \backslash
20212 cfoot{}
20213 \end_layout
20214
20215 \begin_layout Standard
20216
20217 \change_inserted 564990737 1672236008
20218 There is,
20219  however,
20220  an easier way to make simple changes.
20221  If you load the
20222 \family sans
20223 \bar under
20224 D
20225 \bar default
20226 ocument\SpecialChar menuseparator
20227
20228 \bar under
20229 S
20230 \bar default
20231 ettings\SpecialChar menuseparator
20232 Modules\SpecialChar menuseparator
20233 Page Layout\SpecialChar menuseparator
20234 Custom Header/Footer Text
20235 \family default
20236  module,
20237  you will find you have six new environments corresponding to the six fields described above.
20238 \end_layout
20239
20240 \begin_layout Standard
20241
20242 \change_inserted 564990737 1672236008
20243 Let's get really fancy:
20244  lets put the section number with the word
20245 \begin_inset Quotes eld
20246 \end_inset
20247
20248 Section
20249 \begin_inset Quotes erd
20250 \end_inset
20251
20252  (e.
20253 \begin_inset space \thinspace{}
20254 \end_inset
20255
20256 g.
20257 \begin_inset space \space{}
20258 \end_inset
20259
20260 Section 3) in the upper left,
20261  the page number (e.
20262 \begin_inset space \thinspace{}
20263 \end_inset
20264
20265 g.
20266 \begin_inset space \space{}
20267 \end_inset
20268
20269 Page 4) in the upper right,
20270  your name in the lower left,
20271  and the date in the lower right.
20272  Use your newly enabled environments to add these entries:
20273 \end_layout
20274
20275 \begin_layout Standard
20276
20277 \change_inserted 564990737 1672236008
20278 \begin_inset VSpace defskip
20279 \end_inset
20280
20281
20282 \end_layout
20283
20284 \begin_layout Standard
20285
20286 \change_inserted 564990737 1672236008
20287
20288 \color green
20289 Left
20290 \begin_inset space ~
20291 \end_inset
20292
20293 header:
20294
20295 \series bold
20296 \color inherit
20297
20298 \series default
20299 Section
20300 \family typewriter
20301
20302 \family sans
20303
20304 \backslash
20305 thesection
20306 \end_layout
20307
20308 \begin_layout Standard
20309
20310 \change_inserted 564990737 1672236008
20311
20312 \color green
20313 Center header:
20314 \end_layout
20315
20316 \begin_layout Standard
20317
20318 \change_inserted 564990737 1672236008
20319
20320 \color green
20321 Right header:
20322
20323 \color inherit
20324  Page
20325 \family typewriter
20326
20327 \family sans
20328
20329 \backslash
20330 thepage
20331 \end_layout
20332
20333 \begin_layout Standard
20334
20335 \change_inserted 564990737 1672236008
20336
20337 \color green
20338 Left footer:
20339
20340 \color inherit
20341  John Q.
20342  DocWriter
20343 \end_layout
20344
20345 \begin_layout Standard
20346
20347 \change_inserted 564990737 1672236008
20348
20349 \color green
20350 Center footer:
20351 \end_layout
20352
20353 \begin_layout Standard
20354
20355 \change_inserted 564990737 1672236008
20356
20357 \color green
20358 Right footer:
20359
20360 \series bold
20361 \color inherit
20362
20363 \family sans
20364 \series default
20365
20366 \backslash
20367 today
20368 \end_layout
20369
20370 \begin_layout Standard
20371
20372 \change_inserted 564990737 1672236008
20373 \begin_inset VSpace defskip
20374 \end_inset
20375
20376
20377 \end_layout
20378
20379 \begin_layout Standard
20380
20381 \change_inserted 564990737 1672236008
20382 Make sure you enter the commands
20383 \family sans
20384
20385 \backslash
20386 thesection
20387 \family default
20388 ,
20389
20390 \family sans
20391
20392 \backslash
20393 thepage
20394 \family default
20395  and
20396 \family sans
20397
20398 \backslash
20399 today
20400 \family default
20401  as \SpecialChar TeX
20402  Code commands
20403 \series bold
20404 .
20405
20406 \series default
20407  The commands
20408 \family sans
20409
20410 \backslash
20411 thesection
20412 \family default
20413  and
20414 \family sans
20415
20416 \backslash
20417 thepage
20418 \family default
20419  access \SpecialChar LaTeX
20420 ’s section and page counters,
20421  and so print out the current section and page numbers.
20422
20423 \family sans
20424
20425 \backslash
20426 today
20427 \family default
20428  simply prints out today’s date.
20429 \end_layout
20430
20431 \begin_layout Standard
20432
20433 \change_inserted 564990737 1672236008
20434 The thicknesses of the horizontal rules drawn beneath the header and above the footer can also be modified.
20435  If you don't want one of the rules,
20436  set its thickness to 0.
20437  The header rule has a default thickness of 0.4pt,
20438  the footer rule is 0pt.
20439  For this you will need to use \SpecialChar TeX
20440  Code commands like
20441 \end_layout
20442
20443 \begin_layout Standard
20444
20445 \change_inserted 564990737 1672236008
20446
20447 \family sans
20448
20449 \backslash
20450 renewcommand{
20451 \backslash
20452 headrulewidth}{0.4pt}
20453 \family default
20454  and
20455 \end_layout
20456
20457 \begin_layout Standard
20458
20459 \change_inserted 564990737 1672236008
20460
20461 \family sans
20462
20463 \backslash
20464 renewcommand{
20465 \backslash
20466 footrulewidth}{0.4pt}
20467 \family default
20468  to set the thicknesses.
20469 \end_layout
20470
20471 \begin_layout Standard
20472
20473 \change_inserted 564990737 1672236008
20474 You can switch the header/footer settings on and off for individual pages using \SpecialChar TeX
20475  Code commands like
20476 \family sans
20477
20478 \backslash
20479 thispagestyle{empty}
20480 \family default
20481 ,
20482
20483 \family sans
20484
20485 \backslash
20486 thispagestyle{plain}
20487 \family default
20488 ,
20489  and
20490 \family sans
20491
20492 \backslash
20493 thispagestyle{fancy}
20494 \family default
20495 .
20496  Simply insert them in the text on the page you want changed and mark them as \SpecialChar TeX
20497  code.
20498  In fact,
20499  title pages are marked as plain by default,
20500  while following pages are marked fancy when using the global fancy setting.
20501
20502 \end_layout
20503
20504 \begin_layout Standard
20505
20506 \change_inserted 564990737 1672236008
20507 If you want a header or footer to be on the outer side of a two sided document,
20508  you need to use something like:
20509 \end_layout
20510
20511 \begin_layout Standard
20512
20513 \change_inserted 564990737 1672236008
20514
20515 \family sans
20516 \begin_inset Flex Strong
20517 status collapsed
20518
20519 \begin_layout Plain Layout
20520
20521 \change_inserted 564990737 1672236008
20522
20523 \family sans
20524 \series medium
20525
20526 \backslash
20527 fancyfoot{}
20528 \change_unchanged
20529
20530 \end_layout
20531
20532 \end_inset
20533
20534
20535 \end_layout
20536
20537 \begin_layout Standard
20538
20539 \change_inserted 564990737 1672236008
20540
20541 \family sans
20542 \begin_inset Flex Strong
20543 status collapsed
20544
20545 \begin_layout Plain Layout
20546
20547 \change_inserted 564990737 1672236008
20548
20549 \family sans
20550 \series medium
20551
20552 \backslash
20553 fancyfoot[LE,RO]{
20554 \backslash
20555 thepage}
20556 \change_unchanged
20557
20558 \end_layout
20559
20560 \end_inset
20561
20562
20563 \end_layout
20564
20565 \begin_layout Standard
20566
20567 \change_inserted 564990737 1672236008
20568 The first command clears all existing footers avoiding any conflicts with your new command.
20569 \end_layout
20570
20571 \begin_layout Standard
20572
20573 \change_inserted 564990737 1672236008
20574 You can enter any of these commands,
20575  the simpler ones in any of your new environments,
20576  the more complex ones as \SpecialChar TeX
20577  Code commands,
20578  at any point in your document and they will take effect on the next page.
20579 \end_layout
20580
20581 \begin_layout Standard
20582
20583 \change_inserted 564990737 1672236008
20584 As a final example,
20585  it is possible to include an image in the header or footer.
20586  Suppose you want to put a company logo in the upper left hand corner.
20587  You might try something like
20588 \end_layout
20589
20590 \begin_layout Standard
20591
20592 \change_inserted 564990737 1672236008
20593
20594 \family sans
20595
20596 \backslash
20597 lhead{
20598 \backslash
20599 resizebox{1in}{!}{
20600 \backslash
20601 includegraphics{logo.eps}}}
20602 \end_layout
20603
20604 \begin_layout Standard
20605 \noindent
20606
20607 \change_inserted 564990737 1672236008
20608 (you may need to preface this with
20609 \family sans
20610
20611 \backslash
20612 usepackage{graphics}
20613 \family default
20614  if you don't include graphics elsewhere in your document).
20615 \end_layout
20616
20617 \begin_layout Standard
20618
20619 \change_inserted 564990737 1672236008
20620 For more information on fancy headers,
20621  you can get the
20622 \begin_inset Flex Code
20623 status collapsed
20624
20625 \begin_layout Plain Layout
20626
20627 \change_inserted 564990737 1672236008
20628 fancyhdr
20629 \change_unchanged
20630
20631 \end_layout
20632
20633 \end_inset
20634
20635  documentation from
20636 \begin_inset CommandInset href
20637 LatexCommand href
20638 name "CTAN"
20639 target "http://www.ctan.org/pkg/fancyhdr"
20640 literal "false"
20641
20642 \end_inset
20643
20644 .
20645
20646 \end_layout
20647
20648 \begin_layout Subsection
20649
20650 \change_inserted 564990737 1672236008
20651 Landscape Document Parts
20652 \end_layout
20653
20654 \begin_layout Standard
20655
20656 \change_inserted 564990737 1672236008
20657 This module outputs parts of the document in landscape mode using
20658 \family sans
20659 Insert\SpecialChar menuseparator
20660 Custom Insets\SpecialChar menuseparator
20661 Landscape
20662 \family default
20663  or
20664 \family sans
20665 Insert\SpecialChar menuseparator
20666 Custom Insets\SpecialChar menuseparator
20667 Landscape (Floating)
20668 \family default
20669 .
20670 \end_layout
20671
20672 \begin_layout Subsection
20673
20674 \change_inserted 564990737 1672236008
20675 \begin_inset CommandInset label
20676 LatexCommand label
20677 name "sec:Multiple-Columns"
20678
20679 \end_inset
20680
20681 Multiple Columns
20682 \end_layout
20683
20684 \begin_layout Standard
20685
20686 \change_inserted 564990737 1672236008
20687 This module uses the
20688 \family sans
20689 multicol
20690 \family default
20691
20692 \begin_inset Index idx
20693 range none
20694 pageformat default
20695 status collapsed
20696
20697 \begin_layout Plain Layout
20698
20699 \change_inserted 564990737 1672236008
20700 \SpecialChar LaTeX
20701 -packages !
20702  multicol
20703 \change_unchanged
20704
20705 \end_layout
20706
20707 \end_inset
20708
20709  package and is independent of the option
20710 \family sans
20711 Two-
20712 \bar under
20713 c
20714 \bar default
20715 olumn document
20716 \family default
20717  in the
20718 \family sans
20719 \bar under
20720 D
20721 \bar default
20722 ocument\SpecialChar menuseparator
20723
20724 \bar under
20725 S
20726 \bar default
20727 ettings\SpecialChar menuseparator
20728 Text
20729 \begin_inset space ~
20730 \end_inset
20731
20732 Layout
20733 \family default
20734  dialog.
20735  If you want to have two columns for the whole document,
20736  you are recommended to use the
20737 \family sans
20738 Two-
20739 \bar under
20740 c
20741 \bar default
20742 olumn document
20743 \family default
20744  option.
20745  For all other cases use this module.
20746 \change_deleted 564990737 1672236008
20747 Multiple Text Columns
20748 \end_layout
20749
20750 \begin_layout Standard
20751
20752 \change_deleted 564990737 1672236008
20753 This feature is independent of the option
20754 \family sans
20755 Two-column document
20756 \family default
20757  in the document settings under
20758 \family sans
20759 Text Layout
20760 \family default
20761 .
20762  If you want to have 2
20763 \begin_inset space ~
20764 \end_inset
20765
20766 columns for the whole document,
20767  it is recommended to use the
20768 \family sans
20769 Two-column document
20770 \family default
20771  option.
20772  For all other cases use this feature.
20773 \end_layout
20774
20775 \begin_layout Standard
20776
20777 \change_deleted 564990737 1672236008
20778 To use multiple text columns in your document,
20779  you have to load the module
20780 \family sans
20781 Multiple Columns
20782 \family default
20783  (menu
20784 \family sans
20785 Document\SpecialChar menuseparator
20786 Settings\SpecialChar menuseparator
20787 Modules
20788 \family default
20789 ) and must have the \SpecialChar LaTeX
20790 -package
20791 \begin_inset Flex Code
20792 status collapsed
20793
20794 \begin_layout Plain Layout
20795 multicol
20796 \end_layout
20797
20798 \end_inset
20799
20800  installed.
20801 \change_unchanged
20802
20803 \end_layout
20804
20805 \begin_layout Standard
20806 Footnotes within multiple columns will be placed at the bottom of the page and not under each column.
20807  Within the different columns you can use everything,
20808  with the limitation that for floats you need to
20809 \change_deleted 564990737 1672236179
20810 use the float option
20811 \family sans
20812 Span columns
20813 \change_inserted 564990737 1672236179
20814
20815 \family default
20816 check the option
20817 \family sans
20818 \bar under
20819 S
20820 \bar default
20821 pan
20822 \begin_inset space ~
20823 \end_inset
20824
20825 columns
20826 \family default
20827  in
20828 \family sans
20829 \bar under
20830 E
20831 \bar default
20832 dit\SpecialChar menuseparator
20833 Flo
20834 \bar under
20835 a
20836 \bar default
20837 t
20838 \begin_inset space ~
20839 \end_inset
20840
20841 Settings
20842 \change_unchanged
20843
20844 \family default
20845 .
20846 \end_layout
20847
20848 \begin_layout Subsubsection
20849 Basics
20850 \end_layout
20851
20852 \begin_layout Standard
20853 If you want to have 2
20854 \begin_inset space ~
20855 \end_inset
20856
20857 columns in your text,
20858  insert a multicolumn inset via the menu
20859 \family sans
20860 Insert\SpecialChar menuseparator
20861 Custom
20862 \begin_inset space ~
20863 \end_inset
20864
20865 Insets\SpecialChar menuseparator
20866 Multiple
20867 \begin_inset space ~
20868 \end_inset
20869
20870 Columns
20871 \family default
20872  where the columns should start.
20873  Write all text that should be printed in 2
20874 \begin_inset space ~
20875 \end_inset
20876
20877 columns into this inset.
20878 \end_layout
20879
20880 \begin_layout Standard
20881 Here is an example:
20882 \end_layout
20883
20884 \begin_layout Standard
20885 \noindent
20886 \begin_inset Flex Multiple Columns
20887 status open
20888
20889 \begin_layout Plain Layout
20890 \noindent
20891
20892 \series bold
20893 \size small
20894 The Adventure of the Empty House
20895 \series default
20896
20897 \begin_inset Newline newline
20898 \end_inset
20899
20900 by Sir Arthur Conan Doyle
20901 \end_layout
20902
20903 \begin_layout Plain Layout
20904
20905 \size small
20906 It was in the spring of the year 1894 that all London was interested,
20907  and the fashionable world dismayed,
20908  by the murder of the Honourable Ronald Adair under most unusual and inexplicable circumstances.
20909  The public has already learned those particulars of the crime which came out in the police investigation,
20910  but a good deal was suppressed upon that occasion,
20911  since the case for the prosecution was so overwhelmingly strong that it was not necessary to bring forward all the facts.
20912  Only now,
20913  at the end of nearly ten years,
20914  am I allowed to supply those missing links which make up the whole of that remarkable chain.
20915  The crime was of interest in itself,
20916  but that interest was as nothing to me compared to the inconceivable sequel,
20917  which afforded me the greatest shock and surprise of any event in my adventurous life.
20918  Even now,
20919  after this long interval,
20920  I find myself thrilling as I think of it,
20921  and feeling once more that sudden flood of joy,
20922  amazement,
20923  and incredulity which utterly submerged my mind.
20924  Let me say to that public,
20925  which has shown some interest in those glimpses which I have occasionally given them of the thoughts and actions of a very remarkable man,
20926  that they are not to blame me if I have not shared my knowledge with them,
20927  for I should have considered it my first duty to do so,
20928  had I not been barred by a positive prohibition from his own lips,
20929  which was only withdrawn upon the third of last month.
20930 \end_layout
20931
20932 \end_inset
20933
20934
20935 \end_layout
20936
20937 \begin_layout Standard
20938 To get 3 or more columns,
20939  set the cursor into the multicolumn inset and use the menu
20940 \family sans
20941 Insert\SpecialChar menuseparator
20942 Number
20943 \begin_inset space ~
20944 \end_inset
20945
20946 of
20947 \begin_inset space ~
20948 \end_inset
20949
20950 Columns
20951 \family default
20952 .
20953  The number of the desired columns is written into that inset (for 3
20954 \begin_inset space ~
20955 \end_inset
20956
20957 columns write
20958 \begin_inset Quotes eld
20959 \end_inset
20960
20961 3
20962 \begin_inset Quotes erd
20963 \end_inset
20964
20965 ).
20966 \begin_inset Newline newline
20967 \end_inset
20968
20969 Here is an example with 3
20970 \begin_inset space ~
20971 \end_inset
20972
20973 columns:
20974 \end_layout
20975
20976 \begin_layout Standard
20977 \begin_inset Flex Multiple Columns
20978 status open
20979
20980 \begin_layout Plain Layout
20981
20982 \size footnotesize
20983 \begin_inset Argument 1
20984 status open
20985
20986 \begin_layout Plain Layout
20987
20988 3
20989 \end_layout
20990
20991 \end_inset
20992
20993 It can be imagined that my close intimacy with Sherlock Holmes had interested me deeply in crime,
20994  and that after his disappearance I never failed to read with care the various problems which came before the public.
20995  And I even attempted,
20996  more than once,
20997  for my own private satisfaction,
20998  to employ his methods in their solution,
20999  though with indifferent success.
21000  There was none,
21001  however,
21002  which appealed to me like this tragedy of Ronald Adair.
21003  As I read the evidence at the inquest,
21004  which led up to a verdict of willful murder against some person or persons unknown,
21005  I realized more clearly than I had ever done the loss which the community had sustained by the death of Sherlock Holmes.
21006  There were points about this strange business which would,
21007  I was sure,
21008  have specially appealed to him,
21009  and the efforts of the police would have been supplemented,
21010  or more probably anticipated,
21011  by the trained observation and the alert mind of the first criminal agent in Europe.
21012  All day,
21013  as I drove upon my round,
21014  I turned over the case in my mind and found no explanation which appeared to me to be adequate.
21015  At the risk of telling a twice-told tale,
21016  I will recapitulate the facts as they were known to the public at the conclusion of the inquest.
21017 \end_layout
21018
21019 \end_inset
21020
21021
21022 \end_layout
21023
21024 \begin_layout Standard
21025 You can have up to 10
21026 \begin_inset space ~
21027 \end_inset
21028
21029 columns if you want to,
21030  but that might not be very pleasant for the readers of your document.
21031 \end_layout
21032
21033 \begin_layout Standard
21034
21035 \change_deleted 564990737 1672236245
21036 \begin_inset Newpage newpage
21037 \end_inset
21038
21039
21040 \change_unchanged
21041
21042 \end_layout
21043
21044 \begin_layout Subsubsection
21045 Columns inside Columns
21046 \end_layout
21047
21048 \begin_layout Standard
21049 You can also have columns inside columns:
21050 \end_layout
21051
21052 \begin_layout Standard
21053 \begin_inset Flex Multiple Columns
21054 status open
21055
21056 \begin_layout Plain Layout
21057
21058 \size footnotesize
21059 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
21060  at that time governor of one of the Australian colonies.
21061  Adair's mother had returned from Australia to undergo the operation for cataract,
21062  and she,
21063  her son Ronald,
21064  and her daughter Hilda were living together at 427 Park Lane.
21065 \end_layout
21066
21067 \begin_layout Plain Layout
21068 \begin_inset Flex Multiple Columns
21069 status open
21070
21071 \begin_layout Plain Layout
21072
21073 \size footnotesize
21074 The youth moved in the best society
21075 \begin_inset space ~
21076 \end_inset
21077
21078 – had,
21079  so far as was known,
21080  no enemies and no particular vices.
21081  He had been engaged to Miss Edith Woodley,
21082  of Carstairs,
21083  but the engagement had been broken off by mutual consent some months before,
21084  and there was no sign that it had left any very profound feeling behind it.
21085  For the rest {sic} the man's life moved in a narrow and conventional circle,
21086  for his habits were quiet and his nature unemotional.
21087  Yet it was upon this easy-going young aristocrat that death came,
21088  in most strange and unexpected form,
21089  between the hours of ten and eleven-twenty on the night of March 30,
21090  1894.
21091 \end_layout
21092
21093 \end_inset
21094
21095
21096 \end_layout
21097
21098 \begin_layout Plain Layout
21099
21100 \size footnotesize
21101 Ronald Adair was fond of cards
21102 \begin_inset space ~
21103 \end_inset
21104
21105 – playing continually,
21106  but never for such stakes as would hurt him.
21107  He was a member of the Baldwin,
21108  the Cavendish,
21109  and the Bagatelle card clubs.
21110  It was shown that,
21111  after dinner on the day of his death,
21112  he had played a rubber of whist at the latter club.
21113  He had also played there in the afternoon.
21114
21115 \size default
21116
21117 \size footnotesize
21118 The evidence of those who had played with him
21119 \begin_inset space ~
21120 \end_inset
21121
21122 – Mr.
21123  Murray,
21124  Sir John Hardy,
21125  and Colonel Moran
21126 \begin_inset space ~
21127 \end_inset
21128
21129 – showed that the game was whist,
21130  and that there was a fairly equal fall of the cards.
21131  Adair might have lost five pounds,
21132  but not more.
21133  His fortune was a considerable one,
21134  and such a loss could not in any way affect him.
21135  He had played nearly every day at one club or other,
21136  but he was a cautious player,
21137  and usually rose a winner.
21138  It came out in evidence that,
21139  in partnership with Colonel Moran,
21140  he had actually won as much as four hundred and twenty pounds in a sitting,
21141  some weeks before,
21142  from Godfrey Milner and Lord Balmoral.
21143  So much for his recent history as it came out at the inquest.
21144 \end_layout
21145
21146 \end_inset
21147
21148
21149 \end_layout
21150
21151 \begin_layout Subsubsection
21152 Advanced Examples
21153 \end_layout
21154
21155 \begin_layout Standard
21156 The examples in this section show some more special features of multiple columns.
21157 \end_layout
21158
21159 \begin_layout Standard
21160 For more features of multiple columns,
21161  have a look at the
21162 \begin_inset CommandInset href
21163 LatexCommand href
21164 name "documentation"
21165 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
21166 literal "false"
21167
21168 \end_inset
21169
21170  of the \SpecialChar LaTeX
21171 -package
21172 \begin_inset Flex Code
21173 status collapsed
21174
21175 \begin_layout Plain Layout
21176 multicol
21177 \end_layout
21178
21179 \end_inset
21180
21181 .
21182 \end_layout
21183
21184 \begin_layout Paragraph
21185 Preface
21186 \end_layout
21187
21188 \begin_layout Standard
21189 To add a preface text for multiple columns,
21190  set the cursor into the multicolumn inset and use the menu
21191 \family sans
21192 Insert\SpecialChar menuseparator
21193 Preface
21194 \family default
21195 .
21196  Write your preface text into that inset.
21197 \begin_inset Newline newline
21198 \end_inset
21199
21200 This is an example with some preface text:
21201 \end_layout
21202
21203 \begin_layout Standard
21204 \begin_inset VSpace bigskip
21205 \end_inset
21206
21207
21208 \end_layout
21209
21210 \begin_layout Standard
21211 \begin_inset Flex Multiple Columns
21212 status open
21213
21214 \begin_layout Plain Layout
21215 \begin_inset Argument 2
21216 status open
21217
21218 \begin_layout Plain Layout
21219 And the story continues and continues and continues and continues\SpecialChar ldots
21220
21221 \end_layout
21222
21223 \end_inset
21224
21225
21226 \size small
21227 On the evening of the crime,
21228  he returned from the club exactly at ten.
21229  His mother and sister were out spending the evening with a relation.
21230  The servant deposed that she heard him enter the front room on the second floor,
21231  generally used as his sitting-room.
21232  She had lit a fire there,
21233  and as it smoked she had opened the window.
21234  No sound was heard from the room until eleven-twenty,
21235  the hour of the return of Lady Maynooth and her daughter.
21236  Desiring to say good-night,
21237  she attempted to enter her son's room.
21238  The door was locked on the inside,
21239  and no answer could be got to their cries and knocking.
21240  Help was obtained,
21241  and the door forced.
21242  The unfortunate young man was found lying near the table.
21243  His head had been horribly mutilated by an expanding revolver bullet,
21244  but no weapon of any sort was to be found in the room.
21245 \end_layout
21246
21247 \end_inset
21248
21249
21250 \end_layout
21251
21252 \begin_layout Standard
21253 You can also use a section heading as the preface if you use a section command as \SpecialChar TeX
21254  Code.
21255  For example the command
21256 \end_layout
21257
21258 \begin_layout LyX-Code
21259
21260 \backslash
21261 subsection{subsection title}
21262 \end_layout
21263
21264 \begin_layout Standard
21265 creates a subsection.
21266  In this example the preface is a subsubsection:
21267 \end_layout
21268
21269 \begin_layout Standard
21270 \begin_inset Flex Multiple Columns
21271 status open
21272
21273 \begin_layout Plain Layout
21274 \begin_inset Argument 2
21275 status open
21276
21277 \begin_layout Plain Layout
21278 \begin_inset ERT
21279 status collapsed
21280
21281 \begin_layout Plain Layout
21282
21283
21284 \backslash
21285 subsubsection{
21286 \end_layout
21287
21288 \end_inset
21289
21290 This is a subsubsection heading as a preface
21291 \begin_inset ERT
21292 status collapsed
21293
21294 \begin_layout Plain Layout
21295
21296 }
21297 \end_layout
21298
21299 \end_inset
21300
21301
21302 \end_layout
21303
21304 \end_inset
21305
21306
21307 \size small
21308 A minute examination of the circumstances served only to make the case more complex.
21309  In the first place,
21310  no reason could be given why the young man should have fastened the door upon the inside.
21311  There was the possibility that the murderer had done this,
21312  and had afterwards escaped by the window.
21313  The drop was at least twenty feet,
21314  however,
21315  and a bed of crocuses in full bloom lay beneath.
21316  Neither the flowers nor the earth showed any sign of having been disturbed,
21317  nor were there any marks upon the narrow strip of grass which separated the house from the road.
21318  Apparently,
21319  therefore,
21320  it was the young man himself who had fastened the door.
21321  But how did he come by his death?
21322  No one could have climbed up to the window without leaving traces.
21323  Suppose a man had fired through the window,
21324  he would indeed be a remarkable shot who could with a revolver inflict so deadly a wound.
21325  Again,
21326  Park Lane is a frequented thoroughfare;
21327  there is a cab stand within a hundred yards of the house.
21328  No one had heard a shot.
21329 \end_layout
21330
21331 \end_inset
21332
21333
21334 \end_layout
21335
21336 \begin_layout Standard
21337 If there is less vertical space than 6
21338 \begin_inset space ~
21339 \end_inset
21340
21341 text lines is left on the page at the beginning of the multiple columns,
21342  a page break will be inserted before the multiple columns.
21343  Depending on the number of lines of the preface text,
21344  you might want to change this space.
21345  This is done by setting the cursor into the mulitcolumn inset behind the preface (if there is any) and using the menu
21346 \family sans
21347 Insert\SpecialChar menuseparator
21348 Space
21349 \begin_inset space ~
21350 \end_inset
21351
21352 Before
21353 \begin_inset space ~
21354 \end_inset
21355
21356 Page
21357 \begin_inset space ~
21358 \end_inset
21359
21360 Break
21361 \family default
21362 .
21363  Insert into that inset the amount of space like e.
21364 \begin_inset space \thinspace{}
21365 \end_inset
21366
21367 g.
21368 \begin_inset space \space{}
21369 \end_inset
21370
21371
21372 \begin_inset Quotes eld
21373 \end_inset
21374
21375 5cm
21376 \begin_inset Quotes erd
21377 \end_inset
21378
21379 .
21380 \begin_inset Newline newline
21381 \end_inset
21382
21383 In this example the space is set to 7
21384 \begin_inset space ~
21385 \end_inset
21386
21387 text lines by using
21388 \begin_inset Flex Code
21389 status collapsed
21390
21391 \begin_layout Plain Layout
21392 7
21393 \backslash
21394 baselineskip
21395 \end_layout
21396
21397 \end_inset
21398
21399  (where the command
21400 \begin_inset Flex Code
21401 status collapsed
21402
21403 \begin_layout Plain Layout
21404
21405 \backslash
21406 baselineskip
21407 \end_layout
21408
21409 \end_inset
21410
21411  needs to be inserted as \SpecialChar TeX
21412  code):
21413 \end_layout
21414
21415 \begin_layout Standard
21416 \begin_inset Flex Multiple Columns
21417 status open
21418
21419 \begin_layout Plain Layout
21420 \begin_inset Argument 3
21421 status open
21422
21423 \begin_layout Plain Layout
21424 7
21425 \begin_inset ERT
21426 status collapsed
21427
21428 \begin_layout Plain Layout
21429
21430
21431 \backslash
21432 baselineskip
21433 \end_layout
21434
21435 \end_inset
21436
21437
21438 \end_layout
21439
21440 \end_inset
21441
21442
21443 \size small
21444 On the evening of the crime,
21445  he returned from the club exactly at ten.
21446  His mother and sister were out spending the evening with a relation.
21447  The servant deposed that she heard him enter the front room on the second floor,
21448  generally used as his sitting-room.
21449  She had lit a fire there,
21450  and as it smoked she had opened the window.
21451  No sound was heard from the room until eleven-twenty,
21452  the hour of the return of Lady Maynooth and her daughter.
21453  Desiring to say good-night,
21454  she attempted to enter her son's room.
21455  The door was locked on the inside,
21456  and no answer could be got to their cries and knocking.
21457  Help was obtained,
21458  and the door forced.
21459  The unfortunate young man was found lying near the table.
21460  His head had been horribly mutilated by an expanding revolver bullet,
21461  but no weapon of any sort was to be found in the room.
21462 \end_layout
21463
21464 \end_inset
21465
21466
21467 \end_layout
21468
21469 \begin_layout Paragraph
21470 Surrounding Space
21471 \end_layout
21472
21473 \begin_layout Standard
21474 The amount of space before and after multiple columns can be changed by changing the length
21475 \begin_inset Flex Code
21476 status collapsed
21477
21478 \begin_layout Plain Layout
21479
21480 \backslash
21481 multicolsep
21482 \end_layout
21483
21484 \end_inset
21485
21486 .
21487  For example the command
21488 \end_layout
21489
21490 \begin_layout LyX-Code
21491
21492 \backslash
21493 setlength{
21494 \backslash
21495 multicolsep}{3cm}
21496 \end_layout
21497
21498 \begin_layout Standard
21499 in \SpecialChar TeX
21500  Code changes its value to 3
21501 \begin_inset space \thinspace{}
21502 \end_inset
21503
21504 cm.
21505  The change must be made before the multiple columns' start.
21506  The predefined value is 13
21507 \begin_inset space \thinspace{}
21508 \end_inset
21509
21510 pt.
21511 \end_layout
21512
21513 \begin_layout Standard
21514 For this example
21515 \begin_inset Flex Code
21516 status collapsed
21517
21518 \begin_layout Plain Layout
21519
21520 \backslash
21521 multicolsep
21522 \end_layout
21523
21524 \end_inset
21525
21526  was set to 2.5
21527 \begin_inset space \thinspace{}
21528 \end_inset
21529
21530 cm:
21531 \end_layout
21532
21533 \begin_layout Standard
21534 \begin_inset ERT
21535 status open
21536
21537 \begin_layout Plain Layout
21538
21539
21540 \backslash
21541 setlength{
21542 \backslash
21543 multicolsep}{2.5cm}
21544 \end_layout
21545
21546 \end_inset
21547
21548
21549 \end_layout
21550
21551 \begin_layout Standard
21552 \begin_inset Flex Multiple Columns
21553 status open
21554
21555 \begin_layout Plain Layout
21556
21557 \size small
21558 All day I turned these facts over in my mind,
21559  endeavouring to hit upon some theory which could reconcile them all,
21560  and to find that line of least resistance which my poor friend had declared to be the starting-point of every investigation.
21561  I confess that I made little progress.
21562  In the evening I strolled across the Park,
21563  and found myself about six o'clock at the Oxford Street end of Park Lane.
21564  A group of loafers upon the pavements,
21565  all staring up at a particular window,
21566  directed me to the house which I had come to see.
21567  A tall,
21568  thin man with coloured glasses,
21569  whom I strongly suspected of being a plain-clothes detective,
21570  was pointing out some theory of his own,
21571  while the others crowded round to listen to what he said.
21572  I got as near him as I could,
21573  but his observations seemed to me to be absurd,
21574  so I withdrew again in some disgust.
21575  As I did so I struck against an elderly,
21576  deformed man,
21577  who had been behind me,
21578  and I knocked down several books which he was carrying.
21579 \end_layout
21580
21581 \end_inset
21582
21583
21584 \end_layout
21585
21586 \begin_layout Standard
21587 \begin_inset Note Greyedout
21588 status open
21589
21590 \begin_layout Plain Layout
21591
21592 \series bold
21593 Note:
21594
21595 \series default
21596  The values you set with
21597 \begin_inset Flex Code
21598 status collapsed
21599
21600 \begin_layout Plain Layout
21601
21602 \backslash
21603 setlength
21604 \end_layout
21605
21606 \end_inset
21607
21608  will be used for all following multiple columns until you change them again.
21609 \end_layout
21610
21611 \end_inset
21612
21613
21614 \end_layout
21615
21616 \begin_layout Standard
21617 \begin_inset ERT
21618 status collapsed
21619
21620 \begin_layout Plain Layout
21621
21622
21623 \backslash
21624 setlength{
21625 \backslash
21626 multicolsep}{13pt}
21627 \end_layout
21628
21629 \end_inset
21630
21631
21632 \begin_inset Note Note
21633 status collapsed
21634
21635 \begin_layout Plain Layout
21636 go back to the default
21637 \end_layout
21638
21639 \end_inset
21640
21641
21642 \end_layout
21643
21644 \begin_layout Standard
21645
21646 \change_deleted 564990737 1672236355
21647 \begin_inset Newpage newpage
21648 \end_inset
21649
21650
21651 \change_unchanged
21652
21653 \end_layout
21654
21655 \begin_layout Paragraph
21656 Column Breaks
21657 \end_layout
21658
21659 \begin_layout Standard
21660 A column break can be forced by inserting the command
21661 \begin_inset Flex Code
21662 status collapsed
21663
21664 \begin_layout Plain Layout
21665
21666 \backslash
21667 columnbreak{}
21668 \end_layout
21669
21670 \end_inset
21671
21672  as \SpecialChar TeX
21673  Code to that position in the text where the column should be broken.
21674  Note that this leads in most cases to whitespace in the text.
21675 \begin_inset Newline newline
21676 \end_inset
21677
21678 Here is an example:
21679 \end_layout
21680
21681 \begin_layout Standard
21682 \begin_inset Flex Multiple Columns
21683 status open
21684
21685 \begin_layout Plain Layout
21686
21687 \size small
21688 \begin_inset Quotes eld
21689 \end_inset
21690
21691 You're surprised to see me,
21692  sir,
21693 \begin_inset Quotes erd
21694 \end_inset
21695
21696  said he,
21697  in a strange,
21698  croaking voice.
21699 \end_layout
21700
21701 \begin_layout Plain Layout
21702
21703 \size small
21704 I acknowledged that I was.
21705 \end_layout
21706
21707 \begin_layout Plain Layout
21708
21709 \size small
21710 \begin_inset Quotes eld
21711 \end_inset
21712
21713 Well,
21714  I've a conscience,
21715  sir,
21716  and when I chanced to see you go into this house,
21717  as I came hobbling after you,
21718  I thought to myself,
21719  I'll just step in and see that kind gentleman,
21720  and tell him that if I was a bit gruff in my manner there was not any harm meant,
21721  and that I am much obliged to him for picking up my books.
21722 \begin_inset Quotes erd
21723 \end_inset
21724
21725
21726 \end_layout
21727
21728 \begin_layout Plain Layout
21729
21730 \size small
21731 \begin_inset Quotes eld
21732 \end_inset
21733
21734 You make too much of a trifle,
21735 \begin_inset Quotes erd
21736 \end_inset
21737
21738  said I.
21739
21740 \begin_inset Quotes eld
21741 \end_inset
21742
21743 May I ask how you knew who I was?
21744 \begin_inset Quotes erd
21745 \end_inset
21746
21747  AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
21748 \begin_inset ERT
21749 status collapsed
21750
21751 \begin_layout Plain Layout
21752
21753
21754 \backslash
21755 columnbreak{}
21756 \end_layout
21757
21758 \end_inset
21759
21760
21761 \end_layout
21762
21763 \begin_layout Plain Layout
21764
21765 \size small
21766 \begin_inset Quotes eld
21767 \end_inset
21768
21769 Well,
21770  sir,
21771  if it isn't too great a liberty,
21772  I am a neighbour of yours,
21773  for you'll find my little bookshop at the corner of Church Street,
21774  and very happy to see you,
21775  I am sure.
21776  Maybe you collect yourself,
21777  sir.
21778  Here's
21779 \noun on
21780 British
21781 \begin_inset space ~
21782 \end_inset
21783
21784 Birds
21785 \noun default
21786 ,
21787  and
21788 \noun on
21789 Catullus
21790 \noun default
21791 ,
21792  and
21793 \noun on
21794 The Holy War
21795 \noun default
21796
21797 \begin_inset space ~
21798 \end_inset
21799
21800 – a bargain,
21801  every one of them.
21802  With five volumes you could just fill that gap on that second shelf.
21803  It looks untidy,
21804  does it not,
21805  sir?
21806 \begin_inset Quotes erd
21807 \end_inset
21808
21809
21810 \end_layout
21811
21812 \end_inset
21813
21814
21815 \end_layout
21816
21817 \begin_layout Paragraph
21818 Column Separation
21819 \end_layout
21820
21821 \begin_layout Standard
21822 The width of the columns is automatically calculated,
21823  but you can modify the space between the columns.
21824  This is done by changing the length
21825 \begin_inset Flex Code
21826 status collapsed
21827
21828 \begin_layout Plain Layout
21829
21830 \backslash
21831 columnsep
21832 \end_layout
21833
21834 \end_inset
21835
21836 .
21837  Its predefined value is 10
21838 \begin_inset space \thinspace{}
21839 \end_inset
21840
21841 pt.
21842  Here is an example where
21843 \begin_inset Flex Code
21844 status collapsed
21845
21846 \begin_layout Plain Layout
21847
21848 \backslash
21849 columnsep
21850 \end_layout
21851
21852 \end_inset
21853
21854  is set to 3
21855 \begin_inset space \thinspace{}
21856 \end_inset
21857
21858 cm:
21859 \end_layout
21860
21861 \begin_layout Standard
21862 \begin_inset ERT
21863 status open
21864
21865 \begin_layout Plain Layout
21866
21867
21868 \backslash
21869 setlength{
21870 \backslash
21871 columnsep}{3cm}
21872 \end_layout
21873
21874 \end_inset
21875
21876
21877 \end_layout
21878
21879 \begin_layout Standard
21880 \begin_inset Flex Multiple Columns
21881 status open
21882
21883 \begin_layout Plain Layout
21884
21885 \size small
21886 My observations of No.
21887 \begin_inset space \space{}
21888 \end_inset
21889
21890 427 Park Lane did little to clear up the problem in which I was interested.
21891  The house was separated from the street by a low wall and railing,
21892  the whole not more than five feet high.
21893  It was perfectly easy,
21894  therefore,
21895  for anyone to get into the garden,
21896  but the window was entirely inaccessible,
21897  since there was no water pipe or anything which could help the most active man to climb it.
21898  More puzzled than ever,
21899  I retraced my steps to Kensington.
21900  I had not been in my study five minutes when the maid entered to say that a person desired to see me.
21901  To my astonishment it was none other than my strange old book collector,
21902  his sharp,
21903  wizened face peering out from a frame of white hair,
21904  and his precious volumes,
21905  a dozen of them at least,
21906  wedged under his right arm.
21907 \end_layout
21908
21909 \end_inset
21910
21911
21912 \end_layout
21913
21914 \begin_layout Standard
21915 \begin_inset ERT
21916 status collapsed
21917
21918 \begin_layout Plain Layout
21919
21920
21921 \backslash
21922 setlength{
21923 \backslash
21924 columnsep}{10pt}
21925 \end_layout
21926
21927 \end_inset
21928
21929
21930 \begin_inset Note Note
21931 status collapsed
21932
21933 \begin_layout Plain Layout
21934 go back to the default
21935 \end_layout
21936
21937 \end_inset
21938
21939
21940 \end_layout
21941
21942 \begin_layout Paragraph
21943 Vertical Lines
21944 \end_layout
21945
21946 \begin_layout Standard
21947 Between the columns a rule with a width of the length
21948 \begin_inset Flex Code
21949 status collapsed
21950
21951 \begin_layout Plain Layout
21952
21953 \backslash
21954 columnseprule
21955 \end_layout
21956
21957 \end_inset
21958
21959  is placed.
21960  If this rule width is set to 0
21961 \begin_inset space \thinspace{}
21962 \end_inset
21963
21964 pt (this is the default),
21965  the rule is suppressed.
21966  In the following example the rule is 2
21967 \begin_inset space \thinspace{}
21968 \end_inset
21969
21970 pt wide:
21971 \end_layout
21972
21973 \begin_layout Standard
21974 \begin_inset ERT
21975 status open
21976
21977 \begin_layout Plain Layout
21978
21979
21980 \backslash
21981 setlength{
21982 \backslash
21983 columnseprule}{2pt}
21984 \end_layout
21985
21986 \end_inset
21987
21988
21989 \end_layout
21990
21991 \begin_layout Standard
21992 \begin_inset Flex Multiple Columns
21993 status open
21994
21995 \begin_layout Plain Layout
21996
21997 \size small
21998 \begin_inset Quotes eld
21999 \end_inset
22000
22001 You're surprised to see me,
22002  sir,
22003 \begin_inset Quotes erd
22004 \end_inset
22005
22006  said he,
22007  in a strange,
22008  croaking voice.
22009 \end_layout
22010
22011 \begin_layout Plain Layout
22012
22013 \size small
22014 I acknowledged that I was.
22015 \end_layout
22016
22017 \begin_layout Plain Layout
22018
22019 \size small
22020 \begin_inset Quotes eld
22021 \end_inset
22022
22023 Well,
22024  I've a conscience,
22025  sir,
22026  and when I chanced to see you go into this house,
22027  as I came hobbling after you,
22028  I thought to myself,
22029  I'll just step in and see that kind gentleman,
22030  and tell him that if I was a bit gruff in my manner there was not any harm meant,
22031  and that I am much obliged to him for picking up my books.
22032 \begin_inset Quotes erd
22033 \end_inset
22034
22035
22036 \end_layout
22037
22038 \begin_layout Plain Layout
22039
22040 \size small
22041 \begin_inset Quotes eld
22042 \end_inset
22043
22044 You make too much of a trifle,
22045 \begin_inset Quotes erd
22046 \end_inset
22047
22048  said I.
22049
22050 \begin_inset Quotes eld
22051 \end_inset
22052
22053 May I ask how you knew who I was?
22054 \begin_inset Quotes erd
22055 \end_inset
22056
22057
22058 \end_layout
22059
22060 \begin_layout Plain Layout
22061
22062 \size small
22063 \begin_inset Quotes eld
22064 \end_inset
22065
22066 Well,
22067  sir,
22068  if it isn't too great a liberty,
22069  I am a neighbour of yours,
22070  for you'll find my little bookshop at the corner of Church Street,
22071  and very happy to see you,
22072  I am sure.
22073  Maybe you collect yourself,
22074  sir.
22075  Here's
22076 \noun on
22077 British
22078 \begin_inset space ~
22079 \end_inset
22080
22081 Birds
22082 \noun default
22083 ,
22084  and
22085 \noun on
22086 Catullus
22087 \noun default
22088 ,
22089  and
22090 \noun on
22091 The Holy War
22092 \noun default
22093
22094 \begin_inset space ~
22095 \end_inset
22096
22097 – a bargain,
22098  every one of them.
22099  With five volumes you could just fill that gap on that second shelf.
22100  It looks untidy,
22101  does it not,
22102  sir?
22103 \begin_inset Quotes erd
22104 \end_inset
22105
22106
22107 \end_layout
22108
22109 \end_inset
22110
22111
22112 \end_layout
22113
22114 \begin_layout Standard
22115 \begin_inset VSpace defskip
22116 \end_inset
22117
22118
22119 \end_layout
22120
22121 \begin_layout Standard
22122 The rule can be colored by redefining the command
22123 \begin_inset Flex Code
22124 status collapsed
22125
22126 \begin_layout Plain Layout
22127
22128 \backslash
22129 columnseprulecolor
22130 \end_layout
22131
22132 \end_inset
22133
22134 .
22135  This is done by inserting the command
22136 \end_layout
22137
22138 \begin_layout LyX-Code
22139
22140 \backslash
22141 renewcommand{
22142 \backslash
22143 columnseprulecolor}{
22144 \backslash
22145 color{red}}
22146 \end_layout
22147
22148 \begin_layout Standard
22149 as \SpecialChar TeX
22150  Code before the multicolumn inset.
22151  Replace
22152 \begin_inset Flex Code
22153 status collapsed
22154
22155 \begin_layout Plain Layout
22156 red
22157 \end_layout
22158
22159 \end_inset
22160
22161  in this command by a color of your choice.
22162  You can use all pre- and self-defined colors.
22163  See the
22164 \emph on
22165 EmbeddedObjects
22166 \emph default
22167  manual,
22168  section
22169 \emph on
22170 Colored
22171 \begin_inset space ~
22172 \end_inset
22173
22174 Tables
22175 \emph default
22176  for more information about pre- and self-defined colors.
22177  To go back to the default color insert the command
22178 \end_layout
22179
22180 \begin_layout LyX-Code
22181
22182 \backslash
22183 renewcommand{
22184 \backslash
22185 columnseprulecolor}{
22186 \backslash
22187 normalcolor}
22188 \end_layout
22189
22190 \begin_layout Standard
22191 Here is the example with a cyan rule and 1
22192 \begin_inset space \thinspace{}
22193 \end_inset
22194
22195 cm column separation:
22196 \end_layout
22197
22198 \begin_layout Standard
22199 \begin_inset ERT
22200 status open
22201
22202 \begin_layout Plain Layout
22203
22204
22205 \backslash
22206 setlength{
22207 \backslash
22208 columnsep}{1cm}
22209 \end_layout
22210
22211 \begin_layout Plain Layout
22212
22213
22214 \backslash
22215 renewcommand{
22216 \backslash
22217 columnseprulecolor}{
22218 \backslash
22219 color{cyan}}
22220 \end_layout
22221
22222 \end_inset
22223
22224
22225 \end_layout
22226
22227 \begin_layout Standard
22228 \begin_inset Flex Multiple Columns
22229 status open
22230
22231 \begin_layout Plain Layout
22232
22233 \size small
22234 \begin_inset Quotes eld
22235 \end_inset
22236
22237 You're surprised to see me,
22238  sir,
22239 \begin_inset Quotes erd
22240 \end_inset
22241
22242  said he,
22243  in a strange,
22244  croaking voice.
22245 \end_layout
22246
22247 \begin_layout Plain Layout
22248
22249 \size small
22250 I acknowledged that I was.
22251 \end_layout
22252
22253 \begin_layout Plain Layout
22254
22255 \size small
22256 \begin_inset Quotes eld
22257 \end_inset
22258
22259 Well,
22260  I've a conscience,
22261  sir,
22262  and when I chanced to see you go into this house,
22263  as I came hobbling after you,
22264  I thought to myself,
22265  I'll just step in and see that kind gentleman,
22266  and tell him that if I was a bit gruff in my manner there was not any harm meant,
22267  and that I am much obliged to him for picking up my books.
22268 \begin_inset Quotes erd
22269 \end_inset
22270
22271
22272 \end_layout
22273
22274 \begin_layout Plain Layout
22275
22276 \size small
22277 \begin_inset Quotes eld
22278 \end_inset
22279
22280 You make too much of a trifle,
22281 \begin_inset Quotes erd
22282 \end_inset
22283
22284  said I.
22285
22286 \begin_inset Quotes eld
22287 \end_inset
22288
22289 May I ask how you knew who I was?
22290 \begin_inset Quotes erd
22291 \end_inset
22292
22293
22294 \end_layout
22295
22296 \begin_layout Plain Layout
22297
22298 \size small
22299 \begin_inset Quotes eld
22300 \end_inset
22301
22302 Well,
22303  sir,
22304  if it isn't too great a liberty,
22305  I am a neighbour of yours,
22306  for you'll find my little bookshop at the corner of Church Street,
22307  and very happy to see you,
22308  I am sure.
22309  Maybe you collect yourself,
22310  sir.
22311  Here's
22312 \noun on
22313 British
22314 \begin_inset space ~
22315 \end_inset
22316
22317 Birds
22318 \noun default
22319 ,
22320  and
22321 \noun on
22322 Catullus
22323 \noun default
22324 ,
22325  and
22326 \noun on
22327 The Holy War
22328 \noun default
22329
22330 \begin_inset space ~
22331 \end_inset
22332
22333 – a bargain,
22334  every one of them.
22335  With five volumes you could just fill that gap on that second shelf.
22336  It looks untidy,
22337  does it not,
22338  sir?
22339 \begin_inset Quotes erd
22340 \end_inset
22341
22342
22343 \end_layout
22344
22345 \end_inset
22346
22347
22348 \end_layout
22349
22350 \begin_layout Standard
22351 \begin_inset ERT
22352 status collapsed
22353
22354 \begin_layout Plain Layout
22355
22356
22357 \backslash
22358 setlength{
22359 \backslash
22360 columnseprule}{0pt}
22361 \end_layout
22362
22363 \begin_layout Plain Layout
22364
22365
22366 \backslash
22367 renewcommand{
22368 \backslash
22369 columnseprulecolor}{
22370 \backslash
22371 normalcolor}
22372 \end_layout
22373
22374 \end_inset
22375
22376
22377 \begin_inset Note Note
22378 status collapsed
22379
22380 \begin_layout Plain Layout
22381 go back to the default
22382 \end_layout
22383
22384 \end_inset
22385
22386
22387 \end_layout
22388
22389 \begin_layout Section
22390
22391 \change_inserted 564990737 1671270380
22392 Paragraph Styles
22393 \end_layout
22394
22395 \begin_layout Subsection
22396
22397 \change_inserted 564990737 1671270398
22398 Custom
22399 \change_deleted 564990737 1671270396
22400 Non-standard
22401 \change_unchanged
22402  Paragraph Shapes
22403 \end_layout
22404
22405 \begin_layout Standard
22406 \noindent
22407 \SpecialChar LaTeX
22408  as well as any other text processor uses by default rectangular paragraphs.
22409  For special cases like for example posters,
22410  invitation cards or poems you can modify the paragraph shape to one of your choice.
22411
22412 \change_deleted 564990737 1672311802
22413 This can be done by using the \SpecialChar LaTeX
22414 -package
22415 \begin_inset Flex Code
22416 status collapsed
22417
22418 \begin_layout Plain Layout
22419 shapepar
22420 \end_layout
22421
22422 \end_inset
22423
22424  which is loaded by using in the document settings the module
22425 \family sans
22426 Custom paragraph shapes
22427 \family default
22428 .
22429 \change_inserted 564990737 1672311802
22430 This module uses the
22431 \family sans
22432 shapepar
22433 \family default
22434  package to provide over a dozen paragraph shapes as well as commands to define custom shapes.
22435
22436 \change_unchanged
22437
22438 \end_layout
22439
22440 \begin_layout Subsubsection
22441 Predefined shapes
22442 \end_layout
22443
22444 \begin_layout Standard
22445
22446 \series bold
22447 shapepar
22448 \series default
22449  provides the following shapes:
22450 \end_layout
22451
22452 \begin_layout Standard
22453 \begin_inset Tabular
22454 <lyxtabular version="3" rows="13" columns="3">
22455 <features booktabs="true" islongtable="true" longtabularalignment="center">
22456 <column alignment="left" valignment="middle" width="16col%">
22457 <column alignment="left" valignment="middle" width="40col%">
22458 <column alignment="left" valignment="middle" width="35col%">
22459 <row endhead="true">
22460 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22461 \begin_inset Text
22462
22463 \begin_layout Plain Layout
22464
22465 \series bold
22466 \size small
22467 Name
22468 \end_layout
22469
22470 \end_inset
22471 </cell>
22472 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22473 \begin_inset Text
22474
22475 \begin_layout Plain Layout
22476
22477 \series bold
22478 \size small
22479 Description
22480 \end_layout
22481
22482 \end_inset
22483 </cell>
22484 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22485 \begin_inset Text
22486
22487 \begin_layout Plain Layout
22488
22489 \series bold
22490 \size small
22491 Annotation
22492 \end_layout
22493
22494 \end_inset
22495 </cell>
22496 </row>
22497 <row interlinespace="default">
22498 <cell alignment="left" valignment="top" usebox="none">
22499 \begin_inset Text
22500
22501 \begin_layout Plain Layout
22502
22503 \size small
22504 CDlabel
22505 \end_layout
22506
22507 \end_inset
22508 </cell>
22509 <cell alignment="left" valignment="top" usebox="none">
22510 \begin_inset Text
22511
22512 \begin_layout Plain Layout
22513
22514 \size small
22515 Circle with circular hole (in the size of a CD/DVD)
22516 \end_layout
22517
22518 \end_inset
22519 </cell>
22520 <cell alignment="left" valignment="top" usebox="none">
22521 \begin_inset Text
22522
22523 \begin_layout Plain Layout
22524
22525 \size small
22526 Cannot be scaled,
22527  take care there is not too much text
22528 \end_layout
22529
22530 \end_inset
22531 </cell>
22532 </row>
22533 <row interlinespace="default">
22534 <cell alignment="left" valignment="top" usebox="none">
22535 \begin_inset Text
22536
22537 \begin_layout Plain Layout
22538
22539 \size small
22540 Circle
22541 \end_layout
22542
22543 \end_inset
22544 </cell>
22545 <cell alignment="left" valignment="top" usebox="none">
22546 \begin_inset Text
22547
22548 \begin_layout Plain Layout
22549
22550 \size small
22551 Circle
22552 \end_layout
22553
22554 \end_inset
22555 </cell>
22556 <cell alignment="left" valignment="top" usebox="none">
22557 \begin_inset Text
22558
22559 \begin_layout Plain Layout
22560
22561 \size small
22562 Fragile,
22563  calculation might fail
22564 \end_layout
22565
22566 \end_inset
22567 </cell>
22568 </row>
22569 <row interlinespace="default">
22570 <cell alignment="left" valignment="top" usebox="none">
22571 \begin_inset Text
22572
22573 \begin_layout Plain Layout
22574
22575 \size small
22576 Diamond
22577 \end_layout
22578
22579 \end_inset
22580 </cell>
22581 <cell alignment="left" valignment="top" usebox="none">
22582 \begin_inset Text
22583
22584 \begin_layout Plain Layout
22585
22586 \size small
22587 Rhomboid (symbolizing a
22588 \begin_inset Quotes eld
22589 \end_inset
22590
22591 diamond
22592 \begin_inset Quotes erd
22593 \end_inset
22594
22595 )
22596 \end_layout
22597
22598 \end_inset
22599 </cell>
22600 <cell alignment="left" valignment="top" usebox="none">
22601 \begin_inset Text
22602
22603 \begin_layout Plain Layout
22604
22605 \size small
22606 -
22607 \end_layout
22608
22609 \end_inset
22610 </cell>
22611 </row>
22612 <row interlinespace="default">
22613 <cell alignment="left" valignment="top" usebox="none">
22614 \begin_inset Text
22615
22616 \begin_layout Plain Layout
22617
22618 \size small
22619 Heart
22620 \end_layout
22621
22622 \end_inset
22623 </cell>
22624 <cell alignment="left" valignment="top" usebox="none">
22625 \begin_inset Text
22626
22627 \begin_layout Plain Layout
22628
22629 \size small
22630 Heart-like shape
22631 \end_layout
22632
22633 \end_inset
22634 </cell>
22635 <cell alignment="left" valignment="top" usebox="none">
22636 \begin_inset Text
22637
22638 \begin_layout Plain Layout
22639
22640 \size small
22641 -
22642 \end_layout
22643
22644 \end_inset
22645 </cell>
22646 </row>
22647 <row interlinespace="default">
22648 <cell alignment="left" valignment="top" usebox="none">
22649 \begin_inset Text
22650
22651 \begin_layout Plain Layout
22652
22653 \size small
22654 Hexagon
22655 \end_layout
22656
22657 \end_inset
22658 </cell>
22659 <cell alignment="left" valignment="top" usebox="none">
22660 \begin_inset Text
22661
22662 \begin_layout Plain Layout
22663
22664 \size small
22665 Hexagon
22666 \end_layout
22667
22668 \end_inset
22669 </cell>
22670 <cell alignment="left" valignment="top" usebox="none">
22671 \begin_inset Text
22672
22673 \begin_layout Plain Layout
22674
22675 \size small
22676 -
22677 \end_layout
22678
22679 \end_inset
22680 </cell>
22681 </row>
22682 <row interlinespace="default">
22683 <cell alignment="left" valignment="top" usebox="none">
22684 \begin_inset Text
22685
22686 \begin_layout Plain Layout
22687
22688 \size small
22689 Nut
22690 \end_layout
22691
22692 \end_inset
22693 </cell>
22694 <cell alignment="left" valignment="top" usebox="none">
22695 \begin_inset Text
22696
22697 \begin_layout Plain Layout
22698
22699 \size small
22700 Nut for bolt (hexagon with circular hole)
22701 \end_layout
22702
22703 \end_inset
22704 </cell>
22705 <cell alignment="left" valignment="top" usebox="none">
22706 \begin_inset Text
22707
22708 \begin_layout Plain Layout
22709
22710 \size small
22711 -
22712 \end_layout
22713
22714 \end_inset
22715 </cell>
22716 </row>
22717 <row interlinespace="default">
22718 <cell alignment="left" valignment="top" usebox="none">
22719 \begin_inset Text
22720
22721 \begin_layout Plain Layout
22722
22723 \size small
22724 Square
22725 \end_layout
22726
22727 \end_inset
22728 </cell>
22729 <cell alignment="left" valignment="top" usebox="none">
22730 \begin_inset Text
22731
22732 \begin_layout Plain Layout
22733
22734 \size small
22735 Square
22736 \end_layout
22737
22738 \end_inset
22739 </cell>
22740 <cell alignment="left" valignment="top" usebox="none">
22741 \begin_inset Text
22742
22743 \begin_layout Plain Layout
22744
22745 \size small
22746 -
22747 \end_layout
22748
22749 \end_inset
22750 </cell>
22751 </row>
22752 <row interlinespace="default">
22753 <cell alignment="left" valignment="top" usebox="none">
22754 \begin_inset Text
22755
22756 \begin_layout Plain Layout
22757
22758 \size small
22759 Star
22760 \end_layout
22761
22762 \end_inset
22763 </cell>
22764 <cell alignment="left" valignment="top" usebox="none">
22765 \begin_inset Text
22766
22767 \begin_layout Plain Layout
22768
22769 \size small
22770 Five-point star
22771 \end_layout
22772
22773 \end_inset
22774 </cell>
22775 <cell alignment="left" valignment="top" usebox="none">
22776 \begin_inset Text
22777
22778 \begin_layout Plain Layout
22779
22780 \size small
22781 -
22782 \end_layout
22783
22784 \end_inset
22785 </cell>
22786 </row>
22787 <row interlinespace="default">
22788 <cell alignment="left" valignment="top" usebox="none">
22789 \begin_inset Text
22790
22791 \begin_layout Plain Layout
22792
22793 \size small
22794 Candle
22795 \end_layout
22796
22797 \end_inset
22798 </cell>
22799 <cell alignment="left" valignment="top" usebox="none">
22800 \begin_inset Text
22801
22802 \begin_layout Plain Layout
22803
22804 \size small
22805 Burning candle
22806 \end_layout
22807
22808 \end_inset
22809 </cell>
22810 <cell alignment="left" valignment="top" usebox="none">
22811 \begin_inset Text
22812
22813 \begin_layout Plain Layout
22814
22815 \size small
22816 -
22817 \end_layout
22818
22819 \end_inset
22820 </cell>
22821 </row>
22822 <row interlinespace="default">
22823 <cell alignment="left" valignment="top" usebox="none">
22824 \begin_inset Text
22825
22826 \begin_layout Plain Layout
22827
22828 \size small
22829 Drop down/up
22830 \end_layout
22831
22832 \end_inset
22833 </cell>
22834 <cell alignment="left" valignment="top" usebox="none">
22835 \begin_inset Text
22836
22837 \begin_layout Plain Layout
22838
22839 \size small
22840 Normal/reversed rain drop
22841 \end_layout
22842
22843 \end_inset
22844 </cell>
22845 <cell alignment="left" valignment="top" usebox="none">
22846 \begin_inset Text
22847
22848 \begin_layout Plain Layout
22849
22850 \size small
22851 Fragile,
22852  calculation might fail
22853 \end_layout
22854
22855 \end_inset
22856 </cell>
22857 </row>
22858 <row interlinespace="default">
22859 <cell alignment="left" valignment="top" usebox="none">
22860 \begin_inset Text
22861
22862 \begin_layout Plain Layout
22863
22864 \size small
22865 \SpecialChar TeX
22866
22867 \end_layout
22868
22869 \end_inset
22870 </cell>
22871 <cell alignment="left" valignment="top" usebox="none">
22872 \begin_inset Text
22873
22874 \begin_layout Plain Layout
22875
22876 \size small
22877 The \SpecialChar TeX
22878  logo
22879 \end_layout
22880
22881 \end_inset
22882 </cell>
22883 <cell alignment="left" valignment="top" usebox="none">
22884 \begin_inset Text
22885
22886 \begin_layout Plain Layout
22887
22888 \size small
22889 -
22890 \end_layout
22891
22892 \end_inset
22893 </cell>
22894 </row>
22895 <row interlinespace="default">
22896 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
22897 \begin_inset Text
22898
22899 \begin_layout Plain Layout
22900
22901 \size small
22902 Triangle up/down/
22903 \begin_inset Newline newline
22904 \end_inset
22905
22906 left/right
22907 \end_layout
22908
22909 \end_inset
22910 </cell>
22911 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
22912 \begin_inset Text
22913
22914 \begin_layout Plain Layout
22915
22916 \size small
22917 Triangles in different orientations
22918 \end_layout
22919
22920 \end_inset
22921 </cell>
22922 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
22923 \begin_inset Text
22924
22925 \begin_layout Plain Layout
22926
22927 \size small
22928 -
22929 \end_layout
22930
22931 \end_inset
22932 </cell>
22933 </row>
22934 </lyxtabular>
22935
22936 \end_inset
22937
22938
22939 \end_layout
22940
22941 \begin_layout Standard
22942 To use a shape for your paragraph,
22943  simply select it in \SpecialChar LyX
22944 's pull-down box for environments in the toolbar.
22945 \end_layout
22946
22947 \begin_layout Standard
22948 \begin_inset Newpage newpage
22949 \end_inset
22950
22951
22952 \end_layout
22953
22954 \begin_layout Standard
22955 Here is an example paragraph in the shape of a nut:
22956 \end_layout
22957
22958 \begin_layout Standard
22959 \begin_inset VSpace bigskip
22960 \end_inset
22961
22962
22963 \end_layout
22964
22965 \begin_layout Nut
22966
22967 \lang latin
22968 Lorem ipsum dolor sit amet,
22969  consetetur sadipscing elitr,
22970  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22971  sed diam voluptua.
22972  At vero eos et accusam et justo duo dolores et ea rebum.
22973  Stet clita kasd gubergren,
22974  no sea takimata sanctus est Lorem ipsum dolor sit amet.
22975  Lorem ipsum dolor sit amet,
22976  consetetur sadipscing elitr,
22977  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22978  sed diam voluptua.
22979 \end_layout
22980
22981 \begin_layout Standard
22982 \begin_inset VSpace bigskip
22983 \end_inset
22984
22985
22986 \end_layout
22987
22988 \begin_layout Standard
22989 \begin_inset Note Greyedout
22990 status open
22991
22992 \begin_layout Plain Layout
22993
22994 \series bold
22995 Note
22996 \series default
22997 :
22998
22999 \family sans
23000 shapepar
23001 \family default
23002  paragraphs cannot run over a page break.
23003 \end_layout
23004
23005 \end_inset
23006
23007
23008 \end_layout
23009
23010 \begin_layout Standard
23011 \begin_inset VSpace bigskip
23012 \end_inset
23013
23014
23015 \end_layout
23016
23017 \begin_layout Standard
23018 The package
23019 \begin_inset Flex Code
23020 status collapsed
23021
23022 \begin_layout Plain Layout
23023 shapepar
23024 \end_layout
23025
23026 \end_inset
23027
23028  takes care that the shape will always be preserved,
23029  no matter how much text is in the paragraph.
23030  Therefore the paragraph size changes with the amount of contained text.
23031  This can lead to paragraph sizes exceeding the page margins.
23032  To demonstrate the size scaling,
23033  here is the same example paragraph but with twice as much text:
23034 \end_layout
23035
23036 \begin_layout Standard
23037 \begin_inset Newpage newpage
23038 \end_inset
23039
23040
23041 \end_layout
23042
23043 \begin_layout Nut
23044
23045 \lang latin
23046 Lorem ipsum dolor sit amet,
23047  consetetur sadipscing elitr,
23048  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
23049  sed diam voluptua.
23050  At vero eos et accusam et justo duo dolores et ea rebum.
23051  Stet clita kasd gubergren,
23052  no sea takimata sanctus est Lorem ipsum dolor sit amet.
23053  Lorem ipsum dolor sit amet,
23054  consetetur sadipscing elitr,
23055  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
23056  sed diam voluptua.
23057  Lorem 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  Lorem ipsum dolor sit amet,
23065  consetetur sadipscing elitr,
23066  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
23067  sed diam voluptua.
23068 \end_layout
23069
23070 \begin_layout Standard
23071 \begin_inset VSpace bigskip
23072 \end_inset
23073
23074
23075 \end_layout
23076
23077 \begin_layout Standard
23078 An exception is the shape
23079 \family sans
23080 CDlabel
23081 \family default
23082 .
23083  It cannot be scaled because it must fit the size of a CD/DVD.
23084  Therefore the amount of text that fits into the shape is limited.
23085 \begin_inset Newline newline
23086 \end_inset
23087
23088 The
23089 \family sans
23090 drop
23091 \family default
23092  shapes and the
23093 \family sans
23094 circle
23095 \family default
23096  shape are fragile,
23097  meaning that the calculation of their size can fail,
23098  depending on the amount of text.
23099  You will then get the \SpecialChar LaTeX
23100  error
23101 \begin_inset Quotes eld
23102 \end_inset
23103
23104 Arithmetic overflow
23105 \begin_inset Quotes erd
23106 \end_inset
23107
23108 .
23109  In this case one can try to remove or add some text;
23110  if nothing works one has to use another shape.
23111 \end_layout
23112
23113 \begin_layout Standard
23114 \begin_inset VSpace bigskip
23115 \end_inset
23116
23117
23118 \end_layout
23119
23120 \begin_layout Standard
23121 For shapes with tips you will maybe see that \SpecialChar LaTeX
23122 's hyphenation routine fails for text in the tips.
23123  Therefore it is often necessary to add hyphenation points
23124 \family sans
23125 (
23126 \begin_inset Info
23127 type  "shortcut"
23128 arg   "specialchar-insert hyphenation"
23129 \end_inset
23130
23131
23132 \family default
23133 ) to the corresponding text parts.
23134 \end_layout
23135
23136 \begin_layout Standard
23137 \begin_inset VSpace bigskip
23138 \end_inset
23139
23140
23141 \end_layout
23142
23143 \begin_layout Standard
23144 Shapepar paragraphs are either always centered or placed on the page so that their left border touches the left page margin.
23145  You can therefore not use the paragraph dialog to align such paragraphs.
23146  A solution is to put the paragraph into a minipage or parbox and align the box.
23147  The problem is hereby to find the right width for the box.
23148  Because if it is too wide and you center the box,
23149  the paragraph is not centered too because it sticks at the left side of the box.
23150  So you might have to play a bit with the width until it fits.
23151  Here are two heart-shaped paragraphs,
23152  the first one is not aligned,
23153  the second one is right-aligned:
23154 \end_layout
23155
23156 \begin_layout Standard
23157 \begin_inset Newpage newpage
23158 \end_inset
23159
23160
23161 \end_layout
23162
23163 \begin_layout Heart
23164 \noindent
23165
23166 \lang latin
23167 Lo\SpecialChar softhyphen
23168 rem ipsum dolor sit amet,
23169  consetetur sadipscing elitr,
23170  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
23171  sed diam voluptua.
23172  At vero eos et accusam et justo duo dolores et ea rebum.
23173  Stet clita kasd gubergren,
23174  no sea takimata sanctus est Lorem ipsum dolor sit amet.
23175 \end_layout
23176
23177 \begin_layout Standard
23178 \begin_inset VSpace bigskip
23179 \end_inset
23180
23181
23182 \end_layout
23183
23184 \begin_layout Standard
23185 \noindent
23186 \align right
23187 \begin_inset Box Frameless
23188 position "t"
23189 hor_pos "c"
23190 has_inner_box 1
23191 inner_pos "t"
23192 use_parbox 1
23193 use_makebox 0
23194 width "42col%"
23195 special "none"
23196 height "1in"
23197 height_special "totalheight"
23198 thickness "0.4pt"
23199 separation "3pt"
23200 shadowsize "4pt"
23201 framecolor "black"
23202 backgroundcolor "none"
23203 status open
23204
23205 \begin_layout Heart
23206 \noindent
23207
23208 \lang latin
23209 Lo\SpecialChar softhyphen
23210 rem ipsum dolor sit amet,
23211  consetetur sadipscing elitr,
23212  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
23213  sed diam voluptua.
23214  At vero eos et accusam et justo duo dolores et ea rebum.
23215  Stet clita kasd gubergren,
23216  no sea takimata sanctus est Lorem ipsum dolor sit amet.
23217 \end_layout
23218
23219 \end_inset
23220
23221
23222 \end_layout
23223
23224 \begin_layout Subsubsection
23225 Custom shapes
23226 \end_layout
23227
23228 \begin_layout Standard
23229 You can define any shape you want.
23230  Doing this manually is a lot of work because every coordinate must be specified.
23231  But there is a way to let the computer calculate the coordinates:
23232 \end_layout
23233
23234 \begin_layout Enumerate
23235 Install the program
23236 \begin_inset CommandInset href
23237 LatexCommand href
23238 name "Jpgfdraw"
23239 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
23240 literal "false"
23241
23242 \end_inset
23243
23244 .
23245 \end_layout
23246
23247 \begin_layout Enumerate
23248 In
23249 \family sans
23250 Jpgfdraw
23251 \family default
23252  go to the menu
23253 \family sans
23254 TeX/LaTeX\SpecialChar menuseparator
23255 Settings\SpecialChar menuseparator
23256 Set Normal Size
23257 \family default
23258  and select the font size you are using in your document.
23259  For example this document uses the size 12
23260 \begin_inset space \thinspace{}
23261 \end_inset
23262
23263 pt.
23264 \end_layout
23265
23266 \begin_layout Enumerate
23267 Draw a shape.
23268 \end_layout
23269
23270 \begin_layout Enumerate
23271 Use the menu
23272 \family sans
23273 TeX/LaTeX\SpecialChar menuseparator
23274 Shapepar
23275 \family default
23276  to export the shape to coordinates.
23277  In the appearing dialog use either the outline of your shape for the coordinates or the path itself.
23278 \begin_inset Foot
23279 status collapsed
23280
23281 \begin_layout Plain Layout
23282 For more information see
23283 \begin_inset CommandInset href
23284 LatexCommand href
23285 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
23286 literal "false"
23287
23288 \end_inset
23289
23290
23291 \end_layout
23292
23293 \end_inset
23294
23295
23296 \end_layout
23297
23298 \begin_layout Standard
23299 The coordinates are written into a \SpecialChar TeX
23300  file.
23301  To use it for your \SpecialChar LyX
23302  document
23303 \end_layout
23304
23305 \begin_layout Enumerate
23306 Place the cursor before the first character of your paragraph (or into a new empty one).
23307 \end_layout
23308
23309 \begin_layout Enumerate
23310 Open in \SpecialChar LyX
23311  the menu
23312 \family sans
23313 Insert\SpecialChar menuseparator
23314 File\SpecialChar menuseparator
23315 Child
23316 \begin_inset space ~
23317 \end_inset
23318
23319 Document
23320 \family default
23321 ,
23322  select the file and use
23323 \family sans
23324 Input
23325 \family default
23326  as
23327 \family sans
23328 Include Type.
23329 \end_layout
23330
23331 \begin_layout Standard
23332 \begin_inset VSpace defskip
23333 \end_inset
23334
23335
23336 \end_layout
23337
23338 \begin_layout Standard
23339 \begin_inset Note Greyedout
23340 status open
23341
23342 \begin_layout Plain Layout
23343
23344 \series bold
23345 Note
23346 \series default
23347 :
23348  The changed shape only applies to the current paragraph;
23349  everything is reset to normal for the next paragraph.
23350  Therefore the shape definition file must be input into every paragraph with the desired shape.
23351 \end_layout
23352
23353 \end_inset
23354
23355
23356 \end_layout
23357
23358 \begin_layout Standard
23359 \begin_inset VSpace bigskip
23360 \end_inset
23361
23362
23363 \end_layout
23364
23365 \begin_layout Standard
23366 Here is an example:
23367 \end_layout
23368
23369 \begin_layout Standard
23370 \begin_inset VSpace bigskip
23371 \end_inset
23372
23373
23374 \end_layout
23375
23376 \begin_layout Standard
23377 \begin_inset CommandInset include
23378 LatexCommand input
23379 filename "SpecialParagraphShape.tex"
23380 literal "true"
23381
23382 \end_inset
23383
23384
23385 \lang latin
23386 Lorem ipsum dolor sit amet,
23387  consetetur sadipscing elitr,
23388  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
23389  sed diam voluptua.
23390  At vero eos et accusam et justo duo dolores et ea rebum.
23391  Stet clita kasd gubergren,
23392  no sea takimata sanctus est Lorem ipsum dolor sit amet.
23393  Lorem ipsum dolor sit amet,
23394  consetetur sadipscing elitr,
23395  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
23396  sed diam voluptua.
23397 \end_layout
23398
23399 \begin_layout Standard
23400 \begin_inset VSpace bigskip
23401 \end_inset
23402
23403
23404 \end_layout
23405
23406 \begin_layout Standard
23407
23408 \series bold
23409 A tip:
23410
23411 \series default
23412  to draw complexer shapes in
23413 \family sans
23414 Jpgfdraw
23415 \family default
23416  you can draw the shape in a program of your choice and import the resulting image to
23417 \family sans
23418 Jpgfdraw
23419 \family default
23420 .
23421  Then you only need to draw a line or spline along the outline of the image.
23422 \end_layout
23423
23424 \begin_layout Standard
23425 \begin_inset VSpace bigskip
23426 \end_inset
23427
23428
23429 \end_layout
23430
23431 \begin_layout Standard
23432 The module
23433 \family sans
23434 Custom paragraph shapes
23435 \family default
23436  also provides the two commands
23437 \family sans
23438 shapepar
23439 \family default
23440  and
23441 \family sans
23442 Shapepar
23443 \family default
23444  which can be used to define custom shapes coordinate by coordinate.
23445 \begin_inset Foot
23446 status collapsed
23447
23448 \begin_layout Plain Layout
23449 These commands are internally used for all shapes described here.
23450 \end_layout
23451
23452 \end_inset
23453
23454  For information how these styles are used and about further customization possibilities,
23455  have a look at the
23456 \begin_inset CommandInset href
23457 LatexCommand href
23458 name "documentation"
23459 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
23460 literal "false"
23461
23462 \end_inset
23463
23464  of the package
23465 \begin_inset Flex Code
23466 status collapsed
23467
23468 \begin_layout Plain Layout
23469 shapepar
23470 \end_layout
23471
23472 \end_inset
23473
23474 .
23475 \end_layout
23476
23477 \begin_layout Subsection
23478
23479 \change_inserted 564990737 1672311925
23480 Hanging Paragraphs
23481 \end_layout
23482
23483 \begin_layout Hanging
23484
23485 \change_inserted 564990737 1672311925
23486 This module adds the
23487 \family sans
23488 Hanging
23489 \family default
23490  paragraph style,
23491  that is,
23492  one where all but the first line of the paragraph is indented.
23493  This may not appear in your \SpecialChar LyX
23494  document but will appear in the final output.
23495 \end_layout
23496
23497 \begin_layout Subsection
23498
23499 \change_inserted 564990737 1672311925
23500 \begin_inset CommandInset label
23501 LatexCommand label
23502 name "subsec:Initials"
23503
23504 \end_inset
23505
23506 Initials (Drop Caps)
23507 \end_layout
23508
23509 \begin_layout Initial
23510
23511 \change_inserted 564990737 1672311925
23512 \begin_inset Argument 2
23513 status open
23514
23515 \begin_layout Plain Layout
23516
23517 \change_inserted 564990737 1672311925
23518 T
23519 \change_unchanged
23520
23521 \end_layout
23522
23523 \end_inset
23524
23525
23526 \begin_inset Argument 3
23527 status open
23528
23529 \begin_layout Plain Layout
23530
23531 \change_inserted 564990737 1672311925
23532 his
23533 \change_unchanged
23534
23535 \end_layout
23536
23537 \end_inset
23538
23539  module adds a drop capitals paragraph style
23540 \family sans
23541 Initials
23542 \family default
23543  for paragraph environments which you can use wherever you want to have drop capitals.
23544  You then have three more items in the
23545 \family sans
23546 Insert
23547 \family default
23548  menu:
23549 \end_layout
23550
23551 \begin_layout Itemize
23552
23553 \change_inserted 564990737 1672311925
23554
23555 \family sans
23556 Initial
23557 \family default
23558  which creates an inset for the drop capital
23559 \end_layout
23560
23561 \begin_layout Itemize
23562
23563 \change_inserted 564990737 1672311925
23564
23565 \family sans
23566 Rest of initial
23567 \family default
23568  which creates an inset for the rest of the word
23569 \end_layout
23570
23571 \begin_layout Itemize
23572
23573 \change_inserted 564990737 1672311925
23574
23575 \family sans
23576 Options
23577 \family default
23578  which allow you configure the formatting of the drop capital.
23579 \end_layout
23580
23581 \begin_layout Standard
23582
23583 \change_inserted 564990737 1672311925
23584 To customize the appearance of the style,
23585  see
23586 \family sans
23587 Help\SpecialChar menuseparator
23588 Embedded Objects\SpecialChar menuseparator
23589 Objects Surrounded by Text\SpecialChar menuseparator
23590 Initials
23591 \family default
23592 .
23593 \end_layout
23594
23595 \begin_layout Section
23596
23597 \change_inserted 564990737 1672312011
23598 Text Markup
23599 \end_layout
23600
23601 \begin_layout Subsection
23602
23603 \change_inserted 564990737 1672312011
23604 Hyphenatable Text Markup
23605 \end_layout
23606
23607 \begin_layout Standard
23608
23609 \change_inserted 564990737 1672312011
23610 This package defines text styles to highlight,
23611  space-out,
23612  strike-through,
23613  underline and capitalize/small-cap text by means of the
23614 \family sans
23615 soul
23616 \family default
23617  package.
23618  As opposed to the markup provided by the Text Properties dialog,
23619  words marked-up with
23620 \family sans
23621 soul
23622 \family default
23623  are hyphenated.
23624  See the
23625 \begin_inset CommandInset href
23626 LatexCommand href
23627 name "soul documentation"
23628 target "http://mirrors.ctan.org/macros/generic/soul/soul.pdf"
23629 literal "false"
23630
23631 \end_inset
23632
23633 .
23634 \end_layout
23635
23636 \begin_layout Subsection
23637
23638 \change_inserted 564990737 1672312011
23639 Logical Markup
23640 \end_layout
23641
23642 \begin_layout Standard
23643
23644 \change_inserted 564990737 1672312011
23645 This module defines some character styles for logical markup:
23646
23647 \noun on
23648
23649 \begin_inset Flex Noun
23650 status collapsed
23651
23652 \begin_layout Plain Layout
23653
23654 \change_inserted 564990737 1672312011
23655
23656 \noun on
23657 noun
23658 \change_unchanged
23659
23660 \end_layout
23661
23662 \end_inset
23663
23664
23665 \noun default
23666 ,
23667
23668 \emph on
23669
23670 \begin_inset Flex Emph
23671 status collapsed
23672
23673 \begin_layout Plain Layout
23674
23675 \change_inserted 564990737 1672312011
23676
23677 \emph on
23678 emph
23679 \change_unchanged
23680
23681 \end_layout
23682
23683 \end_inset
23684
23685
23686 \emph default
23687 ,
23688
23689 \begin_inset Flex Strong
23690 status collapsed
23691
23692 \begin_layout Plain Layout
23693
23694 \change_inserted 564990737 1672312011
23695 strong
23696 \change_unchanged
23697
23698 \end_layout
23699
23700 \end_inset
23701
23702 ,
23703  and
23704 \begin_inset Flex Code
23705 status collapsed
23706
23707 \begin_layout Plain Layout
23708
23709 \change_inserted 564990737 1672312011
23710 code
23711 \change_unchanged
23712
23713 \end_layout
23714
23715 \end_inset
23716
23717  which are accessed via the
23718 \family sans
23719 \bar under
23720 E
23721 \bar default
23722 dit\SpecialChar menuseparator
23723 Custom
23724 \begin_inset space ~
23725 \end_inset
23726
23727 Text
23728 \begin_inset space ~
23729 \end_inset
23730
23731
23732 \bar under
23733 S
23734 \bar default
23735 tyles
23736 \family default
23737  menu.
23738 \end_layout
23739
23740 \begin_layout Chapter
23741
23742 \change_deleted 564990737 1671304317
23743 Customizing
23744 \change_unchanged
23745 Bibliograph
23746 \change_inserted 564990737 1671304322
23747 y
23748 \change_deleted 564990737 1671304331
23749 ies with Bib\SpecialChar TeX
23750  or Biblatex
23751 \change_unchanged
23752
23753 \end_layout
23754
23755 \begin_layout Standard
23756 The most basic information about how to use Bib\SpecialChar TeX
23757  or
23758 \family sans
23759 Biblatex
23760 \family default
23761  with \SpecialChar LyX
23762  is contained in the section
23763 \emph on
23764 Bibliography databases
23765 \emph default
23766  of the
23767 \emph on
23768 User's Guide
23769 \emph default
23770 .
23771  The following subsections explain special bibliography features supported by \SpecialChar LyX
23772 .
23773 \end_layout
23774
23775 \begin_layout Section
23776 Alternative Citation Styles
23777 \end_layout
23778
23779 \begin_layout Standard
23780 Standard Bib\SpecialChar TeX
23781  uses numbers (e.
23782 \begin_inset space \thinspace{}
23783 \end_inset
23784
23785 g.
23786 \begin_inset space \space{}
23787 \end_inset
23788
23789
23790 \begin_inset Quotes eld
23791 \end_inset
23792
23793 [12]
23794 \begin_inset Quotes erd
23795 \end_inset
23796
23797 ) to refer to a cited work.
23798  However,
23799  in many scientific disciplines,
23800  other citation styles are in use.
23801  The most common one is the author-year style (e.
23802 \begin_inset space \thinspace{}
23803 \end_inset
23804
23805 g.
23806 \begin_inset space \space{}
23807 \end_inset
23808
23809
23810 \begin_inset Quotes eld
23811 \end_inset
23812
23813 Knuth 1984a
23814 \begin_inset Quotes erd
23815 \end_inset
23816
23817 ).
23818  \SpecialChar LyX
23819  supports three packages that provide this style,
23820
23821 \begin_inset Flex Code
23822 status collapsed
23823
23824 \begin_layout Plain Layout
23825 biblatex
23826 \end_layout
23827
23828 \end_inset
23829
23830 ,
23831
23832 \begin_inset Flex Code
23833 status collapsed
23834
23835 \begin_layout Plain Layout
23836 natbib
23837 \end_layout
23838
23839 \end_inset
23840
23841 ,
23842  and
23843 \begin_inset Flex Code
23844 status collapsed
23845
23846 \begin_layout Plain Layout
23847 jurabib
23848 \end_layout
23849
23850 \end_inset
23851
23852 .
23853  Each of these packages has their pros and cons,
23854  which cannot be listed in detail.
23855  If you only want to have simple author-year (or author-numerical) style,
23856  or if you want to use one of the countless style files for
23857 \begin_inset Flex Code
23858 status collapsed
23859
23860 \begin_layout Plain Layout
23861 natbib
23862 \end_layout
23863
23864 \end_inset
23865
23866 ,
23867  then the established
23868 \begin_inset Flex Code
23869 status collapsed
23870
23871 \begin_layout Plain Layout
23872 natbib
23873 \end_layout
23874
23875 \end_inset
23876
23877  package is probably your choice.
23878  If you look for specific citation styles common in law studies,
23879  you might consider the
23880 \begin_inset Flex Code
23881 status collapsed
23882
23883 \begin_layout Plain Layout
23884 jurabib
23885 \end_layout
23886
23887 \end_inset
23888
23889  package.
23890  If you want to have full control over the formatting or look for advanced features such as ibidem,
23891  footnote citations,
23892  full title citations,
23893  advanced date formats (such as 400 BC) or full localization to other languages than English,
23894  you should definitely consider
23895 \begin_inset Flex Code
23896 status collapsed
23897
23898 \begin_layout Plain Layout
23899 biblatex
23900 \end_layout
23901
23902 \end_inset
23903
23904 ,
23905  which exceeds all other packages in terms of features,
23906  but is also quite heavy and more resource-hungry.
23907 \end_layout
23908
23909 \begin_layout Standard
23910 The handling of these packages in \SpecialChar LyX
23911  is basically the same.
23912  Go to
23913 \begin_inset Flex Noun
23914 status collapsed
23915
23916 \begin_layout Plain Layout
23917 Document\SpecialChar menuseparator
23918 Settings
23919 \end_layout
23920
23921 \end_inset
23922
23923  and select under
23924 \begin_inset Flex Noun
23925 status collapsed
23926
23927 \begin_layout Plain Layout
23928 Bibliography
23929 \end_layout
23930
23931 \end_inset
23932
23933  the
23934 \begin_inset Flex Noun
23935 status collapsed
23936
23937 \begin_layout Plain Layout
23938 Style Format
23939 \end_layout
23940
23941 \end_inset
23942
23943
23944 \begin_inset Flex Noun
23945 status collapsed
23946
23947 \begin_layout Plain Layout
23948 Basic (BibTeX)
23949 \end_layout
23950
23951 \end_inset
23952
23953 ,
23954
23955 \begin_inset Flex Noun
23956 status collapsed
23957
23958 \begin_layout Plain Layout
23959 Biblatex
23960 \end_layout
23961
23962 \end_inset
23963
23964 ,
23965
23966 \begin_inset Flex Noun
23967 status collapsed
23968
23969 \begin_layout Plain Layout
23970 Biblatex (Natbib mode)
23971 \end_layout
23972
23973 \end_inset
23974
23975 ,
23976
23977 \begin_inset Flex Noun
23978 status collapsed
23979
23980 \begin_layout Plain Layout
23981 Natbib (BibTeX)
23982 \end_layout
23983
23984 \end_inset
23985
23986  or
23987 \begin_inset Flex Noun
23988 status collapsed
23989
23990 \begin_layout Plain Layout
23991 Jurabib (BibTeX)
23992 \end_layout
23993
23994 \end_inset
23995
23996  (see sec.
23997 \begin_inset space ~
23998 \end_inset
23999
24000 6.5.3 in the User's Guide for more information on these choices).
24001  With all these packages,
24002  you will get some extra features in the citation dialog and you can select the style of the reference (
24003 \begin_inset Quotes eld
24004 \end_inset
24005
24006 Knuth 1984
24007 \begin_inset Quotes erd
24008 \end_inset
24009
24010 ,
24011
24012 \begin_inset Quotes eld
24013 \end_inset
24014
24015 Knuth (1984)
24016 \begin_inset Quotes erd
24017 \end_inset
24018
24019 ,
24020
24021 \begin_inset Quotes eld
24022 \end_inset
24023
24024 Knuth,
24025  1984
24026 \begin_inset Quotes erd
24027 \end_inset
24028
24029 ,
24030
24031 \begin_inset Quotes eld
24032 \end_inset
24033
24034 1984
24035 \begin_inset Quotes erd
24036 \end_inset
24037
24038  etc.).
24039  Note that either package needs specifically designed style files.
24040  They all ship their own,
24041  but there are lots of additional style files,
24042  and there is even an interactive style file builder
24043 \begin_inset Foot
24044 status collapsed
24045
24046 \begin_layout Plain Layout
24047 See
24048 \begin_inset Flex URL
24049 status open
24050
24051 \begin_layout Plain Layout
24052
24053 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
24054 \end_layout
24055
24056 \end_inset
24057
24058
24059 \end_layout
24060
24061 \end_inset
24062
24063  for
24064 \begin_inset Flex Code
24065 status collapsed
24066
24067 \begin_layout Plain Layout
24068 natbib
24069 \end_layout
24070
24071 \end_inset
24072
24073 .
24074 \end_layout
24075
24076 \begin_layout Section
24077 Subdivided Bibliographies
24078 \end_layout
24079
24080 \begin_layout Standard
24081 Sometimes you might need to divide your bibliography into several sections.
24082  If you are for instance a historian,
24083  the possibility to separate sources and scientific works is most likely a
24084 \begin_inset Quotes eld
24085 \end_inset
24086
24087 must have
24088 \begin_inset Quotes erd
24089 \end_inset
24090
24091 .
24092  Unfortunately,
24093  Bib\SpecialChar TeX
24094  itself does not allow you to do this.
24095  But with the help of some \SpecialChar LaTeX
24096  packages,
24097  Bib\SpecialChar TeX
24098  can be extended to fit your needs.
24099 \end_layout
24100
24101 \begin_layout Standard
24102 \SpecialChar LyX
24103  provides native support for one of these packages,
24104
24105 \family typewriter
24106 bibtopic
24107 \family default
24108 .
24109 \begin_inset Foot
24110 status collapsed
24111
24112 \begin_layout Plain Layout
24113 Available from
24114 \begin_inset Flex URL
24115 status open
24116
24117 \begin_layout Plain Layout
24118
24119 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
24120 \end_layout
24121
24122 \end_inset
24123
24124
24125 \end_layout
24126
24127 \end_inset
24128
24129  The advantage of this package (compared to other packages such as
24130 \family typewriter
24131 multibib
24132 \family default
24133 ) is that you don't need to define new citation commands.
24134  Instead,
24135  you need to prepare different bibliographic databases which include the entries for the different sections of the bibliography.
24136  For example:
24137  If you want to divide your bibliography into the sections
24138 \begin_inset Quotes eld
24139 \end_inset
24140
24141 Sources
24142 \begin_inset Quotes erd
24143 \end_inset
24144
24145  and
24146 \begin_inset Quotes eld
24147 \end_inset
24148
24149 Scientific works
24150 \begin_inset Quotes erd
24151 \end_inset
24152
24153 ,
24154  you first need to create two bibliographic databases,
24155  e.
24156 \begin_inset space \thinspace{}
24157 \end_inset
24158
24159 g.
24160 \begin_inset space \space{}
24161 \end_inset
24162
24163
24164 \begin_inset Flex Code
24165 status collapsed
24166
24167 \begin_layout Plain Layout
24168 sources.bib
24169 \end_layout
24170
24171 \end_inset
24172
24173  and
24174 \begin_inset Flex Code
24175 status collapsed
24176
24177 \begin_layout Plain Layout
24178 scientific.bib
24179 \end_layout
24180
24181 \end_inset
24182
24183 .
24184
24185 \end_layout
24186
24187 \begin_layout Standard
24188 Go to
24189 \begin_inset Flex Noun
24190 status collapsed
24191
24192 \begin_layout Plain Layout
24193 Document\SpecialChar menuseparator
24194 Settings
24195 \end_layout
24196
24197 \end_inset
24198
24199  and check under
24200 \begin_inset Flex Noun
24201 status collapsed
24202
24203 \begin_layout Plain Layout
24204 Bibliography
24205 \end_layout
24206
24207 \end_inset
24208
24209  the option
24210 \begin_inset Flex Noun
24211 status collapsed
24212
24213 \begin_layout Plain Layout
24214 Subdivided bibliography
24215 \end_layout
24216
24217 \end_inset
24218
24219 .
24220  Now you can insert multiple Bib\SpecialChar TeX
24221  bibliographies,
24222  one for each section of your bibliography.
24223  Returning to our example:
24224  Insert the Bib\SpecialChar TeX
24225  bibliography
24226 \begin_inset Flex Code
24227 status collapsed
24228
24229 \begin_layout Plain Layout
24230 sources.bib
24231 \end_layout
24232
24233 \end_inset
24234
24235  and a second one for the database
24236 \begin_inset Flex Code
24237 status collapsed
24238
24239 \begin_layout Plain Layout
24240 scientific.bib
24241 \end_layout
24242
24243 \end_inset
24244
24245 .
24246  You are free to use the same or different styles for each section.
24247  Additionally,
24248  you can choose if the bibliography section should contain
24249 \begin_inset Quotes eld
24250 \end_inset
24251
24252 all cited references
24253 \begin_inset Quotes erd
24254 \end_inset
24255
24256  of the specified database(s) (which is the default),
24257
24258 \begin_inset Quotes eld
24259 \end_inset
24260
24261 all uncited references
24262 \begin_inset Quotes erd
24263 \end_inset
24264
24265  or even
24266 \begin_inset Quotes eld
24267 \end_inset
24268
24269 all references
24270 \begin_inset Quotes erd
24271 \end_inset
24272
24273 .
24274  This might be useful if you would like to separate your bibliography into three sections:
24275
24276 \begin_inset Quotes eld
24277 \end_inset
24278
24279 Cited sources
24280 \begin_inset Quotes erd
24281 \end_inset
24282
24283 ,
24284
24285 \begin_inset Quotes eld
24286 \end_inset
24287
24288 Uncited sources
24289 \begin_inset Quotes erd
24290 \end_inset
24291
24292 ,
24293  and
24294 \begin_inset Quotes eld
24295 \end_inset
24296
24297 Scientific works
24298 \begin_inset Quotes erd
24299 \end_inset
24300
24301 .
24302  The titles for the sections can be added as ordinary sections or subsections.
24303  Since
24304 \begin_inset Flex Code
24305 status collapsed
24306
24307 \begin_layout Plain Layout
24308 bibtopic
24309 \end_layout
24310
24311 \end_inset
24312
24313  removes the bibliography title,
24314  you have to manually re-add that,
24315  too (as a chapter* or section*,
24316  for instance).
24317 \end_layout
24318
24319 \begin_layout Standard
24320 With
24321 \family sans
24322 Biblatex
24323 \family default
24324 ,
24325  the procedure is a bit different.
24326  Since
24327 \family typewriter
24328 bibtopic
24329 \family default
24330  does not work with
24331 \family sans
24332 Biblatex
24333 \family default
24334 ,
24335  the aforementioned
24336 \begin_inset Flex Noun
24337 status collapsed
24338
24339 \begin_layout Plain Layout
24340 Subdivided bibliography
24341 \end_layout
24342
24343 \end_inset
24344
24345  option is disabled if you use
24346 \family sans
24347 Biblatex
24348 \family default
24349 .
24350  However,
24351
24352 \family sans
24353 Biblatex
24354 \family default
24355  provides its own means to generate subdivided bibliographies.
24356  You can either add keywords to bibliography entries via the
24357 \begin_inset Flex Code
24358 status collapsed
24359
24360 \begin_layout Plain Layout
24361 keywords
24362 \end_layout
24363
24364 \end_inset
24365
24366  entry option and then filter bibliography sections by keyword (by adding
24367 \begin_inset Flex Code
24368 status collapsed
24369
24370 \begin_layout Plain Layout
24371 keyword=mykeyword
24372 \end_layout
24373
24374 \end_inset
24375
24376  to the
24377 \begin_inset Flex Noun
24378 status collapsed
24379
24380 \begin_layout Plain Layout
24381 Options
24382 \end_layout
24383
24384 \end_inset
24385
24386  field of the dialog that opens if you left-click on the
24387 \begin_inset Flex Noun
24388 status collapsed
24389
24390 \begin_layout Plain Layout
24391 Biblatex Generated Bibliography
24392 \end_layout
24393
24394 \end_inset
24395
24396  button),
24397  or you can filter by entry types (such as
24398 \emph on
24399 book
24400 \emph default
24401  or
24402 \emph on
24403 article
24404 \emph default
24405 ) by entering e.
24406 \begin_inset space \thinspace{}
24407 \end_inset
24408
24409 g.
24410
24411 \begin_inset Flex Code
24412 status collapsed
24413
24414 \begin_layout Plain Layout
24415 type=book
24416 \end_layout
24417
24418 \end_inset
24419
24420  or
24421 \begin_inset Flex Code
24422 status collapsed
24423
24424 \begin_layout Plain Layout
24425 nottype=collection
24426 \end_layout
24427
24428 \end_inset
24429
24430  to the mentioned
24431 \begin_inset Flex Noun
24432 status collapsed
24433
24434 \begin_layout Plain Layout
24435 Options
24436 \end_layout
24437
24438 \end_inset
24439
24440  field,
24441  or you can create so-called
24442 \begin_inset Quotes eld
24443 \end_inset
24444
24445 Bibliography Categories
24446 \begin_inset Quotes erd
24447 \end_inset
24448
24449  to which you can assign individual entries.
24450  Please refer to the Biblatex manual,
24451  section
24452 \emph on
24453 Subdivided Bibliographies
24454 \emph default
24455 ,
24456  for details.
24457 \end_layout
24458
24459 \begin_layout Section
24460 Multiple Bibliographies
24461 \begin_inset CommandInset label
24462 LatexCommand label
24463 name "subsec:Multiple-Bibliographies"
24464
24465 \end_inset
24466
24467
24468 \end_layout
24469
24470 \begin_layout Standard
24471 Multiple bibliographies,
24472  e.
24473 \begin_inset space \thinspace{}
24474 \end_inset
24475
24476 g.
24477 \begin_inset space \space{}
24478 \end_inset
24479
24480 a bibliography for each part,
24481  chapter,
24482  section,
24483  subsection or child (sub-document) of the document,
24484  are also supported by \SpecialChar LyX
24485 .
24486  In order to enable it,
24487  go to
24488 \begin_inset Flex Noun
24489 status collapsed
24490
24491 \begin_layout Plain Layout
24492 Document\SpecialChar menuseparator
24493 Settings\SpecialChar menuseparator
24494 Bibliography
24495 \end_layout
24496
24497 \end_inset
24498
24499  and select the relevant unit (e.
24500 \begin_inset space \thinspace{}
24501 \end_inset
24502
24503 g.,
24504
24505 \begin_inset Quotes eld
24506 \end_inset
24507
24508 per section
24509 \begin_inset Quotes erd
24510 \end_inset
24511
24512 ) in the
24513 \begin_inset Flex Noun
24514 status collapsed
24515
24516 \begin_layout Plain Layout
24517 Multiple Bibliographies
24518 \end_layout
24519
24520 \end_inset
24521
24522  combo box.
24523  Then add a Bib(la)\SpecialChar TeX
24524  bibliography to each unit (e.
24525 \begin_inset space \thinspace{}
24526 \end_inset
24527
24528 g.,
24529  section) of your document.
24530  In the output,
24531  a separate bibliography,
24532  containing only the references done in the current unit is generated.
24533 \end_layout
24534
24535 \begin_layout Standard
24536 If you use Bib\SpecialChar TeX
24537 ,
24538  either the
24539 \begin_inset Flex Code
24540 status collapsed
24541
24542 \begin_layout Plain Layout
24543 chapterbib
24544 \end_layout
24545
24546 \end_inset
24547
24548  or the
24549 \begin_inset Flex Code
24550 status collapsed
24551
24552 \begin_layout Plain Layout
24553 bibtopic
24554 \end_layout
24555
24556 \end_inset
24557
24558  package is used to create multiple bibliographies.
24559  The former package is used if you select
24560 \begin_inset Quotes eld
24561 \end_inset
24562
24563 per child document
24564 \begin_inset Quotes erd
24565 \end_inset
24566
24567  and do
24568 \emph on
24569 not
24570 \emph default
24571  check
24572 \begin_inset Flex Noun
24573 status collapsed
24574
24575 \begin_layout Plain Layout
24576 Sectioned Bibliography
24577 \end_layout
24578
24579 \end_inset
24580
24581 .
24582  In all other cases,
24583
24584 \begin_inset Flex Code
24585 status collapsed
24586
24587 \begin_layout Plain Layout
24588 bibtopic
24589 \end_layout
24590
24591 \end_inset
24592
24593  is used.
24594 \begin_inset Foot
24595 status collapsed
24596
24597 \begin_layout Plain Layout
24598 An alternative approach,
24599  if you are willing to use some
24600 \begin_inset Flex Noun
24601 status collapsed
24602
24603 \begin_layout Plain Layout
24604 \SpecialChar TeX
24605  Code
24606 \end_layout
24607
24608 \end_inset
24609
24610  (see section
24611 \begin_inset space ~
24612 \end_inset
24613
24614
24615 \begin_inset CommandInset ref
24616 LatexCommand ref
24617 reference "sec:Inserting-TeX-Code"
24618 nolink "false"
24619
24620 \end_inset
24621
24622 ),
24623  is to use the
24624 \begin_inset Flex Code
24625 status collapsed
24626
24627 \begin_layout Plain Layout
24628 bibunits
24629 \end_layout
24630
24631 \end_inset
24632
24633  package.
24634 \end_layout
24635
24636 \end_inset
24637
24638  If
24639 \begin_inset Flex Code
24640 status collapsed
24641
24642 \begin_layout Plain Layout
24643 bibtopic
24644 \end_layout
24645
24646 \end_inset
24647
24648  is used,
24649  \SpecialChar LyX
24650  encloses the specified units in
24651 \begin_inset Flex Code
24652 status collapsed
24653
24654 \begin_layout Plain Layout
24655 bibtopic
24656 \end_layout
24657
24658 \end_inset
24659
24660 's
24661 \begin_inset Flex Code
24662 status collapsed
24663
24664 \begin_layout Plain Layout
24665
24666 \backslash
24667 begin{btUnit}
24668 \end_layout
24669
24670 \end_inset
24671
24672  and
24673 \begin_inset Flex Code
24674 status collapsed
24675
24676 \begin_layout Plain Layout
24677
24678 \backslash
24679 end{btUnit}
24680 \end_layout
24681
24682 \end_inset
24683
24684  in order to create the units.
24685  Note that this approach has some limitations.
24686  First,
24687  every citation reference has to be inside some
24688 \begin_inset Flex Code
24689 status collapsed
24690
24691 \begin_layout Plain Layout
24692 btUnit
24693 \end_layout
24694
24695 \end_inset
24696
24697 .
24698  So citations outside a defined unit (e.
24699 \begin_inset space \thinspace{}
24700 \end_inset
24701
24702 g.,
24703  before the first section if you use
24704 \begin_inset Quotes eld
24705 \end_inset
24706
24707 by section
24708 \begin_inset Quotes erd
24709 \end_inset
24710
24711 ) will appear as
24712 \begin_inset Quotes eld
24713 \end_inset
24714
24715 ???
24716 \begin_inset Quotes erd
24717 \end_inset
24718
24719 .
24720  You can also create your own units by entering
24721 \begin_inset Flex Code
24722 status collapsed
24723
24724 \begin_layout Plain Layout
24725
24726 \backslash
24727 begin{btUnit}
24728 \end_layout
24729
24730 \end_inset
24731
24732  and
24733 \begin_inset Flex Code
24734 status collapsed
24735
24736 \begin_layout Plain Layout
24737
24738 \backslash
24739 end{btUnit}
24740 \end_layout
24741
24742 \end_inset
24743
24744  as \SpecialChar TeX
24745  code (for instance to work around the mentioned limitation).
24746  Note,
24747  though,
24748  that
24749 \begin_inset Flex Code
24750 status collapsed
24751
24752 \begin_layout Plain Layout
24753 btUnit
24754 \end_layout
24755
24756 \end_inset
24757
24758 s cannot be nested.
24759  A second limitation is that
24760 \begin_inset Flex Code
24761 status collapsed
24762
24763 \begin_layout Plain Layout
24764 bibtopic
24765 \end_layout
24766
24767 \end_inset
24768
24769  always processes all references of a bibliography database,
24770  even if they are not cited.
24771  This can result in odd labels (e.
24772 \begin_inset space \thinspace{}
24773 \end_inset
24774
24775 g.
24776
24777 \begin_inset Quotes eld
24778 \end_inset
24779
24780 Miller 2014b
24781 \begin_inset Quotes erd
24782 \end_inset
24783
24784  if two works of this author from 2014 are in the database,
24785  even if only one is cited).
24786 \end_layout
24787
24788 \begin_layout Standard
24789 If you use
24790 \family sans
24791 Biblatex
24792 \family default
24793 ,
24794  the
24795 \begin_inset Flex Code
24796 status collapsed
24797
24798 \begin_layout Plain Layout
24799 refsection
24800 \end_layout
24801
24802 \end_inset
24803
24804  option is used instead.
24805  If you need specific units,
24806  you can start them with the \SpecialChar TeX
24807  code
24808 \begin_inset Flex Code
24809 status collapsed
24810
24811 \begin_layout Plain Layout
24812
24813 \backslash
24814 newrefsection
24815 \end_layout
24816
24817 \end_inset
24818
24819  or
24820 \begin_inset Flex Code
24821 status collapsed
24822
24823 \begin_layout Plain Layout
24824
24825 \backslash
24826 newrefsegment
24827 \end_layout
24828
24829 \end_inset
24830
24831 ,
24832  respectively.
24833  If you also want to control the end of the unit,
24834  use the environment
24835 \begin_inset Flex Code
24836 status collapsed
24837
24838 \begin_layout Plain Layout
24839
24840 \backslash
24841 begin{refsection}
24842 \end_layout
24843
24844 \end_inset
24845
24846  \SpecialChar ldots
24847
24848 \begin_inset Flex Code
24849 status collapsed
24850
24851 \begin_layout Plain Layout
24852
24853 \backslash
24854 end{refsection}
24855 \end_layout
24856
24857 \end_inset
24858
24859  instead.
24860  Note,
24861  though,
24862  that
24863 \begin_inset Flex Code
24864 status collapsed
24865
24866 \begin_layout Plain Layout
24867 refsection
24868 \end_layout
24869
24870 \end_inset
24871
24872 s cannot be nested.
24873  In addition to the individual bibliography of the current unit,
24874
24875 \family sans
24876 Biblatex
24877 \family default
24878  also provides an easy way to output all bibliographies,
24879  subsequently,
24880  at one place (e.
24881 \begin_inset space \thinspace{}
24882 \end_inset
24883
24884 g.,
24885  at the end of the document).
24886  Select
24887 \begin_inset Quotes eld
24888 \end_inset
24889
24890 all reference units
24891 \begin_inset Quotes erd
24892 \end_inset
24893
24894  from the Content combo box of the Bib(la)TeX inset dialog in order to achieve this.
24895  Please refer to the
24896 \family sans
24897 Biblatex
24898 \family default
24899  manual for more information on this topic.
24900 \end_layout
24901
24902 \begin_layout Chapter
24903
24904 \change_deleted 564990737 1671355654
24905 Itemize
24906 \change_unchanged
24907 Bullet
24908 \change_inserted 564990737 1671355667
24909 s
24910 \change_deleted 564990737 1671355661
24911  Selection
24912 \change_inserted 564990737 1671355684
24913
24914 \begin_inset CommandInset label
24915 LatexCommand label
24916 name "chap:bullets"
24917
24918 \end_inset
24919
24920
24921 \change_deleted 564990737 1671355684
24922
24923 \begin_inset CommandInset label
24924 LatexCommand label
24925 name "sec:bullet"
24926
24927 \end_inset
24928
24929
24930 \change_unchanged
24931
24932 \end_layout
24933
24934 \begin_layout Standard
24935 by
24936 \noun on
24937  Allan Rae
24938 \end_layout
24939
24940 \begin_layout Section
24941 Introduction
24942 \end_layout
24943
24944 \begin_layout Standard
24945 \SpecialChar LyX
24946  provides 216 bullet shapes that can be accessed from a simple dialog.
24947  Using this dialog you can easily specify what bullet shape to use at each level of an itemized list.
24948  These settings are document-wide so you won't be able to specify different sets of bullets for different paragraphs.
24949 \begin_inset Foot
24950 status collapsed
24951
24952 \begin_layout Plain Layout
24953 Well,
24954  actually you can but you'll have to do it by hand.
24955 \end_layout
24956
24957 \end_inset
24958
24959
24960 \end_layout
24961
24962 \begin_layout Section
24963 How it looks
24964 \end_layout
24965
24966 \begin_layout Standard
24967 Open the dialog by selecting the
24968 \begin_inset Flex Noun
24969 status collapsed
24970
24971 \begin_layout Plain Layout
24972 Document\SpecialChar menuseparator
24973 Settings
24974 \end_layout
24975
24976 \end_inset
24977
24978  menu item and then select the
24979 \begin_inset Flex Noun
24980 status collapsed
24981
24982 \begin_layout Plain Layout
24983 Bullets
24984 \end_layout
24985
24986 \end_inset
24987
24988  tab.
24989 \end_layout
24990
24991 \begin_layout Standard
24992 The dialog provides you with a table of bullet shapes.
24993  A column of buttons on the left of the table provides access to the six different panels of bullet shapes.
24994  The row of buttons across the top is used to select which bullet depth you are changing.
24995
24996 \change_deleted 244031559 1603875981
24997  A text entry under the table shows the currently selected bullet shape's \SpecialChar LaTeX
24998  equivalent and this can be edited if desired.
24999  If you do modify the text you will also need to specify any needed packages in the \SpecialChar LaTeX
25000  preamble.
25001 \change_unchanged
25002
25003 \end_layout
25004
25005 \begin_layout Standard
25006 The six panels are divided up by the packages they require.
25007  The following table shows the mappings from button name to \SpecialChar LaTeX
25008  package.
25009 \end_layout
25010
25011 \begin_layout Standard
25012 \align center
25013 \begin_inset Tabular
25014 <lyxtabular version="3" rows="7" columns="2">
25015 <features tabularvalignment="middle">
25016 <column alignment="center" valignment="top" width="0pt">
25017 <column alignment="center" valignment="top" width="0pt">
25018 <row>
25019 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25020 \begin_inset Text
25021
25022 \begin_layout Plain Layout
25023
25024 \family roman
25025 \series medium
25026 \shape up
25027 \size normal
25028 \emph off
25029 \bar no
25030 \noun off
25031 \color none
25032 Button
25033 \end_layout
25034
25035 \end_inset
25036 </cell>
25037 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25038 \begin_inset Text
25039
25040 \begin_layout Plain Layout
25041
25042 \family roman
25043 \series medium
25044 \shape up
25045 \size normal
25046 \emph off
25047 \bar no
25048 \noun off
25049 \color none
25050 Packages Required
25051 \end_layout
25052
25053 \end_inset
25054 </cell>
25055 </row>
25056 <row>
25057 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25058 \begin_inset Text
25059
25060 \begin_layout Plain Layout
25061
25062 \family sans
25063 \series medium
25064 \shape up
25065 \size normal
25066 \emph off
25067 \bar no
25068 \noun off
25069 \color none
25070 Standard
25071 \end_layout
25072
25073 \end_inset
25074 </cell>
25075 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25076 \begin_inset Text
25077
25078 \begin_layout Plain Layout
25079
25080 \series medium
25081 \shape up
25082 \size normal
25083 \emph off
25084 \bar no
25085 \noun off
25086 \color none
25087 base \SpecialChar LaTeX
25088
25089 \end_layout
25090
25091 \end_inset
25092 </cell>
25093 </row>
25094 <row>
25095 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25096 \begin_inset Text
25097
25098 \begin_layout Plain Layout
25099
25100 \family sans
25101 \series medium
25102 \shape up
25103 \size normal
25104 \emph off
25105 \bar no
25106 \noun off
25107 \color none
25108 Maths
25109 \end_layout
25110
25111 \end_inset
25112 </cell>
25113 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25114 \begin_inset Text
25115
25116 \begin_layout Plain Layout
25117
25118 \family typewriter
25119 \series medium
25120 \shape up
25121 \size normal
25122 \emph off
25123 \bar no
25124 \noun off
25125 \color none
25126 amssymb.sty
25127 \end_layout
25128
25129 \end_inset
25130 </cell>
25131 </row>
25132 <row>
25133 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25134 \begin_inset Text
25135
25136 \begin_layout Plain Layout
25137
25138 \family sans
25139 \series medium
25140 \shape up
25141 \size normal
25142 \emph off
25143 \bar no
25144 \noun off
25145 \color none
25146 Ding1
25147 \end_layout
25148
25149 \end_inset
25150 </cell>
25151 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25152 \begin_inset Text
25153
25154 \begin_layout Plain Layout
25155
25156 \family typewriter
25157 \series medium
25158 \shape up
25159 \size normal
25160 \emph off
25161 \bar no
25162 \noun off
25163 \color none
25164 pifont.sty
25165 \end_layout
25166
25167 \end_inset
25168 </cell>
25169 </row>
25170 <row>
25171 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25172 \begin_inset Text
25173
25174 \begin_layout Plain Layout
25175
25176 \family sans
25177 \series medium
25178 \shape up
25179 \size normal
25180 \emph off
25181 \bar no
25182 \noun off
25183 \color none
25184 Ding2
25185 \end_layout
25186
25187 \end_inset
25188 </cell>
25189 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25190 \begin_inset Text
25191
25192 \begin_layout Plain Layout
25193
25194 \family typewriter
25195 \series medium
25196 \shape up
25197 \size normal
25198 \emph off
25199 \bar no
25200 \noun off
25201 \color none
25202 pifont.sty
25203 \end_layout
25204
25205 \end_inset
25206 </cell>
25207 </row>
25208 <row>
25209 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25210 \begin_inset Text
25211
25212 \begin_layout Plain Layout
25213
25214 \family sans
25215 \series medium
25216 \shape up
25217 \size normal
25218 \emph off
25219 \bar no
25220 \noun off
25221 \color none
25222 Ding3
25223 \end_layout
25224
25225 \end_inset
25226 </cell>
25227 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25228 \begin_inset Text
25229
25230 \begin_layout Plain Layout
25231
25232 \family typewriter
25233 \series medium
25234 \shape up
25235 \size normal
25236 \emph off
25237 \bar no
25238 \noun off
25239 \color none
25240 pifont.sty
25241 \end_layout
25242
25243 \end_inset
25244 </cell>
25245 </row>
25246 <row>
25247 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25248 \begin_inset Text
25249
25250 \begin_layout Plain Layout
25251
25252 \family sans
25253 \series medium
25254 \shape up
25255 \size normal
25256 \emph off
25257 \bar no
25258 \noun off
25259 \color none
25260 Ding4
25261 \end_layout
25262
25263 \end_inset
25264 </cell>
25265 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25266 \begin_inset Text
25267
25268 \begin_layout Plain Layout
25269
25270 \family typewriter
25271 \series medium
25272 \shape up
25273 \size normal
25274 \emph off
25275 \bar no
25276 \noun off
25277 \color none
25278 pifont.sty
25279 \end_layout
25280
25281 \end_inset
25282 </cell>
25283 </row>
25284 </lyxtabular>
25285
25286 \end_inset
25287
25288
25289 \end_layout
25290
25291 \begin_layout Standard
25292 \SpecialChar LyX
25293  doesn't stop you using bullets from packages you don't have.
25294  If you get errors from \SpecialChar LaTeX
25295  when you try to view or print the file,
25296  then it is likely you are missing a package.
25297 \begin_inset Foot
25298 status collapsed
25299
25300 \begin_layout Plain Layout
25301 \SpecialChar LyX
25302  doesn't restrict your use since you may be editing locally and exporting elsewhere.
25303 \end_layout
25304
25305 \end_inset
25306
25307
25308 \end_layout
25309
25310 \begin_layout Section
25311 How to use it
25312 \end_layout
25313
25314 \begin_layout Standard
25315 Select which bullet depth you want to change then select the bullet shape and size.
25316  Any changes will not be visible in \SpecialChar LyX
25317 ,
25318  but are visible when viewing the document.
25319 \end_layout
25320
25321 \begin_layout Standard
25322 You can reset a bullet shape to the default simply by clicking your right mouse button on the appropriate bullet depth button.
25323 \begin_inset Foot
25324 status open
25325
25326 \begin_layout Plain Layout
25327
25328 \change_inserted 564990737 1672138075
25329 \begin_inset CommandInset label
25330 LatexCommand label
25331 name "fn:If-you-really"
25332
25333 \end_inset
25334
25335
25336 \change_unchanged
25337 If you
25338 \emph on
25339 really
25340 \emph default
25341  want to have multiple sets of paragraphs with different sets of bullets in each,
25342  then you're going to have to get your hands dirty with \SpecialChar TeX
25343  code.
25344  The bullet selection dialog can help though because it provides you with the \SpecialChar LaTeX
25345  code for a wide range of bullet shapes.
25346  To make your own custom paragraphs you have the following options:
25347 \end_layout
25348
25349 \begin_layout Plain Layout
25350 \begin_inset ERT
25351 status open
25352
25353 \begin_layout Plain Layout
25354
25355
25356 \backslash
25357 let
25358 \backslash
25359 savelabelitemi=
25360 \backslash
25361 labelitemi
25362 \end_layout
25363
25364 \end_inset
25365
25366
25367 \end_layout
25368
25369 \begin_layout Plain Layout
25370 \begin_inset ERT
25371 status open
25372
25373 \begin_layout Plain Layout
25374
25375
25376 \backslash
25377 renewcommand
25378 \backslash
25379 labelitemi[0]{
25380 \backslash
25381 small
25382 \backslash
25383 (
25384 \backslash
25385 sharp
25386 \backslash
25387 )}
25388 \end_layout
25389
25390 \end_inset
25391
25392
25393 \end_layout
25394
25395 \begin_layout Itemize
25396 Use the \SpecialChar LaTeX
25397  command
25398 \begin_inset Flex Code
25399 status collapsed
25400
25401 \begin_layout Plain Layout
25402
25403 \backslash
25404 renewcommand{}{}
25405 \end_layout
25406
25407 \end_inset
25408
25409  to specify a new bullet shape for a given depth.
25410  You'll also need to save the current bullet shape so you can restore it again afterwards.
25411  In this itemized list the following \SpecialChar LaTeX
25412  code was used to change the bullet used for the first depth.
25413 \end_layout
25414
25415 \begin_deeper
25416 \begin_layout LyX-Code
25417
25418 \backslash
25419 let
25420 \backslash
25421 savelabelitemi=
25422 \backslash
25423 labelitemi
25424 \end_layout
25425
25426 \begin_layout LyX-Code
25427
25428 \backslash
25429 renewcommand
25430 \backslash
25431 labelitemi[0]{
25432 \backslash
25433 small
25434 \backslash
25435 (
25436 \backslash
25437 sharp
25438 \backslash
25439 )}
25440 \end_layout
25441
25442 \end_deeper
25443 \begin_layout Itemize
25444 Note that the itemize depth is specified in Roman numerals as part of the
25445 \family typewriter
25446
25447 \backslash
25448 labelitem
25449 \family default
25450  command.
25451 \end_layout
25452
25453 \begin_layout Itemize
25454 \begin_inset Argument item:1
25455 status open
25456
25457 \begin_layout Plain Layout
25458 \begin_inset ERT
25459 status open
25460
25461 \begin_layout Plain Layout
25462
25463
25464 \backslash
25465 (
25466 \backslash
25467 star
25468 \backslash
25469 )
25470 \end_layout
25471
25472 \end_inset
25473
25474
25475 \end_layout
25476
25477 \end_inset
25478
25479  Specify each individual entry by starting each item with the bullet shape enclosed in a
25480 \begin_inset Quotes eld
25481 \end_inset
25482
25483 Custom Item
25484 \begin_inset Quotes erd
25485 \end_inset
25486
25487  inset (available at
25488 \family sans
25489 Insert\SpecialChar menuseparator
25490 Custom Item
25491 \family default
25492 ) and set as
25493 \begin_inset Flex Noun
25494 status collapsed
25495
25496 \begin_layout Plain Layout
25497 \SpecialChar TeX
25498  Code
25499 \end_layout
25500
25501 \end_inset
25502
25503 .
25504  For example,
25505  this item was started with
25506 \begin_inset Flex Code
25507 status collapsed
25508
25509 \begin_layout Plain Layout
25510
25511 \backslash
25512 (
25513 \backslash
25514 star
25515 \backslash
25516 )
25517 \end_layout
25518
25519 \end_inset
25520
25521 .
25522 \end_layout
25523
25524 \begin_layout Plain Layout
25525 \begin_inset ERT
25526 status open
25527
25528 \begin_layout Plain Layout
25529
25530
25531 \backslash
25532 renewcommand
25533 \backslash
25534 labelitemi[0]{
25535 \backslash
25536 savelabelitemi}
25537 \end_layout
25538
25539 \end_inset
25540
25541
25542 \end_layout
25543
25544 \begin_layout Plain Layout
25545 You'll also need to revert the labelitem back to its previous setting for the global bullet shape settings to remain in effect.
25546  The way used here was:
25547 \end_layout
25548
25549 \begin_layout LyX-Code
25550
25551 \backslash
25552 renewcommand
25553 \backslash
25554 labelitemi[0]{
25555 \backslash
25556 savelabelitemi}
25557 \end_layout
25558
25559 \end_inset
25560
25561
25562 \end_layout
25563
25564 \begin_layout Chapter
25565 Supplemental Tools
25566 \end_layout
25567
25568 \begin_layout Section
25569 Multipart Documents
25570 \end_layout
25571
25572 \begin_layout Subsection
25573 General Operation
25574 \end_layout
25575
25576 \begin_layout Standard
25577 When you are working on a large file with many sections,
25578  it is often convenient to break up the document into several files,
25579  or perhaps you have something where a table may change from time to time,
25580  but the preceding text does not.
25581  In these cases,
25582  you should seriously consider using multipart documents.
25583  For example,
25584  scientific papers often have five major sections:
25585  the introduction,
25586  observations,
25587  results,
25588  discussion,
25589  and conclusion.
25590  Each of these could be its own separate \SpecialChar LyX
25591  file,
25592  with one
25593 \begin_inset Quotes eld
25594 \end_inset
25595
25596 master
25597 \begin_inset Quotes erd
25598 \end_inset
25599
25600  file which contains the title,
25601  authors,
25602  abstract,
25603  references,
25604  etc.,
25605  plus the five included files.
25606  It is important to note that each of these files is a full \SpecialChar LyX
25607  file which can be formatted and printed on its own,
25608  as well as included in a master file.
25609  Each of these files must have the same document class,
25610  however—
25611 don't attempt to mix book classes with article classes.
25612  You may also include \SpecialChar LaTeX
25613  files;
25614  however,
25615  these files must not have their own preamble (i.
25616 \begin_inset space \thinspace{}
25617 \end_inset
25618
25619 e.
25620 \begin_inset space \space{}
25621 \end_inset
25622
25623 everything up to and including the
25624 \begin_inset Flex Code
25625 status collapsed
25626
25627 \begin_layout Plain Layout
25628
25629 \backslash
25630 begin{document}
25631 \end_layout
25632
25633 \end_inset
25634
25635  line as well as the
25636 \begin_inset Flex Code
25637 status collapsed
25638
25639 \begin_layout Plain Layout
25640
25641 \backslash
25642 end{document}
25643 \end_layout
25644
25645 \end_inset
25646
25647  line must be deleted) or else errors will be generated when you try to make a DVI file.
25648 \end_layout
25649
25650 \begin_layout Standard
25651 \SpecialChar LyX
25652  allows you to include files quite easily with
25653 \begin_inset Flex Noun
25654 status collapsed
25655
25656 \begin_layout Plain Layout
25657 Insert\SpecialChar menuseparator
25658 Child
25659 \begin_inset space ~
25660 \end_inset
25661
25662 Document
25663 \end_layout
25664
25665 \end_inset
25666
25667 .
25668  When you click on this selection a small box is inserted into the file at the current cursor location.
25669  Clicking on the box raises a dialog which allows you to select the file to be included,
25670  and the method of its inclusion.
25671
25672 \end_layout
25673
25674 \begin_layout Standard
25675 The file selection box should by now be obvious.
25676  The three inclusion methods are
25677 \begin_inset Quotes eld
25678 \end_inset
25679
25680 include
25681 \begin_inset Quotes erd
25682 \end_inset
25683
25684 ,
25685
25686 \begin_inset Quotes eld
25687 \end_inset
25688
25689 input
25690 \begin_inset Quotes erd
25691 \end_inset
25692
25693 ,
25694  and
25695 \begin_inset Quotes eld
25696 \end_inset
25697
25698 verbatim
25699 \begin_inset Quotes erd
25700 \end_inset
25701
25702 .
25703  The methods
25704 \begin_inset Quotes eld
25705 \end_inset
25706
25707 include
25708 \begin_inset Quotes erd
25709 \end_inset
25710
25711  and
25712 \begin_inset Quotes eld
25713 \end_inset
25714
25715 input
25716 \begin_inset Quotes erd
25717 \end_inset
25718
25719  are similar in many ways,
25720  but there are also some notable differences:
25721 \end_layout
25722
25723 \begin_layout Enumerate
25724 Files that are
25725 \begin_inset Quotes eld
25726 \end_inset
25727
25728 included
25729 \begin_inset Quotes erd
25730 \end_inset
25731
25732  are typeset beginning on a new page,
25733  while files that are
25734 \begin_inset Quotes eld
25735 \end_inset
25736
25737 inputted
25738 \begin_inset Quotes erd
25739 \end_inset
25740
25741  are typeset starting on the current page.
25742 \end_layout
25743
25744 \begin_layout Enumerate
25745 \begin_inset Quotes eld
25746 \end_inset
25747
25748 Included
25749 \begin_inset Quotes erd
25750 \end_inset
25751
25752  files cannot themselves
25753 \begin_inset Quotes eld
25754 \end_inset
25755
25756 include
25757 \begin_inset Quotes erd
25758 \end_inset
25759
25760  further files (
25761 \begin_inset Quotes eld
25762 \end_inset
25763
25764 grandchilds
25765 \begin_inset Quotes erd
25766 \end_inset
25767
25768 ).
25769  With
25770 \begin_inset Quotes eld
25771 \end_inset
25772
25773 input
25774 \begin_inset Quotes erd
25775 \end_inset
25776
25777 ,
25778  on the other hand,
25779  infinite sub-inputting is possible.
25780 \end_layout
25781
25782 \begin_layout Enumerate
25783 \begin_inset Quotes eld
25784 \end_inset
25785
25786 Include
25787 \begin_inset Quotes erd
25788 \end_inset
25789
25790  allow for the output of only selected
25791 \begin_inset Quotes eld
25792 \end_inset
25793
25794 included
25795 \begin_inset Quotes erd
25796 \end_inset
25797
25798  files,
25799  while maintaining the actual counters (pagination etc.) and references (please refer to the section
25800 \emph on
25801 Child
25802 \begin_inset space ~
25803 \end_inset
25804
25805 Documents
25806 \emph default
25807  of the
25808 \emph on
25809 Embedded
25810 \begin_inset space ~
25811 \end_inset
25812
25813 Objects
25814 \emph default
25815  manual for details).
25816 \end_layout
25817
25818 \begin_layout Standard
25819 Hence,
25820
25821 \begin_inset Quotes eld
25822 \end_inset
25823
25824 include
25825 \begin_inset Quotes erd
25826 \end_inset
25827
25828  is the preferred method for chapters that are outsourced to child documents,
25829  while
25830 \begin_inset Quotes eld
25831 \end_inset
25832
25833 input
25834 \begin_inset Quotes erd
25835 \end_inset
25836
25837  is more suitable for arbitrary file inheritance.
25838 \end_layout
25839
25840 \begin_layout Standard
25841 A
25842 \begin_inset Quotes eld
25843 \end_inset
25844
25845 verbatim
25846 \begin_inset Quotes erd
25847 \end_inset
25848
25849  included file allows you to include a file typeset exactly as it appears in the file,
25850  i.
25851 \begin_inset space \thinspace{}
25852 \end_inset
25853
25854 e.
25855 \begin_inset space \space{}
25856 \end_inset
25857
25858 in
25859 \begin_inset Flex Code
25860 status collapsed
25861
25862 \begin_layout Plain Layout
25863 verbatim
25864 \end_layout
25865
25866 \end_inset
25867
25868  mode,
25869  with the characters set in a fixed-width typewriter font.
25870  Normally,
25871  spaces in this file are invisible,
25872  though two consecutive spaces are conserved,
25873  unlike \SpecialChar LyX
25874 's normal treatment of spaces.
25875  However,
25876  setting the
25877 \begin_inset Flex Noun
25878 status collapsed
25879
25880 \begin_layout Plain Layout
25881 Mark
25882 \begin_inset space ~
25883 \end_inset
25884
25885 spaces
25886 \begin_inset space ~
25887 \end_inset
25888
25889 in
25890 \begin_inset space ~
25891 \end_inset
25892
25893 output
25894 \end_layout
25895
25896 \end_inset
25897
25898  checkbox typesets a mark to unambiguously define the presence of a space.
25899
25900 \end_layout
25901
25902 \begin_layout Standard
25903 Generally,
25904  the master file is converted into a full \SpecialChar LaTeX
25905  file before typesetting,
25906  while the included files are converted to \SpecialChar LaTeX
25907  files that do not have all the preamble information.
25908 \end_layout
25909
25910 \begin_layout Subsection
25911 Cross-References Between Files
25912 \end_layout
25913
25914 \begin_layout Standard
25915 \begin_inset Box Shadowbox
25916 position "t"
25917 hor_pos "c"
25918 has_inner_box 1
25919 inner_pos "t"
25920 use_parbox 0
25921 use_makebox 0
25922 width "100col%"
25923 special "none"
25924 height "1in"
25925 height_special "totalheight"
25926 thickness "0.4pt"
25927 separation "3pt"
25928 shadowsize "4pt"
25929 framecolor "black"
25930 backgroundcolor "none"
25931 status open
25932
25933 \begin_layout Plain Layout
25934 This section is somewhat out of date.
25935  Need to describe default master documents and how children are opened when the master is.
25936  [[FIXME]]
25937 \end_layout
25938
25939 \end_inset
25940
25941
25942 \end_layout
25943
25944 \begin_layout Standard
25945 It is possible to set up cross-references between the different files.
25946  First,
25947  open all the files in question:
25948  let's call them A and B in a two file example,
25949  where B is included in A.
25950  Let's say you insert a label in A,
25951  then want to reference it in B.
25952  Open the cross-reference dialog whilst in document B,
25953  and you can select the
25954 \begin_inset Quotes eld
25955 \end_inset
25956
25957 buffer
25958 \begin_inset Quotes erd
25959 \end_inset
25960
25961  to use.
25962 \end_layout
25963
25964 \begin_layout Subsection
25965 Bibliography Lists in all Subdocuments
25966 \end_layout
25967
25968 \begin_layout Standard
25969 If you work with child documents,
25970  you might want to have only one main bibliography at the end,
25971  but still be able to have a selected bibliography for the child if you output it on its own.
25972  Here is how to achieve this.
25973 \end_layout
25974
25975 \begin_layout Standard
25976 For the main document,
25977  you just insert a bibliography inset at the place where the main bibliography has to appear (within the master file or within a child).
25978  If the bibliography inset is in the master file,
25979  the references will be inherited by all children,
25980  so they are available in the citation dialog within each child.
25981 \end_layout
25982
25983 \begin_layout Standard
25984 For child-specific bibliographies,
25985  insert bibliography insets within the child documents,
25986  at the place where the bibliography should appear when the child is compiled separately.
25987  However,
25988  the trick is to insert them into a branch (
25989 \family sans
25990 Insert\SpecialChar menuseparator
25991 Branch\SpecialChar menuseparator
25992 Insert New Branch...
25993 \family default
25994 ),
25995  e.
25996 \begin_inset space \thinspace{}
25997 \end_inset
25998
25999 g.
26000  called
26001 \begin_inset Quotes eld
26002 \end_inset
26003
26004 Childonly
26005 \begin_inset Quotes erd
26006 \end_inset
26007
26008 .
26009  Within the children,
26010  activate the branch (
26011 \family sans
26012 Document\SpecialChar menuseparator
26013 Settings...\SpecialChar menuseparator
26014 Branches
26015 \family default
26016 ).
26017  Within the master,
26018  deactivate the branch (
26019 \family sans
26020 Document\SpecialChar menuseparator
26021 Settings...\SpecialChar menuseparator
26022 Branches
26023 \family default
26024 ).
26025  Now the child's bibliography will be ignored by the master,
26026  but considered by the child.
26027 \end_layout
26028
26029 \begin_layout Standard
26030 If you need multiple bibliographies (e.
26031 \begin_inset space \thinspace{}
26032 \end_inset
26033
26034 g.,
26035  one per child in the
26036 \emph on
26037 main document
26038 \emph default
26039 ),
26040  please refer to sec.
26041 \begin_inset space ~
26042 \end_inset
26043
26044
26045 \begin_inset CommandInset ref
26046 LatexCommand ref
26047 reference "subsec:Multiple-Bibliographies"
26048 nolink "false"
26049
26050 \end_inset
26051
26052 .
26053 \end_layout
26054
26055 \begin_layout Section
26056 \SpecialChar LyX
26057  Archives
26058 \end_layout
26059
26060 \begin_layout Standard
26061 Users sometimes need to be able to
26062 \begin_inset Quotes eld
26063 \end_inset
26064
26065 bundle
26066 \begin_inset Quotes erd
26067 \end_inset
26068
26069  a \SpecialChar LyX
26070  file together with all the images (and other files) on which it depends,
26071  either for sending to a publisher or for sharing with a co-author.
26072  \SpecialChar LyX
26073  includes a Python script (
26074 \begin_inset Flex Code
26075 status collapsed
26076
26077 \begin_layout Plain Layout
26078 lyxpak.py
26079 \end_layout
26080
26081 \end_inset
26082
26083 ) that automates this process.
26084  To use it,
26085  you must have either the
26086 \begin_inset Flex Code
26087 status collapsed
26088
26089 \begin_layout Plain Layout
26090 zipfile
26091 \end_layout
26092
26093 \end_inset
26094
26095  or
26096 \begin_inset Flex Code
26097 status collapsed
26098
26099 \begin_layout Plain Layout
26100 tarfile
26101 \end_layout
26102
26103 \end_inset
26104
26105  python modules installed on your system.
26106  By default,
26107  the script prefers the
26108 \begin_inset Flex Code
26109 status collapsed
26110
26111 \begin_layout Plain Layout
26112 gzip
26113 \end_layout
26114
26115 \end_inset
26116
26117 -compressed
26118 \begin_inset Flex Code
26119 status collapsed
26120
26121 \begin_layout Plain Layout
26122 tar
26123 \end_layout
26124
26125 \end_inset
26126
26127  format on Unix-like systems and the
26128 \begin_inset Flex Code
26129 status collapsed
26130
26131 \begin_layout Plain Layout
26132 zip
26133 \end_layout
26134
26135 \end_inset
26136
26137  format on Windows.
26138 \end_layout
26139
26140 \begin_layout Standard
26141 \SpecialChar LyX
26142 's configuration process will set the script up to export a `\SpecialChar LyX
26143  Archive',
26144  and this format will then be available under
26145 \begin_inset Flex Code
26146 status collapsed
26147
26148 \begin_layout Plain Layout
26149 File\SpecialChar menuseparator
26150 Export
26151 \end_layout
26152
26153 \end_inset
26154
26155 .
26156 \end_layout
26157
26158 \begin_layout Standard
26159 Independently of the platform,
26160  the generation of a particular archive format can be forced by adding either the
26161 \begin_inset Flex Code
26162 status collapsed
26163
26164 \begin_layout Plain Layout
26165 -t
26166 \end_layout
26167
26168 \end_inset
26169
26170  (for the
26171 \begin_inset Flex Code
26172 status collapsed
26173
26174 \begin_layout Plain Layout
26175 tar
26176 \end_layout
26177
26178 \end_inset
26179
26180  format) or
26181 \begin_inset Flex Code
26182 status collapsed
26183
26184 \begin_layout Plain Layout
26185 -z
26186 \end_layout
26187
26188 \end_inset
26189
26190  (for the
26191 \begin_inset Flex Code
26192 status collapsed
26193
26194 \begin_layout Plain Layout
26195 zip
26196 \end_layout
26197
26198 \end_inset
26199
26200  format) switch to the
26201 \begin_inset Flex Code
26202 status collapsed
26203
26204 \begin_layout Plain Layout
26205 \SpecialChar LyX
26206 \SpecialChar menuseparator
26207 \SpecialChar LyX
26208  Archive
26209 \end_layout
26210
26211 \end_inset
26212
26213  converter in
26214 \begin_inset Flex Code
26215 status collapsed
26216
26217 \begin_layout Plain Layout
26218 Tools\SpecialChar menuseparator
26219 Preferences\SpecialChar menuseparator
26220 File Handling\SpecialChar menuseparator
26221 Converters
26222 \end_layout
26223
26224 \end_inset
26225
26226 .
26227  (Make sure you add the switch after the script name,
26228  not before it.)
26229 \end_layout
26230
26231 \begin_layout Section
26232 Fancy Headers and Footers
26233 \end_layout
26234
26235 \begin_layout Standard
26236 The default page layout is rather plain;
26237  for an
26238 \begin_inset Flex Code
26239 status collapsed
26240
26241 \begin_layout Plain Layout
26242 article
26243 \end_layout
26244
26245 \end_inset
26246
26247  document class,
26248  all you get is a centered page number at the bottom of the page.
26249  This document uses KOMA-script's book class,
26250  so it appears to be a bit fancier.
26251  But to really put on a show,
26252  you need to set the document page style to
26253 \begin_inset Quotes eld
26254 \end_inset
26255
26256 fancy
26257 \begin_inset Quotes erd
26258 \end_inset
26259
26260 ,
26261  as mentioned in the
26262 \emph on
26263 User Guide
26264 \emph default
26265 .
26266  This section describes the \SpecialChar LaTeX
26267  code you need to insert in your \SpecialChar LaTeX
26268  preamble in order to get the desired effects.
26269 \end_layout
26270
26271 \begin_layout Standard
26272 For more information on fancy headers,
26273  see the
26274 \begin_inset Flex Code
26275 status collapsed
26276
26277 \begin_layout Plain Layout
26278 fancyhdr
26279 \end_layout
26280
26281 \end_inset
26282
26283  package documentation.
26284  (
26285 \begin_inset Flex URL
26286 status collapsed
26287
26288 \begin_layout Plain Layout
26289
26290 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
26291 \end_layout
26292
26293 \end_inset
26294
26295 )
26296 \end_layout
26297
26298 \begin_layout Standard
26299 The page header is divided into three fields,
26300  not surprisingly labeled
26301 \begin_inset Quotes eld
26302 \end_inset
26303
26304 left
26305 \begin_inset Quotes erd
26306 \end_inset
26307
26308 ,
26309
26310 \begin_inset Quotes eld
26311 \end_inset
26312
26313 center
26314 \begin_inset Quotes erd
26315 \end_inset
26316
26317 ,
26318  and
26319 \begin_inset Quotes eld
26320 \end_inset
26321
26322 right
26323 \begin_inset Quotes erd
26324 \end_inset
26325
26326 .
26327  The footer is also divided into these three fields.
26328  The \SpecialChar LaTeX
26329  commands to set these fields in the simplest manner are
26330 \begin_inset Flex Code
26331 status collapsed
26332
26333 \begin_layout Plain Layout
26334
26335 \backslash
26336 lhead
26337 \end_layout
26338
26339 \end_inset
26340
26341 ,
26342
26343 \begin_inset Flex Code
26344 status collapsed
26345
26346 \begin_layout Plain Layout
26347
26348 \backslash
26349 chead
26350 \end_layout
26351
26352 \end_inset
26353
26354 ,
26355
26356 \begin_inset Flex Code
26357 status collapsed
26358
26359 \begin_layout Plain Layout
26360
26361 \backslash
26362 rhead
26363 \end_layout
26364
26365 \end_inset
26366
26367 ,
26368
26369 \begin_inset Flex Code
26370 status collapsed
26371
26372 \begin_layout Plain Layout
26373
26374 \backslash
26375 lfoot
26376 \end_layout
26377
26378 \end_inset
26379
26380 ,
26381  etc.
26382  Suppose you wish to put your name in the upper left hand corner of each page.
26383  Simply insert the following command in the preamble:
26384
26385 \end_layout
26386
26387 \begin_layout Standard
26388
26389 \family typewriter
26390
26391 \backslash
26392 lhead{John Q.
26393  DocWriter}
26394 \end_layout
26395
26396 \begin_layout Standard
26397 You will now see your name in the upper left.
26398  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,
26399  e.
26400 \begin_inset space \thinspace{}
26401 \end_inset
26402
26403 g.:
26404 \end_layout
26405
26406 \begin_layout Standard
26407
26408 \family typewriter
26409
26410 \backslash
26411 cfoot{}
26412 \end_layout
26413
26414 \begin_layout Standard
26415 Let's get really fancy:
26416  lets put the section number with the word
26417 \begin_inset Quotes eld
26418 \end_inset
26419
26420 Section
26421 \begin_inset Quotes erd
26422 \end_inset
26423
26424  (e.
26425 \begin_inset space \thinspace{}
26426 \end_inset
26427
26428 g.
26429 \begin_inset space \space{}
26430 \end_inset
26431
26432 Section 3) in the upper left,
26433  the page number (e.
26434 \begin_inset space \thinspace{}
26435 \end_inset
26436
26437 g.
26438 \begin_inset space \space{}
26439 \end_inset
26440
26441 Page 4) in the upper right,
26442  your name in the lower left,
26443  and the date in the lower right.
26444  The following commands should now appear in the preamble:
26445 \end_layout
26446
26447 \begin_layout Standard
26448
26449 \family typewriter
26450
26451 \backslash
26452 lhead{Section
26453 \backslash
26454 thesection}
26455 \end_layout
26456
26457 \begin_layout Standard
26458
26459 \family typewriter
26460
26461 \backslash
26462 chead{}
26463 \end_layout
26464
26465 \begin_layout Standard
26466
26467 \family typewriter
26468
26469 \backslash
26470 rhead{Page
26471 \backslash
26472 thepage}
26473 \end_layout
26474
26475 \begin_layout Standard
26476
26477 \family typewriter
26478
26479 \backslash
26480 lfoot{John Q.
26481  DocWriter}
26482 \end_layout
26483
26484 \begin_layout Standard
26485
26486 \family typewriter
26487
26488 \backslash
26489 cfoot{}
26490 \end_layout
26491
26492 \begin_layout Standard
26493
26494 \family typewriter
26495
26496 \backslash
26497 rfoot{
26498 \backslash
26499 today}
26500 \end_layout
26501
26502 \begin_layout Standard
26503 The commands
26504 \begin_inset Flex Code
26505 status collapsed
26506
26507 \begin_layout Plain Layout
26508
26509 \backslash
26510 thesection
26511 \end_layout
26512
26513 \end_inset
26514
26515  and
26516 \begin_inset Flex Code
26517 status collapsed
26518
26519 \begin_layout Plain Layout
26520
26521 \backslash
26522 thepage
26523 \end_layout
26524
26525 \end_inset
26526
26527  access \SpecialChar LaTeX
26528 's section and page counters,
26529  and so print out the current section and page number.
26530
26531 \begin_inset Flex Code
26532 status collapsed
26533
26534 \begin_layout Plain Layout
26535
26536 \backslash
26537 today
26538 \end_layout
26539
26540 \end_inset
26541
26542  simply prints out today's date.
26543 \end_layout
26544
26545 \begin_layout Standard
26546 The thicknesses of the horizontal rules drawn beneath the header and above the footer can also be modified.
26547  If you don't want one of the rules,
26548  set its thickness to 0.
26549  The header rule has a default thickness of 0.4pt,
26550  the footer rule is 0pt.
26551  Use commands
26552 \family typewriter
26553
26554 \family default
26555 like
26556 \begin_inset Flex Code
26557 status collapsed
26558
26559 \begin_layout Plain Layout
26560
26561 \backslash
26562 renewcommand{
26563 \backslash
26564 headrulewidth}{0.4pt}
26565 \end_layout
26566
26567 \end_inset
26568
26569  and
26570 \begin_inset Flex Code
26571 status collapsed
26572
26573 \begin_layout Plain Layout
26574
26575 \backslash
26576 renewcommand{
26577 \backslash
26578 footrulewidth}{0.4pt}
26579 \end_layout
26580
26581 \end_inset
26582
26583  to set the thicknesses.
26584 \end_layout
26585
26586 \begin_layout Standard
26587 You can switch the header/footer settings on and off for individual pages using commands like
26588 \begin_inset Flex Code
26589 status collapsed
26590
26591 \begin_layout Plain Layout
26592
26593 \backslash
26594 thispagestyle{empty}
26595 \end_layout
26596
26597 \end_inset
26598
26599 ,
26600
26601 \begin_inset Flex Code
26602 status collapsed
26603
26604 \begin_layout Plain Layout
26605
26606 \backslash
26607 thispagestyle{plain}
26608 \end_layout
26609
26610 \end_inset
26611
26612 ,
26613  and
26614 \begin_inset Flex Code
26615 status collapsed
26616
26617 \begin_layout Plain Layout
26618
26619 \backslash
26620 thispagestyle{fancy}
26621 \end_layout
26622
26623 \end_inset
26624
26625 .
26626  Simply insert them in the text on the page you want changed and mark them as \SpecialChar TeX
26627  code.
26628  In fact,
26629  title pages are marked as plain by default,
26630  while following pages are marked fancy when using the global fancy setting.
26631 \end_layout
26632
26633 \begin_layout Standard
26634 As a final example,
26635  it is possible to include an image in the header or footer.
26636  Suppose you want to put a company logo in the upper lefthand corner.
26637  You might try something like
26638 \end_layout
26639
26640 \begin_layout Standard
26641
26642 \family typewriter
26643
26644 \backslash
26645 lhead{
26646 \backslash
26647 resizebox{1in}{!}{
26648 \backslash
26649 includegraphics{logo.eps}}}
26650 \end_layout
26651
26652 \begin_layout Standard
26653 \noindent
26654 (you may need to preface this with
26655 \begin_inset Flex Code
26656 status collapsed
26657
26658 \begin_layout Plain Layout
26659
26660 \backslash
26661 usepackage{graphics}
26662 \end_layout
26663
26664 \end_inset
26665
26666  if you don't include graphics elsewhere in your document).
26667 \end_layout
26668
26669 \begin_layout Chapter
26670 \SpecialChar LyX
26671  and the World Wide Web
26672 \end_layout
26673
26674 \begin_layout Standard
26675 \SpecialChar LyX
26676  has long supported the export of documents to various web-friendly formats,
26677  such as HTML.
26678  Before version 2.0,
26679  however,
26680  HTML export was always accomplished by the use of external converters.
26681 \begin_inset Foot
26682 status collapsed
26683
26684 \begin_layout Plain Layout
26685 For details on the use of external converters with \SpecialChar LyX
26686 ,
26687  see the
26688 \emph on
26689 Converters
26690 \emph default
26691  section of the Customization manual.
26692 \end_layout
26693
26694 \end_inset
26695
26696  These fall into two large groups:
26697  there are converters that use \SpecialChar LaTeX
26698  as an intermediate format,
26699  such as
26700 \begin_inset Flex Code
26701 status collapsed
26702
26703 \begin_layout Plain Layout
26704 htlatex
26705 \end_layout
26706
26707 \end_inset
26708
26709 ,
26710
26711 \begin_inset Flex Code
26712 status collapsed
26713
26714 \begin_layout Plain Layout
26715 html2latex
26716 \end_layout
26717
26718 \end_inset
26719
26720 ,
26721  and
26722 \begin_inset Flex Code
26723 status collapsed
26724
26725 \begin_layout Plain Layout
26726 plastex
26727 \end_layout
26728
26729 \end_inset
26730
26731 ,
26732  relying upon \SpecialChar LyX
26733  to produce the \SpecialChar LaTeX
26734 ;
26735  and there is a converter that works directly on \SpecialChar LyX
26736  files,
26737
26738 \begin_inset Flex Code
26739 status collapsed
26740
26741 \begin_layout Plain Layout
26742 e\SpecialChar LyX
26743 er
26744 \end_layout
26745
26746 \end_inset
26747
26748 .
26749  All of these have different advantages and disadvantages.
26750
26751 \end_layout
26752
26753 \begin_layout Standard
26754 The \SpecialChar LaTeX
26755 -based converters have the advantage that,
26756  in principle,
26757  they know everything about the exported document that \SpecialChar LaTeX
26758  does.
26759  Such converters do not care,
26760  for example,
26761  if a certain block of code was produced by \SpecialChar LyX
26762  or was Evil Red Text.
26763  These converters know about
26764 \begin_inset Flex Code
26765 status collapsed
26766
26767 \begin_layout Plain Layout
26768 aux
26769 \end_layout
26770
26771 \end_inset
26772
26773  files,
26774  counters,
26775  and references,
26776  and can often make use of the
26777 \begin_inset Flex Code
26778 status collapsed
26779
26780 \begin_layout Plain Layout
26781 bbl
26782 \end_layout
26783
26784 \end_inset
26785
26786  files generated by Bib\SpecialChar TeX
26787 .
26788  On the other hand,
26789  \SpecialChar LaTeX
26790  is a very hard language to parse—
26791 it is sometimes said that only \SpecialChar TeX
26792  itself understands \SpecialChar TeX
26793 —
26794 and \SpecialChar LaTeX
26795 -based converters will often choke on what seem to be quite simple constructs;
26796  complex ones can throw them completely,
26797  and as of this writing,
26798  for example,
26799  the
26800 \emph on
26801 Embedded Objects
26802 \emph default
26803  manual will not export with
26804 \begin_inset Flex Code
26805 status collapsed
26806
26807 \begin_layout Plain Layout
26808 htlatex
26809 \end_layout
26810
26811 \end_inset
26812
26813 ,
26814  though the others will.
26815  The other issue concerns how math is handled.
26816  These converters typically convert the formulae into little pictures that are then linked from the HTML document.
26817  Since these are actually generated by \SpecialChar LaTeX
26818 ,
26819  they are accurate.
26820  But they do not scale well,
26821  and just getting them to look as if they are actually meant to be in your document—
26822 so that the font sizes seem to be roughly the same—
26823 can be a challenge.
26824 \end_layout
26825
26826 \begin_layout Standard
26827 Alex Fernandez's
26828 \begin_inset Flex Code
26829 status collapsed
26830
26831 \begin_layout Plain Layout
26832 e\SpecialChar LyX
26833 er
26834 \end_layout
26835
26836 \end_inset
26837
26838  (
26839 \begin_inset CommandInset href
26840 LatexCommand href
26841 name "http://pinchito.es/elyxer/"
26842 target "http://pinchito.es/elyxer/"
26843 literal "false"
26844
26845 \end_inset
26846
26847 ) solves some of these problems.
26848  In particular,
26849  the formulae it produces scale perfectly,
26850  since it renders math using a combination of HTML and CSS rather than converting the formulae to images.
26851  But even moderately complex formula are rendered less well than with
26852 \begin_inset Flex Code
26853 status collapsed
26854
26855 \begin_layout Plain Layout
26856 htlatex
26857 \end_layout
26858
26859 \end_inset
26860
26861 ;
26862  this reflects the limitations of HTML.
26863 \begin_inset Foot
26864 status collapsed
26865
26866 \begin_layout Plain Layout
26867 That said,
26868
26869 \begin_inset Flex Code
26870 status collapsed
26871
26872 \begin_layout Plain Layout
26873 e\SpecialChar LyX
26874 er
26875 \end_layout
26876
26877 \end_inset
26878
26879  can also use jsMath and MathJax for equations,
26880  but this setting is only available globally and requires one to have access to a server that runs the backend.
26881 \end_layout
26882
26883 \end_inset
26884
26885  More importantly (as of version 1.1.1,
26886  at least),
26887
26888 \begin_inset Flex Code
26889 status collapsed
26890
26891 \begin_layout Plain Layout
26892 e\SpecialChar LyX
26893 er
26894 \end_layout
26895
26896 \end_inset
26897
26898  has limited support for math macros and no support for user-defined paragraph or character styles.
26899  These limitations make
26900 \begin_inset Flex Code
26901 status collapsed
26902
26903 \begin_layout Plain Layout
26904 e\SpecialChar LyX
26905 er
26906 \end_layout
26907
26908 \end_inset
26909
26910  unsuitable for many of the documents \SpecialChar LyX
26911  users produce.
26912  In principle,
26913  of course,
26914  these problems could be solved,
26915  but the \SpecialChar LyX
26916  developers have decided to follow a different path and have made \SpecialChar LyX
26917  itself capable of writing XHTML,
26918  just as it is capable of writing \SpecialChar LaTeX
26919 ,
26920  DocBook,
26921  and plaintext.
26922 \end_layout
26923
26924 \begin_layout Standard
26925 As of this writing,
26926  XHTML output remains under development and should probably be regarded as
26927 \begin_inset Quotes eld
26928 \end_inset
26929
26930 experimental
26931 \begin_inset Quotes erd
26932 \end_inset
26933
26934 .
26935 \begin_inset Foot
26936 status collapsed
26937
26938 \begin_layout Plain Layout
26939 The file
26940 \begin_inset Flex Code
26941 status collapsed
26942
26943 \begin_layout Plain Layout
26944 development/HTML/HTML.notes
26945 \end_layout
26946
26947 \end_inset
26948
26949 ,
26950  which can be found in the \SpecialChar LyX
26951  source tree or
26952 \begin_inset CommandInset href
26953 LatexCommand href
26954 name "accessed online"
26955 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
26956 literal "false"
26957
26958 \end_inset
26959
26960 ,
26961  usually contains up-to-date information about the state of XHTML output.
26962  See also the list of XHTML bugs on
26963 \begin_inset CommandInset href
26964 LatexCommand href
26965 name "the bug tracker"
26966 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"
26967 literal "false"
26968
26969 \end_inset
26970
26971 .
26972 \end_layout
26973
26974 \end_inset
26975
26976  Still,
26977  the developers have chosen this approach because it has several potential advantages over the other two.
26978 \end_layout
26979
26980 \begin_layout Standard
26981 These advantages are primarily due to the fact that the XHTML output routines,
26982  since they are part of \SpecialChar LyX
26983 ,
26984  know everything \SpecialChar LyX
26985  knows about the document being exported.
26986 \begin_inset Foot
26987 status collapsed
26988
26989 \begin_layout Plain Layout
26990 Another advantage is that,
26991  since these routines are internal to \SpecialChar LyX
26992 ,
26993  they are immune to changes in \SpecialChar LyX
26994 's file format,
26995  or to changes in the semantics of existing insets.
26996 \end_layout
26997
26998 \end_inset
26999
27000  So they know about the table of contents (as displayed in the outline),
27001  about the counters associated with different paragraph styles,
27002  and about user-defined styles.
27003  The XHTML output routines know what \SpecialChar LyX
27004  knows about internationalization,
27005  too,
27006  so they will output
27007 \begin_inset Quotes eld
27008 \end_inset
27009
27010 Chapter 1
27011 \begin_inset Quotes erd
27012 \end_inset
27013
27014  or
27015 \begin_inset Quotes eld
27016 \end_inset
27017
27018
27019 \lang ngerman
27020 Kapitel
27021 \lang english
27022  1
27023 \begin_inset Quotes erd
27024 \end_inset
27025
27026 ,
27027  depending upon the language in effect at the time.
27028
27029 \end_layout
27030
27031 \begin_layout Standard
27032 Quite generally,
27033  the output routines know what \SpecialChar LyX
27034  knows about document layout,
27035  that is,
27036  about how the document is to be rendered on screen.
27037  We use this information when we output the document as XHTML.
27038  In particular,
27039  \SpecialChar LyX
27040
27041 \emph on
27042 automatically
27043 \emph default
27044  generates CSS style information corresponding to the layout information it uses to render the document on screen:
27045  if section headings are supposed to be sans-serif and bold as seen in \SpecialChar LyX
27046 ,
27047  then (by default) they will be sans-serif and bold when viewed in a web browser,
27048  too.
27049  And this is true not just for pre-defined styles,
27050  like Section,
27051  but for any style,
27052  including user-defined styles.
27053  Indeed,
27054  the XHTML output routines make no distinction between user-defined paragraph and
27055 \change_deleted 244031559 1603876931
27056 character
27057 \change_inserted 244031559 1603876940
27058 text
27059 \change_unchanged
27060  styles and \SpecialChar LyX
27061 's own pre-defined styles:
27062  in each case,
27063  everything \SpecialChar LyX
27064  knows about the styles is contained in the layout files.
27065  And much the same is true as regards pre-defined textual insets,
27066  such as footnotes,
27067  and various custom insets.
27068
27069 \end_layout
27070
27071 \begin_layout Standard
27072 The result is that XHTML output can be customized and extended in exactly the same way \SpecialChar LaTeX
27073  output can be customized and extended:
27074  through layout files and modules.
27075  See chapter five of the
27076 \emph on
27077 Customization
27078 \emph default
27079 manual for the details.
27080 \end_layout
27081
27082 \begin_layout Standard
27083 The remainder of this chapter contains more detailed information on XHTML output,
27084  its limitations,
27085  and ways to work around those limitations.
27086 \end_layout
27087
27088 \begin_layout Section
27089 Math Output in XHTML
27090 \end_layout
27091
27092 \begin_layout Standard
27093 \SpecialChar LyX
27094  offers four choices for how math is rendered.
27095  These have various advantages and disadvantages:
27096 \end_layout
27097
27098 \begin_layout Itemize
27099 MathML
27100 \begin_inset Newline newline
27101 \end_inset
27102
27103 MathML is a dialect of XML designed specifically for mathematics on the web,
27104  and it typically renders very well in browsers that support it.
27105  The disadvantage is that not all browsers support MathML,
27106  and support is not complete even in the Gecko-based browsers,
27107  such as Firefox.
27108 \begin_inset Newline newline
27109 \end_inset
27110
27111 If \SpecialChar LyX
27112  is unable to render a formula as MathML—
27113 for example,
27114  if the formula uses the
27115 \begin_inset Flex Code
27116 status collapsed
27117
27118 \begin_layout Plain Layout
27119 xymatrix
27120 \end_layout
27121
27122 \end_inset
27123
27124  package or ERT—
27125 then it will instead output the formula as an image.
27126
27127 \end_layout
27128
27129 \begin_layout Itemize
27130 HTML
27131 \begin_inset Newline newline
27132 \end_inset
27133
27134 As mentioned above,
27135
27136 \begin_inset Flex Code
27137 status collapsed
27138
27139 \begin_layout Plain Layout
27140 elyxer
27141 \end_layout
27142
27143 \end_inset
27144
27145  outputs math as HTML,
27146  styled by CSS.
27147 \begin_inset Foot
27148 status collapsed
27149
27150 \begin_layout Plain Layout
27151 \SpecialChar LyX
27152  has borrowed some of the CSS for its HTML output from
27153 \begin_inset Flex Code
27154 status collapsed
27155
27156 \begin_layout Plain Layout
27157 elyxer
27158 \end_layout
27159
27160 \end_inset
27161
27162 .
27163 \end_layout
27164
27165 \end_inset
27166
27167  For simple formulae,
27168  this can work quite well,
27169  though with more complicated formulae it tends to break down.
27170  Still,
27171  this method has the advantage that it is very widely supported and so it may be appropriate for documents that contain only a little,
27172  fairly simple math.
27173 \begin_inset Newline newline
27174 \end_inset
27175
27176 If Lyx is unable to render a formula as HTML—
27177 for example,
27178  if the formula uses the
27179 \begin_inset Flex Code
27180 status collapsed
27181
27182 \begin_layout Plain Layout
27183 xymatrix
27184 \end_layout
27185
27186 \end_inset
27187
27188  package or ERT—
27189 then it will instead output the formula as an image.
27190
27191 \end_layout
27192
27193 \begin_layout Itemize
27194 Images
27195 \begin_inset Newline newline
27196 \end_inset
27197
27198 Like
27199 \begin_inset Flex Code
27200 status collapsed
27201
27202 \begin_layout Plain Layout
27203 htlatex
27204 \end_layout
27205
27206 \end_inset
27207
27208 ,
27209  \SpecialChar LyX
27210  will output formulae as images,
27211  the very same images,
27212  in fact,
27213  that are used for instant preview.
27214 \begin_inset Foot
27215 status collapsed
27216
27217 \begin_layout Plain Layout
27218 Instant preview does
27219 \emph on
27220 not
27221 \emph default
27222 have to be on for images to be output,
27223  however.
27224 \end_layout
27225
27226 \end_inset
27227
27228  The advantage to this method is that the images are simply generated by \SpecialChar LaTeX
27229 ,
27230  so they are very accurate.
27231  The disadvantage,
27232  as mentioned earlier,
27233  is that these are bitmapped images,
27234  so they do not scale terribly well,
27235  and one cannot copy them,
27236  etc.
27237 \begin_inset Newline newline
27238 \end_inset
27239
27240 The size of the images can be controlled by setting the
27241 \begin_inset Quotes eld
27242 \end_inset
27243
27244 Math Images Scaling
27245 \begin_inset Quotes erd
27246 \end_inset
27247
27248  parameter under
27249 \begin_inset Flex Noun
27250 status collapsed
27251
27252 \begin_layout Plain Layout
27253 Document\SpecialChar menuseparator
27254 Settings\SpecialChar menuseparator
27255 Formats
27256 \end_layout
27257
27258 \end_inset
27259
27260 .
27261 \begin_inset Foot
27262 status collapsed
27263
27264 \begin_layout Plain Layout
27265 For those who want to know,
27266  this controls the resolution of the image in dots per inch and is based upon a default of 75 dpi.
27267 \end_layout
27268
27269 \end_inset
27270
27271
27272 \begin_inset Newline newline
27273 \end_inset
27274
27275 If \SpecialChar LyX
27276  for some reason fails to create an image for a formula (e.g.,
27277  if a required \SpecialChar LaTeX
27278  package is not installed),
27279  then it will fall back to outputing the raw \SpecialChar LaTeX
27280 .
27281 \end_layout
27282
27283 \begin_layout Itemize
27284 \SpecialChar LaTeX
27285
27286 \begin_inset Newline newline
27287 \end_inset
27288
27289 Finally,
27290  \SpecialChar LyX
27291  will happily output math as \SpecialChar LaTeX
27292 .
27293  As well as being the output of last resort,
27294  this method can be used with such tools as
27295 \begin_inset CommandInset href
27296 LatexCommand href
27297 name "jsMath"
27298 target "http://www.math.union.edu/~dpvc/jsMath/"
27299 literal "false"
27300
27301 \end_inset
27302
27303 ,
27304  which uses JavaScript to render \SpecialChar LaTeX
27305  embedded in HTML documents.
27306  \SpecialChar LyX
27307  wraps the \SpecialChar LaTeX
27308  in either a
27309 \begin_inset Flex Code
27310 status collapsed
27311
27312 \begin_layout Plain Layout
27313 span
27314 \end_layout
27315
27316 \end_inset
27317
27318  (for inline formulas) or
27319 \begin_inset Flex Code
27320 status collapsed
27321
27322 \begin_layout Plain Layout
27323 div
27324 \end_layout
27325
27326 \end_inset
27327
27328  (for displayed formulas) with
27329 \begin_inset Flex Code
27330 status collapsed
27331
27332 \begin_layout Plain Layout
27333 class='math'
27334 \end_layout
27335
27336 \end_inset
27337
27338 ,
27339  as is required for jsMath.
27340 \end_layout
27341
27342 \begin_layout Standard
27343 One of these output methods must be selected under
27344 \begin_inset Flex Noun
27345 status collapsed
27346
27347 \begin_layout Plain Layout
27348 Document\SpecialChar menuseparator
27349 Settings\SpecialChar menuseparator
27350 Formats
27351 \end_layout
27352
27353 \end_inset
27354
27355 .
27356  By default,
27357  \SpecialChar LyX
27358  outputs MathML.
27359  This is a document-wide setting,
27360  therefore.
27361 \end_layout
27362
27363 \begin_layout Standard
27364 Eventually,
27365  \SpecialChar LyX
27366  will offer the user the option to select an alternate output method for a particular inset,
27367  say,
27368  one that isn't being rendered very well by MathML.
27369 \begin_inset Foot
27370 status collapsed
27371
27372 \begin_layout Plain Layout
27373 That said,
27374  since \SpecialChar LyX
27375  falls back to images if the inset contains ERT,
27376  then one can force output as an image by putting some harmless ERT into the math,
27377  for example:
27378
27379 \begin_inset Formula $a=b\relax$
27380 \end_inset
27381
27382 .
27383 \end_layout
27384
27385 \end_inset
27386
27387
27388 \end_layout
27389
27390 \begin_layout Section
27391 Bibliography and Citations
27392 \end_layout
27393
27394 \begin_layout Standard
27395 XHTML output fully supports bibliographies and citations.
27396
27397 \end_layout
27398
27399 \begin_layout Standard
27400 Citation labels are generated by the same machinery that generates \SpecialChar LyX
27401 's on-screen labels,
27402  so the labels will look in the output much as they do in \SpecialChar LyX
27403 ,
27404  though better.
27405  If you are using numerical citations,
27406  then \SpecialChar LyX
27407  will output numerical labels,
27408  such as [1] or [17],
27409  rather than simply showing the citation key in square brackets,
27410  as it does on-screen.
27411  If you are using author-year citations,
27412  then \SpecialChar LyX
27413  will add lowercase letters to the years,
27414  just as Bib\SpecialChar TeX
27415  does,
27416  if it finds more than one citation for a given author-year combination.
27417  The labels will be printed with the bibliography entries.
27418  Note that there is,
27419  at present,
27420  no way to customize the appearance of the labels,
27421  for example,
27422  to choose between square brackets and parentheses.
27423 \end_layout
27424
27425 \begin_layout Standard
27426 Bibliography output is handled by the same machinery that handles the presentation of reference information in the citation dialog,
27427  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.
27428  The formatting can be customized in your layout file or,
27429  preferably,
27430  in a module.
27431  See the
27432 \emph on
27433 Customization
27434 \emph default
27435  manual for the details.
27436 \end_layout
27437
27438 \begin_layout Standard
27439 The main defect at present is that cross-referenced information is printed with every entry with which it is associated.
27440  So you can see things like this:
27441 \end_layout
27442
27443 \begin_layout Quote
27444 Jason Stanley,
27445
27446 \begin_inset Quotes eld
27447 \end_inset
27448
27449 Context and Logical Form
27450 \begin_inset Quotes erd
27451 \end_inset
27452
27453 ,
27454  in
27455 \emph on
27456 Language in Context:
27457  Selected Essays
27458 \emph default
27459  (Oxford:
27460  Oxford University Press,
27461  2007),
27462  pp.
27463  30–68.
27464 \end_layout
27465
27466 \begin_layout Quote
27467 Jason Stanley,
27468
27469 \begin_inset Quotes eld
27470 \end_inset
27471
27472 Semantics in Context
27473 \begin_inset Quotes erd
27474 \end_inset
27475
27476 ,
27477  in
27478 \emph on
27479 Language in Context:
27480  Selected Essays
27481 \emph default
27482  (Oxford:
27483  Oxford University Press,
27484  2007),
27485  pp.
27486  201–30.
27487 \end_layout
27488
27489 \begin_layout Standard
27490 This should be fixed before long.
27491 \end_layout
27492
27493 \begin_layout Standard
27494 There is no support at present for sectioned bibliographies.
27495  If you have multiple bibliographies,
27496  then \SpecialChar LyX
27497  will print the same bibliography over and over.
27498 \end_layout
27499
27500 \begin_layout Section
27501 Indexes
27502 \end_layout
27503
27504 \begin_layout Standard
27505 \SpecialChar LyX
27506  will happily export indexes as XHTML,
27507  but with certain limitations at the moment.
27508 \end_layout
27509
27510 \begin_layout Standard
27511 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
27512 \emph on
27513 User's Guide
27514 \emph default
27515 .
27516 \begin_inset Foot
27517 status collapsed
27518
27519 \begin_layout Plain Layout
27520 The main issue here is that \SpecialChar LyX
27521  itself does not really handle these.
27522  It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
27523 .
27524 \end_layout
27525
27526 \end_inset
27527
27528  We'll describe how they are handled using the subsection headings from that section.
27529 \end_layout
27530
27531 \begin_layout Itemize
27532 Grouping Index Entries (aka,
27533  sub-entries):
27534  \SpecialChar LyX
27535  makes an effort to support these,
27536  but the entries must be separated by
27537 \begin_inset Quotes eld
27538 \end_inset
27539
27540  !
27541
27542 \begin_inset Quotes erd
27543 \end_inset
27544
27545 ,
27546  that is,
27547  there must be spaces around the exclamation point.
27548  This is because it is otherwise too difficult to check for escaped exclamation points,
27549  ones in math,
27550  and so forth.
27551 \end_layout
27552
27553 \begin_layout Itemize
27554 Page Ranges:
27555  There is no support at all for page ranges,
27556  since these make no sense with XHMTL.
27557  Instead,
27558  you will just get two index entries,
27559  one at either end.
27560 \end_layout
27561
27562 \begin_layout Itemize
27563 Cross-referencing:
27564  There is no support for cross-referencing.
27565  If \SpecialChar LyX
27566  finds an entry containing the
27567 \begin_inset Quotes eld
27568 \end_inset
27569
27570 |see\SpecialChar ldots
27571
27572 \begin_inset Quotes erd
27573 \end_inset
27574
27575  construct,
27576  it is just dropped,
27577  and the rest is treated as an ordinary index entry.
27578 \end_layout
27579
27580 \begin_layout Itemize
27581 Index Entry Order:
27582  \SpecialChar LyX
27583  does support attempts to fix the sorting order.
27584  It will take what is before the first `@' it finds and use that for sorting,
27585  taking what follows the first `@' to be the actual entry.
27586  At present,
27587  \SpecialChar LyX
27588  does not check for escaped `@',
27589  so do not try to index email addresses.
27590 \end_layout
27591
27592 \begin_layout Itemize
27593 Index Entry Layout:
27594  You can format entries by using the text style dialog,
27595  or by using any other method available within \SpecialChar LyX
27596  itself.
27597  There is no support for constructs like:
27598
27599 \begin_inset Quotes eld
27600 \end_inset
27601
27602 entry|textbf
27603 \begin_inset Quotes erd
27604 \end_inset
27605
27606 .
27607  Indeed,
27608  if \SpecialChar LyX
27609  finds a pipe symbol,
27610  `|',
27611  in an entry,
27612  it will delete it and everything that follows it.
27613 \end_layout
27614
27615 \begin_layout Itemize
27616 Multiple Indexes:
27617  There is no support for multiple indexes.
27618  Rather,
27619  all index entries will be printed as one large index.
27620  To avoid our printing several versions of the index,
27621  we print only the main index,
27622  so make sure you have one.
27623 \end_layout
27624
27625 \begin_layout Section
27626 Nomenclature and Glossary
27627 \end_layout
27628
27629 \begin_layout Standard
27630 There is at present no support for glossaries.
27631  Adding it would be fairly trivial,
27632  and welcome.
27633 \end_layout
27634
27635 \begin_layout Chapter
27636
27637 \change_inserted 1075283030 1616534180
27638 DocBook Output
27639 \end_layout
27640
27641 \begin_layout Standard
27642
27643 \change_inserted 1075283030 1616534386
27644 Apart from HTML,
27645  \SpecialChar LyX
27646  can generate documents in the DocBook XML vocabulary.
27647  With versions 2.3 and before,
27648  only select templates could be used to generate DocBook documents (only version 4).
27649  Starting with \SpecialChar LyX
27650  2.4,
27651  most \SpecialChar LyX
27652  layouts can generate valid DocBook documents (only version 5).
27653  This feature is built into \SpecialChar LyX
27654  and does not require the use of external tools.
27655 \end_layout
27656
27657 \begin_layout Standard
27658
27659 \change_inserted 1075283030 1616534437
27660 The result is that the DocBook output can be customized and extended in exactly the same way \SpecialChar LaTeX
27661  output can be customized and extended:
27662  through layout files and modules.
27663  See chapter five of the
27664 \emph on
27665 Customization
27666 \emph default
27667 manual for the details.
27668 \end_layout
27669
27670 \begin_layout Standard
27671
27672 \change_inserted 1075283030 1616534475
27673 Most \SpecialChar LyX
27674  features are supported with DocBook,
27675  like math output.
27676 \end_layout
27677
27678 \begin_layout Itemize
27679
27680 \change_inserted 1075283030 1616534741
27681 Math output is performed mostly in MathML (the major exception being constructions not supported by \SpecialChar LyX
27682 ,
27683  i.e.
27684  ERTs).
27685  All formulae are also available in raw \SpecialChar TeX
27686  in the DocBook output for further processing.
27687 \end_layout
27688
27689 \begin_layout Itemize
27690
27691 \change_inserted 1075283030 1616534852
27692 Bibliographies and citations are implemented,
27693  including with an external BibTeX file.
27694  Bibliography entries are not prerendered when the detailed information are available,
27695  but rather output with the standard DocBook constructs.
27696  The external DocBook processor is expected to handle the rendering of entries.
27697 \end_layout
27698
27699 \begin_layout Itemize
27700
27701 \change_inserted 1075283030 1616534863
27702 Indexes are supported,
27703  including multiple indices.
27704  Grouping (with
27705 \family typewriter
27706 !
27707 \family default
27708 ),
27709  page ranges,
27710  and cross-references (
27711 \family typewriter
27712 |see
27713 \family default
27714 ) are supported,
27715  with the exception of the same symbols escaped.
27716  Entry order (
27717 \family typewriter
27718 @
27719 \family default
27720 ) and layout (
27721 \family typewriter
27722 |mathbf
27723 \family default
27724 ) are not supported.
27725  There is no support for escaping of index entries.
27726 \end_layout
27727
27728 \begin_layout Itemize
27729
27730 \change_inserted 1075283030 1616534884
27731 Glossaries are implemented.
27732 \end_layout
27733
27734 \begin_layout Standard
27735
27736 \change_inserted 1075283030 1616534894
27737 Two major parameters can be set at the document level.
27738 \end_layout
27739
27740 \begin_layout Itemize
27741
27742 \change_inserted 1075283030 1616534948
27743 Format for tables:
27744  \SpecialChar LyX
27745  can generate tables either as HTML (default value) or CALS,
27746  depending on the user's requirements.
27747  Most DocBook processors accept both formats.
27748 \end_layout
27749
27750 \begin_layout Itemize
27751
27752 \change_inserted 1075283030 1616535006
27753 MathML prefix:
27754  in DocBook,
27755  MathML is included within its own name space,
27756  unlike HTML.
27757  The implication is that there must be an indication of the tags belonging to the MathML standard.
27758  Three choices are offered:
27759
27760 \end_layout
27761
27762 \begin_deeper
27763 \begin_layout Itemize
27764
27765 \change_inserted 1075283030 1616535044
27766 Inline:
27767  the MathML name space is defined for each formula (using the
27768 \family typewriter
27769 xmlns
27770 \family default
27771  attribute on each formula)
27772 \end_layout
27773
27774 \begin_layout Itemize
27775
27776 \change_inserted 1075283030 1616535090
27777 With the
27778 \family typewriter
27779 m
27780 \family default
27781  prefix (default):
27782  the MathML name space is defined at the document level (using the
27783 \family typewriter
27784 xmlns:m
27785 \family default
27786  attribute on the root element).
27787  Each MathML is prefixed with
27788 \family typewriter
27789 m
27790 \family default
27791 :
27792  for instance,
27793
27794 \family typewriter
27795 m:math
27796 \end_layout
27797
27798 \begin_layout Itemize
27799
27800 \change_inserted 1075283030 1616620405
27801 With the
27802 \family typewriter
27803 mml
27804 \family default
27805  prefix:
27806  similar to the
27807 \family typewriter
27808 m
27809 \family default
27810  option,
27811  but with
27812 \family typewriter
27813 mml
27814 \end_layout
27815
27816 \begin_layout Standard
27817
27818 \change_inserted 1075283030 1616620470
27819 This option is especially useful if you want \SpecialChar LyX
27820  to match your personal style or to work with buggy software that only accepts one prefix for MathML.
27821 \change_unchanged
27822
27823 \end_layout
27824
27825 \end_deeper
27826 \begin_layout Chapter
27827 The \SpecialChar LyX
27828  Server
27829 \end_layout
27830
27831 \begin_layout Section
27832 Introduction
27833 \end_layout
27834
27835 \begin_layout Standard
27836 The `\SpecialChar LyX
27837  server' allows other programs to talk to \SpecialChar LyX
27838 ,
27839  invoke \SpecialChar LyX
27840  commands,
27841  and retrieve information about the \SpecialChar LyX
27842  internal state.
27843  This is only intended for advanced users,
27844  but they should find it useful.
27845  It is by writing to the \SpecialChar LyX
27846  server,
27847  for example,
27848  that bibliography managers,
27849  such as JabRef,
27850  are able to
27851 \begin_inset Quotes eld
27852 \end_inset
27853
27854 push
27855 \begin_inset Quotes erd
27856 \end_inset
27857
27858  citations to \SpecialChar LyX
27859 .
27860 \end_layout
27861
27862 \begin_layout Section
27863 Starting the \SpecialChar LyX
27864  Server
27865 \begin_inset CommandInset label
27866 LatexCommand label
27867 name "sec:Starting-the-Server"
27868
27869 \end_inset
27870
27871
27872 \end_layout
27873
27874 \begin_layout Standard
27875 The \SpecialChar LyX
27876  server works through the use of a pair of named pipes.
27877  These are usually located in
27878 \begin_inset Flex Code
27879 status collapsed
27880
27881 \begin_layout Plain Layout
27882 UserDir
27883 \end_layout
27884
27885 \end_inset
27886
27887 ,
27888  (except on Windows,
27889  where
27890 \emph on
27891 local
27892 \emph default
27893  named pipes are special objects located in
27894 \begin_inset Flex Code
27895 status collapsed
27896
27897 \begin_layout Plain Layout
27898
27899 \backslash
27900
27901 \backslash
27902 .
27903 \backslash
27904 pipe
27905 \end_layout
27906
27907 \end_inset
27908
27909 ) and have the names
27910 \begin_inset Quotes eld
27911 \end_inset
27912
27913
27914 \begin_inset Flex Code
27915 status collapsed
27916
27917 \begin_layout Plain Layout
27918 lyxpipe.in
27919 \end_layout
27920
27921 \end_inset
27922
27923
27924 \begin_inset Quotes erd
27925 \end_inset
27926
27927  and
27928 \begin_inset Quotes eld
27929 \end_inset
27930
27931
27932 \begin_inset Flex Code
27933 status collapsed
27934
27935 \begin_layout Plain Layout
27936 lyxpipe.out
27937 \end_layout
27938
27939 \end_inset
27940
27941
27942 \begin_inset Quotes erd
27943 \end_inset
27944
27945 .
27946  External programs write into
27947 \begin_inset Flex Code
27948 status collapsed
27949
27950 \begin_layout Plain Layout
27951 lyxpipe.in
27952 \end_layout
27953
27954 \end_inset
27955
27956  and read back data from
27957 \begin_inset Flex Code
27958 status collapsed
27959
27960 \begin_layout Plain Layout
27961 lyxpipe.out
27962 \end_layout
27963
27964 \end_inset
27965
27966 .
27967  The stem of the pipe names can be defined in the
27968 \begin_inset Flex Noun
27969 status collapsed
27970
27971 \begin_layout Plain Layout
27972 Tools\SpecialChar menuseparator
27973 Preferences
27974 \end_layout
27975
27976 \end_inset
27977
27978  dialog,
27979  for example
27980 \begin_inset Flex Code
27981 status collapsed
27982
27983 \begin_layout Plain Layout
27984 "/home/myhome/lyxpipe"
27985 \end_layout
27986
27987 \end_inset
27988
27989 ,
27990  or
27991 \begin_inset Flex Code
27992 status collapsed
27993
27994 \begin_layout Plain Layout
27995 "
27996 \backslash
27997
27998 \backslash
27999 .
28000 \backslash
28001 pipe
28002 \backslash
28003 lyxpipe"
28004 \end_layout
28005
28006 \end_inset
28007
28008  on Windows (where any working path instead of lyxpipe can be used,
28009  for example
28010 \begin_inset Flex Code
28011 status collapsed
28012
28013 \begin_layout Plain Layout
28014 "
28015 \backslash
28016
28017 \backslash
28018 .
28019 \backslash
28020 pipe
28021 \backslash
28022 my
28023 \backslash
28024 lyx
28025 \backslash
28026 pipe"
28027 \end_layout
28028
28029 \end_inset
28030
28031  would also work).
28032  You
28033 \emph on
28034 must
28035 \emph default
28036  configure this manually in order for the server to start.
28037 \end_layout
28038
28039 \begin_layout Standard
28040 \SpecialChar LyX
28041  will add the '
28042 \begin_inset Flex Code
28043 status collapsed
28044
28045 \begin_layout Plain Layout
28046 .in
28047 \end_layout
28048
28049 \end_inset
28050
28051 ' and '
28052 \begin_inset Flex Code
28053 status collapsed
28054
28055 \begin_layout Plain Layout
28056 .out
28057 \end_layout
28058
28059 \end_inset
28060
28061 ' to create the pipes.
28062  If one of the pipes already exists,
28063  \SpecialChar LyX
28064  will assume that another \SpecialChar LyX
28065  process is already running and will not start the server.
28066  On POSIX (Unix like) systems,
28067  if for some other reason,
28068  an unused
28069 \begin_inset Quotes eld
28070 \end_inset
28071
28072 stale
28073 \begin_inset Quotes erd
28074 \end_inset
28075
28076  pipe is left in existence when \SpecialChar LyX
28077  closes,
28078  then \SpecialChar LyX
28079  will try to delete it.
28080  If this fails for some reason,
28081  you will need to delete the pipes manually and then restart \SpecialChar LyX
28082 .
28083  On Windows,
28084  pipes are deleted by the OS on program termination or crash,
28085  so
28086 \begin_inset Quotes eld
28087 \end_inset
28088
28089 stale
28090 \begin_inset Quotes erd
28091 \end_inset
28092
28093  pipes should not be possible.
28094 \end_layout
28095
28096 \begin_layout Standard
28097 To have several \SpecialChar LyX
28098  processes with servers at the same time,
28099  you have to use different configurations,
28100  perhaps by using separate user directories,
28101  each with its own
28102 \begin_inset Flex Code
28103 status collapsed
28104
28105 \begin_layout Plain Layout
28106 preferences
28107 \end_layout
28108
28109 \end_inset
28110
28111  file,
28112  for each process.
28113 \end_layout
28114
28115 \begin_layout Standard
28116 If you are developing a client program,
28117  you might find it useful to enable debugging information from the \SpecialChar LyX
28118  server.
28119  Do this by starting \SpecialChar LyX
28120  as
28121 \begin_inset Flex Code
28122 status collapsed
28123
28124 \begin_layout Plain Layout
28125 lyx -dbg lyxserver
28126 \end_layout
28127
28128 \end_inset
28129
28130 .
28131 \end_layout
28132
28133 \begin_layout Standard
28134 You can find a complete example client written in C++ in the source distribution as
28135 \begin_inset Flex Code
28136 status collapsed
28137
28138 \begin_layout Plain Layout
28139 development/lyxserver/server_monitor.cpp
28140 \end_layout
28141
28142 \end_inset
28143
28144 .
28145 \end_layout
28146
28147 \begin_layout Standard
28148 Another useful tool is the command-line based client found in
28149 \begin_inset Flex Code
28150 status collapsed
28151
28152 \begin_layout Plain Layout
28153 src/client/lyxclient
28154 \end_layout
28155
28156 \end_inset
28157
28158 .
28159 \end_layout
28160
28161 \begin_layout Section
28162 Normal communication
28163 \end_layout
28164
28165 \begin_layout Standard
28166 To issue a \SpecialChar LyX
28167  call,
28168  the client writes a line of ASCII text into the input pipe.
28169  This line has the following format:
28170 \end_layout
28171
28172 \begin_layout Quote
28173 LYXCMD:
28174 \emph on
28175 clientname
28176 \emph default
28177 :
28178 \emph on
28179 function
28180 \emph default
28181 :
28182 \emph on
28183 argument
28184 \end_layout
28185
28186 \begin_layout Description
28187 clientname is a name that the client can choose arbitrarily.
28188  Its only use is that \SpecialChar LyX
28189  will echo it if it sends an answer—
28190 so a client can dispatch results from different requesters.
28191 \end_layout
28192
28193 \begin_layout Description
28194 function is the function you want \SpecialChar LyX
28195  to perform.
28196  It is the same as the commands you'd use in the minibuffer.
28197 \end_layout
28198
28199 \begin_layout Description
28200 argument is an optional argument which is meaningful only to some functions (for instance,
28201  the
28202 \begin_inset Quotes eld
28203 \end_inset
28204
28205 self-insert
28206 \begin_inset Quotes erd
28207 \end_inset
28208
28209  LFUN will insert the argument as text at the cursor position).
28210 \end_layout
28211
28212 \begin_layout Standard
28213 The answer from \SpecialChar LyX
28214  will arrive in the output pipe and be of the form
28215 \end_layout
28216
28217 \begin_layout Quote
28218 INFO:
28219 \emph on
28220 clientname
28221 \emph default
28222 :
28223 \emph on
28224 function
28225 \emph default
28226 :
28227 \emph on
28228 data
28229 \end_layout
28230
28231 \begin_layout Standard
28232 where
28233 \emph on
28234 clientname
28235 \emph default
28236  and
28237 \emph on
28238 function
28239 \emph default
28240  are just echoed from the command request,
28241  while
28242 \emph on
28243 data
28244 \emph default
28245  is more or less useful information filled according to how the command execution worked out.
28246  Some commands,
28247  such as
28248 \begin_inset Quotes eld
28249 \end_inset
28250
28251 font-state
28252 \begin_inset Quotes erd
28253 \end_inset
28254
28255 ,
28256  will return information about the internal state of \SpecialChar LyX
28257 ,
28258  while other will return an empty data-response.
28259  This means that the command execution went fine.
28260 \end_layout
28261
28262 \begin_layout Standard
28263 In case of errors,
28264  the response from \SpecialChar LyX
28265  will have this form
28266 \end_layout
28267
28268 \begin_layout Quote
28269 ERROR:
28270 \emph on
28271 clientname
28272 \emph default
28273 :
28274 \emph on
28275 function
28276 \emph default
28277 :
28278 \emph on
28279 error message
28280 \end_layout
28281
28282 \begin_layout Standard
28283 where the
28284 \emph on
28285 error message
28286 \emph default
28287  should contain an explanation of why the command failed.
28288 \end_layout
28289
28290 \begin_layout Standard
28291 Examples:
28292 \end_layout
28293
28294 \begin_layout LyX-Code
28295 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
28296 \begin_inset Newline newline
28297 \end_inset
28298
28299 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
28300 \begin_inset Newline newline
28301 \end_inset
28302
28303 read a <~/.lyxpipe.out
28304 \begin_inset Newline newline
28305 \end_inset
28306
28307 echo $a
28308 \end_layout
28309
28310 \begin_layout Subsection
28311 AppleScript (Mac OS X)
28312 \end_layout
28313
28314 \begin_layout Standard
28315 Since \SpecialChar LyX
28316  2.1,
28317  \SpecialChar LyX
28318  supports basic interactions with AppleScript for normal communication through the command run.
28319  This command takes a direct argument (the
28320 \series bold
28321 function
28322 \series default
28323  to perform) and an optional argument.
28324  It either returns the output of the function or triggers an error with the error message and code.
28325 \end_layout
28326
28327 \begin_layout Standard
28328 Example:
28329 \end_layout
28330
28331 \begin_layout LyX-Code
28332 tell application "\SpecialChar LyX
28333 "
28334 \end_layout
28335
28336 \begin_layout LyX-Code
28337   try
28338 \end_layout
28339
28340 \begin_layout LyX-Code
28341     -- Stores the current file name into f
28342 \end_layout
28343
28344 \begin_layout LyX-Code
28345     set f to (run "server-get-filename" with argument "")
28346 \end_layout
28347
28348 \begin_layout LyX-Code
28349     on error the error_message number the error_number
28350 \end_layout
28351
28352 \begin_layout LyX-Code
28353       display dialog "Error:
28354  " & the error_number & ".
28355  " ¬
28356 \end_layout
28357
28358 \begin_layout LyX-Code
28359               & the error_message buttons {"OK"} default button 1
28360 \end_layout
28361
28362 \begin_layout LyX-Code
28363   end try
28364 \end_layout
28365
28366 \begin_layout LyX-Code
28367 end tell
28368 \end_layout
28369
28370 \begin_layout Section
28371 Notification
28372 \end_layout
28373
28374 \begin_layout Standard
28375 \SpecialChar LyX
28376  can notify clients of events going on asynchronously.
28377  Currently it will only do this if the user binds a key sequence with the function
28378 \begin_inset Quotes eld
28379 \end_inset
28380
28381 notify
28382 \begin_inset Quotes erd
28383 \end_inset
28384
28385 .
28386  The format of the string \SpecialChar LyX
28387  sends is as follows:
28388 \end_layout
28389
28390 \begin_layout Quote
28391 \begin_inset Flex Code
28392 status collapsed
28393
28394 \begin_layout Plain Layout
28395 NOTIFY:
28396 \end_layout
28397
28398 \end_inset
28399
28400
28401 \emph on
28402 key-sequence
28403 \end_layout
28404
28405 \begin_layout Standard
28406 where
28407 \emph on
28408 key-sequence
28409 \emph default
28410  is the printed representation of the key sequence that was actually typed by the user.
28411 \end_layout
28412
28413 \begin_layout Standard
28414 This mechanism can be used to extend \SpecialChar LyX
28415 's command set and implement macros.
28416  Bind some key sequence to
28417 \begin_inset Quotes eld
28418 \end_inset
28419
28420 notify
28421 \begin_inset Quotes erd
28422 \end_inset
28423
28424 .
28425  Then start a client that listens on the output pipe,
28426  dispatches the command according to the sequence,
28427  and starts a function that may use \SpecialChar LyX
28428  calls and \SpecialChar LyX
28429  requests to issue a command or a series of commands to \SpecialChar LyX
28430 .
28431 \end_layout
28432
28433 \begin_layout Section
28434 The simple \SpecialChar LyX
28435  Server Protocol
28436 \end_layout
28437
28438 \begin_layout Standard
28439 \SpecialChar LyX
28440  implements a simple protocol that can be used for session management.
28441  All messages are of the form
28442 \end_layout
28443
28444 \begin_layout Quote
28445 LYXSRV:
28446 \emph on
28447 clientname
28448 \emph default
28449 :
28450 \emph on
28451 protocol message
28452 \end_layout
28453
28454 \begin_layout Standard
28455 where
28456 \emph on
28457 protocol message
28458 \emph default
28459  can be
28460 \begin_inset Quotes eld
28461 \end_inset
28462
28463 hello
28464 \begin_inset Quotes erd
28465 \end_inset
28466
28467  or
28468 \begin_inset Quotes eld
28469 \end_inset
28470
28471 bye
28472 \begin_inset Quotes erd
28473 \end_inset
28474
28475 .
28476  If
28477 \begin_inset Quotes eld
28478 \end_inset
28479
28480 hello
28481 \begin_inset Quotes erd
28482 \end_inset
28483
28484  is received from a client,
28485  \SpecialChar LyX
28486  will report back to inform the client that it's listening to it's messages,
28487  while
28488 \begin_inset Quotes eld
28489 \end_inset
28490
28491 bye
28492 \begin_inset Quotes erd
28493 \end_inset
28494
28495  sent from \SpecialChar LyX
28496  will inform clients that \SpecialChar LyX
28497  is closing.
28498 \end_layout
28499
28500 \begin_layout Section
28501 Reverse DVI/PDF search
28502 \end_layout
28503
28504 \begin_layout Standard
28505 Some DVI/PDF viewers
28506 \begin_inset Foot
28507 status collapsed
28508
28509 \begin_layout Plain Layout
28510 The following viewers offer the reverse PDF search feature:
28511  Okular on KDE/Linux,
28512  Qpdfview on Unix,
28513  Skim on Mac OSX and SumatraPDF on Windows.
28514 \end_layout
28515
28516 \end_inset
28517
28518  provide
28519 \emph on
28520 reverse search
28521 \emph default
28522  facility (also called
28523 \emph on
28524 inverse search
28525 \emph default
28526 ).
28527  This means that you can tell \SpecialChar LyX
28528  to put the cursor to a specific line in the document by clicking at the respective position in the DVI/PDF output.
28529  To achieve this,
28530  the viewer must be able to communicate with \SpecialChar LyX
28531 .
28532  This is done via the \SpecialChar LyX
28533  server either by using the named pipe (
28534 \emph on
28535 lyxpipe
28536 \emph default
28537 ),
28538  or the UNIX domain socket (
28539 \emph on
28540 lyxsocket
28541 \emph default
28542 ) that \SpecialChar LyX
28543  creates in its temporary directory (this is the way the
28544 \begin_inset Flex Code
28545 status collapsed
28546
28547 \begin_layout Plain Layout
28548 lyxclient
28549 \end_layout
28550
28551 \end_inset
28552
28553  program communicates with \SpecialChar LyX
28554 ).
28555  In some cases,
28556  you need a helper script that mediates between the viewer and \SpecialChar LyX
28557 ,
28558  in others,
28559  the viewer can communicate with \SpecialChar LyX
28560  directly.
28561  This depends on the selected viewer and on your operating system.
28562  The same applies to the way viewers need to be configured and the way the reverse search is actually performed.
28563  In what follows,
28564  we will thus describe how to setup reverse search for specific viewers.
28565  Before we turn to this,
28566  though,
28567  we will explain what needs to be done generally to enable reverse search in the DVI/PDF output.
28568 \end_layout
28569
28570 \begin_layout Subsection
28571 Automatic setup
28572 \begin_inset CommandInset label
28573 LatexCommand label
28574 name "subsec:rev-search"
28575
28576 \end_inset
28577
28578
28579 \end_layout
28580
28581 \begin_layout Standard
28582 In most cases \SpecialChar LyX
28583  will do the work for you by pressing the following button in the toolbar:
28584
28585 \begin_inset Info
28586 type  "icon"
28587 arg   "buffer-toggle-output-sync"
28588 \end_inset
28589
28590 .
28591  Alternatively,
28592  you can also enable the feature by checking
28593 \family sans
28594 Synchronize with Output
28595 \family default
28596  in
28597 \begin_inset Flex Noun
28598 status collapsed
28599
28600 \begin_layout Plain Layout
28601 Document\SpecialChar menuseparator
28602 Settings\SpecialChar menuseparator
28603 Formats
28604 \end_layout
28605
28606 \end_inset
28607
28608 .
28609  In such a case \SpecialChar LyX
28610  will automatically insert the necessary Sync\SpecialChar TeX
28611  macro (for PDF) or load the srcltx package (for DVI) respectively.
28612  This option can be easily reached also on
28613 \begin_inset Flex Code
28614 status collapsed
28615
28616 \begin_layout Plain Layout
28617 View/Update
28618 \end_layout
28619
28620 \end_inset
28621
28622  Toolbar.
28623 \end_layout
28624
28625 \begin_layout Standard
28626 If you need a different setting,
28627  you can select or input a custom macro from the drop down box just below
28628 \begin_inset Flex Noun
28629 status collapsed
28630
28631 \begin_layout Plain Layout
28632 Document\SpecialChar menuseparator
28633 Settings\SpecialChar menuseparator
28634 Output\SpecialChar menuseparator
28635 Synchronize with Output
28636 \end_layout
28637
28638 \end_inset
28639
28640 .
28641 \end_layout
28642
28643 \begin_layout Standard
28644 Note that the method
28645 \begin_inset Flex Code
28646 status collapsed
28647
28648 \begin_layout Plain Layout
28649
28650 \backslash
28651 synctex=1
28652 \end_layout
28653
28654 \end_inset
28655
28656  enables gzip compression.
28657  If your viewer does not support it,
28658  you should instead use
28659 \begin_inset Flex Code
28660 status collapsed
28661
28662 \begin_layout Plain Layout
28663
28664 \backslash
28665 synctex=-1
28666 \end_layout
28667
28668 \end_inset
28669
28670 .
28671 \end_layout
28672
28673 \begin_layout Standard
28674 Please also note that including the
28675 \begin_inset Flex Code
28676 status collapsed
28677
28678 \begin_layout Plain Layout
28679 srcltx
28680 \end_layout
28681
28682 \end_inset
28683
28684  package or
28685 \begin_inset Flex Code
28686 status collapsed
28687
28688 \begin_layout Plain Layout
28689 src-specials
28690 \end_layout
28691
28692 \end_inset
28693
28694  sometimes has an undesired impact on the typesetting.
28695  Thus,
28696  you should switch output synchronization off for the final typesetting if you use the
28697 \begin_inset Flex Code
28698 status collapsed
28699
28700 \begin_layout Plain Layout
28701 srcltx
28702 \end_layout
28703
28704 \end_inset
28705
28706  package or
28707 \begin_inset Flex Code
28708 status collapsed
28709
28710 \begin_layout Plain Layout
28711 src-specials
28712 \end_layout
28713
28714 \end_inset
28715
28716 .
28717
28718 \end_layout
28719
28720 \begin_layout Standard
28721 In case you need some more special settings that are not covered by the automatic settings,
28722  read the next section about how to set up output synchronization manually.
28723  If the automatic setup suits your needs,
28724  you can readily jump to section
28725 \begin_inset space ~
28726 \end_inset
28727
28728
28729 \begin_inset CommandInset ref
28730 LatexCommand ref
28731 reference "subsec:configuring-viewers"
28732 nolink "false"
28733
28734 \end_inset
28735
28736 ,
28737  where the necessary configuration steps in your viewer – needed both with the automatic and the manual setup – are described.
28738 \end_layout
28739
28740 \begin_layout Subsection
28741 Manual setup
28742 \end_layout
28743
28744 \begin_layout Standard
28745 \SpecialChar LaTeX
28746  provides several different methods for reverse search.
28747  Some are built-in in the
28748 \begin_inset Flex Code
28749 status collapsed
28750
28751 \begin_layout Plain Layout
28752 latex/pdflatex
28753 \end_layout
28754
28755 \end_inset
28756
28757  program,
28758  some are provided by external packages.
28759  Your choice depends on whether your \SpecialChar LaTeX
28760  distribution already provides a given method (the built-in methods are rather new) and whether your viewer can cope with it.
28761  The available methods are described in the following.
28762 \end_layout
28763
28764 \begin_layout Subsubsection*
28765 Built-in DVI-search via src-specials (DVI only)
28766 \end_layout
28767
28768 \begin_layout Standard
28769 This method provides the DVI file with the necessary information for reverse search.
28770  It is available in \SpecialChar LaTeX
28771  since quite some time (any somewhat recent \SpecialChar LaTeX
28772  distribution should include it),
28773  and it works reliably.
28774  To enable it,
28775  change the
28776 \begin_inset Flex Noun
28777 status collapsed
28778
28779 \begin_layout Plain Layout
28780 La
28781 \family sans
28782 TeX
28783 \family default
28784  (plain)->DVI
28785 \end_layout
28786
28787 \end_inset
28788
28789  or
28790 \begin_inset Flex Noun
28791 status collapsed
28792
28793 \begin_layout Plain Layout
28794 La
28795 \family sans
28796 TeX
28797 \family default
28798  (plain)->DraftDVI
28799 \end_layout
28800
28801 \end_inset
28802
28803  converter in
28804 \begin_inset Flex Noun
28805 status collapsed
28806
28807 \begin_layout Plain Layout
28808 Preferences\SpecialChar menuseparator
28809 File Handling\SpecialChar menuseparator
28810 Converters
28811 \end_layout
28812
28813 \end_inset
28814
28815  to
28816 \begin_inset Flex Code
28817 status collapsed
28818
28819 \begin_layout Plain Layout
28820 latex -src-specials $$i
28821 \end_layout
28822
28823 \end_inset
28824
28825 .
28826  If this doesn't work,
28827  check if your \SpecialChar TeX
28828  engine needs different options (the syntax might differ in some distributions).
28829 \end_layout
28830
28831 \begin_layout Subsubsection*
28832 External Packages (PDFSync and scrltx)
28833 \end_layout
28834
28835 \begin_layout Standard
28836 The packages
28837 \emph on
28838 pdfsync
28839 \emph default
28840  and
28841 \emph on
28842 scrltx
28843 \emph default
28844  provide reverse search facility for PDF output (via pdflatex) and DVI output,
28845  respectively.
28846  In order to enable it,
28847  load the packages in the \SpecialChar LyX
28848  preamble:
28849
28850 \end_layout
28851
28852 \begin_layout Itemize
28853 \begin_inset Flex Code
28854 status collapsed
28855
28856 \begin_layout Plain Layout
28857
28858 \backslash
28859 usepackage{pdfsync}
28860 \end_layout
28861
28862 \end_inset
28863
28864  for reverse PDF search,
28865 \end_layout
28866
28867 \begin_layout Itemize
28868 \begin_inset Flex Code
28869 status collapsed
28870
28871 \begin_layout Plain Layout
28872
28873 \backslash
28874 usepackage[active]{srcltx}
28875 \end_layout
28876
28877 \end_inset
28878
28879  for reverse DVI search.
28880 \end_layout
28881
28882 \begin_layout Standard
28883 If you want to be able to perform both DVI and PDF reverse searches,
28884  you can also insert in the preamble the following lines
28885 \end_layout
28886
28887 \begin_layout LyX-Code
28888
28889 \backslash
28890 usepackage{ifpdf}
28891 \begin_inset Newline newline
28892 \end_inset
28893
28894
28895 \backslash
28896 ifpdf
28897 \begin_inset Newline newline
28898 \end_inset
28899
28900
28901 \backslash
28902 usepackage{pdfsync}
28903 \begin_inset Newline newline
28904 \end_inset
28905
28906
28907 \backslash
28908 else
28909 \begin_inset Newline newline
28910 \end_inset
28911
28912
28913 \backslash
28914 usepackage[active]{srcltx}
28915 \begin_inset Newline newline
28916 \end_inset
28917
28918
28919 \backslash
28920 fi
28921 \end_layout
28922
28923 \begin_layout Standard
28924 This way,
28925  you can preview the file as either DVI or PDF (pdflatex) and the right package will be used.
28926 \end_layout
28927
28928 \begin_layout Standard
28929 Note that PDFSync might affect the output layout of your document.
28930  It is therefore advised to disable PDFsync for final documents.
28931 \end_layout
28932
28933 \begin_layout Subsubsection*
28934 Built-in reverse search via Sync\SpecialChar TeX
28935  (DVI and PDF)
28936 \end_layout
28937
28938 \begin_layout Standard
28939 Recent versions of
28940 \begin_inset Flex Code
28941 status collapsed
28942
28943 \begin_layout Plain Layout
28944 (pdf)latex
28945 \end_layout
28946
28947 \end_inset
28948
28949  have built-in support for both PDF and DVI reverse search.
28950  This so-called
28951 \emph on
28952 Sync\SpecialChar TeX
28953
28954 \emph default
28955  facility is basically the result of the integration of the PDFSync package to the pdftex program and its merge with the
28956 \emph on
28957 scr-specials
28958 \emph default
28959  approach.
28960  You need at least \SpecialChar TeX
28961 Live 2008 or a recent Mik\SpecialChar TeX
28962  distribution in order to use it.
28963 \begin_inset Foot
28964 status collapsed
28965
28966 \begin_layout Plain Layout
28967 For some reason,
28968  Mik\SpecialChar TeX
28969  does not understand/obey the command \SpecialChar LyX
28970  inserts into the preamble when you check the "Enable Forward/Reverse Search" button in the toolbar and does not generate the necessary info.
28971 \end_layout
28972
28973 \begin_layout Plain Layout
28974 The generation of the required info can be forced by changing the converter "\SpecialChar LaTeX
28975  (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e.,
28976  by adding the -synctex=1 switch).
28977 \end_layout
28978
28979 \end_inset
28980
28981  Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
28982  Skim on the Mac,
28983  SumatraPDF on Windows;
28984  see the next section for details) already provide Sync\SpecialChar TeX
28985  support.
28986 \end_layout
28987
28988 \begin_layout Standard
28989 To enable Sync\SpecialChar TeX
28990  for DVI output,
28991  change the
28992 \begin_inset Flex Noun
28993 status collapsed
28994
28995 \begin_layout Plain Layout
28996 La
28997 \family sans
28998 TeX
28999 \family default
29000  (plain) -> DVI
29001 \end_layout
29002
29003 \end_inset
29004
29005  or
29006 \begin_inset Flex Noun
29007 status collapsed
29008
29009 \begin_layout Plain Layout
29010 La
29011 \family sans
29012 TeX
29013 \family default
29014  (plain) -> DraftDVI
29015 \end_layout
29016
29017 \end_inset
29018
29019  converter in
29020 \begin_inset Flex Noun
29021 status collapsed
29022
29023 \begin_layout Plain Layout
29024 Preferences\SpecialChar menuseparator
29025 File Handling\SpecialChar menuseparator
29026 Converters
29027 \end_layout
29028
29029 \end_inset
29030
29031  to
29032 \begin_inset Flex Code
29033 status collapsed
29034
29035 \begin_layout Plain Layout
29036 latex -synctex=1 $$i
29037 \end_layout
29038
29039 \end_inset
29040
29041 ,
29042  and for PDF output,
29043  change the
29044 \begin_inset Flex Noun
29045 status collapsed
29046
29047 \begin_layout Plain Layout
29048 La
29049 \family sans
29050 TeX
29051 \family default
29052  (pdflatex) -> PDF (pdflatex)
29053 \end_layout
29054
29055 \end_inset
29056
29057  converter to
29058 \begin_inset Flex Code
29059 status collapsed
29060
29061 \begin_layout Plain Layout
29062 pdflatex -synctex=1 $$i
29063 \end_layout
29064
29065 \end_inset
29066
29067 .
29068  Should your viewer not be considered in the following description,
29069  or in case of missing success,
29070  please check the documentation of your viewer whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
29071 .
29072 \begin_inset Foot
29073 status collapsed
29074
29075 \begin_layout Plain Layout
29076 Note that the option
29077 \begin_inset Flex Code
29078 status collapsed
29079
29080 \begin_layout Plain Layout
29081 -synctex=1
29082 \end_layout
29083
29084 \end_inset
29085
29086  option enables gzip compression.
29087  If your viewer does not support it,
29088  you should instead use
29089 \begin_inset Flex Code
29090 status collapsed
29091
29092 \begin_layout Plain Layout
29093 -synctex=-1
29094 \end_layout
29095
29096 \end_inset
29097
29098 .
29099 \end_layout
29100
29101 \end_inset
29102
29103
29104 \end_layout
29105
29106 \begin_layout Subsection
29107 Configuring and using specific viewers
29108 \begin_inset CommandInset label
29109 LatexCommand label
29110 name "subsec:configuring-viewers"
29111
29112 \end_inset
29113
29114
29115 \end_layout
29116
29117 \begin_layout Subsubsection*
29118 Xdvi (all platforms)
29119 \end_layout
29120
29121 \begin_layout Standard
29122 If you use
29123 \begin_inset Flex Code
29124 status collapsed
29125
29126 \begin_layout Plain Layout
29127 xdvi
29128 \end_layout
29129
29130 \end_inset
29131
29132 ,
29133  you don't need to do anything else for performing a reverse DVI search,
29134  as \SpecialChar LyX
29135  already provides the necessary hooks for automatically using the
29136 \begin_inset Flex Code
29137 status collapsed
29138
29139 \begin_layout Plain Layout
29140 lyxclient
29141 \end_layout
29142
29143 \end_inset
29144
29145  program.
29146  Just setup your document as described above (reverse search is triggered by Ctrl-click or Alt-click on Mac OSX,
29147  respectively).
29148 \end_layout
29149
29150 \begin_layout Standard
29151 However,
29152  if for whatever reason you want to use the named pipe instead of the socket for communicating with \SpecialChar LyX
29153 ,
29154  simply change the DVI viewer in
29155 \begin_inset Flex Noun
29156 status collapsed
29157
29158 \begin_layout Plain Layout
29159 Preferences\SpecialChar menuseparator
29160 File Handling\SpecialChar menuseparator
29161 File formats
29162 \end_layout
29163
29164 \end_inset
29165
29166  to
29167 \begin_inset Foot
29168 status collapsed
29169
29170 \begin_layout Plain Layout
29171 On Mac OSX you have to use
29172 \begin_inset Flex Code
29173 status collapsed
29174
29175 \begin_layout Plain Layout
29176 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
29177 \end_layout
29178
29179 \end_inset
29180
29181
29182 \end_layout
29183
29184 \end_inset
29185
29186
29187 \begin_inset Flex Code
29188 status collapsed
29189
29190 \begin_layout Plain Layout
29191 xdvi -editor "lyxeditor.sh %f %l"
29192 \end_layout
29193
29194 \end_inset
29195
29196 ,
29197  where
29198 \begin_inset Flex Code
29199 status collapsed
29200
29201 \begin_layout Plain Layout
29202 lyxeditor.sh
29203 \end_layout
29204
29205 \end_inset
29206
29207  is a suitable script.
29208  For example,
29209  a minimal shell script is the following one:
29210 \end_layout
29211
29212 \begin_layout LyX-Code
29213 #!/bin/sh
29214 \begin_inset Newline newline
29215 \end_inset
29216
29217 LYXPIPE="/path/to/lyxpipe"
29218 \begin_inset Newline newline
29219 \end_inset
29220
29221 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
29222 \begin_inset Newline newline
29223 \end_inset
29224
29225 echo "$COMMAND" > "${LYXPIPE}".in || exit
29226 \begin_inset Newline newline
29227 \end_inset
29228
29229 read TMP < "${LYXPIPE}".out || exit
29230 \end_layout
29231
29232 \begin_layout Standard
29233 where
29234 \begin_inset Flex Code
29235 status collapsed
29236
29237 \begin_layout Plain Layout
29238 /path/to/lyxpipe
29239 \end_layout
29240
29241 \end_inset
29242
29243  is the LyXServer pipe path specified in
29244 \begin_inset Flex Noun
29245 status collapsed
29246
29247 \begin_layout Plain Layout
29248 Preferences\SpecialChar menuseparator
29249 Paths
29250 \end_layout
29251
29252 \end_inset
29253
29254 .
29255 \begin_inset Foot
29256 status collapsed
29257
29258 \begin_layout Plain Layout
29259 In the
29260 \begin_inset Flex Code
29261 status collapsed
29262
29263 \begin_layout Plain Layout
29264 development/tools
29265 \end_layout
29266
29267 \end_inset
29268
29269  folder of a source distribution you can find a
29270 \begin_inset Flex Code
29271 status collapsed
29272
29273 \begin_layout Plain Layout
29274 lyxeditor
29275 \end_layout
29276
29277 \end_inset
29278
29279  script which is able to locate the
29280 \emph on
29281 lyxpipe
29282 \emph default
29283  based on your preferences.
29284 \end_layout
29285
29286 \end_inset
29287
29288
29289 \end_layout
29290
29291 \begin_layout Subsubsection*
29292 MacDviX (Mac OSX)
29293 \end_layout
29294
29295 \begin_layout Standard
29296 At the end of
29297 \begin_inset Flex Code
29298 status collapsed
29299
29300 \begin_layout Plain Layout
29301 /Applications/MacDviX_Folder/calleditor.script
29302 \end_layout
29303
29304 \end_inset
29305
29306 ,
29307  add the following lines:
29308 \end_layout
29309
29310 \begin_layout LyX-Code
29311 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
29312 \begin_inset Newline newline
29313 \end_inset
29314
29315 exit 1
29316 \end_layout
29317
29318 \begin_layout Standard
29319 Modify the lines accordingly if you install \SpecialChar LyX
29320  somewhere else than in the Applications folder.
29321 \end_layout
29322
29323 \begin_layout Standard
29324 Reverse search is triggered by Alt-click (OPTION-click).
29325 \end_layout
29326
29327 \begin_layout Subsubsection*
29328 Skim (Mac OSX)
29329 \end_layout
29330
29331 \begin_layout Standard
29332 Enter
29333 \begin_inset Flex Code
29334 status collapsed
29335
29336 \begin_layout Plain Layout
29337 open -a Skim.app $$i
29338 \end_layout
29339
29340 \end_inset
29341
29342  to the viewer setting in
29343 \begin_inset Flex Noun
29344 status collapsed
29345
29346 \begin_layout Plain Layout
29347 Preferences\SpecialChar menuseparator
29348 File Handling\SpecialChar menuseparator
29349 File formats\SpecialChar menuseparator
29350 PDF (pdflatex)
29351 \end_layout
29352
29353 \end_inset
29354
29355 ,
29356  and then in
29357 \begin_inset Flex Noun
29358 status collapsed
29359
29360 \begin_layout Plain Layout
29361 Skim\SpecialChar menuseparator
29362 Preferences\SpecialChar menuseparator
29363 Sync
29364 \end_layout
29365
29366 \end_inset
29367
29368  choose
29369 \begin_inset Flex Noun
29370 status collapsed
29371
29372 \begin_layout Plain Layout
29373 custom
29374 \end_layout
29375
29376 \end_inset
29377
29378  preset and enter command
29379 \begin_inset Flex Noun
29380 status collapsed
29381
29382 \begin_layout Plain Layout
29383 /Applications/\SpecialChar LyX
29384 .app/Contents/MacOS/lyxeditor
29385 \end_layout
29386
29387 \end_inset
29388
29389 .
29390 \end_layout
29391
29392 \begin_layout Standard
29393 Reverse search is triggered by COMMAND-SHIFT-click
29394 \end_layout
29395
29396 \begin_layout Subsubsection*
29397 Evince (GNOME)
29398 \end_layout
29399
29400 \begin_layout Standard
29401 Reverse search with evince does not work out of the box,
29402  but it can be achieved by means of some third party helper scripts.
29403  Please refer to
29404 \begin_inset CommandInset href
29405 LatexCommand href
29406 target "https://wiki.lyx.org/LyX/SyncTeX"
29407 literal "false"
29408
29409 \end_inset
29410
29411  for details.
29412 \end_layout
29413
29414 \begin_layout Subsubsection*
29415 Okular (KDE)
29416 \end_layout
29417
29418 \begin_layout Standard
29419 Go to
29420 \begin_inset Flex Noun
29421 status collapsed
29422
29423 \begin_layout Plain Layout
29424 Settings\SpecialChar menuseparator
29425 Configure Okular\SpecialChar menuseparator
29426 Editor
29427 \end_layout
29428
29429 \end_inset
29430
29431  and select LyX
29432 \begin_inset Quotes erd
29433 \end_inset
29434
29435  as editor.
29436  This inserts the appropriate command (
29437 \begin_inset Flex Code
29438 status collapsed
29439
29440 \begin_layout Plain Layout
29441 lyxclient -g %f %l
29442 \end_layout
29443
29444 \end_inset
29445
29446 ).
29447 \end_layout
29448
29449 \begin_layout Standard
29450 Reverse search is triggered by SHIFT-click.
29451
29452 \change_inserted -712698321 1578211026
29453  Note that this only works if Okular is in
29454 \begin_inset Quotes eld
29455 \end_inset
29456
29457 Browse
29458 \begin_inset Quotes erd
29459 \end_inset
29460
29461  mode (i.
29462 \begin_inset space \thinspace{}
29463 \end_inset
29464
29465 e.,
29466  the hand symbol is clicked).
29467 \change_unchanged
29468
29469 \end_layout
29470
29471 \begin_layout Subsubsection*
29472 Qpdfview (Unix)
29473 \end_layout
29474
29475 \begin_layout Standard
29476 Qpdfview supports Sync\SpecialChar TeX
29477  since version 0.3.5.
29478  Go to
29479 \begin_inset Flex Noun
29480 status collapsed
29481
29482 \begin_layout Plain Layout
29483 Edit\SpecialChar menuseparator
29484 Settings\SpecialChar menuseparator
29485 Behavior
29486 \end_layout
29487
29488 \end_inset
29489
29490 ,
29491  click on the input field of the
29492 \begin_inset Quotes eld
29493 \end_inset
29494
29495 Source editor
29496 \begin_inset Quotes erd
29497 \end_inset
29498
29499  item and add the command
29500 \begin_inset Flex Code
29501 status collapsed
29502
29503 \begin_layout Plain Layout
29504 lyxclient -g %1 %2
29505 \end_layout
29506
29507 \end_inset
29508
29509 .
29510 \end_layout
29511
29512 \begin_layout Standard
29513 Reverse search is triggered by double-click or,
29514  in more recent versions,
29515  by context menu.
29516 \end_layout
29517
29518 \begin_layout Subsubsection*
29519 YAP (Windows)
29520 \end_layout
29521
29522 \begin_layout Standard
29523 Launch yap,
29524  choose its
29525 \begin_inset Flex Noun
29526 status collapsed
29527
29528 \begin_layout Plain Layout
29529 View\SpecialChar menuseparator
29530 Options
29531 \end_layout
29532
29533 \end_inset
29534
29535  menu and select the
29536 \begin_inset Quotes eld
29537 \end_inset
29538
29539 Inverse DVI Search
29540 \begin_inset Quotes erd
29541 \end_inset
29542
29543  tab.
29544  Click on the
29545 \begin_inset Quotes eld
29546 \end_inset
29547
29548 New\SpecialChar ldots
29549
29550 \begin_inset Quotes erd
29551 \end_inset
29552
29553  button and,
29554  in the window that opens,
29555  enter
29556 \begin_inset Quotes eld
29557 \end_inset
29558
29559 \SpecialChar LyX
29560  Editor
29561 \begin_inset Quotes erd
29562 \end_inset
29563
29564  (or any other name you like) in the
29565 \begin_inset Quotes eld
29566 \end_inset
29567
29568 Name:
29569 \begin_inset Quotes erd
29570 \end_inset
29571
29572  field.
29573  Now click on the button labeled
29574 \begin_inset Quotes eld
29575 \end_inset
29576
29577 \SpecialChar ldots
29578
29579 \begin_inset Quotes erd
29580 \end_inset
29581
29582  to open a file dialog and navigate to the directory containing the batch file
29583 \begin_inset Flex Code
29584 status collapsed
29585
29586 \begin_layout Plain Layout
29587 lyxeditor.bat
29588 \end_layout
29589
29590 \end_inset
29591
29592  (see below).
29593  Select
29594 \begin_inset Flex Code
29595 status collapsed
29596
29597 \begin_layout Plain Layout
29598 lyxeditor.bat
29599 \end_layout
29600
29601 \end_inset
29602
29603  and then specify the program arguments as
29604 \begin_inset Flex Code
29605 status collapsed
29606
29607 \begin_layout Plain Layout
29608 %f %l
29609 \end_layout
29610
29611 \end_inset
29612
29613 .
29614  The
29615 \begin_inset Flex Code
29616 status collapsed
29617
29618 \begin_layout Plain Layout
29619 lyxeditor.bat
29620 \end_layout
29621
29622 \end_inset
29623
29624  wrapper is used for communicating with \SpecialChar LyX
29625  through the
29626 \emph on
29627 lyxpipe
29628 \emph default
29629  and is as follows:
29630 \end_layout
29631
29632 \begin_layout LyX-Code
29633 @echo off
29634 \begin_inset Newline newline
29635 \end_inset
29636
29637 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
29638 \backslash
29639
29640 \backslash
29641 .
29642 \backslash
29643 pipe
29644 \backslash
29645 lyxpipe.in
29646 \begin_inset Newline newline
29647 \end_inset
29648
29649 type
29650 \backslash
29651
29652 \backslash
29653 .
29654 \backslash
29655 pipe
29656 \backslash
29657 lyxpipe.out
29658 \end_layout
29659
29660 \begin_layout Standard
29661 Make sure that the \SpecialChar LyX
29662 Server pipe path you specified in \SpecialChar LyX
29663  is
29664 \begin_inset Flex Code
29665 status collapsed
29666
29667 \begin_layout Plain Layout
29668
29669 \backslash
29670
29671 \backslash
29672 .
29673 \backslash
29674 pipe
29675 \backslash
29676 lyxpipe
29677 \end_layout
29678
29679 \end_inset
29680
29681 ,
29682  otherwise change the
29683 \begin_inset Flex Code
29684 status collapsed
29685
29686 \begin_layout Plain Layout
29687 lyxeditor.bat
29688 \end_layout
29689
29690 \end_inset
29691
29692  wrapper accordingly.
29693 \end_layout
29694
29695 \begin_layout Standard
29696 In yap,
29697  reverse search is triggered by double-click.
29698 \end_layout
29699
29700 \begin_layout Subsubsection*
29701 SumatraPDF (Windows)
29702 \end_layout
29703
29704 \begin_layout Standard
29705 In order to use SumatraPDF for inverse search,
29706  enter
29707 \begin_inset Flex Code
29708 status collapsed
29709
29710 \begin_layout Plain Layout
29711 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
29712 \end_layout
29713
29714 \end_inset
29715
29716  in the viewer setting in
29717 \begin_inset Flex Noun
29718 status collapsed
29719
29720 \begin_layout Plain Layout
29721 Preferences\SpecialChar menuseparator
29722 File Handling\SpecialChar menuseparator
29723 File formats\SpecialChar menuseparator
29724 PDF (pdflatex)
29725 \end_layout
29726
29727 \end_inset
29728
29729 ,
29730  where
29731 \begin_inset Flex Code
29732 status collapsed
29733
29734 \begin_layout Plain Layout
29735 lyxeditor.bat
29736 \end_layout
29737
29738 \end_inset
29739
29740  is the previous wrapper.
29741  If SumatraPDF.exe is not in your command PATH,
29742  use its full file name.
29743 \end_layout
29744
29745 \begin_layout Standard
29746 Reverse search is triggered by double-click.
29747 \end_layout
29748
29749 \begin_layout Subsubsection*
29750 YAP (Cygwin)
29751 \end_layout
29752
29753 \begin_layout Standard
29754 First of all,
29755  make sure that yap is your default DVI viewer in the Windows environment,
29756  then launch it,
29757  choose its
29758 \begin_inset Flex Noun
29759 status collapsed
29760
29761 \begin_layout Plain Layout
29762 View\SpecialChar menuseparator
29763 Options
29764 \end_layout
29765
29766 \end_inset
29767
29768  menu and select the
29769 \begin_inset Quotes eld
29770 \end_inset
29771
29772 Inverse DVI Search
29773 \begin_inset Quotes erd
29774 \end_inset
29775
29776  tab.
29777  Click on the
29778 \begin_inset Quotes eld
29779 \end_inset
29780
29781 New\SpecialChar ldots
29782
29783 \begin_inset Quotes erd
29784 \end_inset
29785
29786  button and,
29787  in the window that opens,
29788  enter
29789 \begin_inset Quotes eld
29790 \end_inset
29791
29792 \SpecialChar LyX
29793  Editor
29794 \begin_inset Quotes erd
29795 \end_inset
29796
29797  (or any other name you like) in the
29798 \begin_inset Quotes eld
29799 \end_inset
29800
29801 Name:
29802 \begin_inset Quotes erd
29803 \end_inset
29804
29805  field.
29806  Now click on the button labeled
29807 \begin_inset Quotes eld
29808 \end_inset
29809
29810 \SpecialChar ldots
29811
29812 \begin_inset Quotes erd
29813 \end_inset
29814
29815  to open a file dialog and navigate to the directory containing the
29816 \begin_inset Flex Code
29817 status collapsed
29818
29819 \begin_layout Plain Layout
29820 lyxeditor.exe
29821 \end_layout
29822
29823 \end_inset
29824
29825  program (which is installed by default on Cygwin along with the \SpecialChar LyX
29826  executable).
29827  Select
29828 \begin_inset Flex Code
29829 status collapsed
29830
29831 \begin_layout Plain Layout
29832 lyxeditor.exe
29833 \end_layout
29834
29835 \end_inset
29836
29837  and then specify the program arguments as
29838 \begin_inset Flex Code
29839 status collapsed
29840
29841 \begin_layout Plain Layout
29842 -g %f %l
29843 \end_layout
29844
29845 \end_inset
29846
29847 .
29848  In this way,
29849  you will be using the
29850 \emph on
29851 lyxsocket
29852 \emph default
29853  for communicating with \SpecialChar LyX
29854 .
29855  If,
29856  for whatever reason,
29857  you want to use the
29858 \emph on
29859 lyxpipe
29860 \emph default
29861 ,
29862  omit the
29863 \begin_inset Flex Code
29864 status collapsed
29865
29866 \begin_layout Plain Layout
29867 -g
29868 \end_layout
29869
29870 \end_inset
29871
29872  option and be sure to specify the \SpecialChar LyX
29873 Server pipe path in the \SpecialChar LyX
29874  preferences.
29875 \end_layout
29876
29877 \begin_layout Standard
29878 In yap,
29879  reverse search is triggered by double-click.
29880 \end_layout
29881
29882 \begin_layout Subsubsection*
29883 SumatraPDF (Cygwin)
29884 \end_layout
29885
29886 \begin_layout Standard
29887 In order to use SumatraPDF for inverse search,
29888  enter
29889 \begin_inset Flex Code
29890 status collapsed
29891
29892 \begin_layout Plain Layout
29893 SumatraPDF -inverse-search "lyxeditor -g %f %l"
29894 \end_layout
29895
29896 \end_inset
29897
29898  in the viewer setting in
29899 \begin_inset Flex Noun
29900 status collapsed
29901
29902 \begin_layout Plain Layout
29903 Preferences\SpecialChar menuseparator
29904 File Handling\SpecialChar menuseparator
29905 File formats\SpecialChar menuseparator
29906 PDF (pdflatex)
29907 \end_layout
29908
29909 \end_inset
29910
29911 .
29912  If SumatraPDF.exe is not in your command PATH,
29913  use its full posix path.
29914  The
29915 \begin_inset Flex Code
29916 status collapsed
29917
29918 \begin_layout Plain Layout
29919 -g
29920 \end_layout
29921
29922 \end_inset
29923
29924  enables communication via the
29925 \emph on
29926 lyxsocket
29927 \emph default
29928 .
29929  Again,
29930  omit the
29931 \begin_inset Flex Code
29932 status collapsed
29933
29934 \begin_layout Plain Layout
29935 -g
29936 \end_layout
29937
29938 \end_inset
29939
29940  option if you want to use the
29941 \emph on
29942 lyxpipe
29943 \emph default
29944 ,
29945  and be sure to specify the \SpecialChar LyX
29946 Server pipe path in the \SpecialChar LyX
29947  preferences.
29948 \end_layout
29949
29950 \begin_layout Standard
29951 Reverse search is triggered by double-click.
29952 \end_layout
29953
29954 \begin_layout Section
29955 Forward search
29956 \end_layout
29957
29958 \begin_layout Standard
29959 Forward search is,
29960  as the name implies,
29961  in a sense the
29962 \begin_inset Quotes eld
29963 \end_inset
29964
29965 opposite
29966 \begin_inset Quotes erd
29967 \end_inset
29968
29969  of reverse search.
29970  It allows you to let the viewer jump to a given position from within \SpecialChar LyX
29971 .
29972  If forward search is set up (as described in what follows),
29973  you can put the cursor anywhere in your \SpecialChar LyX
29974  document,
29975  and hit
29976 \begin_inset Flex Noun
29977 status collapsed
29978
29979 \begin_layout Plain Layout
29980 Navigate\SpecialChar menuseparator
29981 Forward search
29982 \end_layout
29983
29984 \end_inset
29985
29986  (or select
29987 \begin_inset Flex Noun
29988 status collapsed
29989
29990 \begin_layout Plain Layout
29991 Forward search
29992 \end_layout
29993
29994 \end_inset
29995
29996  in the context menu via right mouse click),
29997  and then the viewer will jump to that position as well.
29998  This implies,
29999  of course,
30000  that your viewer supports this function.
30001 \end_layout
30002
30003 \begin_layout Standard
30004 To make forward search possible,
30005  you first need to provide the generated output PDF/DVI file with additional information about the \SpecialChar TeX
30006  sources.
30007  This can be done via the methods described in the section
30008 \begin_inset CommandInset ref
30009 LatexCommand ref
30010 reference "subsec:rev-search"
30011 nolink "false"
30012
30013 \end_inset
30014
30015 .
30016 \end_layout
30017
30018 \begin_layout Standard
30019 Additionally,
30020  you need to configure \SpecialChar LyX
30021  for using your viewers in
30022 \begin_inset Flex Noun
30023 status collapsed
30024
30025 \begin_layout Plain Layout
30026 Tools\SpecialChar menuseparator
30027 Preferences\SpecialChar menuseparator
30028 Output\SpecialChar menuseparator
30029 General
30030 \end_layout
30031
30032 \end_inset
30033
30034 .
30035  We provide a range of tested configurations for some viewers,
30036  which you can select from the drop down list.
30037  If none of these configurations suits you,
30038  you have to find out and enter a suitable configuration yourself.
30039  The definition syntax uses the following placeholders:
30040 \end_layout
30041
30042 \begin_layout Itemize
30043 \noindent
30044 \begin_inset Flex Code
30045 status collapsed
30046
30047 \begin_layout Plain Layout
30048 $$n
30049 \end_layout
30050
30051 \end_inset
30052
30053 :
30054  row number
30055 \end_layout
30056
30057 \begin_layout Itemize
30058 \noindent
30059 \begin_inset Flex Code
30060 status collapsed
30061
30062 \begin_layout Plain Layout
30063 $$t
30064 \end_layout
30065
30066 \end_inset
30067
30068 :
30069  name of the (temporary) exported .tex file (without path)
30070 \end_layout
30071
30072 \begin_layout Itemize
30073 \noindent
30074 \begin_inset Flex Code
30075 status collapsed
30076
30077 \begin_layout Plain Layout
30078 $$f
30079 \end_layout
30080
30081 \end_inset
30082
30083 :
30084  name of the (temporary) exported .tex file (including path)
30085 \end_layout
30086
30087 \begin_layout Itemize
30088 \noindent
30089 \begin_inset Flex Code
30090 status collapsed
30091
30092 \begin_layout Plain Layout
30093 $$o
30094 \end_layout
30095
30096 \end_inset
30097
30098 :
30099  name of the exported output file (either dvi or pdf,
30100  depending on which one exists in the temporary directory)
30101 \end_layout
30102
30103 \begin_layout Standard
30104 Note that only some of the viewers provide full and usable forward search functionality out of the box,
30105  among them yap,
30106  xdvi,
30107  okular
30108 \begin_inset Foot
30109 status collapsed
30110
30111 \begin_layout Plain Layout
30112 You might want to set
30113 \begin_inset Flex Code
30114 status collapsed
30115
30116 \begin_layout Plain Layout
30117 okular --unique
30118 \end_layout
30119
30120 \end_inset
30121
30122  in
30123 \begin_inset Flex Noun
30124 status collapsed
30125
30126 \begin_layout Plain Layout
30127 Tools\SpecialChar menuseparator
30128 Preferences\SpecialChar menuseparator
30129 File Handling\SpecialChar menuseparator
30130 File
30131 \begin_inset space ~
30132 \end_inset
30133
30134 Formats
30135 \end_layout
30136
30137 \end_inset
30138
30139
30140 \end_layout
30141
30142 \end_inset
30143
30144 ,
30145  qpdfview,
30146  and SumatraPDF
30147 \begin_inset Foot
30148 status collapsed
30149
30150 \begin_layout Plain Layout
30151 SumatraPDF can also use DDE commands through the external program CMCDDE —
30152  downloadable from
30153 \begin_inset CommandInset href
30154 LatexCommand href
30155 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
30156 literal "false"
30157
30158 \end_inset
30159
30160
30161 \end_layout
30162
30163 \end_inset
30164
30165 .
30166  Others,
30167  such as evince
30168 \begin_inset Foot
30169 status collapsed
30170
30171 \begin_layout Plain Layout
30172 Forward search with evince can be achieved by means of third party helper scripts.
30173  Please refer to
30174 \begin_inset CommandInset href
30175 LatexCommand href
30176 target "https://wiki.lyx.org/LyX/SyncTeX"
30177 literal "false"
30178
30179 \end_inset
30180
30181  for details.
30182 \end_layout
30183
30184 \end_inset
30185
30186 ,
30187  require some extra tools in order to use forward search.
30188  While many of the widespread PDF viewers (most notably Adobe Reader) do not support forward search at all,
30189  some other viewers – e.
30190 \begin_inset space \thinspace{}
30191 \end_inset
30192
30193 g.
30194  xpdf – allow at least to reload the document and jump to a specific page of the file,
30195  so you can at least navigate
30196 \begin_inset Quotes eld
30197 \end_inset
30198
30199 near
30200 \begin_inset Quotes erd
30201 \end_inset
30202
30203 .
30204  This latter functionality is provided by an external call of synctex (see the predefined example configurations).
30205
30206 \end_layout
30207
30208 \begin_layout Standard
30209 Forward search works both with DVI and PDF output.
30210  \SpecialChar LyX
30211  simply checks which preview format you have used before (i.
30212 \begin_inset space \thinspace{}
30213 \end_inset
30214
30215 e.,
30216  which format is already there in the temporary directory) and chooses the appropriate configuration for the respective format.
30217 \change_deleted 564990737 1672743015
30218
30219 \end_layout
30220
30221 \begin_layout Standard
30222
30223 \change_deleted 564990737 1672743015
30224 Special Document Classes
30225 \end_layout
30226
30227 \begin_layout Standard
30228
30229 \change_deleted 564990737 1669742044
30230 A&A Paper
30231 \end_layout
30232
30233 \begin_layout Standard
30234
30235 \change_deleted 564990737 1669742044
30236 by
30237 \noun on
30238 Peter Sütterlin
30239 \end_layout
30240
30241 \begin_layout Standard
30242
30243 \change_deleted 564990737 1669742044
30244 Introduction
30245 \end_layout
30246
30247 \begin_layout Standard
30248
30249 \change_deleted 564990737 1669742044
30250 This section describes how \SpecialChar LyX
30251  can be used to write articles for submission to the scientific journal
30252 \emph on
30253 Astronomy and Astrophysics
30254 \emph default
30255  (
30256 \begin_inset Flex URL
30257 status collapsed
30258
30259 \begin_layout Plain Layout
30260
30261 https://www.aanda.org/
30262 \end_layout
30263
30264 \end_inset
30265
30266 ) using Version 5.01 of the document class
30267 \family typewriter
30268 aa.cls
30269 \family default
30270 .
30271  This package can be downloaded from the ftp site
30272 \end_layout
30273
30274 \begin_layout Standard
30275
30276 \change_deleted 564990737 1669742044
30277 \begin_inset VSpace medskip
30278 \end_inset
30279
30280
30281 \end_layout
30282
30283 \begin_layout Standard
30284 \align center
30285
30286 \change_deleted 564990737 1669742044
30287 \begin_inset Flex URL
30288 status collapsed
30289
30290 \begin_layout Plain Layout
30291
30292 ftp://ftp.edpsciences.org/pub/aa/readme.html
30293 \end_layout
30294
30295 \end_inset
30296
30297
30298 \end_layout
30299
30300 \begin_layout Standard
30301
30302 \change_deleted 564990737 1669742044
30303 \begin_inset VSpace medskip
30304 \end_inset
30305
30306
30307 \end_layout
30308
30309 \begin_layout Standard
30310
30311 \change_deleted 564990737 1669742044
30312 A manual comes together with that package,
30313  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.
30314
30315 \end_layout
30316
30317 \begin_layout Standard
30318
30319 \change_deleted 564990737 1669742044
30320 Please note that the publisher of the journal was changed from Springer to EDP Sciences starting January 1,
30321  2001.
30322  That change involved also some slight changes to the style files,
30323  namely the removal of the thesaurus command.
30324  The \SpecialChar LyX
30325  class aa supports the newest version of these style files,
30326  V 5.01.
30327  If you have an older version installed,
30328  please upgrade.
30329  For compatibility,
30330  the old (version 4) layout has been kept as
30331 \family sans
30332 article (A&A V4)
30333 \family default
30334 .
30335  Please refer to the comments in
30336 \family typewriter
30337 \SpecialChar LyX
30338 Dir/layouts/aapaper.layout
30339 \family default
30340 .
30341 \end_layout
30342
30343 \begin_layout Standard
30344
30345 \change_deleted 564990737 1669742044
30346 Getting started
30347 \end_layout
30348
30349 \begin_layout Standard
30350
30351 \change_deleted 564990737 1669742044
30352 It is recommended you start from the example template distributed with \SpecialChar LyX
30353 .
30354  If you are not using a template,
30355  note the following settings:
30356 \end_layout
30357
30358 \begin_layout Itemize
30359
30360 \change_deleted 564990737 1669742044
30361 Select
30362 \family sans
30363 article (A&A)
30364 \family default
30365  in the
30366 \family sans
30367 Document\SpecialChar menuseparator
30368 Settings
30369 \family default
30370  dialog (OK,
30371  that one was obvious).
30372 \end_layout
30373
30374 \begin_layout Itemize
30375
30376 \change_deleted 564990737 1669742044
30377 Don't change the option
30378 \family sans
30379 Page
30380 \begin_inset space ~
30381 \end_inset
30382
30383 style
30384 \family default
30385 :
30386  Leave it set to
30387 \family sans
30388 default
30389 \family default
30390 .
30391  The whole layout is done by the macros,
30392  you shouldn't change anything.
30393 \end_layout
30394
30395 \begin_layout Standard
30396
30397 \change_deleted 564990737 1669742044
30398 The header block
30399 \end_layout
30400
30401 \begin_layout Standard
30402
30403 \change_deleted 564990737 1669742044
30404 First thing to enter is the header information.
30405  It consists of seven entries,
30406  of which some are optional.
30407  They are
30408 \end_layout
30409
30410 \begin_layout Itemize
30411
30412 \change_deleted 564990737 1669742044
30413
30414 \family sans
30415 Title
30416 \family default
30417 :
30418  [required]
30419 \end_layout
30420
30421 \begin_layout Itemize
30422
30423 \change_deleted 564990737 1669742044
30424
30425 \family sans
30426 Subtitle
30427 \family default
30428 :
30429  [optional]
30430 \end_layout
30431
30432 \begin_layout Itemize
30433
30434 \change_deleted 564990737 1669742044
30435
30436 \family sans
30437 Author
30438 \family default
30439 :
30440  [required]
30441 \end_layout
30442
30443 \begin_layout Itemize
30444
30445 \change_deleted 564990737 1669742044
30446
30447 \family sans
30448 Address
30449 \family default
30450 :
30451  [required]
30452 \end_layout
30453
30454 \begin_layout Itemize
30455
30456 \change_deleted 564990737 1669742044
30457
30458 \family sans
30459 Offprints
30460 \family default
30461 :
30462  [optional] if more than one author:
30463  whom to contact for offprint requests.
30464 \end_layout
30465
30466 \begin_layout Itemize
30467
30468 \change_deleted 564990737 1669742044
30469
30470 \family sans
30471 Mail
30472 \family default
30473 :
30474  [optional] mail address for contacts.
30475 \end_layout
30476
30477 \begin_layout Itemize
30478
30479 \change_deleted 564990737 1669742044
30480
30481 \family sans
30482 Date
30483 \family default
30484 :
30485  [required].
30486  Suggested format is
30487 \family typewriter
30488 Received:
30489  <date>;
30490  Accepted <date>
30491 \end_layout
30492
30493 \begin_layout Standard
30494
30495 \change_deleted 564990737 1669742044
30496 There is no need to issue the
30497 \family typewriter
30498
30499 \backslash
30500 maketitle
30501 \family default
30502  command,
30503  this is done automatically by \SpecialChar LyX
30504  when the header is finished.
30505  Although the order of the single header entries doesn't matter it is advised to keep the above sequence,
30506  just to get the best optics and meets the layout of the real document.
30507 \end_layout
30508
30509 \begin_layout Standard
30510
30511 \change_deleted 564990737 1669742044
30512 If you want to place footnotes in the header block,
30513  e.
30514 \begin_inset space \thinspace{}
30515 \end_inset
30516
30517 g.
30518 \begin_inset space \space{}
30519 \end_inset
30520
30521 to state your present address,
30522  just use the standard footnote via the menu
30523 \family sans
30524 Insert\SpecialChar menuseparator
30525 Footnote.
30526
30527 \family default
30528  \SpecialChar LyX
30529  will automagically use the term
30530 \family typewriter
30531
30532 \backslash
30533 thanks{}
30534 \family default
30535  in that case.
30536 \end_layout
30537
30538 \begin_layout Standard
30539
30540 \change_deleted 564990737 1669742044
30541 Under
30542 \family sans
30543 Edit\SpecialChar menuseparator
30544 Text Style
30545 \family default
30546 ,
30547  you'll find two insets which are relevant for the titling:
30548 \end_layout
30549
30550 \begin_layout Itemize
30551
30552 \change_deleted 564990737 1669742044
30553
30554 \family sans
30555 Institute
30556 \family typewriter
30557
30558 \family default
30559 to mark corresponding author\SpecialChar breakableslash
30560 institute pairs.
30561  The institutes are numbered sequentially as they appear in the
30562 \family sans
30563 Address
30564 \family default
30565  field,
30566  so you have to put a marker to each author.
30567 \end_layout
30568
30569 \begin_layout Itemize
30570
30571 \change_deleted 564990737 1669742044
30572
30573 \family sans
30574 Email
30575 \family default
30576  to supply an email address for fast contact.
30577 \end_layout
30578
30579 \begin_layout Standard
30580
30581 \change_deleted 564990737 1669742044
30582 In addition to these topics,
30583  the macros use one additional \SpecialChar LaTeX
30584  command that has no counterpart in \SpecialChar LyX
30585 :
30586 \end_layout
30587
30588 \begin_layout Itemize
30589
30590 \change_deleted 564990737 1669742044
30591
30592 \family typewriter
30593
30594 \backslash
30595 and
30596 \family default
30597  to separate different names for more than one author and institute,
30598  respectively.
30599 \end_layout
30600
30601 \begin_layout Standard
30602
30603 \change_deleted 564990737 1669742044
30604 The appropriate command has to be entered in \SpecialChar LyX
30605  and marked as \SpecialChar LaTeX
30606  code.
30607  See the examples.
30608
30609 \end_layout
30610
30611 \begin_layout Standard
30612
30613 \change_deleted 564990737 1669742044
30614 The abstract
30615 \end_layout
30616
30617 \begin_layout Standard
30618
30619 \change_deleted 564990737 1669742044
30620 The abstract should immediately follow the header block.
30621  With version 5 the abstract environment was changed to a command,
30622  and there is now a restriction to only one paragraph.
30623  In addition,
30624  it should contain an entry with the keywords.
30625  This is done via the paragraph style
30626 \family sans
30627 Keywords
30628 \family default
30629 .
30630  Refer to the example paper.
30631 \end_layout
30632
30633 \begin_layout Standard
30634
30635 \change_deleted 564990737 1669742044
30636 Supported environments
30637 \end_layout
30638
30639 \begin_layout Standard
30640
30641 \change_deleted 564990737 1669742044
30642 The A&A paper layout supports the following environments for structuring your text:
30643 \end_layout
30644
30645 \begin_layout Itemize
30646
30647 \change_deleted 564990737 1669742044
30648
30649 \family sans
30650 Standard
30651 \end_layout
30652
30653 \begin_layout Itemize
30654
30655 \change_deleted 564990737 1669742044
30656
30657 \family sans
30658 Section
30659 \end_layout
30660
30661 \begin_layout Itemize
30662
30663 \change_deleted 564990737 1669742044
30664
30665 \family sans
30666 Subsection
30667 \end_layout
30668
30669 \begin_layout Itemize
30670
30671 \change_deleted 564990737 1669742044
30672
30673 \family sans
30674 Subsubsection
30675 \end_layout
30676
30677 \begin_layout Itemize
30678
30679 \change_deleted 564990737 1669742044
30680
30681 \family sans
30682 Itemize
30683 \end_layout
30684
30685 \begin_layout Itemize
30686
30687 \change_deleted 564990737 1669742044
30688
30689 \family sans
30690 Enumerate
30691 \end_layout
30692
30693 \begin_layout Itemize
30694
30695 \change_deleted 564990737 1669742044
30696
30697 \family sans
30698 Description
30699 \end_layout
30700
30701 \begin_layout Itemize
30702
30703 \change_deleted 564990737 1669742044
30704
30705 \family sans
30706 Caption
30707 \end_layout
30708
30709 \begin_layout Itemize
30710
30711 \change_deleted 564990737 1669742044
30712
30713 \family sans
30714 Abstract
30715 \end_layout
30716
30717 \begin_layout Itemize
30718
30719 \change_deleted 564990737 1669742044
30720
30721 \family sans
30722 Acknowledgment
30723 \end_layout
30724
30725 \begin_layout Itemize
30726
30727 \change_deleted 564990737 1669742044
30728
30729 \family sans
30730 Bibliography
30731 \end_layout
30732
30733 \begin_layout Itemize
30734
30735 \change_deleted 564990737 1669742044
30736
30737 \family sans
30738 \SpecialChar LaTeX
30739
30740 \end_layout
30741
30742 \begin_layout Standard
30743
30744 \change_deleted 564990737 1669742044
30745 Commands not supported by \SpecialChar LyX
30746
30747 \end_layout
30748
30749 \begin_layout Standard
30750
30751 \change_deleted 564990737 1669742044
30752 Some commands are not yet supported by the
30753 \family sans
30754 paper (A&A)
30755 \family default
30756  layout for \SpecialChar LyX
30757 .
30758  Some have already been mentioned.
30759  For the sake of completeness,
30760  they are listed all together here:
30761 \end_layout
30762
30763 \begin_layout Itemize
30764
30765 \change_deleted 564990737 1669742044
30766
30767 \family typewriter
30768
30769 \backslash
30770 and
30771 \end_layout
30772
30773 \begin_layout Itemize
30774
30775 \change_deleted 564990737 1669742044
30776
30777 \family typewriter
30778
30779 \backslash
30780 authorrunning
30781 \end_layout
30782
30783 \begin_layout Itemize
30784
30785 \change_deleted 564990737 1669742044
30786
30787 \family typewriter
30788
30789 \backslash
30790 object{}
30791 \end_layout
30792
30793 \begin_layout Itemize
30794
30795 \change_deleted 564990737 1669742044
30796
30797 \family typewriter
30798
30799 \backslash
30800 titlerunning{}
30801 \end_layout
30802
30803 \begin_layout Standard
30804
30805 \change_deleted 564990737 1669742044
30806 If you want to use any of these commands,
30807  you have to enter them yourself.
30808
30809 \series bold
30810 Do not forget to mark them as \SpecialChar LaTeX
30811  code!
30812 \end_layout
30813
30814 \begin_layout Standard
30815
30816 \change_deleted 564990737 1669742044
30817 Figure and Table Floats
30818 \end_layout
30819
30820 \begin_layout Standard
30821
30822 \change_deleted 564990737 1669742044
30823 \SpecialChar LyX
30824  provides support for the necessary float environments
30825 \family sans
30826 figure,
30827  figure*,
30828  table
30829 \family default
30830  and
30831 \family sans
30832 table*
30833 \family default
30834 ,
30835  therefore we won't tell much about it here.
30836  Refer to the
30837 \emph on
30838 User's
30839 \begin_inset space ~
30840 \end_inset
30841
30842 Guide
30843 \emph default
30844 .
30845  Just remember that tables should be left-aligned.
30846  For that,
30847  select the table and change the alignment in
30848 \family sans
30849 Edit\SpecialChar menuseparator
30850 Paragraph
30851 \begin_inset space ~
30852 \end_inset
30853
30854 Settings.
30855 \end_layout
30856
30857 \begin_layout Standard
30858
30859 \change_deleted 564990737 1669742044
30860 There is only one special thing:
30861  the figures with caption besides the figure.
30862  To create such a figure,
30863  you have to do the following:
30864 \end_layout
30865
30866 \begin_layout Enumerate
30867
30868 \change_deleted 564990737 1669742044
30869 Create a wide figure float:
30870
30871 \family sans
30872 Insert\SpecialChar menuseparator
30873 Float\SpecialChar menuseparator
30874 Figure
30875 \family default
30876 ,
30877  then right click in the figure and select
30878 \family sans
30879 Span
30880 \begin_inset space ~
30881 \end_inset
30882
30883 columns
30884 \family default
30885 .
30886 \end_layout
30887
30888 \begin_layout Enumerate
30889
30890 \change_deleted 564990737 1669742044
30891 Enter your caption text.
30892 \end_layout
30893
30894 \begin_layout Enumerate
30895
30896 \change_deleted 564990737 1669742044
30897 Press
30898 \family sans
30899 Return
30900 \family default
30901  to move the cursor above the caption.
30902 \end_layout
30903
30904 \begin_layout Enumerate
30905
30906 \change_deleted 564990737 1669742044
30907 Insert your figure
30908 \end_layout
30909
30910 \begin_layout Enumerate
30911
30912 \change_deleted 564990737 1669742044
30913 Position the cursor behind the figure and insert a horizontal fill:
30914
30915 \family sans
30916 Insert\SpecialChar menuseparator
30917 Special
30918 \begin_inset space ~
30919 \end_inset
30920
30921 Character\SpecialChar menuseparator
30922 Horizontal
30923 \begin_inset space ~
30924 \end_inset
30925
30926 Fill
30927 \family default
30928 .
30929 \end_layout
30930
30931 \begin_layout Enumerate
30932
30933 \change_deleted 564990737 1669742044
30934 Switch to \SpecialChar LaTeX
30935  mode:
30936
30937 \family sans
30938 M-c
30939 \begin_inset space ~
30940 \end_inset
30941
30942 t
30943 \family default
30944 .
30945 \end_layout
30946
30947 \begin_layout Enumerate
30948
30949 \change_deleted 564990737 1669742044
30950 Enter
30951 \family typewriter
30952
30953 \backslash
30954 parbox[b]{55mm}{
30955 \family default
30956 .
30957
30958 \series bold
30959 Do not close the brace!
30960 \end_layout
30961
30962 \begin_layout Enumerate
30963
30964 \change_deleted 564990737 1669742044
30965 Position the cursor behind the caption text,
30966  switch to \SpecialChar LaTeX
30967  mode and insert the closing brace:
30968
30969 \family sans
30970 M-c
30971 \begin_inset space ~
30972 \end_inset
30973
30974 t
30975 \family default
30976
30977 \family typewriter
30978 }
30979 \family default
30980 .
30981 \end_layout
30982
30983 \begin_layout Standard
30984
30985 \change_deleted 564990737 1669742044
30986 Also,
30987  refer to the figures in the example paper.
30988 \end_layout
30989
30990 \begin_layout Standard
30991
30992 \change_deleted 564990737 1669742044
30993 Referee layout
30994 \end_layout
30995
30996 \begin_layout Standard
30997
30998 \change_deleted 564990737 1669742044
30999 For submission,
31000  the paper has to be formated in a special double-spacing layout.
31001  For this purpose,
31002  you have to give the option
31003 \family typewriter
31004 referee
31005 \family default
31006  to the document class.
31007  This must be done using the custom class options field in the
31008 \family sans
31009 Document\SpecialChar menuseparator
31010 Settings
31011 \family default
31012  dialog.
31013  Just enter the string
31014 \family typewriter
31015 referee
31016 \family default
31017  there.
31018 \end_layout
31019
31020 \begin_layout Standard
31021
31022 \change_deleted 564990737 1669742044
31023 The example paper
31024 \end_layout
31025
31026 \begin_layout Standard
31027
31028 \change_deleted 564990737 1669742044
31029 The
31030 \family sans
31031 Examples
31032 \family default
31033  directory contains an example paper written with \SpecialChar LyX
31034 .
31035  It is the example paper from the original macro package,
31036  translated to \SpecialChar LyX
31037 .
31038  Use it for inspiration,
31039  and compare the original \SpecialChar LaTeX
31040  code with \SpecialChar LyX
31041  way of writing.
31042 \end_layout
31043
31044 \begin_layout Standard
31045
31046 \change_deleted 564990737 1671097429
31047 Dinbrief
31048 \end_layout
31049
31050 \begin_layout Standard
31051
31052 \change_deleted 564990737 1671097429
31053 The document class
31054 \family sans
31055 dinbrief
31056 \family default
31057  can be used to type letters according to German conventions.
31058  A template file is included in
31059 \family typewriter
31060 .../lyx/share/templates
31061 \family default
31062  for you to use as a starting point.
31063 \end_layout
31064
31065 \begin_layout Standard
31066
31067 \change_deleted 564990737 1671097429
31068 Elsevier Journals
31069 \end_layout
31070
31071 \begin_layout Standard
31072
31073 \change_deleted 564990737 1671097429
31074 See the \SpecialChar LyX
31075  template file
31076 \family typewriter
31077 elsarticle.lyx
31078 \family default
31079 .
31080  It contains all infos you need.
31081 \end_layout
31082
31083 \begin_layout Standard
31084
31085 \change_deleted 564990737 1669755802
31086 ijmpc and ijmpd
31087 \end_layout
31088
31089 \begin_layout Standard
31090
31091 \change_deleted 564990737 1669755802
31092 by
31093 \noun on
31094 Panayotis Papasotiriou
31095 \end_layout
31096
31097 \begin_layout Standard
31098
31099 \change_deleted 564990737 1669755802
31100 Overview
31101 \end_layout
31102
31103 \begin_layout Standard
31104
31105 \change_deleted 564990737 1669755802
31106 The ijmpc package is a set of macros that facilitates electronic manuscript submission to the
31107 \emph on
31108 International Journal of Modern Physics C
31109 \emph default
31110 .
31111  Similarly,
31112  the ijmpd package is for creating manuscripts to be submitted to the
31113 \emph on
31114 International Journal of Modern Physics D
31115 \emph default
31116 .
31117  Both journals are published by World Scientific.
31118  The corresponding document classes are named
31119 \family typewriter
31120 ws-ijmpc.cls
31121 \family default
31122  and
31123 \family typewriter
31124 ws-ijmpd.cls
31125 \family default
31126 ,
31127  respectively.
31128  These files,
31129  together with instructions for the authors,
31130  can be downloaded from the sites
31131 \begin_inset Flex URL
31132 status collapsed
31133
31134 \begin_layout Plain Layout
31135
31136 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
31137 \end_layout
31138
31139 \end_inset
31140
31141  and
31142 \begin_inset Flex URL
31143 status collapsed
31144
31145 \begin_layout Plain Layout
31146
31147 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
31148 \end_layout
31149
31150 \end_inset
31151
31152 .
31153  Both packages are modified versions of the standard
31154 \begin_inset Quotes eld
31155 \end_inset
31156
31157 article
31158 \begin_inset Quotes erd
31159 \end_inset
31160
31161  package,
31162  and they are almost (but not exactly) identical.
31163  Most of their features are supported by \SpecialChar LyX
31164 .
31165  I have used \SpecialChar LyX
31166  successfully to write articles submitted to both journals without any problem.
31167 \end_layout
31168
31169 \begin_layout Standard
31170
31171 \change_deleted 564990737 1669755802
31172 Writing a paper
31173 \end_layout
31174
31175 \begin_layout Standard
31176
31177 \change_deleted 564990737 1669755802
31178 As usual,
31179  the easiest way to write a paper is to start with a template.
31180  Click on
31181 \family sans
31182 File\SpecialChar menuseparator
31183 New from
31184 \family default
31185
31186 \family sans
31187 Template
31188 \family default
31189 ,
31190  then choose the
31191 \family typewriter
31192 ijmpc.lyx
31193 \family default
31194  or
31195 \family typewriter
31196 ijmpd.lyx
31197 \family default
31198  template.
31199  This will give an (almost) empty document that includes the most common fields found in a manuscript.
31200  Simply overwrite the existing text (including the brackets,
31201
31202 \family typewriter
31203 <>
31204 \family default
31205 ) with your text.
31206  You should keep in mind the following remarks.
31207 \end_layout
31208
31209 \begin_layout Enumerate
31210
31211 \change_deleted 564990737 1669755802
31212 \SpecialChar LyX
31213  won't let you change the font size and the page style of the document,
31214  because such modifications are not allowed by both packages.
31215 \end_layout
31216
31217 \begin_layout Enumerate
31218
31219 \change_deleted 564990737 1669755802
31220 The language of the document should not be changed.
31221  Before previewing your paper,
31222  be sure that the babel package is not used.
31223  To do this,
31224  click on
31225 \begin_inset Info
31226 type  "menu"
31227 arg   "dialog-show document"
31228 \end_inset
31229
31230
31231 \family sans
31232 \SpecialChar menuseparator
31233 Language
31234 \family default
31235 ,
31236  and select
31237 \begin_inset Quotes eld
31238 \end_inset
31239
31240 None
31241 \begin_inset Quotes erd
31242 \end_inset
31243
31244  as
31245 \family sans
31246 Language Package
31247 \family default
31248 .
31249 \end_layout
31250
31251 \begin_layout Enumerate
31252
31253 \change_deleted 564990737 1669755802
31254 The
31255 \begin_inset Quotes eld
31256 \end_inset
31257
31258 Keywords
31259 \begin_inset Quotes erd
31260 \end_inset
31261
31262  style must be used to define keywords.
31263 \end_layout
31264
31265 \begin_layout Enumerate
31266
31267 \change_deleted 564990737 1669755802
31268 The ijmpc package provides a style named
31269 \begin_inset Quotes eld
31270 \end_inset
31271
31272 Classification Codes
31273 \begin_inset Quotes erd
31274 \end_inset
31275
31276 ,
31277  which can be used to define classification codes,
31278  such as PACS numbers.
31279  Note that this facility is not supported by the ijmpd package.
31280 \end_layout
31281
31282 \begin_layout Enumerate
31283
31284 \change_deleted 564990737 1669755802
31285 Several new environments are available:
31286
31287 \begin_inset Quotes eld
31288 \end_inset
31289
31290 Definition
31291 \begin_inset Quotes erd
31292 \end_inset
31293
31294 ,
31295
31296 \begin_inset Quotes eld
31297 \end_inset
31298
31299 Step
31300 \begin_inset Quotes erd
31301 \end_inset
31302
31303 ,
31304
31305 \begin_inset Quotes eld
31306 \end_inset
31307
31308 Example
31309 \begin_inset Quotes erd
31310 \end_inset
31311
31312 ,
31313
31314 \begin_inset Quotes eld
31315 \end_inset
31316
31317 Remark
31318 \begin_inset Quotes erd
31319 \end_inset
31320
31321 ,
31322
31323 \begin_inset Quotes eld
31324 \end_inset
31325
31326 Notation
31327 \begin_inset Quotes erd
31328 \end_inset
31329
31330 ,
31331
31332 \begin_inset Quotes eld
31333 \end_inset
31334
31335 Theorem
31336 \begin_inset Quotes erd
31337 \end_inset
31338
31339 ,
31340
31341 \begin_inset Quotes eld
31342 \end_inset
31343
31344 Proof
31345 \begin_inset Quotes erd
31346 \end_inset
31347
31348 ,
31349
31350 \begin_inset Quotes eld
31351 \end_inset
31352
31353 Corollary
31354 \begin_inset Quotes erd
31355 \end_inset
31356
31357 ,
31358
31359 \begin_inset Quotes eld
31360 \end_inset
31361
31362 Lemma
31363 \begin_inset Quotes erd
31364 \end_inset
31365
31366 ,
31367
31368 \begin_inset Quotes eld
31369 \end_inset
31370
31371 Proposition
31372 \begin_inset Quotes erd
31373 \end_inset
31374
31375 ,
31376
31377 \begin_inset Quotes eld
31378 \end_inset
31379
31380 Prop
31381 \begin_inset Quotes erd
31382 \end_inset
31383
31384 ,
31385
31386 \begin_inset Quotes eld
31387 \end_inset
31388
31389 Question
31390 \begin_inset Quotes erd
31391 \end_inset
31392
31393 ,
31394
31395 \begin_inset Quotes eld
31396 \end_inset
31397
31398 Claim
31399 \begin_inset Quotes erd
31400 \end_inset
31401
31402 ,
31403  and
31404 \begin_inset Quotes eld
31405 \end_inset
31406
31407 Conjecture
31408 \begin_inset Quotes erd
31409 \end_inset
31410
31411 .
31412  Their use is more or less obvious.
31413  \SpecialChar LyX
31414  supports all these environments;
31415  it will use the proper label,
31416  text style,
31417  and numbering scheme for each of them.
31418 \end_layout
31419
31420 \begin_layout Enumerate
31421
31422 \change_deleted 564990737 1669755802
31423 Both packages use basic citations;
31424  the natbib package should not be used.
31425  In \SpecialChar LyX
31426 ,
31427  citation references are shown as usual;
31428  in the output,
31429  citations are shown as superscripts.
31430  If you want to use a citation as normal text,
31431  you should use the
31432 \family typewriter
31433 refcite
31434 \family default
31435  command,
31436  e.
31437 \begin_inset space \thinspace{}
31438 \end_inset
31439
31440 g.
31441 \begin_inset space \space{}
31442 \end_inset
31443
31444
31445 \begin_inset Quotes eld
31446 \end_inset
31447
31448 See Ref.
31449 \begin_inset space \space{}
31450 \end_inset
31451
31452
31453 \family typewriter
31454
31455 \backslash
31456 refcite{key}
31457 \family default
31458
31459 \begin_inset Quotes erd
31460 \end_inset
31461
31462 .
31463 \end_layout
31464
31465 \begin_layout Enumerate
31466
31467 \change_deleted 564990737 1669755802
31468 There is no
31469 \begin_inset Quotes eld
31470 \end_inset
31471
31472 Acknowledgments
31473 \begin_inset Quotes erd
31474 \end_inset
31475
31476  section in both packages.
31477  To put acknowledgments,
31478  just use the
31479 \begin_inset Quotes eld
31480 \end_inset
31481
31482 Section*
31483 \begin_inset Quotes erd
31484 \end_inset
31485
31486  environment.
31487 \end_layout
31488
31489 \begin_layout Enumerate
31490
31491 \change_deleted 564990737 1669755802
31492 Appendices may be added to the paper,
31493
31494 \emph on
31495 after
31496 \emph default
31497  the Acknowledgments and
31498 \shape italic
31499 before
31500 \shape default
31501  the References.
31502  \SpecialChar LyX
31503  provides a special environment,
31504  called
31505 \begin_inset Quotes eld
31506 \end_inset
31507
31508 Appendices Section
31509 \begin_inset Quotes erd
31510 \end_inset
31511
31512  which marks the beginning of the appendices.
31513  This environment should be left blank;
31514  it just sends a \SpecialChar LaTeX
31515  command,
31516  but nothing is really printed.
31517  In \SpecialChar LyX
31518 ,
31519  the word
31520 \begin_inset Quotes eld
31521 \end_inset
31522
31523 Appendix
31524 \begin_inset Quotes erd
31525 \end_inset
31526
31527  is printed with blue letters,
31528  as a signal that all sections after that point are appendices.
31529  To write an appendix,
31530  use the
31531 \begin_inset Quotes eld
31532 \end_inset
31533
31534 Appendix
31535 \begin_inset Quotes erd
31536 \end_inset
31537
31538  environment.
31539  \SpecialChar LyX
31540  will number each appendix with capital letters,
31541  as required by both journals.
31542  Note that
31543 \begin_inset Quotes eld
31544 \end_inset
31545
31546 Appendices Section
31547 \begin_inset Quotes erd
31548 \end_inset
31549
31550
31551 \emph on
31552 must
31553 \emph default
31554  be present before the first appendix;
31555  if not,
31556  all appendices will be numbered as normal sections in the output.
31557 \end_layout
31558
31559 \begin_layout Enumerate
31560
31561 \change_deleted 564990737 1669755802
31562 The ijmpc and the ijmpd packages use the
31563 \family typewriter
31564 tbl
31565 \family default
31566  command to implement table captions.
31567  As a result,
31568  a table created by \SpecialChar LyX
31569  is printed correctly,
31570  but its caption is ignored.
31571  However,
31572  you can use some \SpecialChar TeX
31573  code to overcome this problem,
31574  so that captions are printed as expected.
31575  To do so,
31576  create a float table as usual,
31577  remove the caption,
31578  and replace it with the \SpecialChar TeX
31579  code
31580 \family typewriter
31581
31582 \backslash
31583 tbl{
31584 \emph on
31585 your table caption
31586 \emph default
31587 }{
31588 \family default
31589  (sic);
31590  you must also the \SpecialChar TeX
31591  code
31592 \family typewriter
31593 }
31594 \family default
31595  immediately after the tabular material.
31596  Study the example table included in the template files to see how this trick is implemented.
31597  Alternatively,
31598  If you need table captions,
31599  you should implement the whole table float in a
31600 \family typewriter
31601 .tex
31602 \family default
31603  file,
31604  then include this file to the \SpecialChar LyX
31605  document (
31606 \family sans
31607 Insert\SpecialChar menuseparator
31608 File\SpecialChar menuseparator
31609 Child
31610 \begin_inset space ~
31611 \end_inset
31612
31613 Document
31614 \family default
31615 ).
31616  Details on how to create a table float can be found in the files
31617 \family typewriter
31618 ws-ijmpc.tex
31619 \family default
31620  and
31621 \family typewriter
31622 ws-ijmpd.tex
31623 \family default
31624 ,
31625  included in the corresponding packages.
31626 \end_layout
31627
31628 \begin_layout Standard
31629
31630 \change_deleted 564990737 1669755802
31631 Preparing a paper for submission
31632 \end_layout
31633
31634 \begin_layout Standard
31635
31636 \change_deleted 564990737 1669755802
31637 Before you submit your paper you must export the \SpecialChar LyX
31638  document as a \SpecialChar LaTeX
31639  file (
31640 \family sans
31641 File\SpecialChar menuseparator
31642 Export\SpecialChar menuseparator
31643 \SpecialChar LaTeX
31644
31645 \family default
31646 )
31647 \begin_inset Foot
31648 status open
31649
31650 \begin_layout Plain Layout
31651 Actually you have the choice between \SpecialChar LaTeX
31652  (plain) and pdflatex.
31653  If you intend to use pdflatex to prepare the paper,
31654  you should use the pdflatex option so that included graphics are converted to PDF format,
31655  ready for use by pdflatex.
31656 \end_layout
31657
31658 \end_inset
31659
31660 ,
31661  then make the following changes to the resulting
31662 \family typewriter
31663 .tex
31664 \family default
31665  file.
31666 \end_layout
31667
31668 \begin_layout Enumerate
31669
31670 \change_deleted 564990737 1669755802
31671 Remove the comment lines before the
31672 \family typewriter
31673
31674 \backslash
31675 documentclass
31676 \family default
31677  command.
31678 \end_layout
31679
31680 \begin_layout Enumerate
31681
31682 \change_deleted 564990737 1669755802
31683 Remove everything between (and including) the
31684 \family typewriter
31685
31686 \backslash
31687 makeatletter
31688 \family default
31689  and
31690 \family typewriter
31691
31692 \backslash
31693 makeatother
31694 \family default
31695  commands,
31696  except for any commands you specifically put into the \SpecialChar LaTeX
31697  preamble.
31698 \end_layout
31699
31700 \begin_layout Standard
31701
31702 \change_deleted 564990737 1672743015
31703 The modified
31704 \family typewriter
31705 .tex
31706 \family default
31707  file should be saved and processed through \SpecialChar LaTeX
31708  as many times as necessary.
31709  You may also want to check the resulting
31710 \family typewriter
31711 .dvi
31712 \family default
31713  document.
31714 \end_layout
31715
31716 \begin_layout Standard
31717
31718 \change_deleted 564990737 1669801478
31719 iopart
31720 \end_layout
31721
31722 \begin_layout Standard
31723
31724 \change_deleted 564990737 1669801478
31725 by
31726 \noun on
31727 Uwe Stöhr
31728 \end_layout
31729
31730 \begin_layout Standard
31731
31732 \change_deleted 564990737 1669801478
31733 Overview
31734 \end_layout
31735
31736 \begin_layout Standard
31737
31738 \change_deleted 564990737 1669801478
31739 The iopart package provides a document class to create electronic manuscript submission to the journals published by the Institute of Physics.
31740  Instructions for the authors how to create a paper using the iopart class can be downloaded together with the iopart package from the site
31741 \begin_inset Flex URL
31742 status collapsed
31743
31744 \begin_layout Plain Layout
31745
31746 ftp://ftp.iop.org/pub/journals/latex2e
31747 \end_layout
31748
31749 \end_inset
31750
31751 .
31752 \end_layout
31753
31754 \begin_layout Standard
31755
31756 \change_deleted 564990737 1669801478
31757 Writing a paper
31758 \end_layout
31759
31760 \begin_layout Standard
31761
31762 \change_deleted 564990737 1669801478
31763 The easiest way to write a paper is to start with the template
31764 \emph on
31765 IOP-article.lyx
31766 \emph default
31767  that is available via
31768 \family sans
31769 File\SpecialChar menuseparator
31770 New From Template
31771 \family default
31772  The template explains how to use the special text environments.
31773  Here are the most important advices:
31774 \end_layout
31775
31776 \begin_layout Itemize
31777
31778 \change_deleted 564990737 1669801478
31779 To be able to compile your document to a PDF,
31780  PS,
31781  or DVI,
31782  ensure that the no AMS packages are loaded in
31783 \family sans
31784 Document\SpecialChar menuseparator
31785 Settings\SpecialChar menuseparator
31786 Math Options
31787 \family default
31788 !
31789 \end_layout
31790
31791 \begin_layout Itemize
31792
31793 \change_deleted 564990737 1669801478
31794
31795 \size normal
31796 The title environment defines the kind of your paper.
31797  So use one of the following environments for the title:
31798 \end_layout
31799
31800 \begin_deeper
31801 \begin_layout Itemize
31802
31803 \change_deleted 564990737 1669801478
31804
31805 \family sans
31806 \size normal
31807 Title
31808 \family default
31809  for a Paper
31810 \end_layout
31811
31812 \begin_layout Itemize
31813
31814 \change_deleted 564990737 1669801478
31815
31816 \family sans
31817 \size normal
31818 Review
31819 \family default
31820  for a Review
31821 \end_layout
31822
31823 \begin_layout Itemize
31824
31825 \change_deleted 564990737 1669801478
31826
31827 \family sans
31828 \size normal
31829 Topical
31830 \family default
31831  for a Topical review
31832 \end_layout
31833
31834 \begin_layout Itemize
31835
31836 \change_deleted 564990737 1669801478
31837
31838 \family sans
31839 \size normal
31840 Comment
31841 \family default
31842  for a Comment
31843 \end_layout
31844
31845 \begin_layout Itemize
31846
31847 \change_deleted 564990737 1669801478
31848
31849 \family sans
31850 \size normal
31851 Note
31852 \family default
31853  for a Note
31854 \end_layout
31855
31856 \begin_layout Itemize
31857
31858 \change_deleted 564990737 1669801478
31859
31860 \family sans
31861 \size normal
31862 Paper
31863 \family default
31864  for a Paper (same as Title)
31865 \end_layout
31866
31867 \begin_layout Itemize
31868
31869 \change_deleted 564990737 1669801478
31870
31871 \family sans
31872 \size normal
31873 Prelim
31874 \family default
31875  for a Preliminary communication
31876 \end_layout
31877
31878 \begin_layout Itemize
31879
31880 \change_deleted 564990737 1669801478
31881
31882 \family sans
31883 \size normal
31884 Rapid
31885 \family default
31886  for a Rapid communication
31887 \end_layout
31888
31889 \begin_layout Itemize
31890
31891 \change_deleted 564990737 1669801478
31892
31893 \family sans
31894 \size normal
31895 Letter
31896 \family default
31897  for a Letter to the editor
31898 \end_layout
31899
31900 \end_deeper
31901 \begin_layout Itemize
31902
31903 \change_deleted 564990737 1669801478
31904
31905 \size normal
31906 All title environments except of
31907 \family sans
31908 Letter
31909 \family default
31910  can have an optional short title.
31911 \end_layout
31912
31913 \begin_layout Itemize
31914
31915 \change_deleted 564990737 1669801478
31916 There is a general title environment
31917 \family sans
31918 Article
31919 \family default
31920  which is not directly supported by \SpecialChar LyX
31921 .
31922  This can be used as \SpecialChar TeX
31923  code when your document doesn't fit into one of the other title types.
31924 \end_layout
31925
31926 \begin_layout Standard
31927
31928 \change_deleted 564990737 1672743015
31929 For more informations like hints for special table and formula formatting,
31930  look at the IOP author guidelines.
31931 \end_layout
31932
31933 \begin_layout Standard
31934
31935 \change_deleted 564990737 1670317155
31936 Kluwer
31937 \end_layout
31938
31939 \begin_layout Standard
31940
31941 \change_deleted 564990737 1670317155
31942 by
31943 \noun on
31944 Panayotis Papasotiriou
31945 \end_layout
31946
31947 \begin_layout Standard
31948
31949 \change_deleted 564990737 1670317155
31950 Overview
31951 \end_layout
31952
31953 \begin_layout Standard
31954
31955 \change_deleted 564990737 1670317155
31956 The Kluwer package is a set of macros produced by Kluwer Academic Publishers that facilitates electronic manuscript submission to the journals they publish.
31957  Most known of them (at least in my domain of interest) are
31958 \emph on
31959 Astrophysics and Space Science
31960 \emph default
31961  and
31962 \emph on
31963 Solar Physics
31964 \emph default
31965 ,
31966  but there are many others (see a complete list at
31967 \begin_inset Flex URL
31968 status collapsed
31969
31970 \begin_layout Plain Layout
31971
31972 http://www.wkap.nl/jrnllist.htm/JRNLHOME
31973 \end_layout
31974
31975 \end_inset
31976
31977 ).
31978  The Kluwer package may be downloaded from the site
31979 \begin_inset Flex URL
31980 status collapsed
31981
31982 \begin_layout Plain Layout
31983
31984 http://www.wkap.nl/kaphtml.htm/STYLEFILES
31985 \end_layout
31986
31987 \end_inset
31988
31989 .
31990  A complete user guide is contained in that package (but it can also be downloaded separately).
31991 \end_layout
31992
31993 \begin_layout Standard
31994
31995 \change_deleted 564990737 1670317155
31996 \SpecialChar LyX
31997  supports many features of the package but not everything.
31998  However,
31999  the \SpecialChar TeX
32000  code needed is reduced to some
32001 \begin_inset Quotes eld
32002 \end_inset
32003
32004 peculiar
32005 \begin_inset Quotes erd
32006 \end_inset
32007
32008  commands of the package (see
32009 \begin_inset space ~
32010 \end_inset
32011
32012
32013 \begin_inset CommandInset ref
32014 LatexCommand ref
32015 reference "subsec:kluwer_peculiarities"
32016 nolink "false"
32017
32018 \end_inset
32019
32020 ).
32021  I have recently used \SpecialChar LyX
32022  to write an article submitted to the
32023 \emph on
32024 Astrophysics and Space Science
32025 \emph default
32026  without any problem.
32027 \end_layout
32028
32029 \begin_layout Standard
32030
32031 \change_deleted 564990737 1670317155
32032 Writing a paper
32033 \end_layout
32034
32035 \begin_layout Standard
32036
32037 \change_deleted 564990737 1670317155
32038 The easiest way to write a paper is to start with the Kluwer template file.
32039  Click on
32040 \family sans
32041 File\SpecialChar menuseparator
32042 New from
32043 \family default
32044
32045 \family sans
32046 Template
32047 \family default
32048 ,
32049  then choose the
32050 \family typewriter
32051 kluwer.lyx
32052 \family default
32053  template.
32054  This will give an (almost) empty document that includes the most common fields found in a manuscript and a short description of their use.
32055  As in most templates,
32056  simply overwrite the existing text (including the brackets,
32057
32058 \family typewriter
32059 <>
32060 \family default
32061 ) with the correct information.
32062 \end_layout
32063
32064 \begin_layout Standard
32065
32066 \change_deleted 564990737 1670317155
32067 Preparing a paper for submission
32068 \end_layout
32069
32070 \begin_layout Standard
32071
32072 \change_deleted 564990737 1670317155
32073 As in the AAS\SpecialChar TeX
32074  package,
32075  before you submit your paper to a journal you must
32076 \begin_inset Quotes eld
32077 \end_inset
32078
32079 postprocess
32080 \begin_inset Quotes erd
32081 \end_inset
32082
32083  it as follows.
32084 \end_layout
32085
32086 \begin_layout Enumerate
32087
32088 \change_deleted 564990737 1670317155
32089 Export your paper as a \SpecialChar LaTeX
32090  file.
32091  To do this,
32092  click on
32093 \family sans
32094 File\SpecialChar menuseparator
32095 Export\SpecialChar menuseparator
32096 \SpecialChar LaTeX
32097
32098 \family default
32099 .
32100
32101 \end_layout
32102
32103 \begin_layout Enumerate
32104
32105 \change_deleted 564990737 1670317155
32106 Edit the resulting
32107 \family typewriter
32108 .tex
32109 \family default
32110  file with a text editor and make the following changes
32111 \end_layout
32112
32113 \begin_deeper
32114 \begin_layout Enumerate
32115
32116 \change_deleted 564990737 1670317155
32117 remove the comment lines before the
32118 \family typewriter
32119
32120 \backslash
32121 documentclass
32122 \family default
32123  command,
32124 \end_layout
32125
32126 \begin_layout Enumerate
32127
32128 \change_deleted 564990737 1670317155
32129 remove everything between (and including) the
32130 \family typewriter
32131
32132 \backslash
32133 makeatletter
32134 \family default
32135  and
32136 \family typewriter
32137
32138 \backslash
32139 makeatother
32140 \family default
32141  commands,
32142  except for any commands you specifically put into the \SpecialChar LaTeX
32143  preamble.
32144 \end_layout
32145
32146 \begin_layout Standard
32147
32148 \change_deleted 564990737 1670317155
32149 Save the resulting
32150 \family typewriter
32151 .tex
32152 \family default
32153  file.
32154 \end_layout
32155
32156 \end_deeper
32157 \begin_layout Enumerate
32158
32159 \change_deleted 564990737 1670317155
32160 Run the
32161 \family typewriter
32162 .tex
32163 \family default
32164  file through \SpecialChar LaTeX
32165  as many times as necessary (usually up to three).
32166 \end_layout
32167
32168 \begin_layout Enumerate
32169
32170 \change_deleted 564990737 1670317155
32171 View the resulting
32172 \family typewriter
32173 .dvi
32174 \family default
32175  document using,
32176  e.
32177 \begin_inset space \thinspace{}
32178 \end_inset
32179
32180 g.
32181 \begin_inset space \space{}
32182 \end_inset
32183
32184
32185 \family sans
32186 xdvi
32187 \family default
32188 ,
32189  and check if everything is OK (it should,
32190  if you didn't make any mistake).
32191 \end_layout
32192
32193 \begin_layout Standard
32194
32195 \change_deleted 564990737 1670317155
32196 \begin_inset Quotes eld
32197 \end_inset
32198
32199 Peculiarities
32200 \begin_inset Quotes erd
32201 \end_inset
32202
32203  of the Kluwer package
32204 \begin_inset CommandInset label
32205 LatexCommand label
32206 name "subsec:kluwer_peculiarities"
32207
32208 \end_inset
32209
32210
32211 \end_layout
32212
32213 \begin_layout Standard
32214
32215 \change_deleted 564990737 1670317155
32216 The Kluwer package has the following
32217 \begin_inset Quotes eld
32218 \end_inset
32219
32220 peculiarities
32221 \begin_inset Quotes erd
32222 \end_inset
32223
32224 .
32225 \end_layout
32226
32227 \begin_layout Enumerate
32228
32229 \change_deleted 564990737 1670317155
32230 It is possible to write multiple articles in the same \SpecialChar LaTeX
32231  file
32232 \begin_inset Foot
32233 status collapsed
32234
32235 \begin_layout Plain Layout
32236 I can't imagine any good reason to do this.
32237 \end_layout
32238
32239 \end_inset
32240
32241 .
32242  Each article must be included in the environment
32243 \begin_inset Quotes eld
32244 \end_inset
32245
32246 article
32247 \begin_inset Quotes erd
32248 \end_inset
32249
32250 .
32251  Unfortunately,
32252  this environment cannot be omitted,
32253  even if you write just one article.
32254  Therefore,
32255  each article starts with the command
32256 \family typewriter
32257
32258 \backslash
32259 begin{article}
32260 \family default
32261  and,
32262  obviously,
32263  ends with the command
32264 \family typewriter
32265
32266 \backslash
32267 end{article}
32268 \family default
32269 .
32270  Although this can be implemented in \SpecialChar LyX
32271 ,
32272  I didn't included it,
32273  since it looks ugly and can confuse the novice user.
32274  Therefore,
32275  you need to enter them directly and mark them as \SpecialChar LaTeX
32276  code (the well-known
32277 \begin_inset Quotes eld
32278 \end_inset
32279
32280 \SpecialChar TeX
32281  code
32282 \begin_inset Quotes erd
32283 \end_inset
32284
32285 ).
32286 \end_layout
32287
32288 \begin_layout Enumerate
32289
32290 \change_deleted 564990737 1670317155
32291 Information given at the beginning of the article (i.
32292 \begin_inset space \thinspace{}
32293 \end_inset
32294
32295 e.
32296 \begin_inset space \space{}
32297 \end_inset
32298
32299 title,
32300  subtitle,
32301  author,
32302  institution,
32303  running title,
32304  running author,
32305  abstract and keywords) must be included in an environment called
32306 \begin_inset Quotes eld
32307 \end_inset
32308
32309 opening
32310 \begin_inset Quotes erd
32311 \end_inset
32312
32313 .
32314  This is not implemented in \SpecialChar LyX
32315 ,
32316  so you must enter title,
32317  subtitle etc.
32318 \begin_inset space ~
32319 \end_inset
32320
32321 between two \SpecialChar TeX
32322  code lines (
32323 \family typewriter
32324
32325 \backslash
32326 begin{opening}
32327 \family default
32328  and
32329 \family typewriter
32330
32331 \backslash
32332 end{opening}
32333 \family default
32334 ).
32335 \end_layout
32336
32337 \begin_layout Enumerate
32338
32339 \change_deleted 564990737 1670317155
32340 According to the user manual,
32341  the label of each bibliography item must be written as
32342 \family typewriter
32343
32344 \backslash
32345 protect
32346 \backslash
32347 citeauthoryear{
32348 \family default
32349 \emph on
32350 author(s)
32351 \family typewriter
32352 \emph default
32353 }{
32354 \family default
32355 \emph on
32356 year
32357 \family typewriter
32358 \emph default
32359 }
32360 \family default
32361 .
32362 \end_layout
32363
32364 \begin_layout Standard
32365
32366 \change_deleted 564990737 1670317155
32367 The
32368 \family typewriter
32369 kluwer.lyx
32370 \family default
32371  template takes care of all these
32372 \begin_inset Quotes eld
32373 \end_inset
32374
32375 peculiarities
32376 \begin_inset Quotes erd
32377 \end_inset
32378
32379 .
32380  If you start a new paper using this template you don't need to do anything special.
32381  Just
32382 \end_layout
32383
32384 \begin_layout Enumerate
32385
32386 \change_deleted 564990737 1670317155
32387 don't delete the \SpecialChar TeX
32388  code included in the template,
32389  and
32390 \end_layout
32391
32392 \begin_layout Enumerate
32393
32394 \change_deleted 564990737 1670317155
32395 copy the example bibliography item included in the template and modify it as necessary to enter new bibliography items.
32396 \end_layout
32397
32398 \begin_layout Standard
32399
32400 \change_deleted 564990737 1671097446
32401 Paper
32402 \end_layout
32403
32404 \begin_layout Standard
32405
32406 \change_deleted 564990737 1671097446
32407 The document class
32408 \family sans
32409 paper
32410 \family default
32411  provides an alternative to the standard
32412 \family sans
32413 article
32414 \family default
32415  class.
32416  It provides similar functionality,
32417  but you might prefer this layout with sans serif sections,
32418  headings,
32419  and more.
32420 \end_layout
32421
32422 \begin_layout Standard
32423
32424 \change_deleted 564990737 1671097446
32425 Springer Journals (
32426 \family sans
32427 svjour
32428 \family default
32429 )
32430 \end_layout
32431
32432 \begin_layout Standard
32433
32434 \change_deleted 564990737 1671097446
32435 by
32436 \noun on
32437 Martin Vermeer
32438 \end_layout
32439
32440 \begin_layout Standard
32441
32442 \change_deleted 564990737 1671097446
32443 Description
32444 \end_layout
32445
32446 \begin_layout Standard
32447
32448 \change_deleted 564990737 1671097446
32449 These are the layout files for some of the journal formats used by Springer Verlag and listed on
32450 \begin_inset Flex URL
32451 status collapsed
32452
32453 \begin_layout Plain Layout
32454
32455 http://www.springer.de/author/tex/help-journals.html
32456 \end_layout
32457
32458 \end_inset
32459
32460 ,
32461  where you should also go to fetch the class files (yes,
32462  these are \SpecialChar LaTeX2e
32463  now!).
32464  It is a modular system:
32465  the things common to all journals are implemented in
32466 \family typewriter
32467 svjour.inc
32468 \family default
32469 ,
32470  which journal-specific layout files (such as,
32471  e.
32472 \begin_inset space \thinspace{}
32473 \end_inset
32474
32475 g.
32476 \begin_inset space \space{}
32477 \end_inset
32478
32479
32480 \family typewriter
32481 svjog.layout
32482 \family default
32483  for Journal of Geodesy) can include.
32484 \end_layout
32485
32486 \begin_layout Standard
32487
32488 \change_deleted 564990737 1671097446
32489 This means that implementing support for any other Springer journal on this list is as simple as writing your own
32490 \family typewriter
32491 sv
32492 \family default
32493 <myjournal>
32494 \family typewriter
32495 .layout
32496 \family default
32497  file following the outline given in
32498 \family typewriter
32499 svjog.layout
32500 \family default
32501 .
32502
32503 \end_layout
32504
32505 \begin_layout Standard
32506
32507 \change_deleted 564990737 1671097446
32508 It is reasonably well tested only for the Journal of Geodesy.
32509
32510 \family typewriter
32511 svjour
32512 \family default
32513  and
32514 \family typewriter
32515 svjog
32516 \family default
32517  come with the standard \SpecialChar LyX
32518  distribution.
32519  Install the relevant class file (downloaded from Springer) in a proper directory,
32520  reconfigure \SpecialChar LaTeX
32521  (in the te\SpecialChar TeX
32522  case by running
32523 \family typewriter
32524 texhash
32525 \family default
32526 ,
32527  as root if necessary —
32528  doesn't \SpecialChar LyX
32529  take care of this?),
32530  reconfigure \SpecialChar LyX
32531  and it should work.
32532 \end_layout
32533
32534 \begin_layout Standard
32535
32536 \change_deleted 564990737 1671097446
32537 New styles
32538 \end_layout
32539
32540 \begin_layout Standard
32541
32542 \change_deleted 564990737 1671097446
32543 A large number of theorem-like styles —
32544
32545 \family sans
32546 Claim,
32547  Conjecture,
32548
32549 \family default
32550
32551 \family sans
32552 \SpecialChar ldots
32553 Theorem
32554 \family default
32555 .
32556 \end_layout
32557
32558 \begin_layout Standard
32559
32560 \change_deleted 564990737 1671097446
32561
32562 \family sans
32563 Headnote,
32564  Dedication,
32565  Subtitle,
32566  Running_\SpecialChar LaTeX
32567 _Title,
32568  Author_Running,
32569  Institute,
32570  Mail,
32571  Offprints,
32572  Keywords,
32573  Acknowledgements,
32574  Acknowledgement
32575 \family default
32576 .
32577  See the Springer class file documentation for details.
32578 \end_layout
32579
32580 \begin_layout Standard
32581
32582 \change_deleted 564990737 1671097446
32583 Supported journals
32584 \end_layout
32585
32586 \begin_layout Itemize
32587
32588 \change_deleted 564990737 1671097446
32589
32590 \emph on
32591 Journal of Geodesy
32592 \emph default
32593 :
32594
32595 \family typewriter
32596 svjog.layout
32597 \family default
32598  —
32599  Martin Vermeer
32600 \end_layout
32601
32602 \begin_layout Itemize
32603
32604 \change_deleted 564990737 1671097446
32605
32606 \emph on
32607 Probability Theory and Related Fields
32608 \emph default
32609 :
32610
32611 \family typewriter
32612 svprobth.layout
32613 \family default
32614  —
32615  Jean-Marc Lasgouttes
32616 \end_layout
32617
32618 \begin_layout Standard
32619
32620 \change_deleted 564990737 1671097446
32621 Add your own,
32622  it isn't so hard!
32623 \end_layout
32624
32625 \begin_layout Standard
32626
32627 \change_deleted 564990737 1671097446
32628 Credits
32629 \end_layout
32630
32631 \begin_layout Standard
32632
32633 \change_deleted 564990737 1671097446
32634 These files are partly based on the older
32635 \family typewriter
32636 ejour2.layout
32637 \family default
32638 ,
32639  which was again based on a tinkered-with version of an old \SpecialChar LaTeX
32640  2.09 style file from Springer.
32641  All this,
32642  and the
32643 \family typewriter
32644 ejour2
32645 \family default
32646  layout,
32647  are now defunct.
32648  Jean-Marc Lasgouttes helped out big in making me find my way around the \SpecialChar LyX
32649  layout file mechanism.
32650 \end_layout
32651
32652 \begin_layout Standard
32653
32654 \change_deleted 564990737 1671097446
32655 Bugs
32656 \end_layout
32657
32658 \begin_layout Standard
32659
32660 \change_deleted 564990737 1671097446
32661 Probably.
32662  But probably less than in the old hacked-\SpecialChar LaTeX
32663
32664 \family typewriter
32665 ejour2
32666 \family default
32667 .
32668 \end_layout
32669
32670 \begin_layout Chapter
32671 \SpecialChar LyX
32672  Features needing Extra Software
32673 \end_layout
32674
32675 \begin_layout Section
32676 Checking \SpecialChar TeX
32677
32678 \end_layout
32679
32680 \begin_layout Standard
32681 by
32682 \noun on
32683 Asger Alstrup
32684 \end_layout
32685
32686 \begin_layout Subsection
32687 Introduction
32688 \end_layout
32689
32690 \begin_layout Standard
32691 If you have the
32692 \family typewriter
32693 chktex
32694 \family default
32695  program installed
32696 \begin_inset Foot
32697 status collapsed
32698
32699 \begin_layout Plain Layout
32700
32701 \family typewriter
32702 chktex
32703 \family default
32704  is not yet available when you are using the \SpecialChar LaTeX
32705  distribution MiK\SpecialChar TeX
32706 .
32707 \end_layout
32708
32709 \end_inset
32710
32711 ,
32712  you'll find in the
32713 \family sans
32714 Tools
32715 \family default
32716  menu the entry:
32717
32718 \family sans
32719 Check
32720 \begin_inset space ~
32721 \end_inset
32722
32723 TeX
32724 \family default
32725 .
32726  You can get
32727 \family typewriter
32728 chktex
32729 \family default
32730  from CTAN,
32731 \begin_inset Newline newline
32732 \end_inset
32733
32734
32735 \begin_inset CommandInset href
32736 LatexCommand href
32737 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
32738 literal "false"
32739
32740 \end_inset
32741
32742 .
32743 \end_layout
32744
32745 \begin_layout Standard
32746 The
32747 \family sans
32748 Chk\SpecialChar TeX
32749
32750 \family default
32751  package is a program that was written by
32752 \begin_inset Flex Noun
32753 status collapsed
32754
32755 \begin_layout Plain Layout
32756 Jens T.
32757 \begin_inset space ~
32758 \end_inset
32759
32760 Berger Thielemann
32761 \end_layout
32762
32763 \end_inset
32764
32765  in frustration because some constructs in \SpecialChar LaTeX
32766  are sometimes non-intuitive,
32767  and easy to forget.
32768  The program runs over your \SpecialChar LaTeX
32769  file,
32770  checks the integrity of the file,
32771  and flags some common errors.
32772  In other technical words,
32773  it is
32774 \family typewriter
32775 lint
32776 \family default
32777  for \SpecialChar LaTeX
32778 .
32779 \end_layout
32780
32781 \begin_layout Standard
32782 Well,
32783  what is a syntax checker doing in \SpecialChar LyX
32784  which is supposed to produce correct \SpecialChar LaTeX
32785  anyways?
32786  The answer is simple:
32787  Just as
32788 \family typewriter
32789 Lint
32790 \family default
32791  not only checks the
32792 \emph on
32793 syntax
32794 \emph default
32795  of C programs,
32796  but also does
32797 \emph on
32798 semantic
32799 \emph default
32800  checks for type-errors,
32801
32802 \family sans
32803 Chk\SpecialChar TeX
32804
32805 \family default
32806  catches some common
32807 \emph on
32808 typographic
32809 \emph default
32810  errors,
32811  in addition to the syntactical ones.
32812  Specifically,
32813
32814 \family sans
32815 Chk\SpecialChar TeX
32816
32817 \family default
32818  is capable of detecting several common errors,
32819  such as
32820 \end_layout
32821
32822 \begin_layout Itemize
32823 Ellipsis detection:
32824 \begin_inset Newline newline
32825 \end_inset
32826
32827 Use \SpecialChar ldots
32828  instead of ...
32829 \end_layout
32830
32831 \begin_layout Itemize
32832 No space in front of/after parenthesis:
32833 \begin_inset Newline newline
32834 \end_inset
32835
32836 ( wrong spacing )
32837 \end_layout
32838
32839 \begin_layout Itemize
32840 Enforcement of normal space after common abbreviations:
32841 \begin_inset Newline newline
32842 \end_inset
32843
32844 e.
32845 \begin_inset space \thinspace{}
32846 \end_inset
32847
32848 g.
32849 \begin_inset space \space{}
32850 \end_inset
32851
32852 is too wide spacing.
32853 \end_layout
32854
32855 \begin_layout Itemize
32856 Enforcement of end-of-sentence space when the last sentence ends with a capital letter:
32857 \begin_inset Newline newline
32858 \end_inset
32859
32860 This is a TEST.
32861  And this is wrong spacing.
32862 \end_layout
32863
32864 \begin_layout Itemize
32865 Space in front of labels and similar commands:
32866 \begin_inset Newline newline
32867 \end_inset
32868
32869 The label should stick right up to the text to avoid falling to a wrong page.
32870
32871 \begin_inset CommandInset label
32872 LatexCommand label
32873 name "sec:chktex"
32874
32875 \end_inset
32876
32877
32878 \begin_inset Foot
32879 status collapsed
32880
32881 \begin_layout Plain Layout
32882 This footnote is in danger of falling off to a wrong page
32883 \end_layout
32884
32885 \end_inset
32886
32887  The label is separated too much.
32888 \end_layout
32889
32890 \begin_layout Itemize
32891 Space in front of references,
32892  instead of hard spaces:
32893 \begin_inset Newline newline
32894 \end_inset
32895
32896 If you have bad luck,
32897  the text will break right between the referenced text and reference number,
32898  and that's a pity.
32899  See section
32900 \begin_inset CommandInset ref
32901 LatexCommand ref
32902 reference "sec:chktex"
32903 nolink "false"
32904
32905 \end_inset
32906
32907 .
32908 \end_layout
32909
32910 \begin_layout Itemize
32911 Use of
32912 \begin_inset Quotes eld
32913 \end_inset
32914
32915 x
32916 \begin_inset Quotes erd
32917 \end_inset
32918
32919  instead of
32920 \begin_inset Formula $\times$
32921 \end_inset
32922
32923  between numbers:
32924 \begin_inset Newline newline
32925 \end_inset
32926
32927 2x2 looks cheap compared to
32928 \begin_inset Formula $2\times2$
32929 \end_inset
32930
32931 .
32932 \end_layout
32933
32934 \begin_layout Standard
32935 and more \SpecialChar ldots
32936  It is an invaluable tool when you are
32937 \begin_inset Quotes eld
32938 \end_inset
32939
32940 finishing up
32941 \begin_inset Quotes erd
32942 \end_inset
32943
32944  your document before printing,
32945  and you should run it right after the obligatory spelling check,
32946  and before you go fine tuning the typesetting.
32947 \end_layout
32948
32949 \begin_layout Subsection
32950 How to use it
32951 \end_layout
32952
32953 \begin_layout Standard
32954 If you have the program installed,
32955  usage is as simple as choosing
32956 \family sans
32957 Tools\SpecialChar menuseparator
32958 Check
32959 \begin_inset space ~
32960 \end_inset
32961
32962 TeX
32963 \family default
32964 .
32965  This will make \SpecialChar LyX
32966  generate a \SpecialChar LaTeX
32967  file of your document,
32968  start
32969 \family sans
32970 Chk\SpecialChar TeX
32971
32972 \family default
32973  to check it,
32974  and then make \SpecialChar LyX
32975  insert
32976 \begin_inset Quotes eld
32977 \end_inset
32978
32979 error boxes
32980 \begin_inset Quotes erd
32981 \end_inset
32982
32983  with the warnings from
32984 \family sans
32985 Chk\SpecialChar TeX
32986
32987 \family default
32988 ,
32989  if there were any.
32990  The warnings will be placed close to the point of the mistake,
32991  and you can quickly find them by using the
32992 \family sans
32993 Navigate\SpecialChar menuseparator
32994 Error
32995 \family default
32996  menu item,
32997  or the shortcut key
32998 \family sans
32999 C-g
33000 \family default
33001  from the default
33002 \family typewriter
33003 cua
33004 \family default
33005  bind file.
33006  Open the error boxes by clicking on them with the mouse,
33007  or use the shortcut key
33008 \family sans
33009 C-i
33010 \family default
33011  from
33012 \family typewriter
33013 cua
33014 \family default
33015  bindings,
33016  or the corresponding
33017 \family sans
33018 C-o
33019 \family default
33020  for the alternate
33021 \family typewriter
33022 emacs
33023 \family default
33024  bind file.
33025  Read the warning and correct the mistake,
33026  if it is a mistake.
33027  If you have trouble understanding what the warning is about,
33028  you can safely ignore it.
33029  Remember that there is a hidden layer between the document on screen and the technical details in invoking
33030 \family sans
33031 Chk\SpecialChar TeX
33032
33033 \family default
33034 ,
33035  and this gap can make some warnings seem arcane or just plain silly.
33036 \end_layout
33037
33038 \begin_layout Standard
33039 This document is an excellent testing bed for the feature,
33040  and it should provide quite a few warnings for you to fiddle with.
33041  Since computers are only so smart,
33042  expect most of the warnings to be false alarms,
33043  though.
33044 \end_layout
33045
33046 \begin_layout Subsection
33047 How to fine tune it
33048 \end_layout
33049
33050 \begin_layout Standard
33051 Sometimes,
33052  you'll find that
33053 \family sans
33054 Chk\SpecialChar TeX
33055
33056 \family default
33057  makes more noise than suits your mood.
33058  Then you can choose not to use it,
33059  wait until your mood changes,
33060  or try to customize
33061 \family sans
33062 Chk\SpecialChar TeX
33063
33064 \family default
33065  to get better along with you.
33066 \end_layout
33067
33068 \begin_layout Standard
33069 Although
33070 \family sans
33071 Chk\SpecialChar TeX
33072
33073 \family default
33074
33075 \emph on
33076 is
33077 \emph default
33078  very configurable and extensible,
33079  you should not expect to solve all problems with
33080 \family sans
33081 Chk\SpecialChar TeX
33082
33083 \family default
33084  in \SpecialChar LyX
33085  this way.
33086  Since \SpecialChar LyX
33087  has to generate a somewhat special \SpecialChar LaTeX
33088  file to be able to match the line numbers from the
33089 \family sans
33090 Chk\SpecialChar TeX
33091
33092 \family default
33093  output
33094 \begin_inset Foot
33095 status collapsed
33096
33097 \begin_layout Plain Layout
33098 You can inspect the specific output from
33099 \family sans
33100 chktex
33101 \family default
33102  by using
33103 \family sans
33104 Document\SpecialChar menuseparator
33105 \SpecialChar LaTeX
33106
33107 \begin_inset space ~
33108 \end_inset
33109
33110 Log
33111 \family default
33112  right after a
33113 \family sans
33114 chktex
33115 \family default
33116  run.
33117 \end_layout
33118
33119 \end_inset
33120
33121  to the internal document structure,
33122  some of the warnings will not appear correctly.
33123  There are two things you can do about this:
33124 \end_layout
33125
33126 \begin_layout Itemize
33127 Fine tune the
33128 \family sans
33129 Chk\SpecialChar TeX
33130
33131 \family default
33132  invocation command line in
33133 \begin_inset Flex Noun
33134 status collapsed
33135
33136 \begin_layout Plain Layout
33137 Tools\SpecialChar menuseparator
33138 Preferences\SpecialChar menuseparator
33139 Output\SpecialChar menuseparator
33140 LaTeX\SpecialChar menuseparator
33141 CheckTeX command
33142 \end_layout
33143
33144 \end_inset
33145
33146 ,
33147  or the global
33148 \family sans
33149 Chk\SpecialChar TeX
33150
33151 \family default
33152  installation configuration file (usually with the file
33153 \family typewriter
33154 chktexrc
33155 \family default
33156 ).
33157  See below to learn what warnings can be enabled and disabled on the command line.
33158 \end_layout
33159
33160 \begin_layout Itemize
33161 Export your document as a raw \SpecialChar LaTeX
33162  file using
33163 \family sans
33164 File\SpecialChar menuseparator
33165 Export\SpecialChar menuseparator
33166 \SpecialChar LaTeX
33167
33168 \family default
33169  and run
33170 \family typewriter
33171 chktex
33172 \family default
33173  manually on that.
33174  Invoked in this way,
33175  it can be a hassle to find the corresponding place in the document inside \SpecialChar LyX
33176 ,
33177  but with a little patience,
33178  you should be able to do it.
33179 \end_layout
33180
33181 \begin_layout Standard
33182 Here follows the warning messages that can be enabled and disabled in
33183 \family sans
33184 Preferences
33185 \family default
33186 .
33187  Use
33188 \family typewriter
33189 -n#
33190 \family default
33191  to disable a warning,
33192  and
33193 \family typewriter
33194 -w#
33195 \family default
33196  to enable a warning.
33197  The emphasized entries are disabled by default,
33198  because the default is "
33199 \family typewriter
33200 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
33201 \family default
33202 ".
33203 \end_layout
33204
33205 \begin_layout Standard
33206 Notice that you should only use the options that enable and disable warnings,
33207  because \SpecialChar LyX
33208  relies on some of the other command line parameters to be set in a specific way to have a chance to communicate with
33209 \family typewriter
33210 chktex
33211 \family default
33212 .
33213 \end_layout
33214
33215 \begin_layout Enumerate
33216
33217 \size small
33218 \emph on
33219 Command terminated with space.
33220 \end_layout
33221
33222 \begin_layout Enumerate
33223
33224 \size small
33225 Non-breaking space (
33226 \begin_inset Quotes eld
33227 \end_inset
33228
33229
33230 \family typewriter
33231 ~
33232 \family default
33233
33234 \begin_inset Quotes erd
33235 \end_inset
33236
33237 ) should have been used.
33238 \end_layout
33239
33240 \begin_layout Enumerate
33241
33242 \size small
33243 \emph on
33244 You should enclose the previous parenthesis with
33245 \begin_inset Quotes eld
33246 \end_inset
33247
33248
33249 \family typewriter
33250 {}
33251 \family default
33252
33253 \begin_inset Quotes erd
33254 \end_inset
33255
33256 .
33257 \end_layout
33258
33259 \begin_layout Enumerate
33260
33261 \size small
33262 Italic correction (
33263 \begin_inset Quotes eld
33264 \end_inset
33265
33266
33267 \family typewriter
33268
33269 \backslash
33270 /
33271 \family default
33272
33273 \begin_inset Quotes erd
33274 \end_inset
33275
33276 ) found in non-italic buffer.
33277 \end_layout
33278
33279 \begin_layout Enumerate
33280
33281 \size small
33282 Italic correction (
33283 \begin_inset Quotes eld
33284 \end_inset
33285
33286
33287 \family typewriter
33288
33289 \backslash
33290 /
33291 \family default
33292
33293 \begin_inset Quotes erd
33294 \end_inset
33295
33296 ) found more than once.
33297 \end_layout
33298
33299 \begin_layout Enumerate
33300
33301 \size small
33302 \emph on
33303 No italic correction (
33304 \begin_inset Quotes eld
33305 \end_inset
33306
33307
33308 \family typewriter
33309
33310 \backslash
33311 /
33312 \family default
33313
33314 \begin_inset Quotes erd
33315 \end_inset
33316
33317 ) found.
33318 \end_layout
33319
33320 \begin_layout Enumerate
33321
33322 \size small
33323 Accent command
33324 \begin_inset Quotes eld
33325 \end_inset
33326
33327
33328 \family typewriter
33329 cmd
33330 \family default
33331
33332 \begin_inset Quotes erd
33333 \end_inset
33334
33335  needs use of
33336 \begin_inset Quotes eld
33337 \end_inset
33338
33339
33340 \family typewriter
33341 cmd
33342 \family default
33343
33344 \begin_inset Quotes erd
33345 \end_inset
33346
33347 .
33348 \end_layout
33349
33350 \begin_layout Enumerate
33351
33352 \size small
33353 Wrong length of dash may have been used.
33354 \end_layout
33355
33356 \begin_layout Enumerate
33357
33358 \size small
33359 \emph on
33360 \begin_inset Quotes eld
33361 \end_inset
33362
33363
33364 \family typewriter
33365 %s
33366 \family default
33367
33368 \begin_inset Quotes erd
33369 \end_inset
33370
33371  expected,
33372  found
33373 \begin_inset Quotes eld
33374 \end_inset
33375
33376
33377 \family typewriter
33378 %s
33379 \family default
33380
33381 \begin_inset Quotes erd
33382 \end_inset
33383
33384 .
33385 \end_layout
33386
33387 \begin_layout Enumerate
33388
33389 \size small
33390 Solo
33391 \begin_inset Quotes eld
33392 \end_inset
33393
33394
33395 \family typewriter
33396 %s
33397 \family default
33398
33399 \begin_inset Quotes erd
33400 \end_inset
33401
33402  found.
33403 \end_layout
33404
33405 \begin_layout Enumerate
33406
33407 \size small
33408 You should use
33409 \begin_inset Quotes eld
33410 \end_inset
33411
33412
33413 \family typewriter
33414 %s
33415 \family default
33416
33417 \begin_inset Quotes erd
33418 \end_inset
33419
33420  to achieve an ellipsis.
33421 \end_layout
33422
33423 \begin_layout Enumerate
33424
33425 \size small
33426 Inter-word spacing (
33427 \begin_inset Quotes eld
33428 \end_inset
33429
33430
33431 \family typewriter
33432
33433 \backslash
33434
33435 \family default
33436
33437 \begin_inset Quotes eld
33438 \end_inset
33439
33440 ) should perhaps be used.
33441 \end_layout
33442
33443 \begin_layout Enumerate
33444
33445 \size small
33446 Inter-sentence spacing (
33447 \begin_inset Quotes eld
33448 \end_inset
33449
33450
33451 \family typewriter
33452
33453 \backslash
33454 @
33455 \family default
33456
33457 \begin_inset Quotes erd
33458 \end_inset
33459
33460 ) should perhaps be used.
33461 \end_layout
33462
33463 \begin_layout Enumerate
33464
33465 \size small
33466 Could not find argument for command.
33467 \end_layout
33468
33469 \begin_layout Enumerate
33470
33471 \size small
33472 No match found for
33473 \begin_inset Quotes eld
33474 \end_inset
33475
33476
33477 \family typewriter
33478 %s
33479 \family default
33480
33481 \begin_inset Quotes erd
33482 \end_inset
33483
33484 .
33485 \end_layout
33486
33487 \begin_layout Enumerate
33488
33489 \size small
33490 Math mode still on at end of \SpecialChar LaTeX
33491  file.
33492 \end_layout
33493
33494 \begin_layout Enumerate
33495
33496 \size small
33497 Number of
33498 \begin_inset Quotes eld
33499 \end_inset
33500
33501
33502 \family typewriter
33503 char
33504 \family default
33505
33506 \begin_inset Quotes erd
33507 \end_inset
33508
33509  doesn't match the number of
33510 \begin_inset Quotes eld
33511 \end_inset
33512
33513
33514 \family typewriter
33515 char
33516 \family default
33517
33518 \begin_inset Quotes erd
33519 \end_inset
33520
33521 .
33522 \end_layout
33523
33524 \begin_layout Enumerate
33525
33526 \size small
33527 You should use either
33528 \family typewriter
33529
33530 \begin_inset Quotes eld
33531 \end_inset
33532
33533
33534 \family default
33535  or
33536 \family typewriter
33537
33538 \begin_inset Quotes erd
33539 \end_inset
33540
33541
33542 \family default
33543  as an alternative to
33544 \begin_inset Quotes eld
33545 \end_inset
33546
33547
33548 \family typewriter
33549 "
33550 \family default
33551
33552 \begin_inset Quotes erd
33553 \end_inset
33554
33555 .
33556 \end_layout
33557
33558 \begin_layout Enumerate
33559
33560 \size small
33561 You should use "
33562 \family typewriter
33563 '
33564 \family default
33565 " (ASCII 39) instead of "
33566 \family typewriter
33567 ´
33568 \family default
33569 " (ASCII 180).
33570 \end_layout
33571
33572 \begin_layout Enumerate
33573
33574 \size small
33575 User-specified pattern found.
33576 \end_layout
33577
33578 \begin_layout Enumerate
33579
33580 \size small
33581 This command might not be intended.
33582 \end_layout
33583
33584 \begin_layout Enumerate
33585
33586 \size small
33587 \emph on
33588 Comment displayed.
33589 \end_layout
33590
33591 \begin_layout Enumerate
33592
33593 \size small
33594 Either
33595 \family typewriter
33596 ''
33597 \backslash
33598 ,'
33599 \family default
33600  or
33601 \family typewriter
33602 '
33603 \backslash
33604 ,''
33605 \family default
33606  will look better.
33607 \end_layout
33608
33609 \begin_layout Enumerate
33610
33611 \size small
33612 Delete this space to maintain correct page references.
33613 \end_layout
33614
33615 \begin_layout Enumerate
33616
33617 \size small
33618 \emph on
33619 You might wish to put this between a pair of
33620 \begin_inset Quotes eld
33621 \end_inset
33622
33623
33624 \family typewriter
33625 {}
33626 \family default
33627
33628 \begin_inset Quotes erd
33629 \end_inset
33630
33631 .
33632 \end_layout
33633
33634 \begin_layout Enumerate
33635
33636 \size small
33637 You ought to remove spaces in front of punctuation.
33638 \end_layout
33639
33640 \begin_layout Enumerate
33641
33642 \size small
33643 Could not execute \SpecialChar LaTeX
33644  command.
33645 \end_layout
33646
33647 \begin_layout Enumerate
33648
33649 \size small
33650 Don't use
33651 \family typewriter
33652
33653 \backslash
33654 /
33655 \family default
33656  in front of small punctuation.
33657 \end_layout
33658
33659 \begin_layout Enumerate
33660
33661 \family typewriter
33662 \size small
33663 $
33664 \backslash
33665 times$
33666 \family default
33667  may look prettier here.
33668 \end_layout
33669
33670 \begin_layout Enumerate
33671
33672 \size small
33673 \emph on
33674 Multiple spaces detected in output.
33675 \end_layout
33676
33677 \begin_layout Enumerate
33678
33679 \size small
33680 This text may be ignored.
33681 \end_layout
33682
33683 \begin_layout Enumerate
33684
33685 \size small
33686 Use
33687 \family typewriter
33688
33689 \begin_inset Quotes eld
33690 \end_inset
33691
33692
33693 \family default
33694  to begin quotation,
33695  not
33696 \family typewriter
33697 '
33698 \family default
33699 .
33700 \end_layout
33701
33702 \begin_layout Enumerate
33703
33704 \size small
33705 Use
33706 \family typewriter
33707 '
33708 \family default
33709  to end quotation,
33710  not
33711 \family typewriter
33712
33713 \begin_inset Quotes eld
33714 \end_inset
33715
33716
33717 \family default
33718 .
33719 \end_layout
33720
33721 \begin_layout Enumerate
33722
33723 \size small
33724 Don't mix quotes.
33725 \end_layout
33726
33727 \begin_layout Enumerate
33728
33729 \size small
33730 You should perhaps use
33731 \begin_inset Quotes eld
33732 \end_inset
33733
33734
33735 \family typewriter
33736 cmd
33737 \family default
33738
33739 \begin_inset Quotes erd
33740 \end_inset
33741
33742  instead.
33743 \end_layout
33744
33745 \begin_layout Enumerate
33746
33747 \size small
33748 You should put a space in front of/after parenthesis.
33749 \end_layout
33750
33751 \begin_layout Enumerate
33752
33753 \size small
33754 You should avoid spaces in front of/after parenthesis.
33755 \end_layout
33756
33757 \begin_layout Enumerate
33758
33759 \size small
33760 \emph on
33761 You should not use punctuation in front of/after quotes.
33762 \end_layout
33763
33764 \begin_layout Enumerate
33765
33766 \size small
33767 Double space found.
33768 \end_layout
33769
33770 \begin_layout Enumerate
33771
33772 \size small
33773 You should put punctuation outside inner/inside display math mode.
33774 \end_layout
33775
33776 \begin_layout Enumerate
33777
33778 \size small
33779 You ought to not use primitive \SpecialChar TeX
33780  in \SpecialChar LaTeX
33781  code.
33782 \end_layout
33783
33784 \begin_layout Enumerate
33785
33786 \size small
33787 You should remove spaces in front of
33788 \begin_inset Quotes eld
33789 \end_inset
33790
33791
33792 \family typewriter
33793 %s
33794 \family default
33795
33796 \begin_inset Quotes erd
33797 \end_inset
33798
33799
33800 \end_layout
33801
33802 \begin_layout Enumerate
33803
33804 \size small
33805 \begin_inset Quotes eld
33806 \end_inset
33807
33808
33809 \family typewriter
33810 %s
33811 \family default
33812
33813 \begin_inset Quotes erd
33814 \end_inset
33815
33816  is normally not followed by
33817 \begin_inset Quotes eld
33818 \end_inset
33819
33820
33821 \family typewriter
33822 %c
33823 \family default
33824
33825 \begin_inset Quotes erd
33826 \end_inset
33827
33828 .
33829 \end_layout
33830
33831 \begin_layout Standard
33832 In later versions of \SpecialChar LyX
33833 ,
33834  we hope to provide a more complete interface to this tool (and it's smaller cousin
33835 \family typewriter
33836 lacheck
33837 \family default
33838 ) to exploit the full power of it.
33839  But it's not exactly useless as it is now:
33840  go try it on one of your existing documents of a certain length and be surprised.
33841 \end_layout
33842
33843 \begin_layout Section
33844 Version Control in \SpecialChar LyX
33845
33846 \end_layout
33847
33848 \begin_layout Standard
33849 by
33850 \noun on
33851  Lars Gullik Bjønnes
33852 \noun default
33853 and
33854 \noun on
33855 Pavel Sanda
33856 \end_layout
33857
33858 \begin_layout Subsection
33859 Introduction
33860 \end_layout
33861
33862 \begin_layout Standard
33863 \SpecialChar LyX
33864  supports some of the most basic RCS/CVS/SVN/GIT commands.
33865  If you need something a bit more sophisticated you will have to do that manually in a terminal.
33866 \end_layout
33867
33868 \begin_layout Standard
33869 Also note that CVS support is not as good as subversion support,
33870  so we advise using SVN instead.
33871  A good place to start learning Subversion is the SVN Book
33872 \begin_inset Foot
33873 status collapsed
33874
33875 \begin_layout Plain Layout
33876 \begin_inset CommandInset href
33877 LatexCommand href
33878 target "http://svnbook.red-bean.com/"
33879 literal "false"
33880
33881 \end_inset
33882
33883
33884 \end_layout
33885
33886 \end_inset
33887
33888 .
33889  In the case of RCS you should read
33890 \begin_inset Quotes eld
33891 \end_inset
33892
33893 rcsintro
33894 \begin_inset Quotes erd
33895 \end_inset
33896
33897  (a man file,
33898  read it with
33899 \family typewriter
33900 man rcsintro
33901 \family default
33902 ).
33903  This file describes all the basic features of RCS.
33904  You should especially notice the comment about a RCS directory,
33905  and the notion of a master RCS file (the file ending in
33906 \family typewriter
33907 ,v
33908 \family default
33909 ).
33910 \end_layout
33911
33912 \begin_layout Standard
33913 Before you begin to use the version control features in \SpecialChar LyX
33914 ,
33915  you should be familiar with RCS/CVS/SVN/GIT usage.
33916  The implementation in \SpecialChar LyX
33917  assumes a recent version of the GNU RCS or CVS/SVN package —
33918  no guarantees are made for older versions.
33919  Most of the log messages are not currently displayed after operations —
33920  you can check them in the Messages pane if you are unsure.
33921  Regular users of version control will appreciate the VC toolbar,
33922  which can be enabled via
33923 \family sans
33924 View\SpecialChar menuseparator
33925 Toolbars\SpecialChar menuseparator
33926 Version
33927 \begin_inset space ~
33928 \end_inset
33929
33930 Control
33931 \family default
33932 .
33933 \end_layout
33934
33935 \begin_layout Standard
33936 For introducing your own external commands consult
33937 \begin_inset Flex Code
33938 status collapsed
33939
33940 \begin_layout Plain Layout
33941 vc-command
33942 \end_layout
33943
33944 \end_inset
33945
33946  in the manual
33947 \emph on
33948 \SpecialChar LyX
33949  Functions
33950 \emph default
33951 .
33952 \end_layout
33953
33954 \begin_layout Standard
33955 It is strongly recommended to store documents in uncompressed format if using version control (uncheck
33956 \family sans
33957 Document\SpecialChar menuseparator
33958 Compressed
33959 \family default
33960  if it is checked):
33961  Uncompressed LyX documents are text files and therefore for merging two different versions by version control systems.
33962  Compressed LyX documents are binary files,
33963  which cannot be merged by version control systems.
33964 \end_layout
33965
33966 \begin_layout Subsection
33967 RCS commands in \SpecialChar LyX
33968
33969 \end_layout
33970
33971 \begin_layout Standard
33972 The following sections describe the RCS commands supported by \SpecialChar LyX
33973 .
33974  You can find them in the
33975 \family sans
33976 File\SpecialChar menuseparator
33977 Version
33978 \begin_inset space ~
33979 \end_inset
33980
33981 Control
33982 \family default
33983  submenu.
33984  \SpecialChar LyX
33985  was tested against RCS 5.7/5.8.
33986 \end_layout
33987
33988 \begin_layout Subsubsection
33989
33990 \family sans
33991 Register
33992 \end_layout
33993
33994 \begin_layout Standard
33995 If your document is not under revision control,
33996  this is the only item shown in the menu.
33997  And if it is under revision control,
33998  the
33999 \family sans
34000 Register
34001 \family default
34002  item is not visible.
34003
34004 \end_layout
34005
34006 \begin_layout Standard
34007 This command registers your document with RCS (unless you are under the directory managed by CVS)\SpecialChar endofsentence
34008  You are asked interactively to supply an initial description of the document.
34009  The document is now set in Read-Only mode and you have to
34010 \family sans
34011 Check
34012 \begin_inset space ~
34013 \end_inset
34014
34015 Out
34016 \begin_inset space ~
34017 \end_inset
34018
34019 For
34020 \begin_inset space ~
34021 \end_inset
34022
34023 Edit
34024 \family default
34025 ,
34026  before making any changes to it.
34027  A document under revision control has a
34028 \begin_inset Quotes eld
34029 \end_inset
34030
34031 [RCS:<version> <locker>]
34032 \begin_inset Quotes erd
34033 \end_inset
34034
34035  item tagged to the filename in the minibuffer.
34036 \end_layout
34037
34038 \begin_layout Standard
34039 RCS command that is run:
34040 \end_layout
34041
34042 \begin_layout LyX-Code
34043
34044 \family typewriter
34045 ci -q -u -i -t-"<initial description>" <file-name>
34046 \end_layout
34047
34048 \begin_layout Standard
34049 Read
34050 \family typewriter
34051 man ci
34052 \family default
34053  to understand the switches.
34054
34055 \end_layout
34056
34057 \begin_layout Subsubsection
34058
34059 \family sans
34060 Check In Changes
34061 \end_layout
34062
34063 \begin_layout Standard
34064 When you are finished editing a file,
34065  you check in your changes.
34066  When you do this,
34067  you are asked for a description of the changes.
34068  This is stored in the history log.
34069  The version number is bumped,
34070  your changes are applied to the master RCS file,
34071  the document is unlocked and set to Read-Only mode.
34072 \end_layout
34073
34074 \begin_layout Itemize
34075 RCS command:
34076
34077 \family typewriter
34078 ci -q -u -m"<description>" <file-name>
34079 \end_layout
34080
34081 \begin_layout Subsubsection
34082
34083 \family sans
34084 Check Out For Edit
34085 \end_layout
34086
34087 \begin_layout Standard
34088 By doing this you lock the document so that only you can edit it.
34089  This will also make the document Read-Write only for you.
34090  You will usually continue editing for a while and when you are finished you check in your changes.
34091  The status line is changed to reflect that you have locked the file.
34092 \end_layout
34093
34094 \begin_layout Itemize
34095 RCS command:
34096
34097 \family typewriter
34098 co -q -l <file-name>
34099 \end_layout
34100
34101 \begin_layout Subsubsection
34102
34103 \family sans
34104 Revert To Repository Version
34105 \end_layout
34106
34107 \begin_layout Standard
34108 This will discard all changes made to the document since the last check in.
34109  You get a warning before changes are discarded.
34110 \end_layout
34111
34112 \begin_layout Itemize
34113 RCS command:
34114
34115 \family typewriter
34116 co -f -u<version> <file-name>
34117 \end_layout
34118
34119 \begin_layout Subsubsection
34120
34121 \family sans
34122 Copy
34123 \end_layout
34124
34125 \begin_layout Standard
34126 This will create a copy of the current document.
34127  Since RCS does not support copy operations natively,
34128  the version history is not preserved,
34129  and the copy is added as a new file.
34130  It requires a clean document without any changes since the last checkin.
34131  You are asked for a file name and a description of the copy operation.
34132  After that the copy is created,
34133  both locally and in the repository.
34134  If the parent directories of the copied and original document differ,
34135  all relative paths of included files of the copy are adjusted (like in
34136 \family sans
34137 File\SpecialChar menuseparator
34138 Save As
34139 \family default
34140 \SpecialChar ldots
34141 ).
34142  Finally,
34143  the copy is loaded instead of the original document.
34144 \end_layout
34145
34146 \begin_layout Labeling
34147 \labelwidthstring 00.00.0000
34148 RCS
34149 \begin_inset space ~
34150 \end_inset
34151
34152 commands:
34153
34154 \begin_inset space ~
34155 \end_inset
34156
34157
34158 \begin_inset Newline newline
34159 \end_inset
34160
34161 Copy
34162 \begin_inset Flex Code
34163 status collapsed
34164
34165 \begin_layout Plain Layout
34166
34167 \family typewriter
34168 \begin_inset Quotes qld
34169 \end_inset
34170
34171 <file-name>
34172 \begin_inset Quotes qld
34173 \end_inset
34174
34175
34176 \end_layout
34177
34178 \end_inset
34179
34180  to
34181 \begin_inset Flex Code
34182 status collapsed
34183
34184 \begin_layout Plain Layout
34185
34186 \family typewriter
34187 \begin_inset Quotes qld
34188 \end_inset
34189
34190 <new-file-name>
34191 \begin_inset Quotes qld
34192 \end_inset
34193
34194
34195 \end_layout
34196
34197 \end_inset
34198
34199
34200 \begin_inset Newline newline
34201 \end_inset
34202
34203
34204 \begin_inset Flex Code
34205 status collapsed
34206
34207 \begin_layout Plain Layout
34208 ci -q -u
34209 \family typewriter
34210 -i
34211 \begin_inset Quotes qld
34212 \end_inset
34213
34214 <new-file-name>
34215 \begin_inset Quotes qld
34216 \end_inset
34217
34218
34219 \end_layout
34220
34221 \end_inset
34222
34223
34224 \end_layout
34225
34226 \begin_layout Subsubsection
34227
34228 \family sans
34229 Undo Last Checkin
34230 \end_layout
34231
34232 \begin_layout Standard
34233 This makes as if the last check in never happened.
34234  No changes are made to the document loaded into \SpecialChar LyX
34235 ,
34236  but the last version is removed from the master RCS file.
34237 \end_layout
34238
34239 \begin_layout Itemize
34240 RCS command:
34241
34242 \family typewriter
34243 rcs -o<version> <file-name>
34244 \end_layout
34245
34246 \begin_layout Subsubsection
34247
34248 \family sans
34249 Show History
34250 \end_layout
34251
34252 \begin_layout Standard
34253 This shows the complete history of the RCS document.
34254  The output of
34255 \family typewriter
34256 rlog <file-name>
34257 \family default
34258  is shown in a browser.
34259  See
34260 \family typewriter
34261 man rlog
34262 \family default
34263  for more info.
34264 \end_layout
34265
34266 \begin_layout Subsubsection
34267 Revision info
34268 \end_layout
34269
34270 \begin_layout Standard
34271 \SpecialChar LyX
34272  supports RCS version number,
34273  author name,
34274  date and time of last commit.
34275  All those are extracted from
34276 \family typewriter
34277 rlog -r <file-name>
34278 \family default
34279 .
34280  See
34281 \begin_inset CommandInset ref
34282 LatexCommand ref
34283 reference "subsec:VCS-Revision-Information"
34284 nolink "false"
34285
34286 \end_inset
34287
34288  for details.
34289 \end_layout
34290
34291 \begin_layout Subsection
34292 CVS commands in \SpecialChar LyX
34293
34294 \end_layout
34295
34296 \begin_layout Standard
34297 A subset of CVS operations is supported by \SpecialChar LyX
34298 .
34299  You can find the commands in the
34300 \family sans
34301 File\SpecialChar menuseparator
34302 Version
34303 \begin_inset space ~
34304 \end_inset
34305
34306 Control
34307 \family default
34308  submenu.
34309  The version control system SVN is more powerful,
34310  so please use it instead of CVS if possible.
34311 \end_layout
34312
34313 \begin_layout Subsubsection
34314
34315 \family sans
34316 General CVS usage
34317 \end_layout
34318
34319 \begin_layout Standard
34320 If you start from scratch with CVS you have to create your repository and checkout the working copy with external tools.
34321  If you're using a client-server setup you may need to login before doing the first repository checkout.
34322 \end_layout
34323
34324 \begin_layout Standard
34325 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.
34326  Standard CVS repositories don't operate with a file locking mechanism.
34327  This may be surprising,
34328  but conflicts only occur if people disagree on the proper content of the same part of a document.
34329  So,
34330  if co-workers are used to communicate regularly,
34331  these conflicts occur rarely.
34332  If they don't communicate they have a fundamental problem anyway.
34333  Nevertheless some people like to work with so called
34334 \begin_inset Quotes eld
34335 \end_inset
34336
34337 reserved checkouts
34338 \begin_inset Quotes erd
34339 \end_inset
34340
34341 .
34342  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.
34343  When the changes are checked in the working copy returns to readonly state.
34344  With \SpecialChar LyX
34345  one has to edit the
34346 \begin_inset Flex Code
34347 status collapsed
34348
34349 \begin_layout Plain Layout
34350 .cvsrc
34351 \end_layout
34352
34353 \end_inset
34354
34355  file and add the line
34356 \begin_inset Flex Code
34357 status collapsed
34358
34359 \begin_layout Plain Layout
34360 cvs -r
34361 \end_layout
34362
34363 \end_inset
34364
34365  to work with reserved checkouts.
34366  The benefit is the possibility to see who is using a writable copy of some document.
34367  It's not guaranteed only one user makes a copy writable.
34368 \end_layout
34369
34370 \begin_layout Standard
34371 \SpecialChar LyX
34372  tries to guess if you're using reserved or non-reserved checkouts.
34373  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.
34374  When a reserved checkout is detected you have to use
34375 \begin_inset Flex Noun
34376 status collapsed
34377
34378 \begin_layout Plain Layout
34379 Check Out
34380 \end_layout
34381
34382 \end_inset
34383
34384  to make your working copy writable if it's readonly.
34385  After doing so the
34386 \begin_inset Flex Noun
34387 status collapsed
34388
34389 \begin_layout Plain Layout
34390 Check In
34391 \end_layout
34392
34393 \end_inset
34394
34395  operation is possible and that makes your working copy readonly again after transferring your changes to the repository.
34396 \end_layout
34397
34398 \begin_layout Standard
34399 More information about CVS can be found here
34400 \begin_inset Flex URL
34401 status collapsed
34402
34403 \begin_layout Plain Layout
34404
34405 http://www.nongnu.org/cvs
34406 \end_layout
34407
34408 \end_inset
34409
34410  and here
34411 \begin_inset Flex URL
34412 status collapsed
34413
34414 \begin_layout Plain Layout
34415
34416 http://ximbiot.com/cvs
34417 \end_layout
34418
34419 \end_inset
34420
34421 .
34422 \end_layout
34423
34424 \begin_layout Standard
34425 Read
34426 \family typewriter
34427 man cvs
34428 \family default
34429  to understand the sub-commands and the switches mentioned below.
34430 \end_layout
34431
34432 \begin_layout Subsubsection
34433
34434 \family sans
34435 Register
34436 \end_layout
34437
34438 \begin_layout Standard
34439 If your document is not under revision control,
34440  this is the only item shown in the menu.
34441  And if it is under revision control,
34442  the
34443 \family sans
34444 Register
34445 \family default
34446  item is not visible.
34447
34448 \end_layout
34449
34450 \begin_layout Standard
34451 This command registers in CVS your document
34452 \begin_inset Flex Strong
34453 status collapsed
34454
34455 \begin_layout Plain Layout
34456
34457 \emph on
34458 only
34459 \end_layout
34460
34461 \end_inset
34462
34463  in the case you have already the documents directory under CVS control (in particular
34464 \family typewriter
34465 CVS/Entries
34466 \family default
34467  file exists).
34468  This means you have to create or checkout the archive by yourself using external tools.
34469  (In case you forget that step \SpecialChar LyX
34470  registers the document with RCS.)
34471 \end_layout
34472
34473 \begin_layout Standard
34474 Then you are asked interactively to supply an initial description of the document.
34475  Don't forget that registered file is not yet checked in.
34476 \end_layout
34477
34478 \begin_layout Standard
34479 CVS command that is run:
34480
34481 \family typewriter
34482 cvs -q add -m"<entered message>" "<file-name>"
34483 \end_layout
34484
34485 \begin_layout Standard
34486 The term
34487 \family typewriter
34488 "<file-name>"
34489 \family default
34490  above and for all other CVS commands is an abbreviation for
34491 \begin_inset Quotes eld
34492 \end_inset
34493
34494 change the current working directory to file location and use the file name without path component as argument
34495 \begin_inset Quotes erd
34496 \end_inset
34497
34498 .
34499 \end_layout
34500
34501 \begin_layout Subsubsection
34502
34503 \family sans
34504 Check In Changes
34505 \end_layout
34506
34507 \begin_layout Standard
34508 When you are finished editing a file,
34509  you commit your changes.
34510  When you do this and you had changed the document,
34511  you are asked for a description of the changes.
34512  After that changes are written to the repository.
34513  In case you didn't change the document and a reserved checkout is detected the reservation made on
34514 \begin_inset Flex Noun
34515 status collapsed
34516
34517 \begin_layout Plain Layout
34518 Check Out
34519 \end_layout
34520
34521 \end_inset
34522
34523  is undone.
34524 \end_layout
34525
34526 \begin_layout Labeling
34527 \labelwidthstring 00.00.0000
34528 CVS
34529 \begin_inset space ~
34530 \end_inset
34531
34532 command:
34533
34534 \begin_inset space ~
34535 \end_inset
34536
34537
34538 \begin_inset Newline newline
34539 \end_inset
34540
34541
34542 \begin_inset Flex Code
34543 status collapsed
34544
34545 \begin_layout Plain Layout
34546 cvs
34547 \family typewriter
34548 -q commit -m"<description>" "<file-name>"
34549 \end_layout
34550
34551 \end_inset
34552
34553  or
34554 \begin_inset Newline newline
34555 \end_inset
34556
34557
34558 \begin_inset Flex Code
34559 status collapsed
34560
34561 \begin_layout Plain Layout
34562 cvs -q unedit
34563 \family typewriter
34564 "<file-name>"
34565 \end_layout
34566
34567 \end_inset
34568
34569
34570 \end_layout
34571
34572 \begin_layout Subsubsection
34573
34574 \family sans
34575 Check Out Changes
34576 \end_layout
34577
34578 \begin_layout Standard
34579 When you are sharing a repository with others,
34580  you may have to incorporate their changes into your working copy.
34581 \end_layout
34582
34583 \begin_layout Standard
34584 CVS command:
34585
34586 \family typewriter
34587 cvs -q update "<file-name>"
34588 \end_layout
34589
34590 \begin_layout Standard
34591 If a readonly checkout is detected the working copy is made writable and reserved.
34592 \end_layout
34593
34594 \begin_layout Standard
34595 CVS command:
34596
34597 \family typewriter
34598 cvs -q edit "<file-name>"
34599 \end_layout
34600
34601 \begin_layout Subsubsection
34602
34603 \family sans
34604 Revert To Repository Version
34605 \end_layout
34606
34607 \begin_layout Standard
34608 This will discard all changes made to the document since the last check in.
34609  You get a warning before changes are discarded.
34610  Firstly the file is deleted,
34611  secondly CVS update command is run.
34612 \end_layout
34613
34614 \begin_layout Standard
34615 CVS command:
34616
34617 \family typewriter
34618 cvs -q update "<file-name>"
34619 \end_layout
34620
34621 \begin_layout Standard
34622 If a reserved checkout is detected and the working copy has no changes only the reservation is undone.
34623 \end_layout
34624
34625 \begin_layout Standard
34626 CVS command:
34627
34628 \family typewriter
34629 cvs -q unedit "<file-name>"
34630 \end_layout
34631
34632 \begin_layout Subsubsection
34633
34634 \family sans
34635 Copy
34636 \end_layout
34637
34638 \begin_layout Standard
34639 This will create a copy of the current document.
34640  Since CVS does not support copy operations natively,
34641  the version history is not preserved,
34642  and the copy is added as a new file.
34643  It requires a clean document without any changes since the last checkin.
34644  You are asked for a file name and a description of the copy operation.
34645  After that the copy is created,
34646  both locally and in the repository.
34647  If the parent directories of the copied and original document differ,
34648  all relative paths of included files of the copy are adjusted (like in
34649 \family sans
34650 File\SpecialChar menuseparator
34651 Save As
34652 \family default
34653 \SpecialChar ldots
34654 ).
34655  Finally,
34656  the copy is loaded instead of the original document.
34657 \end_layout
34658
34659 \begin_layout Labeling
34660 \labelwidthstring 00.00.0000
34661 CVS
34662 \begin_inset space ~
34663 \end_inset
34664
34665 commands:
34666
34667 \begin_inset space ~
34668 \end_inset
34669
34670
34671 \begin_inset Newline newline
34672 \end_inset
34673
34674 Copy
34675 \begin_inset Flex Code
34676 status collapsed
34677
34678 \begin_layout Plain Layout
34679 "<file-name>"
34680 \end_layout
34681
34682 \end_inset
34683
34684  to
34685 \begin_inset Flex Code
34686 status collapsed
34687
34688 \begin_layout Plain Layout
34689 "<new-file-name>"
34690 \end_layout
34691
34692 \end_inset
34693
34694
34695 \begin_inset Newline newline
34696 \end_inset
34697
34698
34699 \begin_inset Flex Code
34700 status collapsed
34701
34702 \begin_layout Plain Layout
34703 cvs -q add "<new-file-name>"
34704 \end_layout
34705
34706 \end_inset
34707
34708
34709 \end_layout
34710
34711 \begin_layout Subsubsection
34712
34713 \family sans
34714 Rename
34715 \end_layout
34716
34717 \begin_layout Standard
34718 This will rename the current document.
34719  Since CVS does not support rename operations natively,
34720  the version history is not preserved,
34721  the renamed document is added as a new file,
34722  and the original document is deleted.
34723  It requires a clean document without any changes since the last checkin.
34724  You are asked for a file name and a description of the rename operation.
34725  After that the document is renamed,
34726  both locally and in the repository.
34727  If the parent directories of the new and old file names differ,
34728  all relative paths of included files are adjusted (like in
34729 \family sans
34730 File\SpecialChar menuseparator
34731 Save As
34732 \family default
34733 \SpecialChar ldots
34734 ).
34735  Finally,
34736  the document is reloaded using the new name.
34737 \end_layout
34738
34739 \begin_layout Labeling
34740 \labelwidthstring 00.00.0000
34741 CVS
34742 \begin_inset space ~
34743 \end_inset
34744
34745 commands:
34746
34747 \begin_inset space ~
34748 \end_inset
34749
34750
34751 \begin_inset Newline newline
34752 \end_inset
34753
34754 Rename
34755 \begin_inset Flex Code
34756 status collapsed
34757
34758 \begin_layout Plain Layout
34759 "<file-name>"
34760 \end_layout
34761
34762 \end_inset
34763
34764  to
34765 \begin_inset Flex Code
34766 status collapsed
34767
34768 \begin_layout Plain Layout
34769 "<new-file-name>"
34770 \end_layout
34771
34772 \end_inset
34773
34774
34775 \begin_inset Newline newline
34776 \end_inset
34777
34778
34779 \begin_inset Flex Code
34780 status collapsed
34781
34782 \begin_layout Plain Layout
34783 cvs -q add "<new-file-name>"
34784 \end_layout
34785
34786 \end_inset
34787
34788
34789 \begin_inset Newline newline
34790 \end_inset
34791
34792
34793 \begin_inset Flex Code
34794 status collapsed
34795
34796 \begin_layout Plain Layout
34797 cvs -q remove "<file-name>"
34798 \end_layout
34799
34800 \end_inset
34801
34802
34803 \end_layout
34804
34805 \begin_layout Subsubsection
34806 Update of the local directory checkout from repository
34807 \end_layout
34808
34809 \begin_layout Standard
34810 Once your documents gets more complex,
34811  containing sub-documents and pictures,
34812  including external
34813 \begin_inset Flex Code
34814 status collapsed
34815
34816 \begin_layout Plain Layout
34817 .tex
34818 \end_layout
34819
34820 \end_inset
34821
34822  files and so on using version control becomes more complicated.
34823  \SpecialChar LyX
34824  supports updating the whole tree in which resides the document.
34825  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.
34826  You have to organize the files structure so that all external files are in the same directory or subdirectories of the document.
34827  It's good practice anyway to store multipart documents in an extra directory.
34828 \end_layout
34829
34830 \begin_layout Standard
34831 The
34832 \begin_inset Flex Code
34833 status collapsed
34834
34835 \begin_layout Plain Layout
34836 Update local directory from repository
34837 \end_layout
34838
34839 \end_inset
34840
34841  command updates the whole directory.
34842  If local changes are detected user is warned before update starts.
34843  In case of merge conflicts both versions of the conflicting document parts are placed in the final document.
34844  You have to review and correct the result of the merge.
34845  You'll find the conflicts enclosed in pairs of
34846 \begin_inset Flex Code
34847 status collapsed
34848
34849 \begin_layout Plain Layout
34850 <<<<<<<
34851 \end_layout
34852
34853 \end_inset
34854
34855  and
34856 \begin_inset Flex Code
34857 status collapsed
34858
34859 \begin_layout Plain Layout
34860 >>>>>>>
34861 \end_layout
34862
34863 \end_inset
34864
34865  separated by
34866 \begin_inset Flex Code
34867 status collapsed
34868
34869 \begin_layout Plain Layout
34870 =======
34871 \end_layout
34872
34873 \end_inset
34874
34875 .
34876  The first part is your version as before the update operation with the document name prepended.
34877  The second one is the repository version with the version number after the sequence of
34878 \begin_inset Flex Code
34879 status collapsed
34880
34881 \begin_layout Plain Layout
34882 >
34883 \end_layout
34884
34885 \end_inset
34886
34887  signs.
34888 \end_layout
34889
34890 \begin_layout Labeling
34891 \labelwidthstring 00.00.0000
34892 CVS
34893 \begin_inset space ~
34894 \end_inset
34895
34896 commands:
34897
34898 \begin_inset space ~
34899 \end_inset
34900
34901
34902 \begin_inset Newline newline
34903 \end_inset
34904
34905
34906 \begin_inset Flex Code
34907 status collapsed
34908
34909 \begin_layout Plain Layout
34910 cd $path;
34911  cvs diff
34912 \family typewriter
34913 "."
34914 \end_layout
34915
34916 \end_inset
34917
34918  (Ask if changes are detected.)
34919 \begin_inset Newline newline
34920 \end_inset
34921
34922
34923 \begin_inset Flex Code
34924 status collapsed
34925
34926 \begin_layout Plain Layout
34927 cd $path;
34928  cvs -q update
34929 \family typewriter
34930 "."
34931 \end_layout
34932
34933 \end_inset
34934
34935
34936 \end_layout
34937
34938 \begin_layout Standard
34939 where
34940 \begin_inset Flex Code
34941 status collapsed
34942
34943 \begin_layout Plain Layout
34944 $path
34945 \end_layout
34946
34947 \end_inset
34948
34949  stands for the path to the document.
34950 \end_layout
34951
34952 \begin_layout Subsubsection
34953
34954 \family sans
34955 Show History
34956 \end_layout
34957
34958 \begin_layout Standard
34959 This shows the complete history of the CVS document.
34960  The output of
34961 \family typewriter
34962 cvs log "<file-name>"
34963 \family default
34964  is shown in a browser.
34965 \end_layout
34966
34967 \begin_layout Subsubsection
34968 Revision info
34969 \end_layout
34970
34971 \begin_layout Standard
34972 \SpecialChar LyX
34973  supports CVS version number,
34974  author name,
34975  date and time of last commit.
34976  All those are extracted from
34977 \family typewriter
34978 cvs log -r <file-name>
34979 \family default
34980 .
34981  See
34982 \begin_inset CommandInset ref
34983 LatexCommand ref
34984 reference "subsec:VCS-Revision-Information"
34985 nolink "false"
34986
34987 \end_inset
34988
34989  for details.
34990 \end_layout
34991
34992 \begin_layout Subsection
34993 SVN commands in \SpecialChar LyX
34994
34995 \end_layout
34996
34997 \begin_layout Standard
34998 SVN is now partially supported by \SpecialChar LyX
34999 .
35000  You can find the commands in the
35001 \family sans
35002 File\SpecialChar menuseparator
35003 Version
35004 \begin_inset space ~
35005 \end_inset
35006
35007 Control
35008 \family default
35009  submenu.
35010  Please note that if you use password protected access to repository via ssh,
35011  you will be asked in terminal window.
35012  \SpecialChar LyX
35013  was tested against SVN 1.5,
35014  1.6,
35015  1.7 and 1.8
35016 \begin_inset Foot
35017 status collapsed
35018
35019 \begin_layout Plain Layout
35020 Most of the commands will work with 1.4 too,
35021  see
35022 \begin_inset CommandInset ref
35023 LatexCommand ref
35024 reference "subsec:SVN-Repo-Update"
35025 nolink "false"
35026
35027 \end_inset
35028
35029 .
35030  There seems to be currently unresolved permissions problem under SVN 1.8 with reverting changes when file is locked.
35031 \end_layout
35032
35033 \end_inset
35034
35035
35036 \end_layout
35037
35038 \begin_layout Subsubsection
35039
35040 \family sans
35041 Register
35042 \end_layout
35043
35044 \begin_layout Standard
35045 If your document is not under revision control,
35046  this is the only item shown in the menu.
35047  And if it is under revision control,
35048  the
35049 \family sans
35050 Register
35051 \family default
35052  item is not visible.
35053 \end_layout
35054
35055 \begin_layout Standard
35056 This command registers in SVN your document ONLY in case you have already the documents directory under SVN control (in particular
35057 \family typewriter
35058 .svn/entries
35059 \family default
35060  file exists).
35061  This means you have to checkout the archive by yourself.
35062 \end_layout
35063
35064 \begin_layout Standard
35065 Then you are asked interactively to supply an initial description of the document.
35066  Don't forget that registered file is not yet commited.
35067 \end_layout
35068
35069 \begin_layout Standard
35070 SVN command that is run:
35071
35072 \family typewriter
35073 svn add -q
35074 \begin_inset Quotes qld
35075 \end_inset
35076
35077 <file-name>
35078 \begin_inset Quotes qld
35079 \end_inset
35080
35081
35082 \end_layout
35083
35084 \begin_layout Standard
35085 Read
35086 \family typewriter
35087 man svn
35088 \family default
35089  to understand the switches.
35090 \end_layout
35091
35092 \begin_layout Subsubsection
35093
35094 \family sans
35095 Check In Changes
35096 \end_layout
35097
35098 \begin_layout Standard
35099 When you are finished editing a file,
35100  you commit your changes.
35101  When you do this,
35102  you are asked for a description of the changes.
35103  After that changes are commited.
35104 \end_layout
35105
35106 \begin_layout Standard
35107 SVN command:
35108 \begin_inset Foot
35109 status collapsed
35110
35111 \begin_layout Plain Layout
35112 In case locking is not enabled.
35113  See Section
35114 \begin_inset CommandInset ref
35115 LatexCommand ref
35116 reference "subsec:SVN-File-Locking"
35117 nolink "false"
35118
35119 \end_inset
35120
35121 .
35122 \end_layout
35123
35124 \end_inset
35125
35126
35127 \family typewriter
35128 svn commit -q -m"<description>" <file-name>
35129 \end_layout
35130
35131 \begin_layout Subsubsection
35132
35133 \family sans
35134 Check Out For Edit
35135 \end_layout
35136
35137 \begin_layout Standard
35138 Updates the changes of this file from the repository.
35139  Be sure you understand SVN merging and conflicts resolving before using this function,
35140  because all conflicts has to be resolved manually by you!
35141 \end_layout
35142
35143 \begin_layout Standard
35144 SVN command:
35145 \begin_inset Foot
35146 status collapsed
35147
35148 \begin_layout Plain Layout
35149 Ditto.
35150 \end_layout
35151
35152 \end_inset
35153
35154
35155 \family typewriter
35156 svn update --non-interactive
35157 \begin_inset Quotes qld
35158 \end_inset
35159
35160 <file-name>
35161 \begin_inset Quotes qld
35162 \end_inset
35163
35164
35165 \end_layout
35166
35167 \begin_layout Subsubsection
35168
35169 \family sans
35170 Revert To Repository Version
35171 \end_layout
35172
35173 \begin_layout Standard
35174 This will discard all changes made to the document since the last check in.
35175  You get a warning before changes are discarded.
35176 \end_layout
35177
35178 \begin_layout Standard
35179 SVN command:
35180
35181 \family typewriter
35182 svn revert -q
35183 \begin_inset Quotes qld
35184 \end_inset
35185
35186 <file-name>
35187 \begin_inset Quotes qld
35188 \end_inset
35189
35190
35191 \end_layout
35192
35193 \begin_layout Subsubsection
35194
35195 \family sans
35196 Copy
35197 \end_layout
35198
35199 \begin_layout Standard
35200 This will create a copy of the current document including the version history.
35201  It requires a clean document without any changes since the last checkin.
35202  You are asked for a file name and a description of the copy operation.
35203  After that the copy is created,
35204  both locally and in the repository.
35205  If the parent directories of the copied and original document differ,
35206  all relative paths of included files of the copy are adjusted (like in
35207 \family sans
35208 File\SpecialChar menuseparator
35209 Save As
35210 \family default
35211 \SpecialChar ldots
35212 ).
35213  Finally,
35214  the copy is loaded instead of the original document.
35215 \end_layout
35216
35217 \begin_layout Labeling
35218 \labelwidthstring 00.00.0000
35219 SVN
35220 \begin_inset space ~
35221 \end_inset
35222
35223 commands:
35224
35225 \begin_inset space ~
35226 \end_inset
35227
35228
35229 \begin_inset Newline newline
35230 \end_inset
35231
35232
35233 \begin_inset Flex Code
35234 status collapsed
35235
35236 \begin_layout Plain Layout
35237 svn copy -q
35238 \family typewriter
35239
35240 \begin_inset Quotes qld
35241 \end_inset
35242
35243 <file-name>
35244 \begin_inset Quotes qld
35245 \end_inset
35246
35247
35248 \begin_inset Quotes qld
35249 \end_inset
35250
35251 <new-file-name>
35252 \begin_inset Quotes qld
35253 \end_inset
35254
35255
35256 \end_layout
35257
35258 \end_inset
35259
35260
35261 \begin_inset Newline newline
35262 \end_inset
35263
35264
35265 \begin_inset Flex Code
35266 status collapsed
35267
35268 \begin_layout Plain Layout
35269 svn commit
35270 \end_layout
35271
35272 \end_inset
35273
35274
35275 \end_layout
35276
35277 \begin_layout Subsubsection
35278
35279 \family sans
35280 Rename
35281 \end_layout
35282
35283 \begin_layout Standard
35284 This will rename the current document including the version history.
35285  It requires a clean document without any changes since the last checkin.
35286  You are asked for a file name and a description of the rename operation.
35287  After that the document is renamed,
35288  both locally and in the repository.
35289  If the parent directories of the new and old file names differ,
35290  all relative paths of included files are adjusted (like in
35291 \family sans
35292 File\SpecialChar menuseparator
35293 Save As
35294 \family default
35295 \SpecialChar ldots
35296 ).
35297  Finally,
35298  the document is reloaded using the new name.
35299 \end_layout
35300
35301 \begin_layout Labeling
35302 \labelwidthstring 00.00.0000
35303 SVN
35304 \begin_inset space ~
35305 \end_inset
35306
35307 commands:
35308
35309 \begin_inset space ~
35310 \end_inset
35311
35312
35313 \begin_inset Newline newline
35314 \end_inset
35315
35316
35317 \begin_inset Flex Code
35318 status collapsed
35319
35320 \begin_layout Plain Layout
35321 svn move -q
35322 \family typewriter
35323
35324 \begin_inset Quotes qld
35325 \end_inset
35326
35327 <file-name>
35328 \begin_inset Quotes qld
35329 \end_inset
35330
35331
35332 \begin_inset Quotes qld
35333 \end_inset
35334
35335 <new-file-name>
35336 \begin_inset Quotes qld
35337 \end_inset
35338
35339
35340 \end_layout
35341
35342 \end_inset
35343
35344
35345 \begin_inset Newline newline
35346 \end_inset
35347
35348
35349 \begin_inset Flex Code
35350 status collapsed
35351
35352 \begin_layout Plain Layout
35353 svn commit
35354 \end_layout
35355
35356 \end_inset
35357
35358
35359 \end_layout
35360
35361 \begin_layout Subsubsection
35362 \begin_inset CommandInset label
35363 LatexCommand label
35364 name "subsec:SVN-Repo-Update"
35365
35366 \end_inset
35367
35368 Update of the local directory checkout from repository
35369 \begin_inset Foot
35370 status collapsed
35371
35372 \begin_layout Plain Layout
35373 Note that this command will work only with subversion
35374 \begin_inset Formula $\geqq1.5$
35375 \end_inset
35376
35377
35378 \end_layout
35379
35380 \end_inset
35381
35382
35383 \end_layout
35384
35385 \begin_layout Standard
35386 All the commands above have one shortcoming – they deal with the current document only.
35387  Once your document contains pictures,
35388  includes external
35389 \begin_inset Flex Code
35390 status collapsed
35391
35392 \begin_layout Plain Layout
35393 .tex
35394 \end_layout
35395
35396 \end_inset
35397
35398  files and so on administration becomes more complicated.
35399  \SpecialChar LyX
35400  now supports updating the whole tree in which resides the document
35401 \begin_inset Foot
35402 status collapsed
35403
35404 \begin_layout Plain Layout
35405 One need to organize the files structure so that all external files are in the same directory or subdirectories of the document.
35406
35407 \end_layout
35408
35409 \end_inset
35410
35411 .
35412  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.
35413
35414 \end_layout
35415
35416 \begin_layout Standard
35417 \begin_inset Flex Code
35418 status collapsed
35419
35420 \begin_layout Plain Layout
35421 Update local directory from repository
35422 \end_layout
35423
35424 \end_inset
35425
35426  command updates the whole directory and in case of merge conflicts local version of the files are left,
35427  so no unintended data loss occurs.
35428  If local changes are detected user is warned before update starts.
35429 \end_layout
35430
35431 \begin_layout Labeling
35432 \labelwidthstring 00.00.0000
35433 SVN
35434 \begin_inset space ~
35435 \end_inset
35436
35437 commands:
35438
35439 \begin_inset space ~
35440 \end_inset
35441
35442
35443 \begin_inset Newline newline
35444 \end_inset
35445
35446
35447 \begin_inset Flex Code
35448 status collapsed
35449
35450 \begin_layout Plain Layout
35451 svn diff $path
35452 \end_layout
35453
35454 \end_inset
35455
35456  (Ask if changes are detected.)
35457 \begin_inset Newline newline
35458 \end_inset
35459
35460
35461 \begin_inset Flex Code
35462 status collapsed
35463
35464 \begin_layout Plain Layout
35465 svn update --accept mine-full $path
35466 \end_layout
35467
35468 \end_inset
35469
35470
35471 \end_layout
35472
35473 \begin_layout Standard
35474 where
35475 \begin_inset Flex Code
35476 status collapsed
35477
35478 \begin_layout Plain Layout
35479 $path
35480 \end_layout
35481
35482 \end_inset
35483
35484  stands for the path to the document.
35485 \end_layout
35486
35487 \begin_layout Subsubsection
35488
35489 \family sans
35490 Show History
35491 \end_layout
35492
35493 \begin_layout Standard
35494 This shows the complete history of the SVN document.
35495  The output of
35496 \family typewriter
35497 svn log
35498 \begin_inset Quotes qld
35499 \end_inset
35500
35501 <file-name>
35502 \begin_inset Quotes qld
35503 \end_inset
35504
35505
35506 \family default
35507  is shown in a browser.
35508 \end_layout
35509
35510 \begin_layout Subsubsection
35511 File Locking
35512 \begin_inset CommandInset label
35513 LatexCommand label
35514 name "subsec:SVN-File-Locking"
35515
35516 \end_inset
35517
35518
35519 \end_layout
35520
35521 \begin_layout Standard
35522 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.
35523  When such a conflict happens it needs manual resolving and one reasonable alternative is to provide some kind of locking mechanism,
35524  which guarantees that only one user is allowed to edit file at the given time.
35525 \end_layout
35526
35527 \begin_layout Standard
35528 SVN has two such mechanisms to provide mutual exclusivity for file access – locks and automatic setting of write permissions (see sec.
35529
35530 \begin_inset CommandInset ref
35531 LatexCommand ref
35532 reference "subsec:Automatical-Locking-Property"
35533 nolink "false"
35534
35535 \end_inset
35536
35537 ) based on
35538 \begin_inset Flex Code
35539 status collapsed
35540
35541 \begin_layout Plain Layout
35542 svn:needs-lock
35543 \end_layout
35544
35545 \end_inset
35546
35547  file svn property
35548 \begin_inset Foot
35549 status collapsed
35550
35551 \begin_layout Plain Layout
35552 \begin_inset Flex URL
35553 status open
35554
35555 \begin_layout Plain Layout
35556
35557 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
35558 \end_layout
35559
35560 \end_inset
35561
35562
35563 \end_layout
35564
35565 \end_inset
35566
35567 .
35568  If this property is detected for a given document \SpecialChar LyX
35569  starts to use SVN locks for document editing automatically and the whole check-in/out mechanism switches to the same regimen as for RCS.
35570  This in particular means there are two different modes of file use in \SpecialChar LyX
35571 :
35572 \end_layout
35573
35574 \begin_layout Itemize
35575 Unlocked state.
35576  The loaded file is in the read-only mode.
35577  For editing on needs to check-out.
35578
35579 \emph on
35580 Check-out
35581 \emph default
35582  consists of updating from the repository and gaining write lock.
35583  If the lock is not possible to obtain,
35584  we remain in unlocked state.
35585 \end_layout
35586
35587 \begin_layout Itemize
35588 Locked state.
35589  The loaded file is in the
35590 \begin_inset Quotes els
35591 \end_inset
35592
35593 normal
35594 \begin_inset Quotes ers
35595 \end_inset
35596
35597  edit mode.
35598  No other user is allowed to edit the file.
35599
35600 \emph on
35601 Check-in
35602 \emph default
35603  consists of commiting changes and releasing write-lock.
35604  If no changes have been made to the document,
35605  no commit will be produced
35606 \begin_inset Foot
35607 status collapsed
35608
35609 \begin_layout Plain Layout
35610 Don't be puzzled by the fact that you will be asked for commit message anyway.
35611 \end_layout
35612
35613 \end_inset
35614
35615  and only the write-lock will be released.
35616 \end_layout
35617
35618 \begin_layout Standard
35619 SVN commands:
35620 \end_layout
35621
35622 \begin_layout Labeling
35623 \labelwidthstring 00.00.0000
35624 Check-in:
35625
35626 \family typewriter
35627  svn commit -q -m"<description>" "<file-name>"
35628 \begin_inset Newline newline
35629 \end_inset
35630
35631 svn unlock "<file-name>"
35632 \end_layout
35633
35634 \begin_layout Labeling
35635 \labelwidthstring 00.00.0000
35636 Check-out:
35637
35638 \family typewriter
35639 svn update "<file-name>"
35640 \begin_inset Newline newline
35641 \end_inset
35642
35643 svn lock "<file-name>"
35644 \end_layout
35645
35646 \begin_layout Subsubsection
35647
35648 \family typewriter
35649 \begin_inset CommandInset label
35650 LatexCommand label
35651 name "subsec:Automatical-Locking-Property"
35652
35653 \end_inset
35654
35655
35656 \family default
35657 Automatic Locking Property
35658 \end_layout
35659
35660 \begin_layout Standard
35661 The above mentioned automatic setting of write permissions of the .lyx file can be set through
35662 \family sans
35663  File\SpecialChar menuseparator
35664 Version
35665 \begin_inset space ~
35666 \end_inset
35667
35668 Control\SpecialChar menuseparator
35669 Use Locking Property
35670 \family default
35671 .
35672  This command is active only when the file is not locked on the svn server (i.e.
35673  you need to check-out before proceeding).
35674 \end_layout
35675
35676 \begin_layout Labeling
35677 \labelwidthstring 00.00.0000
35678 SVN
35679 \begin_inset space ~
35680 \end_inset
35681
35682 commands:
35683 \end_layout
35684
35685 \begin_layout Labeling
35686 \labelwidthstring 00.00.0000
35687 Set:
35688
35689 \family typewriter
35690  svn propset svn:needs-lock ON "<file-name>"
35691 \end_layout
35692
35693 \begin_layout Labeling
35694 \labelwidthstring 00.00.0000
35695 Unset:
35696
35697 \family typewriter
35698 svn propdel svn:needs-lock "<file-name>"
35699 \end_layout
35700
35701 \begin_layout Subsubsection
35702 \begin_inset CommandInset label
35703 LatexCommand label
35704 name "subsec:VCS-Revision-Information"
35705
35706 \end_inset
35707
35708 Revision Information in Documents
35709 \end_layout
35710
35711 \begin_layout Standard
35712 There are more possibilities how to activate revision information in our document.
35713 \end_layout
35714
35715 \begin_layout Itemize
35716 \SpecialChar LyX
35717  supports directly:
35718 \end_layout
35719
35720 \begin_deeper
35721 \begin_layout Itemize
35722 tree revision information (
35723 \begin_inset Flex Code
35724 status collapsed
35725
35726 \begin_layout Plain Layout
35727 vcs-tree-revision
35728 \end_layout
35729
35730 \end_inset
35731
35732 ).
35733  The result is the output of the
35734 \begin_inset Flex Code
35735 status collapsed
35736
35737 \begin_layout Plain Layout
35738 svnversion
35739 \end_layout
35740
35741 \end_inset
35742
35743  command,
35744  the following table gives you an idea,
35745  how to read the results.
35746 \end_layout
35747
35748 \begin_layout Standard
35749 \align center
35750 \begin_inset Tabular
35751 <lyxtabular version="3" rows="6" columns="2">
35752 <features tabularvalignment="middle">
35753 <column alignment="left" valignment="top">
35754 <column alignment="left" valignment="top">
35755 <row>
35756 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
35757 \begin_inset Text
35758
35759 \begin_layout Plain Layout
35760
35761 \series bold
35762 Output
35763 \end_layout
35764
35765 \end_inset
35766 </cell>
35767 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
35768 \begin_inset Text
35769
35770 \begin_layout Plain Layout
35771
35772 \series bold
35773 Meaning
35774 \end_layout
35775
35776 \end_inset
35777 </cell>
35778 </row>
35779 <row>
35780 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
35781 \begin_inset Text
35782
35783 \begin_layout Plain Layout
35784 4123:4168
35785 \end_layout
35786
35787 \end_inset
35788 </cell>
35789 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
35790 \begin_inset Text
35791
35792 \begin_layout Plain Layout
35793 mixed revision working copy
35794 \end_layout
35795
35796 \end_inset
35797 </cell>
35798 </row>
35799 <row>
35800 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
35801 \begin_inset Text
35802
35803 \begin_layout Plain Layout
35804 4168M
35805 \end_layout
35806
35807 \end_inset
35808 </cell>
35809 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
35810 \begin_inset Text
35811
35812 \begin_layout Plain Layout
35813 modified working copy
35814 \end_layout
35815
35816 \end_inset
35817 </cell>
35818 </row>
35819 <row>
35820 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
35821 \begin_inset Text
35822
35823 \begin_layout Plain Layout
35824 4123S
35825 \end_layout
35826
35827 \end_inset
35828 </cell>
35829 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
35830 \begin_inset Text
35831
35832 \begin_layout Plain Layout
35833 switched working copy
35834 \end_layout
35835
35836 \end_inset
35837 </cell>
35838 </row>
35839 <row>
35840 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
35841 \begin_inset Text
35842
35843 \begin_layout Plain Layout
35844 4123P
35845 \end_layout
35846
35847 \end_inset
35848 </cell>
35849 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
35850 \begin_inset Text
35851
35852 \begin_layout Plain Layout
35853 partial working copy,
35854  from a sparse checkout
35855 \end_layout
35856
35857 \end_inset
35858 </cell>
35859 </row>
35860 <row>
35861 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
35862 \begin_inset Text
35863
35864 \begin_layout Plain Layout
35865 4123:4168MS
35866 \end_layout
35867
35868 \end_inset
35869 </cell>
35870 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
35871 \begin_inset Text
35872
35873 \begin_layout Plain Layout
35874 mixed revision,
35875  modified,
35876  switched working copy
35877 \end_layout
35878
35879 \end_inset
35880 </cell>
35881 </row>
35882 </lyxtabular>
35883
35884 \end_inset
35885
35886
35887 \end_layout
35888
35889 \begin_layout Itemize
35890 file revision information.
35891  The result comes from parsing the output of
35892 \begin_inset Flex Code
35893 status collapsed
35894
35895 \begin_layout Plain Layout
35896 svn
35897 \begin_inset space ~
35898 \end_inset
35899
35900 info
35901 \begin_inset space ~
35902 \end_inset
35903
35904 --xml
35905 \begin_inset space ~
35906 \end_inset
35907
35908 file.lyx
35909 \end_layout
35910
35911 \end_inset
35912
35913 .
35914  Supported flags are:
35915 \end_layout
35916
35917 \begin_deeper
35918 \begin_layout Itemize
35919 version number of the last commit (
35920 \begin_inset Flex Code
35921 status collapsed
35922
35923 \begin_layout Plain Layout
35924 vcs-revision
35925 \end_layout
35926
35927 \end_inset
35928
35929 )
35930 \end_layout
35931
35932 \begin_layout Itemize
35933 author of the last commit (
35934 \begin_inset Flex Code
35935 status collapsed
35936
35937 \begin_layout Plain Layout
35938 vcs-author
35939 \end_layout
35940
35941 \end_inset
35942
35943 )
35944 \end_layout
35945
35946 \begin_layout Itemize
35947 date of the last commit (
35948 \begin_inset Flex Code
35949 status collapsed
35950
35951 \begin_layout Plain Layout
35952 vcs-date
35953 \end_layout
35954
35955 \end_inset
35956
35957 )
35958 \end_layout
35959
35960 \begin_layout Itemize
35961 time of the last commit (
35962 \begin_inset Flex Code
35963 status collapsed
35964
35965 \begin_layout Plain Layout
35966 vcs-time
35967 \end_layout
35968
35969 \end_inset
35970
35971 )
35972 \end_layout
35973
35974 \end_deeper
35975 \begin_layout Standard
35976 You can obtain this info via InsetInfo (
35977 \change_inserted 5863208 1564400022
35978 Insert\SpecialChar menuseparator
35979 Field\SpecialChar menuseparator
35980 Version Control Revision
35981 \change_deleted 5863208 1564399852
35982 e.g.
35983
35984 \begin_inset Flex Code
35985 status collapsed
35986
35987 \begin_layout Plain Layout
35988 info-insert buffer vcs-date
35989 \end_layout
35990
35991 \end_inset
35992
35993
35994 \change_unchanged
35995 ).
35996  The information will be available only when you have the file stored under svn managment (i.e.
35997  the
35998 \begin_inset Flex Code
35999 status collapsed
36000
36001 \begin_layout Plain Layout
36002 .svn
36003 \end_layout
36004
36005 \end_inset
36006
36007  directory is available with your document).
36008 \end_layout
36009
36010 \end_deeper
36011 \begin_layout Itemize
36012 Another—
36013 a hacking one—
36014 possibility is to use svn keywords
36015 \begin_inset Foot
36016 status collapsed
36017
36018 \begin_layout Plain Layout
36019 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
36020 \end_layout
36021
36022 \end_inset
36023
36024 .
36025  In short – you set file keywords property (e.g.
36026
36027 \family sans
36028 svn propset svn:keywords 'Rev' file.lyx
36029 \family default
36030 ) and then paste keyword \SpecialChar TeX
36031  code
36032 \begin_inset Foot
36033 status collapsed
36034
36035 \begin_layout Plain Layout
36036 This is an easy way how to ensure that \SpecialChar LyX
36037  won't break the line in the middle of keyword tag.
36038 \end_layout
36039
36040 \end_inset
36041
36042  tag in your document (e.g.
36043
36044 \begin_inset Flex Code
36045 status collapsed
36046
36047 \begin_layout Plain Layout
36048 $Rev$
36049 \end_layout
36050
36051 \end_inset
36052
36053 ).
36054  This way svn client will automatically substitute revision number (e.g.
36055
36056 \begin_inset Flex Code
36057 status collapsed
36058
36059 \begin_layout Plain Layout
36060 $Rev:
36061  59 $
36062 \end_layout
36063
36064 \end_inset
36065
36066 ) after each update and commit.
36067  There are more problems with this approach.
36068  Firstly,
36069  the '$' character is used in \SpecialChar TeX
36070  world for math equations,
36071  so any occurence of math formula
36072 \begin_inset Formula $Rev$
36073 \end_inset
36074
36075  become
36076 \begin_inset Formula $Rev:59$
36077 \end_inset
36078
36079  in your \SpecialChar LyX
36080  document.
36081  Similarly for other keywords like Id,
36082  Date,
36083  Author,
36084  etc.
36085  Secondly svn output is dependent on your locales,
36086  so its very easy that svn would produce some problematic strings once Date is used.
36087  Thirdly you get the whole 'Rev:
36088  59' string in your document instead of the plain number.
36089  Until subversion implements user's custom keywords it will be hard to use this approach reliably or let \SpecialChar LyX
36090  to support it directly.
36091 \end_layout
36092
36093 \begin_layout Subsection
36094 SVN and Windows Environment
36095 \end_layout
36096
36097 \begin_layout Quote
36098 My inclination is to say that if the user cannot figure out the command line operations on their own fairly quickly,
36099  they would be well advised to use TortoiseSVN.
36100  —
36101 P.
36102  A.
36103  Rubin
36104 \end_layout
36105
36106 \begin_layout Subsubsection
36107 Preparation
36108 \end_layout
36109
36110 \begin_layout Standard
36111 In addition to installing \SpecialChar LyX
36112 ,
36113  and having access to a Subversion repository,
36114  the user will need to install the Subversion client program.
36115  A Windows installer for the client program is available from
36116 \begin_inset CommandInset href
36117 LatexCommand href
36118 name "CollabNet"
36119 target "http://www.collab.net/nonav/downloads/subversion/"
36120 literal "false"
36121
36122 \end_inset
36123
36124 .
36125  The user may also want to install
36126 \begin_inset CommandInset href
36127 LatexCommand href
36128 name "TortoiseSVN"
36129 target "http://tortoisesvn.tigris.org/"
36130 literal "false"
36131
36132 \end_inset
36133
36134 ,
36135  which integrates Subversion operations into the context (rightclick) menu of Windows Explorer.
36136  Operations done outside \SpecialChar LyX
36137  will typically be more convenient using the Explorer context menu.
36138  Note that TortoiseSVN is not a replacement for the client program,
36139  which is what \SpecialChar LyX
36140  itself will use.
36141 \end_layout
36142
36143 \begin_layout Subsubsection
36144 Bringing a document under Subversion control
36145 \end_layout
36146
36147 \begin_layout Standard
36148 Before a \SpecialChar LyX
36149  document can be brought under version control in Subversion,
36150  its parent directory needs to be under version control.
36151  If the document is being added to a project already in the repository,
36152  this is accomplished by checking the project out to the directory where the new document will be placed.
36153  If the project itself is not yet under version control (for instance,
36154  if this document starts a new project),
36155  the directory must be imported into the repository.
36156  This is done outside \SpecialChar LyX
36157 .
36158  Both import and checkout are easily accomplished from the Explorer context menu using TortoiseSVN,
36159  or alternatively can be done using the command line client at a DOS prompt.
36160  The procedure for importing the project using TortoiseSVN is described below,
36161  assuming an existing repository and a new project being started in
36162 \family typewriter
36163 C:
36164 \backslash
36165 new project
36166 \family default
36167 .
36168  For information on using the Subversion client program,
36169  run
36170 \family typewriter
36171 svn --help
36172 \family default
36173 in a DOS shell.
36174 \end_layout
36175
36176 \begin_layout Enumerate
36177 Locate
36178 \family typewriter
36179 C:
36180 \backslash
36181 new project
36182 \family default
36183 in Windows Explorer,
36184  right click it,
36185  and select
36186 \family sans
36187 TortoiseSVN\SpecialChar menuseparator
36188 Repo-browser
36189 \family default
36190 .
36191  If necessary,
36192  adjust the URL for the repository,
36193  then click OK.
36194 \end_layout
36195
36196 \begin_layout Enumerate
36197 Right click the level of the repository under which you want to place the new project folder (typically the top level) and click
36198 \family sans
36199 Create folder
36200 \family default
36201  Supply a name for the project folder and click OK.
36202  Add a message for the log file if desired,
36203  then click OK again.
36204  The new project folder should appear in the repository.
36205  Finally,
36206  click OK again to exit the repository browser.
36207 \end_layout
36208
36209 \begin_layout Enumerate
36210 Once again right click
36211 \family typewriter
36212 C:
36213 \backslash
36214 new project
36215 \family default
36216 ,
36217  this time selecting SVN Checkout\SpecialChar ldots
36218  Select the URL of the project folder you just created in the repository,
36219  and set the checkout directory to
36220 \family typewriter
36221 C:
36222 \backslash
36223 new project.
36224
36225 \family default
36226  Click OK.
36227  You will be warned about a non-empty folder;
36228  click OK to proceed.
36229  You should now have a
36230 \family typewriter
36231 .svn
36232 \family default
36233  directory under
36234 \family typewriter
36235 C:
36236 \backslash
36237 new project.
36238 \end_layout
36239
36240 \begin_layout Enumerate
36241 Create or open your document in \SpecialChar LyX
36242  and click
36243 \family sans
36244 File\SpecialChar menuseparator
36245 Version
36246 \begin_inset space ~
36247 \end_inset
36248
36249 Control\SpecialChar menuseparator
36250 Register.
36251
36252 \family default
36253 Add a log message and click OK to commit the document to version control.
36254 \end_layout
36255
36256 \begin_layout Standard
36257 From this point onward,
36258  you should have full functionality in the
36259 \family sans
36260 File\SpecialChar menuseparator
36261 Version
36262 \begin_inset space ~
36263 \end_inset
36264
36265 Control
36266 \family default
36267  menu.
36268  You also have the option of checking the document in and out,
36269  viewing its history,
36270  etc.
36271  using the TortoiseSVN context menu in Windows Explorer or the Subversion client program from a command prompt.
36272 \end_layout
36273
36274 \begin_layout Subsubsection
36275 SSH tunnel used with SVN under Windows
36276 \end_layout
36277
36278 \begin_layout Standard
36279 Compared with Linux setting up an svn client to communicate over ssh under Windows is a rather troublesome task.
36280  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,
36281  also be prepared for a great deal of frustration\SpecialChar ldots
36282
36283 \end_layout
36284
36285 \begin_layout Enumerate
36286 Get an svn client for windows,
36287  as described in the previous sections.
36288  When it is a fresh install run some svn command (e.g.
36289
36290 \begin_inset Flex Code
36291 status collapsed
36292
36293 \begin_layout Plain Layout
36294 svn --version
36295 \end_layout
36296
36297 \end_inset
36298
36299 ) to create config files,
36300  which you will need to change later on.
36301 \end_layout
36302
36303 \begin_layout Enumerate
36304 Choose an ssh client for Windows.
36305  There are several possibilities,
36306  we will use the one from Putty tools
36307 \begin_inset Foot
36308 status collapsed
36309
36310 \begin_layout Plain Layout
36311 \begin_inset Flex URL
36312 status collapsed
36313
36314 \begin_layout Plain Layout
36315
36316 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
36317 \end_layout
36318
36319 \end_inset
36320
36321
36322 \end_layout
36323
36324 \end_inset
36325
36326 .
36327  You will need to set the connection up so that the client doesn't ask for any password from you.
36328  To keep things easy we will use only keys without any additional password protection etc.
36329 \end_layout
36330
36331 \begin_deeper
36332 \begin_layout Enumerate
36333 Generate keys by
36334 \begin_inset Flex Code
36335 status collapsed
36336
36337 \begin_layout Plain Layout
36338 puttygen
36339 \end_layout
36340
36341 \end_inset
36342
36343 .
36344  Save your private .ppk key file and put the public one on the server side.
36345  If the SVN server runs on Linux,
36346  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
36347 \begin_inset Quotes eld
36348 \end_inset
36349
36350
36351 \emph on
36352 Public key for pasting into OpenSSH authorized_keys file
36353 \emph default
36354 :
36355 \begin_inset Quotes erd
36356 \end_inset
36357
36358  edit field into the server's
36359 \begin_inset Flex Code
36360 status collapsed
36361
36362 \begin_layout Plain Layout
36363 ~/.ssh/authorized_keys
36364 \end_layout
36365
36366 \end_inset
36367
36368  /
36369 \begin_inset Flex Code
36370 status collapsed
36371
36372 \begin_layout Plain Layout
36373 authorized_keys2
36374 \end_layout
36375
36376 \end_inset
36377
36378  file.
36379 \end_layout
36380
36381 \begin_layout Enumerate
36382 Get the Putty's
36383 \begin_inset Flex Code
36384 status collapsed
36385
36386 \begin_layout Plain Layout
36387 plink
36388 \end_layout
36389
36390 \end_inset
36391
36392 .
36393  In the SVN config file
36394 \begin_inset Foot
36395 status collapsed
36396
36397 \begin_layout Plain Layout
36398 Exact path depends on Windows version,
36399  usually somewhere around
36400 \begin_inset Flex Code
36401 status collapsed
36402
36403 \begin_layout Plain Layout
36404 c:
36405 \backslash
36406 Documents and Settings
36407 \backslash
36408 user
36409 \backslash
36410 Application Data
36411 \backslash
36412 Subversion
36413 \backslash
36414 config
36415 \end_layout
36416
36417 \end_inset
36418
36419  /
36420 \begin_inset Flex Code
36421 status collapsed
36422
36423 \begin_layout Plain Layout
36424 AppData
36425 \backslash
36426 Roaming
36427 \backslash
36428 Subversion
36429 \end_layout
36430
36431 \end_inset
36432
36433 .
36434 \end_layout
36435
36436 \end_inset
36437
36438 ,
36439  section [tunnels],
36440  setup ssh command,
36441  e.g.
36442
36443 \begin_inset Flex Code
36444 status collapsed
36445
36446 \begin_layout Plain Layout
36447 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
36448 \end_layout
36449
36450 \end_inset
36451
36452 .
36453 \begin_inset Foot
36454 status collapsed
36455
36456 \begin_layout Plain Layout
36457 It will usually take a lot of time to get exact command right and it depends on many things.
36458  For example do not have some remote server saved as a default session in Putty etc.
36459  If things fail,
36460  try to connect via plink without SVN first.
36461 \end_layout
36462
36463 \end_inset
36464
36465
36466 \end_layout
36467
36468 \end_deeper
36469 \begin_layout Enumerate
36470 Checkout the SVN archive,
36471  e.
36472 \begin_inset space \thinspace{}
36473 \end_inset
36474
36475 g.
36476 \begin_inset Newline newline
36477 \end_inset
36478
36479
36480 \begin_inset Flex Code
36481 status collapsed
36482
36483 \begin_layout Plain Layout
36484 svn co svn+ssh://user@server/repository_path
36485 \end_layout
36486
36487 \end_inset
36488
36489 .
36490 \end_layout
36491
36492 \begin_layout Subsubsection
36493 End-of-Line Conversions
36494 \end_layout
36495
36496 \begin_layout Standard
36497 When the collaborators are mixing Linux and Windows environments,
36498  \SpecialChar LyX
36499  will use different line endings inside the .lyx files.
36500  This is not a problem as far as \SpecialChar LyX
36501  functionality is concerned,
36502  but the commit diffs will be huge and merge-conflicts prone.
36503  Fortunately SVN itself knows
36504 \begin_inset Foot
36505 status collapsed
36506
36507 \begin_layout Plain Layout
36508 \begin_inset Flex URL
36509 status collapsed
36510
36511 \begin_layout Plain Layout
36512
36513 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
36514 \end_layout
36515
36516 \end_inset
36517
36518
36519 \end_layout
36520
36521 \end_inset
36522
36523  how to deal with CR/LF problems when switching .lyx files to the
36524 \begin_inset Flex Code
36525 status collapsed
36526
36527 \begin_layout Plain Layout
36528 native
36529 \end_layout
36530
36531 \end_inset
36532
36533  mode.
36534 \begin_inset Foot
36535 status collapsed
36536
36537 \begin_layout Plain Layout
36538 For the lazy guys:
36539
36540 \begin_inset Flex Code
36541 status collapsed
36542
36543 \begin_layout Plain Layout
36544 svn propset svn:eol-style native FILE_NAME
36545 \end_layout
36546
36547 \end_inset
36548
36549
36550 \end_layout
36551
36552 \end_inset
36553
36554
36555 \end_layout
36556
36557 \begin_layout Subsection
36558 GIT commands in \SpecialChar LyX
36559
36560 \end_layout
36561
36562 \begin_layout Standard
36563 A minimal subset of GIT commands is now supported by \SpecialChar LyX
36564 .
36565  You can find the commands in the
36566 \family sans
36567 File\SpecialChar menuseparator
36568 Version
36569 \begin_inset space ~
36570 \end_inset
36571
36572 Control
36573 \family default
36574  submenu.
36575  Please note that if you use password protected access to repository via ssh,
36576  you will be asked in terminal window.
36577  \SpecialChar LyX
36578  was tested against GIT 1.7.
36579 \begin_inset Foot
36580 status collapsed
36581
36582 \begin_layout Plain Layout
36583 Windows users please note that you need to ensure that git is on the path.
36584  This can be set from within \SpecialChar LyX
36585  at
36586 \family sans
36587 Tools\SpecialChar menuseparator
36588 Preferences\SpecialChar menuseparator
36589 Paths\SpecialChar menuseparator
36590 PATH prefix
36591 \family default
36592 .
36593 \end_layout
36594
36595 \end_inset
36596
36597
36598 \end_layout
36599
36600 \begin_layout Standard
36601 One big difference of GIT and the other supported version control systems is the distributed nature of GIT:
36602  With traditional version control systems there is one central server which hosts the repository.
36603  Users commit their changes to the server,
36604  and get updates made by other users from it.
36605  With GIT,
36606  users commit to a local repository.
36607  The local repository can be synchronized with one or more remote repositories using the
36608 \begin_inset Flex Code
36609 status collapsed
36610
36611 \begin_layout Plain Layout
36612 pull
36613 \end_layout
36614
36615 \end_inset
36616
36617  and
36618 \begin_inset Flex Code
36619 status collapsed
36620
36621 \begin_layout Plain Layout
36622 push
36623 \end_layout
36624
36625 \end_inset
36626
36627  GIT commands.
36628  \SpecialChar LyX
36629  does not interact in any way with remote GIT repositories.
36630  It works exclusively with the local repository in a very similar way as with a central CVS or SVN repository.
36631  If you use remote GIT repositories you need to do the
36632 \begin_inset Flex Code
36633 status collapsed
36634
36635 \begin_layout Plain Layout
36636 pull
36637 \end_layout
36638
36639 \end_inset
36640
36641  and
36642 \begin_inset Flex Code
36643 status collapsed
36644
36645 \begin_layout Plain Layout
36646 push
36647 \end_layout
36648
36649 \end_inset
36650
36651  operations with your favourite GIT client.
36652 \end_layout
36653
36654 \begin_layout Subsubsection
36655
36656 \family sans
36657 Register
36658 \end_layout
36659
36660 \begin_layout Standard
36661 If your document is not under revision control,
36662  this is the only item shown in the menu.
36663  And if it is under revision control,
36664  the
36665 \family sans
36666 Register
36667 \family default
36668  item is not visible.
36669 \end_layout
36670
36671 \begin_layout Standard
36672 This command registers in GIT your document ONLY in case you have already the documents directory under GIT control (in particular
36673 \family typewriter
36674 .git/index
36675 \family default
36676  file exists).
36677  This means you have to checkout the archive by yourself.
36678 \end_layout
36679
36680 \begin_layout Standard
36681 Then you are asked interactively to supply an initial description of the document.
36682  Don't forget that registered file is not yet committed.
36683 \end_layout
36684
36685 \begin_layout Standard
36686 GIT command that is run:
36687
36688 \family typewriter
36689 git add
36690 \begin_inset Quotes qld
36691 \end_inset
36692
36693 <file-name>
36694 \begin_inset Quotes qld
36695 \end_inset
36696
36697
36698 \end_layout
36699
36700 \begin_layout Standard
36701 Read
36702 \family typewriter
36703 man git
36704 \family default
36705  to understand the switches.
36706 \end_layout
36707
36708 \begin_layout Subsubsection
36709
36710 \family sans
36711 Check In Changes
36712 \end_layout
36713
36714 \begin_layout Standard
36715 When you are finished editing a file,
36716  you commit your changes.
36717  When you do this,
36718  you are asked for a description of the changes.
36719  After that changes are committed.
36720 \end_layout
36721
36722 \begin_layout Standard
36723 GIT command:
36724
36725 \family typewriter
36726 git commit -q -m"<description>" <file-name>
36727 \end_layout
36728
36729 \begin_layout Subsubsection
36730
36731 \family sans
36732 Revert To Repository Version
36733 \end_layout
36734
36735 \begin_layout Standard
36736 This will discard all changes made to the document since the last check in.
36737  You get a warning before changes are discarded.
36738 \end_layout
36739
36740 \begin_layout Standard
36741 GIT command:
36742
36743 \family typewriter
36744 git checkout -q
36745 \begin_inset Quotes qld
36746 \end_inset
36747
36748 <file-name>
36749 \begin_inset Quotes qld
36750 \end_inset
36751
36752
36753 \end_layout
36754
36755 \begin_layout Subsubsection
36756
36757 \family sans
36758 Rename
36759 \end_layout
36760
36761 \begin_layout Standard
36762 This will rename the current document including the version history.
36763  It requires a clean document without any changes since the last checkin.
36764  You are asked for a file name and a description of the rename operation.
36765  After that the document is renamed,
36766  both locally and in the repository.
36767  If the parent directories of the new and old file names differ,
36768  all relative paths of included files are adjusted (like in
36769 \family sans
36770 File\SpecialChar menuseparator
36771 Save As
36772 \family default
36773 \SpecialChar ldots
36774 ).
36775  Finally,
36776  the document is reloaded using the new name.
36777 \end_layout
36778
36779 \begin_layout Labeling
36780 \labelwidthstring 00.00.0000
36781 GIT
36782 \begin_inset space ~
36783 \end_inset
36784
36785 commands:
36786
36787 \begin_inset space ~
36788 \end_inset
36789
36790
36791 \begin_inset Newline newline
36792 \end_inset
36793
36794
36795 \begin_inset Flex Code
36796 status collapsed
36797
36798 \begin_layout Plain Layout
36799 git mv
36800 \family typewriter
36801
36802 \begin_inset Quotes qld
36803 \end_inset
36804
36805 <file-name>
36806 \begin_inset Quotes qld
36807 \end_inset
36808
36809
36810 \begin_inset Quotes qld
36811 \end_inset
36812
36813 <new-file-name>
36814 \begin_inset Quotes qld
36815 \end_inset
36816
36817
36818 \end_layout
36819
36820 \end_inset
36821
36822
36823 \begin_inset Newline newline
36824 \end_inset
36825
36826
36827 \begin_inset Flex Code
36828 status collapsed
36829
36830 \begin_layout Plain Layout
36831 git commit
36832 \end_layout
36833
36834 \end_inset
36835
36836
36837 \end_layout
36838
36839 \begin_layout Subsubsection
36840
36841 \family sans
36842 Show History
36843 \end_layout
36844
36845 \begin_layout Standard
36846 This shows the complete history of the GIT document.
36847  The output of
36848 \family typewriter
36849 git log
36850 \begin_inset Quotes qld
36851 \end_inset
36852
36853 <file-name>
36854 \begin_inset Quotes qld
36855 \end_inset
36856
36857
36858 \family default
36859  is shown in a browser.
36860 \end_layout
36861
36862 \begin_layout Subsubsection
36863 Version Info
36864 \end_layout
36865
36866 \begin_layout Standard
36867 \SpecialChar LyX
36868  supports GIT hash number of the last commit to the file,
36869
36870 \change_inserted 1119979965 1564297456
36871 its abbreviated form,
36872
36873 \change_unchanged
36874 author name,
36875  date and time of last commit.
36876  All those are extracted from
36877 \family typewriter
36878 git log -n 1 --pretty=format:%H%n
36879 \change_inserted 1119979965 1564297427
36880 %h%n
36881 \change_unchanged
36882 %an%n%ai
36883 \family default
36884 .
36885  Tree version information is obtained via
36886 \family typewriter
36887 git describe --abbrev --dirty --long
36888 \family default
36889 .
36890  See
36891 \begin_inset CommandInset ref
36892 LatexCommand ref
36893 reference "subsec:VCS-Revision-Information"
36894 nolink "false"
36895
36896 \end_inset
36897
36898  for other details.
36899 \end_layout
36900
36901 \begin_layout Subsection
36902 Further tuning
36903 \end_layout
36904
36905 \begin_layout Standard
36906 With the recent addition of the
36907 \begin_inset Flex Code
36908 status collapsed
36909
36910 \begin_layout Plain Layout
36911 vc-command
36912 \end_layout
36913
36914 \end_inset
36915
36916  function \SpecialChar LyX
36917  power users are allowed to create their own commands for revision control.
36918 \end_layout
36919
36920 \begin_layout Standard
36921 As an example you can see how two TortoiseSVN commands could be integrated directly:
36922 \end_layout
36923
36924 \begin_layout Description
36925 Commit:
36926
36927 \begin_inset Flex Code
36928 status collapsed
36929
36930 \begin_layout Plain Layout
36931 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
36932 \end_layout
36933
36934 \end_inset
36935
36936
36937 \end_layout
36938
36939 \begin_layout Description
36940 Revert:
36941
36942 \begin_inset Flex Code
36943 status collapsed
36944
36945 \begin_layout Plain Layout
36946 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
36947 \end_layout
36948
36949 \end_inset
36950
36951
36952 \end_layout
36953
36954 \begin_layout Subsection
36955 Version control and Document comparison
36956 \end_layout
36957
36958 \begin_layout Standard
36959 One of the typical uses of version control is to inspect the changes between revisions,
36960  usually by creating
36961 \begin_inset Flex Code
36962 status collapsed
36963
36964 \begin_layout Plain Layout
36965 diff
36966 \end_layout
36967
36968 \end_inset
36969
36970  dumps.
36971  While this is useful for plain text files,
36972  it is much less useful in the case of \SpecialChar LyX
36973  files,
36974  which have more a complicated structure.
36975  Hence we provide binding to the Document comparison feature.
36976  There are two ways of calling this feature – either by direct call of
36977 \begin_inset Flex Code
36978 status collapsed
36979
36980 \begin_layout Plain Layout
36981 vc-compare
36982 \end_layout
36983
36984 \end_inset
36985
36986  \SpecialChar LyX
36987  function (for details see \SpecialChar LyX
36988  functions manual) or by the toolbar icon
36989 \begin_inset Info
36990 type  "icon"
36991 arg   "vc-compare"
36992 \end_inset
36993
36994  or the menu item
36995 \begin_inset Info
36996 type  "menu"
36997 arg   "vc-compare"
36998 \end_inset
36999
37000 ,
37001  respectively.
37002  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 '
37003 \begin_inset Flex Noun
37004 status collapsed
37005
37006 \begin_layout Plain Layout
37007 0
37008 \end_layout
37009
37010 \end_inset
37011
37012 ' revisions back means comparison of the edited file with last commited revision).
37013
37014 \end_layout
37015
37016 \begin_layout Standard
37017 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,
37018  numbers always point to the last number in RCS revision number,
37019  i.e.
37020  '35' in '1.2.35'.
37021  We don't currently support GIT addressing of revisions,
37022  one can just compare edited document with its revision X steps backs,
37023  where X is addressed as
37024 \begin_inset Flex Code
37025 status collapsed
37026
37027 \begin_layout Plain Layout
37028 HEAD~X
37029 \end_layout
37030
37031 \end_inset
37032
37033 .
37034 \end_layout
37035
37036 \begin_layout Section
37037
37038 \change_inserted 564990737 1672161575
37039 \begin_inset CommandInset label
37040 LatexCommand label
37041 name "sec:Literate-Programming"
37042
37043 \end_inset
37044
37045
37046 \change_unchanged
37047 Literate Programming
37048 \end_layout
37049
37050 \begin_layout Standard
37051 Updated by
37052 \noun on
37053 Kayvan Sylvan
37054 \noun default
37055 (kayvan@sylvan.com)
37056 \noun on
37057 ,
37058
37059 \noun default
37060 original documentation written by
37061 \noun on
37062 Edmar Wienskoski Jr.
37063
37064 \noun default
37065  (edmar-w-jr@technologist.com)
37066 \end_layout
37067
37068 \begin_layout Subsection
37069 Introduction
37070 \end_layout
37071
37072 \begin_layout Standard
37073 The main purpose of this documentation is to show you how to use \SpecialChar LyX
37074  for literate programming,
37075  where it is assumed that you are familiar with this programming technique,
37076  and know what
37077 \begin_inset Quotes eld
37078 \end_inset
37079
37080 tangling
37081 \begin_inset Quotes erd
37082 \end_inset
37083
37084  and
37085 \begin_inset Quotes eld
37086 \end_inset
37087
37088 weaving
37089 \begin_inset Quotes erd
37090 \end_inset
37091
37092  means.
37093  If that is not the case,
37094  please follow the web links provided in the following sections.
37095  There is a lot of good documentation out there covering old development history to the latest tools tips.
37096 \end_layout
37097
37098 \begin_layout Standard
37099 It is also assumed that you are familiar with \SpecialChar LyX
37100  itself to a point that you are comfortable changing your \SpecialChar LyX
37101  preferences,
37102  and X resources file.
37103  If that is not the case please refer to other \SpecialChar LyX
37104  documentation to cover your specific needs.
37105 \end_layout
37106
37107 \begin_layout Subsection
37108 Literate Programming
37109 \end_layout
37110
37111 \begin_layout Standard
37112 From the Literate Programming FAQ:
37113
37114 \end_layout
37115
37116 \begin_layout Quotation
37117 Literate programming is the combination of documentation and source together in a fashion suited for reading by human beings.
37118  In fact,
37119  literate programs should be enjoyable reading,
37120  even inviting!
37121  (Sorry Bob,
37122  I couldn't resist!) In general,
37123  literate programs combine source and documentation in a single file.
37124  Literate programming tools then parse the file to produce either readable documentation or compilable source.
37125  The WEB style of literate programming was created by D.
37126 \begin_inset space \thinspace{}
37127 \end_inset
37128
37129 E.
37130  Knuth during the development of his \SpecialChar TeX
37131  typesetting software.
37132
37133 \end_layout
37134
37135 \begin_layout Standard
37136 Another excerpt says:
37137 \end_layout
37138
37139 \begin_layout Quotation
37140
37141 \emph on
37142 How is literate programming different from verbose commenting?
37143 \end_layout
37144
37145 \begin_layout Quotation
37146 There are three distinguishing characteristics.
37147  In order of importance,
37148  they are:
37149
37150 \end_layout
37151
37152 \begin_deeper
37153 \begin_layout Itemize
37154 flexible order of elaboration
37155 \end_layout
37156
37157 \begin_layout Itemize
37158 automatic support for browsing
37159 \end_layout
37160
37161 \begin_layout Itemize
37162 typeset documentation,
37163  especially diagrams and mathematics
37164 \end_layout
37165
37166 \end_deeper
37167 \begin_layout Standard
37168 Now that I sparked your curiosity,
37169  take a look in the references.
37170 \end_layout
37171
37172 \begin_layout Subsubsection
37173 References
37174 \end_layout
37175
37176 \begin_layout Standard
37177 The complete Literate Programming FAQ can be found at:
37178 \end_layout
37179
37180 \begin_layout Quote
37181 Literate Programming FAQ
37182 \begin_inset Flex URL
37183 status open
37184
37185 \begin_layout Plain Layout
37186
37187 http://www.literateprogramming.com/lpfaq.pdf
37188 \end_layout
37189
37190 \end_inset
37191
37192
37193 \end_layout
37194
37195 \begin_layout Standard
37196 The FAQ lists 23 (twenty three!) different literate programming tools.
37197  Where some are specialized or
37198 \begin_inset Quotes eld
37199 \end_inset
37200
37201 tailored
37202 \begin_inset Quotes erd
37203 \end_inset
37204
37205  for particular programming languages,
37206  while other have general scope.
37207  I selected
37208 \noun on
37209 Noweb
37210 \noun default
37211  for my own use for several reasons:
37212 \end_layout
37213
37214 \begin_layout Itemize
37215 It can generate the documentation either in \SpecialChar LaTeX
37216  or HTML.
37217 \end_layout
37218
37219 \begin_layout Itemize
37220 It has a open architecture,
37221  i.
37222 \begin_inset space \thinspace{}
37223 \end_inset
37224
37225 e.
37226 \begin_inset space \space{}
37227 \end_inset
37228
37229 it is easy to plug in new filters
37230 \begin_inset Foot
37231 status collapsed
37232
37233 \begin_layout Plain Layout
37234
37235 \emph on
37236 Filters
37237 \emph default
37238 are programs that read a given data stream and output a manipulated data stream.
37239  That way,
37240  a WEB file (consisting of literate code) can be turned into a file consisting only of C program code or \SpecialChar LaTeX
37241  code.
37242 \end_layout
37243
37244 \end_inset
37245
37246  and to perform special processing that you may need.
37247
37248 \end_layout
37249
37250 \begin_layout Itemize
37251 There is a good selection of filters available already (the HTML is one of them).
37252 \end_layout
37253
37254 \begin_layout Itemize
37255 It is free.
37256 \end_layout
37257
37258 \begin_layout Standard
37259 The Noweb web page can be found at:
37260
37261 \end_layout
37262
37263 \begin_layout Quote
37264 Noweb home page
37265 \begin_inset Flex URL
37266 status collapsed
37267
37268 \begin_layout Plain Layout
37269
37270 https://www.cs.tufts.edu/~nr/noweb/
37271 \end_layout
37272
37273 \end_inset
37274
37275
37276 \end_layout
37277
37278 \begin_layout Standard
37279 Starting from there you can reach many other interesting links and even some literate program examples.
37280 \end_layout
37281
37282 \begin_layout Subsection
37283 \SpecialChar LyX
37284  and Literate Programming with Noweb
37285 \end_layout
37286
37287 \begin_layout Standard
37288 The \SpecialChar LyX
37289  support for Literate Programming is provided by using the generic \SpecialChar LyX
37290  converters mechanism.
37291  This support is provided in a
37292 \begin_inset Quotes eld
37293 \end_inset
37294
37295 Noweb independent
37296 \begin_inset Quotes erd
37297 \end_inset
37298
37299  way,
37300  i.
37301 \begin_inset space \thinspace{}
37302 \end_inset
37303
37304 e.
37305 \begin_inset space \space{}
37306 \end_inset
37307
37308 you will be able to use this new \SpecialChar LyX
37309  feature with some other literate programming tool of your choice by just changing your \SpecialChar LyX
37310  preferences.
37311 \end_layout
37312
37313 \begin_layout Subsubsection
37314 Generating documents and code (weaving and tangling)
37315 \end_layout
37316
37317 \begin_layout Paragraph
37318 Using the noweb module
37319 \end_layout
37320
37321 \begin_layout Standard
37322 If you have installed Noweb and \SpecialChar LyX
37323  successfully,
37324  whenever you open a new document,
37325  after you have chosen its document class,
37326  use the
37327 \family sans
37328 Document\SpecialChar menuseparator
37329 Settings
37330 \family default
37331  menu to add the
37332 \begin_inset Quotes eld
37333 \end_inset
37334
37335 noweb
37336 \begin_inset Quotes erd
37337 \end_inset
37338
37339  module.
37340  If Noweb is correctly installed,
37341  when you click on the
37342 \begin_inset Quotes eld
37343 \end_inset
37344
37345 Modules
37346 \begin_inset Quotes erd
37347 \end_inset
37348
37349  link,
37350  you will see the
37351 \begin_inset Quotes eld
37352 \end_inset
37353
37354 noweb
37355 \begin_inset Quotes erd
37356 \end_inset
37357
37358  module in the available list and you can add it to your document.
37359 \end_layout
37360
37361 \begin_layout Paragraph
37362 Typing code in
37363 \end_layout
37364
37365 \begin_layout Standard
37366 \SpecialChar LyX
37367  enables you to write code with a custom inset named
37368 \begin_inset Flex Noun
37369 status collapsed
37370
37371 \begin_layout Plain Layout
37372 Chunk
37373 \end_layout
37374
37375 \end_inset
37376
37377 .
37378  Noweb delimits chunks like this:
37379 \end_layout
37380
37381 \begin_layout LyX-Code
37382 <<My code>>=
37383 \end_layout
37384
37385 \begin_layout LyX-Code
37386   code
37387 \end_layout
37388
37389 \begin_layout LyX-Code
37390   more code
37391 \end_layout
37392
37393 \begin_layout LyX-Code
37394   even more code
37395 \end_layout
37396
37397 \begin_layout LyX-Code
37398   @
37399 \end_layout
37400
37401 \begin_layout Standard
37402 The problem is that whatever is written in between the << and the
37403 \family typewriter
37404 @
37405 \family default
37406  must be taken literally,
37407  i.
37408 \begin_inset space \thinspace{}
37409 \end_inset
37410
37411 e.
37412 \begin_inset space \space{}
37413 \end_inset
37414
37415 \SpecialChar LyX
37416  should be prevented from making any special interpretation of what has been written.
37417  This is also handled by
37418 \begin_inset Flex Noun
37419 status collapsed
37420
37421 \begin_layout Plain Layout
37422 Chunk
37423 \end_layout
37424
37425 \end_inset
37426
37427 ,
37428  that works like a normal text inset but has a free spacing capability.
37429 \end_layout
37430
37431 \begin_layout Standard
37432 As a special note,
37433  you can also use the
37434 \begin_inset Quotes eld
37435 \end_inset
37436
37437 %def
37438 \begin_inset Quotes erd
37439 \end_inset
37440
37441  construct of Noweb in your chunks to add items to Noweb's identifier cross-reference:
37442 \end_layout
37443
37444 \begin_layout LyX-Code
37445 <<My chunk>>=
37446 \end_layout
37447
37448 \begin_layout LyX-Code
37449 def some_function(args):
37450 \end_layout
37451
37452 \begin_layout LyX-Code
37453    "This is the doc string for this function."
37454 \end_layout
37455
37456 \begin_layout LyX-Code
37457    print "My args:
37458  ",
37459  args
37460 \end_layout
37461
37462 \begin_layout LyX-Code
37463 @ %def some_function
37464 \end_layout
37465
37466 \begin_layout Standard
37467 For an example of this usage and the resulting cross-reference output,
37468  look at the Literate python program in
37469 \emph on
37470 LIBDIR/examples/listerrors.lyx
37471 \emph default
37472  which should make this all clear.
37473 \end_layout
37474
37475 \begin_layout Paragraph
37476 Generating the documentation
37477 \end_layout
37478
37479 \begin_layout Standard
37480 At this point you already have a new document file with a proper document class,
37481  and with some code and text on it.
37482  How do I print it?
37483  The answer is simple,
37484  you select
37485 \family sans
37486 View\SpecialChar menuseparator
37487 DVI,
37488
37489 \family default
37490  etc.
37491  Just like you would do for a plain document.
37492  No special procedure is required.
37493 \end_layout
37494
37495 \begin_layout Standard
37496 To help orientate you,
37497  I will now explain what happens inside \SpecialChar LyX
37498 :
37499 \end_layout
37500
37501 \begin_layout Enumerate
37502 When the
37503 \family sans
37504 Update\SpecialChar menuseparator
37505 DVI
37506 \family default
37507  menu option is chosen,
37508  a \SpecialChar LaTeX
37509  file is generated.
37510
37511 \end_layout
37512
37513 \begin_deeper
37514 \begin_layout Standard
37515 If the document is of any literate class the generated file will be named with an extension name defined by the
37516 \begin_inset Quotes eld
37517 \end_inset
37518
37519 literate
37520 \begin_inset Quotes erd
37521 \end_inset
37522
37523  format (defined in the Preferences panel),
37524  otherwise the file will have the usual
37525 \family typewriter
37526 .tex
37527 \family default
37528  extension.
37529 \end_layout
37530
37531 \end_deeper
37532 \begin_layout Enumerate
37533 Note that the only difference so far is in the name of the file,
37534  no special processing is required by \SpecialChar LyX
37535 .
37536  Given that you formatted the code using the
37537 \begin_inset Flex Noun
37538 status collapsed
37539
37540 \begin_layout Plain Layout
37541 Chunk
37542 \end_layout
37543
37544 \end_inset
37545
37546  inset that,
37547  by itself,
37548  takes care of the business.
37549 \end_layout
37550
37551 \begin_layout Enumerate
37552 If the document is of any literate class \SpecialChar LyX
37553  will then use the internal \SpecialChar LyX
37554  to Noweb converter,
37555  followed by the Noweb to \SpecialChar LaTeX
37556  converter
37557 \begin_inset Foot
37558 status collapsed
37559
37560 \begin_layout Plain Layout
37561 The converters are defined in the
37562 \family sans
37563 Tools\SpecialChar menuseparator
37564 Preferences
37565 \family default
37566  panel,
37567  under the
37568 \begin_inset Quotes eld
37569 \end_inset
37570
37571 Conversion
37572 \begin_inset Quotes erd
37573 \end_inset
37574
37575  tab.
37576  See section
37577 \emph on
37578 Converters
37579 \emph default
37580  of the
37581 \emph on
37582 Customization
37583 \emph default
37584  manual for general information about converters.
37585 \end_layout
37586
37587 \end_inset
37588
37589  to generate the \SpecialChar LaTeX
37590  file.
37591 \end_layout
37592
37593 \begin_deeper
37594 \begin_layout Standard
37595 Otherwise it will just skip this step.
37596 \end_layout
37597
37598 \end_deeper
37599 \begin_layout Enumerate
37600 Finally,
37601  \SpecialChar LaTeX
37602  is invoked and the regular post processing continues as in a plain document.
37603 \end_layout
37604
37605 \begin_layout Standard
37606 Independence from a particular
37607 \begin_inset Quotes eld
37608 \end_inset
37609
37610 literate tool
37611 \begin_inset Quotes erd
37612 \end_inset
37613
37614  is easily achieved by changing the commands that are run by the various converters.
37615 \end_layout
37616
37617 \begin_layout Paragraph
37618 Generating the code
37619 \end_layout
37620
37621 \begin_layout Standard
37622 When the build menu option is chosen or the corresponding button in the toolbar is pressed,
37623  a \SpecialChar LaTeX
37624  file is generated just like step 1 above.
37625  Next,
37626  \SpecialChar LyX
37627  invokes the
37628 \family typewriter
37629 Noweb->Program
37630 \family default
37631  converter.
37632  This converter needs to be defined by the user and is not installed by default,
37633  though the Program format is.
37634  This converter (like any other converter) will have two parts:
37635 \end_layout
37636
37637 \begin_layout Enumerate
37638 The converter program itself.
37639  This program performs the conversion from the one format to the other (in this case,
37640  from the Noweb format to the Program pseudo-format).
37641 \end_layout
37642
37643 \begin_layout Enumerate
37644 The error log parser.
37645  This is a program whose sole purpose is to rewrite error messages in a format that \SpecialChar LyX
37646  understands.
37647  This makes it possible for \SpecialChar LyX
37648  to place error boxes in the right places in the file buffer.
37649 \end_layout
37650
37651 \begin_layout Standard
37652 The first part,
37653  the
37654 \begin_inset Quotes eld
37655 \end_inset
37656
37657 Converter
37658 \begin_inset Quotes erd
37659 \end_inset
37660
37661  setting,
37662  should be set to
37663 \end_layout
37664
37665 \begin_layout LyX-Code
37666
37667 \family typewriter
37668 build-script $$i
37669 \family default
37670  $$r
37671 \end_layout
37672
37673 \begin_layout Standard
37674 This basically means that \SpecialChar LyX
37675  will call
37676 \begin_inset Quotes eld
37677 \end_inset
37678
37679 build-script
37680 \begin_inset Quotes erd
37681 \end_inset
37682
37683  (a program or script) with the name of the Noweb file (normally a file in the \SpecialChar LyX
37684  temp directory) and the directory path of the original \SpecialChar LyX
37685  file.
37686
37687 \end_layout
37688
37689 \begin_layout Standard
37690 This is an implementation of
37691 \begin_inset Quotes eld
37692 \end_inset
37693
37694 build-script
37695 \begin_inset Quotes erd
37696 \end_inset
37697
37698  that you can place in a directory on your path:
37699 \end_layout
37700
37701 \begin_layout LyX-Code
37702
37703 \family sans
37704 #!/bin/sh
37705 \end_layout
37706
37707 \begin_layout LyX-Code
37708
37709 \family sans
37710 #
37711 \end_layout
37712
37713 \begin_layout LyX-Code
37714
37715 \family sans
37716 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
37717 \end_layout
37718
37719 \begin_layout Standard
37720 The next part of the converter setting is the
37721 \begin_inset Quotes eld
37722 \end_inset
37723
37724 Flags
37725 \begin_inset Quotes erd
37726 \end_inset
37727
37728  which is to be set to
37729 \end_layout
37730
37731 \begin_layout LyX-Code
37732
37733 \family typewriter
37734 parselog=$$s/scripts/listerrors
37735 \end_layout
37736
37737 \begin_layout Standard
37738 This will run any errors that are generated by the
37739 \begin_inset Quotes eld
37740 \end_inset
37741
37742 build-script
37743 \begin_inset Quotes erd
37744 \end_inset
37745
37746  process through the
37747 \begin_inset Quotes eld
37748 \end_inset
37749
37750 listerrors
37751 \begin_inset Quotes erd
37752 \end_inset
37753
37754  program.
37755 \end_layout
37756
37757 \begin_layout Standard
37758 The build will normally take place in \SpecialChar LyX
37759 's temporary directory,
37760  so the files produced by the conversion will be in that directory.
37761  \SpecialChar LyX
37762  will copy out what it regards as the `main' file,
37763  but the
37764 \family typewriter
37765 Noweb->Program
37766 \family default
37767  conversion may produce several files,
37768  and so most of these would then be deleted when \SpecialChar LyX
37769  was closed.
37770  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.
37771 \end_layout
37772
37773 \begin_layout Paragraph
37774 Build instructions in the document
37775 \end_layout
37776
37777 \begin_layout Standard
37778 The last piece of the integration between \SpecialChar LyX
37779  and noweb is the
37780 \begin_inset Quotes eld
37781 \end_inset
37782
37783 build-script
37784 \begin_inset Quotes erd
37785 \end_inset
37786
37787  chunk.
37788  Generally,
37789  the instructions for building your program should be embedded in a chunk of its own.
37790  The noweb-specific
37791 \begin_inset Quotes eld
37792 \end_inset
37793
37794 build-script
37795 \begin_inset Quotes erd
37796 \end_inset
37797
37798  above uses the notangle command to look for this chunk (called
37799 \begin_inset Quotes eld
37800 \end_inset
37801
37802 build-script
37803 \begin_inset Quotes erd
37804 \end_inset
37805
37806 ) and runs its contents through
37807 \begin_inset Quotes eld
37808 \end_inset
37809
37810 sh
37811 \begin_inset Quotes erd
37812 \end_inset
37813
37814 .
37815 \end_layout
37816
37817 \begin_layout Standard
37818 Typically,
37819  such a chunk would look something like this:
37820 \end_layout
37821
37822 \begin_layout LyX-Code
37823 <<build-script>>=
37824 \end_layout
37825
37826 \begin_layout LyX-Code
37827 #!/bin/sh
37828 \begin_inset Newline newline
37829 \end_inset
37830
37831 if [ -z "${NOWEB_SOURCE}" ]
37832 \begin_inset Newline newline
37833 \end_inset
37834
37835 then
37836 \end_layout
37837
37838 \begin_layout LyX-Code
37839 NOWEB_SOURCE=myfile.nw
37840 \begin_inset Newline newline
37841 \end_inset
37842
37843 fi
37844 \begin_inset Newline newline
37845 \end_inset
37846
37847 [...
37848  code to extract files ...
37849  use NOWEB_OUTPUT_DIR here ...]
37850 \begin_inset Newline newline
37851 \end_inset
37852
37853 [...
37854  code to compile files ...]
37855 \begin_inset Newline newline
37856 \end_inset
37857
37858 @
37859 \end_layout
37860
37861 \begin_layout Standard
37862 Look in
37863 \change_deleted 564990737 1672161716
37864
37865 \emph on
37866 LIBDIR/examples/listerrors.lyx
37867 \emph default
37868  or in
37869 \emph on
37870 LIBDIR/examples/Literate.lyx
37871 \change_inserted 564990737 1672161716
37872
37873 \family sans
37874 \emph default
37875 File\SpecialChar menuseparator
37876 Open Example\SpecialChar menuseparator
37877 Modules\SpecialChar menuseparator
37878 Noweb Listerrors
37879 \change_unchanged
37880
37881 \family default
37882  which implement
37883 \change_deleted 564990737 1672161729
37884 two
37885 \change_unchanged
37886 versions of the
37887 \begin_inset Quotes eld
37888 \end_inset
37889
37890 listerrors
37891 \begin_inset Quotes erd
37892 \end_inset
37893
37894  program for some illustrations of how all of these pieces go together or in
37895 \change_deleted 564990737 1672161756
37896
37897 \emph on
37898 LIBDIR/examples/noweb2lyx.lyx
37899 \change_inserted 564990737 1672161756
37900
37901 \family sans
37902 \emph default
37903 File\SpecialChar menuseparator
37904 Open Example\SpecialChar menuseparator
37905 Modules\SpecialChar menuseparator
37906 Noweb2\SpecialChar LyX
37907
37908 \change_unchanged
37909
37910 \family default
37911 \emph on
37912 .
37913
37914 \emph default
37915  Interestingly,
37916  these
37917 \change_deleted 564990737 1672161767
37918 three
37919 \change_unchanged
37920 files show off the language-indepence of the \SpecialChar LyX
37921  literate programming support since they are written in Python
37922 \change_deleted 564990737 1672161782
37923 ,
37924  C
37925 \change_unchanged
37926  and Perl respectively.
37927 \end_layout
37928
37929 \begin_layout Subsubsection
37930 Configuring \SpecialChar LyX
37931
37932 \end_layout
37933
37934 \begin_layout Standard
37935 All the Literate Programming support is configured by the
37936 \family sans
37937 Tools\SpecialChar menuseparator
37938 Preferences
37939 \family default
37940  panel in the
37941 \begin_inset Quotes eld
37942 \end_inset
37943
37944 File Handling
37945 \begin_inset Quotes erd
37946 \end_inset
37947
37948  tab.
37949  The important parts are:
37950 \end_layout
37951
37952 \begin_layout Description
37953 the
37954 \begin_inset space ~
37955 \end_inset
37956
37957
37958 \begin_inset Quotes eld
37959 \end_inset
37960
37961 NoWeb
37962 \begin_inset Quotes erd
37963 \end_inset
37964
37965
37966 \begin_inset space ~
37967 \end_inset
37968
37969 format Set up via the File Formats tab,
37970  this is where the Noweb-specific pieces are set up.
37971  The
37972 \family sans
37973 GUI Name
37974 \family default
37975  is set to
37976 \family typewriter
37977 NoWeb
37978 \family default
37979 ,
37980  the file extension is set to
37981 \family typewriter
37982 .nw
37983 \family default
37984 .
37985  This tells \SpecialChar LyX
37986  to create a file with a
37987 \family typewriter
37988 .nw
37989 \family default
37990  extension in the first step of the conversion process.
37991 \end_layout
37992
37993 \begin_layout Description
37994 the
37995 \begin_inset space ~
37996 \end_inset
37997
37998
37999 \family sans
38000 Program
38001 \family default
38002
38003 \begin_inset space ~
38004 \end_inset
38005
38006 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).
38007 \end_layout
38008
38009 \begin_layout Description
38010
38011 \family sans
38012 NoWeb
38013 \family default
38014 ->
38015 \family sans
38016 \SpecialChar LaTeX
38017
38018 \family default
38019  This converter performs the
38020 \begin_inset Quotes eld
38021 \end_inset
38022
38023 weaving
38024 \begin_inset Quotes erd
38025 \end_inset
38026
38027  of the literate document.
38028  For Noweb,
38029  it is set to
38030 \begin_inset Quotes eld
38031 \end_inset
38032
38033
38034 \family typewriter
38035 noweave -delay -index $$i > $$o
38036 \family default
38037
38038 \begin_inset Quotes erd
38039 \end_inset
38040
38041
38042 \end_layout
38043
38044 \begin_layout Description
38045
38046 \family sans
38047 NoWeb
38048 \family default
38049 ->
38050 \family sans
38051 Program
38052 \family default
38053  This performs the
38054 \begin_inset Quotes eld
38055 \end_inset
38056
38057 tangling step
38058 \begin_inset Quotes erd
38059 \end_inset
38060
38061 .
38062  As stated above,
38063  the Converter is set to
38064 \begin_inset Quotes eld
38065 \end_inset
38066
38067
38068 \family typewriter
38069 build-script $$i
38070 \family default
38071  $$r
38072 \begin_inset Quotes erd
38073 \end_inset
38074
38075 ,
38076  with Flags set to
38077 \begin_inset Newline newline
38078 \end_inset
38079
38080
38081 \begin_inset Quotes eld
38082 \end_inset
38083
38084
38085 \family typewriter
38086 parselog=$$s/scripts/listerrors
38087 \family default
38088
38089 \begin_inset Quotes erd
38090 \end_inset
38091
38092 .
38093 \end_layout
38094
38095 \begin_layout Subsubsection
38096 Debug extensions
38097 \end_layout
38098
38099 \begin_layout Standard
38100 There is also a new function implemented in the \SpecialChar LyX
38101  server,
38102  the
38103 \begin_inset Quotes eld
38104 \end_inset
38105
38106 server-goto-file-row" function,
38107  to be used with ddd/gdb or other debugger.
38108
38109 \end_layout
38110
38111 \begin_layout Standard
38112 When debugging code with ddd/gdb,
38113  it is possible to invoke a text editor at the current execution position with a single key stroke.
38114  The default ddd configuration for that is shift-ctrl-V.
38115  It happens that you can define the editor command line invocation in ddd by accessing the
38116 \family sans
38117 Edit\SpecialChar menuseparator
38118 Preferences\SpecialChar menuseparator
38119 Helpers
38120 \family default
38121  dialog and changing the "Edit Sources" entry.
38122 \end_layout
38123
38124 \begin_layout Standard
38125 I take advantage of the newly created \SpecialChar LyX
38126  server function and this ddd feature,
38127  and set
38128 \begin_inset Quotes eld
38129 \end_inset
38130
38131 Edit Sources
38132 \begin_inset Quotes erd
38133 \end_inset
38134
38135  to:
38136 \end_layout
38137
38138 \begin_layout LyX-Code
38139 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
38140 \end_layout
38141
38142 \begin_layout Standard
38143 With this,
38144  whenever you are using ddd and find a point in the program that you want to edit,
38145  you just press shift-ctrl-V (in the ddd window),
38146  and ddd will forward this information to \SpecialChar LyX
38147  through the \SpecialChar LyX
38148  server and then the \SpecialChar LyX
38149  window will show the same file with the cursor at the same position ddd was pointing to.
38150  No more guessing or long scrolling to locate a point in the program back from debugging !
38151 \end_layout
38152
38153 \begin_layout Standard
38154 Note however that you must enable the \SpecialChar LyX
38155  server to get this feature working (it is disabled by default).
38156  Sec.
38157 \begin_inset space ~
38158 \end_inset
38159
38160
38161 \begin_inset CommandInset ref
38162 LatexCommand ref
38163 reference "sec:Starting-the-Server"
38164 nolink "false"
38165
38166 \end_inset
38167
38168  explains how to do that.
38169 \end_layout
38170
38171 \begin_layout Subsubsection
38172 Toolbar extensions
38173 \end_layout
38174
38175 \begin_layout Standard
38176 There are six new buttons that can be added to your \SpecialChar LyX
38177  toolbar.
38178  Four of these buttons are short cuts to layout styles:
38179
38180 \family sans
38181 Standard
38182 \family default
38183 ,
38184
38185 \family sans
38186 Section
38187 \family default
38188 ,
38189
38190 \family sans
38191 \SpecialChar LaTeX
38192
38193 \family default
38194 ,
38195  and
38196 \family sans
38197 \SpecialChar LyX
38198 -Code
38199 \family default
38200 ,
38201  one for the custom inset
38202 \family sans
38203 Chunk
38204 \family default
38205 .
38206  The last one is a short cut to the
38207 \begin_inset Quotes eld
38208 \end_inset
38209
38210 Build Program
38211 \begin_inset Quotes erd
38212 \end_inset
38213
38214  File menu entry.
38215
38216 \end_layout
38217
38218 \begin_layout Standard
38219 \SpecialChar LyX
38220  has a range of buttons that are available for tool bar customization.
38221  In my toolbar I like to combine the six short cuts above with two more:
38222  One for
38223 \family sans
38224 Document
38225 \family default
38226 \SpecialChar menuseparator
38227
38228 \family sans
38229 Update
38230 \family default
38231 \SpecialChar menuseparator
38232
38233 \family sans
38234 DVI
38235 \family default
38236  and the other for
38237 \family sans
38238 Document\SpecialChar menuseparator
38239 View\SpecialChar menuseparator
38240 DVI
38241 \family default
38242  File menu entries.
38243  Here is how it looks like:
38244 \end_layout
38245
38246 \begin_layout LyX-Code
38247 Toolbar
38248 \end_layout
38249
38250 \begin_layout LyX-Code
38251   Layouts
38252 \end_layout
38253
38254 \begin_layout LyX-Code
38255   Icon "layout Standard"
38256 \end_layout
38257
38258 \begin_layout LyX-Code
38259   Icon "layout Section"
38260 \end_layout
38261
38262 \begin_layout LyX-Code
38263   Icon "layout \SpecialChar LaTeX
38264 "
38265 \end_layout
38266
38267 \begin_layout LyX-Code
38268   Icon "layout \SpecialChar LyX
38269 -Code"
38270 \end_layout
38271
38272 \begin_layout LyX-Code
38273   Icon "flex.insert Chunk"
38274 \end_layout
38275
38276 \begin_layout LyX-Code
38277   Separator
38278 \end_layout
38279
38280 \begin_layout LyX-Code
38281   Icon "buffer-view"
38282 \end_layout
38283
38284 \begin_layout LyX-Code
38285   Icon "buffer-typeset"
38286 \end_layout
38287
38288 \begin_layout LyX-Code
38289   Icon "build-program"
38290 \end_layout
38291
38292 \begin_layout LyX-Code
38293   Separator
38294 \end_layout
38295
38296 \begin_layout LyX-Code
38297 .
38298 \end_layout
38299
38300 \begin_layout LyX-Code
38301 .
38302 \end_layout
38303
38304 \begin_layout LyX-Code
38305 .
38306 \end_layout
38307
38308 \begin_layout LyX-Code
38309 End
38310 \end_layout
38311
38312 \begin_layout Subsubsection
38313 Colors customization
38314 \end_layout
38315
38316 \begin_layout Standard
38317 There are a number of colors in \SpecialChar LyX
38318  that can be customized in
38319 \family sans
38320 Preferences
38321 \family default
38322 .
38323  One of the things that bothers people is the \SpecialChar LaTeX
38324  font color.
38325  The default color is red,
38326  since the chunks uses \SpecialChar LaTeX
38327  font,
38328  and there is a lot of chunks in literate documents,
38329  you may get tired of seeing everything in red.
38330  You can change it by going to the tabs
38331 \family sans
38332 Look&Feel
38333 \family default
38334 ,
38335
38336 \family sans
38337 Colors.
38338 \end_layout
38339
38340 \begin_layout Standard
38341 The next thing is the visible presence of the newline character in the screen.
38342  You can choose the color of this particular character and make it blend in the background.
38343  I recommend you choosing a color that is close to the background but not equal,
38344  that way you still can see it is there,
38345  but it is not bothering you anymore.
38346 \end_layout
38347
38348 \begin_layout Subsection
38349 \SpecialChar LyX
38350  and knitr/Sweave
38351 \end_layout
38352
38353 \begin_layout Standard
38354 Support for
38355 \family sans
38356 knitr
38357 \family default
38358  and
38359 \family sans
38360 Sweave
38361 \family default
38362  is documented in
38363 \change_inserted 564990737 1672161863
38364
38365 \family sans
38366 Help\SpecialChar menuseparator
38367 Specific Manuals\SpecialChar menuseparator
38368 Knitr
38369 \family default
38370  and
38371 \change_unchanged
38372
38373 \change_deleted 564990737 1671643409
38374 the
38375 \emph on
38376 knitr.lyx
38377 \emph default
38378  example file
38379 \change_inserted 564990737 1672161856
38380
38381 \family sans
38382 File\SpecialChar menuseparator
38383 Open Example\SpecialChar menuseparator
38384 Modules\SpecialChar menuseparator
38385 Rnw (knitr)
38386 \change_unchanged
38387
38388 \family default
38389  and in
38390 \change_deleted 564990737 1671643461
38391 the Sweave manual (menu
38392 \family sans
38393 Help\SpecialChar menuseparator
38394 Specific Manuals
38395 \family default
38396 )
38397 \change_inserted 564990737 1672161856
38398
38399 \family sans
38400 Help\SpecialChar menuseparator
38401 Specific Manuals\SpecialChar menuseparator
38402 Sweave
38403 \change_deleted 564990737 1672161921
38404
38405 \family default
38406 .
38407
38408 \change_inserted 564990737 1672161917
38409  and
38410 \family sans
38411 File\SpecialChar menuseparator
38412 Open Example\SpecialChar menuseparator
38413 Modules\SpecialChar menuseparator
38414 Sweave
38415 \family default
38416 .
38417 \change_deleted 564990737 1672742969
38418
38419 \end_layout
38420
38421 \begin_layout Standard
38422
38423 \change_deleted 564990737 1671355343
38424 Special features
38425 \end_layout
38426
38427 \begin_layout Standard
38428
38429 \change_deleted 564990737 1671355343
38430 You can do everything with \SpecialChar LyX
38431  that you can do with \SpecialChar LaTeX
38432 .
38433  However,
38434  \SpecialChar LyX
38435  cannot support every \SpecialChar LaTeX
38436  feature directly.
38437  But you can always use \SpecialChar TeX
38438  Code.
38439  This chapter shows you some more special things you might want to use.
38440  For other special things you can do with figures,
38441  tables,
38442  floats,
38443  boxes and notes,
38444  have a look at the
38445 \emph on
38446 Embedded
38447 \begin_inset space ~
38448 \end_inset
38449
38450 Objects
38451 \emph default
38452  manual.
38453 \change_unchanged
38454
38455 \end_layout
38456
38457 \end_body
38458 \end_document