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 \emph on
6592 article (mwart)
6593 \emph default
6594 ,
6595
6596 \emph on
6597 report (mwrep)
6598 \emph default
6599  and
6600 \emph on
6601 book
6602 \emph default
6603
6604 \emph on
6605 (mwbk)
6606 \emph default
6607  correspond to the \SpecialChar LaTeX
6608  document classes
6609 \family typewriter
6610 mwart.cls
6611 \family default
6612 ,
6613
6614 \family typewriter
6615 mwrep.cls
6616 \family default
6617  and
6618 \family typewriter
6619 mwbk.cls
6620 \family default
6621 ,
6622  resp.
6623  They are replacements for the standard document classes
6624 \family typewriter
6625 article.cls
6626 \family default
6627 ,
6628
6629 \family typewriter
6630 report.cls
6631 \family default
6632  and
6633 \family typewriter
6634 book.cls
6635 \family default
6636 ,
6637  resp.,
6638  and fit better to Polish typography conventions in a number of points.
6639
6640 \end_layout
6641
6642 \begin_layout Standard
6643 Basic differences:
6644 \end_layout
6645
6646 \begin_layout Itemize
6647 Unnumbered titles (with star,
6648  e.
6649 \begin_inset space \thinspace{}
6650 \end_inset
6651
6652 g.
6653 \begin_inset space \space{}
6654 \end_inset
6655
6656
6657 \family sans
6658 Section*
6659 \family default
6660 ) are added into table of contents,
6661 \end_layout
6662
6663 \begin_layout Itemize
6664 Additional page styles:
6665 \end_layout
6666
6667 \begin_deeper
6668 \begin_layout Description
6669 uheadings header with separated lines,
6670 \end_layout
6671
6672 \begin_layout Description
6673 myheadings custom header,
6674  contents headers via commands:
6675
6676 \family typewriter
6677
6678 \backslash
6679 markright
6680 \family default
6681  and
6682 \family typewriter
6683
6684 \backslash
6685 markboth
6686 \family default
6687 ,
6688 \end_layout
6689
6690 \begin_layout Description
6691 myuheadings custom header with separated lines,
6692 \end_layout
6693
6694 \begin_layout Description
6695 outer page number is placed on outer side of page
6696 \end_layout
6697
6698 \end_deeper
6699 \begin_layout Itemize
6700 Options
6701 \end_layout
6702
6703 \begin_deeper
6704 \begin_layout Description
6705 rmheadings serif titles —
6706  default,
6707 \end_layout
6708
6709 \begin_layout Description
6710 sfheadings sansserif titles,
6711 \end_layout
6712
6713 \begin_layout Description
6714 authortitle on title page first placed is author next title —
6715  default,
6716 \end_layout
6717
6718 \begin_layout Description
6719 titleauthor on title page first placed is title next author,
6720 \end_layout
6721
6722 \begin_layout Description
6723 withmarginpar reserve place on page for margins.
6724 \end_layout
6725
6726 \end_deeper
6727 \begin_layout Subsection
6728
6729 \change_inserted 564990737 1672652245
6730 Tufte Collection
6731 \end_layout
6732
6733 \begin_layout Standard
6734
6735 \change_inserted 564990737 1672652245
6736 The document classes
6737 \family sans
6738 book
6739 \begin_inset space \thinspace{}
6740 \end_inset
6741
6742 (Tufte)
6743 \family default
6744  and
6745 \family sans
6746 handout
6747 \begin_inset space \thinspace{}
6748 \end_inset
6749
6750 (Tufte)
6751 \family default
6752  use the
6753 \family typewriter
6754 tufte-book.cls
6755 \family default
6756  and
6757 \family typewriter
6758 tufte-handout.cls
6759 \family default
6760  document classes.
6761  Detailed information about these document classes can be found in
6762 \family sans
6763 File\SpecialChar menuseparator
6764 Open Example\SpecialChar menuseparator
6765 Books\SpecialChar menuseparator
6766 Tufte Book
6767 \family default
6768  and
6769 \family sans
6770 File\SpecialChar menuseparator
6771 Open Example\SpecialChar menuseparator
6772 Handouts\SpecialChar menuseparator
6773 Tufte Handout
6774 \family default
6775 .
6776 \end_layout
6777
6778 \begin_layout Section
6779
6780 \change_inserted 564990737 1670439534
6781 Articles
6782 \end_layout
6783
6784 \begin_layout Standard
6785
6786 \change_inserted 564990737 1670794710
6787 See also the document classes in the Collections (section
6788 \begin_inset space ~
6789 \end_inset
6790
6791
6792 \begin_inset CommandInset ref
6793 LatexCommand ref
6794 reference "sec:Collections"
6795 nolink "false"
6796
6797 \end_inset
6798
6799 ).
6800 \end_layout
6801
6802 \begin_layout Subsection
6803
6804 \change_inserted 564990737 1670794716
6805 A&A Paper
6806 \end_layout
6807
6808 \begin_layout Standard
6809
6810 \change_inserted 564990737 1670794716
6811 Original by
6812 \noun on
6813 Peter Sütterlin
6814 \noun default
6815 ;
6816  updated by the \SpecialChar LyX
6817  Team
6818 \end_layout
6819
6820 \begin_layout Subsubsection
6821
6822 \change_inserted 564990737 1670794716
6823 Introduction
6824 \end_layout
6825
6826 \begin_layout Standard
6827
6828 \change_inserted 564990737 1670794716
6829 This section describes how \SpecialChar LyX
6830  can be used to write articles for submission to the scientific journal
6831 \emph on
6832 Astronomy and Astrophysics
6833 \emph default
6834  (
6835 \begin_inset CommandInset href
6836 LatexCommand href
6837 name "aa-package"
6838 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
6839 literal "false"
6840
6841 \end_inset
6842
6843 ) using Version 9.1 of the document class
6844 \family typewriter
6845 aa.cls
6846 \family default
6847 ;
6848  information about it is available at
6849 \begin_inset Flex URL
6850 status collapsed
6851
6852 \begin_layout Plain Layout
6853
6854 \change_inserted 564990737 1670794716
6855
6856 https://www.aanda.org/for-authors/latex-issues/texnical-background-information
6857 \change_unchanged
6858
6859 \end_layout
6860
6861 \end_inset
6862
6863 .
6864 \end_layout
6865
6866 \begin_layout Standard
6867
6868 \change_inserted 564990737 1670794716
6869 A manual comes together with the package and should be consulted before installing this document class as described in the
6870 \emph on
6871 Installing New Document Classe
6872 \emph default
6873 s section of the
6874 \emph on
6875 Customization
6876 \emph default
6877  manual.
6878
6879 \end_layout
6880
6881 \begin_layout Standard
6882
6883 \change_inserted 564990737 1670794716
6884 \begin_inset Note Greyedout
6885 status open
6886
6887 \begin_layout Plain Layout
6888
6889 \change_inserted 564990737 1670794716
6890 Please note that the publisher of the journal was changed from Springer to EDP Sciences starting January 1,
6891  2001.
6892  That change also involved some slight changes to the style files,
6893  namely the removal of the thesaurus command.
6894  If you have an older version installed,
6895  please upgrade.
6896  For information about compatibility with the old (version 4) layout,
6897  please refer to the comments in
6898 \family typewriter
6899 \SpecialChar LyX
6900 Dir/layouts/aapaper.layout
6901 \family default
6902 .
6903 \end_layout
6904
6905 \end_inset
6906
6907
6908 \end_layout
6909
6910 \begin_layout Subsubsection
6911
6912 \change_inserted 564990737 1670794716
6913 Getting started
6914 \end_layout
6915
6916 \begin_layout Standard
6917
6918 \change_inserted 564990737 1671617129
6919 It is recommended you start from the template in the menu
6920 \family sans
6921 \bar under
6922 F
6923 \bar default
6924 ile\SpecialChar menuseparator
6925 New
6926 \begin_inset space ~
6927 \end_inset
6928
6929 fro
6930 \bar under
6931 m
6932 \bar default
6933
6934 \begin_inset space ~
6935 \end_inset
6936
6937 Template\SpecialChar menuseparator
6938 Articles\SpecialChar menuseparator
6939 Astronomy & Astrophysics
6940 \family default
6941 .
6942  If you are not using the template,
6943  note the following settings:
6944 \end_layout
6945
6946 \begin_layout Itemize
6947
6948 \change_inserted 564990737 1670794716
6949 Select
6950 \family sans
6951 article (A&A)
6952 \family default
6953  in the
6954 \family sans
6955 \bar under
6956 D
6957 \bar default
6958 ocument\SpecialChar menuseparator
6959
6960 \bar under
6961 S
6962 \bar default
6963 ettings\SpecialChar menuseparator
6964 Document
6965 \begin_inset space ~
6966 \end_inset
6967
6968 Class
6969 \family default
6970  dialog (OK,
6971  that one was obvious).
6972 \end_layout
6973
6974 \begin_layout Itemize
6975
6976 \change_inserted 564990737 1670794716
6977 Don't change the
6978 \family sans
6979 Headings
6980 \begin_inset space ~
6981 \end_inset
6982
6983
6984 \bar under
6985 s
6986 \bar default
6987 tyle
6988 \family default
6989  in the
6990 \family sans
6991 Page
6992 \begin_inset space ~
6993 \end_inset
6994
6995 Layout
6996 \family default
6997  dialog:
6998  leave it set to
6999 \family sans
7000 Default
7001 \family default
7002 .
7003  The whole layout is done by the macros,
7004  you shouldn't change anything.
7005 \end_layout
7006
7007 \begin_layout Subsubsection
7008
7009 \change_inserted 564990737 1670794716
7010 The header block
7011 \end_layout
7012
7013 \begin_layout Standard
7014
7015 \change_inserted 564990737 1670794716
7016 First thing to enter is the header information.
7017  It consists of five entries,
7018  of which one is optional.
7019  They are
7020 \end_layout
7021
7022 \begin_layout Itemize
7023
7024 \change_inserted 564990737 1670794716
7025
7026 \family sans
7027 Title
7028 \family default
7029 :
7030  [required]
7031 \end_layout
7032
7033 \begin_layout Itemize
7034
7035 \change_inserted 564990737 1670794716
7036
7037 \family sans
7038 Subtitle
7039 \family default
7040 :
7041  [optional]
7042 \end_layout
7043
7044 \begin_layout Itemize
7045
7046 \change_inserted 564990737 1670794716
7047
7048 \family sans
7049 Author
7050 \family default
7051 :
7052  [required]
7053 \end_layout
7054
7055 \begin_layout Itemize
7056
7057 \change_inserted 564990737 1670794716
7058
7059 \family typewriter
7060 Institute
7061 \family default
7062 :
7063  [required]
7064 \end_layout
7065
7066 \begin_layout Itemize
7067
7068 \change_inserted 564990737 1670794716
7069
7070 \family sans
7071 Date
7072 \family default
7073 :
7074  [required].
7075  Suggested format is
7076 \family typewriter
7077 Received:
7078  <date>;
7079  Accepted <date>
7080 \end_layout
7081
7082 \begin_layout Standard
7083
7084 \change_inserted 564990737 1670794716
7085 Although the order of the single header entries doesn't matter it is advised to keep the above sequence,
7086  just to get the best optics and meets the layout of the real document.
7087 \end_layout
7088
7089 \begin_layout Standard
7090
7091 \change_inserted 564990737 1670794716
7092 If you want to place footnotes in the header block,
7093  e.
7094 \begin_inset space \thinspace{}
7095 \end_inset
7096
7097 g.
7098 \begin_inset space \space{}
7099 \end_inset
7100
7101 to state your present address,
7102  just use the standard footnote via the menu
7103 \family sans
7104 \bar under
7105 I
7106 \bar default
7107 nsert\SpecialChar menuseparator
7108
7109 \bar under
7110 F
7111 \bar default
7112 ootnote.
7113
7114 \family default
7115  \SpecialChar LyX
7116  will automagically use the term
7117 \family typewriter
7118
7119 \backslash
7120 thanks{}
7121 \family default
7122  in that case.
7123 \end_layout
7124
7125 \begin_layout Standard
7126
7127 \change_inserted 564990737 1670794716
7128 In addition to these topics,
7129  the macros use three additional \SpecialChar LaTeX
7130  commands that have no counterpart in \SpecialChar LyX
7131 :
7132 \end_layout
7133
7134 \begin_layout Itemize
7135
7136 \change_inserted 564990737 1670794716
7137
7138 \family typewriter
7139
7140 \backslash
7141 and
7142 \family default
7143  to separate different names for more than one author and institute,
7144  respectively.
7145 \end_layout
7146
7147 \begin_layout Itemize
7148
7149 \change_inserted 564990737 1670794716
7150
7151 \family typewriter
7152
7153 \backslash
7154 inst{<nr>}
7155 \family default
7156  to mark corresponding author/institute pairs.
7157  The institutes are numbered sequentially as they appear in the
7158 \family sans
7159 Institute
7160 \family default
7161  field,
7162  so you have to put a marker to each author.
7163 \end_layout
7164
7165 \begin_layout Itemize
7166
7167 \change_inserted 564990737 1670794716
7168
7169 \family typewriter
7170
7171 \backslash
7172 email{address}
7173 \family default
7174  to supply an email address for fast contact.
7175 \end_layout
7176
7177 \begin_layout Standard
7178
7179 \change_inserted 564990737 1671642374
7180 In all cases,
7181  the appropriate command has to be entered as \SpecialChar TeX
7182  code in \SpecialChar LyX
7183 .
7184  See the examples in the template and in
7185 \family sans
7186 File\SpecialChar menuseparator
7187 Open Example\SpecialChar menuseparator
7188 Articles\SpecialChar menuseparator
7189 Astronomy & Astrophysics
7190 \family default
7191 .
7192 \change_unchanged
7193
7194 \end_layout
7195
7196 \begin_layout Subsubsection
7197
7198 \change_inserted 564990737 1670794716
7199 The abstract
7200 \end_layout
7201
7202 \begin_layout Standard
7203
7204 \change_inserted 564990737 1670794716
7205 The abstract should immediately follow the header block and must contain five tokens:
7206
7207 \family typewriter
7208
7209 \backslash
7210 abstract{}{}{}{}{}
7211 \family default
7212
7213 \end_layout
7214
7215 \begin_layout Enumerate
7216
7217 \change_inserted 564990737 1670794716
7218
7219 \family typewriter
7220 context heading
7221 \family default
7222  (optional) {} leave it empty if necessary
7223 \end_layout
7224
7225 \begin_layout Enumerate
7226
7227 \change_inserted 564990737 1670794716
7228
7229 \family typewriter
7230 aims heading
7231 \family default
7232  (mandatory) {}
7233 \end_layout
7234
7235 \begin_layout Enumerate
7236
7237 \change_inserted 564990737 1670794716
7238
7239 \family typewriter
7240 methods heading
7241 \family default
7242  (mandatory) {}
7243 \end_layout
7244
7245 \begin_layout Enumerate
7246
7247 \change_inserted 564990737 1670794716
7248
7249 \family typewriter
7250 results heading
7251 \family default
7252  (mandatory) {}
7253 \end_layout
7254
7255 \begin_layout Enumerate
7256
7257 \change_inserted 564990737 1670794716
7258
7259 \family typewriter
7260 conclusions heading
7261 \family default
7262  (optional) {} leave it empty if necessary
7263 \end_layout
7264
7265 \begin_layout Standard
7266
7267 \change_inserted 564990737 1670794716
7268 (NB.
7269  This structure not shown in
7270 \emph on
7271 aa_sample.lyx.
7272 \emph default
7273 )
7274 \end_layout
7275
7276 \begin_layout Subsubsection
7277
7278 \change_inserted 564990737 1670794716
7279 Supported environments
7280 \end_layout
7281
7282 \begin_layout Standard
7283
7284 \change_inserted 564990737 1670794716
7285 The A&A paper layout supports the following environments for structuring your text:
7286 \end_layout
7287
7288 \begin_layout Itemize
7289
7290 \change_inserted 564990737 1670794716
7291
7292 \family sans
7293 Standard
7294 \end_layout
7295
7296 \begin_layout Itemize
7297
7298 \change_inserted 564990737 1670794716
7299
7300 \family sans
7301 Section
7302 \end_layout
7303
7304 \begin_layout Itemize
7305
7306 \change_inserted 564990737 1670794716
7307
7308 \family sans
7309 Subsection
7310 \end_layout
7311
7312 \begin_layout Itemize
7313
7314 \change_inserted 564990737 1670794716
7315
7316 \family sans
7317 Subsubsection
7318 \end_layout
7319
7320 \begin_layout Itemize
7321
7322 \change_inserted 564990737 1670794716
7323
7324 \family sans
7325 Itemize
7326 \end_layout
7327
7328 \begin_layout Itemize
7329
7330 \change_inserted 564990737 1670794716
7331
7332 \family sans
7333 Enumerate
7334 \end_layout
7335
7336 \begin_layout Itemize
7337
7338 \change_inserted 564990737 1670794716
7339
7340 \family sans
7341 Description
7342 \end_layout
7343
7344 \begin_layout Itemize
7345
7346 \change_inserted 564990737 1670794716
7347
7348 \family sans
7349 Caption
7350 \end_layout
7351
7352 \begin_layout Itemize
7353
7354 \change_inserted 564990737 1670794716
7355
7356 \family sans
7357 Abstract
7358 \end_layout
7359
7360 \begin_layout Itemize
7361
7362 \change_inserted 564990737 1670794716
7363
7364 \family sans
7365 Acknowledgment
7366 \end_layout
7367
7368 \begin_layout Itemize
7369
7370 \change_inserted 564990737 1670794716
7371
7372 \family sans
7373 Bibliography
7374 \end_layout
7375
7376 \begin_layout Itemize
7377
7378 \change_inserted 564990737 1670794716
7379
7380 \family sans
7381 \SpecialChar LaTeX
7382
7383 \end_layout
7384
7385 \begin_layout Subsubsection
7386
7387 \change_inserted 564990737 1670794716
7388 Commands not supported by \SpecialChar LyX
7389
7390 \end_layout
7391
7392 \begin_layout Standard
7393
7394 \change_inserted 564990737 1670794716
7395 Some commands are not yet supported by the
7396 \family sans
7397 paper (A&A)
7398 \family default
7399  layout for \SpecialChar LyX
7400 .
7401  Some have already been mentioned.
7402  For the sake of completeness,
7403  they are listed all together here:
7404 \end_layout
7405
7406 \begin_layout Itemize
7407
7408 \change_inserted 564990737 1670794716
7409
7410 \family typewriter
7411
7412 \backslash
7413 and
7414 \end_layout
7415
7416 \begin_layout Itemize
7417
7418 \change_inserted 564990737 1670794716
7419
7420 \family typewriter
7421
7422 \backslash
7423 email
7424 \end_layout
7425
7426 \begin_layout Itemize
7427
7428 \change_inserted 564990737 1670794716
7429
7430 \family typewriter
7431
7432 \backslash
7433 inst{}
7434 \end_layout
7435
7436 \begin_layout Itemize
7437
7438 \change_inserted 564990737 1670794716
7439
7440 \family typewriter
7441
7442 \backslash
7443 keywords{}
7444 \end_layout
7445
7446 \begin_layout Itemize
7447
7448 \change_inserted 564990737 1670794716
7449
7450 \family typewriter
7451
7452 \backslash
7453 object{}
7454 \end_layout
7455
7456 \begin_layout Standard
7457
7458 \change_inserted 564990737 1670794716
7459 If you want to use any of these commands,
7460  you have to enter them yourself.
7461
7462 \family typewriter
7463 Do not forget to use
7464 \family sans
7465
7466 \bar under
7467 I
7468 \bar default
7469 nsert\SpecialChar menuseparator
7470 \SpecialChar TeX
7471
7472 \begin_inset space ~
7473 \end_inset
7474
7475 Code
7476 \family default
7477 \series bold
7478 !
7479 \end_layout
7480
7481 \begin_layout Subsubsection
7482
7483 \change_inserted 564990737 1670794716
7484 Figure and Table Floats
7485 \end_layout
7486
7487 \begin_layout Standard
7488
7489 \change_inserted 564990737 1670794716
7490 \SpecialChar LyX
7491  provides support for the necessary float environments
7492 \family sans
7493 figure,
7494  figure*,
7495  table
7496 \family default
7497  and
7498 \family sans
7499 table*
7500 \family default
7501 ,
7502  therefore we won't tell much about it here.
7503  Refer to the
7504 \emph on
7505 User's
7506 \begin_inset space ~
7507 \end_inset
7508
7509 Guide
7510 \emph default
7511 .
7512  Just remember that tables should be left-aligned.
7513  For that,
7514  select the table and change the alignment in
7515 \family sans
7516 \bar under
7517 E
7518 \bar default
7519 dit\SpecialChar menuseparator
7520
7521 \bar under
7522 P
7523 \bar default
7524 aragraph
7525 \begin_inset space ~
7526 \end_inset
7527
7528 Settings.
7529 \end_layout
7530
7531 \begin_layout Standard
7532
7533 \change_inserted 564990737 1670794716
7534 There is only one special thing:
7535  the figures with a caption beside the figure.
7536  To create such a figure,
7537  you have to do the following:
7538 \end_layout
7539
7540 \begin_layout Enumerate
7541
7542 \change_inserted 564990737 1670794716
7543 Create a wide figure float:
7544
7545 \family sans
7546 \bar under
7547 I
7548 \bar default
7549 nsert\SpecialChar menuseparator
7550 Flo
7551 \bar under
7552 a
7553 \bar default
7554 t\SpecialChar menuseparator
7555 Figure
7556 \family default
7557 ,
7558  then,
7559  from within the float,
7560  use the menu
7561 \family sans
7562 \bar under
7563 E
7564 \bar default
7565 dit\SpecialChar menuseparator
7566 Flo
7567 \bar under
7568 a
7569 \bar default
7570 t
7571 \begin_inset space ~
7572 \end_inset
7573
7574 Settings
7575 \family default
7576  and check
7577 \family sans
7578 \bar under
7579 S
7580 \bar default
7581 pan
7582 \begin_inset space ~
7583 \end_inset
7584
7585 columns
7586 \family default
7587  in the
7588 \family sans
7589 float
7590 \family default
7591  dialog.
7592 \end_layout
7593
7594 \begin_layout Enumerate
7595
7596 \change_inserted 564990737 1670794716
7597 Enter your caption text.
7598 \end_layout
7599
7600 \begin_layout Enumerate
7601
7602 \change_inserted 564990737 1670794716
7603 Press
7604 \family sans
7605 Return
7606 \family default
7607  to move the cursor above the caption.
7608 \end_layout
7609
7610 \begin_layout Enumerate
7611
7612 \change_inserted 564990737 1670794716
7613 Insert your figure
7614 \end_layout
7615
7616 \begin_layout Enumerate
7617
7618 \change_inserted 564990737 1670794716
7619 Position the cursor after the figure and insert a horizontal fill by using the menu:
7620
7621 \family sans
7622 \bar under
7623 I
7624 \bar default
7625 nsert\SpecialChar menuseparator
7626 F
7627 \bar under
7628 o
7629 \bar default
7630 rmatting\SpecialChar menuseparator
7631 H
7632 \bar under
7633 o
7634 \bar default
7635 rizontal
7636 \begin_inset space ~
7637 \end_inset
7638
7639 Space
7640 \family default
7641  to open the
7642 \family sans
7643 space
7644 \family default
7645  dialog and select the
7646 \family sans
7647 Horizontal fill
7648 \family default
7649  option from the
7650 \family sans
7651 \bar under
7652 S
7653 \bar default
7654 pacing
7655 \family default
7656  pull-down menu.
7657 \end_layout
7658
7659 \begin_layout Enumerate
7660
7661 \change_inserted 564990737 1670794716
7662 Switch to \SpecialChar LaTeX
7663  mode:
7664
7665 \family sans
7666 M-c
7667 \begin_inset space ~
7668 \end_inset
7669
7670 t
7671 \family default
7672 .
7673 \end_layout
7674
7675 \begin_layout Enumerate
7676
7677 \change_inserted 564990737 1670794716
7678 Enter
7679 \family typewriter
7680
7681 \backslash
7682 parbox[b]{55mm}{
7683 \family default
7684
7685 \emph on
7686 Do not close the brace!
7687 \end_layout
7688
7689 \begin_layout Enumerate
7690
7691 \change_inserted 564990737 1670794716
7692 Position the cursor behind the caption text,
7693  switch to \SpecialChar LaTeX
7694  mode and insert the closing brace:
7695
7696 \family sans
7697 M-c
7698 \begin_inset space ~
7699 \end_inset
7700
7701 t
7702 \family default
7703
7704 \family typewriter
7705 }
7706 \family default
7707 .
7708 \end_layout
7709
7710 \begin_layout Standard
7711
7712 \change_inserted 564990737 1671642458
7713 Also,
7714  refer to the figures in the file in
7715 \family sans
7716 File\SpecialChar menuseparator
7717 Open Example\SpecialChar menuseparator
7718 Articles\SpecialChar menuseparator
7719 Astronomy & Astrophysics
7720 \family default
7721 .
7722 \end_layout
7723
7724 \begin_layout Subsubsection
7725
7726 \change_inserted 564990737 1670794716
7727 Referee layout
7728 \end_layout
7729
7730 \begin_layout Standard
7731
7732 \change_inserted 564990737 1670794716
7733 For submission,
7734  the paper has to be formatted in a special double-spacing layout.
7735  For this purpose,
7736  you have to add the option
7737 \family typewriter
7738 referee
7739 \family default
7740  to the
7741 \family sans
7742 Cus
7743 \bar under
7744 t
7745 \bar default
7746 om Class
7747 \begin_inset space ~
7748 \end_inset
7749
7750 options
7751 \family default
7752  in the
7753 \family sans
7754 \bar under
7755 D
7756 \bar default
7757 ocument\SpecialChar menuseparator
7758
7759 \bar under
7760 S
7761 \bar default
7762 ettings\SpecialChar menuseparator
7763 Document
7764 \begin_inset space ~
7765 \end_inset
7766
7767 Class
7768 \family default
7769  dialog.
7770
7771 \end_layout
7772
7773 \begin_layout Subsubsection
7774
7775 \change_inserted 564990737 1670794716
7776 The example paper
7777 \end_layout
7778
7779 \begin_layout Standard
7780
7781 \change_inserted 564990737 1671642520
7782 The example in
7783 \family sans
7784 File\SpecialChar menuseparator
7785 Open Example\SpecialChar menuseparator
7786 Articles\SpecialChar menuseparator
7787 Astronomy & Astrophysics
7788 \family default
7789  was written with \SpecialChar LyX
7790 .
7791  It is the example paper from the original macro package,
7792
7793 \family typewriter
7794 aa.dem
7795 \family default
7796  in the
7797 \begin_inset CommandInset href
7798 LatexCommand href
7799 name "aa-package"
7800 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
7801 literal "false"
7802
7803 \end_inset
7804
7805 ,
7806  but translated to \SpecialChar LyX
7807  using the older unstructured abstract type.
7808  Use it for inspiration,
7809  and compare the \SpecialChar LaTeX
7810  code in
7811 \family typewriter
7812 aa.dem
7813 \family default
7814  with the \SpecialChar LyX
7815  way of writing.
7816 \end_layout
7817
7818 \begin_layout Subsection
7819 AAS\SpecialChar TeX
7820
7821 \end_layout
7822
7823 \begin_layout Standard
7824 by
7825 \noun on
7826 Mike Ressler
7827 \end_layout
7828
7829 \begin_layout Subsubsection
7830 Introduction
7831 \end_layout
7832
7833 \begin_layout Standard
7834 AAS\SpecialChar TeX
7835  is a set of macros produced by the American Astronomical Society to facilitate electronic manuscript submission to the three journals they publish:
7836  the Astrophysical Journal (including the Letters and Supplement),
7837  the Astronomical Journal,
7838  and the Publications of the Astronomical Society of the Pacific.
7839  \SpecialChar LyX
7840  has proven to be an excellent tool for generating these documents,
7841  especially given its equation,
7842  citation,
7843  and figure handling capabilities.
7844  \SpecialChar LyX
7845  requires version 5.0 (or higher) of these macros;
7846  preferably 6.0,
7847  which is the version described here,
7848  or higher.
7849  Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
7850 2.09 and are fundamentally incompatible with \SpecialChar LyX
7851 .
7852  The AAS\SpecialChar TeX
7853  package may be downloaded from the AAS\SpecialChar TeX
7854  Web site
7855 \end_layout
7856
7857 \begin_layout Standard
7858 \begin_inset VSpace medskip
7859 \end_inset
7860
7861
7862 \end_layout
7863
7864 \begin_layout Standard
7865 \align center
7866 \begin_inset Flex URL
7867 status collapsed
7868
7869 \begin_layout Plain Layout
7870
7871 https://aas.org/aastex/aastex-downloads
7872 \end_layout
7873
7874 \end_inset
7875
7876
7877 \end_layout
7878
7879 \begin_layout Standard
7880 \begin_inset VSpace medskip
7881 \end_inset
7882
7883
7884 \end_layout
7885
7886 \begin_layout Standard
7887 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
7888 .
7889  \SpecialChar LyX
7890  will not reduce the need to figure out all the AAS\SpecialChar TeX
7891  commands,
7892  it will only reduce the drudgery of typing everything in.
7893  It is your responsibility to ensure that the final exported \SpecialChar LaTeX
7894  document conforms completely to the requirements of the journal to which you are submitting your paper.
7895 \end_layout
7896
7897 \begin_layout Subsubsection
7898 Starting a New Paper
7899 \end_layout
7900
7901 \begin_layout Standard
7902 I strongly suggest that you start with the AAS\SpecialChar TeX
7903  template file.
7904  Click on
7905 \family sans
7906 File\SpecialChar menuseparator
7907 New from
7908 \family default
7909
7910 \family sans
7911 Template
7912 \change_inserted 564990737 1671617265
7913 \SpecialChar menuseparator
7914 Articles\SpecialChar menuseparator
7915 American Astronomical Society
7916 \change_deleted 564990737 1671617310
7917
7918 \family default
7919 ,
7920  enter the new file name,
7921  then choose the
7922 \family typewriter
7923 aastex6.lyx
7924 \family default
7925  template
7926 \change_unchanged
7927 .
7928  This will show the most common fields found in a manuscript.
7929  Simply overwrite the existing text (including the brackets,
7930
7931 \family typewriter
7932 <>
7933 \family default
7934 ) with the correct information.
7935  Many of the AAS\SpecialChar TeX
7936  commands and environments can be implemented directly in \SpecialChar LyX
7937 ,
7938  but some cannot.
7939  For commands such as these,
7940  the \SpecialChar LaTeX
7941  code must be entered directly and marked as such.
7942  Such commands are referred to as \SpecialChar TeX
7943  code,
7944  or Evil Red Text.
7945  I tried to minimize the amount of \SpecialChar TeX
7946  code needed in an AAS\SpecialChar TeX
7947  document.
7948 \end_layout
7949
7950 \begin_layout Subsubsection
7951 Finishing Your Paper
7952 \end_layout
7953
7954 \begin_layout Standard
7955 When the paper is finished to your satisfaction and previews/prints correctly,
7956  there are a few
7957 \begin_inset Quotes eld
7958 \end_inset
7959
7960 postprocessing
7961 \begin_inset Quotes erd
7962 \end_inset
7963
7964  actions which need to be done before you submit it to the journals.
7965
7966 \end_layout
7967
7968 \begin_layout Enumerate
7969 Export your paper as a \SpecialChar LaTeX
7970  file (
7971 \family sans
7972 File\SpecialChar menuseparator
7973 Export\SpecialChar menuseparator
7974 \SpecialChar LaTeX
7975
7976 \family default
7977 ).
7978
7979 \end_layout
7980
7981 \begin_layout Enumerate
7982 Edit the resulting
7983 \family typewriter
7984 .tex
7985 \family default
7986  file with your favorite text editor
7987 \end_layout
7988
7989 \begin_deeper
7990 \begin_layout Enumerate
7991 remove the comment lines before the
7992 \family typewriter
7993
7994 \backslash
7995 documentclass
7996 \family default
7997  command
7998 \end_layout
7999
8000 \begin_layout Enumerate
8001 remove the
8002 \family typewriter
8003
8004 \backslash
8005 usepackage...{fontenc}
8006 \family default
8007  line if it appears (usually just after
8008 \family typewriter
8009
8010 \backslash
8011 documentclass
8012 \family default
8013 };
8014  also remove the
8015 \family typewriter
8016
8017 \backslash
8018 secnumdepth
8019 \family default
8020  line if it appears.
8021 \end_layout
8022
8023 \begin_layout Enumerate
8024 remove everything between (and including) the
8025 \family typewriter
8026
8027 \backslash
8028 makeatletter
8029 \family default
8030  and
8031 \family typewriter
8032
8033 \backslash
8034 makeatother
8035 \family default
8036  commands,
8037  except for any commands you specifically put into the \SpecialChar LaTeX
8038  preamble (which should appear immediately after the
8039 \begin_inset Quotes eld
8040 \end_inset
8041
8042 User specified \SpecialChar LaTeX
8043  commands
8044 \begin_inset Quotes erd
8045 \end_inset
8046
8047  comment in the
8048 \family typewriter
8049 .tex
8050 \family default
8051  file).
8052 \end_layout
8053
8054 \end_deeper
8055 \begin_layout Enumerate
8056 Run the resulting file through \SpecialChar LaTeX
8057  to make sure it still processes correctly.
8058 \end_layout
8059
8060 \begin_layout Enumerate
8061 Reread the journal requirements to make sure your filenames and formats are correct.
8062 \end_layout
8063
8064 \begin_layout Enumerate
8065 Submit it.
8066 \end_layout
8067
8068 \begin_layout Subsubsection
8069 Comments On Specific Commands
8070 \end_layout
8071
8072 \begin_layout Standard
8073 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
8074  commands:
8075  the AAS\SpecialChar TeX
8076  User Guide (
8077 \family typewriter
8078 aasguide.tex
8079 \family default
8080 ) gives a good description of each.
8081  Thus it's probably easiest for me to go down the list as found in the guide and offer comments where necessary.
8082  So let's begin \SpecialChar ldots
8083
8084 \end_layout
8085
8086 \begin_layout Paragraph
8087 Things that work as expected
8088 \end_layout
8089
8090 \begin_layout Standard
8091 Because they work as you might expect,
8092  I simply list them and the section they are found in:
8093
8094 \family typewriter
8095
8096 \backslash
8097 documentclass
8098 \family default
8099  (2.1.1),
8100
8101 \family typewriter
8102
8103 \backslash
8104 begin{document}
8105 \family default
8106  (2.2),
8107
8108 \family typewriter
8109
8110 \backslash
8111 title
8112 \family default
8113  (2.3),
8114
8115 \family typewriter
8116
8117 \backslash
8118 author
8119 \family default
8120  (2.3),
8121
8122 \family typewriter
8123
8124 \backslash
8125 affil
8126 \family default
8127  (2.3),
8128
8129 \family typewriter
8130
8131 \backslash
8132 abstract
8133 \family default
8134  (2.4),
8135
8136 \family typewriter
8137
8138 \backslash
8139 keywords
8140 \family default
8141  (2.5),
8142
8143 \family typewriter
8144
8145 \backslash
8146 section
8147 \family default
8148  (2.7),
8149
8150 \family typewriter
8151
8152 \backslash
8153 subsection
8154 \family default
8155  (2.7),
8156
8157 \family typewriter
8158
8159 \backslash
8160 subsubsection
8161 \family default
8162  (2.7),
8163
8164 \family typewriter
8165
8166 \backslash
8167 paragraph
8168 \family default
8169  (2.7),
8170
8171 \family typewriter
8172
8173 \backslash
8174 facility
8175 \family default
8176  (2.10),
8177
8178 \family typewriter
8179
8180 \backslash
8181 begin{displaymath}
8182 \family default
8183  (2.12),
8184
8185 \family typewriter
8186
8187 \backslash
8188 begin{equation}
8189 \family default
8190  (2.12),
8191
8192 \family typewriter
8193
8194 \backslash
8195 begin{eqnarray}
8196 \family default
8197  (2.12),
8198
8199 \family typewriter
8200
8201 \backslash
8202 begin{mathletters}
8203 \family default
8204  (2.12),
8205
8206 \family typewriter
8207
8208 \backslash
8209 begin{thebibliography}
8210 \family default
8211  (2.13.1),
8212
8213 \family typewriter
8214
8215 \backslash
8216 bibitem
8217 \family default
8218  (2.13.2),
8219  all the cite commands and their variations (2.13.2),
8220  the generic graphicx figure commands (2.14.1),
8221
8222 \family typewriter
8223
8224 \backslash
8225 begin{table}
8226 \family default
8227  (2.15.4),
8228
8229 \family typewriter
8230
8231 \backslash
8232 begin{tabular}
8233 \family default
8234  (2.15.4),
8235
8236 \family typewriter
8237
8238 \backslash
8239 caption
8240 \family default
8241  (2.15.4),
8242
8243 \family typewriter
8244
8245 \backslash
8246 label
8247 \family default
8248  (2.15.4,
8249  amongst other places),
8250
8251 \family typewriter
8252
8253 \backslash
8254 tablerefs
8255 \family default
8256  (2.15.5),
8257
8258 \family typewriter
8259
8260 \backslash
8261 tablecomments
8262 \family default
8263  (2.15.5),
8264
8265 \family typewriter
8266
8267 \backslash
8268 url
8269 \family default
8270  (2.17.4),
8271
8272 \family typewriter
8273
8274 \backslash
8275 end{document}
8276 \family default
8277  (2.18).
8278 \end_layout
8279
8280 \begin_layout Standard
8281 The following style options also work correctly:
8282
8283 \family typewriter
8284 longabstract
8285 \family default
8286  (2.4),
8287
8288 \family typewriter
8289 preprint
8290 \family default
8291  (3.2.1),
8292
8293 \family typewriter
8294 preprint2
8295 \family default
8296  (3.2.2),
8297
8298 \family typewriter
8299 eqsecnum
8300 \family default
8301  (3.3),
8302
8303 \family typewriter
8304 flushrt
8305 \family default
8306  (3.4).
8307  Simply put them in the
8308 \family sans
8309 Options
8310 \family default
8311  box in
8312 \family sans
8313 Layout\SpecialChar menuseparator
8314 Document
8315 \family default
8316 .
8317 \end_layout
8318
8319 \begin_layout Paragraph
8320 Things that work,
8321  but require more comment
8322 \end_layout
8323
8324 \begin_layout Standard
8325 The following items work,
8326  but require a little more discussion:
8327 \end_layout
8328
8329 \begin_layout Itemize
8330 These items are reserved for use by the journal editors,
8331  but you can put them into the \SpecialChar LaTeX
8332  preamble if you feel compelled to do so:
8333
8334 \family typewriter
8335
8336 \backslash
8337 received
8338 \family default
8339 ,
8340
8341 \family typewriter
8342
8343 \backslash
8344 revised
8345 \family default
8346 ,
8347
8348 \family typewriter
8349
8350 \backslash
8351 accepted
8352 \family default
8353 ,
8354
8355 \family typewriter
8356
8357 \backslash
8358 ccc
8359 \family default
8360 ,
8361
8362 \family typewriter
8363
8364 \backslash
8365 cpright
8366 \family default
8367  (all from 2.1.3)
8368 \end_layout
8369
8370 \begin_layout Itemize
8371 These items may be placed in the \SpecialChar LaTeX
8372  preamble,
8373  and are included as blanks in the template file:
8374
8375 \family typewriter
8376
8377 \backslash
8378 slugcomment
8379 \family default
8380  (2.1.4),
8381
8382 \family typewriter
8383
8384 \backslash
8385 shorttitle
8386 \family default
8387  (2.1.5),
8388
8389 \family typewriter
8390
8391 \backslash
8392 shortauthors
8393 \family default
8394  (2.1.5)
8395 \end_layout
8396
8397 \begin_layout Itemize
8398
8399 \family typewriter
8400
8401 \backslash
8402 email
8403 \family default
8404  (2.3) – can only be used
8405 \begin_inset Quotes eld
8406 \end_inset
8407
8408 standalone
8409 \begin_inset Quotes erd
8410 \end_inset
8411
8412 ,
8413  not in the middle of a paragraph.
8414  Use \SpecialChar TeX
8415  code if you need to embed it.
8416 \end_layout
8417
8418 \begin_layout Itemize
8419
8420 \family typewriter
8421
8422 \backslash
8423 and
8424 \family default
8425  (2.3) – will have extra {} after it.
8426  This should not cause an error.
8427 \end_layout
8428
8429 \begin_layout Itemize
8430
8431 \family typewriter
8432
8433 \backslash
8434 notetoeditor
8435 \family default
8436  (2.6) – can only be used
8437 \begin_inset Quotes eld
8438 \end_inset
8439
8440 standalone
8441 \begin_inset Quotes erd
8442 \end_inset
8443
8444 ,
8445  not in the middle of a paragraph.
8446  Use \SpecialChar TeX
8447  code if you need to embed it.
8448 \end_layout
8449
8450 \begin_layout Itemize
8451
8452 \family typewriter
8453
8454 \backslash
8455 placetable
8456 \family default
8457  (2.8) – can't insert a cross-reference tag,
8458  you must type the tag name by hand
8459 \end_layout
8460
8461 \begin_layout Itemize
8462
8463 \family typewriter
8464
8465 \backslash
8466 placefigure
8467 \family default
8468  (2.8) – same as for
8469 \family typewriter
8470
8471 \backslash
8472 placetable
8473 \end_layout
8474
8475 \begin_layout Itemize
8476
8477 \family typewriter
8478
8479 \backslash
8480 acknowledgements
8481 \family default
8482  (2.9) – will have extra {} after it.
8483  This should not cause an error.
8484 \end_layout
8485
8486 \begin_layout Itemize
8487
8488 \family typewriter
8489
8490 \backslash
8491 appendix
8492 \family default
8493  (2.11) – will have extra {} after it.
8494  This should not cause an error.
8495 \end_layout
8496
8497 \begin_layout Itemize
8498
8499 \family typewriter
8500
8501 \backslash
8502 figcaption
8503 \family default
8504  (2.14.2) – you can insert an optional filename argument by placing the cursor at the beginning of the text and selecting
8505 \family sans
8506 Insert\SpecialChar menuseparator
8507 Short Title
8508 \family default
8509 .
8510
8511 \begin_inset Quotes eld
8512 \end_inset
8513
8514 Short Title
8515 \begin_inset Quotes erd
8516 \end_inset
8517
8518  inserts an optional argument of the type needed by
8519 \family typewriter
8520
8521 \backslash
8522 figcaption
8523 \family default
8524 .
8525  Hopefully it will be renamed someday.
8526 \end_layout
8527
8528 \begin_layout Itemize
8529
8530 \family typewriter
8531
8532 \backslash
8533 objectname
8534 \family default
8535  (2.17.1) – same as
8536 \family typewriter
8537
8538 \backslash
8539 figcaption
8540 \family default
8541  for the catalog ID optional parameter
8542 \end_layout
8543
8544 \begin_layout Itemize
8545
8546 \family typewriter
8547
8548 \backslash
8549 dataset
8550 \family default
8551  (2.17.1) – same as
8552 \family typewriter
8553
8554 \backslash
8555 figcaption
8556 \family default
8557  for the catalog ID optional parameter
8558 \end_layout
8559
8560 \begin_layout Paragraph
8561 Things not implemented,
8562  use \SpecialChar TeX
8563  code
8564 \end_layout
8565
8566 \begin_layout Standard
8567
8568 \family typewriter
8569
8570 \backslash
8571 eqnum
8572 \family default
8573  (2.12),
8574
8575 \family typewriter
8576
8577 \backslash
8578 setcounter{equation}
8579 \family default
8580  (2.12),
8581  Journal name abbreviations (2.13.4),
8582
8583 \family typewriter
8584
8585 \backslash
8586 figurenum
8587 \family default
8588  (2.14.1),
8589
8590 \family typewriter
8591
8592 \backslash
8593 epsscale
8594 \family default
8595  (2.14.1),
8596
8597 \family typewriter
8598
8599 \backslash
8600 plotone
8601 \family default
8602  (2.14.1),
8603
8604 \family typewriter
8605
8606 \backslash
8607 plottwo
8608 \family default
8609  (2.14.1),
8610
8611 \family typewriter
8612
8613 \backslash
8614 tablenum
8615 \family default
8616  (2.15.4),
8617
8618 \family typewriter
8619
8620 \backslash
8621 tableline
8622 \family default
8623  (2.15.4,
8624  insert it as the first element in the lefthand cell after where you want it.
8625  Don't use any of \SpecialChar LyX
8626 's rules in the table),
8627
8628 \family typewriter
8629
8630 \backslash
8631 tablenotemark
8632 \family default
8633  (2.15.5),
8634
8635 \family typewriter
8636
8637 \backslash
8638 tablenotetext
8639 \family default
8640  (2.15.5),
8641  much of Misc (2.17,
8642  except
8643 \family typewriter
8644
8645 \backslash
8646 objectname
8647 \family default
8648 ,
8649
8650 \family typewriter
8651
8652 \backslash
8653 dataset
8654 \family default
8655 ,
8656
8657 \family typewriter
8658
8659 \backslash
8660 url
8661 \family default
8662 ,
8663  and
8664 \family typewriter
8665
8666 \backslash
8667 email
8668 \family default
8669 ;
8670  see above),
8671
8672 \family typewriter
8673
8674 \backslash
8675 singlespace
8676 \family default
8677  (3.1),
8678
8679 \family typewriter
8680
8681 \backslash
8682 doublespace
8683 \family default
8684  (3.1),
8685
8686 \family typewriter
8687
8688 \backslash
8689 onecolumn
8690 \family default
8691  (3.2),
8692
8693 \family typewriter
8694
8695 \backslash
8696 twocolumn
8697 \family default
8698  (3.2)
8699 \end_layout
8700
8701 \begin_layout Paragraph
8702 Things that cannot be implemented
8703 \end_layout
8704
8705 \begin_layout Standard
8706 \SpecialChar ldots
8707  at least in any meaningful sort of way,
8708  so I suggest ignoring them.
8709  They are the references environment (2.13.3),
8710  and the deluxetable environment (2.15).
8711  If you really,
8712  really need to use deluxetable,
8713  I suggest editing it in a separate file with a text editor,
8714  then using
8715 \family sans
8716 Insert\SpecialChar menuseparator
8717 Child
8718 \begin_inset space ~
8719 \end_inset
8720
8721 Document
8722 \family default
8723  to include it in your \SpecialChar LyX
8724  document.
8725  See
8726 \change_deleted 564990737 1671642564
8727 the
8728 \family typewriter
8729 aas_sample.lyx
8730 \family default
8731  file to see
8732 \change_inserted 564990737 1671642618
8733
8734 \family sans
8735 File\SpecialChar menuseparator
8736 Open Example\SpecialChar menuseparator
8737 Articles\SpecialChar menuseparator
8738 American Astronomical Society
8739 \change_unchanged
8740
8741 \family default
8742
8743 \change_inserted 564990737 1671642621
8744 for
8745 \change_unchanged
8746 an example of this.
8747 \end_layout
8748
8749 \begin_layout Subsubsection
8750 FAQs,
8751  Tips,
8752  Tricks,
8753  and Other Ruminations
8754 \end_layout
8755
8756 \begin_layout Paragraph
8757 Getting \SpecialChar LyX
8758  and AAS\SpecialChar TeX
8759  to cooperate
8760 \end_layout
8761
8762 \begin_layout Standard
8763 It can be a bit tricky to get \SpecialChar LyX
8764  to recognize a new layout and document class.
8765  When all else fails,
8766  do this:
8767 \end_layout
8768
8769 \begin_layout Enumerate
8770 Make certain that \SpecialChar LaTeX
8771  can find AAS\SpecialChar TeX
8772 .
8773  Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
8774  distribution into a directory completely unrelated to \SpecialChar LaTeX
8775  or AAS\SpecialChar TeX
8776  and run \SpecialChar LaTeX
8777  on
8778 \family typewriter
8779 sample.tex
8780 \family default
8781 .
8782 \end_layout
8783
8784 \begin_layout Enumerate
8785 Make certain that
8786 \family typewriter
8787 aastex.layout
8788 \family default
8789  appears in \SpecialChar LyX
8790 's
8791 \family typewriter
8792 layouts
8793 \family default
8794  folder
8795 \end_layout
8796
8797 \begin_layout Enumerate
8798 Rerun
8799 \family sans
8800 Tools\SpecialChar menuseparator
8801 Reconfigure
8802 \family default
8803  in \SpecialChar LyX
8804 ,
8805  then restart \SpecialChar LyX
8806 .
8807 \end_layout
8808
8809 \begin_layout Enumerate
8810 Open a regular new file,
8811  not from a template.
8812  Does AAS\SpecialChar TeX
8813  appear in the class list in
8814 \family sans
8815 Document\SpecialChar menuseparator
8816 Settings
8817 \family default
8818 ?
8819 \end_layout
8820
8821 \begin_layout Standard
8822 If you get a warning from an existing AAS\SpecialChar TeX
8823  document about not being able to find the AAS\SpecialChar TeX
8824  layout or a message about
8825 \begin_inset Quotes eld
8826 \end_inset
8827
8828 You should not mix title layouts with normal ones
8829 \begin_inset Quotes erd
8830 \end_inset
8831
8832 ,
8833  things haven't been installed correctly.
8834 \end_layout
8835
8836 \begin_layout Paragraph
8837 \SpecialChar LaTeX
8838  error processing a table
8839 \end_layout
8840
8841 \begin_layout Standard
8842 \SpecialChar LyX
8843 ,
8844  by default,
8845  attempts to center the table caption/title.
8846  This seems to produce a bad interaction in AAS\SpecialChar TeX
8847  so you should click somewhere in the caption/title,
8848  then select
8849 \family sans
8850 Edit\SpecialChar menuseparator
8851 Paragraph
8852 \begin_inset space ~
8853 \end_inset
8854
8855 Settings
8856 \family default
8857 ,
8858  then set the
8859 \family sans
8860 Alignment
8861 \family default
8862  to
8863 \family sans
8864 Block
8865 \family default
8866 .
8867  This took care of it for me.
8868 \end_layout
8869
8870 \begin_layout Paragraph
8871 References
8872 \end_layout
8873
8874 \begin_layout Standard
8875 A couple of things:
8876  1) I have noticed some funny spacing in the reference entries in the text.
8877  When you enter the bibliography item data,
8878  make sure their is
8879 \emph on
8880 no
8881 \emph default
8882  space between the last author and the parenthesis setting off the year;
8883
8884 \emph on
8885 e.
8886 \begin_inset space \thinspace{}
8887 \end_inset
8888
8889 g.
8890 \begin_inset space \space{}
8891 \end_inset
8892
8893
8894 \emph default
8895 type
8896 \family typewriter
8897 Ressler(1992)
8898 \family default
8899 ,
8900  not
8901 \family typewriter
8902 Ressler (1992)
8903 \family default
8904 .
8905  2) Entering the references at all is not obvious.
8906  The easiest thing is to start typing your first reference at the end of the document,
8907  then mark it as type
8908 \family sans
8909 References
8910 \family default
8911 .
8912  That will put a small gray box in front of what you just typed.
8913  Click on the box to fill in the rest of the information.
8914  For new references,
8915  go to the end of an existing reference and press return.
8916  That will create a new line with its own box,
8917  etc.
8918 \end_layout
8919
8920 \begin_layout Paragraph
8921 Including EPS files
8922 \end_layout
8923
8924 \begin_layout Standard
8925 Even though AAS\SpecialChar TeX
8926  provides its own figure commands (
8927 \family typewriter
8928
8929 \backslash
8930 plotone
8931 \family default
8932 ,
8933  for example),
8934  I much prefer \SpecialChar LaTeX
8935 's standard figure commands (with the default graphicx).
8936  You can insert the
8937 \family typewriter
8938
8939 \backslash
8940 plotone
8941 \family default
8942 ,
8943  etc.
8944 \begin_inset space ~
8945 \end_inset
8946
8947 commands as \SpecialChar TeX
8948  code into a Figure Float box if you desire,
8949  but I never have much luck getting the layout right.
8950  With the standard graphics,
8951  \SpecialChar LyX
8952  will insert a
8953 \family typewriter
8954
8955 \backslash
8956 usepackage{graphicx}
8957 \family default
8958  command into the \SpecialChar LaTeX
8959  preamble and handle the figures in the standard \SpecialChar LaTeX2e
8960  way,
8961  interspersing the figures in the text.
8962  I believe ApJ accepts figures exactly this way now;
8963  AJ might still use the
8964 \begin_inset Quotes eld
8965 \end_inset
8966
8967 stack everything at the end
8968 \begin_inset Quotes erd
8969 \end_inset
8970
8971  technique.
8972 \end_layout
8973
8974 \begin_layout Paragraph
8975 Things I could have done,
8976  but didn't
8977 \end_layout
8978
8979 \begin_layout Standard
8980 There are a few
8981 \begin_inset Quotes eld
8982 \end_inset
8983
8984 pretty
8985 \begin_inset Quotes erd
8986 \end_inset
8987
8988  things I could have implemented,
8989  but chose not to.
8990  For instance,
8991  I saw no point in double-spacing the text in the \SpecialChar LyX
8992  window,
8993  even though it is double-spaced in the paper manuscript.
8994  Also,
8995  I chose not to make separate layouts for the preprint and preprint2 styles.
8996  Since I assume you will spend most of your time in the plain manuscript mode anyway,
8997  I decided not to chew up more disk space with this.
8998
8999 \end_layout
9000
9001 \begin_layout Subsubsection
9002 Final Caveat
9003 \end_layout
9004
9005 \begin_layout Standard
9006 Your mileage may vary.
9007  I've now had papers published by both ApJ and AJ that have had 98% of the effort done in \SpecialChar LyX
9008 ;
9009  the last 2% was the \SpecialChar LaTeX
9010  post-processing and a few cleanups.
9011  I have had no trouble with the submission process,
9012  and I'm sure the journals were never aware that there might be a difference.
9013  So,
9014  go forth and publish!
9015 \end_layout
9016
9017 \begin_layout Subsection
9018
9019 \change_inserted 564990737 1671442131
9020 Chess
9021 \end_layout
9022
9023 \begin_layout Standard
9024
9025 \change_inserted 564990737 1671642768
9026 The document class
9027 \family sans
9028 article
9029 \begin_inset space \thinspace{}
9030 \end_inset
9031
9032 (Chess)
9033 \family default
9034  uses the
9035 \family typewriter
9036 article.cls
9037 \family default
9038  document class together with the style
9039 \family sans
9040 lyxskak.sty
9041 \family default
9042  to facilitate the description of chess games.
9043  See
9044 \family sans
9045 File\SpecialChar menuseparator
9046 Open Example\SpecialChar menuseparator
9047 Articles\SpecialChar menuseparator
9048 Chess
9049 \family default
9050  where you will find
9051 \family sans
9052 Game 1
9053 \family default
9054  and
9055 \family sans
9056 Game 2
9057 \family default
9058 .
9059 \end_layout
9060
9061 \begin_layout Subsection
9062
9063 \change_inserted 564990737 1671042028
9064 Elsevier
9065 \end_layout
9066
9067 \begin_layout Standard
9068
9069 \change_inserted 564990737 1671617396
9070 The document class
9071 \family sans
9072 article
9073 \begin_inset space \thinspace{}
9074 \end_inset
9075
9076 (Elsevier)
9077 \family default
9078  provides the
9079 \family typewriter
9080 elsarticle.cls
9081 \family default
9082  document class.
9083  This provides the following additional environments:
9084
9085 \family sans
9086 Title
9087 \begin_inset space ~
9088 \end_inset
9089
9090 footnote
9091 \family default
9092 ,
9093
9094 \family sans
9095 Author
9096 \begin_inset space ~
9097 \end_inset
9098
9099 footnote
9100 \family default
9101 ,
9102
9103 \family sans
9104 Corresponding
9105 \begin_inset space ~
9106 \end_inset
9107
9108 author
9109 \family default
9110 ,
9111
9112 \family sans
9113 Address
9114 \family default
9115 ,
9116
9117 \family sans
9118 Email
9119 \family default
9120  and
9121 \family sans
9122 Keywords
9123 \family default
9124 .
9125  A template is available in the menu
9126 \family sans
9127 \bar under
9128 F
9129 \bar default
9130 ile\SpecialChar menuseparator
9131 New
9132 \begin_inset space ~
9133 \end_inset
9134
9135 fro
9136 \bar under
9137 m
9138 \bar default
9139
9140 \begin_inset space ~
9141 \end_inset
9142
9143 Template\SpecialChar menuseparator
9144 Articles\SpecialChar menuseparator
9145 Elsevier
9146 \family default
9147 .
9148  It has been customized with further environments and contains all the information you may need.
9149  However,
9150  the documentation is also available from
9151 \begin_inset CommandInset href
9152 LatexCommand href
9153 name "CTAN"
9154 target "http://mirrors.ctan.org/macros/latex/contrib/elsarticle/doc/elsdoc.pdf"
9155 literal "false"
9156
9157 \end_inset
9158
9159 .
9160 \end_layout
9161
9162 \begin_layout Subsection
9163
9164 \change_inserted 564990737 1671042046
9165 Paper
9166 \end_layout
9167
9168 \begin_layout Standard
9169
9170 \change_inserted 564990737 1671042046
9171 The document class
9172 \family sans
9173 article
9174 \begin_inset space \thinspace{}
9175 \end_inset
9176
9177 (paper)
9178 \family default
9179  provides an alternative to the
9180 \family typewriter
9181 article.cls
9182 \family default
9183  document class.
9184  It provides similar functionality,
9185  but you might prefer this layout with sans serif sections,
9186  headings,
9187  and more.
9188 \end_layout
9189
9190 \begin_layout Subsection
9191 Rev\SpecialChar TeX
9192 4
9193 \end_layout
9194
9195 \begin_layout Standard
9196 by
9197 \noun on
9198 Amir Karger
9199 \end_layout
9200
9201 \begin_layout Standard
9202 \begin_inset VSpace bigskip
9203 \end_inset
9204
9205
9206 \end_layout
9207
9208 \begin_layout Standard
9209 \noindent
9210 The
9211 \family sans
9212 Revtex
9213 \begin_inset space ~
9214 \end_inset
9215
9216 4
9217 \family default
9218  textclass works with the American Physical Sociey's Rev\SpecialChar TeX
9219  4.0 (the
9220 \begin_inset Formula $\beta$
9221 \end_inset
9222
9223  release of May,
9224  1999) class.
9225 \end_layout
9226
9227 \begin_layout Standard
9228 \SpecialChar LyX
9229  has a
9230 \family sans
9231 Revtex
9232 \family default
9233  textclass,
9234  which works with Rev\SpecialChar TeX
9235  3.1.
9236  However,
9237  v3.1 is basically obsolete,
9238  as it works with \SpecialChar LaTeX
9239  2.09.
9240  That means that it doesn't interact very well with \SpecialChar LyX
9241 ,
9242  which requires \SpecialChar LaTeX2e
9243 ,
9244  although it has been kludged to work.
9245  Since Rev\SpecialChar TeX
9246  4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
9247 ,
9248  \SpecialChar LyX
9249  with the
9250 \family sans
9251 Rev\SpecialChar TeX
9252
9253 \begin_inset space ~
9254 \end_inset
9255
9256 4
9257 \family default
9258  textclass should also be pretty easy to use.
9259 \end_layout
9260
9261 \begin_layout Standard
9262 These documents are supposed to be used in
9263 \emph on
9264 addition
9265 \emph default
9266  to the Rev\SpecialChar TeX
9267  4.0 documents,
9268  so we don't describe any of the special Rev\SpecialChar TeX
9269  macros,
9270  and assume you'll know what to put in the preamble if necessary.
9271 \end_layout
9272
9273 \begin_layout Subsubsection
9274 Installation
9275 \end_layout
9276
9277 \begin_layout Standard
9278 All you need to do is install Rev\SpecialChar TeX
9279  4,
9280  as described in the package's README file.
9281  The package can be found at The Rev\SpecialChar TeX
9282  4 Web Site
9283 \begin_inset Flex URL
9284 status collapsed
9285
9286 \begin_layout Plain Layout
9287
9288 http://publish.aps.org/revtex4/
9289 \end_layout
9290
9291 \end_inset
9292
9293 .
9294  Install it somewhere that \SpecialChar LaTeX
9295  can see it.
9296  Test it by trying to \SpecialChar LaTeX
9297  a short Rev\SpecialChar TeX
9298  4 document in some random directory (i.
9299 \begin_inset space \thinspace{}
9300 \end_inset
9301
9302 e.
9303 \begin_inset space \space{}
9304 \end_inset
9305
9306 not the directory where you installed the class file.) Then,
9307  if you reconfigure \SpecialChar LyX
9308 ,
9309  it will find the class file and let you use the Rev\SpecialChar TeX
9310 4 textclass.
9311 \end_layout
9312
9313 \begin_layout Standard
9314 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
9315  4 document using
9316 \family typewriter
9317 tex2lyx
9318 \family default
9319 ,
9320  or to use the
9321 \family sans
9322 Revtex
9323 \begin_inset space ~
9324 \end_inset
9325
9326 4
9327 \family default
9328  template,
9329  found in the templates directory.
9330 \end_layout
9331
9332 \begin_layout Subsubsection
9333 Preamble Matter
9334 \end_layout
9335
9336 \begin_layout Standard
9337 Optional arguments to
9338 \family typewriter
9339
9340 \backslash
9341 documentclass
9342 \family default
9343 ,
9344  like
9345 \begin_inset Quotes eld
9346 \end_inset
9347
9348 preprint
9349 \begin_inset Quotes erd
9350 \end_inset
9351
9352  and
9353 \begin_inset Quotes eld
9354 \end_inset
9355
9356 aps
9357 \begin_inset Quotes erd
9358 \end_inset
9359
9360 ,
9361  go in the
9362 \family sans
9363 Extra
9364 \begin_inset space ~
9365 \end_inset
9366
9367 Options
9368 \family default
9369  field in the
9370 \family sans
9371 Document
9372 \begin_inset space ~
9373 \end_inset
9374
9375 Layout
9376 \family default
9377  dialog,
9378  as usual.
9379  Remember that in Rev\SpecialChar TeX
9380 ,
9381  at least one optional argument is required!
9382
9383 \end_layout
9384
9385 \begin_layout Standard
9386 Other preamble matter,
9387  like
9388 \family typewriter
9389
9390 \backslash
9391 draft
9392 \family default
9393  etc.
9394 \begin_inset space ~
9395 \end_inset
9396
9397 goes in the
9398 \family sans
9399 \SpecialChar LaTeX
9400
9401 \begin_inset space ~
9402 \end_inset
9403
9404 Preamble
9405 \family default
9406  dialog,
9407  also as usual.
9408 \end_layout
9409
9410 \begin_layout Subsubsection
9411 Layouts
9412 \end_layout
9413
9414 \begin_layout Standard
9415 The layouts basically correspond to the commands in Rev\SpecialChar TeX
9416 4.0.
9417  For example,
9418  the Email layout corresponds to
9419 \family typewriter
9420
9421 \backslash
9422 email{}
9423 \family default
9424 .
9425  Note that (at least as of Rev\SpecialChar TeX
9426  4.0 Beta),
9427  the
9428 \family sans
9429 Address
9430 \family default
9431  and
9432 \family sans
9433 Affiliation
9434 \family default
9435  layouts are exactly equivalent,
9436  so you shouldn't need to use both.
9437 \begin_inset Foot
9438 status collapsed
9439
9440 \begin_layout Plain Layout
9441 In case you're curious,
9442  both were included so that
9443 \family typewriter
9444 tex2lyx
9445 \family default
9446  would be able to translate both
9447 \family typewriter
9448
9449 \backslash
9450 address
9451 \family default
9452  and
9453 \family typewriter
9454
9455 \backslash
9456 affiliation
9457 \family default
9458 .
9459 \end_layout
9460
9461 \end_inset
9462
9463
9464 \end_layout
9465
9466 \begin_layout Subsubsection
9467 Important Notes
9468 \end_layout
9469
9470 \begin_layout Standard
9471 There are a couple of important unique aspects of Rev\SpecialChar TeX
9472  4 which might cause bugs that will be even more confusing in \SpecialChar LyX
9473 .
9474 \end_layout
9475
9476 \begin_layout Standard
9477 In Rev\SpecialChar TeX
9478 ,
9479  the
9480 \family typewriter
9481
9482 \backslash
9483 thanks
9484 \family default
9485  command goes
9486 \emph on
9487 outside
9488 \emph default
9489  the
9490 \family typewriter
9491
9492 \backslash
9493 author
9494 \family default
9495  command.
9496  The \SpecialChar LyX
9497  equivalent is that there is a separate Thanks layout.
9498  Do
9499 \emph on
9500 not
9501 \emph default
9502  write footnotes in the
9503 \family sans
9504 Author
9505 \family default
9506  layout,
9507  or weird things may happen.
9508  See the Rev\SpecialChar TeX
9509  4 documentation for more details.
9510 \end_layout
9511
9512 \begin_layout Standard
9513 Also,
9514  the
9515 \family sans
9516 Author
9517 \begin_inset space ~
9518 \end_inset
9519
9520 Email
9521 \family default
9522 ,
9523
9524 \family sans
9525 Author
9526 \begin_inset space ~
9527 \end_inset
9528
9529 URL
9530 \family default
9531 ,
9532  and
9533 \family sans
9534 Thanks
9535 \family default
9536  layouts must be placed
9537 \emph on
9538 in between
9539 \emph default
9540  the
9541 \family sans
9542 Author
9543 \family default
9544  layout and the corresponding
9545 \family sans
9546 Address
9547 \family default
9548  (or equivalent
9549 \family sans
9550 Affiliation
9551 \family default
9552 ) layout.
9553  If you put the
9554 \family sans
9555 Thanks
9556 \family default
9557  after the
9558 \family sans
9559 Address
9560 \family default
9561 ,
9562  the \SpecialChar LaTeX
9563  won't compile.
9564 \end_layout
9565
9566 \begin_layout Subsection
9567
9568 \change_inserted 564990737 1671042072
9569 Springer Journals
9570 \end_layout
9571
9572 \begin_layout Standard
9573
9574 \change_inserted 564990737 1671042072
9575 All the
9576 \family sans
9577 svj*
9578 \family default
9579  classes were replaced in 2013 with a completely new
9580 \family sans
9581 sr-vorl.cls
9582 \family default
9583 .
9584  This package provides a \SpecialChar LaTeX
9585  class and templates for books to be published at Springer Gabler Research,
9586  Springer Vieweg Research,
9587  Springer Spektrum Research,
9588  Springer VS Research,
9589  or Springer VS Forschung.
9590  The documentation is available in German from
9591 \begin_inset CommandInset href
9592 LatexCommand href
9593 name "CTAN"
9594 target "http://mirrors.ctan.org/macros/latex/contrib/springer/sr-vorl/sr-vorl.pdf"
9595 literal "false"
9596
9597 \end_inset
9598
9599 .
9600 \end_layout
9601
9602 \begin_layout Section
9603
9604 \change_inserted 564990737 1670439560
9605 Books
9606 \end_layout
9607
9608 \begin_layout Standard
9609
9610 \change_inserted 564990737 1670439581
9611 See also the document classes in the Collections (section
9612 \begin_inset space ~
9613 \end_inset
9614
9615
9616 \begin_inset CommandInset ref
9617 LatexCommand ref
9618 reference "sec:Collections"
9619 nolink "false"
9620
9621 \end_inset
9622
9623 ).
9624 \end_layout
9625
9626 \begin_layout Subsection
9627 Memoir
9628 \end_layout
9629
9630 \begin_layout Standard
9631 By
9632 \noun on
9633 Jürgen Spitzmüller
9634 \end_layout
9635
9636 \begin_layout Subsubsection
9637 Overview
9638 \end_layout
9639
9640 \begin_layout Standard
9641 Memoir is a very powerful and constantly evolving class.
9642  It has been designed with regard to fictional and non-fictional literature.
9643  Its aim is to let the user have maximum control over the typesetting of his document.
9644  Memoir is based on the standard book class,
9645  but it can also emulate the article class (see below).
9646 \end_layout
9647
9648 \begin_layout Standard
9649 Peter Wilson,
9650  the developer of Memoir,
9651  is known as the author of lots of useful packages in the \SpecialChar LaTeX
9652  world.
9653  Most of them have been merged with Memoir.
9654  Therefore,
9655  it is much easier to layout the table of contents,
9656  appendices,
9657  chapter designs and such.
9658  \SpecialChar LyX
9659 ,
9660  though,
9661  does not support all of these goodies natively.
9662  Some of them might be added to forthcoming releases
9663 \begin_inset Foot
9664 status collapsed
9665
9666 \begin_layout Plain Layout
9667 You are invited to send suggestions to
9668 \begin_inset Flex URL
9669 status collapsed
9670
9671 \begin_layout Plain Layout
9672
9673 lyx-devel@lists.lyx.org
9674 \end_layout
9675
9676 \end_inset
9677
9678 .
9679 \end_layout
9680
9681 \end_inset
9682
9683 ,
9684  lots will probably never be supported,
9685  due to the limitations of \SpecialChar LyX
9686 's framework.
9687  Of course you can still use all features with the help of some native \SpecialChar LaTeX
9688  commands (\SpecialChar TeX
9689  code
9690 \begin_inset Foot
9691 status collapsed
9692
9693 \begin_layout Plain Layout
9694 Cf.
9695 \begin_inset ERT
9696 status collapsed
9697
9698 \begin_layout Plain Layout
9699
9700
9701 \backslash
9702
9703 \end_layout
9704
9705 \end_inset
9706
9707 section
9708 \begin_inset space ~
9709 \end_inset
9710
9711
9712 \begin_inset CommandInset ref
9713 LatexCommand ref
9714 reference "sec:Inserting-TeX-Code"
9715 nolink "false"
9716
9717 \end_inset
9718
9719  for details.
9720 \end_layout
9721
9722 \end_inset
9723
9724 ).
9725  In this section,
9726  we can only list those features that are natively supported by \SpecialChar LyX
9727 .
9728  For detailed descriptions (and for the rest of features) we recommend you have a look at the detailed manual of the Memoir class
9729 \begin_inset Foot
9730 status collapsed
9731
9732 \begin_layout Plain Layout
9733 Cf.
9734 \begin_inset ERT
9735 status collapsed
9736
9737 \begin_layout Plain Layout
9738
9739
9740 \backslash
9741
9742 \end_layout
9743
9744 \end_inset
9745
9746
9747 \begin_inset Flex URL
9748 status collapsed
9749
9750 \begin_layout Plain Layout
9751
9752 CTAN:/macros/latex/memoir/memman.pdf
9753 \end_layout
9754
9755 \end_inset
9756
9757 .
9758 \end_layout
9759
9760 \end_inset
9761
9762 ,
9763  which is not only a user guide for the class,
9764  but also both a comprehensive description on good typesetting and a superb example for good typesetting itself.
9765 \end_layout
9766
9767 \begin_layout Subsubsection
9768 Basic features and restrictions
9769 \end_layout
9770
9771 \begin_layout Standard
9772 Memoir supports basically all features of the standard book classes.
9773  There are,
9774  however,
9775  some differences,
9776  as follows:
9777 \end_layout
9778
9779 \begin_layout Description
9780 Font
9781 \begin_inset space ~
9782 \end_inset
9783
9784 sizes:
9785  Memoir has a broader range of font sizes:
9786  9,
9787  10,
9788  11,
9789  12,
9790  14,
9791  17
9792 \end_layout
9793
9794 \begin_layout Description
9795 Page
9796 \begin_inset space ~
9797 \end_inset
9798
9799 style:
9800  The fancy page style is not supported,
9801  due to a command clash between Memoir and the fancyhdr package (they both define a command with the same name,
9802  which confuses \SpecialChar LaTeX
9803 ).
9804  Instead,
9805  Memoir comes with a number of its own page styles (see
9806 \family sans
9807 Document\SpecialChar menuseparator
9808 Settings\SpecialChar menuseparator
9809 Page
9810 \begin_inset space ~
9811 \end_inset
9812
9813 Style
9814 \family default
9815 ).
9816  If you want to use these for the chapter pages,
9817  you have to use the command
9818 \family typewriter
9819
9820 \backslash
9821 chapterstyle
9822 \family default
9823  in the main text or in preamble (e.
9824 \begin_inset space \thinspace{}
9825 \end_inset
9826
9827 g.
9828 \begin_inset space \space{}
9829 \end_inset
9830
9831
9832 \family typewriter
9833
9834 \backslash
9835 chapterstyle{companion}
9836 \family default
9837 ).
9838 \end_layout
9839
9840 \begin_layout Description
9841 Sectioning:
9842  Sectionings (chapter,
9843  section,
9844  subsection etc.) come with an optional argument in the standard classes.
9845  With this,
9846  you can specify an alternative version of the title for the table of contents and the headers (for instance,
9847  if the title is too long).
9848  In \SpecialChar LyX
9849 ,
9850  you can do this via
9851 \family sans
9852 Insert\SpecialChar menuseparator
9853 Short
9854 \begin_inset space ~
9855 \end_inset
9856
9857 Title
9858 \family default
9859  at the beginning of a chapter/section.
9860  Memoir features a second optional argument and thus separates the table of contents from the header.
9861  You can define three variants of a title with this:
9862  one for the main text,
9863  one for the table of contents,
9864  and one for the headers.
9865  \SpecialChar LyX
9866  makes these available in form of specific
9867 \family sans
9868 Short Title
9869 \family default
9870  variants in the
9871 \family sans
9872 Insert
9873 \family default
9874  menu.
9875 \end_layout
9876
9877 \begin_layout Description
9878 TOC/LOT/LOF:
9879  In the standard classes (and in many other classes),
9880  the table of contents,
9881  the list of figures and the list of table start a new page automatically.
9882  Memoir does not follow this route.
9883  You have to insert a page break yourself,
9884  if you want to have one.
9885 \end_layout
9886
9887 \begin_layout Description
9888 Titlepage:
9889  For some unknown reason,
9890  Memoir uses pagination on the title page (in the standard classes,
9891  title pages are
9892 \begin_inset Quotes eld
9893 \end_inset
9894
9895 empty
9896 \begin_inset Quotes erd
9897 \end_inset
9898
9899 ).
9900  If you want an empty title page,
9901  type
9902 \family typewriter
9903
9904 \backslash
9905 aliaspagestyle{title}{empty}
9906 \family default
9907  in the preamble.
9908 \end_layout
9909
9910 \begin_layout Description
9911 Article:
9912  With the class option
9913 \emph on
9914 article
9915 \emph default
9916  (to be inserted in
9917 \family sans
9918 Document\SpecialChar menuseparator
9919 Settings\SpecialChar menuseparator
9920 Class Settings\SpecialChar menuseparator
9921 Custom
9922 \begin_inset space ~
9923 \end_inset
9924
9925 Options
9926 \family default
9927 ),
9928  you can emulate article style.
9929  That is,
9930  counters (footnotes,
9931  figures,
9932  tables etc.) will not be reset on new chapters,
9933  chapters don't start a new page (but are—
9934 in contrary to
9935 \begin_inset Quotes eld
9936 \end_inset
9937
9938 real
9939 \begin_inset Quotes erd
9940 \end_inset
9941
9942  article classes—
9943 still allowed),
9944  parts,
9945  though,
9946  use their own page,
9947  as in book.
9948 \end_layout
9949
9950 \begin_layout Description
9951 Oldfontcommands:
9952  By default,
9953  Memoir does not allow the use of the deprecated font commands,
9954  which have been used in the old \SpecialChar LaTeX
9955  version 2.09 (e.
9956 \begin_inset space \thinspace{}
9957 \end_inset
9958
9959 g.
9960 \begin_inset space \space{}
9961 \end_inset
9962
9963
9964 \family typewriter
9965
9966 \backslash
9967 rm
9968 \family default
9969 ,
9970
9971 \family typewriter
9972
9973 \backslash
9974 it
9975 \family default
9976 ).
9977  It produces an error and stops \SpecialChar LaTeX
9978  whenever such a command appears.
9979  The class option
9980 \emph on
9981 oldfontcommands
9982 \emph default
9983  reallows the commands and spits out warnings instead (which does at least not stop \SpecialChar LaTeX
9984 ).
9985  Since a lot of packages and particularly Bib\SpecialChar TeX
9986  style files are still using those commands,
9987  we have decided to use this option by default.
9988 \end_layout
9989
9990 \begin_layout Subsubsection
9991 Extra features
9992 \end_layout
9993
9994 \begin_layout Standard
9995 We will only describe the features supported by \SpecialChar LyX
9996  (which is not much currently).
9997  Please consult the Memoir manual
9998 \begin_inset Foot
9999 status collapsed
10000
10001 \begin_layout Plain Layout
10002 Cf.
10003 \begin_inset ERT
10004 status collapsed
10005
10006 \begin_layout Plain Layout
10007
10008
10009 \backslash
10010
10011 \end_layout
10012
10013 \end_inset
10014
10015
10016 \begin_inset Flex URL
10017 status collapsed
10018
10019 \begin_layout Plain Layout
10020
10021 CTAN:/macros/latex/memoir/memman.pdf
10022 \end_layout
10023
10024 \end_inset
10025
10026 .
10027 \end_layout
10028
10029 \end_inset
10030
10031  for details.
10032 \end_layout
10033
10034 \begin_layout Description
10035 Abstract:
10036  You may wonder why an abstract is an extra feature.
10037  Well,
10038  it is in book class.
10039  Usually books don't have abstracts.
10040  Memoir,
10041  however,
10042  has.
10043  You can use it wherever and how often you like.
10044 \end_layout
10045
10046 \begin_layout Description
10047 Chapterprecis:
10048  You may know this older typesetting style:
10049  The contents of a chapter are summarized below the title and also in the table of contents (e.
10050 \begin_inset space \thinspace{}
10051 \end_inset
10052
10053 g.
10054 \begin_inset space \space{}
10055 \end_inset
10056
10057
10058 \emph on
10059 Our hero arrives in Troia;
10060  he loses some friends;
10061  he finds others
10062 \emph default
10063 ).
10064  Chapterprecis does exactly this.
10065  It is therefore only sensible below a chapter.
10066 \end_layout
10067
10068 \begin_layout Description
10069 Epigraph:
10070  An epigraph is a smart slogan or motto at the beginning of a chapter.
10071  The epigraph environment provides an elegant way of typesetting such a motto.
10072  The motto itself (text) and its (optional) author (source) are divided by a short line.
10073  The author (source) can be inserted via
10074 \family sans
10075 Insert\SpecialChar menuseparator
10076 Epigraph Source
10077 \family default
10078 \emph on
10079 .
10080 \end_layout
10081
10082 \begin_layout Description
10083 Poemtitle:
10084  Memoir has lots of possibilities to typeset poetry (up to very complex figurative poems).
10085  \SpecialChar LyX
10086  can only support a few of them.
10087  One is poemtitle,
10088  which is a centered title for poems,
10089  which will also be added to the table of contents (verse is the standard environment for poems.
10090  Memoir has some enhanced versions of verse,
10091  but you need to use \SpecialChar TeX
10092  code,
10093  because they have to be nested inside regular verse environments,
10094  which is not possible with \SpecialChar LyX
10095 ).
10096 \end_layout
10097
10098 \begin_layout Description
10099 Poemtitle*:
10100  Same as poemtitle,
10101  but it adds no entry to the table of contents.
10102 \end_layout
10103
10104 \begin_layout Subsection
10105
10106 \change_inserted 564990737 1671442175
10107 Recipe Book
10108 \end_layout
10109
10110 \begin_layout Standard
10111
10112 \change_inserted 564990737 1671442175
10113 The document class
10114 \family typewriter
10115 RecipeBook.cls
10116 \family default
10117  uses the
10118 \family sans
10119 book
10120 \begin_inset space \thinspace{}
10121 \end_inset
10122
10123 (KOMA-Script)
10124 \family default
10125  document class but adds two environments:
10126 \end_layout
10127
10128 \begin_layout Description
10129
10130 \change_inserted 564990737 1671442175
10131 Recipe a numbered section environment at the
10132 \family typewriter
10133 Subsubsection
10134 \family default
10135  level which generates a bold centered heading above a double horizontal rule
10136 \end_layout
10137
10138 \begin_layout Description
10139
10140 \change_inserted 564990737 1671442175
10141 Ingredients a
10142 \family typewriter
10143 Description
10144 \family default
10145  environment where
10146 \series bold
10147 \emph on
10148 Ingredients
10149 \series default
10150 \emph default
10151  are what are being described and the environment ends with a horizontal rule.
10152 \end_layout
10153
10154 \begin_layout Standard
10155
10156 \change_inserted 564990737 1671642866
10157
10158 \family sans
10159 File\SpecialChar menuseparator
10160 Open Example\SpecialChar menuseparator
10161 Books\SpecialChar menuseparator
10162 Recipe Book
10163 \family default
10164  illustrates its use.
10165 \end_layout
10166
10167 \begin_layout Standard
10168
10169 \change_inserted 564990737 1671442175
10170 It is designed for typesetting one or two recipes per page,
10171  with dimensions of 5.5
10172 \begin_inset Quotes qrd
10173 \end_inset
10174
10175  x 8.5
10176 \begin_inset Quotes qrd
10177 \end_inset
10178
10179 .
10180  The hyperlinked table of contents (ToC) and page numbers make browsing recipes convenient,
10181  and the pages can be joined together or printed 2 per page to normal letterpaper easily.
10182  The size was chosen to work in half-page 3-ring binder cover sheets,
10183  because un-laminated paper just doesn't last in the kitchen.
10184 \end_layout
10185
10186 \begin_layout Standard
10187
10188 \change_inserted 564990737 1671442175
10189 The half-letter pages can be printed two per page using your printer driver,
10190  or bound together using
10191 \family typewriter
10192 pdfjam --nup 2x1 --papersize '{11in,8.5in}'
10193 \family default
10194
10195 \family typewriter
10196 Recipes.pdf
10197 \family default
10198  where
10199 \family typewriter
10200 Recipes.pdf
10201 \family default
10202  is the compiled version of your recipes.
10203 \end_layout
10204
10205 \begin_layout Section
10206
10207 \change_inserted 564990737 1671442207
10208 Curricula vitarum
10209 \end_layout
10210
10211 \begin_layout Subsection
10212
10213 \change_inserted 564990737 1671442208
10214 Europass
10215 \end_layout
10216
10217 \begin_layout Standard
10218
10219 \change_inserted 564990737 1671642942
10220 The document class
10221 \family sans
10222 curriculum
10223 \begin_inset space \space{}
10224 \end_inset
10225
10226 vitae
10227 \begin_inset space \thinspace{}
10228 \end_inset
10229
10230 (Europass)
10231 \family default
10232  provides the
10233 \family typewriter
10234 europasscv.cls
10235 \family default
10236  document class,
10237  an unofficial implementation of the ‘Europass CV’ recommended by the European Commission in 2013.
10238
10239 \family sans
10240 File\SpecialChar menuseparator
10241 Open Example\SpecialChar menuseparator
10242 Curricula Vitae\SpecialChar menuseparator
10243 Europass CV (2013)
10244 \family default
10245  offers guidance on its use.
10246  Its documentation is available from
10247 \begin_inset CommandInset href
10248 LatexCommand href
10249 name "CTAN"
10250 target "http://mirrors.ctan.org/macros/latex/contrib/europasscv/europasscv.pdf"
10251 literal "false"
10252
10253 \end_inset
10254
10255 .
10256 \end_layout
10257
10258 \begin_layout Subsection
10259
10260 \change_inserted 564990737 1671442208
10261 European
10262 \end_layout
10263
10264 \begin_layout Standard
10265
10266 \change_inserted 564990737 1671642984
10267 The document class
10268 \family sans
10269 curriculum
10270 \begin_inset space \space{}
10271 \end_inset
10272
10273 vitae
10274 \begin_inset space \thinspace{}
10275 \end_inset
10276
10277 (Europe)
10278 \family default
10279  provides the
10280 \family typewriter
10281 europecv.cls
10282 \family default
10283  document class,
10284  an unofficial implementation of the “Europass CV” recommended by the European Commission in 2002.
10285
10286 \family sans
10287 File\SpecialChar menuseparator
10288 Open Example\SpecialChar menuseparator
10289 Curricula Vitae\SpecialChar menuseparator
10290 Europe CV
10291 \family default
10292  offers guidance on its use.
10293  Its documentation is available from
10294 \begin_inset CommandInset href
10295 LatexCommand href
10296 name "CTAN"
10297 target "http://mirrors.ctan.org/macros/latex/contrib/europecv/europecv.pdf"
10298 literal "false"
10299
10300 \end_inset
10301
10302 .
10303 \end_layout
10304
10305 \begin_layout Subsection
10306
10307 \change_inserted 564990737 1671442208
10308 Modern
10309 \end_layout
10310
10311 \begin_layout Standard
10312
10313 \change_inserted 564990737 1671643003
10314 The document class
10315 \family sans
10316 curriculum
10317 \begin_inset space \space{}
10318 \end_inset
10319
10320 vitae
10321 \begin_inset space \thinspace{}
10322 \end_inset
10323
10324 (modern)
10325 \family default
10326  provides the
10327 \family typewriter
10328 moderncv.cls
10329 \family default
10330  document class.
10331  This allows the creation of customizable CVs.
10332
10333 \family sans
10334 File\SpecialChar menuseparator
10335 Open Example\SpecialChar menuseparator
10336 Curricula Vitae\SpecialChar menuseparator
10337 Modern CV
10338 \family default
10339  offers guidance on its use.
10340  Its documentation is available from
10341 \begin_inset CommandInset href
10342 LatexCommand href
10343 name "CTAN"
10344 target "http://mirrors.ctan.org/macros/latex/contrib/moderncv/manual/moderncv_userguide.pdf"
10345 literal "false"
10346
10347 \end_inset
10348
10349 .
10350 \end_layout
10351
10352 \begin_layout Subsection
10353
10354 \change_inserted 564990737 1671442208
10355 Simple
10356 \end_layout
10357
10358 \begin_layout Standard
10359
10360 \change_inserted 564990737 1671643024
10361 The document class
10362 \family sans
10363 curriculum
10364 \begin_inset space \space{}
10365 \end_inset
10366
10367 vitae
10368 \begin_inset space \thinspace{}
10369 \end_inset
10370
10371 (simple)
10372 \family default
10373  provides the
10374 \family typewriter
10375 simplecv.cls
10376 \family default
10377  document class,
10378  originally developed for use with \SpecialChar LyX
10379 .
10380
10381 \family sans
10382 File\SpecialChar menuseparator
10383 Open Example\SpecialChar menuseparator
10384 Curricula Vitae\SpecialChar menuseparator
10385 Simple CV
10386 \family default
10387  offers guidance on its use.
10388  Its documentation is available from
10389 \begin_inset CommandInset href
10390 LatexCommand href
10391 name "CTAN"
10392 target "http://mirrors.ctan.org/macros/latex/contrib/simplecv/simplecv.pdf"
10393 literal "false"
10394
10395 \end_inset
10396
10397
10398 \end_layout
10399
10400 \begin_layout Section
10401
10402 \change_inserted 564990737 1672652454
10403 Letters
10404 \end_layout
10405
10406 \begin_layout Standard
10407
10408 \change_inserted 564990737 1672652455
10409 See also the
10410 \family typewriter
10411 letter
10412 \begin_inset space \space{}
10413 \end_inset
10414
10415 (KOMA-Script v.2)
10416 \family default
10417  (section
10418 \begin_inset space ~
10419 \end_inset
10420
10421
10422 \begin_inset CommandInset ref
10423 LatexCommand ref
10424 reference "subsec:The-new-letter"
10425 nolink "false"
10426
10427 \end_inset
10428
10429 ) and
10430 \family typewriter
10431 letter
10432 \begin_inset space \space{}
10433 \end_inset
10434
10435 (with extra font sizes)
10436 \family default
10437  (section
10438 \begin_inset space ~
10439 \end_inset
10440
10441
10442 \begin_inset CommandInset ref
10443 LatexCommand ref
10444 reference "subsec:Extra-font-sizes"
10445 nolink "false"
10446
10447 \end_inset
10448
10449 ) document classes .
10450 \end_layout
10451
10452 \begin_layout Subsection
10453
10454 \change_inserted 564990737 1671041970
10455 Din-Brief
10456 \end_layout
10457
10458 \begin_layout Standard
10459
10460 \change_inserted 564990737 1671617528
10461 The document class
10462 \family sans
10463 Din-Brief
10464 \family default
10465  provides the
10466 \family typewriter
10467 dinbrief.cls
10468 \family default
10469  document class for writing letters according to the
10470 \emph on
10471 Deutsches Institut für Normung
10472 \emph default
10473  conventions.
10474  The file in the menu
10475 \family sans
10476 \bar under
10477 F
10478 \bar default
10479 ile\SpecialChar menuseparator
10480 New
10481 \begin_inset space ~
10482 \end_inset
10483
10484 fro
10485 \bar under
10486 m
10487 \bar default
10488
10489 \begin_inset space ~
10490 \end_inset
10491
10492 Template\SpecialChar menuseparator
10493 Letters\SpecialChar menuseparator
10494 DIN-Brief
10495 \family default
10496  offers guidance on its use.
10497  The documentation is available from
10498 \begin_inset CommandInset href
10499 LatexCommand href
10500 name "CTAN"
10501 target "http://mirrors.ctan.org/macros/latex/contrib/dinbrief/liesmich"
10502 literal "false"
10503
10504 \end_inset
10505
10506 .
10507 \end_layout
10508
10509 \begin_layout Subsection
10510
10511 \change_inserted 564990737 1672652499
10512 frletter
10513 \end_layout
10514
10515 \begin_layout Standard
10516
10517 \change_inserted 564990737 1672652499
10518 The document class
10519 \family sans
10520 French letter
10521 \begin_inset space \space{}
10522 \end_inset
10523
10524 (frletter)
10525 \family default
10526  provides the
10527 \family typewriter
10528 frletter.cls
10529 \family default
10530  document class for writing letters according to French conventions.
10531  The file in the menu
10532 \family sans
10533 \bar under
10534 F
10535 \bar default
10536 ile\SpecialChar menuseparator
10537 New
10538 \begin_inset space ~
10539 \end_inset
10540
10541 fro
10542 \bar under
10543 m
10544 \bar default
10545
10546 \begin_inset space ~
10547 \end_inset
10548
10549 Template\SpecialChar menuseparator
10550 Letters\SpecialChar menuseparator
10551 French letter
10552 \begin_inset space \space{}
10553 \end_inset
10554
10555 (frletter)
10556 \family default
10557  offers guidance on its use.
10558 \end_layout
10559
10560 \begin_layout Subsection
10561
10562 \change_inserted 564990737 1672652499
10563 G-Brief
10564 \end_layout
10565
10566 \begin_layout Standard
10567
10568 \change_inserted 564990737 1672652499
10569 The document class
10570 \family sans
10571 G-Brief (V.
10572 \begin_inset space \thinspace{}
10573 \end_inset
10574
10575 2)
10576 \family default
10577  provides the newer
10578 \family typewriter
10579 g-brief2.cls
10580 \family default
10581  document class for writing letters in German.
10582  The file in the menu
10583 \family sans
10584 \bar under
10585 F
10586 \bar default
10587 ile\SpecialChar menuseparator
10588 New
10589 \begin_inset space ~
10590 \end_inset
10591
10592 fro
10593 \bar under
10594 m
10595 \bar default
10596
10597 \begin_inset space ~
10598 \end_inset
10599
10600 Template\SpecialChar menuseparator
10601 Letters\SpecialChar menuseparator
10602 G-Brief (V.
10603 \begin_inset space \thinspace{}
10604 \end_inset
10605
10606 2)
10607 \family default
10608  offers guidance on its use.
10609  The documentation is available from
10610 \begin_inset CommandInset href
10611 LatexCommand href
10612 name "CTAN"
10613 target "http://mirrors.ctan.org/macros/latex/contrib/g-brief/g-brief.pdf"
10614 literal "false"
10615
10616 \end_inset
10617
10618 .
10619 \end_layout
10620
10621 \begin_layout Subsection
10622
10623 \change_inserted 564990737 1671458835
10624 letter
10625 \end_layout
10626
10627 \begin_layout Standard
10628
10629 \change_inserted 564990737 1671617591
10630 The document class
10631 \family sans
10632 letter
10633 \family default
10634  provides the
10635 \family sans
10636 letter.cls
10637 \family default
10638  document class for English letters and to create mailing labels.
10639  The file in the menu
10640 \family sans
10641 \bar under
10642 F
10643 \bar default
10644 ile\SpecialChar menuseparator
10645 New
10646 \begin_inset space ~
10647 \end_inset
10648
10649 fro
10650 \bar under
10651 m
10652 \bar default
10653
10654 \begin_inset space ~
10655 \end_inset
10656
10657 Template\SpecialChar menuseparator
10658 Letters\SpecialChar menuseparator
10659 Letter (Standard Class)
10660 \family default
10661  offers guidance on its use.
10662 \end_layout
10663
10664 \begin_layout Subsection
10665
10666 \change_inserted 564990737 1672652527
10667 lettre
10668 \end_layout
10669
10670 \begin_layout Standard
10671
10672 \change_inserted 564990737 1672652527
10673 The document class
10674 \family sans
10675 French letter
10676 \begin_inset space \space{}
10677 \end_inset
10678
10679 (lettre)
10680 \family default
10681  provides the
10682 \family typewriter
10683 lettre.cls
10684 \family default
10685  document class for writing letters,
10686  faxes and envelopes in French.
10687  The file in the menu
10688 \family sans
10689 \bar under
10690 F
10691 \bar default
10692 ile\SpecialChar menuseparator
10693 New
10694 \begin_inset space ~
10695 \end_inset
10696
10697 fro
10698 \bar under
10699 m
10700 \bar default
10701
10702 \begin_inset space ~
10703 \end_inset
10704
10705 Template\SpecialChar menuseparator
10706 Letters\SpecialChar menuseparator
10707 French letter
10708 \begin_inset space \space{}
10709 \end_inset
10710
10711 (lettre)
10712 \family default
10713  offers guidance on its use.
10714  The documentation is available from
10715 \begin_inset CommandInset href
10716 LatexCommand href
10717 name "CTAN"
10718 target "http://mirrors.ctan.org/macros/latex/contrib/lettre/lettre.pdf"
10719 literal "false"
10720
10721 \end_inset
10722
10723 .
10724 \end_layout
10725
10726 \begin_layout Section
10727
10728 \change_inserted 564990737 1670439660
10729 Presentations
10730 \end_layout
10731
10732 \begin_layout Subsection
10733
10734 \change_inserted 564990737 1671458922
10735 Beamer
10736 \end_layout
10737
10738 \begin_layout Standard
10739
10740 \change_inserted 564990737 1671617655
10741 The document class
10742 \family sans
10743 presentation
10744 \begin_inset space \thinspace{}
10745 \end_inset
10746
10747 (beamer)
10748 \family default
10749  uses the
10750 \family typewriter
10751 beamer.cls
10752 \family default
10753  document class for creating presentations.
10754  The file in the menu
10755 \family sans
10756 \bar under
10757 F
10758 \bar default
10759 ile\SpecialChar menuseparator
10760 New
10761 \begin_inset space ~
10762 \end_inset
10763
10764 fro
10765 \bar under
10766 m
10767 \bar default
10768
10769 \begin_inset space ~
10770 \end_inset
10771
10772 Template\SpecialChar menuseparator
10773 Presentations\SpecialChar menuseparator
10774 Beamer
10775 \family default
10776  offers guidance on its use.
10777  The documentation is available from
10778 \begin_inset CommandInset href
10779 LatexCommand href
10780 name "CTAN"
10781 target "http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf"
10782 literal "false"
10783
10784 \end_inset
10785
10786 .
10787 \end_layout
10788
10789 \begin_layout Subsection
10790 Foils [aka
10791 \family sans
10792 Foil\SpecialChar TeX
10793
10794 \family default
10795 ]
10796 \begin_inset CommandInset label
10797 LatexCommand label
10798 name "sec:foiltex"
10799
10800 \end_inset
10801
10802
10803 \end_layout
10804
10805 \begin_layout Standard
10806
10807 \change_inserted 564990737 1672743383
10808 Original by
10809 \noun on
10810 Allan Rae
10811 \noun default
10812 ;
10813  updated by the \SpecialChar LyX
10814  Team
10815 \end_layout
10816
10817 \begin_layout Subsubsection
10818
10819 \change_inserted 564990737 1672743383
10820 Introduction
10821 \end_layout
10822
10823 \begin_layout Standard
10824
10825 \change_inserted 564990737 1672743396
10826 The document class
10827 \family sans
10828 presentation
10829 \begin_inset space \thinspace{}
10830 \end_inset
10831
10832 (Foil\SpecialChar TeX
10833 )
10834 \family default
10835  uses the
10836 \family typewriter
10837 foils.cls
10838 \family default
10839  document class to make slides for overhead projectors.
10840  There are two document classes that can do this:
10841  the
10842 \family sans
10843 presentations
10844 \begin_inset space \thinspace{}
10845 \end_inset
10846
10847 (slides)
10848 \family default
10849  document class (section
10850 \begin_inset space ~
10851 \end_inset
10852
10853
10854 \begin_inset CommandInset ref
10855 LatexCommand ref
10856 reference "sec:slitex"
10857 plural "false"
10858 caps "false"
10859 noprefix "false"
10860 nolink "false"
10861
10862 \end_inset
10863
10864 ) and the
10865 \family sans
10866 Foil\SpecialChar TeX
10867
10868 \family default
10869  slides class.
10870  As of 2023 the former has continued to be maintained whereas
10871 \family sans
10872 Foil\SpecialChar TeX
10873
10874 \family default
10875  has not been maintained since 2008.
10876  This section documents the latter.
10877  If your machine doesn’t have the
10878 \family sans
10879 presentation
10880 \begin_inset space \thinspace{}
10881 \end_inset
10882
10883 (Foil\SpecialChar TeX
10884 )
10885 \family default
10886  document class installed,
10887  you’ll probably have to use the
10888 \family sans
10889 presentations
10890 \begin_inset space \thinspace{}
10891 \end_inset
10892
10893 (slides)
10894 \family default
10895  document class.
10896  If you want to install the
10897 \family typewriter
10898 foils.cls
10899 \family default
10900  document class,
10901  it is available from
10902 \begin_inset CommandInset href
10903 LatexCommand href
10904 name "CTAN"
10905 target "https://www.ctan.org/pkg/foiltex"
10906 literal "false"
10907
10908 \end_inset
10909
10910 .
10911  You should also read the
10912 \emph on
10913 Installing New Document Classes
10914 \emph default
10915  chapter of the
10916 \emph on
10917 Customization
10918 \emph default
10919  manual.
10920 \change_deleted 564990737 1672743436
10921 by
10922 \noun on
10923 Allan Rae
10924 \end_layout
10925
10926 \begin_layout Standard
10927
10928 \change_deleted 564990737 1672743383
10929 Introduction
10930 \end_layout
10931
10932 \begin_layout Standard
10933
10934 \change_deleted 564990737 1672743383
10935 This section describes how to use \SpecialChar LyX
10936  to make slides for overhead projectors.
10937  There are two document classes that can do this:
10938  the default slides class and the
10939 \family sans
10940 Foil\SpecialChar TeX
10941
10942 \family default
10943  slides class.
10944  This section documents the latter.
10945 \end_layout
10946
10947 \begin_layout Standard
10948
10949 \change_deleted 564990737 1672743383
10950 I'm going to say this again,
10951  nice and clear,
10952  so that there's no misunderstanding:
10953 \end_layout
10954
10955 \begin_layout Standard
10956
10957 \change_deleted 564990737 1672743383
10958 \begin_inset VSpace bigskip
10959 \end_inset
10960
10961
10962 \end_layout
10963
10964 \begin_layout Standard
10965 \align center
10966
10967 \change_deleted 564990737 1672743383
10968
10969 \size large
10970 This section documents the class
10971 \begin_inset Quotes eld
10972 \end_inset
10973
10974
10975 \family sans
10976 FoilTeX
10977 \family default
10978
10979 \begin_inset Quotes erd
10980 \end_inset
10981
10982
10983 \emph on
10984 only.
10985 \end_layout
10986
10987 \begin_layout Standard
10988
10989 \change_deleted 564990737 1672743383
10990 \begin_inset VSpace bigskip
10991 \end_inset
10992
10993
10994 \end_layout
10995
10996 \begin_layout Standard
10997
10998 \change_deleted 564990737 1672743383
10999 If you're looking for the documentation for
11000 \begin_inset Quotes eld
11001 \end_inset
11002
11003
11004 \family sans
11005 slides (default)
11006 \family default
11007
11008 \begin_inset Quotes erd
11009 \end_inset
11010
11011 ,
11012  check out section
11013 \begin_inset space ~
11014 \end_inset
11015
11016
11017 \begin_inset CommandInset ref
11018 LatexCommand ref
11019 reference "sec:slitex"
11020 nolink "false"
11021
11022 \end_inset
11023
11024 .
11025  If your machine doesn't have the
11026 \family sans
11027 foils
11028 \family default
11029  class
11030 \family sans
11031 FoilTeX
11032 \family default
11033  installed,
11034  you'll probably have to use the default
11035 \family sans
11036 slides
11037 \family default
11038  class,
11039  which isn't quite as good as
11040 \family sans
11041 foils.
11042 \end_layout
11043
11044 \begin_layout Standard
11045
11046 \change_deleted 564990737 1672743383
11047 The
11048 \family sans
11049 foils
11050 \family default
11051  class is designed for use with version
11052 \begin_inset space ~
11053 \end_inset
11054
11055 2.1 of the
11056 \family sans
11057 foils.cls
11058 \family default
11059  \SpecialChar LaTeX
11060  class file which is now an integral part of \SpecialChar LaTeX2e
11061 .
11062 \change_unchanged
11063
11064 \end_layout
11065
11066 \begin_layout Subsubsection
11067 Getting Started
11068 \end_layout
11069
11070 \begin_layout Standard
11071 Obviously,
11072  to use this document class,
11073  you need to select
11074 \family sans
11075 FoilTeX
11076 \family default
11077  from the
11078 \family sans
11079 Class
11080 \family default
11081  entry in the
11082 \family sans
11083 Document
11084 \begin_inset space ~
11085 \end_inset
11086
11087 Layout
11088 \family default
11089  dialog.
11090  There are some settings in the
11091 \family sans
11092 Document
11093 \begin_inset space ~
11094 \end_inset
11095
11096 Layout
11097 \family default
11098  dialog that you should know about that are specific to this class:
11099 \end_layout
11100
11101 \begin_layout Itemize
11102 Don't change the options
11103 \family sans
11104 Sides
11105 \family default
11106  and
11107 \family sans
11108 Columns
11109 \family default
11110  on the
11111 \family sans
11112 Document
11113 \begin_inset space ~
11114 \end_inset
11115
11116 Layout
11117 \family default
11118  dialog.
11119  They're ignored by the
11120 \family sans
11121 foils
11122 \family default
11123  class.
11124 \end_layout
11125
11126 \begin_layout Itemize
11127 The default font size is 20
11128 \begin_inset space \thinspace{}
11129 \end_inset
11130
11131 pt with the other options being 17
11132 \begin_inset space \thinspace{}
11133 \end_inset
11134
11135 pt,
11136  25
11137 \begin_inset space \thinspace{}
11138 \end_inset
11139
11140 pt and 30
11141 \begin_inset space \thinspace{}
11142 \end_inset
11143
11144 pt.
11145 \end_layout
11146
11147 \begin_layout Itemize
11148 The default font is
11149 \family sans
11150 sans
11151 \family default
11152
11153 \family sans
11154 serif
11155 \family default
11156  but all math equations are still typeset in the usual roman font.
11157 \end_layout
11158
11159 \begin_layout Itemize
11160
11161 \family sans
11162 Foil\SpecialChar TeX
11163
11164 \family default
11165  supports A4 and Letter paper sizes as well as a special size for working with 35
11166 \begin_inset space \thinspace{}
11167 \end_inset
11168
11169 mm slides.
11170  It doesn't support A5,
11171  B5,
11172  legal or executive paper sizes.
11173 \end_layout
11174
11175 \begin_layout Itemize
11176 Don't bother changing the
11177 \family sans
11178 Float Placement
11179 \family default
11180  settings because they are ignored anyway.
11181  All floats appear where they are defined in the text.
11182 \end_layout
11183
11184 \begin_layout Itemize
11185 The
11186 \family sans
11187 Pagestyle
11188 \family default
11189  setting behaves a bit differently for this class.
11190
11191 \family sans
11192 Foil\SpecialChar TeX
11193
11194 \family default
11195  provides extensive footer and header capabilities including a user-defined logo.
11196  See section
11197 \begin_inset space ~
11198 \end_inset
11199
11200
11201 \begin_inset CommandInset ref
11202 LatexCommand ref
11203 reference "sec:foilfoot"
11204 nolink "false"
11205
11206 \end_inset
11207
11208  for more details.
11209  The title page is treated differently to all other pages in the document and is
11210 \emph on
11211 always
11212 \emph default
11213  unnumbered and
11214 \emph on
11215 always
11216 \emph default
11217  has the logo centered at the bottom of the page (if one is defined).
11218  The possible page style choices and what they do are as follows:
11219 \end_layout
11220
11221 \begin_deeper
11222 \begin_layout Labeling
11223 \labelwidthstring MMMMMMM
11224
11225 \family sans
11226 \series bold
11227 empty
11228 \family default
11229 \series default
11230  The final output contains no page numbers,
11231  or other headers or footers (except footnotes of course).
11232
11233 \end_layout
11234
11235 \begin_layout Labeling
11236 \labelwidthstring MMMMMMM
11237
11238 \family sans
11239 \series bold
11240 plain
11241 \family default
11242 \series default
11243  The final output contains page numbers centered at the bottom of the page.
11244  No other headings or footers (other than footnotes).
11245 \end_layout
11246
11247 \begin_layout Labeling
11248 \labelwidthstring MMMMMMM
11249
11250 \series bold
11251 foilheadings
11252 \series default
11253  Page numbers in lower right corner.
11254  Additional headers and footers are also shown.
11255  This is also the default.
11256 \end_layout
11257
11258 \begin_layout Labeling
11259 \labelwidthstring MMMMMMM
11260
11261 \series bold
11262 fancy
11263 \series default
11264  Gives you access to the
11265 \family sans
11266 fancyheadings
11267 \family default
11268  package although its use with
11269 \family sans
11270 Foil\SpecialChar TeX
11271
11272 \family default
11273  is discouraged by the writer of the
11274 \family sans
11275 Foil\SpecialChar TeX
11276
11277 \family default
11278  package because of some potential page layout clashes.
11279 \end_layout
11280
11281 \end_deeper
11282 \begin_layout Paragraph
11283 Extra Options
11284 \end_layout
11285
11286 \begin_layout Standard
11287 The following options may be used in the extra class options in the
11288 \family sans
11289 Document\SpecialChar menuseparator
11290 Settings
11291 \family default
11292  dialog.
11293 \end_layout
11294
11295 \begin_layout Labeling
11296 \labelwidthstring MMMMMMx
11297
11298 \series bold
11299 35mmSlide
11300 \series default
11301  This sets up the page layout for 7.33
11302 \begin_inset space \thinspace{}
11303 \end_inset
11304
11305 in by 11
11306 \begin_inset space \thinspace{}
11307 \end_inset
11308
11309 in paper,
11310  which is about the same aspect ratio as a 35
11311 \begin_inset space \thinspace{}
11312 \end_inset
11313
11314 mm slide,
11315  making it a bit easier to work with this medium.
11316 \end_layout
11317
11318 \begin_layout Labeling
11319 \labelwidthstring MMMMMMx
11320
11321 \series bold
11322 headrule
11323 \series default
11324  Places a rule across the page below the header on every page except the title page.
11325 \end_layout
11326
11327 \begin_layout Labeling
11328 \labelwidthstring MMMMMMx
11329
11330 \series bold
11331 footrule
11332 \series default
11333  Places a rule across the page above the footer on every page except the title page.
11334 \end_layout
11335
11336 \begin_layout Labeling
11337 \labelwidthstring MMMMMMx
11338
11339 \series bold
11340 dvips
11341 \series default
11342  This is automatically set each time you create a new
11343 \family sans
11344 foils
11345 \family default
11346  document.
11347  This option tells
11348 \family sans
11349 Foil\SpecialChar TeX
11350
11351 \family default
11352  to use the dvips driver to rotate those pages that are set as landscape foils.
11353 \end_layout
11354
11355 \begin_layout Labeling
11356 \labelwidthstring MMMMMMx
11357
11358 \series bold
11359 landscape
11360 \series default
11361  Simply changes the page dimensions to those of a landscape page but doesn't do any rotation.
11362  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.
11363  Note that this option effectively reverses the roles of the
11364 \family sans
11365 Foilhead
11366 \family default
11367  and
11368 \family sans
11369 Rotatefoilhead
11370 \family default
11371  environments (don't worry these are described in the next section).
11372 \end_layout
11373
11374 \begin_layout Labeling
11375 \labelwidthstring MMMMMMx
11376
11377 \series bold
11378 leqno
11379 \series default
11380  Equation numbers on the left.
11381 \end_layout
11382
11383 \begin_layout Labeling
11384 \labelwidthstring MMMMMMx
11385
11386 \series bold
11387 fleqn
11388 \series default
11389  Flush-left equations.
11390 \end_layout
11391
11392 \begin_layout Subsubsection
11393 Supported Environments
11394 \end_layout
11395
11396 \begin_layout Standard
11397 Most of the environments commonly supported in other classes are also supported by the
11398 \family sans
11399 foils
11400 \family default
11401  class.
11402  There are several additional environments provided by
11403 \family sans
11404 Foil\SpecialChar TeX
11405
11406 \family default
11407  as well as a couple added by \SpecialChar LyX
11408 .
11409  The following environments are shared with other classes:
11410 \end_layout
11411
11412 \begin_layout Standard
11413 \begin_inset Flex Multiple Columns
11414 status open
11415
11416 \begin_layout Itemize
11417
11418 \family sans
11419 Standard
11420 \end_layout
11421
11422 \begin_layout Itemize
11423
11424 \family sans
11425 Itemize
11426 \end_layout
11427
11428 \begin_layout Itemize
11429
11430 \family sans
11431 Enumerate
11432 \end_layout
11433
11434 \begin_layout Itemize
11435
11436 \family sans
11437 Description
11438 \end_layout
11439
11440 \begin_layout Itemize
11441
11442 \family sans
11443 List
11444 \end_layout
11445
11446 \begin_layout Itemize
11447
11448 \family sans
11449 \SpecialChar LyX
11450 -Code
11451 \end_layout
11452
11453 \begin_layout Itemize
11454
11455 \family sans
11456 Verse
11457 \end_layout
11458
11459 \begin_layout Itemize
11460
11461 \family sans
11462 Quote
11463 \end_layout
11464
11465 \begin_layout Itemize
11466
11467 \family sans
11468 Quotation
11469 \end_layout
11470
11471 \begin_layout Itemize
11472
11473 \family sans
11474 TitleAuthor
11475 \end_layout
11476
11477 \begin_layout Itemize
11478
11479 \family sans
11480 Date
11481 \end_layout
11482
11483 \begin_layout Itemize
11484
11485 \family sans
11486 Abstract
11487 \end_layout
11488
11489 \begin_layout Itemize
11490
11491 \family sans
11492 Bibliography
11493 \end_layout
11494
11495 \begin_layout Itemize
11496
11497 \family sans
11498 Address
11499 \end_layout
11500
11501 \begin_layout Itemize
11502
11503 \family sans
11504 RightAddress
11505 \end_layout
11506
11507 \end_inset
11508
11509
11510 \end_layout
11511
11512 \begin_layout Standard
11513 That is,
11514  all the major environments apart from the sectioning environments.
11515  Since foils are essentially self-contained sections,
11516  with a title and body,
11517
11518 \family sans
11519 Foil\SpecialChar TeX
11520
11521 \family default
11522  provides specific commands for starting new foils and these are:
11523 \end_layout
11524
11525 \begin_layout Itemize
11526
11527 \family sans
11528 Foilhead
11529 \end_layout
11530
11531 \begin_layout Itemize
11532
11533 \family sans
11534 Rotatefoilhead
11535 \end_layout
11536
11537 \begin_layout Standard
11538 \SpecialChar LyX
11539  also provides slightly modified versions of these two environments called:
11540 \end_layout
11541
11542 \begin_layout Itemize
11543
11544 \family sans
11545 ShortFoilhead
11546 \end_layout
11547
11548 \begin_layout Itemize
11549
11550 \family sans
11551 ShortRotatefoilhead
11552 \end_layout
11553
11554 \begin_layout Standard
11555 and the differences will be explained in the next section.
11556 \end_layout
11557
11558 \begin_layout Standard
11559 Since foils are often used in presenting ideas or new theorems and such
11560 \family sans
11561 Foil\SpecialChar TeX
11562
11563 \family default
11564  also provides a comprehensive box of goodies for presenting them:
11565 \end_layout
11566
11567 \begin_layout Standard
11568 \begin_inset Flex Multiple Columns
11569 status open
11570
11571 \begin_layout Itemize
11572
11573 \family sans
11574 Theorem
11575 \end_layout
11576
11577 \begin_layout Itemize
11578
11579 \family sans
11580 Lemma
11581 \end_layout
11582
11583 \begin_layout Itemize
11584
11585 \family sans
11586 Corollary
11587 \end_layout
11588
11589 \begin_layout Itemize
11590
11591 \family sans
11592 Proposition
11593 \end_layout
11594
11595 \begin_layout Itemize
11596
11597 \family sans
11598 Definition
11599 \end_layout
11600
11601 \begin_layout Itemize
11602
11603 \family sans
11604 Proof
11605 \end_layout
11606
11607 \begin_layout Itemize
11608
11609 \family sans
11610 Theorem*
11611 \end_layout
11612
11613 \begin_layout Itemize
11614
11615 \family sans
11616 Lemma*
11617 \end_layout
11618
11619 \begin_layout Itemize
11620
11621 \family sans
11622 Corollary*
11623 \end_layout
11624
11625 \begin_layout Itemize
11626
11627 \family sans
11628 Proposition*
11629 \end_layout
11630
11631 \begin_layout Itemize
11632
11633 \family sans
11634 Definition*
11635 \end_layout
11636
11637 \end_inset
11638
11639
11640 \end_layout
11641
11642 \begin_layout Standard
11643 The starred versions are unnumbered while the unstarred versions are numbered.
11644  There are also two list environments added by \SpecialChar LyX
11645  and these are:
11646 \end_layout
11647
11648 \begin_layout Itemize
11649
11650 \family sans
11651 TickList
11652 \end_layout
11653
11654 \begin_layout Itemize
11655
11656 \family sans
11657 CrossList
11658 \end_layout
11659
11660 \begin_layout Standard
11661
11662 \family sans
11663 Foil\SpecialChar TeX
11664
11665 \family default
11666  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.
11667  If you want to change these settings in your document the best place to do so is at the very top of a foil,
11668  i.
11669 \begin_inset space \thinspace{}
11670 \end_inset
11671
11672 e.
11673 \emph on
11674
11675 \begin_inset space \space{}
11676 \end_inset
11677
11678
11679 \emph default
11680 straight after the foilhead.
11681 \end_layout
11682
11683 \begin_layout Standard
11684 For this purpose,
11685  the following command styles are provided [
11686 \shape smallcaps
11687 Martin Vermeer
11688 \shape default
11689 ]:
11690 \end_layout
11691
11692 \begin_layout Standard
11693 \begin_inset Flex Multiple Columns
11694 status open
11695
11696 \begin_layout Itemize
11697
11698 \family sans
11699 My
11700 \begin_inset space ~
11701 \end_inset
11702
11703 Logo
11704 \end_layout
11705
11706 \begin_layout Itemize
11707
11708 \family sans
11709 Restriction
11710 \end_layout
11711
11712 \begin_layout Itemize
11713
11714 \family sans
11715 Right
11716 \begin_inset space ~
11717 \end_inset
11718
11719 Footer
11720 \end_layout
11721
11722 \begin_layout Itemize
11723
11724 \family sans
11725 Right
11726 \begin_inset space ~
11727 \end_inset
11728
11729 Header
11730 \end_layout
11731
11732 \begin_layout Itemize
11733
11734 \family sans
11735 Left
11736 \begin_inset space ~
11737 \end_inset
11738
11739 Header
11740 \end_layout
11741
11742 \begin_deeper
11743 \begin_layout Plain Layout
11744 \begin_inset space ~
11745 \end_inset
11746
11747
11748 \end_layout
11749
11750 \end_deeper
11751 \end_inset
11752
11753
11754 \end_layout
11755
11756 \begin_layout Standard
11757 There are also a few commands provided by
11758 \family sans
11759 Foil\SpecialChar TeX
11760
11761 \family default
11762  that aren't directly supported by \SpecialChar LyX
11763  but I'll tell you what they do and how to use them in section
11764 \begin_inset space ~
11765 \end_inset
11766
11767
11768 \begin_inset CommandInset ref
11769 LatexCommand ref
11770 reference "sec:unsuppfoils"
11771 nolink "false"
11772
11773 \end_inset
11774
11775 .
11776 \end_layout
11777
11778 \begin_layout Subsubsection
11779 Building a Set of Foils
11780 \end_layout
11781
11782 \begin_layout Standard
11783 This section will give a simple introduction to using the different environments to build a set of foils.
11784  If you want to see an example set of foils,
11785  take a look at
11786 \change_deleted 564990737 1671643085
11787 the
11788 \family typewriter
11789 Foils.lyx
11790 \family default
11791  file you find in \SpecialChar LyX
11792 's
11793 \family typewriter
11794 examples
11795 \family default
11796  folder
11797 \change_inserted 564990737 1671643099
11798
11799 \family sans
11800 File\SpecialChar menuseparator
11801 Open Example\SpecialChar menuseparator
11802 Presentations\SpecialChar menuseparator
11803 Foils
11804 \change_unchanged
11805
11806 \family default
11807 .
11808 \end_layout
11809
11810 \begin_layout Paragraph
11811 Give It a Title Page
11812 \end_layout
11813
11814 \begin_layout Standard
11815 Unlike other classes that provide
11816 \family sans
11817 Title
11818 \family default
11819 ,
11820
11821 \family sans
11822 Author
11823 \family default
11824 ,
11825
11826 \family sans
11827 Date
11828 \family default
11829  and
11830 \family sans
11831 Abstract
11832 \family default
11833  environments,
11834
11835 \family sans
11836 foils
11837 \family default
11838  creates the title on a page of its own.
11839  If you leave out the
11840 \family sans
11841 Date
11842 \family default
11843  environment \SpecialChar LaTeX
11844  will substitute the current date (every time you regenerate the output).
11845 \end_layout
11846
11847 \begin_layout Paragraph
11848 Start a New Foil
11849 \end_layout
11850
11851 \begin_layout Standard
11852 As I mentioned earlier,
11853  there are four ways of starting a new foil.
11854  For portrait foils you should use
11855 \family sans
11856 Foilhead
11857 \family default
11858  or
11859 \family sans
11860 ShortFoilhead.
11861
11862 \family default
11863  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.
11864 \end_layout
11865
11866 \begin_layout Standard
11867 Landscape foils are generated using the
11868 \family sans
11869 Rotatefoilhead
11870 \family default
11871  and
11872 \family sans
11873 ShortRotatefoilhead
11874 \family default
11875  environments.
11876  Again the only difference is the spacing between foilhead and body.
11877  Both of the short versions have 0.5
11878 \begin_inset space ~
11879 \end_inset
11880
11881 inches less separation between the foilhead and the body.
11882
11883 \end_layout
11884
11885 \begin_layout Standard
11886 One problem with the support for landscape foils is the requirement that you have to use the
11887 \family typewriter
11888 dvips
11889 \family default
11890  driver to generate the PostScript output otherwise the foils won't be rotated.
11891  It is possible to get landscape foils even if you haven't got the
11892 \family typewriter
11893 dvips
11894 \family default
11895  driver provided you can feed your foils sideways through your printer ;-)
11896 \end_layout
11897
11898 \begin_layout Paragraph
11899 Theorems,
11900  Lemmas,
11901  Proofs and more
11902 \end_layout
11903
11904 \begin_layout Standard
11905 You can't have two of the same type of these environments directly following each other.
11906  If you use a normal paragraph break,
11907  ,
11908  you will just be extending the previous environment as if you had merged the two environments together.
11909  Rather than that,
11910  you need to insert a so-called separator.
11911  Please refer to the section entitled
11912 \emph on
11913 Separate Nestings
11914 \emph default
11915  in the
11916 \emph on
11917 User's Guide
11918 \emph default
11919 .
11920 \end_layout
11921
11922 \begin_layout Paragraph
11923 Lists
11924 \end_layout
11925
11926 \begin_layout Standard
11927 You get all the commonly supported list styles found in other classes as well as two new ones.
11928  I'll only describe the new ones here.
11929  If you want to find out more about the other list environments check out the
11930 \emph on
11931 User's Guide.
11932
11933 \emph default
11934  If you intend to use itemized lists you might also want to read about the
11935 \family sans
11936 Itemize
11937 \begin_inset space ~
11938 \end_inset
11939
11940 Bullet
11941 \begin_inset space ~
11942 \end_inset
11943
11944 Selection
11945 \family default
11946  dialog described above in section
11947 \begin_inset space ~
11948 \end_inset
11949
11950
11951 \change_inserted 564990737 1671355684
11952
11953 \begin_inset CommandInset ref
11954 LatexCommand ref
11955 reference "chap:bullets"
11956 nolink "false"
11957
11958 \end_inset
11959
11960
11961 \change_deleted 564990737 1671355684
11962
11963 \begin_inset CommandInset ref
11964 LatexCommand ref
11965 reference "sec:bullet"
11966 nolink "false"
11967
11968 \end_inset
11969
11970
11971 \change_unchanged
11972 .
11973 \end_layout
11974
11975 \begin_layout Standard
11976 The two new list styles,
11977
11978 \family sans
11979 TickList
11980 \family default
11981  and
11982 \family sans
11983 CrossList
11984 \family default
11985 ,
11986  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.
11987  These lists are in fact dedicated variants of the
11988 \family sans
11989 Itemize
11990 \family default
11991  environment.
11992  They do however require that you have the
11993 \family typewriter
11994 psnfss
11995 \family default
11996  packages installed.
11997 \end_layout
11998
11999 \begin_layout Paragraph
12000 Figures and Tables
12001 \end_layout
12002
12003 \begin_layout Standard
12004
12005 \family sans
12006 Foil\SpecialChar TeX
12007
12008 \family default
12009  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.
12010  In fact if you change the float placement settings they are simply ignored.
12011 \end_layout
12012
12013 \begin_layout Paragraph
12014 Page Headers and Footers
12015 \begin_inset CommandInset label
12016 LatexCommand label
12017 name "sec:foilfoot"
12018
12019 \end_inset
12020
12021
12022 \end_layout
12023
12024 \begin_layout Standard
12025
12026 \family sans
12027 My
12028 \begin_inset space ~
12029 \end_inset
12030
12031 Logo
12032 \family default
12033  and
12034 \family sans
12035 Restriction
12036 \family default
12037  are two commands used to control the left-footer text string.
12038  The first is meant to allow you to include a graphic logo on your foils and defaults to
12039 \begin_inset Quotes eld
12040 \end_inset
12041
12042 -Typeset by
12043 \family sans
12044 Foil\SpecialChar TeX
12045
12046 \family default
12047 -
12048 \begin_inset Quotes erd
12049 \end_inset
12050
12051 .
12052  While the second is meant to provide a classification for the audience,
12053
12054 \emph on
12055 e.
12056 \begin_inset space \thinspace{}
12057 \end_inset
12058
12059 g.
12060 \emph default
12061
12062 \begin_inset space \space{}
12063 \end_inset
12064
12065 Confidential.
12066  It is empty by default.
12067 \end_layout
12068
12069 \begin_layout Standard
12070 The remaining page corners can be filled by
12071 \family sans
12072 Right
12073 \begin_inset space ~
12074 \end_inset
12075
12076 Footer
12077 \family default
12078  (which defaults to page numbers),
12079
12080 \family sans
12081 Right
12082 \begin_inset space ~
12083 \end_inset
12084
12085 Header
12086 \family default
12087  (top right) and
12088 \family sans
12089 Left
12090 \begin_inset space ~
12091 \end_inset
12092
12093 Header
12094 \family default
12095  (top left).
12096 \end_layout
12097
12098 \begin_layout Subsubsection
12099 Unsupported
12100 \family sans
12101 Foil\SpecialChar TeX
12102
12103 \family default
12104  Goodies
12105 \begin_inset CommandInset label
12106 LatexCommand label
12107 name "sec:unsuppfoils"
12108
12109 \end_inset
12110
12111
12112 \end_layout
12113
12114 \begin_layout Standard
12115 All the commands mentioned below need to be set in a
12116 \family sans
12117 \SpecialChar LaTeX
12118
12119 \family default
12120  environment or as
12121 \family sans
12122 \SpecialChar TeX
12123
12124 \family default
12125  within another environment.
12126 \end_layout
12127
12128 \begin_layout Paragraph
12129 Lengths
12130 \end_layout
12131
12132 \begin_layout Standard
12133 All lengths are adjusted using the
12134 \family typewriter
12135
12136 \backslash
12137 setlength{
12138 \family default
12139 \emph on
12140 lengthname
12141 \family typewriter
12142 \emph default
12143 }{
12144 \family default
12145 \emph on
12146 newlength
12147 \family typewriter
12148 \emph default
12149 }
12150 \family default
12151  command.
12152  Where
12153 \emph on
12154 lengthname
12155 \emph default
12156  should be replaced by the name given to the length you want to change and
12157 \emph on
12158 newlength
12159 \emph default
12160  is the length value.
12161  All lengths should be specified in units of length such as inches (
12162 \family typewriter
12163 in
12164 \family default
12165 ),
12166  millimeters (
12167 \family typewriter
12168 mm
12169 \family default
12170 ) or points (
12171 \family typewriter
12172 pt
12173 \family default
12174 ) or relative to some document or font-based length such as
12175 \family typewriter
12176
12177 \backslash
12178 textwidth
12179 \family default
12180 .
12181
12182 \end_layout
12183
12184 \begin_layout Standard
12185 It's possible to change the spacing between a foilhead and the body of the foil by adjusting the length specified by
12186 \family typewriter
12187
12188 \backslash
12189 foilheadskip
12190 \family default
12191 .
12192  For example,
12193  to make
12194 \emph on
12195 all
12196 \emph default
12197  foilheads 0.5
12198 \begin_inset space \space{}
12199 \end_inset
12200
12201 in closer to their bodies put the following in the preamble:
12202
12203 \family typewriter
12204
12205 \backslash
12206 setlength{
12207 \backslash
12208 foilheadskip}{-0.5in}
12209 \end_layout
12210
12211 \begin_layout Standard
12212 The spacings around floats can be adjusted by setting these lengths:
12213 \end_layout
12214
12215 \begin_layout Labeling
12216 \labelwidthstring MMMMMMMMMMM
12217
12218 \family typewriter
12219
12220 \backslash
12221 abovefloatskip
12222 \family default
12223  Separation between the text and the top of the float
12224 \end_layout
12225
12226 \begin_layout Labeling
12227 \labelwidthstring MMMMMMMMMMM
12228
12229 \family typewriter
12230
12231 \backslash
12232 abovecaptionskip
12233 \family default
12234  Separation between the float and the caption
12235 \end_layout
12236
12237 \begin_layout Labeling
12238 \labelwidthstring MMMMMMMMMMM
12239
12240 \family typewriter
12241
12242 \backslash
12243 belowcaptionskip
12244 \family default
12245  Separation between the caption and the following text
12246 \end_layout
12247
12248 \begin_layout Labeling
12249 \labelwidthstring MMMMMMMMMMM
12250
12251 \family typewriter
12252
12253 \backslash
12254 captionwidth
12255 \family default
12256  You can make the captions narrower than the surrounding text by adjusting this length.
12257  Best done relative to
12258 \family typewriter
12259
12260 \backslash
12261 textwidth
12262 \family default
12263 .
12264 \end_layout
12265
12266 \begin_layout Standard
12267 There are also several title page related lengths that you may find useful if you have a long title or several authors:
12268 \end_layout
12269
12270 \begin_layout Labeling
12271 \labelwidthstring MMMMMMMMMMM
12272
12273 \family typewriter
12274
12275 \backslash
12276 abovetitleskip
12277 \family default
12278  Separation from headers to
12279 \family sans
12280 Title
12281 \end_layout
12282
12283 \begin_layout Labeling
12284 \labelwidthstring MMMMMMMMMMM
12285
12286 \family typewriter
12287
12288 \backslash
12289 titleauthorskip
12290 \family default
12291  between
12292 \family sans
12293 Title
12294 \family default
12295  and
12296 \family sans
12297 Author
12298 \family default
12299  environments
12300 \end_layout
12301
12302 \begin_layout Labeling
12303 \labelwidthstring MMMMMMMMMMM
12304
12305 \family typewriter
12306
12307 \backslash
12308 authorauthorskip
12309 \family default
12310  between multiple
12311 \family sans
12312 Author
12313 \family default
12314  lines
12315 \end_layout
12316
12317 \begin_layout Labeling
12318 \labelwidthstring MMMMMMMMMMM
12319
12320 \family typewriter
12321
12322 \backslash
12323 authordateskip
12324 \family default
12325  between the
12326 \family sans
12327 Author
12328 \family default
12329  and the
12330 \family sans
12331 Date
12332 \end_layout
12333
12334 \begin_layout Labeling
12335 \labelwidthstring MMMMMMMMMMM
12336
12337 \family typewriter
12338
12339 \backslash
12340 dateabstractskip
12341 \family default
12342  between the
12343 \family sans
12344 Date
12345 \family default
12346  and the
12347 \family sans
12348 Abstract
12349 \end_layout
12350
12351 \begin_layout Standard
12352 The last length related command affects all the list environments.
12353  If you place
12354 \family typewriter
12355
12356 \backslash
12357 zerolistvertdimens
12358 \family default
12359
12360 \emph on
12361 inside
12362 \emph default
12363  a list environment then all the vertical spacing between the list items is removed.
12364  Note that this is a command not a length so it doesn't require
12365 \family typewriter
12366
12367 \backslash
12368 setlength
12369 \family default
12370  like the stuff mentioned above.
12371 \end_layout
12372
12373 \begin_layout Paragraph
12374 Headers and Footers
12375 \end_layout
12376
12377 \begin_layout Standard
12378 The
12379 \family typewriter
12380
12381 \backslash
12382 LogoOn
12383 \family default
12384  and
12385 \family typewriter
12386
12387 \backslash
12388 LogoOff
12389 \family default
12390  commands control whether the logo in the
12391 \family sans
12392 MyLogo
12393 \family default
12394  definition appear on a given page.
12395  If you put
12396 \family typewriter
12397
12398 \backslash
12399 LogoOff
12400 \family default
12401  in the preamble then none of the foils will have the logo on them.
12402  If you don't want the logo on a particular page place the
12403 \family typewriter
12404
12405 \backslash
12406 LogoOff
12407 \family default
12408  directly after the foilhead of that page and the
12409 \family typewriter
12410
12411 \backslash
12412 LogoOn
12413 \family default
12414  directly after the next foilhead.
12415 \end_layout
12416
12417 \begin_layout Standard
12418 If you decide to use the
12419 \family sans
12420 fancy
12421 \family default
12422  page style setting in the
12423 \family sans
12424 Document
12425 \begin_inset space ~
12426 \end_inset
12427
12428 Layout
12429 \family default
12430  dialog you should probably add
12431 \family typewriter
12432
12433 \backslash
12434 let
12435 \backslash
12436 headwidth
12437 \backslash
12438 textwidth
12439 \family default
12440  to your preamble so headers and footers on landscape pages are correctly placed when rotated.
12441  This is due to some clashes between the page layouts provided by the
12442 \family sans
12443 fancyheadings
12444 \family default
12445  package and the
12446 \family sans
12447 foils
12448 \family default
12449  class.
12450 \end_layout
12451
12452 \begin_layout Subsection
12453
12454 \change_inserted 564990737 1671459032
12455 Powerdot
12456 \end_layout
12457
12458 \begin_layout Standard
12459
12460 \change_inserted 564990737 1671643165
12461 The document class
12462 \family sans
12463 presentation
12464 \begin_inset space \thinspace{}
12465 \end_inset
12466
12467 (powerdot)
12468 \family default
12469  uses the
12470 \family typewriter
12471 powerdot.cls
12472 \family default
12473  document class for creating presentations.
12474
12475 \family sans
12476 File\SpecialChar menuseparator
12477 Open Example\SpecialChar menuseparator
12478 Presentations\SpecialChar menuseparator
12479 Powerdot
12480 \family default
12481  offers guidance on its use.
12482  The documentation is available from
12483 \begin_inset CommandInset href
12484 LatexCommand href
12485 name "CTAN"
12486 target "http://mirrors.ctan.org/macros/latex/contrib/powerdot/doc/powerdot.pdf"
12487 literal "false"
12488
12489 \end_inset
12490
12491 .
12492 \end_layout
12493
12494 \begin_layout Subsection
12495
12496 \change_inserted 564990737 1671459032
12497 \begin_inset CommandInset label
12498 LatexCommand label
12499 name "subsec:Seminar"
12500
12501 \end_inset
12502
12503
12504 \family sans
12505 Seminar
12506 \end_layout
12507
12508 \begin_layout Standard
12509
12510 \change_inserted 564990737 1671643194
12511 The document class
12512 \family sans
12513 presentations
12514 \begin_inset space \thinspace{}
12515 \end_inset
12516
12517 (seminar)
12518 \family default
12519  uses the
12520 \family typewriter
12521 seminar.cls
12522 \family default
12523  document class for creating presentations.
12524
12525 \family sans
12526 File\SpecialChar menuseparator
12527 Open Example\SpecialChar menuseparator
12528 Presentations\SpecialChar menuseparator
12529 Seminar
12530 \family default
12531  offers guidance on its use.
12532  The documentation is available from
12533 \begin_inset CommandInset href
12534 LatexCommand href
12535 name "CTAN"
12536 target "http://mirrors.ctan.org/macros/latex/contrib/seminar/doc/seminar-doc.pdf"
12537 literal "false"
12538
12539 \end_inset
12540
12541 .
12542 \end_layout
12543
12544 \begin_layout Subsection
12545 Slides [aka
12546 \noun on
12547 Sli\SpecialChar TeX
12548
12549 \noun default
12550 ]
12551 \begin_inset CommandInset label
12552 LatexCommand label
12553 name "sec:slitex"
12554
12555 \end_inset
12556
12557
12558 \end_layout
12559
12560 \begin_layout Standard
12561
12562 \change_inserted 564990737 1672743492
12563 Original by
12564 \noun on
12565 John Weiss
12566 \noun default
12567 ;
12568  updated by the \SpecialChar LyX
12569  Team
12570 \end_layout
12571
12572 \begin_layout Subsubsection
12573
12574 \change_inserted 564990737 1672743492
12575 Introduction
12576 \end_layout
12577
12578 \begin_layout Standard
12579
12580 \change_inserted 564990737 1672743492
12581 This section describes how to use \SpecialChar LyX
12582  to make slides for overhead projectors.
12583  There are two document classes that can do this:
12584  the
12585 \family typewriter
12586 presentations
12587 \begin_inset space \thinspace{}
12588 \end_inset
12589
12590 (slides)
12591 \family default
12592  document class and the
12593 \family sans
12594 presentation
12595 \begin_inset space \thinspace{}
12596 \end_inset
12597
12598 (Foil\SpecialChar TeX
12599 )
12600 \family default
12601  document class.
12602  This section documents the former.
12603  If you’re looking for the documentation for
12604 \family sans
12605 presentation
12606 \begin_inset space \thinspace{}
12607 \end_inset
12608
12609 (Foil\SpecialChar TeX
12610 )
12611 \family default
12612 ,
12613  check out section
12614 \begin_inset space ~
12615 \end_inset
12616
12617
12618 \begin_inset CommandInset ref
12619 LatexCommand ref
12620 reference "sec:Foiltex"
12621 nolink "false"
12622
12623 \end_inset
12624
12625 .
12626  As of 2023 the former has continued to be maintained whereas
12627 \family sans
12628 Foil\SpecialChar TeX
12629
12630 \family default
12631  has not been maintained since 2008.
12632
12633 \change_deleted 564990737 1672743492
12634 by
12635 \noun on
12636 John Weiss
12637 \noun default
12638
12639 \end_layout
12640
12641 \begin_layout Standard
12642
12643 \change_deleted 564990737 1672743492
12644 Introduction
12645 \end_layout
12646
12647 \begin_layout Standard
12648
12649 \change_deleted 564990737 1672743492
12650 This section describes how to use \SpecialChar LyX
12651  to make slides for overhead projectors.
12652  There are two document classes that can do this:
12653  the default slides class and the
12654 \family sans
12655 Foil\SpecialChar TeX
12656
12657 \family default
12658  slides class.
12659  This section documents the former.
12660 \end_layout
12661
12662 \begin_layout Standard
12663
12664 \change_deleted 564990737 1672743492
12665 I'm going to say this again,
12666  nice and clear,
12667  so that there's no misunderstanding:
12668 \end_layout
12669
12670 \begin_layout Standard
12671
12672 \change_deleted 564990737 1672743492
12673 \begin_inset VSpace bigskip
12674 \end_inset
12675
12676
12677 \end_layout
12678
12679 \begin_layout Standard
12680 \align center
12681
12682 \change_deleted 564990737 1672743492
12683
12684 \size large
12685 This section documents the class
12686 \begin_inset Quotes eld
12687 \end_inset
12688
12689
12690 \family sans
12691 slides (default)
12692 \family default
12693
12694 \begin_inset Quotes erd
12695 \end_inset
12696
12697
12698 \emph on
12699 only.
12700 \end_layout
12701
12702 \begin_layout Standard
12703
12704 \change_deleted 564990737 1672743492
12705 \begin_inset VSpace bigskip
12706 \end_inset
12707
12708
12709 \end_layout
12710
12711 \begin_layout Standard
12712
12713 \change_deleted 564990737 1672743492
12714 If you're looking for the documentation for
12715 \begin_inset Quotes eld
12716 \end_inset
12717
12718
12719 \family sans
12720 slides (Foil\SpecialChar TeX
12721 )
12722 \family default
12723
12724 \begin_inset Quotes erd
12725 \end_inset
12726
12727 ,
12728  check out section
12729 \begin_inset space ~
12730 \end_inset
12731
12732
12733 \begin_inset CommandInset ref
12734 LatexCommand ref
12735 reference "sec:foiltex"
12736 nolink "false"
12737
12738 \end_inset
12739
12740 .
12741  The
12742 \family sans
12743 foils
12744 \family default
12745  class [
12746 \begin_inset Quotes eld
12747 \end_inset
12748
12749
12750 \family sans
12751 slides (Foil\SpecialChar TeX
12752 )
12753 \family default
12754
12755 \begin_inset Quotes erd
12756 \end_inset
12757
12758 ] is actually somewhat better than the default
12759 \family sans
12760 slides
12761 \family default
12762  class,
12763 \begin_inset Foot
12764 status collapsed
12765
12766 \begin_layout Plain Layout
12767 \SpecialChar ldots
12768 or so I've been told repeatedly by its advocates.
12769  Having never used it,
12770  I have no idea if this claim is true or not.
12771 \end_layout
12772
12773 \end_inset
12774
12775  which this section documents.
12776 \end_layout
12777
12778 \begin_layout Standard
12779
12780 \change_deleted 564990737 1672743492
12781 This class is the \SpecialChar LaTeX2e
12782  improvement of the old
12783 \noun on
12784 Sli\SpecialChar TeX
12785
12786 \noun default
12787  package.
12788  Every \SpecialChar LaTeX2e
12789  distribution includes this class [which I'll just refer to as
12790 \begin_inset Quotes eld
12791 \end_inset
12792
12793
12794 \family sans
12795 slides
12796 \family default
12797
12798 \begin_inset Quotes erd
12799 \end_inset
12800
12801  from now on],
12802  so you're bound to have it.
12803  As I noted earlier,
12804  there are other classes,
12805  such as
12806 \family sans
12807 foils
12808 \family default
12809 ,
12810  which also produce slides for overhead projectors and do a better job at it.
12811  However,
12812  there are some things which
12813 \family sans
12814 slides
12815 \family default
12816  can do which the others can't,
12817  such as generate overlays.
12818  Read on to learn more!
12819 \change_unchanged
12820
12821 \end_layout
12822
12823 \begin_layout Subsubsection
12824 Getting Started
12825 \begin_inset CommandInset label
12826 LatexCommand label
12827 name "sec:slidesetup"
12828
12829 \end_inset
12830
12831
12832 \end_layout
12833
12834 \begin_layout Standard
12835 Obviously,
12836  to use this document class,
12837  you need to select
12838 \begin_inset Quotes eld
12839 \end_inset
12840
12841
12842 \family sans
12843 slides (default)
12844 \family default
12845
12846 \begin_inset Quotes erd
12847 \end_inset
12848
12849  from the class list in the
12850 \family sans
12851 Document\SpecialChar menuseparator
12852 Settings
12853 \family default
12854  dialog.
12855  There are some other special things you should know about this class:
12856 \end_layout
12857
12858 \begin_layout Itemize
12859 Don't bother changing the options
12860 \family sans
12861 Sides and Columns
12862 \family default
12863 .
12864  They're not supported by the
12865 \family sans
12866 slides
12867 \family default
12868  class,
12869  anyways.
12870 \end_layout
12871
12872 \begin_layout Itemize
12873 The option
12874 \family sans
12875 Page
12876 \begin_inset space ~
12877 \end_inset
12878
12879 style
12880 \family default
12881  behaves a bit differently for this class.
12882  The possible choices and what they do are as follows:
12883 \end_layout
12884
12885 \begin_deeper
12886 \begin_layout Description
12887
12888 \family sans
12889 plain
12890 \family default
12891  The final output contains page numbers in the lower right corner.
12892 \end_layout
12893
12894 \begin_layout Description
12895
12896 \family sans
12897 headings
12898 \family default
12899  Like
12900 \family sans
12901 plain
12902 \family default
12903 ,
12904  but also prints out any time markers you've put in.
12905  This is the default.
12906 \end_layout
12907
12908 \begin_layout Description
12909
12910 \family sans
12911 empty
12912 \family default
12913  The final output contains no page numbers,
12914  time markers,
12915  or alignment markers.
12916 \end_layout
12917
12918 \end_deeper
12919 \begin_layout Itemize
12920 The
12921 \family sans
12922 slides
12923 \family default
12924  class has an extra option:
12925
12926 \family typewriter
12927 clock
12928 \family default
12929 .
12930  To use it,
12931  put
12932 \begin_inset Quotes eld
12933 \end_inset
12934
12935
12936 \family typewriter
12937 clock
12938 \family default
12939
12940 \begin_inset Quotes erd
12941 \end_inset
12942
12943  in the extra class options.
12944 \end_layout
12945
12946 \begin_deeper
12947 \begin_layout Standard
12948 Using this options allows you to add time markers to
12949 \family sans
12950 Note
12951 \family default
12952 s.
12953  See section
12954 \begin_inset space ~
12955 \end_inset
12956
12957
12958 \begin_inset CommandInset ref
12959 LatexCommand ref
12960 reference "sec:slideNote"
12961 nolink "false"
12962
12963 \end_inset
12964
12965  for more details.
12966 \end_layout
12967
12968 \end_deeper
12969 \begin_layout Standard
12970 You can also use the template file
12971 \change_deleted 564990737 1671617694
12972
12973 \begin_inset Quotes eld
12974 \end_inset
12975
12976
12977 \family typewriter
12978 slides.lyx
12979 \family default
12980
12981 \begin_inset Quotes erd
12982 \end_inset
12983
12984
12985 \change_unchanged
12986  to automatically set up a document to use the
12987 \family sans
12988 slides
12989 \family default
12990  class
12991 \change_deleted 564990737 1671617699
12992 [
12993 \change_unchanged
12994 using
12995 \family sans
12996 File\SpecialChar menuseparator
12997 New
12998 \begin_inset space ~
12999 \end_inset
13000
13001 from
13002 \begin_inset space ~
13003 \end_inset
13004
13005 Template
13006 \change_inserted 564990737 1671617723
13007 \SpecialChar menuseparator
13008 Presentations\SpecialChar menuseparator
13009 Slides
13010 \change_unchanged
13011
13012 \family default
13013  to open your new document
13014 \change_deleted 564990737 1671617728
13015 ]
13016 \change_unchanged
13017 .
13018  The template file also contains some examples of the special paragraph environments used by this class.
13019  I'll describe those next.
13020 \end_layout
13021
13022 \begin_layout Subsubsection
13023 Paragraph Environments
13024 \end_layout
13025
13026 \begin_layout Paragraph
13027 Supported Environments
13028 \end_layout
13029
13030 \begin_layout Standard
13031 The first thing you'll notice when you start up a new
13032 \family sans
13033 slides
13034 \family default
13035  document is the font size and type:
13036  it's the equivalent of the size
13037 \begin_inset Quotes eld
13038 \end_inset
13039
13040
13041 \family sans
13042 Largest
13043 \family default
13044
13045 \begin_inset Quotes erd
13046 \end_inset
13047
13048  in the
13049 \family sans
13050 Sans
13051 \begin_inset space ~
13052 \end_inset
13053
13054 Serif
13055 \family default
13056  font.
13057  This is also what's used in the output.
13058  Think of this as a
13059 \begin_inset Quotes eld
13060 \end_inset
13061
13062 visual cue
13063 \begin_inset Quotes erd
13064 \end_inset
13065
13066  to remind you that this is a slide.
13067  Your final slides will use a larger font;
13068  ergo,
13069  you'll have less space.
13070  Of course,
13071  the larger default screen font isn't WYSIWYG,
13072  only a reminder.
13073 \end_layout
13074
13075 \begin_layout Standard
13076 The next thing that becomes obvious is the changes to the paragraph environment pull-down box [at the far-left end of the toolbar].
13077  Most of the paragraph environments you're used to seeing are missing.
13078  There are also five new ones.
13079  That's because the
13080 \family sans
13081 slides
13082 \family default
13083  class itself only supports certain paragraph environments:
13084 \end_layout
13085
13086 \begin_layout Itemize
13087
13088 \family sans
13089 Standard
13090 \end_layout
13091
13092 \begin_layout Itemize
13093
13094 \family sans
13095 Itemize
13096 \end_layout
13097
13098 \begin_layout Itemize
13099
13100 \family sans
13101 Enumerate
13102 \end_layout
13103
13104 \begin_layout Itemize
13105
13106 \family sans
13107 Description
13108 \end_layout
13109
13110 \begin_layout Itemize
13111
13112 \family sans
13113 List
13114 \end_layout
13115
13116 \begin_layout Itemize
13117
13118 \family sans
13119 Quotation
13120 \end_layout
13121
13122 \begin_layout Itemize
13123
13124 \family sans
13125 Quote
13126 \end_layout
13127
13128 \begin_layout Itemize
13129
13130 \family sans
13131 Verse
13132 \end_layout
13133
13134 \begin_layout Itemize
13135
13136 \family sans
13137 Caption
13138 \end_layout
13139
13140 \begin_layout Itemize
13141
13142 \family sans
13143 \SpecialChar LyX
13144 -Code
13145 \end_layout
13146
13147 \begin_layout Standard
13148 All of the other standard environments,
13149  including the section-heading environments,
13150  aren't used in the
13151 \family sans
13152 slides
13153 \family default
13154  class.
13155 \end_layout
13156
13157 \begin_layout Standard
13158 On the other hand,
13159  you'll notice the following new environments:
13160 \end_layout
13161
13162 \begin_layout Itemize
13163
13164 \family sans
13165 Slide
13166 \end_layout
13167
13168 \begin_layout Itemize
13169
13170 \family sans
13171 Overlay
13172 \end_layout
13173
13174 \begin_layout Itemize
13175
13176 \family sans
13177 Note
13178 \end_layout
13179
13180 \begin_layout Itemize
13181
13182 \family sans
13183 InvisibleText
13184 \end_layout
13185
13186 \begin_layout Itemize
13187
13188 \family sans
13189 VisibleText
13190 \end_layout
13191
13192 \begin_layout Standard
13193 These five are kind of quirky,
13194  due to a
13195 \begin_inset Quotes eld
13196 \end_inset
13197
13198 feature
13199 \begin_inset Quotes erd
13200 \end_inset
13201
13202  in \SpecialChar LyX
13203 .
13204  You see,
13205  \SpecialChar LyX
13206  doesn't permit you to nest any other paragraph environment into an empty environment.
13207  Now,
13208  that's fine and dandy,
13209  but it means that you wouldn't be able to start a slide with anything except plain text.
13210  To deal with this,
13211  I've performed a little
13212 \begin_inset Quotes eld
13213 \end_inset
13214
13215 \SpecialChar LaTeX
13216  magic.
13217 \begin_inset Quotes erd
13218 \end_inset
13219
13220
13221 \end_layout
13222
13223 \begin_layout Paragraph
13224 Quirks of the New Environments
13225 \begin_inset CommandInset label
13226 LatexCommand label
13227 name "sec:slideQuirk"
13228
13229 \end_inset
13230
13231
13232 \end_layout
13233
13234 \begin_layout Standard
13235 All five of the new paragraph environments are somewhat quirky due to inherent limitiations in the current version of \SpecialChar LyX
13236 .
13237  As I just mentioned,
13238  \SpecialChar LyX
13239  forbids environments that begin with another environment.
13240  To get around this,
13241  the
13242 \family sans
13243 Slide
13244 \family default
13245  environment isn't a paragraph environment as described in the
13246 \emph on
13247 User's Guide
13248 \emph default
13249 .
13250
13251 \end_layout
13252
13253 \begin_layout Standard
13254 You should consider
13255 \family sans
13256 Slide
13257 \family default
13258 ,
13259
13260 \family sans
13261 Overlay
13262 \family default
13263 ,
13264  and
13265 \family sans
13266 Note
13267 \family default
13268  to be
13269 \begin_inset Quotes eld
13270 \end_inset
13271
13272 pseudo-environments.
13273 \begin_inset Quotes erd
13274 \end_inset
13275
13276  They look like a section heading or a
13277 \begin_inset Quotes eld
13278 \end_inset
13279
13280
13281 \family sans
13282 Caption
13283 \family default
13284 ,
13285 \begin_inset Quotes erd
13286 \end_inset
13287
13288  but really begin a [and,
13289  if necessary,
13290  end the previous] paragraph environment.
13291  Likewise,
13292  treat
13293 \family sans
13294 InvisibleText
13295 \family default
13296  and
13297 \family sans
13298 VisibleText
13299 \family default
13300  as
13301 \begin_inset Quotes eld
13302 \end_inset
13303
13304 pseudo-commands.
13305 \begin_inset Quotes erd
13306 \end_inset
13307
13308  These two perform some action.
13309 \end_layout
13310
13311 \begin_layout Standard
13312 A common feature of all five environments,
13313
13314 \family sans
13315 Slide
13316 \family default
13317 ,
13318
13319 \family sans
13320 Overlay
13321 \family default
13322 ,
13323
13324 \family sans
13325 Note
13326 \family default
13327 ,
13328
13329 \family sans
13330 InvisibleText
13331 \family default
13332  and
13333 \family sans
13334 VisibleText
13335 \family default
13336 ,
13337  is a rather long-ish label.
13338  The text following this label —
13339  ordinarily the contents of the paragraph environment —
13340  is utterly irrelevant for
13341 \family sans
13342 Slide
13343 \family default
13344 ,
13345
13346 \family sans
13347 Overlay
13348 \family default
13349 ,
13350
13351 \family sans
13352 Note
13353 \family default
13354 ,
13355
13356 \family sans
13357 InvisibleText
13358 \family default
13359  and
13360 \family sans
13361 VisibleText
13362 \family default
13363 .
13364  \SpecialChar LyX
13365  completely ignores it.
13366  In fact,
13367  you can leave these five environments completely empty.
13368
13369 \end_layout
13370
13371 \begin_layout Standard
13372 While you don't
13373 \emph on
13374 have
13375 \emph default
13376  to put any text after the rather long-ish label,
13377  you might want to.
13378  This could be a short description of the contents of the
13379 \family sans
13380 Slide
13381 \family default
13382 ,
13383  for example.
13384  In that case,
13385  enter your descriptive comment and hit
13386 \family sans
13387 Return
13388 \family default
13389  as you normally would.
13390 \end_layout
13391
13392 \begin_layout Standard
13393 If,
13394  on the other hand,
13395  you don't want to enter any descriptive text,
13396  you'll hit another \SpecialChar LyX
13397  quirk.
13398  \SpecialChar LyX
13399 ,
13400  like nature,
13401  abhors a vacuum,
13402  and will not let you start a new paragraph environment until you put something in the old one.
13403  So,
13404  do this:
13405 \end_layout
13406
13407 \begin_layout Itemize
13408 Start entering the text that will
13409 \emph on
13410 follow
13411 \emph default
13412  the new
13413 \family sans
13414 Slide
13415 \family default
13416 ,
13417
13418 \family sans
13419 Overlay
13420 \family default
13421 ,
13422
13423 \family sans
13424 Note
13425 \family default
13426 ,
13427
13428 \family sans
13429 InvisibleText
13430 \family default
13431  or
13432 \family sans
13433 VisibleText
13434 \family default
13435 .
13436
13437 \end_layout
13438
13439 \begin_layout Itemize
13440 Now move to the beginning of that paragraph.
13441
13442 \end_layout
13443
13444 \begin_layout Itemize
13445 Next,
13446  hit
13447 \family sans
13448 Return
13449 \family default
13450 .
13451
13452 \end_layout
13453
13454 \begin_layout Itemize
13455 Finally,
13456  change this new,
13457  empty paragraph to a
13458 \family sans
13459 Slide
13460 \family default
13461 ,
13462
13463 \family sans
13464 Overlay
13465 \family default
13466 ,
13467
13468 \family sans
13469 Note
13470 \family default
13471 ,
13472
13473 \family sans
13474 InvisibleText
13475 \family default
13476  or
13477 \family sans
13478 VisibleText
13479 \family default
13480 .
13481
13482 \end_layout
13483
13484 \begin_layout Standard
13485 Some future version of \SpecialChar LyX
13486  will,
13487  hopefully,
13488  resolve this quirkiness\SpecialChar ldots
13489
13490 \end_layout
13491
13492 \begin_layout Subsubsection
13493 Making a Presentation with
13494 \family sans
13495 Slide
13496 \family default
13497 ,
13498
13499 \family sans
13500 Overlay
13501 \family default
13502  and
13503 \family sans
13504 Note
13505 \end_layout
13506
13507 \begin_layout Paragraph
13508 Using the
13509 \family sans
13510 Slide
13511 \family default
13512  Environment
13513 \end_layout
13514
13515 \begin_layout Standard
13516 If you're expecting this section to teach you how to actually make a presentation,
13517  you'll be sorely disappointed.
13518  Naturally,
13519  I'll describe all of the ways the
13520 \family sans
13521 slides
13522 \family default
13523  class can assist you in preparing the materials for a presentation.
13524  Filling in the contents,
13525  however,
13526  is up to you.
13527  [Then again,
13528  that
13529 \emph on
13530 is
13531 \emph default
13532  the \SpecialChar LyX
13533  philosophy.]
13534 \end_layout
13535
13536 \begin_layout Standard
13537 Choosing the
13538 \family sans
13539 Slide
13540 \family default
13541  environment [in the manner described in section
13542 \begin_inset space ~
13543 \end_inset
13544
13545
13546 \begin_inset CommandInset ref
13547 LatexCommand ref
13548 reference "sec:slideQuirk"
13549 nolink "false"
13550
13551 \end_inset
13552
13553 ] tells \SpecialChar LyX
13554  to begin a new slide [duh].
13555  The label for this environment/
13556 \begin_inset Quotes erd
13557 \end_inset
13558
13559 pseudo-command
13560 \begin_inset Quotes erd
13561 \end_inset
13562
13563  is an
13564 \begin_inset Quotes eld
13565 \end_inset
13566
13567 ASCII line,
13568 \begin_inset Quotes erd
13569 \end_inset
13570
13571  in cool blue,
13572  followed by the label,
13573
13574 \begin_inset Quotes eld
13575 \end_inset
13576
13577 NewSlide:
13578 \begin_inset Quotes erd
13579 \end_inset
13580
13581 .
13582  Any text or paragraph environments that follow this one go on the new slide.
13583  It's that simple.
13584 \end_layout
13585
13586 \begin_layout Standard
13587 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
13588  (this can be specified in the
13589 \family sans
13590 Paragraph Layout
13591 \family default
13592  dialog).
13593  In fact,
13594  you'll want to,
13595  once you finish entering the contents of one slide.
13596  If you've entered more text than can physically fit on a slide,
13597  the extra overflows onto a new slide.
13598  I don't recommend doing this,
13599  however,
13600  since the overflow slide won't have any page number on it.
13601  Furthermore,
13602  it may interfere with any
13603 \family sans
13604 Overlay
13605 \family default
13606  you've made to accompany the oversized
13607 \family sans
13608 Slide
13609 \family default
13610 .
13611 \end_layout
13612
13613 \begin_layout Standard
13614 The
13615 \family sans
13616 Overlay
13617 \family default
13618  and
13619 \family sans
13620 Note
13621 \family default
13622  environments work the same way as the
13623 \family sans
13624 Slide
13625 \family default
13626  environment.
13627  They both create an
13628 \begin_inset Quotes eld
13629 \end_inset
13630
13631 ASCII line
13632 \begin_inset Quotes erd
13633 \end_inset
13634
13635  followed by a label [
13636 \begin_inset Quotes eld
13637 \end_inset
13638
13639 NewOverlay:
13640 \begin_inset Quotes erd
13641 \end_inset
13642
13643  and
13644 \begin_inset Quotes eld
13645 \end_inset
13646
13647 NewNote:
13648 \begin_inset Quotes erd
13649 \end_inset
13650
13651 ,
13652  respectively].
13653  The color is a stunning magenta instead of blue,
13654  and the
13655 \begin_inset Quotes eld
13656 \end_inset
13657
13658 ASCII line
13659 \begin_inset Quotes erd
13660 \end_inset
13661
13662  will look different,
13663  in style and in length.
13664  The label fonts of all three also differ from one another.
13665 \end_layout
13666
13667 \begin_layout Standard
13668 As with a
13669 \family sans
13670 Slide
13671 \family default
13672 ,
13673  if the contents of a
13674 \family sans
13675 Note
13676 \family default
13677  or
13678 \family sans
13679 Overlay
13680 \family default
13681  exceed the physical size of a slide or sheet of paper,
13682  the extra will overflow onto a new sheet.
13683  Again,
13684  you should avoid this.
13685  It defeats the whole purpose of
13686 \family sans
13687 Note
13688 \family default
13689 s and
13690 \family sans
13691 Overlay
13692 \family default
13693 s.
13694 \end_layout
13695
13696 \begin_layout Paragraph
13697 Using
13698 \family sans
13699 Overlay
13700 \family default
13701  with
13702 \family sans
13703 Slide
13704 \end_layout
13705
13706 \begin_layout Standard
13707 The idea behind an
13708 \family sans
13709 Overlay
13710 \family default
13711  is a slide that sits atop another slide.
13712  Perhaps you wish to discuss a figure on the main
13713 \family sans
13714 Slide
13715 \family default
13716  before displaying the text associated with it.
13717  One way to accomplish this is tape a flap of dark paper over the part of the
13718 \family sans
13719 Slide
13720 \family default
13721  you want to display later.
13722  This method fails,
13723  however,
13724  if you wish to overlap one graph with another,
13725  for example.
13726  You would then have to fumble while speaking to align the two separate,
13727  overlapping
13728 \family sans
13729 Slide
13730 \family default
13731 s to align the two graphs.
13732  The use of an
13733 \family sans
13734 Overlay
13735 \family default
13736  environment in both cases makes life much easier.
13737 \end_layout
13738
13739 \begin_layout Standard
13740 Each
13741 \family sans
13742 Overlay
13743 \family default
13744  receives the page number of its
13745 \begin_inset Quotes eld
13746 \end_inset
13747
13748 parent
13749 \begin_inset Quotes erd
13750 \end_inset
13751
13752
13753 \family sans
13754 Slide
13755 \family default
13756 ,
13757  appended by
13758 \begin_inset Quotes eld
13759 \end_inset
13760
13761
13762 \family typewriter
13763 -a
13764 \family default
13765
13766 \begin_inset Quotes erd
13767 \end_inset
13768
13769 .
13770 \begin_inset Foot
13771 status collapsed
13772
13773 \begin_layout Plain Layout
13774 Presumably,
13775  mutliple
13776 \family sans
13777 Overlay
13778 \family default
13779 s would have
13780 \begin_inset Quotes eld
13781 \end_inset
13782
13783
13784 \family typewriter
13785 -a
13786 \family default
13787
13788 \begin_inset Quotes erd
13789 \end_inset
13790
13791 ,
13792
13793 \begin_inset Quotes eld
13794 \end_inset
13795
13796
13797 \family typewriter
13798 -b
13799 \family default
13800
13801 \begin_inset Quotes erd
13802 \end_inset
13803
13804 ,
13805
13806 \begin_inset Quotes eld
13807 \end_inset
13808
13809
13810 \family typewriter
13811 -c
13812 \family default
13813
13814 \begin_inset Quotes erd
13815 \end_inset
13816
13817 ,
13818  etc.
13819 \begin_inset space ~
13820 \end_inset
13821
13822 appended to the page number of the parent
13823 \family sans
13824 Slide
13825 \family default
13826 .
13827
13828 \end_layout
13829
13830 \end_inset
13831
13832  Clearly,
13833  you want the contents of both the
13834 \family sans
13835 Slide
13836 \family default
13837  and the
13838 \family sans
13839 Overlay
13840 \family default
13841  to each fit on a single physical slide!
13842  You should probably consider an
13843 \family sans
13844 Overlay
13845 \family default
13846  as
13847 \begin_inset Quotes eld
13848 \end_inset
13849
13850 part of
13851 \begin_inset Quotes erd
13852 \end_inset
13853
13854  a
13855 \family sans
13856 Slide
13857 \family default
13858 .
13859  Indeed,
13860  the \SpecialChar LyX
13861
13862 \family sans
13863 slides
13864 \family default
13865  class provides a visual cue for this:
13866  the label at the start of an
13867 \family sans
13868 Overlay
13869 \family default
13870  is shorter than that at the start of a
13871 \family sans
13872 Slide
13873 \family default
13874 .
13875  Lastly,
13876  when you generate printable output,
13877  you'll find alignment markers in all four corners of both the
13878 \family sans
13879 Overlay
13880 \family default
13881  page and its parent
13882 \family sans
13883 Slide
13884 \family default
13885 .
13886  These will assist you in lining up the two physical slides.
13887 \end_layout
13888
13889 \begin_layout Standard
13890 The major problem in overlaying two slides is aligning the contents of the two transparencies.
13891  How much space should you leave for that graph on the second slide?
13892  Worse still,
13893  what if you want a graph and a sentence on second slide,
13894  but there is text on the main transparency that goes in between them?
13895  You could try and insert vertical space of the right size.
13896  The better way is to use
13897 \family sans
13898 InvisibleText
13899 \family default
13900  and
13901 \family sans
13902 VisibleText
13903 \family default
13904 .
13905 \end_layout
13906
13907 \begin_layout Standard
13908 As their names imply,
13909
13910 \family sans
13911 InvisibleText
13912 \family default
13913  and
13914 \family sans
13915 VisibleText
13916 \family default
13917  are two command-like paragraph environments that make all subsequent text invisible and visible,
13918  respectively.
13919  Note from section
13920 \begin_inset space ~
13921 \end_inset
13922
13923
13924 \begin_inset CommandInset ref
13925 LatexCommand ref
13926 reference "sec:slideQuirk"
13927 nolink "false"
13928
13929 \end_inset
13930
13931  that you don't place anything
13932 \emph on
13933 into
13934 \emph default
13935  these two environments,
13936  however.
13937  When you create an
13938 \family sans
13939 InvisibleText
13940 \family default
13941 ,
13942  it inserts a centered,
13943  sky-blue label into the page reading
13944 \begin_inset Quotes eld
13945 \end_inset
13946
13947 <Invisible Text Follows>
13948 \begin_inset Quotes erd
13949 \end_inset
13950
13951 .
13952  For paragraphs following this label,
13953  the parts of the
13954 \family sans
13955 Slide
13956 \family default
13957  [or
13958 \family sans
13959 Overlay
13960 \family default
13961 ;
13962  it doesn't matter which] where they would be contain instead blank space.
13963
13964 \end_layout
13965
13966 \begin_layout Standard
13967 For
13968 \family sans
13969 VisibleText
13970 \family default
13971 ,
13972  the corresponding centered label is
13973 \begin_inset Quotes eld
13974 \end_inset
13975
13976 <Visible Text Follows>
13977 \begin_inset Quotes erd
13978 \end_inset
13979
13980  in blazing green.
13981  Paragraphs following this label behave normally.
13982  Note that the beginning of a new
13983 \family sans
13984 Slide
13985 \family default
13986 ,
13987
13988 \family sans
13989 Overlay
13990 \family default
13991 ,
13992  or
13993 \family sans
13994 Note
13995 \family default
13996  automatically shuts off an
13997 \family sans
13998 InvisibleText
13999 \family default
14000 .
14001  It's therefore not necessary to use
14002 \family sans
14003 VisibleText
14004 \family default
14005  at the end of a
14006 \family sans
14007 Slide
14008 \family default
14009 .
14010 \end_layout
14011
14012 \begin_layout Standard
14013 By now,
14014  it should be obvious how to create overlay transparencies using the proper combination of
14015 \family sans
14016 InvisibleText
14017 \family default
14018  and
14019 \family sans
14020 VisibleText
14021 \family default
14022  on a
14023 \family sans
14024 Slide
14025 \family default
14026  and
14027 \family sans
14028 Overlay
14029 \family default
14030 :
14031 \end_layout
14032
14033 \begin_layout Enumerate
14034 Create a
14035 \family sans
14036 Slide
14037 \family default
14038 ,
14039  including everything that will appear on it,
14040  whether on the main slide or on the
14041 \family sans
14042 Overlay
14043 \family default
14044 .
14045 \end_layout
14046
14047 \begin_layout Enumerate
14048 Before each figure or paragraph that will appear only on the
14049 \family sans
14050 Overlay
14051 \family default
14052 ,
14053  insert an
14054 \family sans
14055 InvisibleText
14056 \family default
14057  environment.
14058  If necessary,
14059  insert a
14060 \family sans
14061 VisibleText
14062 \family default
14063  environment after the
14064 \family sans
14065 Overlay
14066 \family default
14067 -only text.
14068 \end_layout
14069
14070 \begin_layout Enumerate
14071 Start an
14072 \family sans
14073 Overlay
14074 \family default
14075  immediately following the
14076 \family sans
14077 Slide
14078 \family default
14079 .
14080 \end_layout
14081
14082 \begin_layout Enumerate
14083 Copy the contents of this
14084 \family sans
14085 Slide
14086 \family default
14087  into the
14088 \family sans
14089 Overlay
14090 \family default
14091 .
14092 \end_layout
14093
14094 \begin_layout Enumerate
14095 Within the
14096 \family sans
14097 Overlay
14098 \family default
14099 ,
14100  change all of the
14101 \family sans
14102 InvisibleText
14103 \family default
14104  lines to
14105 \family sans
14106 VisibleText
14107 \family default
14108  and vice-versa.
14109 \end_layout
14110
14111 \begin_layout Standard
14112 That's it.
14113  You've just made an
14114 \family sans
14115 Overlay
14116 \family default
14117 .
14118 \end_layout
14119
14120 \begin_layout Standard
14121 There's one problem with the way I've designed the \SpecialChar LyX
14122
14123 \family sans
14124 slides
14125 \family default
14126  class:
14127  you can't make text in the middle of a paragraph invisible,
14128  nor make text in the middle of an invisible paragraph visible again.
14129  To accomplish this feat,
14130  you'll need to use some inlined \SpecialChar LaTeX
14131  codes.
14132 \begin_inset Foot
14133 status collapsed
14134
14135 \begin_layout Plain Layout
14136 The commands of interest are:
14137
14138 \end_layout
14139
14140 \begin_layout Itemize
14141
14142 \family typewriter
14143 {
14144 \backslash
14145 invisible \SpecialChar ldots
14146  }
14147 \end_layout
14148
14149 \begin_layout Itemize
14150
14151 \family typewriter
14152 {
14153 \backslash
14154 visible \SpecialChar ldots
14155  }
14156 \end_layout
14157
14158 \begin_layout Plain Layout
14159 \SpecialChar ldots
14160 and need to be marked as \SpecialChar TeX
14161 .
14162  The text whose
14163 \begin_inset Quotes eld
14164 \end_inset
14165
14166 visibility
14167 \begin_inset Quotes erd
14168 \end_inset
14169
14170  you wish to change goes in between the brackets [and after the
14171 \family typewriter
14172
14173 \backslash
14174 invisible
14175 \family default
14176  or
14177 \family typewriter
14178
14179 \backslash
14180 visible
14181 \family default
14182  command].
14183  If you don't know how to mark text as \SpecialChar TeX
14184 ,
14185  see the appropriate section of the
14186 \emph on
14187 User's Guide
14188 \emph default
14189 .
14190 \end_layout
14191
14192 \end_inset
14193
14194
14195 \end_layout
14196
14197 \begin_layout Paragraph
14198 Using
14199 \family sans
14200 Note
14201 \family default
14202  with
14203 \family sans
14204 Slide
14205 \family default
14206
14207 \begin_inset CommandInset label
14208 LatexCommand label
14209 name "sec:slideNote"
14210
14211 \end_inset
14212
14213
14214 \end_layout
14215
14216 \begin_layout Standard
14217 Like an
14218 \family sans
14219 Overlay
14220 \family default
14221 ,
14222  a
14223 \family sans
14224 Note
14225 \family default
14226  is associated with a
14227 \begin_inset Quotes eld
14228 \end_inset
14229
14230 parent
14231 \begin_inset Quotes erd
14232 \end_inset
14233
14234
14235 \family sans
14236 Slide
14237 \family default
14238 .
14239  Here,
14240  too,
14241  the \SpecialChar LyX
14242
14243 \family sans
14244 slides
14245 \family default
14246  class provides visual cues.
14247  The label for a
14248 \family sans
14249 Note
14250 \family default
14251  is shorter than that of a
14252 \family sans
14253 Slide
14254 \family default
14255  [yet longer than that of an
14256 \family sans
14257 Overlay
14258 \family default
14259 ] and,
14260  like the label of an
14261 \family sans
14262 Overlay
14263 \family default
14264  is shockingly magenta.
14265  Additionally,
14266  the printed
14267 \family sans
14268 Note
14269 \family default
14270  has the page number of its
14271 \begin_inset Quotes eld
14272 \end_inset
14273
14274 parent
14275 \begin_inset Quotes erd
14276 \end_inset
14277
14278
14279 \family sans
14280 Slide
14281 \family default
14282 ,
14283  appended by
14284 \begin_inset Quotes eld
14285 \end_inset
14286
14287
14288 \family typewriter
14289 -
14290 \family default
14291 1
14292 \begin_inset Quotes erd
14293 \end_inset
14294
14295 ,
14296
14297 \begin_inset Quotes eld
14298 \end_inset
14299
14300
14301 \family typewriter
14302 -
14303 \family default
14304 2
14305 \begin_inset Quotes erd
14306 \end_inset
14307
14308 ,
14309
14310 \begin_inset Quotes eld
14311 \end_inset
14312
14313
14314 \family typewriter
14315 -
14316 \family default
14317 3
14318 \begin_inset Quotes erd
14319 \end_inset
14320
14321 ,
14322  etc.
14323  You can have multiple
14324 \family sans
14325 Note
14326 \family default
14327 s associated with a single
14328 \family sans
14329 Slide
14330 \family default
14331 ,
14332  and,
14333  as with
14334 \family sans
14335 Slide
14336 \family default
14337  and
14338 \family sans
14339 Overlay
14340 \family default
14341 ,
14342  you'll probably want to break up long
14343 \family sans
14344 Note
14345 \family default
14346 s so that they fit on a single sheet of paper.
14347 \end_layout
14348
14349 \begin_layout Standard
14350 The purpose of a
14351 \family sans
14352 Note
14353 \family default
14354  is obvious:
14355  it contains anything additional you might want to say about a
14356 \family sans
14357 Slide
14358 \family default
14359 .
14360  It could also be used as a sheet of reminders for a particular
14361 \family sans
14362 Slide
14363 \family default
14364 .
14365  In the case of the latter,
14366  you might want to make use of time markers.
14367  Currently,
14368  the \SpecialChar LyX
14369
14370 \family sans
14371 slides
14372 \family default
14373  class has no
14374 \begin_inset Quotes eld
14375 \end_inset
14376
14377 native
14378 \begin_inset Quotes erd
14379 \end_inset
14380
14381  support for time markers,
14382  a
14383 \noun on
14384 Sli\SpecialChar TeX
14385
14386 \noun default
14387  feature.
14388  So,
14389  you'll have to resort to using the \SpecialChar LaTeX
14390  codes.
14391 \end_layout
14392
14393 \begin_layout Standard
14394 To use time markers,
14395  you'll need to specify the extra class option
14396 \begin_inset Quotes eld
14397 \end_inset
14398
14399
14400 \family typewriter
14401 clock
14402 \family default
14403
14404 \begin_inset Quotes erd
14405 \end_inset
14406
14407  [see section
14408 \begin_inset space ~
14409 \end_inset
14410
14411
14412 \begin_inset CommandInset ref
14413 LatexCommand ref
14414 reference "sec:slidesetup"
14415 nolink "false"
14416
14417 \end_inset
14418
14419 ].
14420  This option turns on timing marks,
14421  which will appear in the lower-left-hand corner of every
14422 \family sans
14423 Note
14424 \family default
14425  you generate.
14426  To set what appears in the time marker,
14427  you use the \SpecialChar LaTeX
14428  commands
14429 \begin_inset Quotes eld
14430 \end_inset
14431
14432
14433 \family typewriter
14434
14435 \backslash
14436 settime{}
14437 \family default
14438
14439 \begin_inset Quotes erd
14440 \end_inset
14441
14442  and
14443 \begin_inset Quotes eld
14444 \end_inset
14445
14446
14447 \family typewriter
14448
14449 \backslash
14450 addtime{}
14451 \family default
14452
14453 \begin_inset Quotes erd
14454 \end_inset
14455
14456 .
14457  The arguments of both commands are time measured in seconds.
14458
14459 \begin_inset Quotes eld
14460 \end_inset
14461
14462
14463 \family typewriter
14464
14465 \backslash
14466 settime{}
14467 \family default
14468
14469 \begin_inset Quotes erd
14470 \end_inset
14471
14472  sets the time marker to a given time.
14473
14474 \begin_inset Quotes eld
14475 \end_inset
14476
14477
14478 \family typewriter
14479
14480 \backslash
14481 addtime{}
14482 \family default
14483
14484 \begin_inset Quotes erd
14485 \end_inset
14486
14487  increments the time marker by the specified amount.
14488  Using time markers and
14489 \family sans
14490 Note
14491 \family default
14492 s in this fashion,
14493  you can remind yourself how much time to spend on a particular
14494 \family sans
14495 Slide
14496 \family default
14497 .
14498 \end_layout
14499
14500 \begin_layout Standard
14501 There's one last feature to describe.
14502  Clearly,
14503  you'd like to print out all of your
14504 \family sans
14505 Slide
14506 \family default
14507 s and
14508 \family sans
14509 Overlay
14510 \family default
14511 s on transparencies while printing all of your
14512 \family sans
14513 Note
14514 \family default
14515 s on plain paper.
14516  However,
14517  a
14518 \family sans
14519 Note
14520 \family default
14521
14522 \emph on
14523 must
14524 \emph default
14525  follow the
14526 \family sans
14527 Slide
14528 \family default
14529  with which it is associated.
14530  What's a person to do?
14531 \end_layout
14532
14533 \begin_layout Standard
14534 Luckily,
14535  there are two \SpecialChar LaTeX
14536  commands that allow you to select what to print out.
14537  Both must be placed into the preamble of your document.
14538  The command
14539 \begin_inset Quotes eld
14540 \end_inset
14541
14542
14543 \family typewriter
14544
14545 \backslash
14546 onlyslides{
14547 \backslash
14548 slides}
14549 \family default
14550
14551 \begin_inset Quotes erd
14552 \end_inset
14553
14554  will cause the output to contain only the
14555 \family sans
14556 Slide
14557 \family default
14558 s and
14559 \family sans
14560 Overlay
14561 \family default
14562 s.
14563  Correspondingly,
14564  the command
14565 \begin_inset Quotes eld
14566 \end_inset
14567
14568
14569 \family typewriter
14570
14571 \backslash
14572 onlynotes{
14573 \backslash
14574 notes}
14575 \family default
14576
14577 \begin_inset Quotes erd
14578 \end_inset
14579
14580  prevents the output of anything but
14581 \family sans
14582 Note
14583 \family default
14584 s.
14585  I'd advise placing both commands in the preamble and initially comment both out.
14586  You can then preview your entire presentation as you write.
14587  When you're done writing,
14588  you can then uncomment one of the two to select what you want to print.
14589  I like to uncomment
14590 \begin_inset Quotes eld
14591 \end_inset
14592
14593
14594 \family typewriter
14595
14596 \backslash
14597 onlyslides{
14598 \backslash
14599 slides}
14600 \family default
14601
14602 \begin_inset Quotes erd
14603 \end_inset
14604
14605  ,
14606  print to a file with
14607 \begin_inset Quotes eld
14608 \end_inset
14609
14610
14611 \family typewriter
14612 -slides
14613 \family default
14614
14615 \begin_inset Quotes erd
14616 \end_inset
14617
14618  in its name,
14619  comment it back out,
14620  then uncomment
14621 \begin_inset Quotes eld
14622 \end_inset
14623
14624
14625 \family typewriter
14626
14627 \backslash
14628 onlynotes{
14629 \backslash
14630 notes}
14631 \family default
14632
14633 \begin_inset Quotes erd
14634 \end_inset
14635
14636  and print to a
14637 \begin_inset Quotes eld
14638 \end_inset
14639
14640
14641 \family typewriter
14642 *-notes.ps
14643 \family default
14644
14645 \begin_inset Quotes erd
14646 \end_inset
14647
14648  file.
14649  I can then send either file to a printer,
14650  loading transparencies or plain paper as appropriate.
14651 \end_layout
14652
14653 \begin_layout Standard
14654 You can also provide other arguments to the
14655 \begin_inset Quotes eld
14656 \end_inset
14657
14658
14659 \family typewriter
14660
14661 \backslash
14662 onlyslides{}
14663 \family default
14664
14665 \begin_inset Quotes erd
14666 \end_inset
14667
14668  and
14669 \begin_inset Quotes eld
14670 \end_inset
14671
14672
14673 \family typewriter
14674
14675 \backslash
14676 onlynotes{}
14677 \family default
14678
14679 \begin_inset Quotes erd
14680 \end_inset
14681
14682  commands.
14683  See a good \SpecialChar LaTeX
14684  book for details.
14685 \end_layout
14686
14687 \begin_layout Subsubsection
14688 The
14689 \family sans
14690 slides
14691 \family default
14692  Class Template File
14693 \end_layout
14694
14695 \begin_layout Standard
14696 I have also provided a template file
14697 \change_deleted 564990737 1671617750
14698 ,
14699
14700 \begin_inset Quotes eld
14701 \end_inset
14702
14703
14704 \family typewriter
14705 slides.lyx
14706 \family default
14707
14708 \begin_inset Quotes erd
14709 \end_inset
14710
14711 ,
14712
14713 \change_unchanged
14714  with the
14715 \family sans
14716 slides
14717 \family default
14718  class.
14719  To use it,
14720  begin your new presentation with
14721 \family sans
14722 File\SpecialChar menuseparator
14723 New
14724 \begin_inset space ~
14725 \end_inset
14726
14727 from
14728 \begin_inset space ~
14729 \end_inset
14730
14731 Template
14732 \change_inserted 564990737 1671616988
14733 \SpecialChar menuseparator
14734 Presentations\SpecialChar menuseparator
14735 Slides
14736 \change_unchanged
14737
14738 \family default
14739 .
14740  Your new \SpecialChar LyX
14741  presentation file will contain an example
14742 \family sans
14743 Slide
14744 \family default
14745  –
14746 \family sans
14747 Overlay
14748 \family default
14749  –
14750 \family sans
14751 Note
14752 \family default
14753  triplet.
14754  The
14755 \family sans
14756 Slide
14757 \family default
14758  and
14759 \family sans
14760 Overlay
14761 \family default
14762  additionally contain an example of the use of
14763 \family sans
14764 InvisibleText
14765 \family default
14766  and
14767 \family sans
14768 VisibleText
14769 \family default
14770 .
14771  Lastly,
14772  the preamble will contain:
14773 \end_layout
14774
14775 \begin_layout LyX-Code
14776 % Uncomment to print out only slides and overlays
14777 \end_layout
14778
14779 \begin_layout LyX-Code
14780 %
14781 \end_layout
14782
14783 \begin_layout LyX-Code
14784 %
14785 \backslash
14786 onlyslides{
14787 \backslash
14788 slides}
14789 \begin_inset Newline newline
14790 \end_inset
14791
14792
14793 \end_layout
14794
14795 \begin_layout LyX-Code
14796 % Uncomment to print out only notes
14797 \end_layout
14798
14799 \begin_layout LyX-Code
14800 %
14801 \end_layout
14802
14803 \begin_layout LyX-Code
14804 %
14805 \backslash
14806 onlynotes{
14807 \backslash
14808 notes}
14809 \end_layout
14810
14811 \begin_layout Standard
14812 One final thing:
14813  I created this class to support the \SpecialChar LaTeX2e
14814
14815 \begin_inset Quotes eld
14816 \end_inset
14817
14818
14819 \noun on
14820 Sli\SpecialChar TeX
14821
14822 \noun default
14823  emulation
14824 \begin_inset Quotes erd
14825 \end_inset
14826
14827  class,
14828  one of the built-in \SpecialChar LaTeX2e
14829  classes.
14830  Neither I nor the rest of the \SpecialChar LyX
14831  Team endorse or oppose the use of this built-in slide class.
14832  It's here if you want it or need it.
14833  There exist other \SpecialChar LaTeX2e
14834  classes for creating presentations,
14835  such as the
14836 \family sans
14837 Foils
14838 \family default
14839  class [see section
14840 \begin_inset space ~
14841 \end_inset
14842
14843
14844 \begin_inset CommandInset ref
14845 LatexCommand ref
14846 reference "sec:foiltex"
14847 nolink "false"
14848
14849 \end_inset
14850
14851 ] or the
14852 \begin_inset Quotes eld
14853 \end_inset
14854
14855
14856 \family typewriter
14857 seminar
14858 \family default
14859
14860 \begin_inset Quotes erd
14861 \end_inset
14862
14863  package [present on some \SpecialChar TeX
14864  distributions].
14865  The latter is not yet supported under \SpecialChar LyX
14866 .
14867 \begin_inset Foot
14868 status collapsed
14869
14870 \begin_layout Plain Layout
14871 Perhaps you can take on the task\SpecialChar ldots
14872
14873 \end_layout
14874
14875 \end_inset
14876
14877  I know nothing about these other classes.
14878  Try them out to see what sort of alternative they provide.
14879 \end_layout
14880
14881 \begin_layout Section
14882
14883 \change_inserted 564990737 1670439661
14884 Reports
14885 \end_layout
14886
14887 \begin_layout Subsection
14888
14889 \change_inserted 564990737 1670439661
14890 report
14891 \end_layout
14892
14893 \begin_layout Standard
14894
14895 \change_inserted 564990737 1670439661
14896 The document class
14897 \family sans
14898 report
14899 \family default
14900  provides the
14901 \family sans
14902 report.cls
14903 \family default
14904  document class for preparing reports.
14905  Like the
14906 \family sans
14907 book
14908 \family default
14909  document class,
14910  this provides parts,
14911  chapters and sections but does not provide the paragraph styles needed for a book;
14912  like the
14913 \family sans
14914 article
14915 \family default
14916  document class,
14917  it provides the abstract paragraph style.
14918  In two-sided mode,
14919  it does not start a new chapter on the right hand page.
14920 \end_layout
14921
14922 \begin_layout Standard
14923
14924 \change_inserted 564990737 1672743528
14925 The remaining
14926 \family sans
14927 report
14928 \family default
14929  document classes are described in the Collections (section
14930 \begin_inset space ~
14931 \end_inset
14932
14933
14934 \begin_inset CommandInset ref
14935 LatexCommand ref
14936 reference "sec:Collections"
14937 nolink "false"
14938
14939 \end_inset
14940
14941 ).
14942 \end_layout
14943
14944 \begin_layout Standard
14945
14946 \change_inserted 564990737 1672743530
14947 For
14948 \family sans
14949 report
14950 \begin_inset space \thinspace{}
14951 \end_inset
14952
14953 (Japanese in vertical writing)
14954 \family default
14955  and
14956 \family sans
14957 report
14958 \begin_inset space \thinspace{}
14959 \end_inset
14960
14961 (Japanese)
14962 \family default
14963 ,
14964  see section
14965 \begin_inset space ~
14966 \end_inset
14967
14968
14969 \begin_inset CommandInset ref
14970 LatexCommand ref
14971 reference "subsec:Japanese"
14972 nolink "false"
14973
14974 \end_inset
14975
14976 .
14977 \end_layout
14978
14979 \begin_layout Standard
14980
14981 \change_inserted 564990737 1672743530
14982 For
14983 \family sans
14984 report
14985 \begin_inset space \thinspace{}
14986 \end_inset
14987
14988 (KOMA-Script)
14989 \family default
14990 ,
14991  see section
14992 \begin_inset space ~
14993 \end_inset
14994
14995
14996 \begin_inset CommandInset ref
14997 LatexCommand ref
14998 reference "subsec:KOMA-Script"
14999 nolink "false"
15000
15001 \end_inset
15002
15003 .
15004 \end_layout
15005
15006 \begin_layout Standard
15007
15008 \change_inserted 564990737 1672743530
15009 For
15010 \family sans
15011 report
15012 \begin_inset space \thinspace{}
15013 \end_inset
15014
15015 (with extra font sizes)
15016 \family default
15017 ,
15018  see section
15019 \begin_inset space ~
15020 \end_inset
15021
15022
15023 \begin_inset CommandInset ref
15024 LatexCommand ref
15025 reference "subsec:Extra-font-sizes"
15026 nolink "false"
15027
15028 \end_inset
15029
15030 .
15031 \end_layout
15032
15033 \begin_layout Standard
15034
15035 \change_inserted 564990737 1672743569
15036 For
15037 \family sans
15038 report
15039 \begin_inset space \thinspace{}
15040 \end_inset
15041
15042 (Polish version by M.
15043 \begin_inset space \thinspace{}
15044 \end_inset
15045
15046 W.)
15047 \family default
15048 ,
15049  see section
15050 \begin_inset space ~
15051 \end_inset
15052
15053
15054 \begin_inset CommandInset ref
15055 LatexCommand ref
15056 reference "subsec:Polish-M.W.collection"
15057 plural "false"
15058 caps "false"
15059 noprefix "false"
15060 nolink "false"
15061
15062 \end_inset
15063
15064 .
15065 \end_layout
15066
15067 \begin_layout Section
15068
15069 \change_inserted 564990737 1670439674
15070 Scripts (drama)
15071 \end_layout
15072
15073 \begin_layout Subsection
15074 Broadway
15075 \end_layout
15076
15077 \begin_layout Standard
15078 by
15079 \shape smallcaps
15080 Garst Reese
15081 \end_layout
15082
15083 \begin_layout Subsubsection
15084 Introduction
15085 \end_layout
15086
15087 \begin_layout Standard
15088 Broadway is for writing plays.
15089  The format is more decorative than Hollywood,
15090  and much less standardized.
15091  This format should be suitable for workshops.
15092 \end_layout
15093
15094 \begin_layout Subsubsection
15095 Special problems
15096 \end_layout
15097
15098 \begin_layout Standard
15099 The same as in Hollywood.
15100 \end_layout
15101
15102 \begin_layout Subsubsection
15103 Special features
15104 \end_layout
15105
15106 \begin_layout Standard
15107 Insert the
15108 \family sans
15109 Speaker
15110 \family default
15111  names as labels then cross-reference the label to insert the name.
15112  The cross-reference dialog will show the current cast of characters.
15113 \end_layout
15114
15115 \begin_layout Subsubsection
15116 Paper size and Margins
15117 \end_layout
15118
15119 \begin_layout Standard
15120 USLetter,
15121  left 1.6in,
15122  right 0.75in,
15123  top 0.5in,
15124  bottom 0.75in
15125 \end_layout
15126
15127 \begin_layout Subsubsection
15128 Environments
15129 \end_layout
15130
15131 \begin_layout Standard
15132 The following environments are available.
15133  You can use broadway.bind to get the bind keys shown at the right.
15134 \end_layout
15135
15136 \begin_layout Itemize
15137
15138 \family sans
15139 Standard
15140 \begin_inset Newline newline
15141 \end_inset
15142
15143
15144 \family default
15145 You should not have to use this,
15146  but it is here for anything that does not fit otherwise.
15147 \end_layout
15148
15149 \begin_layout Itemize
15150
15151 \family sans
15152 Narrative
15153 \begin_inset space \hfill{}
15154 \end_inset
15155
15156 M-z n
15157 \begin_inset Newline newline
15158 \end_inset
15159
15160
15161 \family default
15162 Used to describe stage setting and the action.
15163  First use of speaker names in all CAPs.
15164 \end_layout
15165
15166 \begin_layout Itemize
15167
15168 \family sans
15169 ACT
15170 \begin_inset space \hfill{}
15171 \end_inset
15172
15173 M-z a
15174 \begin_inset Newline newline
15175 \end_inset
15176
15177
15178 \family default
15179 Automatically numbered.
15180  On screen it will be arabic,
15181  but will print as Roman.
15182 \end_layout
15183
15184 \begin_layout Itemize
15185
15186 \family sans
15187 ACT*
15188 \begin_inset space \hfill{}
15189 \end_inset
15190
15191 M-z S at
15192 \begin_inset Newline newline
15193 \end_inset
15194
15195
15196 \family default
15197 Subtitle for
15198 \family sans
15199 ACT.
15200
15201 \family default
15202  It is just centered text.
15203 \end_layout
15204
15205 \begin_layout Itemize
15206
15207 \family sans
15208 SCENE
15209 \begin_inset space \hfill{}
15210 \end_inset
15211
15212 M-z S-S
15213 \begin_inset Newline newline
15214 \end_inset
15215
15216
15217 \family default
15218 Not automatically numbered.
15219  You supply the number.
15220  This is because I couldn't figure out how.
15221 \end_layout
15222
15223 \begin_layout Itemize
15224
15225 \family sans
15226 AT_RISE:
15227 \begin_inset space \hfill{}
15228 \end_inset
15229
15230 M-z S-R
15231 \begin_inset Newline newline
15232 \end_inset
15233
15234
15235 \family default
15236 A special case of Narrative to describe the setting and action as the curtain rises.
15237 \end_layout
15238
15239 \begin_layout Itemize
15240
15241 \family sans
15242 Speaker
15243 \begin_inset space \hfill{}
15244 \end_inset
15245
15246 M-z s
15247 \begin_inset Newline newline
15248 \end_inset
15249
15250
15251 \family default
15252 The speaker's (actor's) title,
15253  centered in all CAPS.
15254 \end_layout
15255
15256 \begin_layout Itemize
15257
15258 \family sans
15259 Parenthetical
15260 \begin_inset space \hfill{}
15261 \end_inset
15262
15263 M-z p
15264 \begin_inset Newline newline
15265 \end_inset
15266
15267
15268 \family default
15269 Instructions to the speaker.
15270  The parentheses are automatically inserted.
15271  The ( will appear on screen,
15272  but both will be in the printed play.
15273  This environment is only used within
15274 \family sans
15275 Dialogue
15276 \family default
15277 .
15278 \end_layout
15279
15280 \begin_layout Itemize
15281
15282 \family sans
15283 Dialogue
15284 \begin_inset space \hfill{}
15285 \end_inset
15286
15287 M-z d
15288 \begin_inset Newline newline
15289 \end_inset
15290
15291
15292 \family default
15293 What the Speaker says.
15294 \end_layout
15295
15296 \begin_layout Itemize
15297
15298 \family sans
15299 CURTAIN
15300 \begin_inset space \hfill{}
15301 \end_inset
15302
15303 M-z S-C
15304 \begin_inset Newline newline
15305 \end_inset
15306
15307
15308 \family default
15309 The curtain comes down.
15310 \end_layout
15311
15312 \begin_layout Itemize
15313
15314 \family sans
15315 Title
15316 \begin_inset space \hfill{}
15317 \end_inset
15318
15319 M-z S-T
15320 \end_layout
15321
15322 \begin_layout Itemize
15323
15324 \family sans
15325 Author
15326 \begin_inset space \hfill{}
15327 \end_inset
15328
15329 M-z S-A
15330 \end_layout
15331
15332 \begin_layout Itemize
15333
15334 \family sans
15335 Right_Address
15336 \begin_inset space \hfill{}
15337 \end_inset
15338
15339 M-z r
15340 \end_layout
15341
15342 \begin_layout Standard
15343 Hello there.
15344 \end_layout
15345
15346 \begin_layout Subsection
15347 Hollywood (Hollywood spec scripts)
15348 \end_layout
15349
15350 \begin_layout Standard
15351 by
15352 \shape smallcaps
15353 Garst Reese
15354 \end_layout
15355
15356 \begin_layout Subsubsection
15357 Introduction
15358 \end_layout
15359
15360 \begin_layout Standard
15361 Getting the format of a Hollywood script right is a
15362 \begin_inset Quotes eld
15363 \end_inset
15364
15365 rite of passage.
15366 \begin_inset Quotes erd
15367 \end_inset
15368
15369  It is designed to make the readers focus on content and to be easy and familiar for the actors to read.
15370  Each page of a script should be one minute of film.
15371  Nothing goes in a script that you cannot see or hear on screen.
15372  The courier 12 pt font should be used throughout.
15373  No italics.
15374 \end_layout
15375
15376 \begin_layout Subsubsection
15377 Special problems
15378 \end_layout
15379
15380 \begin_layout Standard
15381 Speakers' lines should NEVER break in mid-sentence.
15382  If a speaker's lines continue over a page break,
15383  repeat the
15384 \family sans
15385 Speaker
15386 \family default
15387  title followed by (Cont'd).
15388 \end_layout
15389
15390 \begin_layout Subsubsection
15391 Special features
15392 \end_layout
15393
15394 \begin_layout Standard
15395 Insert the
15396 \family sans
15397 Speaker
15398 \family default
15399  names as labels then cross-reference the label to insert the name.
15400  The cross-reference dialog will show the current cast of characters.
15401  You can use this to insert the speaker name in narratives also.
15402 \end_layout
15403
15404 \begin_layout Subsubsection
15405 Paper size and Margins
15406 \end_layout
15407
15408 \begin_layout Standard
15409 USLetter,
15410  left 1.6in,
15411  right 0.75in,
15412  top 0.5in,
15413  bottom 0.75in
15414 \end_layout
15415
15416 \begin_layout Subsubsection
15417 Environments
15418 \end_layout
15419
15420 \begin_layout Standard
15421 The following environments are available.
15422  You can use hollywood.bind to get the bind keys shown at the right.
15423 \end_layout
15424
15425 \begin_layout Itemize
15426
15427 \family sans
15428 Standard
15429 \begin_inset Newline newline
15430 \end_inset
15431
15432
15433 \family default
15434 Used where nothing else works.
15435  Try to avoid it.
15436 \end_layout
15437
15438 \begin_layout Itemize
15439
15440 \family sans
15441 FADE_IN
15442 \family default
15443 :
15444 \begin_inset space \hfill{}
15445 \end_inset
15446
15447
15448 \family sans
15449 M-z S-I
15450 \family default
15451
15452 \begin_inset Newline newline
15453 \end_inset
15454
15455 Usually followed by something like
15456 \begin_inset Quotes eld
15457 \end_inset
15458
15459 on Sally waking up.
15460 \begin_inset Quotes erd
15461 \end_inset
15462
15463
15464 \end_layout
15465
15466 \begin_layout Itemize
15467
15468 \family sans
15469 INT:
15470 \begin_inset space \hfill{}
15471 \end_inset
15472
15473 M-z i
15474 \begin_inset Newline newline
15475 \end_inset
15476
15477
15478 \family default
15479 Introduces a new INTERIOR camera set-up.
15480  Always followed by DAY or NIGHT,
15481  or something similar to define the lighting required.
15482  Everthing on this line in CAPS.
15483 \end_layout
15484
15485 \begin_layout Itemize
15486
15487 \family sans
15488 EXT:
15489 \begin_inset space \hfill{}
15490 \end_inset
15491
15492 M-z e
15493 \begin_inset Newline newline
15494 \end_inset
15495
15496
15497 \family default
15498 Introduces a new EXTERIOR camera set-up.
15499  Everthing on this line in CAPS.
15500 \end_layout
15501
15502 \begin_layout Itemize
15503
15504 \family sans
15505 Speaker
15506 \begin_inset space \hfill{}
15507 \end_inset
15508
15509 M-z s
15510 \begin_inset Newline newline
15511 \end_inset
15512
15513
15514 \family default
15515 The character speaking.
15516 \end_layout
15517
15518 \begin_layout Itemize
15519
15520 \family sans
15521 Parenthetical
15522 \begin_inset space \hfill{}
15523 \end_inset
15524
15525 M-z p
15526 \begin_inset Newline newline
15527 \end_inset
15528
15529
15530 \family default
15531 Instructions to the speaker.
15532  The () are automatically inserted.
15533 \end_layout
15534
15535 \begin_layout Itemize
15536
15537 \family sans
15538 Dialogue
15539 \begin_inset space \hfill{}
15540 \end_inset
15541
15542 M-z d
15543 \begin_inset Newline newline
15544 \end_inset
15545
15546
15547 \family default
15548 What the
15549 \family sans
15550 Speaker
15551 \family default
15552  says.
15553 \end_layout
15554
15555 \begin_layout Itemize
15556
15557 \family sans
15558 Transition
15559 \begin_inset space \hfill{}
15560 \end_inset
15561
15562 M-z t
15563 \begin_inset Newline newline
15564 \end_inset
15565
15566
15567 \family default
15568 Camera movement instruction.
15569  e.
15570 \begin_inset space \thinspace{}
15571 \end_inset
15572
15573 g.
15574 \begin_inset space \space{}
15575 \end_inset
15576
15577 CUT TO:
15578 \end_layout
15579
15580 \begin_layout Itemize
15581
15582 \family sans
15583 FADE OUT:
15584 \begin_inset space \hfill{}
15585 \end_inset
15586
15587 M-z S-I
15588 \end_layout
15589
15590 \begin_layout Itemize
15591
15592 \family sans
15593 Author
15594 \begin_inset space \hfill{}
15595 \end_inset
15596
15597 M-z S-A
15598 \end_layout
15599
15600 \begin_layout Itemize
15601
15602 \family sans
15603 Title
15604 \begin_inset space \hfill{}
15605 \end_inset
15606
15607 M-z S-T
15608 \end_layout
15609
15610 \begin_layout Itemize
15611
15612 \family sans
15613 Right_Address
15614 \begin_inset space \hfill{}
15615 \end_inset
15616
15617 M-z r
15618 \end_layout
15619
15620 \begin_layout Subsubsection
15621 Script jargon
15622 \end_layout
15623
15624 \begin_layout Itemize
15625 (O.S) —
15626  off screen
15627 \end_layout
15628
15629 \begin_layout Itemize
15630 (V.0) —
15631  voice over
15632 \end_layout
15633
15634 \begin_layout Itemize
15635 b.
15636 \begin_inset space \thinspace{}
15637 \end_inset
15638
15639 g.
15640  —
15641  background
15642 \end_layout
15643
15644 \begin_layout Itemize
15645 C.U.
15646  —
15647  close-up
15648 \end_layout
15649
15650 \begin_layout Itemize
15651 PAN —
15652  camera movement
15653 \end_layout
15654
15655 \begin_layout Itemize
15656 INSERT —
15657  cut to close-up of
15658 \end_layout
15659
15660 \begin_layout Chapter
15661
15662 \change_inserted 564990737 1671185876
15663 Modules
15664 \end_layout
15665
15666 \begin_layout Section
15667
15668 \change_inserted 564990737 1671716212
15669 Academic Field Specifics
15670 \end_layout
15671
15672 \begin_layout Subsection
15673
15674 \change_inserted 564990737 1671716212
15675 Chemistry:
15676  Hazard and Precautionary Statements
15677 \end_layout
15678
15679 \begin_layout Standard
15680
15681 \change_inserted 564990737 1671716212
15682 This module provides two insets to typeset numbers and phrases of chemical hazard and precautionary statements.
15683  For a description see
15684 \family sans
15685 File\SpecialChar menuseparator
15686 Open Example\SpecialChar menuseparator
15687 Modules\SpecialChar menuseparator
15688 Hazard and Precautionary Statements
15689 \family default
15690  and
15691 \family sans
15692 Help\SpecialChar menuseparator
15693 Specific Manuals\SpecialChar menuseparator
15694 Hazard and Precautionary Statements
15695 \family default
15696 .
15697 \end_layout
15698
15699 \begin_layout Subsection
15700
15701 \change_inserted 564990737 1671716212
15702
15703 \series bold
15704 Chemistry:
15705  Risk and Safety Statements
15706 \end_layout
15707
15708 \begin_layout Standard
15709
15710 \change_inserted 564990737 1671716212
15711 This module provides two insets,
15712
15713 \family sans
15714 R-S number
15715 \family default
15716  and
15717 \family sans
15718 R-S phrase
15719 \family default
15720 ,
15721  accessible via the menu
15722 \family sans
15723 \bar under
15724 I
15725 \bar default
15726 nsert\SpecialChar menuseparator
15727 Custom
15728 \begin_inset space ~
15729 \end_inset
15730
15731 Insets
15732 \family default
15733  and an environment to typeset numbers and phrases of chemical risk and safety statements.
15734 \end_layout
15735
15736 \begin_layout Subsection
15737
15738 \change_inserted 564990737 1671716212
15739 Linguistics
15740 \end_layout
15741
15742 \begin_layout Standard
15743
15744 \change_inserted 564990737 1671716212
15745 This module uses the
15746 \family sans
15747 covington.sty
15748 \family default
15749  package to add environments useful for linguistics (numbered examples,
15750  glosses,
15751  semantic markup,
15752  tableau floats).
15753  You can obtain information about this module in
15754 \family sans
15755 \bar under
15756 H
15757 \bar default
15758 elp\SpecialChar menuseparator
15759 S
15760 \bar under
15761 p
15762 \bar default
15763 ecific
15764 \begin_inset space ~
15765 \end_inset
15766
15767 Manuals\SpecialChar menuseparator
15768
15769 \bar under
15770 L
15771 \bar default
15772 inguistics
15773 \family default
15774  and
15775 \family sans
15776 File\SpecialChar menuseparator
15777 Open Example\SpecialChar menuseparator
15778 Modules\SpecialChar menuseparator
15779 Linguistics
15780 \family default
15781 .
15782 \end_layout
15783
15784 \begin_layout Section
15785
15786 \change_inserted 564990737 1671788778
15787 Accessibility
15788 \end_layout
15789
15790 \begin_layout Subsection
15791
15792 \change_inserted 564990737 1671788778
15793 Braille
15794 \end_layout
15795
15796 \begin_layout Standard
15797
15798 \change_inserted 564990737 1671788778
15799 This module supports the Braille writing system.
15800  It requires the \SpecialChar LaTeX
15801  package
15802 \family typewriter
15803 braille.sty
15804 \family default
15805 .
15806  This and its documentation can be obtained from
15807 \begin_inset CommandInset href
15808 LatexCommand href
15809 name "CTAN"
15810 target "https://www.ctan.org/pkg/braille"
15811 literal "false"
15812
15813 \end_inset
15814
15815 .
15816  You do not have to reconfigure your system after installing it.
15817  See
15818 \family sans
15819 \bar under
15820 H
15821 \bar default
15822 elp\SpecialChar menuseparator
15823 S
15824 \bar under
15825 p
15826 \bar default
15827 ecific
15828 \begin_inset space ~
15829 \end_inset
15830
15831 Manuals\SpecialChar menuseparator
15832
15833 \bar under
15834 B
15835 \bar default
15836 raille
15837 \family default
15838  and
15839 \family sans
15840 File\SpecialChar menuseparator
15841 Open Example\SpecialChar menuseparator
15842 Modules\SpecialChar menuseparator
15843 Braille
15844 \family default
15845 .
15846 \end_layout
15847
15848 \begin_layout Section
15849
15850 \change_inserted 564990737 1671788778
15851 Annotation & Revision
15852 \end_layout
15853
15854 \begin_layout Subsection
15855
15856 \change_inserted 564990737 1671788778
15857 FiXme Notes
15858 \end_layout
15859
15860 \begin_layout Standard
15861
15862 \change_inserted 564990737 1671788778
15863 This module provides “FiXme” (marginal) annotations for document revision purposes.
15864  A list of annotations can be produced by using the “List of FIXMEs” paragraph style.
15865  The annotations are customizable via the LaTeX preamble.
15866  See the FiXme documentation which can be obtained from
15867 \begin_inset CommandInset href
15868 LatexCommand href
15869 name "CTAN"
15870 target "http://mirrors.ctan.org/macros/latex/contrib/fixme/fixme.pdf"
15871 literal "false"
15872
15873 \end_inset
15874
15875 .
15876
15877 \end_layout
15878
15879 \begin_layout Paragraph
15880
15881 \change_inserted 564990737 1671788778
15882 Note:
15883 \end_layout
15884
15885 \begin_layout Standard
15886
15887 \change_inserted 564990737 1671788778
15888 by default,
15889  the notes are only displayed in “draft” mode (if the option “draft” has been inserted in
15890 \family sans
15891 Document\SpecialChar menuseparator
15892 Settings\SpecialChar menuseparator
15893 Document Class\SpecialChar menuseparator
15894 Class Options\SpecialChar menuseparator
15895 Custom
15896 \family default
15897 ).
15898  To display them always,
15899  insert
15900 \family typewriter
15901
15902 \backslash
15903 fxsetup{draft}
15904 \family default
15905  in
15906 \family sans
15907 Document\SpecialChar menuseparator
15908 Settings\SpecialChar menuseparator
15909 \SpecialChar LaTeX
15910  Preamble
15911 \family default
15912 .
15913
15914 \end_layout
15915
15916 \begin_layout Subsection
15917
15918 \change_inserted 564990737 1671788778
15919 PDF Comments
15920 \end_layout
15921
15922 \begin_layout Standard
15923
15924 \change_inserted 564990737 1671788778
15925 This module provides various kinds of annotations for PDF output.
15926  See
15927 \family sans
15928 Help\SpecialChar menuseparator
15929 Specific Manuals\SpecialChar menuseparator
15930 PDF comments and File\SpecialChar menuseparator
15931 Open Example\SpecialChar menuseparator
15932 Modules\SpecialChar menuseparator
15933 PDF Comments
15934 \family default
15935 .
15936 \end_layout
15937
15938 \begin_layout Subsection
15939
15940 \change_inserted 564990737 1671788778
15941
15942 \series bold
15943 PDF Form
15944 \end_layout
15945
15946 \begin_layout Standard
15947
15948 \change_inserted 564990737 1671788778
15949 This module provides fields and buttons for PDF forms.
15950  See the
15951 \begin_inset CommandInset href
15952 LatexCommand href
15953 name "hyperref documentation"
15954 target "http://mirrors.ctan.org/macros/latex/contrib/hyperref/doc/hyperref-doc.pdf"
15955 literal "false"
15956
15957 \end_inset
15958
15959 ,
15960
15961 \family sans
15962 Help\SpecialChar menuseparator
15963 Specific Manuals\SpecialChar menuseparator
15964 PDF forms and File\SpecialChar menuseparator
15965 Open Example\SpecialChar menuseparator
15966 Modules\SpecialChar menuseparator
15967 PDF Form
15968 \family default
15969 .
15970 \end_layout
15971
15972 \begin_layout Subsection
15973
15974 \change_inserted 564990737 1671788778
15975
15976 \series bold
15977 Ruby (Furigana)
15978 \end_layout
15979
15980 \begin_layout Standard
15981
15982 \change_inserted 564990737 1671788778
15983 This module defines an inset to typeset reading aids (ruby,
15984  furigana) to Chinese characters.
15985  It uses the “okumakro,” “luatexja-ruby” or “ruby” package (depending on the TeX engine) or a fallback definition.
15986
15987 \end_layout
15988
15989 \begin_layout Subsection
15990
15991 \change_inserted 564990737 1671788778
15992
15993 \series bold
15994 TODO notes
15995 \end_layout
15996
15997 \begin_layout Standard
15998
15999 \change_inserted 564990737 1671788778
16000 This module provides custom insets to insert TODO items in your document.
16001  In order to generate a “List of TODOs,” the module provides a paragraph style.
16002  Inserting “final” in
16003 \family sans
16004 Document\SpecialChar menuseparator
16005 Settings\SpecialChar menuseparator
16006 Document Class\SpecialChar menuseparator
16007 Class Options\SpecialChar menuseparator
16008 Custom
16009 \family default
16010 ) suppresses the output of TODO notes.
16011  See the
16012 \begin_inset CommandInset href
16013 LatexCommand href
16014 name "todonotes documentation"
16015 target "http://mirrors.ctan.org/macros/latex/contrib/todonotes/todonotes.pdf"
16016 literal "false"
16017
16018 \end_inset
16019
16020 .
16021 \end_layout
16022
16023 \begin_layout Section
16024
16025 \change_inserted 564990737 1671829045
16026 Bibliography
16027 \end_layout
16028
16029 \begin_layout Subsection
16030
16031 \change_inserted 564990737 1671829045
16032 APA Style with NatBib
16033 \end_layout
16034
16035 \begin_layout Standard
16036
16037 \change_inserted 564990737 1671829045
16038 This module adds support for using natbib together with apacite (the bibliography style need not be apacite —
16039  it could be apacite,
16040  apacitex,
16041  or any bibliography that works with both the natbib and apacite packages.)
16042 \end_layout
16043
16044 \begin_layout Section
16045
16046 \change_inserted 564990737 1671829045
16047 Boxes
16048 \end_layout
16049
16050 \begin_layout Subsection
16051
16052 \change_inserted 564990737 1671829045
16053 Fancy Colored Boxes
16054 \end_layout
16055
16056 \begin_layout Standard
16057
16058 \change_inserted 564990737 1671829045
16059 This module adds ten custom insets that support colored boxes via the tcolorbox package.
16060  See
16061 \family sans
16062 Help\SpecialChar menuseparator
16063 Specific Manuals\SpecialChar menuseparator
16064 Colored boxes
16065 \family default
16066 ,
16067
16068 \family sans
16069 File\SpecialChar menuseparator
16070 Open Example\SpecialChar menuseparator
16071 Modules\SpecialChar menuseparator
16072 Fancy Color Boxes
16073 \family default
16074  the
16075 \begin_inset CommandInset href
16076 LatexCommand href
16077 name "tcolorbox documentation"
16078 target "http://mirrors.ctan.org/macros/latex/contrib/tcolorbox/tcolorbox.pdf"
16079 literal "false"
16080
16081 \end_inset
16082
16083  for details.
16084
16085 \end_layout
16086
16087 \begin_layout Subsection
16088
16089 \change_inserted 564990737 1671829045
16090 Graphic boxes
16091 \end_layout
16092
16093 \begin_layout Standard
16094
16095 \change_inserted 564990737 1671829045
16096 This provides the custom insets
16097 \family sans
16098 Reflectbox
16099 \family default
16100 ,
16101
16102 \family sans
16103 Resizebox
16104 \family default
16105 ,
16106
16107 \family sans
16108 Rotatebox
16109 \family default
16110  and
16111 \family sans
16112 Scalebox
16113 \family default
16114  to scale and rotate its content.
16115 \end_layout
16116
16117 \begin_layout Standard
16118
16119 \change_inserted 564990737 1671829045
16120
16121 \family sans
16122 Reflectbox
16123 \family default
16124  is a simple way of reversing text without any other enhancement:
16125 \end_layout
16126
16127 \begin_layout Standard
16128
16129 \change_inserted 564990737 1671829045
16130 \begin_inset Flex Reflectbox
16131 status open
16132
16133 \begin_layout Plain Layout
16134
16135 \change_inserted 564990737 1671829045
16136 Great Western Railway
16137 \change_unchanged
16138
16139 \end_layout
16140
16141 \end_inset
16142
16143
16144 \end_layout
16145
16146 \begin_layout Standard
16147
16148 \change_inserted 564990737 1671829045
16149 (You will need to use Ctrl-R to see any of these examples.)
16150 \end_layout
16151
16152 \begin_layout Standard
16153
16154 \change_inserted 564990737 1671829045
16155
16156 \family sans
16157 Resizebox
16158 \family default
16159  allows you to specify the dimensions of the text or image;
16160  permissible units are em,
16161  ex,
16162  in,
16163  pt,
16164  pc,
16165  cm,
16166  mm,
16167  dd,
16168  cc,
16169  nd,
16170  nc,
16171  bp,
16172  or sp;
16173  if you enter
16174 \family typewriter
16175 !
16176
16177 \family default
16178  for
16179 \family typewriter
16180 Height
16181 \family default
16182  it scales by the width factor:
16183 \end_layout
16184
16185 \begin_layout Standard
16186
16187 \change_inserted 564990737 1671829045
16188 \begin_inset Flex Resizebox
16189 status open
16190
16191 \begin_layout Plain Layout
16192
16193 \change_inserted 564990737 1671829045
16194 \begin_inset Argument 1
16195 status open
16196
16197 \begin_layout Plain Layout
16198
16199 \change_inserted 564990737 1671829045
16200 48mm
16201 \change_unchanged
16202
16203 \end_layout
16204
16205 \end_inset
16206
16207
16208 \begin_inset Argument 2
16209 status open
16210
16211 \begin_layout Plain Layout
16212
16213 \change_inserted 564990737 1671829045
16214 !
16215 \change_unchanged
16216
16217 \end_layout
16218
16219 \end_inset
16220
16221 Great Western Railway
16222 \change_unchanged
16223
16224 \end_layout
16225
16226 \end_inset
16227
16228
16229 \end_layout
16230
16231 \begin_layout Standard
16232
16233 \change_inserted 564990737 1671829045
16234
16235 \family sans
16236 Rotatebox
16237 \family default
16238  allows you to rotate text around the reference point of the box.
16239  If you wish to rotate the box around a different origin,
16240  place the cursor inside the box and select Insert\SpecialChar menuseparator
16241 Origin;
16242  o
16243 \family typewriter
16244 rigin
16245 \family default
16246  is specified as
16247 \family typewriter
16248 c
16249 \family default
16250 ,
16251
16252 \family typewriter
16253  l
16254 \family default
16255 ,
16256
16257 \family typewriter
16258  r
16259 \family default
16260 ,
16261
16262 \family typewriter
16263  b
16264 \family default
16265 ,
16266
16267 \family typewriter
16268  t
16269 \family default
16270  or meaningful combinations of these and the counterclockwise rotation angle is expressed in degrees.
16271  For example:
16272 \end_layout
16273
16274 \begin_layout Standard
16275
16276 \change_inserted 564990737 1671829045
16277 \begin_inset Flex Rotatebox
16278 status open
16279
16280 \begin_layout Plain Layout
16281
16282 \change_inserted 564990737 1671829045
16283 \begin_inset Argument 1
16284 status open
16285
16286 \begin_layout Plain Layout
16287
16288 \change_inserted 274215730 1672888693
16289 origin
16290 \change_inserted 564990737 1671829045
16291 =c
16292 \change_unchanged
16293
16294 \end_layout
16295
16296 \end_inset
16297
16298
16299 \begin_inset Argument 2
16300 status open
16301
16302 \begin_layout Plain Layout
16303
16304 \change_inserted 564990737 1671829045
16305 30
16306 \change_unchanged
16307
16308 \end_layout
16309
16310 \end_inset
16311
16312 Great Western Railway
16313 \change_unchanged
16314
16315 \end_layout
16316
16317 \end_inset
16318
16319
16320 \end_layout
16321
16322 \begin_layout Standard
16323
16324 \change_inserted 564990737 1671829045
16325 You can combine boxes as in:
16326 \end_layout
16327
16328 \begin_layout Standard
16329
16330 \change_inserted 564990737 1671829045
16331 \begin_inset Flex Rotatebox
16332 status open
16333
16334 \begin_layout Plain Layout
16335
16336 \change_inserted 564990737 1671829045
16337 \begin_inset Argument 1
16338 status open
16339
16340 \begin_layout Plain Layout
16341
16342 \change_inserted 274215730 1672888702
16343 origin
16344 \change_inserted 564990737 1671829045
16345 =c
16346 \change_unchanged
16347
16348 \end_layout
16349
16350 \end_inset
16351
16352
16353 \begin_inset Argument 2
16354 status open
16355
16356 \begin_layout Plain Layout
16357
16358 \change_inserted 564990737 1671829045
16359 -15
16360 \change_unchanged
16361
16362 \end_layout
16363
16364 \end_inset
16365
16366
16367 \begin_inset Flex Resizebox
16368 status open
16369
16370 \begin_layout Plain Layout
16371
16372 \change_inserted 564990737 1671829045
16373 \begin_inset Argument 1
16374 status open
16375
16376 \begin_layout Plain Layout
16377
16378 \change_inserted 564990737 1671829045
16379 48mm
16380 \change_unchanged
16381
16382 \end_layout
16383
16384 \end_inset
16385
16386
16387 \begin_inset Argument 2
16388 status open
16389
16390 \begin_layout Plain Layout
16391
16392 \change_inserted 564990737 1671829045
16393 !
16394 \change_unchanged
16395
16396 \end_layout
16397
16398 \end_inset
16399
16400
16401 \begin_inset Flex Reflectbox
16402 status open
16403
16404 \begin_layout Plain Layout
16405
16406 \change_inserted 564990737 1671829045
16407 Great Western Railway
16408 \change_unchanged
16409
16410 \end_layout
16411
16412 \end_inset
16413
16414
16415 \change_unchanged
16416
16417 \end_layout
16418
16419 \end_inset
16420
16421
16422 \change_unchanged
16423
16424 \end_layout
16425
16426 \end_inset
16427
16428
16429 \end_layout
16430
16431 \begin_layout Standard
16432
16433 \change_inserted 564990737 1671829045
16434
16435 \family sans
16436 Scalebox
16437 \family default
16438  scales text;
16439  select Insert\SpecialChar menuseparator
16440 V-Factor to add a vertical factor.
16441  If the vertical factor is omitted,
16442  the horizontal is used.
16443  Adding different horizontal and vertical values creates distortion as in
16444 \end_layout
16445
16446 \begin_layout Standard
16447
16448 \change_inserted 564990737 1671829045
16449
16450 \family typewriter
16451 \begin_inset Flex Scalebox
16452 status open
16453
16454 \begin_layout Plain Layout
16455
16456 \change_inserted 564990737 1671829045
16457 \begin_inset Argument 1
16458 status open
16459
16460 \begin_layout Plain Layout
16461
16462 \change_inserted 564990737 1671829045
16463 2
16464 \change_unchanged
16465
16466 \end_layout
16467
16468 \end_inset
16469
16470
16471 \begin_inset Argument 2
16472 status open
16473
16474 \begin_layout Plain Layout
16475
16476 \change_inserted 564990737 1671829045
16477 1.5
16478 \change_unchanged
16479
16480 \end_layout
16481
16482 \end_inset
16483
16484
16485 \family roman
16486 Great Western Railway
16487 \change_unchanged
16488
16489 \end_layout
16490
16491 \end_inset
16492
16493 .
16494 \end_layout
16495
16496 \begin_layout Standard
16497
16498 \change_inserted 564990737 1671829045
16499 A negative horizontal value reverses the text and a negative vertical value inverts it so that you get
16500 \end_layout
16501
16502 \begin_layout Standard
16503
16504 \change_inserted 564990737 1671829045
16505 \begin_inset Flex Scalebox
16506 status open
16507
16508 \begin_layout Plain Layout
16509
16510 \change_inserted 564990737 1671829045
16511 \begin_inset Argument 1
16512 status open
16513
16514 \begin_layout Plain Layout
16515
16516 \change_inserted 564990737 1671829045
16517 -1
16518 \change_unchanged
16519
16520 \end_layout
16521
16522 \end_inset
16523
16524
16525 \begin_inset Argument 2
16526 status open
16527
16528 \begin_layout Plain Layout
16529
16530 \change_inserted 564990737 1671829045
16531 1
16532 \change_unchanged
16533
16534 \end_layout
16535
16536 \end_inset
16537
16538 Great Western Railway
16539 \change_unchanged
16540
16541 \end_layout
16542
16543 \end_inset
16544
16545  and
16546 \begin_inset Flex Scalebox
16547 status open
16548
16549 \begin_layout Plain Layout
16550
16551 \change_inserted 564990737 1671829045
16552 \begin_inset Argument 1
16553 status open
16554
16555 \begin_layout Plain Layout
16556
16557 \change_inserted 564990737 1671829045
16558 1
16559 \change_unchanged
16560
16561 \end_layout
16562
16563 \end_inset
16564
16565
16566 \begin_inset Argument 2
16567 status open
16568
16569 \begin_layout Plain Layout
16570
16571 \change_inserted 564990737 1671829045
16572 -1
16573 \change_unchanged
16574
16575 \end_layout
16576
16577 \end_inset
16578
16579 Great Western Railway
16580 \change_unchanged
16581
16582 \end_layout
16583
16584 \end_inset
16585
16586 .
16587 \end_layout
16588
16589 \begin_layout Subsection
16590
16591 \change_inserted 564990737 1671884699
16592 Section Boxes
16593 \end_layout
16594
16595 \begin_layout Standard
16596
16597 \change_inserted 564990737 1671884699
16598 This module defines Boxes with section header.
16599  It is mainly intended for the SciPoster Document class.
16600
16601 \end_layout
16602
16603 \begin_layout Subsection
16604
16605 \change_inserted 564990737 1671884699
16606 Variable-width Minipages
16607 \end_layout
16608
16609 \begin_layout Standard
16610
16611 \change_inserted 564990737 1671884699
16612 This module adds a
16613 \family sans
16614 Minipage (Var.
16615 \begin_inset space \thinspace{}
16616 \end_inset
16617
16618 Width)
16619 \family default
16620  inset to
16621 \family sans
16622 Insert\SpecialChar menuseparator
16623 Custom Inset
16624 \family default
16625  using the
16626 \family sans
16627 varwidth
16628 \family default
16629  LaTeX package.
16630  The
16631 \family sans
16632 varwidth
16633 \family default
16634  package provides a variable-width minipage,
16635  whose resulting width is the width of its contents (if this does not exceed the specified maximum width).
16636  The inset has two optional arguments which can be added by placing the cursor inside the minipage and entering
16637 \family sans
16638 Insert\SpecialChar menuseparator
16639 Vert.
16640 \begin_inset space \thinspace{}
16641 \end_inset
16642
16643 Adjustment
16644 \family default
16645  (
16646 \family typewriter
16647 c|t|b
16648 \family default
16649 ) or
16650 \family sans
16651 Insert\SpecialChar menuseparator
16652 Max.
16653 \begin_inset space \thinspace{}
16654 \end_inset
16655
16656 Width
16657 \family default
16658  (defaults to
16659 \family typewriter
16660
16661 \backslash
16662 linewidth
16663 \family default
16664 ).
16665  See
16666 \family sans
16667 File\SpecialChar menuseparator
16668 Open Example\SpecialChar menuseparator
16669 Variable-width Minipages
16670 \family default
16671 .
16672
16673 \end_layout
16674
16675 \begin_layout Section
16676
16677 \change_inserted 564990737 1671884699
16678 Fixes & Hacks
16679 \end_layout
16680
16681 \begin_layout Subsection
16682
16683 \change_inserted 564990737 1671884699
16684 Fix Computer Modern Fonts
16685 \end_layout
16686
16687 \begin_layout Standard
16688
16689 \change_inserted 564990737 1671884699
16690 This module uses the
16691 \family sans
16692 fix-cm
16693 \family default
16694  package to improve the appearance of Computer Modern fonts and make them available with arbitrary sizes.
16695  See the
16696 \begin_inset CommandInset href
16697 LatexCommand href
16698 name "fix-cm documentation"
16699 target "http://mirrors.ctan.org/macros/latex/base/fix-cm.pdf"
16700 literal "false"
16701
16702 \end_inset
16703
16704 .
16705
16706 \end_layout
16707
16708 \begin_layout Subsection
16709
16710 \change_inserted 564990737 1671884699
16711 \SpecialChar LaTeX
16712  Kernel Fixes (Obsolete)
16713 \end_layout
16714
16715 \begin_layout Standard
16716
16717 \change_inserted 564990737 1671884699
16718 This module loads the \SpecialChar LaTeX
16719  package
16720 \family sans
16721 fixltx2e
16722 \family default
16723  which contains some bug fixes for \SpecialChar LaTeX
16724 .
16725  If you use this module your typeset document may look different when you process it,
16726  depending on the respective version of
16727 \family sans
16728 fixltx2e
16729 \family default
16730 .
16731
16732 \end_layout
16733
16734 \begin_layout Paragraph
16735
16736 \change_inserted 564990737 1671884699
16737 Note:
16738 \end_layout
16739
16740 \begin_layout Standard
16741
16742 \change_inserted 564990737 1671884699
16743 recent \SpecialChar LaTeX
16744  kernels (as of 2015/01/01) include the functionality of
16745 \family sans
16746 fixltx2e
16747 \family default
16748 ,
16749  so the
16750 \family sans
16751 fixltx2e
16752 \family default
16753  module is obsolete with newer \SpecialChar LaTeX
16754  distributions.
16755
16756 \end_layout
16757
16758 \begin_layout Subsection
16759
16760 \change_inserted 564990737 1671884699
16761 Minimalistic Insets
16762 \end_layout
16763
16764 \begin_layout Standard
16765
16766 \change_inserted 564990737 1671884699
16767 This module redefines several insets (Index,
16768  Branch,
16769  URL) as being Minimalistic.
16770 \end_layout
16771
16772 \begin_layout Subsection
16773
16774 \change_inserted 564990737 1671884699
16775 Title and Preamble Hacks
16776 \end_layout
16777
16778 \begin_layout Standard
16779
16780 \change_inserted 564990737 1671884699
16781 This module provides two new paragraph styles:
16782
16783 \end_layout
16784
16785 \begin_layout Enumerate
16786
16787 \change_inserted 564990737 1671884699
16788
16789 \family sans
16790 In Preamble
16791 \family default
16792  which puts whatever is entered into it into the preamble.
16793  This can be used,
16794  if one wishes,
16795  to include preamble code in the body of a LyX document.
16796
16797 \end_layout
16798
16799 \begin_layout Enumerate
16800
16801 \change_inserted 564990737 1671884699
16802
16803 \family sans
16804 In Title
16805 \family default
16806  which that will put its contents into the body of the LaTeX document,
16807  but before
16808 \family typewriter
16809
16810 \backslash
16811 maketitle
16812 \family default
16813  is issued.
16814  This is useful for making branches and notes in title-related material.
16815  (However,
16816  if you put these in a Standard layout,
16817  this signals to LyX to output
16818 \family typewriter
16819
16820 \backslash
16821 maketitle
16822 \family default
16823 ,
16824  which may then come too early.)
16825 \end_layout
16826
16827 \begin_layout Section
16828
16829 \change_inserted 564990737 1672081439
16830 Floats & captions
16831 \end_layout
16832
16833 \begin_layout Subsection
16834
16835 \change_inserted 564990737 1672081439
16836 Algorithm2e Float
16837 \end_layout
16838
16839 \begin_layout Standard
16840
16841 \change_inserted 564990737 1672081439
16842 This module uses the
16843 \family sans
16844 algorithm2e
16845 \family default
16846  package for algorithm floats rather than LyX’s home-brewed algorithm floats.
16847  Use the Algorithm paragraph style to enter and indent the algorithm.
16848  See the
16849 \begin_inset CommandInset href
16850 LatexCommand href
16851 name "algorithm2e documentation"
16852 target "http://mirrors.ctan.org/macros/latex/contrib/algorithm2e/doc/algorithm2e.pdf"
16853 literal "false"
16854
16855 \end_inset
16856
16857 .
16858 \end_layout
16859
16860 \begin_layout Subsection
16861
16862 \change_inserted 564990737 1672081439
16863 Bilingual Captions AKA Multilingual Captions
16864 \end_layout
16865
16866 \begin_layout Standard
16867
16868 \change_inserted 564990737 1672081439
16869 This module provides the paragraph style
16870 \family sans
16871 Caption
16872 \begin_inset space ~
16873 \end_inset
16874
16875 setup
16876 \family default
16877  with which to typeset multilingual captions.
16878  Within this paragraph style
16879 \family sans
16880 Insert\SpecialChar menuseparator
16881 Language
16882 \family default
16883  allows you to enter the desired language using one of the babel names.
16884  See
16885 \family sans
16886 File\SpecialChar menuseparator
16887 Open Example\SpecialChar menuseparator
16888 Multilingual Captions
16889 \family default
16890  and
16891 \family sans
16892 Help\SpecialChar menuseparator
16893 Specific Manuals\SpecialChar menuseparator
16894 Multilingual Captions
16895 \family default
16896  further information on its use.
16897 \end_layout
16898
16899 \begin_layout Subsection
16900
16901 \change_inserted 564990737 1672081439
16902 Number Figures by Section
16903 \end_layout
16904
16905 \begin_layout Standard
16906
16907 \change_inserted 564990737 1672081439
16908 This module resets the figure number at section start and prepends the section number to the figure number,
16909  as in “Figure 2.1.” (By default book and report document classes number by Chapter and article document classes have a single sequence.)
16910 \end_layout
16911
16912 \begin_layout Subsection
16913
16914 \change_inserted 564990737 1672081439
16915 Number Tables by Section
16916 \end_layout
16917
16918 \begin_layout Standard
16919
16920 \change_inserted 564990737 1672081439
16921 This module resets the table number at section start and prepends the section number to the table number,
16922  as in “Table 2.1.” (By default book and report document classes number by Chapter and article document classes have a single sequence.)
16923 \end_layout
16924
16925 \begin_layout Section
16926
16927 \change_inserted 564990737 1672081439
16928 Foot- and Endnotes
16929 \end_layout
16930
16931 \begin_layout Subsection
16932
16933 \change_inserted 564990737 1672081439
16934 Endnotes (Basic)
16935 \end_layout
16936
16937 \begin_layout Standard
16938
16939 \change_inserted 564990737 1672081439
16940 This module adds an endnote inset,
16941  in addition to footnotes.
16942  This uses the
16943 \family sans
16944 endnotes
16945 \family default
16946  package,
16947  which has some limitations but works with older LaTeX distributions as well.
16948  Use
16949 \family sans
16950 Insert\SpecialChar menuseparator
16951 Custom Inset\SpecialChar menuseparator
16952 Endnote
16953 \family default
16954  to insert an endnote and
16955 \family sans
16956 Insert\SpecialChar menuseparator
16957 List/Contents/References\SpecialChar menuseparator
16958 Endnotes
16959 \family default
16960  to insert the endnotes list where you want the endnotes to appear.
16961  See also
16962 \family sans
16963 Help\SpecialChar menuseparator
16964 Embedded\SpecialChar menuseparator
16965  Objects\SpecialChar menuseparator
16966 Notes\SpecialChar menuseparator
16967 Footnotes
16968 \family default
16969 .
16970 \end_layout
16971
16972 \begin_layout Subsection
16973
16974 \change_inserted 564990737 1672081439
16975 Endnotes (Extended)
16976 \end_layout
16977
16978 \begin_layout Standard
16979
16980 \change_inserted 564990737 1672081439
16981 This module adds an endnote inset,
16982  in addition to footnotes.
16983  This uses the
16984 \family sans
16985 enotez
16986 \family default
16987  package which is more powerful and customizable than the
16988 \family sans
16989 endnotes
16990 \family default
16991  package,
16992  but requires a fairly modern LaTeX distribution (with LaTeX3).
16993  Use
16994 \family sans
16995 Insert\SpecialChar menuseparator
16996 Custom Inset\SpecialChar menuseparator
16997 Endnote
16998 \family default
16999  to insert an endnote and
17000 \family sans
17001 Insert\SpecialChar menuseparator
17002 List/Contents/References\SpecialChar menuseparator
17003 Endnotes
17004 \family default
17005  to insert the endnotes list where you want the endnotes to appear.
17006  See also
17007 \family sans
17008 Help\SpecialChar menuseparator
17009 Embedded\SpecialChar menuseparator
17010  Objects\SpecialChar menuseparator
17011 Notes\SpecialChar menuseparator
17012 Footnotes
17013 \family default
17014 .
17015 \end_layout
17016
17017 \begin_layout Subsection
17018
17019 \change_inserted 564990737 1672081439
17020 Footnotes as Endnotes (Basic)
17021 \end_layout
17022
17023 \begin_layout Standard
17024
17025 \change_inserted 564990737 1672081439
17026 This module sets all footnotes as endnotes.
17027  This uses the
17028 \family sans
17029 endnotes
17030 \family default
17031  package,
17032  which has some limitations but works with older LaTeX distributions as well.
17033  Use
17034 \family sans
17035 Insert\SpecialChar menuseparator
17036 List/Contents/References\SpecialChar menuseparator
17037 Endnotes
17038 \family default
17039  to insert the endnotes list where you want the endnotes to appear.
17040  See also
17041 \family sans
17042 Help\SpecialChar menuseparator
17043 Embedded\SpecialChar menuseparator
17044  Objects\SpecialChar menuseparator
17045 Notes\SpecialChar menuseparator
17046 Footnotes
17047 \family default
17048 .
17049 \end_layout
17050
17051 \begin_layout Subsection
17052
17053 \change_inserted 564990737 1672081439
17054 Footnotes as Endnotes (Extended)
17055 \end_layout
17056
17057 \begin_layout Standard
17058
17059 \change_inserted 564990737 1672081439
17060 This module sets all footnotes as endnotes.
17061  This uses the
17062 \family sans
17063 enotez
17064 \family default
17065  package which is more powerful and customizable than then
17066 \family sans
17067 endnotes
17068 \family default
17069  package,
17070  but requires a fairly modern LaTeX distribution (with LaTeX3).
17071  Use
17072 \family sans
17073 Insert\SpecialChar menuseparator
17074 List/Contents/References\SpecialChar menuseparator
17075 Endnotes
17076 \family default
17077  to insert the endnotes list where you want the endnotes to appear.
17078  See also
17079 \family sans
17080 Help\SpecialChar menuseparator
17081 Embedded\SpecialChar menuseparator
17082  Objects\SpecialChar menuseparator
17083 Notes\SpecialChar menuseparator
17084 Footnotes
17085 \family default
17086 .
17087 \end_layout
17088
17089 \begin_layout Section
17090
17091 \change_inserted 564990737 1672081439
17092 Leisure,
17093  Sports and Music
17094 \end_layout
17095
17096 \begin_layout Subsection
17097
17098 \change_inserted 564990737 1672081439
17099 Chess Board
17100 \end_layout
17101
17102 \begin_layout Standard
17103
17104 \change_inserted 564990737 1672081439
17105 This module provides support for the
17106 \family sans
17107 chessboard
17108 \family default
17109  package to print chess games.
17110  See
17111 \family sans
17112 File\SpecialChar menuseparator
17113 Open Example\SpecialChar menuseparator
17114 Articles\SpecialChar menuseparator
17115 Chess
17116 \family default
17117  where you will find
17118 \family sans
17119 Game 1
17120 \family default
17121  and
17122 \family sans
17123 Game 2
17124 \family default
17125  and the
17126 \begin_inset CommandInset href
17127 LatexCommand href
17128 name "chessboard documentation"
17129 target "http://mirrors.ctan.org/macros/latex/contrib/chessboard/chessboard.pdf"
17130 literal "false"
17131
17132 \end_inset
17133
17134 .
17135 \end_layout
17136
17137 \begin_layout Subsection
17138
17139 \change_inserted 564990737 1672081439
17140 Lilypond Music Notation
17141 \end_layout
17142
17143 \begin_layout Standard
17144
17145 \change_inserted 564990737 1672081439
17146 This module provides an inset via
17147 \family sans
17148 \bar under
17149 I
17150 \bar default
17151 nsert\SpecialChar menuseparator
17152 Custom Inset\SpecialChar menuseparator
17153 Lilypond
17154 \family default
17155  in which to enter code for the LilyPond music editor.
17156  It will then be processed in the output.
17157  See
17158 \family sans
17159 Help\SpecialChar menuseparator
17160 Specific Manuals\SpecialChar menuseparator
17161 Lilypond
17162 \family default
17163  and
17164 \family sans
17165 File\SpecialChar menuseparator
17166 Open Example\SpecialChar menuseparator
17167 Modules\SpecialChar menuseparator
17168 Lilypond Book
17169 \family default
17170 .
17171  It cannot be used if the modules
17172 \family sans
17173 Rnw
17174 \begin_inset space \thinspace{}
17175 \end_inset
17176
17177 (knitr) or Sweave
17178 \family default
17179  have been loaded.
17180 \end_layout
17181
17182 \begin_layout Section
17183
17184 \change_inserted 564990737 1672138150
17185 List enhancements
17186 \end_layout
17187
17188 \begin_layout Subsection
17189
17190 \change_inserted 564990737 1672138150
17191 Customizable Lists
17192 \begin_inset CommandInset label
17193 LatexCommand label
17194 name "subsec:Customizable-Lists"
17195
17196 \end_inset
17197
17198
17199 \end_layout
17200
17201 \begin_layout Standard
17202
17203 \change_inserted 564990737 1672138150
17204 This module uses the
17205 \family sans
17206  enumitem
17207 \family default
17208  package to enable the customization of various list environments.
17209 \end_layout
17210
17211 \begin_layout Subsubsection
17212
17213 \change_inserted 564990737 1672138150
17214 Custom Enumerate Lists
17215 \end_layout
17216
17217 \begin_layout Standard
17218 \noindent
17219
17220 \change_inserted 564990737 1672138150
17221 The default numbering of numbered lists can be changed by adding an optional argument (menu
17222 \family sans
17223 \bar under
17224 I
17225 \bar default
17226 nsert\SpecialChar menuseparator
17227
17228 \bar under
17229 S
17230 \bar default
17231 hort Title
17232 \family default
17233 ) to the first item of each level in the list.
17234  There you add the command
17235 \end_layout
17236
17237 \begin_layout Standard
17238
17239 \change_inserted 564990737 1672138150
17240
17241 \family sans
17242 label=
17243 \backslash
17244 roman{enumi}
17245 \end_layout
17246
17247 \begin_layout Standard
17248
17249 \change_inserted 564990737 1672138150
17250 in \SpecialChar TeX
17251  Code (shortcut
17252 \begin_inset Info
17253 type  "shortcut"
17254 arg   "ert-insert"
17255 \end_inset
17256
17257 ).
17258 \end_layout
17259
17260 \begin_layout Standard
17261
17262 \change_inserted 564990737 1672138150
17263
17264 \family sans
17265 enumi
17266 \family default
17267  is the first level counter of the enumeration.
17268  To change the numbering for the list sublevels,
17269  replace the “
17270 \family sans
17271 i
17272 \family default
17273 ” in the command by the small Roman numeral of the level (
17274 \family sans
17275 enumi
17276 \family default
17277 ,
17278
17279 \family sans
17280 enumii
17281 \family default
17282 ,
17283
17284 \family sans
17285 enumiii
17286 \family default
17287 ,
17288
17289 \family sans
17290 enumiv
17291 \family default
17292 ).
17293 \end_layout
17294
17295 \begin_layout Standard
17296
17297 \change_inserted 564990737 1672138150
17298 The command
17299 \family sans
17300
17301 \backslash
17302 roman
17303 \family default
17304  outputs the counter as a small Roman numeral.
17305  For capital Roman numerals replace
17306 \family sans
17307
17308 \backslash
17309 roman
17310 \family default
17311  with
17312 \family sans
17313
17314 \backslash
17315 Roman
17316 \family default
17317  in the command above.
17318  For Arabic numerals use
17319 \family sans
17320
17321 \backslash
17322 arabic
17323 \family default
17324 .
17325  To
17326 \begin_inset Quotes eld
17327 \end_inset
17328
17329 number
17330 \begin_inset Quotes erd
17331 \end_inset
17332
17333  items with capital or small Latin letters use
17334 \family sans
17335
17336 \backslash
17337 Alph
17338 \family default
17339  or
17340 \family sans
17341
17342 \backslash
17343 alph
17344 \family default
17345 ,
17346  respectively.
17347 \end_layout
17348
17349 \begin_layout Standard
17350 \noindent
17351
17352 \change_inserted 564990737 1672138150
17353 \begin_inset Note Greyedout
17354 status collapsed
17355
17356 \begin_layout Plain Layout
17357
17358 \change_inserted 564990737 1672138150
17359
17360 \series bold
17361 Note:
17362
17363 \series default
17364  You can only number 26
17365 \begin_inset space ~
17366 \end_inset
17367
17368 items with Latin letters,
17369  because this numbering is limited to single letters.
17370 \end_layout
17371
17372 \end_inset
17373
17374
17375 \end_layout
17376
17377 \begin_layout Standard
17378
17379 \change_inserted 564990737 1672138150
17380 Here is a list with custom numbering:
17381 \end_layout
17382
17383 \begin_layout Enumerate
17384
17385 \change_inserted 564990737 1672138150
17386 \begin_inset Argument 1
17387 status collapsed
17388
17389 \begin_layout Plain Layout
17390
17391 \change_inserted 564990737 1672138150
17392 \begin_inset ERT
17393 status collapsed
17394
17395 \begin_layout Plain Layout
17396
17397 \change_inserted 564990737 1672138150
17398
17399 label=
17400 \backslash
17401 #
17402 \backslash
17403 Alph{enumi}
17404 \backslash
17405 #
17406 \end_layout
17407
17408 \end_inset
17409
17410
17411 \change_unchanged
17412
17413 \end_layout
17414
17415 \end_inset
17416
17417 Level 1
17418 \begin_inset Separator latexpar
17419 \end_inset
17420
17421
17422 \end_layout
17423
17424 \begin_deeper
17425 \begin_layout Enumerate
17426
17427 \change_inserted 564990737 1672138150
17428 \begin_inset Argument 1
17429 status collapsed
17430
17431 \begin_layout Plain Layout
17432
17433 \change_inserted 564990737 1672138150
17434 \begin_inset ERT
17435 status collapsed
17436
17437 \begin_layout Plain Layout
17438
17439 \change_inserted 564990737 1672138150
17440
17441 label=
17442 \backslash
17443 Alph{enumi}.
17444 \backslash
17445 arabic{enumii}
17446 \end_layout
17447
17448 \end_inset
17449
17450
17451 \change_unchanged
17452
17453 \end_layout
17454
17455 \end_inset
17456
17457 Level 2
17458 \end_layout
17459
17460 \begin_layout Enumerate
17461
17462 \change_inserted 564990737 1672138150
17463 Level 2
17464 \begin_inset Separator latexpar
17465 \end_inset
17466
17467
17468 \end_layout
17469
17470 \begin_deeper
17471 \begin_layout Enumerate
17472
17473 \change_inserted 564990737 1672138150
17474 \begin_inset Argument 1
17475 status collapsed
17476
17477 \begin_layout Plain Layout
17478
17479 \change_inserted 564990737 1672138150
17480 \begin_inset ERT
17481 status collapsed
17482
17483 \begin_layout Plain Layout
17484
17485 \change_inserted 564990737 1672138150
17486
17487 label=
17488 \change_deleted 274215730 1672889016
17489
17490 \backslash
17491 bf
17492 \change_inserted 274215730 1672889016
17493
17494 \backslash
17495 bfseries
17496 \change_inserted 564990737 1672138150
17497 {
17498 \backslash
17499 arabic{enumiii}}
17500 \end_layout
17501
17502 \end_inset
17503
17504
17505 \change_unchanged
17506
17507 \end_layout
17508
17509 \end_inset
17510
17511 Level 3
17512 \begin_inset Separator latexpar
17513 \end_inset
17514
17515
17516 \end_layout
17517
17518 \begin_deeper
17519 \begin_layout Enumerate
17520
17521 \change_inserted 564990737 1672138150
17522 \begin_inset Argument 1
17523 status collapsed
17524
17525 \begin_layout Plain Layout
17526
17527 \change_inserted 564990737 1672138150
17528 \begin_inset ERT
17529 status collapsed
17530
17531 \begin_layout Plain Layout
17532
17533 \change_inserted 564990737 1672138150
17534
17535 label=
17536 \backslash
17537 emph{
17538 \backslash
17539 roman{enumiv})}
17540 \end_layout
17541
17542 \end_inset
17543
17544
17545 \change_unchanged
17546
17547 \end_layout
17548
17549 \end_inset
17550
17551 Level 4
17552 \end_layout
17553
17554 \end_deeper
17555 \end_deeper
17556 \end_deeper
17557 \begin_layout Standard
17558
17559 \change_inserted 564990737 1672138150
17560 For this list these commands were used:
17561 \end_layout
17562
17563 \begin_layout Standard
17564 \noindent
17565
17566 \change_inserted 564990737 1672138150
17567
17568 \family sans
17569 label=
17570 \backslash
17571 #
17572 \backslash
17573 Alph{enumi}
17574 \backslash
17575 #
17576 \begin_inset Newline newline
17577 \end_inset
17578
17579 label=
17580 \backslash
17581 Alph{enumi}.
17582 \backslash
17583 arabic{enumii}
17584 \begin_inset Newline newline
17585 \end_inset
17586
17587 label=
17588 \change_deleted 274215730 1672889037
17589
17590 \backslash
17591 bf
17592 \change_inserted 274215730 1672889037
17593
17594 \backslash
17595 bfseries
17596 \change_inserted 564990737 1672138150
17597 {
17598 \backslash
17599 arabic{enumiii}}
17600 \begin_inset Newline newline
17601 \end_inset
17602
17603 label=
17604 \backslash
17605 emph{
17606 \backslash
17607 roman{enumiv})}
17608 \end_layout
17609
17610 \begin_layout Standard
17611
17612 \change_inserted 564990737 1672138150
17613 where the command
17614 \family sans
17615
17616 \backslash
17617 emph{}
17618 \family default
17619  makes the label emphasized and
17620 \change_deleted 274215730 1672889045
17621
17622 \family sans
17623
17624 \backslash
17625 bf{}
17626 \change_inserted 274215730 1672889046
17627
17628 \backslash
17629 bfseries{}
17630 \change_inserted 564990737 1672138150
17631
17632 \family default
17633  makes it bold.
17634 \end_layout
17635
17636 \begin_layout Standard
17637
17638 \change_inserted 564990737 1672138150
17639 \begin_inset Note Greyedout
17640 status collapsed
17641
17642 \begin_layout Plain Layout
17643
17644 \change_inserted 564990737 1672138150
17645
17646 \series bold
17647 Note:
17648
17649 \series default
17650  When you change the label of a list level,
17651  it will be used for all following lists until you change the definition.
17652 \end_layout
17653
17654 \end_inset
17655
17656
17657 \end_layout
17658
17659 \begin_layout Standard
17660
17661 \change_inserted 564990737 1672138150
17662 \begin_inset ERT
17663 status open
17664
17665 \begin_layout Plain Layout
17666
17667 \change_inserted 564990737 1672138150
17668
17669
17670 \backslash
17671 renewcommand{
17672 \backslash
17673 labelenumi}{
17674 \backslash
17675 thesection.
17676 \backslash
17677 arabic{enumi}}
17678 \end_layout
17679
17680 \end_inset
17681
17682
17683 \end_layout
17684
17685 \begin_layout Subsubsection
17686
17687 \change_inserted 564990737 1672138150
17688 Numbered Paragraphs in Reports
17689 \end_layout
17690
17691 \begin_layout Enumerate
17692
17693 \change_inserted 564990737 1672138213
17694 Official reports often include numbered paragraphs;
17695  you can achieve this with a variation on the approach outlined in the footnote
17696 \begin_inset space ~
17697 \end_inset
17698
17699
17700 \begin_inset CommandInset ref
17701 LatexCommand ref
17702 reference "fn:If-you-really"
17703 plural "false"
17704 caps "false"
17705 noprefix "false"
17706 nolink "false"
17707
17708 \end_inset
17709
17710 .
17711  Replace
17712 \family sans
17713 item
17714 \family default
17715  in each command with
17716 \family sans
17717 enum
17718 \family default
17719 .
17720 \end_layout
17721
17722 \begin_layout Enumerate
17723
17724 \change_inserted 564990737 1672138150
17725 These numbered paragraphs were generated by inserting the \SpecialChar TeX
17726  Code
17727 \begin_inset Separator latexpar
17728 \end_inset
17729
17730
17731 \end_layout
17732
17733 \begin_deeper
17734 \begin_layout Standard
17735
17736 \change_inserted 564990737 1672138150
17737
17738 \family sans
17739
17740 \backslash
17741 renewcommand{
17742 \backslash
17743 labelenumi}{
17744 \backslash
17745 thesection.
17746 \backslash
17747 arabic{enumi}}
17748 \end_layout
17749
17750 \begin_layout Standard
17751
17752 \change_inserted 564990737 1672138150
17753 before the start of the section;
17754
17755 \family sans
17756
17757 \backslash
17758 thesection
17759 \family default
17760  uses the \SpecialChar LaTeX
17761  section counter to generate the first part of the number.
17762 \end_layout
17763
17764 \end_deeper
17765 \begin_layout Enumerate
17766
17767 \change_inserted 564990737 1672138150
17768 I have ignored the subsection heading in this example because,
17769  with paragraphs numbered in this way,
17770  subsections are less likely to be used.
17771 \end_layout
17772
17773 \begin_layout Subsubsection
17774
17775 \change_inserted 564990737 1672138150
17776 Resumed Enumeration
17777 \end_layout
17778
17779 \begin_layout Standard
17780
17781 \change_inserted 564990737 1672138150
17782 \begin_inset ERT
17783 status open
17784
17785 \begin_layout Plain Layout
17786
17787 \change_inserted 564990737 1672138150
17788
17789
17790 \backslash
17791 renewcommand{
17792 \backslash
17793 labelenumi}{
17794 \backslash
17795 arabic{enumi}}
17796 \end_layout
17797
17798 \end_inset
17799
17800
17801 \end_layout
17802
17803 \begin_layout Standard
17804
17805 \change_inserted 564990737 1672138150
17806 Enumerations can be resumed after intermediate paragraphs:
17807 \end_layout
17808
17809 \begin_layout Enumerate
17810
17811 \change_inserted 564990737 1672138150
17812 \begin_inset Argument 1
17813 status collapsed
17814
17815 \begin_layout Plain Layout
17816
17817 \change_inserted 564990737 1672138150
17818 \begin_inset ERT
17819 status collapsed
17820
17821 \begin_layout Plain Layout
17822
17823 \change_inserted 564990737 1672138150
17824
17825 label=
17826 \backslash
17827 arabic{enumi}.
17828 \end_layout
17829
17830 \end_inset
17831
17832
17833 \change_unchanged
17834
17835 \end_layout
17836
17837 \end_inset
17838
17839 first
17840 \begin_inset Note Note
17841 status collapsed
17842
17843 \begin_layout Plain Layout
17844
17845 \change_inserted 564990737 1672138150
17846 goes back to default numbering
17847 \end_layout
17848
17849 \end_inset
17850
17851
17852 \end_layout
17853
17854 \begin_layout Enumerate
17855
17856 \change_inserted 564990737 1672138150
17857 second
17858 \end_layout
17859
17860 \begin_layout Standard
17861
17862 \change_inserted 564990737 1672138150
17863 regular text
17864 \end_layout
17865
17866 \begin_layout Enumerate-Resume
17867
17868 \change_inserted 564990737 1672138150
17869 resumed
17870 \end_layout
17871
17872 \begin_layout Standard
17873
17874 \change_inserted 564990737 1672138150
17875 To resume an enumeration,
17876  use the style
17877 \family sans
17878 Enumerate-Resume
17879 \family default
17880 .
17881  Its numbering appears in blue within \SpecialChar LyX
17882  to indicate that it is a resumed list and that the numbering will not be correct in \SpecialChar LyX
17883 ,
17884  but in the output.
17885 \end_layout
17886
17887 \begin_layout Standard
17888
17889 \change_inserted 564990737 1672138150
17890 \begin_inset Note Greyedout
17891 status collapsed
17892
17893 \begin_layout Plain Layout
17894
17895 \change_inserted 564990737 1672138150
17896
17897 \series bold
17898 Note:
17899
17900 \series default
17901  If there is no previous enumeration to resume,
17902  you will get a \SpecialChar LaTeX
17903  error.
17904 \end_layout
17905
17906 \end_inset
17907
17908
17909 \end_layout
17910
17911 \begin_layout Standard
17912
17913 \change_inserted 564990737 1672138150
17914 Perhaps you might want to resume the list with a different number from the next one.
17915  Or you want to start a new enumeration with a defined number.
17916  This is possible by adding an optional argument to the first list item of a normal enumeration.
17917  There,
17918  insert the command
17919 \end_layout
17920
17921 \begin_layout Standard
17922
17923 \change_inserted 564990737 1672138150
17924
17925 \family sans
17926 start=number
17927 \end_layout
17928
17929 \begin_layout Standard
17930
17931 \change_inserted 564990737 1672138150
17932 where
17933 \family sans
17934 number
17935 \family default
17936  is the number with which you want to resume the list.
17937  An example:
17938 \end_layout
17939
17940 \begin_layout Enumerate
17941
17942 \change_inserted 564990737 1672138150
17943 first item
17944 \end_layout
17945
17946 \begin_layout Enumerate
17947
17948 \change_inserted 564990737 1672138150
17949 second item
17950 \end_layout
17951
17952 \begin_layout Standard
17953
17954 \change_inserted 564990737 1672138150
17955 Enumeration starting at a given value:
17956 \end_layout
17957
17958 \begin_layout Enumerate
17959
17960 \change_inserted 564990737 1672138150
17961 \begin_inset Argument 1
17962 status open
17963
17964 \begin_layout Plain Layout
17965
17966 \change_inserted 564990737 1672138150
17967 \begin_inset ERT
17968 status collapsed
17969
17970 \begin_layout Plain Layout
17971
17972 \change_inserted 564990737 1672138150
17973
17974 start=4
17975 \end_layout
17976
17977 \end_inset
17978
17979
17980 \change_unchanged
17981
17982 \end_layout
17983
17984 \end_inset
17985
17986 This enumeration starts at 4
17987 \end_layout
17988
17989 \begin_layout Subsubsection
17990
17991 \change_inserted 564990737 1672138150
17992 List Spacing
17993 \begin_inset Index idx
17994 range none
17995 pageformat default
17996 status collapsed
17997
17998 \begin_layout Plain Layout
17999
18000 \change_inserted 564990737 1672138150
18001 Lists !
18002  Spacing
18003 \change_unchanged
18004
18005 \end_layout
18006
18007 \end_inset
18008
18009
18010 \end_layout
18011
18012 \begin_layout Standard
18013
18014 \change_inserted 564990737 1672138150
18015 In some cases you might want less or more vertical space between the items of a list.
18016  For example if the default space is too much in your opinion in this case:
18017 \end_layout
18018
18019 \begin_layout Itemize
18020
18021 \change_inserted 564990737 1672138150
18022 A bullet list
18023 \end_layout
18024
18025 \begin_layout Itemize
18026
18027 \change_inserted 564990737 1672138150
18028 with standard spacing
18029 \end_layout
18030
18031 \begin_layout Standard
18032
18033 \change_inserted 564990737 1672138150
18034 You can decrease the space by adding an optional argument to the first item of the list.
18035  Add there the command
18036 \family sans
18037 nolistsep
18038 \family default
18039  to get no additional list space like in this example:
18040 \end_layout
18041
18042 \begin_layout Itemize
18043
18044 \change_inserted 564990737 1672138150
18045 \begin_inset Argument 1
18046 status open
18047
18048 \begin_layout Plain Layout
18049
18050 \change_inserted 564990737 1672138150
18051 \begin_inset ERT
18052 status collapsed
18053
18054 \begin_layout Plain Layout
18055
18056 \change_inserted 564990737 1672138150
18057
18058 nolistsep
18059 \end_layout
18060
18061 \end_inset
18062
18063
18064 \change_unchanged
18065
18066 \end_layout
18067
18068 \end_inset
18069
18070 A bullet list
18071 \end_layout
18072
18073 \begin_layout Itemize
18074
18075 \change_inserted 564990737 1672138150
18076 without additional
18077 \end_layout
18078
18079 \begin_layout Itemize
18080
18081 \change_inserted 564990737 1672138150
18082 vertical space
18083 \end_layout
18084
18085 \begin_layout Standard
18086
18087 \change_inserted 564990737 1672138150
18088 To add space you can use several other commands provided by the
18089 \family sans
18090 enumitem
18091 \family default
18092
18093 \begin_inset Index idx
18094 range none
18095 pageformat default
18096 status collapsed
18097
18098 \begin_layout Plain Layout
18099
18100 \change_inserted 564990737 1672138150
18101 \SpecialChar LaTeX
18102 -packages !
18103  enumitem
18104 \change_unchanged
18105
18106 \end_layout
18107
18108 \end_inset
18109
18110  package.
18111  For more information see the
18112 \begin_inset CommandInset href
18113 LatexCommand href
18114 name "enumitem documentation"
18115 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
18116 literal "false"
18117
18118 \end_inset
18119
18120 .
18121 \end_layout
18122
18123 \begin_layout Standard
18124
18125 \change_inserted 564990737 1672138150
18126 There are also many commands available to change the horizontal spacing and indentation.
18127  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
18128 \begin_inset space \thinspace{}
18129 \end_inset
18130
18131 cm so that the number is in the page margin:
18132 \end_layout
18133
18134 \begin_layout Enumerate
18135
18136 \change_inserted 564990737 1672138150
18137 \begin_inset Argument 1
18138 status open
18139
18140 \begin_layout Plain Layout
18141
18142 \change_inserted 564990737 1672138150
18143 \begin_inset ERT
18144 status collapsed
18145
18146 \begin_layout Plain Layout
18147
18148 \change_inserted 564990737 1672138150
18149
18150 labelindent=
18151 \backslash
18152 parindent,
18153  labelsep=2cm
18154 \end_layout
18155
18156 \end_inset
18157
18158
18159 \change_unchanged
18160
18161 \end_layout
18162
18163 \end_inset
18164
18165 An enumeration
18166 \end_layout
18167
18168 \begin_layout Enumerate
18169
18170 \change_inserted 564990737 1672138150
18171 with negative indentation
18172 \end_layout
18173
18174 \begin_layout Subsubsection
18175
18176 \change_inserted 564990737 1672138150
18177 Further Customization
18178 \begin_inset Index idx
18179 range none
18180 pageformat default
18181 status collapsed
18182
18183 \begin_layout Plain Layout
18184
18185 \change_inserted 564990737 1672138150
18186 Lists !
18187  Customization
18188 \change_unchanged
18189
18190 \end_layout
18191
18192 \end_inset
18193
18194
18195 \end_layout
18196
18197 \begin_layout Standard
18198
18199 \change_inserted 564990737 1672138150
18200 You can also change the style of description lists.
18201  The command
18202 \end_layout
18203
18204 \begin_layout Standard
18205
18206 \change_inserted 564990737 1672138150
18207
18208 \family sans
18209 font=definition
18210 \end_layout
18211
18212 \begin_layout Standard
18213
18214 \change_inserted 564990737 1672138150
18215 changes the description label font,
18216  the command
18217 \end_layout
18218
18219 \begin_layout Standard
18220
18221 \change_inserted 564990737 1672138150
18222
18223 \family sans
18224 style=definitio
18225 \family default
18226 \series bold
18227 n
18228 \end_layout
18229
18230 \begin_layout Standard
18231
18232 \change_inserted 564990737 1672138150
18233 sets the list style.
18234 \end_layout
18235
18236 \begin_layout Standard
18237
18238 \change_inserted 564990737 1672138150
18239 An example where the command
18240 \end_layout
18241
18242 \begin_layout Standard
18243
18244 \change_inserted 564990737 1672138150
18245
18246 \family sans
18247 font=
18248 \backslash
18249 itshape,
18250  style=nextline
18251 \end_layout
18252
18253 \begin_layout Standard
18254
18255 \change_inserted 564990737 1672138150
18256 is used:
18257 \end_layout
18258
18259 \begin_layout Description
18260
18261 \change_inserted 564990737 1672138150
18262 Ionizing
18263 \begin_inset space ~
18264 \end_inset
18265
18266 radiation:
18267
18268 \begin_inset Argument 1
18269 status collapsed
18270
18271 \begin_layout Plain Layout
18272
18273 \change_inserted 564990737 1672138150
18274 \begin_inset ERT
18275 status collapsed
18276
18277 \begin_layout Plain Layout
18278
18279 \change_inserted 564990737 1672138150
18280
18281 labelindent=0pt,
18282  labelsep=1cm,
18283  font=
18284 \backslash
18285 itshape,
18286  style=nextline
18287 \end_layout
18288
18289 \end_inset
18290
18291
18292 \change_unchanged
18293
18294 \end_layout
18295
18296 \end_inset
18297
18298 Ionizing radiation consists of particles or electromagnetic waves that are energetic enough to detach electrons from atoms or molecules,
18299  therefore ionizing them.
18300 \end_layout
18301
18302 \begin_layout Description
18303
18304 \change_inserted 564990737 1672138150
18305 Reference
18306 \begin_inset space ~
18307 \end_inset
18308
18309 counting:
18310  In computer science,
18311  reference counting is a technique of storing the number of references,
18312  pointers,
18313  or handles to a resource such as an object,
18314  block of memory,
18315  disk space or other resource.
18316 \end_layout
18317
18318 \begin_layout Standard
18319
18320 \change_inserted 564990737 1672138150
18321 There are many more commands and features provided by the
18322 \family sans
18323 enumitem
18324 \family default
18325
18326 \begin_inset Index idx
18327 range none
18328 pageformat default
18329 status collapsed
18330
18331 \begin_layout Plain Layout
18332
18333 \change_inserted 564990737 1672138150
18334 \SpecialChar LaTeX
18335 -packages !
18336  enumitem
18337 \change_unchanged
18338
18339 \end_layout
18340
18341 \end_inset
18342
18343  package.
18344  For more information see the
18345 \begin_inset CommandInset href
18346 LatexCommand href
18347 name "enumitem documentation"
18348 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
18349 literal "false"
18350
18351 \end_inset
18352
18353 .
18354 \end_layout
18355
18356 \begin_layout Subsection
18357
18358 \change_inserted 564990737 1672138150
18359
18360 \series bold
18361 Paragraph Lists
18362 \end_layout
18363
18364 \begin_layout Standard
18365
18366 \change_inserted 564990737 1672138150
18367 This module uses the package
18368 \family sans
18369 paralist
18370 \family default
18371  to provide nine new list environments.
18372  Itemized and enumerated lists can be typeset within paragraphs,
18373  as paragraphs and in a compact version.
18374  Most environments have optional arguments to format the labels.
18375  Additionally,
18376  the \SpecialChar LaTeX
18377  list environments itemize and enumerate are extended to use a similar optional argument.
18378  For further details see
18379 \family sans
18380 File\SpecialChar menuseparator
18381 Open Example\SpecialChar menuseparator
18382 Modules\SpecialChar menuseparator
18383 Paragraph Lists (paralist)
18384 \family default
18385 ,
18386
18387 \family sans
18388 Help\SpecialChar menuseparator
18389 Specific Manuals\SpecialChar menuseparator
18390 Paralist
18391 \family default
18392  and the
18393 \begin_inset CommandInset href
18394 LatexCommand href
18395 name "paralist documentation"
18396 target "http://mirrors.ctan.org/macros/latex/contrib/paralist/paralist.pdf"
18397 literal "false"
18398
18399 \end_inset
18400
18401 .
18402 \end_layout
18403
18404 \begin_layout Section
18405
18406 \change_inserted 564990737 1672161542
18407 Literate Programming
18408 \end_layout
18409
18410 \begin_layout Subsection
18411
18412 \change_inserted 564990737 1672161542
18413 Noweb
18414 \end_layout
18415
18416 \begin_layout Standard
18417
18418 \change_inserted 564990737 1672161542
18419 This module allows the use of Noweb as a literate programming tool.
18420  The files and the documentation for Noweb can be obtained from
18421 \begin_inset CommandInset href
18422 LatexCommand href
18423 name "CTAN"
18424 target "https://www.ctan.org/pkg/noweb"
18425 literal "false"
18426
18427 \end_inset
18428
18429 .
18430  Literate programming is described in section
18431 \begin_inset space ~
18432 \end_inset
18433
18434
18435 \begin_inset CommandInset ref
18436 LatexCommand ref
18437 reference "sec:Literate-Programming"
18438 nolink "false"
18439
18440 \end_inset
18441
18442  and there are three example files:
18443
18444 \family sans
18445 File\SpecialChar menuseparator
18446 Open Example\SpecialChar menuseparator
18447 Modules\SpecialChar menuseparator
18448 Noweb
18449 \family default
18450 ,
18451
18452 \family sans
18453 File\SpecialChar menuseparator
18454 Open Example\SpecialChar menuseparator
18455 Modules\SpecialChar menuseparator
18456 Noweb Listerrors
18457 \family default
18458  and
18459 \family sans
18460 File\SpecialChar menuseparator
18461 Open Example\SpecialChar menuseparator
18462 Modules\SpecialChar menuseparator
18463 Noweb2\SpecialChar LyX
18464
18465 \family default
18466 .
18467 \end_layout
18468
18469 \begin_layout Subsection
18470
18471 \change_inserted 564990737 1672161542
18472 Rnw (knitr)
18473 \end_layout
18474
18475 \begin_layout Standard
18476
18477 \change_inserted 564990737 1672161542
18478 This module uses the
18479 \family typewriter
18480 knitr
18481 \family default
18482  and
18483 \family sans
18484 includernw
18485 \family default
18486  packages.
18487  The
18488 \begin_inset Flex Code
18489 status collapsed
18490
18491 \begin_layout Plain Layout
18492
18493 \change_inserted 564990737 1672161542
18494 knitr
18495 \change_unchanged
18496
18497 \end_layout
18498
18499 \end_inset
18500
18501  package in R for dynamic report generation has to be installed for this module to work:
18502
18503 \begin_inset Flex Code
18504 status collapsed
18505
18506 \begin_layout Plain Layout
18507
18508 \change_inserted 564990737 1672161542
18509 install.packages(“knitr”)
18510 \change_unchanged
18511
18512 \end_layout
18513
18514 \end_inset
18515
18516 .
18517
18518 \end_layout
18519
18520 \begin_layout Paragraph
18521
18522 \change_inserted 564990737 1672161542
18523 Note
18524 \end_layout
18525
18526 \begin_layout Standard
18527
18528 \change_inserted 564990737 1672161542
18529 it depends on R >= 2.14.1.
18530  For more info see
18531 \begin_inset Flex URL
18532 status collapsed
18533
18534 \begin_layout Plain Layout
18535
18536 \change_inserted 564990737 1672161542
18537
18538 http://yihui.name/knitr
18539 \change_unchanged
18540
18541 \end_layout
18542
18543 \end_inset
18544
18545 .
18546
18547 \end_layout
18548
18549 \begin_layout Standard
18550
18551 \change_inserted 564990737 1672161542
18552 The package
18553 \family sans
18554 includernw
18555 \family default
18556  also has to be installed.
18557  It cannot be used if the modules
18558 \family sans
18559 LilyPond
18560 \begin_inset space ~
18561 \end_inset
18562
18563 Book
18564 \family default
18565  or
18566 \family sans
18567 Sweave
18568 \family default
18569  are loaded.
18570  See
18571 \family sans
18572 Help\SpecialChar menuseparator
18573 Specific Manuals\SpecialChar menuseparator
18574 Knitr
18575 \family default
18576 ,
18577
18578 \family sans
18579 File\SpecialChar menuseparator
18580 Open Example\SpecialChar menuseparator
18581 Modules\SpecialChar menuseparator
18582 Rnw (knitr)
18583 \family default
18584  and section
18585 \begin_inset space ~
18586 \end_inset
18587
18588
18589 \begin_inset CommandInset ref
18590 LatexCommand ref
18591 reference "sec:Literate-Programming"
18592 nolink "false"
18593
18594 \end_inset
18595
18596  for information about literate programming.
18597 \end_layout
18598
18599 \begin_layout Subsection
18600
18601 \change_inserted 564990737 1672161542
18602 Sweave
18603 \end_layout
18604
18605 \begin_layout Standard
18606
18607 \change_inserted 564990737 1672161542
18608 This module allows the use of the statistical language S/R as a literate programming tool.
18609  It requires the
18610 \family sans
18611 includernw
18612 \family default
18613  and
18614 \family sans
18615 fancyvrb
18616 \family default
18617  packages.
18618  Both
18619 \begin_inset CommandInset href
18620 LatexCommand href
18621 name "includernw"
18622 target "https://www.ctan.org/pkg/includernw"
18623 literal "false"
18624
18625 \end_inset
18626
18627  and
18628 \begin_inset CommandInset href
18629 LatexCommand href
18630 name "fancyvrb"
18631 target "https://www.ctan.org/pkg/fancyvrb"
18632 literal "false"
18633
18634 \end_inset
18635
18636  are available from CTAN.
18637  It cannot be used if the module
18638 \family sans
18639 LilyPond
18640 \begin_inset space ~
18641 \end_inset
18642
18643 Book
18644 \family default
18645  has been loaded.
18646  See
18647 \family sans
18648 Help\SpecialChar menuseparator
18649 Specific Manuals\SpecialChar menuseparator
18650 Sweave,
18651
18652 \family default
18653
18654 \family sans
18655 File\SpecialChar menuseparator
18656 Open Example\SpecialChar menuseparator
18657 Modules\SpecialChar menuseparator
18658 Sweave
18659 \family default
18660  and section
18661 \begin_inset space ~
18662 \end_inset
18663
18664
18665 \begin_inset CommandInset ref
18666 LatexCommand ref
18667 reference "sec:Literate-Programming"
18668 nolink "false"
18669
18670 \end_inset
18671
18672  for information about literate programming.
18673 \end_layout
18674
18675 \begin_layout Section
18676
18677 \change_inserted 564990737 1672224959
18678 Maths
18679 \end_layout
18680
18681 \begin_layout Subsection
18682
18683 \change_inserted 564990737 1672224959
18684 AMS Theorems
18685 \end_layout
18686
18687 \begin_layout Standard
18688
18689 \change_inserted 564990737 1672224959
18690 This modules defines theorem environments and the proof environment using the extended AMS machinery.
18691  Both numbered and unnumbered types are provided.
18692  By default,
18693  the theorems are numbered consecutively throughout the document.
18694  This can be changed by loading one of the
18695 \family sans
18696 AMS Theorems (Numbered by \SpecialChar ldots
18697 )
18698 \family default
18699  modules.
18700  It cannot be used if the modules
18701 \family sans
18702 Standard Theorems
18703 \family default
18704  or
18705 \family sans
18706 Standard Theorems (Unnumbered)
18707 \family default
18708  have been loaded.
18709 \end_layout
18710
18711 \begin_layout Subsection
18712
18713 \change_inserted 564990737 1672224959
18714 AMS Theorems (Extended)
18715 \end_layout
18716
18717 \begin_layout Standard
18718
18719 \change_inserted 564990737 1672224959
18720 This module defines some additional theorem environments for use with the
18721 \family sans
18722 AMS Theorems
18723 \family default
18724  package (which must be loaded).
18725  It includes Criterion,
18726  Algorithm,
18727  Axiom,
18728  Condition,
18729  Note,
18730  Notation,
18731  Summary,
18732  Acknowledgement,
18733  Conclusion,
18734  Fact,
18735  Assumption,
18736  Case and Question in both numbered and unnumbered forms.
18737 \end_layout
18738
18739 \begin_layout Subsection
18740
18741 \change_inserted 564990737 1672224959
18742 AMS Theorems (Extended,
18743  Numbered by Type within Chapters)
18744 \end_layout
18745
18746 \begin_layout Standard
18747
18748 \change_inserted 564990737 1672224959
18749 This module defines some additional theorem environments for use with the
18750 \family sans
18751 AMS Theorems (Numbered by Type within Chapters)
18752 \family default
18753  package (which must be loaded).
18754  It includes Criterion,
18755  Algorithm,
18756  Axiom,
18757  Condition,
18758  Note,
18759  Notation,
18760  Summary,
18761  Acknowledgement,
18762  Conclusion,
18763  Assumption and Case in both numbered and unnumbered forms.
18764  Unlike the
18765 \family sans
18766 AMS Theorems (Extended)
18767 \family default
18768  module,
18769  the different theorem types provided here each have a separate counter,
18770  restarted with each new chapter (e.g.,
18771  criterion 1.1,
18772  criterion 1.2,
18773  axiom 1.1,
18774  assumption 1.1,
18775  criterion 2.1,
18776  criterion 2.2,
18777  axiom 2.1\SpecialChar ldots
18778 ,
18779  as opposed to criterion 1,
18780  criterion 2,
18781  axiom 3,
18782  assumption 4...).
18783 \end_layout
18784
18785 \begin_layout Subsection
18786
18787 \change_inserted 564990737 1672224959
18788 AMS Theorems (Extended,
18789  Numbered by Type)
18790 \end_layout
18791
18792 \begin_layout Standard
18793
18794 \change_inserted 564990737 1672224959
18795 This module defines some additional theorem environments for use with the
18796 \family sans
18797 AMS Theorems (Numbered by Type)
18798 \family default
18799  package (which must be loaded).
18800  It includes Criterion,
18801  Algorithm,
18802  Axiom,
18803  Condition,
18804  Note,
18805  Notation,
18806  Summary,
18807  Acknowledgement,
18808  Conclusion,
18809  Assumption and Case in both numbered and unnumbered forms.
18810  Unlike the
18811 \family sans
18812 AMS Theorems (Extended)
18813 \family default
18814  module,
18815  the different theorem types provided here each have a separate counter (e.g.,
18816  criterion 1,
18817  criterion 2,
18818  axiom 1,
18819  assumption 1,
18820  criterion 3,
18821  \SpecialChar ldots
18822 ,
18823  as opposed to criterion 1,
18824  criterion 2,
18825  axiom 3,
18826  assumption 4,
18827  \SpecialChar ldots
18828 ).
18829 \end_layout
18830
18831 \begin_layout Subsection
18832
18833 \change_inserted 564990737 1672224959
18834 AMS Theorems (Numbered by Type within Chapters)
18835 \end_layout
18836
18837 \begin_layout Standard
18838
18839 \change_inserted 564990737 1672224959
18840 This module defines theorem environments and the proof environment using the extended AMS machinery.
18841  Both numbered and unnumbered types are provided.
18842  Unlike the
18843 \family sans
18844 AMS Theorems
18845 \family default
18846  module,
18847  the different theorem types provided here each have a separate counter (e.g.,
18848  theorem 1.1,
18849  theorem 1.2,
18850  lemma 1.1,
18851  proposition 1.1,
18852  theorem 1.3,
18853  lemma 1.2,
18854  \SpecialChar ldots
18855 ,
18856  as opposed to theorem 1,
18857  theorem 2,
18858  lemma 3,
18859  proposition 4,
18860  \SpecialChar ldots
18861 ).
18862  The numbering restarts for each chapter:
18863  theorem 1.1,
18864  theorem 2.1,
18865  \SpecialChar ldots
18866  It cannot be used if the modules
18867 \family sans
18868 AMS Theorems
18869 \family default
18870 ,
18871
18872 \family sans
18873 Standard Theorems
18874 \family default
18875 ,
18876
18877 \family sans
18878  Standard Theorems (Numbered by Type)
18879 \family default
18880  or
18881 \family sans
18882  Standard Theorems (Unnumbered)
18883 \family default
18884  have been loaded.
18885 \end_layout
18886
18887 \begin_layout Subsection
18888
18889 \change_inserted 564990737 1672224959
18890 AMS Theorems (Numbered by Type)
18891 \end_layout
18892
18893 \begin_layout Standard
18894
18895 \change_inserted 564990737 1672224959
18896 This module defines theorem environments and the proof environment using the extended AMS machinery.
18897  Both numbered and unnumbered types are provided.
18898  Unlike the
18899 \family sans
18900 AMS Theorems
18901 \family default
18902  module,
18903  the different theorem types provided here each have a separate counter (e.g.,
18904  theorem 1,
18905  theorem 2,
18906  lemma 1,
18907  proposition 1,
18908  theorem 3,
18909  lemma 2,
18910  \SpecialChar ldots
18911 ,
18912  as opposed to theorem 1,
18913  theorem 2,
18914  lemma 3,
18915  proposition 4,
18916  \SpecialChar ldots
18917 ).
18918  The numbering’s scope is the whole document.
18919  For chapter- and section-wide numbering,
18920  use one of the ‘within Sections’/‘within Chapters’ modules,
18921  respectively.
18922  It cannot be used if the modules
18923 \family sans
18924 AMS Theorems
18925 \family default
18926 ,
18927
18928 \family sans
18929 Standard Theorems
18930 \family default
18931 ,
18932
18933 \family sans
18934  Standard Theorems (Numbered by Type)
18935 \family default
18936  or
18937 \family sans
18938  Standard Theorems (Unnumbered)
18939 \family default
18940  have been loaded.
18941 \end_layout
18942
18943 \begin_layout Subsection
18944
18945 \change_inserted 564990737 1672224959
18946 Number Equations by Section
18947 \end_layout
18948
18949 \begin_layout Standard
18950
18951 \change_inserted 564990737 1672224959
18952 This module resets the equation number at section start and prepends the section number to the equation number,
18953  as in “(2.1).”
18954 \end_layout
18955
18956 \begin_layout Subsection
18957
18958 \change_inserted 564990737 1672224959
18959 Standard Theorems
18960 \end_layout
18961
18962 \begin_layout Standard
18963
18964 \change_inserted 564990737 1672224959
18965 This module defines some theorem environments for use with non-AMS classes.
18966  By default,
18967  the theorems are numbered consecutively throughout the document.
18968  This can be changed by loading one of the
18969 \family sans
18970 Standard Theorems (Numbered by \SpecialChar ldots
18971 )
18972 \family default
18973  modules.
18974  It cannot be used if the modules
18975 \family sans
18976 AMS Theorems
18977 \family default
18978  or
18979 \family sans
18980  Standard Theorems (Unnumbered)
18981 \family default
18982  have been loaded.
18983
18984 \end_layout
18985
18986 \begin_layout Subsection
18987
18988 \change_inserted 564990737 1672224959
18989 Standard Theorems (Nameable)
18990 \end_layout
18991
18992 \begin_layout Standard
18993
18994 \change_inserted 564990737 1672224959
18995 This module facilitates the use of named theorems.
18996  The name of the theorem goes into the “Additional Theorem Text” argument.
18997
18998 \end_layout
18999
19000 \begin_layout Subsection
19001
19002 \change_inserted 564990737 1672224959
19003 Standard Theorems (Numbered by Chapter)
19004 \end_layout
19005
19006 \begin_layout Standard
19007
19008 \change_inserted 564990737 1672224959
19009 This module numbers theorems and the like by chapter (i.e.,
19010  the counter is reset at each chapter start).
19011  Use this module only with document classes that provide a chapter environment.
19012  One of the modules
19013 \family sans
19014 AMS Theorems
19015 \family default
19016  or
19017 \family sans
19018 Standard Theorems
19019 \family default
19020  must be loaded.
19021  It cannot be used if the module
19022 \family sans
19023  Standard Theorems (Numbered by Section)
19024 \family default
19025  has been loaded.
19026 \end_layout
19027
19028 \begin_layout Subsection
19029
19030 \change_inserted 564990737 1672224959
19031 Standard Theorems (Numbered by Section)
19032 \end_layout
19033
19034 \begin_layout Standard
19035
19036 \change_inserted 564990737 1672224959
19037 This module numbers theorems and the like by section (i.e.,
19038  the counter is reset at each section start).
19039  One of the modules
19040 \family sans
19041 AMS Theorems
19042 \family default
19043  or
19044 \family sans
19045 Standard Theorems
19046 \family default
19047  must be loaded.
19048  It cannot be used if the module
19049 \family sans
19050  Standard Theorems (Numbered by Chapter)
19051 \family default
19052  has been loaded.
19053 \end_layout
19054
19055 \begin_layout Subsection
19056
19057 \change_inserted 564990737 1672224959
19058 Standard Theorems (Numbered by Type within Chapters)
19059 \end_layout
19060
19061 \begin_layout Standard
19062
19063 \change_inserted 564990737 1672224959
19064 This module defines some theorem environments for use with non-AMS classes.
19065  Unlike the
19066 \family sans
19067  AMS Theorems
19068 \family default
19069  and
19070 \family sans
19071 Standard Theorems
19072 \family default
19073  modules,
19074  the different theorem types provided here each have a separate counter (e.g.,
19075  theorem 1,
19076  theorem 2,
19077  lemma 1,
19078  proposition 1,
19079  theorem 3,
19080  lemma 2,
19081  \SpecialChar ldots
19082 ,
19083  as opposed to theorem 1,
19084  theorem 2,
19085  lemma 3,
19086  proposition 4,
19087  \SpecialChar ldots
19088 ).
19089  The numbering is reset at each chapter start.
19090  One of the modules
19091 \family sans
19092 AMS Theorems (Numbered by Type)
19093 \family default
19094  or
19095 \family sans
19096 Standard Theorems (Numbered by Type)
19097 \family default
19098  must be loaded.
19099  It cannot be used if any of the modules
19100 \family sans
19101  AMS Theorems
19102 \family default
19103 ,
19104
19105 \family sans
19106 Standard Theorems
19107 \family default
19108 ,
19109
19110 \family sans
19111 Standard Theorems (Unnumbered)
19112 \family default
19113 ,
19114
19115 \family sans
19116  Standard Theorems (Numbered by Sections)
19117 \family default
19118  or
19119 \family sans
19120 Standard Theorems (Numbered by Type within Sections)
19121 \family default
19122  have been loaded.
19123 \end_layout
19124
19125 \begin_layout Subsection
19126
19127 \change_inserted 564990737 1672224959
19128 Standard Theorems (Numbered by Type within Sections)
19129 \end_layout
19130
19131 \begin_layout Standard
19132
19133 \change_inserted 564990737 1672224959
19134 This module defines some theorem environments for use with non-AMS classes.
19135  Unlike the
19136 \family sans
19137  AMS Theorems
19138 \family default
19139  and
19140 \family sans
19141 Standard Theorems
19142 \family default
19143  modules,
19144  the different theorem types provided here each have a separate counter (e.g.,
19145  theorem 1,
19146  theorem 2,
19147  lemma 1,
19148  proposition 1,
19149  theorem 3,
19150  lemma 2,
19151  \SpecialChar ldots
19152 ,
19153  as opposed to theorem 1,
19154  theorem 2,
19155  lemma 3,
19156  proposition 4,
19157  \SpecialChar ldots
19158 ).
19159  The numbering is reset at each section start.
19160  One of the modules
19161 \family sans
19162 AMS Theorems (Numbered by Type)
19163 \family default
19164  or
19165 \family sans
19166 Standard Theorems (Numbered by Type)
19167 \family default
19168  must be loaded.
19169  It cannot be used if any of the modules
19170 \family sans
19171  AMS Theorems
19172 \family default
19173 ,
19174
19175 \family sans
19176 Standard Theorems
19177 \family default
19178 ,
19179
19180 \family sans
19181 Standard Theorems (Unnumbered)
19182 \family default
19183 ,
19184
19185 \family sans
19186  Standard Theorems (Numbered by Chapters)
19187 \family default
19188  or
19189 \family sans
19190 Standard Theorems (Numbered by Type within Chapters)
19191 \family default
19192  have been loaded.
19193 \end_layout
19194
19195 \begin_layout Subsection
19196
19197 \change_inserted 564990737 1672224959
19198 Standard Theorems (Numbered by Type)
19199 \end_layout
19200
19201 \begin_layout Standard
19202
19203 \change_inserted 564990737 1672224959
19204 This module defines some theorem environments for use with non-AMS classes.
19205  Unlike the
19206 \family sans
19207 AMS Theorems
19208 \family default
19209  and
19210 \family sans
19211 Standard Theorems
19212 \family default
19213  modules,
19214  the different theorem types provided here each have a separate counter (e.g.,
19215  theorem 1,
19216  theorem 2,
19217  lemma 1,
19218  proposition 1,
19219  theorem 3,
19220  lemma 2,
19221  \SpecialChar ldots
19222 ,
19223  as opposed to theorem 1,
19224  theorem 2,
19225  lemma 3,
19226  proposition 4,
19227  \SpecialChar ldots
19228 ).
19229  The numbering’s scope is the whole document.
19230  For chapter- and section-wide numbering,
19231  use one of the “within Chapters”/“within Sections” modules,
19232  respectively.
19233  It cannot be used if any of the modules
19234 \family sans
19235  AMS Theorems
19236 \family default
19237 ,
19238
19239 \family sans
19240 Standard Theorems
19241 \family default
19242 ,
19243
19244 \family sans
19245 Standard Theorems (Unnumbered)
19246 \family default
19247  or
19248 \family sans
19249  AMS Theorems (Numbered by Type)
19250 \family default
19251  have been loaded.
19252 \end_layout
19253
19254 \begin_layout Subsection
19255
19256 \change_inserted 564990737 1672224959
19257 Standard Theorems (Unnumbered)
19258 \end_layout
19259
19260 \begin_layout Standard
19261
19262 \change_inserted 564990737 1672224959
19263 This module defines only unnumbered theorem environments and the proof environment,
19264  using the extended AMS machinery.
19265  It cannot be used if either of the modules
19266 \family sans
19267  AMS Theorems
19268 \family default
19269  or
19270 \family sans
19271  Standard Theorems
19272 \family default
19273  have been loaded.
19274 \end_layout
19275
19276 \begin_layout Subsection
19277
19278 \change_inserted 564990737 1672224959
19279 Subequations
19280 \end_layout
19281
19282 \begin_layout Standard
19283
19284 \change_inserted 564990737 1672224959
19285 This module provides a straightforward way to segregate subequations in LyX.
19286  See
19287 \family sans
19288 Help\SpecialChar menuseparator
19289 Math\SpecialChar menuseparator
19290 Subnumbering
19291 \family default
19292 .
19293
19294 \end_layout
19295
19296 \begin_layout Section
19297
19298 \change_inserted 564990737 1672236008
19299 Page Layout
19300 \end_layout
19301
19302 \begin_layout Subsection
19303
19304 \change_inserted 564990737 1672236008
19305 Custom Header/Footer Text
19306 \end_layout
19307
19308 \begin_layout Standard
19309
19310 \change_inserted 564990737 1672236008
19311 This module requires the
19312 \family sans
19313 Page
19314 \begin_inset space ~
19315 \end_inset
19316
19317
19318 \bar under
19319 s
19320 \bar default
19321 tyle
19322 \family default
19323  option in the
19324 \family sans
19325 \bar under
19326 D
19327 \bar default
19328 ocument\SpecialChar menuseparator
19329
19330 \bar under
19331 S
19332 \bar default
19333 ettings\SpecialChar menuseparator
19334 Page
19335 \begin_inset space ~
19336 \end_inset
19337
19338 Layout
19339 \family default
19340  dialog to be set to
19341 \family typewriter
19342 fancy
19343 \family default
19344 .
19345  It adds six environments to document classes which support the
19346 \family typewriter
19347 fancyhdr
19348 \family default
19349  package:
19350 \end_layout
19351
19352 \begin_layout Itemize
19353
19354 \change_inserted 564990737 1672236008
19355
19356 \family sans
19357 Left Header
19358 \end_layout
19359
19360 \begin_layout Itemize
19361
19362 \change_inserted 564990737 1672236008
19363
19364 \family sans
19365 Center Header
19366 \end_layout
19367
19368 \begin_layout Itemize
19369
19370 \change_inserted 564990737 1672236008
19371
19372 \family sans
19373 Right Header
19374 \end_layout
19375
19376 \begin_layout Itemize
19377
19378 \change_inserted 564990737 1672236008
19379
19380 \family sans
19381 Left Footer
19382 \end_layout
19383
19384 \begin_layout Itemize
19385
19386 \change_inserted 564990737 1672236008
19387
19388 \family sans
19389 Center Footer
19390 \end_layout
19391
19392 \begin_layout Itemize
19393
19394 \change_inserted 564990737 1672236008
19395
19396 \family sans
19397 Right Footer
19398 \end_layout
19399
19400 \begin_layout Subsubsection
19401
19402 \change_inserted 564990737 1672236008
19403 Fancy Headers and Footers
19404 \end_layout
19405
19406 \begin_layout Standard
19407
19408 \change_inserted 564990737 1672236008
19409 The default page layout is rather plain;
19410  for an
19411 \begin_inset Flex Code
19412 status collapsed
19413
19414 \begin_layout Plain Layout
19415
19416 \change_inserted 564990737 1672236008
19417 article
19418 \change_unchanged
19419
19420 \end_layout
19421
19422 \end_inset
19423
19424  document class,
19425  all you get is a centered page number at the bottom of the page.
19426  This document uses KOMA-script’s book class;
19427  so it appears to be a bit fancier.
19428  Once the
19429 \family sans
19430 Page
19431 \begin_inset space ~
19432 \end_inset
19433
19434
19435 \bar under
19436 s
19437 \bar default
19438 tyle
19439 \family default
19440  in
19441 \family sans
19442 \bar under
19443 D
19444 \bar default
19445 ocument\SpecialChar menuseparator
19446
19447 \bar under
19448 S
19449 \bar default
19450 ettings\SpecialChar menuseparator
19451 Page Layout
19452 \family default
19453  is set to
19454 \begin_inset Quotes eld
19455 \end_inset
19456
19457 fancy
19458 \begin_inset Quotes erd
19459 \end_inset
19460
19461 ,
19462  you will find that the page header is divided into three fields,
19463  not surprisingly labeled
19464 \begin_inset Quotes eld
19465 \end_inset
19466
19467 left
19468 \begin_inset Quotes erd
19469 \end_inset
19470
19471 ,
19472
19473 \begin_inset Quotes eld
19474 \end_inset
19475
19476 center
19477 \begin_inset Quotes erd
19478 \end_inset
19479
19480 ,
19481  and
19482 \begin_inset Quotes eld
19483 \end_inset
19484
19485 right
19486 \begin_inset Quotes erd
19487 \end_inset
19488
19489 .
19490  The footer is also divided into these three fields.
19491  The \SpecialChar LaTeX
19492  commands to set these fields in the simplest manner are
19493 \family sans
19494
19495 \backslash
19496 lhead
19497 \family default
19498 ,
19499
19500 \family sans
19501
19502 \backslash
19503 chead
19504 \family default
19505 ,
19506
19507 \family sans
19508
19509 \backslash
19510 rhead
19511 \family default
19512 ,
19513
19514 \family sans
19515
19516 \backslash
19517 lfoot
19518 \family default
19519 ,
19520  etc.
19521  Suppose you wish to put your name in the upper left hand corner of each page.
19522  Simply insert the following command in the preamble:
19523
19524 \end_layout
19525
19526 \begin_layout Standard
19527
19528 \change_inserted 564990737 1672236008
19529
19530 \family sans
19531
19532 \backslash
19533 lhead
19534 \family default
19535 \series bold
19536 {
19537 \series default
19538 John Q.
19539  DocWriter
19540 \series bold
19541 }
19542 \end_layout
19543
19544 \begin_layout Standard
19545
19546 \change_inserted 564990737 1672236008
19547 You will now see your name in the upper left.
19548  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,
19549  e.
19550 \begin_inset space \thinspace{}
19551 \end_inset
19552
19553 g.:
19554 \end_layout
19555
19556 \begin_layout Standard
19557
19558 \change_inserted 564990737 1672236008
19559
19560 \family sans
19561
19562 \backslash
19563 cfoot{}
19564 \end_layout
19565
19566 \begin_layout Standard
19567
19568 \change_inserted 564990737 1672236008
19569 There is,
19570  however,
19571  an easier way to make simple changes.
19572  If you load the
19573 \family sans
19574 \bar under
19575 D
19576 \bar default
19577 ocument\SpecialChar menuseparator
19578
19579 \bar under
19580 S
19581 \bar default
19582 ettings\SpecialChar menuseparator
19583 Modules\SpecialChar menuseparator
19584 Page Layout\SpecialChar menuseparator
19585 Custom Header/Footer Text
19586 \family default
19587  module,
19588  you will find you have six new environments corresponding to the six fields described above.
19589 \end_layout
19590
19591 \begin_layout Standard
19592
19593 \change_inserted 564990737 1672236008
19594 Let's get really fancy:
19595  lets put the section number with the word
19596 \begin_inset Quotes eld
19597 \end_inset
19598
19599 Section
19600 \begin_inset Quotes erd
19601 \end_inset
19602
19603  (e.
19604 \begin_inset space \thinspace{}
19605 \end_inset
19606
19607 g.
19608 \begin_inset space \space{}
19609 \end_inset
19610
19611 Section 3) in the upper left,
19612  the page number (e.
19613 \begin_inset space \thinspace{}
19614 \end_inset
19615
19616 g.
19617 \begin_inset space \space{}
19618 \end_inset
19619
19620 Page 4) in the upper right,
19621  your name in the lower left,
19622  and the date in the lower right.
19623  Use your newly enabled environments to add these entries:
19624 \end_layout
19625
19626 \begin_layout Standard
19627
19628 \change_inserted 564990737 1672236008
19629 \begin_inset VSpace defskip
19630 \end_inset
19631
19632
19633 \end_layout
19634
19635 \begin_layout Standard
19636
19637 \change_inserted 564990737 1672236008
19638
19639 \color green
19640 Left
19641 \begin_inset space ~
19642 \end_inset
19643
19644 header:
19645
19646 \series bold
19647 \color inherit
19648
19649 \series default
19650 Section
19651 \family typewriter
19652
19653 \family sans
19654
19655 \backslash
19656 thesection
19657 \end_layout
19658
19659 \begin_layout Standard
19660
19661 \change_inserted 564990737 1672236008
19662
19663 \color green
19664 Center header:
19665 \end_layout
19666
19667 \begin_layout Standard
19668
19669 \change_inserted 564990737 1672236008
19670
19671 \color green
19672 Right header:
19673
19674 \color inherit
19675  Page
19676 \family typewriter
19677
19678 \family sans
19679
19680 \backslash
19681 thepage
19682 \end_layout
19683
19684 \begin_layout Standard
19685
19686 \change_inserted 564990737 1672236008
19687
19688 \color green
19689 Left footer:
19690
19691 \color inherit
19692  John Q.
19693  DocWriter
19694 \end_layout
19695
19696 \begin_layout Standard
19697
19698 \change_inserted 564990737 1672236008
19699
19700 \color green
19701 Center footer:
19702 \end_layout
19703
19704 \begin_layout Standard
19705
19706 \change_inserted 564990737 1672236008
19707
19708 \color green
19709 Right footer:
19710
19711 \series bold
19712 \color inherit
19713
19714 \family sans
19715 \series default
19716
19717 \backslash
19718 today
19719 \end_layout
19720
19721 \begin_layout Standard
19722
19723 \change_inserted 564990737 1672236008
19724 \begin_inset VSpace defskip
19725 \end_inset
19726
19727
19728 \end_layout
19729
19730 \begin_layout Standard
19731
19732 \change_inserted 564990737 1672236008
19733 Make sure you enter the commands
19734 \family sans
19735
19736 \backslash
19737 thesection
19738 \family default
19739 ,
19740
19741 \family sans
19742
19743 \backslash
19744 thepage
19745 \family default
19746  and
19747 \family sans
19748
19749 \backslash
19750 today
19751 \family default
19752  as \SpecialChar TeX
19753  Code commands
19754 \series bold
19755 .
19756
19757 \series default
19758  The commands
19759 \family sans
19760
19761 \backslash
19762 thesection
19763 \family default
19764  and
19765 \family sans
19766
19767 \backslash
19768 thepage
19769 \family default
19770  access \SpecialChar LaTeX
19771 ’s section and page counters,
19772  and so print out the current section and page numbers.
19773
19774 \family sans
19775
19776 \backslash
19777 today
19778 \family default
19779  simply prints out today’s date.
19780 \end_layout
19781
19782 \begin_layout Standard
19783
19784 \change_inserted 564990737 1672236008
19785 The thicknesses of the horizontal rules drawn beneath the header and above the footer can also be modified.
19786  If you don't want one of the rules,
19787  set its thickness to 0.
19788  The header rule has a default thickness of 0.4pt,
19789  the footer rule is 0pt.
19790  For this you will need to use \SpecialChar TeX
19791  Code commands like
19792 \end_layout
19793
19794 \begin_layout Standard
19795
19796 \change_inserted 564990737 1672236008
19797
19798 \family sans
19799
19800 \backslash
19801 renewcommand{
19802 \backslash
19803 headrulewidth}{0.4pt}
19804 \family default
19805  and
19806 \end_layout
19807
19808 \begin_layout Standard
19809
19810 \change_inserted 564990737 1672236008
19811
19812 \family sans
19813
19814 \backslash
19815 renewcommand{
19816 \backslash
19817 footrulewidth}{0.4pt}
19818 \family default
19819  to set the thicknesses.
19820 \end_layout
19821
19822 \begin_layout Standard
19823
19824 \change_inserted 564990737 1672236008
19825 You can switch the header/footer settings on and off for individual pages using \SpecialChar TeX
19826  Code commands like
19827 \family sans
19828
19829 \backslash
19830 thispagestyle{empty}
19831 \family default
19832 ,
19833
19834 \family sans
19835
19836 \backslash
19837 thispagestyle{plain}
19838 \family default
19839 ,
19840  and
19841 \family sans
19842
19843 \backslash
19844 thispagestyle{fancy}
19845 \family default
19846 .
19847  Simply insert them in the text on the page you want changed and mark them as \SpecialChar TeX
19848  code.
19849  In fact,
19850  title pages are marked as plain by default,
19851  while following pages are marked fancy when using the global fancy setting.
19852
19853 \end_layout
19854
19855 \begin_layout Standard
19856
19857 \change_inserted 564990737 1672236008
19858 If you want a header or footer to be on the outer side of a two sided document,
19859  you need to use something like:
19860 \end_layout
19861
19862 \begin_layout Standard
19863
19864 \change_inserted 564990737 1672236008
19865
19866 \family sans
19867 \begin_inset Flex Strong
19868 status collapsed
19869
19870 \begin_layout Plain Layout
19871
19872 \change_inserted 564990737 1672236008
19873
19874 \family sans
19875 \series medium
19876
19877 \backslash
19878 fancyfoot{}
19879 \change_unchanged
19880
19881 \end_layout
19882
19883 \end_inset
19884
19885
19886 \end_layout
19887
19888 \begin_layout Standard
19889
19890 \change_inserted 564990737 1672236008
19891
19892 \family sans
19893 \begin_inset Flex Strong
19894 status collapsed
19895
19896 \begin_layout Plain Layout
19897
19898 \change_inserted 564990737 1672236008
19899
19900 \family sans
19901 \series medium
19902
19903 \backslash
19904 fancyfoot[LE,RO]{
19905 \backslash
19906 thepage}
19907 \change_unchanged
19908
19909 \end_layout
19910
19911 \end_inset
19912
19913
19914 \end_layout
19915
19916 \begin_layout Standard
19917
19918 \change_inserted 564990737 1672236008
19919 The first command clears all existing footers avoiding any conflicts with your new command.
19920 \end_layout
19921
19922 \begin_layout Standard
19923
19924 \change_inserted 564990737 1672236008
19925 You can enter any of these commands,
19926  the simpler ones in any of your new environments,
19927  the more complex ones as \SpecialChar TeX
19928  Code commands,
19929  at any point in your document and they will take effect on the next page.
19930 \end_layout
19931
19932 \begin_layout Standard
19933
19934 \change_inserted 564990737 1672236008
19935 As a final example,
19936  it is possible to include an image in the header or footer.
19937  Suppose you want to put a company logo in the upper left hand corner.
19938  You might try something like
19939 \end_layout
19940
19941 \begin_layout Standard
19942
19943 \change_inserted 564990737 1672236008
19944
19945 \family sans
19946
19947 \backslash
19948 lhead{
19949 \backslash
19950 resizebox{1in}{!}{
19951 \backslash
19952 includegraphics{logo.eps}}}
19953 \end_layout
19954
19955 \begin_layout Standard
19956 \noindent
19957
19958 \change_inserted 564990737 1672236008
19959 (you may need to preface this with
19960 \family sans
19961
19962 \backslash
19963 usepackage{graphics}
19964 \family default
19965  if you don't include graphics elsewhere in your document).
19966 \end_layout
19967
19968 \begin_layout Standard
19969
19970 \change_inserted 564990737 1672236008
19971 For more information on fancy headers,
19972  you can get the
19973 \begin_inset Flex Code
19974 status collapsed
19975
19976 \begin_layout Plain Layout
19977
19978 \change_inserted 564990737 1672236008
19979 fancyhdr
19980 \change_unchanged
19981
19982 \end_layout
19983
19984 \end_inset
19985
19986  documentation from
19987 \begin_inset CommandInset href
19988 LatexCommand href
19989 name "CTAN"
19990 target "http://www.ctan.org/pkg/fancyhdr"
19991 literal "false"
19992
19993 \end_inset
19994
19995 .
19996
19997 \end_layout
19998
19999 \begin_layout Subsection
20000
20001 \change_inserted 564990737 1672236008
20002 Landscape Document Parts
20003 \end_layout
20004
20005 \begin_layout Standard
20006
20007 \change_inserted 564990737 1672236008
20008 This module outputs parts of the document in landscape mode using
20009 \family sans
20010 Insert\SpecialChar menuseparator
20011 Custom Insets\SpecialChar menuseparator
20012 Landscape
20013 \family default
20014  or
20015 \family sans
20016 Insert\SpecialChar menuseparator
20017 Custom Insets\SpecialChar menuseparator
20018 Landscape (Floating)
20019 \family default
20020 .
20021 \end_layout
20022
20023 \begin_layout Subsection
20024
20025 \change_inserted 564990737 1672236008
20026 \begin_inset CommandInset label
20027 LatexCommand label
20028 name "sec:Multiple-Columns"
20029
20030 \end_inset
20031
20032 Multiple Columns
20033 \end_layout
20034
20035 \begin_layout Standard
20036
20037 \change_inserted 564990737 1672236008
20038 This module uses the
20039 \family sans
20040 multicol
20041 \family default
20042
20043 \begin_inset Index idx
20044 range none
20045 pageformat default
20046 status collapsed
20047
20048 \begin_layout Plain Layout
20049
20050 \change_inserted 564990737 1672236008
20051 \SpecialChar LaTeX
20052 -packages !
20053  multicol
20054 \change_unchanged
20055
20056 \end_layout
20057
20058 \end_inset
20059
20060  package and is independent of the option
20061 \family sans
20062 Two-
20063 \bar under
20064 c
20065 \bar default
20066 olumn document
20067 \family default
20068  in the
20069 \family sans
20070 \bar under
20071 D
20072 \bar default
20073 ocument\SpecialChar menuseparator
20074
20075 \bar under
20076 S
20077 \bar default
20078 ettings\SpecialChar menuseparator
20079 Text
20080 \begin_inset space ~
20081 \end_inset
20082
20083 Layout
20084 \family default
20085  dialog.
20086  If you want to have two columns for the whole document,
20087  you are recommended to use the
20088 \family sans
20089 Two-
20090 \bar under
20091 c
20092 \bar default
20093 olumn document
20094 \family default
20095  option.
20096  For all other cases use this module.
20097 \change_deleted 564990737 1672236008
20098 Multiple Text Columns
20099 \end_layout
20100
20101 \begin_layout Standard
20102
20103 \change_deleted 564990737 1672236008
20104 This feature is independent of the option
20105 \family sans
20106 Two-column document
20107 \family default
20108  in the document settings under
20109 \family sans
20110 Text Layout
20111 \family default
20112 .
20113  If you want to have 2
20114 \begin_inset space ~
20115 \end_inset
20116
20117 columns for the whole document,
20118  it is recommended to use the
20119 \family sans
20120 Two-column document
20121 \family default
20122  option.
20123  For all other cases use this feature.
20124 \end_layout
20125
20126 \begin_layout Standard
20127
20128 \change_deleted 564990737 1672236008
20129 To use multiple text columns in your document,
20130  you have to load the module
20131 \family sans
20132 Multiple Columns
20133 \family default
20134  (menu
20135 \family sans
20136 Document\SpecialChar menuseparator
20137 Settings\SpecialChar menuseparator
20138 Modules
20139 \family default
20140 ) and must have the \SpecialChar LaTeX
20141 -package
20142 \begin_inset Flex Code
20143 status collapsed
20144
20145 \begin_layout Plain Layout
20146 multicol
20147 \end_layout
20148
20149 \end_inset
20150
20151  installed.
20152 \change_unchanged
20153
20154 \end_layout
20155
20156 \begin_layout Standard
20157 Footnotes within multiple columns will be placed at the bottom of the page and not under each column.
20158  Within the different columns you can use everything,
20159  with the limitation that for floats you need to
20160 \change_deleted 564990737 1672236179
20161 use the float option
20162 \family sans
20163 Span columns
20164 \change_inserted 564990737 1672236179
20165
20166 \family default
20167 check the option
20168 \family sans
20169 \bar under
20170 S
20171 \bar default
20172 pan
20173 \begin_inset space ~
20174 \end_inset
20175
20176 columns
20177 \family default
20178  in
20179 \family sans
20180 \bar under
20181 E
20182 \bar default
20183 dit\SpecialChar menuseparator
20184 Flo
20185 \bar under
20186 a
20187 \bar default
20188 t
20189 \begin_inset space ~
20190 \end_inset
20191
20192 Settings
20193 \change_unchanged
20194
20195 \family default
20196 .
20197 \end_layout
20198
20199 \begin_layout Subsubsection
20200 Basics
20201 \end_layout
20202
20203 \begin_layout Standard
20204 If you want to have 2
20205 \begin_inset space ~
20206 \end_inset
20207
20208 columns in your text,
20209  insert a multicolumn inset via the menu
20210 \family sans
20211 Insert\SpecialChar menuseparator
20212 Custom
20213 \begin_inset space ~
20214 \end_inset
20215
20216 Insets\SpecialChar menuseparator
20217 Multiple
20218 \begin_inset space ~
20219 \end_inset
20220
20221 Columns
20222 \family default
20223  where the columns should start.
20224  Write all text that should be printed in 2
20225 \begin_inset space ~
20226 \end_inset
20227
20228 columns into this inset.
20229 \end_layout
20230
20231 \begin_layout Standard
20232 Here is an example:
20233 \end_layout
20234
20235 \begin_layout Standard
20236 \noindent
20237 \begin_inset Flex Multiple Columns
20238 status open
20239
20240 \begin_layout Plain Layout
20241 \noindent
20242
20243 \series bold
20244 \size small
20245 The Adventure of the Empty House
20246 \series default
20247
20248 \begin_inset Newline newline
20249 \end_inset
20250
20251 by Sir Arthur Conan Doyle
20252 \end_layout
20253
20254 \begin_layout Plain Layout
20255
20256 \size small
20257 It was in the spring of the year 1894 that all London was interested,
20258  and the fashionable world dismayed,
20259  by the murder of the Honourable Ronald Adair under most unusual and inexplicable circumstances.
20260  The public has already learned those particulars of the crime which came out in the police investigation,
20261  but a good deal was suppressed upon that occasion,
20262  since the case for the prosecution was so overwhelmingly strong that it was not necessary to bring forward all the facts.
20263  Only now,
20264  at the end of nearly ten years,
20265  am I allowed to supply those missing links which make up the whole of that remarkable chain.
20266  The crime was of interest in itself,
20267  but that interest was as nothing to me compared to the inconceivable sequel,
20268  which afforded me the greatest shock and surprise of any event in my adventurous life.
20269  Even now,
20270  after this long interval,
20271  I find myself thrilling as I think of it,
20272  and feeling once more that sudden flood of joy,
20273  amazement,
20274  and incredulity which utterly submerged my mind.
20275  Let me say to that public,
20276  which has shown some interest in those glimpses which I have occasionally given them of the thoughts and actions of a very remarkable man,
20277  that they are not to blame me if I have not shared my knowledge with them,
20278  for I should have considered it my first duty to do so,
20279  had I not been barred by a positive prohibition from his own lips,
20280  which was only withdrawn upon the third of last month.
20281 \end_layout
20282
20283 \end_inset
20284
20285
20286 \end_layout
20287
20288 \begin_layout Standard
20289 To get 3 or more columns,
20290  set the cursor into the multicolumn inset and use the menu
20291 \family sans
20292 Insert\SpecialChar menuseparator
20293 Number
20294 \begin_inset space ~
20295 \end_inset
20296
20297 of
20298 \begin_inset space ~
20299 \end_inset
20300
20301 Columns
20302 \family default
20303 .
20304  The number of the desired columns is written into that inset (for 3
20305 \begin_inset space ~
20306 \end_inset
20307
20308 columns write
20309 \begin_inset Quotes eld
20310 \end_inset
20311
20312 3
20313 \begin_inset Quotes erd
20314 \end_inset
20315
20316 ).
20317 \begin_inset Newline newline
20318 \end_inset
20319
20320 Here is an example with 3
20321 \begin_inset space ~
20322 \end_inset
20323
20324 columns:
20325 \end_layout
20326
20327 \begin_layout Standard
20328 \begin_inset Flex Multiple Columns
20329 status open
20330
20331 \begin_layout Plain Layout
20332
20333 \size footnotesize
20334 \begin_inset Argument 1
20335 status open
20336
20337 \begin_layout Plain Layout
20338
20339 3
20340 \end_layout
20341
20342 \end_inset
20343
20344 It can be imagined that my close intimacy with Sherlock Holmes had interested me deeply in crime,
20345  and that after his disappearance I never failed to read with care the various problems which came before the public.
20346  And I even attempted,
20347  more than once,
20348  for my own private satisfaction,
20349  to employ his methods in their solution,
20350  though with indifferent success.
20351  There was none,
20352  however,
20353  which appealed to me like this tragedy of Ronald Adair.
20354  As I read the evidence at the inquest,
20355  which led up to a verdict of willful murder against some person or persons unknown,
20356  I realized more clearly than I had ever done the loss which the community had sustained by the death of Sherlock Holmes.
20357  There were points about this strange business which would,
20358  I was sure,
20359  have specially appealed to him,
20360  and the efforts of the police would have been supplemented,
20361  or more probably anticipated,
20362  by the trained observation and the alert mind of the first criminal agent in Europe.
20363  All day,
20364  as I drove upon my round,
20365  I turned over the case in my mind and found no explanation which appeared to me to be adequate.
20366  At the risk of telling a twice-told tale,
20367  I will recapitulate the facts as they were known to the public at the conclusion of the inquest.
20368 \end_layout
20369
20370 \end_inset
20371
20372
20373 \end_layout
20374
20375 \begin_layout Standard
20376 You can have up to 10
20377 \begin_inset space ~
20378 \end_inset
20379
20380 columns if you want to,
20381  but that might not be very pleasant for the readers of your document.
20382 \end_layout
20383
20384 \begin_layout Standard
20385
20386 \change_deleted 564990737 1672236245
20387 \begin_inset Newpage newpage
20388 \end_inset
20389
20390
20391 \change_unchanged
20392
20393 \end_layout
20394
20395 \begin_layout Subsubsection
20396 Columns inside Columns
20397 \end_layout
20398
20399 \begin_layout Standard
20400 You can also have columns inside columns:
20401 \end_layout
20402
20403 \begin_layout Standard
20404 \begin_inset Flex Multiple Columns
20405 status open
20406
20407 \begin_layout Plain Layout
20408
20409 \size footnotesize
20410 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
20411  at that time governor of one of the Australian colonies.
20412  Adair's mother had returned from Australia to undergo the operation for cataract,
20413  and she,
20414  her son Ronald,
20415  and her daughter Hilda were living together at 427 Park Lane.
20416 \end_layout
20417
20418 \begin_layout Plain Layout
20419 \begin_inset Flex Multiple Columns
20420 status open
20421
20422 \begin_layout Plain Layout
20423
20424 \size footnotesize
20425 The youth moved in the best society
20426 \begin_inset space ~
20427 \end_inset
20428
20429 – had,
20430  so far as was known,
20431  no enemies and no particular vices.
20432  He had been engaged to Miss Edith Woodley,
20433  of Carstairs,
20434  but the engagement had been broken off by mutual consent some months before,
20435  and there was no sign that it had left any very profound feeling behind it.
20436  For the rest {sic} the man's life moved in a narrow and conventional circle,
20437  for his habits were quiet and his nature unemotional.
20438  Yet it was upon this easy-going young aristocrat that death came,
20439  in most strange and unexpected form,
20440  between the hours of ten and eleven-twenty on the night of March 30,
20441  1894.
20442 \end_layout
20443
20444 \end_inset
20445
20446
20447 \end_layout
20448
20449 \begin_layout Plain Layout
20450
20451 \size footnotesize
20452 Ronald Adair was fond of cards
20453 \begin_inset space ~
20454 \end_inset
20455
20456 – playing continually,
20457  but never for such stakes as would hurt him.
20458  He was a member of the Baldwin,
20459  the Cavendish,
20460  and the Bagatelle card clubs.
20461  It was shown that,
20462  after dinner on the day of his death,
20463  he had played a rubber of whist at the latter club.
20464  He had also played there in the afternoon.
20465
20466 \size default
20467
20468 \size footnotesize
20469 The evidence of those who had played with him
20470 \begin_inset space ~
20471 \end_inset
20472
20473 – Mr.
20474  Murray,
20475  Sir John Hardy,
20476  and Colonel Moran
20477 \begin_inset space ~
20478 \end_inset
20479
20480 – showed that the game was whist,
20481  and that there was a fairly equal fall of the cards.
20482  Adair might have lost five pounds,
20483  but not more.
20484  His fortune was a considerable one,
20485  and such a loss could not in any way affect him.
20486  He had played nearly every day at one club or other,
20487  but he was a cautious player,
20488  and usually rose a winner.
20489  It came out in evidence that,
20490  in partnership with Colonel Moran,
20491  he had actually won as much as four hundred and twenty pounds in a sitting,
20492  some weeks before,
20493  from Godfrey Milner and Lord Balmoral.
20494  So much for his recent history as it came out at the inquest.
20495 \end_layout
20496
20497 \end_inset
20498
20499
20500 \end_layout
20501
20502 \begin_layout Subsubsection
20503 Advanced Examples
20504 \end_layout
20505
20506 \begin_layout Standard
20507 The examples in this section show some more special features of multiple columns.
20508 \end_layout
20509
20510 \begin_layout Standard
20511 For more features of multiple columns,
20512  have a look at the
20513 \begin_inset CommandInset href
20514 LatexCommand href
20515 name "documentation"
20516 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
20517 literal "false"
20518
20519 \end_inset
20520
20521  of the \SpecialChar LaTeX
20522 -package
20523 \begin_inset Flex Code
20524 status collapsed
20525
20526 \begin_layout Plain Layout
20527 multicol
20528 \end_layout
20529
20530 \end_inset
20531
20532 .
20533 \end_layout
20534
20535 \begin_layout Paragraph
20536 Preface
20537 \end_layout
20538
20539 \begin_layout Standard
20540 To add a preface text for multiple columns,
20541  set the cursor into the multicolumn inset and use the menu
20542 \family sans
20543 Insert\SpecialChar menuseparator
20544 Preface
20545 \family default
20546 .
20547  Write your preface text into that inset.
20548 \begin_inset Newline newline
20549 \end_inset
20550
20551 This is an example with some preface text:
20552 \end_layout
20553
20554 \begin_layout Standard
20555 \begin_inset VSpace bigskip
20556 \end_inset
20557
20558
20559 \end_layout
20560
20561 \begin_layout Standard
20562 \begin_inset Flex Multiple Columns
20563 status open
20564
20565 \begin_layout Plain Layout
20566 \begin_inset Argument 2
20567 status open
20568
20569 \begin_layout Plain Layout
20570 And the story continues and continues and continues and continues\SpecialChar ldots
20571
20572 \end_layout
20573
20574 \end_inset
20575
20576
20577 \size small
20578 On the evening of the crime,
20579  he returned from the club exactly at ten.
20580  His mother and sister were out spending the evening with a relation.
20581  The servant deposed that she heard him enter the front room on the second floor,
20582  generally used as his sitting-room.
20583  She had lit a fire there,
20584  and as it smoked she had opened the window.
20585  No sound was heard from the room until eleven-twenty,
20586  the hour of the return of Lady Maynooth and her daughter.
20587  Desiring to say good-night,
20588  she attempted to enter her son's room.
20589  The door was locked on the inside,
20590  and no answer could be got to their cries and knocking.
20591  Help was obtained,
20592  and the door forced.
20593  The unfortunate young man was found lying near the table.
20594  His head had been horribly mutilated by an expanding revolver bullet,
20595  but no weapon of any sort was to be found in the room.
20596 \end_layout
20597
20598 \end_inset
20599
20600
20601 \end_layout
20602
20603 \begin_layout Standard
20604 You can also use a section heading as the preface if you use a section command as \SpecialChar TeX
20605  Code.
20606  For example the command
20607 \end_layout
20608
20609 \begin_layout LyX-Code
20610
20611 \backslash
20612 subsection{subsection title}
20613 \end_layout
20614
20615 \begin_layout Standard
20616 creates a subsection.
20617  In this example the preface is a subsubsection:
20618 \end_layout
20619
20620 \begin_layout Standard
20621 \begin_inset Flex Multiple Columns
20622 status open
20623
20624 \begin_layout Plain Layout
20625 \begin_inset Argument 2
20626 status open
20627
20628 \begin_layout Plain Layout
20629 \begin_inset ERT
20630 status collapsed
20631
20632 \begin_layout Plain Layout
20633
20634
20635 \backslash
20636 subsubsection{
20637 \end_layout
20638
20639 \end_inset
20640
20641 This is a subsubsection heading as a preface
20642 \begin_inset ERT
20643 status collapsed
20644
20645 \begin_layout Plain Layout
20646
20647 }
20648 \end_layout
20649
20650 \end_inset
20651
20652
20653 \end_layout
20654
20655 \end_inset
20656
20657
20658 \size small
20659 A minute examination of the circumstances served only to make the case more complex.
20660  In the first place,
20661  no reason could be given why the young man should have fastened the door upon the inside.
20662  There was the possibility that the murderer had done this,
20663  and had afterwards escaped by the window.
20664  The drop was at least twenty feet,
20665  however,
20666  and a bed of crocuses in full bloom lay beneath.
20667  Neither the flowers nor the earth showed any sign of having been disturbed,
20668  nor were there any marks upon the narrow strip of grass which separated the house from the road.
20669  Apparently,
20670  therefore,
20671  it was the young man himself who had fastened the door.
20672  But how did he come by his death?
20673  No one could have climbed up to the window without leaving traces.
20674  Suppose a man had fired through the window,
20675  he would indeed be a remarkable shot who could with a revolver inflict so deadly a wound.
20676  Again,
20677  Park Lane is a frequented thoroughfare;
20678  there is a cab stand within a hundred yards of the house.
20679  No one had heard a shot.
20680 \end_layout
20681
20682 \end_inset
20683
20684
20685 \end_layout
20686
20687 \begin_layout Standard
20688 If there is less vertical space than 6
20689 \begin_inset space ~
20690 \end_inset
20691
20692 text lines is left on the page at the beginning of the multiple columns,
20693  a page break will be inserted before the multiple columns.
20694  Depending on the number of lines of the preface text,
20695  you might want to change this space.
20696  This is done by setting the cursor into the mulitcolumn inset behind the preface (if there is any) and using the menu
20697 \family sans
20698 Insert\SpecialChar menuseparator
20699 Space
20700 \begin_inset space ~
20701 \end_inset
20702
20703 Before
20704 \begin_inset space ~
20705 \end_inset
20706
20707 Page
20708 \begin_inset space ~
20709 \end_inset
20710
20711 Break
20712 \family default
20713 .
20714  Insert into that inset the amount of space like e.
20715 \begin_inset space \thinspace{}
20716 \end_inset
20717
20718 g.
20719 \begin_inset space \space{}
20720 \end_inset
20721
20722
20723 \begin_inset Quotes eld
20724 \end_inset
20725
20726 5cm
20727 \begin_inset Quotes erd
20728 \end_inset
20729
20730 .
20731 \begin_inset Newline newline
20732 \end_inset
20733
20734 In this example the space is set to 7
20735 \begin_inset space ~
20736 \end_inset
20737
20738 text lines by using
20739 \begin_inset Flex Code
20740 status collapsed
20741
20742 \begin_layout Plain Layout
20743 7
20744 \backslash
20745 baselineskip
20746 \end_layout
20747
20748 \end_inset
20749
20750  (where the command
20751 \begin_inset Flex Code
20752 status collapsed
20753
20754 \begin_layout Plain Layout
20755
20756 \backslash
20757 baselineskip
20758 \end_layout
20759
20760 \end_inset
20761
20762  needs to be inserted as \SpecialChar TeX
20763  code):
20764 \end_layout
20765
20766 \begin_layout Standard
20767 \begin_inset Flex Multiple Columns
20768 status open
20769
20770 \begin_layout Plain Layout
20771 \begin_inset Argument 3
20772 status open
20773
20774 \begin_layout Plain Layout
20775 7
20776 \begin_inset ERT
20777 status collapsed
20778
20779 \begin_layout Plain Layout
20780
20781
20782 \backslash
20783 baselineskip
20784 \end_layout
20785
20786 \end_inset
20787
20788
20789 \end_layout
20790
20791 \end_inset
20792
20793
20794 \size small
20795 On the evening of the crime,
20796  he returned from the club exactly at ten.
20797  His mother and sister were out spending the evening with a relation.
20798  The servant deposed that she heard him enter the front room on the second floor,
20799  generally used as his sitting-room.
20800  She had lit a fire there,
20801  and as it smoked she had opened the window.
20802  No sound was heard from the room until eleven-twenty,
20803  the hour of the return of Lady Maynooth and her daughter.
20804  Desiring to say good-night,
20805  she attempted to enter her son's room.
20806  The door was locked on the inside,
20807  and no answer could be got to their cries and knocking.
20808  Help was obtained,
20809  and the door forced.
20810  The unfortunate young man was found lying near the table.
20811  His head had been horribly mutilated by an expanding revolver bullet,
20812  but no weapon of any sort was to be found in the room.
20813 \end_layout
20814
20815 \end_inset
20816
20817
20818 \end_layout
20819
20820 \begin_layout Paragraph
20821 Surrounding Space
20822 \end_layout
20823
20824 \begin_layout Standard
20825 The amount of space before and after multiple columns can be changed by changing the length
20826 \begin_inset Flex Code
20827 status collapsed
20828
20829 \begin_layout Plain Layout
20830
20831 \backslash
20832 multicolsep
20833 \end_layout
20834
20835 \end_inset
20836
20837 .
20838  For example the command
20839 \end_layout
20840
20841 \begin_layout LyX-Code
20842
20843 \backslash
20844 setlength{
20845 \backslash
20846 multicolsep}{3cm}
20847 \end_layout
20848
20849 \begin_layout Standard
20850 in \SpecialChar TeX
20851  Code changes its value to 3
20852 \begin_inset space \thinspace{}
20853 \end_inset
20854
20855 cm.
20856  The change must be made before the multiple columns' start.
20857  The predefined value is 13
20858 \begin_inset space \thinspace{}
20859 \end_inset
20860
20861 pt.
20862 \end_layout
20863
20864 \begin_layout Standard
20865 For this example
20866 \begin_inset Flex Code
20867 status collapsed
20868
20869 \begin_layout Plain Layout
20870
20871 \backslash
20872 multicolsep
20873 \end_layout
20874
20875 \end_inset
20876
20877  was set to 2.5
20878 \begin_inset space \thinspace{}
20879 \end_inset
20880
20881 cm:
20882 \end_layout
20883
20884 \begin_layout Standard
20885 \begin_inset ERT
20886 status open
20887
20888 \begin_layout Plain Layout
20889
20890
20891 \backslash
20892 setlength{
20893 \backslash
20894 multicolsep}{2.5cm}
20895 \end_layout
20896
20897 \end_inset
20898
20899
20900 \end_layout
20901
20902 \begin_layout Standard
20903 \begin_inset Flex Multiple Columns
20904 status open
20905
20906 \begin_layout Plain Layout
20907
20908 \size small
20909 All day I turned these facts over in my mind,
20910  endeavouring to hit upon some theory which could reconcile them all,
20911  and to find that line of least resistance which my poor friend had declared to be the starting-point of every investigation.
20912  I confess that I made little progress.
20913  In the evening I strolled across the Park,
20914  and found myself about six o'clock at the Oxford Street end of Park Lane.
20915  A group of loafers upon the pavements,
20916  all staring up at a particular window,
20917  directed me to the house which I had come to see.
20918  A tall,
20919  thin man with coloured glasses,
20920  whom I strongly suspected of being a plain-clothes detective,
20921  was pointing out some theory of his own,
20922  while the others crowded round to listen to what he said.
20923  I got as near him as I could,
20924  but his observations seemed to me to be absurd,
20925  so I withdrew again in some disgust.
20926  As I did so I struck against an elderly,
20927  deformed man,
20928  who had been behind me,
20929  and I knocked down several books which he was carrying.
20930 \end_layout
20931
20932 \end_inset
20933
20934
20935 \end_layout
20936
20937 \begin_layout Standard
20938 \begin_inset Note Greyedout
20939 status open
20940
20941 \begin_layout Plain Layout
20942
20943 \series bold
20944 Note:
20945
20946 \series default
20947  The values you set with
20948 \begin_inset Flex Code
20949 status collapsed
20950
20951 \begin_layout Plain Layout
20952
20953 \backslash
20954 setlength
20955 \end_layout
20956
20957 \end_inset
20958
20959  will be used for all following multiple columns until you change them again.
20960 \end_layout
20961
20962 \end_inset
20963
20964
20965 \end_layout
20966
20967 \begin_layout Standard
20968 \begin_inset ERT
20969 status collapsed
20970
20971 \begin_layout Plain Layout
20972
20973
20974 \backslash
20975 setlength{
20976 \backslash
20977 multicolsep}{13pt}
20978 \end_layout
20979
20980 \end_inset
20981
20982
20983 \begin_inset Note Note
20984 status collapsed
20985
20986 \begin_layout Plain Layout
20987 go back to the default
20988 \end_layout
20989
20990 \end_inset
20991
20992
20993 \end_layout
20994
20995 \begin_layout Standard
20996
20997 \change_deleted 564990737 1672236355
20998 \begin_inset Newpage newpage
20999 \end_inset
21000
21001
21002 \change_unchanged
21003
21004 \end_layout
21005
21006 \begin_layout Paragraph
21007 Column Breaks
21008 \end_layout
21009
21010 \begin_layout Standard
21011 A column break can be forced by inserting the command
21012 \begin_inset Flex Code
21013 status collapsed
21014
21015 \begin_layout Plain Layout
21016
21017 \backslash
21018 columnbreak{}
21019 \end_layout
21020
21021 \end_inset
21022
21023  as \SpecialChar TeX
21024  Code to that position in the text where the column should be broken.
21025  Note that this leads in most cases to whitespace in the text.
21026 \begin_inset Newline newline
21027 \end_inset
21028
21029 Here is an example:
21030 \end_layout
21031
21032 \begin_layout Standard
21033 \begin_inset Flex Multiple Columns
21034 status open
21035
21036 \begin_layout Plain Layout
21037
21038 \size small
21039 \begin_inset Quotes eld
21040 \end_inset
21041
21042 You're surprised to see me,
21043  sir,
21044 \begin_inset Quotes erd
21045 \end_inset
21046
21047  said he,
21048  in a strange,
21049  croaking voice.
21050 \end_layout
21051
21052 \begin_layout Plain Layout
21053
21054 \size small
21055 I acknowledged that I was.
21056 \end_layout
21057
21058 \begin_layout Plain Layout
21059
21060 \size small
21061 \begin_inset Quotes eld
21062 \end_inset
21063
21064 Well,
21065  I've a conscience,
21066  sir,
21067  and when I chanced to see you go into this house,
21068  as I came hobbling after you,
21069  I thought to myself,
21070  I'll just step in and see that kind gentleman,
21071  and tell him that if I was a bit gruff in my manner there was not any harm meant,
21072  and that I am much obliged to him for picking up my books.
21073 \begin_inset Quotes erd
21074 \end_inset
21075
21076
21077 \end_layout
21078
21079 \begin_layout Plain Layout
21080
21081 \size small
21082 \begin_inset Quotes eld
21083 \end_inset
21084
21085 You make too much of a trifle,
21086 \begin_inset Quotes erd
21087 \end_inset
21088
21089  said I.
21090
21091 \begin_inset Quotes eld
21092 \end_inset
21093
21094 May I ask how you knew who I was?
21095 \begin_inset Quotes erd
21096 \end_inset
21097
21098  AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
21099 \begin_inset ERT
21100 status collapsed
21101
21102 \begin_layout Plain Layout
21103
21104
21105 \backslash
21106 columnbreak{}
21107 \end_layout
21108
21109 \end_inset
21110
21111
21112 \end_layout
21113
21114 \begin_layout Plain Layout
21115
21116 \size small
21117 \begin_inset Quotes eld
21118 \end_inset
21119
21120 Well,
21121  sir,
21122  if it isn't too great a liberty,
21123  I am a neighbour of yours,
21124  for you'll find my little bookshop at the corner of Church Street,
21125  and very happy to see you,
21126  I am sure.
21127  Maybe you collect yourself,
21128  sir.
21129  Here's
21130 \noun on
21131 British
21132 \begin_inset space ~
21133 \end_inset
21134
21135 Birds
21136 \noun default
21137 ,
21138  and
21139 \noun on
21140 Catullus
21141 \noun default
21142 ,
21143  and
21144 \noun on
21145 The Holy War
21146 \noun default
21147
21148 \begin_inset space ~
21149 \end_inset
21150
21151 – a bargain,
21152  every one of them.
21153  With five volumes you could just fill that gap on that second shelf.
21154  It looks untidy,
21155  does it not,
21156  sir?
21157 \begin_inset Quotes erd
21158 \end_inset
21159
21160
21161 \end_layout
21162
21163 \end_inset
21164
21165
21166 \end_layout
21167
21168 \begin_layout Paragraph
21169 Column Separation
21170 \end_layout
21171
21172 \begin_layout Standard
21173 The width of the columns is automatically calculated,
21174  but you can modify the space between the columns.
21175  This is done by changing the length
21176 \begin_inset Flex Code
21177 status collapsed
21178
21179 \begin_layout Plain Layout
21180
21181 \backslash
21182 columnsep
21183 \end_layout
21184
21185 \end_inset
21186
21187 .
21188  Its predefined value is 10
21189 \begin_inset space \thinspace{}
21190 \end_inset
21191
21192 pt.
21193  Here is an example where
21194 \begin_inset Flex Code
21195 status collapsed
21196
21197 \begin_layout Plain Layout
21198
21199 \backslash
21200 columnsep
21201 \end_layout
21202
21203 \end_inset
21204
21205  is set to 3
21206 \begin_inset space \thinspace{}
21207 \end_inset
21208
21209 cm:
21210 \end_layout
21211
21212 \begin_layout Standard
21213 \begin_inset ERT
21214 status open
21215
21216 \begin_layout Plain Layout
21217
21218
21219 \backslash
21220 setlength{
21221 \backslash
21222 columnsep}{3cm}
21223 \end_layout
21224
21225 \end_inset
21226
21227
21228 \end_layout
21229
21230 \begin_layout Standard
21231 \begin_inset Flex Multiple Columns
21232 status open
21233
21234 \begin_layout Plain Layout
21235
21236 \size small
21237 My observations of No.
21238 \begin_inset space \space{}
21239 \end_inset
21240
21241 427 Park Lane did little to clear up the problem in which I was interested.
21242  The house was separated from the street by a low wall and railing,
21243  the whole not more than five feet high.
21244  It was perfectly easy,
21245  therefore,
21246  for anyone to get into the garden,
21247  but the window was entirely inaccessible,
21248  since there was no water pipe or anything which could help the most active man to climb it.
21249  More puzzled than ever,
21250  I retraced my steps to Kensington.
21251  I had not been in my study five minutes when the maid entered to say that a person desired to see me.
21252  To my astonishment it was none other than my strange old book collector,
21253  his sharp,
21254  wizened face peering out from a frame of white hair,
21255  and his precious volumes,
21256  a dozen of them at least,
21257  wedged under his right arm.
21258 \end_layout
21259
21260 \end_inset
21261
21262
21263 \end_layout
21264
21265 \begin_layout Standard
21266 \begin_inset ERT
21267 status collapsed
21268
21269 \begin_layout Plain Layout
21270
21271
21272 \backslash
21273 setlength{
21274 \backslash
21275 columnsep}{10pt}
21276 \end_layout
21277
21278 \end_inset
21279
21280
21281 \begin_inset Note Note
21282 status collapsed
21283
21284 \begin_layout Plain Layout
21285 go back to the default
21286 \end_layout
21287
21288 \end_inset
21289
21290
21291 \end_layout
21292
21293 \begin_layout Paragraph
21294 Vertical Lines
21295 \end_layout
21296
21297 \begin_layout Standard
21298 Between the columns a rule with a width of the length
21299 \begin_inset Flex Code
21300 status collapsed
21301
21302 \begin_layout Plain Layout
21303
21304 \backslash
21305 columnseprule
21306 \end_layout
21307
21308 \end_inset
21309
21310  is placed.
21311  If this rule width is set to 0
21312 \begin_inset space \thinspace{}
21313 \end_inset
21314
21315 pt (this is the default),
21316  the rule is suppressed.
21317  In the following example the rule is 2
21318 \begin_inset space \thinspace{}
21319 \end_inset
21320
21321 pt wide:
21322 \end_layout
21323
21324 \begin_layout Standard
21325 \begin_inset ERT
21326 status open
21327
21328 \begin_layout Plain Layout
21329
21330
21331 \backslash
21332 setlength{
21333 \backslash
21334 columnseprule}{2pt}
21335 \end_layout
21336
21337 \end_inset
21338
21339
21340 \end_layout
21341
21342 \begin_layout Standard
21343 \begin_inset Flex Multiple Columns
21344 status open
21345
21346 \begin_layout Plain Layout
21347
21348 \size small
21349 \begin_inset Quotes eld
21350 \end_inset
21351
21352 You're surprised to see me,
21353  sir,
21354 \begin_inset Quotes erd
21355 \end_inset
21356
21357  said he,
21358  in a strange,
21359  croaking voice.
21360 \end_layout
21361
21362 \begin_layout Plain Layout
21363
21364 \size small
21365 I acknowledged that I was.
21366 \end_layout
21367
21368 \begin_layout Plain Layout
21369
21370 \size small
21371 \begin_inset Quotes eld
21372 \end_inset
21373
21374 Well,
21375  I've a conscience,
21376  sir,
21377  and when I chanced to see you go into this house,
21378  as I came hobbling after you,
21379  I thought to myself,
21380  I'll just step in and see that kind gentleman,
21381  and tell him that if I was a bit gruff in my manner there was not any harm meant,
21382  and that I am much obliged to him for picking up my books.
21383 \begin_inset Quotes erd
21384 \end_inset
21385
21386
21387 \end_layout
21388
21389 \begin_layout Plain Layout
21390
21391 \size small
21392 \begin_inset Quotes eld
21393 \end_inset
21394
21395 You make too much of a trifle,
21396 \begin_inset Quotes erd
21397 \end_inset
21398
21399  said I.
21400
21401 \begin_inset Quotes eld
21402 \end_inset
21403
21404 May I ask how you knew who I was?
21405 \begin_inset Quotes erd
21406 \end_inset
21407
21408
21409 \end_layout
21410
21411 \begin_layout Plain Layout
21412
21413 \size small
21414 \begin_inset Quotes eld
21415 \end_inset
21416
21417 Well,
21418  sir,
21419  if it isn't too great a liberty,
21420  I am a neighbour of yours,
21421  for you'll find my little bookshop at the corner of Church Street,
21422  and very happy to see you,
21423  I am sure.
21424  Maybe you collect yourself,
21425  sir.
21426  Here's
21427 \noun on
21428 British
21429 \begin_inset space ~
21430 \end_inset
21431
21432 Birds
21433 \noun default
21434 ,
21435  and
21436 \noun on
21437 Catullus
21438 \noun default
21439 ,
21440  and
21441 \noun on
21442 The Holy War
21443 \noun default
21444
21445 \begin_inset space ~
21446 \end_inset
21447
21448 – a bargain,
21449  every one of them.
21450  With five volumes you could just fill that gap on that second shelf.
21451  It looks untidy,
21452  does it not,
21453  sir?
21454 \begin_inset Quotes erd
21455 \end_inset
21456
21457
21458 \end_layout
21459
21460 \end_inset
21461
21462
21463 \end_layout
21464
21465 \begin_layout Standard
21466 \begin_inset VSpace defskip
21467 \end_inset
21468
21469
21470 \end_layout
21471
21472 \begin_layout Standard
21473 The rule can be colored by redefining the command
21474 \begin_inset Flex Code
21475 status collapsed
21476
21477 \begin_layout Plain Layout
21478
21479 \backslash
21480 columnseprulecolor
21481 \end_layout
21482
21483 \end_inset
21484
21485 .
21486  This is done by inserting the command
21487 \end_layout
21488
21489 \begin_layout LyX-Code
21490
21491 \backslash
21492 renewcommand{
21493 \backslash
21494 columnseprulecolor}{
21495 \backslash
21496 color{red}}
21497 \end_layout
21498
21499 \begin_layout Standard
21500 as \SpecialChar TeX
21501  Code before the multicolumn inset.
21502  Replace
21503 \begin_inset Flex Code
21504 status collapsed
21505
21506 \begin_layout Plain Layout
21507 red
21508 \end_layout
21509
21510 \end_inset
21511
21512  in this command by a color of your choice.
21513  You can use all pre- and self-defined colors.
21514  See the
21515 \emph on
21516 EmbeddedObjects
21517 \emph default
21518  manual,
21519  section
21520 \emph on
21521 Colored
21522 \begin_inset space ~
21523 \end_inset
21524
21525 Tables
21526 \emph default
21527  for more information about pre- and self-defined colors.
21528  To go back to the default color insert the command
21529 \end_layout
21530
21531 \begin_layout LyX-Code
21532
21533 \backslash
21534 renewcommand{
21535 \backslash
21536 columnseprulecolor}{
21537 \backslash
21538 normalcolor}
21539 \end_layout
21540
21541 \begin_layout Standard
21542 Here is the example with a cyan rule and 1
21543 \begin_inset space \thinspace{}
21544 \end_inset
21545
21546 cm column separation:
21547 \end_layout
21548
21549 \begin_layout Standard
21550 \begin_inset ERT
21551 status open
21552
21553 \begin_layout Plain Layout
21554
21555
21556 \backslash
21557 setlength{
21558 \backslash
21559 columnsep}{1cm}
21560 \end_layout
21561
21562 \begin_layout Plain Layout
21563
21564
21565 \backslash
21566 renewcommand{
21567 \backslash
21568 columnseprulecolor}{
21569 \backslash
21570 color{cyan}}
21571 \end_layout
21572
21573 \end_inset
21574
21575
21576 \end_layout
21577
21578 \begin_layout Standard
21579 \begin_inset Flex Multiple Columns
21580 status open
21581
21582 \begin_layout Plain Layout
21583
21584 \size small
21585 \begin_inset Quotes eld
21586 \end_inset
21587
21588 You're surprised to see me,
21589  sir,
21590 \begin_inset Quotes erd
21591 \end_inset
21592
21593  said he,
21594  in a strange,
21595  croaking voice.
21596 \end_layout
21597
21598 \begin_layout Plain Layout
21599
21600 \size small
21601 I acknowledged that I was.
21602 \end_layout
21603
21604 \begin_layout Plain Layout
21605
21606 \size small
21607 \begin_inset Quotes eld
21608 \end_inset
21609
21610 Well,
21611  I've a conscience,
21612  sir,
21613  and when I chanced to see you go into this house,
21614  as I came hobbling after you,
21615  I thought to myself,
21616  I'll just step in and see that kind gentleman,
21617  and tell him that if I was a bit gruff in my manner there was not any harm meant,
21618  and that I am much obliged to him for picking up my books.
21619 \begin_inset Quotes erd
21620 \end_inset
21621
21622
21623 \end_layout
21624
21625 \begin_layout Plain Layout
21626
21627 \size small
21628 \begin_inset Quotes eld
21629 \end_inset
21630
21631 You make too much of a trifle,
21632 \begin_inset Quotes erd
21633 \end_inset
21634
21635  said I.
21636
21637 \begin_inset Quotes eld
21638 \end_inset
21639
21640 May I ask how you knew who I was?
21641 \begin_inset Quotes erd
21642 \end_inset
21643
21644
21645 \end_layout
21646
21647 \begin_layout Plain Layout
21648
21649 \size small
21650 \begin_inset Quotes eld
21651 \end_inset
21652
21653 Well,
21654  sir,
21655  if it isn't too great a liberty,
21656  I am a neighbour of yours,
21657  for you'll find my little bookshop at the corner of Church Street,
21658  and very happy to see you,
21659  I am sure.
21660  Maybe you collect yourself,
21661  sir.
21662  Here's
21663 \noun on
21664 British
21665 \begin_inset space ~
21666 \end_inset
21667
21668 Birds
21669 \noun default
21670 ,
21671  and
21672 \noun on
21673 Catullus
21674 \noun default
21675 ,
21676  and
21677 \noun on
21678 The Holy War
21679 \noun default
21680
21681 \begin_inset space ~
21682 \end_inset
21683
21684 – a bargain,
21685  every one of them.
21686  With five volumes you could just fill that gap on that second shelf.
21687  It looks untidy,
21688  does it not,
21689  sir?
21690 \begin_inset Quotes erd
21691 \end_inset
21692
21693
21694 \end_layout
21695
21696 \end_inset
21697
21698
21699 \end_layout
21700
21701 \begin_layout Standard
21702 \begin_inset ERT
21703 status collapsed
21704
21705 \begin_layout Plain Layout
21706
21707
21708 \backslash
21709 setlength{
21710 \backslash
21711 columnseprule}{0pt}
21712 \end_layout
21713
21714 \begin_layout Plain Layout
21715
21716
21717 \backslash
21718 renewcommand{
21719 \backslash
21720 columnseprulecolor}{
21721 \backslash
21722 normalcolor}
21723 \end_layout
21724
21725 \end_inset
21726
21727
21728 \begin_inset Note Note
21729 status collapsed
21730
21731 \begin_layout Plain Layout
21732 go back to the default
21733 \end_layout
21734
21735 \end_inset
21736
21737
21738 \end_layout
21739
21740 \begin_layout Section
21741
21742 \change_inserted 564990737 1671270380
21743 Paragraph Styles
21744 \end_layout
21745
21746 \begin_layout Subsection
21747
21748 \change_inserted 564990737 1671270398
21749 Custom
21750 \change_deleted 564990737 1671270396
21751 Non-standard
21752 \change_unchanged
21753  Paragraph Shapes
21754 \end_layout
21755
21756 \begin_layout Standard
21757 \noindent
21758 \SpecialChar LaTeX
21759  as well as any other text processor uses by default rectangular paragraphs.
21760  For special cases like for example posters,
21761  invitation cards or poems you can modify the paragraph shape to one of your choice.
21762
21763 \change_deleted 564990737 1672311802
21764 This can be done by using the \SpecialChar LaTeX
21765 -package
21766 \begin_inset Flex Code
21767 status collapsed
21768
21769 \begin_layout Plain Layout
21770 shapepar
21771 \end_layout
21772
21773 \end_inset
21774
21775  which is loaded by using in the document settings the module
21776 \family sans
21777 Custom paragraph shapes
21778 \family default
21779 .
21780 \change_inserted 564990737 1672311802
21781 This module uses the
21782 \family sans
21783 shapepar
21784 \family default
21785  package to provide over a dozen paragraph shapes as well as commands to define custom shapes.
21786
21787 \change_unchanged
21788
21789 \end_layout
21790
21791 \begin_layout Subsubsection
21792 Predefined shapes
21793 \end_layout
21794
21795 \begin_layout Standard
21796
21797 \series bold
21798 shapepar
21799 \series default
21800  provides the following shapes:
21801 \end_layout
21802
21803 \begin_layout Standard
21804 \begin_inset Tabular
21805 <lyxtabular version="3" rows="13" columns="3">
21806 <features booktabs="true" islongtable="true" longtabularalignment="center">
21807 <column alignment="left" valignment="middle" width="16col%">
21808 <column alignment="left" valignment="middle" width="40col%">
21809 <column alignment="left" valignment="middle" width="35col%">
21810 <row endhead="true">
21811 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21812 \begin_inset Text
21813
21814 \begin_layout Plain Layout
21815
21816 \series bold
21817 \size small
21818 Name
21819 \end_layout
21820
21821 \end_inset
21822 </cell>
21823 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21824 \begin_inset Text
21825
21826 \begin_layout Plain Layout
21827
21828 \series bold
21829 \size small
21830 Description
21831 \end_layout
21832
21833 \end_inset
21834 </cell>
21835 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21836 \begin_inset Text
21837
21838 \begin_layout Plain Layout
21839
21840 \series bold
21841 \size small
21842 Annotation
21843 \end_layout
21844
21845 \end_inset
21846 </cell>
21847 </row>
21848 <row interlinespace="default">
21849 <cell alignment="left" valignment="top" usebox="none">
21850 \begin_inset Text
21851
21852 \begin_layout Plain Layout
21853
21854 \size small
21855 CDlabel
21856 \end_layout
21857
21858 \end_inset
21859 </cell>
21860 <cell alignment="left" valignment="top" usebox="none">
21861 \begin_inset Text
21862
21863 \begin_layout Plain Layout
21864
21865 \size small
21866 Circle with circular hole (in the size of a CD/DVD)
21867 \end_layout
21868
21869 \end_inset
21870 </cell>
21871 <cell alignment="left" valignment="top" usebox="none">
21872 \begin_inset Text
21873
21874 \begin_layout Plain Layout
21875
21876 \size small
21877 Cannot be scaled,
21878  take care there is not too much text
21879 \end_layout
21880
21881 \end_inset
21882 </cell>
21883 </row>
21884 <row interlinespace="default">
21885 <cell alignment="left" valignment="top" usebox="none">
21886 \begin_inset Text
21887
21888 \begin_layout Plain Layout
21889
21890 \size small
21891 Circle
21892 \end_layout
21893
21894 \end_inset
21895 </cell>
21896 <cell alignment="left" valignment="top" usebox="none">
21897 \begin_inset Text
21898
21899 \begin_layout Plain Layout
21900
21901 \size small
21902 Circle
21903 \end_layout
21904
21905 \end_inset
21906 </cell>
21907 <cell alignment="left" valignment="top" usebox="none">
21908 \begin_inset Text
21909
21910 \begin_layout Plain Layout
21911
21912 \size small
21913 Fragile,
21914  calculation might fail
21915 \end_layout
21916
21917 \end_inset
21918 </cell>
21919 </row>
21920 <row interlinespace="default">
21921 <cell alignment="left" valignment="top" usebox="none">
21922 \begin_inset Text
21923
21924 \begin_layout Plain Layout
21925
21926 \size small
21927 Diamond
21928 \end_layout
21929
21930 \end_inset
21931 </cell>
21932 <cell alignment="left" valignment="top" usebox="none">
21933 \begin_inset Text
21934
21935 \begin_layout Plain Layout
21936
21937 \size small
21938 Rhomboid (symbolizing a
21939 \begin_inset Quotes eld
21940 \end_inset
21941
21942 diamond
21943 \begin_inset Quotes erd
21944 \end_inset
21945
21946 )
21947 \end_layout
21948
21949 \end_inset
21950 </cell>
21951 <cell alignment="left" valignment="top" usebox="none">
21952 \begin_inset Text
21953
21954 \begin_layout Plain Layout
21955
21956 \size small
21957 -
21958 \end_layout
21959
21960 \end_inset
21961 </cell>
21962 </row>
21963 <row interlinespace="default">
21964 <cell alignment="left" valignment="top" usebox="none">
21965 \begin_inset Text
21966
21967 \begin_layout Plain Layout
21968
21969 \size small
21970 Heart
21971 \end_layout
21972
21973 \end_inset
21974 </cell>
21975 <cell alignment="left" valignment="top" usebox="none">
21976 \begin_inset Text
21977
21978 \begin_layout Plain Layout
21979
21980 \size small
21981 Heart-like shape
21982 \end_layout
21983
21984 \end_inset
21985 </cell>
21986 <cell alignment="left" valignment="top" usebox="none">
21987 \begin_inset Text
21988
21989 \begin_layout Plain Layout
21990
21991 \size small
21992 -
21993 \end_layout
21994
21995 \end_inset
21996 </cell>
21997 </row>
21998 <row interlinespace="default">
21999 <cell alignment="left" valignment="top" usebox="none">
22000 \begin_inset Text
22001
22002 \begin_layout Plain Layout
22003
22004 \size small
22005 Hexagon
22006 \end_layout
22007
22008 \end_inset
22009 </cell>
22010 <cell alignment="left" valignment="top" usebox="none">
22011 \begin_inset Text
22012
22013 \begin_layout Plain Layout
22014
22015 \size small
22016 Hexagon
22017 \end_layout
22018
22019 \end_inset
22020 </cell>
22021 <cell alignment="left" valignment="top" usebox="none">
22022 \begin_inset Text
22023
22024 \begin_layout Plain Layout
22025
22026 \size small
22027 -
22028 \end_layout
22029
22030 \end_inset
22031 </cell>
22032 </row>
22033 <row interlinespace="default">
22034 <cell alignment="left" valignment="top" usebox="none">
22035 \begin_inset Text
22036
22037 \begin_layout Plain Layout
22038
22039 \size small
22040 Nut
22041 \end_layout
22042
22043 \end_inset
22044 </cell>
22045 <cell alignment="left" valignment="top" usebox="none">
22046 \begin_inset Text
22047
22048 \begin_layout Plain Layout
22049
22050 \size small
22051 Nut for bolt (hexagon with circular hole)
22052 \end_layout
22053
22054 \end_inset
22055 </cell>
22056 <cell alignment="left" valignment="top" usebox="none">
22057 \begin_inset Text
22058
22059 \begin_layout Plain Layout
22060
22061 \size small
22062 -
22063 \end_layout
22064
22065 \end_inset
22066 </cell>
22067 </row>
22068 <row interlinespace="default">
22069 <cell alignment="left" valignment="top" usebox="none">
22070 \begin_inset Text
22071
22072 \begin_layout Plain Layout
22073
22074 \size small
22075 Square
22076 \end_layout
22077
22078 \end_inset
22079 </cell>
22080 <cell alignment="left" valignment="top" usebox="none">
22081 \begin_inset Text
22082
22083 \begin_layout Plain Layout
22084
22085 \size small
22086 Square
22087 \end_layout
22088
22089 \end_inset
22090 </cell>
22091 <cell alignment="left" valignment="top" usebox="none">
22092 \begin_inset Text
22093
22094 \begin_layout Plain Layout
22095
22096 \size small
22097 -
22098 \end_layout
22099
22100 \end_inset
22101 </cell>
22102 </row>
22103 <row interlinespace="default">
22104 <cell alignment="left" valignment="top" usebox="none">
22105 \begin_inset Text
22106
22107 \begin_layout Plain Layout
22108
22109 \size small
22110 Star
22111 \end_layout
22112
22113 \end_inset
22114 </cell>
22115 <cell alignment="left" valignment="top" usebox="none">
22116 \begin_inset Text
22117
22118 \begin_layout Plain Layout
22119
22120 \size small
22121 Five-point star
22122 \end_layout
22123
22124 \end_inset
22125 </cell>
22126 <cell alignment="left" valignment="top" usebox="none">
22127 \begin_inset Text
22128
22129 \begin_layout Plain Layout
22130
22131 \size small
22132 -
22133 \end_layout
22134
22135 \end_inset
22136 </cell>
22137 </row>
22138 <row interlinespace="default">
22139 <cell alignment="left" valignment="top" usebox="none">
22140 \begin_inset Text
22141
22142 \begin_layout Plain Layout
22143
22144 \size small
22145 Candle
22146 \end_layout
22147
22148 \end_inset
22149 </cell>
22150 <cell alignment="left" valignment="top" usebox="none">
22151 \begin_inset Text
22152
22153 \begin_layout Plain Layout
22154
22155 \size small
22156 Burning candle
22157 \end_layout
22158
22159 \end_inset
22160 </cell>
22161 <cell alignment="left" valignment="top" usebox="none">
22162 \begin_inset Text
22163
22164 \begin_layout Plain Layout
22165
22166 \size small
22167 -
22168 \end_layout
22169
22170 \end_inset
22171 </cell>
22172 </row>
22173 <row interlinespace="default">
22174 <cell alignment="left" valignment="top" usebox="none">
22175 \begin_inset Text
22176
22177 \begin_layout Plain Layout
22178
22179 \size small
22180 Drop down/up
22181 \end_layout
22182
22183 \end_inset
22184 </cell>
22185 <cell alignment="left" valignment="top" usebox="none">
22186 \begin_inset Text
22187
22188 \begin_layout Plain Layout
22189
22190 \size small
22191 Normal/reversed rain drop
22192 \end_layout
22193
22194 \end_inset
22195 </cell>
22196 <cell alignment="left" valignment="top" usebox="none">
22197 \begin_inset Text
22198
22199 \begin_layout Plain Layout
22200
22201 \size small
22202 Fragile,
22203  calculation might fail
22204 \end_layout
22205
22206 \end_inset
22207 </cell>
22208 </row>
22209 <row interlinespace="default">
22210 <cell alignment="left" valignment="top" usebox="none">
22211 \begin_inset Text
22212
22213 \begin_layout Plain Layout
22214
22215 \size small
22216 \SpecialChar TeX
22217
22218 \end_layout
22219
22220 \end_inset
22221 </cell>
22222 <cell alignment="left" valignment="top" usebox="none">
22223 \begin_inset Text
22224
22225 \begin_layout Plain Layout
22226
22227 \size small
22228 The \SpecialChar TeX
22229  logo
22230 \end_layout
22231
22232 \end_inset
22233 </cell>
22234 <cell alignment="left" valignment="top" usebox="none">
22235 \begin_inset Text
22236
22237 \begin_layout Plain Layout
22238
22239 \size small
22240 -
22241 \end_layout
22242
22243 \end_inset
22244 </cell>
22245 </row>
22246 <row interlinespace="default">
22247 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
22248 \begin_inset Text
22249
22250 \begin_layout Plain Layout
22251
22252 \size small
22253 Triangle up/down/
22254 \begin_inset Newline newline
22255 \end_inset
22256
22257 left/right
22258 \end_layout
22259
22260 \end_inset
22261 </cell>
22262 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
22263 \begin_inset Text
22264
22265 \begin_layout Plain Layout
22266
22267 \size small
22268 Triangles in different orientations
22269 \end_layout
22270
22271 \end_inset
22272 </cell>
22273 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
22274 \begin_inset Text
22275
22276 \begin_layout Plain Layout
22277
22278 \size small
22279 -
22280 \end_layout
22281
22282 \end_inset
22283 </cell>
22284 </row>
22285 </lyxtabular>
22286
22287 \end_inset
22288
22289
22290 \end_layout
22291
22292 \begin_layout Standard
22293 To use a shape for your paragraph,
22294  simply select it in \SpecialChar LyX
22295 's pull-down box for environments in the toolbar.
22296 \end_layout
22297
22298 \begin_layout Standard
22299 \begin_inset Newpage newpage
22300 \end_inset
22301
22302
22303 \end_layout
22304
22305 \begin_layout Standard
22306 Here is an example paragraph in the shape of a nut:
22307 \end_layout
22308
22309 \begin_layout Standard
22310 \begin_inset VSpace bigskip
22311 \end_inset
22312
22313
22314 \end_layout
22315
22316 \begin_layout Nut
22317
22318 \lang latin
22319 Lorem ipsum dolor sit amet,
22320  consetetur sadipscing elitr,
22321  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22322  sed diam voluptua.
22323  At vero eos et accusam et justo duo dolores et ea rebum.
22324  Stet clita kasd gubergren,
22325  no sea takimata sanctus est Lorem ipsum dolor sit amet.
22326  Lorem ipsum dolor sit amet,
22327  consetetur sadipscing elitr,
22328  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22329  sed diam voluptua.
22330 \end_layout
22331
22332 \begin_layout Standard
22333 \begin_inset VSpace bigskip
22334 \end_inset
22335
22336
22337 \end_layout
22338
22339 \begin_layout Standard
22340 \begin_inset Note Greyedout
22341 status open
22342
22343 \begin_layout Plain Layout
22344
22345 \series bold
22346 Note
22347 \series default
22348 :
22349
22350 \family sans
22351 shapepar
22352 \family default
22353  paragraphs cannot run over a page break.
22354 \end_layout
22355
22356 \end_inset
22357
22358
22359 \end_layout
22360
22361 \begin_layout Standard
22362 \begin_inset VSpace bigskip
22363 \end_inset
22364
22365
22366 \end_layout
22367
22368 \begin_layout Standard
22369 The package
22370 \begin_inset Flex Code
22371 status collapsed
22372
22373 \begin_layout Plain Layout
22374 shapepar
22375 \end_layout
22376
22377 \end_inset
22378
22379  takes care that the shape will always be preserved,
22380  no matter how much text is in the paragraph.
22381  Therefore the paragraph size changes with the amount of contained text.
22382  This can lead to paragraph sizes exceeding the page margins.
22383  To demonstrate the size scaling,
22384  here is the same example paragraph but with twice as much text:
22385 \end_layout
22386
22387 \begin_layout Standard
22388 \begin_inset Newpage newpage
22389 \end_inset
22390
22391
22392 \end_layout
22393
22394 \begin_layout Nut
22395
22396 \lang latin
22397 Lorem ipsum dolor sit amet,
22398  consetetur sadipscing elitr,
22399  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22400  sed diam voluptua.
22401  At vero eos et accusam et justo duo dolores et ea rebum.
22402  Stet clita kasd gubergren,
22403  no sea takimata sanctus est Lorem ipsum dolor sit amet.
22404  Lorem ipsum dolor sit amet,
22405  consetetur sadipscing elitr,
22406  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22407  sed diam voluptua.
22408  Lorem ipsum dolor sit amet,
22409  consetetur sadipscing elitr,
22410  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22411  sed diam voluptua.
22412  At vero eos et accusam et justo duo dolores et ea rebum.
22413  Stet clita kasd gubergren,
22414  no sea takimata sanctus est Lorem ipsum dolor sit amet.
22415  Lorem ipsum dolor sit amet,
22416  consetetur sadipscing elitr,
22417  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22418  sed diam voluptua.
22419 \end_layout
22420
22421 \begin_layout Standard
22422 \begin_inset VSpace bigskip
22423 \end_inset
22424
22425
22426 \end_layout
22427
22428 \begin_layout Standard
22429 An exception is the shape
22430 \family sans
22431 CDlabel
22432 \family default
22433 .
22434  It cannot be scaled because it must fit the size of a CD/DVD.
22435  Therefore the amount of text that fits into the shape is limited.
22436 \begin_inset Newline newline
22437 \end_inset
22438
22439 The
22440 \family sans
22441 drop
22442 \family default
22443  shapes and the
22444 \family sans
22445 circle
22446 \family default
22447  shape are fragile,
22448  meaning that the calculation of their size can fail,
22449  depending on the amount of text.
22450  You will then get the \SpecialChar LaTeX
22451  error
22452 \begin_inset Quotes eld
22453 \end_inset
22454
22455 Arithmetic overflow
22456 \begin_inset Quotes erd
22457 \end_inset
22458
22459 .
22460  In this case one can try to remove or add some text;
22461  if nothing works one has to use another shape.
22462 \end_layout
22463
22464 \begin_layout Standard
22465 \begin_inset VSpace bigskip
22466 \end_inset
22467
22468
22469 \end_layout
22470
22471 \begin_layout Standard
22472 For shapes with tips you will maybe see that \SpecialChar LaTeX
22473 's hyphenation routine fails for text in the tips.
22474  Therefore it is often necessary to add hyphenation points
22475 \family sans
22476 (
22477 \begin_inset Info
22478 type  "shortcut"
22479 arg   "specialchar-insert hyphenation"
22480 \end_inset
22481
22482
22483 \family default
22484 ) to the corresponding text parts.
22485 \end_layout
22486
22487 \begin_layout Standard
22488 \begin_inset VSpace bigskip
22489 \end_inset
22490
22491
22492 \end_layout
22493
22494 \begin_layout Standard
22495 Shapepar paragraphs are either always centered or placed on the page so that their left border touches the left page margin.
22496  You can therefore not use the paragraph dialog to align such paragraphs.
22497  A solution is to put the paragraph into a minipage or parbox and align the box.
22498  The problem is hereby to find the right width for the box.
22499  Because if it is too wide and you center the box,
22500  the paragraph is not centered too because it sticks at the left side of the box.
22501  So you might have to play a bit with the width until it fits.
22502  Here are two heart-shaped paragraphs,
22503  the first one is not aligned,
22504  the second one is right-aligned:
22505 \end_layout
22506
22507 \begin_layout Standard
22508 \begin_inset Newpage newpage
22509 \end_inset
22510
22511
22512 \end_layout
22513
22514 \begin_layout Heart
22515 \noindent
22516
22517 \lang latin
22518 Lo\SpecialChar softhyphen
22519 rem ipsum dolor sit amet,
22520  consetetur sadipscing elitr,
22521  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22522  sed diam voluptua.
22523  At vero eos et accusam et justo duo dolores et ea rebum.
22524  Stet clita kasd gubergren,
22525  no sea takimata sanctus est Lorem ipsum dolor sit amet.
22526 \end_layout
22527
22528 \begin_layout Standard
22529 \begin_inset VSpace bigskip
22530 \end_inset
22531
22532
22533 \end_layout
22534
22535 \begin_layout Standard
22536 \noindent
22537 \align right
22538 \begin_inset Box Frameless
22539 position "t"
22540 hor_pos "c"
22541 has_inner_box 1
22542 inner_pos "t"
22543 use_parbox 1
22544 use_makebox 0
22545 width "42col%"
22546 special "none"
22547 height "1in"
22548 height_special "totalheight"
22549 thickness "0.4pt"
22550 separation "3pt"
22551 shadowsize "4pt"
22552 framecolor "black"
22553 backgroundcolor "none"
22554 status open
22555
22556 \begin_layout Heart
22557 \noindent
22558
22559 \lang latin
22560 Lo\SpecialChar softhyphen
22561 rem ipsum dolor sit amet,
22562  consetetur sadipscing elitr,
22563  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22564  sed diam voluptua.
22565  At vero eos et accusam et justo duo dolores et ea rebum.
22566  Stet clita kasd gubergren,
22567  no sea takimata sanctus est Lorem ipsum dolor sit amet.
22568 \end_layout
22569
22570 \end_inset
22571
22572
22573 \end_layout
22574
22575 \begin_layout Subsubsection
22576 Custom shapes
22577 \end_layout
22578
22579 \begin_layout Standard
22580 You can define any shape you want.
22581  Doing this manually is a lot of work because every coordinate must be specified.
22582  But there is a way to let the computer calculate the coordinates:
22583 \end_layout
22584
22585 \begin_layout Enumerate
22586 Install the program
22587 \begin_inset CommandInset href
22588 LatexCommand href
22589 name "Jpgfdraw"
22590 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
22591 literal "false"
22592
22593 \end_inset
22594
22595 .
22596 \end_layout
22597
22598 \begin_layout Enumerate
22599 In
22600 \family sans
22601 Jpgfdraw
22602 \family default
22603  go to the menu
22604 \family sans
22605 TeX/LaTeX\SpecialChar menuseparator
22606 Settings\SpecialChar menuseparator
22607 Set Normal Size
22608 \family default
22609  and select the font size you are using in your document.
22610  For example this document uses the size 12
22611 \begin_inset space \thinspace{}
22612 \end_inset
22613
22614 pt.
22615 \end_layout
22616
22617 \begin_layout Enumerate
22618 Draw a shape.
22619 \end_layout
22620
22621 \begin_layout Enumerate
22622 Use the menu
22623 \family sans
22624 TeX/LaTeX\SpecialChar menuseparator
22625 Shapepar
22626 \family default
22627  to export the shape to coordinates.
22628  In the appearing dialog use either the outline of your shape for the coordinates or the path itself.
22629 \begin_inset Foot
22630 status collapsed
22631
22632 \begin_layout Plain Layout
22633 For more information see
22634 \begin_inset CommandInset href
22635 LatexCommand href
22636 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
22637 literal "false"
22638
22639 \end_inset
22640
22641
22642 \end_layout
22643
22644 \end_inset
22645
22646
22647 \end_layout
22648
22649 \begin_layout Standard
22650 The coordinates are written into a \SpecialChar TeX
22651  file.
22652  To use it for your \SpecialChar LyX
22653  document
22654 \end_layout
22655
22656 \begin_layout Enumerate
22657 Place the cursor before the first character of your paragraph (or into a new empty one).
22658 \end_layout
22659
22660 \begin_layout Enumerate
22661 Open in \SpecialChar LyX
22662  the menu
22663 \family sans
22664 Insert\SpecialChar menuseparator
22665 File\SpecialChar menuseparator
22666 Child
22667 \begin_inset space ~
22668 \end_inset
22669
22670 Document
22671 \family default
22672 ,
22673  select the file and use
22674 \family sans
22675 Input
22676 \family default
22677  as
22678 \family sans
22679 Include Type.
22680 \end_layout
22681
22682 \begin_layout Standard
22683 \begin_inset VSpace defskip
22684 \end_inset
22685
22686
22687 \end_layout
22688
22689 \begin_layout Standard
22690 \begin_inset Note Greyedout
22691 status open
22692
22693 \begin_layout Plain Layout
22694
22695 \series bold
22696 Note
22697 \series default
22698 :
22699  The changed shape only applies to the current paragraph;
22700  everything is reset to normal for the next paragraph.
22701  Therefore the shape definition file must be input into every paragraph with the desired shape.
22702 \end_layout
22703
22704 \end_inset
22705
22706
22707 \end_layout
22708
22709 \begin_layout Standard
22710 \begin_inset VSpace bigskip
22711 \end_inset
22712
22713
22714 \end_layout
22715
22716 \begin_layout Standard
22717 Here is an example:
22718 \end_layout
22719
22720 \begin_layout Standard
22721 \begin_inset VSpace bigskip
22722 \end_inset
22723
22724
22725 \end_layout
22726
22727 \begin_layout Standard
22728 \begin_inset CommandInset include
22729 LatexCommand input
22730 filename "SpecialParagraphShape.tex"
22731 literal "true"
22732
22733 \end_inset
22734
22735
22736 \lang latin
22737 Lorem ipsum dolor sit amet,
22738  consetetur sadipscing elitr,
22739  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22740  sed diam voluptua.
22741  At vero eos et accusam et justo duo dolores et ea rebum.
22742  Stet clita kasd gubergren,
22743  no sea takimata sanctus est Lorem ipsum dolor sit amet.
22744  Lorem ipsum dolor sit amet,
22745  consetetur sadipscing elitr,
22746  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22747  sed diam voluptua.
22748 \end_layout
22749
22750 \begin_layout Standard
22751 \begin_inset VSpace bigskip
22752 \end_inset
22753
22754
22755 \end_layout
22756
22757 \begin_layout Standard
22758
22759 \series bold
22760 A tip:
22761
22762 \series default
22763  to draw complexer shapes in
22764 \family sans
22765 Jpgfdraw
22766 \family default
22767  you can draw the shape in a program of your choice and import the resulting image to
22768 \family sans
22769 Jpgfdraw
22770 \family default
22771 .
22772  Then you only need to draw a line or spline along the outline of the image.
22773 \end_layout
22774
22775 \begin_layout Standard
22776 \begin_inset VSpace bigskip
22777 \end_inset
22778
22779
22780 \end_layout
22781
22782 \begin_layout Standard
22783 The module
22784 \family sans
22785 Custom paragraph shapes
22786 \family default
22787  also provides the two commands
22788 \family sans
22789 shapepar
22790 \family default
22791  and
22792 \family sans
22793 Shapepar
22794 \family default
22795  which can be used to define custom shapes coordinate by coordinate.
22796 \begin_inset Foot
22797 status collapsed
22798
22799 \begin_layout Plain Layout
22800 These commands are internally used for all shapes described here.
22801 \end_layout
22802
22803 \end_inset
22804
22805  For information how these styles are used and about further customization possibilities,
22806  have a look at the
22807 \begin_inset CommandInset href
22808 LatexCommand href
22809 name "documentation"
22810 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
22811 literal "false"
22812
22813 \end_inset
22814
22815  of the package
22816 \begin_inset Flex Code
22817 status collapsed
22818
22819 \begin_layout Plain Layout
22820 shapepar
22821 \end_layout
22822
22823 \end_inset
22824
22825 .
22826 \end_layout
22827
22828 \begin_layout Subsection
22829
22830 \change_inserted 564990737 1672311925
22831 Hanging Paragraphs
22832 \end_layout
22833
22834 \begin_layout Hanging
22835
22836 \change_inserted 564990737 1672311925
22837 This module adds the
22838 \family sans
22839 Hanging
22840 \family default
22841  paragraph style,
22842  that is,
22843  one where all but the first line of the paragraph is indented.
22844  This may not appear in your \SpecialChar LyX
22845  document but will appear in the final output.
22846 \end_layout
22847
22848 \begin_layout Subsection
22849
22850 \change_inserted 564990737 1672311925
22851 \begin_inset CommandInset label
22852 LatexCommand label
22853 name "subsec:Initials"
22854
22855 \end_inset
22856
22857 Initials (Drop Caps)
22858 \end_layout
22859
22860 \begin_layout Initial
22861
22862 \change_inserted 564990737 1672311925
22863 \begin_inset Argument 2
22864 status open
22865
22866 \begin_layout Plain Layout
22867
22868 \change_inserted 564990737 1672311925
22869 T
22870 \change_unchanged
22871
22872 \end_layout
22873
22874 \end_inset
22875
22876
22877 \begin_inset Argument 3
22878 status open
22879
22880 \begin_layout Plain Layout
22881
22882 \change_inserted 564990737 1672311925
22883 his
22884 \change_unchanged
22885
22886 \end_layout
22887
22888 \end_inset
22889
22890  module adds a drop capitals paragraph style
22891 \family sans
22892 Initials
22893 \family default
22894  for paragraph environments which you can use wherever you want to have drop capitals.
22895  You then have three more items in the
22896 \family sans
22897 Insert
22898 \family default
22899  menu:
22900 \end_layout
22901
22902 \begin_layout Itemize
22903
22904 \change_inserted 564990737 1672311925
22905
22906 \family sans
22907 Initial
22908 \family default
22909  which creates an inset for the drop capital
22910 \end_layout
22911
22912 \begin_layout Itemize
22913
22914 \change_inserted 564990737 1672311925
22915
22916 \family sans
22917 Rest of initial
22918 \family default
22919  which creates an inset for the rest of the word
22920 \end_layout
22921
22922 \begin_layout Itemize
22923
22924 \change_inserted 564990737 1672311925
22925
22926 \family sans
22927 Options
22928 \family default
22929  which allow you configure the formatting of the drop capital.
22930 \end_layout
22931
22932 \begin_layout Standard
22933
22934 \change_inserted 564990737 1672311925
22935 To customize the appearance of the style,
22936  see
22937 \family sans
22938 Help\SpecialChar menuseparator
22939 Embedded Objects\SpecialChar menuseparator
22940 Objects Surrounded by Text\SpecialChar menuseparator
22941 Initials
22942 \family default
22943 .
22944 \end_layout
22945
22946 \begin_layout Section
22947
22948 \change_inserted 564990737 1672312011
22949 Text Markup
22950 \end_layout
22951
22952 \begin_layout Subsection
22953
22954 \change_inserted 564990737 1672312011
22955 Hyphenatable Text Markup
22956 \end_layout
22957
22958 \begin_layout Standard
22959
22960 \change_inserted 564990737 1672312011
22961 This package defines text styles to highlight,
22962  space-out,
22963  strike-through,
22964  underline and capitalize/small-cap text by means of the
22965 \family sans
22966 soul
22967 \family default
22968  package.
22969  As opposed to the markup provided by the Text Properties dialog,
22970  words marked-up with
22971 \family sans
22972 soul
22973 \family default
22974  are hyphenated.
22975  See the
22976 \begin_inset CommandInset href
22977 LatexCommand href
22978 name "soul documentation"
22979 target "http://mirrors.ctan.org/macros/generic/soul/soul.pdf"
22980 literal "false"
22981
22982 \end_inset
22983
22984 .
22985 \end_layout
22986
22987 \begin_layout Subsection
22988
22989 \change_inserted 564990737 1672312011
22990 Logical Markup
22991 \end_layout
22992
22993 \begin_layout Standard
22994
22995 \change_inserted 564990737 1672312011
22996 This module defines some character styles for logical markup:
22997
22998 \noun on
22999
23000 \begin_inset Flex Noun
23001 status collapsed
23002
23003 \begin_layout Plain Layout
23004
23005 \change_inserted 564990737 1672312011
23006
23007 \noun on
23008 noun
23009 \change_unchanged
23010
23011 \end_layout
23012
23013 \end_inset
23014
23015
23016 \noun default
23017 ,
23018
23019 \emph on
23020
23021 \begin_inset Flex Emph
23022 status collapsed
23023
23024 \begin_layout Plain Layout
23025
23026 \change_inserted 564990737 1672312011
23027
23028 \emph on
23029 emph
23030 \change_unchanged
23031
23032 \end_layout
23033
23034 \end_inset
23035
23036
23037 \emph default
23038 ,
23039
23040 \begin_inset Flex Strong
23041 status collapsed
23042
23043 \begin_layout Plain Layout
23044
23045 \change_inserted 564990737 1672312011
23046 strong
23047 \change_unchanged
23048
23049 \end_layout
23050
23051 \end_inset
23052
23053 ,
23054  and
23055 \begin_inset Flex Code
23056 status collapsed
23057
23058 \begin_layout Plain Layout
23059
23060 \change_inserted 564990737 1672312011
23061 code
23062 \change_unchanged
23063
23064 \end_layout
23065
23066 \end_inset
23067
23068  which are accessed via the
23069 \family sans
23070 \bar under
23071 E
23072 \bar default
23073 dit\SpecialChar menuseparator
23074 Custom
23075 \begin_inset space ~
23076 \end_inset
23077
23078 Text
23079 \begin_inset space ~
23080 \end_inset
23081
23082
23083 \bar under
23084 S
23085 \bar default
23086 tyles
23087 \family default
23088  menu.
23089 \end_layout
23090
23091 \begin_layout Chapter
23092
23093 \change_deleted 564990737 1671304317
23094 Customizing
23095 \change_unchanged
23096 Bibliograph
23097 \change_inserted 564990737 1671304322
23098 y
23099 \change_deleted 564990737 1671304331
23100 ies with Bib\SpecialChar TeX
23101  or Biblatex
23102 \change_unchanged
23103
23104 \end_layout
23105
23106 \begin_layout Standard
23107 The most basic information about how to use Bib\SpecialChar TeX
23108  or
23109 \family sans
23110 Biblatex
23111 \family default
23112  with \SpecialChar LyX
23113  is contained in the section
23114 \emph on
23115 Bibliography databases
23116 \emph default
23117  of the
23118 \emph on
23119 User's Guide
23120 \emph default
23121 .
23122  The following subsections explain special bibliography features supported by \SpecialChar LyX
23123 .
23124 \end_layout
23125
23126 \begin_layout Section
23127 Alternative Citation Styles
23128 \end_layout
23129
23130 \begin_layout Standard
23131 Standard Bib\SpecialChar TeX
23132  uses numbers (e.
23133 \begin_inset space \thinspace{}
23134 \end_inset
23135
23136 g.
23137 \begin_inset space \space{}
23138 \end_inset
23139
23140
23141 \begin_inset Quotes eld
23142 \end_inset
23143
23144 [12]
23145 \begin_inset Quotes erd
23146 \end_inset
23147
23148 ) to refer to a cited work.
23149  However,
23150  in many scientific disciplines,
23151  other citation styles are in use.
23152  The most common one is the author-year style (e.
23153 \begin_inset space \thinspace{}
23154 \end_inset
23155
23156 g.
23157 \begin_inset space \space{}
23158 \end_inset
23159
23160
23161 \begin_inset Quotes eld
23162 \end_inset
23163
23164 Knuth 1984a
23165 \begin_inset Quotes erd
23166 \end_inset
23167
23168 ).
23169  \SpecialChar LyX
23170  supports three packages that provide this style,
23171
23172 \begin_inset Flex Code
23173 status collapsed
23174
23175 \begin_layout Plain Layout
23176 biblatex
23177 \end_layout
23178
23179 \end_inset
23180
23181 ,
23182
23183 \begin_inset Flex Code
23184 status collapsed
23185
23186 \begin_layout Plain Layout
23187 natbib
23188 \end_layout
23189
23190 \end_inset
23191
23192 ,
23193  and
23194 \begin_inset Flex Code
23195 status collapsed
23196
23197 \begin_layout Plain Layout
23198 jurabib
23199 \end_layout
23200
23201 \end_inset
23202
23203 .
23204  Each of these packages has their pros and cons,
23205  which cannot be listed in detail.
23206  If you only want to have simple author-year (or author-numerical) style,
23207  or if you want to use one of the countless style files for
23208 \begin_inset Flex Code
23209 status collapsed
23210
23211 \begin_layout Plain Layout
23212 natbib
23213 \end_layout
23214
23215 \end_inset
23216
23217 ,
23218  then the established
23219 \begin_inset Flex Code
23220 status collapsed
23221
23222 \begin_layout Plain Layout
23223 natbib
23224 \end_layout
23225
23226 \end_inset
23227
23228  package is probably your choice.
23229  If you look for specific citation styles common in law studies,
23230  you might consider the
23231 \begin_inset Flex Code
23232 status collapsed
23233
23234 \begin_layout Plain Layout
23235 jurabib
23236 \end_layout
23237
23238 \end_inset
23239
23240  package.
23241  If you want to have full control over the formatting or look for advanced features such as ibidem,
23242  footnote citations,
23243  full title citations,
23244  advanced date formats (such as 400 BC) or full localization to other languages than English,
23245  you should definitely consider
23246 \begin_inset Flex Code
23247 status collapsed
23248
23249 \begin_layout Plain Layout
23250 biblatex
23251 \end_layout
23252
23253 \end_inset
23254
23255 ,
23256  which exceeds all other packages in terms of features,
23257  but is also quite heavy and more resource-hungry.
23258 \end_layout
23259
23260 \begin_layout Standard
23261 The handling of these packages in \SpecialChar LyX
23262  is basically the same.
23263  Go to
23264 \begin_inset Flex Noun
23265 status collapsed
23266
23267 \begin_layout Plain Layout
23268 Document\SpecialChar menuseparator
23269 Settings
23270 \end_layout
23271
23272 \end_inset
23273
23274  and select under
23275 \begin_inset Flex Noun
23276 status collapsed
23277
23278 \begin_layout Plain Layout
23279 Bibliography
23280 \end_layout
23281
23282 \end_inset
23283
23284  the
23285 \begin_inset Flex Noun
23286 status collapsed
23287
23288 \begin_layout Plain Layout
23289 Style Format
23290 \end_layout
23291
23292 \end_inset
23293
23294
23295 \begin_inset Flex Noun
23296 status collapsed
23297
23298 \begin_layout Plain Layout
23299 Basic (BibTeX)
23300 \end_layout
23301
23302 \end_inset
23303
23304 ,
23305
23306 \begin_inset Flex Noun
23307 status collapsed
23308
23309 \begin_layout Plain Layout
23310 Biblatex
23311 \end_layout
23312
23313 \end_inset
23314
23315 ,
23316
23317 \begin_inset Flex Noun
23318 status collapsed
23319
23320 \begin_layout Plain Layout
23321 Biblatex (Natbib mode)
23322 \end_layout
23323
23324 \end_inset
23325
23326 ,
23327
23328 \begin_inset Flex Noun
23329 status collapsed
23330
23331 \begin_layout Plain Layout
23332 Natbib (BibTeX)
23333 \end_layout
23334
23335 \end_inset
23336
23337  or
23338 \begin_inset Flex Noun
23339 status collapsed
23340
23341 \begin_layout Plain Layout
23342 Jurabib (BibTeX)
23343 \end_layout
23344
23345 \end_inset
23346
23347  (see sec.
23348 \begin_inset space ~
23349 \end_inset
23350
23351 6.5.3 in the User's Guide for more information on these choices).
23352  With all these packages,
23353  you will get some extra features in the citation dialog and you can select the style of the reference (
23354 \begin_inset Quotes eld
23355 \end_inset
23356
23357 Knuth 1984
23358 \begin_inset Quotes erd
23359 \end_inset
23360
23361 ,
23362
23363 \begin_inset Quotes eld
23364 \end_inset
23365
23366 Knuth (1984)
23367 \begin_inset Quotes erd
23368 \end_inset
23369
23370 ,
23371
23372 \begin_inset Quotes eld
23373 \end_inset
23374
23375 Knuth,
23376  1984
23377 \begin_inset Quotes erd
23378 \end_inset
23379
23380 ,
23381
23382 \begin_inset Quotes eld
23383 \end_inset
23384
23385 1984
23386 \begin_inset Quotes erd
23387 \end_inset
23388
23389  etc.).
23390  Note that either package needs specifically designed style files.
23391  They all ship their own,
23392  but there are lots of additional style files,
23393  and there is even an interactive style file builder
23394 \begin_inset Foot
23395 status collapsed
23396
23397 \begin_layout Plain Layout
23398 See
23399 \begin_inset Flex URL
23400 status open
23401
23402 \begin_layout Plain Layout
23403
23404 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
23405 \end_layout
23406
23407 \end_inset
23408
23409
23410 \end_layout
23411
23412 \end_inset
23413
23414  for
23415 \begin_inset Flex Code
23416 status collapsed
23417
23418 \begin_layout Plain Layout
23419 natbib
23420 \end_layout
23421
23422 \end_inset
23423
23424 .
23425 \end_layout
23426
23427 \begin_layout Section
23428 Subdivided Bibliographies
23429 \end_layout
23430
23431 \begin_layout Standard
23432 Sometimes you might need to divide your bibliography into several sections.
23433  If you are for instance a historian,
23434  the possibility to separate sources and scientific works is most likely a
23435 \begin_inset Quotes eld
23436 \end_inset
23437
23438 must have
23439 \begin_inset Quotes erd
23440 \end_inset
23441
23442 .
23443  Unfortunately,
23444  Bib\SpecialChar TeX
23445  itself does not allow you to do this.
23446  But with the help of some \SpecialChar LaTeX
23447  packages,
23448  Bib\SpecialChar TeX
23449  can be extended to fit your needs.
23450 \end_layout
23451
23452 \begin_layout Standard
23453 \SpecialChar LyX
23454  provides native support for one of these packages,
23455
23456 \family typewriter
23457 bibtopic
23458 \family default
23459 .
23460 \begin_inset Foot
23461 status collapsed
23462
23463 \begin_layout Plain Layout
23464 Available from
23465 \begin_inset Flex URL
23466 status open
23467
23468 \begin_layout Plain Layout
23469
23470 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
23471 \end_layout
23472
23473 \end_inset
23474
23475
23476 \end_layout
23477
23478 \end_inset
23479
23480  The advantage of this package (compared to other packages such as
23481 \family typewriter
23482 multibib
23483 \family default
23484 ) is that you don't need to define new citation commands.
23485  Instead,
23486  you need to prepare different bibliographic databases which include the entries for the different sections of the bibliography.
23487  For example:
23488  If you want to divide your bibliography into the sections
23489 \begin_inset Quotes eld
23490 \end_inset
23491
23492 Sources
23493 \begin_inset Quotes erd
23494 \end_inset
23495
23496  and
23497 \begin_inset Quotes eld
23498 \end_inset
23499
23500 Scientific works
23501 \begin_inset Quotes erd
23502 \end_inset
23503
23504 ,
23505  you first need to create two bibliographic databases,
23506  e.
23507 \begin_inset space \thinspace{}
23508 \end_inset
23509
23510 g.
23511 \begin_inset space \space{}
23512 \end_inset
23513
23514
23515 \begin_inset Flex Code
23516 status collapsed
23517
23518 \begin_layout Plain Layout
23519 sources.bib
23520 \end_layout
23521
23522 \end_inset
23523
23524  and
23525 \begin_inset Flex Code
23526 status collapsed
23527
23528 \begin_layout Plain Layout
23529 scientific.bib
23530 \end_layout
23531
23532 \end_inset
23533
23534 .
23535
23536 \end_layout
23537
23538 \begin_layout Standard
23539 Go to
23540 \begin_inset Flex Noun
23541 status collapsed
23542
23543 \begin_layout Plain Layout
23544 Document\SpecialChar menuseparator
23545 Settings
23546 \end_layout
23547
23548 \end_inset
23549
23550  and check under
23551 \begin_inset Flex Noun
23552 status collapsed
23553
23554 \begin_layout Plain Layout
23555 Bibliography
23556 \end_layout
23557
23558 \end_inset
23559
23560  the option
23561 \begin_inset Flex Noun
23562 status collapsed
23563
23564 \begin_layout Plain Layout
23565 Subdivided bibliography
23566 \end_layout
23567
23568 \end_inset
23569
23570 .
23571  Now you can insert multiple Bib\SpecialChar TeX
23572  bibliographies,
23573  one for each section of your bibliography.
23574  Returning to our example:
23575  Insert the Bib\SpecialChar TeX
23576  bibliography
23577 \begin_inset Flex Code
23578 status collapsed
23579
23580 \begin_layout Plain Layout
23581 sources.bib
23582 \end_layout
23583
23584 \end_inset
23585
23586  and a second one for the database
23587 \begin_inset Flex Code
23588 status collapsed
23589
23590 \begin_layout Plain Layout
23591 scientific.bib
23592 \end_layout
23593
23594 \end_inset
23595
23596 .
23597  You are free to use the same or different styles for each section.
23598  Additionally,
23599  you can choose if the bibliography section should contain
23600 \begin_inset Quotes eld
23601 \end_inset
23602
23603 all cited references
23604 \begin_inset Quotes erd
23605 \end_inset
23606
23607  of the specified database(s) (which is the default),
23608
23609 \begin_inset Quotes eld
23610 \end_inset
23611
23612 all uncited references
23613 \begin_inset Quotes erd
23614 \end_inset
23615
23616  or even
23617 \begin_inset Quotes eld
23618 \end_inset
23619
23620 all references
23621 \begin_inset Quotes erd
23622 \end_inset
23623
23624 .
23625  This might be useful if you would like to separate your bibliography into three sections:
23626
23627 \begin_inset Quotes eld
23628 \end_inset
23629
23630 Cited sources
23631 \begin_inset Quotes erd
23632 \end_inset
23633
23634 ,
23635
23636 \begin_inset Quotes eld
23637 \end_inset
23638
23639 Uncited sources
23640 \begin_inset Quotes erd
23641 \end_inset
23642
23643 ,
23644  and
23645 \begin_inset Quotes eld
23646 \end_inset
23647
23648 Scientific works
23649 \begin_inset Quotes erd
23650 \end_inset
23651
23652 .
23653  The titles for the sections can be added as ordinary sections or subsections.
23654  Since
23655 \begin_inset Flex Code
23656 status collapsed
23657
23658 \begin_layout Plain Layout
23659 bibtopic
23660 \end_layout
23661
23662 \end_inset
23663
23664  removes the bibliography title,
23665  you have to manually re-add that,
23666  too (as a chapter* or section*,
23667  for instance).
23668 \end_layout
23669
23670 \begin_layout Standard
23671 With
23672 \family sans
23673 Biblatex
23674 \family default
23675 ,
23676  the procedure is a bit different.
23677  Since
23678 \family typewriter
23679 bibtopic
23680 \family default
23681  does not work with
23682 \family sans
23683 Biblatex
23684 \family default
23685 ,
23686  the aforementioned
23687 \begin_inset Flex Noun
23688 status collapsed
23689
23690 \begin_layout Plain Layout
23691 Subdivided bibliography
23692 \end_layout
23693
23694 \end_inset
23695
23696  option is disabled if you use
23697 \family sans
23698 Biblatex
23699 \family default
23700 .
23701  However,
23702
23703 \family sans
23704 Biblatex
23705 \family default
23706  provides its own means to generate subdivided bibliographies.
23707  You can either add keywords to bibliography entries via the
23708 \begin_inset Flex Code
23709 status collapsed
23710
23711 \begin_layout Plain Layout
23712 keywords
23713 \end_layout
23714
23715 \end_inset
23716
23717  entry option and then filter bibliography sections by keyword (by adding
23718 \begin_inset Flex Code
23719 status collapsed
23720
23721 \begin_layout Plain Layout
23722 keyword=mykeyword
23723 \end_layout
23724
23725 \end_inset
23726
23727  to the
23728 \begin_inset Flex Noun
23729 status collapsed
23730
23731 \begin_layout Plain Layout
23732 Options
23733 \end_layout
23734
23735 \end_inset
23736
23737  field of the dialog that opens if you left-click on the
23738 \begin_inset Flex Noun
23739 status collapsed
23740
23741 \begin_layout Plain Layout
23742 Biblatex Generated Bibliography
23743 \end_layout
23744
23745 \end_inset
23746
23747  button),
23748  or you can filter by entry types (such as
23749 \emph on
23750 book
23751 \emph default
23752  or
23753 \emph on
23754 article
23755 \emph default
23756 ) by entering e.
23757 \begin_inset space \thinspace{}
23758 \end_inset
23759
23760 g.
23761
23762 \begin_inset Flex Code
23763 status collapsed
23764
23765 \begin_layout Plain Layout
23766 type=book
23767 \end_layout
23768
23769 \end_inset
23770
23771  or
23772 \begin_inset Flex Code
23773 status collapsed
23774
23775 \begin_layout Plain Layout
23776 nottype=collection
23777 \end_layout
23778
23779 \end_inset
23780
23781  to the mentioned
23782 \begin_inset Flex Noun
23783 status collapsed
23784
23785 \begin_layout Plain Layout
23786 Options
23787 \end_layout
23788
23789 \end_inset
23790
23791  field,
23792  or you can create so-called
23793 \begin_inset Quotes eld
23794 \end_inset
23795
23796 Bibliography Categories
23797 \begin_inset Quotes erd
23798 \end_inset
23799
23800  to which you can assign individual entries.
23801  Please refer to the Biblatex manual,
23802  section
23803 \emph on
23804 Subdivided Bibliographies
23805 \emph default
23806 ,
23807  for details.
23808 \end_layout
23809
23810 \begin_layout Section
23811 Multiple Bibliographies
23812 \begin_inset CommandInset label
23813 LatexCommand label
23814 name "subsec:Multiple-Bibliographies"
23815
23816 \end_inset
23817
23818
23819 \end_layout
23820
23821 \begin_layout Standard
23822 Multiple bibliographies,
23823  e.
23824 \begin_inset space \thinspace{}
23825 \end_inset
23826
23827 g.
23828 \begin_inset space \space{}
23829 \end_inset
23830
23831 a bibliography for each part,
23832  chapter,
23833  section,
23834  subsection or child (sub-document) of the document,
23835  are also supported by \SpecialChar LyX
23836 .
23837  In order to enable it,
23838  go to
23839 \begin_inset Flex Noun
23840 status collapsed
23841
23842 \begin_layout Plain Layout
23843 Document\SpecialChar menuseparator
23844 Settings\SpecialChar menuseparator
23845 Bibliography
23846 \end_layout
23847
23848 \end_inset
23849
23850  and select the relevant unit (e.
23851 \begin_inset space \thinspace{}
23852 \end_inset
23853
23854 g.,
23855
23856 \begin_inset Quotes eld
23857 \end_inset
23858
23859 per section
23860 \begin_inset Quotes erd
23861 \end_inset
23862
23863 ) in the
23864 \begin_inset Flex Noun
23865 status collapsed
23866
23867 \begin_layout Plain Layout
23868 Multiple Bibliographies
23869 \end_layout
23870
23871 \end_inset
23872
23873  combo box.
23874  Then add a Bib(la)\SpecialChar TeX
23875  bibliography to each unit (e.
23876 \begin_inset space \thinspace{}
23877 \end_inset
23878
23879 g.,
23880  section) of your document.
23881  In the output,
23882  a separate bibliography,
23883  containing only the references done in the current unit is generated.
23884 \end_layout
23885
23886 \begin_layout Standard
23887 If you use Bib\SpecialChar TeX
23888 ,
23889  either the
23890 \begin_inset Flex Code
23891 status collapsed
23892
23893 \begin_layout Plain Layout
23894 chapterbib
23895 \end_layout
23896
23897 \end_inset
23898
23899  or the
23900 \begin_inset Flex Code
23901 status collapsed
23902
23903 \begin_layout Plain Layout
23904 bibtopic
23905 \end_layout
23906
23907 \end_inset
23908
23909  package is used to create multiple bibliographies.
23910  The former package is used if you select
23911 \begin_inset Quotes eld
23912 \end_inset
23913
23914 per child document
23915 \begin_inset Quotes erd
23916 \end_inset
23917
23918  and do
23919 \emph on
23920 not
23921 \emph default
23922  check
23923 \begin_inset Flex Noun
23924 status collapsed
23925
23926 \begin_layout Plain Layout
23927 Sectioned Bibliography
23928 \end_layout
23929
23930 \end_inset
23931
23932 .
23933  In all other cases,
23934
23935 \begin_inset Flex Code
23936 status collapsed
23937
23938 \begin_layout Plain Layout
23939 bibtopic
23940 \end_layout
23941
23942 \end_inset
23943
23944  is used.
23945 \begin_inset Foot
23946 status collapsed
23947
23948 \begin_layout Plain Layout
23949 An alternative approach,
23950  if you are willing to use some
23951 \begin_inset Flex Noun
23952 status collapsed
23953
23954 \begin_layout Plain Layout
23955 \SpecialChar TeX
23956  Code
23957 \end_layout
23958
23959 \end_inset
23960
23961  (see section
23962 \begin_inset space ~
23963 \end_inset
23964
23965
23966 \begin_inset CommandInset ref
23967 LatexCommand ref
23968 reference "sec:Inserting-TeX-Code"
23969 nolink "false"
23970
23971 \end_inset
23972
23973 ),
23974  is to use the
23975 \begin_inset Flex Code
23976 status collapsed
23977
23978 \begin_layout Plain Layout
23979 bibunits
23980 \end_layout
23981
23982 \end_inset
23983
23984  package.
23985 \end_layout
23986
23987 \end_inset
23988
23989  If
23990 \begin_inset Flex Code
23991 status collapsed
23992
23993 \begin_layout Plain Layout
23994 bibtopic
23995 \end_layout
23996
23997 \end_inset
23998
23999  is used,
24000  \SpecialChar LyX
24001  encloses the specified units in
24002 \begin_inset Flex Code
24003 status collapsed
24004
24005 \begin_layout Plain Layout
24006 bibtopic
24007 \end_layout
24008
24009 \end_inset
24010
24011 's
24012 \begin_inset Flex Code
24013 status collapsed
24014
24015 \begin_layout Plain Layout
24016
24017 \backslash
24018 begin{btUnit}
24019 \end_layout
24020
24021 \end_inset
24022
24023  and
24024 \begin_inset Flex Code
24025 status collapsed
24026
24027 \begin_layout Plain Layout
24028
24029 \backslash
24030 end{btUnit}
24031 \end_layout
24032
24033 \end_inset
24034
24035  in order to create the units.
24036  Note that this approach has some limitations.
24037  First,
24038  every citation reference has to be inside some
24039 \begin_inset Flex Code
24040 status collapsed
24041
24042 \begin_layout Plain Layout
24043 btUnit
24044 \end_layout
24045
24046 \end_inset
24047
24048 .
24049  So citations outside a defined unit (e.
24050 \begin_inset space \thinspace{}
24051 \end_inset
24052
24053 g.,
24054  before the first section if you use
24055 \begin_inset Quotes eld
24056 \end_inset
24057
24058 by section
24059 \begin_inset Quotes erd
24060 \end_inset
24061
24062 ) will appear as
24063 \begin_inset Quotes eld
24064 \end_inset
24065
24066 ???
24067 \begin_inset Quotes erd
24068 \end_inset
24069
24070 .
24071  You can also create your own units by entering
24072 \begin_inset Flex Code
24073 status collapsed
24074
24075 \begin_layout Plain Layout
24076
24077 \backslash
24078 begin{btUnit}
24079 \end_layout
24080
24081 \end_inset
24082
24083  and
24084 \begin_inset Flex Code
24085 status collapsed
24086
24087 \begin_layout Plain Layout
24088
24089 \backslash
24090 end{btUnit}
24091 \end_layout
24092
24093 \end_inset
24094
24095  as \SpecialChar TeX
24096  code (for instance to work around the mentioned limitation).
24097  Note,
24098  though,
24099  that
24100 \begin_inset Flex Code
24101 status collapsed
24102
24103 \begin_layout Plain Layout
24104 btUnit
24105 \end_layout
24106
24107 \end_inset
24108
24109 s cannot be nested.
24110  A second limitation is that
24111 \begin_inset Flex Code
24112 status collapsed
24113
24114 \begin_layout Plain Layout
24115 bibtopic
24116 \end_layout
24117
24118 \end_inset
24119
24120  always processes all references of a bibliography database,
24121  even if they are not cited.
24122  This can result in odd labels (e.
24123 \begin_inset space \thinspace{}
24124 \end_inset
24125
24126 g.
24127
24128 \begin_inset Quotes eld
24129 \end_inset
24130
24131 Miller 2014b
24132 \begin_inset Quotes erd
24133 \end_inset
24134
24135  if two works of this author from 2014 are in the database,
24136  even if only one is cited).
24137 \end_layout
24138
24139 \begin_layout Standard
24140 If you use
24141 \family sans
24142 Biblatex
24143 \family default
24144 ,
24145  the
24146 \begin_inset Flex Code
24147 status collapsed
24148
24149 \begin_layout Plain Layout
24150 refsection
24151 \end_layout
24152
24153 \end_inset
24154
24155  option is used instead.
24156  If you need specific units,
24157  you can start them with the \SpecialChar TeX
24158  code
24159 \begin_inset Flex Code
24160 status collapsed
24161
24162 \begin_layout Plain Layout
24163
24164 \backslash
24165 newrefsection
24166 \end_layout
24167
24168 \end_inset
24169
24170  or
24171 \begin_inset Flex Code
24172 status collapsed
24173
24174 \begin_layout Plain Layout
24175
24176 \backslash
24177 newrefsegment
24178 \end_layout
24179
24180 \end_inset
24181
24182 ,
24183  respectively.
24184  If you also want to control the end of the unit,
24185  use the environment
24186 \begin_inset Flex Code
24187 status collapsed
24188
24189 \begin_layout Plain Layout
24190
24191 \backslash
24192 begin{refsection}
24193 \end_layout
24194
24195 \end_inset
24196
24197  \SpecialChar ldots
24198
24199 \begin_inset Flex Code
24200 status collapsed
24201
24202 \begin_layout Plain Layout
24203
24204 \backslash
24205 end{refsection}
24206 \end_layout
24207
24208 \end_inset
24209
24210  instead.
24211  Note,
24212  though,
24213  that
24214 \begin_inset Flex Code
24215 status collapsed
24216
24217 \begin_layout Plain Layout
24218 refsection
24219 \end_layout
24220
24221 \end_inset
24222
24223 s cannot be nested.
24224  In addition to the individual bibliography of the current unit,
24225
24226 \family sans
24227 Biblatex
24228 \family default
24229  also provides an easy way to output all bibliographies,
24230  subsequently,
24231  at one place (e.
24232 \begin_inset space \thinspace{}
24233 \end_inset
24234
24235 g.,
24236  at the end of the document).
24237  Select
24238 \begin_inset Quotes eld
24239 \end_inset
24240
24241 all reference units
24242 \begin_inset Quotes erd
24243 \end_inset
24244
24245  from the Content combo box of the Bib(la)TeX inset dialog in order to achieve this.
24246  Please refer to the
24247 \family sans
24248 Biblatex
24249 \family default
24250  manual for more information on this topic.
24251 \end_layout
24252
24253 \begin_layout Chapter
24254
24255 \change_deleted 564990737 1671355654
24256 Itemize
24257 \change_unchanged
24258 Bullet
24259 \change_inserted 564990737 1671355667
24260 s
24261 \change_deleted 564990737 1671355661
24262  Selection
24263 \change_inserted 564990737 1671355684
24264
24265 \begin_inset CommandInset label
24266 LatexCommand label
24267 name "chap:bullets"
24268
24269 \end_inset
24270
24271
24272 \change_deleted 564990737 1671355684
24273
24274 \begin_inset CommandInset label
24275 LatexCommand label
24276 name "sec:bullet"
24277
24278 \end_inset
24279
24280
24281 \change_unchanged
24282
24283 \end_layout
24284
24285 \begin_layout Standard
24286 by
24287 \noun on
24288  Allan Rae
24289 \end_layout
24290
24291 \begin_layout Section
24292 Introduction
24293 \end_layout
24294
24295 \begin_layout Standard
24296 \SpecialChar LyX
24297  provides 216 bullet shapes that can be accessed from a simple dialog.
24298  Using this dialog you can easily specify what bullet shape to use at each level of an itemized list.
24299  These settings are document-wide so you won't be able to specify different sets of bullets for different paragraphs.
24300 \begin_inset Foot
24301 status collapsed
24302
24303 \begin_layout Plain Layout
24304 Well,
24305  actually you can but you'll have to do it by hand.
24306 \end_layout
24307
24308 \end_inset
24309
24310
24311 \end_layout
24312
24313 \begin_layout Section
24314 How it looks
24315 \end_layout
24316
24317 \begin_layout Standard
24318 Open the dialog by selecting the
24319 \begin_inset Flex Noun
24320 status collapsed
24321
24322 \begin_layout Plain Layout
24323 Document\SpecialChar menuseparator
24324 Settings
24325 \end_layout
24326
24327 \end_inset
24328
24329  menu item and then select the
24330 \begin_inset Flex Noun
24331 status collapsed
24332
24333 \begin_layout Plain Layout
24334 Bullets
24335 \end_layout
24336
24337 \end_inset
24338
24339  tab.
24340 \end_layout
24341
24342 \begin_layout Standard
24343 The dialog provides you with a table of bullet shapes.
24344  A column of buttons on the left of the table provides access to the six different panels of bullet shapes.
24345  The row of buttons across the top is used to select which bullet depth you are changing.
24346
24347 \change_deleted 244031559 1603875981
24348  A text entry under the table shows the currently selected bullet shape's \SpecialChar LaTeX
24349  equivalent and this can be edited if desired.
24350  If you do modify the text you will also need to specify any needed packages in the \SpecialChar LaTeX
24351  preamble.
24352 \change_unchanged
24353
24354 \end_layout
24355
24356 \begin_layout Standard
24357 The six panels are divided up by the packages they require.
24358  The following table shows the mappings from button name to \SpecialChar LaTeX
24359  package.
24360 \end_layout
24361
24362 \begin_layout Standard
24363 \align center
24364 \begin_inset Tabular
24365 <lyxtabular version="3" rows="7" columns="2">
24366 <features tabularvalignment="middle">
24367 <column alignment="center" valignment="top" width="0pt">
24368 <column alignment="center" valignment="top" width="0pt">
24369 <row>
24370 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
24371 \begin_inset Text
24372
24373 \begin_layout Plain Layout
24374
24375 \family roman
24376 \series medium
24377 \shape up
24378 \size normal
24379 \emph off
24380 \bar no
24381 \noun off
24382 \color none
24383 Button
24384 \end_layout
24385
24386 \end_inset
24387 </cell>
24388 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
24389 \begin_inset Text
24390
24391 \begin_layout Plain Layout
24392
24393 \family roman
24394 \series medium
24395 \shape up
24396 \size normal
24397 \emph off
24398 \bar no
24399 \noun off
24400 \color none
24401 Packages Required
24402 \end_layout
24403
24404 \end_inset
24405 </cell>
24406 </row>
24407 <row>
24408 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
24409 \begin_inset Text
24410
24411 \begin_layout Plain Layout
24412
24413 \family sans
24414 \series medium
24415 \shape up
24416 \size normal
24417 \emph off
24418 \bar no
24419 \noun off
24420 \color none
24421 Standard
24422 \end_layout
24423
24424 \end_inset
24425 </cell>
24426 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
24427 \begin_inset Text
24428
24429 \begin_layout Plain Layout
24430
24431 \series medium
24432 \shape up
24433 \size normal
24434 \emph off
24435 \bar no
24436 \noun off
24437 \color none
24438 base \SpecialChar LaTeX
24439
24440 \end_layout
24441
24442 \end_inset
24443 </cell>
24444 </row>
24445 <row>
24446 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
24447 \begin_inset Text
24448
24449 \begin_layout Plain Layout
24450
24451 \family sans
24452 \series medium
24453 \shape up
24454 \size normal
24455 \emph off
24456 \bar no
24457 \noun off
24458 \color none
24459 Maths
24460 \end_layout
24461
24462 \end_inset
24463 </cell>
24464 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
24465 \begin_inset Text
24466
24467 \begin_layout Plain Layout
24468
24469 \family typewriter
24470 \series medium
24471 \shape up
24472 \size normal
24473 \emph off
24474 \bar no
24475 \noun off
24476 \color none
24477 amssymb.sty
24478 \end_layout
24479
24480 \end_inset
24481 </cell>
24482 </row>
24483 <row>
24484 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
24485 \begin_inset Text
24486
24487 \begin_layout Plain Layout
24488
24489 \family sans
24490 \series medium
24491 \shape up
24492 \size normal
24493 \emph off
24494 \bar no
24495 \noun off
24496 \color none
24497 Ding1
24498 \end_layout
24499
24500 \end_inset
24501 </cell>
24502 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
24503 \begin_inset Text
24504
24505 \begin_layout Plain Layout
24506
24507 \family typewriter
24508 \series medium
24509 \shape up
24510 \size normal
24511 \emph off
24512 \bar no
24513 \noun off
24514 \color none
24515 pifont.sty
24516 \end_layout
24517
24518 \end_inset
24519 </cell>
24520 </row>
24521 <row>
24522 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
24523 \begin_inset Text
24524
24525 \begin_layout Plain Layout
24526
24527 \family sans
24528 \series medium
24529 \shape up
24530 \size normal
24531 \emph off
24532 \bar no
24533 \noun off
24534 \color none
24535 Ding2
24536 \end_layout
24537
24538 \end_inset
24539 </cell>
24540 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
24541 \begin_inset Text
24542
24543 \begin_layout Plain Layout
24544
24545 \family typewriter
24546 \series medium
24547 \shape up
24548 \size normal
24549 \emph off
24550 \bar no
24551 \noun off
24552 \color none
24553 pifont.sty
24554 \end_layout
24555
24556 \end_inset
24557 </cell>
24558 </row>
24559 <row>
24560 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
24561 \begin_inset Text
24562
24563 \begin_layout Plain Layout
24564
24565 \family sans
24566 \series medium
24567 \shape up
24568 \size normal
24569 \emph off
24570 \bar no
24571 \noun off
24572 \color none
24573 Ding3
24574 \end_layout
24575
24576 \end_inset
24577 </cell>
24578 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
24579 \begin_inset Text
24580
24581 \begin_layout Plain Layout
24582
24583 \family typewriter
24584 \series medium
24585 \shape up
24586 \size normal
24587 \emph off
24588 \bar no
24589 \noun off
24590 \color none
24591 pifont.sty
24592 \end_layout
24593
24594 \end_inset
24595 </cell>
24596 </row>
24597 <row>
24598 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
24599 \begin_inset Text
24600
24601 \begin_layout Plain Layout
24602
24603 \family sans
24604 \series medium
24605 \shape up
24606 \size normal
24607 \emph off
24608 \bar no
24609 \noun off
24610 \color none
24611 Ding4
24612 \end_layout
24613
24614 \end_inset
24615 </cell>
24616 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
24617 \begin_inset Text
24618
24619 \begin_layout Plain Layout
24620
24621 \family typewriter
24622 \series medium
24623 \shape up
24624 \size normal
24625 \emph off
24626 \bar no
24627 \noun off
24628 \color none
24629 pifont.sty
24630 \end_layout
24631
24632 \end_inset
24633 </cell>
24634 </row>
24635 </lyxtabular>
24636
24637 \end_inset
24638
24639
24640 \end_layout
24641
24642 \begin_layout Standard
24643 \SpecialChar LyX
24644  doesn't stop you using bullets from packages you don't have.
24645  If you get errors from \SpecialChar LaTeX
24646  when you try to view or print the file,
24647  then it is likely you are missing a package.
24648 \begin_inset Foot
24649 status collapsed
24650
24651 \begin_layout Plain Layout
24652 \SpecialChar LyX
24653  doesn't restrict your use since you may be editing locally and exporting elsewhere.
24654 \end_layout
24655
24656 \end_inset
24657
24658
24659 \end_layout
24660
24661 \begin_layout Section
24662 How to use it
24663 \end_layout
24664
24665 \begin_layout Standard
24666 Select which bullet depth you want to change then select the bullet shape and size.
24667  Any changes will not be visible in \SpecialChar LyX
24668 ,
24669  but are visible when viewing the document.
24670 \end_layout
24671
24672 \begin_layout Standard
24673 You can reset a bullet shape to the default simply by clicking your right mouse button on the appropriate bullet depth button.
24674 \begin_inset Foot
24675 status open
24676
24677 \begin_layout Plain Layout
24678
24679 \change_inserted 564990737 1672138075
24680 \begin_inset CommandInset label
24681 LatexCommand label
24682 name "fn:If-you-really"
24683
24684 \end_inset
24685
24686
24687 \change_unchanged
24688 If you
24689 \emph on
24690 really
24691 \emph default
24692  want to have multiple sets of paragraphs with different sets of bullets in each,
24693  then you're going to have to get your hands dirty with \SpecialChar TeX
24694  code.
24695  The bullet selection dialog can help though because it provides you with the \SpecialChar LaTeX
24696  code for a wide range of bullet shapes.
24697  To make your own custom paragraphs you have the following options:
24698 \end_layout
24699
24700 \begin_layout Plain Layout
24701 \begin_inset ERT
24702 status open
24703
24704 \begin_layout Plain Layout
24705
24706
24707 \backslash
24708 let
24709 \backslash
24710 savelabelitemi=
24711 \backslash
24712 labelitemi
24713 \end_layout
24714
24715 \end_inset
24716
24717
24718 \end_layout
24719
24720 \begin_layout Plain Layout
24721 \begin_inset ERT
24722 status open
24723
24724 \begin_layout Plain Layout
24725
24726
24727 \backslash
24728 renewcommand
24729 \backslash
24730 labelitemi[0]{
24731 \backslash
24732 small
24733 \backslash
24734 (
24735 \backslash
24736 sharp
24737 \backslash
24738 )}
24739 \end_layout
24740
24741 \end_inset
24742
24743
24744 \end_layout
24745
24746 \begin_layout Itemize
24747 Use the \SpecialChar LaTeX
24748  command
24749 \begin_inset Flex Code
24750 status collapsed
24751
24752 \begin_layout Plain Layout
24753
24754 \backslash
24755 renewcommand{}{}
24756 \end_layout
24757
24758 \end_inset
24759
24760  to specify a new bullet shape for a given depth.
24761  You'll also need to save the current bullet shape so you can restore it again afterwards.
24762  In this itemized list the following \SpecialChar LaTeX
24763  code was used to change the bullet used for the first depth.
24764 \end_layout
24765
24766 \begin_deeper
24767 \begin_layout LyX-Code
24768
24769 \backslash
24770 let
24771 \backslash
24772 savelabelitemi=
24773 \backslash
24774 labelitemi
24775 \end_layout
24776
24777 \begin_layout LyX-Code
24778
24779 \backslash
24780 renewcommand
24781 \backslash
24782 labelitemi[0]{
24783 \backslash
24784 small
24785 \backslash
24786 (
24787 \backslash
24788 sharp
24789 \backslash
24790 )}
24791 \end_layout
24792
24793 \end_deeper
24794 \begin_layout Itemize
24795 Note that the itemize depth is specified in Roman numerals as part of the
24796 \family typewriter
24797
24798 \backslash
24799 labelitem
24800 \family default
24801  command.
24802 \end_layout
24803
24804 \begin_layout Itemize
24805 \begin_inset Argument item:1
24806 status open
24807
24808 \begin_layout Plain Layout
24809 \begin_inset ERT
24810 status open
24811
24812 \begin_layout Plain Layout
24813
24814
24815 \backslash
24816 (
24817 \backslash
24818 star
24819 \backslash
24820 )
24821 \end_layout
24822
24823 \end_inset
24824
24825
24826 \end_layout
24827
24828 \end_inset
24829
24830  Specify each individual entry by starting each item with the bullet shape enclosed in a
24831 \begin_inset Quotes eld
24832 \end_inset
24833
24834 Custom Item
24835 \begin_inset Quotes erd
24836 \end_inset
24837
24838  inset (available at
24839 \family sans
24840 Insert\SpecialChar menuseparator
24841 Custom Item
24842 \family default
24843 ) and set as
24844 \begin_inset Flex Noun
24845 status collapsed
24846
24847 \begin_layout Plain Layout
24848 \SpecialChar TeX
24849  Code
24850 \end_layout
24851
24852 \end_inset
24853
24854 .
24855  For example,
24856  this item was started with
24857 \begin_inset Flex Code
24858 status collapsed
24859
24860 \begin_layout Plain Layout
24861
24862 \backslash
24863 (
24864 \backslash
24865 star
24866 \backslash
24867 )
24868 \end_layout
24869
24870 \end_inset
24871
24872 .
24873 \end_layout
24874
24875 \begin_layout Plain Layout
24876 \begin_inset ERT
24877 status open
24878
24879 \begin_layout Plain Layout
24880
24881
24882 \backslash
24883 renewcommand
24884 \backslash
24885 labelitemi[0]{
24886 \backslash
24887 savelabelitemi}
24888 \end_layout
24889
24890 \end_inset
24891
24892
24893 \end_layout
24894
24895 \begin_layout Plain Layout
24896 You'll also need to revert the labelitem back to its previous setting for the global bullet shape settings to remain in effect.
24897  The way used here was:
24898 \end_layout
24899
24900 \begin_layout LyX-Code
24901
24902 \backslash
24903 renewcommand
24904 \backslash
24905 labelitemi[0]{
24906 \backslash
24907 savelabelitemi}
24908 \end_layout
24909
24910 \end_inset
24911
24912
24913 \end_layout
24914
24915 \begin_layout Chapter
24916 Supplemental Tools
24917 \end_layout
24918
24919 \begin_layout Section
24920 Multipart Documents
24921 \end_layout
24922
24923 \begin_layout Subsection
24924 General Operation
24925 \end_layout
24926
24927 \begin_layout Standard
24928 When you are working on a large file with many sections,
24929  it is often convenient to break up the document into several files,
24930  or perhaps you have something where a table may change from time to time,
24931  but the preceding text does not.
24932  In these cases,
24933  you should seriously consider using multipart documents.
24934  For example,
24935  scientific papers often have five major sections:
24936  the introduction,
24937  observations,
24938  results,
24939  discussion,
24940  and conclusion.
24941  Each of these could be its own separate \SpecialChar LyX
24942  file,
24943  with one
24944 \begin_inset Quotes eld
24945 \end_inset
24946
24947 master
24948 \begin_inset Quotes erd
24949 \end_inset
24950
24951  file which contains the title,
24952  authors,
24953  abstract,
24954  references,
24955  etc.,
24956  plus the five included files.
24957  It is important to note that each of these files is a full \SpecialChar LyX
24958  file which can be formatted and printed on its own,
24959  as well as included in a master file.
24960  Each of these files must have the same document class,
24961  however—
24962 don't attempt to mix book classes with article classes.
24963  You may also include \SpecialChar LaTeX
24964  files;
24965  however,
24966  these files must not have their own preamble (i.
24967 \begin_inset space \thinspace{}
24968 \end_inset
24969
24970 e.
24971 \begin_inset space \space{}
24972 \end_inset
24973
24974 everything up to and including the
24975 \begin_inset Flex Code
24976 status collapsed
24977
24978 \begin_layout Plain Layout
24979
24980 \backslash
24981 begin{document}
24982 \end_layout
24983
24984 \end_inset
24985
24986  line as well as the
24987 \begin_inset Flex Code
24988 status collapsed
24989
24990 \begin_layout Plain Layout
24991
24992 \backslash
24993 end{document}
24994 \end_layout
24995
24996 \end_inset
24997
24998  line must be deleted) or else errors will be generated when you try to make a DVI file.
24999 \end_layout
25000
25001 \begin_layout Standard
25002 \SpecialChar LyX
25003  allows you to include files quite easily with
25004 \begin_inset Flex Noun
25005 status collapsed
25006
25007 \begin_layout Plain Layout
25008 Insert\SpecialChar menuseparator
25009 Child
25010 \begin_inset space ~
25011 \end_inset
25012
25013 Document
25014 \end_layout
25015
25016 \end_inset
25017
25018 .
25019  When you click on this selection a small box is inserted into the file at the current cursor location.
25020  Clicking on the box raises a dialog which allows you to select the file to be included,
25021  and the method of its inclusion.
25022
25023 \end_layout
25024
25025 \begin_layout Standard
25026 The file selection box should by now be obvious.
25027  The three inclusion methods are
25028 \begin_inset Quotes eld
25029 \end_inset
25030
25031 include
25032 \begin_inset Quotes erd
25033 \end_inset
25034
25035 ,
25036
25037 \begin_inset Quotes eld
25038 \end_inset
25039
25040 input
25041 \begin_inset Quotes erd
25042 \end_inset
25043
25044 ,
25045  and
25046 \begin_inset Quotes eld
25047 \end_inset
25048
25049 verbatim
25050 \begin_inset Quotes erd
25051 \end_inset
25052
25053 .
25054  The methods
25055 \begin_inset Quotes eld
25056 \end_inset
25057
25058 include
25059 \begin_inset Quotes erd
25060 \end_inset
25061
25062  and
25063 \begin_inset Quotes eld
25064 \end_inset
25065
25066 input
25067 \begin_inset Quotes erd
25068 \end_inset
25069
25070  are similar in many ways,
25071  but there are also some notable differences:
25072 \end_layout
25073
25074 \begin_layout Enumerate
25075 Files that are
25076 \begin_inset Quotes eld
25077 \end_inset
25078
25079 included
25080 \begin_inset Quotes erd
25081 \end_inset
25082
25083  are typeset beginning on a new page,
25084  while files that are
25085 \begin_inset Quotes eld
25086 \end_inset
25087
25088 inputted
25089 \begin_inset Quotes erd
25090 \end_inset
25091
25092  are typeset starting on the current page.
25093 \end_layout
25094
25095 \begin_layout Enumerate
25096 \begin_inset Quotes eld
25097 \end_inset
25098
25099 Included
25100 \begin_inset Quotes erd
25101 \end_inset
25102
25103  files cannot themselves
25104 \begin_inset Quotes eld
25105 \end_inset
25106
25107 include
25108 \begin_inset Quotes erd
25109 \end_inset
25110
25111  further files (
25112 \begin_inset Quotes eld
25113 \end_inset
25114
25115 grandchilds
25116 \begin_inset Quotes erd
25117 \end_inset
25118
25119 ).
25120  With
25121 \begin_inset Quotes eld
25122 \end_inset
25123
25124 input
25125 \begin_inset Quotes erd
25126 \end_inset
25127
25128 ,
25129  on the other hand,
25130  infinite sub-inputting is possible.
25131 \end_layout
25132
25133 \begin_layout Enumerate
25134 \begin_inset Quotes eld
25135 \end_inset
25136
25137 Include
25138 \begin_inset Quotes erd
25139 \end_inset
25140
25141  allow for the output of only selected
25142 \begin_inset Quotes eld
25143 \end_inset
25144
25145 included
25146 \begin_inset Quotes erd
25147 \end_inset
25148
25149  files,
25150  while maintaining the actual counters (pagination etc.) and references (please refer to the section
25151 \emph on
25152 Child
25153 \begin_inset space ~
25154 \end_inset
25155
25156 Documents
25157 \emph default
25158  of the
25159 \emph on
25160 Embedded
25161 \begin_inset space ~
25162 \end_inset
25163
25164 Objects
25165 \emph default
25166  manual for details).
25167 \end_layout
25168
25169 \begin_layout Standard
25170 Hence,
25171
25172 \begin_inset Quotes eld
25173 \end_inset
25174
25175 include
25176 \begin_inset Quotes erd
25177 \end_inset
25178
25179  is the preferred method for chapters that are outsourced to child documents,
25180  while
25181 \begin_inset Quotes eld
25182 \end_inset
25183
25184 input
25185 \begin_inset Quotes erd
25186 \end_inset
25187
25188  is more suitable for arbitrary file inheritance.
25189 \end_layout
25190
25191 \begin_layout Standard
25192 A
25193 \begin_inset Quotes eld
25194 \end_inset
25195
25196 verbatim
25197 \begin_inset Quotes erd
25198 \end_inset
25199
25200  included file allows you to include a file typeset exactly as it appears in the file,
25201  i.
25202 \begin_inset space \thinspace{}
25203 \end_inset
25204
25205 e.
25206 \begin_inset space \space{}
25207 \end_inset
25208
25209 in
25210 \begin_inset Flex Code
25211 status collapsed
25212
25213 \begin_layout Plain Layout
25214 verbatim
25215 \end_layout
25216
25217 \end_inset
25218
25219  mode,
25220  with the characters set in a fixed-width typewriter font.
25221  Normally,
25222  spaces in this file are invisible,
25223  though two consecutive spaces are conserved,
25224  unlike \SpecialChar LyX
25225 's normal treatment of spaces.
25226  However,
25227  setting the
25228 \begin_inset Flex Noun
25229 status collapsed
25230
25231 \begin_layout Plain Layout
25232 Mark
25233 \begin_inset space ~
25234 \end_inset
25235
25236 spaces
25237 \begin_inset space ~
25238 \end_inset
25239
25240 in
25241 \begin_inset space ~
25242 \end_inset
25243
25244 output
25245 \end_layout
25246
25247 \end_inset
25248
25249  checkbox typesets a mark to unambiguously define the presence of a space.
25250
25251 \end_layout
25252
25253 \begin_layout Standard
25254 Generally,
25255  the master file is converted into a full \SpecialChar LaTeX
25256  file before typesetting,
25257  while the included files are converted to \SpecialChar LaTeX
25258  files that do not have all the preamble information.
25259 \end_layout
25260
25261 \begin_layout Subsection
25262 Cross-References Between Files
25263 \end_layout
25264
25265 \begin_layout Standard
25266 \begin_inset Box Shadowbox
25267 position "t"
25268 hor_pos "c"
25269 has_inner_box 1
25270 inner_pos "t"
25271 use_parbox 0
25272 use_makebox 0
25273 width "100col%"
25274 special "none"
25275 height "1in"
25276 height_special "totalheight"
25277 thickness "0.4pt"
25278 separation "3pt"
25279 shadowsize "4pt"
25280 framecolor "black"
25281 backgroundcolor "none"
25282 status open
25283
25284 \begin_layout Plain Layout
25285 This section is somewhat out of date.
25286  Need to describe default master documents and how children are opened when the master is.
25287  [[FIXME]]
25288 \end_layout
25289
25290 \end_inset
25291
25292
25293 \end_layout
25294
25295 \begin_layout Standard
25296 It is possible to set up cross-references between the different files.
25297  First,
25298  open all the files in question:
25299  let's call them A and B in a two file example,
25300  where B is included in A.
25301  Let's say you insert a label in A,
25302  then want to reference it in B.
25303  Open the cross-reference dialog whilst in document B,
25304  and you can select the
25305 \begin_inset Quotes eld
25306 \end_inset
25307
25308 buffer
25309 \begin_inset Quotes erd
25310 \end_inset
25311
25312  to use.
25313 \end_layout
25314
25315 \begin_layout Subsection
25316 Bibliography Lists in all Subdocuments
25317 \end_layout
25318
25319 \begin_layout Standard
25320 If you work with child documents,
25321  you might want to have only one main bibliography at the end,
25322  but still be able to have a selected bibliography for the child if you output it on its own.
25323  Here is how to achieve this.
25324 \end_layout
25325
25326 \begin_layout Standard
25327 For the main document,
25328  you just insert a bibliography inset at the place where the main bibliography has to appear (within the master file or within a child).
25329  If the bibliography inset is in the master file,
25330  the references will be inherited by all children,
25331  so they are available in the citation dialog within each child.
25332 \end_layout
25333
25334 \begin_layout Standard
25335 For child-specific bibliographies,
25336  insert bibliography insets within the child documents,
25337  at the place where the bibliography should appear when the child is compiled separately.
25338  However,
25339  the trick is to insert them into a branch (
25340 \family sans
25341 Insert\SpecialChar menuseparator
25342 Branch\SpecialChar menuseparator
25343 Insert New Branch...
25344 \family default
25345 ),
25346  e.
25347 \begin_inset space \thinspace{}
25348 \end_inset
25349
25350 g.
25351  called
25352 \begin_inset Quotes eld
25353 \end_inset
25354
25355 Childonly
25356 \begin_inset Quotes erd
25357 \end_inset
25358
25359 .
25360  Within the children,
25361  activate the branch (
25362 \family sans
25363 Document\SpecialChar menuseparator
25364 Settings...\SpecialChar menuseparator
25365 Branches
25366 \family default
25367 ).
25368  Within the master,
25369  deactivate the branch (
25370 \family sans
25371 Document\SpecialChar menuseparator
25372 Settings...\SpecialChar menuseparator
25373 Branches
25374 \family default
25375 ).
25376  Now the child's bibliography will be ignored by the master,
25377  but considered by the child.
25378 \end_layout
25379
25380 \begin_layout Standard
25381 If you need multiple bibliographies (e.
25382 \begin_inset space \thinspace{}
25383 \end_inset
25384
25385 g.,
25386  one per child in the
25387 \emph on
25388 main document
25389 \emph default
25390 ),
25391  please refer to sec.
25392 \begin_inset space ~
25393 \end_inset
25394
25395
25396 \begin_inset CommandInset ref
25397 LatexCommand ref
25398 reference "subsec:Multiple-Bibliographies"
25399 nolink "false"
25400
25401 \end_inset
25402
25403 .
25404 \end_layout
25405
25406 \begin_layout Section
25407 \SpecialChar LyX
25408  Archives
25409 \end_layout
25410
25411 \begin_layout Standard
25412 Users sometimes need to be able to
25413 \begin_inset Quotes eld
25414 \end_inset
25415
25416 bundle
25417 \begin_inset Quotes erd
25418 \end_inset
25419
25420  a \SpecialChar LyX
25421  file together with all the images (and other files) on which it depends,
25422  either for sending to a publisher or for sharing with a co-author.
25423  \SpecialChar LyX
25424  includes a Python script (
25425 \begin_inset Flex Code
25426 status collapsed
25427
25428 \begin_layout Plain Layout
25429 lyxpak.py
25430 \end_layout
25431
25432 \end_inset
25433
25434 ) that automates this process.
25435  To use it,
25436  you must have either the
25437 \begin_inset Flex Code
25438 status collapsed
25439
25440 \begin_layout Plain Layout
25441 zipfile
25442 \end_layout
25443
25444 \end_inset
25445
25446  or
25447 \begin_inset Flex Code
25448 status collapsed
25449
25450 \begin_layout Plain Layout
25451 tarfile
25452 \end_layout
25453
25454 \end_inset
25455
25456  python modules installed on your system.
25457  By default,
25458  the script prefers the
25459 \begin_inset Flex Code
25460 status collapsed
25461
25462 \begin_layout Plain Layout
25463 gzip
25464 \end_layout
25465
25466 \end_inset
25467
25468 -compressed
25469 \begin_inset Flex Code
25470 status collapsed
25471
25472 \begin_layout Plain Layout
25473 tar
25474 \end_layout
25475
25476 \end_inset
25477
25478  format on Unix-like systems and the
25479 \begin_inset Flex Code
25480 status collapsed
25481
25482 \begin_layout Plain Layout
25483 zip
25484 \end_layout
25485
25486 \end_inset
25487
25488  format on Windows.
25489 \end_layout
25490
25491 \begin_layout Standard
25492 \SpecialChar LyX
25493 's configuration process will set the script up to export a `\SpecialChar LyX
25494  Archive',
25495  and this format will then be available under
25496 \begin_inset Flex Code
25497 status collapsed
25498
25499 \begin_layout Plain Layout
25500 File\SpecialChar menuseparator
25501 Export
25502 \end_layout
25503
25504 \end_inset
25505
25506 .
25507 \end_layout
25508
25509 \begin_layout Standard
25510 Independently of the platform,
25511  the generation of a particular archive format can be forced by adding either the
25512 \begin_inset Flex Code
25513 status collapsed
25514
25515 \begin_layout Plain Layout
25516 -t
25517 \end_layout
25518
25519 \end_inset
25520
25521  (for the
25522 \begin_inset Flex Code
25523 status collapsed
25524
25525 \begin_layout Plain Layout
25526 tar
25527 \end_layout
25528
25529 \end_inset
25530
25531  format) or
25532 \begin_inset Flex Code
25533 status collapsed
25534
25535 \begin_layout Plain Layout
25536 -z
25537 \end_layout
25538
25539 \end_inset
25540
25541  (for the
25542 \begin_inset Flex Code
25543 status collapsed
25544
25545 \begin_layout Plain Layout
25546 zip
25547 \end_layout
25548
25549 \end_inset
25550
25551  format) switch to the
25552 \begin_inset Flex Code
25553 status collapsed
25554
25555 \begin_layout Plain Layout
25556 \SpecialChar LyX
25557 \SpecialChar menuseparator
25558 \SpecialChar LyX
25559  Archive
25560 \end_layout
25561
25562 \end_inset
25563
25564  converter in
25565 \begin_inset Flex Code
25566 status collapsed
25567
25568 \begin_layout Plain Layout
25569 Tools\SpecialChar menuseparator
25570 Preferences\SpecialChar menuseparator
25571 File Handling\SpecialChar menuseparator
25572 Converters
25573 \end_layout
25574
25575 \end_inset
25576
25577 .
25578  (Make sure you add the switch after the script name,
25579  not before it.)
25580 \end_layout
25581
25582 \begin_layout Section
25583 Fancy Headers and Footers
25584 \end_layout
25585
25586 \begin_layout Standard
25587 The default page layout is rather plain;
25588  for an
25589 \begin_inset Flex Code
25590 status collapsed
25591
25592 \begin_layout Plain Layout
25593 article
25594 \end_layout
25595
25596 \end_inset
25597
25598  document class,
25599  all you get is a centered page number at the bottom of the page.
25600  This document uses KOMA-script's book class,
25601  so it appears to be a bit fancier.
25602  But to really put on a show,
25603  you need to set the document page style to
25604 \begin_inset Quotes eld
25605 \end_inset
25606
25607 fancy
25608 \begin_inset Quotes erd
25609 \end_inset
25610
25611 ,
25612  as mentioned in the
25613 \emph on
25614 User Guide
25615 \emph default
25616 .
25617  This section describes the \SpecialChar LaTeX
25618  code you need to insert in your \SpecialChar LaTeX
25619  preamble in order to get the desired effects.
25620 \end_layout
25621
25622 \begin_layout Standard
25623 For more information on fancy headers,
25624  see the
25625 \begin_inset Flex Code
25626 status collapsed
25627
25628 \begin_layout Plain Layout
25629 fancyhdr
25630 \end_layout
25631
25632 \end_inset
25633
25634  package documentation.
25635  (
25636 \begin_inset Flex URL
25637 status collapsed
25638
25639 \begin_layout Plain Layout
25640
25641 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
25642 \end_layout
25643
25644 \end_inset
25645
25646 )
25647 \end_layout
25648
25649 \begin_layout Standard
25650 The page header is divided into three fields,
25651  not surprisingly labeled
25652 \begin_inset Quotes eld
25653 \end_inset
25654
25655 left
25656 \begin_inset Quotes erd
25657 \end_inset
25658
25659 ,
25660
25661 \begin_inset Quotes eld
25662 \end_inset
25663
25664 center
25665 \begin_inset Quotes erd
25666 \end_inset
25667
25668 ,
25669  and
25670 \begin_inset Quotes eld
25671 \end_inset
25672
25673 right
25674 \begin_inset Quotes erd
25675 \end_inset
25676
25677 .
25678  The footer is also divided into these three fields.
25679  The \SpecialChar LaTeX
25680  commands to set these fields in the simplest manner are
25681 \begin_inset Flex Code
25682 status collapsed
25683
25684 \begin_layout Plain Layout
25685
25686 \backslash
25687 lhead
25688 \end_layout
25689
25690 \end_inset
25691
25692 ,
25693
25694 \begin_inset Flex Code
25695 status collapsed
25696
25697 \begin_layout Plain Layout
25698
25699 \backslash
25700 chead
25701 \end_layout
25702
25703 \end_inset
25704
25705 ,
25706
25707 \begin_inset Flex Code
25708 status collapsed
25709
25710 \begin_layout Plain Layout
25711
25712 \backslash
25713 rhead
25714 \end_layout
25715
25716 \end_inset
25717
25718 ,
25719
25720 \begin_inset Flex Code
25721 status collapsed
25722
25723 \begin_layout Plain Layout
25724
25725 \backslash
25726 lfoot
25727 \end_layout
25728
25729 \end_inset
25730
25731 ,
25732  etc.
25733  Suppose you wish to put your name in the upper left hand corner of each page.
25734  Simply insert the following command in the preamble:
25735
25736 \end_layout
25737
25738 \begin_layout Standard
25739
25740 \family typewriter
25741
25742 \backslash
25743 lhead{John Q.
25744  DocWriter}
25745 \end_layout
25746
25747 \begin_layout Standard
25748 You will now see your name in the upper left.
25749  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,
25750  e.
25751 \begin_inset space \thinspace{}
25752 \end_inset
25753
25754 g.:
25755 \end_layout
25756
25757 \begin_layout Standard
25758
25759 \family typewriter
25760
25761 \backslash
25762 cfoot{}
25763 \end_layout
25764
25765 \begin_layout Standard
25766 Let's get really fancy:
25767  lets put the section number with the word
25768 \begin_inset Quotes eld
25769 \end_inset
25770
25771 Section
25772 \begin_inset Quotes erd
25773 \end_inset
25774
25775  (e.
25776 \begin_inset space \thinspace{}
25777 \end_inset
25778
25779 g.
25780 \begin_inset space \space{}
25781 \end_inset
25782
25783 Section 3) in the upper left,
25784  the page number (e.
25785 \begin_inset space \thinspace{}
25786 \end_inset
25787
25788 g.
25789 \begin_inset space \space{}
25790 \end_inset
25791
25792 Page 4) in the upper right,
25793  your name in the lower left,
25794  and the date in the lower right.
25795  The following commands should now appear in the preamble:
25796 \end_layout
25797
25798 \begin_layout Standard
25799
25800 \family typewriter
25801
25802 \backslash
25803 lhead{Section
25804 \backslash
25805 thesection}
25806 \end_layout
25807
25808 \begin_layout Standard
25809
25810 \family typewriter
25811
25812 \backslash
25813 chead{}
25814 \end_layout
25815
25816 \begin_layout Standard
25817
25818 \family typewriter
25819
25820 \backslash
25821 rhead{Page
25822 \backslash
25823 thepage}
25824 \end_layout
25825
25826 \begin_layout Standard
25827
25828 \family typewriter
25829
25830 \backslash
25831 lfoot{John Q.
25832  DocWriter}
25833 \end_layout
25834
25835 \begin_layout Standard
25836
25837 \family typewriter
25838
25839 \backslash
25840 cfoot{}
25841 \end_layout
25842
25843 \begin_layout Standard
25844
25845 \family typewriter
25846
25847 \backslash
25848 rfoot{
25849 \backslash
25850 today}
25851 \end_layout
25852
25853 \begin_layout Standard
25854 The commands
25855 \begin_inset Flex Code
25856 status collapsed
25857
25858 \begin_layout Plain Layout
25859
25860 \backslash
25861 thesection
25862 \end_layout
25863
25864 \end_inset
25865
25866  and
25867 \begin_inset Flex Code
25868 status collapsed
25869
25870 \begin_layout Plain Layout
25871
25872 \backslash
25873 thepage
25874 \end_layout
25875
25876 \end_inset
25877
25878  access \SpecialChar LaTeX
25879 's section and page counters,
25880  and so print out the current section and page number.
25881
25882 \begin_inset Flex Code
25883 status collapsed
25884
25885 \begin_layout Plain Layout
25886
25887 \backslash
25888 today
25889 \end_layout
25890
25891 \end_inset
25892
25893  simply prints out today's date.
25894 \end_layout
25895
25896 \begin_layout Standard
25897 The thicknesses of the horizontal rules drawn beneath the header and above the footer can also be modified.
25898  If you don't want one of the rules,
25899  set its thickness to 0.
25900  The header rule has a default thickness of 0.4pt,
25901  the footer rule is 0pt.
25902  Use commands
25903 \family typewriter
25904
25905 \family default
25906 like
25907 \begin_inset Flex Code
25908 status collapsed
25909
25910 \begin_layout Plain Layout
25911
25912 \backslash
25913 renewcommand{
25914 \backslash
25915 headrulewidth}{0.4pt}
25916 \end_layout
25917
25918 \end_inset
25919
25920  and
25921 \begin_inset Flex Code
25922 status collapsed
25923
25924 \begin_layout Plain Layout
25925
25926 \backslash
25927 renewcommand{
25928 \backslash
25929 footrulewidth}{0.4pt}
25930 \end_layout
25931
25932 \end_inset
25933
25934  to set the thicknesses.
25935 \end_layout
25936
25937 \begin_layout Standard
25938 You can switch the header/footer settings on and off for individual pages using commands like
25939 \begin_inset Flex Code
25940 status collapsed
25941
25942 \begin_layout Plain Layout
25943
25944 \backslash
25945 thispagestyle{empty}
25946 \end_layout
25947
25948 \end_inset
25949
25950 ,
25951
25952 \begin_inset Flex Code
25953 status collapsed
25954
25955 \begin_layout Plain Layout
25956
25957 \backslash
25958 thispagestyle{plain}
25959 \end_layout
25960
25961 \end_inset
25962
25963 ,
25964  and
25965 \begin_inset Flex Code
25966 status collapsed
25967
25968 \begin_layout Plain Layout
25969
25970 \backslash
25971 thispagestyle{fancy}
25972 \end_layout
25973
25974 \end_inset
25975
25976 .
25977  Simply insert them in the text on the page you want changed and mark them as \SpecialChar TeX
25978  code.
25979  In fact,
25980  title pages are marked as plain by default,
25981  while following pages are marked fancy when using the global fancy setting.
25982 \end_layout
25983
25984 \begin_layout Standard
25985 As a final example,
25986  it is possible to include an image in the header or footer.
25987  Suppose you want to put a company logo in the upper lefthand corner.
25988  You might try something like
25989 \end_layout
25990
25991 \begin_layout Standard
25992
25993 \family typewriter
25994
25995 \backslash
25996 lhead{
25997 \backslash
25998 resizebox{1in}{!}{
25999 \backslash
26000 includegraphics{logo.eps}}}
26001 \end_layout
26002
26003 \begin_layout Standard
26004 \noindent
26005 (you may need to preface this with
26006 \begin_inset Flex Code
26007 status collapsed
26008
26009 \begin_layout Plain Layout
26010
26011 \backslash
26012 usepackage{graphics}
26013 \end_layout
26014
26015 \end_inset
26016
26017  if you don't include graphics elsewhere in your document).
26018 \end_layout
26019
26020 \begin_layout Chapter
26021 \SpecialChar LyX
26022  and the World Wide Web
26023 \end_layout
26024
26025 \begin_layout Standard
26026 \SpecialChar LyX
26027  has long supported the export of documents to various web-friendly formats,
26028  such as HTML.
26029  Before version 2.0,
26030  however,
26031  HTML export was always accomplished by the use of external converters.
26032 \begin_inset Foot
26033 status collapsed
26034
26035 \begin_layout Plain Layout
26036 For details on the use of external converters with \SpecialChar LyX
26037 ,
26038  see the
26039 \emph on
26040 Converters
26041 \emph default
26042  section of the Customization manual.
26043 \end_layout
26044
26045 \end_inset
26046
26047  These fall into two large groups:
26048  there are converters that use \SpecialChar LaTeX
26049  as an intermediate format,
26050  such as
26051 \begin_inset Flex Code
26052 status collapsed
26053
26054 \begin_layout Plain Layout
26055 htlatex
26056 \end_layout
26057
26058 \end_inset
26059
26060 ,
26061
26062 \begin_inset Flex Code
26063 status collapsed
26064
26065 \begin_layout Plain Layout
26066 html2latex
26067 \end_layout
26068
26069 \end_inset
26070
26071 ,
26072  and
26073 \begin_inset Flex Code
26074 status collapsed
26075
26076 \begin_layout Plain Layout
26077 plastex
26078 \end_layout
26079
26080 \end_inset
26081
26082 ,
26083  relying upon \SpecialChar LyX
26084  to produce the \SpecialChar LaTeX
26085 ;
26086  and there is a converter that works directly on \SpecialChar LyX
26087  files,
26088
26089 \begin_inset Flex Code
26090 status collapsed
26091
26092 \begin_layout Plain Layout
26093 e\SpecialChar LyX
26094 er
26095 \end_layout
26096
26097 \end_inset
26098
26099 .
26100  All of these have different advantages and disadvantages.
26101
26102 \end_layout
26103
26104 \begin_layout Standard
26105 The \SpecialChar LaTeX
26106 -based converters have the advantage that,
26107  in principle,
26108  they know everything about the exported document that \SpecialChar LaTeX
26109  does.
26110  Such converters do not care,
26111  for example,
26112  if a certain block of code was produced by \SpecialChar LyX
26113  or was Evil Red Text.
26114  These converters know about
26115 \begin_inset Flex Code
26116 status collapsed
26117
26118 \begin_layout Plain Layout
26119 aux
26120 \end_layout
26121
26122 \end_inset
26123
26124  files,
26125  counters,
26126  and references,
26127  and can often make use of the
26128 \begin_inset Flex Code
26129 status collapsed
26130
26131 \begin_layout Plain Layout
26132 bbl
26133 \end_layout
26134
26135 \end_inset
26136
26137  files generated by Bib\SpecialChar TeX
26138 .
26139  On the other hand,
26140  \SpecialChar LaTeX
26141  is a very hard language to parse—
26142 it is sometimes said that only \SpecialChar TeX
26143  itself understands \SpecialChar TeX
26144 —
26145 and \SpecialChar LaTeX
26146 -based converters will often choke on what seem to be quite simple constructs;
26147  complex ones can throw them completely,
26148  and as of this writing,
26149  for example,
26150  the
26151 \emph on
26152 Embedded Objects
26153 \emph default
26154  manual will not export with
26155 \begin_inset Flex Code
26156 status collapsed
26157
26158 \begin_layout Plain Layout
26159 htlatex
26160 \end_layout
26161
26162 \end_inset
26163
26164 ,
26165  though the others will.
26166  The other issue concerns how math is handled.
26167  These converters typically convert the formulae into little pictures that are then linked from the HTML document.
26168  Since these are actually generated by \SpecialChar LaTeX
26169 ,
26170  they are accurate.
26171  But they do not scale well,
26172  and just getting them to look as if they are actually meant to be in your document—
26173 so that the font sizes seem to be roughly the same—
26174 can be a challenge.
26175 \end_layout
26176
26177 \begin_layout Standard
26178 Alex Fernandez's
26179 \begin_inset Flex Code
26180 status collapsed
26181
26182 \begin_layout Plain Layout
26183 e\SpecialChar LyX
26184 er
26185 \end_layout
26186
26187 \end_inset
26188
26189  (
26190 \begin_inset CommandInset href
26191 LatexCommand href
26192 name "http://pinchito.es/elyxer/"
26193 target "http://pinchito.es/elyxer/"
26194 literal "false"
26195
26196 \end_inset
26197
26198 ) solves some of these problems.
26199  In particular,
26200  the formulae it produces scale perfectly,
26201  since it renders math using a combination of HTML and CSS rather than converting the formulae to images.
26202  But even moderately complex formula are rendered less well than with
26203 \begin_inset Flex Code
26204 status collapsed
26205
26206 \begin_layout Plain Layout
26207 htlatex
26208 \end_layout
26209
26210 \end_inset
26211
26212 ;
26213  this reflects the limitations of HTML.
26214 \begin_inset Foot
26215 status collapsed
26216
26217 \begin_layout Plain Layout
26218 That said,
26219
26220 \begin_inset Flex Code
26221 status collapsed
26222
26223 \begin_layout Plain Layout
26224 e\SpecialChar LyX
26225 er
26226 \end_layout
26227
26228 \end_inset
26229
26230  can also use jsMath and MathJax for equations,
26231  but this setting is only available globally and requires one to have access to a server that runs the backend.
26232 \end_layout
26233
26234 \end_inset
26235
26236  More importantly (as of version 1.1.1,
26237  at least),
26238
26239 \begin_inset Flex Code
26240 status collapsed
26241
26242 \begin_layout Plain Layout
26243 e\SpecialChar LyX
26244 er
26245 \end_layout
26246
26247 \end_inset
26248
26249  has limited support for math macros and no support for user-defined paragraph or character styles.
26250  These limitations make
26251 \begin_inset Flex Code
26252 status collapsed
26253
26254 \begin_layout Plain Layout
26255 e\SpecialChar LyX
26256 er
26257 \end_layout
26258
26259 \end_inset
26260
26261  unsuitable for many of the documents \SpecialChar LyX
26262  users produce.
26263  In principle,
26264  of course,
26265  these problems could be solved,
26266  but the \SpecialChar LyX
26267  developers have decided to follow a different path and have made \SpecialChar LyX
26268  itself capable of writing XHTML,
26269  just as it is capable of writing \SpecialChar LaTeX
26270 ,
26271  DocBook,
26272  and plaintext.
26273 \end_layout
26274
26275 \begin_layout Standard
26276 As of this writing,
26277  XHTML output remains under development and should probably be regarded as
26278 \begin_inset Quotes eld
26279 \end_inset
26280
26281 experimental
26282 \begin_inset Quotes erd
26283 \end_inset
26284
26285 .
26286 \begin_inset Foot
26287 status collapsed
26288
26289 \begin_layout Plain Layout
26290 The file
26291 \begin_inset Flex Code
26292 status collapsed
26293
26294 \begin_layout Plain Layout
26295 development/HTML/HTML.notes
26296 \end_layout
26297
26298 \end_inset
26299
26300 ,
26301  which can be found in the \SpecialChar LyX
26302  source tree or
26303 \begin_inset CommandInset href
26304 LatexCommand href
26305 name "accessed online"
26306 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
26307 literal "false"
26308
26309 \end_inset
26310
26311 ,
26312  usually contains up-to-date information about the state of XHTML output.
26313  See also the list of XHTML bugs on
26314 \begin_inset CommandInset href
26315 LatexCommand href
26316 name "the bug tracker"
26317 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"
26318 literal "false"
26319
26320 \end_inset
26321
26322 .
26323 \end_layout
26324
26325 \end_inset
26326
26327  Still,
26328  the developers have chosen this approach because it has several potential advantages over the other two.
26329 \end_layout
26330
26331 \begin_layout Standard
26332 These advantages are primarily due to the fact that the XHTML output routines,
26333  since they are part of \SpecialChar LyX
26334 ,
26335  know everything \SpecialChar LyX
26336  knows about the document being exported.
26337 \begin_inset Foot
26338 status collapsed
26339
26340 \begin_layout Plain Layout
26341 Another advantage is that,
26342  since these routines are internal to \SpecialChar LyX
26343 ,
26344  they are immune to changes in \SpecialChar LyX
26345 's file format,
26346  or to changes in the semantics of existing insets.
26347 \end_layout
26348
26349 \end_inset
26350
26351  So they know about the table of contents (as displayed in the outline),
26352  about the counters associated with different paragraph styles,
26353  and about user-defined styles.
26354  The XHTML output routines know what \SpecialChar LyX
26355  knows about internationalization,
26356  too,
26357  so they will output
26358 \begin_inset Quotes eld
26359 \end_inset
26360
26361 Chapter 1
26362 \begin_inset Quotes erd
26363 \end_inset
26364
26365  or
26366 \begin_inset Quotes eld
26367 \end_inset
26368
26369
26370 \lang ngerman
26371 Kapitel
26372 \lang english
26373  1
26374 \begin_inset Quotes erd
26375 \end_inset
26376
26377 ,
26378  depending upon the language in effect at the time.
26379
26380 \end_layout
26381
26382 \begin_layout Standard
26383 Quite generally,
26384  the output routines know what \SpecialChar LyX
26385  knows about document layout,
26386  that is,
26387  about how the document is to be rendered on screen.
26388  We use this information when we output the document as XHTML.
26389  In particular,
26390  \SpecialChar LyX
26391
26392 \emph on
26393 automatically
26394 \emph default
26395  generates CSS style information corresponding to the layout information it uses to render the document on screen:
26396  if section headings are supposed to be sans-serif and bold as seen in \SpecialChar LyX
26397 ,
26398  then (by default) they will be sans-serif and bold when viewed in a web browser,
26399  too.
26400  And this is true not just for pre-defined styles,
26401  like Section,
26402  but for any style,
26403  including user-defined styles.
26404  Indeed,
26405  the XHTML output routines make no distinction between user-defined paragraph and
26406 \change_deleted 244031559 1603876931
26407 character
26408 \change_inserted 244031559 1603876940
26409 text
26410 \change_unchanged
26411  styles and \SpecialChar LyX
26412 's own pre-defined styles:
26413  in each case,
26414  everything \SpecialChar LyX
26415  knows about the styles is contained in the layout files.
26416  And much the same is true as regards pre-defined textual insets,
26417  such as footnotes,
26418  and various custom insets.
26419
26420 \end_layout
26421
26422 \begin_layout Standard
26423 The result is that XHTML output can be customized and extended in exactly the same way \SpecialChar LaTeX
26424  output can be customized and extended:
26425  through layout files and modules.
26426  See chapter five of the
26427 \emph on
26428 Customization
26429 \emph default
26430 manual for the details.
26431 \end_layout
26432
26433 \begin_layout Standard
26434 The remainder of this chapter contains more detailed information on XHTML output,
26435  its limitations,
26436  and ways to work around those limitations.
26437 \end_layout
26438
26439 \begin_layout Section
26440 Math Output in XHTML
26441 \end_layout
26442
26443 \begin_layout Standard
26444 \SpecialChar LyX
26445  offers four choices for how math is rendered.
26446  These have various advantages and disadvantages:
26447 \end_layout
26448
26449 \begin_layout Itemize
26450 MathML
26451 \begin_inset Newline newline
26452 \end_inset
26453
26454 MathML is a dialect of XML designed specifically for mathematics on the web,
26455  and it typically renders very well in browsers that support it.
26456  The disadvantage is that not all browsers support MathML,
26457  and support is not complete even in the Gecko-based browsers,
26458  such as Firefox.
26459 \begin_inset Newline newline
26460 \end_inset
26461
26462 If \SpecialChar LyX
26463  is unable to render a formula as MathML—
26464 for example,
26465  if the formula uses the
26466 \begin_inset Flex Code
26467 status collapsed
26468
26469 \begin_layout Plain Layout
26470 xymatrix
26471 \end_layout
26472
26473 \end_inset
26474
26475  package or ERT—
26476 then it will instead output the formula as an image.
26477
26478 \end_layout
26479
26480 \begin_layout Itemize
26481 HTML
26482 \begin_inset Newline newline
26483 \end_inset
26484
26485 As mentioned above,
26486
26487 \begin_inset Flex Code
26488 status collapsed
26489
26490 \begin_layout Plain Layout
26491 elyxer
26492 \end_layout
26493
26494 \end_inset
26495
26496  outputs math as HTML,
26497  styled by CSS.
26498 \begin_inset Foot
26499 status collapsed
26500
26501 \begin_layout Plain Layout
26502 \SpecialChar LyX
26503  has borrowed some of the CSS for its HTML output from
26504 \begin_inset Flex Code
26505 status collapsed
26506
26507 \begin_layout Plain Layout
26508 elyxer
26509 \end_layout
26510
26511 \end_inset
26512
26513 .
26514 \end_layout
26515
26516 \end_inset
26517
26518  For simple formulae,
26519  this can work quite well,
26520  though with more complicated formulae it tends to break down.
26521  Still,
26522  this method has the advantage that it is very widely supported and so it may be appropriate for documents that contain only a little,
26523  fairly simple math.
26524 \begin_inset Newline newline
26525 \end_inset
26526
26527 If Lyx is unable to render a formula as HTML—
26528 for example,
26529  if the formula uses the
26530 \begin_inset Flex Code
26531 status collapsed
26532
26533 \begin_layout Plain Layout
26534 xymatrix
26535 \end_layout
26536
26537 \end_inset
26538
26539  package or ERT—
26540 then it will instead output the formula as an image.
26541
26542 \end_layout
26543
26544 \begin_layout Itemize
26545 Images
26546 \begin_inset Newline newline
26547 \end_inset
26548
26549 Like
26550 \begin_inset Flex Code
26551 status collapsed
26552
26553 \begin_layout Plain Layout
26554 htlatex
26555 \end_layout
26556
26557 \end_inset
26558
26559 ,
26560  \SpecialChar LyX
26561  will output formulae as images,
26562  the very same images,
26563  in fact,
26564  that are used for instant preview.
26565 \begin_inset Foot
26566 status collapsed
26567
26568 \begin_layout Plain Layout
26569 Instant preview does
26570 \emph on
26571 not
26572 \emph default
26573 have to be on for images to be output,
26574  however.
26575 \end_layout
26576
26577 \end_inset
26578
26579  The advantage to this method is that the images are simply generated by \SpecialChar LaTeX
26580 ,
26581  so they are very accurate.
26582  The disadvantage,
26583  as mentioned earlier,
26584  is that these are bitmapped images,
26585  so they do not scale terribly well,
26586  and one cannot copy them,
26587  etc.
26588 \begin_inset Newline newline
26589 \end_inset
26590
26591 The size of the images can be controlled by setting the
26592 \begin_inset Quotes eld
26593 \end_inset
26594
26595 Math Images Scaling
26596 \begin_inset Quotes erd
26597 \end_inset
26598
26599  parameter under
26600 \begin_inset Flex Noun
26601 status collapsed
26602
26603 \begin_layout Plain Layout
26604 Document\SpecialChar menuseparator
26605 Settings\SpecialChar menuseparator
26606 Formats
26607 \end_layout
26608
26609 \end_inset
26610
26611 .
26612 \begin_inset Foot
26613 status collapsed
26614
26615 \begin_layout Plain Layout
26616 For those who want to know,
26617  this controls the resolution of the image in dots per inch and is based upon a default of 75 dpi.
26618 \end_layout
26619
26620 \end_inset
26621
26622
26623 \begin_inset Newline newline
26624 \end_inset
26625
26626 If \SpecialChar LyX
26627  for some reason fails to create an image for a formula (e.g.,
26628  if a required \SpecialChar LaTeX
26629  package is not installed),
26630  then it will fall back to outputing the raw \SpecialChar LaTeX
26631 .
26632 \end_layout
26633
26634 \begin_layout Itemize
26635 \SpecialChar LaTeX
26636
26637 \begin_inset Newline newline
26638 \end_inset
26639
26640 Finally,
26641  \SpecialChar LyX
26642  will happily output math as \SpecialChar LaTeX
26643 .
26644  As well as being the output of last resort,
26645  this method can be used with such tools as
26646 \begin_inset CommandInset href
26647 LatexCommand href
26648 name "jsMath"
26649 target "http://www.math.union.edu/~dpvc/jsMath/"
26650 literal "false"
26651
26652 \end_inset
26653
26654 ,
26655  which uses JavaScript to render \SpecialChar LaTeX
26656  embedded in HTML documents.
26657  \SpecialChar LyX
26658  wraps the \SpecialChar LaTeX
26659  in either a
26660 \begin_inset Flex Code
26661 status collapsed
26662
26663 \begin_layout Plain Layout
26664 span
26665 \end_layout
26666
26667 \end_inset
26668
26669  (for inline formulas) or
26670 \begin_inset Flex Code
26671 status collapsed
26672
26673 \begin_layout Plain Layout
26674 div
26675 \end_layout
26676
26677 \end_inset
26678
26679  (for displayed formulas) with
26680 \begin_inset Flex Code
26681 status collapsed
26682
26683 \begin_layout Plain Layout
26684 class='math'
26685 \end_layout
26686
26687 \end_inset
26688
26689 ,
26690  as is required for jsMath.
26691 \end_layout
26692
26693 \begin_layout Standard
26694 One of these output methods must be selected under
26695 \begin_inset Flex Noun
26696 status collapsed
26697
26698 \begin_layout Plain Layout
26699 Document\SpecialChar menuseparator
26700 Settings\SpecialChar menuseparator
26701 Formats
26702 \end_layout
26703
26704 \end_inset
26705
26706 .
26707  By default,
26708  \SpecialChar LyX
26709  outputs MathML.
26710  This is a document-wide setting,
26711  therefore.
26712 \end_layout
26713
26714 \begin_layout Standard
26715 Eventually,
26716  \SpecialChar LyX
26717  will offer the user the option to select an alternate output method for a particular inset,
26718  say,
26719  one that isn't being rendered very well by MathML.
26720 \begin_inset Foot
26721 status collapsed
26722
26723 \begin_layout Plain Layout
26724 That said,
26725  since \SpecialChar LyX
26726  falls back to images if the inset contains ERT,
26727  then one can force output as an image by putting some harmless ERT into the math,
26728  for example:
26729
26730 \begin_inset Formula $a=b\relax$
26731 \end_inset
26732
26733 .
26734 \end_layout
26735
26736 \end_inset
26737
26738
26739 \end_layout
26740
26741 \begin_layout Section
26742 Bibliography and Citations
26743 \end_layout
26744
26745 \begin_layout Standard
26746 XHTML output fully supports bibliographies and citations.
26747
26748 \end_layout
26749
26750 \begin_layout Standard
26751 Citation labels are generated by the same machinery that generates \SpecialChar LyX
26752 's on-screen labels,
26753  so the labels will look in the output much as they do in \SpecialChar LyX
26754 ,
26755  though better.
26756  If you are using numerical citations,
26757  then \SpecialChar LyX
26758  will output numerical labels,
26759  such as [1] or [17],
26760  rather than simply showing the citation key in square brackets,
26761  as it does on-screen.
26762  If you are using author-year citations,
26763  then \SpecialChar LyX
26764  will add lowercase letters to the years,
26765  just as Bib\SpecialChar TeX
26766  does,
26767  if it finds more than one citation for a given author-year combination.
26768  The labels will be printed with the bibliography entries.
26769  Note that there is,
26770  at present,
26771  no way to customize the appearance of the labels,
26772  for example,
26773  to choose between square brackets and parentheses.
26774 \end_layout
26775
26776 \begin_layout Standard
26777 Bibliography output is handled by the same machinery that handles the presentation of reference information in the citation dialog,
26778  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.
26779  The formatting can be customized in your layout file or,
26780  preferably,
26781  in a module.
26782  See the
26783 \emph on
26784 Customization
26785 \emph default
26786  manual for the details.
26787 \end_layout
26788
26789 \begin_layout Standard
26790 The main defect at present is that cross-referenced information is printed with every entry with which it is associated.
26791  So you can see things like this:
26792 \end_layout
26793
26794 \begin_layout Quote
26795 Jason Stanley,
26796
26797 \begin_inset Quotes eld
26798 \end_inset
26799
26800 Context and Logical Form
26801 \begin_inset Quotes erd
26802 \end_inset
26803
26804 ,
26805  in
26806 \emph on
26807 Language in Context:
26808  Selected Essays
26809 \emph default
26810  (Oxford:
26811  Oxford University Press,
26812  2007),
26813  pp.
26814  30–68.
26815 \end_layout
26816
26817 \begin_layout Quote
26818 Jason Stanley,
26819
26820 \begin_inset Quotes eld
26821 \end_inset
26822
26823 Semantics in Context
26824 \begin_inset Quotes erd
26825 \end_inset
26826
26827 ,
26828  in
26829 \emph on
26830 Language in Context:
26831  Selected Essays
26832 \emph default
26833  (Oxford:
26834  Oxford University Press,
26835  2007),
26836  pp.
26837  201–30.
26838 \end_layout
26839
26840 \begin_layout Standard
26841 This should be fixed before long.
26842 \end_layout
26843
26844 \begin_layout Standard
26845 There is no support at present for sectioned bibliographies.
26846  If you have multiple bibliographies,
26847  then \SpecialChar LyX
26848  will print the same bibliography over and over.
26849 \end_layout
26850
26851 \begin_layout Section
26852 Indexes
26853 \end_layout
26854
26855 \begin_layout Standard
26856 \SpecialChar LyX
26857  will happily export indexes as XHTML,
26858  but with certain limitations at the moment.
26859 \end_layout
26860
26861 \begin_layout Standard
26862 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
26863 \emph on
26864 User's Guide
26865 \emph default
26866 .
26867 \begin_inset Foot
26868 status collapsed
26869
26870 \begin_layout Plain Layout
26871 The main issue here is that \SpecialChar LyX
26872  itself does not really handle these.
26873  It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
26874 .
26875 \end_layout
26876
26877 \end_inset
26878
26879  We'll describe how they are handled using the subsection headings from that section.
26880 \end_layout
26881
26882 \begin_layout Itemize
26883 Grouping Index Entries (aka,
26884  sub-entries):
26885  \SpecialChar LyX
26886  makes an effort to support these,
26887  but the entries must be separated by
26888 \begin_inset Quotes eld
26889 \end_inset
26890
26891  !
26892
26893 \begin_inset Quotes erd
26894 \end_inset
26895
26896 ,
26897  that is,
26898  there must be spaces around the exclamation point.
26899  This is because it is otherwise too difficult to check for escaped exclamation points,
26900  ones in math,
26901  and so forth.
26902 \end_layout
26903
26904 \begin_layout Itemize
26905 Page Ranges:
26906  There is no support at all for page ranges,
26907  since these make no sense with XHMTL.
26908  Instead,
26909  you will just get two index entries,
26910  one at either end.
26911 \end_layout
26912
26913 \begin_layout Itemize
26914 Cross-referencing:
26915  There is no support for cross-referencing.
26916  If \SpecialChar LyX
26917  finds an entry containing the
26918 \begin_inset Quotes eld
26919 \end_inset
26920
26921 |see\SpecialChar ldots
26922
26923 \begin_inset Quotes erd
26924 \end_inset
26925
26926  construct,
26927  it is just dropped,
26928  and the rest is treated as an ordinary index entry.
26929 \end_layout
26930
26931 \begin_layout Itemize
26932 Index Entry Order:
26933  \SpecialChar LyX
26934  does support attempts to fix the sorting order.
26935  It will take what is before the first `@' it finds and use that for sorting,
26936  taking what follows the first `@' to be the actual entry.
26937  At present,
26938  \SpecialChar LyX
26939  does not check for escaped `@',
26940  so do not try to index email addresses.
26941 \end_layout
26942
26943 \begin_layout Itemize
26944 Index Entry Layout:
26945  You can format entries by using the text style dialog,
26946  or by using any other method available within \SpecialChar LyX
26947  itself.
26948  There is no support for constructs like:
26949
26950 \begin_inset Quotes eld
26951 \end_inset
26952
26953 entry|textbf
26954 \begin_inset Quotes erd
26955 \end_inset
26956
26957 .
26958  Indeed,
26959  if \SpecialChar LyX
26960  finds a pipe symbol,
26961  `|',
26962  in an entry,
26963  it will delete it and everything that follows it.
26964 \end_layout
26965
26966 \begin_layout Itemize
26967 Multiple Indexes:
26968  There is no support for multiple indexes.
26969  Rather,
26970  all index entries will be printed as one large index.
26971  To avoid our printing several versions of the index,
26972  we print only the main index,
26973  so make sure you have one.
26974 \end_layout
26975
26976 \begin_layout Section
26977 Nomenclature and Glossary
26978 \end_layout
26979
26980 \begin_layout Standard
26981 There is at present no support for glossaries.
26982  Adding it would be fairly trivial,
26983  and welcome.
26984 \end_layout
26985
26986 \begin_layout Chapter
26987
26988 \change_inserted 1075283030 1616534180
26989 DocBook Output
26990 \end_layout
26991
26992 \begin_layout Standard
26993
26994 \change_inserted 1075283030 1616534386
26995 Apart from HTML,
26996  \SpecialChar LyX
26997  can generate documents in the DocBook XML vocabulary.
26998  With versions 2.3 and before,
26999  only select templates could be used to generate DocBook documents (only version 4).
27000  Starting with \SpecialChar LyX
27001  2.4,
27002  most \SpecialChar LyX
27003  layouts can generate valid DocBook documents (only version 5).
27004  This feature is built into \SpecialChar LyX
27005  and does not require the use of external tools.
27006 \end_layout
27007
27008 \begin_layout Standard
27009
27010 \change_inserted 1075283030 1616534437
27011 The result is that the DocBook output can be customized and extended in exactly the same way \SpecialChar LaTeX
27012  output can be customized and extended:
27013  through layout files and modules.
27014  See chapter five of the
27015 \emph on
27016 Customization
27017 \emph default
27018 manual for the details.
27019 \end_layout
27020
27021 \begin_layout Standard
27022
27023 \change_inserted 1075283030 1616534475
27024 Most \SpecialChar LyX
27025  features are supported with DocBook,
27026  like math output.
27027 \end_layout
27028
27029 \begin_layout Itemize
27030
27031 \change_inserted 1075283030 1616534741
27032 Math output is performed mostly in MathML (the major exception being constructions not supported by \SpecialChar LyX
27033 ,
27034  i.e.
27035  ERTs).
27036  All formulae are also available in raw \SpecialChar TeX
27037  in the DocBook output for further processing.
27038 \end_layout
27039
27040 \begin_layout Itemize
27041
27042 \change_inserted 1075283030 1616534852
27043 Bibliographies and citations are implemented,
27044  including with an external BibTeX file.
27045  Bibliography entries are not prerendered when the detailed information are available,
27046  but rather output with the standard DocBook constructs.
27047  The external DocBook processor is expected to handle the rendering of entries.
27048 \end_layout
27049
27050 \begin_layout Itemize
27051
27052 \change_inserted 1075283030 1616534863
27053 Indexes are supported,
27054  including multiple indices.
27055  Grouping (with
27056 \family typewriter
27057 !
27058 \family default
27059 ),
27060  page ranges,
27061  and cross-references (
27062 \family typewriter
27063 |see
27064 \family default
27065 ) are supported,
27066  with the exception of the same symbols escaped.
27067  Entry order (
27068 \family typewriter
27069 @
27070 \family default
27071 ) and layout (
27072 \family typewriter
27073 |mathbf
27074 \family default
27075 ) are not supported.
27076  There is no support for escaping of index entries.
27077 \end_layout
27078
27079 \begin_layout Itemize
27080
27081 \change_inserted 1075283030 1616534884
27082 Glossaries are implemented.
27083 \end_layout
27084
27085 \begin_layout Standard
27086
27087 \change_inserted 1075283030 1616534894
27088 Two major parameters can be set at the document level.
27089 \end_layout
27090
27091 \begin_layout Itemize
27092
27093 \change_inserted 1075283030 1616534948
27094 Format for tables:
27095  \SpecialChar LyX
27096  can generate tables either as HTML (default value) or CALS,
27097  depending on the user's requirements.
27098  Most DocBook processors accept both formats.
27099 \end_layout
27100
27101 \begin_layout Itemize
27102
27103 \change_inserted 1075283030 1616535006
27104 MathML prefix:
27105  in DocBook,
27106  MathML is included within its own name space,
27107  unlike HTML.
27108  The implication is that there must be an indication of the tags belonging to the MathML standard.
27109  Three choices are offered:
27110
27111 \end_layout
27112
27113 \begin_deeper
27114 \begin_layout Itemize
27115
27116 \change_inserted 1075283030 1616535044
27117 Inline:
27118  the MathML name space is defined for each formula (using the
27119 \family typewriter
27120 xmlns
27121 \family default
27122  attribute on each formula)
27123 \end_layout
27124
27125 \begin_layout Itemize
27126
27127 \change_inserted 1075283030 1616535090
27128 With the
27129 \family typewriter
27130 m
27131 \family default
27132  prefix (default):
27133  the MathML name space is defined at the document level (using the
27134 \family typewriter
27135 xmlns:m
27136 \family default
27137  attribute on the root element).
27138  Each MathML is prefixed with
27139 \family typewriter
27140 m
27141 \family default
27142 :
27143  for instance,
27144
27145 \family typewriter
27146 m:math
27147 \end_layout
27148
27149 \begin_layout Itemize
27150
27151 \change_inserted 1075283030 1616620405
27152 With the
27153 \family typewriter
27154 mml
27155 \family default
27156  prefix:
27157  similar to the
27158 \family typewriter
27159 m
27160 \family default
27161  option,
27162  but with
27163 \family typewriter
27164 mml
27165 \end_layout
27166
27167 \begin_layout Standard
27168
27169 \change_inserted 1075283030 1616620470
27170 This option is especially useful if you want \SpecialChar LyX
27171  to match your personal style or to work with buggy software that only accepts one prefix for MathML.
27172 \change_unchanged
27173
27174 \end_layout
27175
27176 \end_deeper
27177 \begin_layout Chapter
27178 The \SpecialChar LyX
27179  Server
27180 \end_layout
27181
27182 \begin_layout Section
27183 Introduction
27184 \end_layout
27185
27186 \begin_layout Standard
27187 The `\SpecialChar LyX
27188  server' allows other programs to talk to \SpecialChar LyX
27189 ,
27190  invoke \SpecialChar LyX
27191  commands,
27192  and retrieve information about the \SpecialChar LyX
27193  internal state.
27194  This is only intended for advanced users,
27195  but they should find it useful.
27196  It is by writing to the \SpecialChar LyX
27197  server,
27198  for example,
27199  that bibliography managers,
27200  such as JabRef,
27201  are able to
27202 \begin_inset Quotes eld
27203 \end_inset
27204
27205 push
27206 \begin_inset Quotes erd
27207 \end_inset
27208
27209  citations to \SpecialChar LyX
27210 .
27211 \end_layout
27212
27213 \begin_layout Section
27214 Starting the \SpecialChar LyX
27215  Server
27216 \begin_inset CommandInset label
27217 LatexCommand label
27218 name "sec:Starting-the-Server"
27219
27220 \end_inset
27221
27222
27223 \end_layout
27224
27225 \begin_layout Standard
27226 The \SpecialChar LyX
27227  server works through the use of a pair of named pipes.
27228  These are usually located in
27229 \begin_inset Flex Code
27230 status collapsed
27231
27232 \begin_layout Plain Layout
27233 UserDir
27234 \end_layout
27235
27236 \end_inset
27237
27238 ,
27239  (except on Windows,
27240  where
27241 \emph on
27242 local
27243 \emph default
27244  named pipes are special objects located in
27245 \begin_inset Flex Code
27246 status collapsed
27247
27248 \begin_layout Plain Layout
27249
27250 \backslash
27251
27252 \backslash
27253 .
27254 \backslash
27255 pipe
27256 \end_layout
27257
27258 \end_inset
27259
27260 ) and have the names
27261 \begin_inset Quotes eld
27262 \end_inset
27263
27264
27265 \begin_inset Flex Code
27266 status collapsed
27267
27268 \begin_layout Plain Layout
27269 lyxpipe.in
27270 \end_layout
27271
27272 \end_inset
27273
27274
27275 \begin_inset Quotes erd
27276 \end_inset
27277
27278  and
27279 \begin_inset Quotes eld
27280 \end_inset
27281
27282
27283 \begin_inset Flex Code
27284 status collapsed
27285
27286 \begin_layout Plain Layout
27287 lyxpipe.out
27288 \end_layout
27289
27290 \end_inset
27291
27292
27293 \begin_inset Quotes erd
27294 \end_inset
27295
27296 .
27297  External programs write into
27298 \begin_inset Flex Code
27299 status collapsed
27300
27301 \begin_layout Plain Layout
27302 lyxpipe.in
27303 \end_layout
27304
27305 \end_inset
27306
27307  and read back data from
27308 \begin_inset Flex Code
27309 status collapsed
27310
27311 \begin_layout Plain Layout
27312 lyxpipe.out
27313 \end_layout
27314
27315 \end_inset
27316
27317 .
27318  The stem of the pipe names can be defined in the
27319 \begin_inset Flex Noun
27320 status collapsed
27321
27322 \begin_layout Plain Layout
27323 Tools\SpecialChar menuseparator
27324 Preferences
27325 \end_layout
27326
27327 \end_inset
27328
27329  dialog,
27330  for example
27331 \begin_inset Flex Code
27332 status collapsed
27333
27334 \begin_layout Plain Layout
27335 "/home/myhome/lyxpipe"
27336 \end_layout
27337
27338 \end_inset
27339
27340 ,
27341  or
27342 \begin_inset Flex Code
27343 status collapsed
27344
27345 \begin_layout Plain Layout
27346 "
27347 \backslash
27348
27349 \backslash
27350 .
27351 \backslash
27352 pipe
27353 \backslash
27354 lyxpipe"
27355 \end_layout
27356
27357 \end_inset
27358
27359  on Windows (where any working path instead of lyxpipe can be used,
27360  for example
27361 \begin_inset Flex Code
27362 status collapsed
27363
27364 \begin_layout Plain Layout
27365 "
27366 \backslash
27367
27368 \backslash
27369 .
27370 \backslash
27371 pipe
27372 \backslash
27373 my
27374 \backslash
27375 lyx
27376 \backslash
27377 pipe"
27378 \end_layout
27379
27380 \end_inset
27381
27382  would also work).
27383  You
27384 \emph on
27385 must
27386 \emph default
27387  configure this manually in order for the server to start.
27388 \end_layout
27389
27390 \begin_layout Standard
27391 \SpecialChar LyX
27392  will add the '
27393 \begin_inset Flex Code
27394 status collapsed
27395
27396 \begin_layout Plain Layout
27397 .in
27398 \end_layout
27399
27400 \end_inset
27401
27402 ' and '
27403 \begin_inset Flex Code
27404 status collapsed
27405
27406 \begin_layout Plain Layout
27407 .out
27408 \end_layout
27409
27410 \end_inset
27411
27412 ' to create the pipes.
27413  If one of the pipes already exists,
27414  \SpecialChar LyX
27415  will assume that another \SpecialChar LyX
27416  process is already running and will not start the server.
27417  On POSIX (Unix like) systems,
27418  if for some other reason,
27419  an unused
27420 \begin_inset Quotes eld
27421 \end_inset
27422
27423 stale
27424 \begin_inset Quotes erd
27425 \end_inset
27426
27427  pipe is left in existence when \SpecialChar LyX
27428  closes,
27429  then \SpecialChar LyX
27430  will try to delete it.
27431  If this fails for some reason,
27432  you will need to delete the pipes manually and then restart \SpecialChar LyX
27433 .
27434  On Windows,
27435  pipes are deleted by the OS on program termination or crash,
27436  so
27437 \begin_inset Quotes eld
27438 \end_inset
27439
27440 stale
27441 \begin_inset Quotes erd
27442 \end_inset
27443
27444  pipes should not be possible.
27445 \end_layout
27446
27447 \begin_layout Standard
27448 To have several \SpecialChar LyX
27449  processes with servers at the same time,
27450  you have to use different configurations,
27451  perhaps by using separate user directories,
27452  each with its own
27453 \begin_inset Flex Code
27454 status collapsed
27455
27456 \begin_layout Plain Layout
27457 preferences
27458 \end_layout
27459
27460 \end_inset
27461
27462  file,
27463  for each process.
27464 \end_layout
27465
27466 \begin_layout Standard
27467 If you are developing a client program,
27468  you might find it useful to enable debugging information from the \SpecialChar LyX
27469  server.
27470  Do this by starting \SpecialChar LyX
27471  as
27472 \begin_inset Flex Code
27473 status collapsed
27474
27475 \begin_layout Plain Layout
27476 lyx -dbg lyxserver
27477 \end_layout
27478
27479 \end_inset
27480
27481 .
27482 \end_layout
27483
27484 \begin_layout Standard
27485 You can find a complete example client written in C++ in the source distribution as
27486 \begin_inset Flex Code
27487 status collapsed
27488
27489 \begin_layout Plain Layout
27490 development/lyxserver/server_monitor.cpp
27491 \end_layout
27492
27493 \end_inset
27494
27495 .
27496 \end_layout
27497
27498 \begin_layout Standard
27499 Another useful tool is the command-line based client found in
27500 \begin_inset Flex Code
27501 status collapsed
27502
27503 \begin_layout Plain Layout
27504 src/client/lyxclient
27505 \end_layout
27506
27507 \end_inset
27508
27509 .
27510 \end_layout
27511
27512 \begin_layout Section
27513 Normal communication
27514 \end_layout
27515
27516 \begin_layout Standard
27517 To issue a \SpecialChar LyX
27518  call,
27519  the client writes a line of ASCII text into the input pipe.
27520  This line has the following format:
27521 \end_layout
27522
27523 \begin_layout Quote
27524 LYXCMD:
27525 \emph on
27526 clientname
27527 \emph default
27528 :
27529 \emph on
27530 function
27531 \emph default
27532 :
27533 \emph on
27534 argument
27535 \end_layout
27536
27537 \begin_layout Description
27538 clientname is a name that the client can choose arbitrarily.
27539  Its only use is that \SpecialChar LyX
27540  will echo it if it sends an answer—
27541 so a client can dispatch results from different requesters.
27542 \end_layout
27543
27544 \begin_layout Description
27545 function is the function you want \SpecialChar LyX
27546  to perform.
27547  It is the same as the commands you'd use in the minibuffer.
27548 \end_layout
27549
27550 \begin_layout Description
27551 argument is an optional argument which is meaningful only to some functions (for instance,
27552  the
27553 \begin_inset Quotes eld
27554 \end_inset
27555
27556 self-insert
27557 \begin_inset Quotes erd
27558 \end_inset
27559
27560  LFUN will insert the argument as text at the cursor position).
27561 \end_layout
27562
27563 \begin_layout Standard
27564 The answer from \SpecialChar LyX
27565  will arrive in the output pipe and be of the form
27566 \end_layout
27567
27568 \begin_layout Quote
27569 INFO:
27570 \emph on
27571 clientname
27572 \emph default
27573 :
27574 \emph on
27575 function
27576 \emph default
27577 :
27578 \emph on
27579 data
27580 \end_layout
27581
27582 \begin_layout Standard
27583 where
27584 \emph on
27585 clientname
27586 \emph default
27587  and
27588 \emph on
27589 function
27590 \emph default
27591  are just echoed from the command request,
27592  while
27593 \emph on
27594 data
27595 \emph default
27596  is more or less useful information filled according to how the command execution worked out.
27597  Some commands,
27598  such as
27599 \begin_inset Quotes eld
27600 \end_inset
27601
27602 font-state
27603 \begin_inset Quotes erd
27604 \end_inset
27605
27606 ,
27607  will return information about the internal state of \SpecialChar LyX
27608 ,
27609  while other will return an empty data-response.
27610  This means that the command execution went fine.
27611 \end_layout
27612
27613 \begin_layout Standard
27614 In case of errors,
27615  the response from \SpecialChar LyX
27616  will have this form
27617 \end_layout
27618
27619 \begin_layout Quote
27620 ERROR:
27621 \emph on
27622 clientname
27623 \emph default
27624 :
27625 \emph on
27626 function
27627 \emph default
27628 :
27629 \emph on
27630 error message
27631 \end_layout
27632
27633 \begin_layout Standard
27634 where the
27635 \emph on
27636 error message
27637 \emph default
27638  should contain an explanation of why the command failed.
27639 \end_layout
27640
27641 \begin_layout Standard
27642 Examples:
27643 \end_layout
27644
27645 \begin_layout LyX-Code
27646 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
27647 \begin_inset Newline newline
27648 \end_inset
27649
27650 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
27651 \begin_inset Newline newline
27652 \end_inset
27653
27654 read a <~/.lyxpipe.out
27655 \begin_inset Newline newline
27656 \end_inset
27657
27658 echo $a
27659 \end_layout
27660
27661 \begin_layout Subsection
27662 AppleScript (Mac OS X)
27663 \end_layout
27664
27665 \begin_layout Standard
27666 Since \SpecialChar LyX
27667  2.1,
27668  \SpecialChar LyX
27669  supports basic interactions with AppleScript for normal communication through the command run.
27670  This command takes a direct argument (the
27671 \series bold
27672 function
27673 \series default
27674  to perform) and an optional argument.
27675  It either returns the output of the function or triggers an error with the error message and code.
27676 \end_layout
27677
27678 \begin_layout Standard
27679 Example:
27680 \end_layout
27681
27682 \begin_layout LyX-Code
27683 tell application "\SpecialChar LyX
27684 "
27685 \end_layout
27686
27687 \begin_layout LyX-Code
27688   try
27689 \end_layout
27690
27691 \begin_layout LyX-Code
27692     -- Stores the current file name into f
27693 \end_layout
27694
27695 \begin_layout LyX-Code
27696     set f to (run "server-get-filename" with argument "")
27697 \end_layout
27698
27699 \begin_layout LyX-Code
27700     on error the error_message number the error_number
27701 \end_layout
27702
27703 \begin_layout LyX-Code
27704       display dialog "Error:
27705  " & the error_number & ".
27706  " ¬
27707 \end_layout
27708
27709 \begin_layout LyX-Code
27710               & the error_message buttons {"OK"} default button 1
27711 \end_layout
27712
27713 \begin_layout LyX-Code
27714   end try
27715 \end_layout
27716
27717 \begin_layout LyX-Code
27718 end tell
27719 \end_layout
27720
27721 \begin_layout Section
27722 Notification
27723 \end_layout
27724
27725 \begin_layout Standard
27726 \SpecialChar LyX
27727  can notify clients of events going on asynchronously.
27728  Currently it will only do this if the user binds a key sequence with the function
27729 \begin_inset Quotes eld
27730 \end_inset
27731
27732 notify
27733 \begin_inset Quotes erd
27734 \end_inset
27735
27736 .
27737  The format of the string \SpecialChar LyX
27738  sends is as follows:
27739 \end_layout
27740
27741 \begin_layout Quote
27742 \begin_inset Flex Code
27743 status collapsed
27744
27745 \begin_layout Plain Layout
27746 NOTIFY:
27747 \end_layout
27748
27749 \end_inset
27750
27751
27752 \emph on
27753 key-sequence
27754 \end_layout
27755
27756 \begin_layout Standard
27757 where
27758 \emph on
27759 key-sequence
27760 \emph default
27761  is the printed representation of the key sequence that was actually typed by the user.
27762 \end_layout
27763
27764 \begin_layout Standard
27765 This mechanism can be used to extend \SpecialChar LyX
27766 's command set and implement macros.
27767  Bind some key sequence to
27768 \begin_inset Quotes eld
27769 \end_inset
27770
27771 notify
27772 \begin_inset Quotes erd
27773 \end_inset
27774
27775 .
27776  Then start a client that listens on the output pipe,
27777  dispatches the command according to the sequence,
27778  and starts a function that may use \SpecialChar LyX
27779  calls and \SpecialChar LyX
27780  requests to issue a command or a series of commands to \SpecialChar LyX
27781 .
27782 \end_layout
27783
27784 \begin_layout Section
27785 The simple \SpecialChar LyX
27786  Server Protocol
27787 \end_layout
27788
27789 \begin_layout Standard
27790 \SpecialChar LyX
27791  implements a simple protocol that can be used for session management.
27792  All messages are of the form
27793 \end_layout
27794
27795 \begin_layout Quote
27796 LYXSRV:
27797 \emph on
27798 clientname
27799 \emph default
27800 :
27801 \emph on
27802 protocol message
27803 \end_layout
27804
27805 \begin_layout Standard
27806 where
27807 \emph on
27808 protocol message
27809 \emph default
27810  can be
27811 \begin_inset Quotes eld
27812 \end_inset
27813
27814 hello
27815 \begin_inset Quotes erd
27816 \end_inset
27817
27818  or
27819 \begin_inset Quotes eld
27820 \end_inset
27821
27822 bye
27823 \begin_inset Quotes erd
27824 \end_inset
27825
27826 .
27827  If
27828 \begin_inset Quotes eld
27829 \end_inset
27830
27831 hello
27832 \begin_inset Quotes erd
27833 \end_inset
27834
27835  is received from a client,
27836  \SpecialChar LyX
27837  will report back to inform the client that it's listening to it's messages,
27838  while
27839 \begin_inset Quotes eld
27840 \end_inset
27841
27842 bye
27843 \begin_inset Quotes erd
27844 \end_inset
27845
27846  sent from \SpecialChar LyX
27847  will inform clients that \SpecialChar LyX
27848  is closing.
27849 \end_layout
27850
27851 \begin_layout Section
27852 Reverse DVI/PDF search
27853 \end_layout
27854
27855 \begin_layout Standard
27856 Some DVI/PDF viewers
27857 \begin_inset Foot
27858 status collapsed
27859
27860 \begin_layout Plain Layout
27861 The following viewers offer the reverse PDF search feature:
27862  Okular on KDE/Linux,
27863  Qpdfview on Unix,
27864  Skim on Mac OSX and SumatraPDF on Windows.
27865 \end_layout
27866
27867 \end_inset
27868
27869  provide
27870 \emph on
27871 reverse search
27872 \emph default
27873  facility (also called
27874 \emph on
27875 inverse search
27876 \emph default
27877 ).
27878  This means that you can tell \SpecialChar LyX
27879  to put the cursor to a specific line in the document by clicking at the respective position in the DVI/PDF output.
27880  To achieve this,
27881  the viewer must be able to communicate with \SpecialChar LyX
27882 .
27883  This is done via the \SpecialChar LyX
27884  server either by using the named pipe (
27885 \emph on
27886 lyxpipe
27887 \emph default
27888 ),
27889  or the UNIX domain socket (
27890 \emph on
27891 lyxsocket
27892 \emph default
27893 ) that \SpecialChar LyX
27894  creates in its temporary directory (this is the way the
27895 \begin_inset Flex Code
27896 status collapsed
27897
27898 \begin_layout Plain Layout
27899 lyxclient
27900 \end_layout
27901
27902 \end_inset
27903
27904  program communicates with \SpecialChar LyX
27905 ).
27906  In some cases,
27907  you need a helper script that mediates between the viewer and \SpecialChar LyX
27908 ,
27909  in others,
27910  the viewer can communicate with \SpecialChar LyX
27911  directly.
27912  This depends on the selected viewer and on your operating system.
27913  The same applies to the way viewers need to be configured and the way the reverse search is actually performed.
27914  In what follows,
27915  we will thus describe how to setup reverse search for specific viewers.
27916  Before we turn to this,
27917  though,
27918  we will explain what needs to be done generally to enable reverse search in the DVI/PDF output.
27919 \end_layout
27920
27921 \begin_layout Subsection
27922 Automatic setup
27923 \begin_inset CommandInset label
27924 LatexCommand label
27925 name "subsec:rev-search"
27926
27927 \end_inset
27928
27929
27930 \end_layout
27931
27932 \begin_layout Standard
27933 In most cases \SpecialChar LyX
27934  will do the work for you by pressing the following button in the toolbar:
27935
27936 \begin_inset Info
27937 type  "icon"
27938 arg   "buffer-toggle-output-sync"
27939 \end_inset
27940
27941 .
27942  Alternatively,
27943  you can also enable the feature by checking
27944 \family sans
27945 Synchronize with Output
27946 \family default
27947  in
27948 \begin_inset Flex Noun
27949 status collapsed
27950
27951 \begin_layout Plain Layout
27952 Document\SpecialChar menuseparator
27953 Settings\SpecialChar menuseparator
27954 Formats
27955 \end_layout
27956
27957 \end_inset
27958
27959 .
27960  In such a case \SpecialChar LyX
27961  will automatically insert the necessary Sync\SpecialChar TeX
27962  macro (for PDF) or load the srcltx package (for DVI) respectively.
27963  This option can be easily reached also on
27964 \begin_inset Flex Code
27965 status collapsed
27966
27967 \begin_layout Plain Layout
27968 View/Update
27969 \end_layout
27970
27971 \end_inset
27972
27973  Toolbar.
27974 \end_layout
27975
27976 \begin_layout Standard
27977 If you need a different setting,
27978  you can select or input a custom macro from the drop down box just below
27979 \begin_inset Flex Noun
27980 status collapsed
27981
27982 \begin_layout Plain Layout
27983 Document\SpecialChar menuseparator
27984 Settings\SpecialChar menuseparator
27985 Output\SpecialChar menuseparator
27986 Synchronize with Output
27987 \end_layout
27988
27989 \end_inset
27990
27991 .
27992 \end_layout
27993
27994 \begin_layout Standard
27995 Note that the method
27996 \begin_inset Flex Code
27997 status collapsed
27998
27999 \begin_layout Plain Layout
28000
28001 \backslash
28002 synctex=1
28003 \end_layout
28004
28005 \end_inset
28006
28007  enables gzip compression.
28008  If your viewer does not support it,
28009  you should instead use
28010 \begin_inset Flex Code
28011 status collapsed
28012
28013 \begin_layout Plain Layout
28014
28015 \backslash
28016 synctex=-1
28017 \end_layout
28018
28019 \end_inset
28020
28021 .
28022 \end_layout
28023
28024 \begin_layout Standard
28025 Please also note that including the
28026 \begin_inset Flex Code
28027 status collapsed
28028
28029 \begin_layout Plain Layout
28030 srcltx
28031 \end_layout
28032
28033 \end_inset
28034
28035  package or
28036 \begin_inset Flex Code
28037 status collapsed
28038
28039 \begin_layout Plain Layout
28040 src-specials
28041 \end_layout
28042
28043 \end_inset
28044
28045  sometimes has an undesired impact on the typesetting.
28046  Thus,
28047  you should switch output synchronization off for the final typesetting if you use the
28048 \begin_inset Flex Code
28049 status collapsed
28050
28051 \begin_layout Plain Layout
28052 srcltx
28053 \end_layout
28054
28055 \end_inset
28056
28057  package or
28058 \begin_inset Flex Code
28059 status collapsed
28060
28061 \begin_layout Plain Layout
28062 src-specials
28063 \end_layout
28064
28065 \end_inset
28066
28067 .
28068
28069 \end_layout
28070
28071 \begin_layout Standard
28072 In case you need some more special settings that are not covered by the automatic settings,
28073  read the next section about how to set up output synchronization manually.
28074  If the automatic setup suits your needs,
28075  you can readily jump to section
28076 \begin_inset space ~
28077 \end_inset
28078
28079
28080 \begin_inset CommandInset ref
28081 LatexCommand ref
28082 reference "subsec:configuring-viewers"
28083 nolink "false"
28084
28085 \end_inset
28086
28087 ,
28088  where the necessary configuration steps in your viewer – needed both with the automatic and the manual setup – are described.
28089 \end_layout
28090
28091 \begin_layout Subsection
28092 Manual setup
28093 \end_layout
28094
28095 \begin_layout Standard
28096 \SpecialChar LaTeX
28097  provides several different methods for reverse search.
28098  Some are built-in in the
28099 \begin_inset Flex Code
28100 status collapsed
28101
28102 \begin_layout Plain Layout
28103 latex/pdflatex
28104 \end_layout
28105
28106 \end_inset
28107
28108  program,
28109  some are provided by external packages.
28110  Your choice depends on whether your \SpecialChar LaTeX
28111  distribution already provides a given method (the built-in methods are rather new) and whether your viewer can cope with it.
28112  The available methods are described in the following.
28113 \end_layout
28114
28115 \begin_layout Subsubsection*
28116 Built-in DVI-search via src-specials (DVI only)
28117 \end_layout
28118
28119 \begin_layout Standard
28120 This method provides the DVI file with the necessary information for reverse search.
28121  It is available in \SpecialChar LaTeX
28122  since quite some time (any somewhat recent \SpecialChar LaTeX
28123  distribution should include it),
28124  and it works reliably.
28125  To enable it,
28126  change the
28127 \begin_inset Flex Noun
28128 status collapsed
28129
28130 \begin_layout Plain Layout
28131 La
28132 \family sans
28133 TeX
28134 \family default
28135  (plain)->DVI
28136 \end_layout
28137
28138 \end_inset
28139
28140  or
28141 \begin_inset Flex Noun
28142 status collapsed
28143
28144 \begin_layout Plain Layout
28145 La
28146 \family sans
28147 TeX
28148 \family default
28149  (plain)->DraftDVI
28150 \end_layout
28151
28152 \end_inset
28153
28154  converter in
28155 \begin_inset Flex Noun
28156 status collapsed
28157
28158 \begin_layout Plain Layout
28159 Preferences\SpecialChar menuseparator
28160 File Handling\SpecialChar menuseparator
28161 Converters
28162 \end_layout
28163
28164 \end_inset
28165
28166  to
28167 \begin_inset Flex Code
28168 status collapsed
28169
28170 \begin_layout Plain Layout
28171 latex -src-specials $$i
28172 \end_layout
28173
28174 \end_inset
28175
28176 .
28177  If this doesn't work,
28178  check if your \SpecialChar TeX
28179  engine needs different options (the syntax might differ in some distributions).
28180 \end_layout
28181
28182 \begin_layout Subsubsection*
28183 External Packages (PDFSync and scrltx)
28184 \end_layout
28185
28186 \begin_layout Standard
28187 The packages
28188 \emph on
28189 pdfsync
28190 \emph default
28191  and
28192 \emph on
28193 scrltx
28194 \emph default
28195  provide reverse search facility for PDF output (via pdflatex) and DVI output,
28196  respectively.
28197  In order to enable it,
28198  load the packages in the \SpecialChar LyX
28199  preamble:
28200
28201 \end_layout
28202
28203 \begin_layout Itemize
28204 \begin_inset Flex Code
28205 status collapsed
28206
28207 \begin_layout Plain Layout
28208
28209 \backslash
28210 usepackage{pdfsync}
28211 \end_layout
28212
28213 \end_inset
28214
28215  for reverse PDF search,
28216 \end_layout
28217
28218 \begin_layout Itemize
28219 \begin_inset Flex Code
28220 status collapsed
28221
28222 \begin_layout Plain Layout
28223
28224 \backslash
28225 usepackage[active]{srcltx}
28226 \end_layout
28227
28228 \end_inset
28229
28230  for reverse DVI search.
28231 \end_layout
28232
28233 \begin_layout Standard
28234 If you want to be able to perform both DVI and PDF reverse searches,
28235  you can also insert in the preamble the following lines
28236 \end_layout
28237
28238 \begin_layout LyX-Code
28239
28240 \backslash
28241 usepackage{ifpdf}
28242 \begin_inset Newline newline
28243 \end_inset
28244
28245
28246 \backslash
28247 ifpdf
28248 \begin_inset Newline newline
28249 \end_inset
28250
28251
28252 \backslash
28253 usepackage{pdfsync}
28254 \begin_inset Newline newline
28255 \end_inset
28256
28257
28258 \backslash
28259 else
28260 \begin_inset Newline newline
28261 \end_inset
28262
28263
28264 \backslash
28265 usepackage[active]{srcltx}
28266 \begin_inset Newline newline
28267 \end_inset
28268
28269
28270 \backslash
28271 fi
28272 \end_layout
28273
28274 \begin_layout Standard
28275 This way,
28276  you can preview the file as either DVI or PDF (pdflatex) and the right package will be used.
28277 \end_layout
28278
28279 \begin_layout Standard
28280 Note that PDFSync might affect the output layout of your document.
28281  It is therefore advised to disable PDFsync for final documents.
28282 \end_layout
28283
28284 \begin_layout Subsubsection*
28285 Built-in reverse search via Sync\SpecialChar TeX
28286  (DVI and PDF)
28287 \end_layout
28288
28289 \begin_layout Standard
28290 Recent versions of
28291 \begin_inset Flex Code
28292 status collapsed
28293
28294 \begin_layout Plain Layout
28295 (pdf)latex
28296 \end_layout
28297
28298 \end_inset
28299
28300  have built-in support for both PDF and DVI reverse search.
28301  This so-called
28302 \emph on
28303 Sync\SpecialChar TeX
28304
28305 \emph default
28306  facility is basically the result of the integration of the PDFSync package to the pdftex program and its merge with the
28307 \emph on
28308 scr-specials
28309 \emph default
28310  approach.
28311  You need at least \SpecialChar TeX
28312 Live 2008 or a recent Mik\SpecialChar TeX
28313  distribution in order to use it.
28314 \begin_inset Foot
28315 status collapsed
28316
28317 \begin_layout Plain Layout
28318 For some reason,
28319  Mik\SpecialChar TeX
28320  does not understand/obey the command \SpecialChar LyX
28321  inserts into the preamble when you check the "Enable Forward/Reverse Search" button in the toolbar and does not generate the necessary info.
28322 \end_layout
28323
28324 \begin_layout Plain Layout
28325 The generation of the required info can be forced by changing the converter "\SpecialChar LaTeX
28326  (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e.,
28327  by adding the -synctex=1 switch).
28328 \end_layout
28329
28330 \end_inset
28331
28332  Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
28333  Skim on the Mac,
28334  SumatraPDF on Windows;
28335  see the next section for details) already provide Sync\SpecialChar TeX
28336  support.
28337 \end_layout
28338
28339 \begin_layout Standard
28340 To enable Sync\SpecialChar TeX
28341  for DVI output,
28342  change the
28343 \begin_inset Flex Noun
28344 status collapsed
28345
28346 \begin_layout Plain Layout
28347 La
28348 \family sans
28349 TeX
28350 \family default
28351  (plain) -> DVI
28352 \end_layout
28353
28354 \end_inset
28355
28356  or
28357 \begin_inset Flex Noun
28358 status collapsed
28359
28360 \begin_layout Plain Layout
28361 La
28362 \family sans
28363 TeX
28364 \family default
28365  (plain) -> DraftDVI
28366 \end_layout
28367
28368 \end_inset
28369
28370  converter in
28371 \begin_inset Flex Noun
28372 status collapsed
28373
28374 \begin_layout Plain Layout
28375 Preferences\SpecialChar menuseparator
28376 File Handling\SpecialChar menuseparator
28377 Converters
28378 \end_layout
28379
28380 \end_inset
28381
28382  to
28383 \begin_inset Flex Code
28384 status collapsed
28385
28386 \begin_layout Plain Layout
28387 latex -synctex=1 $$i
28388 \end_layout
28389
28390 \end_inset
28391
28392 ,
28393  and for PDF output,
28394  change the
28395 \begin_inset Flex Noun
28396 status collapsed
28397
28398 \begin_layout Plain Layout
28399 La
28400 \family sans
28401 TeX
28402 \family default
28403  (pdflatex) -> PDF (pdflatex)
28404 \end_layout
28405
28406 \end_inset
28407
28408  converter to
28409 \begin_inset Flex Code
28410 status collapsed
28411
28412 \begin_layout Plain Layout
28413 pdflatex -synctex=1 $$i
28414 \end_layout
28415
28416 \end_inset
28417
28418 .
28419  Should your viewer not be considered in the following description,
28420  or in case of missing success,
28421  please check the documentation of your viewer whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
28422 .
28423 \begin_inset Foot
28424 status collapsed
28425
28426 \begin_layout Plain Layout
28427 Note that the option
28428 \begin_inset Flex Code
28429 status collapsed
28430
28431 \begin_layout Plain Layout
28432 -synctex=1
28433 \end_layout
28434
28435 \end_inset
28436
28437  option enables gzip compression.
28438  If your viewer does not support it,
28439  you should instead use
28440 \begin_inset Flex Code
28441 status collapsed
28442
28443 \begin_layout Plain Layout
28444 -synctex=-1
28445 \end_layout
28446
28447 \end_inset
28448
28449 .
28450 \end_layout
28451
28452 \end_inset
28453
28454
28455 \end_layout
28456
28457 \begin_layout Subsection
28458 Configuring and using specific viewers
28459 \begin_inset CommandInset label
28460 LatexCommand label
28461 name "subsec:configuring-viewers"
28462
28463 \end_inset
28464
28465
28466 \end_layout
28467
28468 \begin_layout Subsubsection*
28469 Xdvi (all platforms)
28470 \end_layout
28471
28472 \begin_layout Standard
28473 If you use
28474 \begin_inset Flex Code
28475 status collapsed
28476
28477 \begin_layout Plain Layout
28478 xdvi
28479 \end_layout
28480
28481 \end_inset
28482
28483 ,
28484  you don't need to do anything else for performing a reverse DVI search,
28485  as \SpecialChar LyX
28486  already provides the necessary hooks for automatically using the
28487 \begin_inset Flex Code
28488 status collapsed
28489
28490 \begin_layout Plain Layout
28491 lyxclient
28492 \end_layout
28493
28494 \end_inset
28495
28496  program.
28497  Just setup your document as described above (reverse search is triggered by Ctrl-click or Alt-click on Mac OSX,
28498  respectively).
28499 \end_layout
28500
28501 \begin_layout Standard
28502 However,
28503  if for whatever reason you want to use the named pipe instead of the socket for communicating with \SpecialChar LyX
28504 ,
28505  simply change the DVI viewer in
28506 \begin_inset Flex Noun
28507 status collapsed
28508
28509 \begin_layout Plain Layout
28510 Preferences\SpecialChar menuseparator
28511 File Handling\SpecialChar menuseparator
28512 File formats
28513 \end_layout
28514
28515 \end_inset
28516
28517  to
28518 \begin_inset Foot
28519 status collapsed
28520
28521 \begin_layout Plain Layout
28522 On Mac OSX you have to use
28523 \begin_inset Flex Code
28524 status collapsed
28525
28526 \begin_layout Plain Layout
28527 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
28528 \end_layout
28529
28530 \end_inset
28531
28532
28533 \end_layout
28534
28535 \end_inset
28536
28537
28538 \begin_inset Flex Code
28539 status collapsed
28540
28541 \begin_layout Plain Layout
28542 xdvi -editor "lyxeditor.sh %f %l"
28543 \end_layout
28544
28545 \end_inset
28546
28547 ,
28548  where
28549 \begin_inset Flex Code
28550 status collapsed
28551
28552 \begin_layout Plain Layout
28553 lyxeditor.sh
28554 \end_layout
28555
28556 \end_inset
28557
28558  is a suitable script.
28559  For example,
28560  a minimal shell script is the following one:
28561 \end_layout
28562
28563 \begin_layout LyX-Code
28564 #!/bin/sh
28565 \begin_inset Newline newline
28566 \end_inset
28567
28568 LYXPIPE="/path/to/lyxpipe"
28569 \begin_inset Newline newline
28570 \end_inset
28571
28572 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
28573 \begin_inset Newline newline
28574 \end_inset
28575
28576 echo "$COMMAND" > "${LYXPIPE}".in || exit
28577 \begin_inset Newline newline
28578 \end_inset
28579
28580 read TMP < "${LYXPIPE}".out || exit
28581 \end_layout
28582
28583 \begin_layout Standard
28584 where
28585 \begin_inset Flex Code
28586 status collapsed
28587
28588 \begin_layout Plain Layout
28589 /path/to/lyxpipe
28590 \end_layout
28591
28592 \end_inset
28593
28594  is the LyXServer pipe path specified in
28595 \begin_inset Flex Noun
28596 status collapsed
28597
28598 \begin_layout Plain Layout
28599 Preferences\SpecialChar menuseparator
28600 Paths
28601 \end_layout
28602
28603 \end_inset
28604
28605 .
28606 \begin_inset Foot
28607 status collapsed
28608
28609 \begin_layout Plain Layout
28610 In the
28611 \begin_inset Flex Code
28612 status collapsed
28613
28614 \begin_layout Plain Layout
28615 development/tools
28616 \end_layout
28617
28618 \end_inset
28619
28620  folder of a source distribution you can find a
28621 \begin_inset Flex Code
28622 status collapsed
28623
28624 \begin_layout Plain Layout
28625 lyxeditor
28626 \end_layout
28627
28628 \end_inset
28629
28630  script which is able to locate the
28631 \emph on
28632 lyxpipe
28633 \emph default
28634  based on your preferences.
28635 \end_layout
28636
28637 \end_inset
28638
28639
28640 \end_layout
28641
28642 \begin_layout Subsubsection*
28643 MacDviX (Mac OSX)
28644 \end_layout
28645
28646 \begin_layout Standard
28647 At the end of
28648 \begin_inset Flex Code
28649 status collapsed
28650
28651 \begin_layout Plain Layout
28652 /Applications/MacDviX_Folder/calleditor.script
28653 \end_layout
28654
28655 \end_inset
28656
28657 ,
28658  add the following lines:
28659 \end_layout
28660
28661 \begin_layout LyX-Code
28662 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
28663 \begin_inset Newline newline
28664 \end_inset
28665
28666 exit 1
28667 \end_layout
28668
28669 \begin_layout Standard
28670 Modify the lines accordingly if you install \SpecialChar LyX
28671  somewhere else than in the Applications folder.
28672 \end_layout
28673
28674 \begin_layout Standard
28675 Reverse search is triggered by Alt-click (OPTION-click).
28676 \end_layout
28677
28678 \begin_layout Subsubsection*
28679 Skim (Mac OSX)
28680 \end_layout
28681
28682 \begin_layout Standard
28683 Enter
28684 \begin_inset Flex Code
28685 status collapsed
28686
28687 \begin_layout Plain Layout
28688 open -a Skim.app $$i
28689 \end_layout
28690
28691 \end_inset
28692
28693  to the viewer setting in
28694 \begin_inset Flex Noun
28695 status collapsed
28696
28697 \begin_layout Plain Layout
28698 Preferences\SpecialChar menuseparator
28699 File Handling\SpecialChar menuseparator
28700 File formats\SpecialChar menuseparator
28701 PDF (pdflatex)
28702 \end_layout
28703
28704 \end_inset
28705
28706 ,
28707  and then in
28708 \begin_inset Flex Noun
28709 status collapsed
28710
28711 \begin_layout Plain Layout
28712 Skim\SpecialChar menuseparator
28713 Preferences\SpecialChar menuseparator
28714 Sync
28715 \end_layout
28716
28717 \end_inset
28718
28719  choose
28720 \begin_inset Flex Noun
28721 status collapsed
28722
28723 \begin_layout Plain Layout
28724 custom
28725 \end_layout
28726
28727 \end_inset
28728
28729  preset and enter command
28730 \begin_inset Flex Noun
28731 status collapsed
28732
28733 \begin_layout Plain Layout
28734 /Applications/\SpecialChar LyX
28735 .app/Contents/MacOS/lyxeditor
28736 \end_layout
28737
28738 \end_inset
28739
28740 .
28741 \end_layout
28742
28743 \begin_layout Standard
28744 Reverse search is triggered by COMMAND-SHIFT-click
28745 \end_layout
28746
28747 \begin_layout Subsubsection*
28748 Evince (GNOME)
28749 \end_layout
28750
28751 \begin_layout Standard
28752 Reverse search with evince does not work out of the box,
28753  but it can be achieved by means of some third party helper scripts.
28754  Please refer to
28755 \begin_inset CommandInset href
28756 LatexCommand href
28757 target "https://wiki.lyx.org/LyX/SyncTeX"
28758 literal "false"
28759
28760 \end_inset
28761
28762  for details.
28763 \end_layout
28764
28765 \begin_layout Subsubsection*
28766 Okular (KDE)
28767 \end_layout
28768
28769 \begin_layout Standard
28770 Go to
28771 \begin_inset Flex Noun
28772 status collapsed
28773
28774 \begin_layout Plain Layout
28775 Settings\SpecialChar menuseparator
28776 Configure Okular\SpecialChar menuseparator
28777 Editor
28778 \end_layout
28779
28780 \end_inset
28781
28782  and select LyX
28783 \begin_inset Quotes erd
28784 \end_inset
28785
28786  as editor.
28787  This inserts the appropriate command (
28788 \begin_inset Flex Code
28789 status collapsed
28790
28791 \begin_layout Plain Layout
28792 lyxclient -g %f %l
28793 \end_layout
28794
28795 \end_inset
28796
28797 ).
28798 \end_layout
28799
28800 \begin_layout Standard
28801 Reverse search is triggered by SHIFT-click.
28802
28803 \change_inserted -712698321 1578211026
28804  Note that this only works if Okular is in
28805 \begin_inset Quotes eld
28806 \end_inset
28807
28808 Browse
28809 \begin_inset Quotes erd
28810 \end_inset
28811
28812  mode (i.
28813 \begin_inset space \thinspace{}
28814 \end_inset
28815
28816 e.,
28817  the hand symbol is clicked).
28818 \change_unchanged
28819
28820 \end_layout
28821
28822 \begin_layout Subsubsection*
28823 Qpdfview (Unix)
28824 \end_layout
28825
28826 \begin_layout Standard
28827 Qpdfview supports Sync\SpecialChar TeX
28828  since version 0.3.5.
28829  Go to
28830 \begin_inset Flex Noun
28831 status collapsed
28832
28833 \begin_layout Plain Layout
28834 Edit\SpecialChar menuseparator
28835 Settings\SpecialChar menuseparator
28836 Behavior
28837 \end_layout
28838
28839 \end_inset
28840
28841 ,
28842  click on the input field of the
28843 \begin_inset Quotes eld
28844 \end_inset
28845
28846 Source editor
28847 \begin_inset Quotes erd
28848 \end_inset
28849
28850  item and add the command
28851 \begin_inset Flex Code
28852 status collapsed
28853
28854 \begin_layout Plain Layout
28855 lyxclient -g %1 %2
28856 \end_layout
28857
28858 \end_inset
28859
28860 .
28861 \end_layout
28862
28863 \begin_layout Standard
28864 Reverse search is triggered by double-click or,
28865  in more recent versions,
28866  by context menu.
28867 \end_layout
28868
28869 \begin_layout Subsubsection*
28870 YAP (Windows)
28871 \end_layout
28872
28873 \begin_layout Standard
28874 Launch yap,
28875  choose its
28876 \begin_inset Flex Noun
28877 status collapsed
28878
28879 \begin_layout Plain Layout
28880 View\SpecialChar menuseparator
28881 Options
28882 \end_layout
28883
28884 \end_inset
28885
28886  menu and select the
28887 \begin_inset Quotes eld
28888 \end_inset
28889
28890 Inverse DVI Search
28891 \begin_inset Quotes erd
28892 \end_inset
28893
28894  tab.
28895  Click on the
28896 \begin_inset Quotes eld
28897 \end_inset
28898
28899 New\SpecialChar ldots
28900
28901 \begin_inset Quotes erd
28902 \end_inset
28903
28904  button and,
28905  in the window that opens,
28906  enter
28907 \begin_inset Quotes eld
28908 \end_inset
28909
28910 \SpecialChar LyX
28911  Editor
28912 \begin_inset Quotes erd
28913 \end_inset
28914
28915  (or any other name you like) in the
28916 \begin_inset Quotes eld
28917 \end_inset
28918
28919 Name:
28920 \begin_inset Quotes erd
28921 \end_inset
28922
28923  field.
28924  Now click on the button labeled
28925 \begin_inset Quotes eld
28926 \end_inset
28927
28928 \SpecialChar ldots
28929
28930 \begin_inset Quotes erd
28931 \end_inset
28932
28933  to open a file dialog and navigate to the directory containing the batch file
28934 \begin_inset Flex Code
28935 status collapsed
28936
28937 \begin_layout Plain Layout
28938 lyxeditor.bat
28939 \end_layout
28940
28941 \end_inset
28942
28943  (see below).
28944  Select
28945 \begin_inset Flex Code
28946 status collapsed
28947
28948 \begin_layout Plain Layout
28949 lyxeditor.bat
28950 \end_layout
28951
28952 \end_inset
28953
28954  and then specify the program arguments as
28955 \begin_inset Flex Code
28956 status collapsed
28957
28958 \begin_layout Plain Layout
28959 %f %l
28960 \end_layout
28961
28962 \end_inset
28963
28964 .
28965  The
28966 \begin_inset Flex Code
28967 status collapsed
28968
28969 \begin_layout Plain Layout
28970 lyxeditor.bat
28971 \end_layout
28972
28973 \end_inset
28974
28975  wrapper is used for communicating with \SpecialChar LyX
28976  through the
28977 \emph on
28978 lyxpipe
28979 \emph default
28980  and is as follows:
28981 \end_layout
28982
28983 \begin_layout LyX-Code
28984 @echo off
28985 \begin_inset Newline newline
28986 \end_inset
28987
28988 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
28989 \backslash
28990
28991 \backslash
28992 .
28993 \backslash
28994 pipe
28995 \backslash
28996 lyxpipe.in
28997 \begin_inset Newline newline
28998 \end_inset
28999
29000 type
29001 \backslash
29002
29003 \backslash
29004 .
29005 \backslash
29006 pipe
29007 \backslash
29008 lyxpipe.out
29009 \end_layout
29010
29011 \begin_layout Standard
29012 Make sure that the \SpecialChar LyX
29013 Server pipe path you specified in \SpecialChar LyX
29014  is
29015 \begin_inset Flex Code
29016 status collapsed
29017
29018 \begin_layout Plain Layout
29019
29020 \backslash
29021
29022 \backslash
29023 .
29024 \backslash
29025 pipe
29026 \backslash
29027 lyxpipe
29028 \end_layout
29029
29030 \end_inset
29031
29032 ,
29033  otherwise change the
29034 \begin_inset Flex Code
29035 status collapsed
29036
29037 \begin_layout Plain Layout
29038 lyxeditor.bat
29039 \end_layout
29040
29041 \end_inset
29042
29043  wrapper accordingly.
29044 \end_layout
29045
29046 \begin_layout Standard
29047 In yap,
29048  reverse search is triggered by double-click.
29049 \end_layout
29050
29051 \begin_layout Subsubsection*
29052 SumatraPDF (Windows)
29053 \end_layout
29054
29055 \begin_layout Standard
29056 In order to use SumatraPDF for inverse search,
29057  enter
29058 \begin_inset Flex Code
29059 status collapsed
29060
29061 \begin_layout Plain Layout
29062 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
29063 \end_layout
29064
29065 \end_inset
29066
29067  in the viewer setting in
29068 \begin_inset Flex Noun
29069 status collapsed
29070
29071 \begin_layout Plain Layout
29072 Preferences\SpecialChar menuseparator
29073 File Handling\SpecialChar menuseparator
29074 File formats\SpecialChar menuseparator
29075 PDF (pdflatex)
29076 \end_layout
29077
29078 \end_inset
29079
29080 ,
29081  where
29082 \begin_inset Flex Code
29083 status collapsed
29084
29085 \begin_layout Plain Layout
29086 lyxeditor.bat
29087 \end_layout
29088
29089 \end_inset
29090
29091  is the previous wrapper.
29092  If SumatraPDF.exe is not in your command PATH,
29093  use its full file name.
29094 \end_layout
29095
29096 \begin_layout Standard
29097 Reverse search is triggered by double-click.
29098 \end_layout
29099
29100 \begin_layout Subsubsection*
29101 YAP (Cygwin)
29102 \end_layout
29103
29104 \begin_layout Standard
29105 First of all,
29106  make sure that yap is your default DVI viewer in the Windows environment,
29107  then launch it,
29108  choose its
29109 \begin_inset Flex Noun
29110 status collapsed
29111
29112 \begin_layout Plain Layout
29113 View\SpecialChar menuseparator
29114 Options
29115 \end_layout
29116
29117 \end_inset
29118
29119  menu and select the
29120 \begin_inset Quotes eld
29121 \end_inset
29122
29123 Inverse DVI Search
29124 \begin_inset Quotes erd
29125 \end_inset
29126
29127  tab.
29128  Click on the
29129 \begin_inset Quotes eld
29130 \end_inset
29131
29132 New\SpecialChar ldots
29133
29134 \begin_inset Quotes erd
29135 \end_inset
29136
29137  button and,
29138  in the window that opens,
29139  enter
29140 \begin_inset Quotes eld
29141 \end_inset
29142
29143 \SpecialChar LyX
29144  Editor
29145 \begin_inset Quotes erd
29146 \end_inset
29147
29148  (or any other name you like) in the
29149 \begin_inset Quotes eld
29150 \end_inset
29151
29152 Name:
29153 \begin_inset Quotes erd
29154 \end_inset
29155
29156  field.
29157  Now click on the button labeled
29158 \begin_inset Quotes eld
29159 \end_inset
29160
29161 \SpecialChar ldots
29162
29163 \begin_inset Quotes erd
29164 \end_inset
29165
29166  to open a file dialog and navigate to the directory containing the
29167 \begin_inset Flex Code
29168 status collapsed
29169
29170 \begin_layout Plain Layout
29171 lyxeditor.exe
29172 \end_layout
29173
29174 \end_inset
29175
29176  program (which is installed by default on Cygwin along with the \SpecialChar LyX
29177  executable).
29178  Select
29179 \begin_inset Flex Code
29180 status collapsed
29181
29182 \begin_layout Plain Layout
29183 lyxeditor.exe
29184 \end_layout
29185
29186 \end_inset
29187
29188  and then specify the program arguments as
29189 \begin_inset Flex Code
29190 status collapsed
29191
29192 \begin_layout Plain Layout
29193 -g %f %l
29194 \end_layout
29195
29196 \end_inset
29197
29198 .
29199  In this way,
29200  you will be using the
29201 \emph on
29202 lyxsocket
29203 \emph default
29204  for communicating with \SpecialChar LyX
29205 .
29206  If,
29207  for whatever reason,
29208  you want to use the
29209 \emph on
29210 lyxpipe
29211 \emph default
29212 ,
29213  omit the
29214 \begin_inset Flex Code
29215 status collapsed
29216
29217 \begin_layout Plain Layout
29218 -g
29219 \end_layout
29220
29221 \end_inset
29222
29223  option and be sure to specify the \SpecialChar LyX
29224 Server pipe path in the \SpecialChar LyX
29225  preferences.
29226 \end_layout
29227
29228 \begin_layout Standard
29229 In yap,
29230  reverse search is triggered by double-click.
29231 \end_layout
29232
29233 \begin_layout Subsubsection*
29234 SumatraPDF (Cygwin)
29235 \end_layout
29236
29237 \begin_layout Standard
29238 In order to use SumatraPDF for inverse search,
29239  enter
29240 \begin_inset Flex Code
29241 status collapsed
29242
29243 \begin_layout Plain Layout
29244 SumatraPDF -inverse-search "lyxeditor -g %f %l"
29245 \end_layout
29246
29247 \end_inset
29248
29249  in the viewer setting in
29250 \begin_inset Flex Noun
29251 status collapsed
29252
29253 \begin_layout Plain Layout
29254 Preferences\SpecialChar menuseparator
29255 File Handling\SpecialChar menuseparator
29256 File formats\SpecialChar menuseparator
29257 PDF (pdflatex)
29258 \end_layout
29259
29260 \end_inset
29261
29262 .
29263  If SumatraPDF.exe is not in your command PATH,
29264  use its full posix path.
29265  The
29266 \begin_inset Flex Code
29267 status collapsed
29268
29269 \begin_layout Plain Layout
29270 -g
29271 \end_layout
29272
29273 \end_inset
29274
29275  enables communication via the
29276 \emph on
29277 lyxsocket
29278 \emph default
29279 .
29280  Again,
29281  omit the
29282 \begin_inset Flex Code
29283 status collapsed
29284
29285 \begin_layout Plain Layout
29286 -g
29287 \end_layout
29288
29289 \end_inset
29290
29291  option if you want to use the
29292 \emph on
29293 lyxpipe
29294 \emph default
29295 ,
29296  and be sure to specify the \SpecialChar LyX
29297 Server pipe path in the \SpecialChar LyX
29298  preferences.
29299 \end_layout
29300
29301 \begin_layout Standard
29302 Reverse search is triggered by double-click.
29303 \end_layout
29304
29305 \begin_layout Section
29306 Forward search
29307 \end_layout
29308
29309 \begin_layout Standard
29310 Forward search is,
29311  as the name implies,
29312  in a sense the
29313 \begin_inset Quotes eld
29314 \end_inset
29315
29316 opposite
29317 \begin_inset Quotes erd
29318 \end_inset
29319
29320  of reverse search.
29321  It allows you to let the viewer jump to a given position from within \SpecialChar LyX
29322 .
29323  If forward search is set up (as described in what follows),
29324  you can put the cursor anywhere in your \SpecialChar LyX
29325  document,
29326  and hit
29327 \begin_inset Flex Noun
29328 status collapsed
29329
29330 \begin_layout Plain Layout
29331 Navigate\SpecialChar menuseparator
29332 Forward search
29333 \end_layout
29334
29335 \end_inset
29336
29337  (or select
29338 \begin_inset Flex Noun
29339 status collapsed
29340
29341 \begin_layout Plain Layout
29342 Forward search
29343 \end_layout
29344
29345 \end_inset
29346
29347  in the context menu via right mouse click),
29348  and then the viewer will jump to that position as well.
29349  This implies,
29350  of course,
29351  that your viewer supports this function.
29352 \end_layout
29353
29354 \begin_layout Standard
29355 To make forward search possible,
29356  you first need to provide the generated output PDF/DVI file with additional information about the \SpecialChar TeX
29357  sources.
29358  This can be done via the methods described in the section
29359 \begin_inset CommandInset ref
29360 LatexCommand ref
29361 reference "subsec:rev-search"
29362 nolink "false"
29363
29364 \end_inset
29365
29366 .
29367 \end_layout
29368
29369 \begin_layout Standard
29370 Additionally,
29371  you need to configure \SpecialChar LyX
29372  for using your viewers in
29373 \begin_inset Flex Noun
29374 status collapsed
29375
29376 \begin_layout Plain Layout
29377 Tools\SpecialChar menuseparator
29378 Preferences\SpecialChar menuseparator
29379 Output\SpecialChar menuseparator
29380 General
29381 \end_layout
29382
29383 \end_inset
29384
29385 .
29386  We provide a range of tested configurations for some viewers,
29387  which you can select from the drop down list.
29388  If none of these configurations suits you,
29389  you have to find out and enter a suitable configuration yourself.
29390  The definition syntax uses the following placeholders:
29391 \end_layout
29392
29393 \begin_layout Itemize
29394 \noindent
29395 \begin_inset Flex Code
29396 status collapsed
29397
29398 \begin_layout Plain Layout
29399 $$n
29400 \end_layout
29401
29402 \end_inset
29403
29404 :
29405  row number
29406 \end_layout
29407
29408 \begin_layout Itemize
29409 \noindent
29410 \begin_inset Flex Code
29411 status collapsed
29412
29413 \begin_layout Plain Layout
29414 $$t
29415 \end_layout
29416
29417 \end_inset
29418
29419 :
29420  name of the (temporary) exported .tex file (without path)
29421 \end_layout
29422
29423 \begin_layout Itemize
29424 \noindent
29425 \begin_inset Flex Code
29426 status collapsed
29427
29428 \begin_layout Plain Layout
29429 $$f
29430 \end_layout
29431
29432 \end_inset
29433
29434 :
29435  name of the (temporary) exported .tex file (including path)
29436 \end_layout
29437
29438 \begin_layout Itemize
29439 \noindent
29440 \begin_inset Flex Code
29441 status collapsed
29442
29443 \begin_layout Plain Layout
29444 $$o
29445 \end_layout
29446
29447 \end_inset
29448
29449 :
29450  name of the exported output file (either dvi or pdf,
29451  depending on which one exists in the temporary directory)
29452 \end_layout
29453
29454 \begin_layout Standard
29455 Note that only some of the viewers provide full and usable forward search functionality out of the box,
29456  among them yap,
29457  xdvi,
29458  okular
29459 \begin_inset Foot
29460 status collapsed
29461
29462 \begin_layout Plain Layout
29463 You might want to set
29464 \begin_inset Flex Code
29465 status collapsed
29466
29467 \begin_layout Plain Layout
29468 okular --unique
29469 \end_layout
29470
29471 \end_inset
29472
29473  in
29474 \begin_inset Flex Noun
29475 status collapsed
29476
29477 \begin_layout Plain Layout
29478 Tools\SpecialChar menuseparator
29479 Preferences\SpecialChar menuseparator
29480 File Handling\SpecialChar menuseparator
29481 File
29482 \begin_inset space ~
29483 \end_inset
29484
29485 Formats
29486 \end_layout
29487
29488 \end_inset
29489
29490
29491 \end_layout
29492
29493 \end_inset
29494
29495 ,
29496  qpdfview,
29497  and SumatraPDF
29498 \begin_inset Foot
29499 status collapsed
29500
29501 \begin_layout Plain Layout
29502 SumatraPDF can also use DDE commands through the external program CMCDDE —
29503  downloadable from
29504 \begin_inset CommandInset href
29505 LatexCommand href
29506 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
29507 literal "false"
29508
29509 \end_inset
29510
29511
29512 \end_layout
29513
29514 \end_inset
29515
29516 .
29517  Others,
29518  such as evince
29519 \begin_inset Foot
29520 status collapsed
29521
29522 \begin_layout Plain Layout
29523 Forward search with evince can be achieved by means of third party helper scripts.
29524  Please refer to
29525 \begin_inset CommandInset href
29526 LatexCommand href
29527 target "https://wiki.lyx.org/LyX/SyncTeX"
29528 literal "false"
29529
29530 \end_inset
29531
29532  for details.
29533 \end_layout
29534
29535 \end_inset
29536
29537 ,
29538  require some extra tools in order to use forward search.
29539  While many of the widespread PDF viewers (most notably Adobe Reader) do not support forward search at all,
29540  some other viewers – e.
29541 \begin_inset space \thinspace{}
29542 \end_inset
29543
29544 g.
29545  xpdf – allow at least to reload the document and jump to a specific page of the file,
29546  so you can at least navigate
29547 \begin_inset Quotes eld
29548 \end_inset
29549
29550 near
29551 \begin_inset Quotes erd
29552 \end_inset
29553
29554 .
29555  This latter functionality is provided by an external call of synctex (see the predefined example configurations).
29556
29557 \end_layout
29558
29559 \begin_layout Standard
29560 Forward search works both with DVI and PDF output.
29561  \SpecialChar LyX
29562  simply checks which preview format you have used before (i.
29563 \begin_inset space \thinspace{}
29564 \end_inset
29565
29566 e.,
29567  which format is already there in the temporary directory) and chooses the appropriate configuration for the respective format.
29568 \change_deleted 564990737 1672743015
29569
29570 \end_layout
29571
29572 \begin_layout Standard
29573
29574 \change_deleted 564990737 1672743015
29575 Special Document Classes
29576 \end_layout
29577
29578 \begin_layout Standard
29579
29580 \change_deleted 564990737 1669742044
29581 A&A Paper
29582 \end_layout
29583
29584 \begin_layout Standard
29585
29586 \change_deleted 564990737 1669742044
29587 by
29588 \noun on
29589 Peter Sütterlin
29590 \end_layout
29591
29592 \begin_layout Standard
29593
29594 \change_deleted 564990737 1669742044
29595 Introduction
29596 \end_layout
29597
29598 \begin_layout Standard
29599
29600 \change_deleted 564990737 1669742044
29601 This section describes how \SpecialChar LyX
29602  can be used to write articles for submission to the scientific journal
29603 \emph on
29604 Astronomy and Astrophysics
29605 \emph default
29606  (
29607 \begin_inset Flex URL
29608 status collapsed
29609
29610 \begin_layout Plain Layout
29611
29612 https://www.aanda.org/
29613 \end_layout
29614
29615 \end_inset
29616
29617 ) using Version 5.01 of the document class
29618 \family typewriter
29619 aa.cls
29620 \family default
29621 .
29622  This package can be downloaded from the ftp site
29623 \end_layout
29624
29625 \begin_layout Standard
29626
29627 \change_deleted 564990737 1669742044
29628 \begin_inset VSpace medskip
29629 \end_inset
29630
29631
29632 \end_layout
29633
29634 \begin_layout Standard
29635 \align center
29636
29637 \change_deleted 564990737 1669742044
29638 \begin_inset Flex URL
29639 status collapsed
29640
29641 \begin_layout Plain Layout
29642
29643 ftp://ftp.edpsciences.org/pub/aa/readme.html
29644 \end_layout
29645
29646 \end_inset
29647
29648
29649 \end_layout
29650
29651 \begin_layout Standard
29652
29653 \change_deleted 564990737 1669742044
29654 \begin_inset VSpace medskip
29655 \end_inset
29656
29657
29658 \end_layout
29659
29660 \begin_layout Standard
29661
29662 \change_deleted 564990737 1669742044
29663 A manual comes together with that package,
29664  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.
29665
29666 \end_layout
29667
29668 \begin_layout Standard
29669
29670 \change_deleted 564990737 1669742044
29671 Please note that the publisher of the journal was changed from Springer to EDP Sciences starting January 1,
29672  2001.
29673  That change involved also some slight changes to the style files,
29674  namely the removal of the thesaurus command.
29675  The \SpecialChar LyX
29676  class aa supports the newest version of these style files,
29677  V 5.01.
29678  If you have an older version installed,
29679  please upgrade.
29680  For compatibility,
29681  the old (version 4) layout has been kept as
29682 \family sans
29683 article (A&A V4)
29684 \family default
29685 .
29686  Please refer to the comments in
29687 \family typewriter
29688 \SpecialChar LyX
29689 Dir/layouts/aapaper.layout
29690 \family default
29691 .
29692 \end_layout
29693
29694 \begin_layout Standard
29695
29696 \change_deleted 564990737 1669742044
29697 Getting started
29698 \end_layout
29699
29700 \begin_layout Standard
29701
29702 \change_deleted 564990737 1669742044
29703 It is recommended you start from the example template distributed with \SpecialChar LyX
29704 .
29705  If you are not using a template,
29706  note the following settings:
29707 \end_layout
29708
29709 \begin_layout Itemize
29710
29711 \change_deleted 564990737 1669742044
29712 Select
29713 \family sans
29714 article (A&A)
29715 \family default
29716  in the
29717 \family sans
29718 Document\SpecialChar menuseparator
29719 Settings
29720 \family default
29721  dialog (OK,
29722  that one was obvious).
29723 \end_layout
29724
29725 \begin_layout Itemize
29726
29727 \change_deleted 564990737 1669742044
29728 Don't change the option
29729 \family sans
29730 Page
29731 \begin_inset space ~
29732 \end_inset
29733
29734 style
29735 \family default
29736 :
29737  Leave it set to
29738 \family sans
29739 default
29740 \family default
29741 .
29742  The whole layout is done by the macros,
29743  you shouldn't change anything.
29744 \end_layout
29745
29746 \begin_layout Standard
29747
29748 \change_deleted 564990737 1669742044
29749 The header block
29750 \end_layout
29751
29752 \begin_layout Standard
29753
29754 \change_deleted 564990737 1669742044
29755 First thing to enter is the header information.
29756  It consists of seven entries,
29757  of which some are optional.
29758  They are
29759 \end_layout
29760
29761 \begin_layout Itemize
29762
29763 \change_deleted 564990737 1669742044
29764
29765 \family sans
29766 Title
29767 \family default
29768 :
29769  [required]
29770 \end_layout
29771
29772 \begin_layout Itemize
29773
29774 \change_deleted 564990737 1669742044
29775
29776 \family sans
29777 Subtitle
29778 \family default
29779 :
29780  [optional]
29781 \end_layout
29782
29783 \begin_layout Itemize
29784
29785 \change_deleted 564990737 1669742044
29786
29787 \family sans
29788 Author
29789 \family default
29790 :
29791  [required]
29792 \end_layout
29793
29794 \begin_layout Itemize
29795
29796 \change_deleted 564990737 1669742044
29797
29798 \family sans
29799 Address
29800 \family default
29801 :
29802  [required]
29803 \end_layout
29804
29805 \begin_layout Itemize
29806
29807 \change_deleted 564990737 1669742044
29808
29809 \family sans
29810 Offprints
29811 \family default
29812 :
29813  [optional] if more than one author:
29814  whom to contact for offprint requests.
29815 \end_layout
29816
29817 \begin_layout Itemize
29818
29819 \change_deleted 564990737 1669742044
29820
29821 \family sans
29822 Mail
29823 \family default
29824 :
29825  [optional] mail address for contacts.
29826 \end_layout
29827
29828 \begin_layout Itemize
29829
29830 \change_deleted 564990737 1669742044
29831
29832 \family sans
29833 Date
29834 \family default
29835 :
29836  [required].
29837  Suggested format is
29838 \family typewriter
29839 Received:
29840  <date>;
29841  Accepted <date>
29842 \end_layout
29843
29844 \begin_layout Standard
29845
29846 \change_deleted 564990737 1669742044
29847 There is no need to issue the
29848 \family typewriter
29849
29850 \backslash
29851 maketitle
29852 \family default
29853  command,
29854  this is done automatically by \SpecialChar LyX
29855  when the header is finished.
29856  Although the order of the single header entries doesn't matter it is advised to keep the above sequence,
29857  just to get the best optics and meets the layout of the real document.
29858 \end_layout
29859
29860 \begin_layout Standard
29861
29862 \change_deleted 564990737 1669742044
29863 If you want to place footnotes in the header block,
29864  e.
29865 \begin_inset space \thinspace{}
29866 \end_inset
29867
29868 g.
29869 \begin_inset space \space{}
29870 \end_inset
29871
29872 to state your present address,
29873  just use the standard footnote via the menu
29874 \family sans
29875 Insert\SpecialChar menuseparator
29876 Footnote.
29877
29878 \family default
29879  \SpecialChar LyX
29880  will automagically use the term
29881 \family typewriter
29882
29883 \backslash
29884 thanks{}
29885 \family default
29886  in that case.
29887 \end_layout
29888
29889 \begin_layout Standard
29890
29891 \change_deleted 564990737 1669742044
29892 Under
29893 \family sans
29894 Edit\SpecialChar menuseparator
29895 Text Style
29896 \family default
29897 ,
29898  you'll find two insets which are relevant for the titling:
29899 \end_layout
29900
29901 \begin_layout Itemize
29902
29903 \change_deleted 564990737 1669742044
29904
29905 \family sans
29906 Institute
29907 \family typewriter
29908
29909 \family default
29910 to mark corresponding author\SpecialChar breakableslash
29911 institute pairs.
29912  The institutes are numbered sequentially as they appear in the
29913 \family sans
29914 Address
29915 \family default
29916  field,
29917  so you have to put a marker to each author.
29918 \end_layout
29919
29920 \begin_layout Itemize
29921
29922 \change_deleted 564990737 1669742044
29923
29924 \family sans
29925 Email
29926 \family default
29927  to supply an email address for fast contact.
29928 \end_layout
29929
29930 \begin_layout Standard
29931
29932 \change_deleted 564990737 1669742044
29933 In addition to these topics,
29934  the macros use one additional \SpecialChar LaTeX
29935  command that has no counterpart in \SpecialChar LyX
29936 :
29937 \end_layout
29938
29939 \begin_layout Itemize
29940
29941 \change_deleted 564990737 1669742044
29942
29943 \family typewriter
29944
29945 \backslash
29946 and
29947 \family default
29948  to separate different names for more than one author and institute,
29949  respectively.
29950 \end_layout
29951
29952 \begin_layout Standard
29953
29954 \change_deleted 564990737 1669742044
29955 The appropriate command has to be entered in \SpecialChar LyX
29956  and marked as \SpecialChar LaTeX
29957  code.
29958  See the examples.
29959
29960 \end_layout
29961
29962 \begin_layout Standard
29963
29964 \change_deleted 564990737 1669742044
29965 The abstract
29966 \end_layout
29967
29968 \begin_layout Standard
29969
29970 \change_deleted 564990737 1669742044
29971 The abstract should immediately follow the header block.
29972  With version 5 the abstract environment was changed to a command,
29973  and there is now a restriction to only one paragraph.
29974  In addition,
29975  it should contain an entry with the keywords.
29976  This is done via the paragraph style
29977 \family sans
29978 Keywords
29979 \family default
29980 .
29981  Refer to the example paper.
29982 \end_layout
29983
29984 \begin_layout Standard
29985
29986 \change_deleted 564990737 1669742044
29987 Supported environments
29988 \end_layout
29989
29990 \begin_layout Standard
29991
29992 \change_deleted 564990737 1669742044
29993 The A&A paper layout supports the following environments for structuring your text:
29994 \end_layout
29995
29996 \begin_layout Itemize
29997
29998 \change_deleted 564990737 1669742044
29999
30000 \family sans
30001 Standard
30002 \end_layout
30003
30004 \begin_layout Itemize
30005
30006 \change_deleted 564990737 1669742044
30007
30008 \family sans
30009 Section
30010 \end_layout
30011
30012 \begin_layout Itemize
30013
30014 \change_deleted 564990737 1669742044
30015
30016 \family sans
30017 Subsection
30018 \end_layout
30019
30020 \begin_layout Itemize
30021
30022 \change_deleted 564990737 1669742044
30023
30024 \family sans
30025 Subsubsection
30026 \end_layout
30027
30028 \begin_layout Itemize
30029
30030 \change_deleted 564990737 1669742044
30031
30032 \family sans
30033 Itemize
30034 \end_layout
30035
30036 \begin_layout Itemize
30037
30038 \change_deleted 564990737 1669742044
30039
30040 \family sans
30041 Enumerate
30042 \end_layout
30043
30044 \begin_layout Itemize
30045
30046 \change_deleted 564990737 1669742044
30047
30048 \family sans
30049 Description
30050 \end_layout
30051
30052 \begin_layout Itemize
30053
30054 \change_deleted 564990737 1669742044
30055
30056 \family sans
30057 Caption
30058 \end_layout
30059
30060 \begin_layout Itemize
30061
30062 \change_deleted 564990737 1669742044
30063
30064 \family sans
30065 Abstract
30066 \end_layout
30067
30068 \begin_layout Itemize
30069
30070 \change_deleted 564990737 1669742044
30071
30072 \family sans
30073 Acknowledgment
30074 \end_layout
30075
30076 \begin_layout Itemize
30077
30078 \change_deleted 564990737 1669742044
30079
30080 \family sans
30081 Bibliography
30082 \end_layout
30083
30084 \begin_layout Itemize
30085
30086 \change_deleted 564990737 1669742044
30087
30088 \family sans
30089 \SpecialChar LaTeX
30090
30091 \end_layout
30092
30093 \begin_layout Standard
30094
30095 \change_deleted 564990737 1669742044
30096 Commands not supported by \SpecialChar LyX
30097
30098 \end_layout
30099
30100 \begin_layout Standard
30101
30102 \change_deleted 564990737 1669742044
30103 Some commands are not yet supported by the
30104 \family sans
30105 paper (A&A)
30106 \family default
30107  layout for \SpecialChar LyX
30108 .
30109  Some have already been mentioned.
30110  For the sake of completeness,
30111  they are listed all together here:
30112 \end_layout
30113
30114 \begin_layout Itemize
30115
30116 \change_deleted 564990737 1669742044
30117
30118 \family typewriter
30119
30120 \backslash
30121 and
30122 \end_layout
30123
30124 \begin_layout Itemize
30125
30126 \change_deleted 564990737 1669742044
30127
30128 \family typewriter
30129
30130 \backslash
30131 authorrunning
30132 \end_layout
30133
30134 \begin_layout Itemize
30135
30136 \change_deleted 564990737 1669742044
30137
30138 \family typewriter
30139
30140 \backslash
30141 object{}
30142 \end_layout
30143
30144 \begin_layout Itemize
30145
30146 \change_deleted 564990737 1669742044
30147
30148 \family typewriter
30149
30150 \backslash
30151 titlerunning{}
30152 \end_layout
30153
30154 \begin_layout Standard
30155
30156 \change_deleted 564990737 1669742044
30157 If you want to use any of these commands,
30158  you have to enter them yourself.
30159
30160 \series bold
30161 Do not forget to mark them as \SpecialChar LaTeX
30162  code!
30163 \end_layout
30164
30165 \begin_layout Standard
30166
30167 \change_deleted 564990737 1669742044
30168 Figure and Table Floats
30169 \end_layout
30170
30171 \begin_layout Standard
30172
30173 \change_deleted 564990737 1669742044
30174 \SpecialChar LyX
30175  provides support for the necessary float environments
30176 \family sans
30177 figure,
30178  figure*,
30179  table
30180 \family default
30181  and
30182 \family sans
30183 table*
30184 \family default
30185 ,
30186  therefore we won't tell much about it here.
30187  Refer to the
30188 \emph on
30189 User's
30190 \begin_inset space ~
30191 \end_inset
30192
30193 Guide
30194 \emph default
30195 .
30196  Just remember that tables should be left-aligned.
30197  For that,
30198  select the table and change the alignment in
30199 \family sans
30200 Edit\SpecialChar menuseparator
30201 Paragraph
30202 \begin_inset space ~
30203 \end_inset
30204
30205 Settings.
30206 \end_layout
30207
30208 \begin_layout Standard
30209
30210 \change_deleted 564990737 1669742044
30211 There is only one special thing:
30212  the figures with caption besides the figure.
30213  To create such a figure,
30214  you have to do the following:
30215 \end_layout
30216
30217 \begin_layout Enumerate
30218
30219 \change_deleted 564990737 1669742044
30220 Create a wide figure float:
30221
30222 \family sans
30223 Insert\SpecialChar menuseparator
30224 Float\SpecialChar menuseparator
30225 Figure
30226 \family default
30227 ,
30228  then right click in the figure and select
30229 \family sans
30230 Span
30231 \begin_inset space ~
30232 \end_inset
30233
30234 columns
30235 \family default
30236 .
30237 \end_layout
30238
30239 \begin_layout Enumerate
30240
30241 \change_deleted 564990737 1669742044
30242 Enter your caption text.
30243 \end_layout
30244
30245 \begin_layout Enumerate
30246
30247 \change_deleted 564990737 1669742044
30248 Press
30249 \family sans
30250 Return
30251 \family default
30252  to move the cursor above the caption.
30253 \end_layout
30254
30255 \begin_layout Enumerate
30256
30257 \change_deleted 564990737 1669742044
30258 Insert your figure
30259 \end_layout
30260
30261 \begin_layout Enumerate
30262
30263 \change_deleted 564990737 1669742044
30264 Position the cursor behind the figure and insert a horizontal fill:
30265
30266 \family sans
30267 Insert\SpecialChar menuseparator
30268 Special
30269 \begin_inset space ~
30270 \end_inset
30271
30272 Character\SpecialChar menuseparator
30273 Horizontal
30274 \begin_inset space ~
30275 \end_inset
30276
30277 Fill
30278 \family default
30279 .
30280 \end_layout
30281
30282 \begin_layout Enumerate
30283
30284 \change_deleted 564990737 1669742044
30285 Switch to \SpecialChar LaTeX
30286  mode:
30287
30288 \family sans
30289 M-c
30290 \begin_inset space ~
30291 \end_inset
30292
30293 t
30294 \family default
30295 .
30296 \end_layout
30297
30298 \begin_layout Enumerate
30299
30300 \change_deleted 564990737 1669742044
30301 Enter
30302 \family typewriter
30303
30304 \backslash
30305 parbox[b]{55mm}{
30306 \family default
30307 .
30308
30309 \series bold
30310 Do not close the brace!
30311 \end_layout
30312
30313 \begin_layout Enumerate
30314
30315 \change_deleted 564990737 1669742044
30316 Position the cursor behind the caption text,
30317  switch to \SpecialChar LaTeX
30318  mode and insert the closing brace:
30319
30320 \family sans
30321 M-c
30322 \begin_inset space ~
30323 \end_inset
30324
30325 t
30326 \family default
30327
30328 \family typewriter
30329 }
30330 \family default
30331 .
30332 \end_layout
30333
30334 \begin_layout Standard
30335
30336 \change_deleted 564990737 1669742044
30337 Also,
30338  refer to the figures in the example paper.
30339 \end_layout
30340
30341 \begin_layout Standard
30342
30343 \change_deleted 564990737 1669742044
30344 Referee layout
30345 \end_layout
30346
30347 \begin_layout Standard
30348
30349 \change_deleted 564990737 1669742044
30350 For submission,
30351  the paper has to be formated in a special double-spacing layout.
30352  For this purpose,
30353  you have to give the option
30354 \family typewriter
30355 referee
30356 \family default
30357  to the document class.
30358  This must be done using the custom class options field in the
30359 \family sans
30360 Document\SpecialChar menuseparator
30361 Settings
30362 \family default
30363  dialog.
30364  Just enter the string
30365 \family typewriter
30366 referee
30367 \family default
30368  there.
30369 \end_layout
30370
30371 \begin_layout Standard
30372
30373 \change_deleted 564990737 1669742044
30374 The example paper
30375 \end_layout
30376
30377 \begin_layout Standard
30378
30379 \change_deleted 564990737 1669742044
30380 The
30381 \family sans
30382 Examples
30383 \family default
30384  directory contains an example paper written with \SpecialChar LyX
30385 .
30386  It is the example paper from the original macro package,
30387  translated to \SpecialChar LyX
30388 .
30389  Use it for inspiration,
30390  and compare the original \SpecialChar LaTeX
30391  code with \SpecialChar LyX
30392  way of writing.
30393 \end_layout
30394
30395 \begin_layout Standard
30396
30397 \change_deleted 564990737 1671097429
30398 Dinbrief
30399 \end_layout
30400
30401 \begin_layout Standard
30402
30403 \change_deleted 564990737 1671097429
30404 The document class
30405 \family sans
30406 dinbrief
30407 \family default
30408  can be used to type letters according to German conventions.
30409  A template file is included in
30410 \family typewriter
30411 .../lyx/share/templates
30412 \family default
30413  for you to use as a starting point.
30414 \end_layout
30415
30416 \begin_layout Standard
30417
30418 \change_deleted 564990737 1671097429
30419 Elsevier Journals
30420 \end_layout
30421
30422 \begin_layout Standard
30423
30424 \change_deleted 564990737 1671097429
30425 See the \SpecialChar LyX
30426  template file
30427 \family typewriter
30428 elsarticle.lyx
30429 \family default
30430 .
30431  It contains all infos you need.
30432 \end_layout
30433
30434 \begin_layout Standard
30435
30436 \change_deleted 564990737 1669755802
30437 ijmpc and ijmpd
30438 \end_layout
30439
30440 \begin_layout Standard
30441
30442 \change_deleted 564990737 1669755802
30443 by
30444 \noun on
30445 Panayotis Papasotiriou
30446 \end_layout
30447
30448 \begin_layout Standard
30449
30450 \change_deleted 564990737 1669755802
30451 Overview
30452 \end_layout
30453
30454 \begin_layout Standard
30455
30456 \change_deleted 564990737 1669755802
30457 The ijmpc package is a set of macros that facilitates electronic manuscript submission to the
30458 \emph on
30459 International Journal of Modern Physics C
30460 \emph default
30461 .
30462  Similarly,
30463  the ijmpd package is for creating manuscripts to be submitted to the
30464 \emph on
30465 International Journal of Modern Physics D
30466 \emph default
30467 .
30468  Both journals are published by World Scientific.
30469  The corresponding document classes are named
30470 \family typewriter
30471 ws-ijmpc.cls
30472 \family default
30473  and
30474 \family typewriter
30475 ws-ijmpd.cls
30476 \family default
30477 ,
30478  respectively.
30479  These files,
30480  together with instructions for the authors,
30481  can be downloaded from the sites
30482 \begin_inset Flex URL
30483 status collapsed
30484
30485 \begin_layout Plain Layout
30486
30487 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
30488 \end_layout
30489
30490 \end_inset
30491
30492  and
30493 \begin_inset Flex URL
30494 status collapsed
30495
30496 \begin_layout Plain Layout
30497
30498 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
30499 \end_layout
30500
30501 \end_inset
30502
30503 .
30504  Both packages are modified versions of the standard
30505 \begin_inset Quotes eld
30506 \end_inset
30507
30508 article
30509 \begin_inset Quotes erd
30510 \end_inset
30511
30512  package,
30513  and they are almost (but not exactly) identical.
30514  Most of their features are supported by \SpecialChar LyX
30515 .
30516  I have used \SpecialChar LyX
30517  successfully to write articles submitted to both journals without any problem.
30518 \end_layout
30519
30520 \begin_layout Standard
30521
30522 \change_deleted 564990737 1669755802
30523 Writing a paper
30524 \end_layout
30525
30526 \begin_layout Standard
30527
30528 \change_deleted 564990737 1669755802
30529 As usual,
30530  the easiest way to write a paper is to start with a template.
30531  Click on
30532 \family sans
30533 File\SpecialChar menuseparator
30534 New from
30535 \family default
30536
30537 \family sans
30538 Template
30539 \family default
30540 ,
30541  then choose the
30542 \family typewriter
30543 ijmpc.lyx
30544 \family default
30545  or
30546 \family typewriter
30547 ijmpd.lyx
30548 \family default
30549  template.
30550  This will give an (almost) empty document that includes the most common fields found in a manuscript.
30551  Simply overwrite the existing text (including the brackets,
30552
30553 \family typewriter
30554 <>
30555 \family default
30556 ) with your text.
30557  You should keep in mind the following remarks.
30558 \end_layout
30559
30560 \begin_layout Enumerate
30561
30562 \change_deleted 564990737 1669755802
30563 \SpecialChar LyX
30564  won't let you change the font size and the page style of the document,
30565  because such modifications are not allowed by both packages.
30566 \end_layout
30567
30568 \begin_layout Enumerate
30569
30570 \change_deleted 564990737 1669755802
30571 The language of the document should not be changed.
30572  Before previewing your paper,
30573  be sure that the babel package is not used.
30574  To do this,
30575  click on
30576 \begin_inset Info
30577 type  "menu"
30578 arg   "dialog-show document"
30579 \end_inset
30580
30581
30582 \family sans
30583 \SpecialChar menuseparator
30584 Language
30585 \family default
30586 ,
30587  and select
30588 \begin_inset Quotes eld
30589 \end_inset
30590
30591 None
30592 \begin_inset Quotes erd
30593 \end_inset
30594
30595  as
30596 \family sans
30597 Language Package
30598 \family default
30599 .
30600 \end_layout
30601
30602 \begin_layout Enumerate
30603
30604 \change_deleted 564990737 1669755802
30605 The
30606 \begin_inset Quotes eld
30607 \end_inset
30608
30609 Keywords
30610 \begin_inset Quotes erd
30611 \end_inset
30612
30613  style must be used to define keywords.
30614 \end_layout
30615
30616 \begin_layout Enumerate
30617
30618 \change_deleted 564990737 1669755802
30619 The ijmpc package provides a style named
30620 \begin_inset Quotes eld
30621 \end_inset
30622
30623 Classification Codes
30624 \begin_inset Quotes erd
30625 \end_inset
30626
30627 ,
30628  which can be used to define classification codes,
30629  such as PACS numbers.
30630  Note that this facility is not supported by the ijmpd package.
30631 \end_layout
30632
30633 \begin_layout Enumerate
30634
30635 \change_deleted 564990737 1669755802
30636 Several new environments are available:
30637
30638 \begin_inset Quotes eld
30639 \end_inset
30640
30641 Definition
30642 \begin_inset Quotes erd
30643 \end_inset
30644
30645 ,
30646
30647 \begin_inset Quotes eld
30648 \end_inset
30649
30650 Step
30651 \begin_inset Quotes erd
30652 \end_inset
30653
30654 ,
30655
30656 \begin_inset Quotes eld
30657 \end_inset
30658
30659 Example
30660 \begin_inset Quotes erd
30661 \end_inset
30662
30663 ,
30664
30665 \begin_inset Quotes eld
30666 \end_inset
30667
30668 Remark
30669 \begin_inset Quotes erd
30670 \end_inset
30671
30672 ,
30673
30674 \begin_inset Quotes eld
30675 \end_inset
30676
30677 Notation
30678 \begin_inset Quotes erd
30679 \end_inset
30680
30681 ,
30682
30683 \begin_inset Quotes eld
30684 \end_inset
30685
30686 Theorem
30687 \begin_inset Quotes erd
30688 \end_inset
30689
30690 ,
30691
30692 \begin_inset Quotes eld
30693 \end_inset
30694
30695 Proof
30696 \begin_inset Quotes erd
30697 \end_inset
30698
30699 ,
30700
30701 \begin_inset Quotes eld
30702 \end_inset
30703
30704 Corollary
30705 \begin_inset Quotes erd
30706 \end_inset
30707
30708 ,
30709
30710 \begin_inset Quotes eld
30711 \end_inset
30712
30713 Lemma
30714 \begin_inset Quotes erd
30715 \end_inset
30716
30717 ,
30718
30719 \begin_inset Quotes eld
30720 \end_inset
30721
30722 Proposition
30723 \begin_inset Quotes erd
30724 \end_inset
30725
30726 ,
30727
30728 \begin_inset Quotes eld
30729 \end_inset
30730
30731 Prop
30732 \begin_inset Quotes erd
30733 \end_inset
30734
30735 ,
30736
30737 \begin_inset Quotes eld
30738 \end_inset
30739
30740 Question
30741 \begin_inset Quotes erd
30742 \end_inset
30743
30744 ,
30745
30746 \begin_inset Quotes eld
30747 \end_inset
30748
30749 Claim
30750 \begin_inset Quotes erd
30751 \end_inset
30752
30753 ,
30754  and
30755 \begin_inset Quotes eld
30756 \end_inset
30757
30758 Conjecture
30759 \begin_inset Quotes erd
30760 \end_inset
30761
30762 .
30763  Their use is more or less obvious.
30764  \SpecialChar LyX
30765  supports all these environments;
30766  it will use the proper label,
30767  text style,
30768  and numbering scheme for each of them.
30769 \end_layout
30770
30771 \begin_layout Enumerate
30772
30773 \change_deleted 564990737 1669755802
30774 Both packages use basic citations;
30775  the natbib package should not be used.
30776  In \SpecialChar LyX
30777 ,
30778  citation references are shown as usual;
30779  in the output,
30780  citations are shown as superscripts.
30781  If you want to use a citation as normal text,
30782  you should use the
30783 \family typewriter
30784 refcite
30785 \family default
30786  command,
30787  e.
30788 \begin_inset space \thinspace{}
30789 \end_inset
30790
30791 g.
30792 \begin_inset space \space{}
30793 \end_inset
30794
30795
30796 \begin_inset Quotes eld
30797 \end_inset
30798
30799 See Ref.
30800 \begin_inset space \space{}
30801 \end_inset
30802
30803
30804 \family typewriter
30805
30806 \backslash
30807 refcite{key}
30808 \family default
30809
30810 \begin_inset Quotes erd
30811 \end_inset
30812
30813 .
30814 \end_layout
30815
30816 \begin_layout Enumerate
30817
30818 \change_deleted 564990737 1669755802
30819 There is no
30820 \begin_inset Quotes eld
30821 \end_inset
30822
30823 Acknowledgments
30824 \begin_inset Quotes erd
30825 \end_inset
30826
30827  section in both packages.
30828  To put acknowledgments,
30829  just use the
30830 \begin_inset Quotes eld
30831 \end_inset
30832
30833 Section*
30834 \begin_inset Quotes erd
30835 \end_inset
30836
30837  environment.
30838 \end_layout
30839
30840 \begin_layout Enumerate
30841
30842 \change_deleted 564990737 1669755802
30843 Appendices may be added to the paper,
30844
30845 \emph on
30846 after
30847 \emph default
30848  the Acknowledgments and
30849 \shape italic
30850 before
30851 \shape default
30852  the References.
30853  \SpecialChar LyX
30854  provides a special environment,
30855  called
30856 \begin_inset Quotes eld
30857 \end_inset
30858
30859 Appendices Section
30860 \begin_inset Quotes erd
30861 \end_inset
30862
30863  which marks the beginning of the appendices.
30864  This environment should be left blank;
30865  it just sends a \SpecialChar LaTeX
30866  command,
30867  but nothing is really printed.
30868  In \SpecialChar LyX
30869 ,
30870  the word
30871 \begin_inset Quotes eld
30872 \end_inset
30873
30874 Appendix
30875 \begin_inset Quotes erd
30876 \end_inset
30877
30878  is printed with blue letters,
30879  as a signal that all sections after that point are appendices.
30880  To write an appendix,
30881  use the
30882 \begin_inset Quotes eld
30883 \end_inset
30884
30885 Appendix
30886 \begin_inset Quotes erd
30887 \end_inset
30888
30889  environment.
30890  \SpecialChar LyX
30891  will number each appendix with capital letters,
30892  as required by both journals.
30893  Note that
30894 \begin_inset Quotes eld
30895 \end_inset
30896
30897 Appendices Section
30898 \begin_inset Quotes erd
30899 \end_inset
30900
30901
30902 \emph on
30903 must
30904 \emph default
30905  be present before the first appendix;
30906  if not,
30907  all appendices will be numbered as normal sections in the output.
30908 \end_layout
30909
30910 \begin_layout Enumerate
30911
30912 \change_deleted 564990737 1669755802
30913 The ijmpc and the ijmpd packages use the
30914 \family typewriter
30915 tbl
30916 \family default
30917  command to implement table captions.
30918  As a result,
30919  a table created by \SpecialChar LyX
30920  is printed correctly,
30921  but its caption is ignored.
30922  However,
30923  you can use some \SpecialChar TeX
30924  code to overcome this problem,
30925  so that captions are printed as expected.
30926  To do so,
30927  create a float table as usual,
30928  remove the caption,
30929  and replace it with the \SpecialChar TeX
30930  code
30931 \family typewriter
30932
30933 \backslash
30934 tbl{
30935 \emph on
30936 your table caption
30937 \emph default
30938 }{
30939 \family default
30940  (sic);
30941  you must also the \SpecialChar TeX
30942  code
30943 \family typewriter
30944 }
30945 \family default
30946  immediately after the tabular material.
30947  Study the example table included in the template files to see how this trick is implemented.
30948  Alternatively,
30949  If you need table captions,
30950  you should implement the whole table float in a
30951 \family typewriter
30952 .tex
30953 \family default
30954  file,
30955  then include this file to the \SpecialChar LyX
30956  document (
30957 \family sans
30958 Insert\SpecialChar menuseparator
30959 File\SpecialChar menuseparator
30960 Child
30961 \begin_inset space ~
30962 \end_inset
30963
30964 Document
30965 \family default
30966 ).
30967  Details on how to create a table float can be found in the files
30968 \family typewriter
30969 ws-ijmpc.tex
30970 \family default
30971  and
30972 \family typewriter
30973 ws-ijmpd.tex
30974 \family default
30975 ,
30976  included in the corresponding packages.
30977 \end_layout
30978
30979 \begin_layout Standard
30980
30981 \change_deleted 564990737 1669755802
30982 Preparing a paper for submission
30983 \end_layout
30984
30985 \begin_layout Standard
30986
30987 \change_deleted 564990737 1669755802
30988 Before you submit your paper you must export the \SpecialChar LyX
30989  document as a \SpecialChar LaTeX
30990  file (
30991 \family sans
30992 File\SpecialChar menuseparator
30993 Export\SpecialChar menuseparator
30994 \SpecialChar LaTeX
30995
30996 \family default
30997 )
30998 \begin_inset Foot
30999 status open
31000
31001 \begin_layout Plain Layout
31002 Actually you have the choice between \SpecialChar LaTeX
31003  (plain) and pdflatex.
31004  If you intend to use pdflatex to prepare the paper,
31005  you should use the pdflatex option so that included graphics are converted to PDF format,
31006  ready for use by pdflatex.
31007 \end_layout
31008
31009 \end_inset
31010
31011 ,
31012  then make the following changes to the resulting
31013 \family typewriter
31014 .tex
31015 \family default
31016  file.
31017 \end_layout
31018
31019 \begin_layout Enumerate
31020
31021 \change_deleted 564990737 1669755802
31022 Remove the comment lines before the
31023 \family typewriter
31024
31025 \backslash
31026 documentclass
31027 \family default
31028  command.
31029 \end_layout
31030
31031 \begin_layout Enumerate
31032
31033 \change_deleted 564990737 1669755802
31034 Remove everything between (and including) the
31035 \family typewriter
31036
31037 \backslash
31038 makeatletter
31039 \family default
31040  and
31041 \family typewriter
31042
31043 \backslash
31044 makeatother
31045 \family default
31046  commands,
31047  except for any commands you specifically put into the \SpecialChar LaTeX
31048  preamble.
31049 \end_layout
31050
31051 \begin_layout Standard
31052
31053 \change_deleted 564990737 1672743015
31054 The modified
31055 \family typewriter
31056 .tex
31057 \family default
31058  file should be saved and processed through \SpecialChar LaTeX
31059  as many times as necessary.
31060  You may also want to check the resulting
31061 \family typewriter
31062 .dvi
31063 \family default
31064  document.
31065 \end_layout
31066
31067 \begin_layout Standard
31068
31069 \change_deleted 564990737 1669801478
31070 iopart
31071 \end_layout
31072
31073 \begin_layout Standard
31074
31075 \change_deleted 564990737 1669801478
31076 by
31077 \noun on
31078 Uwe Stöhr
31079 \end_layout
31080
31081 \begin_layout Standard
31082
31083 \change_deleted 564990737 1669801478
31084 Overview
31085 \end_layout
31086
31087 \begin_layout Standard
31088
31089 \change_deleted 564990737 1669801478
31090 The iopart package provides a document class to create electronic manuscript submission to the journals published by the Institute of Physics.
31091  Instructions for the authors how to create a paper using the iopart class can be downloaded together with the iopart package from the site
31092 \begin_inset Flex URL
31093 status collapsed
31094
31095 \begin_layout Plain Layout
31096
31097 ftp://ftp.iop.org/pub/journals/latex2e
31098 \end_layout
31099
31100 \end_inset
31101
31102 .
31103 \end_layout
31104
31105 \begin_layout Standard
31106
31107 \change_deleted 564990737 1669801478
31108 Writing a paper
31109 \end_layout
31110
31111 \begin_layout Standard
31112
31113 \change_deleted 564990737 1669801478
31114 The easiest way to write a paper is to start with the template
31115 \emph on
31116 IOP-article.lyx
31117 \emph default
31118  that is available via
31119 \family sans
31120 File\SpecialChar menuseparator
31121 New From Template
31122 \family default
31123  The template explains how to use the special text environments.
31124  Here are the most important advices:
31125 \end_layout
31126
31127 \begin_layout Itemize
31128
31129 \change_deleted 564990737 1669801478
31130 To be able to compile your document to a PDF,
31131  PS,
31132  or DVI,
31133  ensure that the no AMS packages are loaded in
31134 \family sans
31135 Document\SpecialChar menuseparator
31136 Settings\SpecialChar menuseparator
31137 Math Options
31138 \family default
31139 !
31140 \end_layout
31141
31142 \begin_layout Itemize
31143
31144 \change_deleted 564990737 1669801478
31145
31146 \size normal
31147 The title environment defines the kind of your paper.
31148  So use one of the following environments for the title:
31149 \end_layout
31150
31151 \begin_deeper
31152 \begin_layout Itemize
31153
31154 \change_deleted 564990737 1669801478
31155
31156 \family sans
31157 \size normal
31158 Title
31159 \family default
31160  for a Paper
31161 \end_layout
31162
31163 \begin_layout Itemize
31164
31165 \change_deleted 564990737 1669801478
31166
31167 \family sans
31168 \size normal
31169 Review
31170 \family default
31171  for a Review
31172 \end_layout
31173
31174 \begin_layout Itemize
31175
31176 \change_deleted 564990737 1669801478
31177
31178 \family sans
31179 \size normal
31180 Topical
31181 \family default
31182  for a Topical review
31183 \end_layout
31184
31185 \begin_layout Itemize
31186
31187 \change_deleted 564990737 1669801478
31188
31189 \family sans
31190 \size normal
31191 Comment
31192 \family default
31193  for a Comment
31194 \end_layout
31195
31196 \begin_layout Itemize
31197
31198 \change_deleted 564990737 1669801478
31199
31200 \family sans
31201 \size normal
31202 Note
31203 \family default
31204  for a Note
31205 \end_layout
31206
31207 \begin_layout Itemize
31208
31209 \change_deleted 564990737 1669801478
31210
31211 \family sans
31212 \size normal
31213 Paper
31214 \family default
31215  for a Paper (same as Title)
31216 \end_layout
31217
31218 \begin_layout Itemize
31219
31220 \change_deleted 564990737 1669801478
31221
31222 \family sans
31223 \size normal
31224 Prelim
31225 \family default
31226  for a Preliminary communication
31227 \end_layout
31228
31229 \begin_layout Itemize
31230
31231 \change_deleted 564990737 1669801478
31232
31233 \family sans
31234 \size normal
31235 Rapid
31236 \family default
31237  for a Rapid communication
31238 \end_layout
31239
31240 \begin_layout Itemize
31241
31242 \change_deleted 564990737 1669801478
31243
31244 \family sans
31245 \size normal
31246 Letter
31247 \family default
31248  for a Letter to the editor
31249 \end_layout
31250
31251 \end_deeper
31252 \begin_layout Itemize
31253
31254 \change_deleted 564990737 1669801478
31255
31256 \size normal
31257 All title environments except of
31258 \family sans
31259 Letter
31260 \family default
31261  can have an optional short title.
31262 \end_layout
31263
31264 \begin_layout Itemize
31265
31266 \change_deleted 564990737 1669801478
31267 There is a general title environment
31268 \family sans
31269 Article
31270 \family default
31271  which is not directly supported by \SpecialChar LyX
31272 .
31273  This can be used as \SpecialChar TeX
31274  code when your document doesn't fit into one of the other title types.
31275 \end_layout
31276
31277 \begin_layout Standard
31278
31279 \change_deleted 564990737 1672743015
31280 For more informations like hints for special table and formula formatting,
31281  look at the IOP author guidelines.
31282 \end_layout
31283
31284 \begin_layout Standard
31285
31286 \change_deleted 564990737 1670317155
31287 Kluwer
31288 \end_layout
31289
31290 \begin_layout Standard
31291
31292 \change_deleted 564990737 1670317155
31293 by
31294 \noun on
31295 Panayotis Papasotiriou
31296 \end_layout
31297
31298 \begin_layout Standard
31299
31300 \change_deleted 564990737 1670317155
31301 Overview
31302 \end_layout
31303
31304 \begin_layout Standard
31305
31306 \change_deleted 564990737 1670317155
31307 The Kluwer package is a set of macros produced by Kluwer Academic Publishers that facilitates electronic manuscript submission to the journals they publish.
31308  Most known of them (at least in my domain of interest) are
31309 \emph on
31310 Astrophysics and Space Science
31311 \emph default
31312  and
31313 \emph on
31314 Solar Physics
31315 \emph default
31316 ,
31317  but there are many others (see a complete list at
31318 \begin_inset Flex URL
31319 status collapsed
31320
31321 \begin_layout Plain Layout
31322
31323 http://www.wkap.nl/jrnllist.htm/JRNLHOME
31324 \end_layout
31325
31326 \end_inset
31327
31328 ).
31329  The Kluwer package may be downloaded from the site
31330 \begin_inset Flex URL
31331 status collapsed
31332
31333 \begin_layout Plain Layout
31334
31335 http://www.wkap.nl/kaphtml.htm/STYLEFILES
31336 \end_layout
31337
31338 \end_inset
31339
31340 .
31341  A complete user guide is contained in that package (but it can also be downloaded separately).
31342 \end_layout
31343
31344 \begin_layout Standard
31345
31346 \change_deleted 564990737 1670317155
31347 \SpecialChar LyX
31348  supports many features of the package but not everything.
31349  However,
31350  the \SpecialChar TeX
31351  code needed is reduced to some
31352 \begin_inset Quotes eld
31353 \end_inset
31354
31355 peculiar
31356 \begin_inset Quotes erd
31357 \end_inset
31358
31359  commands of the package (see
31360 \begin_inset space ~
31361 \end_inset
31362
31363
31364 \begin_inset CommandInset ref
31365 LatexCommand ref
31366 reference "subsec:kluwer_peculiarities"
31367 nolink "false"
31368
31369 \end_inset
31370
31371 ).
31372  I have recently used \SpecialChar LyX
31373  to write an article submitted to the
31374 \emph on
31375 Astrophysics and Space Science
31376 \emph default
31377  without any problem.
31378 \end_layout
31379
31380 \begin_layout Standard
31381
31382 \change_deleted 564990737 1670317155
31383 Writing a paper
31384 \end_layout
31385
31386 \begin_layout Standard
31387
31388 \change_deleted 564990737 1670317155
31389 The easiest way to write a paper is to start with the Kluwer template file.
31390  Click on
31391 \family sans
31392 File\SpecialChar menuseparator
31393 New from
31394 \family default
31395
31396 \family sans
31397 Template
31398 \family default
31399 ,
31400  then choose the
31401 \family typewriter
31402 kluwer.lyx
31403 \family default
31404  template.
31405  This will give an (almost) empty document that includes the most common fields found in a manuscript and a short description of their use.
31406  As in most templates,
31407  simply overwrite the existing text (including the brackets,
31408
31409 \family typewriter
31410 <>
31411 \family default
31412 ) with the correct information.
31413 \end_layout
31414
31415 \begin_layout Standard
31416
31417 \change_deleted 564990737 1670317155
31418 Preparing a paper for submission
31419 \end_layout
31420
31421 \begin_layout Standard
31422
31423 \change_deleted 564990737 1670317155
31424 As in the AAS\SpecialChar TeX
31425  package,
31426  before you submit your paper to a journal you must
31427 \begin_inset Quotes eld
31428 \end_inset
31429
31430 postprocess
31431 \begin_inset Quotes erd
31432 \end_inset
31433
31434  it as follows.
31435 \end_layout
31436
31437 \begin_layout Enumerate
31438
31439 \change_deleted 564990737 1670317155
31440 Export your paper as a \SpecialChar LaTeX
31441  file.
31442  To do this,
31443  click on
31444 \family sans
31445 File\SpecialChar menuseparator
31446 Export\SpecialChar menuseparator
31447 \SpecialChar LaTeX
31448
31449 \family default
31450 .
31451
31452 \end_layout
31453
31454 \begin_layout Enumerate
31455
31456 \change_deleted 564990737 1670317155
31457 Edit the resulting
31458 \family typewriter
31459 .tex
31460 \family default
31461  file with a text editor and make the following changes
31462 \end_layout
31463
31464 \begin_deeper
31465 \begin_layout Enumerate
31466
31467 \change_deleted 564990737 1670317155
31468 remove the comment lines before the
31469 \family typewriter
31470
31471 \backslash
31472 documentclass
31473 \family default
31474  command,
31475 \end_layout
31476
31477 \begin_layout Enumerate
31478
31479 \change_deleted 564990737 1670317155
31480 remove everything between (and including) the
31481 \family typewriter
31482
31483 \backslash
31484 makeatletter
31485 \family default
31486  and
31487 \family typewriter
31488
31489 \backslash
31490 makeatother
31491 \family default
31492  commands,
31493  except for any commands you specifically put into the \SpecialChar LaTeX
31494  preamble.
31495 \end_layout
31496
31497 \begin_layout Standard
31498
31499 \change_deleted 564990737 1670317155
31500 Save the resulting
31501 \family typewriter
31502 .tex
31503 \family default
31504  file.
31505 \end_layout
31506
31507 \end_deeper
31508 \begin_layout Enumerate
31509
31510 \change_deleted 564990737 1670317155
31511 Run the
31512 \family typewriter
31513 .tex
31514 \family default
31515  file through \SpecialChar LaTeX
31516  as many times as necessary (usually up to three).
31517 \end_layout
31518
31519 \begin_layout Enumerate
31520
31521 \change_deleted 564990737 1670317155
31522 View the resulting
31523 \family typewriter
31524 .dvi
31525 \family default
31526  document using,
31527  e.
31528 \begin_inset space \thinspace{}
31529 \end_inset
31530
31531 g.
31532 \begin_inset space \space{}
31533 \end_inset
31534
31535
31536 \family sans
31537 xdvi
31538 \family default
31539 ,
31540  and check if everything is OK (it should,
31541  if you didn't make any mistake).
31542 \end_layout
31543
31544 \begin_layout Standard
31545
31546 \change_deleted 564990737 1670317155
31547 \begin_inset Quotes eld
31548 \end_inset
31549
31550 Peculiarities
31551 \begin_inset Quotes erd
31552 \end_inset
31553
31554  of the Kluwer package
31555 \begin_inset CommandInset label
31556 LatexCommand label
31557 name "subsec:kluwer_peculiarities"
31558
31559 \end_inset
31560
31561
31562 \end_layout
31563
31564 \begin_layout Standard
31565
31566 \change_deleted 564990737 1670317155
31567 The Kluwer package has the following
31568 \begin_inset Quotes eld
31569 \end_inset
31570
31571 peculiarities
31572 \begin_inset Quotes erd
31573 \end_inset
31574
31575 .
31576 \end_layout
31577
31578 \begin_layout Enumerate
31579
31580 \change_deleted 564990737 1670317155
31581 It is possible to write multiple articles in the same \SpecialChar LaTeX
31582  file
31583 \begin_inset Foot
31584 status collapsed
31585
31586 \begin_layout Plain Layout
31587 I can't imagine any good reason to do this.
31588 \end_layout
31589
31590 \end_inset
31591
31592 .
31593  Each article must be included in the environment
31594 \begin_inset Quotes eld
31595 \end_inset
31596
31597 article
31598 \begin_inset Quotes erd
31599 \end_inset
31600
31601 .
31602  Unfortunately,
31603  this environment cannot be omitted,
31604  even if you write just one article.
31605  Therefore,
31606  each article starts with the command
31607 \family typewriter
31608
31609 \backslash
31610 begin{article}
31611 \family default
31612  and,
31613  obviously,
31614  ends with the command
31615 \family typewriter
31616
31617 \backslash
31618 end{article}
31619 \family default
31620 .
31621  Although this can be implemented in \SpecialChar LyX
31622 ,
31623  I didn't included it,
31624  since it looks ugly and can confuse the novice user.
31625  Therefore,
31626  you need to enter them directly and mark them as \SpecialChar LaTeX
31627  code (the well-known
31628 \begin_inset Quotes eld
31629 \end_inset
31630
31631 \SpecialChar TeX
31632  code
31633 \begin_inset Quotes erd
31634 \end_inset
31635
31636 ).
31637 \end_layout
31638
31639 \begin_layout Enumerate
31640
31641 \change_deleted 564990737 1670317155
31642 Information given at the beginning of the article (i.
31643 \begin_inset space \thinspace{}
31644 \end_inset
31645
31646 e.
31647 \begin_inset space \space{}
31648 \end_inset
31649
31650 title,
31651  subtitle,
31652  author,
31653  institution,
31654  running title,
31655  running author,
31656  abstract and keywords) must be included in an environment called
31657 \begin_inset Quotes eld
31658 \end_inset
31659
31660 opening
31661 \begin_inset Quotes erd
31662 \end_inset
31663
31664 .
31665  This is not implemented in \SpecialChar LyX
31666 ,
31667  so you must enter title,
31668  subtitle etc.
31669 \begin_inset space ~
31670 \end_inset
31671
31672 between two \SpecialChar TeX
31673  code lines (
31674 \family typewriter
31675
31676 \backslash
31677 begin{opening}
31678 \family default
31679  and
31680 \family typewriter
31681
31682 \backslash
31683 end{opening}
31684 \family default
31685 ).
31686 \end_layout
31687
31688 \begin_layout Enumerate
31689
31690 \change_deleted 564990737 1670317155
31691 According to the user manual,
31692  the label of each bibliography item must be written as
31693 \family typewriter
31694
31695 \backslash
31696 protect
31697 \backslash
31698 citeauthoryear{
31699 \family default
31700 \emph on
31701 author(s)
31702 \family typewriter
31703 \emph default
31704 }{
31705 \family default
31706 \emph on
31707 year
31708 \family typewriter
31709 \emph default
31710 }
31711 \family default
31712 .
31713 \end_layout
31714
31715 \begin_layout Standard
31716
31717 \change_deleted 564990737 1670317155
31718 The
31719 \family typewriter
31720 kluwer.lyx
31721 \family default
31722  template takes care of all these
31723 \begin_inset Quotes eld
31724 \end_inset
31725
31726 peculiarities
31727 \begin_inset Quotes erd
31728 \end_inset
31729
31730 .
31731  If you start a new paper using this template you don't need to do anything special.
31732  Just
31733 \end_layout
31734
31735 \begin_layout Enumerate
31736
31737 \change_deleted 564990737 1670317155
31738 don't delete the \SpecialChar TeX
31739  code included in the template,
31740  and
31741 \end_layout
31742
31743 \begin_layout Enumerate
31744
31745 \change_deleted 564990737 1670317155
31746 copy the example bibliography item included in the template and modify it as necessary to enter new bibliography items.
31747 \end_layout
31748
31749 \begin_layout Standard
31750
31751 \change_deleted 564990737 1671097446
31752 Paper
31753 \end_layout
31754
31755 \begin_layout Standard
31756
31757 \change_deleted 564990737 1671097446
31758 The document class
31759 \family sans
31760 paper
31761 \family default
31762  provides an alternative to the standard
31763 \family sans
31764 article
31765 \family default
31766  class.
31767  It provides similar functionality,
31768  but you might prefer this layout with sans serif sections,
31769  headings,
31770  and more.
31771 \end_layout
31772
31773 \begin_layout Standard
31774
31775 \change_deleted 564990737 1671097446
31776 Springer Journals (
31777 \family sans
31778 svjour
31779 \family default
31780 )
31781 \end_layout
31782
31783 \begin_layout Standard
31784
31785 \change_deleted 564990737 1671097446
31786 by
31787 \noun on
31788 Martin Vermeer
31789 \end_layout
31790
31791 \begin_layout Standard
31792
31793 \change_deleted 564990737 1671097446
31794 Description
31795 \end_layout
31796
31797 \begin_layout Standard
31798
31799 \change_deleted 564990737 1671097446
31800 These are the layout files for some of the journal formats used by Springer Verlag and listed on
31801 \begin_inset Flex URL
31802 status collapsed
31803
31804 \begin_layout Plain Layout
31805
31806 http://www.springer.de/author/tex/help-journals.html
31807 \end_layout
31808
31809 \end_inset
31810
31811 ,
31812  where you should also go to fetch the class files (yes,
31813  these are \SpecialChar LaTeX2e
31814  now!).
31815  It is a modular system:
31816  the things common to all journals are implemented in
31817 \family typewriter
31818 svjour.inc
31819 \family default
31820 ,
31821  which journal-specific layout files (such as,
31822  e.
31823 \begin_inset space \thinspace{}
31824 \end_inset
31825
31826 g.
31827 \begin_inset space \space{}
31828 \end_inset
31829
31830
31831 \family typewriter
31832 svjog.layout
31833 \family default
31834  for Journal of Geodesy) can include.
31835 \end_layout
31836
31837 \begin_layout Standard
31838
31839 \change_deleted 564990737 1671097446
31840 This means that implementing support for any other Springer journal on this list is as simple as writing your own
31841 \family typewriter
31842 sv
31843 \family default
31844 <myjournal>
31845 \family typewriter
31846 .layout
31847 \family default
31848  file following the outline given in
31849 \family typewriter
31850 svjog.layout
31851 \family default
31852 .
31853
31854 \end_layout
31855
31856 \begin_layout Standard
31857
31858 \change_deleted 564990737 1671097446
31859 It is reasonably well tested only for the Journal of Geodesy.
31860
31861 \family typewriter
31862 svjour
31863 \family default
31864  and
31865 \family typewriter
31866 svjog
31867 \family default
31868  come with the standard \SpecialChar LyX
31869  distribution.
31870  Install the relevant class file (downloaded from Springer) in a proper directory,
31871  reconfigure \SpecialChar LaTeX
31872  (in the te\SpecialChar TeX
31873  case by running
31874 \family typewriter
31875 texhash
31876 \family default
31877 ,
31878  as root if necessary —
31879  doesn't \SpecialChar LyX
31880  take care of this?),
31881  reconfigure \SpecialChar LyX
31882  and it should work.
31883 \end_layout
31884
31885 \begin_layout Standard
31886
31887 \change_deleted 564990737 1671097446
31888 New styles
31889 \end_layout
31890
31891 \begin_layout Standard
31892
31893 \change_deleted 564990737 1671097446
31894 A large number of theorem-like styles —
31895
31896 \family sans
31897 Claim,
31898  Conjecture,
31899
31900 \family default
31901
31902 \family sans
31903 \SpecialChar ldots
31904 Theorem
31905 \family default
31906 .
31907 \end_layout
31908
31909 \begin_layout Standard
31910
31911 \change_deleted 564990737 1671097446
31912
31913 \family sans
31914 Headnote,
31915  Dedication,
31916  Subtitle,
31917  Running_\SpecialChar LaTeX
31918 _Title,
31919  Author_Running,
31920  Institute,
31921  Mail,
31922  Offprints,
31923  Keywords,
31924  Acknowledgements,
31925  Acknowledgement
31926 \family default
31927 .
31928  See the Springer class file documentation for details.
31929 \end_layout
31930
31931 \begin_layout Standard
31932
31933 \change_deleted 564990737 1671097446
31934 Supported journals
31935 \end_layout
31936
31937 \begin_layout Itemize
31938
31939 \change_deleted 564990737 1671097446
31940
31941 \emph on
31942 Journal of Geodesy
31943 \emph default
31944 :
31945
31946 \family typewriter
31947 svjog.layout
31948 \family default
31949  —
31950  Martin Vermeer
31951 \end_layout
31952
31953 \begin_layout Itemize
31954
31955 \change_deleted 564990737 1671097446
31956
31957 \emph on
31958 Probability Theory and Related Fields
31959 \emph default
31960 :
31961
31962 \family typewriter
31963 svprobth.layout
31964 \family default
31965  —
31966  Jean-Marc Lasgouttes
31967 \end_layout
31968
31969 \begin_layout Standard
31970
31971 \change_deleted 564990737 1671097446
31972 Add your own,
31973  it isn't so hard!
31974 \end_layout
31975
31976 \begin_layout Standard
31977
31978 \change_deleted 564990737 1671097446
31979 Credits
31980 \end_layout
31981
31982 \begin_layout Standard
31983
31984 \change_deleted 564990737 1671097446
31985 These files are partly based on the older
31986 \family typewriter
31987 ejour2.layout
31988 \family default
31989 ,
31990  which was again based on a tinkered-with version of an old \SpecialChar LaTeX
31991  2.09 style file from Springer.
31992  All this,
31993  and the
31994 \family typewriter
31995 ejour2
31996 \family default
31997  layout,
31998  are now defunct.
31999  Jean-Marc Lasgouttes helped out big in making me find my way around the \SpecialChar LyX
32000  layout file mechanism.
32001 \end_layout
32002
32003 \begin_layout Standard
32004
32005 \change_deleted 564990737 1671097446
32006 Bugs
32007 \end_layout
32008
32009 \begin_layout Standard
32010
32011 \change_deleted 564990737 1671097446
32012 Probably.
32013  But probably less than in the old hacked-\SpecialChar LaTeX
32014
32015 \family typewriter
32016 ejour2
32017 \family default
32018 .
32019 \end_layout
32020
32021 \begin_layout Chapter
32022 \SpecialChar LyX
32023  Features needing Extra Software
32024 \end_layout
32025
32026 \begin_layout Section
32027 Checking \SpecialChar TeX
32028
32029 \end_layout
32030
32031 \begin_layout Standard
32032 by
32033 \noun on
32034 Asger Alstrup
32035 \end_layout
32036
32037 \begin_layout Subsection
32038 Introduction
32039 \end_layout
32040
32041 \begin_layout Standard
32042 If you have the
32043 \family typewriter
32044 chktex
32045 \family default
32046  program installed
32047 \begin_inset Foot
32048 status collapsed
32049
32050 \begin_layout Plain Layout
32051
32052 \family typewriter
32053 chktex
32054 \family default
32055  is not yet available when you are using the \SpecialChar LaTeX
32056  distribution MiK\SpecialChar TeX
32057 .
32058 \end_layout
32059
32060 \end_inset
32061
32062 ,
32063  you'll find in the
32064 \family sans
32065 Tools
32066 \family default
32067  menu the entry:
32068
32069 \family sans
32070 Check
32071 \begin_inset space ~
32072 \end_inset
32073
32074 TeX
32075 \family default
32076 .
32077  You can get
32078 \family typewriter
32079 chktex
32080 \family default
32081  from CTAN,
32082 \begin_inset Newline newline
32083 \end_inset
32084
32085
32086 \begin_inset CommandInset href
32087 LatexCommand href
32088 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
32089 literal "false"
32090
32091 \end_inset
32092
32093 .
32094 \end_layout
32095
32096 \begin_layout Standard
32097 The
32098 \family sans
32099 Chk\SpecialChar TeX
32100
32101 \family default
32102  package is a program that was written by
32103 \begin_inset Flex Noun
32104 status collapsed
32105
32106 \begin_layout Plain Layout
32107 Jens T.
32108 \begin_inset space ~
32109 \end_inset
32110
32111 Berger Thielemann
32112 \end_layout
32113
32114 \end_inset
32115
32116  in frustration because some constructs in \SpecialChar LaTeX
32117  are sometimes non-intuitive,
32118  and easy to forget.
32119  The program runs over your \SpecialChar LaTeX
32120  file,
32121  checks the integrity of the file,
32122  and flags some common errors.
32123  In other technical words,
32124  it is
32125 \family typewriter
32126 lint
32127 \family default
32128  for \SpecialChar LaTeX
32129 .
32130 \end_layout
32131
32132 \begin_layout Standard
32133 Well,
32134  what is a syntax checker doing in \SpecialChar LyX
32135  which is supposed to produce correct \SpecialChar LaTeX
32136  anyways?
32137  The answer is simple:
32138  Just as
32139 \family typewriter
32140 Lint
32141 \family default
32142  not only checks the
32143 \emph on
32144 syntax
32145 \emph default
32146  of C programs,
32147  but also does
32148 \emph on
32149 semantic
32150 \emph default
32151  checks for type-errors,
32152
32153 \family sans
32154 Chk\SpecialChar TeX
32155
32156 \family default
32157  catches some common
32158 \emph on
32159 typographic
32160 \emph default
32161  errors,
32162  in addition to the syntactical ones.
32163  Specifically,
32164
32165 \family sans
32166 Chk\SpecialChar TeX
32167
32168 \family default
32169  is capable of detecting several common errors,
32170  such as
32171 \end_layout
32172
32173 \begin_layout Itemize
32174 Ellipsis detection:
32175 \begin_inset Newline newline
32176 \end_inset
32177
32178 Use \SpecialChar ldots
32179  instead of ...
32180 \end_layout
32181
32182 \begin_layout Itemize
32183 No space in front of/after parenthesis:
32184 \begin_inset Newline newline
32185 \end_inset
32186
32187 ( wrong spacing )
32188 \end_layout
32189
32190 \begin_layout Itemize
32191 Enforcement of normal space after common abbreviations:
32192 \begin_inset Newline newline
32193 \end_inset
32194
32195 e.
32196 \begin_inset space \thinspace{}
32197 \end_inset
32198
32199 g.
32200 \begin_inset space \space{}
32201 \end_inset
32202
32203 is too wide spacing.
32204 \end_layout
32205
32206 \begin_layout Itemize
32207 Enforcement of end-of-sentence space when the last sentence ends with a capital letter:
32208 \begin_inset Newline newline
32209 \end_inset
32210
32211 This is a TEST.
32212  And this is wrong spacing.
32213 \end_layout
32214
32215 \begin_layout Itemize
32216 Space in front of labels and similar commands:
32217 \begin_inset Newline newline
32218 \end_inset
32219
32220 The label should stick right up to the text to avoid falling to a wrong page.
32221
32222 \begin_inset CommandInset label
32223 LatexCommand label
32224 name "sec:chktex"
32225
32226 \end_inset
32227
32228
32229 \begin_inset Foot
32230 status collapsed
32231
32232 \begin_layout Plain Layout
32233 This footnote is in danger of falling off to a wrong page
32234 \end_layout
32235
32236 \end_inset
32237
32238  The label is separated too much.
32239 \end_layout
32240
32241 \begin_layout Itemize
32242 Space in front of references,
32243  instead of hard spaces:
32244 \begin_inset Newline newline
32245 \end_inset
32246
32247 If you have bad luck,
32248  the text will break right between the referenced text and reference number,
32249  and that's a pity.
32250  See section
32251 \begin_inset CommandInset ref
32252 LatexCommand ref
32253 reference "sec:chktex"
32254 nolink "false"
32255
32256 \end_inset
32257
32258 .
32259 \end_layout
32260
32261 \begin_layout Itemize
32262 Use of
32263 \begin_inset Quotes eld
32264 \end_inset
32265
32266 x
32267 \begin_inset Quotes erd
32268 \end_inset
32269
32270  instead of
32271 \begin_inset Formula $\times$
32272 \end_inset
32273
32274  between numbers:
32275 \begin_inset Newline newline
32276 \end_inset
32277
32278 2x2 looks cheap compared to
32279 \begin_inset Formula $2\times2$
32280 \end_inset
32281
32282 .
32283 \end_layout
32284
32285 \begin_layout Standard
32286 and more \SpecialChar ldots
32287  It is an invaluable tool when you are
32288 \begin_inset Quotes eld
32289 \end_inset
32290
32291 finishing up
32292 \begin_inset Quotes erd
32293 \end_inset
32294
32295  your document before printing,
32296  and you should run it right after the obligatory spelling check,
32297  and before you go fine tuning the typesetting.
32298 \end_layout
32299
32300 \begin_layout Subsection
32301 How to use it
32302 \end_layout
32303
32304 \begin_layout Standard
32305 If you have the program installed,
32306  usage is as simple as choosing
32307 \family sans
32308 Tools\SpecialChar menuseparator
32309 Check
32310 \begin_inset space ~
32311 \end_inset
32312
32313 TeX
32314 \family default
32315 .
32316  This will make \SpecialChar LyX
32317  generate a \SpecialChar LaTeX
32318  file of your document,
32319  start
32320 \family sans
32321 Chk\SpecialChar TeX
32322
32323 \family default
32324  to check it,
32325  and then make \SpecialChar LyX
32326  insert
32327 \begin_inset Quotes eld
32328 \end_inset
32329
32330 error boxes
32331 \begin_inset Quotes erd
32332 \end_inset
32333
32334  with the warnings from
32335 \family sans
32336 Chk\SpecialChar TeX
32337
32338 \family default
32339 ,
32340  if there were any.
32341  The warnings will be placed close to the point of the mistake,
32342  and you can quickly find them by using the
32343 \family sans
32344 Navigate\SpecialChar menuseparator
32345 Error
32346 \family default
32347  menu item,
32348  or the shortcut key
32349 \family sans
32350 C-g
32351 \family default
32352  from the default
32353 \family typewriter
32354 cua
32355 \family default
32356  bind file.
32357  Open the error boxes by clicking on them with the mouse,
32358  or use the shortcut key
32359 \family sans
32360 C-i
32361 \family default
32362  from
32363 \family typewriter
32364 cua
32365 \family default
32366  bindings,
32367  or the corresponding
32368 \family sans
32369 C-o
32370 \family default
32371  for the alternate
32372 \family typewriter
32373 emacs
32374 \family default
32375  bind file.
32376  Read the warning and correct the mistake,
32377  if it is a mistake.
32378  If you have trouble understanding what the warning is about,
32379  you can safely ignore it.
32380  Remember that there is a hidden layer between the document on screen and the technical details in invoking
32381 \family sans
32382 Chk\SpecialChar TeX
32383
32384 \family default
32385 ,
32386  and this gap can make some warnings seem arcane or just plain silly.
32387 \end_layout
32388
32389 \begin_layout Standard
32390 This document is an excellent testing bed for the feature,
32391  and it should provide quite a few warnings for you to fiddle with.
32392  Since computers are only so smart,
32393  expect most of the warnings to be false alarms,
32394  though.
32395 \end_layout
32396
32397 \begin_layout Subsection
32398 How to fine tune it
32399 \end_layout
32400
32401 \begin_layout Standard
32402 Sometimes,
32403  you'll find that
32404 \family sans
32405 Chk\SpecialChar TeX
32406
32407 \family default
32408  makes more noise than suits your mood.
32409  Then you can choose not to use it,
32410  wait until your mood changes,
32411  or try to customize
32412 \family sans
32413 Chk\SpecialChar TeX
32414
32415 \family default
32416  to get better along with you.
32417 \end_layout
32418
32419 \begin_layout Standard
32420 Although
32421 \family sans
32422 Chk\SpecialChar TeX
32423
32424 \family default
32425
32426 \emph on
32427 is
32428 \emph default
32429  very configurable and extensible,
32430  you should not expect to solve all problems with
32431 \family sans
32432 Chk\SpecialChar TeX
32433
32434 \family default
32435  in \SpecialChar LyX
32436  this way.
32437  Since \SpecialChar LyX
32438  has to generate a somewhat special \SpecialChar LaTeX
32439  file to be able to match the line numbers from the
32440 \family sans
32441 Chk\SpecialChar TeX
32442
32443 \family default
32444  output
32445 \begin_inset Foot
32446 status collapsed
32447
32448 \begin_layout Plain Layout
32449 You can inspect the specific output from
32450 \family sans
32451 chktex
32452 \family default
32453  by using
32454 \family sans
32455 Document\SpecialChar menuseparator
32456 \SpecialChar LaTeX
32457
32458 \begin_inset space ~
32459 \end_inset
32460
32461 Log
32462 \family default
32463  right after a
32464 \family sans
32465 chktex
32466 \family default
32467  run.
32468 \end_layout
32469
32470 \end_inset
32471
32472  to the internal document structure,
32473  some of the warnings will not appear correctly.
32474  There are two things you can do about this:
32475 \end_layout
32476
32477 \begin_layout Itemize
32478 Fine tune the
32479 \family sans
32480 Chk\SpecialChar TeX
32481
32482 \family default
32483  invocation command line in
32484 \begin_inset Flex Noun
32485 status collapsed
32486
32487 \begin_layout Plain Layout
32488 Tools\SpecialChar menuseparator
32489 Preferences\SpecialChar menuseparator
32490 Output\SpecialChar menuseparator
32491 LaTeX\SpecialChar menuseparator
32492 CheckTeX command
32493 \end_layout
32494
32495 \end_inset
32496
32497 ,
32498  or the global
32499 \family sans
32500 Chk\SpecialChar TeX
32501
32502 \family default
32503  installation configuration file (usually with the file
32504 \family typewriter
32505 chktexrc
32506 \family default
32507 ).
32508  See below to learn what warnings can be enabled and disabled on the command line.
32509 \end_layout
32510
32511 \begin_layout Itemize
32512 Export your document as a raw \SpecialChar LaTeX
32513  file using
32514 \family sans
32515 File\SpecialChar menuseparator
32516 Export\SpecialChar menuseparator
32517 \SpecialChar LaTeX
32518
32519 \family default
32520  and run
32521 \family typewriter
32522 chktex
32523 \family default
32524  manually on that.
32525  Invoked in this way,
32526  it can be a hassle to find the corresponding place in the document inside \SpecialChar LyX
32527 ,
32528  but with a little patience,
32529  you should be able to do it.
32530 \end_layout
32531
32532 \begin_layout Standard
32533 Here follows the warning messages that can be enabled and disabled in
32534 \family sans
32535 Preferences
32536 \family default
32537 .
32538  Use
32539 \family typewriter
32540 -n#
32541 \family default
32542  to disable a warning,
32543  and
32544 \family typewriter
32545 -w#
32546 \family default
32547  to enable a warning.
32548  The emphasized entries are disabled by default,
32549  because the default is "
32550 \family typewriter
32551 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
32552 \family default
32553 ".
32554 \end_layout
32555
32556 \begin_layout Standard
32557 Notice that you should only use the options that enable and disable warnings,
32558  because \SpecialChar LyX
32559  relies on some of the other command line parameters to be set in a specific way to have a chance to communicate with
32560 \family typewriter
32561 chktex
32562 \family default
32563 .
32564 \end_layout
32565
32566 \begin_layout Enumerate
32567
32568 \size small
32569 \emph on
32570 Command terminated with space.
32571 \end_layout
32572
32573 \begin_layout Enumerate
32574
32575 \size small
32576 Non-breaking space (
32577 \begin_inset Quotes eld
32578 \end_inset
32579
32580
32581 \family typewriter
32582 ~
32583 \family default
32584
32585 \begin_inset Quotes erd
32586 \end_inset
32587
32588 ) should have been used.
32589 \end_layout
32590
32591 \begin_layout Enumerate
32592
32593 \size small
32594 \emph on
32595 You should enclose the previous parenthesis with
32596 \begin_inset Quotes eld
32597 \end_inset
32598
32599
32600 \family typewriter
32601 {}
32602 \family default
32603
32604 \begin_inset Quotes erd
32605 \end_inset
32606
32607 .
32608 \end_layout
32609
32610 \begin_layout Enumerate
32611
32612 \size small
32613 Italic correction (
32614 \begin_inset Quotes eld
32615 \end_inset
32616
32617
32618 \family typewriter
32619
32620 \backslash
32621 /
32622 \family default
32623
32624 \begin_inset Quotes erd
32625 \end_inset
32626
32627 ) found in non-italic buffer.
32628 \end_layout
32629
32630 \begin_layout Enumerate
32631
32632 \size small
32633 Italic correction (
32634 \begin_inset Quotes eld
32635 \end_inset
32636
32637
32638 \family typewriter
32639
32640 \backslash
32641 /
32642 \family default
32643
32644 \begin_inset Quotes erd
32645 \end_inset
32646
32647 ) found more than once.
32648 \end_layout
32649
32650 \begin_layout Enumerate
32651
32652 \size small
32653 \emph on
32654 No italic correction (
32655 \begin_inset Quotes eld
32656 \end_inset
32657
32658
32659 \family typewriter
32660
32661 \backslash
32662 /
32663 \family default
32664
32665 \begin_inset Quotes erd
32666 \end_inset
32667
32668 ) found.
32669 \end_layout
32670
32671 \begin_layout Enumerate
32672
32673 \size small
32674 Accent command
32675 \begin_inset Quotes eld
32676 \end_inset
32677
32678
32679 \family typewriter
32680 cmd
32681 \family default
32682
32683 \begin_inset Quotes erd
32684 \end_inset
32685
32686  needs use of
32687 \begin_inset Quotes eld
32688 \end_inset
32689
32690
32691 \family typewriter
32692 cmd
32693 \family default
32694
32695 \begin_inset Quotes erd
32696 \end_inset
32697
32698 .
32699 \end_layout
32700
32701 \begin_layout Enumerate
32702
32703 \size small
32704 Wrong length of dash may have been used.
32705 \end_layout
32706
32707 \begin_layout Enumerate
32708
32709 \size small
32710 \emph on
32711 \begin_inset Quotes eld
32712 \end_inset
32713
32714
32715 \family typewriter
32716 %s
32717 \family default
32718
32719 \begin_inset Quotes erd
32720 \end_inset
32721
32722  expected,
32723  found
32724 \begin_inset Quotes eld
32725 \end_inset
32726
32727
32728 \family typewriter
32729 %s
32730 \family default
32731
32732 \begin_inset Quotes erd
32733 \end_inset
32734
32735 .
32736 \end_layout
32737
32738 \begin_layout Enumerate
32739
32740 \size small
32741 Solo
32742 \begin_inset Quotes eld
32743 \end_inset
32744
32745
32746 \family typewriter
32747 %s
32748 \family default
32749
32750 \begin_inset Quotes erd
32751 \end_inset
32752
32753  found.
32754 \end_layout
32755
32756 \begin_layout Enumerate
32757
32758 \size small
32759 You should use
32760 \begin_inset Quotes eld
32761 \end_inset
32762
32763
32764 \family typewriter
32765 %s
32766 \family default
32767
32768 \begin_inset Quotes erd
32769 \end_inset
32770
32771  to achieve an ellipsis.
32772 \end_layout
32773
32774 \begin_layout Enumerate
32775
32776 \size small
32777 Inter-word spacing (
32778 \begin_inset Quotes eld
32779 \end_inset
32780
32781
32782 \family typewriter
32783
32784 \backslash
32785
32786 \family default
32787
32788 \begin_inset Quotes eld
32789 \end_inset
32790
32791 ) should perhaps be used.
32792 \end_layout
32793
32794 \begin_layout Enumerate
32795
32796 \size small
32797 Inter-sentence spacing (
32798 \begin_inset Quotes eld
32799 \end_inset
32800
32801
32802 \family typewriter
32803
32804 \backslash
32805 @
32806 \family default
32807
32808 \begin_inset Quotes erd
32809 \end_inset
32810
32811 ) should perhaps be used.
32812 \end_layout
32813
32814 \begin_layout Enumerate
32815
32816 \size small
32817 Could not find argument for command.
32818 \end_layout
32819
32820 \begin_layout Enumerate
32821
32822 \size small
32823 No match found for
32824 \begin_inset Quotes eld
32825 \end_inset
32826
32827
32828 \family typewriter
32829 %s
32830 \family default
32831
32832 \begin_inset Quotes erd
32833 \end_inset
32834
32835 .
32836 \end_layout
32837
32838 \begin_layout Enumerate
32839
32840 \size small
32841 Math mode still on at end of \SpecialChar LaTeX
32842  file.
32843 \end_layout
32844
32845 \begin_layout Enumerate
32846
32847 \size small
32848 Number of
32849 \begin_inset Quotes eld
32850 \end_inset
32851
32852
32853 \family typewriter
32854 char
32855 \family default
32856
32857 \begin_inset Quotes erd
32858 \end_inset
32859
32860  doesn't match the number of
32861 \begin_inset Quotes eld
32862 \end_inset
32863
32864
32865 \family typewriter
32866 char
32867 \family default
32868
32869 \begin_inset Quotes erd
32870 \end_inset
32871
32872 .
32873 \end_layout
32874
32875 \begin_layout Enumerate
32876
32877 \size small
32878 You should use either
32879 \family typewriter
32880
32881 \begin_inset Quotes eld
32882 \end_inset
32883
32884
32885 \family default
32886  or
32887 \family typewriter
32888
32889 \begin_inset Quotes erd
32890 \end_inset
32891
32892
32893 \family default
32894  as an alternative to
32895 \begin_inset Quotes eld
32896 \end_inset
32897
32898
32899 \family typewriter
32900 "
32901 \family default
32902
32903 \begin_inset Quotes erd
32904 \end_inset
32905
32906 .
32907 \end_layout
32908
32909 \begin_layout Enumerate
32910
32911 \size small
32912 You should use "
32913 \family typewriter
32914 '
32915 \family default
32916 " (ASCII 39) instead of "
32917 \family typewriter
32918 ´
32919 \family default
32920 " (ASCII 180).
32921 \end_layout
32922
32923 \begin_layout Enumerate
32924
32925 \size small
32926 User-specified pattern found.
32927 \end_layout
32928
32929 \begin_layout Enumerate
32930
32931 \size small
32932 This command might not be intended.
32933 \end_layout
32934
32935 \begin_layout Enumerate
32936
32937 \size small
32938 \emph on
32939 Comment displayed.
32940 \end_layout
32941
32942 \begin_layout Enumerate
32943
32944 \size small
32945 Either
32946 \family typewriter
32947 ''
32948 \backslash
32949 ,'
32950 \family default
32951  or
32952 \family typewriter
32953 '
32954 \backslash
32955 ,''
32956 \family default
32957  will look better.
32958 \end_layout
32959
32960 \begin_layout Enumerate
32961
32962 \size small
32963 Delete this space to maintain correct page references.
32964 \end_layout
32965
32966 \begin_layout Enumerate
32967
32968 \size small
32969 \emph on
32970 You might wish to put this between a pair of
32971 \begin_inset Quotes eld
32972 \end_inset
32973
32974
32975 \family typewriter
32976 {}
32977 \family default
32978
32979 \begin_inset Quotes erd
32980 \end_inset
32981
32982 .
32983 \end_layout
32984
32985 \begin_layout Enumerate
32986
32987 \size small
32988 You ought to remove spaces in front of punctuation.
32989 \end_layout
32990
32991 \begin_layout Enumerate
32992
32993 \size small
32994 Could not execute \SpecialChar LaTeX
32995  command.
32996 \end_layout
32997
32998 \begin_layout Enumerate
32999
33000 \size small
33001 Don't use
33002 \family typewriter
33003
33004 \backslash
33005 /
33006 \family default
33007  in front of small punctuation.
33008 \end_layout
33009
33010 \begin_layout Enumerate
33011
33012 \family typewriter
33013 \size small
33014 $
33015 \backslash
33016 times$
33017 \family default
33018  may look prettier here.
33019 \end_layout
33020
33021 \begin_layout Enumerate
33022
33023 \size small
33024 \emph on
33025 Multiple spaces detected in output.
33026 \end_layout
33027
33028 \begin_layout Enumerate
33029
33030 \size small
33031 This text may be ignored.
33032 \end_layout
33033
33034 \begin_layout Enumerate
33035
33036 \size small
33037 Use
33038 \family typewriter
33039
33040 \begin_inset Quotes eld
33041 \end_inset
33042
33043
33044 \family default
33045  to begin quotation,
33046  not
33047 \family typewriter
33048 '
33049 \family default
33050 .
33051 \end_layout
33052
33053 \begin_layout Enumerate
33054
33055 \size small
33056 Use
33057 \family typewriter
33058 '
33059 \family default
33060  to end quotation,
33061  not
33062 \family typewriter
33063
33064 \begin_inset Quotes eld
33065 \end_inset
33066
33067
33068 \family default
33069 .
33070 \end_layout
33071
33072 \begin_layout Enumerate
33073
33074 \size small
33075 Don't mix quotes.
33076 \end_layout
33077
33078 \begin_layout Enumerate
33079
33080 \size small
33081 You should perhaps use
33082 \begin_inset Quotes eld
33083 \end_inset
33084
33085
33086 \family typewriter
33087 cmd
33088 \family default
33089
33090 \begin_inset Quotes erd
33091 \end_inset
33092
33093  instead.
33094 \end_layout
33095
33096 \begin_layout Enumerate
33097
33098 \size small
33099 You should put a space in front of/after parenthesis.
33100 \end_layout
33101
33102 \begin_layout Enumerate
33103
33104 \size small
33105 You should avoid spaces in front of/after parenthesis.
33106 \end_layout
33107
33108 \begin_layout Enumerate
33109
33110 \size small
33111 \emph on
33112 You should not use punctuation in front of/after quotes.
33113 \end_layout
33114
33115 \begin_layout Enumerate
33116
33117 \size small
33118 Double space found.
33119 \end_layout
33120
33121 \begin_layout Enumerate
33122
33123 \size small
33124 You should put punctuation outside inner/inside display math mode.
33125 \end_layout
33126
33127 \begin_layout Enumerate
33128
33129 \size small
33130 You ought to not use primitive \SpecialChar TeX
33131  in \SpecialChar LaTeX
33132  code.
33133 \end_layout
33134
33135 \begin_layout Enumerate
33136
33137 \size small
33138 You should remove spaces in front of
33139 \begin_inset Quotes eld
33140 \end_inset
33141
33142
33143 \family typewriter
33144 %s
33145 \family default
33146
33147 \begin_inset Quotes erd
33148 \end_inset
33149
33150
33151 \end_layout
33152
33153 \begin_layout Enumerate
33154
33155 \size small
33156 \begin_inset Quotes eld
33157 \end_inset
33158
33159
33160 \family typewriter
33161 %s
33162 \family default
33163
33164 \begin_inset Quotes erd
33165 \end_inset
33166
33167  is normally not followed by
33168 \begin_inset Quotes eld
33169 \end_inset
33170
33171
33172 \family typewriter
33173 %c
33174 \family default
33175
33176 \begin_inset Quotes erd
33177 \end_inset
33178
33179 .
33180 \end_layout
33181
33182 \begin_layout Standard
33183 In later versions of \SpecialChar LyX
33184 ,
33185  we hope to provide a more complete interface to this tool (and it's smaller cousin
33186 \family typewriter
33187 lacheck
33188 \family default
33189 ) to exploit the full power of it.
33190  But it's not exactly useless as it is now:
33191  go try it on one of your existing documents of a certain length and be surprised.
33192 \end_layout
33193
33194 \begin_layout Section
33195 Version Control in \SpecialChar LyX
33196
33197 \end_layout
33198
33199 \begin_layout Standard
33200 by
33201 \noun on
33202  Lars Gullik Bjønnes
33203 \noun default
33204 and
33205 \noun on
33206 Pavel Sanda
33207 \end_layout
33208
33209 \begin_layout Subsection
33210 Introduction
33211 \end_layout
33212
33213 \begin_layout Standard
33214 \SpecialChar LyX
33215  supports some of the most basic RCS/CVS/SVN/GIT commands.
33216  If you need something a bit more sophisticated you will have to do that manually in a terminal.
33217 \end_layout
33218
33219 \begin_layout Standard
33220 Also note that CVS support is not as good as subversion support,
33221  so we advise using SVN instead.
33222  A good place to start learning Subversion is the SVN Book
33223 \begin_inset Foot
33224 status collapsed
33225
33226 \begin_layout Plain Layout
33227 \begin_inset CommandInset href
33228 LatexCommand href
33229 target "http://svnbook.red-bean.com/"
33230 literal "false"
33231
33232 \end_inset
33233
33234
33235 \end_layout
33236
33237 \end_inset
33238
33239 .
33240  In the case of RCS you should read
33241 \begin_inset Quotes eld
33242 \end_inset
33243
33244 rcsintro
33245 \begin_inset Quotes erd
33246 \end_inset
33247
33248  (a man file,
33249  read it with
33250 \family typewriter
33251 man rcsintro
33252 \family default
33253 ).
33254  This file describes all the basic features of RCS.
33255  You should especially notice the comment about a RCS directory,
33256  and the notion of a master RCS file (the file ending in
33257 \family typewriter
33258 ,v
33259 \family default
33260 ).
33261 \end_layout
33262
33263 \begin_layout Standard
33264 Before you begin to use the version control features in \SpecialChar LyX
33265 ,
33266  you should be familiar with RCS/CVS/SVN/GIT usage.
33267  The implementation in \SpecialChar LyX
33268  assumes a recent version of the GNU RCS or CVS/SVN package —
33269  no guarantees are made for older versions.
33270  Most of the log messages are not currently displayed after operations —
33271  you can check them in the Messages pane if you are unsure.
33272  Regular users of version control will appreciate the VC toolbar,
33273  which can be enabled via
33274 \family sans
33275 View\SpecialChar menuseparator
33276 Toolbars\SpecialChar menuseparator
33277 Version
33278 \begin_inset space ~
33279 \end_inset
33280
33281 Control
33282 \family default
33283 .
33284 \end_layout
33285
33286 \begin_layout Standard
33287 For introducing your own external commands consult
33288 \begin_inset Flex Code
33289 status collapsed
33290
33291 \begin_layout Plain Layout
33292 vc-command
33293 \end_layout
33294
33295 \end_inset
33296
33297  in the manual
33298 \emph on
33299 \SpecialChar LyX
33300  Functions
33301 \emph default
33302 .
33303 \end_layout
33304
33305 \begin_layout Standard
33306 It is strongly recommended to store documents in uncompressed format if using version control (uncheck
33307 \family sans
33308 Document\SpecialChar menuseparator
33309 Compressed
33310 \family default
33311  if it is checked):
33312  Uncompressed LyX documents are text files and therefore for merging two different versions by version control systems.
33313  Compressed LyX documents are binary files,
33314  which cannot be merged by version control systems.
33315 \end_layout
33316
33317 \begin_layout Subsection
33318 RCS commands in \SpecialChar LyX
33319
33320 \end_layout
33321
33322 \begin_layout Standard
33323 The following sections describe the RCS commands supported by \SpecialChar LyX
33324 .
33325  You can find them in the
33326 \family sans
33327 File\SpecialChar menuseparator
33328 Version
33329 \begin_inset space ~
33330 \end_inset
33331
33332 Control
33333 \family default
33334  submenu.
33335  \SpecialChar LyX
33336  was tested against RCS 5.7/5.8.
33337 \end_layout
33338
33339 \begin_layout Subsubsection
33340
33341 \family sans
33342 Register
33343 \end_layout
33344
33345 \begin_layout Standard
33346 If your document is not under revision control,
33347  this is the only item shown in the menu.
33348  And if it is under revision control,
33349  the
33350 \family sans
33351 Register
33352 \family default
33353  item is not visible.
33354
33355 \end_layout
33356
33357 \begin_layout Standard
33358 This command registers your document with RCS (unless you are under the directory managed by CVS)\SpecialChar endofsentence
33359  You are asked interactively to supply an initial description of the document.
33360  The document is now set in Read-Only mode and you have to
33361 \family sans
33362 Check
33363 \begin_inset space ~
33364 \end_inset
33365
33366 Out
33367 \begin_inset space ~
33368 \end_inset
33369
33370 For
33371 \begin_inset space ~
33372 \end_inset
33373
33374 Edit
33375 \family default
33376 ,
33377  before making any changes to it.
33378  A document under revision control has a
33379 \begin_inset Quotes eld
33380 \end_inset
33381
33382 [RCS:<version> <locker>]
33383 \begin_inset Quotes erd
33384 \end_inset
33385
33386  item tagged to the filename in the minibuffer.
33387 \end_layout
33388
33389 \begin_layout Standard
33390 RCS command that is run:
33391 \end_layout
33392
33393 \begin_layout LyX-Code
33394
33395 \family typewriter
33396 ci -q -u -i -t-"<initial description>" <file-name>
33397 \end_layout
33398
33399 \begin_layout Standard
33400 Read
33401 \family typewriter
33402 man ci
33403 \family default
33404  to understand the switches.
33405
33406 \end_layout
33407
33408 \begin_layout Subsubsection
33409
33410 \family sans
33411 Check In Changes
33412 \end_layout
33413
33414 \begin_layout Standard
33415 When you are finished editing a file,
33416  you check in your changes.
33417  When you do this,
33418  you are asked for a description of the changes.
33419  This is stored in the history log.
33420  The version number is bumped,
33421  your changes are applied to the master RCS file,
33422  the document is unlocked and set to Read-Only mode.
33423 \end_layout
33424
33425 \begin_layout Itemize
33426 RCS command:
33427
33428 \family typewriter
33429 ci -q -u -m"<description>" <file-name>
33430 \end_layout
33431
33432 \begin_layout Subsubsection
33433
33434 \family sans
33435 Check Out For Edit
33436 \end_layout
33437
33438 \begin_layout Standard
33439 By doing this you lock the document so that only you can edit it.
33440  This will also make the document Read-Write only for you.
33441  You will usually continue editing for a while and when you are finished you check in your changes.
33442  The status line is changed to reflect that you have locked the file.
33443 \end_layout
33444
33445 \begin_layout Itemize
33446 RCS command:
33447
33448 \family typewriter
33449 co -q -l <file-name>
33450 \end_layout
33451
33452 \begin_layout Subsubsection
33453
33454 \family sans
33455 Revert To Repository Version
33456 \end_layout
33457
33458 \begin_layout Standard
33459 This will discard all changes made to the document since the last check in.
33460  You get a warning before changes are discarded.
33461 \end_layout
33462
33463 \begin_layout Itemize
33464 RCS command:
33465
33466 \family typewriter
33467 co -f -u<version> <file-name>
33468 \end_layout
33469
33470 \begin_layout Subsubsection
33471
33472 \family sans
33473 Copy
33474 \end_layout
33475
33476 \begin_layout Standard
33477 This will create a copy of the current document.
33478  Since RCS does not support copy operations natively,
33479  the version history is not preserved,
33480  and the copy is added as a new file.
33481  It requires a clean document without any changes since the last checkin.
33482  You are asked for a file name and a description of the copy operation.
33483  After that the copy is created,
33484  both locally and in the repository.
33485  If the parent directories of the copied and original document differ,
33486  all relative paths of included files of the copy are adjusted (like in
33487 \family sans
33488 File\SpecialChar menuseparator
33489 Save As
33490 \family default
33491 \SpecialChar ldots
33492 ).
33493  Finally,
33494  the copy is loaded instead of the original document.
33495 \end_layout
33496
33497 \begin_layout Labeling
33498 \labelwidthstring 00.00.0000
33499 RCS
33500 \begin_inset space ~
33501 \end_inset
33502
33503 commands:
33504
33505 \begin_inset space ~
33506 \end_inset
33507
33508
33509 \begin_inset Newline newline
33510 \end_inset
33511
33512 Copy
33513 \begin_inset Flex Code
33514 status collapsed
33515
33516 \begin_layout Plain Layout
33517
33518 \family typewriter
33519 \begin_inset Quotes qld
33520 \end_inset
33521
33522 <file-name>
33523 \begin_inset Quotes qld
33524 \end_inset
33525
33526
33527 \end_layout
33528
33529 \end_inset
33530
33531  to
33532 \begin_inset Flex Code
33533 status collapsed
33534
33535 \begin_layout Plain Layout
33536
33537 \family typewriter
33538 \begin_inset Quotes qld
33539 \end_inset
33540
33541 <new-file-name>
33542 \begin_inset Quotes qld
33543 \end_inset
33544
33545
33546 \end_layout
33547
33548 \end_inset
33549
33550
33551 \begin_inset Newline newline
33552 \end_inset
33553
33554
33555 \begin_inset Flex Code
33556 status collapsed
33557
33558 \begin_layout Plain Layout
33559 ci -q -u
33560 \family typewriter
33561 -i
33562 \begin_inset Quotes qld
33563 \end_inset
33564
33565 <new-file-name>
33566 \begin_inset Quotes qld
33567 \end_inset
33568
33569
33570 \end_layout
33571
33572 \end_inset
33573
33574
33575 \end_layout
33576
33577 \begin_layout Subsubsection
33578
33579 \family sans
33580 Undo Last Checkin
33581 \end_layout
33582
33583 \begin_layout Standard
33584 This makes as if the last check in never happened.
33585  No changes are made to the document loaded into \SpecialChar LyX
33586 ,
33587  but the last version is removed from the master RCS file.
33588 \end_layout
33589
33590 \begin_layout Itemize
33591 RCS command:
33592
33593 \family typewriter
33594 rcs -o<version> <file-name>
33595 \end_layout
33596
33597 \begin_layout Subsubsection
33598
33599 \family sans
33600 Show History
33601 \end_layout
33602
33603 \begin_layout Standard
33604 This shows the complete history of the RCS document.
33605  The output of
33606 \family typewriter
33607 rlog <file-name>
33608 \family default
33609  is shown in a browser.
33610  See
33611 \family typewriter
33612 man rlog
33613 \family default
33614  for more info.
33615 \end_layout
33616
33617 \begin_layout Subsubsection
33618 Revision info
33619 \end_layout
33620
33621 \begin_layout Standard
33622 \SpecialChar LyX
33623  supports RCS version number,
33624  author name,
33625  date and time of last commit.
33626  All those are extracted from
33627 \family typewriter
33628 rlog -r <file-name>
33629 \family default
33630 .
33631  See
33632 \begin_inset CommandInset ref
33633 LatexCommand ref
33634 reference "subsec:VCS-Revision-Information"
33635 nolink "false"
33636
33637 \end_inset
33638
33639  for details.
33640 \end_layout
33641
33642 \begin_layout Subsection
33643 CVS commands in \SpecialChar LyX
33644
33645 \end_layout
33646
33647 \begin_layout Standard
33648 A subset of CVS operations is supported by \SpecialChar LyX
33649 .
33650  You can find the commands in the
33651 \family sans
33652 File\SpecialChar menuseparator
33653 Version
33654 \begin_inset space ~
33655 \end_inset
33656
33657 Control
33658 \family default
33659  submenu.
33660  The version control system SVN is more powerful,
33661  so please use it instead of CVS if possible.
33662 \end_layout
33663
33664 \begin_layout Subsubsection
33665
33666 \family sans
33667 General CVS usage
33668 \end_layout
33669
33670 \begin_layout Standard
33671 If you start from scratch with CVS you have to create your repository and checkout the working copy with external tools.
33672  If you're using a client-server setup you may need to login before doing the first repository checkout.
33673 \end_layout
33674
33675 \begin_layout Standard
33676 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.
33677  Standard CVS repositories don't operate with a file locking mechanism.
33678  This may be surprising,
33679  but conflicts only occur if people disagree on the proper content of the same part of a document.
33680  So,
33681  if co-workers are used to communicate regularly,
33682  these conflicts occur rarely.
33683  If they don't communicate they have a fundamental problem anyway.
33684  Nevertheless some people like to work with so called
33685 \begin_inset Quotes eld
33686 \end_inset
33687
33688 reserved checkouts
33689 \begin_inset Quotes erd
33690 \end_inset
33691
33692 .
33693  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.
33694  When the changes are checked in the working copy returns to readonly state.
33695  With \SpecialChar LyX
33696  one has to edit the
33697 \begin_inset Flex Code
33698 status collapsed
33699
33700 \begin_layout Plain Layout
33701 .cvsrc
33702 \end_layout
33703
33704 \end_inset
33705
33706  file and add the line
33707 \begin_inset Flex Code
33708 status collapsed
33709
33710 \begin_layout Plain Layout
33711 cvs -r
33712 \end_layout
33713
33714 \end_inset
33715
33716  to work with reserved checkouts.
33717  The benefit is the possibility to see who is using a writable copy of some document.
33718  It's not guaranteed only one user makes a copy writable.
33719 \end_layout
33720
33721 \begin_layout Standard
33722 \SpecialChar LyX
33723  tries to guess if you're using reserved or non-reserved checkouts.
33724  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.
33725  When a reserved checkout is detected you have to use
33726 \begin_inset Flex Noun
33727 status collapsed
33728
33729 \begin_layout Plain Layout
33730 Check Out
33731 \end_layout
33732
33733 \end_inset
33734
33735  to make your working copy writable if it's readonly.
33736  After doing so the
33737 \begin_inset Flex Noun
33738 status collapsed
33739
33740 \begin_layout Plain Layout
33741 Check In
33742 \end_layout
33743
33744 \end_inset
33745
33746  operation is possible and that makes your working copy readonly again after transferring your changes to the repository.
33747 \end_layout
33748
33749 \begin_layout Standard
33750 More information about CVS can be found here
33751 \begin_inset Flex URL
33752 status collapsed
33753
33754 \begin_layout Plain Layout
33755
33756 http://www.nongnu.org/cvs
33757 \end_layout
33758
33759 \end_inset
33760
33761  and here
33762 \begin_inset Flex URL
33763 status collapsed
33764
33765 \begin_layout Plain Layout
33766
33767 http://ximbiot.com/cvs
33768 \end_layout
33769
33770 \end_inset
33771
33772 .
33773 \end_layout
33774
33775 \begin_layout Standard
33776 Read
33777 \family typewriter
33778 man cvs
33779 \family default
33780  to understand the sub-commands and the switches mentioned below.
33781 \end_layout
33782
33783 \begin_layout Subsubsection
33784
33785 \family sans
33786 Register
33787 \end_layout
33788
33789 \begin_layout Standard
33790 If your document is not under revision control,
33791  this is the only item shown in the menu.
33792  And if it is under revision control,
33793  the
33794 \family sans
33795 Register
33796 \family default
33797  item is not visible.
33798
33799 \end_layout
33800
33801 \begin_layout Standard
33802 This command registers in CVS your document
33803 \begin_inset Flex Strong
33804 status collapsed
33805
33806 \begin_layout Plain Layout
33807
33808 \emph on
33809 only
33810 \end_layout
33811
33812 \end_inset
33813
33814  in the case you have already the documents directory under CVS control (in particular
33815 \family typewriter
33816 CVS/Entries
33817 \family default
33818  file exists).
33819  This means you have to create or checkout the archive by yourself using external tools.
33820  (In case you forget that step \SpecialChar LyX
33821  registers the document with RCS.)
33822 \end_layout
33823
33824 \begin_layout Standard
33825 Then you are asked interactively to supply an initial description of the document.
33826  Don't forget that registered file is not yet checked in.
33827 \end_layout
33828
33829 \begin_layout Standard
33830 CVS command that is run:
33831
33832 \family typewriter
33833 cvs -q add -m"<entered message>" "<file-name>"
33834 \end_layout
33835
33836 \begin_layout Standard
33837 The term
33838 \family typewriter
33839 "<file-name>"
33840 \family default
33841  above and for all other CVS commands is an abbreviation for
33842 \begin_inset Quotes eld
33843 \end_inset
33844
33845 change the current working directory to file location and use the file name without path component as argument
33846 \begin_inset Quotes erd
33847 \end_inset
33848
33849 .
33850 \end_layout
33851
33852 \begin_layout Subsubsection
33853
33854 \family sans
33855 Check In Changes
33856 \end_layout
33857
33858 \begin_layout Standard
33859 When you are finished editing a file,
33860  you commit your changes.
33861  When you do this and you had changed the document,
33862  you are asked for a description of the changes.
33863  After that changes are written to the repository.
33864  In case you didn't change the document and a reserved checkout is detected the reservation made on
33865 \begin_inset Flex Noun
33866 status collapsed
33867
33868 \begin_layout Plain Layout
33869 Check Out
33870 \end_layout
33871
33872 \end_inset
33873
33874  is undone.
33875 \end_layout
33876
33877 \begin_layout Labeling
33878 \labelwidthstring 00.00.0000
33879 CVS
33880 \begin_inset space ~
33881 \end_inset
33882
33883 command:
33884
33885 \begin_inset space ~
33886 \end_inset
33887
33888
33889 \begin_inset Newline newline
33890 \end_inset
33891
33892
33893 \begin_inset Flex Code
33894 status collapsed
33895
33896 \begin_layout Plain Layout
33897 cvs
33898 \family typewriter
33899 -q commit -m"<description>" "<file-name>"
33900 \end_layout
33901
33902 \end_inset
33903
33904  or
33905 \begin_inset Newline newline
33906 \end_inset
33907
33908
33909 \begin_inset Flex Code
33910 status collapsed
33911
33912 \begin_layout Plain Layout
33913 cvs -q unedit
33914 \family typewriter
33915 "<file-name>"
33916 \end_layout
33917
33918 \end_inset
33919
33920
33921 \end_layout
33922
33923 \begin_layout Subsubsection
33924
33925 \family sans
33926 Check Out Changes
33927 \end_layout
33928
33929 \begin_layout Standard
33930 When you are sharing a repository with others,
33931  you may have to incorporate their changes into your working copy.
33932 \end_layout
33933
33934 \begin_layout Standard
33935 CVS command:
33936
33937 \family typewriter
33938 cvs -q update "<file-name>"
33939 \end_layout
33940
33941 \begin_layout Standard
33942 If a readonly checkout is detected the working copy is made writable and reserved.
33943 \end_layout
33944
33945 \begin_layout Standard
33946 CVS command:
33947
33948 \family typewriter
33949 cvs -q edit "<file-name>"
33950 \end_layout
33951
33952 \begin_layout Subsubsection
33953
33954 \family sans
33955 Revert To Repository Version
33956 \end_layout
33957
33958 \begin_layout Standard
33959 This will discard all changes made to the document since the last check in.
33960  You get a warning before changes are discarded.
33961  Firstly the file is deleted,
33962  secondly CVS update command is run.
33963 \end_layout
33964
33965 \begin_layout Standard
33966 CVS command:
33967
33968 \family typewriter
33969 cvs -q update "<file-name>"
33970 \end_layout
33971
33972 \begin_layout Standard
33973 If a reserved checkout is detected and the working copy has no changes only the reservation is undone.
33974 \end_layout
33975
33976 \begin_layout Standard
33977 CVS command:
33978
33979 \family typewriter
33980 cvs -q unedit "<file-name>"
33981 \end_layout
33982
33983 \begin_layout Subsubsection
33984
33985 \family sans
33986 Copy
33987 \end_layout
33988
33989 \begin_layout Standard
33990 This will create a copy of the current document.
33991  Since CVS does not support copy operations natively,
33992  the version history is not preserved,
33993  and the copy is added as a new file.
33994  It requires a clean document without any changes since the last checkin.
33995  You are asked for a file name and a description of the copy operation.
33996  After that the copy is created,
33997  both locally and in the repository.
33998  If the parent directories of the copied and original document differ,
33999  all relative paths of included files of the copy are adjusted (like in
34000 \family sans
34001 File\SpecialChar menuseparator
34002 Save As
34003 \family default
34004 \SpecialChar ldots
34005 ).
34006  Finally,
34007  the copy is loaded instead of the original document.
34008 \end_layout
34009
34010 \begin_layout Labeling
34011 \labelwidthstring 00.00.0000
34012 CVS
34013 \begin_inset space ~
34014 \end_inset
34015
34016 commands:
34017
34018 \begin_inset space ~
34019 \end_inset
34020
34021
34022 \begin_inset Newline newline
34023 \end_inset
34024
34025 Copy
34026 \begin_inset Flex Code
34027 status collapsed
34028
34029 \begin_layout Plain Layout
34030 "<file-name>"
34031 \end_layout
34032
34033 \end_inset
34034
34035  to
34036 \begin_inset Flex Code
34037 status collapsed
34038
34039 \begin_layout Plain Layout
34040 "<new-file-name>"
34041 \end_layout
34042
34043 \end_inset
34044
34045
34046 \begin_inset Newline newline
34047 \end_inset
34048
34049
34050 \begin_inset Flex Code
34051 status collapsed
34052
34053 \begin_layout Plain Layout
34054 cvs -q add "<new-file-name>"
34055 \end_layout
34056
34057 \end_inset
34058
34059
34060 \end_layout
34061
34062 \begin_layout Subsubsection
34063
34064 \family sans
34065 Rename
34066 \end_layout
34067
34068 \begin_layout Standard
34069 This will rename the current document.
34070  Since CVS does not support rename operations natively,
34071  the version history is not preserved,
34072  the renamed document is added as a new file,
34073  and the original document is deleted.
34074  It requires a clean document without any changes since the last checkin.
34075  You are asked for a file name and a description of the rename operation.
34076  After that the document is renamed,
34077  both locally and in the repository.
34078  If the parent directories of the new and old file names differ,
34079  all relative paths of included files are adjusted (like in
34080 \family sans
34081 File\SpecialChar menuseparator
34082 Save As
34083 \family default
34084 \SpecialChar ldots
34085 ).
34086  Finally,
34087  the document is reloaded using the new name.
34088 \end_layout
34089
34090 \begin_layout Labeling
34091 \labelwidthstring 00.00.0000
34092 CVS
34093 \begin_inset space ~
34094 \end_inset
34095
34096 commands:
34097
34098 \begin_inset space ~
34099 \end_inset
34100
34101
34102 \begin_inset Newline newline
34103 \end_inset
34104
34105 Rename
34106 \begin_inset Flex Code
34107 status collapsed
34108
34109 \begin_layout Plain Layout
34110 "<file-name>"
34111 \end_layout
34112
34113 \end_inset
34114
34115  to
34116 \begin_inset Flex Code
34117 status collapsed
34118
34119 \begin_layout Plain Layout
34120 "<new-file-name>"
34121 \end_layout
34122
34123 \end_inset
34124
34125
34126 \begin_inset Newline newline
34127 \end_inset
34128
34129
34130 \begin_inset Flex Code
34131 status collapsed
34132
34133 \begin_layout Plain Layout
34134 cvs -q add "<new-file-name>"
34135 \end_layout
34136
34137 \end_inset
34138
34139
34140 \begin_inset Newline newline
34141 \end_inset
34142
34143
34144 \begin_inset Flex Code
34145 status collapsed
34146
34147 \begin_layout Plain Layout
34148 cvs -q remove "<file-name>"
34149 \end_layout
34150
34151 \end_inset
34152
34153
34154 \end_layout
34155
34156 \begin_layout Subsubsection
34157 Update of the local directory checkout from repository
34158 \end_layout
34159
34160 \begin_layout Standard
34161 Once your documents gets more complex,
34162  containing sub-documents and pictures,
34163  including external
34164 \begin_inset Flex Code
34165 status collapsed
34166
34167 \begin_layout Plain Layout
34168 .tex
34169 \end_layout
34170
34171 \end_inset
34172
34173  files and so on using version control becomes more complicated.
34174  \SpecialChar LyX
34175  supports updating the whole tree in which resides the document.
34176  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.
34177  You have to organize the files structure so that all external files are in the same directory or subdirectories of the document.
34178  It's good practice anyway to store multipart documents in an extra directory.
34179 \end_layout
34180
34181 \begin_layout Standard
34182 The
34183 \begin_inset Flex Code
34184 status collapsed
34185
34186 \begin_layout Plain Layout
34187 Update local directory from repository
34188 \end_layout
34189
34190 \end_inset
34191
34192  command updates the whole directory.
34193  If local changes are detected user is warned before update starts.
34194  In case of merge conflicts both versions of the conflicting document parts are placed in the final document.
34195  You have to review and correct the result of the merge.
34196  You'll find the conflicts enclosed in pairs of
34197 \begin_inset Flex Code
34198 status collapsed
34199
34200 \begin_layout Plain Layout
34201 <<<<<<<
34202 \end_layout
34203
34204 \end_inset
34205
34206  and
34207 \begin_inset Flex Code
34208 status collapsed
34209
34210 \begin_layout Plain Layout
34211 >>>>>>>
34212 \end_layout
34213
34214 \end_inset
34215
34216  separated by
34217 \begin_inset Flex Code
34218 status collapsed
34219
34220 \begin_layout Plain Layout
34221 =======
34222 \end_layout
34223
34224 \end_inset
34225
34226 .
34227  The first part is your version as before the update operation with the document name prepended.
34228  The second one is the repository version with the version number after the sequence of
34229 \begin_inset Flex Code
34230 status collapsed
34231
34232 \begin_layout Plain Layout
34233 >
34234 \end_layout
34235
34236 \end_inset
34237
34238  signs.
34239 \end_layout
34240
34241 \begin_layout Labeling
34242 \labelwidthstring 00.00.0000
34243 CVS
34244 \begin_inset space ~
34245 \end_inset
34246
34247 commands:
34248
34249 \begin_inset space ~
34250 \end_inset
34251
34252
34253 \begin_inset Newline newline
34254 \end_inset
34255
34256
34257 \begin_inset Flex Code
34258 status collapsed
34259
34260 \begin_layout Plain Layout
34261 cd $path;
34262  cvs diff
34263 \family typewriter
34264 "."
34265 \end_layout
34266
34267 \end_inset
34268
34269  (Ask if changes are detected.)
34270 \begin_inset Newline newline
34271 \end_inset
34272
34273
34274 \begin_inset Flex Code
34275 status collapsed
34276
34277 \begin_layout Plain Layout
34278 cd $path;
34279  cvs -q update
34280 \family typewriter
34281 "."
34282 \end_layout
34283
34284 \end_inset
34285
34286
34287 \end_layout
34288
34289 \begin_layout Standard
34290 where
34291 \begin_inset Flex Code
34292 status collapsed
34293
34294 \begin_layout Plain Layout
34295 $path
34296 \end_layout
34297
34298 \end_inset
34299
34300  stands for the path to the document.
34301 \end_layout
34302
34303 \begin_layout Subsubsection
34304
34305 \family sans
34306 Show History
34307 \end_layout
34308
34309 \begin_layout Standard
34310 This shows the complete history of the CVS document.
34311  The output of
34312 \family typewriter
34313 cvs log "<file-name>"
34314 \family default
34315  is shown in a browser.
34316 \end_layout
34317
34318 \begin_layout Subsubsection
34319 Revision info
34320 \end_layout
34321
34322 \begin_layout Standard
34323 \SpecialChar LyX
34324  supports CVS version number,
34325  author name,
34326  date and time of last commit.
34327  All those are extracted from
34328 \family typewriter
34329 cvs log -r <file-name>
34330 \family default
34331 .
34332  See
34333 \begin_inset CommandInset ref
34334 LatexCommand ref
34335 reference "subsec:VCS-Revision-Information"
34336 nolink "false"
34337
34338 \end_inset
34339
34340  for details.
34341 \end_layout
34342
34343 \begin_layout Subsection
34344 SVN commands in \SpecialChar LyX
34345
34346 \end_layout
34347
34348 \begin_layout Standard
34349 SVN is now partially supported by \SpecialChar LyX
34350 .
34351  You can find the commands in the
34352 \family sans
34353 File\SpecialChar menuseparator
34354 Version
34355 \begin_inset space ~
34356 \end_inset
34357
34358 Control
34359 \family default
34360  submenu.
34361  Please note that if you use password protected access to repository via ssh,
34362  you will be asked in terminal window.
34363  \SpecialChar LyX
34364  was tested against SVN 1.5,
34365  1.6,
34366  1.7 and 1.8
34367 \begin_inset Foot
34368 status collapsed
34369
34370 \begin_layout Plain Layout
34371 Most of the commands will work with 1.4 too,
34372  see
34373 \begin_inset CommandInset ref
34374 LatexCommand ref
34375 reference "subsec:SVN-Repo-Update"
34376 nolink "false"
34377
34378 \end_inset
34379
34380 .
34381  There seems to be currently unresolved permissions problem under SVN 1.8 with reverting changes when file is locked.
34382 \end_layout
34383
34384 \end_inset
34385
34386
34387 \end_layout
34388
34389 \begin_layout Subsubsection
34390
34391 \family sans
34392 Register
34393 \end_layout
34394
34395 \begin_layout Standard
34396 If your document is not under revision control,
34397  this is the only item shown in the menu.
34398  And if it is under revision control,
34399  the
34400 \family sans
34401 Register
34402 \family default
34403  item is not visible.
34404 \end_layout
34405
34406 \begin_layout Standard
34407 This command registers in SVN your document ONLY in case you have already the documents directory under SVN control (in particular
34408 \family typewriter
34409 .svn/entries
34410 \family default
34411  file exists).
34412  This means you have to checkout the archive by yourself.
34413 \end_layout
34414
34415 \begin_layout Standard
34416 Then you are asked interactively to supply an initial description of the document.
34417  Don't forget that registered file is not yet commited.
34418 \end_layout
34419
34420 \begin_layout Standard
34421 SVN command that is run:
34422
34423 \family typewriter
34424 svn add -q
34425 \begin_inset Quotes qld
34426 \end_inset
34427
34428 <file-name>
34429 \begin_inset Quotes qld
34430 \end_inset
34431
34432
34433 \end_layout
34434
34435 \begin_layout Standard
34436 Read
34437 \family typewriter
34438 man svn
34439 \family default
34440  to understand the switches.
34441 \end_layout
34442
34443 \begin_layout Subsubsection
34444
34445 \family sans
34446 Check In Changes
34447 \end_layout
34448
34449 \begin_layout Standard
34450 When you are finished editing a file,
34451  you commit your changes.
34452  When you do this,
34453  you are asked for a description of the changes.
34454  After that changes are commited.
34455 \end_layout
34456
34457 \begin_layout Standard
34458 SVN command:
34459 \begin_inset Foot
34460 status collapsed
34461
34462 \begin_layout Plain Layout
34463 In case locking is not enabled.
34464  See Section
34465 \begin_inset CommandInset ref
34466 LatexCommand ref
34467 reference "subsec:SVN-File-Locking"
34468 nolink "false"
34469
34470 \end_inset
34471
34472 .
34473 \end_layout
34474
34475 \end_inset
34476
34477
34478 \family typewriter
34479 svn commit -q -m"<description>" <file-name>
34480 \end_layout
34481
34482 \begin_layout Subsubsection
34483
34484 \family sans
34485 Check Out For Edit
34486 \end_layout
34487
34488 \begin_layout Standard
34489 Updates the changes of this file from the repository.
34490  Be sure you understand SVN merging and conflicts resolving before using this function,
34491  because all conflicts has to be resolved manually by you!
34492 \end_layout
34493
34494 \begin_layout Standard
34495 SVN command:
34496 \begin_inset Foot
34497 status collapsed
34498
34499 \begin_layout Plain Layout
34500 Ditto.
34501 \end_layout
34502
34503 \end_inset
34504
34505
34506 \family typewriter
34507 svn update --non-interactive
34508 \begin_inset Quotes qld
34509 \end_inset
34510
34511 <file-name>
34512 \begin_inset Quotes qld
34513 \end_inset
34514
34515
34516 \end_layout
34517
34518 \begin_layout Subsubsection
34519
34520 \family sans
34521 Revert To Repository Version
34522 \end_layout
34523
34524 \begin_layout Standard
34525 This will discard all changes made to the document since the last check in.
34526  You get a warning before changes are discarded.
34527 \end_layout
34528
34529 \begin_layout Standard
34530 SVN command:
34531
34532 \family typewriter
34533 svn revert -q
34534 \begin_inset Quotes qld
34535 \end_inset
34536
34537 <file-name>
34538 \begin_inset Quotes qld
34539 \end_inset
34540
34541
34542 \end_layout
34543
34544 \begin_layout Subsubsection
34545
34546 \family sans
34547 Copy
34548 \end_layout
34549
34550 \begin_layout Standard
34551 This will create a copy of the current document including the version history.
34552  It requires a clean document without any changes since the last checkin.
34553  You are asked for a file name and a description of the copy operation.
34554  After that the copy is created,
34555  both locally and in the repository.
34556  If the parent directories of the copied and original document differ,
34557  all relative paths of included files of the copy are adjusted (like in
34558 \family sans
34559 File\SpecialChar menuseparator
34560 Save As
34561 \family default
34562 \SpecialChar ldots
34563 ).
34564  Finally,
34565  the copy is loaded instead of the original document.
34566 \end_layout
34567
34568 \begin_layout Labeling
34569 \labelwidthstring 00.00.0000
34570 SVN
34571 \begin_inset space ~
34572 \end_inset
34573
34574 commands:
34575
34576 \begin_inset space ~
34577 \end_inset
34578
34579
34580 \begin_inset Newline newline
34581 \end_inset
34582
34583
34584 \begin_inset Flex Code
34585 status collapsed
34586
34587 \begin_layout Plain Layout
34588 svn copy -q
34589 \family typewriter
34590
34591 \begin_inset Quotes qld
34592 \end_inset
34593
34594 <file-name>
34595 \begin_inset Quotes qld
34596 \end_inset
34597
34598
34599 \begin_inset Quotes qld
34600 \end_inset
34601
34602 <new-file-name>
34603 \begin_inset Quotes qld
34604 \end_inset
34605
34606
34607 \end_layout
34608
34609 \end_inset
34610
34611
34612 \begin_inset Newline newline
34613 \end_inset
34614
34615
34616 \begin_inset Flex Code
34617 status collapsed
34618
34619 \begin_layout Plain Layout
34620 svn commit
34621 \end_layout
34622
34623 \end_inset
34624
34625
34626 \end_layout
34627
34628 \begin_layout Subsubsection
34629
34630 \family sans
34631 Rename
34632 \end_layout
34633
34634 \begin_layout Standard
34635 This will rename the current document including the version history.
34636  It requires a clean document without any changes since the last checkin.
34637  You are asked for a file name and a description of the rename operation.
34638  After that the document is renamed,
34639  both locally and in the repository.
34640  If the parent directories of the new and old file names differ,
34641  all relative paths of included files are adjusted (like in
34642 \family sans
34643 File\SpecialChar menuseparator
34644 Save As
34645 \family default
34646 \SpecialChar ldots
34647 ).
34648  Finally,
34649  the document is reloaded using the new name.
34650 \end_layout
34651
34652 \begin_layout Labeling
34653 \labelwidthstring 00.00.0000
34654 SVN
34655 \begin_inset space ~
34656 \end_inset
34657
34658 commands:
34659
34660 \begin_inset space ~
34661 \end_inset
34662
34663
34664 \begin_inset Newline newline
34665 \end_inset
34666
34667
34668 \begin_inset Flex Code
34669 status collapsed
34670
34671 \begin_layout Plain Layout
34672 svn move -q
34673 \family typewriter
34674
34675 \begin_inset Quotes qld
34676 \end_inset
34677
34678 <file-name>
34679 \begin_inset Quotes qld
34680 \end_inset
34681
34682
34683 \begin_inset Quotes qld
34684 \end_inset
34685
34686 <new-file-name>
34687 \begin_inset Quotes qld
34688 \end_inset
34689
34690
34691 \end_layout
34692
34693 \end_inset
34694
34695
34696 \begin_inset Newline newline
34697 \end_inset
34698
34699
34700 \begin_inset Flex Code
34701 status collapsed
34702
34703 \begin_layout Plain Layout
34704 svn commit
34705 \end_layout
34706
34707 \end_inset
34708
34709
34710 \end_layout
34711
34712 \begin_layout Subsubsection
34713 \begin_inset CommandInset label
34714 LatexCommand label
34715 name "subsec:SVN-Repo-Update"
34716
34717 \end_inset
34718
34719 Update of the local directory checkout from repository
34720 \begin_inset Foot
34721 status collapsed
34722
34723 \begin_layout Plain Layout
34724 Note that this command will work only with subversion
34725 \begin_inset Formula $\geqq1.5$
34726 \end_inset
34727
34728
34729 \end_layout
34730
34731 \end_inset
34732
34733
34734 \end_layout
34735
34736 \begin_layout Standard
34737 All the commands above have one shortcoming – they deal with the current document only.
34738  Once your document contains pictures,
34739  includes external
34740 \begin_inset Flex Code
34741 status collapsed
34742
34743 \begin_layout Plain Layout
34744 .tex
34745 \end_layout
34746
34747 \end_inset
34748
34749  files and so on administration becomes more complicated.
34750  \SpecialChar LyX
34751  now supports updating the whole tree in which resides the document
34752 \begin_inset Foot
34753 status collapsed
34754
34755 \begin_layout Plain Layout
34756 One need to organize the files structure so that all external files are in the same directory or subdirectories of the document.
34757
34758 \end_layout
34759
34760 \end_inset
34761
34762 .
34763  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.
34764
34765 \end_layout
34766
34767 \begin_layout Standard
34768 \begin_inset Flex Code
34769 status collapsed
34770
34771 \begin_layout Plain Layout
34772 Update local directory from repository
34773 \end_layout
34774
34775 \end_inset
34776
34777  command updates the whole directory and in case of merge conflicts local version of the files are left,
34778  so no unintended data loss occurs.
34779  If local changes are detected user is warned before update starts.
34780 \end_layout
34781
34782 \begin_layout Labeling
34783 \labelwidthstring 00.00.0000
34784 SVN
34785 \begin_inset space ~
34786 \end_inset
34787
34788 commands:
34789
34790 \begin_inset space ~
34791 \end_inset
34792
34793
34794 \begin_inset Newline newline
34795 \end_inset
34796
34797
34798 \begin_inset Flex Code
34799 status collapsed
34800
34801 \begin_layout Plain Layout
34802 svn diff $path
34803 \end_layout
34804
34805 \end_inset
34806
34807  (Ask if changes are detected.)
34808 \begin_inset Newline newline
34809 \end_inset
34810
34811
34812 \begin_inset Flex Code
34813 status collapsed
34814
34815 \begin_layout Plain Layout
34816 svn update --accept mine-full $path
34817 \end_layout
34818
34819 \end_inset
34820
34821
34822 \end_layout
34823
34824 \begin_layout Standard
34825 where
34826 \begin_inset Flex Code
34827 status collapsed
34828
34829 \begin_layout Plain Layout
34830 $path
34831 \end_layout
34832
34833 \end_inset
34834
34835  stands for the path to the document.
34836 \end_layout
34837
34838 \begin_layout Subsubsection
34839
34840 \family sans
34841 Show History
34842 \end_layout
34843
34844 \begin_layout Standard
34845 This shows the complete history of the SVN document.
34846  The output of
34847 \family typewriter
34848 svn log
34849 \begin_inset Quotes qld
34850 \end_inset
34851
34852 <file-name>
34853 \begin_inset Quotes qld
34854 \end_inset
34855
34856
34857 \family default
34858  is shown in a browser.
34859 \end_layout
34860
34861 \begin_layout Subsubsection
34862 File Locking
34863 \begin_inset CommandInset label
34864 LatexCommand label
34865 name "subsec:SVN-File-Locking"
34866
34867 \end_inset
34868
34869
34870 \end_layout
34871
34872 \begin_layout Standard
34873 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.
34874  When such a conflict happens it needs manual resolving and one reasonable alternative is to provide some kind of locking mechanism,
34875  which guarantees that only one user is allowed to edit file at the given time.
34876 \end_layout
34877
34878 \begin_layout Standard
34879 SVN has two such mechanisms to provide mutual exclusivity for file access – locks and automatic setting of write permissions (see sec.
34880
34881 \begin_inset CommandInset ref
34882 LatexCommand ref
34883 reference "subsec:Automatical-Locking-Property"
34884 nolink "false"
34885
34886 \end_inset
34887
34888 ) based on
34889 \begin_inset Flex Code
34890 status collapsed
34891
34892 \begin_layout Plain Layout
34893 svn:needs-lock
34894 \end_layout
34895
34896 \end_inset
34897
34898  file svn property
34899 \begin_inset Foot
34900 status collapsed
34901
34902 \begin_layout Plain Layout
34903 \begin_inset Flex URL
34904 status open
34905
34906 \begin_layout Plain Layout
34907
34908 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
34909 \end_layout
34910
34911 \end_inset
34912
34913
34914 \end_layout
34915
34916 \end_inset
34917
34918 .
34919  If this property is detected for a given document \SpecialChar LyX
34920  starts to use SVN locks for document editing automatically and the whole check-in/out mechanism switches to the same regimen as for RCS.
34921  This in particular means there are two different modes of file use in \SpecialChar LyX
34922 :
34923 \end_layout
34924
34925 \begin_layout Itemize
34926 Unlocked state.
34927  The loaded file is in the read-only mode.
34928  For editing on needs to check-out.
34929
34930 \emph on
34931 Check-out
34932 \emph default
34933  consists of updating from the repository and gaining write lock.
34934  If the lock is not possible to obtain,
34935  we remain in unlocked state.
34936 \end_layout
34937
34938 \begin_layout Itemize
34939 Locked state.
34940  The loaded file is in the
34941 \begin_inset Quotes els
34942 \end_inset
34943
34944 normal
34945 \begin_inset Quotes ers
34946 \end_inset
34947
34948  edit mode.
34949  No other user is allowed to edit the file.
34950
34951 \emph on
34952 Check-in
34953 \emph default
34954  consists of commiting changes and releasing write-lock.
34955  If no changes have been made to the document,
34956  no commit will be produced
34957 \begin_inset Foot
34958 status collapsed
34959
34960 \begin_layout Plain Layout
34961 Don't be puzzled by the fact that you will be asked for commit message anyway.
34962 \end_layout
34963
34964 \end_inset
34965
34966  and only the write-lock will be released.
34967 \end_layout
34968
34969 \begin_layout Standard
34970 SVN commands:
34971 \end_layout
34972
34973 \begin_layout Labeling
34974 \labelwidthstring 00.00.0000
34975 Check-in:
34976
34977 \family typewriter
34978  svn commit -q -m"<description>" "<file-name>"
34979 \begin_inset Newline newline
34980 \end_inset
34981
34982 svn unlock "<file-name>"
34983 \end_layout
34984
34985 \begin_layout Labeling
34986 \labelwidthstring 00.00.0000
34987 Check-out:
34988
34989 \family typewriter
34990 svn update "<file-name>"
34991 \begin_inset Newline newline
34992 \end_inset
34993
34994 svn lock "<file-name>"
34995 \end_layout
34996
34997 \begin_layout Subsubsection
34998
34999 \family typewriter
35000 \begin_inset CommandInset label
35001 LatexCommand label
35002 name "subsec:Automatical-Locking-Property"
35003
35004 \end_inset
35005
35006
35007 \family default
35008 Automatic Locking Property
35009 \end_layout
35010
35011 \begin_layout Standard
35012 The above mentioned automatic setting of write permissions of the .lyx file can be set through
35013 \family sans
35014  File\SpecialChar menuseparator
35015 Version
35016 \begin_inset space ~
35017 \end_inset
35018
35019 Control\SpecialChar menuseparator
35020 Use Locking Property
35021 \family default
35022 .
35023  This command is active only when the file is not locked on the svn server (i.e.
35024  you need to check-out before proceeding).
35025 \end_layout
35026
35027 \begin_layout Labeling
35028 \labelwidthstring 00.00.0000
35029 SVN
35030 \begin_inset space ~
35031 \end_inset
35032
35033 commands:
35034 \end_layout
35035
35036 \begin_layout Labeling
35037 \labelwidthstring 00.00.0000
35038 Set:
35039
35040 \family typewriter
35041  svn propset svn:needs-lock ON "<file-name>"
35042 \end_layout
35043
35044 \begin_layout Labeling
35045 \labelwidthstring 00.00.0000
35046 Unset:
35047
35048 \family typewriter
35049 svn propdel svn:needs-lock "<file-name>"
35050 \end_layout
35051
35052 \begin_layout Subsubsection
35053 \begin_inset CommandInset label
35054 LatexCommand label
35055 name "subsec:VCS-Revision-Information"
35056
35057 \end_inset
35058
35059 Revision Information in Documents
35060 \end_layout
35061
35062 \begin_layout Standard
35063 There are more possibilities how to activate revision information in our document.
35064 \end_layout
35065
35066 \begin_layout Itemize
35067 \SpecialChar LyX
35068  supports directly:
35069 \end_layout
35070
35071 \begin_deeper
35072 \begin_layout Itemize
35073 tree revision information (
35074 \begin_inset Flex Code
35075 status collapsed
35076
35077 \begin_layout Plain Layout
35078 vcs-tree-revision
35079 \end_layout
35080
35081 \end_inset
35082
35083 ).
35084  The result is the output of the
35085 \begin_inset Flex Code
35086 status collapsed
35087
35088 \begin_layout Plain Layout
35089 svnversion
35090 \end_layout
35091
35092 \end_inset
35093
35094  command,
35095  the following table gives you an idea,
35096  how to read the results.
35097 \end_layout
35098
35099 \begin_layout Standard
35100 \align center
35101 \begin_inset Tabular
35102 <lyxtabular version="3" rows="6" columns="2">
35103 <features tabularvalignment="middle">
35104 <column alignment="left" valignment="top">
35105 <column alignment="left" valignment="top">
35106 <row>
35107 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
35108 \begin_inset Text
35109
35110 \begin_layout Plain Layout
35111
35112 \series bold
35113 Output
35114 \end_layout
35115
35116 \end_inset
35117 </cell>
35118 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
35119 \begin_inset Text
35120
35121 \begin_layout Plain Layout
35122
35123 \series bold
35124 Meaning
35125 \end_layout
35126
35127 \end_inset
35128 </cell>
35129 </row>
35130 <row>
35131 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
35132 \begin_inset Text
35133
35134 \begin_layout Plain Layout
35135 4123:4168
35136 \end_layout
35137
35138 \end_inset
35139 </cell>
35140 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
35141 \begin_inset Text
35142
35143 \begin_layout Plain Layout
35144 mixed revision working copy
35145 \end_layout
35146
35147 \end_inset
35148 </cell>
35149 </row>
35150 <row>
35151 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
35152 \begin_inset Text
35153
35154 \begin_layout Plain Layout
35155 4168M
35156 \end_layout
35157
35158 \end_inset
35159 </cell>
35160 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
35161 \begin_inset Text
35162
35163 \begin_layout Plain Layout
35164 modified working copy
35165 \end_layout
35166
35167 \end_inset
35168 </cell>
35169 </row>
35170 <row>
35171 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
35172 \begin_inset Text
35173
35174 \begin_layout Plain Layout
35175 4123S
35176 \end_layout
35177
35178 \end_inset
35179 </cell>
35180 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
35181 \begin_inset Text
35182
35183 \begin_layout Plain Layout
35184 switched working copy
35185 \end_layout
35186
35187 \end_inset
35188 </cell>
35189 </row>
35190 <row>
35191 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
35192 \begin_inset Text
35193
35194 \begin_layout Plain Layout
35195 4123P
35196 \end_layout
35197
35198 \end_inset
35199 </cell>
35200 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
35201 \begin_inset Text
35202
35203 \begin_layout Plain Layout
35204 partial working copy,
35205  from a sparse checkout
35206 \end_layout
35207
35208 \end_inset
35209 </cell>
35210 </row>
35211 <row>
35212 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
35213 \begin_inset Text
35214
35215 \begin_layout Plain Layout
35216 4123:4168MS
35217 \end_layout
35218
35219 \end_inset
35220 </cell>
35221 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
35222 \begin_inset Text
35223
35224 \begin_layout Plain Layout
35225 mixed revision,
35226  modified,
35227  switched working copy
35228 \end_layout
35229
35230 \end_inset
35231 </cell>
35232 </row>
35233 </lyxtabular>
35234
35235 \end_inset
35236
35237
35238 \end_layout
35239
35240 \begin_layout Itemize
35241 file revision information.
35242  The result comes from parsing the output of
35243 \begin_inset Flex Code
35244 status collapsed
35245
35246 \begin_layout Plain Layout
35247 svn
35248 \begin_inset space ~
35249 \end_inset
35250
35251 info
35252 \begin_inset space ~
35253 \end_inset
35254
35255 --xml
35256 \begin_inset space ~
35257 \end_inset
35258
35259 file.lyx
35260 \end_layout
35261
35262 \end_inset
35263
35264 .
35265  Supported flags are:
35266 \end_layout
35267
35268 \begin_deeper
35269 \begin_layout Itemize
35270 version number of the last commit (
35271 \begin_inset Flex Code
35272 status collapsed
35273
35274 \begin_layout Plain Layout
35275 vcs-revision
35276 \end_layout
35277
35278 \end_inset
35279
35280 )
35281 \end_layout
35282
35283 \begin_layout Itemize
35284 author of the last commit (
35285 \begin_inset Flex Code
35286 status collapsed
35287
35288 \begin_layout Plain Layout
35289 vcs-author
35290 \end_layout
35291
35292 \end_inset
35293
35294 )
35295 \end_layout
35296
35297 \begin_layout Itemize
35298 date of the last commit (
35299 \begin_inset Flex Code
35300 status collapsed
35301
35302 \begin_layout Plain Layout
35303 vcs-date
35304 \end_layout
35305
35306 \end_inset
35307
35308 )
35309 \end_layout
35310
35311 \begin_layout Itemize
35312 time of the last commit (
35313 \begin_inset Flex Code
35314 status collapsed
35315
35316 \begin_layout Plain Layout
35317 vcs-time
35318 \end_layout
35319
35320 \end_inset
35321
35322 )
35323 \end_layout
35324
35325 \end_deeper
35326 \begin_layout Standard
35327 You can obtain this info via InsetInfo (
35328 \change_inserted 5863208 1564400022
35329 Insert\SpecialChar menuseparator
35330 Field\SpecialChar menuseparator
35331 Version Control Revision
35332 \change_deleted 5863208 1564399852
35333 e.g.
35334
35335 \begin_inset Flex Code
35336 status collapsed
35337
35338 \begin_layout Plain Layout
35339 info-insert buffer vcs-date
35340 \end_layout
35341
35342 \end_inset
35343
35344
35345 \change_unchanged
35346 ).
35347  The information will be available only when you have the file stored under svn managment (i.e.
35348  the
35349 \begin_inset Flex Code
35350 status collapsed
35351
35352 \begin_layout Plain Layout
35353 .svn
35354 \end_layout
35355
35356 \end_inset
35357
35358  directory is available with your document).
35359 \end_layout
35360
35361 \end_deeper
35362 \begin_layout Itemize
35363 Another—
35364 a hacking one—
35365 possibility is to use svn keywords
35366 \begin_inset Foot
35367 status collapsed
35368
35369 \begin_layout Plain Layout
35370 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
35371 \end_layout
35372
35373 \end_inset
35374
35375 .
35376  In short – you set file keywords property (e.g.
35377
35378 \family sans
35379 svn propset svn:keywords 'Rev' file.lyx
35380 \family default
35381 ) and then paste keyword \SpecialChar TeX
35382  code
35383 \begin_inset Foot
35384 status collapsed
35385
35386 \begin_layout Plain Layout
35387 This is an easy way how to ensure that \SpecialChar LyX
35388  won't break the line in the middle of keyword tag.
35389 \end_layout
35390
35391 \end_inset
35392
35393  tag in your document (e.g.
35394
35395 \begin_inset Flex Code
35396 status collapsed
35397
35398 \begin_layout Plain Layout
35399 $Rev$
35400 \end_layout
35401
35402 \end_inset
35403
35404 ).
35405  This way svn client will automatically substitute revision number (e.g.
35406
35407 \begin_inset Flex Code
35408 status collapsed
35409
35410 \begin_layout Plain Layout
35411 $Rev:
35412  59 $
35413 \end_layout
35414
35415 \end_inset
35416
35417 ) after each update and commit.
35418  There are more problems with this approach.
35419  Firstly,
35420  the '$' character is used in \SpecialChar TeX
35421  world for math equations,
35422  so any occurence of math formula
35423 \begin_inset Formula $Rev$
35424 \end_inset
35425
35426  become
35427 \begin_inset Formula $Rev:59$
35428 \end_inset
35429
35430  in your \SpecialChar LyX
35431  document.
35432  Similarly for other keywords like Id,
35433  Date,
35434  Author,
35435  etc.
35436  Secondly svn output is dependent on your locales,
35437  so its very easy that svn would produce some problematic strings once Date is used.
35438  Thirdly you get the whole 'Rev:
35439  59' string in your document instead of the plain number.
35440  Until subversion implements user's custom keywords it will be hard to use this approach reliably or let \SpecialChar LyX
35441  to support it directly.
35442 \end_layout
35443
35444 \begin_layout Subsection
35445 SVN and Windows Environment
35446 \end_layout
35447
35448 \begin_layout Quote
35449 My inclination is to say that if the user cannot figure out the command line operations on their own fairly quickly,
35450  they would be well advised to use TortoiseSVN.
35451  —
35452 P.
35453  A.
35454  Rubin
35455 \end_layout
35456
35457 \begin_layout Subsubsection
35458 Preparation
35459 \end_layout
35460
35461 \begin_layout Standard
35462 In addition to installing \SpecialChar LyX
35463 ,
35464  and having access to a Subversion repository,
35465  the user will need to install the Subversion client program.
35466  A Windows installer for the client program is available from
35467 \begin_inset CommandInset href
35468 LatexCommand href
35469 name "CollabNet"
35470 target "http://www.collab.net/nonav/downloads/subversion/"
35471 literal "false"
35472
35473 \end_inset
35474
35475 .
35476  The user may also want to install
35477 \begin_inset CommandInset href
35478 LatexCommand href
35479 name "TortoiseSVN"
35480 target "http://tortoisesvn.tigris.org/"
35481 literal "false"
35482
35483 \end_inset
35484
35485 ,
35486  which integrates Subversion operations into the context (rightclick) menu of Windows Explorer.
35487  Operations done outside \SpecialChar LyX
35488  will typically be more convenient using the Explorer context menu.
35489  Note that TortoiseSVN is not a replacement for the client program,
35490  which is what \SpecialChar LyX
35491  itself will use.
35492 \end_layout
35493
35494 \begin_layout Subsubsection
35495 Bringing a document under Subversion control
35496 \end_layout
35497
35498 \begin_layout Standard
35499 Before a \SpecialChar LyX
35500  document can be brought under version control in Subversion,
35501  its parent directory needs to be under version control.
35502  If the document is being added to a project already in the repository,
35503  this is accomplished by checking the project out to the directory where the new document will be placed.
35504  If the project itself is not yet under version control (for instance,
35505  if this document starts a new project),
35506  the directory must be imported into the repository.
35507  This is done outside \SpecialChar LyX
35508 .
35509  Both import and checkout are easily accomplished from the Explorer context menu using TortoiseSVN,
35510  or alternatively can be done using the command line client at a DOS prompt.
35511  The procedure for importing the project using TortoiseSVN is described below,
35512  assuming an existing repository and a new project being started in
35513 \family typewriter
35514 C:
35515 \backslash
35516 new project
35517 \family default
35518 .
35519  For information on using the Subversion client program,
35520  run
35521 \family typewriter
35522 svn --help
35523 \family default
35524 in a DOS shell.
35525 \end_layout
35526
35527 \begin_layout Enumerate
35528 Locate
35529 \family typewriter
35530 C:
35531 \backslash
35532 new project
35533 \family default
35534 in Windows Explorer,
35535  right click it,
35536  and select
35537 \family sans
35538 TortoiseSVN\SpecialChar menuseparator
35539 Repo-browser
35540 \family default
35541 .
35542  If necessary,
35543  adjust the URL for the repository,
35544  then click OK.
35545 \end_layout
35546
35547 \begin_layout Enumerate
35548 Right click the level of the repository under which you want to place the new project folder (typically the top level) and click
35549 \family sans
35550 Create folder
35551 \family default
35552  Supply a name for the project folder and click OK.
35553  Add a message for the log file if desired,
35554  then click OK again.
35555  The new project folder should appear in the repository.
35556  Finally,
35557  click OK again to exit the repository browser.
35558 \end_layout
35559
35560 \begin_layout Enumerate
35561 Once again right click
35562 \family typewriter
35563 C:
35564 \backslash
35565 new project
35566 \family default
35567 ,
35568  this time selecting SVN Checkout\SpecialChar ldots
35569  Select the URL of the project folder you just created in the repository,
35570  and set the checkout directory to
35571 \family typewriter
35572 C:
35573 \backslash
35574 new project.
35575
35576 \family default
35577  Click OK.
35578  You will be warned about a non-empty folder;
35579  click OK to proceed.
35580  You should now have a
35581 \family typewriter
35582 .svn
35583 \family default
35584  directory under
35585 \family typewriter
35586 C:
35587 \backslash
35588 new project.
35589 \end_layout
35590
35591 \begin_layout Enumerate
35592 Create or open your document in \SpecialChar LyX
35593  and click
35594 \family sans
35595 File\SpecialChar menuseparator
35596 Version
35597 \begin_inset space ~
35598 \end_inset
35599
35600 Control\SpecialChar menuseparator
35601 Register.
35602
35603 \family default
35604 Add a log message and click OK to commit the document to version control.
35605 \end_layout
35606
35607 \begin_layout Standard
35608 From this point onward,
35609  you should have full functionality in the
35610 \family sans
35611 File\SpecialChar menuseparator
35612 Version
35613 \begin_inset space ~
35614 \end_inset
35615
35616 Control
35617 \family default
35618  menu.
35619  You also have the option of checking the document in and out,
35620  viewing its history,
35621  etc.
35622  using the TortoiseSVN context menu in Windows Explorer or the Subversion client program from a command prompt.
35623 \end_layout
35624
35625 \begin_layout Subsubsection
35626 SSH tunnel used with SVN under Windows
35627 \end_layout
35628
35629 \begin_layout Standard
35630 Compared with Linux setting up an svn client to communicate over ssh under Windows is a rather troublesome task.
35631  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,
35632  also be prepared for a great deal of frustration\SpecialChar ldots
35633
35634 \end_layout
35635
35636 \begin_layout Enumerate
35637 Get an svn client for windows,
35638  as described in the previous sections.
35639  When it is a fresh install run some svn command (e.g.
35640
35641 \begin_inset Flex Code
35642 status collapsed
35643
35644 \begin_layout Plain Layout
35645 svn --version
35646 \end_layout
35647
35648 \end_inset
35649
35650 ) to create config files,
35651  which you will need to change later on.
35652 \end_layout
35653
35654 \begin_layout Enumerate
35655 Choose an ssh client for Windows.
35656  There are several possibilities,
35657  we will use the one from Putty tools
35658 \begin_inset Foot
35659 status collapsed
35660
35661 \begin_layout Plain Layout
35662 \begin_inset Flex URL
35663 status collapsed
35664
35665 \begin_layout Plain Layout
35666
35667 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
35668 \end_layout
35669
35670 \end_inset
35671
35672
35673 \end_layout
35674
35675 \end_inset
35676
35677 .
35678  You will need to set the connection up so that the client doesn't ask for any password from you.
35679  To keep things easy we will use only keys without any additional password protection etc.
35680 \end_layout
35681
35682 \begin_deeper
35683 \begin_layout Enumerate
35684 Generate keys by
35685 \begin_inset Flex Code
35686 status collapsed
35687
35688 \begin_layout Plain Layout
35689 puttygen
35690 \end_layout
35691
35692 \end_inset
35693
35694 .
35695  Save your private .ppk key file and put the public one on the server side.
35696  If the SVN server runs on Linux,
35697  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
35698 \begin_inset Quotes eld
35699 \end_inset
35700
35701
35702 \emph on
35703 Public key for pasting into OpenSSH authorized_keys file
35704 \emph default
35705 :
35706 \begin_inset Quotes erd
35707 \end_inset
35708
35709  edit field into the server's
35710 \begin_inset Flex Code
35711 status collapsed
35712
35713 \begin_layout Plain Layout
35714 ~/.ssh/authorized_keys
35715 \end_layout
35716
35717 \end_inset
35718
35719  /
35720 \begin_inset Flex Code
35721 status collapsed
35722
35723 \begin_layout Plain Layout
35724 authorized_keys2
35725 \end_layout
35726
35727 \end_inset
35728
35729  file.
35730 \end_layout
35731
35732 \begin_layout Enumerate
35733 Get the Putty's
35734 \begin_inset Flex Code
35735 status collapsed
35736
35737 \begin_layout Plain Layout
35738 plink
35739 \end_layout
35740
35741 \end_inset
35742
35743 .
35744  In the SVN config file
35745 \begin_inset Foot
35746 status collapsed
35747
35748 \begin_layout Plain Layout
35749 Exact path depends on Windows version,
35750  usually somewhere around
35751 \begin_inset Flex Code
35752 status collapsed
35753
35754 \begin_layout Plain Layout
35755 c:
35756 \backslash
35757 Documents and Settings
35758 \backslash
35759 user
35760 \backslash
35761 Application Data
35762 \backslash
35763 Subversion
35764 \backslash
35765 config
35766 \end_layout
35767
35768 \end_inset
35769
35770  /
35771 \begin_inset Flex Code
35772 status collapsed
35773
35774 \begin_layout Plain Layout
35775 AppData
35776 \backslash
35777 Roaming
35778 \backslash
35779 Subversion
35780 \end_layout
35781
35782 \end_inset
35783
35784 .
35785 \end_layout
35786
35787 \end_inset
35788
35789 ,
35790  section [tunnels],
35791  setup ssh command,
35792  e.g.
35793
35794 \begin_inset Flex Code
35795 status collapsed
35796
35797 \begin_layout Plain Layout
35798 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
35799 \end_layout
35800
35801 \end_inset
35802
35803 .
35804 \begin_inset Foot
35805 status collapsed
35806
35807 \begin_layout Plain Layout
35808 It will usually take a lot of time to get exact command right and it depends on many things.
35809  For example do not have some remote server saved as a default session in Putty etc.
35810  If things fail,
35811  try to connect via plink without SVN first.
35812 \end_layout
35813
35814 \end_inset
35815
35816
35817 \end_layout
35818
35819 \end_deeper
35820 \begin_layout Enumerate
35821 Checkout the SVN archive,
35822  e.
35823 \begin_inset space \thinspace{}
35824 \end_inset
35825
35826 g.
35827 \begin_inset Newline newline
35828 \end_inset
35829
35830
35831 \begin_inset Flex Code
35832 status collapsed
35833
35834 \begin_layout Plain Layout
35835 svn co svn+ssh://user@server/repository_path
35836 \end_layout
35837
35838 \end_inset
35839
35840 .
35841 \end_layout
35842
35843 \begin_layout Subsubsection
35844 End-of-Line Conversions
35845 \end_layout
35846
35847 \begin_layout Standard
35848 When the collaborators are mixing Linux and Windows environments,
35849  \SpecialChar LyX
35850  will use different line endings inside the .lyx files.
35851  This is not a problem as far as \SpecialChar LyX
35852  functionality is concerned,
35853  but the commit diffs will be huge and merge-conflicts prone.
35854  Fortunately SVN itself knows
35855 \begin_inset Foot
35856 status collapsed
35857
35858 \begin_layout Plain Layout
35859 \begin_inset Flex URL
35860 status collapsed
35861
35862 \begin_layout Plain Layout
35863
35864 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
35865 \end_layout
35866
35867 \end_inset
35868
35869
35870 \end_layout
35871
35872 \end_inset
35873
35874  how to deal with CR/LF problems when switching .lyx files to the
35875 \begin_inset Flex Code
35876 status collapsed
35877
35878 \begin_layout Plain Layout
35879 native
35880 \end_layout
35881
35882 \end_inset
35883
35884  mode.
35885 \begin_inset Foot
35886 status collapsed
35887
35888 \begin_layout Plain Layout
35889 For the lazy guys:
35890
35891 \begin_inset Flex Code
35892 status collapsed
35893
35894 \begin_layout Plain Layout
35895 svn propset svn:eol-style native FILE_NAME
35896 \end_layout
35897
35898 \end_inset
35899
35900
35901 \end_layout
35902
35903 \end_inset
35904
35905
35906 \end_layout
35907
35908 \begin_layout Subsection
35909 GIT commands in \SpecialChar LyX
35910
35911 \end_layout
35912
35913 \begin_layout Standard
35914 A minimal subset of GIT commands is now supported by \SpecialChar LyX
35915 .
35916  You can find the commands in the
35917 \family sans
35918 File\SpecialChar menuseparator
35919 Version
35920 \begin_inset space ~
35921 \end_inset
35922
35923 Control
35924 \family default
35925  submenu.
35926  Please note that if you use password protected access to repository via ssh,
35927  you will be asked in terminal window.
35928  \SpecialChar LyX
35929  was tested against GIT 1.7.
35930 \begin_inset Foot
35931 status collapsed
35932
35933 \begin_layout Plain Layout
35934 Windows users please note that you need to ensure that git is on the path.
35935  This can be set from within \SpecialChar LyX
35936  at
35937 \family sans
35938 Tools\SpecialChar menuseparator
35939 Preferences\SpecialChar menuseparator
35940 Paths\SpecialChar menuseparator
35941 PATH prefix
35942 \family default
35943 .
35944 \end_layout
35945
35946 \end_inset
35947
35948
35949 \end_layout
35950
35951 \begin_layout Standard
35952 One big difference of GIT and the other supported version control systems is the distributed nature of GIT:
35953  With traditional version control systems there is one central server which hosts the repository.
35954  Users commit their changes to the server,
35955  and get updates made by other users from it.
35956  With GIT,
35957  users commit to a local repository.
35958  The local repository can be synchronized with one or more remote repositories using the
35959 \begin_inset Flex Code
35960 status collapsed
35961
35962 \begin_layout Plain Layout
35963 pull
35964 \end_layout
35965
35966 \end_inset
35967
35968  and
35969 \begin_inset Flex Code
35970 status collapsed
35971
35972 \begin_layout Plain Layout
35973 push
35974 \end_layout
35975
35976 \end_inset
35977
35978  GIT commands.
35979  \SpecialChar LyX
35980  does not interact in any way with remote GIT repositories.
35981  It works exclusively with the local repository in a very similar way as with a central CVS or SVN repository.
35982  If you use remote GIT repositories you need to do the
35983 \begin_inset Flex Code
35984 status collapsed
35985
35986 \begin_layout Plain Layout
35987 pull
35988 \end_layout
35989
35990 \end_inset
35991
35992  and
35993 \begin_inset Flex Code
35994 status collapsed
35995
35996 \begin_layout Plain Layout
35997 push
35998 \end_layout
35999
36000 \end_inset
36001
36002  operations with your favourite GIT client.
36003 \end_layout
36004
36005 \begin_layout Subsubsection
36006
36007 \family sans
36008 Register
36009 \end_layout
36010
36011 \begin_layout Standard
36012 If your document is not under revision control,
36013  this is the only item shown in the menu.
36014  And if it is under revision control,
36015  the
36016 \family sans
36017 Register
36018 \family default
36019  item is not visible.
36020 \end_layout
36021
36022 \begin_layout Standard
36023 This command registers in GIT your document ONLY in case you have already the documents directory under GIT control (in particular
36024 \family typewriter
36025 .git/index
36026 \family default
36027  file exists).
36028  This means you have to checkout the archive by yourself.
36029 \end_layout
36030
36031 \begin_layout Standard
36032 Then you are asked interactively to supply an initial description of the document.
36033  Don't forget that registered file is not yet committed.
36034 \end_layout
36035
36036 \begin_layout Standard
36037 GIT command that is run:
36038
36039 \family typewriter
36040 git add
36041 \begin_inset Quotes qld
36042 \end_inset
36043
36044 <file-name>
36045 \begin_inset Quotes qld
36046 \end_inset
36047
36048
36049 \end_layout
36050
36051 \begin_layout Standard
36052 Read
36053 \family typewriter
36054 man git
36055 \family default
36056  to understand the switches.
36057 \end_layout
36058
36059 \begin_layout Subsubsection
36060
36061 \family sans
36062 Check In Changes
36063 \end_layout
36064
36065 \begin_layout Standard
36066 When you are finished editing a file,
36067  you commit your changes.
36068  When you do this,
36069  you are asked for a description of the changes.
36070  After that changes are committed.
36071 \end_layout
36072
36073 \begin_layout Standard
36074 GIT command:
36075
36076 \family typewriter
36077 git commit -q -m"<description>" <file-name>
36078 \end_layout
36079
36080 \begin_layout Subsubsection
36081
36082 \family sans
36083 Revert To Repository Version
36084 \end_layout
36085
36086 \begin_layout Standard
36087 This will discard all changes made to the document since the last check in.
36088  You get a warning before changes are discarded.
36089 \end_layout
36090
36091 \begin_layout Standard
36092 GIT command:
36093
36094 \family typewriter
36095 git checkout -q
36096 \begin_inset Quotes qld
36097 \end_inset
36098
36099 <file-name>
36100 \begin_inset Quotes qld
36101 \end_inset
36102
36103
36104 \end_layout
36105
36106 \begin_layout Subsubsection
36107
36108 \family sans
36109 Rename
36110 \end_layout
36111
36112 \begin_layout Standard
36113 This will rename the current document including the version history.
36114  It requires a clean document without any changes since the last checkin.
36115  You are asked for a file name and a description of the rename operation.
36116  After that the document is renamed,
36117  both locally and in the repository.
36118  If the parent directories of the new and old file names differ,
36119  all relative paths of included files are adjusted (like in
36120 \family sans
36121 File\SpecialChar menuseparator
36122 Save As
36123 \family default
36124 \SpecialChar ldots
36125 ).
36126  Finally,
36127  the document is reloaded using the new name.
36128 \end_layout
36129
36130 \begin_layout Labeling
36131 \labelwidthstring 00.00.0000
36132 GIT
36133 \begin_inset space ~
36134 \end_inset
36135
36136 commands:
36137
36138 \begin_inset space ~
36139 \end_inset
36140
36141
36142 \begin_inset Newline newline
36143 \end_inset
36144
36145
36146 \begin_inset Flex Code
36147 status collapsed
36148
36149 \begin_layout Plain Layout
36150 git mv
36151 \family typewriter
36152
36153 \begin_inset Quotes qld
36154 \end_inset
36155
36156 <file-name>
36157 \begin_inset Quotes qld
36158 \end_inset
36159
36160
36161 \begin_inset Quotes qld
36162 \end_inset
36163
36164 <new-file-name>
36165 \begin_inset Quotes qld
36166 \end_inset
36167
36168
36169 \end_layout
36170
36171 \end_inset
36172
36173
36174 \begin_inset Newline newline
36175 \end_inset
36176
36177
36178 \begin_inset Flex Code
36179 status collapsed
36180
36181 \begin_layout Plain Layout
36182 git commit
36183 \end_layout
36184
36185 \end_inset
36186
36187
36188 \end_layout
36189
36190 \begin_layout Subsubsection
36191
36192 \family sans
36193 Show History
36194 \end_layout
36195
36196 \begin_layout Standard
36197 This shows the complete history of the GIT document.
36198  The output of
36199 \family typewriter
36200 git log
36201 \begin_inset Quotes qld
36202 \end_inset
36203
36204 <file-name>
36205 \begin_inset Quotes qld
36206 \end_inset
36207
36208
36209 \family default
36210  is shown in a browser.
36211 \end_layout
36212
36213 \begin_layout Subsubsection
36214 Version Info
36215 \end_layout
36216
36217 \begin_layout Standard
36218 \SpecialChar LyX
36219  supports GIT hash number of the last commit to the file,
36220
36221 \change_inserted 1119979965 1564297456
36222 its abbreviated form,
36223
36224 \change_unchanged
36225 author name,
36226  date and time of last commit.
36227  All those are extracted from
36228 \family typewriter
36229 git log -n 1 --pretty=format:%H%n
36230 \change_inserted 1119979965 1564297427
36231 %h%n
36232 \change_unchanged
36233 %an%n%ai
36234 \family default
36235 .
36236  Tree version information is obtained via
36237 \family typewriter
36238 git describe --abbrev --dirty --long
36239 \family default
36240 .
36241  See
36242 \begin_inset CommandInset ref
36243 LatexCommand ref
36244 reference "subsec:VCS-Revision-Information"
36245 nolink "false"
36246
36247 \end_inset
36248
36249  for other details.
36250 \end_layout
36251
36252 \begin_layout Subsection
36253 Further tuning
36254 \end_layout
36255
36256 \begin_layout Standard
36257 With the recent addition of the
36258 \begin_inset Flex Code
36259 status collapsed
36260
36261 \begin_layout Plain Layout
36262 vc-command
36263 \end_layout
36264
36265 \end_inset
36266
36267  function \SpecialChar LyX
36268  power users are allowed to create their own commands for revision control.
36269 \end_layout
36270
36271 \begin_layout Standard
36272 As an example you can see how two TortoiseSVN commands could be integrated directly:
36273 \end_layout
36274
36275 \begin_layout Description
36276 Commit:
36277
36278 \begin_inset Flex Code
36279 status collapsed
36280
36281 \begin_layout Plain Layout
36282 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
36283 \end_layout
36284
36285 \end_inset
36286
36287
36288 \end_layout
36289
36290 \begin_layout Description
36291 Revert:
36292
36293 \begin_inset Flex Code
36294 status collapsed
36295
36296 \begin_layout Plain Layout
36297 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
36298 \end_layout
36299
36300 \end_inset
36301
36302
36303 \end_layout
36304
36305 \begin_layout Subsection
36306 Version control and Document comparison
36307 \end_layout
36308
36309 \begin_layout Standard
36310 One of the typical uses of version control is to inspect the changes between revisions,
36311  usually by creating
36312 \begin_inset Flex Code
36313 status collapsed
36314
36315 \begin_layout Plain Layout
36316 diff
36317 \end_layout
36318
36319 \end_inset
36320
36321  dumps.
36322  While this is useful for plain text files,
36323  it is much less useful in the case of \SpecialChar LyX
36324  files,
36325  which have more a complicated structure.
36326  Hence we provide binding to the Document comparison feature.
36327  There are two ways of calling this feature – either by direct call of
36328 \begin_inset Flex Code
36329 status collapsed
36330
36331 \begin_layout Plain Layout
36332 vc-compare
36333 \end_layout
36334
36335 \end_inset
36336
36337  \SpecialChar LyX
36338  function (for details see \SpecialChar LyX
36339  functions manual) or by the toolbar icon
36340 \begin_inset Info
36341 type  "icon"
36342 arg   "vc-compare"
36343 \end_inset
36344
36345  or the menu item
36346 \begin_inset Info
36347 type  "menu"
36348 arg   "vc-compare"
36349 \end_inset
36350
36351 ,
36352  respectively.
36353  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 '
36354 \begin_inset Flex Noun
36355 status collapsed
36356
36357 \begin_layout Plain Layout
36358 0
36359 \end_layout
36360
36361 \end_inset
36362
36363 ' revisions back means comparison of the edited file with last commited revision).
36364
36365 \end_layout
36366
36367 \begin_layout Standard
36368 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,
36369  numbers always point to the last number in RCS revision number,
36370  i.e.
36371  '35' in '1.2.35'.
36372  We don't currently support GIT addressing of revisions,
36373  one can just compare edited document with its revision X steps backs,
36374  where X is addressed as
36375 \begin_inset Flex Code
36376 status collapsed
36377
36378 \begin_layout Plain Layout
36379 HEAD~X
36380 \end_layout
36381
36382 \end_inset
36383
36384 .
36385 \end_layout
36386
36387 \begin_layout Section
36388
36389 \change_inserted 564990737 1672161575
36390 \begin_inset CommandInset label
36391 LatexCommand label
36392 name "sec:Literate-Programming"
36393
36394 \end_inset
36395
36396
36397 \change_unchanged
36398 Literate Programming
36399 \end_layout
36400
36401 \begin_layout Standard
36402 Updated by
36403 \noun on
36404 Kayvan Sylvan
36405 \noun default
36406 (kayvan@sylvan.com)
36407 \noun on
36408 ,
36409
36410 \noun default
36411 original documentation written by
36412 \noun on
36413 Edmar Wienskoski Jr.
36414
36415 \noun default
36416  (edmar-w-jr@technologist.com)
36417 \end_layout
36418
36419 \begin_layout Subsection
36420 Introduction
36421 \end_layout
36422
36423 \begin_layout Standard
36424 The main purpose of this documentation is to show you how to use \SpecialChar LyX
36425  for literate programming,
36426  where it is assumed that you are familiar with this programming technique,
36427  and know what
36428 \begin_inset Quotes eld
36429 \end_inset
36430
36431 tangling
36432 \begin_inset Quotes erd
36433 \end_inset
36434
36435  and
36436 \begin_inset Quotes eld
36437 \end_inset
36438
36439 weaving
36440 \begin_inset Quotes erd
36441 \end_inset
36442
36443  means.
36444  If that is not the case,
36445  please follow the web links provided in the following sections.
36446  There is a lot of good documentation out there covering old development history to the latest tools tips.
36447 \end_layout
36448
36449 \begin_layout Standard
36450 It is also assumed that you are familiar with \SpecialChar LyX
36451  itself to a point that you are comfortable changing your \SpecialChar LyX
36452  preferences,
36453  and X resources file.
36454  If that is not the case please refer to other \SpecialChar LyX
36455  documentation to cover your specific needs.
36456 \end_layout
36457
36458 \begin_layout Subsection
36459 Literate Programming
36460 \end_layout
36461
36462 \begin_layout Standard
36463 From the Literate Programming FAQ:
36464
36465 \end_layout
36466
36467 \begin_layout Quotation
36468 Literate programming is the combination of documentation and source together in a fashion suited for reading by human beings.
36469  In fact,
36470  literate programs should be enjoyable reading,
36471  even inviting!
36472  (Sorry Bob,
36473  I couldn't resist!) In general,
36474  literate programs combine source and documentation in a single file.
36475  Literate programming tools then parse the file to produce either readable documentation or compilable source.
36476  The WEB style of literate programming was created by D.
36477 \begin_inset space \thinspace{}
36478 \end_inset
36479
36480 E.
36481  Knuth during the development of his \SpecialChar TeX
36482  typesetting software.
36483
36484 \end_layout
36485
36486 \begin_layout Standard
36487 Another excerpt says:
36488 \end_layout
36489
36490 \begin_layout Quotation
36491
36492 \emph on
36493 How is literate programming different from verbose commenting?
36494 \end_layout
36495
36496 \begin_layout Quotation
36497 There are three distinguishing characteristics.
36498  In order of importance,
36499  they are:
36500
36501 \end_layout
36502
36503 \begin_deeper
36504 \begin_layout Itemize
36505 flexible order of elaboration
36506 \end_layout
36507
36508 \begin_layout Itemize
36509 automatic support for browsing
36510 \end_layout
36511
36512 \begin_layout Itemize
36513 typeset documentation,
36514  especially diagrams and mathematics
36515 \end_layout
36516
36517 \end_deeper
36518 \begin_layout Standard
36519 Now that I sparked your curiosity,
36520  take a look in the references.
36521 \end_layout
36522
36523 \begin_layout Subsubsection
36524 References
36525 \end_layout
36526
36527 \begin_layout Standard
36528 The complete Literate Programming FAQ can be found at:
36529 \end_layout
36530
36531 \begin_layout Quote
36532 Literate Programming FAQ
36533 \begin_inset Flex URL
36534 status open
36535
36536 \begin_layout Plain Layout
36537
36538 http://www.literateprogramming.com/lpfaq.pdf
36539 \end_layout
36540
36541 \end_inset
36542
36543
36544 \end_layout
36545
36546 \begin_layout Standard
36547 The FAQ lists 23 (twenty three!) different literate programming tools.
36548  Where some are specialized or
36549 \begin_inset Quotes eld
36550 \end_inset
36551
36552 tailored
36553 \begin_inset Quotes erd
36554 \end_inset
36555
36556  for particular programming languages,
36557  while other have general scope.
36558  I selected
36559 \noun on
36560 Noweb
36561 \noun default
36562  for my own use for several reasons:
36563 \end_layout
36564
36565 \begin_layout Itemize
36566 It can generate the documentation either in \SpecialChar LaTeX
36567  or HTML.
36568 \end_layout
36569
36570 \begin_layout Itemize
36571 It has a open architecture,
36572  i.
36573 \begin_inset space \thinspace{}
36574 \end_inset
36575
36576 e.
36577 \begin_inset space \space{}
36578 \end_inset
36579
36580 it is easy to plug in new filters
36581 \begin_inset Foot
36582 status collapsed
36583
36584 \begin_layout Plain Layout
36585
36586 \emph on
36587 Filters
36588 \emph default
36589 are programs that read a given data stream and output a manipulated data stream.
36590  That way,
36591  a WEB file (consisting of literate code) can be turned into a file consisting only of C program code or \SpecialChar LaTeX
36592  code.
36593 \end_layout
36594
36595 \end_inset
36596
36597  and to perform special processing that you may need.
36598
36599 \end_layout
36600
36601 \begin_layout Itemize
36602 There is a good selection of filters available already (the HTML is one of them).
36603 \end_layout
36604
36605 \begin_layout Itemize
36606 It is free.
36607 \end_layout
36608
36609 \begin_layout Standard
36610 The Noweb web page can be found at:
36611
36612 \end_layout
36613
36614 \begin_layout Quote
36615 Noweb home page
36616 \begin_inset Flex URL
36617 status collapsed
36618
36619 \begin_layout Plain Layout
36620
36621 https://www.cs.tufts.edu/~nr/noweb/
36622 \end_layout
36623
36624 \end_inset
36625
36626
36627 \end_layout
36628
36629 \begin_layout Standard
36630 Starting from there you can reach many other interesting links and even some literate program examples.
36631 \end_layout
36632
36633 \begin_layout Subsection
36634 \SpecialChar LyX
36635  and Literate Programming with Noweb
36636 \end_layout
36637
36638 \begin_layout Standard
36639 The \SpecialChar LyX
36640  support for Literate Programming is provided by using the generic \SpecialChar LyX
36641  converters mechanism.
36642  This support is provided in a
36643 \begin_inset Quotes eld
36644 \end_inset
36645
36646 Noweb independent
36647 \begin_inset Quotes erd
36648 \end_inset
36649
36650  way,
36651  i.
36652 \begin_inset space \thinspace{}
36653 \end_inset
36654
36655 e.
36656 \begin_inset space \space{}
36657 \end_inset
36658
36659 you will be able to use this new \SpecialChar LyX
36660  feature with some other literate programming tool of your choice by just changing your \SpecialChar LyX
36661  preferences.
36662 \end_layout
36663
36664 \begin_layout Subsubsection
36665 Generating documents and code (weaving and tangling)
36666 \end_layout
36667
36668 \begin_layout Paragraph
36669 Using the noweb module
36670 \end_layout
36671
36672 \begin_layout Standard
36673 If you have installed Noweb and \SpecialChar LyX
36674  successfully,
36675  whenever you open a new document,
36676  after you have chosen its document class,
36677  use the
36678 \family sans
36679 Document\SpecialChar menuseparator
36680 Settings
36681 \family default
36682  menu to add the
36683 \begin_inset Quotes eld
36684 \end_inset
36685
36686 noweb
36687 \begin_inset Quotes erd
36688 \end_inset
36689
36690  module.
36691  If Noweb is correctly installed,
36692  when you click on the
36693 \begin_inset Quotes eld
36694 \end_inset
36695
36696 Modules
36697 \begin_inset Quotes erd
36698 \end_inset
36699
36700  link,
36701  you will see the
36702 \begin_inset Quotes eld
36703 \end_inset
36704
36705 noweb
36706 \begin_inset Quotes erd
36707 \end_inset
36708
36709  module in the available list and you can add it to your document.
36710 \end_layout
36711
36712 \begin_layout Paragraph
36713 Typing code in
36714 \end_layout
36715
36716 \begin_layout Standard
36717 \SpecialChar LyX
36718  enables you to write code with a custom inset named
36719 \begin_inset Flex Noun
36720 status collapsed
36721
36722 \begin_layout Plain Layout
36723 Chunk
36724 \end_layout
36725
36726 \end_inset
36727
36728 .
36729  Noweb delimits chunks like this:
36730 \end_layout
36731
36732 \begin_layout LyX-Code
36733 <<My code>>=
36734 \end_layout
36735
36736 \begin_layout LyX-Code
36737   code
36738 \end_layout
36739
36740 \begin_layout LyX-Code
36741   more code
36742 \end_layout
36743
36744 \begin_layout LyX-Code
36745   even more code
36746 \end_layout
36747
36748 \begin_layout LyX-Code
36749   @
36750 \end_layout
36751
36752 \begin_layout Standard
36753 The problem is that whatever is written in between the << and the
36754 \family typewriter
36755 @
36756 \family default
36757  must be taken literally,
36758  i.
36759 \begin_inset space \thinspace{}
36760 \end_inset
36761
36762 e.
36763 \begin_inset space \space{}
36764 \end_inset
36765
36766 \SpecialChar LyX
36767  should be prevented from making any special interpretation of what has been written.
36768  This is also handled by
36769 \begin_inset Flex Noun
36770 status collapsed
36771
36772 \begin_layout Plain Layout
36773 Chunk
36774 \end_layout
36775
36776 \end_inset
36777
36778 ,
36779  that works like a normal text inset but has a free spacing capability.
36780 \end_layout
36781
36782 \begin_layout Standard
36783 As a special note,
36784  you can also use the
36785 \begin_inset Quotes eld
36786 \end_inset
36787
36788 %def
36789 \begin_inset Quotes erd
36790 \end_inset
36791
36792  construct of Noweb in your chunks to add items to Noweb's identifier cross-reference:
36793 \end_layout
36794
36795 \begin_layout LyX-Code
36796 <<My chunk>>=
36797 \end_layout
36798
36799 \begin_layout LyX-Code
36800 def some_function(args):
36801 \end_layout
36802
36803 \begin_layout LyX-Code
36804    "This is the doc string for this function."
36805 \end_layout
36806
36807 \begin_layout LyX-Code
36808    print "My args:
36809  ",
36810  args
36811 \end_layout
36812
36813 \begin_layout LyX-Code
36814 @ %def some_function
36815 \end_layout
36816
36817 \begin_layout Standard
36818 For an example of this usage and the resulting cross-reference output,
36819  look at the Literate python program in
36820 \emph on
36821 LIBDIR/examples/listerrors.lyx
36822 \emph default
36823  which should make this all clear.
36824 \end_layout
36825
36826 \begin_layout Paragraph
36827 Generating the documentation
36828 \end_layout
36829
36830 \begin_layout Standard
36831 At this point you already have a new document file with a proper document class,
36832  and with some code and text on it.
36833  How do I print it?
36834  The answer is simple,
36835  you select
36836 \family sans
36837 View\SpecialChar menuseparator
36838 DVI,
36839
36840 \family default
36841  etc.
36842  Just like you would do for a plain document.
36843  No special procedure is required.
36844 \end_layout
36845
36846 \begin_layout Standard
36847 To help orientate you,
36848  I will now explain what happens inside \SpecialChar LyX
36849 :
36850 \end_layout
36851
36852 \begin_layout Enumerate
36853 When the
36854 \family sans
36855 Update\SpecialChar menuseparator
36856 DVI
36857 \family default
36858  menu option is chosen,
36859  a \SpecialChar LaTeX
36860  file is generated.
36861
36862 \end_layout
36863
36864 \begin_deeper
36865 \begin_layout Standard
36866 If the document is of any literate class the generated file will be named with an extension name defined by the
36867 \begin_inset Quotes eld
36868 \end_inset
36869
36870 literate
36871 \begin_inset Quotes erd
36872 \end_inset
36873
36874  format (defined in the Preferences panel),
36875  otherwise the file will have the usual
36876 \family typewriter
36877 .tex
36878 \family default
36879  extension.
36880 \end_layout
36881
36882 \end_deeper
36883 \begin_layout Enumerate
36884 Note that the only difference so far is in the name of the file,
36885  no special processing is required by \SpecialChar LyX
36886 .
36887  Given that you formatted the code using the
36888 \begin_inset Flex Noun
36889 status collapsed
36890
36891 \begin_layout Plain Layout
36892 Chunk
36893 \end_layout
36894
36895 \end_inset
36896
36897  inset that,
36898  by itself,
36899  takes care of the business.
36900 \end_layout
36901
36902 \begin_layout Enumerate
36903 If the document is of any literate class \SpecialChar LyX
36904  will then use the internal \SpecialChar LyX
36905  to Noweb converter,
36906  followed by the Noweb to \SpecialChar LaTeX
36907  converter
36908 \begin_inset Foot
36909 status collapsed
36910
36911 \begin_layout Plain Layout
36912 The converters are defined in the
36913 \family sans
36914 Tools\SpecialChar menuseparator
36915 Preferences
36916 \family default
36917  panel,
36918  under the
36919 \begin_inset Quotes eld
36920 \end_inset
36921
36922 Conversion
36923 \begin_inset Quotes erd
36924 \end_inset
36925
36926  tab.
36927  See section
36928 \emph on
36929 Converters
36930 \emph default
36931  of the
36932 \emph on
36933 Customization
36934 \emph default
36935  manual for general information about converters.
36936 \end_layout
36937
36938 \end_inset
36939
36940  to generate the \SpecialChar LaTeX
36941  file.
36942 \end_layout
36943
36944 \begin_deeper
36945 \begin_layout Standard
36946 Otherwise it will just skip this step.
36947 \end_layout
36948
36949 \end_deeper
36950 \begin_layout Enumerate
36951 Finally,
36952  \SpecialChar LaTeX
36953  is invoked and the regular post processing continues as in a plain document.
36954 \end_layout
36955
36956 \begin_layout Standard
36957 Independence from a particular
36958 \begin_inset Quotes eld
36959 \end_inset
36960
36961 literate tool
36962 \begin_inset Quotes erd
36963 \end_inset
36964
36965  is easily achieved by changing the commands that are run by the various converters.
36966 \end_layout
36967
36968 \begin_layout Paragraph
36969 Generating the code
36970 \end_layout
36971
36972 \begin_layout Standard
36973 When the build menu option is chosen or the corresponding button in the toolbar is pressed,
36974  a \SpecialChar LaTeX
36975  file is generated just like step 1 above.
36976  Next,
36977  \SpecialChar LyX
36978  invokes the
36979 \family typewriter
36980 Noweb->Program
36981 \family default
36982  converter.
36983  This converter needs to be defined by the user and is not installed by default,
36984  though the Program format is.
36985  This converter (like any other converter) will have two parts:
36986 \end_layout
36987
36988 \begin_layout Enumerate
36989 The converter program itself.
36990  This program performs the conversion from the one format to the other (in this case,
36991  from the Noweb format to the Program pseudo-format).
36992 \end_layout
36993
36994 \begin_layout Enumerate
36995 The error log parser.
36996  This is a program whose sole purpose is to rewrite error messages in a format that \SpecialChar LyX
36997  understands.
36998  This makes it possible for \SpecialChar LyX
36999  to place error boxes in the right places in the file buffer.
37000 \end_layout
37001
37002 \begin_layout Standard
37003 The first part,
37004  the
37005 \begin_inset Quotes eld
37006 \end_inset
37007
37008 Converter
37009 \begin_inset Quotes erd
37010 \end_inset
37011
37012  setting,
37013  should be set to
37014 \end_layout
37015
37016 \begin_layout LyX-Code
37017
37018 \family typewriter
37019 build-script $$i
37020 \family default
37021  $$r
37022 \end_layout
37023
37024 \begin_layout Standard
37025 This basically means that \SpecialChar LyX
37026  will call
37027 \begin_inset Quotes eld
37028 \end_inset
37029
37030 build-script
37031 \begin_inset Quotes erd
37032 \end_inset
37033
37034  (a program or script) with the name of the Noweb file (normally a file in the \SpecialChar LyX
37035  temp directory) and the directory path of the original \SpecialChar LyX
37036  file.
37037
37038 \end_layout
37039
37040 \begin_layout Standard
37041 This is an implementation of
37042 \begin_inset Quotes eld
37043 \end_inset
37044
37045 build-script
37046 \begin_inset Quotes erd
37047 \end_inset
37048
37049  that you can place in a directory on your path:
37050 \end_layout
37051
37052 \begin_layout LyX-Code
37053
37054 \family sans
37055 #!/bin/sh
37056 \end_layout
37057
37058 \begin_layout LyX-Code
37059
37060 \family sans
37061 #
37062 \end_layout
37063
37064 \begin_layout LyX-Code
37065
37066 \family sans
37067 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
37068 \end_layout
37069
37070 \begin_layout Standard
37071 The next part of the converter setting is the
37072 \begin_inset Quotes eld
37073 \end_inset
37074
37075 Flags
37076 \begin_inset Quotes erd
37077 \end_inset
37078
37079  which is to be set to
37080 \end_layout
37081
37082 \begin_layout LyX-Code
37083
37084 \family typewriter
37085 parselog=$$s/scripts/listerrors
37086 \end_layout
37087
37088 \begin_layout Standard
37089 This will run any errors that are generated by the
37090 \begin_inset Quotes eld
37091 \end_inset
37092
37093 build-script
37094 \begin_inset Quotes erd
37095 \end_inset
37096
37097  process through the
37098 \begin_inset Quotes eld
37099 \end_inset
37100
37101 listerrors
37102 \begin_inset Quotes erd
37103 \end_inset
37104
37105  program.
37106 \end_layout
37107
37108 \begin_layout Standard
37109 The build will normally take place in \SpecialChar LyX
37110 's temporary directory,
37111  so the files produced by the conversion will be in that directory.
37112  \SpecialChar LyX
37113  will copy out what it regards as the `main' file,
37114  but the
37115 \family typewriter
37116 Noweb->Program
37117 \family default
37118  conversion may produce several files,
37119  and so most of these would then be deleted when \SpecialChar LyX
37120  was closed.
37121  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.
37122 \end_layout
37123
37124 \begin_layout Paragraph
37125 Build instructions in the document
37126 \end_layout
37127
37128 \begin_layout Standard
37129 The last piece of the integration between \SpecialChar LyX
37130  and noweb is the
37131 \begin_inset Quotes eld
37132 \end_inset
37133
37134 build-script
37135 \begin_inset Quotes erd
37136 \end_inset
37137
37138  chunk.
37139  Generally,
37140  the instructions for building your program should be embedded in a chunk of its own.
37141  The noweb-specific
37142 \begin_inset Quotes eld
37143 \end_inset
37144
37145 build-script
37146 \begin_inset Quotes erd
37147 \end_inset
37148
37149  above uses the notangle command to look for this chunk (called
37150 \begin_inset Quotes eld
37151 \end_inset
37152
37153 build-script
37154 \begin_inset Quotes erd
37155 \end_inset
37156
37157 ) and runs its contents through
37158 \begin_inset Quotes eld
37159 \end_inset
37160
37161 sh
37162 \begin_inset Quotes erd
37163 \end_inset
37164
37165 .
37166 \end_layout
37167
37168 \begin_layout Standard
37169 Typically,
37170  such a chunk would look something like this:
37171 \end_layout
37172
37173 \begin_layout LyX-Code
37174 <<build-script>>=
37175 \end_layout
37176
37177 \begin_layout LyX-Code
37178 #!/bin/sh
37179 \begin_inset Newline newline
37180 \end_inset
37181
37182 if [ -z "${NOWEB_SOURCE}" ]
37183 \begin_inset Newline newline
37184 \end_inset
37185
37186 then
37187 \end_layout
37188
37189 \begin_layout LyX-Code
37190 NOWEB_SOURCE=myfile.nw
37191 \begin_inset Newline newline
37192 \end_inset
37193
37194 fi
37195 \begin_inset Newline newline
37196 \end_inset
37197
37198 [...
37199  code to extract files ...
37200  use NOWEB_OUTPUT_DIR here ...]
37201 \begin_inset Newline newline
37202 \end_inset
37203
37204 [...
37205  code to compile files ...]
37206 \begin_inset Newline newline
37207 \end_inset
37208
37209 @
37210 \end_layout
37211
37212 \begin_layout Standard
37213 Look in
37214 \change_deleted 564990737 1672161716
37215
37216 \emph on
37217 LIBDIR/examples/listerrors.lyx
37218 \emph default
37219  or in
37220 \emph on
37221 LIBDIR/examples/Literate.lyx
37222 \change_inserted 564990737 1672161716
37223
37224 \family sans
37225 \emph default
37226 File\SpecialChar menuseparator
37227 Open Example\SpecialChar menuseparator
37228 Modules\SpecialChar menuseparator
37229 Noweb Listerrors
37230 \change_unchanged
37231
37232 \family default
37233  which implement
37234 \change_deleted 564990737 1672161729
37235 two
37236 \change_unchanged
37237 versions of the
37238 \begin_inset Quotes eld
37239 \end_inset
37240
37241 listerrors
37242 \begin_inset Quotes erd
37243 \end_inset
37244
37245  program for some illustrations of how all of these pieces go together or in
37246 \change_deleted 564990737 1672161756
37247
37248 \emph on
37249 LIBDIR/examples/noweb2lyx.lyx
37250 \change_inserted 564990737 1672161756
37251
37252 \family sans
37253 \emph default
37254 File\SpecialChar menuseparator
37255 Open Example\SpecialChar menuseparator
37256 Modules\SpecialChar menuseparator
37257 Noweb2\SpecialChar LyX
37258
37259 \change_unchanged
37260
37261 \family default
37262 \emph on
37263 .
37264
37265 \emph default
37266  Interestingly,
37267  these
37268 \change_deleted 564990737 1672161767
37269 three
37270 \change_unchanged
37271 files show off the language-indepence of the \SpecialChar LyX
37272  literate programming support since they are written in Python
37273 \change_deleted 564990737 1672161782
37274 ,
37275  C
37276 \change_unchanged
37277  and Perl respectively.
37278 \end_layout
37279
37280 \begin_layout Subsubsection
37281 Configuring \SpecialChar LyX
37282
37283 \end_layout
37284
37285 \begin_layout Standard
37286 All the Literate Programming support is configured by the
37287 \family sans
37288 Tools\SpecialChar menuseparator
37289 Preferences
37290 \family default
37291  panel in the
37292 \begin_inset Quotes eld
37293 \end_inset
37294
37295 File Handling
37296 \begin_inset Quotes erd
37297 \end_inset
37298
37299  tab.
37300  The important parts are:
37301 \end_layout
37302
37303 \begin_layout Description
37304 the
37305 \begin_inset space ~
37306 \end_inset
37307
37308
37309 \begin_inset Quotes eld
37310 \end_inset
37311
37312 NoWeb
37313 \begin_inset Quotes erd
37314 \end_inset
37315
37316
37317 \begin_inset space ~
37318 \end_inset
37319
37320 format Set up via the File Formats tab,
37321  this is where the Noweb-specific pieces are set up.
37322  The
37323 \family sans
37324 GUI Name
37325 \family default
37326  is set to
37327 \family typewriter
37328 NoWeb
37329 \family default
37330 ,
37331  the file extension is set to
37332 \family typewriter
37333 .nw
37334 \family default
37335 .
37336  This tells \SpecialChar LyX
37337  to create a file with a
37338 \family typewriter
37339 .nw
37340 \family default
37341  extension in the first step of the conversion process.
37342 \end_layout
37343
37344 \begin_layout Description
37345 the
37346 \begin_inset space ~
37347 \end_inset
37348
37349
37350 \family sans
37351 Program
37352 \family default
37353
37354 \begin_inset space ~
37355 \end_inset
37356
37357 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).
37358 \end_layout
37359
37360 \begin_layout Description
37361
37362 \family sans
37363 NoWeb
37364 \family default
37365 ->
37366 \family sans
37367 \SpecialChar LaTeX
37368
37369 \family default
37370  This converter performs the
37371 \begin_inset Quotes eld
37372 \end_inset
37373
37374 weaving
37375 \begin_inset Quotes erd
37376 \end_inset
37377
37378  of the literate document.
37379  For Noweb,
37380  it is set to
37381 \begin_inset Quotes eld
37382 \end_inset
37383
37384
37385 \family typewriter
37386 noweave -delay -index $$i > $$o
37387 \family default
37388
37389 \begin_inset Quotes erd
37390 \end_inset
37391
37392
37393 \end_layout
37394
37395 \begin_layout Description
37396
37397 \family sans
37398 NoWeb
37399 \family default
37400 ->
37401 \family sans
37402 Program
37403 \family default
37404  This performs the
37405 \begin_inset Quotes eld
37406 \end_inset
37407
37408 tangling step
37409 \begin_inset Quotes erd
37410 \end_inset
37411
37412 .
37413  As stated above,
37414  the Converter is set to
37415 \begin_inset Quotes eld
37416 \end_inset
37417
37418
37419 \family typewriter
37420 build-script $$i
37421 \family default
37422  $$r
37423 \begin_inset Quotes erd
37424 \end_inset
37425
37426 ,
37427  with Flags set to
37428 \begin_inset Newline newline
37429 \end_inset
37430
37431
37432 \begin_inset Quotes eld
37433 \end_inset
37434
37435
37436 \family typewriter
37437 parselog=$$s/scripts/listerrors
37438 \family default
37439
37440 \begin_inset Quotes erd
37441 \end_inset
37442
37443 .
37444 \end_layout
37445
37446 \begin_layout Subsubsection
37447 Debug extensions
37448 \end_layout
37449
37450 \begin_layout Standard
37451 There is also a new function implemented in the \SpecialChar LyX
37452  server,
37453  the
37454 \begin_inset Quotes eld
37455 \end_inset
37456
37457 server-goto-file-row" function,
37458  to be used with ddd/gdb or other debugger.
37459
37460 \end_layout
37461
37462 \begin_layout Standard
37463 When debugging code with ddd/gdb,
37464  it is possible to invoke a text editor at the current execution position with a single key stroke.
37465  The default ddd configuration for that is shift-ctrl-V.
37466  It happens that you can define the editor command line invocation in ddd by accessing the
37467 \family sans
37468 Edit\SpecialChar menuseparator
37469 Preferences\SpecialChar menuseparator
37470 Helpers
37471 \family default
37472  dialog and changing the "Edit Sources" entry.
37473 \end_layout
37474
37475 \begin_layout Standard
37476 I take advantage of the newly created \SpecialChar LyX
37477  server function and this ddd feature,
37478  and set
37479 \begin_inset Quotes eld
37480 \end_inset
37481
37482 Edit Sources
37483 \begin_inset Quotes erd
37484 \end_inset
37485
37486  to:
37487 \end_layout
37488
37489 \begin_layout LyX-Code
37490 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
37491 \end_layout
37492
37493 \begin_layout Standard
37494 With this,
37495  whenever you are using ddd and find a point in the program that you want to edit,
37496  you just press shift-ctrl-V (in the ddd window),
37497  and ddd will forward this information to \SpecialChar LyX
37498  through the \SpecialChar LyX
37499  server and then the \SpecialChar LyX
37500  window will show the same file with the cursor at the same position ddd was pointing to.
37501  No more guessing or long scrolling to locate a point in the program back from debugging !
37502 \end_layout
37503
37504 \begin_layout Standard
37505 Note however that you must enable the \SpecialChar LyX
37506  server to get this feature working (it is disabled by default).
37507  Sec.
37508 \begin_inset space ~
37509 \end_inset
37510
37511
37512 \begin_inset CommandInset ref
37513 LatexCommand ref
37514 reference "sec:Starting-the-Server"
37515 nolink "false"
37516
37517 \end_inset
37518
37519  explains how to do that.
37520 \end_layout
37521
37522 \begin_layout Subsubsection
37523 Toolbar extensions
37524 \end_layout
37525
37526 \begin_layout Standard
37527 There are six new buttons that can be added to your \SpecialChar LyX
37528  toolbar.
37529  Four of these buttons are short cuts to layout styles:
37530
37531 \family sans
37532 Standard
37533 \family default
37534 ,
37535
37536 \family sans
37537 Section
37538 \family default
37539 ,
37540
37541 \family sans
37542 \SpecialChar LaTeX
37543
37544 \family default
37545 ,
37546  and
37547 \family sans
37548 \SpecialChar LyX
37549 -Code
37550 \family default
37551 ,
37552  one for the custom inset
37553 \family sans
37554 Chunk
37555 \family default
37556 .
37557  The last one is a short cut to the
37558 \begin_inset Quotes eld
37559 \end_inset
37560
37561 Build Program
37562 \begin_inset Quotes erd
37563 \end_inset
37564
37565  File menu entry.
37566
37567 \end_layout
37568
37569 \begin_layout Standard
37570 \SpecialChar LyX
37571  has a range of buttons that are available for tool bar customization.
37572  In my toolbar I like to combine the six short cuts above with two more:
37573  One for
37574 \family sans
37575 Document
37576 \family default
37577 \SpecialChar menuseparator
37578
37579 \family sans
37580 Update
37581 \family default
37582 \SpecialChar menuseparator
37583
37584 \family sans
37585 DVI
37586 \family default
37587  and the other for
37588 \family sans
37589 Document\SpecialChar menuseparator
37590 View\SpecialChar menuseparator
37591 DVI
37592 \family default
37593  File menu entries.
37594  Here is how it looks like:
37595 \end_layout
37596
37597 \begin_layout LyX-Code
37598 Toolbar
37599 \end_layout
37600
37601 \begin_layout LyX-Code
37602   Layouts
37603 \end_layout
37604
37605 \begin_layout LyX-Code
37606   Icon "layout Standard"
37607 \end_layout
37608
37609 \begin_layout LyX-Code
37610   Icon "layout Section"
37611 \end_layout
37612
37613 \begin_layout LyX-Code
37614   Icon "layout \SpecialChar LaTeX
37615 "
37616 \end_layout
37617
37618 \begin_layout LyX-Code
37619   Icon "layout \SpecialChar LyX
37620 -Code"
37621 \end_layout
37622
37623 \begin_layout LyX-Code
37624   Icon "flex.insert Chunk"
37625 \end_layout
37626
37627 \begin_layout LyX-Code
37628   Separator
37629 \end_layout
37630
37631 \begin_layout LyX-Code
37632   Icon "buffer-view"
37633 \end_layout
37634
37635 \begin_layout LyX-Code
37636   Icon "buffer-typeset"
37637 \end_layout
37638
37639 \begin_layout LyX-Code
37640   Icon "build-program"
37641 \end_layout
37642
37643 \begin_layout LyX-Code
37644   Separator
37645 \end_layout
37646
37647 \begin_layout LyX-Code
37648 .
37649 \end_layout
37650
37651 \begin_layout LyX-Code
37652 .
37653 \end_layout
37654
37655 \begin_layout LyX-Code
37656 .
37657 \end_layout
37658
37659 \begin_layout LyX-Code
37660 End
37661 \end_layout
37662
37663 \begin_layout Subsubsection
37664 Colors customization
37665 \end_layout
37666
37667 \begin_layout Standard
37668 There are a number of colors in \SpecialChar LyX
37669  that can be customized in
37670 \family sans
37671 Preferences
37672 \family default
37673 .
37674  One of the things that bothers people is the \SpecialChar LaTeX
37675  font color.
37676  The default color is red,
37677  since the chunks uses \SpecialChar LaTeX
37678  font,
37679  and there is a lot of chunks in literate documents,
37680  you may get tired of seeing everything in red.
37681  You can change it by going to the tabs
37682 \family sans
37683 Look&Feel
37684 \family default
37685 ,
37686
37687 \family sans
37688 Colors.
37689 \end_layout
37690
37691 \begin_layout Standard
37692 The next thing is the visible presence of the newline character in the screen.
37693  You can choose the color of this particular character and make it blend in the background.
37694  I recommend you choosing a color that is close to the background but not equal,
37695  that way you still can see it is there,
37696  but it is not bothering you anymore.
37697 \end_layout
37698
37699 \begin_layout Subsection
37700 \SpecialChar LyX
37701  and knitr/Sweave
37702 \end_layout
37703
37704 \begin_layout Standard
37705 Support for
37706 \family sans
37707 knitr
37708 \family default
37709  and
37710 \family sans
37711 Sweave
37712 \family default
37713  is documented in
37714 \change_inserted 564990737 1672161863
37715
37716 \family sans
37717 Help\SpecialChar menuseparator
37718 Specific Manuals\SpecialChar menuseparator
37719 Knitr
37720 \family default
37721  and
37722 \change_unchanged
37723
37724 \change_deleted 564990737 1671643409
37725 the
37726 \emph on
37727 knitr.lyx
37728 \emph default
37729  example file
37730 \change_inserted 564990737 1672161856
37731
37732 \family sans
37733 File\SpecialChar menuseparator
37734 Open Example\SpecialChar menuseparator
37735 Modules\SpecialChar menuseparator
37736 Rnw (knitr)
37737 \change_unchanged
37738
37739 \family default
37740  and in
37741 \change_deleted 564990737 1671643461
37742 the Sweave manual (menu
37743 \family sans
37744 Help\SpecialChar menuseparator
37745 Specific Manuals
37746 \family default
37747 )
37748 \change_inserted 564990737 1672161856
37749
37750 \family sans
37751 Help\SpecialChar menuseparator
37752 Specific Manuals\SpecialChar menuseparator
37753 Sweave
37754 \change_deleted 564990737 1672161921
37755
37756 \family default
37757 .
37758
37759 \change_inserted 564990737 1672161917
37760  and
37761 \family sans
37762 File\SpecialChar menuseparator
37763 Open Example\SpecialChar menuseparator
37764 Modules\SpecialChar menuseparator
37765 Sweave
37766 \family default
37767 .
37768 \change_deleted 564990737 1672742969
37769
37770 \end_layout
37771
37772 \begin_layout Standard
37773
37774 \change_deleted 564990737 1671355343
37775 Special features
37776 \end_layout
37777
37778 \begin_layout Standard
37779
37780 \change_deleted 564990737 1671355343
37781 You can do everything with \SpecialChar LyX
37782  that you can do with \SpecialChar LaTeX
37783 .
37784  However,
37785  \SpecialChar LyX
37786  cannot support every \SpecialChar LaTeX
37787  feature directly.
37788  But you can always use \SpecialChar TeX
37789  Code.
37790  This chapter shows you some more special things you might want to use.
37791  For other special things you can do with figures,
37792  tables,
37793  floats,
37794  boxes and notes,
37795  have a look at the
37796 \emph on
37797 Embedded
37798 \begin_inset space ~
37799 \end_inset
37800
37801 Objects
37802 \emph default
37803  manual.
37804 \change_unchanged
37805
37806 \end_layout
37807
37808 \end_body
37809 \end_document