lib/doc/Additional.lyx

   1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
   2 \lyxformat 615
   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 \change_deleted -712698321 1674917358
 750
 751 \family sans
 752
 753 \begin_inset Flex Noun
 754 status collapsed
 755
 756 \begin_layout Plain Layout
 757
 758 \noun off
 759 Export\SpecialChar menuseparator
 760 LaTeX
 761 \end_layout
 762
 763 \end_inset
 764
 765
 766 \change_inserted -712698321 1674917358
 767 Export\SpecialChar menuseparator
 768 LaTeX
 769 \change_unchanged
 770
 771 \family default
 772  from the
 773 \change_deleted -712698321 1674917366
 774
 775 \begin_inset Flex Noun
 776 status collapsed
 777
 778 \begin_layout Plain Layout
 779 File
 780 \end_layout
 781
 782 \end_inset
 783
 784
 785 \change_inserted -712698321 1674917366
 786
 787 \family sans
 788 File
 789 \change_unchanged
 790
 791 \family default
 792  menu (or
 793 \change_deleted -712698321 1674917371
 794
 795 \begin_inset Flex Noun
 796 status collapsed
 797
 798 \begin_layout Plain Layout
 799 View\SpecialChar menuseparator
 800 Source
 801 \begin_inset space ~
 802 \end_inset
 803
 804 Pane
 805 \end_layout
 806
 807 \end_inset
 808
 809
 810 \change_inserted -712698321 1674917371
 811
 812 \family sans
 813 View\SpecialChar menuseparator
 814 Source
 815 \begin_inset space ~
 816 \end_inset
 817
 818 Pane
 819 \change_unchanged
 820
 821 \family default
 822 ),
 823  then look at the preamble of the resulting
 824 \begin_inset Flex Code
 825 status collapsed
 826
 827 \begin_layout Plain Layout
 828 .tex
 829 \end_layout
 830
 831 \end_inset
 832
 833  file.
 834  You'll notice a variety of new macros defined specifically by \SpecialChar LyX
 835 .
 836  These macros are defined automatically,
 837  according to the features you use in the document.
 838 \end_layout
 839
 840 \begin_layout Standard
 841 There are several commands that automatically invoke \SpecialChar LaTeX
 842 .
 843  They are:
 844 \end_layout
 845
 846 \begin_layout Itemize
 847
 848 \change_deleted -712698321 1674917379
 849 \begin_inset Flex Noun
 850 status collapsed
 851
 852 \begin_layout Plain Layout
 853 Document\SpecialChar menuseparator
 854 View
 855 \end_layout
 856
 857 \end_inset
 858
 859
 860 \change_inserted -712698321 1674917379
 861
 862 \family sans
 863 Document\SpecialChar menuseparator
 864 View
 865 \change_unchanged
 866
 867 \end_layout
 868
 869 \begin_layout Itemize
 870
 871 \change_deleted -712698321 1674917381
 872 \begin_inset Flex Noun
 873 status collapsed
 874
 875 \begin_layout Plain Layout
 876 Document\SpecialChar menuseparator
 877 Update
 878 \end_layout
 879
 880 \end_inset
 881
 882
 883 \change_inserted -712698321 1674917381
 884
 885 \family sans
 886 Document\SpecialChar menuseparator
 887 Update
 888 \change_unchanged
 889
 890 \end_layout
 891
 892 \begin_layout Standard
 893 They will only invoke \SpecialChar LaTeX
 894  if the file has changed since the last time \SpecialChar LaTeX
 895  was run.
 896
 897 \end_layout
 898
 899 \begin_layout Standard
 900 When \SpecialChar LyX
 901  runs \SpecialChar LaTeX
 902  on the file you're editing,
 903  it performs these steps:
 904 \end_layout
 905
 906 \begin_layout Enumerate
 907 Convert the document to \SpecialChar LaTeX
 908  and save to a file with the extension
 909 \begin_inset Flex Code
 910 status collapsed
 911
 912 \begin_layout Plain Layout
 913 .tex
 914 \end_layout
 915
 916 \end_inset
 917
 918  in place of
 919 \begin_inset Flex Code
 920 status collapsed
 921
 922 \begin_layout Plain Layout
 923 .lyx
 924 \end_layout
 925
 926 \end_inset
 927
 928 .
 929 \end_layout
 930
 931 \begin_layout Enumerate
 932 Run \SpecialChar LaTeX
 933  on the
 934 \begin_inset Flex Code
 935 status collapsed
 936
 937 \begin_layout Plain Layout
 938 .tex
 939 \end_layout
 940
 941 \end_inset
 942
 943  file (maybe several times),
 944  and run any other commands (such as
 945 \begin_inset Flex Code
 946 status collapsed
 947
 948 \begin_layout Plain Layout
 949 bibtex
 950 \end_layout
 951
 952 \end_inset
 953
 954  or
 955 \begin_inset Flex Code
 956 status collapsed
 957
 958 \begin_layout Plain Layout
 959 makeindex
 960 \end_layout
 961
 962 \end_inset
 963
 964 ) needed to compile the \SpecialChar LaTeX
 965  file.
 966 \end_layout
 967
 968 \begin_layout Enumerate
 969 If there are any errors,
 970  show the error log.
 971 \end_layout
 972
 973 \begin_layout Standard
 974 If you have run \SpecialChar LaTeX
 975  using
 976 \change_deleted -712698321 1674917394
 977
 978 \begin_inset Flex Noun
 979 status collapsed
 980
 981 \begin_layout Plain Layout
 982 View\SpecialChar menuseparator
 983 DVI
 984 \end_layout
 985
 986 \end_inset
 987
 988
 989 \change_inserted -712698321 1674917394
 990
 991 \family sans
 992 View\SpecialChar menuseparator
 993 DVI
 994 \change_unchanged
 995
 996 \family default
 997 ,
 998  \SpecialChar LyX
 999  then runs a DVI viewer to display the DVI-file.
1000  If you have used
1001 \change_deleted -712698321 1674917400
1002
1003 \begin_inset Flex Noun
1004 status collapsed
1005
1006 \begin_layout Plain Layout
1007 View\SpecialChar menuseparator
1008 PostScript
1009 \end_layout
1010
1011 \end_inset
1012
1013
1014 \change_inserted -712698321 1674917400
1015
1016 \family sans
1017 View\SpecialChar menuseparator
1018 PostScript
1019 \change_unchanged
1020
1021 \family default
1022 ,
1023  \SpecialChar LyX
1024  performs further steps:
1025 \end_layout
1026
1027 \begin_layout Enumerate
1028 Run
1029 \begin_inset Flex Code
1030 status collapsed
1031
1032 \begin_layout Plain Layout
1033 dvips
1034 \end_layout
1035
1036 \end_inset
1037
1038  to convert the DVI file to PostScript.
1039 \end_layout
1040
1041 \begin_layout Enumerate
1042 Run a PostScript viewer,
1043  such as
1044 \begin_inset Flex Code
1045 status collapsed
1046
1047 \begin_layout Plain Layout
1048 ghostview
1049 \end_layout
1050
1051 \end_inset
1052
1053 ,
1054  to display the PostScript file.
1055 \end_layout
1056
1057 \begin_layout Standard
1058 \SpecialChar LyX
1059  does similar things when viewing,
1060  or exporting,
1061  other formats.
1062 \end_layout
1063
1064 \begin_layout Section
1065 Translating \SpecialChar LaTeX
1066  files into \SpecialChar LyX
1067
1068 \end_layout
1069
1070 \begin_layout Standard
1071 You can import a \SpecialChar LaTeX
1072  file into \SpecialChar LyX
1073  by using the
1074 \change_deleted -712698321 1674917408
1075
1076 \begin_inset Flex Noun
1077 status collapsed
1078
1079 \begin_layout Plain Layout
1080 File\SpecialChar menuseparator
1081 Import\SpecialChar menuseparator
1082 LaTeX
1083 \end_layout
1084
1085 \end_inset
1086
1087
1088 \change_inserted -712698321 1674917408
1089
1090 \family sans
1091 File\SpecialChar menuseparator
1092 Import\SpecialChar menuseparator
1093 LaTeX
1094 \change_unchanged
1095
1096 \family default
1097  command in \SpecialChar LyX
1098 .
1099  This will call a program named
1100 \begin_inset Flex Code
1101 status collapsed
1102
1103 \begin_layout Plain Layout
1104 tex2lyx
1105 \end_layout
1106
1107 \end_inset
1108
1109  which will create a file
1110 \begin_inset Flex Code
1111 status collapsed
1112
1113 \begin_layout Plain Layout
1114 foo.lyx
1115 \end_layout
1116
1117 \end_inset
1118
1119  from the file
1120 \begin_inset Flex Code
1121 status collapsed
1122
1123 \begin_layout Plain Layout
1124 foo.tex
1125 \end_layout
1126
1127 \end_inset
1128
1129 .
1130  \SpecialChar LyX
1131  will then open that file.
1132 \begin_inset Foot
1133 status collapsed
1134
1135 \begin_layout Plain Layout
1136 \begin_inset Flex Code
1137 status collapsed
1138
1139 \begin_layout Plain Layout
1140 tex2lyx
1141 \end_layout
1142
1143 \end_inset
1144
1145  can also be run from the command line,
1146  of course.
1147 \end_layout
1148
1149 \end_inset
1150
1151
1152 \end_layout
1153
1154 \begin_layout Standard
1155 \begin_inset Flex Code
1156 status collapsed
1157
1158 \begin_layout Plain Layout
1159 tex2lyx
1160 \end_layout
1161
1162 \end_inset
1163
1164  will translate most legal \SpecialChar LaTeX
1165 ,
1166  but not everything.
1167  It will put things it doesn't understand into \SpecialChar TeX
1168  code,
1169  so after translating a file with
1170 \begin_inset Flex Code
1171 status collapsed
1172
1173 \begin_layout Plain Layout
1174 tex2lyx
1175 \end_layout
1176
1177 \end_inset
1178
1179 ,
1180  you can look for \SpecialChar TeX
1181  code and hand-edit it until it looks right.
1182 \end_layout
1183
1184 \begin_layout Standard
1185 If you don't know what \SpecialChar TeX
1186  code is,
1187  read the next section.
1188 \end_layout
1189
1190 \begin_layout Section
1191 \begin_inset CommandInset label
1192 LatexCommand label
1193 name "sec:Inserting-TeX-Code"
1194
1195 \end_inset
1196
1197 Inserting \SpecialChar TeX
1198  Code into \SpecialChar LyX
1199  Documents
1200 \end_layout
1201
1202 \begin_layout Standard
1203 Anything you can do in \SpecialChar LaTeX
1204  you can do in \SpecialChar LyX
1205 ,
1206  for a very simple reason:
1207  You can always insert \SpecialChar TeX
1208  code into any \SpecialChar LyX
1209  document.
1210  \SpecialChar LyX
1211  cannot,
1212  and will never be able to,
1213  display every possible \SpecialChar LaTeX
1214  construct.
1215  If ever you need to insert \SpecialChar LaTeX
1216  commands into your \SpecialChar LyX
1217  document,
1218  you can use the
1219 \begin_inset Flex Code
1220 status collapsed
1221
1222 \begin_layout Plain Layout
1223 \SpecialChar TeX
1224  Code
1225 \end_layout
1226
1227 \end_inset
1228
1229  box,
1230  which you can insert into your document with
1231 \change_deleted -712698321 1674917417
1232
1233 \begin_inset Flex Noun
1234 status collapsed
1235
1236 \begin_layout Plain Layout
1237 Insert\SpecialChar menuseparator
1238
1239 \family sans
1240 TeX
1241 \family default
1242  Code
1243 \end_layout
1244
1245 \end_inset
1246
1247
1248 \change_inserted -712698321 1674917417
1249
1250 \family sans
1251 Insert\SpecialChar menuseparator
1252 TeX Code
1253 \change_unchanged
1254
1255 \family default
1256  or the keyboard shortcut
1257 \begin_inset Info
1258 type  "shortcut"
1259 arg   "ert-insert"
1260 \end_inset
1261
1262 .
1263 \end_layout
1264
1265 \begin_layout Standard
1266 Here's an example of inserting \SpecialChar LaTeX
1267  commands in a \SpecialChar LyX
1268  document.
1269  The code looks like this:
1270 \end_layout
1271
1272 \begin_layout LyX-Code
1273
1274 \backslash
1275 begin{tabular}{ll}
1276 \begin_inset Newline newline
1277 \end_inset
1278
1279
1280 \backslash
1281 begin{minipage}{5cm}
1282 \begin_inset Newline newline
1283 \end_inset
1284
1285 This is an example of a minipage environment.
1286  You
1287 \begin_inset Newline newline
1288 \end_inset
1289
1290 can put nearly everything in it,
1291  even (non-floating)
1292 \begin_inset Newline newline
1293 \end_inset
1294
1295 figures and tables.
1296
1297 \begin_inset Newline newline
1298 \end_inset
1299
1300
1301 \backslash
1302 end{minipage}
1303 \begin_inset Newline newline
1304 \end_inset
1305
1306 &
1307 \begin_inset Newline newline
1308 \end_inset
1309
1310
1311 \backslash
1312 begin{minipage}{5cm}
1313 \begin_inset Newline newline
1314 \end_inset
1315
1316
1317 \backslash
1318 begin{verbatim}
1319 \begin_inset Newline newline
1320 \end_inset
1321
1322
1323 \backslash
1324 begin{minipage}{5cm}
1325 \begin_inset Newline newline
1326 \end_inset
1327
1328 This ...
1329
1330 \begin_inset Newline newline
1331 \end_inset
1332
1333
1334 \backslash
1335 end{minipage}
1336 \begin_inset Newline newline
1337 \end_inset
1338
1339
1340 \backslash
1341 end{verbatim}
1342 \begin_inset Newline newline
1343 \end_inset
1344
1345
1346 \backslash
1347 end{minipage}
1348 \begin_inset Newline newline
1349 \end_inset
1350
1351
1352 \backslash
1353 end{tabular}
1354 \end_layout
1355
1356 \begin_layout LyX-Code
1357
1358 \end_layout
1359
1360 \begin_layout Standard
1361 The
1362 \begin_inset Flex Code
1363 status collapsed
1364
1365 \begin_layout Plain Layout
1366 \SpecialChar TeX
1367  Code
1368 \end_layout
1369
1370 \end_inset
1371
1372  box containing this text is directly after this paragraph.
1373  Those of you reading the manual in \SpecialChar LyX
1374  will only see the \SpecialChar TeX
1375  code inset.
1376  Those reading a printed version of the manuals will see the actual results:
1377 \begin_inset VSpace bigskip
1378 \end_inset
1379
1380
1381 \end_layout
1382
1383 \begin_layout Standard
1384 \begin_inset ERT
1385 status open
1386
1387 \begin_layout Plain Layout
1388
1389
1390 \backslash
1391 begin{tabular}{ll}
1392 \end_layout
1393
1394 \begin_layout Plain Layout
1395
1396
1397 \backslash
1398 begin{minipage}{5cm}
1399 \end_layout
1400
1401 \begin_layout Plain Layout
1402
1403 This is an example of a minipage environment.
1404  You can put nearly everything in it,
1405  even (non-floating) figures and tables.
1406
1407 \end_layout
1408
1409 \begin_layout Plain Layout
1410
1411
1412 \backslash
1413 end{minipage}
1414 \end_layout
1415
1416 \begin_layout Plain Layout
1417
1418 &
1419 \end_layout
1420
1421 \begin_layout Plain Layout
1422
1423
1424 \backslash
1425 begin{minipage}{5cm}
1426 \end_layout
1427
1428 \begin_layout Plain Layout
1429
1430
1431 \backslash
1432 begin{verbatim}
1433 \end_layout
1434
1435 \begin_layout Plain Layout
1436
1437
1438 \backslash
1439 begin{minipage}{5cm}
1440 \end_layout
1441
1442 \begin_layout Plain Layout
1443
1444 This ...
1445
1446 \end_layout
1447
1448 \begin_layout Plain Layout
1449
1450
1451 \backslash
1452 end{minipage}
1453 \end_layout
1454
1455 \begin_layout Plain Layout
1456
1457
1458 \backslash
1459 end{verbatim}
1460 \end_layout
1461
1462 \begin_layout Plain Layout
1463
1464
1465 \backslash
1466 end{minipage}
1467 \end_layout
1468
1469 \begin_layout Plain Layout
1470
1471
1472 \backslash
1473 end{tabular}
1474 \end_layout
1475
1476 \end_inset
1477
1478
1479 \begin_inset VSpace bigskip
1480 \end_inset
1481
1482
1483 \end_layout
1484
1485 \begin_layout Standard
1486 In addition to using \SpecialChar TeX
1487  code,
1488  you can also create a separate file containing some complex \SpecialChar LaTeX
1489  structure and then use
1490 \change_deleted -712698321 1674917427
1491
1492 \begin_inset Flex Noun
1493 status collapsed
1494
1495 \begin_layout Plain Layout
1496 Insert\SpecialChar menuseparator
1497 Child
1498 \begin_inset space ~
1499 \end_inset
1500
1501 Document
1502 \end_layout
1503
1504 \end_inset
1505
1506
1507 \change_inserted -712698321 1674917427
1508
1509 \family sans
1510 Insert\SpecialChar menuseparator
1511 Child
1512 \begin_inset space ~
1513 \end_inset
1514
1515 Document
1516 \change_unchanged
1517
1518 \family default
1519 to include your file (you should select the type
1520 \begin_inset Flex Code
1521 status collapsed
1522
1523 \begin_layout Plain Layout
1524 Input
1525 \end_layout
1526
1527 \end_inset
1528
1529 ).
1530  We recommend that you only do this if you have a
1531 \begin_inset Flex Code
1532 status collapsed
1533
1534 \begin_layout Plain Layout
1535 .tex
1536 \end_layout
1537
1538 \end_inset
1539
1540  file which you
1541 \emph on
1542 know
1543 \emph default
1544  works already.
1545  Otherwise,
1546  you'll have a big job tracking down \SpecialChar LaTeX
1547  errors.
1548 \end_layout
1549
1550 \begin_layout Standard
1551 There are a few last points to emphasize:
1552 \end_layout
1553
1554 \begin_layout Itemize
1555 \SpecialChar LyX
1556
1557 \emph on
1558 does not
1559 \emph default
1560  check if your \SpecialChar LaTeX
1561  code is correct.
1562 \end_layout
1563
1564 \begin_layout Itemize
1565 Beware of reinventing the wheel.
1566 \end_layout
1567
1568 \begin_layout Standard
1569 On that last point,
1570  \SpecialChar LyX
1571  does have quite a few features tucked into it,
1572  and more are coming.
1573  Be sure to check the manuals to make sure that \SpecialChar LyX
1574  doesn't have such-and-such feature before you decide you have to do it by hand.
1575  Moreover,
1576  there are numerous \SpecialChar LaTeX
1577  packages out there to do all sorts of things,
1578  from labels to envelopes to fancy multipage tables.
1579  Check out
1580 \change_inserted 244031559 1603815732
1581
1582 \begin_inset CommandInset href
1583 LatexCommand href
1584 name "CTAN"
1585 target "https://www.ctan.org/"
1586 literal "false"
1587
1588 \end_inset
1589
1590
1591 \change_deleted 244031559 1603815732
1592
1593 \begin_inset CommandInset href
1594 LatexCommand href
1595 name "CTAN"
1596 target "http://www.ctan.org/"
1597 literal "false"
1598
1599 \end_inset
1600
1601
1602 \change_unchanged
1603  for details.
1604 \end_layout
1605
1606 \begin_layout Standard
1607 If you do need to do some wild and fancy things within your document,
1608  be sure to check out a good \SpecialChar LaTeX
1609  book for assistance.
1610  There are a number of them listed in the bibliography of the
1611 \emph on
1612 User's Guide
1613 \emph default
1614 .
1615 \end_layout
1616
1617 \begin_layout Section
1618 \SpecialChar LyX
1619  and the \SpecialChar LaTeX
1620  Preamble
1621 \end_layout
1622
1623 \begin_layout Subsection
1624 About the \SpecialChar LaTeX
1625  Preamble
1626 \end_layout
1627
1628 \begin_layout Standard
1629 If you already know \SpecialChar LaTeX
1630 ,
1631  there is no need to explain here what the preamble is good for.
1632  If you don't,
1633  the following will give you some ideas—
1634 we recommend again that you consult a \SpecialChar LaTeX
1635  book for further information.
1636  In any case,
1637  you should read the points below,
1638  because they explain what you can do and what you don't need to do in the \SpecialChar LaTeX
1639  preamble of a \SpecialChar LyX
1640  document.
1641 \end_layout
1642
1643 \begin_layout Standard
1644 The \SpecialChar LaTeX
1645  preamble comes at the very beginning of a document,
1646
1647 \emph on
1648 before
1649 \emph default
1650  the text.
1651  It serves to:
1652 \end_layout
1653
1654 \begin_layout Itemize
1655 Declare the document class.
1656
1657 \begin_inset Newline newline
1658 \end_inset
1659
1660 \SpecialChar LyX
1661  already does this for you.
1662  If you're a seasoned \SpecialChar LaTeX
1663 -nician,
1664  and you have a custom document class you want to use,
1665  check out the
1666 \emph on
1667 Customization Manual
1668 \emph default
1669  for information on how to make \SpecialChar LyX
1670  interface to it.
1671 \end_layout
1672
1673 \begin_layout Itemize
1674 Declare the usage of packages.
1675
1676 \begin_inset Newline newline
1677 \end_inset
1678
1679 \SpecialChar LaTeX
1680  packages provide special commands,
1681  which are only available within a document when the package has been declared in the preamble.
1682  In addition to providing special commands,
1683  the inclusion of a package can change the document.
1684  For example,
1685  the package
1686 \begin_inset Flex Code
1687 status collapsed
1688
1689 \begin_layout Plain Layout
1690 indentfirst
1691 \end_layout
1692
1693 \end_inset
1694
1695  forces all paragraphs to be indented.
1696  There are other packages for labels,
1697  envelopes,
1698  margins,
1699  etc.
1700
1701 \end_layout
1702
1703 \begin_layout Itemize
1704 Set counters,
1705  variables,
1706  lengths and widths.
1707
1708 \begin_inset Newline newline
1709 \end_inset
1710
1711 There are several \SpecialChar LaTeX
1712  counters and variables that
1713 \emph on
1714 must
1715 \emph default
1716  be set globally from within the preamble in order to have the desired effect.
1717  (There are variables that you can set and reset inside the document,
1718  too.) Margins are a good example of something that must be set in the preamble.
1719  Another example is the label format for lists.
1720  You can actually set these just about anywhere,
1721  but it's best to do it just once,
1722  inside the preamble.
1723 \end_layout
1724
1725 \begin_layout Itemize
1726 Declare user defined commands (with
1727 \begin_inset Flex Code
1728 status collapsed
1729
1730 \begin_layout Plain Layout
1731
1732 \backslash
1733 newcommand
1734 \end_layout
1735
1736 \end_inset
1737
1738  or
1739 \begin_inset Flex Code
1740 status collapsed
1741
1742 \begin_layout Plain Layout
1743
1744 \backslash
1745 renewcommand
1746 \end_layout
1747
1748 \end_inset
1749
1750 ).
1751 \begin_inset Newline newline
1752 \end_inset
1753
1754 These are abbreviations for \SpecialChar LaTeX
1755  commands which appear very often inside a document.
1756  Although the preamble is a good place to declare such commands,
1757  they
1758 \emph on
1759 can
1760 \emph default
1761  be declared anywhere (before they are used for the first time,
1762  of course).
1763  This can be useful if there is a lot of raw \SpecialChar LaTeX
1764  code in your document,
1765  which normally should not be the case.
1766 \end_layout
1767
1768 \begin_layout Standard
1769 \SpecialChar LyX
1770  adds its own set of definitions to the preamble of the
1771 \begin_inset Flex Code
1772 status collapsed
1773
1774 \begin_layout Plain Layout
1775 .tex
1776 \end_layout
1777
1778 \end_inset
1779
1780  file it produces.
1781  This makes \SpecialChar LaTeX
1782  files generated by \SpecialChar LyX
1783  portable.
1784 \end_layout
1785
1786 \begin_layout Subsection
1787 Changing the Preamble
1788 \end_layout
1789
1790 \begin_layout Standard
1791 The commands which \SpecialChar LyX
1792  adds to the preamble of a \SpecialChar LaTeX
1793  file are fixed;
1794  you can't change them without patching \SpecialChar LyX
1795  itself.
1796  You can,
1797  however,
1798  add your own stuff to the preamble by selecting
1799 \begin_inset Flex Noun
1800 status collapsed
1801
1802 \begin_layout Plain Layout
1803 \SpecialChar LaTeX
1804
1805 \begin_inset space ~
1806 \end_inset
1807
1808 Preamble
1809 \end_layout
1810
1811 \end_inset
1812
1813  in the
1814 \change_deleted -712698321 1674917437
1815
1816 \begin_inset Flex Noun
1817 status collapsed
1818
1819 \begin_layout Plain Layout
1820 Document\SpecialChar menuseparator
1821 Settings
1822 \end_layout
1823
1824 \end_inset
1825
1826
1827 \change_inserted -712698321 1674917437
1828
1829 \family sans
1830 Document\SpecialChar menuseparator
1831 Settings
1832 \change_unchanged
1833
1834 \family default
1835  dialog.
1836  \SpecialChar LyX
1837  adds anything in the
1838 \begin_inset Flex Noun
1839 status collapsed
1840
1841 \begin_layout Plain Layout
1842 Preamble
1843 \end_layout
1844
1845 \end_inset
1846
1847  dialog to its own built-in preamble.
1848  Before adding your own declarations in the preamble,
1849  you should make sure that \SpecialChar LyX
1850  doesn't already support what you want to do.
1851  (Remember what we said about reinventing the wheel?) Also,
1852
1853 \emph on
1854 make sure your preamble code is correct
1855 \emph default
1856 .
1857  \SpecialChar LyX
1858  doesn't check it for you.
1859  If there is an error,
1860  you're likely to get an error like
1861 \begin_inset Quotes eld
1862 \end_inset
1863
1864
1865 \begin_inset Flex Code
1866 status collapsed
1867
1868 \begin_layout Plain Layout
1869 Missing
1870 \backslash
1871 begin{document}
1872 \end_layout
1873
1874 \end_inset
1875
1876
1877 \begin_inset Quotes erd
1878 \end_inset
1879
1880 .
1881  If you see this error,
1882  check your preamble.
1883 \end_layout
1884
1885 \begin_layout Subsection
1886 Examples
1887 \end_layout
1888
1889 \begin_layout Standard
1890 Here are some examples of what you can add to a preamble,
1891  and what they do.
1892 \end_layout
1893
1894 \begin_layout Subsubsection
1895 Example #1:
1896  Offsets
1897 \end_layout
1898
1899 \begin_layout Standard
1900 There are two variables under \SpecialChar LaTeX
1901  that control page position:
1902
1903 \begin_inset Flex Code
1904 status collapsed
1905
1906 \begin_layout Plain Layout
1907
1908 \backslash
1909 hoffset
1910 \end_layout
1911
1912 \end_inset
1913
1914  and
1915 \begin_inset Flex Code
1916 status collapsed
1917
1918 \begin_layout Plain Layout
1919
1920 \backslash
1921 voffset
1922 \end_layout
1923
1924 \end_inset
1925
1926 .
1927  Their names should be self-explanatory.
1928  These variables are useful if you think for a moment about computer labels.
1929  Sometimes,
1930  the size of a print medium and the area of the medium that you can actually print on aren't the same.
1931  This is where
1932 \begin_inset Flex Code
1933 status collapsed
1934
1935 \begin_layout Plain Layout
1936
1937 \backslash
1938 hoffset
1939 \end_layout
1940
1941 \end_inset
1942
1943  and
1944 \begin_inset Flex Code
1945 status collapsed
1946
1947 \begin_layout Plain Layout
1948
1949 \backslash
1950 voffset
1951 \end_layout
1952
1953 \end_inset
1954
1955  come in.
1956 \end_layout
1957
1958 \begin_layout Standard
1959 The default values for
1960 \begin_inset Flex Code
1961 status collapsed
1962
1963 \begin_layout Plain Layout
1964
1965 \backslash
1966 hoffset
1967 \end_layout
1968
1969 \end_inset
1970
1971  and
1972 \begin_inset Flex Code
1973 status collapsed
1974
1975 \begin_layout Plain Layout
1976
1977 \backslash
1978 voffset
1979 \end_layout
1980
1981 \end_inset
1982
1983  are both 0
1984 \begin_inset space \thinspace{}
1985 \end_inset
1986
1987 points,
1988  i.
1989 \begin_inset space \thinspace{}
1990 \end_inset
1991
1992 e.
1993 \begin_inset space \space{}
1994 \end_inset
1995
1996 the page isn't shifted.
1997  Unfortunately,
1998  some DVI drivers always seem to shift the page.
1999  We have no idea why,
2000  or why the sysadmin hasn't fixed such behavior.
2001  If you're using \SpecialChar LyX
2002  on a system that you don't personally maintain,
2003  and your sysadmin is a doofus,
2004
2005 \begin_inset Flex Code
2006 status collapsed
2007
2008 \begin_layout Plain Layout
2009
2010 \backslash
2011 hoffset
2012 \end_layout
2013
2014 \end_inset
2015
2016  and
2017 \begin_inset Flex Code
2018 status collapsed
2019
2020 \begin_layout Plain Layout
2021
2022 \backslash
2023 voffset
2024 \end_layout
2025
2026 \end_inset
2027
2028  can save the day.
2029  Suppose your left and top margins are always 0.5
2030 \begin_inset space \thinspace{}
2031 \end_inset
2032
2033 inches too big.
2034  You can add this to the preamble:
2035 \end_layout
2036
2037 \begin_layout LyX-Code
2038
2039 \backslash
2040 setlength{
2041 \backslash
2042 hoffset}{-0.5 in}
2043 \end_layout
2044
2045 \begin_layout LyX-Code
2046
2047 \backslash
2048 setlength{
2049 \backslash
2050 voffset}{-0.5 in}
2051 \end_layout
2052
2053 \begin_layout Standard
2054 and your margins should now be correct.
2055 \end_layout
2056
2057 \begin_layout Subsubsection
2058 Example #2:
2059  Labels
2060 \end_layout
2061
2062 \begin_layout Standard
2063 Speaking of labels,
2064  suppose you wanted to print out a bunch of address labels.
2065  There's a rather nice package,
2066  available at your nearest CTAN archive,
2067  for printing sheets of labels:
2068
2069 \begin_inset Flex Code
2070 status collapsed
2071
2072 \begin_layout Plain Layout
2073 labels.sty
2074 \end_layout
2075
2076 \end_inset
2077
2078 .
2079  Now,
2080  your system may not have this package installed by default.
2081  We leave that up to you to check.
2082  You'll also want to read the documentation for it;
2083  we're not going to do that for you.
2084  Since this is an example,
2085  however,
2086  we'll give you an example of how you use this package.
2087 \end_layout
2088
2089 \begin_layout Standard
2090 First,
2091  make sure you're using the
2092 \begin_inset Flex Code
2093 status collapsed
2094
2095 \begin_layout Plain Layout
2096 article
2097 \end_layout
2098
2099 \end_inset
2100
2101  document class.
2102  Next,
2103  you need to put the following in your preamble:
2104 \end_layout
2105
2106 \begin_layout LyX-Code
2107
2108 \backslash
2109 usepackage{labels}
2110 \end_layout
2111
2112 \begin_layout LyX-Code
2113
2114 \backslash
2115 LabelCols=3
2116 \end_layout
2117
2118 \begin_layout LyX-Code
2119
2120 \backslash
2121 LabelRows=7
2122 \end_layout
2123
2124 \begin_layout LyX-Code
2125
2126 \backslash
2127 LeftBorder=8mm
2128 \end_layout
2129
2130 \begin_layout LyX-Code
2131
2132 \backslash
2133 RightBorder=8mm
2134 \end_layout
2135
2136 \begin_layout LyX-Code
2137
2138 \backslash
2139 TopBorder=9mm
2140 \end_layout
2141
2142 \begin_layout LyX-Code
2143
2144 \backslash
2145 BottomBorder=2mm
2146 \end_layout
2147
2148 \begin_layout Standard
2149 This sets things up for Avery label sheets,
2150  stock #5360.
2151  You're now ready to print labels,
2152  but you'll need to insert \SpecialChar LaTeX
2153  code,
2154  placing the commands
2155 \begin_inset Flex Code
2156 status collapsed
2157
2158 \begin_layout Plain Layout
2159
2160 \backslash
2161 begin{labels}
2162 \end_layout
2163
2164 \end_inset
2165
2166  and
2167 \begin_inset Flex Code
2168 status collapsed
2169
2170 \begin_layout Plain Layout
2171
2172 \backslash
2173 end{labels}
2174 \end_layout
2175
2176 \end_inset
2177
2178  around each label text.
2179  This and other special features of
2180 \begin_inset Flex Code
2181 status collapsed
2182
2183 \begin_layout Plain Layout
2184 labels.sty
2185 \end_layout
2186
2187 \end_inset
2188
2189  are explained in its documentation.
2190 \end_layout
2191
2192 \begin_layout Standard
2193 Someday,
2194  someone may write a \SpecialChar LyX
2195  layout file to support this package directly.
2196  Maybe that someone is you.
2197 \end_layout
2198
2199 \begin_layout Subsubsection
2200 Example #3:
2201  Paragraph Indentation
2202 \end_layout
2203
2204 \begin_layout Standard
2205 Americans are trained to indent the first line of
2206 \emph on
2207 every
2208 \emph default
2209  paragraph.
2210  As with all of their other weird quirks,
2211  most Americans will whine and moan until they can have their way and indent the first line of all paragraphs.
2212  (Yes,
2213  we're joking.
2214  (We are?)
2215 \emph on
2216 Yeah
2217 \emph default
2218 ,
2219  we are.)
2220 \end_layout
2221
2222 \begin_layout Standard
2223 Of course,
2224  this behavior isn't standard typography.
2225  In books,
2226  you typically only indent the first line of a paragraph
2227 \emph on
2228 if
2229 \emph default
2230  it follows another one.
2231  The idea behind indenting the first line of a paragraph is to distinguish neighboring paragraphs from one another.
2232  If there is no previous paragraph—
2233 for example,
2234  if it follows a figure or is the first paragraph in a section—
2235 then there is no need for indentation.
2236
2237 \end_layout
2238
2239 \begin_layout Standard
2240 If you're a typical American (we're still joking!),
2241  though,
2242  you don't care about such esoteric things;
2243  you want your indentation!
2244  Add this to the preamble:
2245 \end_layout
2246
2247 \begin_layout LyX-Code
2248
2249 \backslash
2250 usepackage{indentfirst}
2251 \end_layout
2252
2253 \begin_layout Standard
2254 If your \SpecialChar TeX
2255  distribution isn't braindead,
2256  you'll have this package,
2257  and all of your paragraphs will get the indentation the Founding Fathers intended they should have.
2258 \end_layout
2259
2260 \begin_layout Subsubsection
2261 Example #4:
2262  This Document
2263 \end_layout
2264
2265 \begin_layout Standard
2266 You can also check out the preamble of this document to get an idea of some of the advanced things you can do.
2267 \end_layout
2268
2269 \begin_layout Section
2270 \SpecialChar LyX
2271  and \SpecialChar LaTeX
2272  Errors
2273 \end_layout
2274
2275 \begin_layout Standard
2276 When \SpecialChar LyX
2277  calls \SpecialChar LaTeX
2278 ,
2279  it tells \SpecialChar LaTeX
2280  to blithely ignore any errors and keep going.
2281  It then uses the logfile from the \SpecialChar LaTeX
2282  run to do a post-mortem.
2283  After analyzing the logfile,
2284  \SpecialChar LyX
2285  displays a dialog listing the errors.
2286  Clicking on any one of them will take you to the position in your \SpecialChar LyX
2287  file where the error occurred.
2288 \begin_inset Foot
2289 status collapsed
2290
2291 \begin_layout Plain Layout
2292 Well,
2293  usually.
2294  Analyzing the logfile is a tough job,
2295  and \SpecialChar LyX
2296  doesn't always go to the right line.
2297  There are also cases where \SpecialChar LaTeX
2298  reports the error on one line,
2299  but the actual error is earlier.
2300  This is not unlike forgetting a closing brace in a program:
2301  You'll get an error,
2302  but only later.
2303 \end_layout
2304
2305 \end_inset
2306
2307
2308 \end_layout
2309
2310 \begin_layout Standard
2311 Some folks also like to look at the log file directly:
2312  It is available from
2313 \change_deleted -712698321 1674917444
2314
2315 \begin_inset Flex Noun
2316 status collapsed
2317
2318 \begin_layout Plain Layout
2319 Document\SpecialChar menuseparator
2320 LaTeX
2321 \begin_inset space ~
2322 \end_inset
2323
2324 Log
2325 \end_layout
2326
2327 \end_inset
2328
2329
2330 \change_inserted -712698321 1674917444
2331
2332 \family sans
2333 Document\SpecialChar menuseparator
2334 LaTeX
2335 \begin_inset space ~
2336 \end_inset
2337
2338 Log
2339 \change_unchanged
2340
2341 \family default
2342 .
2343  There are some fairly common error messages and warnings.
2344  We'll cover those here.
2345  You should look at a good \SpecialChar LaTeX
2346  book for a complete listing.
2347 \end_layout
2348
2349 \begin_layout Itemize
2350 \begin_inset Flex Code
2351 status collapsed
2352
2353 \begin_layout Plain Layout
2354 LaTeX Warning
2355 \end_layout
2356
2357 \end_inset
2358
2359
2360 \begin_inset Newline newline
2361 \end_inset
2362
2363 Anything beginning with these words is a warning message for the purpose of
2364 \begin_inset Quotes eld
2365 \end_inset
2366
2367 debugging
2368 \begin_inset Quotes erd
2369 \end_inset
2370
2371  the \SpecialChar LaTeX
2372  code itself.
2373  You'll get messages like this if you added or changed cross-references or bibliography entries,
2374  in which case,
2375  \SpecialChar LaTeX
2376  is trying to tell you that you need to make another run.
2377  You can by-and-large ignore these.
2378 \end_layout
2379
2380 \begin_layout Itemize
2381 \begin_inset Flex Code
2382 status collapsed
2383
2384 \begin_layout Plain Layout
2385 LaTeX Font Warning
2386 \end_layout
2387
2388 \end_inset
2389
2390
2391 \begin_inset Newline newline
2392 \end_inset
2393
2394 Another warning message,
2395  this time about fonts which \SpecialChar LaTeX
2396  couldn't find.
2397  The rest of the message will often say something about a replacement font that \SpecialChar LaTeX
2398  used.
2399  You can safely ignore these,
2400  too.
2401 \end_layout
2402
2403 \begin_layout Itemize
2404 \begin_inset Flex Code
2405 status collapsed
2406
2407 \begin_layout Plain Layout
2408 Overfull
2409 \backslash
2410 hbox
2411 \end_layout
2412
2413 \end_inset
2414
2415
2416 \begin_inset Newline newline
2417 \end_inset
2418
2419 \SpecialChar LaTeX
2420  absolutely
2421 \emph on
2422 loves
2423 \emph default
2424  to spew these out.
2425  It seems to generate at least one of these messages for just about any document you write.
2426  They are warnings about lines that were too long and run past the right margin.
2427  This happens if \SpecialChar LaTeX
2428  does not find a reasonable way to break the lines (notoriously often with typewriter font,
2429  since this does not allow for automatic break points).
2430  In many cases,
2431  this is unnoticeable in the final output.
2432  (It can be just a point or two.) Sometimes,
2433  however,
2434  the lines run rather visibly into the margin;
2435  something you will not want to have in your final print.
2436
2437 \begin_inset Newline newline
2438 \end_inset
2439
2440 There are several global ways to try to minimize the overfull lines.
2441  Clicking
2442 \family sans
2443 Enable micro-typographic extensions
2444 \family default
2445  in
2446 \family sans
2447 Document\SpecialChar menuseparator
2448 Settings\SpecialChar menuseparator
2449 Fonts
2450 \family default
2451  might already improve things a lot.
2452  Furthermore,
2453  \SpecialChar LaTeX
2454  code such as the following in
2455 \family sans
2456 Document\SpecialChar menuseparator
2457 Settings\SpecialChar menuseparator
2458 Preamble
2459 \family default
2460  usually reduces the overfull lines drastically (we use this in the preamble of this document):
2461 \end_layout
2462
2463 \begin_deeper
2464 \begin_layout LyX-Code
2465
2466 \backslash
2467 tolerance 1414
2468 \begin_inset Newline newline
2469 \end_inset
2470
2471
2472 \backslash
2473 hbadness 1414
2474 \begin_inset Newline newline
2475 \end_inset
2476
2477
2478 \backslash
2479 emergencystretch 1.5em
2480 \begin_inset Newline newline
2481 \end_inset
2482
2483
2484 \backslash
2485 hfuzz 0.3pt
2486 \end_layout
2487
2488 \begin_layout Standard
2489 In some cases,
2490  however,
2491  you eventually have to rewrite the text to get the line breaking right.
2492 \begin_inset Foot
2493 status collapsed
2494
2495 \begin_layout Plain Layout
2496 For more information,
2497  see
2498 \begin_inset Flex URL
2499 status open
2500
2501 \begin_layout Plain Layout
2502
2503 http://www.tex.ac.uk/FAQ-overfull.html
2504 \end_layout
2505
2506 \end_inset
2507
2508
2509 \end_layout
2510
2511 \end_inset
2512
2513
2514 \end_layout
2515
2516 \begin_layout Standard
2517 In any case,
2518  you should check the respective lines,
2519  at least for the final version of your document.
2520  Your eyes will tell you if there's a problem with something that's too wide.
2521 \begin_inset Foot
2522 status collapsed
2523
2524 \begin_layout Plain Layout
2525 You can also enable the `draft' option in
2526 \change_deleted -712698321 1674917458
2527
2528 \begin_inset Flex Noun
2529 status collapsed
2530
2531 \begin_layout Plain Layout
2532 Document\SpecialChar menuseparator
2533 Settings
2534 \end_layout
2535
2536 \end_inset
2537
2538
2539 \change_inserted -712698321 1674917458
2540
2541 \family sans
2542 Document\SpecialChar menuseparator
2543 Settings
2544 \change_unchanged
2545
2546 \family default
2547 ,
2548  and then \SpecialChar LaTeX
2549  will draw a black box in the margin of lines that are overfull.
2550 \end_layout
2551
2552 \end_inset
2553
2554
2555 \end_layout
2556
2557 \end_deeper
2558 \begin_layout Itemize
2559 \begin_inset Flex Code
2560 status collapsed
2561
2562 \begin_layout Plain Layout
2563 Underfull
2564 \backslash
2565 hbox
2566 \end_layout
2567
2568 \end_inset
2569
2570
2571 \begin_inset Newline newline
2572 \end_inset
2573
2574 Not quite as common as its cousin.
2575  This happens again if \SpecialChar LaTeX
2576  does not find a reasonable break point and consequently generates too loose lines.
2577  As with the overfull lines,
2578  you should check if this is a visible problem.
2579 \end_layout
2580
2581 \begin_layout Itemize
2582 \begin_inset Flex Code
2583 status collapsed
2584
2585 \begin_layout Plain Layout
2586 Overfull
2587 \backslash
2588 vbox
2589 \end_layout
2590
2591 \end_inset
2592
2593  and
2594 \begin_inset Flex Code
2595 status collapsed
2596
2597 \begin_layout Plain Layout
2598 Underfull
2599 \backslash
2600 vbox
2601 \end_layout
2602
2603 \end_inset
2604
2605
2606 \begin_inset Newline newline
2607 \end_inset
2608
2609 Warnings about troubles breaking the page.
2610  Once again,
2611  just look at the output.
2612  Your eyes will tell you where something has gone wrong.
2613 \end_layout
2614
2615 \begin_layout Itemize
2616 \begin_inset Flex Code
2617 status collapsed
2618
2619 \begin_layout Plain Layout
2620 LaTeX Error:
2621  File
2622 \begin_inset Quotes els
2623 \end_inset
2624
2625 Xxxx
2626 \begin_inset Quotes ers
2627 \end_inset
2628
2629  not found
2630 \end_layout
2631
2632 \end_inset
2633
2634
2635 \begin_inset Newline newline
2636 \end_inset
2637
2638 The file
2639 \begin_inset Quotes eld
2640 \end_inset
2641
2642 Xxxx
2643 \begin_inset Quotes erd
2644 \end_inset
2645
2646  isn't installed on this system.
2647  This usually appears because some package your document needs isn't installed.
2648  If you didn't touch the preamble or didn't use the
2649 \begin_inset Flex Code
2650 status collapsed
2651
2652 \begin_layout Plain Layout
2653
2654 \backslash
2655 usepackage{}
2656 \end_layout
2657
2658 \end_inset
2659
2660  command,
2661  then one of the packages \SpecialChar LyX
2662  tried to load is missing.
2663  Use
2664 \change_deleted -712698321 1674917468
2665
2666 \begin_inset Flex Noun
2667 status collapsed
2668
2669 \begin_layout Plain Layout
2670 Help\SpecialChar menuseparator
2671 \SpecialChar LaTeX
2672  Configuration
2673 \end_layout
2674
2675 \end_inset
2676
2677
2678 \change_inserted -712698321 1674917478
2679
2680 \family sans
2681 Help\SpecialChar menuseparator
2682 LaTeX Configuration
2683 \change_unchanged
2684
2685 \family default
2686  to get a list of packages that \SpecialChar LyX
2687  knows about.
2688  This file is updated whenever you reconfigure \SpecialChar LyX
2689  (using
2690 \change_deleted -712698321 1674917484
2691
2692 \begin_inset Flex Noun
2693 status collapsed
2694
2695 \begin_layout Plain Layout
2696 Tools\SpecialChar menuseparator
2697 Reconfigure
2698 \end_layout
2699
2700 \end_inset
2701
2702
2703 \change_inserted -712698321 1674917484
2704
2705 \family sans
2706 Tools\SpecialChar menuseparator
2707 Reconfigure
2708 \change_unchanged
2709
2710 \family default
2711 ) and tells you which packages have been detected and what they do.
2712 \begin_inset Newline newline
2713 \end_inset
2714
2715 If you did use the
2716 \begin_inset Flex Code
2717 status collapsed
2718
2719 \begin_layout Plain Layout
2720
2721 \backslash
2722 usepackage{}
2723 \end_layout
2724
2725 \end_inset
2726
2727  command and the package in question isn't installed,
2728  then you'll need to install it yourself.
2729 \end_layout
2730
2731 \begin_layout Itemize
2732 \begin_inset Flex Code
2733 status collapsed
2734
2735 \begin_layout Plain Layout
2736 LaTeX Error:
2737  Unknown option
2738 \end_layout
2739
2740 \end_inset
2741
2742
2743 \begin_inset Newline newline
2744 \end_inset
2745
2746 Error messages beginning with this are trying to tell you that you specified a bad or undefined option to a package.
2747  Check the package's documentation.
2748 \end_layout
2749
2750 \begin_layout Itemize
2751 \begin_inset Flex Code
2752 status collapsed
2753
2754 \begin_layout Plain Layout
2755 Undefined control sequence
2756 \end_layout
2757
2758 \end_inset
2759
2760
2761 \begin_inset Newline newline
2762 \end_inset
2763
2764 If you've inserted \SpecialChar LaTeX
2765  code into your document,
2766  but made a typo,
2767  you'll get one of these.
2768  You may have forgotten to load a package.
2769  In any case,
2770  this error message usually means that you used an undefined command.
2771
2772 \end_layout
2773
2774 \begin_layout Standard
2775 There are other error and warning messages.
2776  Some are self-explanatory.
2777  These are usually \SpecialChar LaTeX
2778  messages.
2779  Others are downright cryptic.
2780  These are usually \SpecialChar TeX
2781  error messages,
2782  and we really have
2783 \emph on
2784 no clue
2785 \emph default
2786  what they mean or how to decipher them.
2787  No-one does.
2788 \end_layout
2789
2790 \begin_layout Standard
2791 There's a general sequence you should follow if you get error messages:
2792 \end_layout
2793
2794 \begin_layout Enumerate
2795 Look at the \SpecialChar LaTeX
2796  code you inserted for typos.
2797 \end_layout
2798
2799 \begin_layout Enumerate
2800 If there are no typos,
2801  check that you used the command(s) correctly.
2802 \end_layout
2803
2804 \begin_layout Enumerate
2805 If you get a bunch of error boxes piled up at the very top of the document—
2806 and especially if you see a
2807 \begin_inset Quotes eld
2808 \end_inset
2809
2810
2811 \begin_inset Flex Code
2812 status collapsed
2813
2814 \begin_layout Plain Layout
2815 Missing
2816 \backslash
2817 begin{document}
2818 \end_layout
2819
2820 \end_inset
2821
2822
2823 \begin_inset Quotes erd
2824 \end_inset
2825
2826  error—
2827 it means that there are errors in the preamble.
2828  Start debugging your preamble.
2829 \end_layout
2830
2831 \begin_layout Enumerate
2832 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2833  code to the document,
2834  the first suspect is your \SpecialChar LaTeX
2835  distribution itself.
2836  Check for missing packages and install them.
2837 \end_layout
2838
2839 \begin_layout Enumerate
2840 Okay,
2841  so there are no missing packages.
2842  Did you use any of the fine-tuning options in \SpecialChar LyX
2843 ?
2844  Specifically,
2845  did you
2846 \emph on
2847 misuse
2848 \emph default
2849  any of them,
2850  like trying to manually insert lots of
2851 \begin_inset Flex Code
2852 status collapsed
2853
2854 \begin_layout Plain Layout
2855
2856 \change_deleted 177693 1654669036
2857 Protected
2858 \change_inserted 177693 1654669038
2859 Non-Breaking
2860 \change_unchanged
2861
2862 \begin_inset space ~
2863 \end_inset
2864
2865
2866 \change_deleted 177693 1654669040
2867 Blanks
2868 \change_inserted 177693 1654669041
2869 Spaces
2870 \change_unchanged
2871
2872 \end_layout
2873
2874 \end_inset
2875
2876 ,
2877
2878 \begin_inset Flex Code
2879 status collapsed
2880
2881 \begin_layout Plain Layout
2882 Linebreaks
2883 \end_layout
2884
2885 \end_inset
2886
2887 ,
2888  or
2889 \begin_inset Flex Code
2890 status collapsed
2891
2892 \begin_layout Plain Layout
2893 Pagebreaks
2894 \end_layout
2895
2896 \end_inset
2897
2898 ?
2899  Did you try to kludge something together with these instead of using the appropriate paragraph environment?
2900 \end_layout
2901
2902 \begin_layout Enumerate
2903 All right,
2904  you didn't use any of the fine-tuning options,
2905  you played by the rules.
2906  Did you try to pull a fancy maneuver?
2907  Did you do something funky inside a table or an equation,
2908  like inserting a graphic into a table cell?
2909 \end_layout
2910
2911 \begin_layout Enumerate
2912 Do you have long sections of text where \SpecialChar LaTeX
2913  cannot find a place to break a line?
2914  By default,
2915  \SpecialChar LaTeX
2916  is rather strict about how much extra inter-word spacing it will add in order to break a line.
2917  Preferably,
2918  you should rework the paragraph to avoid the problem.
2919 \end_layout
2920
2921 \begin_layout Enumerate
2922 Did you go overboard with the nesting?
2923  \SpecialChar LyX
2924  (currently) doesn't check to make sure you're in the limits for nesting environments.
2925  If you nested a bunch of environments to the
2926 \begin_inset Formula $17^{\mathrm{th}}$
2927 \end_inset
2928
2929  level,
2930  that's the problem.
2931  (The limit in \SpecialChar LaTeX
2932  is five.)
2933 \end_layout
2934
2935 \begin_layout Enumerate
2936 Okay,
2937  you didn't get any error messages,
2938  but your output looks awful.
2939  If you have a table or figure that's too wide or long for the page,
2940  you need to:
2941 \end_layout
2942
2943 \begin_deeper
2944 \begin_layout Enumerate
2945 rescale the figure so it fits.
2946 \end_layout
2947
2948 \begin_layout Enumerate
2949 trim down the table so it fits.
2950 \end_layout
2951
2952 \end_deeper
2953 \begin_layout Enumerate
2954 If something else is wrong with the output,
2955  and you didn't try to pull anything fancy or kludge the fine-tuning options,
2956  we're not sure what's wrong.
2957 \end_layout
2958
2959 \begin_layout Standard
2960 If all this doesn't help—
2961 well,
2962  then
2963 \emph on
2964 perhaps
2965 \emph default
2966  you might have found a bug in \SpecialChar LyX
2967 \SpecialChar ldots
2968 .
2969 \end_layout
2970
2971 \begin_layout Chapter
2972
2973 \change_inserted 564990737 1672345271
2974 Document classes
2975 \end_layout
2976
2977 \begin_layout Standard
2978
2979 \change_inserted 564990737 1672345272
2980 As explained in the
2981 \emph on
2982 User's Guide
2983 \emph default
2984 ,
2985  \SpecialChar LaTeX
2986  originally offered four standard document classes,
2987  article,
2988  report,
2989  book and letter,
2990  but individuals and organizations,
2991  most notably the American Mathematical Society in the early days,
2992  have made many contributions to extending the range of document classes.
2993  In this chapter we summarize the main externally maintained classes,
2994  some of which are marked “Unavailable:” in the pull-down
2995 \family sans
2996 Document
2997 \begin_inset space ~
2998 \end_inset
2999
3000
3001 \bar under
3002 c
3003 \bar default
3004 lass
3005 \family default
3006  list in the
3007 \family sans
3008 \bar under
3009 D
3010 \bar default
3011 ocument\SpecialChar menuseparator
3012
3013 \bar under
3014 S
3015 \bar default
3016 ettings\SpecialChar menuseparator
3017 Document
3018 \begin_inset space ~
3019 \end_inset
3020
3021 class
3022 \family default
3023  dialog and which you will need to install as described in the
3024 \emph on
3025 Installing New Document Classes
3026 \emph default
3027  chapter of the
3028 \emph on
3029 Customization
3030 \emph default
3031  manual if you want to use them.
3032
3033 \end_layout
3034
3035 \begin_layout Section
3036
3037 \change_inserted 564990737 1670439533
3038 \begin_inset CommandInset label
3039 LatexCommand label
3040 name "sec:Collections"
3041
3042 \end_inset
3043
3044 Collections
3045 \end_layout
3046
3047 \begin_layout Subsection
3048
3049 \change_inserted 564990737 1672345298
3050 \begin_inset CommandInset label
3051 LatexCommand label
3052 name "subsec:AMS-LaTeX-(American-Mathematical"
3053
3054 \end_inset
3055
3056 AMS-\SpecialChar LaTeX
3057  (American Mathematical Society)
3058 \end_layout
3059
3060 \begin_layout Standard
3061
3062 \change_inserted 564990737 1672345298
3063 The \SpecialChar LyX
3064  supported document classes
3065 \family sans
3066 article (AMS)
3067 \family default
3068  and
3069 \family sans
3070 book (AMS)
3071 \family default
3072  are maintained by the Society;
3073  use of their features is described in the Math manual and on their website
3074 \begin_inset Flex URL
3075 status collapsed
3076
3077 \begin_layout Plain Layout
3078
3079 \change_inserted 564990737 1672345298
3080
3081 http://www.ams.org/publications/authors/tex/amslatex
3082 \change_unchanged
3083
3084 \end_layout
3085
3086 \end_inset
3087
3088 .
3089  The following summary was originally provided by
3090 \noun on
3091 David Johnson
3092 \noun default
3093  and updated by
3094 \noun on
3095 Richard
3096 \change_inserted -712698321 1673082716
3097 Kimberly
3098 \change_inserted 564990737 1672345298
3099 Heck
3100 \noun default
3101  and the \SpecialChar LyX
3102  Team
3103 \noun on
3104 .
3105 \change_deleted 564990737 1672345297
3106
3107 \noun default
3108 AMS \SpecialChar LaTeX
3109
3110 \end_layout
3111
3112 \begin_layout Standard
3113
3114 \change_deleted 564990737 1672345297
3115 by
3116 \noun on
3117 David Johnson
3118 \noun default
3119 ;
3120  updated by
3121 \noun on
3122 Richard Kimberly Heck
3123 \change_unchanged
3124
3125 \end_layout
3126
3127 \begin_layout Standard
3128 \begin_inset VSpace bigskip
3129 \end_inset
3130
3131
3132 \end_layout
3133
3134 \begin_layout Standard
3135 \noindent
3136 The AMS \SpecialChar LaTeX
3137  layouts are set up to conform to suggested styles for mathematical papers to be submitted to American Mathematical Society publications.
3138  The layouts are not tailored to a specific journal,
3139  but easily can be.
3140  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
3141  output).
3142  That documentation is available on the Web at
3143 \begin_inset Flex URL
3144 status open
3145
3146 \begin_layout Plain Layout
3147
3148 http://www.ams.org
3149 \end_layout
3150
3151 \end_inset
3152
3153  or by ftp at
3154 \begin_inset Flex URL
3155 status open
3156
3157 \begin_layout Plain Layout
3158
3159 ftp://ftp.ams.org/pub/tex/amslatex/
3160 \end_layout
3161
3162 \end_inset
3163
3164 .
3165  These layouts are appropriate,
3166  and useful,
3167  for any mathematical writing.
3168
3169 \end_layout
3170
3171 \begin_layout Standard
3172 There are
3173 \change_deleted -712698321 1673083001
3174 two
3175 \change_inserted -712698321 1673083002
3176 three
3177 \change_unchanged
3178  basic AMS \SpecialChar LaTeX
3179  layouts:
3180
3181 \end_layout
3182
3183 \begin_layout Itemize
3184 amsart:
3185  The standard AMS article format
3186 \change_inserted 564990737 1672345333
3187 ;
3188  see
3189 \family sans
3190 File\SpecialChar menuseparator
3191 Open Example\SpecialChar menuseparator
3192 Articles\SpecialChar menuseparator
3193 American Mathematical Society (AMS)
3194 \change_unchanged
3195
3196 \family default
3197 .
3198 \end_layout
3199
3200 \begin_layout Itemize
3201 amsbook:
3202  the standard AMS book (really,
3203  monograph) format
3204 \change_inserted 564990737 1672345366
3205 ;
3206  see
3207 \family sans
3208 File\SpecialChar menuseparator
3209 Open Example\SpecialChar menuseparator
3210 Books\SpecialChar menuseparator
3211 American Mathematical Society (AMS)
3212 \change_unchanged
3213
3214 \family default
3215 .
3216 \change_inserted 564990737 1672345369
3217
3218 \end_layout
3219
3220 \begin_layout Itemize
3221
3222 \change_inserted 564990737 1672345383
3223 amsproc:
3224  the standard AMS proceedings format.
3225 \end_layout
3226
3227 \begin_layout Standard
3228
3229 \change_inserted 564990737 1672345383
3230 \SpecialChar LyX
3231  only supports the first two natively;
3232  see the
3233 \emph on
3234 Installing New Document Classes
3235 \emph default
3236  chapter of the
3237 \emph on
3238 Customization
3239 \emph default
3240  manual if you want to use
3241 \family sans
3242 amsproc
3243 \family default
3244 .
3245 \end_layout
3246
3247 \begin_layout Standard
3248 The layouts themselves contain only the minimum necessary to use the AMS classes.
3249  They do not,
3250  in particular,
3251  contain any of the `theorem' environments used for setting theorems,
3252  lemmas,
3253  and the like.
3254  These are contained,
3255  instead,
3256  in the
3257 \change_deleted 564990737 1672345416
3258
3259 \begin_inset Flex Code
3260 status collapsed
3261
3262 \begin_layout Plain Layout
3263 Theorems (AMS)
3264 \end_layout
3265
3266 \end_inset
3267
3268
3269 \change_inserted 564990737 1672345416
3270
3271 \family sans
3272 AMS Theorems
3273 \change_unchanged
3274
3275 \family default
3276  module,
3277  which is loaded by default when you select one of the AMS classes.
3278  (It can also be used with other classes and can be removed,
3279  if you would rather use something else.) Less commonly used environments are in the
3280 \change_deleted 564990737 1672345436
3281
3282 \begin_inset Flex Code
3283 status collapsed
3284
3285 \begin_layout Plain Layout
3286 Theorems (AMS-Extended)
3287 \end_layout
3288
3289 \end_inset
3290
3291
3292 \change_inserted 564990737 1672345436
3293
3294 \family sans
3295 AMS Theorems (Extended)
3296 \change_unchanged
3297
3298 \family default
3299  module,
3300  which must be loaded manually.
3301 \end_layout
3302
3303 \begin_layout Standard
3304 By default,
3305  theorems and the like are numbered consecutively throughout the document,
3306  but this may be modified by loading the module
3307 \change_deleted 564990737 1672345461
3308
3309 \begin_inset Flex Code
3310 status collapsed
3311
3312 \begin_layout Plain Layout
3313 Theorems (Order by Section)
3314 \end_layout
3315
3316 \end_inset
3317
3318
3319 \change_inserted 564990737 1672345461
3320
3321 \family sans
3322 Standard Theorems (Numbered by Section)
3323 \change_unchanged
3324
3325 \family default
3326  or,
3327  if you are using
3328 \begin_inset Flex Code
3329 status collapsed
3330
3331 \begin_layout Plain Layout
3332 book (AMS)
3333 \end_layout
3334
3335 \end_inset
3336
3337 ,
3338  the module
3339 \change_deleted 564990737 1672345479
3340
3341 \begin_inset Flex Code
3342 status collapsed
3343
3344 \begin_layout Plain Layout
3345 Theorems (Order by Chapter)
3346 \end_layout
3347
3348 \end_inset
3349
3350
3351 \change_inserted 564990737 1672345480
3352
3353 \family sans
3354 Standard Theorems (Numbered by Chapter)
3355 \change_unchanged
3356
3357 \family default
3358 .
3359  These will number the results as
3360 \begin_inset Formula $n.m$
3361 \end_inset
3362
3363 ,
3364  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).
3365  Many environments are also available unnumbered.
3366  These are indicated by an asterisk at the end.
3367  If you happen to want
3368 \emph on
3369 only
3370 \emph default
3371  unnumbered results,
3372  the module
3373 \change_deleted 564990737 1672345498
3374
3375 \begin_inset Flex Code
3376 status collapsed
3377
3378 \begin_layout Plain Layout
3379 Theorems (Starred)
3380 \end_layout
3381
3382 \end_inset
3383
3384
3385 \change_inserted 564990737 1672345498
3386
3387 \family sans
3388 Standard Theorems (Unnumbered)
3389 \change_unchanged
3390
3391 \family default
3392  provides that option.
3393 \end_layout
3394
3395 \begin_layout Standard
3396 Note that these modules do not
3397 \emph on
3398 have
3399 \emph default
3400  to be used with the AMS classes.
3401  It is perfectly possible to use the
3402 \change_deleted 564990737 1672345520
3403
3404 \begin_inset Flex Code
3405 status collapsed
3406
3407 \begin_layout Plain Layout
3408 Theorems (AMS)
3409 \end_layout
3410
3411 \end_inset
3412
3413
3414 \change_inserted 564990737 1672345520
3415
3416 \family sans
3417 AMS Theorems
3418 \change_unchanged
3419
3420 \family default
3421  module,
3422  and the others mentioned,
3423  with other classes,
3424  such as
3425 \begin_inset Flex Code
3426 status collapsed
3427
3428 \begin_layout Plain Layout
3429
3430 \change_deleted -712698321 1673083855
3431 article
3432 \change_inserted -712698321 1673083855
3433 Article (Standard Class)
3434 \change_unchanged
3435
3436 \end_layout
3437
3438 \end_inset
3439
3440 ,
3441
3442 \begin_inset Flex Code
3443 status collapsed
3444
3445 \begin_layout Plain Layout
3446
3447 \change_deleted -712698321 1673083858
3448 report
3449 \change_inserted -712698321 1673083862
3450 Report (Standard Class)
3451 \change_unchanged
3452
3453 \end_layout
3454
3455 \end_inset
3456
3457 ,
3458
3459 \begin_inset Flex Code
3460 status collapsed
3461
3462 \begin_layout Plain Layout
3463
3464 \change_deleted -712698321 1673083819
3465 book (KOMA-script)
3466 \change_inserted -712698321 1673083822
3467 KOMA-Script Book
3468 \change_unchanged
3469
3470 \end_layout
3471
3472 \end_inset
3473
3474 ,
3475  and so forth.
3476 \end_layout
3477
3478 \begin_layout Subsubsection
3479 What these layouts provide
3480 \end_layout
3481
3482 \begin_layout Standard
3483 There is a long list of included environments provided by these layouts.
3484  In AMS-\SpecialChar LaTeX
3485 ,
3486  there is,
3487  in fact,
3488  an opportunity to define an unlimited variety of `theorem' environments.
3489  However,
3490  the AMS recommends the environments that are available in \SpecialChar LyX
3491 .
3492
3493 \end_layout
3494
3495 \begin_layout Standard
3496 The following environments—
3497 as well as the standard environments,
3498  such as
3499 \begin_inset Flex Noun
3500 status collapsed
3501
3502 \begin_layout Plain Layout
3503 section
3504 \end_layout
3505
3506 \end_inset
3507
3508 ,
3509
3510 \begin_inset Flex Noun
3511 status collapsed
3512
3513 \begin_layout Plain Layout
3514 bibliography
3515 \end_layout
3516
3517 \end_inset
3518
3519 ,
3520
3521 \begin_inset Flex Noun
3522 status collapsed
3523
3524 \begin_layout Plain Layout
3525 title
3526 \end_layout
3527
3528 \end_inset
3529
3530 ,
3531
3532 \begin_inset Flex Noun
3533 status collapsed
3534
3535 \begin_layout Plain Layout
3536 author
3537 \end_layout
3538
3539 \end_inset
3540
3541 ,
3542  and
3543 \begin_inset Flex Noun
3544 status collapsed
3545
3546 \begin_layout Plain Layout
3547 date
3548 \end_layout
3549
3550 \end_inset
3551
3552 —
3553 are provided by
3554 \begin_inset Flex Code
3555 status collapsed
3556
3557 \begin_layout Plain Layout
3558 article (AMS)
3559 \end_layout
3560
3561 \end_inset
3562
3563  and
3564 \begin_inset Flex Code
3565 status collapsed
3566
3567 \begin_layout Plain Layout
3568 book (AMS)
3569 \end_layout
3570
3571 \end_inset
3572
3573 :
3574 \end_layout
3575
3576 \begin_layout Description
3577 Address This should be the author's permanent address.
3578 \end_layout
3579
3580 \begin_layout Description
3581 Current
3582 \begin_inset space ~
3583 \end_inset
3584
3585 Address This should be the author's temporary address at the time of submission,
3586  if different from the Address.
3587 \end_layout
3588
3589 \begin_layout Description
3590 Email Author's e-mail address
3591 \end_layout
3592
3593 \begin_layout Description
3594 URL Author's Web address,
3595  if desired.
3596 \end_layout
3597
3598 \begin_layout Description
3599 Keywords Key words or phrases used to identify specific topics discussed in the paper.
3600 \end_layout
3601
3602 \begin_layout Description
3603 Subjectclass These refer to the AMS Subject Classifications,
3604  published and described in
3605 \emph on
3606 Mathematical Reviews
3607 \emph default
3608 .
3609  These are also available online at the AMS cites listed above.
3610 \end_layout
3611
3612 \begin_layout Description
3613 Thanks
3614 \end_layout
3615
3616 \begin_layout Description
3617 Dedicatory
3618 \end_layout
3619
3620 \begin_layout Description
3621 Translator
3622 \end_layout
3623
3624 \begin_layout Standard
3625 The following environments are provided by both the
3626 \change_deleted 564990737 1672345566
3627
3628 \begin_inset Flex Code
3629 status collapsed
3630
3631 \begin_layout Plain Layout
3632 Theorems
3633 \end_layout
3634
3635 \end_inset
3636
3637
3638 \change_inserted 564990737 1672345566
3639
3640 \family sans
3641 Standard Theorems
3642 \change_unchanged
3643
3644 \family default
3645  and
3646 \change_deleted 564990737 1672345580
3647
3648 \begin_inset Flex Code
3649 status collapsed
3650
3651 \begin_layout Plain Layout
3652 Theorems (AMS)
3653 \end_layout
3654
3655 \end_inset
3656
3657
3658 \change_inserted 564990737 1672345580
3659
3660 \family sans
3661 AMS Theorems
3662 \change_unchanged
3663
3664 \family default
3665  modules,
3666  in the latter case in both
3667 \change_deleted -712698321 1673084072
3668 starred (
3669 \change_unchanged
3670 unnumbered
3671 \change_deleted -712698321 1673084073
3672 )
3673 \change_unchanged
3674  and
3675 \change_deleted -712698321 1673084075
3676 unstarred (
3677 \change_unchanged
3678 numbered
3679 \change_deleted -712698321 1673084077
3680 )
3681 \change_unchanged
3682  versions.
3683  These same environments are provided only in the starred versions by the
3684 \change_deleted 564990737 1672345596
3685
3686 \begin_inset Flex Code
3687 status collapsed
3688
3689 \begin_layout Plain Layout
3690 Theorems (Starred)
3691 \end_layout
3692
3693 \end_inset
3694
3695
3696 \change_inserted 564990737 1672345596
3697
3698 \family sans
3699 Standard Theorems
3700 \change_inserted -712698321 1673084060
3701  (Unnumbered)
3702 \change_unchanged
3703
3704 \family default
3705  module:
3706 \end_layout
3707
3708 \begin_layout Theorem
3709 This is typically used for the statements of major results.
3710
3711 \end_layout
3712
3713 \begin_layout Corollary*
3714 This is used for statements which follow fairly directly from previous statements.
3715  Again,
3716  these can be major results.
3717
3718 \end_layout
3719
3720 \begin_layout Lemma
3721 These are smaller results needed to prove other statements.
3722 \end_layout
3723
3724 \begin_layout Proposition
3725 These are less major results which (hopefully) add to the general theory being discussed.
3726 \end_layout
3727
3728 \begin_layout Conjecture
3729 These are statements provided without justification,
3730  which the author does not know how to prove,
3731  but which seem to be true (to the author,
3732  at least).
3733 \end_layout
3734
3735 \begin_layout Definition*
3736 Guess what this is for.
3737  The font is different for this environment than for the previous ones.
3738
3739 \end_layout
3740
3741 \begin_layout Example*
3742 Used for examples illustrating proven results.
3743 \end_layout
3744
3745 \begin_layout Problem
3746 It's not really known what this is for.
3747  You should figure it out.
3748 \end_layout
3749
3750 \begin_layout Exercise*
3751 Write a description for this one.
3752 \end_layout
3753
3754 \begin_layout Remark
3755 This environment is also a type of theorem,
3756  usually a lesser sort of observation.
3757 \end_layout
3758
3759 \begin_layout Claim*
3760 Often used in the course of giving a proof of a larger result.
3761 \end_layout
3762
3763 \begin_layout Case
3764 Generally,
3765  these are used to break up long arguments,
3766  using specific instances of some condition.
3767
3768 \end_layout
3769
3770 \begin_layout Case
3771 The numbering scheme for cases is on its own,
3772  not together with other numbered statements.
3773
3774 \end_layout
3775
3776 \begin_layout Proof
3777 At the end of this environment,
3778  a QED symbol (usually a square,
3779  but it can vary with different styles) is placed.
3780  If you want to have other environments within this one—
3781 for example,
3782  Case environments—
3783 and have the QED symbol appear only after them,
3784  then the other environments need to be nested within the proof environment.
3785  See the section
3786 \emph on
3787 Nesting Environments
3788 \emph default
3789  of the
3790 \emph on
3791 User's Guide
3792 \emph default
3793  for information on nesting.
3794 \end_layout
3795
3796 \begin_layout Fact
3797
3798 \change_inserted 564990737 1672345651
3799 Used in a way similar to Proposition,
3800  though perhaps lower on the scale.
3801 \end_layout
3802
3803 \begin_layout Standard
3804 And these environments are provided by
3805 \change_deleted 564990737 1672345684
3806
3807 \begin_inset Flex Code
3808 status collapsed
3809
3810 \begin_layout Plain Layout
3811 Theorems (AMS-Extended)
3812 \end_layout
3813
3814 \end_inset
3815
3816
3817 \change_inserted 564990737 1672345689
3818
3819 \family sans
3820 AMS Theorems (Extended
3821 \family default
3822 )
3823 \change_unchanged
3824 :
3825 \end_layout
3826
3827 \begin_layout Criterion*
3828 A required condition.
3829 \end_layout
3830
3831 \begin_layout Algorithm*
3832 A general procedure to be used.
3833 \end_layout
3834
3835 \begin_layout Axiom*
3836 This is a property or statement taken as true within the system being discussed.
3837 \end_layout
3838
3839 \begin_layout Condition*
3840 Sometimes used to state a condition assumed within the present context of discussion.
3841 \end_layout
3842
3843 \begin_layout Note*
3844 Similar to a Remark.
3845 \end_layout
3846
3847 \begin_layout Notation*
3848 Used for the explanation of,
3849  yes,
3850  notation.
3851 \end_layout
3852
3853 \begin_layout Summary
3854 Do we really need to tell you?
3855
3856 \end_layout
3857
3858 \begin_layout Standard
3859
3860 \change_deleted -712698321 1675595089
3861 Acknowledgement.
3862 \change_unchanged
3863
3864 \end_layout
3865
3866 \begin_layout Conclusion*
3867 Sometimes used at the end of a long train of argument.
3868 \change_deleted 564990737 1672345729
3869
3870 \end_layout
3871
3872 \begin_layout Fact
3873
3874 \change_deleted 564990737 1672345638
3875 Used in a way similar to Proposition,
3876  though perhaps lower on the scale.
3877 \change_inserted 564990737 1672345720
3878
3879 \end_layout
3880
3881 \begin_layout Assumption*
3882
3883 \change_inserted 564990737 1672345721
3884 Assumption
3885 \end_layout
3886
3887 \begin_layout Question*
3888
3889 \change_inserted 564990737 1672345721
3890 Question
3891 \end_layout
3892
3893 \begin_layout Standard
3894
3895 \change_inserted 564990737 1672345721
3896 There are ten more Maths modules available including several offering options ordered on
3897 \family sans
3898 (Numbered by Type \SpecialChar ldots
3899 )
3900 \family default
3901 .
3902 \change_unchanged
3903
3904 \end_layout
3905
3906 \begin_layout Standard
3907 In addition,
3908  the AMS classes automatically provide the AMS \SpecialChar LaTeX
3909  and AMS fonts packages.
3910  They need to be available on your system in order to use these environments.
3911 \end_layout
3912
3913 \begin_layout Subsection
3914
3915 \change_inserted 564990737 1671383236
3916 \begin_inset CommandInset label
3917 LatexCommand label
3918 name "subsec:Extra-font-sizes"
3919
3920 \end_inset
3921
3922 Extra font sizes
3923 \end_layout
3924
3925 \begin_layout Standard
3926
3927 \change_inserted 564990737 1671383236
3928 The “Extra font sizes” collection provides the document classes
3929 \family sans
3930 article
3931 \begin_inset space \thinspace{}
3932 \end_inset
3933
3934 (with extra font sizes)
3935 \family default
3936 ,
3937
3938 \family sans
3939 book
3940 \begin_inset space \thinspace{}
3941 \end_inset
3942
3943 (with extra font sizes)
3944 \family default
3945 ,
3946
3947 \family sans
3948 letter
3949 \begin_inset space \thinspace{}
3950 \end_inset
3951
3952 (with extra font sizes)
3953 \family default
3954  and
3955 \family sans
3956 report
3957 \begin_inset space \thinspace{}
3958 \end_inset
3959
3960 (with extra font sizes)
3961 \family default
3962  which use the
3963 \family typewriter
3964 article.cls
3965 \family default
3966 ,
3967
3968 \family typewriter
3969 book.cls
3970 \family default
3971 ,
3972
3973 \family typewriter
3974 letter.cls
3975 \family default
3976  and
3977 \family typewriter
3978 report.cls
3979 \family default
3980  document classes respectively but offer the additional
3981 \family sans
3982 \bar under
3983 B
3984 \bar default
3985 ase
3986 \begin_inset space ~
3987 \end_inset
3988
3989 Size
3990 \family default
3991  options 8,
3992  9,
3993  14,
3994  17 and 20 in the
3995 \family sans
3996 \bar under
3997 D
3998 \bar default
3999 ocument\SpecialChar menuseparator
4000
4001 \bar under
4002 S
4003 \bar default
4004 ettings\SpecialChar menuseparator
4005 Fonts
4006 \family default
4007  dialog.
4008 \end_layout
4009
4010 \begin_layout Subsection
4011
4012 \change_inserted 564990737 1671383236
4013 Hebrew
4014 \end_layout
4015
4016 \begin_layout Standard
4017
4018 \change_inserted 564990737 1671383236
4019 The document classes
4020 \family sans
4021 article
4022 \begin_inset space \thinspace{}
4023 \end_inset
4024
4025 (Hebrew)
4026 \family default
4027  and
4028 \family sans
4029 letter
4030 \begin_inset space \thinspace{}
4031 \end_inset
4032
4033 (Hebrew)
4034 \family default
4035  use the
4036 \family typewriter
4037 article.cl
4038 \family sans
4039 s
4040 \family default
4041  and
4042 \family typewriter
4043 letter.cls
4044 \family default
4045  document classes to facilitate the use of Hebrew in \SpecialChar LyX
4046 .
4047 \end_layout
4048
4049 \begin_layout Subsection
4050
4051 \change_inserted 564990737 1671383236
4052 \begin_inset CommandInset label
4053 LatexCommand label
4054 name "subsec:Japanese"
4055
4056 \end_inset
4057
4058 Japanese
4059 \end_layout
4060
4061 \begin_layout Standard
4062
4063 \change_inserted 564990737 1671383236
4064 The document classes
4065 \change_inserted -712698321 1673089024
4066
4067 \family sans
4068 Japanese
4069 \change_deleted -712698321 1673089025
4070 a
4071 \change_inserted -712698321 1673089025
4072 A
4073 \change_inserted 564990737 1671383236
4074 rticle
4075 \begin_inset space \thinspace{}
4076 \end_inset
4077
4078 (
4079 \change_deleted -712698321 1673089027
4080 Japanese
4081 \change_inserted 564990737 1671383236
4082 JS Class)
4083 \family default
4084 ,
4085
4086 \family sans
4087
4088 \change_deleted -712698321 1673089041
4089 article
4090 \change_inserted -712698321 1673089041
4091 Japanese Article
4092 \change_inserted 564990737 1671383236
4093
4094 \begin_inset space \thinspace{}
4095 \end_inset
4096
4097 (
4098 \change_deleted -712698321 1673089044
4099 Japanese
4100 \change_inserted 564990737 1671383236
4101 Standard Class Vertical Writing)
4102 \family default
4103 ,
4104
4105 \change_deleted -712698321 1673089041
4106
4107 \family sans
4108 article
4109 \begin_inset space \thinspace{}
4110 \end_inset
4111
4112 (Japanese Standard Class)
4113 \change_inserted -712698321 1673088992
4114 Japanese Article (Standard Class)
4115 \change_inserted 564990737 1671383236
4116
4117 \family default
4118 ,
4119
4120 \change_inserted -712698321 1673089053
4121
4122 \family sans
4123 Japanese
4124 \change_deleted -712698321 1673089053
4125 b
4126 \change_inserted -712698321 1673089064
4127 B
4128 \change_inserted 564990737 1671383236
4129 ook
4130 \begin_inset space \thinspace{}
4131 \end_inset
4132
4133 (
4134 \change_deleted -712698321 1673089067
4135 Japanese
4136 \change_inserted 564990737 1671383236
4137 JS Class)
4138 \family default
4139 ,
4140
4141 \family sans
4142
4143 \change_inserted -712698321 1673089073
4144 Japanese B
4145 \change_deleted -712698321 1673089270
4146 b
4147 \change_inserted 564990737 1671383236
4148 ook
4149 \begin_inset space \thinspace{}
4150 \end_inset
4151
4152 (
4153 \change_deleted -712698321 1673089077
4154 Japanese
4155 \change_inserted 564990737 1671383236
4156 Standard Class Vertical Writing)
4157 \family default
4158 ,
4159
4160 \change_deleted -712698321 1673089083
4161
4162 \family sans
4163 b
4164 \change_inserted -712698321 1673089083
4165 Japanese B
4166 \change_inserted 564990737 1671383236
4167 ook
4168 \begin_inset space \thinspace{}
4169 \end_inset
4170
4171 (
4172 \change_deleted -712698321 1673089087
4173 Japanese
4174 \change_inserted 564990737 1671383236
4175 Standard Class)
4176 \family default
4177 ,
4178
4179 \change_inserted -712698321 1673089094
4180
4181 \family sans
4182 Japanese
4183 \change_deleted -712698321 1673089094
4184 r
4185 \change_inserted -712698321 1673089094
4186 R
4187 \change_inserted 564990737 1671383236
4188 eport
4189 \begin_inset space \thinspace{}
4190 \end_inset
4191
4192 (
4193 \change_deleted -712698321 1673089097
4194 Japanese
4195 \change_inserted 564990737 1671383236
4196 Vertical Writing)
4197 \family default
4198  and
4199 \change_deleted -712698321 1673089104
4200
4201 \family sans
4202 r
4203 \change_inserted -712698321 1673089104
4204 Japanese R
4205 \change_inserted 564990737 1671383236
4206 eport
4207 \begin_inset space \thinspace{}
4208 \end_inset
4209
4210 (
4211 \change_deleted -712698321 1673089107
4212 Japanese
4213 \change_inserted 564990737 1671383236
4214 Standard Class)
4215 \family default
4216  provide document classes for the Japanese language.
4217 \end_layout
4218
4219 \begin_layout Subsection
4220
4221 \change_inserted 564990737 1672429136
4222 \begin_inset CommandInset label
4223 LatexCommand label
4224 name "subsec:KOMA-Script"
4225
4226 \end_inset
4227
4228 KOMA-Script
4229 \end_layout
4230
4231 \begin_layout Standard
4232
4233 \change_inserted 564990737 1672429136
4234 Original by
4235 \noun on
4236 Bernd Rellermeyer
4237 \noun default
4238 ;
4239  updated by
4240 \noun on
4241 Jürgen Spitzmüller
4242 \noun default
4243  and the \SpecialChar LyX
4244  Team
4245 \change_deleted 564990737 1672429136
4246 Koma-Script
4247 \end_layout
4248
4249 \begin_layout Standard
4250
4251 \change_deleted 564990737 1672429136
4252 by
4253 \noun on
4254 Bernd Rellermeyer
4255 \change_unchanged
4256
4257 \end_layout
4258
4259 \begin_layout Subsubsection
4260 Overview
4261 \change_inserted 564990737 1672429161
4262
4263 \end_layout
4264
4265 \begin_layout Standard
4266
4267 \change_inserted 564990737 1672429162
4268 The KOMA-Script collection of document classes is a development of the Script classes created by Frank Neukam in the early 1990s;
4269  it was formally launched with the addition of a letter class in 1994.
4270  Since then,
4271  a second letter class has been added.
4272  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.
4273
4274 \change_unchanged
4275
4276 \end_layout
4277
4278 \begin_layout Standard
4279 The \SpecialChar LyX
4280  document classes
4281 \change_deleted -712698321 1673089779
4282
4283 \emph on
4284 article (koma-script)
4285 \change_inserted -712698321 1673089784
4286 KOMA-Script Article
4287 \change_unchanged
4288
4289 \emph default
4290 ,
4291
4292 \change_deleted -712698321 1673089790
4293
4294 \emph on
4295 report (koma-script)
4296 \change_inserted -712698321 1673089794
4297 KOMA-Script Report
4298 \change_unchanged
4299
4300 \emph default
4301 ,
4302
4303 \change_deleted -712698321 1673089790
4304
4305 \emph on
4306 book
4307 \emph default
4308
4309 \emph on
4310 (koma-script)
4311 \change_inserted -712698321 1673089771
4312 KOMA-Script Book
4313 \change_unchanged
4314
4315 \emph default
4316 ,
4317  and
4318 \change_inserted -712698321 1673089799
4319
4320 \emph on
4321 KOMA-Script
4322 \change_deleted -712698321 1673089802
4323 l
4324 \change_inserted -712698321 1673089802
4325 L
4326 \change_unchanged
4327 etter
4328 \change_deleted -712698321 1673089811
4329
4330 \emph default
4331
4332 \emph on
4333 (koma-script)
4334 \change_unchanged
4335
4336 \emph default
4337  correspond to the \SpecialChar LaTeX
4338  document classes
4339 \family typewriter
4340 scrartcl.cls
4341 \family default
4342 ,
4343
4344 \family typewriter
4345 scrreprt.cls
4346 \family default
4347 ,
4348
4349 \family typewriter
4350 scrbook.cls
4351 \family default
4352 ,
4353  and
4354 \family typewriter
4355 scrlettr.cls
4356 \family default
4357 ,
4358  resp.
4359 \begin_inset space ~
4360 \end_inset
4361
4362 of the Koma-Script family.
4363  They are replacements for the standard document classes
4364 \family typewriter
4365 article.cls
4366 \family default
4367 ,
4368
4369 \family typewriter
4370 report.cls
4371 \family default
4372 ,
4373
4374 \family typewriter
4375 book.cls
4376 \family default
4377  and
4378 \family typewriter
4379 letter.cls
4380 \family default
4381 ,
4382  resp.,
4383  and fit better to European typography conventions in a number of points.
4384 \end_layout
4385
4386 \begin_layout Itemize
4387
4388 \change_deleted 564990737 1672429262
4389 Standard character size is
4390 \change_inserted 564990737 1672429263
4391 The base character sizes when you select a KOMA-Script class are
4392 \change_unchanged
4393  11pt in
4394 \change_deleted -712698321 1673089877
4395
4396 \emph on
4397 article (koma-script)
4398 \change_inserted -712698321 1673089877
4399 KOMA-Script Article
4400 \change_unchanged
4401
4402 \emph default
4403 ,
4404
4405 \change_deleted -712698321 1673089886
4406
4407 \emph on
4408 report (koma-script)
4409 \change_inserted -712698321 1673089886
4410 KOMA-Script Report
4411 \change_unchanged
4412
4413 \emph default
4414 ,
4415  and
4416 \change_deleted -712698321 1673089893
4417
4418 \emph on
4419 book (koma-script)
4420 \change_inserted -712698321 1673089893
4421 KOMA-Script Book
4422 \change_deleted 564990737 1672429267
4423
4424 \emph default
4425 ,
4426
4427 \change_unchanged
4428  and 12pt in
4429 \change_deleted -712698321 1673089903
4430
4431 \emph on
4432 letter (koma-script)
4433 \change_inserted -712698321 1673089903
4434 KOMA-Script Letter
4435 \change_unchanged
4436
4437 \emph default
4438 .
4439 \end_layout
4440
4441 \begin_layout Itemize
4442 Headings,
4443  labels of the description environment,
4444  and a number of elements of the
4445 \change_deleted -712698321 1673089925
4446
4447 \emph on
4448 letter (koma-script)
4449 \change_inserted -712698321 1673089925
4450 KOMA-Script Letter
4451 \change_unchanged
4452
4453 \emph default
4454  document class are set in a bold sans serif font.
4455 \begin_inset Foot
4456 status collapsed
4457
4458 \begin_layout Plain Layout
4459 There is a big difference between the bold sans serif old cm fonts and new ec fonts,
4460  especially in the appearance of headings.
4461  In comparison,
4462  the ec bold sans serif fonts look a bit thin.
4463  Here the \SpecialChar LaTeX
4464  package
4465 \family typewriter
4466 cmsd.sty by
4467 \family default
4468
4469 \shape smallcaps
4470 Walter Schmidt
4471 \shape default
4472  helps to produce the
4473 \begin_inset Quotes eld
4474 \end_inset
4475
4476 usual
4477 \begin_inset Quotes erd
4478 \end_inset
4479
4480  appearance when using the ec fonts.
4481 \end_layout
4482
4483 \end_inset
4484
4485  The numbering of chapter headings is made in the same way as the numbering of section headings,
4486  that is without the extra line
4487 \begin_inset Quotes eld
4488 \end_inset
4489
4490 Chapter\SpecialChar ldots
4491
4492 \begin_inset Quotes erd
4493 \end_inset
4494
4495 .
4496  In addition,
4497  the appearance of the headings can be modified by using a number of options (in \SpecialChar LyX
4498  to be entered in the field
4499 \family sans
4500 Extra
4501 \begin_inset space ~
4502 \end_inset
4503
4504 Options
4505 \family default
4506  of the dialog
4507 \family sans
4508 Layout\SpecialChar menuseparator
4509 Document
4510 \family default
4511 ).
4512
4513 \end_layout
4514
4515 \begin_layout Itemize
4516
4517 \change_deleted 564990737 1672429310
4518 The main means in the Koma-Script document classes to design the type area are the options
4519 \family sans
4520 BCOR
4521 \family default
4522  and
4523 \family sans
4524 DIV
4525 \family default
4526  (in \SpecialChar LyX
4527  to be entered in the extra class options field in the dialog
4528 \family sans
4529 Document\SpecialChar menuseparator
4530 Settings
4531 \family default
4532 ).
4533  They make a clearer modification of page margins possible as do the options of the dialog
4534 \family sans
4535 Document\SpecialChar menuseparator
4536 Settings
4537 \family default
4538 .
4539
4540 \change_inserted 564990737 1672429310
4541 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.
4542  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.
4543  You can change the sizes of the margins by changing the factor by which the page is divided into strips;
4544  the default for an A4 page is 9 and increasing this factor will produce increasingly narrower strips and therefore narrower margins.
4545
4546 \end_layout
4547
4548 \begin_deeper
4549 \begin_layout Standard
4550
4551 \change_inserted 564990737 1672429310
4552 Whatever the factor,
4553  two strips are allocated to the outer and bottom margins of a two-sided document and one strip to the inner and top margins,
4554  leaving a text area occupying around half the page.
4555  Since most two-sided documents have a binding,
4556  this can make the inner margins appear too narrow;
4557  so you can apply a binding correction to the page which is deducted before the size of the strips is calculated.
4558
4559 \end_layout
4560
4561 \begin_layout Standard
4562
4563 \change_inserted 564990737 1672429310
4564 The main means in the Koma-Script document classes to design the type area are the options
4565 \family sans
4566 BCOR
4567 \family default
4568  and
4569 \family sans
4570 DIV
4571 \family default
4572  entered in
4573 \family sans
4574 Document\SpecialChar menuseparator
4575 Settings\SpecialChar menuseparator
4576 Document Class\SpecialChar menuseparator
4577 Class Options\SpecialChar menuseparator
4578 Custom
4579 \family default
4580 .
4581
4582 \end_layout
4583
4584 \begin_layout Standard
4585
4586 \change_inserted 564990737 1672429310
4587 In this document,
4588  the binding correction is 7.5mm which is added in the form
4589 \family typewriter
4590 BCOR7.5mm
4591 \family default
4592  to
4593 \family sans
4594 Class
4595 \begin_inset space ~
4596 \end_inset
4597
4598 options\SpecialChar menuseparator
4599 Cus
4600 \bar under
4601 t
4602 \bar default
4603 om
4604 \family default
4605  dialog.
4606  To change the factor to 11,
4607  for example,
4608  add the entry
4609 \family typewriter
4610 DIV=11
4611 \family default
4612  to the comma separated list of entries in the
4613 \family sans
4614 Cus
4615 \bar under
4616 t
4617 \bar default
4618 om
4619 \family default
4620
4621 \family sans
4622 Class
4623 \begin_inset space ~
4624 \end_inset
4625
4626 options
4627 \family default
4628 .
4629  If you want the default value of this factor for a page size other than A4,
4630  add the entry
4631 \family typewriter
4632 DIV=calc
4633 \family default
4634 .
4635 \end_layout
4636
4637 \begin_layout Standard
4638
4639 \change_inserted 564990737 1672429310
4640 To use the circle method of calculating the page layout,
4641  use
4642 \family typewriter
4643 DIV=classic
4644 \family default
4645  instead.
4646 \change_unchanged
4647
4648 \end_layout
4649
4650 \end_deeper
4651 \begin_layout Itemize
4652 The \SpecialChar LaTeX
4653  document classes of the Koma-Script family define a number of additional commands.
4654  Those part of it which makes sense in \SpecialChar LyX
4655  is implemented in corresponding paragraph types.
4656 \end_layout
4657
4658 \begin_layout Standard
4659 Detailed descriptions of the \SpecialChar LaTeX
4660  document classes of the Koma-Script family can be found in the Koma-Script documentation
4661 \emph on
4662 scrguide
4663 \emph default
4664  (German) and
4665 \emph on
4666 scrguien
4667 \emph default
4668  (English).
4669 \end_layout
4670
4671 \begin_layout Subsubsection
4672
4673 \change_inserted 564990737 1672429358
4674
4675 \series bold
4676 \begin_inset CommandInset label
4677 LatexCommand label
4678 name "subsec:article-(KOMA-Script),-report"
4679
4680 \end_inset
4681
4682
4683 \change_deleted -712698321 1673090826
4684
4685 \series default
4686 article (KOMA-Script)
4687 \change_inserted -712698321 1673090826
4688
4689 \emph on
4690 KOMA-Script Article
4691 \change_inserted 564990737 1672429358
4692
4693 \emph default
4694 ,
4695
4696 \change_deleted -712698321 1673090830
4697 report (KOMA-Script)
4698 \change_inserted -712698321 1673090840
4699
4700 \emph on
4701 KOMA-Script Report
4702 \change_inserted 564990737 1672429358
4703
4704 \emph default
4705 ,
4706  and
4707 \change_deleted -712698321 1673090835
4708 book (KOMA-Script)
4709 \change_inserted -712698321 1673090844
4710
4711 \emph on
4712 KOMA-Script Book
4713 \change_deleted 564990737 1672429367
4714
4715 \emph default
4716 article (koma-script),
4717  report (koma-script),
4718  and book (koma-script)
4719 \change_unchanged
4720
4721 \end_layout
4722
4723 \begin_layout Standard
4724 The document classes
4725 \change_deleted -712698321 1673090858
4726
4727 \emph on
4728 article (koma-script)
4729 \change_inserted -712698321 1673090858
4730 KOMA-Script Article
4731 \change_unchanged
4732
4733 \emph default
4734 ,
4735
4736 \change_deleted -712698321 1673090862
4737
4738 \emph on
4739 report (koma-script)
4740 \change_inserted -712698321 1673090869
4741 KOMA-Script Report
4742 \change_unchanged
4743
4744 \emph default
4745 ,
4746  and
4747 \change_deleted -712698321 1673090866
4748
4749 \emph on
4750 book
4751 \emph default
4752
4753 \emph on
4754 (koma-script)
4755 \change_inserted -712698321 1673090874
4756 KOMA-Script Book
4757 \change_unchanged
4758
4759 \emph default
4760  are implemented in the layout files
4761 \family typewriter
4762 scrartcl.layout
4763 \family default
4764 ,
4765
4766 \family typewriter
4767 scrreprt.layout
4768 \family default
4769 ,
4770  and
4771 \family typewriter
4772 scrbook.layout
4773 \family default
4774 ,
4775  resp.
4776  They contain all the paragraph types of the corresponding standard document classes
4777 \emph on
4778 article
4779 \emph default
4780 ,
4781
4782 \emph on
4783 report
4784 \emph default
4785 ,
4786  and
4787 \emph on
4788 book
4789 \emph default
4790 ,
4791  resp.,
4792  partly modified,
4793  with the exception of the \SpecialChar LyX
4794  specific
4795 \family sans
4796 List
4797 \family default
4798 -type,
4799  which is replaced by the new
4800 \family sans
4801 Labeling
4802 \family default
4803 -type having the same functionality.
4804  Beside the
4805 \family sans
4806 Labeling
4807 \family default
4808 -Type there is a number of new paragraph types added.
4809  They are
4810 \emph on
4811 not
4812 \emph default
4813  part of
4814 \emph on
4815 letter (koma-script)
4816 \emph default
4817 .
4818 \end_layout
4819
4820 \begin_layout Itemize
4821
4822 \family sans
4823 Addpart,
4824  Addchap
4825 \family default
4826 ,
4827
4828 \family sans
4829 Addsec
4830 \family default
4831 :
4832  are equivalents to
4833 \family sans
4834 Part*,
4835  Chapter*
4836 \family default
4837  and
4838 \family sans
4839 Section*
4840 \family default
4841 ,
4842  resp.,
4843  additionally inserting an entry in the table of contents.
4844
4845 \family sans
4846 Addpart
4847 \family default
4848  and
4849 \family sans
4850 Addchap
4851 \family default
4852  are not contained in
4853 \emph on
4854 article (koma-script)
4855 \emph default
4856 .
4857 \end_layout
4858
4859 \begin_layout Itemize
4860
4861 \family sans
4862 Addchap*
4863 \family default
4864 ,
4865
4866 \family sans
4867 Addsec*
4868 \family default
4869 :
4870  behave exactly as
4871 \family sans
4872 Addchap
4873 \family default
4874  and
4875 \family sans
4876 Addsec
4877 \family default
4878 ,
4879  resp.,
4880  additionally clearing running heads.
4881
4882 \family sans
4883 Addchap*
4884 \family default
4885  is not contained in
4886 \emph on
4887 article (koma-script)
4888 \emph default
4889 .
4890 \begin_inset Foot
4891 status collapsed
4892
4893 \begin_layout Plain Layout
4894 There is also an
4895 \family typewriter
4896
4897 \backslash
4898 addpart*
4899 \family default
4900  command in
4901 \emph on
4902 book (koma-script)
4903 \emph default
4904  and in
4905 \emph on
4906 report (koma-script)
4907 \emph default
4908 ,
4909  but since this is identical to
4910 \family sans
4911 Part*
4912 \family default
4913 ,
4914  is has not been implemented in \SpecialChar LyX
4915 .
4916 \end_layout
4917
4918 \end_inset
4919
4920
4921 \end_layout
4922
4923 \begin_layout Itemize
4924
4925 \family sans
4926 Minisec
4927 \family default
4928 :
4929  generates a heading directly above the following paragraph in the standard character size without affecting the structure of the document.
4930 \end_layout
4931
4932 \begin_layout Itemize
4933
4934 \family sans
4935 Captionabove
4936 \family default
4937  and
4938 \family sans
4939 Captionbelow
4940 \family default
4941  are special captions which respect the different space settings needed for captions placed above or below an element (if you follow strict typographic rules,
4942  you might want to place table captions always above the table).
4943  You can also use the class option
4944 \family typewriter
4945 tablecaptionsabove
4946 \family default
4947 ,
4948  which will switch
4949 \family sans
4950 caption
4951 \family default
4952  to
4953 \family sans
4954 captionabove
4955 \family default
4956  for tables and
4957 \family sans
4958 captionbelow
4959 \family default
4960  for figures.
4961  You need at least Koma-Script version 2.8q to use this.
4962 \end_layout
4963
4964 \begin_layout Itemize
4965
4966 \family sans
4967 Dictum
4968 \family default
4969 :
4970  can be used to set a bonmot,
4971  e.
4972 \begin_inset space \thinspace{}
4973 \end_inset
4974
4975 g.
4976 \begin_inset space \space{}
4977 \end_inset
4978
4979 at the beginning of a chapter.
4980  If you use the optional argument (
4981 \family sans
4982 Insert\SpecialChar menuseparator
4983 Dictum
4984 \begin_inset space ~
4985 \end_inset
4986
4987 Author
4988 \family default
4989 ),
4990  you can insert the dictum's author there.
4991  Dictum and author are separated by a line.
4992  You need at least Koma-Script version 2.8q to use this.
4993
4994 \family sans
4995 Dictum
4996 \family default
4997  is not contained in
4998 \emph on
4999 article (koma-script)
5000 \emph default
5001 .
5002 \end_layout
5003
5004 \begin_layout Standard
5005 The following types,
5006  together with the standard types
5007 \family sans
5008 Title
5009 \family default
5010 ,
5011
5012 \family sans
5013 Author
5014 \family default
5015 ,
5016  and
5017 \family sans
5018 Date
5019 \family default
5020 ,
5021  form the title area of the document.
5022  They must be entered ahead of the first
5023 \begin_inset Quotes eld
5024 \end_inset
5025
5026 ordinary
5027 \begin_inset Quotes erd
5028 \end_inset
5029
5030  paragraph.
5031 \begin_inset Foot
5032 status collapsed
5033
5034 \begin_layout Plain Layout
5035 The corresponding \SpecialChar LaTeX
5036  commands must appear before the
5037 \family typewriter
5038
5039 \backslash
5040 maketitle
5041 \family default
5042  command.
5043 \end_layout
5044
5045 \end_inset
5046
5047  When such a type is used more than once,
5048  the latter usage overwrites the former one,
5049  that means,
5050  for every type only the latest usage is valid.
5051  The order of the different types however has,
5052  like
5053 \family sans
5054 Title
5055 \family default
5056 ,
5057
5058 \family sans
5059 Author
5060 \family default
5061 ,
5062  and
5063 \family sans
5064 Date
5065 \family default
5066 ,
5067  no effect on the appearance of the produced document.
5068 \end_layout
5069
5070 \begin_layout Itemize
5071
5072 \family sans
5073 Subject
5074 \family default
5075 :
5076  produces a centered paragraph above the ordinary title (
5077 \family sans
5078 Title
5079 \family default
5080 ,
5081
5082 \family sans
5083 Author
5084 \family default
5085 ,
5086
5087 \family sans
5088 Date
5089 \family default
5090 ) for the subject of the document.
5091 \end_layout
5092
5093 \begin_layout Itemize
5094
5095 \family sans
5096 Publishers
5097 \family default
5098 :
5099  produces a centered paragraph below the ordinary title (
5100 \family sans
5101 Title
5102 \family default
5103 ,
5104
5105 \family sans
5106 Author
5107 \family default
5108 ,
5109
5110 \family sans
5111 Date
5112 \family default
5113 ) for the publishers' name.
5114 \end_layout
5115
5116 \begin_layout Itemize
5117
5118 \family sans
5119 Dedication
5120 \family default
5121 :
5122  in
5123 \emph on
5124 report (koma-script)
5125 \emph default
5126  and
5127 \emph on
5128 book (koma-script)
5129 \emph default
5130  produces a centered paragraph on its own page behind the title page,
5131  or in
5132 \emph on
5133 article (koma-script)
5134 \emph default
5135  produces a centered paragraph below the ordinary title (
5136 \family sans
5137 Title
5138 \family default
5139 ,
5140
5141 \family sans
5142 Author
5143 \family default
5144 ,
5145
5146 \family sans
5147 Date
5148 \family default
5149 ,
5150
5151 \family sans
5152 Publishers
5153 \family default
5154 ) for a dedication.
5155 \end_layout
5156
5157 \begin_layout Itemize
5158
5159 \family sans
5160 Titlehead
5161 \family default
5162 :
5163  produces a left aligned paragraph above the ordinary title (
5164 \family sans
5165 Title
5166 \family default
5167 ,
5168
5169 \family sans
5170 Author
5171 \family default
5172 ,
5173
5174 \family sans
5175 Date
5176 \family default
5177 ,
5178
5179 \family sans
5180 Subject
5181 \family default
5182 ) for a document`s head.
5183 \end_layout
5184
5185 \begin_layout Itemize
5186
5187 \family sans
5188 Uppertitleback
5189 \family default
5190 :
5191  produces in a double-sided print in
5192 \emph on
5193 report (koma-script)
5194 \emph default
5195  and
5196 \emph on
5197 book (koma-script)
5198 \emph default
5199  a left-aligned paragraph at the top of the title page`s back or has no effect in a single-sided print or in
5200 \emph on
5201 article (koma-script)
5202 \emph default
5203 .
5204 \end_layout
5205
5206 \begin_layout Itemize
5207
5208 \family sans
5209 Lowertitleback
5210 \family default
5211 :
5212  produces in a double-sided print in
5213 \emph on
5214 report (koma-script)
5215 \emph default
5216  and
5217 \emph on
5218 book (koma-script)
5219 \emph default
5220  a left-aligned paragraph at the bottom of the title page`s back or has no effect in a single-sided print or in
5221 \emph on
5222 article (koma-script)
5223 \emph default
5224 .
5225 \end_layout
5226
5227 \begin_layout Itemize
5228
5229 \family sans
5230 Extratitle
5231 \family default
5232 :
5233  produces a special
5234 \begin_inset Quotes eld
5235 \end_inset
5236
5237 dirty
5238 \begin_inset Quotes erd
5239 \end_inset
5240
5241  page ahead of the actual document containing a paragraph without special formatting.
5242 \end_layout
5243
5244 \begin_layout Standard
5245
5246 \change_inserted 564990737 1672429680
5247 KOMA-Script offers a wide range of
5248 \family sans
5249 Cus
5250 \bar under
5251 t
5252 \bar default
5253 om Class
5254 \begin_inset space ~
5255 \end_inset
5256
5257 options
5258 \family default
5259  for the
5260 \family sans
5261 \bar under
5262 D
5263 \bar default
5264 ocument\SpecialChar menuseparator
5265
5266 \bar under
5267 S
5268 \bar default
5269 ettings\SpecialChar menuseparator
5270 Document
5271 \begin_inset space ~
5272 \end_inset
5273
5274 class
5275 \family default
5276  dialog which you can apply to the whole document,
5277  among them
5278 \end_layout
5279
5280 \begin_layout Description
5281
5282 \change_inserted 564990737 1672429680
5283
5284 \family typewriter
5285 \series medium
5286 draft=true
5287 \family default
5288 \series default
5289  which produces a PDF with a small black box at the end any line in which a formatting error occurs;
5290  the default setting is
5291 \family typewriter
5292 false
5293 \end_layout
5294
5295 \begin_layout Description
5296
5297 \change_inserted 564990737 1672429680
5298
5299 \family typewriter
5300 \series medium
5301 headings=
5302 \family default
5303 \series default
5304  which may take the values
5305 \family typewriter
5306 big
5307 \family default
5308 ,
5309
5310 \family typewriter
5311 normal
5312 \family default
5313  or
5314 \family typewriter
5315 small
5316 \family default
5317 ;
5318  the first and last adjust the sizes of the headings to take account of page sizes where the default values may not be suitable
5319 \end_layout
5320
5321 \begin_layout Description
5322
5323 \change_inserted 564990737 1672429680
5324
5325 \family typewriter
5326 \series medium
5327 numbers=
5328 \family default
5329 \series default
5330  which may take the values
5331 \family typewriter
5332 auto
5333 \family default
5334  (the default),
5335
5336 \family typewriter
5337 enddot
5338 \family default
5339  or
5340 \family typewriter
5341 noenddot
5342 \family default
5343 ;
5344  the first leaves it up to KOMA-Script to add periods after chapter,
5345  section numbers,
5346  etc.;
5347  the second forces the addition of periods and third suppresses them
5348 \end_layout
5349
5350 \begin_layout Standard
5351
5352 \change_inserted 564990737 1672429680
5353 and the math options:
5354 \end_layout
5355
5356 \begin_layout Description
5357
5358 \change_inserted 564990737 1672429680
5359
5360 \family typewriter
5361 \series medium
5362 leqno
5363 \family default
5364 \series default
5365  which causes equations to be numbered on the left rather than on the right,
5366  and
5367 \end_layout
5368
5369 \begin_layout Description
5370
5371 \change_inserted 564990737 1672429680
5372
5373 \family typewriter
5374 \series medium
5375 fleqn
5376 \family default
5377 \series default
5378  which causes equations to be left justified rather than centered.
5379 \end_layout
5380
5381 \begin_layout Standard
5382
5383 \change_inserted 564990737 1672429680
5384 It also provides commands to affect the output of the document independently of the standard \SpecialChar LaTeX
5385  commands and packages;
5386  for example,
5387  if you want your captions in bold add
5388 \end_layout
5389
5390 \begin_layout Standard
5391
5392 \change_inserted 564990737 1672429680
5393
5394 \family typewriter
5395
5396 \backslash
5397 setkomafont{captionlabel}{
5398 \backslash
5399 bfseries}
5400 \end_layout
5401
5402 \begin_layout Standard
5403
5404 \change_inserted 564990737 1672429680
5405 to
5406 \family sans
5407 \bar under
5408 D
5409 \bar default
5410 ocument\SpecialChar menuseparator
5411
5412 \bar under
5413 S
5414 \bar default
5415 ettings
5416 \family default
5417 \SpecialChar menuseparator
5418
5419 \family sans
5420 \SpecialChar LaTeX
5421
5422 \begin_inset space ~
5423 \end_inset
5424
5425 Preamble
5426 \family default
5427 ) and the problem is solved.
5428 \end_layout
5429
5430 \begin_layout Standard
5431
5432 \change_inserted 564990737 1672429680
5433 If you are writing a book,
5434  it is normal to have the preliminary pages numbered in Roman numerals and the Chapters in this part unnumbered.
5435  If you use the Chapter* environment,
5436  your Foreword and Preface will not appear in the Table of Contents;
5437  to make them to appear in the Table of contents,
5438  you need to use Chapter environments and add the \SpecialChar TeX
5439  code
5440 \end_layout
5441
5442 \begin_layout Standard
5443
5444 \change_inserted 564990737 1672429680
5445
5446 \family typewriter
5447
5448 \backslash
5449 frontmatter
5450 \end_layout
5451
5452 \begin_layout Standard
5453
5454 \change_inserted 564990737 1672429680
5455 at the very start of the book (not in the \SpecialChar LaTeX
5456  Preamble) and
5457 \end_layout
5458
5459 \begin_layout Standard
5460
5461 \change_inserted 564990737 1672429680
5462
5463 \family typewriter
5464
5465 \backslash
5466 mainmatter
5467 \end_layout
5468
5469 \begin_layout Standard
5470
5471 \change_inserted 564990737 1672429680
5472 before the first chapter of the body of the text.
5473
5474 \change_inserted -712698321 1673092640
5475 Alternatively,
5476  you might also use
5477 \family sans
5478 Chapter* (TOC)
5479 \family default
5480 .
5481 \end_layout
5482
5483 \begin_layout Standard
5484
5485 \change_inserted 564990737 1672429680
5486 You may also want to have some unnumbered Chapter environments at the end of the book after the Appendices,
5487  if any.
5488 \begin_inset Foot
5489 status open
5490
5491 \begin_layout Plain Layout
5492
5493 \change_inserted 564990737 1672429680
5494 Appendices are normally “numbered” with letters.
5495 \end_layout
5496
5497 \end_inset
5498
5499  If you use the Chapter* environment,
5500  they will not appear in the Table of Contents;
5501  so add the \SpecialChar TeX
5502  code
5503 \end_layout
5504
5505 \begin_layout Standard
5506
5507 \change_inserted 564990737 1672429680
5508
5509 \family typewriter
5510
5511 \backslash
5512 backmatter
5513 \end_layout
5514
5515 \begin_layout Standard
5516
5517 \change_inserted 564990737 1672429682
5518 before the first of these headings and use the Chapter environment.
5519  These commands will have no effect on the numbering in \SpecialChar LyX
5520 ,
5521  only on the PDF output where the headings will be unnumbered and appear in the Table of Contents.
5522 \end_layout
5523
5524 \begin_layout Standard
5525 The layout files for the document classes
5526 \emph on
5527 article (koma-script)
5528 \emph default
5529 ,
5530
5531 \emph on
5532 report (koma-script)
5533 \emph default
5534 ,
5535  and
5536 \emph on
5537 book (koma-script)
5538 \emph default
5539  do include the file
5540 \family typewriter
5541 scrmacros.inc
5542 \family default
5543 .
5544  This is thought of as a place to define your own types.
5545  Copy scrmacros
5546 \family typewriter
5547 .inc
5548 \family default
5549  in your personal layout directory and edit the file!
5550 \change_deleted 564990737 1672430255
5551
5552 \end_layout
5553
5554 \begin_layout Standard
5555
5556 \change_deleted 564990737 1672430255
5557 letter (koma-script)
5558 \end_layout
5559
5560 \begin_layout Description
5561
5562 \change_deleted 564990737 1672429749
5563 Note:
5564  This section discusses the obsolete
5565 \family sans
5566 KOMA-Script-Letter (v.
5567 \begin_inset space ~
5568 \end_inset
5569
5570 1)
5571 \family default
5572 ,
5573  which is not even included anymore in recent KOMA releases.
5574  Please refer to the next section for the current KOMA-Script-Letter class (v.
5575 \begin_inset space ~
5576 \end_inset
5577
5578 2)!
5579 \end_layout
5580
5581 \begin_layout Standard
5582 \noindent
5583
5584 \change_deleted 564990737 1672429749
5585 The document class
5586 \emph on
5587 letter (koma-script)
5588 \emph default
5589  is implemented in the layout file
5590 \family typewriter
5591 scrlettr.layout
5592 \family default
5593 .
5594  It contains all the paragraph types of the corresponding standard document class
5595 \emph on
5596 letter
5597 \emph default
5598 ,
5599  partly modified,
5600  with the exception of the \SpecialChar LyX
5601  specific types
5602 \family sans
5603 \SpecialChar LyX
5604 -Code
5605 \family default
5606  and
5607 \family sans
5608 Comment
5609 \family default
5610  and the
5611 \family sans
5612 List
5613 \family default
5614  type,
5615  which is replaced by the new
5616 \family sans
5617 Labeling
5618 \family default
5619  type.
5620  In addition,
5621  it contains,
5622  in contrast to the standard document class,
5623  the standard types
5624 \family sans
5625 \SpecialChar LaTeX
5626
5627 \family default
5628 ,
5629
5630 \family sans
5631 Quotation
5632 \family default
5633 ,
5634
5635 \family sans
5636 Quote
5637 \family default
5638 ,
5639  and
5640 \family sans
5641 Verse
5642 \family default
5643 .
5644  Furthermore,
5645  there are a number of new letter specific types.
5646 \end_layout
5647
5648 \begin_layout Standard
5649
5650 \change_deleted 564990737 1672429749
5651 The appearance of the letter produced by this document class can be controlled by a number of \SpecialChar LaTeX
5652  commands,
5653  which you can put in the \SpecialChar LaTeX
5654  preamble.
5655 \begin_inset Foot
5656 status collapsed
5657
5658 \begin_layout Plain Layout
5659 For example,
5660  the standard appearance of the letter`s heading,
5661  consisting of name and address,
5662  is quite self-willed.
5663  An
5664 \begin_inset Quotes eld
5665 \end_inset
5666
5667 ordinary
5668 \begin_inset Quotes erd
5669 \end_inset
5670
5671  heading is produced by the following \SpecialChar LaTeX
5672  commands in the preamble:
5673 \end_layout
5674
5675 \begin_layout LyX-Code
5676
5677 \backslash
5678 firsthead{
5679 \backslash
5680 parbox[b]{
5681 \backslash
5682 textwidth}
5683 \end_layout
5684
5685 \begin_layout LyX-Code
5686   {
5687 \backslash
5688 ignorespaces
5689 \backslash
5690 fromname
5691 \backslash
5692
5693 \backslash
5694
5695 \backslash
5696 ignorespaces
5697 \backslash
5698 fromaddress}}
5699 \end_layout
5700
5701 \begin_layout LyX-Code
5702
5703 \backslash
5704 nexthead{
5705 \backslash
5706 parbox[b]{
5707 \backslash
5708 textwidth}
5709 \end_layout
5710
5711 \begin_layout LyX-Code
5712   {
5713 \backslash
5714 ignorespaces
5715 \backslash
5716 fromname
5717 \backslash
5718 hfill
5719 \backslash
5720 ignorespaces
5721 \backslash
5722 pagename
5723 \backslash
5724
5725 \backslash
5726 thepage}}
5727 \end_layout
5728
5729 \end_inset
5730
5731  A detailed German description of such \SpecialChar LaTeX
5732  commands can be found in the Koma-Script documentation
5733 \emph on
5734 scrguide
5735 \emph default
5736 .
5737  With it,
5738  the letter's author can produce his personal letter layout.
5739 \end_layout
5740
5741 \begin_layout Standard
5742
5743 \change_deleted 564990737 1672429749
5744 The types
5745 \family sans
5746 Letter
5747 \family default
5748  and
5749 \family sans
5750 Opening
5751 \family default
5752  define the beginning of the letter and must be used in every letter.
5753  To emphasize them in the \SpecialChar LyX
5754  document class,
5755  they are marked with the letter
5756 \shape italic
5757 L
5758 \shape default
5759  or
5760 \shape italic
5761 O
5762 \shape default
5763 ,
5764  resp.
5765 \begin_inset space ~
5766 \end_inset
5767
5768 in the left margin.
5769  It is possible to write any number of letters in one file.
5770  An
5771 \family sans
5772 Opening
5773 \family default
5774  type produces a new letter using the same addressee and a
5775 \family sans
5776 Letter
5777 \family default
5778  type produces a new addressee.
5779  The types
5780 \family sans
5781 Closing
5782 \family default
5783 ,
5784
5785 \family sans
5786 PS
5787 \family default
5788 ,
5789
5790 \family sans
5791 CC
5792 \family default
5793 ,
5794  and
5795 \family sans
5796 Encl
5797 \family default
5798  are ordinary paragraph types and can also be used several times in one and the same letter.
5799 \end_layout
5800
5801 \begin_layout Itemize
5802
5803 \change_deleted 564990737 1672429749
5804
5805 \family sans
5806 Letter
5807 \family default
5808 :
5809  produces a paragraph for the addressee and implicitly defines the beginning of the letter.
5810 \end_layout
5811
5812 \begin_layout Itemize
5813
5814 \change_deleted 564990737 1672429749
5815
5816 \family sans
5817 Opening
5818 \family default
5819 :
5820  produces a paragraph for the form of address and implicitly produces a new letter.
5821 \end_layout
5822
5823 \begin_layout Itemize
5824
5825 \change_deleted 564990737 1672429749
5826
5827 \family sans
5828 Closing
5829 \family default
5830 :
5831  produces a paragraph for a close.
5832 \end_layout
5833
5834 \begin_layout Itemize
5835
5836 \change_deleted 564990737 1672429749
5837
5838 \family sans
5839 PS
5840 \family default
5841 :
5842  produces a paragraph for a postscript.
5843 \end_layout
5844
5845 \begin_layout Itemize
5846
5847 \change_deleted 564990737 1672429749
5848
5849 \family sans
5850 CC
5851 \family default
5852 :
5853  produces a paragraph for a distribution list.
5854 \end_layout
5855
5856 \begin_layout Itemize
5857
5858 \change_deleted 564990737 1672429749
5859
5860 \family sans
5861 Encl
5862 \family default
5863 :
5864  produces a paragraph for enclosures.
5865 \end_layout
5866
5867 \begin_layout Standard
5868
5869 \change_deleted 564990737 1672429749
5870 The types
5871 \family sans
5872 Name
5873 \family default
5874 ,
5875
5876 \family sans
5877 Signature
5878 \family default
5879 ,
5880
5881 \family sans
5882 Address
5883 \family default
5884 ,
5885
5886 \family sans
5887 Telephone
5888 \family default
5889 ,
5890
5891 \family sans
5892 Place
5893 \family default
5894 ,
5895
5896 \family sans
5897 Backaddress
5898 \family default
5899 ,
5900
5901 \family sans
5902 Specialmail
5903 \family default
5904 ,
5905
5906 \family sans
5907 Location
5908 \family default
5909 ,
5910
5911 \family sans
5912 Title
5913 \family default
5914 ,
5915  and
5916 \family sans
5917 Subject
5918 \family default
5919  are input types provided with a label to enter information,
5920  which will be processed by the document class.
5921 \begin_inset Foot
5922 status collapsed
5923
5924 \begin_layout Plain Layout
5925 It could be seen as a matter of inconsequence,
5926  that the types
5927 \family sans
5928 Letter
5929 \family default
5930  and
5931 \family sans
5932 Opening
5933 \family default
5934  described above are not such input types as well.
5935  Because of the special meaning of those types,
5936  however,
5937  I have implemented them as ordinary paragraph types with a one letter mark in the left margin.
5938  Moreover,
5939  it would affect my feeling of symmetry,
5940  if the
5941 \family sans
5942 Opening
5943 \family default
5944  type and the
5945 \family sans
5946 Closing
5947 \family default
5948  type had such a serious different appearance.
5949 \end_layout
5950
5951 \end_inset
5952
5953  The types must be used ahead of the corresponding
5954 \family sans
5955 Opening
5956 \family default
5957  type.
5958 \end_layout
5959
5960 \begin_layout Standard
5961
5962 \change_deleted 564990737 1672429749
5963 An implementation of these types in a WYSIWYG fashion does not seem to make sense,
5964  because the real appearance of the produced letter does not only depend on the usage of the particular type,
5965  but also on other factors.
5966  For example,
5967  a signature entered in the
5968 \family sans
5969 Signature
5970 \family default
5971  type will in the standard behavior appear in the produced letter only,
5972  when in the same letter also a
5973 \family sans
5974 Closing
5975 \family default
5976  type is used.
5977  The entered value of the
5978 \family sans
5979 Telephone
5980 \family default
5981  type will in the standard behavior not appear in the produced letter at all.
5982  The possibility to design the letter`s heading freely is already indicated in a footnote above.
5983 \end_layout
5984
5985 \begin_layout Standard
5986
5987 \change_deleted 564990737 1672429749
5988 The input types can also be used as empty paragraphs.
5989  This makes sense e.
5990 \begin_inset space \thinspace{}
5991 \end_inset
5992
5993 g.
5994 \begin_inset space \space{}
5995 \end_inset
5996
5997 for the
5998 \family sans
5999 Signature
6000 \family default
6001  type.
6002  If the
6003 \family sans
6004 Signature
6005 \family default
6006  type is not used at all,
6007  in the standard behavior the value of the
6008 \family sans
6009 Name
6010 \family default
6011  type is used as signature,
6012  whereas if an empty
6013 \family sans
6014 Signature
6015 \family default
6016  type is used,
6017  no signature value is defined.
6018 \end_layout
6019
6020 \begin_layout Standard
6021
6022 \change_deleted 564990737 1672429749
6023 By using the input types it is possible to write a letter template,
6024  containing filled input types with your personal dates (name,
6025  address,
6026  etc.) and empty input types for other dates you want to enter.
6027 \end_layout
6028
6029 \begin_layout Itemize
6030
6031 \change_deleted 564990737 1672429749
6032
6033 \family sans
6034 Name
6035 \family default
6036 :
6037  sender's name,
6038  in the standard behavior appears as a centered paragraph in small caps in the letter`s heading.
6039 \end_layout
6040
6041 \begin_layout Itemize
6042
6043 \change_deleted 564990737 1672429749
6044
6045 \family sans
6046 Signature
6047 \family default
6048 :
6049  sender's signature,
6050  in the standard behavior appears below the
6051 \family sans
6052 Closing
6053 \family default
6054  type.
6055  If no
6056 \family sans
6057 Signature
6058 \family default
6059  type is used,
6060  the value of the
6061 \family sans
6062 Name
6063 \family default
6064  type appears instead.
6065 \end_layout
6066
6067 \begin_layout Itemize
6068
6069 \change_deleted 564990737 1672429749
6070
6071 \family sans
6072 Address
6073 \family default
6074 :
6075  sender's address,
6076  in the standard behavior appears in a centered paragraph in the letter`s heading below the sender's name.
6077 \end_layout
6078
6079 \begin_layout Itemize
6080
6081 \change_deleted 564990737 1672429749
6082
6083 \family sans
6084 Telephone
6085 \family default
6086 :
6087  sender's telephone number,
6088  in the standard behavior only sets the \SpecialChar LaTeX
6089  variable
6090 \family typewriter
6091
6092 \backslash
6093 telephonenum
6094 \family default
6095 .
6096 \end_layout
6097
6098 \begin_layout Itemize
6099
6100 \change_deleted 564990737 1672429749
6101
6102 \family sans
6103 Place
6104 \family default
6105 :
6106  place of the letter`s making.
6107 \end_layout
6108
6109 \begin_layout Itemize
6110
6111 \change_deleted 564990737 1672429749
6112
6113 \family sans
6114 Date
6115 \family default
6116 :
6117  date of the letter`s making.
6118
6119 \family sans
6120 Place
6121 \family default
6122  and
6123 \family sans
6124 Date
6125 \family default
6126 ,
6127  in the standard behavior,
6128  produce the place and the date in a right-aligned line below the addressee's field.
6129  If an empty
6130 \family sans
6131 Date
6132 \family default
6133  type is used,
6134  neither place nor date appear,
6135  independent of the value of the
6136 \family sans
6137 Place
6138 \family default
6139  type.
6140  If no
6141 \family sans
6142 Date
6143 \family default
6144  type is used,
6145  the date of the letter `s production is used.
6146 \end_layout
6147
6148 \begin_layout Itemize
6149
6150 \change_deleted 564990737 1672429749
6151
6152 \family sans
6153 Backaddress
6154 \family default
6155 :
6156  sender`s back address,
6157  in the standard behavior appears above the addressee's field in a small sans serif font.
6158 \end_layout
6159
6160 \begin_layout Itemize
6161
6162 \change_deleted 564990737 1672429749
6163
6164 \family sans
6165 Specialmail
6166 \family default
6167 :
6168  special mail information,
6169  in the standard behavior appears underlined above the addressee's field below the back address.
6170 \end_layout
6171
6172 \begin_layout Itemize
6173
6174 \change_deleted 564990737 1672429749
6175
6176 \family sans
6177 Location
6178 \family default
6179 :
6180  additional information,
6181  in the standard behavior appears on right side below the addressee`s field.
6182 \end_layout
6183
6184 \begin_layout Itemize
6185
6186 \change_deleted 564990737 1672429749
6187
6188 \family sans
6189 Title
6190 \family default
6191 :
6192  the letter's title,
6193  in the standard behavior appears in a big,
6194  bold,
6195  sans serif font above the subject.
6196 \end_layout
6197
6198 \begin_layout Itemize
6199
6200 \change_deleted 564990737 1672429749
6201
6202 \family sans
6203 Subject
6204 \family default
6205 :
6206  the letter's subject,
6207  in the standard behavior appears in a bold font above the
6208 \family sans
6209 Opening
6210 \family default
6211  paragraph.
6212 \end_layout
6213
6214 \begin_layout Standard
6215
6216 \change_deleted 564990737 1672429749
6217 The types
6218 \family sans
6219 Yourref
6220 \family default
6221 ,
6222
6223 \family sans
6224 Yourmail
6225 \family default
6226 ,
6227
6228 \family sans
6229 Myref
6230 \family default
6231 ,
6232
6233 \family sans
6234 Customer
6235 \family default
6236 ,
6237  and
6238 \family sans
6239 Invoice
6240 \family default
6241  produce a business letter like line above the
6242 \family sans
6243 Title
6244 \family default
6245  line containing the fields
6246 \begin_inset Quotes eld
6247 \end_inset
6248
6249 Your ref.
6250 \begin_inset Quotes erd
6251 \end_inset
6252
6253 ,
6254
6255 \begin_inset Quotes eld
6256 \end_inset
6257
6258 Your letter of
6259 \begin_inset Quotes erd
6260 \end_inset
6261
6262 ,
6263
6264 \begin_inset Quotes eld
6265 \end_inset
6266
6267 Our ref.
6268 \begin_inset Quotes erd
6269 \end_inset
6270
6271 ,
6272
6273 \begin_inset Quotes eld
6274 \end_inset
6275
6276 Customer no.
6277 \begin_inset Quotes erd
6278 \end_inset
6279
6280 ,
6281
6282 \begin_inset Quotes eld
6283 \end_inset
6284
6285 Invoice no.
6286 \begin_inset Quotes erd
6287 \end_inset
6288
6289 ,
6290  and
6291 \begin_inset Quotes eld
6292 \end_inset
6293
6294 Date
6295 \begin_inset Quotes erd
6296 \end_inset
6297
6298 .
6299  For the date field,
6300  the value of the
6301 \family sans
6302 Date
6303 \family default
6304  type is used.
6305  If one of these
6306 \begin_inset Quotes eld
6307 \end_inset
6308
6309 business letter types
6310 \begin_inset Quotes erd
6311 \end_inset
6312
6313  is used,
6314  the value of the
6315 \family sans
6316 Place
6317 \family default
6318  type however does not appear,
6319  but only the \SpecialChar LaTeX
6320  variable
6321 \family typewriter
6322
6323 \backslash
6324 fromplace
6325 \family default
6326  is set.
6327  The ordinary output of place and date in a right-aligned line below the addressee`s field is suppressed.
6328  The types are implemented as input types provided with a label and must be used ahead of the corresponding
6329 \family sans
6330 Opening
6331 \family default
6332  type.
6333 \end_layout
6334
6335 \begin_layout Itemize
6336
6337 \change_deleted 564990737 1672429749
6338
6339 \family sans
6340 Yourref
6341 \family default
6342 :
6343  Your ref.
6344 \end_layout
6345
6346 \begin_layout Itemize
6347
6348 \change_deleted 564990737 1672429749
6349
6350 \family sans
6351 Yourmail
6352 \family default
6353 :
6354  Your letter of.
6355 \end_layout
6356
6357 \begin_layout Itemize
6358
6359 \change_deleted 564990737 1672429749
6360
6361 \family sans
6362 Myref
6363 \family default
6364 :
6365  Our ref.
6366 \end_layout
6367
6368 \begin_layout Itemize
6369
6370 \change_deleted 564990737 1672429749
6371
6372 \family sans
6373 Customer
6374 \family default
6375 :
6376  Customer no.
6377 \end_layout
6378
6379 \begin_layout Itemize
6380
6381 \change_deleted 564990737 1672429749
6382
6383 \family sans
6384 Invoice
6385 \family default
6386 :
6387  Invoice no.
6388 \change_unchanged
6389
6390 \end_layout
6391
6392 \begin_layout Subsubsection
6393
6394 \change_deleted 564990737 1672429773
6395 The new letter class:
6396  letter (koma-script v.2)
6397 \change_inserted 564990737 1672429774
6398
6399 \begin_inset CommandInset label
6400 LatexCommand label
6401 name "subsec:The-new-letter"
6402
6403 \end_inset
6404
6405 The new letter class:
6406
6407 \change_inserted -712698321 1673092709
6408 KOMA-Script
6409 \change_deleted -712698321 1673092710
6410 l
6411 \change_inserted -712698321 1673092710
6412 L
6413 \change_inserted 564990737 1672429774
6414 etter (
6415 \change_deleted -712698321 1673092713
6416 KOMA-Script v
6417 \change_inserted -712698321 1673092714
6418 V
6419 \change_inserted 564990737 1672429774
6420 .
6421
6422 \change_inserted -712698321 1673092715
6423
6424 \change_inserted 564990737 1672429774
6425 2)
6426 \change_unchanged
6427
6428 \end_layout
6429
6430 \begin_layout Standard
6431 by
6432 \noun on
6433 Jürgen Spitzmüller
6434 \end_layout
6435
6436 \begin_layout Standard
6437 \begin_inset VSpace medskip
6438 \end_inset
6439
6440
6441 \end_layout
6442
6443 \begin_layout Standard
6444 \noindent
6445 Koma-Script version 2.8 has introduced a new letter class
6446 \family typewriter
6447 scrlttr2
6448 \family default
6449  which supersedes the now unsupported
6450 \family typewriter
6451 scrlettr
6452 \family default
6453 .
6454  It has —
6455  on the \SpecialChar LaTeX
6456  side —
6457  a completely new interface and is not compatible with the old class.
6458  Therefore,
6459  \SpecialChar LyX
6460  supports both,
6461  though it is recommended you use the new class.
6462 \end_layout
6463
6464 \begin_layout Standard
6465 This class covers the same functionality as
6466 \emph on
6467 letter (koma-script),
6468
6469 \emph default
6470  and a few more.
6471  The basic items are
6472 \family sans
6473 Address
6474 \family default
6475  (receiver's address,
6476  same as
6477 \family sans
6478 Letter
6479 \family default
6480  in the old layout),
6481
6482 \family sans
6483 Opening
6484 \family default
6485 ,
6486  and
6487 \family sans
6488 Closing
6489 \family default
6490 .
6491
6492 \family sans
6493 NextAddress
6494 \family default
6495  will start a new letter (i.
6496 \begin_inset space \thinspace{}
6497 \end_inset
6498
6499 e.
6500 \begin_inset space \space{}
6501 \end_inset
6502
6503 you can write several letters per document).
6504  New elements are sender's
6505 \family sans
6506 E-Mail
6507 \family default
6508 ,
6509
6510 \family sans
6511 URL
6512 \family default
6513 ,
6514
6515 \family sans
6516 Fax
6517 \family default
6518 ,
6519
6520 \family sans
6521 Bank
6522 \family default
6523  and the possibility to use a
6524 \family sans
6525 Logo
6526 \family default
6527  (via
6528 \family sans
6529 Insert\SpecialChar menuseparator
6530 Graphics
6531 \family default
6532 ) in the header.
6533 \end_layout
6534
6535 \begin_layout Standard
6536 The biggest improvement is,
6537  though,
6538  that the letter's layout is configurable to meet almost any needs.
6539  This can be done via the preamble or with a special style file (Letter Class Option,
6540  extension
6541 \family typewriter
6542 *.lco
6543 \family default
6544 ),
6545  that will be read in as a class option.
6546 \begin_inset Foot
6547 status collapsed
6548
6549 \begin_layout Plain Layout
6550 The KOMA package comes with some default
6551 \family typewriter
6552 *.lco
6553 \family default
6554  files.
6555  There is,
6556  for instance,
6557  a
6558 \family typewriter
6559 DIN.lco
6560 \family default
6561  file that follows german typesetting rules,
6562  or a
6563 \family typewriter
6564 KOMAold.lco
6565 \family default
6566  that provides the default layout of the old
6567 \family typewriter
6568 scrlettr
6569 \family default
6570  class.
6571  The latter can be loaded with the class option
6572 \family typewriter
6573 KOMAold
6574 \family default
6575 ,
6576  inserted via the
6577 \family sans
6578 Layout\SpecialChar menuseparator
6579 Document\SpecialChar menuseparator
6580 Extra Options
6581 \family default
6582  field.
6583 \end_layout
6584
6585 \end_inset
6586
6587  Have a look at the
6588 \change_deleted 564990737 1671617922
6589
6590 \emph on
6591 koma-letter2
6592 \change_unchanged
6593
6594 \emph default
6595  template
6596 \change_deleted 564990737 1671617938
6597 that is included in \SpecialChar LyX
6598  for examples
6599 \change_inserted 564990737 1671617997
6600  in
6601 \family sans
6602 \bar under
6603 F
6604 \bar default
6605 ile\SpecialChar menuseparator
6606 New
6607 \begin_inset space ~
6608 \end_inset
6609
6610 fro
6611 \bar under
6612 m
6613 \bar default
6614
6615 \begin_inset space ~
6616 \end_inset
6617
6618 Template\SpecialChar menuseparator
6619 Letters\SpecialChar menuseparator
6620 KOMA-Script Letter (V.2)
6621 \change_unchanged
6622
6623 \family default
6624 .
6625  A detailed description is to be found in the Koma-Script documentation (
6626 \emph on
6627 scrguide
6628 \emph default
6629 ).
6630 \end_layout
6631
6632 \begin_layout Subsubsection
6633 Problems
6634 \end_layout
6635
6636 \begin_layout Standard
6637 Visualizing the Koma-Script document classes in \SpecialChar LyX
6638 ,
6639  the \SpecialChar LyX
6640  internals cause some problems.
6641 \end_layout
6642
6643 \begin_layout Itemize
6644 The chapter number of a
6645 \family sans
6646 Chapter
6647 \family default
6648  type appears on a line of its own above the chapter heading instead of appearing in the same line ahead of it.
6649  The cause for that is the \SpecialChar LyX
6650  internal behavior for the labeltype
6651 \family sans
6652 Counter_Chapter
6653 \family default
6654  in the layout file.
6655 \end_layout
6656
6657 \begin_layout Itemize
6658 The headings of the types
6659 \family sans
6660 Addchap
6661 \family default
6662  and
6663 \family sans
6664 Addsec
6665 \family default
6666  are only put in the
6667 \begin_inset Quotes eld
6668 \end_inset
6669
6670 true
6671 \begin_inset Quotes erd
6672 \end_inset
6673
6674  \SpecialChar LaTeX
6675  table of contents,
6676  but not in the \SpecialChar LyX
6677  table of contents (
6678 \family sans
6679 Document\SpecialChar menuseparator
6680 Table
6681 \begin_inset space ~
6682 \end_inset
6683
6684 of
6685 \begin_inset space ~
6686 \end_inset
6687
6688 Contents
6689 \family default
6690 ).
6691 \end_layout
6692
6693 \begin_layout Itemize
6694 The paragraphs in a
6695 \emph on
6696 letter
6697 \emph default
6698  document class appear in a skip separation mode,
6699  not indented.
6700  This is the standard behavior,
6701  no special \SpecialChar LaTeX
6702  commands are needed for that.
6703  But in the
6704 \family sans
6705 Document\SpecialChar menuseparator
6706 Settings
6707 \family default
6708  dialog the corresponding radio button indicates
6709 \family sans
6710 Indent
6711 \family default
6712 .
6713  A
6714 \family sans
6715 Skip
6716 \family default
6717  value always has the effect that extra \SpecialChar LaTeX
6718  commands are inserted in the document to produce the gap,
6719  which is not what is wanted in this case.
6720 \end_layout
6721
6722 \begin_layout Subsection
6723
6724 \change_inserted 564990737 1672743555
6725 \begin_inset CommandInset label
6726 LatexCommand label
6727 name "subsec:Polish-M.W.collection"
6728
6729 \end_inset
6730
6731 Polish M.
6732 \begin_inset space \thinspace{}
6733 \end_inset
6734
6735 W.
6736 \begin_inset space \space{}
6737 \end_inset
6738
6739 collection
6740 \change_deleted 564990737 1670924933
6741 Article (mwart),
6742  book (mwbk) and report (mwrep)
6743 \begin_inset Argument status
6744 status collapsed
6745
6746 \begin_layout Plain Layout
6747 The
6748 \family typewriter
6749 mw
6750 \family default
6751  Classes
6752 \end_layout
6753
6754 \end_inset
6755
6756
6757 \change_unchanged
6758
6759 \end_layout
6760
6761 \begin_layout Standard
6762 by
6763 \noun on
6764 Tomasz Luczak
6765 \end_layout
6766
6767 \begin_layout Standard
6768 The \SpecialChar LyX
6769  document classes
6770 \change_deleted -712698321 1673094342
6771
6772 \emph on
6773 article (mwart)
6774 \change_inserted -712698321 1673094343
6775 Polish Article (MW Bundle)
6776 \change_unchanged
6777
6778 \emph default
6779 ,
6780
6781 \change_deleted -712698321 1673094349
6782
6783 \emph on
6784 report (mwrep)
6785 \change_inserted -712698321 1673094356
6786 Polish Report (MW Bundle)
6787 \change_unchanged
6788
6789 \emph default
6790  and
6791 \change_deleted -712698321 1673094352
6792
6793 \emph on
6794 book
6795 \emph default
6796
6797 \emph on
6798 (mwbk)
6799 \change_inserted -712698321 1673094359
6800 Polish Book (MW Bundle)
6801 \change_unchanged
6802
6803 \emph default
6804  correspond to the \SpecialChar LaTeX
6805  document classes
6806 \family typewriter
6807 mwart.cls
6808 \family default
6809 ,
6810
6811 \family typewriter
6812 mwrep.cls
6813 \family default
6814  and
6815 \family typewriter
6816 mwbk.cls
6817 \family default
6818 ,
6819  resp.
6820  They are replacements for the standard document classes
6821 \family typewriter
6822 article.cls
6823 \family default
6824 ,
6825
6826 \family typewriter
6827 report.cls
6828 \family default
6829  and
6830 \family typewriter
6831 book.cls
6832 \family default
6833 ,
6834  resp.,
6835  and fit better to Polish typography conventions in a number of points.
6836
6837 \end_layout
6838
6839 \begin_layout Standard
6840 Basic differences:
6841 \end_layout
6842
6843 \begin_layout Itemize
6844 Unnumbered titles (with star,
6845  e.
6846 \begin_inset space \thinspace{}
6847 \end_inset
6848
6849 g.
6850 \begin_inset space \space{}
6851 \end_inset
6852
6853
6854 \family sans
6855 Section*
6856 \family default
6857 ) are added into table of contents,
6858 \end_layout
6859
6860 \begin_layout Itemize
6861 Additional page styles:
6862 \end_layout
6863
6864 \begin_deeper
6865 \begin_layout Description
6866 uheadings header with separated lines,
6867 \end_layout
6868
6869 \begin_layout Description
6870 myheadings custom header,
6871  contents headers via commands:
6872
6873 \family typewriter
6874
6875 \backslash
6876 markright
6877 \family default
6878  and
6879 \family typewriter
6880
6881 \backslash
6882 markboth
6883 \family default
6884 ,
6885 \end_layout
6886
6887 \begin_layout Description
6888 myuheadings custom header with separated lines,
6889 \end_layout
6890
6891 \begin_layout Description
6892 outer page number is placed on outer side of page
6893 \end_layout
6894
6895 \end_deeper
6896 \begin_layout Itemize
6897 Options
6898 \end_layout
6899
6900 \begin_deeper
6901 \begin_layout Description
6902 rmheadings serif titles —
6903  default,
6904 \end_layout
6905
6906 \begin_layout Description
6907 sfheadings sansserif titles,
6908 \end_layout
6909
6910 \begin_layout Description
6911 authortitle on title page first placed is author next title —
6912  default,
6913 \end_layout
6914
6915 \begin_layout Description
6916 titleauthor on title page first placed is title next author,
6917 \end_layout
6918
6919 \begin_layout Description
6920 withmarginpar reserve place on page for margins.
6921 \end_layout
6922
6923 \end_deeper
6924 \begin_layout Subsection
6925
6926 \change_inserted 564990737 1672652245
6927 Tufte Collection
6928 \end_layout
6929
6930 \begin_layout Standard
6931
6932 \change_inserted 564990737 1672652245
6933 The document classes
6934 \change_deleted -712698321 1673094404
6935
6936 \family sans
6937 book
6938 \begin_inset space \thinspace{}
6939 \end_inset
6940
6941 (Tufte)
6942 \change_inserted -712698321 1673094404
6943 Tufte Book
6944 \change_inserted 564990737 1672652245
6945
6946 \family default
6947  and
6948 \change_deleted -712698321 1673094408
6949
6950 \family sans
6951 handout
6952 \begin_inset space \thinspace{}
6953 \end_inset
6954
6955 (Tufte)
6956 \change_inserted -712698321 1673094411
6957 Tufte Handout
6958 \change_inserted 564990737 1672652245
6959
6960 \family default
6961  use the
6962 \family typewriter
6963 tufte-book.cls
6964 \family default
6965  and
6966 \family typewriter
6967 tufte-handout.cls
6968 \family default
6969  document classes.
6970  Detailed information about these document classes can be found in
6971 \family sans
6972 File\SpecialChar menuseparator
6973 Open Example\SpecialChar menuseparator
6974 Books\SpecialChar menuseparator
6975 Tufte Book
6976 \family default
6977  and
6978 \family sans
6979 File\SpecialChar menuseparator
6980 Open Example\SpecialChar menuseparator
6981 Handouts\SpecialChar menuseparator
6982 Tufte Handout
6983 \family default
6984 .
6985 \end_layout
6986
6987 \begin_layout Section
6988
6989 \change_inserted 564990737 1670439534
6990 Articles
6991 \end_layout
6992
6993 \begin_layout Standard
6994
6995 \change_inserted 564990737 1670794710
6996 See also the document classes in the Collections (section
6997 \begin_inset space ~
6998 \end_inset
6999
7000
7001 \begin_inset CommandInset ref
7002 LatexCommand ref
7003 reference "sec:Collections"
7004 nolink "false"
7005
7006 \end_inset
7007
7008 ).
7009 \end_layout
7010
7011 \begin_layout Subsection
7012
7013 \change_deleted -712698321 1673095198
7014 A&A Paper
7015 \change_inserted -712698321 1673095198
7016 Astronomy & Astrophysics
7017 \change_inserted 564990737 1670794716
7018
7019 \end_layout
7020
7021 \begin_layout Standard
7022
7023 \change_inserted 564990737 1670794716
7024 Original by
7025 \noun on
7026 Peter Sütterlin
7027 \noun default
7028 ;
7029  updated by the \SpecialChar LyX
7030  Team
7031 \end_layout
7032
7033 \begin_layout Subsubsection
7034
7035 \change_inserted 564990737 1670794716
7036 Introduction
7037 \end_layout
7038
7039 \begin_layout Standard
7040
7041 \change_inserted 564990737 1670794716
7042 This section describes how \SpecialChar LyX
7043  can be used to write articles for submission to the scientific journal
7044 \emph on
7045 Astronomy
7046 \change_deleted -712698321 1673095254
7047 and
7048 \change_inserted -712698321 1673095254
7049 &
7050 \change_inserted 564990737 1670794716
7051  Astrophysics
7052 \emph default
7053  (
7054 \begin_inset CommandInset href
7055 LatexCommand href
7056 name "aa-package"
7057 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
7058 literal "false"
7059
7060 \end_inset
7061
7062 ) using Version 9.1 of the document class
7063 \family typewriter
7064 aa.cls
7065 \family default
7066 ;
7067  information about it is available at
7068 \begin_inset Flex URL
7069 status collapsed
7070
7071 \begin_layout Plain Layout
7072
7073 \change_inserted 564990737 1670794716
7074
7075 https://www.aanda.org/for-authors/latex-issues/texnical-background-information
7076 \change_unchanged
7077
7078 \end_layout
7079
7080 \end_inset
7081
7082 .
7083 \end_layout
7084
7085 \begin_layout Standard
7086
7087 \change_inserted 564990737 1670794716
7088 A manual comes together with the package and should be consulted before installing this document class as described in the
7089 \emph on
7090 Installing New Document Classe
7091 \emph default
7092 s section of the
7093 \emph on
7094 Customization
7095 \emph default
7096  manual.
7097
7098 \end_layout
7099
7100 \begin_layout Standard
7101
7102 \change_inserted 564990737 1670794716
7103 \begin_inset Note Greyedout
7104 status open
7105
7106 \begin_layout Plain Layout
7107
7108 \change_inserted 564990737 1670794716
7109 Please note that the publisher of the journal was changed from Springer to EDP Sciences starting January 1,
7110  2001.
7111  That change also involved some slight changes to the style files,
7112  namely the removal of the thesaurus command.
7113  If you have an older version installed,
7114  please upgrade.
7115  For information about compatibility with the old (version 4) layout,
7116  please refer to the comments in
7117 \family typewriter
7118 \SpecialChar LyX
7119 Dir/layouts/aapaper.layout
7120 \family default
7121 .
7122 \end_layout
7123
7124 \end_inset
7125
7126
7127 \end_layout
7128
7129 \begin_layout Subsubsection
7130
7131 \change_inserted 564990737 1670794716
7132 Getting started
7133 \end_layout
7134
7135 \begin_layout Standard
7136
7137 \change_inserted 564990737 1671617129
7138 It is recommended you start from the template in the menu
7139 \family sans
7140 \bar under
7141 F
7142 \bar default
7143 ile\SpecialChar menuseparator
7144 New
7145 \begin_inset space ~
7146 \end_inset
7147
7148 fro
7149 \bar under
7150 m
7151 \bar default
7152
7153 \begin_inset space ~
7154 \end_inset
7155
7156 Template\SpecialChar menuseparator
7157 Articles\SpecialChar menuseparator
7158 Astronomy & Astrophysics
7159 \family default
7160 .
7161  If you are not using the template,
7162  note the following settings:
7163 \end_layout
7164
7165 \begin_layout Itemize
7166
7167 \change_inserted 564990737 1670794716
7168 Select
7169 \change_deleted -712698321 1673095619
7170
7171 \family sans
7172 article (A&A)
7173 \change_inserted -712698321 1673095619
7174 Astronomy & Astrophysics
7175 \change_inserted 564990737 1670794716
7176
7177 \family default
7178  in the
7179 \family sans
7180 \bar under
7181 D
7182 \bar default
7183 ocument\SpecialChar menuseparator
7184
7185 \bar under
7186 S
7187 \bar default
7188 ettings\SpecialChar menuseparator
7189 Document
7190 \begin_inset space ~
7191 \end_inset
7192
7193 Class
7194 \family default
7195  dialog (OK,
7196  that one was obvious).
7197 \end_layout
7198
7199 \begin_layout Itemize
7200
7201 \change_inserted 564990737 1670794716
7202 Don't change the
7203 \family sans
7204 Headings
7205 \begin_inset space ~
7206 \end_inset
7207
7208
7209 \bar under
7210 s
7211 \bar default
7212 tyle
7213 \family default
7214  in the
7215 \family sans
7216 Page
7217 \begin_inset space ~
7218 \end_inset
7219
7220 Layout
7221 \family default
7222  dialog:
7223  leave it set to
7224 \family sans
7225 Default
7226 \family default
7227 .
7228  The whole layout is done by the macros,
7229  you shouldn't change anything.
7230 \end_layout
7231
7232 \begin_layout Subsubsection
7233
7234 \change_inserted 564990737 1670794716
7235 The header block
7236 \end_layout
7237
7238 \begin_layout Standard
7239
7240 \change_inserted 564990737 1670794716
7241 First thing to enter is the header information.
7242  It consists of
7243 \change_deleted -712698321 1673167006
7244 five
7245 \change_inserted -712698321 1673167007
7246 seven
7247 \change_inserted 564990737 1670794716
7248  entries,
7249  of which one is optional.
7250  They are
7251 \end_layout
7252
7253 \begin_layout Itemize
7254
7255 \change_inserted 564990737 1670794716
7256
7257 \family sans
7258 Title
7259 \family default
7260 :
7261  [required]
7262 \end_layout
7263
7264 \begin_layout Itemize
7265
7266 \change_inserted 564990737 1670794716
7267
7268 \family sans
7269 Subtitle
7270 \family default
7271 :
7272  [optional]
7273 \end_layout
7274
7275 \begin_layout Itemize
7276
7277 \change_inserted 564990737 1670794716
7278
7279 \family sans
7280 Author
7281 \family default
7282 :
7283  [required]
7284 \end_layout
7285
7286 \begin_layout Itemize
7287
7288 \change_deleted -712698321 1673167065
7289
7290 \family sans
7291 Institute
7292 \change_inserted -712698321 1673167065
7293 Address
7294 \change_inserted 564990737 1670794716
7295
7296 \family default
7297 :
7298  [required]
7299 \change_inserted -712698321 1673167087
7300
7301 \end_layout
7302
7303 \begin_layout Itemize
7304
7305 \change_inserted -712698321 1673168577
7306
7307 \family sans
7308 Offprints
7309 \family default
7310  [optional].
7311  Determines to whom correspondence and reprints are to be sent.
7312 \end_layout
7313
7314 \begin_layout Itemize
7315
7316 \change_inserted -712698321 1673168590
7317
7318 \family sans
7319 Mail
7320 \family default
7321  [optional] Snail mail address for contacts.
7322 \change_inserted 564990737 1670794716
7323
7324 \end_layout
7325
7326 \begin_layout Itemize
7327
7328 \change_inserted 564990737 1670794716
7329
7330 \family sans
7331 Date
7332 \family default
7333 :
7334  [required].
7335  Suggested format is
7336 \family typewriter
7337 Received:
7338  <date>;
7339  Accepted <date>
7340 \end_layout
7341
7342 \begin_layout Standard
7343
7344 \change_inserted -712698321 1673168612
7345 There is no need to issue the
7346 \family typewriter
7347
7348 \backslash
7349 maketitle
7350 \family default
7351  command,
7352  this is done automatically by \SpecialChar LyX
7353  when the header is finished.
7354
7355 \change_inserted 564990737 1670794716
7356 Although the order of the single header entries doesn't matter it is advised to keep the above sequence,
7357  just to get the best optics and meets the layout of the real document.
7358 \end_layout
7359
7360 \begin_layout Standard
7361
7362 \change_inserted 564990737 1670794716
7363 If you want to place footnotes in the header block,
7364  e.
7365 \begin_inset space \thinspace{}
7366 \end_inset
7367
7368 g.
7369 \begin_inset space \space{}
7370 \end_inset
7371
7372 to state your present address,
7373  just use the standard footnote via the menu
7374 \family sans
7375 \bar under
7376 I
7377 \bar default
7378 nsert\SpecialChar menuseparator
7379
7380 \bar under
7381 F
7382 \bar default
7383 ootnote.
7384
7385 \family default
7386  \SpecialChar LyX
7387  will automagically use the term
7388 \family typewriter
7389
7390 \backslash
7391 thanks{}
7392 \family default
7393  in that case.
7394 \change_inserted -712698321 1673168649
7395
7396 \end_layout
7397
7398 \begin_layout Standard
7399
7400 \change_inserted -712698321 1673168649
7401 Under
7402 \family sans
7403 Edit\SpecialChar menuseparator
7404 Text Style
7405 \family default
7406 ,
7407  you'll find two insets which are relevant for the titling:
7408 \end_layout
7409
7410 \begin_layout Itemize
7411
7412 \change_inserted -712698321 1673168649
7413
7414 \family sans
7415 Institute
7416 \family typewriter
7417
7418 \family default
7419 to mark corresponding author\SpecialChar breakableslash
7420 institute pairs.
7421  The institutes are numbered sequentially as they appear in the
7422 \family sans
7423 Address
7424 \family default
7425  field,
7426  so you have to put a marker to each author.
7427 \end_layout
7428
7429 \begin_layout Itemize
7430
7431 \change_inserted -712698321 1673168649
7432
7433 \family sans
7434 Email
7435 \family default
7436  to supply an email address for fast contact.
7437 \change_inserted 564990737 1670794716
7438
7439 \end_layout
7440
7441 \begin_layout Standard
7442
7443 \change_inserted 564990737 1670794716
7444 In addition to these topics,
7445  the macros use three additional \SpecialChar LaTeX
7446  commands that have no counterpart in \SpecialChar LyX
7447 :
7448 \end_layout
7449
7450 \begin_layout Itemize
7451
7452 \change_inserted 564990737 1670794716
7453
7454 \family typewriter
7455
7456 \backslash
7457 and
7458 \family default
7459  to separate different names for more than one author and institute,
7460  respectively.
7461 \end_layout
7462
7463 \begin_layout Itemize
7464
7465 \change_deleted -712698321 1673168671
7466
7467 \family typewriter
7468
7469 \backslash
7470 inst{<nr>}
7471 \family default
7472  to mark corresponding author/institute pairs.
7473  The institutes are numbered sequentially as they appear in the
7474 \family sans
7475 Institute
7476 \family default
7477  field,
7478  so you have to put a marker to each author.
7479 \end_layout
7480
7481 \begin_layout Itemize
7482
7483 \change_deleted -712698321 1673168671
7484
7485 \family typewriter
7486
7487 \backslash
7488 email{address}
7489 \family default
7490  to supply an email address for fast contact.
7491 \change_inserted 564990737 1670794716
7492
7493 \end_layout
7494
7495 \begin_layout Standard
7496
7497 \change_deleted -712698321 1673168684
7498 In all cases,
7499  t
7500 \change_inserted -712698321 1673168684
7501 T
7502 \change_inserted 564990737 1671642374
7503 he appropriate command has to be entered as \SpecialChar TeX
7504  code in \SpecialChar LyX
7505 .
7506  See the examples in the template and in
7507 \family sans
7508 File\SpecialChar menuseparator
7509 Open Example\SpecialChar menuseparator
7510 Articles\SpecialChar menuseparator
7511 Astronomy & Astrophysics
7512 \family default
7513 .
7514 \change_unchanged
7515
7516 \end_layout
7517
7518 \begin_layout Subsubsection
7519
7520 \change_inserted 564990737 1670794716
7521 The abstract
7522 \end_layout
7523
7524 \begin_layout Standard
7525
7526 \change_inserted -712698321 1673168754
7527 The abstract should immediately follow the header block.
7528  With version 5 the abstract environment was changed to a command,
7529  and there is now a restriction to only one paragraph.
7530  In addition,
7531  it should contain an entry with the keywords.
7532  This is done via the paragraph style
7533 \family sans
7534 Keywords
7535 \family default
7536 .
7537  Refer to the example paper.
7538 \change_deleted -712698321 1673168754
7539 The abstract should immediately follow the header block and must contain five tokens:
7540
7541 \family typewriter
7542
7543 \backslash
7544 abstract{}{}{}{}{}
7545 \family default
7546
7547 \end_layout
7548
7549 \begin_layout Enumerate
7550
7551 \change_deleted -712698321 1673168754
7552
7553 \family typewriter
7554 context heading
7555 \family default
7556  (optional) {} leave it empty if necessary
7557 \end_layout
7558
7559 \begin_layout Enumerate
7560
7561 \change_deleted -712698321 1673168754
7562
7563 \family typewriter
7564 aims heading
7565 \family default
7566  (mandatory) {}
7567 \end_layout
7568
7569 \begin_layout Enumerate
7570
7571 \change_deleted -712698321 1673168754
7572
7573 \family typewriter
7574 methods heading
7575 \family default
7576  (mandatory) {}
7577 \end_layout
7578
7579 \begin_layout Enumerate
7580
7581 \change_deleted -712698321 1673168754
7582
7583 \family typewriter
7584 results heading
7585 \family default
7586  (mandatory) {}
7587 \end_layout
7588
7589 \begin_layout Enumerate
7590
7591 \change_deleted -712698321 1673168754
7592
7593 \family typewriter
7594 conclusions heading
7595 \family default
7596  (optional) {} leave it empty if necessary
7597 \end_layout
7598
7599 \begin_layout Standard
7600
7601 \change_deleted -712698321 1673168754
7602 (NB.
7603  This structure not shown in
7604 \emph on
7605 aa_sample.lyx.
7606 \emph default
7607 )
7608 \change_inserted 564990737 1670794716
7609
7610 \end_layout
7611
7612 \begin_layout Subsubsection
7613
7614 \change_inserted 564990737 1670794716
7615 Supported environments
7616 \end_layout
7617
7618 \begin_layout Standard
7619
7620 \change_inserted 564990737 1670794716
7621 The A&A paper layout supports the following environments for structuring your text:
7622 \end_layout
7623
7624 \begin_layout Standard
7625
7626 \change_inserted -712698321 1673169058
7627
7628 \family sans
7629 \begin_inset Flex Multiple Columns
7630 status open
7631
7632 \begin_layout Itemize
7633
7634 \change_inserted -712698321 1673169058
7635
7636 \family sans
7637 Standard
7638 \end_layout
7639
7640 \begin_layout Itemize
7641
7642 \change_inserted -712698321 1673169058
7643
7644 \family sans
7645 Section
7646 \end_layout
7647
7648 \begin_layout Itemize
7649
7650 \change_inserted -712698321 1673169058
7651
7652 \family sans
7653 Subsection
7654 \end_layout
7655
7656 \begin_layout Itemize
7657
7658 \change_inserted -712698321 1673169058
7659
7660 \family sans
7661 Subsubsection
7662 \end_layout
7663
7664 \begin_layout Itemize
7665
7666 \change_inserted -712698321 1673169058
7667
7668 \family sans
7669 Itemize
7670 \end_layout
7671
7672 \begin_layout Itemize
7673
7674 \change_inserted -712698321 1673169058
7675
7676 \family sans
7677 Enumerate
7678 \end_layout
7679
7680 \begin_layout Itemize
7681
7682 \change_inserted -712698321 1673169058
7683
7684 \family sans
7685 Description
7686 \end_layout
7687
7688 \begin_layout Itemize
7689
7690 \change_inserted -712698321 1673169058
7691
7692 \family sans
7693 Caption
7694 \end_layout
7695
7696 \begin_layout Itemize
7697
7698 \change_inserted -712698321 1673169058
7699
7700 \family sans
7701 Abstract
7702 \end_layout
7703
7704 \begin_layout Itemize
7705
7706 \change_inserted -712698321 1673169058
7707
7708 \family sans
7709 Acknowledgment
7710 \end_layout
7711
7712 \begin_layout Itemize
7713
7714 \change_inserted -712698321 1673169058
7715
7716 \family sans
7717 Bibliography
7718 \end_layout
7719
7720 \begin_layout Itemize
7721
7722 \change_inserted -712698321 1673169078
7723 LaTeX
7724 \change_unchanged
7725
7726 \end_layout
7727
7728 \end_inset
7729
7730
7731 \change_deleted -712698321 1673169058
7732 Standard
7733 \end_layout
7734
7735 \begin_layout Itemize
7736
7737 \change_deleted -712698321 1673169058
7738
7739 \family sans
7740 Section
7741 \end_layout
7742
7743 \begin_layout Itemize
7744
7745 \change_deleted -712698321 1673169058
7746
7747 \family sans
7748 Subsection
7749 \end_layout
7750
7751 \begin_layout Itemize
7752
7753 \change_deleted -712698321 1673169058
7754
7755 \family sans
7756 Subsubsection
7757 \end_layout
7758
7759 \begin_layout Itemize
7760
7761 \change_deleted -712698321 1673169058
7762
7763 \family sans
7764 Itemize
7765 \end_layout
7766
7767 \begin_layout Itemize
7768
7769 \change_deleted -712698321 1673169058
7770
7771 \family sans
7772 Enumerate
7773 \end_layout
7774
7775 \begin_layout Itemize
7776
7777 \change_deleted -712698321 1673169058
7778
7779 \family sans
7780 Description
7781 \end_layout
7782
7783 \begin_layout Itemize
7784
7785 \change_deleted -712698321 1673169058
7786
7787 \family sans
7788 Caption
7789 \end_layout
7790
7791 \begin_layout Itemize
7792
7793 \change_deleted -712698321 1673169058
7794
7795 \family sans
7796 Abstract
7797 \end_layout
7798
7799 \begin_layout Itemize
7800
7801 \change_deleted -712698321 1673169058
7802
7803 \family sans
7804 Acknowledgment
7805 \end_layout
7806
7807 \begin_layout Itemize
7808
7809 \change_deleted -712698321 1673169058
7810
7811 \family sans
7812 Bibliography
7813 \end_layout
7814
7815 \begin_layout Itemize
7816
7817 \change_deleted -712698321 1673169058
7818
7819 \family sans
7820 \SpecialChar LaTeX
7821
7822 \change_inserted 564990737 1670794716
7823
7824 \end_layout
7825
7826 \begin_layout Subsubsection
7827
7828 \change_inserted 564990737 1670794716
7829 Commands not supported by \SpecialChar LyX
7830
7831 \end_layout
7832
7833 \begin_layout Standard
7834
7835 \change_inserted 564990737 1670794716
7836 Some commands are not yet supported by the
7837 \change_deleted -712698321 1673169117
7838
7839 \family sans
7840 paper (A&A)
7841 \change_inserted -712698321 1673169117
7842 Astronomy & Astrophysics
7843 \change_inserted 564990737 1670794716
7844
7845 \family default
7846  layout for \SpecialChar LyX
7847 .
7848  Some have already been mentioned.
7849  For the sake of completeness,
7850  they are listed all together here:
7851 \end_layout
7852
7853 \begin_layout Itemize
7854
7855 \change_inserted 564990737 1670794716
7856
7857 \family typewriter
7858
7859 \backslash
7860 and
7861 \end_layout
7862
7863 \begin_layout Itemize
7864
7865 \change_inserted -712698321 1673168793
7866
7867 \family typewriter
7868
7869 \backslash
7870 authorrunning
7871 \end_layout
7872
7873 \begin_layout Itemize
7874
7875 \change_inserted -712698321 1673168793
7876
7877 \family typewriter
7878
7879 \backslash
7880 object{}
7881 \end_layout
7882
7883 \begin_layout Itemize
7884
7885 \change_inserted -712698321 1673168793
7886
7887 \family typewriter
7888
7889 \backslash
7890 titlerunning{}
7891 \change_deleted -712698321 1673168793
7892
7893 \backslash
7894 email
7895 \end_layout
7896
7897 \begin_layout Itemize
7898
7899 \change_deleted -712698321 1673168793
7900
7901 \family typewriter
7902
7903 \backslash
7904 inst{}
7905 \end_layout
7906
7907 \begin_layout Itemize
7908
7909 \change_deleted -712698321 1673168793
7910
7911 \family typewriter
7912
7913 \backslash
7914 keywords{}
7915 \end_layout
7916
7917 \begin_layout Itemize
7918
7919 \change_deleted -712698321 1673168793
7920
7921 \family typewriter
7922
7923 \backslash
7924 object{}
7925 \change_inserted 564990737 1670794716
7926
7927 \end_layout
7928
7929 \begin_layout Standard
7930
7931 \change_inserted 564990737 1670794716
7932 If you want to use any of these commands,
7933  you have to enter them yourself.
7934  Do not forget to use
7935 \family sans
7936
7937 \bar under
7938 I
7939 \bar default
7940 nsert\SpecialChar menuseparator
7941 \SpecialChar TeX
7942
7943 \begin_inset space ~
7944 \end_inset
7945
7946 Code
7947 \family default
7948 !
7949 \end_layout
7950
7951 \begin_layout Subsubsection
7952
7953 \change_inserted 564990737 1670794716
7954 Figure and Table Floats
7955 \end_layout
7956
7957 \begin_layout Standard
7958
7959 \change_inserted 564990737 1670794716
7960 \SpecialChar LyX
7961  provides support for the necessary float environments
7962 \family sans
7963 figure,
7964  figure*,
7965  table
7966 \family default
7967  and
7968 \family sans
7969 table*
7970 \family default
7971 ,
7972  therefore we won't tell much about it here.
7973  Refer to the
7974 \emph on
7975 User's
7976 \begin_inset space ~
7977 \end_inset
7978
7979 Guide
7980 \emph default
7981 .
7982  Just remember that tables should be left-aligned.
7983  For that,
7984  select the table and change the alignment in
7985 \family sans
7986 \bar under
7987 E
7988 \bar default
7989 dit\SpecialChar menuseparator
7990
7991 \bar under
7992 P
7993 \bar default
7994 aragraph
7995 \begin_inset space ~
7996 \end_inset
7997
7998 Settings
7999 \change_inserted -712698321 1673169201
8000
8001 \family default
8002  (
8003 \begin_inset Info
8004 type  "icon"
8005 arg   "layout-paragraph"
8006 \end_inset
8007
8008 )
8009 \change_inserted 564990737 1670794716
8010
8011 \family sans
8012 .
8013 \end_layout
8014
8015 \begin_layout Standard
8016
8017 \change_inserted 564990737 1670794716
8018 There is only one special thing:
8019  the figures with a caption beside the figure.
8020  To create such a figure,
8021  you have to do the following:
8022 \end_layout
8023
8024 \begin_layout Enumerate
8025
8026 \change_inserted 564990737 1670794716
8027 Create a wide figure float:
8028
8029 \family sans
8030 \bar under
8031 I
8032 \bar default
8033 nsert\SpecialChar menuseparator
8034 Flo
8035 \bar under
8036 a
8037 \bar default
8038 t\SpecialChar menuseparator
8039 Figure
8040 \family default
8041 ,
8042  then,
8043  from within the float,
8044  use the menu
8045 \family sans
8046 \bar under
8047 E
8048 \bar default
8049 dit\SpecialChar menuseparator
8050 Flo
8051 \bar under
8052 a
8053 \bar default
8054 t
8055 \begin_inset space ~
8056 \end_inset
8057
8058 Settings
8059 \family default
8060  and check
8061 \family sans
8062 \bar under
8063 S
8064 \bar default
8065 pan
8066 \begin_inset space ~
8067 \end_inset
8068
8069 columns
8070 \family default
8071  in the
8072 \family sans
8073 float
8074 \family default
8075  dialog.
8076 \end_layout
8077
8078 \begin_layout Enumerate
8079
8080 \change_inserted 564990737 1670794716
8081 Enter your caption text.
8082 \end_layout
8083
8084 \begin_layout Enumerate
8085
8086 \change_inserted 564990737 1670794716
8087 Press
8088 \family sans
8089 Return
8090 \family default
8091  to move the cursor above the caption.
8092 \end_layout
8093
8094 \begin_layout Enumerate
8095
8096 \change_inserted 564990737 1670794716
8097 Insert your figure
8098 \end_layout
8099
8100 \begin_layout Enumerate
8101
8102 \change_inserted 564990737 1670794716
8103 Position the cursor after the figure and insert a horizontal fill by using the menu:
8104
8105 \family sans
8106 \bar under
8107 I
8108 \bar default
8109 nsert\SpecialChar menuseparator
8110 F
8111 \bar under
8112 o
8113 \bar default
8114 rmatting\SpecialChar menuseparator
8115 H
8116 \bar under
8117 o
8118 \bar default
8119 rizontal
8120 \begin_inset space ~
8121 \end_inset
8122
8123 Space
8124 \family default
8125  to open the
8126 \family sans
8127 space
8128 \family default
8129  dialog and select the
8130 \family sans
8131 Horizontal fill
8132 \family default
8133  option from the
8134 \family sans
8135 \bar under
8136 S
8137 \bar default
8138 pacing
8139 \family default
8140
8141 \change_deleted -712698321 1673169720
8142 pull-down
8143 \change_inserted -712698321 1673169724
8144 context
8145 \change_inserted 564990737 1670794716
8146  menu.
8147 \end_layout
8148
8149 \begin_layout Enumerate
8150
8151 \change_inserted 564990737 1670794716
8152 Switch to \SpecialChar LaTeX
8153  mode:
8154
8155 \family sans
8156 M-c
8157 \begin_inset space ~
8158 \end_inset
8159
8160 t
8161 \family default
8162 .
8163 \end_layout
8164
8165 \begin_layout Enumerate
8166
8167 \change_inserted 564990737 1670794716
8168 Enter
8169 \family typewriter
8170
8171 \backslash
8172 parbox[b]{55mm}{
8173 \family default
8174
8175 \emph on
8176 Do not close the brace!
8177 \end_layout
8178
8179 \begin_layout Enumerate
8180
8181 \change_inserted 564990737 1670794716
8182 Position the cursor behind the caption text,
8183  switch to \SpecialChar LaTeX
8184  mode and insert the closing brace:
8185
8186 \family sans
8187 M-c
8188 \begin_inset space ~
8189 \end_inset
8190
8191 t
8192 \family default
8193
8194 \family typewriter
8195 }
8196 \family default
8197 .
8198 \end_layout
8199
8200 \begin_layout Standard
8201
8202 \change_inserted 564990737 1671642458
8203 Also,
8204  refer to the figures in the file in
8205 \family sans
8206 File\SpecialChar menuseparator
8207 Open Example\SpecialChar menuseparator
8208 Articles\SpecialChar menuseparator
8209 Astronomy & Astrophysics
8210 \family default
8211 .
8212 \end_layout
8213
8214 \begin_layout Subsubsection
8215
8216 \change_inserted 564990737 1670794716
8217 Referee layout
8218 \end_layout
8219
8220 \begin_layout Standard
8221
8222 \change_inserted 564990737 1670794716
8223 For submission,
8224  the paper has to be formatted in a special double-spacing layout.
8225  For this purpose,
8226  you have to add the option
8227 \family typewriter
8228 referee
8229 \family default
8230  to the
8231 \family sans
8232 Cus
8233 \bar under
8234 t
8235 \bar default
8236 om Class
8237 \begin_inset space ~
8238 \end_inset
8239
8240 options
8241 \family default
8242  in the
8243 \family sans
8244 \bar under
8245 D
8246 \bar default
8247 ocument\SpecialChar menuseparator
8248
8249 \bar under
8250 S
8251 \bar default
8252 ettings\SpecialChar menuseparator
8253 Document
8254 \begin_inset space ~
8255 \end_inset
8256
8257 Class
8258 \family default
8259  dialog.
8260
8261 \end_layout
8262
8263 \begin_layout Subsubsection
8264
8265 \change_inserted 564990737 1670794716
8266 The example paper
8267 \end_layout
8268
8269 \begin_layout Standard
8270
8271 \change_inserted 564990737 1671642520
8272 The example in
8273 \family sans
8274 File\SpecialChar menuseparator
8275 Open Example\SpecialChar menuseparator
8276 Articles\SpecialChar menuseparator
8277 Astronomy & Astrophysics
8278 \family default
8279  was written with \SpecialChar LyX
8280 .
8281  It is the example paper from the original macro package,
8282
8283 \family typewriter
8284 aa.dem
8285 \family default
8286  in the
8287 \begin_inset CommandInset href
8288 LatexCommand href
8289 name "aa-package"
8290 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
8291 literal "false"
8292
8293 \end_inset
8294
8295 ,
8296  but translated to \SpecialChar LyX
8297  using the older unstructured abstract type.
8298  Use it for inspiration,
8299  and compare the \SpecialChar LaTeX
8300  code in
8301 \family typewriter
8302 aa.dem
8303 \family default
8304  with the \SpecialChar LyX
8305  way of writing.
8306 \end_layout
8307
8308 \begin_layout Subsection
8309 AAS\SpecialChar TeX
8310
8311 \end_layout
8312
8313 \begin_layout Standard
8314 by
8315 \noun on
8316 Mike Ressler
8317 \end_layout
8318
8319 \begin_layout Subsubsection
8320 Introduction
8321 \end_layout
8322
8323 \begin_layout Standard
8324 AAS\SpecialChar TeX
8325  is a set of macros produced by the American Astronomical Society to facilitate electronic manuscript submission to the three journals they publish:
8326  the Astrophysical Journal (including the Letters and Supplement),
8327  the Astronomical Journal,
8328  and the Publications of the Astronomical Society of the Pacific.
8329  \SpecialChar LyX
8330  has proven to be an excellent tool for generating these documents,
8331  especially given its equation,
8332  citation,
8333  and figure handling capabilities.
8334  \SpecialChar LyX
8335  requires version 5.0 (or higher) of these macros;
8336  preferably 6.0,
8337  which is the version described here,
8338  or higher.
8339  Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
8340 2.09 and are fundamentally incompatible with \SpecialChar LyX
8341 .
8342  The AAS\SpecialChar TeX
8343  package may be downloaded from the AAS\SpecialChar TeX
8344  Web site
8345 \end_layout
8346
8347 \begin_layout Standard
8348 \begin_inset VSpace medskip
8349 \end_inset
8350
8351
8352 \end_layout
8353
8354 \begin_layout Standard
8355 \align center
8356 \begin_inset Flex URL
8357 status collapsed
8358
8359 \begin_layout Plain Layout
8360
8361 https://aas.org/aastex/aastex-downloads
8362 \end_layout
8363
8364 \end_inset
8365
8366
8367 \end_layout
8368
8369 \begin_layout Standard
8370 \begin_inset VSpace medskip
8371 \end_inset
8372
8373
8374 \end_layout
8375
8376 \begin_layout Standard
8377 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
8378 .
8379  \SpecialChar LyX
8380  will not reduce the need to figure out all the AAS\SpecialChar TeX
8381  commands,
8382  it will only reduce the drudgery of typing everything in.
8383  It is your responsibility to ensure that the final exported \SpecialChar LaTeX
8384  document conforms completely to the requirements of the journal to which you are submitting your paper.
8385 \end_layout
8386
8387 \begin_layout Subsubsection
8388 Starting a New Paper
8389 \end_layout
8390
8391 \begin_layout Standard
8392 I strongly suggest that you start with the AAS\SpecialChar TeX
8393  template file.
8394  Click on
8395 \family sans
8396 File\SpecialChar menuseparator
8397 New from
8398 \family default
8399
8400 \family sans
8401 Template
8402 \change_inserted 564990737 1671617265
8403 \SpecialChar menuseparator
8404 Articles\SpecialChar menuseparator
8405 American Astronomical Society
8406 \change_deleted 564990737 1671617310
8407
8408 \family default
8409 ,
8410  enter the new file name,
8411  then choose the
8412 \family typewriter
8413 aastex6.lyx
8414 \family default
8415  template
8416 \change_unchanged
8417 .
8418  This will show the most common fields found in a manuscript.
8419  Simply overwrite the existing text (including the brackets,
8420
8421 \family typewriter
8422 <>
8423 \family default
8424 ) with the correct information.
8425  Many of the AAS\SpecialChar TeX
8426  commands and environments can be implemented directly in \SpecialChar LyX
8427 ,
8428  but some cannot.
8429  For commands such as these,
8430  the \SpecialChar LaTeX
8431  code must be entered directly and marked as such.
8432  Such commands are referred to as \SpecialChar TeX
8433  code,
8434  or Evil Red Text.
8435  I tried to minimize the amount of \SpecialChar TeX
8436  code needed in an AAS\SpecialChar TeX
8437  document.
8438 \end_layout
8439
8440 \begin_layout Subsubsection
8441 Finishing Your Paper
8442 \end_layout
8443
8444 \begin_layout Standard
8445 When the paper is finished to your satisfaction and previews/prints correctly,
8446  there are a few
8447 \begin_inset Quotes eld
8448 \end_inset
8449
8450 postprocessing
8451 \begin_inset Quotes erd
8452 \end_inset
8453
8454  actions which need to be done before you submit it to the journals.
8455
8456 \end_layout
8457
8458 \begin_layout Enumerate
8459 Export your paper as a \SpecialChar LaTeX
8460  file (
8461 \family sans
8462 File\SpecialChar menuseparator
8463 Export\SpecialChar menuseparator
8464 \SpecialChar LaTeX
8465
8466 \family default
8467 ).
8468
8469 \end_layout
8470
8471 \begin_layout Enumerate
8472 Edit the resulting
8473 \family typewriter
8474 .tex
8475 \family default
8476  file with your favorite text editor
8477 \end_layout
8478
8479 \begin_deeper
8480 \begin_layout Enumerate
8481 remove the comment lines before the
8482 \family typewriter
8483
8484 \backslash
8485 documentclass
8486 \family default
8487  command
8488 \end_layout
8489
8490 \begin_layout Enumerate
8491 remove the
8492 \family typewriter
8493
8494 \backslash
8495 usepackage...{fontenc}
8496 \family default
8497  line if it appears (usually just after
8498 \family typewriter
8499
8500 \backslash
8501 documentclass
8502 \family default
8503 };
8504  also remove the
8505 \family typewriter
8506
8507 \backslash
8508 secnumdepth
8509 \family default
8510  line if it appears.
8511 \end_layout
8512
8513 \begin_layout Enumerate
8514 remove everything between (and including) the
8515 \family typewriter
8516
8517 \backslash
8518 makeatletter
8519 \family default
8520  and
8521 \family typewriter
8522
8523 \backslash
8524 makeatother
8525 \family default
8526  commands,
8527  except for any commands you specifically put into the \SpecialChar LaTeX
8528  preamble (which should appear immediately after the
8529 \begin_inset Quotes eld
8530 \end_inset
8531
8532 User specified \SpecialChar LaTeX
8533  commands
8534 \begin_inset Quotes erd
8535 \end_inset
8536
8537  comment in the
8538 \family typewriter
8539 .tex
8540 \family default
8541  file).
8542 \end_layout
8543
8544 \end_deeper
8545 \begin_layout Enumerate
8546 Run the resulting file through \SpecialChar LaTeX
8547  to make sure it still processes correctly.
8548 \end_layout
8549
8550 \begin_layout Enumerate
8551 Reread the journal requirements to make sure your filenames and formats are correct.
8552 \end_layout
8553
8554 \begin_layout Enumerate
8555 Submit it.
8556 \end_layout
8557
8558 \begin_layout Subsubsection
8559 Comments On Specific Commands
8560 \end_layout
8561
8562 \begin_layout Standard
8563 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
8564  commands:
8565  the AAS\SpecialChar TeX
8566  User Guide (
8567 \family typewriter
8568 aasguide.tex
8569 \family default
8570 ) gives a good description of each.
8571  Thus it's probably easiest for me to go down the list as found in the guide and offer comments where necessary.
8572  So let's begin \SpecialChar ldots
8573
8574 \end_layout
8575
8576 \begin_layout Paragraph
8577 Things that work as expected
8578 \end_layout
8579
8580 \begin_layout Standard
8581 Because they work as you might expect,
8582  I simply list them and the section they are found in:
8583
8584 \family typewriter
8585
8586 \backslash
8587 documentclass
8588 \family default
8589  (2.1.1),
8590
8591 \family typewriter
8592
8593 \backslash
8594 begin{document}
8595 \family default
8596  (2.2),
8597
8598 \family typewriter
8599
8600 \backslash
8601 title
8602 \family default
8603  (2.3),
8604
8605 \family typewriter
8606
8607 \backslash
8608 author
8609 \family default
8610  (2.3),
8611
8612 \family typewriter
8613
8614 \backslash
8615 affil
8616 \family default
8617  (2.3),
8618
8619 \family typewriter
8620
8621 \backslash
8622 abstract
8623 \family default
8624  (2.4),
8625
8626 \family typewriter
8627
8628 \backslash
8629 keywords
8630 \family default
8631  (2.5),
8632
8633 \family typewriter
8634
8635 \backslash
8636 section
8637 \family default
8638  (2.7),
8639
8640 \family typewriter
8641
8642 \backslash
8643 subsection
8644 \family default
8645  (2.7),
8646
8647 \family typewriter
8648
8649 \backslash
8650 subsubsection
8651 \family default
8652  (2.7),
8653
8654 \family typewriter
8655
8656 \backslash
8657 paragraph
8658 \family default
8659  (2.7),
8660
8661 \family typewriter
8662
8663 \backslash
8664 facility
8665 \family default
8666  (2.10),
8667
8668 \family typewriter
8669
8670 \backslash
8671 begin{displaymath}
8672 \family default
8673  (2.12),
8674
8675 \family typewriter
8676
8677 \backslash
8678 begin{equation}
8679 \family default
8680  (2.12),
8681
8682 \family typewriter
8683
8684 \backslash
8685 begin{eqnarray}
8686 \family default
8687  (2.12),
8688
8689 \family typewriter
8690
8691 \backslash
8692 begin{mathletters}
8693 \family default
8694  (2.12),
8695
8696 \family typewriter
8697
8698 \backslash
8699 begin{thebibliography}
8700 \family default
8701  (2.13.1),
8702
8703 \family typewriter
8704
8705 \backslash
8706 bibitem
8707 \family default
8708  (2.13.2),
8709  all the cite commands and their variations (2.13.2),
8710  the generic graphicx figure commands (2.14.1),
8711
8712 \family typewriter
8713
8714 \backslash
8715 begin{table}
8716 \family default
8717  (2.15.4),
8718
8719 \family typewriter
8720
8721 \backslash
8722 begin{tabular}
8723 \family default
8724  (2.15.4),
8725
8726 \family typewriter
8727
8728 \backslash
8729 caption
8730 \family default
8731  (2.15.4),
8732
8733 \family typewriter
8734
8735 \backslash
8736 label
8737 \family default
8738  (2.15.4,
8739  amongst other places),
8740
8741 \family typewriter
8742
8743 \backslash
8744 tablerefs
8745 \family default
8746  (2.15.5),
8747
8748 \family typewriter
8749
8750 \backslash
8751 tablecomments
8752 \family default
8753  (2.15.5),
8754
8755 \family typewriter
8756
8757 \backslash
8758 url
8759 \family default
8760  (2.17.4),
8761
8762 \family typewriter
8763
8764 \backslash
8765 end{document}
8766 \family default
8767  (2.18).
8768 \end_layout
8769
8770 \begin_layout Standard
8771 The following style options also work correctly:
8772
8773 \family typewriter
8774 longabstract
8775 \family default
8776  (2.4),
8777
8778 \family typewriter
8779 preprint
8780 \family default
8781  (3.2.1),
8782
8783 \family typewriter
8784 preprint2
8785 \family default
8786  (3.2.2),
8787
8788 \family typewriter
8789 eqsecnum
8790 \family default
8791  (3.3),
8792
8793 \family typewriter
8794 flushrt
8795 \family default
8796  (3.4).
8797  Simply put them in the
8798 \family sans
8799 Options
8800 \family default
8801  box in
8802 \family sans
8803 Layout\SpecialChar menuseparator
8804 Document
8805 \family default
8806 .
8807 \end_layout
8808
8809 \begin_layout Paragraph
8810 Things that work,
8811  but require more comment
8812 \end_layout
8813
8814 \begin_layout Standard
8815 The following items work,
8816  but require a little more discussion:
8817 \end_layout
8818
8819 \begin_layout Itemize
8820 These items are reserved for use by the journal editors,
8821  but you can put them into the \SpecialChar LaTeX
8822  preamble if you feel compelled to do so:
8823
8824 \family typewriter
8825
8826 \backslash
8827 received
8828 \family default
8829 ,
8830
8831 \family typewriter
8832
8833 \backslash
8834 revised
8835 \family default
8836 ,
8837
8838 \family typewriter
8839
8840 \backslash
8841 accepted
8842 \family default
8843 ,
8844
8845 \family typewriter
8846
8847 \backslash
8848 ccc
8849 \family default
8850 ,
8851
8852 \family typewriter
8853
8854 \backslash
8855 cpright
8856 \family default
8857  (all from 2.1.3)
8858 \end_layout
8859
8860 \begin_layout Itemize
8861 These items may be placed in the \SpecialChar LaTeX
8862  preamble,
8863  and are included as blanks in the template file:
8864
8865 \family typewriter
8866
8867 \backslash
8868 slugcomment
8869 \family default
8870  (2.1.4),
8871
8872 \family typewriter
8873
8874 \backslash
8875 shorttitle
8876 \family default
8877  (2.1.5),
8878
8879 \family typewriter
8880
8881 \backslash
8882 shortauthors
8883 \family default
8884  (2.1.5)
8885 \end_layout
8886
8887 \begin_layout Itemize
8888
8889 \family typewriter
8890
8891 \backslash
8892 email
8893 \family default
8894  (2.3) – can only be used
8895 \begin_inset Quotes eld
8896 \end_inset
8897
8898 standalone
8899 \begin_inset Quotes erd
8900 \end_inset
8901
8902 ,
8903  not in the middle of a paragraph.
8904  Use \SpecialChar TeX
8905  code if you need to embed it.
8906 \end_layout
8907
8908 \begin_layout Itemize
8909
8910 \family typewriter
8911
8912 \backslash
8913 and
8914 \family default
8915  (2.3) – will have extra {} after it.
8916  This should not cause an error.
8917 \end_layout
8918
8919 \begin_layout Itemize
8920
8921 \family typewriter
8922
8923 \backslash
8924 notetoeditor
8925 \family default
8926  (2.6) – can only be used
8927 \begin_inset Quotes eld
8928 \end_inset
8929
8930 standalone
8931 \begin_inset Quotes erd
8932 \end_inset
8933
8934 ,
8935  not in the middle of a paragraph.
8936  Use \SpecialChar TeX
8937  code if you need to embed it.
8938 \end_layout
8939
8940 \begin_layout Itemize
8941
8942 \family typewriter
8943
8944 \backslash
8945 placetable
8946 \family default
8947  (2.8) – can't insert a cross-reference tag,
8948  you must type the tag name by hand
8949 \end_layout
8950
8951 \begin_layout Itemize
8952
8953 \family typewriter
8954
8955 \backslash
8956 placefigure
8957 \family default
8958  (2.8) – same as for
8959 \family typewriter
8960
8961 \backslash
8962 placetable
8963 \end_layout
8964
8965 \begin_layout Itemize
8966
8967 \family typewriter
8968
8969 \backslash
8970 acknowledgements
8971 \family default
8972  (2.9) – will have extra {} after it.
8973  This should not cause an error.
8974 \end_layout
8975
8976 \begin_layout Itemize
8977
8978 \family typewriter
8979
8980 \backslash
8981 appendix
8982 \family default
8983  (2.11) – will have extra {} after it.
8984  This should not cause an error.
8985 \end_layout
8986
8987 \begin_layout Itemize
8988
8989 \family typewriter
8990
8991 \backslash
8992 figcaption
8993 \family default
8994  (2.14.2) – you can insert an optional filename argument by placing the cursor at the beginning of the text and selecting
8995 \family sans
8996 Insert\SpecialChar menuseparator
8997 Short Title
8998 \family default
8999 .
9000
9001 \begin_inset Quotes eld
9002 \end_inset
9003
9004 Short Title
9005 \begin_inset Quotes erd
9006 \end_inset
9007
9008  inserts an optional argument of the type needed by
9009 \family typewriter
9010
9011 \backslash
9012 figcaption
9013 \family default
9014 .
9015  Hopefully it will be renamed someday.
9016 \end_layout
9017
9018 \begin_layout Itemize
9019
9020 \family typewriter
9021
9022 \backslash
9023 objectname
9024 \family default
9025  (2.17.1) – same as
9026 \family typewriter
9027
9028 \backslash
9029 figcaption
9030 \family default
9031  for the catalog ID optional parameter
9032 \end_layout
9033
9034 \begin_layout Itemize
9035
9036 \family typewriter
9037
9038 \backslash
9039 dataset
9040 \family default
9041  (2.17.1) – same as
9042 \family typewriter
9043
9044 \backslash
9045 figcaption
9046 \family default
9047  for the catalog ID optional parameter
9048 \end_layout
9049
9050 \begin_layout Paragraph
9051 Things not implemented,
9052  use \SpecialChar TeX
9053  code
9054 \end_layout
9055
9056 \begin_layout Standard
9057
9058 \family typewriter
9059
9060 \backslash
9061 eqnum
9062 \family default
9063  (2.12),
9064
9065 \family typewriter
9066
9067 \backslash
9068 setcounter{equation}
9069 \family default
9070  (2.12),
9071  Journal name abbreviations (2.13.4),
9072
9073 \family typewriter
9074
9075 \backslash
9076 figurenum
9077 \family default
9078  (2.14.1),
9079
9080 \family typewriter
9081
9082 \backslash
9083 epsscale
9084 \family default
9085  (2.14.1),
9086
9087 \family typewriter
9088
9089 \backslash
9090 plotone
9091 \family default
9092  (2.14.1),
9093
9094 \family typewriter
9095
9096 \backslash
9097 plottwo
9098 \family default
9099  (2.14.1),
9100
9101 \family typewriter
9102
9103 \backslash
9104 tablenum
9105 \family default
9106  (2.15.4),
9107
9108 \family typewriter
9109
9110 \backslash
9111 tableline
9112 \family default
9113  (2.15.4,
9114  insert it as the first element in the lefthand cell after where you want it.
9115  Don't use any of \SpecialChar LyX
9116 's rules in the table),
9117
9118 \family typewriter
9119
9120 \backslash
9121 tablenotemark
9122 \family default
9123  (2.15.5),
9124
9125 \family typewriter
9126
9127 \backslash
9128 tablenotetext
9129 \family default
9130  (2.15.5),
9131  much of Misc (2.17,
9132  except
9133 \family typewriter
9134
9135 \backslash
9136 objectname
9137 \family default
9138 ,
9139
9140 \family typewriter
9141
9142 \backslash
9143 dataset
9144 \family default
9145 ,
9146
9147 \family typewriter
9148
9149 \backslash
9150 url
9151 \family default
9152 ,
9153  and
9154 \family typewriter
9155
9156 \backslash
9157 email
9158 \family default
9159 ;
9160  see above),
9161
9162 \family typewriter
9163
9164 \backslash
9165 singlespace
9166 \family default
9167  (3.1),
9168
9169 \family typewriter
9170
9171 \backslash
9172 doublespace
9173 \family default
9174  (3.1),
9175
9176 \family typewriter
9177
9178 \backslash
9179 onecolumn
9180 \family default
9181  (3.2),
9182
9183 \family typewriter
9184
9185 \backslash
9186 twocolumn
9187 \family default
9188  (3.2)
9189 \end_layout
9190
9191 \begin_layout Paragraph
9192 Things that cannot be implemented
9193 \end_layout
9194
9195 \begin_layout Standard
9196 \SpecialChar ldots
9197  at least in any meaningful sort of way,
9198  so I suggest ignoring them.
9199  They are the references environment (2.13.3),
9200  and the deluxetable environment (2.15).
9201  If you really,
9202  really need to use deluxetable,
9203  I suggest editing it in a separate file with a text editor,
9204  then using
9205 \family sans
9206 Insert\SpecialChar menuseparator
9207 Child
9208 \begin_inset space ~
9209 \end_inset
9210
9211 Document
9212 \family default
9213  to include it in your \SpecialChar LyX
9214  document.
9215  See
9216 \change_deleted 564990737 1671642564
9217 the
9218 \family typewriter
9219 aas_sample.lyx
9220 \family default
9221  file to see
9222 \change_inserted 564990737 1671642618
9223
9224 \family sans
9225 File\SpecialChar menuseparator
9226 Open Example\SpecialChar menuseparator
9227 Articles\SpecialChar menuseparator
9228 American Astronomical Society
9229 \change_unchanged
9230
9231 \family default
9232
9233 \change_inserted 564990737 1671642621
9234 for
9235 \change_unchanged
9236 an example of this.
9237 \end_layout
9238
9239 \begin_layout Subsubsection
9240 FAQs,
9241  Tips,
9242  Tricks,
9243  and Other Ruminations
9244 \end_layout
9245
9246 \begin_layout Paragraph
9247 Getting \SpecialChar LyX
9248  and AAS\SpecialChar TeX
9249  to cooperate
9250 \end_layout
9251
9252 \begin_layout Standard
9253 It can be a bit tricky to get \SpecialChar LyX
9254  to recognize a new layout and document class.
9255  When all else fails,
9256  do this:
9257 \end_layout
9258
9259 \begin_layout Enumerate
9260 Make certain that \SpecialChar LaTeX
9261  can find AAS\SpecialChar TeX
9262 .
9263  Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9264  distribution into a directory completely unrelated to \SpecialChar LaTeX
9265  or AAS\SpecialChar TeX
9266  and run \SpecialChar LaTeX
9267  on
9268 \family typewriter
9269 sample.tex
9270 \family default
9271 .
9272 \end_layout
9273
9274 \begin_layout Enumerate
9275 Make certain that
9276 \family typewriter
9277 aastex.layout
9278 \family default
9279  appears in \SpecialChar LyX
9280 's
9281 \family typewriter
9282 layouts
9283 \family default
9284  folder
9285 \end_layout
9286
9287 \begin_layout Enumerate
9288 Rerun
9289 \family sans
9290 Tools\SpecialChar menuseparator
9291 Reconfigure
9292 \family default
9293  in \SpecialChar LyX
9294 ,
9295  then restart \SpecialChar LyX
9296 .
9297 \end_layout
9298
9299 \begin_layout Enumerate
9300 Open a regular new file,
9301  not from a template.
9302  Does
9303 \change_deleted -712698321 1673170671
9304 AAS\SpecialChar TeX
9305
9306 \change_inserted -712698321 1673170671
9307
9308 \family sans
9309 American Astronomical Society (AASTeX V.
9310 \begin_inset space \thinspace{}
9311 \end_inset
9312
9313 6)
9314 \change_unchanged
9315
9316 \family default
9317  appear in the class list in
9318 \family sans
9319 Document\SpecialChar menuseparator
9320 Settings
9321 \family default
9322 ?
9323 \end_layout
9324
9325 \begin_layout Standard
9326 If you get a warning from an existing AAS\SpecialChar TeX
9327  document about not being able to find the AAS\SpecialChar TeX
9328  layout or a message about
9329 \begin_inset Quotes eld
9330 \end_inset
9331
9332 You should not mix title layouts with normal ones
9333 \begin_inset Quotes erd
9334 \end_inset
9335
9336 ,
9337  things haven't been installed correctly.
9338 \end_layout
9339
9340 \begin_layout Paragraph
9341 \SpecialChar LaTeX
9342  error processing a table
9343 \end_layout
9344
9345 \begin_layout Standard
9346 \SpecialChar LyX
9347 ,
9348  by default,
9349  attempts to center the table caption/title.
9350  This seems to produce a bad interaction in AAS\SpecialChar TeX
9351  so you should click somewhere in the caption/title,
9352  then select
9353 \family sans
9354 Edit\SpecialChar menuseparator
9355 Paragraph
9356 \begin_inset space ~
9357 \end_inset
9358
9359 Settings
9360 \family default
9361 ,
9362  then set the
9363 \family sans
9364 Alignment
9365 \family default
9366  to
9367 \family sans
9368 Block
9369 \family default
9370 .
9371  This took care of it for me.
9372 \end_layout
9373
9374 \begin_layout Paragraph
9375 References
9376 \end_layout
9377
9378 \begin_layout Standard
9379 A couple of things:
9380
9381 \change_inserted -712698321 1673170733
9382
9383 \end_layout
9384
9385 \begin_layout Enumerate
9386
9387 \change_deleted -712698321 1673170736
9388 1)
9389 \change_unchanged
9390 I have noticed some funny spacing in the reference entries in the text.
9391  When you enter the bibliography item data,
9392  make sure their is
9393 \emph on
9394 no
9395 \emph default
9396  space between the last author and the parenthesis setting off the year;
9397
9398 \emph on
9399 e.
9400 \begin_inset space \thinspace{}
9401 \end_inset
9402
9403 g.
9404 \begin_inset space \space{}
9405 \end_inset
9406
9407
9408 \emph default
9409 type
9410 \family typewriter
9411 Ressler(1992)
9412 \family default
9413 ,
9414  not
9415 \family typewriter
9416 Ressler (1992)
9417 \family default
9418 .
9419
9420 \change_deleted -712698321 1673170741
9421 2)
9422 \change_inserted -712698321 1673170741
9423
9424 \end_layout
9425
9426 \begin_layout Enumerate
9427 Entering the references at all is not obvious.
9428  The easiest thing is to start typing your first reference at the end of the document,
9429  then mark it as type
9430 \family sans
9431 References
9432 \family default
9433 .
9434  That will put a small gray box in front of what you just typed.
9435  Click on the box to fill in the rest of the information.
9436  For new references,
9437  go to the end of an existing reference and press return.
9438  That will create a new line with its own box,
9439  etc.
9440 \end_layout
9441
9442 \begin_layout Paragraph
9443 Including EPS files
9444 \end_layout
9445
9446 \begin_layout Standard
9447 Even though AAS\SpecialChar TeX
9448  provides its own figure commands (
9449 \family typewriter
9450
9451 \backslash
9452 plotone
9453 \family default
9454 ,
9455  for example),
9456  I much prefer \SpecialChar LaTeX
9457 's standard figure commands (with the default graphicx).
9458  You can insert the
9459 \family typewriter
9460
9461 \backslash
9462 plotone
9463 \family default
9464 ,
9465  etc.
9466 \begin_inset space ~
9467 \end_inset
9468
9469 commands as \SpecialChar TeX
9470  code into a Figure Float box if you desire,
9471  but I never have much luck getting the layout right.
9472  With the standard graphics,
9473  \SpecialChar LyX
9474  will insert a
9475 \family typewriter
9476
9477 \backslash
9478 usepackage{graphicx}
9479 \family default
9480  command into the \SpecialChar LaTeX
9481  preamble and handle the figures in the standard \SpecialChar LaTeX2e
9482  way,
9483  interspersing the figures in the text.
9484  I believe ApJ accepts figures exactly this way now;
9485  AJ might still use the
9486 \begin_inset Quotes eld
9487 \end_inset
9488
9489 stack everything at the end
9490 \begin_inset Quotes erd
9491 \end_inset
9492
9493  technique.
9494 \end_layout
9495
9496 \begin_layout Paragraph
9497 Things I could have done,
9498  but didn't
9499 \end_layout
9500
9501 \begin_layout Standard
9502 There are a few
9503 \begin_inset Quotes eld
9504 \end_inset
9505
9506 pretty
9507 \begin_inset Quotes erd
9508 \end_inset
9509
9510  things I could have implemented,
9511  but chose not to.
9512  For instance,
9513  I saw no point in double-spacing the text in the \SpecialChar LyX
9514  window,
9515  even though it is double-spaced in the paper manuscript.
9516  Also,
9517  I chose not to make separate layouts for the preprint and preprint2 styles.
9518  Since I assume you will spend most of your time in the plain manuscript mode anyway,
9519  I decided not to chew up more disk space with this.
9520
9521 \end_layout
9522
9523 \begin_layout Subsubsection
9524 Final Caveat
9525 \end_layout
9526
9527 \begin_layout Standard
9528 Your mileage may vary.
9529  I've now had papers published by both ApJ and AJ that have had 98% of the effort done in \SpecialChar LyX
9530 ;
9531  the last 2% was the \SpecialChar LaTeX
9532  post-processing and a few cleanups.
9533  I have had no trouble with the submission process,
9534  and I'm sure the journals were never aware that there might be a difference.
9535  So,
9536  go forth and publish!
9537 \end_layout
9538
9539 \begin_layout Subsection
9540
9541 \change_inserted 564990737 1671442131
9542 Chess
9543 \end_layout
9544
9545 \begin_layout Standard
9546
9547 \change_inserted 564990737 1671642768
9548 The document class
9549 \change_deleted -712698321 1673171415
9550
9551 \family sans
9552 article
9553 \begin_inset space \thinspace{}
9554 \end_inset
9555
9556 (
9557 \change_inserted 564990737 1671642768
9558 Chess
9559 \change_deleted -712698321 1673171417
9560 )
9561 \change_inserted 564990737 1671642768
9562
9563 \family default
9564  uses the
9565 \change_deleted -712698321 1673171421
9566
9567 \family typewriter
9568 article.cls
9569 \family default
9570
9571 \change_inserted -712698321 1673171424
9572 standard article
9573 \change_inserted 564990737 1671642768
9574 document class together with the
9575 \change_deleted -712698321 1673171428
9576 style
9577 \change_inserted -712698321 1673171429
9578 package
9579 \change_inserted 564990737 1671642768
9580
9581 \family sans
9582 lyxskak
9583 \change_deleted -712698321 1673171431
9584 .sty
9585 \change_inserted 564990737 1671642768
9586
9587 \family default
9588  to facilitate the description of chess games.
9589  See
9590 \family sans
9591 File\SpecialChar menuseparator
9592 Open Example\SpecialChar menuseparator
9593 Articles\SpecialChar menuseparator
9594 Chess
9595 \family default
9596  where you will find
9597 \family sans
9598 Game 1
9599 \family default
9600  and
9601 \family sans
9602 Game 2
9603 \family default
9604 .
9605 \end_layout
9606
9607 \begin_layout Subsection
9608
9609 \change_inserted 564990737 1671042028
9610 Elsevier
9611 \end_layout
9612
9613 \begin_layout Standard
9614
9615 \change_inserted 564990737 1671617396
9616 The document class
9617 \change_deleted -712698321 1673171640
9618
9619 \family sans
9620 article
9621 \begin_inset space \thinspace{}
9622 \end_inset
9623
9624 (
9625 \change_inserted 564990737 1671617396
9626 Elsevier
9627 \change_deleted -712698321 1673171643
9628 )
9629 \change_inserted 564990737 1671617396
9630
9631 \family default
9632  provides
9633 \change_inserted -712698321 1673171717
9634 support for
9635 \change_inserted 564990737 1671617396
9636 the
9637 \family typewriter
9638 elsarticle
9639 \change_deleted -712698321 1673171720
9640 .cls
9641 \change_inserted 564990737 1671617396
9642
9643 \family default
9644
9645 \change_deleted -712698321 1673171728
9646 document
9647 \change_inserted -712698321 1673171728
9648 \SpecialChar LaTeX
9649
9650 \change_inserted 564990737 1671617396
9651  class
9652 \change_inserted -712698321 1673171744
9653  for journals in the Elsevier publishing house
9654 \change_inserted 564990737 1671617396
9655 .
9656  This provides the following additional environments:
9657
9658 \family sans
9659 Title
9660 \begin_inset space ~
9661 \end_inset
9662
9663 footnote
9664 \family default
9665 ,
9666
9667 \family sans
9668 Author
9669 \begin_inset space ~
9670 \end_inset
9671
9672 footnote
9673 \family default
9674 ,
9675
9676 \family sans
9677 Corresponding
9678 \begin_inset space ~
9679 \end_inset
9680
9681 author
9682 \family default
9683 ,
9684
9685 \family sans
9686 Address
9687 \family default
9688 ,
9689
9690 \family sans
9691 Email
9692 \family default
9693  and
9694 \family sans
9695 Keywords
9696 \family default
9697 .
9698
9699 \change_inserted -712698321 1673172045
9700
9701 \end_layout
9702
9703 \begin_layout Standard
9704
9705 \change_inserted 564990737 1671617396
9706 A template is available in the menu
9707 \family sans
9708 \bar under
9709 F
9710 \bar default
9711 ile\SpecialChar menuseparator
9712 New
9713 \begin_inset space ~
9714 \end_inset
9715
9716 fro
9717 \bar under
9718 m
9719 \bar default
9720
9721 \begin_inset space ~
9722 \end_inset
9723
9724 Template\SpecialChar menuseparator
9725 Articles\SpecialChar menuseparator
9726 Elsevier
9727 \family default
9728 .
9729  It has been customized with further environments and contains all the information you may need.
9730  However,
9731  the documentation is also available from
9732 \begin_inset CommandInset href
9733 LatexCommand href
9734 name "CTAN"
9735 target "http://mirrors.ctan.org/macros/latex/contrib/elsarticle/doc/elsdoc.pdf"
9736 literal "false"
9737
9738 \end_inset
9739
9740 .
9741 \end_layout
9742
9743 \begin_layout Subsection
9744
9745 \change_inserted 564990737 1671042046
9746 Paper
9747 \end_layout
9748
9749 \begin_layout Standard
9750
9751 \change_inserted 564990737 1671042046
9752 The document class
9753 \change_deleted -712698321 1673172423
9754
9755 \family sans
9756 article
9757 \begin_inset space \thinspace{}
9758 \end_inset
9759
9760 (paper
9761 \change_inserted -712698321 1673172423
9762 Paper (Standard Class)
9763 \change_deleted -712698321 1673172423
9764 )
9765 \change_inserted 564990737 1671042046
9766
9767 \family default
9768  provides an alternative to the
9769 \change_deleted -712698321 1673172092
9770
9771 \family typewriter
9772 article.cls
9773 \change_inserted -712698321 1673172435
9774
9775 \family sans
9776 Article (Standard Class)
9777 \change_inserted 564990737 1671042046
9778
9779 \family default
9780  document class.
9781  It provides similar functionality,
9782  but you might prefer this layout with sans serif sections,
9783  headings,
9784  and more.
9785 \end_layout
9786
9787 \begin_layout Subsection
9788 Rev\SpecialChar TeX
9789 4
9790 \end_layout
9791
9792 \begin_layout Standard
9793 by
9794 \noun on
9795 Amir Karger
9796 \end_layout
9797
9798 \begin_layout Standard
9799 \begin_inset VSpace bigskip
9800 \end_inset
9801
9802
9803 \end_layout
9804
9805 \begin_layout Standard
9806 \noindent
9807 The
9808 \family sans
9809 Rev
9810 \change_deleted -712698321 1673172482
9811 tex
9812 \begin_inset space ~
9813 \end_inset
9814
9815 4
9816 \change_inserted -712698321 1673172487
9817 TeX (V.
9818 \begin_inset space \thinspace{}
9819 \end_inset
9820
9821 4)
9822 \change_unchanged
9823
9824 \family default
9825  textclass works with the American Physical Sociey's Rev\SpecialChar TeX
9826  4.0 (the
9827 \begin_inset Formula $\beta$
9828 \end_inset
9829
9830  release of May,
9831  1999) class.
9832 \end_layout
9833
9834 \begin_layout Standard
9835 \SpecialChar LyX
9836  has a
9837 \family sans
9838 R
9839 \change_deleted -712698321 1673172511
9840 evtex
9841 \change_inserted -712698321 1673172517
9842 EVTeX (obsolete)
9843 \change_unchanged
9844
9845 \family default
9846  textclass,
9847  which works with Rev\SpecialChar TeX
9848  3.1.
9849  However,
9850  v3.1 is basically obsolete,
9851  as it works with \SpecialChar LaTeX
9852  2.09.
9853  That means that it doesn't interact very well with \SpecialChar LyX
9854 ,
9855  which requires \SpecialChar LaTeX2e
9856 ,
9857  although it has been kludged to work.
9858  Since Rev\SpecialChar TeX
9859  4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
9860 ,
9861  \SpecialChar LyX
9862  with the
9863 \change_deleted -712698321 1673172538
9864
9865 \family sans
9866 Rev\SpecialChar TeX
9867
9868 \begin_inset space ~
9869 \end_inset
9870
9871 4
9872 \change_inserted -712698321 1673172538
9873 Revtex
9874 \begin_inset space ~
9875 \end_inset
9876
9877 4TeX (V.
9878 \begin_inset space \thinspace{}
9879 \end_inset
9880
9881 4)
9882 \change_unchanged
9883
9884 \family default
9885  textclass should also be pretty easy to use.
9886 \end_layout
9887
9888 \begin_layout Standard
9889 These documents are supposed to be used in
9890 \emph on
9891 addition
9892 \emph default
9893  to the Rev\SpecialChar TeX
9894  4.0 documents,
9895  so we don't describe any of the special Rev\SpecialChar TeX
9896  macros,
9897  and assume you'll know what to put in the preamble if necessary.
9898 \end_layout
9899
9900 \begin_layout Subsubsection
9901 Installation
9902 \end_layout
9903
9904 \begin_layout Standard
9905 All you need to do is install Rev\SpecialChar TeX
9906  4,
9907  as described in the package's README file.
9908  The package can be found at The Rev\SpecialChar TeX
9909  4 Web Site
9910 \begin_inset Flex URL
9911 status collapsed
9912
9913 \begin_layout Plain Layout
9914
9915 http://publish.aps.org/revtex4/
9916 \end_layout
9917
9918 \end_inset
9919
9920 .
9921  Install it somewhere that \SpecialChar LaTeX
9922  can see it.
9923  Test it by trying to \SpecialChar LaTeX
9924  a short Rev\SpecialChar TeX
9925  4 document in some random directory (i.
9926 \begin_inset space \thinspace{}
9927 \end_inset
9928
9929 e.
9930 \begin_inset space \space{}
9931 \end_inset
9932
9933 not the directory where you installed the class file.) Then,
9934  if you reconfigure \SpecialChar LyX
9935 ,
9936  it will find the class file and let you use the Rev\SpecialChar TeX
9937 4 textclass.
9938 \end_layout
9939
9940 \begin_layout Standard
9941 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
9942  4 document using
9943 \family typewriter
9944 tex2lyx
9945 \family default
9946 ,
9947  or to use the
9948 \family sans
9949 Revtex
9950 \begin_inset space ~
9951 \end_inset
9952
9953 4
9954 \family default
9955  template,
9956  found in
9957 \change_deleted -712698321 1673172641
9958 the templates directory
9959 \change_inserted -712698321 1673172687
9960
9961 \family sans
9962 File\SpecialChar menuseparator
9963 New From Templates\SpecialChar menuseparator
9964 Articles
9965 \change_unchanged
9966
9967 \family default
9968 .
9969 \end_layout
9970
9971 \begin_layout Subsubsection
9972 Preamble Matter
9973 \end_layout
9974
9975 \begin_layout Standard
9976 Optional arguments to
9977 \family typewriter
9978
9979 \backslash
9980 documentclass
9981 \family default
9982 ,
9983  like
9984 \begin_inset Quotes eld
9985 \end_inset
9986
9987 preprint
9988 \begin_inset Quotes erd
9989 \end_inset
9990
9991  and
9992 \begin_inset Quotes eld
9993 \end_inset
9994
9995 aps
9996 \begin_inset Quotes erd
9997 \end_inset
9998
9999 ,
10000  go in the
10001 \family sans
10002 Extra
10003 \begin_inset space ~
10004 \end_inset
10005
10006 Options
10007 \family default
10008  field in the
10009 \family sans
10010 Document
10011 \begin_inset space ~
10012 \end_inset
10013
10014 Layout
10015 \family default
10016  dialog,
10017  as usual.
10018  Remember that in Rev\SpecialChar TeX
10019 ,
10020  at least one optional argument is required!
10021
10022 \end_layout
10023
10024 \begin_layout Standard
10025 Other preamble matter,
10026  like
10027 \family typewriter
10028
10029 \backslash
10030 draft
10031 \family default
10032  etc.
10033 \begin_inset space ~
10034 \end_inset
10035
10036 goes in the
10037 \family sans
10038 \SpecialChar LaTeX
10039
10040 \begin_inset space ~
10041 \end_inset
10042
10043 Preamble
10044 \family default
10045  dialog,
10046  also as usual.
10047 \end_layout
10048
10049 \begin_layout Subsubsection
10050 Layouts
10051 \end_layout
10052
10053 \begin_layout Standard
10054 The layouts basically correspond to the commands in Rev\SpecialChar TeX
10055 4.0.
10056  For example,
10057  the Email layout corresponds to
10058 \family typewriter
10059
10060 \backslash
10061 email{}
10062 \family default
10063 .
10064  Note that (at least as of Rev\SpecialChar TeX
10065  4.0 Beta),
10066  the
10067 \family sans
10068 Address
10069 \family default
10070  and
10071 \family sans
10072 Affiliation
10073 \family default
10074  layouts are exactly equivalent,
10075  so you shouldn't need to use both.
10076 \begin_inset Foot
10077 status collapsed
10078
10079 \begin_layout Plain Layout
10080 In case you're curious,
10081  both were included so that
10082 \family typewriter
10083 tex2lyx
10084 \family default
10085  would be able to translate both
10086 \family typewriter
10087
10088 \backslash
10089 address
10090 \family default
10091  and
10092 \family typewriter
10093
10094 \backslash
10095 affiliation
10096 \family default
10097 .
10098 \end_layout
10099
10100 \end_inset
10101
10102
10103 \end_layout
10104
10105 \begin_layout Subsubsection
10106 Important Notes
10107 \end_layout
10108
10109 \begin_layout Standard
10110 There are a couple of important unique aspects of Rev\SpecialChar TeX
10111  4 which might cause bugs that will be even more confusing in \SpecialChar LyX
10112 .
10113 \end_layout
10114
10115 \begin_layout Standard
10116 In Rev\SpecialChar TeX
10117 ,
10118  the
10119 \family typewriter
10120
10121 \backslash
10122 thanks
10123 \family default
10124  command goes
10125 \emph on
10126 outside
10127 \emph default
10128  the
10129 \family typewriter
10130
10131 \backslash
10132 author
10133 \family default
10134  command.
10135  The \SpecialChar LyX
10136  equivalent is that there is a separate Thanks layout.
10137  Do
10138 \emph on
10139 not
10140 \emph default
10141  write footnotes in the
10142 \family sans
10143 Author
10144 \family default
10145  layout,
10146  or weird things may happen.
10147  See the Rev\SpecialChar TeX
10148  4 documentation for more details.
10149 \end_layout
10150
10151 \begin_layout Standard
10152 Also,
10153  the
10154 \family sans
10155 Author
10156 \begin_inset space ~
10157 \end_inset
10158
10159 Email
10160 \family default
10161 ,
10162
10163 \family sans
10164 Author
10165 \begin_inset space ~
10166 \end_inset
10167
10168 URL
10169 \family default
10170 ,
10171  and
10172 \family sans
10173 Thanks
10174 \family default
10175  layouts must be placed
10176 \emph on
10177 in between
10178 \emph default
10179  the
10180 \family sans
10181 Author
10182 \family default
10183  layout and the corresponding
10184 \family sans
10185 Address
10186 \family default
10187  (or equivalent
10188 \family sans
10189 Affiliation
10190 \family default
10191 ) layout.
10192  If you put the
10193 \family sans
10194 Thanks
10195 \family default
10196  after the
10197 \family sans
10198 Address
10199 \family default
10200 ,
10201  the \SpecialChar LaTeX
10202  won't compile.
10203 \end_layout
10204
10205 \begin_layout Subsection
10206
10207 \change_inserted 564990737 1671042072
10208 Springer Journals
10209 \end_layout
10210
10211 \begin_layout Standard
10212
10213 \change_inserted 564990737 1671042072
10214 All the
10215 \family sans
10216 svj*
10217 \family default
10218  classes were replaced
10219 \change_deleted -712698321 1673176131
10220 in 2013
10221 \change_inserted 564990737 1671042072
10222 with a completely new
10223 \change_deleted -712698321 1673175919
10224
10225 \family sans
10226 sr-vorl.cls
10227 \family default
10228 .
10229  This package provides a \SpecialChar LaTeX
10230  class and templates for books to be published at Springer Gabler Research,
10231  Springer Vieweg Research,
10232  Springer Spektrum Research,
10233  Springer VS Research,
10234  or Springer VS Forschung.
10235  The documentation is available in German from
10236 \begin_inset CommandInset href
10237 LatexCommand href
10238 name "CTAN"
10239 target "http://mirrors.ctan.org/macros/latex/contrib/springer/sr-vorl/sr-vorl.pdf"
10240 literal "false"
10241
10242 \end_inset
10243
10244 .
10245
10246 \change_inserted -712698321 1673176125
10247  class,
10248
10249 \family sans
10250 sn-jnl.cls
10251 \family default
10252 .
10253  Please find information at
10254 \begin_inset Flex URL
10255 status collapsed
10256
10257 \begin_layout Plain Layout
10258
10259 \change_inserted -712698321 1673176047
10260
10261 https://www.springernature.com/gp/authors/campaigns/latex-author-support
10262 \change_unchanged
10263
10264 \end_layout
10265
10266 \end_inset
10267
10268 .
10269  Native \SpecialChar LyX
10270  support is not available yet.
10271 \change_inserted 564990737 1671042072
10272
10273 \end_layout
10274
10275 \begin_layout Section
10276
10277 \change_inserted 564990737 1670439560
10278 Books
10279 \end_layout
10280
10281 \begin_layout Standard
10282
10283 \change_inserted 564990737 1670439581
10284 See also the document classes in the Collections (section
10285 \begin_inset space ~
10286 \end_inset
10287
10288
10289 \begin_inset CommandInset ref
10290 LatexCommand ref
10291 reference "sec:Collections"
10292 nolink "false"
10293
10294 \end_inset
10295
10296 ).
10297 \end_layout
10298
10299 \begin_layout Subsection
10300 Memoir
10301 \end_layout
10302
10303 \begin_layout Standard
10304 By
10305 \noun on
10306 Jürgen Spitzmüller
10307 \end_layout
10308
10309 \begin_layout Subsubsection
10310 Overview
10311 \end_layout
10312
10313 \begin_layout Standard
10314 Memoir is a very powerful and constantly evolving class.
10315  It has been designed with regard to fictional and non-fictional literature.
10316  Its aim is to let the user have maximum control over the typesetting of his document.
10317  Memoir is based on the standard book class,
10318  but it can also emulate the article class (see below).
10319 \end_layout
10320
10321 \begin_layout Standard
10322 Peter Wilson,
10323  the developer of Memoir,
10324  is known as the author of lots of useful packages in the \SpecialChar LaTeX
10325  world.
10326  Most of them have been merged with Memoir.
10327  Therefore,
10328  it is much easier to layout the table of contents,
10329  appendices,
10330  chapter designs and such.
10331  \SpecialChar LyX
10332 ,
10333  though,
10334  does not support all of these goodies natively.
10335  Some of them might be added to forthcoming releases
10336 \begin_inset Foot
10337 status collapsed
10338
10339 \begin_layout Plain Layout
10340 You are invited to send suggestions to
10341 \begin_inset Flex URL
10342 status collapsed
10343
10344 \begin_layout Plain Layout
10345
10346 lyx-devel@lists.lyx.org
10347 \end_layout
10348
10349 \end_inset
10350
10351 .
10352 \end_layout
10353
10354 \end_inset
10355
10356 ,
10357  lots will probably never be supported,
10358  due to the limitations of \SpecialChar LyX
10359 's framework.
10360  Of course you can still use all features with the help of some native \SpecialChar LaTeX
10361  commands (\SpecialChar TeX
10362  code
10363 \begin_inset Foot
10364 status collapsed
10365
10366 \begin_layout Plain Layout
10367 Cf.
10368 \begin_inset ERT
10369 status collapsed
10370
10371 \begin_layout Plain Layout
10372
10373
10374 \backslash
10375
10376 \end_layout
10377
10378 \end_inset
10379
10380 section
10381 \begin_inset space ~
10382 \end_inset
10383
10384
10385 \begin_inset CommandInset ref
10386 LatexCommand ref
10387 reference "sec:Inserting-TeX-Code"
10388 nolink "false"
10389
10390 \end_inset
10391
10392  for details.
10393 \end_layout
10394
10395 \end_inset
10396
10397 ).
10398  In this section,
10399  we can only list those features that are natively supported by \SpecialChar LyX
10400 .
10401  For detailed descriptions (and for the rest of features) we recommend you have a look at the detailed manual of the Memoir class
10402 \begin_inset Foot
10403 status collapsed
10404
10405 \begin_layout Plain Layout
10406 Cf.
10407 \begin_inset ERT
10408 status collapsed
10409
10410 \begin_layout Plain Layout
10411
10412
10413 \backslash
10414
10415 \end_layout
10416
10417 \end_inset
10418
10419
10420 \begin_inset Flex URL
10421 status collapsed
10422
10423 \begin_layout Plain Layout
10424
10425 CTAN:/macros/latex/memoir/memman.pdf
10426 \end_layout
10427
10428 \end_inset
10429
10430 .
10431 \end_layout
10432
10433 \end_inset
10434
10435 ,
10436  which is not only a user guide for the class,
10437  but also both a comprehensive description on good typesetting and a superb example for good typesetting itself.
10438 \end_layout
10439
10440 \begin_layout Subsubsection
10441 Basic features and restrictions
10442 \end_layout
10443
10444 \begin_layout Standard
10445 Memoir supports basically all features of the standard book classes.
10446  There are,
10447  however,
10448  some differences,
10449  as follows:
10450 \end_layout
10451
10452 \begin_layout Description
10453 Font
10454 \begin_inset space ~
10455 \end_inset
10456
10457 sizes:
10458  Memoir has a broader range of font sizes:
10459  9,
10460  10,
10461  11,
10462  12,
10463  14,
10464  17
10465 \end_layout
10466
10467 \begin_layout Description
10468 Page
10469 \begin_inset space ~
10470 \end_inset
10471
10472 style:
10473  The fancy page style is not supported,
10474  due to a command clash between Memoir and the fancyhdr package (they both define a command with the same name,
10475  which confuses \SpecialChar LaTeX
10476 ).
10477  Instead,
10478  Memoir comes with a number of its own page styles (see
10479 \family sans
10480 Document\SpecialChar menuseparator
10481 Settings\SpecialChar menuseparator
10482 Page
10483 \begin_inset space ~
10484 \end_inset
10485
10486 Style
10487 \family default
10488 ).
10489  If you want to use these for the chapter pages,
10490  you have to use the command
10491 \family typewriter
10492
10493 \backslash
10494 chapterstyle
10495 \family default
10496  in the main text or in preamble (e.
10497 \begin_inset space \thinspace{}
10498 \end_inset
10499
10500 g.
10501 \begin_inset space \space{}
10502 \end_inset
10503
10504
10505 \family typewriter
10506
10507 \backslash
10508 chapterstyle{companion}
10509 \family default
10510 ).
10511 \end_layout
10512
10513 \begin_layout Description
10514 Sectioning:
10515  Sectionings (chapter,
10516  section,
10517  subsection etc.) come with an optional argument in the standard classes.
10518  With this,
10519  you can specify an alternative version of the title for the table of contents and the headers (for instance,
10520  if the title is too long).
10521  In \SpecialChar LyX
10522 ,
10523  you can do this via
10524 \family sans
10525 Insert\SpecialChar menuseparator
10526 Short
10527 \begin_inset space ~
10528 \end_inset
10529
10530 Title
10531 \family default
10532  at the beginning of a chapter/section.
10533  Memoir features a second optional argument and thus separates the table of contents from the header.
10534  You can define three variants of a title with this:
10535  one for the main text,
10536  one for the table of contents,
10537  and one for the headers.
10538  \SpecialChar LyX
10539  makes these available in form of specific
10540 \family sans
10541 Short Title
10542 \family default
10543  variants in the
10544 \family sans
10545 Insert
10546 \family default
10547  menu.
10548 \end_layout
10549
10550 \begin_layout Description
10551 TOC/LOT/LOF:
10552  In the standard classes (and in many other classes),
10553  the table of contents,
10554  the list of figures and the list of table start a new page automatically.
10555  Memoir does not follow this route.
10556  You have to insert a page break yourself,
10557  if you want to have one.
10558 \end_layout
10559
10560 \begin_layout Description
10561 Titlepage:
10562  For some unknown reason,
10563  Memoir uses pagination on the title page (in the standard classes,
10564  title pages are
10565 \begin_inset Quotes eld
10566 \end_inset
10567
10568 empty
10569 \begin_inset Quotes erd
10570 \end_inset
10571
10572 ).
10573  If you want an empty title page,
10574  type
10575 \family typewriter
10576
10577 \backslash
10578 aliaspagestyle{title}{empty}
10579 \family default
10580  in the preamble.
10581 \end_layout
10582
10583 \begin_layout Description
10584 Article:
10585  With the class option
10586 \emph on
10587 article
10588 \emph default
10589  (to be inserted in
10590 \family sans
10591 Document\SpecialChar menuseparator
10592 Settings\SpecialChar menuseparator
10593 Class Settings\SpecialChar menuseparator
10594 Custom
10595 \begin_inset space ~
10596 \end_inset
10597
10598 Options
10599 \family default
10600 ),
10601  you can emulate article style.
10602  That is,
10603  counters (footnotes,
10604  figures,
10605  tables etc.) will not be reset on new chapters,
10606  chapters don't start a new page (but are—
10607 in contrary to
10608 \begin_inset Quotes eld
10609 \end_inset
10610
10611 real
10612 \begin_inset Quotes erd
10613 \end_inset
10614
10615  article classes—
10616 still allowed),
10617  parts,
10618  though,
10619  use their own page,
10620  as in book.
10621 \end_layout
10622
10623 \begin_layout Description
10624 Oldfontcommands:
10625  By default,
10626  Memoir does not allow the use of the deprecated font commands,
10627  which have been used in the old \SpecialChar LaTeX
10628  version 2.09 (e.
10629 \begin_inset space \thinspace{}
10630 \end_inset
10631
10632 g.
10633 \begin_inset space \space{}
10634 \end_inset
10635
10636
10637 \family typewriter
10638
10639 \backslash
10640 rm
10641 \family default
10642 ,
10643
10644 \family typewriter
10645
10646 \backslash
10647 it
10648 \family default
10649 ).
10650  It produces an error and stops \SpecialChar LaTeX
10651  whenever such a command appears.
10652  The class option
10653 \emph on
10654 oldfontcommands
10655 \emph default
10656  reallows the commands and spits out warnings instead (which does at least not stop \SpecialChar LaTeX
10657 ).
10658  Since a lot of packages and particularly Bib\SpecialChar TeX
10659  style files are still using those commands,
10660  we have decided to use this option by default.
10661 \end_layout
10662
10663 \begin_layout Subsubsection
10664 Extra features
10665 \end_layout
10666
10667 \begin_layout Standard
10668 We will only describe the features supported by \SpecialChar LyX
10669  (which is not much currently).
10670  Please consult the Memoir manual
10671 \begin_inset Foot
10672 status collapsed
10673
10674 \begin_layout Plain Layout
10675 Cf.
10676 \begin_inset ERT
10677 status collapsed
10678
10679 \begin_layout Plain Layout
10680
10681
10682 \backslash
10683
10684 \end_layout
10685
10686 \end_inset
10687
10688
10689 \begin_inset Flex URL
10690 status collapsed
10691
10692 \begin_layout Plain Layout
10693
10694 CTAN:/macros/latex/memoir/memman.pdf
10695 \end_layout
10696
10697 \end_inset
10698
10699 .
10700 \end_layout
10701
10702 \end_inset
10703
10704  for details.
10705 \end_layout
10706
10707 \begin_layout Description
10708 Abstract:
10709  You may wonder why an abstract is an extra feature.
10710  Well,
10711  it is in book class.
10712  Usually books don't have abstracts.
10713  Memoir,
10714  however,
10715  has.
10716  You can use it wherever and how often you like.
10717 \end_layout
10718
10719 \begin_layout Description
10720 Chapterprecis:
10721  You may know this older typesetting style:
10722  The contents of a chapter are summarized below the title and also in the table of contents (e.
10723 \begin_inset space \thinspace{}
10724 \end_inset
10725
10726 g.
10727 \begin_inset space \space{}
10728 \end_inset
10729
10730
10731 \emph on
10732 Our hero arrives in Troia;
10733  he loses some friends;
10734  he finds others
10735 \emph default
10736 ).
10737  Chapterprecis does exactly this.
10738  It is therefore only sensible below a chapter.
10739 \end_layout
10740
10741 \begin_layout Description
10742 Epigraph:
10743  An epigraph is a smart slogan or motto at the beginning of a chapter.
10744  The epigraph environment provides an elegant way of typesetting such a motto.
10745  The motto itself (text) and its (optional) author (source) are divided by a short line.
10746  The author (source) can be inserted via
10747 \family sans
10748 Insert\SpecialChar menuseparator
10749 Epigraph Source
10750 \family default
10751 \emph on
10752 .
10753 \end_layout
10754
10755 \begin_layout Description
10756 Poemtitle:
10757  Memoir has lots of possibilities to typeset poetry (up to very complex figurative poems).
10758  \SpecialChar LyX
10759  can only support a few of them.
10760  One is poemtitle,
10761  which is a centered title for poems,
10762  which will also be added to the table of contents (verse is the standard environment for poems.
10763  Memoir has some enhanced versions of verse,
10764  but you need to use \SpecialChar TeX
10765  code,
10766  because they have to be nested inside regular verse environments,
10767  which is not possible with \SpecialChar LyX
10768 ).
10769 \end_layout
10770
10771 \begin_layout Description
10772 Poemtitle*:
10773  Same as poemtitle,
10774  but it adds no entry to the table of contents.
10775 \end_layout
10776
10777 \begin_layout Subsection
10778
10779 \change_inserted 564990737 1671442175
10780 Recipe Book
10781 \end_layout
10782
10783 \begin_layout Standard
10784
10785 \change_inserted 564990737 1671442175
10786 The document class
10787 \family sans
10788 Recipe
10789 \change_inserted -712698321 1673182264
10790
10791 \change_inserted 564990737 1671442175
10792 Book
10793 \change_deleted -712698321 1673182266
10794
10795 \family typewriter
10796 .cls
10797 \change_inserted 564990737 1671442175
10798
10799 \family default
10800  uses the
10801 \change_deleted -712698321 1673182282
10802
10803 \family sans
10804 book
10805 \begin_inset space \thinspace{}
10806 \end_inset
10807
10808 (
10809 \change_inserted 564990737 1671442175
10810 KOMA-Script
10811 \change_inserted -712698321 1673182287
10812  Book
10813 \change_deleted -712698321 1673182290
10814 )
10815 \change_inserted 564990737 1671442175
10816
10817 \family default
10818  document class but adds two environments:
10819 \end_layout
10820
10821 \begin_layout Description
10822
10823 \change_inserted 564990737 1671442175
10824 Recipe a numbered section environment at the
10825 \family typewriter
10826 Subsubsection
10827 \family default
10828  level which generates a bold centered heading above a double horizontal rule
10829 \end_layout
10830
10831 \begin_layout Description
10832
10833 \change_inserted 564990737 1671442175
10834 Ingredients a
10835 \family typewriter
10836 Description
10837 \family default
10838  environment where
10839 \series bold
10840 \emph on
10841 Ingredients
10842 \series default
10843 \emph default
10844  are what are being described and the environment ends with a horizontal rule.
10845 \end_layout
10846
10847 \begin_layout Standard
10848
10849 \change_inserted 564990737 1671642866
10850
10851 \family sans
10852 File\SpecialChar menuseparator
10853 Open Example\SpecialChar menuseparator
10854 Books\SpecialChar menuseparator
10855 Recipe Book
10856 \family default
10857  illustrates its use.
10858 \end_layout
10859
10860 \begin_layout Standard
10861
10862 \change_deleted -712698321 1673186391
10863 It
10864 \change_inserted -712698321 1673186393
10865 The class
10866 \change_inserted 564990737 1671442175
10867  is designed for typesetting one or two recipes per page
10868 \change_deleted -712698321 1673199172
10869 ,
10870  with dimensions of 5.5
10871 \begin_inset Quotes qrd
10872 \end_inset
10873
10874  x 8.5
10875 \begin_inset Quotes qrd
10876 \end_inset
10877
10878
10879 \change_inserted 564990737 1671442175
10880 .
10881  The hyperlinked table of contents (ToC) and page numbers make browsing recipes convenient
10882 \change_inserted -712698321 1673186486
10883 .
10884 \change_deleted -712698321 1673186487
10885 ,
10886
10887 \change_inserted 564990737 1671442175
10888
10889 \change_deleted -712698321 1673199346
10890 and the pages can be joined together or printed 2 per page to normal letterpaper easily.
10891  The size was chosen to work in half-page 3-ring binder cover sheets,
10892  because un-laminated paper just doesn't last in the kitchen.
10893 \end_layout
10894
10895 \begin_layout Standard
10896
10897 \change_deleted -712698321 1673199346
10898 The half-letter pages can be printed two per page using your printer driver,
10899  or bound together using
10900 \family typewriter
10901 pdfjam --nup 2x1 --papersize '{11in,8.5in}'
10902 \family default
10903
10904 \family typewriter
10905 Recipes.pdf
10906 \family default
10907  where
10908 \family typewriter
10909 Recipes.pdf
10910 \family default
10911  is the compiled version of your recipes.
10912 \change_inserted -712698321 1673175424
10913
10914 \end_layout
10915
10916 \begin_layout Section
10917
10918 \change_inserted 564990737 1671442207
10919 Curricula vita
10920 \change_deleted -712698321 1673186818
10921 rum
10922 \change_inserted -712698321 1673186818
10923 e
10924 \change_inserted 564990737 1671442207
10925
10926 \end_layout
10927
10928 \begin_layout Subsection
10929
10930 \change_inserted 564990737 1671442208
10931 Europass
10932 \change_inserted -712698321 1673187876
10933  (2013)
10934 \change_inserted 564990737 1671442208
10935
10936 \end_layout
10937
10938 \begin_layout Standard
10939
10940 \change_inserted 564990737 1671642942
10941 The document class
10942 \change_deleted -712698321 1673187623
10943
10944 \family sans
10945 curriculum
10946 \begin_inset space \space{}
10947 \end_inset
10948
10949 vitae
10950 \begin_inset space \thinspace{}
10951 \end_inset
10952
10953 (
10954 \change_inserted 564990737 1671642942
10955 Europass
10956 \change_inserted -712698321 1673187655
10957  (2013)
10958 \change_deleted -712698321 1673187624
10959 )
10960 \change_inserted 564990737 1671642942
10961
10962 \family default
10963  provides the
10964 \family typewriter
10965 europasscv.cls
10966 \family default
10967  document class,
10968  an unofficial implementation of the ‘Europass CV’ recommended by the European Commission in 2013.
10969
10970 \family sans
10971 File\SpecialChar menuseparator
10972 Open Example\SpecialChar menuseparator
10973 Curricula Vitae\SpecialChar menuseparator
10974 Europass
10975 \change_deleted -712698321 1673187728
10976 CV
10977 \change_inserted 564990737 1671642942
10978 (2013)
10979 \family default
10980  offers guidance on its use.
10981  Its documentation is available from
10982 \begin_inset CommandInset href
10983 LatexCommand href
10984 name "CTAN"
10985 target "http://mirrors.ctan.org/macros/latex/contrib/europasscv/europasscv.pdf"
10986 literal "false"
10987
10988 \end_inset
10989
10990 .
10991 \end_layout
10992
10993 \begin_layout Subsection
10994
10995 \change_inserted 564990737 1671442208
10996 Europe
10997 \change_deleted -712698321 1673187829
10998 an
10999 \change_inserted -712698321 1673187829
11000  CV
11001 \change_inserted 564990737 1671442208
11002
11003 \end_layout
11004
11005 \begin_layout Standard
11006
11007 \change_inserted 564990737 1671642984
11008 The document class
11009 \change_deleted -712698321 1673187820
11010
11011 \family sans
11012 curriculum
11013 \begin_inset space \space{}
11014 \end_inset
11015
11016 vitae
11017 \begin_inset space \thinspace{}
11018 \end_inset
11019
11020 (
11021 \change_inserted 564990737 1671642984
11022 Europe
11023 \change_inserted -712698321 1673187823
11024  CV
11025 \change_deleted -712698321 1673187824
11026 )
11027 \change_inserted 564990737 1671642984
11028
11029 \family default
11030  provides the
11031 \family typewriter
11032 europecv.cls
11033 \family default
11034  document class,
11035  an unofficial implementation of the “Europass CV” recommended by the European Commission in 2002.
11036
11037 \family sans
11038 File\SpecialChar menuseparator
11039 Open Example\SpecialChar menuseparator
11040 Curricula Vitae\SpecialChar menuseparator
11041 Europe CV
11042 \family default
11043  offers guidance on its use.
11044  Its documentation is available from
11045 \begin_inset CommandInset href
11046 LatexCommand href
11047 name "CTAN"
11048 target "http://mirrors.ctan.org/macros/latex/contrib/europecv/europecv.pdf"
11049 literal "false"
11050
11051 \end_inset
11052
11053 .
11054 \end_layout
11055
11056 \begin_layout Subsection
11057
11058 \change_inserted 564990737 1671442208
11059 Modern
11060 \change_inserted -712698321 1673187869
11061  CV
11062 \change_inserted 564990737 1671442208
11063
11064 \end_layout
11065
11066 \begin_layout Standard
11067
11068 \change_inserted 564990737 1671643003
11069 The document class
11070 \change_deleted -712698321 1673187880
11071
11072 \family sans
11073 curriculum
11074 \begin_inset space \space{}
11075 \end_inset
11076
11077 vitae
11078 \begin_inset space \thinspace{}
11079 \end_inset
11080
11081 (m
11082 \change_inserted -712698321 1673187880
11083 M
11084 \change_inserted 564990737 1671643003
11085 odern
11086 \change_inserted -712698321 1673187884
11087  CV
11088 \change_deleted -712698321 1673187884
11089 )
11090 \change_inserted 564990737 1671643003
11091
11092 \family default
11093  provides the
11094 \family typewriter
11095 moderncv.cls
11096 \family default
11097  document class.
11098  This allows the creation of customizable CVs.
11099
11100 \family sans
11101 File\SpecialChar menuseparator
11102 Open Example\SpecialChar menuseparator
11103 Curricula Vitae\SpecialChar menuseparator
11104 Modern CV
11105 \family default
11106  offers guidance on its use.
11107  Its documentation is available from
11108 \begin_inset CommandInset href
11109 LatexCommand href
11110 name "CTAN"
11111 target "http://mirrors.ctan.org/macros/latex/contrib/moderncv/manual/moderncv_userguide.pdf"
11112 literal "false"
11113
11114 \end_inset
11115
11116 .
11117 \end_layout
11118
11119 \begin_layout Subsection
11120
11121 \change_inserted 564990737 1671442208
11122 Simple
11123 \change_inserted -712698321 1673187900
11124  CV
11125 \change_inserted 564990737 1671442208
11126
11127 \end_layout
11128
11129 \begin_layout Standard
11130
11131 \change_inserted 564990737 1671643024
11132 The document class
11133 \change_deleted -712698321 1673187895
11134
11135 \family sans
11136 curriculum
11137 \begin_inset space \space{}
11138 \end_inset
11139
11140 vitae
11141 \begin_inset space \thinspace{}
11142 \end_inset
11143
11144 (s
11145 \change_inserted -712698321 1673187895
11146 S
11147 \change_inserted 564990737 1671643024
11148 imple
11149 \change_inserted -712698321 1673187897
11150  CV
11151 \change_deleted -712698321 1673187898
11152 )
11153 \change_inserted 564990737 1671643024
11154
11155 \family default
11156  provides the
11157 \family typewriter
11158 simplecv.cls
11159 \family default
11160  document class,
11161  originally developed for use with \SpecialChar LyX
11162 .
11163
11164 \family sans
11165 File\SpecialChar menuseparator
11166 Open Example\SpecialChar menuseparator
11167 Curricula Vitae\SpecialChar menuseparator
11168 Simple CV
11169 \family default
11170  offers guidance on its use.
11171  Its documentation is available from
11172 \begin_inset CommandInset href
11173 LatexCommand href
11174 name "CTAN"
11175 target "http://mirrors.ctan.org/macros/latex/contrib/simplecv/simplecv.pdf"
11176 literal "false"
11177
11178 \end_inset
11179
11180
11181 \end_layout
11182
11183 \begin_layout Section
11184
11185 \change_inserted 564990737 1672652454
11186 Letters
11187 \end_layout
11188
11189 \begin_layout Standard
11190
11191 \change_inserted 564990737 1672652455
11192 See also the
11193 \change_deleted -712698321 1673245882
11194
11195 \family typewriter
11196 letter
11197 \begin_inset space \space{}
11198 \end_inset
11199
11200 (KOMA-Script v.2)
11201 \change_inserted -712698321 1673245882
11202
11203 \family sans
11204 KOMA-Script Letter (V.
11205  2)
11206 \change_inserted 564990737 1672652455
11207
11208 \family default
11209  (section
11210 \begin_inset space ~
11211 \end_inset
11212
11213
11214 \begin_inset CommandInset ref
11215 LatexCommand ref
11216 reference "subsec:The-new-letter"
11217 nolink "false"
11218
11219 \end_inset
11220
11221 ) and
11222 \change_deleted -712698321 1673245908
11223
11224 \family typewriter
11225 letter
11226 \begin_inset space \space{}
11227 \end_inset
11228
11229 (with extra font sizes)
11230 \change_inserted -712698321 1673245908
11231
11232 \family sans
11233 Letter (Standard Class with Extra Font Sizes)
11234 \change_inserted 564990737 1672652455
11235
11236 \family default
11237  (section
11238 \begin_inset space ~
11239 \end_inset
11240
11241
11242 \begin_inset CommandInset ref
11243 LatexCommand ref
11244 reference "subsec:Extra-font-sizes"
11245 nolink "false"
11246
11247 \end_inset
11248
11249 ) document classes .
11250 \end_layout
11251
11252 \begin_layout Subsection
11253
11254 \change_inserted 564990737 1671041970
11255 D
11256 \change_deleted -712698321 1673246109
11257 in
11258 \change_inserted -712698321 1673246110
11259 IN
11260 \change_inserted 564990737 1671041970
11261 -Brief
11262 \end_layout
11263
11264 \begin_layout Standard
11265
11266 \change_inserted 564990737 1671617528
11267 The document class
11268 \family sans
11269 D
11270 \change_deleted -712698321 1673246116
11271 in
11272 \change_inserted -712698321 1673246116
11273 IN
11274 \change_inserted 564990737 1671617528
11275 -Brief
11276 \family default
11277  provides
11278 \change_inserted -712698321 1673246192
11279 support for
11280 \change_inserted 564990737 1671617528
11281 the
11282 \family typewriter
11283 dinbrief.cls
11284 \family default
11285
11286 \change_deleted -712698321 1673246242
11287 document
11288 \change_inserted -712698321 1673246242
11289 \SpecialChar LaTeX
11290
11291 \change_inserted 564990737 1671617528
11292  class for writing letters according to the
11293 \change_inserted -712698321 1673246140
11294  standards of the German Standards Institute (
11295 \change_deleted -712698321 1673246141
11296
11297 \change_inserted 564990737 1671617528
11298
11299 \emph on
11300 Deutsches Institut für Normung
11301 \change_inserted -712698321 1673246324
11302 ,
11303  DIN)
11304 \change_deleted -712698321 1673246131
11305
11306 \emph default
11307  conventions
11308 \change_inserted 564990737 1671617528
11309 .
11310  The file in the menu
11311 \family sans
11312 \bar under
11313 F
11314 \bar default
11315 ile\SpecialChar menuseparator
11316 New
11317 \begin_inset space ~
11318 \end_inset
11319
11320 fro
11321 \bar under
11322 m
11323 \bar default
11324
11325 \begin_inset space ~
11326 \end_inset
11327
11328 Template\SpecialChar menuseparator
11329 Letters\SpecialChar menuseparator
11330 DIN-Brief
11331 \family default
11332  offers guidance on its use.
11333  The documentation is available from
11334 \begin_inset CommandInset href
11335 LatexCommand href
11336 name "CTAN"
11337 target "http://mirrors.ctan.org/macros/latex/contrib/dinbrief/liesmich"
11338 literal "false"
11339
11340 \end_inset
11341
11342 .
11343 \end_layout
11344
11345 \begin_layout Subsection
11346
11347 \change_deleted -712698321 1673246778
11348 frletter
11349 \change_inserted -712698321 1673246778
11350 French letter
11351 \begin_inset space \space{}
11352 \end_inset
11353
11354 (frletter)
11355 \change_unchanged
11356
11357 \end_layout
11358
11359 \begin_layout Standard
11360
11361 \change_inserted 564990737 1672652499
11362 The document class
11363 \family sans
11364 French letter
11365 \begin_inset space \space{}
11366 \end_inset
11367
11368 (frletter)
11369 \family default
11370  provides
11371 \change_inserted -712698321 1673246198
11372 support for
11373 \change_inserted 564990737 1672652499
11374 the
11375 \family typewriter
11376 frletter.cls
11377 \family default
11378
11379 \change_deleted -712698321 1673246247
11380 document
11381 \change_inserted -712698321 1673246247
11382 \SpecialChar LaTeX
11383
11384 \change_inserted 564990737 1672652499
11385  class for writing letters according to French conventions.
11386  The file in the menu
11387 \family sans
11388 \bar under
11389 F
11390 \bar default
11391 ile\SpecialChar menuseparator
11392 New
11393 \begin_inset space ~
11394 \end_inset
11395
11396 fro
11397 \bar under
11398 m
11399 \bar default
11400
11401 \begin_inset space ~
11402 \end_inset
11403
11404 Template\SpecialChar menuseparator
11405 Letters\SpecialChar menuseparator
11406 French letter
11407 \begin_inset space \space{}
11408 \end_inset
11409
11410 (frletter)
11411 \family default
11412  offers guidance on its use.
11413 \change_inserted -712698321 1673246876
11414
11415 \end_layout
11416
11417 \begin_layout Subsection
11418
11419 \change_inserted -712698321 1673246876
11420 French letter
11421 \begin_inset space \space{}
11422 \end_inset
11423
11424 (lettre)
11425 \end_layout
11426
11427 \begin_layout Standard
11428
11429 \change_inserted -712698321 1673246917
11430 The document class
11431 \family sans
11432 French letter
11433 \begin_inset space \space{}
11434 \end_inset
11435
11436 (lettre)
11437 \family default
11438  provides support for
11439 \family typewriter
11440 lettre.cls
11441 \family default
11442 ,
11443  another \SpecialChar LaTeX
11444  class for writing letters,
11445  but also faxes and envelopes,
11446  in French.
11447  The file in the menu
11448 \family sans
11449 \bar under
11450 F
11451 \bar default
11452 ile\SpecialChar menuseparator
11453 New
11454 \begin_inset space ~
11455 \end_inset
11456
11457 fro
11458 \bar under
11459 m
11460 \bar default
11461
11462 \begin_inset space ~
11463 \end_inset
11464
11465 Template\SpecialChar menuseparator
11466 Letters\SpecialChar menuseparator
11467 French letter
11468 \begin_inset space \space{}
11469 \end_inset
11470
11471 (lettre)
11472 \family default
11473  offers guidance on its use.
11474  The documentation is available from
11475 \begin_inset CommandInset href
11476 LatexCommand href
11477 name "CTAN"
11478 target "http://mirrors.ctan.org/macros/latex/contrib/lettre/lettre.pdf"
11479 literal "false"
11480
11481 \end_inset
11482
11483 .
11484 \change_inserted 564990737 1672652499
11485
11486 \end_layout
11487
11488 \begin_layout Subsection
11489
11490 \change_inserted 564990737 1672652499
11491 G-Brief
11492 \change_inserted -712698321 1673246804
11493  (V.
11494 \begin_inset space \thinspace{}
11495 \end_inset
11496
11497 2)
11498 \change_inserted 564990737 1672652499
11499
11500 \end_layout
11501
11502 \begin_layout Standard
11503
11504 \change_inserted 564990737 1672652499
11505 The document class
11506 \family sans
11507 G-Brief (V.
11508 \begin_inset space \thinspace{}
11509 \end_inset
11510
11511 2)
11512 \family default
11513  provides
11514 \change_inserted -712698321 1673246202
11515 support for
11516 \change_inserted 564990737 1672652499
11517 the
11518 \change_deleted -712698321 1673246498
11519 newer
11520 \change_inserted 564990737 1672652499
11521
11522 \family typewriter
11523 g-brief2.cls
11524 \family default
11525
11526 \change_deleted -712698321 1673246249
11527 document
11528 \change_inserted -712698321 1673246249
11529 \SpecialChar LaTeX
11530
11531 \change_inserted 564990737 1672652499
11532  class for writing letters in German.
11533  The file in the menu
11534 \family sans
11535 \bar under
11536 F
11537 \bar default
11538 ile\SpecialChar menuseparator
11539 New
11540 \begin_inset space ~
11541 \end_inset
11542
11543 fro
11544 \bar under
11545 m
11546 \bar default
11547
11548 \begin_inset space ~
11549 \end_inset
11550
11551 Template\SpecialChar menuseparator
11552 Letters\SpecialChar menuseparator
11553 G-Brief (V.
11554 \begin_inset space \thinspace{}
11555 \end_inset
11556
11557 2)
11558 \family default
11559  offers guidance on its use.
11560  The documentation is available from
11561 \begin_inset CommandInset href
11562 LatexCommand href
11563 name "CTAN"
11564 target "http://mirrors.ctan.org/macros/latex/contrib/g-brief/g-brief.pdf"
11565 literal "false"
11566
11567 \end_inset
11568
11569 .
11570 \end_layout
11571
11572 \begin_layout Subsection
11573
11574 \change_deleted -712698321 1673246462
11575 letter
11576 \end_layout
11577
11578 \begin_layout Standard
11579
11580 \change_deleted -712698321 1673246462
11581 The document class
11582 \family sans
11583 letter
11584 \family default
11585  provides the
11586 \family sans
11587 letter.cls
11588 \family default
11589  document class for English letters and to create mailing labels.
11590  The file in the menu
11591 \family sans
11592 \bar under
11593 F
11594 \bar default
11595 ile\SpecialChar menuseparator
11596 New
11597 \begin_inset space ~
11598 \end_inset
11599
11600 fro
11601 \bar under
11602 m
11603 \bar default
11604
11605 \begin_inset space ~
11606 \end_inset
11607
11608 Template\SpecialChar menuseparator
11609 Letters\SpecialChar menuseparator
11610 Letter (Standard Class)
11611 \family default
11612  offers guidance on its use.
11613 \change_inserted 564990737 1671617591
11614
11615 \end_layout
11616
11617 \begin_layout Subsection
11618
11619 \change_deleted -712698321 1673246872
11620 lettre
11621 \end_layout
11622
11623 \begin_layout Standard
11624
11625 \change_deleted -712698321 1673246872
11626 The document class
11627 \family sans
11628 French letter
11629 \begin_inset space \space{}
11630 \end_inset
11631
11632 (lettre)
11633 \family default
11634  provides the
11635 \family typewriter
11636 lettre.cls
11637 \family default
11638  document class for writing letters,
11639  faxes and envelopes in French.
11640  The file in the menu
11641 \family sans
11642 \bar under
11643 F
11644 \bar default
11645 ile\SpecialChar menuseparator
11646 New
11647 \begin_inset space ~
11648 \end_inset
11649
11650 fro
11651 \bar under
11652 m
11653 \bar default
11654
11655 \begin_inset space ~
11656 \end_inset
11657
11658 Template\SpecialChar menuseparator
11659 Letters\SpecialChar menuseparator
11660 French letter
11661 \begin_inset space \space{}
11662 \end_inset
11663
11664 (lettre)
11665 \family default
11666  offers guidance on its use.
11667  The documentation is available from
11668 \begin_inset CommandInset href
11669 LatexCommand href
11670 name "CTAN"
11671 target "http://mirrors.ctan.org/macros/latex/contrib/lettre/lettre.pdf"
11672 literal "false"
11673
11674 \end_inset
11675
11676 .
11677 \change_inserted 564990737 1672652527
11678
11679 \end_layout
11680
11681 \begin_layout Section
11682
11683 \change_inserted 564990737 1670439660
11684 Presentations
11685 \end_layout
11686
11687 \begin_layout Subsection
11688
11689 \change_inserted 564990737 1671458922
11690 Beamer
11691 \end_layout
11692
11693 \begin_layout Standard
11694
11695 \change_inserted 564990737 1671617655
11696 The document class
11697 \change_deleted -712698321 1673255475
11698
11699 \family sans
11700 presentation
11701 \begin_inset space \thinspace{}
11702 \end_inset
11703
11704 (b
11705 \change_inserted -712698321 1673255475
11706 B
11707 \change_inserted 564990737 1671617655
11708 eamer
11709 \change_deleted -712698321 1673255477
11710 )
11711 \change_inserted 564990737 1671617655
11712
11713 \family default
11714  uses the
11715 \family typewriter
11716 beamer.cls
11717 \family default
11718
11719 \change_deleted -712698321 1673255496
11720 document
11721 \change_inserted -712698321 1673255496
11722 \SpecialChar LaTeX
11723
11724 \change_inserted 564990737 1671617655
11725  class for creating presentations.
11726  The file in the menu
11727 \family sans
11728 \bar under
11729 F
11730 \bar default
11731 ile\SpecialChar menuseparator
11732 New
11733 \begin_inset space ~
11734 \end_inset
11735
11736 fro
11737 \bar under
11738 m
11739 \bar default
11740
11741 \begin_inset space ~
11742 \end_inset
11743
11744 Template\SpecialChar menuseparator
11745 Presentations\SpecialChar menuseparator
11746 Beamer
11747 \family default
11748
11749 \change_inserted -712698321 1673257500
11750 or
11751 \family sans
11752 Help\SpecialChar menuseparator
11753 Specific Manuals\SpecialChar menuseparator
11754 Beamer Presentations
11755 \family default
11756
11757 \change_inserted 564990737 1671617655
11758 offers guidance on its use.
11759  The documentation is available from
11760 \begin_inset CommandInset href
11761 LatexCommand href
11762 name "CTAN"
11763 target "http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf"
11764 literal "false"
11765
11766 \end_inset
11767
11768 .
11769 \end_layout
11770
11771 \begin_layout Subsection
11772
11773 \change_deleted -712698321 1673255766
11774 Foils [aka
11775 \change_unchanged
11776
11777 \family sans
11778 Foil\SpecialChar TeX
11779
11780 \change_deleted -712698321 1673255767
11781
11782 \family default
11783 ]
11784 \change_unchanged
11785
11786 \begin_inset CommandInset label
11787 LatexCommand label
11788 name "sec:foiltex"
11789
11790 \end_inset
11791
11792
11793 \end_layout
11794
11795 \begin_layout Standard
11796
11797 \change_inserted 564990737 1672743383
11798 Original by
11799 \noun on
11800 Allan Rae
11801 \noun default
11802 ;
11803  updated by the \SpecialChar LyX
11804  Team
11805 \end_layout
11806
11807 \begin_layout Subsubsection
11808
11809 \change_inserted 564990737 1672743383
11810 Introduction
11811 \end_layout
11812
11813 \begin_layout Standard
11814
11815 \change_inserted 564990737 1672743396
11816 The document class
11817 \change_deleted -712698321 1673255761
11818
11819 \family sans
11820 presentation
11821 \begin_inset space \thinspace{}
11822 \end_inset
11823
11824 (
11825 \change_inserted 564990737 1672743396
11826 Foil\SpecialChar TeX
11827
11828 \change_deleted -712698321 1673255763
11829 )
11830 \change_inserted 564990737 1672743396
11831
11832 \family default
11833  uses the
11834 \family typewriter
11835 foils.cls
11836 \family default
11837  document class to make slides for overhead projectors.
11838  There are two document classes that can do this:
11839  the
11840 \change_deleted -712698321 1673256124
11841
11842 \family sans
11843 presentations
11844 \begin_inset space \thinspace{}
11845 \end_inset
11846
11847 (s
11848 \change_inserted -712698321 1673256124
11849 S
11850 \change_inserted 564990737 1672743396
11851 lides
11852 \change_deleted -712698321 1673256130
11853 )
11854 \change_inserted 564990737 1672743396
11855
11856 \family default
11857  document class (section
11858 \begin_inset space ~
11859 \end_inset
11860
11861
11862 \begin_inset CommandInset ref
11863 LatexCommand ref
11864 reference "sec:slitex"
11865 plural "false"
11866 caps "false"
11867 noprefix "false"
11868 nolink "false"
11869
11870 \end_inset
11871
11872 ) and the
11873 \family sans
11874 Foil\SpecialChar TeX
11875
11876 \family default
11877  slides class.
11878  As of 2023 the former has continued to be maintained whereas
11879 \family sans
11880 Foil\SpecialChar TeX
11881
11882 \family default
11883  has not been maintained since 2008.
11884  This section documents the latter.
11885  If your machine doesn’t have the
11886 \change_deleted -712698321 1673256264
11887
11888 \family sans
11889 presentation
11890 \begin_inset space \thinspace{}
11891 \end_inset
11892
11893 (
11894 \change_inserted 564990737 1672743396
11895 Foil\SpecialChar TeX
11896
11897 \change_deleted -712698321 1673256265
11898 )
11899 \change_inserted 564990737 1672743396
11900
11901 \family default
11902  document class installed,
11903  you’ll probably have to use the
11904 \change_deleted -712698321 1673256271
11905
11906 \family sans
11907 presentations
11908 \begin_inset space \thinspace{}
11909 \end_inset
11910
11911 (s
11912 \change_inserted -712698321 1673256271
11913 S
11914 \change_inserted 564990737 1672743396
11915 lides
11916 \change_deleted -712698321 1673256273
11917 )
11918 \change_inserted 564990737 1672743396
11919
11920 \family default
11921  document class.
11922  If you want to install the
11923 \family typewriter
11924 foils.cls
11925 \family default
11926  document class,
11927  it is available from
11928 \begin_inset CommandInset href
11929 LatexCommand href
11930 name "CTAN"
11931 target "https://www.ctan.org/pkg/foiltex"
11932 literal "false"
11933
11934 \end_inset
11935
11936 .
11937  You should also read the
11938 \emph on
11939 Installing New Document Classes
11940 \emph default
11941  chapter of the
11942 \emph on
11943 Customization
11944 \emph default
11945  manual.
11946 \change_deleted 564990737 1672743436
11947 by
11948 \noun on
11949 Allan Rae
11950 \end_layout
11951
11952 \begin_layout Standard
11953
11954 \change_deleted 564990737 1672743383
11955 Introduction
11956 \end_layout
11957
11958 \begin_layout Standard
11959
11960 \change_deleted 564990737 1672743383
11961 This section describes how to use \SpecialChar LyX
11962  to make slides for overhead projectors.
11963  There are two document classes that can do this:
11964  the default slides class and the
11965 \family sans
11966 Foil\SpecialChar TeX
11967
11968 \family default
11969  slides class.
11970  This section documents the latter.
11971 \end_layout
11972
11973 \begin_layout Standard
11974
11975 \change_deleted 564990737 1672743383
11976 I'm going to say this again,
11977  nice and clear,
11978  so that there's no misunderstanding:
11979 \end_layout
11980
11981 \begin_layout Standard
11982
11983 \change_deleted 564990737 1672743383
11984 \begin_inset VSpace bigskip
11985 \end_inset
11986
11987
11988 \end_layout
11989
11990 \begin_layout Standard
11991 \align center
11992
11993 \change_deleted 564990737 1672743383
11994
11995 \size large
11996 This section documents the class
11997 \begin_inset Quotes eld
11998 \end_inset
11999
12000
12001 \family sans
12002 FoilTeX
12003 \family default
12004
12005 \begin_inset Quotes erd
12006 \end_inset
12007
12008
12009 \emph on
12010 only.
12011 \end_layout
12012
12013 \begin_layout Standard
12014
12015 \change_deleted 564990737 1672743383
12016 \begin_inset VSpace bigskip
12017 \end_inset
12018
12019
12020 \end_layout
12021
12022 \begin_layout Standard
12023
12024 \change_deleted 564990737 1672743383
12025 If you're looking for the documentation for
12026 \begin_inset Quotes eld
12027 \end_inset
12028
12029
12030 \family sans
12031 slides (default)
12032 \family default
12033
12034 \begin_inset Quotes erd
12035 \end_inset
12036
12037 ,
12038  check out section
12039 \begin_inset space ~
12040 \end_inset
12041
12042
12043 \begin_inset CommandInset ref
12044 LatexCommand ref
12045 reference "sec:slitex"
12046 nolink "false"
12047
12048 \end_inset
12049
12050 .
12051  If your machine doesn't have the
12052 \family sans
12053 foils
12054 \family default
12055  class
12056 \family sans
12057 FoilTeX
12058 \family default
12059  installed,
12060  you'll probably have to use the default
12061 \family sans
12062 slides
12063 \family default
12064  class,
12065  which isn't quite as good as
12066 \family sans
12067 foils.
12068 \end_layout
12069
12070 \begin_layout Standard
12071
12072 \change_deleted 564990737 1672743383
12073 The
12074 \family sans
12075 foils
12076 \family default
12077  class is designed for use with version
12078 \begin_inset space ~
12079 \end_inset
12080
12081 2.1 of the
12082 \family sans
12083 foils.cls
12084 \family default
12085  \SpecialChar LaTeX
12086  class file which is now an integral part of \SpecialChar LaTeX2e
12087 .
12088 \change_unchanged
12089
12090 \end_layout
12091
12092 \begin_layout Subsubsection
12093 Getting Started
12094 \end_layout
12095
12096 \begin_layout Standard
12097 Obviously,
12098  to use this document class,
12099  you need to select
12100 \family sans
12101 FoilTeX
12102 \family default
12103  from the
12104 \family sans
12105 Class
12106 \family default
12107  entry in the
12108 \family sans
12109 Document
12110 \begin_inset space ~
12111 \end_inset
12112
12113 Layout
12114 \family default
12115  dialog.
12116  There are some settings in the
12117 \family sans
12118 Document
12119 \begin_inset space ~
12120 \end_inset
12121
12122 Layout
12123 \family default
12124  dialog that you should know about that are specific to this class:
12125 \end_layout
12126
12127 \begin_layout Itemize
12128 Don't change the options
12129 \family sans
12130 Sides
12131 \family default
12132  and
12133 \family sans
12134 Columns
12135 \family default
12136  on the
12137 \family sans
12138 Document
12139 \begin_inset space ~
12140 \end_inset
12141
12142 Layout
12143 \family default
12144  dialog.
12145  They're ignored by the
12146 \family sans
12147 foils
12148 \family default
12149  class.
12150 \end_layout
12151
12152 \begin_layout Itemize
12153 The default font size is 20
12154 \begin_inset space \thinspace{}
12155 \end_inset
12156
12157 pt with the other options being 17
12158 \begin_inset space \thinspace{}
12159 \end_inset
12160
12161 pt,
12162  25
12163 \begin_inset space \thinspace{}
12164 \end_inset
12165
12166 pt and 30
12167 \begin_inset space \thinspace{}
12168 \end_inset
12169
12170 pt.
12171 \end_layout
12172
12173 \begin_layout Itemize
12174 The default font is
12175 \family sans
12176 sans
12177 \family default
12178
12179 \family sans
12180 serif
12181 \family default
12182  but all math equations are still typeset in the usual roman font.
12183 \end_layout
12184
12185 \begin_layout Itemize
12186
12187 \family sans
12188 Foil\SpecialChar TeX
12189
12190 \family default
12191  supports A4 and Letter paper sizes as well as a special size for working with 35
12192 \begin_inset space \thinspace{}
12193 \end_inset
12194
12195 mm slides.
12196  It doesn't support A5,
12197  B5,
12198  legal or executive paper sizes.
12199 \end_layout
12200
12201 \begin_layout Itemize
12202 Don't bother changing the
12203 \family sans
12204 Float Placement
12205 \family default
12206  settings because they are ignored anyway.
12207  All floats appear where they are defined in the text.
12208 \end_layout
12209
12210 \begin_layout Itemize
12211 The
12212 \family sans
12213 Pagestyle
12214 \family default
12215  setting behaves a bit differently for this class.
12216
12217 \family sans
12218 Foil\SpecialChar TeX
12219
12220 \family default
12221  provides extensive footer and header capabilities including a user-defined logo.
12222  See section
12223 \begin_inset space ~
12224 \end_inset
12225
12226
12227 \begin_inset CommandInset ref
12228 LatexCommand ref
12229 reference "sec:foilfoot"
12230 nolink "false"
12231
12232 \end_inset
12233
12234  for more details.
12235  The title page is treated differently to all other pages in the document and is
12236 \emph on
12237 always
12238 \emph default
12239  unnumbered and
12240 \emph on
12241 always
12242 \emph default
12243  has the logo centered at the bottom of the page (if one is defined).
12244  The possible page style choices and what they do are as follows:
12245 \end_layout
12246
12247 \begin_deeper
12248 \begin_layout Labeling
12249 \labelwidthstring MMMMMMM
12250
12251 \family sans
12252 \series bold
12253 empty
12254 \family default
12255 \series default
12256  The final output contains no page numbers,
12257  or other headers or footers (except footnotes of course).
12258
12259 \end_layout
12260
12261 \begin_layout Labeling
12262 \labelwidthstring MMMMMMM
12263
12264 \family sans
12265 \series bold
12266 plain
12267 \family default
12268 \series default
12269  The final output contains page numbers centered at the bottom of the page.
12270  No other headings or footers (other than footnotes).
12271 \end_layout
12272
12273 \begin_layout Labeling
12274 \labelwidthstring MMMMMMM
12275
12276 \series bold
12277 foilheadings
12278 \series default
12279  Page numbers in lower right corner.
12280  Additional headers and footers are also shown.
12281  This is also the default.
12282 \end_layout
12283
12284 \begin_layout Labeling
12285 \labelwidthstring MMMMMMM
12286
12287 \series bold
12288 fancy
12289 \series default
12290  Gives you access to the
12291 \family sans
12292 fancyheadings
12293 \family default
12294  package although its use with
12295 \family sans
12296 Foil\SpecialChar TeX
12297
12298 \family default
12299  is discouraged by the writer of the
12300 \family sans
12301 Foil\SpecialChar TeX
12302
12303 \family default
12304  package because of some potential page layout clashes.
12305 \end_layout
12306
12307 \end_deeper
12308 \begin_layout Paragraph
12309 Extra Options
12310 \end_layout
12311
12312 \begin_layout Standard
12313 The following options may be used in the extra class options in the
12314 \family sans
12315 Document\SpecialChar menuseparator
12316 Settings
12317 \family default
12318  dialog.
12319 \end_layout
12320
12321 \begin_layout Labeling
12322 \labelwidthstring MMMMMMx
12323
12324 \series bold
12325 35mmSlide
12326 \series default
12327  This sets up the page layout for 7.33
12328 \begin_inset space \thinspace{}
12329 \end_inset
12330
12331 in by 11
12332 \begin_inset space \thinspace{}
12333 \end_inset
12334
12335 in paper,
12336  which is about the same aspect ratio as a 35
12337 \begin_inset space \thinspace{}
12338 \end_inset
12339
12340 mm slide,
12341  making it a bit easier to work with this medium.
12342 \end_layout
12343
12344 \begin_layout Labeling
12345 \labelwidthstring MMMMMMx
12346
12347 \series bold
12348 headrule
12349 \series default
12350  Places a rule across the page below the header on every page except the title page.
12351 \end_layout
12352
12353 \begin_layout Labeling
12354 \labelwidthstring MMMMMMx
12355
12356 \series bold
12357 footrule
12358 \series default
12359  Places a rule across the page above the footer on every page except the title page.
12360 \end_layout
12361
12362 \begin_layout Labeling
12363 \labelwidthstring MMMMMMx
12364
12365 \series bold
12366 dvips
12367 \series default
12368  This is automatically set each time you create a new
12369 \family sans
12370 foils
12371 \family default
12372  document.
12373  This option tells
12374 \family sans
12375 Foil\SpecialChar TeX
12376
12377 \family default
12378  to use the dvips driver to rotate those pages that are set as landscape foils.
12379 \end_layout
12380
12381 \begin_layout Labeling
12382 \labelwidthstring MMMMMMx
12383
12384 \series bold
12385 landscape
12386 \series default
12387  Simply changes the page dimensions to those of a landscape page but doesn't do any rotation.
12388  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.
12389  Note that this option effectively reverses the roles of the
12390 \family sans
12391 Foilhead
12392 \family default
12393  and
12394 \family sans
12395 Rotatefoilhead
12396 \family default
12397  environments (don't worry these are described in the next section).
12398 \end_layout
12399
12400 \begin_layout Labeling
12401 \labelwidthstring MMMMMMx
12402
12403 \series bold
12404 leqno
12405 \series default
12406  Equation numbers on the left.
12407 \end_layout
12408
12409 \begin_layout Labeling
12410 \labelwidthstring MMMMMMx
12411
12412 \series bold
12413 fleqn
12414 \series default
12415  Flush-left equations.
12416 \end_layout
12417
12418 \begin_layout Subsubsection
12419 Supported Environments
12420 \end_layout
12421
12422 \begin_layout Standard
12423 Most of the environments commonly supported in other classes are also supported by the
12424 \change_deleted -712698321 1673256683
12425
12426 \family sans
12427 foils
12428 \change_inserted -712698321 1673256683
12429 Foil\SpecialChar TeX
12430
12431 \change_unchanged
12432
12433 \family default
12434  class.
12435  There are several additional environments provided by
12436 \family sans
12437 Foil\SpecialChar TeX
12438
12439 \family default
12440  as well as a couple added by \SpecialChar LyX
12441 .
12442  The following environments are shared with other classes:
12443 \end_layout
12444
12445 \begin_layout Standard
12446 \begin_inset Flex Multiple Columns
12447 status open
12448
12449 \begin_layout Itemize
12450
12451 \family sans
12452 Standard
12453 \end_layout
12454
12455 \begin_layout Itemize
12456
12457 \family sans
12458 Itemize
12459 \end_layout
12460
12461 \begin_layout Itemize
12462
12463 \family sans
12464 Enumerate
12465 \end_layout
12466
12467 \begin_layout Itemize
12468
12469 \family sans
12470 Description
12471 \end_layout
12472
12473 \begin_layout Itemize
12474
12475 \family sans
12476 List
12477 \end_layout
12478
12479 \begin_layout Itemize
12480
12481 \family sans
12482 \SpecialChar LyX
12483 -Code
12484 \end_layout
12485
12486 \begin_layout Itemize
12487
12488 \family sans
12489 Verse
12490 \end_layout
12491
12492 \begin_layout Itemize
12493
12494 \family sans
12495 Quote
12496 \end_layout
12497
12498 \begin_layout Itemize
12499
12500 \family sans
12501 Quotation
12502 \end_layout
12503
12504 \begin_layout Itemize
12505
12506 \family sans
12507 Title
12508 \change_inserted -712698321 1673256734
12509
12510 \end_layout
12511
12512 \begin_layout Itemize
12513
12514 \family sans
12515 Author
12516 \end_layout
12517
12518 \begin_layout Itemize
12519
12520 \family sans
12521 Date
12522 \end_layout
12523
12524 \begin_layout Itemize
12525
12526 \family sans
12527 Abstract
12528 \end_layout
12529
12530 \begin_layout Itemize
12531
12532 \family sans
12533 Bibliography
12534 \end_layout
12535
12536 \begin_layout Itemize
12537
12538 \family sans
12539 Address
12540 \end_layout
12541
12542 \begin_layout Itemize
12543
12544 \family sans
12545 RightAddress
12546 \end_layout
12547
12548 \end_inset
12549
12550
12551 \end_layout
12552
12553 \begin_layout Standard
12554 That is,
12555  all the major environments apart from the sectioning environments.
12556  Since foils are essentially self-contained sections,
12557  with a title and body,
12558
12559 \family sans
12560 Foil\SpecialChar TeX
12561
12562 \family default
12563  provides specific commands for starting new foils and these are:
12564 \end_layout
12565
12566 \begin_layout Itemize
12567
12568 \family sans
12569 Foilhead
12570 \end_layout
12571
12572 \begin_layout Itemize
12573
12574 \family sans
12575 Rotatefoilhead
12576 \end_layout
12577
12578 \begin_layout Standard
12579 \SpecialChar LyX
12580  also provides slightly modified versions of these two environments called:
12581 \end_layout
12582
12583 \begin_layout Itemize
12584
12585 \family sans
12586 ShortFoilhead
12587 \end_layout
12588
12589 \begin_layout Itemize
12590
12591 \family sans
12592 ShortRotatefoilhead
12593 \end_layout
12594
12595 \begin_layout Standard
12596 and the differences will be explained in the next section.
12597 \end_layout
12598
12599 \begin_layout Standard
12600 Since foils are often used in presenting ideas or new theorems and such
12601 \family sans
12602 Foil\SpecialChar TeX
12603
12604 \family default
12605  also provides a comprehensive box of goodies for presenting them:
12606 \end_layout
12607
12608 \begin_layout Standard
12609 \begin_inset Flex Multiple Columns
12610 status open
12611
12612 \begin_layout Itemize
12613
12614 \family sans
12615 Theorem
12616 \end_layout
12617
12618 \begin_layout Itemize
12619
12620 \family sans
12621 Lemma
12622 \end_layout
12623
12624 \begin_layout Itemize
12625
12626 \family sans
12627 Corollary
12628 \end_layout
12629
12630 \begin_layout Itemize
12631
12632 \family sans
12633 Proposition
12634 \end_layout
12635
12636 \begin_layout Itemize
12637
12638 \family sans
12639 Definition
12640 \end_layout
12641
12642 \begin_layout Itemize
12643
12644 \family sans
12645 Proof
12646 \end_layout
12647
12648 \begin_layout Itemize
12649
12650 \family sans
12651 Theorem*
12652 \end_layout
12653
12654 \begin_layout Itemize
12655
12656 \family sans
12657 Lemma*
12658 \end_layout
12659
12660 \begin_layout Itemize
12661
12662 \family sans
12663 Corollary*
12664 \end_layout
12665
12666 \begin_layout Itemize
12667
12668 \family sans
12669 Proposition*
12670 \end_layout
12671
12672 \begin_layout Itemize
12673
12674 \family sans
12675 Definition*
12676 \end_layout
12677
12678 \end_inset
12679
12680
12681 \end_layout
12682
12683 \begin_layout Standard
12684 The starred versions are unnumbered while the unstarred versions are numbered.
12685  There are also two list environments added by \SpecialChar LyX
12686  and these are:
12687 \end_layout
12688
12689 \begin_layout Itemize
12690
12691 \family sans
12692 TickList
12693 \end_layout
12694
12695 \begin_layout Itemize
12696
12697 \family sans
12698 CrossList
12699 \end_layout
12700
12701 \begin_layout Standard
12702
12703 \family sans
12704 Foil\SpecialChar TeX
12705
12706 \family default
12707  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.
12708  If you want to change these settings in your document the best place to do so is at the very top of a foil,
12709  i.
12710 \begin_inset space \thinspace{}
12711 \end_inset
12712
12713 e.
12714 \emph on
12715
12716 \begin_inset space \space{}
12717 \end_inset
12718
12719
12720 \emph default
12721 straight after the foilhead.
12722 \end_layout
12723
12724 \begin_layout Standard
12725 For this purpose,
12726  the following command styles are provided [
12727 \shape smallcaps
12728 Martin Vermeer
12729 \shape default
12730 ]:
12731 \end_layout
12732
12733 \begin_layout Standard
12734 \begin_inset Flex Multiple Columns
12735 status open
12736
12737 \begin_layout Itemize
12738
12739 \family sans
12740 My
12741 \begin_inset space ~
12742 \end_inset
12743
12744 Logo
12745 \end_layout
12746
12747 \begin_layout Itemize
12748
12749 \family sans
12750 Restriction
12751 \end_layout
12752
12753 \begin_layout Itemize
12754
12755 \family sans
12756 Right
12757 \begin_inset space ~
12758 \end_inset
12759
12760 Footer
12761 \end_layout
12762
12763 \begin_layout Itemize
12764
12765 \family sans
12766 Right
12767 \begin_inset space ~
12768 \end_inset
12769
12770 Header
12771 \end_layout
12772
12773 \begin_layout Itemize
12774
12775 \family sans
12776 Left
12777 \begin_inset space ~
12778 \end_inset
12779
12780 Header
12781 \end_layout
12782
12783 \begin_deeper
12784 \begin_layout Plain Layout
12785 \begin_inset space ~
12786 \end_inset
12787
12788
12789 \end_layout
12790
12791 \end_deeper
12792 \end_inset
12793
12794
12795 \end_layout
12796
12797 \begin_layout Standard
12798 There are also a few commands provided by
12799 \family sans
12800 Foil\SpecialChar TeX
12801
12802 \family default
12803  that aren't directly supported by \SpecialChar LyX
12804  but I'll tell you what they do and how to use them in section
12805 \begin_inset space ~
12806 \end_inset
12807
12808
12809 \begin_inset CommandInset ref
12810 LatexCommand ref
12811 reference "sec:unsuppfoils"
12812 nolink "false"
12813
12814 \end_inset
12815
12816 .
12817 \end_layout
12818
12819 \begin_layout Subsubsection
12820 Building a Set of Foils
12821 \end_layout
12822
12823 \begin_layout Standard
12824 This section will give a simple introduction to using the different environments to build a set of foils.
12825  If you want to see an example set of foils,
12826  take a look at
12827 \change_deleted 564990737 1671643085
12828 the
12829 \family typewriter
12830 Foils.lyx
12831 \family default
12832  file you find in \SpecialChar LyX
12833 's
12834 \family typewriter
12835 examples
12836 \family default
12837  folder
12838 \change_inserted 564990737 1671643099
12839
12840 \family sans
12841 File\SpecialChar menuseparator
12842 Open Example\SpecialChar menuseparator
12843 Presentations\SpecialChar menuseparator
12844 Foils
12845 \change_unchanged
12846
12847 \family default
12848 .
12849 \end_layout
12850
12851 \begin_layout Paragraph
12852 Give It a Title Page
12853 \end_layout
12854
12855 \begin_layout Standard
12856 Unlike other classes that provide
12857 \family sans
12858 Title
12859 \family default
12860 ,
12861
12862 \family sans
12863 Author
12864 \family default
12865 ,
12866
12867 \family sans
12868 Date
12869 \family default
12870  and
12871 \family sans
12872 Abstract
12873 \family default
12874  environments,
12875
12876 \change_deleted -712698321 1673256940
12877
12878 \family sans
12879 foils
12880 \change_inserted -712698321 1673256940
12881
12882 \lang ngerman
12883 FoilTeX
12884 \change_unchanged
12885
12886 \family default
12887 \lang english
12888  creates the title on a page of its own.
12889  If you leave out the
12890 \family sans
12891 Date
12892 \family default
12893  environment \SpecialChar LaTeX
12894  will substitute the current date (every time you regenerate the output).
12895 \end_layout
12896
12897 \begin_layout Paragraph
12898 Start a New Foil
12899 \end_layout
12900
12901 \begin_layout Standard
12902 As I mentioned earlier,
12903  there are four ways of starting a new foil.
12904  For portrait foils you should use
12905 \family sans
12906 Foilhead
12907 \family default
12908  or
12909 \family sans
12910 ShortFoilhead.
12911
12912 \family default
12913  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.
12914 \end_layout
12915
12916 \begin_layout Standard
12917 Landscape foils are generated using the
12918 \family sans
12919 Rotatefoilhead
12920 \family default
12921  and
12922 \family sans
12923 ShortRotatefoilhead
12924 \family default
12925  environments.
12926  Again the only difference is the spacing between foilhead and body.
12927  Both of the short versions have 0.5
12928 \begin_inset space ~
12929 \end_inset
12930
12931 inches less separation between the foilhead and the body.
12932
12933 \end_layout
12934
12935 \begin_layout Standard
12936 One problem with the support for landscape foils is the requirement that you have to use the
12937 \family typewriter
12938 dvips
12939 \family default
12940  driver to generate the PostScript output otherwise the foils won't be rotated.
12941  It is possible to get landscape foils even if you haven't got the
12942 \family typewriter
12943 dvips
12944 \family default
12945  driver provided you can feed your foils sideways through your printer ;-)
12946 \end_layout
12947
12948 \begin_layout Paragraph
12949 Theorems,
12950  Lemmas,
12951  Proofs and more
12952 \end_layout
12953
12954 \begin_layout Standard
12955 You can't have two of the same type of these environments directly following each other.
12956  If you use a normal paragraph break,
12957  ,
12958  you will just be extending the previous environment as if you had merged the two environments together.
12959  Rather than that,
12960  you need to insert a so-called separator.
12961  Please refer to the section entitled
12962 \emph on
12963 Separate Nestings
12964 \emph default
12965  in the
12966 \emph on
12967 User's Guide
12968 \emph default
12969 .
12970 \end_layout
12971
12972 \begin_layout Paragraph
12973 Lists
12974 \end_layout
12975
12976 \begin_layout Standard
12977 You get all the commonly supported list styles found in other classes as well as two new ones.
12978  I'll only describe the new ones here.
12979  If you want to find out more about the other list environments check out the
12980 \emph on
12981 User's Guide.
12982
12983 \emph default
12984  If you intend to use itemized lists you might also want to read about the
12985 \family sans
12986 Itemize
12987 \begin_inset space ~
12988 \end_inset
12989
12990 Bullet
12991 \begin_inset space ~
12992 \end_inset
12993
12994 Selection
12995 \family default
12996  dialog described above in section
12997 \begin_inset space ~
12998 \end_inset
12999
13000
13001 \change_inserted 564990737 1671355684
13002
13003 \begin_inset CommandInset ref
13004 LatexCommand ref
13005 reference "chap:bullets"
13006 nolink "false"
13007
13008 \end_inset
13009
13010
13011 \change_deleted 564990737 1671355684
13012
13013 \begin_inset CommandInset ref
13014 LatexCommand ref
13015 reference "sec:bullet"
13016 nolink "false"
13017
13018 \end_inset
13019
13020
13021 \change_unchanged
13022 .
13023 \end_layout
13024
13025 \begin_layout Standard
13026 The two new list styles,
13027
13028 \family sans
13029 TickList
13030 \family default
13031  and
13032 \family sans
13033 CrossList
13034 \family default
13035 ,
13036  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.
13037  These lists are in fact dedicated variants of the
13038 \family sans
13039 Itemize
13040 \family default
13041  environment.
13042  They do however require that you have the
13043 \family typewriter
13044 psnfss
13045 \family default
13046  packages installed.
13047 \end_layout
13048
13049 \begin_layout Paragraph
13050 Figures and Tables
13051 \end_layout
13052
13053 \begin_layout Standard
13054
13055 \family sans
13056 Foil\SpecialChar TeX
13057
13058 \family default
13059  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.
13060  In fact if you change the float placement settings they are simply ignored.
13061 \end_layout
13062
13063 \begin_layout Paragraph
13064 Page Headers and Footers
13065 \begin_inset CommandInset label
13066 LatexCommand label
13067 name "sec:foilfoot"
13068
13069 \end_inset
13070
13071
13072 \end_layout
13073
13074 \begin_layout Standard
13075
13076 \family sans
13077 My
13078 \begin_inset space ~
13079 \end_inset
13080
13081 Logo
13082 \family default
13083  and
13084 \family sans
13085 Restriction
13086 \family default
13087  are two commands used to control the left-footer text string.
13088  The first is meant to allow you to include a graphic logo on your foils and defaults to
13089 \begin_inset Quotes eld
13090 \end_inset
13091
13092 -Typeset by
13093 \family sans
13094 Foil\SpecialChar TeX
13095
13096 \family default
13097 -
13098 \begin_inset Quotes erd
13099 \end_inset
13100
13101 .
13102  While the second is meant to provide a classification for the audience,
13103
13104 \emph on
13105 e.
13106 \begin_inset space \thinspace{}
13107 \end_inset
13108
13109 g.
13110 \emph default
13111
13112 \begin_inset space \space{}
13113 \end_inset
13114
13115 Confidential.
13116  It is empty by default.
13117 \end_layout
13118
13119 \begin_layout Standard
13120 The remaining page corners can be filled by
13121 \family sans
13122 Right
13123 \begin_inset space ~
13124 \end_inset
13125
13126 Footer
13127 \family default
13128  (which defaults to page numbers),
13129
13130 \family sans
13131 Right
13132 \begin_inset space ~
13133 \end_inset
13134
13135 Header
13136 \family default
13137  (top right) and
13138 \family sans
13139 Left
13140 \begin_inset space ~
13141 \end_inset
13142
13143 Header
13144 \family default
13145  (top left).
13146 \end_layout
13147
13148 \begin_layout Subsubsection
13149 Unsupported
13150 \family sans
13151 Foil\SpecialChar TeX
13152
13153 \family default
13154  Goodies
13155 \begin_inset CommandInset label
13156 LatexCommand label
13157 name "sec:unsuppfoils"
13158
13159 \end_inset
13160
13161
13162 \end_layout
13163
13164 \begin_layout Standard
13165 All the commands mentioned below need to be set in a
13166 \family sans
13167 \SpecialChar LaTeX
13168
13169 \family default
13170  environment or as
13171 \family sans
13172 \SpecialChar TeX
13173
13174 \family default
13175  within another environment.
13176 \end_layout
13177
13178 \begin_layout Paragraph
13179 Lengths
13180 \end_layout
13181
13182 \begin_layout Standard
13183 All lengths are adjusted using the
13184 \family typewriter
13185
13186 \backslash
13187 setlength{
13188 \family default
13189 \emph on
13190 lengthname
13191 \family typewriter
13192 \emph default
13193 }{
13194 \family default
13195 \emph on
13196 newlength
13197 \family typewriter
13198 \emph default
13199 }
13200 \family default
13201  command.
13202  Where
13203 \emph on
13204 lengthname
13205 \emph default
13206  should be replaced by the name given to the length you want to change and
13207 \emph on
13208 newlength
13209 \emph default
13210  is the length value.
13211  All lengths should be specified in units of length such as inches (
13212 \family typewriter
13213 in
13214 \family default
13215 ),
13216  millimeters (
13217 \family typewriter
13218 mm
13219 \family default
13220 ) or points (
13221 \family typewriter
13222 pt
13223 \family default
13224 ) or relative to some document or font-based length such as
13225 \family typewriter
13226
13227 \backslash
13228 textwidth
13229 \family default
13230 .
13231
13232 \end_layout
13233
13234 \begin_layout Standard
13235 It's possible to change the spacing between a foilhead and the body of the foil by adjusting the length specified by
13236 \family typewriter
13237
13238 \backslash
13239 foilheadskip
13240 \family default
13241 .
13242  For example,
13243  to make
13244 \emph on
13245 all
13246 \emph default
13247  foilheads 0.5
13248 \begin_inset space \space{}
13249 \end_inset
13250
13251 in closer to their bodies put the following in the preamble:
13252
13253 \family typewriter
13254
13255 \backslash
13256 setlength{
13257 \backslash
13258 foilheadskip}{-0.5in}
13259 \end_layout
13260
13261 \begin_layout Standard
13262 The spacings around floats can be adjusted by setting these lengths:
13263 \end_layout
13264
13265 \begin_layout Labeling
13266 \labelwidthstring MMMMMMMMMMM
13267
13268 \family typewriter
13269
13270 \backslash
13271 abovefloatskip
13272 \family default
13273  Separation between the text and the top of the float
13274 \end_layout
13275
13276 \begin_layout Labeling
13277 \labelwidthstring MMMMMMMMMMM
13278
13279 \family typewriter
13280
13281 \backslash
13282 abovecaptionskip
13283 \family default
13284  Separation between the float and the caption
13285 \end_layout
13286
13287 \begin_layout Labeling
13288 \labelwidthstring MMMMMMMMMMM
13289
13290 \family typewriter
13291
13292 \backslash
13293 belowcaptionskip
13294 \family default
13295  Separation between the caption and the following text
13296 \end_layout
13297
13298 \begin_layout Labeling
13299 \labelwidthstring MMMMMMMMMMM
13300
13301 \family typewriter
13302
13303 \backslash
13304 captionwidth
13305 \family default
13306  You can make the captions narrower than the surrounding text by adjusting this length.
13307  Best done relative to
13308 \family typewriter
13309
13310 \backslash
13311 textwidth
13312 \family default
13313 .
13314 \end_layout
13315
13316 \begin_layout Standard
13317 There are also several title page related lengths that you may find useful if you have a long title or several authors:
13318 \end_layout
13319
13320 \begin_layout Labeling
13321 \labelwidthstring MMMMMMMMMMM
13322
13323 \family typewriter
13324
13325 \backslash
13326 abovetitleskip
13327 \family default
13328  Separation from headers to
13329 \family sans
13330 Title
13331 \end_layout
13332
13333 \begin_layout Labeling
13334 \labelwidthstring MMMMMMMMMMM
13335
13336 \family typewriter
13337
13338 \backslash
13339 titleauthorskip
13340 \family default
13341  between
13342 \family sans
13343 Title
13344 \family default
13345  and
13346 \family sans
13347 Author
13348 \family default
13349  environments
13350 \end_layout
13351
13352 \begin_layout Labeling
13353 \labelwidthstring MMMMMMMMMMM
13354
13355 \family typewriter
13356
13357 \backslash
13358 authorauthorskip
13359 \family default
13360  between multiple
13361 \family sans
13362 Author
13363 \family default
13364  lines
13365 \end_layout
13366
13367 \begin_layout Labeling
13368 \labelwidthstring MMMMMMMMMMM
13369
13370 \family typewriter
13371
13372 \backslash
13373 authordateskip
13374 \family default
13375  between the
13376 \family sans
13377 Author
13378 \family default
13379  and the
13380 \family sans
13381 Date
13382 \end_layout
13383
13384 \begin_layout Labeling
13385 \labelwidthstring MMMMMMMMMMM
13386
13387 \family typewriter
13388
13389 \backslash
13390 dateabstractskip
13391 \family default
13392  between the
13393 \family sans
13394 Date
13395 \family default
13396  and the
13397 \family sans
13398 Abstract
13399 \end_layout
13400
13401 \begin_layout Standard
13402 The last length related command affects all the list environments.
13403  If you place
13404 \family typewriter
13405
13406 \backslash
13407 zerolistvertdimens
13408 \family default
13409
13410 \emph on
13411 inside
13412 \emph default
13413  a list environment then all the vertical spacing between the list items is removed.
13414  Note that this is a command not a length so it doesn't require
13415 \family typewriter
13416
13417 \backslash
13418 setlength
13419 \family default
13420  like the stuff mentioned above.
13421 \end_layout
13422
13423 \begin_layout Paragraph
13424 Headers and Footers
13425 \end_layout
13426
13427 \begin_layout Standard
13428 The
13429 \family typewriter
13430
13431 \backslash
13432 LogoOn
13433 \family default
13434  and
13435 \family typewriter
13436
13437 \backslash
13438 LogoOff
13439 \family default
13440  commands control whether the logo in the
13441 \family sans
13442 MyLogo
13443 \family default
13444  definition appear on a given page.
13445  If you put
13446 \family typewriter
13447
13448 \backslash
13449 LogoOff
13450 \family default
13451  in the preamble then none of the foils will have the logo on them.
13452  If you don't want the logo on a particular page place the
13453 \family typewriter
13454
13455 \backslash
13456 LogoOff
13457 \family default
13458  directly after the foilhead of that page and the
13459 \family typewriter
13460
13461 \backslash
13462 LogoOn
13463 \family default
13464  directly after the next foilhead.
13465 \end_layout
13466
13467 \begin_layout Standard
13468 If you decide to use the
13469 \family sans
13470 fancy
13471 \family default
13472  page style setting in the
13473 \family sans
13474 Document
13475 \begin_inset space ~
13476 \end_inset
13477
13478 Layout
13479 \family default
13480  dialog you should probably add
13481 \family typewriter
13482
13483 \backslash
13484 let
13485 \backslash
13486 headwidth
13487 \backslash
13488 textwidth
13489 \family default
13490  to your preamble so headers and footers on landscape pages are correctly placed when rotated.
13491  This is due to some clashes between the page layouts provided by the
13492 \family sans
13493 fancyheadings
13494 \family default
13495  package and the
13496 \change_deleted -712698321 1673257120
13497
13498 \family sans
13499 foils
13500 \change_inserted -712698321 1673257120
13501
13502 \lang ngerman
13503 FoilTeX
13504 \change_unchanged
13505
13506 \family default
13507 \lang english
13508  class.
13509 \end_layout
13510
13511 \begin_layout Subsection
13512
13513 \change_inserted 564990737 1671459032
13514 Powerdot
13515 \end_layout
13516
13517 \begin_layout Standard
13518
13519 \change_inserted 564990737 1671643165
13520 The document class
13521 \change_deleted -712698321 1673257152
13522
13523 \family sans
13524 presentation
13525 \begin_inset space \thinspace{}
13526 \end_inset
13527
13528 (p
13529 \change_inserted -712698321 1673257152
13530 P
13531 \change_inserted 564990737 1671643165
13532 owerdot
13533 \change_deleted -712698321 1673257154
13534 )
13535 \change_inserted 564990737 1671643165
13536
13537 \family default
13538  uses the
13539 \family typewriter
13540 powerdot.cls
13541 \family default
13542
13543 \change_deleted -712698321 1673257280
13544 document
13545 \change_inserted -712698321 1673257280
13546 \SpecialChar LaTeX
13547
13548 \change_inserted 564990737 1671643165
13549  class for creating presentations.
13550
13551 \family sans
13552 File\SpecialChar menuseparator
13553 Open Example\SpecialChar menuseparator
13554 Presentations\SpecialChar menuseparator
13555 Powerdot
13556 \family default
13557  offers guidance on its use.
13558  The documentation is available from
13559 \begin_inset CommandInset href
13560 LatexCommand href
13561 name "CTAN"
13562 target "http://mirrors.ctan.org/macros/latex/contrib/powerdot/doc/powerdot.pdf"
13563 literal "false"
13564
13565 \end_inset
13566
13567 .
13568 \end_layout
13569
13570 \begin_layout Subsection
13571
13572 \change_inserted 564990737 1671459032
13573 \begin_inset CommandInset label
13574 LatexCommand label
13575 name "subsec:Seminar"
13576
13577 \end_inset
13578
13579
13580 \family sans
13581 Seminar
13582 \end_layout
13583
13584 \begin_layout Standard
13585
13586 \change_inserted 564990737 1671643194
13587 The document class
13588 \change_deleted -712698321 1673257295
13589
13590 \family sans
13591 presentations
13592 \begin_inset space \thinspace{}
13593 \end_inset
13594
13595 (s
13596 \change_inserted -712698321 1673257295
13597 S
13598 \change_inserted 564990737 1671643194
13599 eminar
13600 \change_deleted -712698321 1673257296
13601 )
13602 \change_inserted 564990737 1671643194
13603
13604 \family default
13605  uses the
13606 \family typewriter
13607 seminar.cls
13608 \family default
13609  document class for creating presentations.
13610
13611 \family sans
13612 File\SpecialChar menuseparator
13613 Open Example\SpecialChar menuseparator
13614 Presentations\SpecialChar menuseparator
13615 Seminar
13616 \family default
13617  offers guidance on its use.
13618  The documentation is available from
13619 \begin_inset CommandInset href
13620 LatexCommand href
13621 name "CTAN"
13622 target "http://mirrors.ctan.org/macros/latex/contrib/seminar/doc/seminar-doc.pdf"
13623 literal "false"
13624
13625 \end_inset
13626
13627 .
13628 \end_layout
13629
13630 \begin_layout Subsection
13631 Slides [aka
13632 \noun on
13633 Sli\SpecialChar TeX
13634
13635 \noun default
13636 ]
13637 \begin_inset CommandInset label
13638 LatexCommand label
13639 name "sec:slitex"
13640
13641 \end_inset
13642
13643
13644 \end_layout
13645
13646 \begin_layout Standard
13647
13648 \change_inserted 564990737 1672743492
13649 Original by
13650 \noun on
13651 John Weiss
13652 \noun default
13653 ;
13654  updated by the \SpecialChar LyX
13655  Team
13656 \end_layout
13657
13658 \begin_layout Subsubsection
13659
13660 \change_inserted 564990737 1672743492
13661 Introduction
13662 \end_layout
13663
13664 \begin_layout Standard
13665
13666 \change_inserted 564990737 1672743492
13667 This section describes how to use \SpecialChar LyX
13668  to make slides for overhead projectors.
13669  There are two document classes that can do this:
13670  the
13671 \change_deleted -712698321 1673257697
13672
13673 \family typewriter
13674 presentations
13675 \begin_inset space \thinspace{}
13676 \end_inset
13677
13678 (s
13679 \change_inserted -712698321 1673257697
13680
13681 \family sans
13682 S
13683 \change_inserted 564990737 1672743492
13684 lides
13685 \change_deleted -712698321 1673257698
13686
13687 \family typewriter
13688 )
13689 \change_inserted 564990737 1672743492
13690
13691 \family default
13692  document class and the
13693 \change_deleted -712698321 1673257705
13694
13695 \family sans
13696 presentation
13697 \begin_inset space \thinspace{}
13698 \end_inset
13699
13700 (
13701 \change_inserted 564990737 1672743492
13702 Foil\SpecialChar TeX
13703
13704 \change_deleted -712698321 1673257707
13705 )
13706 \change_inserted 564990737 1672743492
13707
13708 \family default
13709  document class.
13710  This section documents the former.
13711  If you’re looking for the documentation for
13712 \change_deleted -712698321 1673257759
13713
13714 \family sans
13715 presentation
13716 \begin_inset space \thinspace{}
13717 \end_inset
13718
13719 (
13720 \change_inserted 564990737 1672743492
13721 Foil\SpecialChar TeX
13722
13723 \change_deleted -712698321 1673257760
13724 )
13725 \change_inserted 564990737 1672743492
13726
13727 \family default
13728 ,
13729  check out section
13730 \begin_inset space ~
13731 \end_inset
13732
13733
13734 \change_inserted -712698321 1673257749
13735
13736 \begin_inset CommandInset ref
13737 LatexCommand ref
13738 reference "sec:foiltex"
13739 plural "false"
13740 caps "false"
13741 noprefix "false"
13742 nolink "false"
13743
13744 \end_inset
13745
13746
13747 \change_deleted -712698321 1673257749
13748
13749 \begin_inset CommandInset ref
13750 LatexCommand ref
13751 reference "sec:Foiltex"
13752 nolink "false"
13753
13754 \end_inset
13755
13756
13757 \change_inserted 564990737 1672743492
13758 .
13759  As of 2023
13760 \change_deleted -712698321 1673257899
13761 the former
13762 \change_inserted -712698321 1673257899
13763
13764 \family sans
13765 Slides
13766 \change_inserted 564990737 1672743492
13767
13768 \family default
13769  has continued to be maintained whereas
13770 \family sans
13771 Foil\SpecialChar TeX
13772
13773 \family default
13774  has not been maintained since 2008.
13775
13776 \change_deleted 564990737 1672743492
13777 by
13778 \noun on
13779 John Weiss
13780 \noun default
13781
13782 \end_layout
13783
13784 \begin_layout Standard
13785
13786 \change_deleted 564990737 1672743492
13787 Introduction
13788 \end_layout
13789
13790 \begin_layout Standard
13791
13792 \change_deleted 564990737 1672743492
13793 This section describes how to use \SpecialChar LyX
13794  to make slides for overhead projectors.
13795  There are two document classes that can do this:
13796  the default slides class and the
13797 \family sans
13798 Foil\SpecialChar TeX
13799
13800 \family default
13801  slides class.
13802  This section documents the former.
13803 \end_layout
13804
13805 \begin_layout Standard
13806
13807 \change_deleted 564990737 1672743492
13808 I'm going to say this again,
13809  nice and clear,
13810  so that there's no misunderstanding:
13811 \end_layout
13812
13813 \begin_layout Standard
13814
13815 \change_deleted 564990737 1672743492
13816 \begin_inset VSpace bigskip
13817 \end_inset
13818
13819
13820 \end_layout
13821
13822 \begin_layout Standard
13823 \align center
13824
13825 \change_deleted 564990737 1672743492
13826
13827 \size large
13828 This section documents the class
13829 \begin_inset Quotes eld
13830 \end_inset
13831
13832
13833 \family sans
13834 slides (default)
13835 \family default
13836
13837 \begin_inset Quotes erd
13838 \end_inset
13839
13840
13841 \emph on
13842 only.
13843 \end_layout
13844
13845 \begin_layout Standard
13846
13847 \change_deleted 564990737 1672743492
13848 \begin_inset VSpace bigskip
13849 \end_inset
13850
13851
13852 \end_layout
13853
13854 \begin_layout Standard
13855
13856 \change_deleted 564990737 1672743492
13857 If you're looking for the documentation for
13858 \begin_inset Quotes eld
13859 \end_inset
13860
13861
13862 \family sans
13863 slides (Foil\SpecialChar TeX
13864 )
13865 \family default
13866
13867 \begin_inset Quotes erd
13868 \end_inset
13869
13870 ,
13871  check out section
13872 \begin_inset space ~
13873 \end_inset
13874
13875
13876 \begin_inset CommandInset ref
13877 LatexCommand ref
13878 reference "sec:foiltex"
13879 nolink "false"
13880
13881 \end_inset
13882
13883 .
13884  The
13885 \family sans
13886 foils
13887 \family default
13888  class [
13889 \begin_inset Quotes eld
13890 \end_inset
13891
13892
13893 \family sans
13894 slides (Foil\SpecialChar TeX
13895 )
13896 \family default
13897
13898 \begin_inset Quotes erd
13899 \end_inset
13900
13901 ] is actually somewhat better than the default
13902 \family sans
13903 slides
13904 \family default
13905  class,
13906 \begin_inset Foot
13907 status collapsed
13908
13909 \begin_layout Plain Layout
13910 \SpecialChar ldots
13911 or so I've been told repeatedly by its advocates.
13912  Having never used it,
13913  I have no idea if this claim is true or not.
13914 \end_layout
13915
13916 \end_inset
13917
13918  which this section documents.
13919 \end_layout
13920
13921 \begin_layout Standard
13922
13923 \change_deleted 564990737 1672743492
13924 This class is the \SpecialChar LaTeX2e
13925  improvement of the old
13926 \noun on
13927 Sli\SpecialChar TeX
13928
13929 \noun default
13930  package.
13931  Every \SpecialChar LaTeX2e
13932  distribution includes this class [which I'll just refer to as
13933 \begin_inset Quotes eld
13934 \end_inset
13935
13936
13937 \family sans
13938 slides
13939 \family default
13940
13941 \begin_inset Quotes erd
13942 \end_inset
13943
13944  from now on],
13945  so you're bound to have it.
13946  As I noted earlier,
13947  there are other classes,
13948  such as
13949 \family sans
13950 foils
13951 \family default
13952 ,
13953  which also produce slides for overhead projectors and do a better job at it.
13954  However,
13955  there are some things which
13956 \family sans
13957 slides
13958 \family default
13959  can do which the others can't,
13960  such as generate overlays.
13961  Read on to learn more!
13962 \change_unchanged
13963
13964 \end_layout
13965
13966 \begin_layout Subsubsection
13967 Getting Started
13968 \begin_inset CommandInset label
13969 LatexCommand label
13970 name "sec:slidesetup"
13971
13972 \end_inset
13973
13974
13975 \end_layout
13976
13977 \begin_layout Standard
13978 Obviously,
13979  to use this document class,
13980  you need to select
13981 \begin_inset Quotes eld
13982 \end_inset
13983
13984
13985 \change_deleted -712698321 1673257922
13986
13987 \family sans
13988 s
13989 \change_inserted -712698321 1673257922
13990 S
13991 \change_unchanged
13992 lides
13993 \change_deleted -712698321 1673257925
13994  (default)
13995 \change_unchanged
13996
13997 \family default
13998
13999 \begin_inset Quotes erd
14000 \end_inset
14001
14002  from the class list in the
14003 \family sans
14004 Document\SpecialChar menuseparator
14005 Settings
14006 \family default
14007  dialog.
14008  There are some other special things you should know about this class:
14009 \end_layout
14010
14011 \begin_layout Itemize
14012 Don't bother changing the options
14013 \family sans
14014 Sides and Columns
14015 \family default
14016 .
14017  They're not supported by the
14018 \change_deleted -712698321 1673257960
14019
14020 \family sans
14021 s
14022 \change_inserted -712698321 1673257960
14023 S
14024 \change_unchanged
14025 lides
14026 \family default
14027  class,
14028  anyways.
14029 \end_layout
14030
14031 \begin_layout Itemize
14032 The option
14033 \family sans
14034 Page
14035 \begin_inset space ~
14036 \end_inset
14037
14038 style
14039 \family default
14040  behaves a bit differently for this class.
14041  The possible choices and what they do are as follows:
14042 \end_layout
14043
14044 \begin_deeper
14045 \begin_layout Description
14046
14047 \family sans
14048 plain
14049 \family default
14050  The final output contains page numbers in the lower right corner.
14051 \end_layout
14052
14053 \begin_layout Description
14054
14055 \family sans
14056 headings
14057 \family default
14058  Like
14059 \family sans
14060 plain
14061 \family default
14062 ,
14063  but also prints out any time markers you've put in.
14064  This is the default.
14065 \end_layout
14066
14067 \begin_layout Description
14068
14069 \family sans
14070 empty
14071 \family default
14072  The final output contains no page numbers,
14073  time markers,
14074  or alignment markers.
14075 \end_layout
14076
14077 \end_deeper
14078 \begin_layout Itemize
14079 The
14080 \change_deleted -712698321 1673257971
14081
14082 \family sans
14083 s
14084 \change_inserted -712698321 1673257971
14085 S
14086 \change_unchanged
14087 lides
14088 \family default
14089  class has an extra option:
14090
14091 \family typewriter
14092 clock
14093 \family default
14094 .
14095  To use it,
14096  put
14097 \begin_inset Quotes eld
14098 \end_inset
14099
14100
14101 \family typewriter
14102 clock
14103 \family default
14104
14105 \begin_inset Quotes erd
14106 \end_inset
14107
14108  in the extra class options.
14109 \end_layout
14110
14111 \begin_deeper
14112 \begin_layout Standard
14113 Using this options allows you to add time markers to
14114 \family sans
14115 Note
14116 \family default
14117 s.
14118  See section
14119 \begin_inset space ~
14120 \end_inset
14121
14122
14123 \begin_inset CommandInset ref
14124 LatexCommand ref
14125 reference "sec:slideNote"
14126 nolink "false"
14127
14128 \end_inset
14129
14130  for more details.
14131 \end_layout
14132
14133 \end_deeper
14134 \begin_layout Standard
14135 You can also use the template file
14136 \change_deleted 564990737 1671617694
14137
14138 \begin_inset Quotes eld
14139 \end_inset
14140
14141
14142 \family typewriter
14143 slides.lyx
14144 \family default
14145
14146 \begin_inset Quotes erd
14147 \end_inset
14148
14149
14150 \change_unchanged
14151  to automatically set up a document to use the
14152 \family sans
14153 slides
14154 \family default
14155  class
14156 \change_deleted 564990737 1671617699
14157 [
14158 \change_unchanged
14159 using
14160 \family sans
14161 File\SpecialChar menuseparator
14162 New
14163 \begin_inset space ~
14164 \end_inset
14165
14166 from
14167 \begin_inset space ~
14168 \end_inset
14169
14170 Template
14171 \change_inserted 564990737 1671617723
14172 \SpecialChar menuseparator
14173 Presentations\SpecialChar menuseparator
14174 Slides
14175 \change_unchanged
14176
14177 \family default
14178  to open your new document
14179 \change_deleted 564990737 1671617728
14180 ]
14181 \change_unchanged
14182 .
14183  The template file also contains some examples of the special paragraph environments used by this class.
14184  I'll describe those next.
14185 \end_layout
14186
14187 \begin_layout Subsubsection
14188 Paragraph Environments
14189 \end_layout
14190
14191 \begin_layout Paragraph
14192 Supported Environments
14193 \end_layout
14194
14195 \begin_layout Standard
14196 The first thing you'll notice when you start up a new
14197 \change_deleted -712698321 1673258063
14198
14199 \family sans
14200 s
14201 \change_inserted -712698321 1673258063
14202 S
14203 \change_unchanged
14204 lides
14205 \family default
14206  document is the font size and type:
14207  it's the equivalent of the size
14208 \begin_inset Quotes eld
14209 \end_inset
14210
14211
14212 \family sans
14213 Largest
14214 \family default
14215
14216 \begin_inset Quotes erd
14217 \end_inset
14218
14219  in the
14220 \family sans
14221 Sans
14222 \begin_inset space ~
14223 \end_inset
14224
14225 Serif
14226 \family default
14227  font.
14228  This is also what's used in the output.
14229  Think of this as a
14230 \begin_inset Quotes eld
14231 \end_inset
14232
14233 visual cue
14234 \begin_inset Quotes erd
14235 \end_inset
14236
14237  to remind you that this is a slide.
14238  Your final slides will use a larger font;
14239  ergo,
14240  you'll have less space.
14241  Of course,
14242  the larger default screen font isn't WYSIWYG,
14243  only a reminder.
14244 \end_layout
14245
14246 \begin_layout Standard
14247 The next thing that becomes obvious is the changes to the paragraph environment pull-down box [at the far-left end of the toolbar].
14248  Most of the paragraph environments you're used to seeing are missing.
14249  There are also five new ones.
14250  That's because the
14251 \change_deleted -712698321 1673258093
14252
14253 \family sans
14254 s
14255 \change_inserted -712698321 1673258093
14256 S
14257 \change_unchanged
14258 lides
14259 \family default
14260  class itself only supports certain paragraph environments:
14261 \end_layout
14262
14263 \begin_layout Standard
14264
14265 \change_inserted -712698321 1673258082
14266
14267 \family sans
14268 \begin_inset Flex Multiple Columns
14269 status open
14270
14271 \begin_layout Itemize
14272
14273 \change_inserted -712698321 1673258082
14274
14275 \family sans
14276 Standard
14277 \end_layout
14278
14279 \begin_layout Itemize
14280
14281 \change_inserted -712698321 1673258082
14282
14283 \family sans
14284 Itemize
14285 \end_layout
14286
14287 \begin_layout Itemize
14288
14289 \change_inserted -712698321 1673258082
14290
14291 \family sans
14292 Enumerate
14293 \end_layout
14294
14295 \begin_layout Itemize
14296
14297 \change_inserted -712698321 1673258082
14298
14299 \family sans
14300 Description
14301 \end_layout
14302
14303 \begin_layout Itemize
14304
14305 \change_inserted -712698321 1673258082
14306
14307 \family sans
14308 List
14309 \end_layout
14310
14311 \begin_layout Itemize
14312
14313 \change_inserted -712698321 1673258082
14314
14315 \family sans
14316 Quotation
14317 \end_layout
14318
14319 \begin_layout Itemize
14320
14321 \change_inserted -712698321 1673258082
14322
14323 \family sans
14324 Quote
14325 \end_layout
14326
14327 \begin_layout Itemize
14328
14329 \change_inserted -712698321 1673258082
14330
14331 \family sans
14332 Verse
14333 \end_layout
14334
14335 \begin_layout Itemize
14336
14337 \change_inserted -712698321 1673258082
14338
14339 \family sans
14340 Caption
14341 \end_layout
14342
14343 \begin_layout Itemize
14344
14345 \change_inserted -712698321 1673258082
14346
14347 \family sans
14348 \SpecialChar LyX
14349 -Code
14350 \change_unchanged
14351
14352 \end_layout
14353
14354 \end_inset
14355
14356
14357 \change_deleted -712698321 1673258082
14358 Standard
14359 \end_layout
14360
14361 \begin_layout Itemize
14362
14363 \change_deleted -712698321 1673258082
14364
14365 \family sans
14366 Itemize
14367 \end_layout
14368
14369 \begin_layout Itemize
14370
14371 \change_deleted -712698321 1673258082
14372
14373 \family sans
14374 Enumerate
14375 \end_layout
14376
14377 \begin_layout Itemize
14378
14379 \change_deleted -712698321 1673258082
14380
14381 \family sans
14382 Description
14383 \end_layout
14384
14385 \begin_layout Itemize
14386
14387 \change_deleted -712698321 1673258082
14388
14389 \family sans
14390 List
14391 \end_layout
14392
14393 \begin_layout Itemize
14394
14395 \change_deleted -712698321 1673258082
14396
14397 \family sans
14398 Quotation
14399 \end_layout
14400
14401 \begin_layout Itemize
14402
14403 \change_deleted -712698321 1673258082
14404
14405 \family sans
14406 Quote
14407 \end_layout
14408
14409 \begin_layout Itemize
14410
14411 \change_deleted -712698321 1673258082
14412
14413 \family sans
14414 Verse
14415 \end_layout
14416
14417 \begin_layout Itemize
14418
14419 \change_deleted -712698321 1673258082
14420
14421 \family sans
14422 Caption
14423 \end_layout
14424
14425 \begin_layout Itemize
14426
14427 \change_deleted -712698321 1673258082
14428
14429 \family sans
14430 \SpecialChar LyX
14431 -Code
14432 \change_unchanged
14433
14434 \end_layout
14435
14436 \begin_layout Standard
14437 All of the other standard environments,
14438  including the section-heading environments,
14439  aren't used in the
14440 \change_deleted -712698321 1673258102
14441
14442 \family sans
14443 s
14444 \change_inserted -712698321 1673258102
14445 S
14446 \change_unchanged
14447 lides
14448 \family default
14449  class.
14450 \end_layout
14451
14452 \begin_layout Standard
14453 On the other hand,
14454  you'll notice the following new environments:
14455 \end_layout
14456
14457 \begin_layout Standard
14458
14459 \change_inserted -712698321 1673258111
14460
14461 \family sans
14462 \begin_inset Flex Multiple Columns
14463 status open
14464
14465 \begin_layout Itemize
14466
14467 \change_inserted -712698321 1673258111
14468
14469 \family sans
14470 Slide
14471 \end_layout
14472
14473 \begin_layout Itemize
14474
14475 \change_inserted -712698321 1673258111
14476
14477 \family sans
14478 Overlay
14479 \end_layout
14480
14481 \begin_layout Itemize
14482
14483 \change_inserted -712698321 1673258111
14484
14485 \family sans
14486 Note
14487 \end_layout
14488
14489 \begin_layout Itemize
14490
14491 \change_inserted -712698321 1673258111
14492
14493 \family sans
14494 InvisibleText
14495 \end_layout
14496
14497 \begin_layout Itemize
14498
14499 \change_inserted -712698321 1673258119
14500
14501 \family sans
14502 VisibleText
14503 \end_layout
14504
14505 \begin_deeper
14506 \begin_layout Plain Layout
14507
14508 \change_inserted -712698321 1673258133
14509 \begin_inset space ~
14510 \end_inset
14511
14512
14513 \change_unchanged
14514
14515 \end_layout
14516
14517 \end_deeper
14518 \end_inset
14519
14520
14521 \change_deleted -712698321 1673258111
14522 Slide
14523 \end_layout
14524
14525 \begin_layout Itemize
14526
14527 \change_deleted -712698321 1673258111
14528
14529 \family sans
14530 Overlay
14531 \end_layout
14532
14533 \begin_layout Itemize
14534
14535 \change_deleted -712698321 1673258111
14536
14537 \family sans
14538 Note
14539 \end_layout
14540
14541 \begin_layout Itemize
14542
14543 \change_deleted -712698321 1673258111
14544
14545 \family sans
14546 InvisibleText
14547 \end_layout
14548
14549 \begin_layout Itemize
14550
14551 \change_deleted -712698321 1673258111
14552
14553 \family sans
14554 VisibleText
14555 \change_unchanged
14556
14557 \end_layout
14558
14559 \begin_layout Standard
14560 These five are kind of quirky,
14561  due to a
14562 \begin_inset Quotes eld
14563 \end_inset
14564
14565 feature
14566 \begin_inset Quotes erd
14567 \end_inset
14568
14569  in \SpecialChar LyX
14570 .
14571  You see,
14572  \SpecialChar LyX
14573  doesn't permit you to nest any other paragraph environment into an empty environment.
14574  Now,
14575  that's fine and dandy,
14576  but it means that you wouldn't be able to start a slide with anything except plain text.
14577  To deal with this,
14578  I've performed a little
14579 \begin_inset Quotes eld
14580 \end_inset
14581
14582 \SpecialChar LaTeX
14583  magic.
14584 \begin_inset Quotes erd
14585 \end_inset
14586
14587
14588 \end_layout
14589
14590 \begin_layout Paragraph
14591 Quirks of the New Environments
14592 \begin_inset CommandInset label
14593 LatexCommand label
14594 name "sec:slideQuirk"
14595
14596 \end_inset
14597
14598
14599 \end_layout
14600
14601 \begin_layout Standard
14602 All five of the new paragraph environments are somewhat quirky due to inherent limitiations in the current version of \SpecialChar LyX
14603 .
14604  As I just mentioned,
14605  \SpecialChar LyX
14606  forbids environments that begin with another environment.
14607  To get around this,
14608  the
14609 \family sans
14610 Slide
14611 \family default
14612  environment isn't a paragraph environment as described in the
14613 \emph on
14614 User's Guide
14615 \emph default
14616 .
14617
14618 \end_layout
14619
14620 \begin_layout Standard
14621 You should consider
14622 \family sans
14623 Slide
14624 \family default
14625 ,
14626
14627 \family sans
14628 Overlay
14629 \family default
14630 ,
14631  and
14632 \family sans
14633 Note
14634 \family default
14635  to be
14636 \begin_inset Quotes eld
14637 \end_inset
14638
14639 pseudo-environments.
14640 \begin_inset Quotes erd
14641 \end_inset
14642
14643  They look like a section heading or a
14644 \begin_inset Quotes eld
14645 \end_inset
14646
14647
14648 \family sans
14649 Caption
14650 \family default
14651 ,
14652 \begin_inset Quotes erd
14653 \end_inset
14654
14655  but really begin a [and,
14656  if necessary,
14657  end the previous] paragraph environment.
14658  Likewise,
14659  treat
14660 \family sans
14661 InvisibleText
14662 \family default
14663  and
14664 \family sans
14665 VisibleText
14666 \family default
14667  as
14668 \begin_inset Quotes eld
14669 \end_inset
14670
14671 pseudo-commands.
14672 \begin_inset Quotes erd
14673 \end_inset
14674
14675  These two perform some action.
14676 \end_layout
14677
14678 \begin_layout Standard
14679 A common feature of all five environments,
14680
14681 \family sans
14682 Slide
14683 \family default
14684 ,
14685
14686 \family sans
14687 Overlay
14688 \family default
14689 ,
14690
14691 \family sans
14692 Note
14693 \family default
14694 ,
14695
14696 \family sans
14697 InvisibleText
14698 \family default
14699  and
14700 \family sans
14701 VisibleText
14702 \family default
14703 ,
14704  is a rather long-ish label.
14705  The text following this label —
14706  ordinarily the contents of the paragraph environment —
14707  is utterly irrelevant for
14708 \family sans
14709 Slide
14710 \family default
14711 ,
14712
14713 \family sans
14714 Overlay
14715 \family default
14716 ,
14717
14718 \family sans
14719 Note
14720 \family default
14721 ,
14722
14723 \family sans
14724 InvisibleText
14725 \family default
14726  and
14727 \family sans
14728 VisibleText
14729 \family default
14730 .
14731  \SpecialChar LyX
14732  completely ignores it.
14733  In fact,
14734  you can leave these five environments completely empty.
14735
14736 \end_layout
14737
14738 \begin_layout Standard
14739 While you don't
14740 \emph on
14741 have
14742 \emph default
14743  to put any text after the rather long-ish label,
14744  you might want to.
14745  This could be a short description of the contents of the
14746 \family sans
14747 Slide
14748 \family default
14749 ,
14750  for example.
14751  In that case,
14752  enter your descriptive comment and hit
14753 \family sans
14754 Return
14755 \family default
14756  as you normally would.
14757 \end_layout
14758
14759 \begin_layout Standard
14760
14761 \change_deleted -712698321 1673258321
14762 If,
14763  on the other hand,
14764  you don't want to enter any descriptive text,
14765  you'll hit another \SpecialChar LyX
14766  quirk.
14767  \SpecialChar LyX
14768 ,
14769  like nature,
14770  abhors a vacuum,
14771  and will not let you start a new paragraph environment until you put something in the old one.
14772  So,
14773  do this:
14774 \end_layout
14775
14776 \begin_layout Itemize
14777
14778 \change_deleted -712698321 1673258321
14779 Start entering the text that will
14780 \emph on
14781 follow
14782 \emph default
14783  the new
14784 \family sans
14785 Slide
14786 \family default
14787 ,
14788
14789 \family sans
14790 Overlay
14791 \family default
14792 ,
14793
14794 \family sans
14795 Note
14796 \family default
14797 ,
14798
14799 \family sans
14800 InvisibleText
14801 \family default
14802  or
14803 \family sans
14804 VisibleText
14805 \family default
14806 .
14807
14808 \end_layout
14809
14810 \begin_layout Itemize
14811
14812 \change_deleted -712698321 1673258321
14813 Now move to the beginning of that paragraph.
14814
14815 \end_layout
14816
14817 \begin_layout Itemize
14818
14819 \change_deleted -712698321 1673258321
14820 Next,
14821  hit
14822 \family sans
14823 Return
14824 \family default
14825 .
14826
14827 \end_layout
14828
14829 \begin_layout Itemize
14830
14831 \change_deleted -712698321 1673258321
14832 Finally,
14833  change this new,
14834  empty paragraph to a
14835 \family sans
14836 Slide
14837 \family default
14838 ,
14839
14840 \family sans
14841 Overlay
14842 \family default
14843 ,
14844
14845 \family sans
14846 Note
14847 \family default
14848 ,
14849
14850 \family sans
14851 InvisibleText
14852 \family default
14853  or
14854 \family sans
14855 VisibleText
14856 \family default
14857 .
14858
14859 \end_layout
14860
14861 \begin_layout Standard
14862
14863 \change_deleted -712698321 1673258321
14864 Some future version of \SpecialChar LyX
14865  will,
14866  hopefully,
14867  resolve this quirkiness\SpecialChar ldots
14868
14869 \change_unchanged
14870
14871 \end_layout
14872
14873 \begin_layout Subsubsection
14874 Making a Presentation with
14875 \family sans
14876 Slide
14877 \family default
14878 ,
14879
14880 \family sans
14881 Overlay
14882 \family default
14883  and
14884 \family sans
14885 Note
14886 \end_layout
14887
14888 \begin_layout Paragraph
14889 Using the
14890 \family sans
14891 Slide
14892 \family default
14893  Environment
14894 \end_layout
14895
14896 \begin_layout Standard
14897 If you're expecting this section to teach you how to actually make a presentation,
14898  you'll be sorely disappointed.
14899  Naturally,
14900  I'll describe all of the ways the
14901 \change_deleted -712698321 1673258368
14902
14903 \family sans
14904 s
14905 \change_inserted -712698321 1673258368
14906 S
14907 \change_unchanged
14908 lides
14909 \family default
14910  class can assist you in preparing the materials for a presentation.
14911  Filling in the contents,
14912  however,
14913  is up to you.
14914  [Then again,
14915  that
14916 \emph on
14917 is
14918 \emph default
14919  the \SpecialChar LyX
14920  philosophy.]
14921 \end_layout
14922
14923 \begin_layout Standard
14924 Choosing the
14925 \family sans
14926 Slide
14927 \family default
14928  environment [in the manner described in section
14929 \begin_inset space ~
14930 \end_inset
14931
14932
14933 \begin_inset CommandInset ref
14934 LatexCommand ref
14935 reference "sec:slideQuirk"
14936 nolink "false"
14937
14938 \end_inset
14939
14940 ] tells \SpecialChar LyX
14941  to begin a new slide [duh].
14942  The label for this environment/
14943 \change_inserted -712698321 1673258390
14944
14945 \begin_inset Quotes eld
14946 \end_inset
14947
14948
14949 \change_deleted -712698321 1673258391
14950
14951 \begin_inset Quotes erd
14952 \end_inset
14953
14954
14955 \change_unchanged
14956 pseudo-command
14957 \begin_inset Quotes erd
14958 \end_inset
14959
14960  is an
14961 \begin_inset Quotes eld
14962 \end_inset
14963
14964 ASCII line,
14965 \begin_inset Quotes erd
14966 \end_inset
14967
14968  in cool blue,
14969  followed by the label,
14970
14971 \begin_inset Quotes eld
14972 \end_inset
14973
14974 NewSlide:
14975 \begin_inset Quotes erd
14976 \end_inset
14977
14978 .
14979  Any text or paragraph environments that follow this one go on the new slide.
14980  It's that simple.
14981 \end_layout
14982
14983 \begin_layout Standard
14984 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
14985  (this can be specified in the
14986 \family sans
14987 Paragraph Layout
14988 \family default
14989  dialog).
14990  In fact,
14991  you'll want to,
14992  once you finish entering the contents of one slide.
14993  If you've entered more text than can physically fit on a slide,
14994  the extra overflows onto a new slide.
14995  I don't recommend doing this,
14996  however,
14997  since the overflow slide won't have any page number on it.
14998  Furthermore,
14999  it may interfere with any
15000 \family sans
15001 Overlay
15002 \family default
15003  you've made to accompany the oversized
15004 \family sans
15005 Slide
15006 \family default
15007 .
15008 \end_layout
15009
15010 \begin_layout Standard
15011 The
15012 \family sans
15013 Overlay
15014 \family default
15015  and
15016 \family sans
15017 Note
15018 \family default
15019  environments work the same way as the
15020 \family sans
15021 Slide
15022 \family default
15023  environment.
15024  They both create an
15025 \begin_inset Quotes eld
15026 \end_inset
15027
15028 ASCII line
15029 \begin_inset Quotes erd
15030 \end_inset
15031
15032  followed by a label [
15033 \begin_inset Quotes eld
15034 \end_inset
15035
15036 NewOverlay:
15037 \begin_inset Quotes erd
15038 \end_inset
15039
15040  and
15041 \begin_inset Quotes eld
15042 \end_inset
15043
15044 NewNote:
15045 \begin_inset Quotes erd
15046 \end_inset
15047
15048 ,
15049  respectively].
15050  The color is a stunning magenta instead of blue,
15051  and the
15052 \begin_inset Quotes eld
15053 \end_inset
15054
15055 ASCII line
15056 \begin_inset Quotes erd
15057 \end_inset
15058
15059  will look different,
15060  in style and in length.
15061  The label fonts of all three also differ from one another.
15062 \end_layout
15063
15064 \begin_layout Standard
15065 As with a
15066 \family sans
15067 Slide
15068 \family default
15069 ,
15070  if the contents of a
15071 \family sans
15072 Note
15073 \family default
15074  or
15075 \family sans
15076 Overlay
15077 \family default
15078  exceed the physical size of a slide or sheet of paper,
15079  the extra will overflow onto a new sheet.
15080  Again,
15081  you should avoid this.
15082  It defeats the whole purpose of
15083 \family sans
15084 Note
15085 \family default
15086 s and
15087 \family sans
15088 Overlay
15089 \family default
15090 s.
15091 \end_layout
15092
15093 \begin_layout Paragraph
15094 Using
15095 \family sans
15096 Overlay
15097 \family default
15098  with
15099 \family sans
15100 Slide
15101 \end_layout
15102
15103 \begin_layout Standard
15104 The idea behind an
15105 \family sans
15106 Overlay
15107 \family default
15108  is a slide that sits atop another slide.
15109  Perhaps you wish to discuss a figure on the main
15110 \family sans
15111 Slide
15112 \family default
15113  before displaying the text associated with it.
15114  One way to accomplish this is tape a flap of dark paper over the part of the
15115 \family sans
15116 Slide
15117 \family default
15118  you want to display later.
15119  This method fails,
15120  however,
15121  if you wish to overlap one graph with another,
15122  for example.
15123  You would then have to fumble while speaking to align the two separate,
15124  overlapping
15125 \family sans
15126 Slide
15127 \family default
15128 s to align the two graphs.
15129  The use of an
15130 \family sans
15131 Overlay
15132 \family default
15133  environment in both cases makes life much easier.
15134 \end_layout
15135
15136 \begin_layout Standard
15137 Each
15138 \family sans
15139 Overlay
15140 \family default
15141  receives the page number of its
15142 \begin_inset Quotes eld
15143 \end_inset
15144
15145 parent
15146 \begin_inset Quotes erd
15147 \end_inset
15148
15149
15150 \family sans
15151 Slide
15152 \family default
15153 ,
15154  appended by
15155 \begin_inset Quotes eld
15156 \end_inset
15157
15158
15159 \family typewriter
15160 -a
15161 \family default
15162
15163 \begin_inset Quotes erd
15164 \end_inset
15165
15166 .
15167 \begin_inset Foot
15168 status collapsed
15169
15170 \begin_layout Plain Layout
15171 Presumably,
15172  mutliple
15173 \family sans
15174 Overlay
15175 \family default
15176 s would have
15177 \begin_inset Quotes eld
15178 \end_inset
15179
15180
15181 \family typewriter
15182 -a
15183 \family default
15184
15185 \begin_inset Quotes erd
15186 \end_inset
15187
15188 ,
15189
15190 \begin_inset Quotes eld
15191 \end_inset
15192
15193
15194 \family typewriter
15195 -b
15196 \family default
15197
15198 \begin_inset Quotes erd
15199 \end_inset
15200
15201 ,
15202
15203 \begin_inset Quotes eld
15204 \end_inset
15205
15206
15207 \family typewriter
15208 -c
15209 \family default
15210
15211 \begin_inset Quotes erd
15212 \end_inset
15213
15214 ,
15215  etc.
15216 \begin_inset space ~
15217 \end_inset
15218
15219 appended to the page number of the parent
15220 \family sans
15221 Slide
15222 \family default
15223 .
15224
15225 \end_layout
15226
15227 \end_inset
15228
15229  Clearly,
15230  you want the contents of both the
15231 \family sans
15232 Slide
15233 \family default
15234  and the
15235 \family sans
15236 Overlay
15237 \family default
15238  to each fit on a single physical slide!
15239  You should probably consider an
15240 \family sans
15241 Overlay
15242 \family default
15243  as
15244 \begin_inset Quotes eld
15245 \end_inset
15246
15247 part of
15248 \begin_inset Quotes erd
15249 \end_inset
15250
15251  a
15252 \family sans
15253 Slide
15254 \family default
15255 .
15256  Indeed,
15257  the \SpecialChar LyX
15258
15259 \family sans
15260 slides
15261 \family default
15262  class provides a visual cue for this:
15263  the label at the start of an
15264 \family sans
15265 Overlay
15266 \family default
15267  is shorter than that at the start of a
15268 \family sans
15269 Slide
15270 \family default
15271 .
15272  Lastly,
15273  when you generate printable output,
15274  you'll find alignment markers in all four corners of both the
15275 \family sans
15276 Overlay
15277 \family default
15278  page and its parent
15279 \family sans
15280 Slide
15281 \family default
15282 .
15283  These will assist you in lining up the two physical slides.
15284 \end_layout
15285
15286 \begin_layout Standard
15287 The major problem in overlaying two slides is aligning the contents of the two transparencies.
15288  How much space should you leave for that graph on the second slide?
15289  Worse still,
15290  what if you want a graph and a sentence on second slide,
15291  but there is text on the main transparency that goes in between them?
15292  You could try and insert vertical space of the right size.
15293  The better way is to use
15294 \family sans
15295 InvisibleText
15296 \family default
15297  and
15298 \family sans
15299 VisibleText
15300 \family default
15301 .
15302 \end_layout
15303
15304 \begin_layout Standard
15305 As their names imply,
15306
15307 \family sans
15308 InvisibleText
15309 \family default
15310  and
15311 \family sans
15312 VisibleText
15313 \family default
15314  are two command-like paragraph environments that make all subsequent text invisible and visible,
15315  respectively.
15316  Note from section
15317 \begin_inset space ~
15318 \end_inset
15319
15320
15321 \begin_inset CommandInset ref
15322 LatexCommand ref
15323 reference "sec:slideQuirk"
15324 nolink "false"
15325
15326 \end_inset
15327
15328  that you don't place anything
15329 \emph on
15330 into
15331 \emph default
15332  these two environments,
15333  however.
15334  When you create an
15335 \family sans
15336 InvisibleText
15337 \family default
15338 ,
15339  it inserts a centered,
15340  sky-blue label into the page reading
15341 \begin_inset Quotes eld
15342 \end_inset
15343
15344 <Invisible Text Follows>
15345 \begin_inset Quotes erd
15346 \end_inset
15347
15348 .
15349  For paragraphs following this label,
15350  the parts of the
15351 \family sans
15352 Slide
15353 \family default
15354  [or
15355 \family sans
15356 Overlay
15357 \family default
15358 ;
15359  it doesn't matter which] where they would be contain instead blank space.
15360
15361 \end_layout
15362
15363 \begin_layout Standard
15364 For
15365 \family sans
15366 VisibleText
15367 \family default
15368 ,
15369  the corresponding centered label is
15370 \begin_inset Quotes eld
15371 \end_inset
15372
15373 <Visible Text Follows>
15374 \begin_inset Quotes erd
15375 \end_inset
15376
15377  in blazing green.
15378  Paragraphs following this label behave normally.
15379  Note that the beginning of a new
15380 \family sans
15381 Slide
15382 \family default
15383 ,
15384
15385 \family sans
15386 Overlay
15387 \family default
15388 ,
15389  or
15390 \family sans
15391 Note
15392 \family default
15393  automatically shuts off an
15394 \family sans
15395 InvisibleText
15396 \family default
15397 .
15398  It's therefore not necessary to use
15399 \family sans
15400 VisibleText
15401 \family default
15402  at the end of a
15403 \family sans
15404 Slide
15405 \family default
15406 .
15407 \end_layout
15408
15409 \begin_layout Standard
15410 By now,
15411  it should be obvious how to create overlay transparencies using the proper combination of
15412 \family sans
15413 InvisibleText
15414 \family default
15415  and
15416 \family sans
15417 VisibleText
15418 \family default
15419  on a
15420 \family sans
15421 Slide
15422 \family default
15423  and
15424 \family sans
15425 Overlay
15426 \family default
15427 :
15428 \end_layout
15429
15430 \begin_layout Enumerate
15431 Create a
15432 \family sans
15433 Slide
15434 \family default
15435 ,
15436  including everything that will appear on it,
15437  whether on the main slide or on the
15438 \family sans
15439 Overlay
15440 \family default
15441 .
15442 \end_layout
15443
15444 \begin_layout Enumerate
15445 Before each figure or paragraph that will appear only on the
15446 \family sans
15447 Overlay
15448 \family default
15449 ,
15450  insert an
15451 \family sans
15452 InvisibleText
15453 \family default
15454  environment.
15455  If necessary,
15456  insert a
15457 \family sans
15458 VisibleText
15459 \family default
15460  environment after the
15461 \family sans
15462 Overlay
15463 \family default
15464 -only text.
15465 \end_layout
15466
15467 \begin_layout Enumerate
15468 Start an
15469 \family sans
15470 Overlay
15471 \family default
15472  immediately following the
15473 \family sans
15474 Slide
15475 \family default
15476 .
15477 \end_layout
15478
15479 \begin_layout Enumerate
15480 Copy the contents of this
15481 \family sans
15482 Slide
15483 \family default
15484  into the
15485 \family sans
15486 Overlay
15487 \family default
15488 .
15489 \end_layout
15490
15491 \begin_layout Enumerate
15492 Within the
15493 \family sans
15494 Overlay
15495 \family default
15496 ,
15497  change all of the
15498 \family sans
15499 InvisibleText
15500 \family default
15501  lines to
15502 \family sans
15503 VisibleText
15504 \family default
15505  and vice-versa.
15506 \end_layout
15507
15508 \begin_layout Standard
15509 That's it.
15510  You've just made an
15511 \family sans
15512 Overlay
15513 \family default
15514 .
15515 \end_layout
15516
15517 \begin_layout Standard
15518 There's one problem with the way I've designed the \SpecialChar LyX
15519
15520 \family sans
15521 slides
15522 \family default
15523  class:
15524  you can't make text in the middle of a paragraph invisible,
15525  nor make text in the middle of an invisible paragraph visible again.
15526  To accomplish this feat,
15527  you'll need to use some inlined \SpecialChar LaTeX
15528  codes.
15529 \begin_inset Foot
15530 status collapsed
15531
15532 \begin_layout Plain Layout
15533 The commands of interest are:
15534
15535 \end_layout
15536
15537 \begin_layout Itemize
15538
15539 \family typewriter
15540 {
15541 \backslash
15542 invisible \SpecialChar ldots
15543  }
15544 \end_layout
15545
15546 \begin_layout Itemize
15547
15548 \family typewriter
15549 {
15550 \backslash
15551 visible \SpecialChar ldots
15552  }
15553 \end_layout
15554
15555 \begin_layout Plain Layout
15556 \SpecialChar ldots
15557 and need to be marked as \SpecialChar TeX
15558 .
15559  The text whose
15560 \begin_inset Quotes eld
15561 \end_inset
15562
15563 visibility
15564 \begin_inset Quotes erd
15565 \end_inset
15566
15567  you wish to change goes in between the brackets [and after the
15568 \family typewriter
15569
15570 \backslash
15571 invisible
15572 \family default
15573  or
15574 \family typewriter
15575
15576 \backslash
15577 visible
15578 \family default
15579  command].
15580  If you don't know how to mark text as \SpecialChar TeX
15581 ,
15582  see the appropriate section of the
15583 \emph on
15584 User's Guide
15585 \emph default
15586 .
15587 \end_layout
15588
15589 \end_inset
15590
15591
15592 \end_layout
15593
15594 \begin_layout Paragraph
15595 Using
15596 \family sans
15597 Note
15598 \family default
15599  with
15600 \family sans
15601 Slide
15602 \family default
15603
15604 \begin_inset CommandInset label
15605 LatexCommand label
15606 name "sec:slideNote"
15607
15608 \end_inset
15609
15610
15611 \end_layout
15612
15613 \begin_layout Standard
15614 Like an
15615 \family sans
15616 Overlay
15617 \family default
15618 ,
15619  a
15620 \family sans
15621 Note
15622 \family default
15623  is associated with a
15624 \begin_inset Quotes eld
15625 \end_inset
15626
15627 parent
15628 \begin_inset Quotes erd
15629 \end_inset
15630
15631
15632 \family sans
15633 Slide
15634 \family default
15635 .
15636  Here,
15637  too,
15638  the \SpecialChar LyX
15639
15640 \family sans
15641 slides
15642 \family default
15643  class provides visual cues.
15644  The label for a
15645 \family sans
15646 Note
15647 \family default
15648  is shorter than that of a
15649 \family sans
15650 Slide
15651 \family default
15652  [yet longer than that of an
15653 \family sans
15654 Overlay
15655 \family default
15656 ] and,
15657  like the label of an
15658 \family sans
15659 Overlay
15660 \family default
15661  is shockingly magenta.
15662  Additionally,
15663  the printed
15664 \family sans
15665 Note
15666 \family default
15667  has the page number of its
15668 \begin_inset Quotes eld
15669 \end_inset
15670
15671 parent
15672 \begin_inset Quotes erd
15673 \end_inset
15674
15675
15676 \family sans
15677 Slide
15678 \family default
15679 ,
15680  appended by
15681 \begin_inset Quotes eld
15682 \end_inset
15683
15684
15685 \family typewriter
15686 -
15687 \family default
15688 1
15689 \begin_inset Quotes erd
15690 \end_inset
15691
15692 ,
15693
15694 \begin_inset Quotes eld
15695 \end_inset
15696
15697
15698 \family typewriter
15699 -
15700 \family default
15701 2
15702 \begin_inset Quotes erd
15703 \end_inset
15704
15705 ,
15706
15707 \begin_inset Quotes eld
15708 \end_inset
15709
15710
15711 \family typewriter
15712 -
15713 \family default
15714 3
15715 \begin_inset Quotes erd
15716 \end_inset
15717
15718 ,
15719  etc.
15720  You can have multiple
15721 \family sans
15722 Note
15723 \family default
15724 s associated with a single
15725 \family sans
15726 Slide
15727 \family default
15728 ,
15729  and,
15730  as with
15731 \family sans
15732 Slide
15733 \family default
15734  and
15735 \family sans
15736 Overlay
15737 \family default
15738 ,
15739  you'll probably want to break up long
15740 \family sans
15741 Note
15742 \family default
15743 s so that they fit on a single sheet of paper.
15744 \end_layout
15745
15746 \begin_layout Standard
15747 The purpose of a
15748 \family sans
15749 Note
15750 \family default
15751  is obvious:
15752  it contains anything additional you might want to say about a
15753 \family sans
15754 Slide
15755 \family default
15756 .
15757  It could also be used as a sheet of reminders for a particular
15758 \family sans
15759 Slide
15760 \family default
15761 .
15762  In the case of the latter,
15763  you might want to make use of time markers.
15764  Currently,
15765  the \SpecialChar LyX
15766
15767 \family sans
15768 slides
15769 \family default
15770  class has no
15771 \begin_inset Quotes eld
15772 \end_inset
15773
15774 native
15775 \begin_inset Quotes erd
15776 \end_inset
15777
15778  support for time markers,
15779  a
15780 \noun on
15781 Sli\SpecialChar TeX
15782
15783 \noun default
15784  feature.
15785  So,
15786  you'll have to resort to using the \SpecialChar LaTeX
15787  codes.
15788 \end_layout
15789
15790 \begin_layout Standard
15791 To use time markers,
15792  you'll need to specify the extra class option
15793 \begin_inset Quotes eld
15794 \end_inset
15795
15796
15797 \family typewriter
15798 clock
15799 \family default
15800
15801 \begin_inset Quotes erd
15802 \end_inset
15803
15804  [see section
15805 \begin_inset space ~
15806 \end_inset
15807
15808
15809 \begin_inset CommandInset ref
15810 LatexCommand ref
15811 reference "sec:slidesetup"
15812 nolink "false"
15813
15814 \end_inset
15815
15816 ].
15817  This option turns on timing marks,
15818  which will appear in the lower-left-hand corner of every
15819 \family sans
15820 Note
15821 \family default
15822  you generate.
15823  To set what appears in the time marker,
15824  you use the \SpecialChar LaTeX
15825  commands
15826 \begin_inset Quotes eld
15827 \end_inset
15828
15829
15830 \family typewriter
15831
15832 \backslash
15833 settime{}
15834 \family default
15835
15836 \begin_inset Quotes erd
15837 \end_inset
15838
15839  and
15840 \begin_inset Quotes eld
15841 \end_inset
15842
15843
15844 \family typewriter
15845
15846 \backslash
15847 addtime{}
15848 \family default
15849
15850 \begin_inset Quotes erd
15851 \end_inset
15852
15853 .
15854  The arguments of both commands are time measured in seconds.
15855
15856 \begin_inset Quotes eld
15857 \end_inset
15858
15859
15860 \family typewriter
15861
15862 \backslash
15863 settime{}
15864 \family default
15865
15866 \begin_inset Quotes erd
15867 \end_inset
15868
15869  sets the time marker to a given time.
15870
15871 \begin_inset Quotes eld
15872 \end_inset
15873
15874
15875 \family typewriter
15876
15877 \backslash
15878 addtime{}
15879 \family default
15880
15881 \begin_inset Quotes erd
15882 \end_inset
15883
15884  increments the time marker by the specified amount.
15885  Using time markers and
15886 \family sans
15887 Note
15888 \family default
15889 s in this fashion,
15890  you can remind yourself how much time to spend on a particular
15891 \family sans
15892 Slide
15893 \family default
15894 .
15895 \end_layout
15896
15897 \begin_layout Standard
15898 There's one last feature to describe.
15899  Clearly,
15900  you'd like to print out all of your
15901 \family sans
15902 Slide
15903 \family default
15904 s and
15905 \family sans
15906 Overlay
15907 \family default
15908 s on transparencies while printing all of your
15909 \family sans
15910 Note
15911 \family default
15912 s on plain paper.
15913  However,
15914  a
15915 \family sans
15916 Note
15917 \family default
15918
15919 \emph on
15920 must
15921 \emph default
15922  follow the
15923 \family sans
15924 Slide
15925 \family default
15926  with which it is associated.
15927  What's a person to do?
15928 \end_layout
15929
15930 \begin_layout Standard
15931 Luckily,
15932  there are two \SpecialChar LaTeX
15933  commands that allow you to select what to print out.
15934  Both must be placed into the preamble of your document.
15935  The command
15936 \begin_inset Quotes eld
15937 \end_inset
15938
15939
15940 \family typewriter
15941
15942 \backslash
15943 onlyslides{
15944 \backslash
15945 slides}
15946 \family default
15947
15948 \begin_inset Quotes erd
15949 \end_inset
15950
15951  will cause the output to contain only the
15952 \family sans
15953 Slide
15954 \family default
15955 s and
15956 \family sans
15957 Overlay
15958 \family default
15959 s.
15960  Correspondingly,
15961  the command
15962 \begin_inset Quotes eld
15963 \end_inset
15964
15965
15966 \family typewriter
15967
15968 \backslash
15969 onlynotes{
15970 \backslash
15971 notes}
15972 \family default
15973
15974 \begin_inset Quotes erd
15975 \end_inset
15976
15977  prevents the output of anything but
15978 \family sans
15979 Note
15980 \family default
15981 s.
15982  I'd advise placing both commands in the preamble and initially comment both out.
15983  You can then preview your entire presentation as you write.
15984  When you're done writing,
15985  you can then uncomment one of the two to select what you want to print.
15986  I like to uncomment
15987 \begin_inset Quotes eld
15988 \end_inset
15989
15990
15991 \family typewriter
15992
15993 \backslash
15994 onlyslides{
15995 \backslash
15996 slides}
15997 \family default
15998
15999 \begin_inset Quotes erd
16000 \end_inset
16001
16002  ,
16003  print to a file with
16004 \begin_inset Quotes eld
16005 \end_inset
16006
16007
16008 \family typewriter
16009 -slides
16010 \family default
16011
16012 \begin_inset Quotes erd
16013 \end_inset
16014
16015  in its name,
16016  comment it back out,
16017  then uncomment
16018 \begin_inset Quotes eld
16019 \end_inset
16020
16021
16022 \family typewriter
16023
16024 \backslash
16025 onlynotes{
16026 \backslash
16027 notes}
16028 \family default
16029
16030 \begin_inset Quotes erd
16031 \end_inset
16032
16033  and print to a
16034 \begin_inset Quotes eld
16035 \end_inset
16036
16037
16038 \family typewriter
16039 *-notes.ps
16040 \family default
16041
16042 \begin_inset Quotes erd
16043 \end_inset
16044
16045  file.
16046  I can then send either file to a printer,
16047  loading transparencies or plain paper as appropriate.
16048 \end_layout
16049
16050 \begin_layout Standard
16051 You can also provide other arguments to the
16052 \begin_inset Quotes eld
16053 \end_inset
16054
16055
16056 \family typewriter
16057
16058 \backslash
16059 onlyslides{}
16060 \family default
16061
16062 \begin_inset Quotes erd
16063 \end_inset
16064
16065  and
16066 \begin_inset Quotes eld
16067 \end_inset
16068
16069
16070 \family typewriter
16071
16072 \backslash
16073 onlynotes{}
16074 \family default
16075
16076 \begin_inset Quotes erd
16077 \end_inset
16078
16079  commands.
16080  See a good \SpecialChar LaTeX
16081  book for details.
16082 \end_layout
16083
16084 \begin_layout Subsubsection
16085 The
16086 \family sans
16087 slides
16088 \family default
16089  Class Template File
16090 \end_layout
16091
16092 \begin_layout Standard
16093 I have also provided a template file
16094 \change_deleted 564990737 1671617750
16095 ,
16096
16097 \begin_inset Quotes eld
16098 \end_inset
16099
16100
16101 \family typewriter
16102 slides.lyx
16103 \family default
16104
16105 \begin_inset Quotes erd
16106 \end_inset
16107
16108 ,
16109
16110 \change_unchanged
16111  with the
16112 \family sans
16113 slides
16114 \family default
16115  class.
16116  To use it,
16117  begin your new presentation with
16118 \family sans
16119 File\SpecialChar menuseparator
16120 New
16121 \begin_inset space ~
16122 \end_inset
16123
16124 from
16125 \begin_inset space ~
16126 \end_inset
16127
16128 Template
16129 \change_inserted 564990737 1671616988
16130 \SpecialChar menuseparator
16131 Presentations\SpecialChar menuseparator
16132 Slides
16133 \change_unchanged
16134
16135 \family default
16136 .
16137  Your new \SpecialChar LyX
16138  presentation file will contain an example
16139 \family sans
16140 Slide
16141 \family default
16142  –
16143 \family sans
16144 Overlay
16145 \family default
16146  –
16147 \family sans
16148 Note
16149 \family default
16150  triplet.
16151  The
16152 \family sans
16153 Slide
16154 \family default
16155  and
16156 \family sans
16157 Overlay
16158 \family default
16159  additionally contain an example of the use of
16160 \family sans
16161 InvisibleText
16162 \family default
16163  and
16164 \family sans
16165 VisibleText
16166 \family default
16167 .
16168  Lastly,
16169  the preamble will contain:
16170 \end_layout
16171
16172 \begin_layout LyX-Code
16173 % Uncomment to print out only slides and overlays
16174 \end_layout
16175
16176 \begin_layout LyX-Code
16177 %
16178 \end_layout
16179
16180 \begin_layout LyX-Code
16181 %
16182 \backslash
16183 onlyslides{
16184 \backslash
16185 slides}
16186 \begin_inset Newline newline
16187 \end_inset
16188
16189
16190 \end_layout
16191
16192 \begin_layout LyX-Code
16193 % Uncomment to print out only notes
16194 \end_layout
16195
16196 \begin_layout LyX-Code
16197 %
16198 \end_layout
16199
16200 \begin_layout LyX-Code
16201 %
16202 \backslash
16203 onlynotes{
16204 \backslash
16205 notes}
16206 \end_layout
16207
16208 \begin_layout Standard
16209 One final thing:
16210  I created this class to support the \SpecialChar LaTeX2e
16211
16212 \begin_inset Quotes eld
16213 \end_inset
16214
16215
16216 \noun on
16217 Sli\SpecialChar TeX
16218
16219 \noun default
16220  emulation
16221 \begin_inset Quotes erd
16222 \end_inset
16223
16224  class,
16225  one of the built-in \SpecialChar LaTeX2e
16226  classes.
16227  Neither I nor the rest of the \SpecialChar LyX
16228  Team endorse or oppose the use of this built-in slide class.
16229  It's here if you want it or need it.
16230  There exist other \SpecialChar LaTeX2e
16231  classes for creating presentations,
16232  such
16233 \change_deleted -712698321 1673258708
16234 as the
16235 \change_unchanged
16236
16237 \family sans
16238 Foils
16239 \family default
16240
16241 \change_deleted -712698321 1673258709
16242 class
16243 \change_inserted -712698321 1673258699
16244 (
16245 \change_deleted -712698321 1673258700
16246 [
16247 \change_unchanged
16248 see section
16249 \begin_inset space ~
16250 \end_inset
16251
16252
16253 \begin_inset CommandInset ref
16254 LatexCommand ref
16255 reference "sec:foiltex"
16256 nolink "false"
16257
16258 \end_inset
16259
16260
16261 \change_deleted -712698321 1673258703
16262 ]
16263 \change_inserted -712698321 1673258705
16264 )
16265 \change_unchanged
16266  or
16267 \change_deleted -712698321 1673258714
16268 the
16269 \begin_inset Quotes eld
16270 \end_inset
16271
16272
16273 \family typewriter
16274 seminar
16275 \family default
16276
16277 \begin_inset Quotes erd
16278 \end_inset
16279
16280  package [present on some \SpecialChar TeX
16281  distributions].
16282  The latter is not yet supported under \SpecialChar LyX
16283 .
16284 \begin_inset Foot
16285 status collapsed
16286
16287 \begin_layout Plain Layout
16288 Perhaps you can take on the task\SpecialChar ldots
16289
16290 \end_layout
16291
16292 \end_inset
16293
16294
16295 \change_inserted -712698321 1673258738
16296
16297 \family sans
16298 Seminar
16299 \family default
16300  (see section
16301 \begin_inset space ~
16302 \end_inset
16303
16304
16305 \begin_inset CommandInset ref
16306 LatexCommand ref
16307 reference "subsec:Seminar"
16308 plural "false"
16309 caps "false"
16310 noprefix "false"
16311 nolink "false"
16312
16313 \end_inset
16314
16315 ).
16316
16317 \change_unchanged
16318
16319 \change_deleted -712698321 1673258749
16320 I know nothing about these other classes.
16321
16322 \change_unchanged
16323 Try them out to see what sort of alternative they provide.
16324 \end_layout
16325
16326 \begin_layout Section
16327
16328 \change_inserted 564990737 1670439661
16329 Reports
16330 \end_layout
16331
16332 \begin_layout Subsection
16333
16334 \change_inserted 564990737 1670439661
16335 report
16336 \end_layout
16337
16338 \begin_layout Standard
16339
16340 \change_inserted -712698321 1673689969
16341 Report classes are sort of a hybrid between book and article classes:
16342  like book classes,
16343  they
16344 \change_deleted -712698321 1673689899
16345 The document class
16346 \family sans
16347 report
16348 \family default
16349  provides the
16350 \family sans
16351 report.cls
16352 \family default
16353  document class for preparing reports.
16354  Like the
16355 \family sans
16356 book
16357 \family default
16358  document class,
16359  this
16360 \change_inserted 564990737 1670439661
16361  provide
16362 \change_deleted -712698321 1673689904
16363 s
16364 \change_inserted 564990737 1670439661
16365  parts,
16366  chapters and sections but does not provide
16367 \change_deleted -712698321 1673690062
16368 the paragraph styles needed for a book
16369 \change_inserted -712698321 1673690073
16370 frontmatter,
16371  mainmatter,
16372  and backmatter
16373 \change_inserted 564990737 1670439661
16374 ;
16375  like
16376 \change_deleted -712698321 1673690088
16377 the
16378 \family sans
16379 article
16380 \family default
16381  document
16382 \change_inserted -712698321 1673690083
16383 article
16384 \change_inserted 564990737 1670439661
16385  class
16386 \change_inserted -712698321 1673690085
16387 es
16388 \change_inserted 564990737 1670439661
16389 ,
16390
16391 \change_deleted -712698321 1673690094
16392 it
16393 \change_inserted -712698321 1673690094
16394 they
16395 \change_inserted 564990737 1670439661
16396  provide
16397 \change_deleted -712698321 1673690097
16398 s
16399 \change_inserted 564990737 1670439661
16400
16401 \change_deleted -712698321 1673690101
16402 the
16403 \change_inserted 564990737 1670439661
16404 abstract paragraph style
16405 \change_inserted -712698321 1673690514
16406 s and are one-sided by default.
16407
16408 \change_deleted -712698321 1673690134
16409 .
16410  In two-sided mode,
16411  it does
16412 \change_inserted -712698321 1673690520
16413 Also,
16414  they do
16415 \change_inserted 564990737 1670439661
16416  not start a new chapter on the right hand page
16417 \change_inserted -712698321 1673690150
16418  (even in two-side mode)
16419 \change_inserted 564990737 1670439661
16420 .
16421 \end_layout
16422
16423 \begin_layout Standard
16424
16425 \change_deleted -712698321 1673690173
16426 The remaining
16427 \change_inserted -712698321 1673690287
16428 All externally maintained
16429 \change_inserted 564990737 1672743528
16430
16431 \family sans
16432 report
16433 \family default
16434  document classes
16435 \change_inserted -712698321 1673690678
16436 that are officially supported by \SpecialChar LyX
16437
16438 \change_inserted 564990737 1672743528
16439 are described in the Collections (section
16440 \begin_inset space ~
16441 \end_inset
16442
16443
16444 \begin_inset CommandInset ref
16445 LatexCommand ref
16446 reference "sec:Collections"
16447 nolink "false"
16448
16449 \end_inset
16450
16451 )
16452 \change_inserted -712698321 1673690301
16453 :
16454 \change_deleted -712698321 1673690300
16455 .
16456 \change_inserted 564990737 1672743528
16457
16458 \end_layout
16459
16460 \begin_layout Itemize
16461
16462 \change_inserted 564990737 1672743530
16463 For
16464 \change_deleted -712698321 1673690794
16465
16466 \family sans
16467 report
16468 \begin_inset space \thinspace{}
16469 \end_inset
16470
16471 (Japanese in vertical writing)
16472 \change_inserted -712698321 1673690794
16473 Japanese Report (Vertical Writing)
16474 \change_inserted 564990737 1672743530
16475
16476 \family default
16477  and
16478 \change_deleted -712698321 1673690762
16479
16480 \family sans
16481 report
16482 \begin_inset space \thinspace{}
16483 \end_inset
16484
16485 (Japanese)
16486 \change_inserted -712698321 1673690762
16487 Japanese Report (Standard Class)
16488 \change_inserted 564990737 1672743530
16489
16490 \family default
16491 ,
16492  see section
16493 \begin_inset space ~
16494 \end_inset
16495
16496
16497 \begin_inset CommandInset ref
16498 LatexCommand ref
16499 reference "subsec:Japanese"
16500 nolink "false"
16501
16502 \end_inset
16503
16504 .
16505 \end_layout
16506
16507 \begin_layout Itemize
16508
16509 \change_inserted 564990737 1672743530
16510 For
16511 \change_deleted -712698321 1673690718
16512
16513 \family sans
16514 report
16515 \begin_inset space \thinspace{}
16516 \end_inset
16517
16518 (KOMA-Script)
16519 \change_inserted -712698321 1673690718
16520 KOMA-Script Report
16521 \change_inserted 564990737 1672743530
16522
16523 \family default
16524 ,
16525  see section
16526 \begin_inset space ~
16527 \end_inset
16528
16529
16530 \begin_inset CommandInset ref
16531 LatexCommand ref
16532 reference "subsec:KOMA-Script"
16533 nolink "false"
16534
16535 \end_inset
16536
16537 .
16538 \end_layout
16539
16540 \begin_layout Itemize
16541
16542 \change_inserted 564990737 1672743530
16543 For
16544 \change_deleted -712698321 1673690815
16545
16546 \family sans
16547 report
16548 \begin_inset space \thinspace{}
16549 \end_inset
16550
16551 (with extra font sizes)
16552 \change_inserted -712698321 1673690815
16553 Report (Standard Class with Extra Font Sizes)
16554 \change_inserted 564990737 1672743530
16555
16556 \family default
16557 ,
16558  see section
16559 \begin_inset space ~
16560 \end_inset
16561
16562
16563 \begin_inset CommandInset ref
16564 LatexCommand ref
16565 reference "subsec:Extra-font-sizes"
16566 nolink "false"
16567
16568 \end_inset
16569
16570 .
16571 \end_layout
16572
16573 \begin_layout Itemize
16574
16575 \change_inserted 564990737 1672743569
16576 For
16577 \change_deleted -712698321 1673690833
16578
16579 \family sans
16580 report
16581 \begin_inset space \thinspace{}
16582 \end_inset
16583
16584 (Polish version by M.
16585 \begin_inset space \thinspace{}
16586 \end_inset
16587
16588 W.)
16589 \change_inserted -712698321 1673690833
16590 Polish Report (MW Bundle)
16591 \change_inserted 564990737 1672743569
16592
16593 \family default
16594 ,
16595  see section
16596 \begin_inset space ~
16597 \end_inset
16598
16599
16600 \begin_inset CommandInset ref
16601 LatexCommand ref
16602 reference "subsec:Polish-M.W.collection"
16603 plural "false"
16604 caps "false"
16605 noprefix "false"
16606 nolink "false"
16607
16608 \end_inset
16609
16610 .
16611 \end_layout
16612
16613 \begin_layout Section
16614
16615 \change_inserted 564990737 1670439674
16616 Scripts
16617 \change_deleted -712698321 1673691106
16618  (drama)
16619 \change_inserted -712698321 1673691108
16620
16621 \end_layout
16622
16623 \begin_layout Standard
16624
16625 \change_inserted -712698321 1673691276
16626 In the
16627 \family sans
16628 Scripts
16629 \family default
16630  category,
16631  we assemble document classes that help to write drama or movie scripts.
16632  The category is also open for other scripts,
16633  such as lecture scripts,
16634  for which no classes are officially supported yet by \SpecialChar LyX
16635  though.
16636 \change_inserted 564990737 1670439674
16637
16638 \end_layout
16639
16640 \begin_layout Subsection
16641 Broadway
16642 \end_layout
16643
16644 \begin_layout Standard
16645 by
16646 \shape smallcaps
16647 Garst Reese
16648 \end_layout
16649
16650 \begin_layout Subsubsection
16651 Introduction
16652 \end_layout
16653
16654 \begin_layout Standard
16655
16656 \family sans
16657 Broadway
16658 \family default
16659  is for writing plays.
16660  The format is more decorative than
16661 \family sans
16662 Hollywood
16663 \change_inserted -712698321 1673691568
16664
16665 \family default
16666  (see sec.
16667 \begin_inset space ~
16668 \end_inset
16669
16670
16671 \begin_inset CommandInset ref
16672 LatexCommand ref
16673 reference "subsec:Hollywood"
16674
16675 \end_inset
16676
16677 )
16678 \change_unchanged
16679 ,
16680  and much less standardized.
16681  This format should be suitable for workshops.
16682 \end_layout
16683
16684 \begin_layout Subsubsection
16685 Special problems
16686 \end_layout
16687
16688 \begin_layout Standard
16689 The same as in
16690 \family sans
16691 Hollywood
16692 \change_inserted -712698321 1673691609
16693
16694 \family default
16695  (see section
16696 \begin_inset space ~
16697 \end_inset
16698
16699
16700 \begin_inset CommandInset ref
16701 LatexCommand ref
16702 reference "subsec:Special-problems-Hollywood"
16703
16704 \end_inset
16705
16706 )
16707 \change_unchanged
16708 .
16709 \end_layout
16710
16711 \begin_layout Subsubsection
16712 Special features
16713 \end_layout
16714
16715 \begin_layout Standard
16716 Insert the
16717 \family sans
16718 Speaker
16719 \family default
16720  names as labels then cross-reference the label to insert the name.
16721  The cross-reference dialog will show the current cast of characters.
16722 \end_layout
16723
16724 \begin_layout Subsubsection
16725 Paper size and Margins
16726 \end_layout
16727
16728 \begin_layout Standard
16729 USLetter,
16730  left 1.6in,
16731  right 0.75in,
16732  top 0.5in,
16733  bottom 0.75in
16734 \end_layout
16735
16736 \begin_layout Subsubsection
16737 Environments
16738 \end_layout
16739
16740 \begin_layout Standard
16741 The following environments are available.
16742  You can use
16743 \family typewriter
16744 broadway.bind
16745 \family default
16746  to get the bind keys shown at the right.
16747 \end_layout
16748
16749 \begin_layout Itemize
16750
16751 \family sans
16752 Standard
16753 \begin_inset Newline newline
16754 \end_inset
16755
16756
16757 \family default
16758 You should not have to use this,
16759  but it is here for anything that does not fit otherwise.
16760 \end_layout
16761
16762 \begin_layout Itemize
16763
16764 \family sans
16765 Narrative
16766 \begin_inset space \hfill{}
16767 \end_inset
16768
16769 M-z n
16770 \begin_inset Newline newline
16771 \end_inset
16772
16773
16774 \family default
16775 Used to describe stage setting and the action.
16776  First use of speaker names in all CAPs.
16777 \end_layout
16778
16779 \begin_layout Itemize
16780
16781 \family sans
16782 ACT
16783 \begin_inset space \hfill{}
16784 \end_inset
16785
16786 M-z a
16787 \begin_inset Newline newline
16788 \end_inset
16789
16790
16791 \family default
16792 Automatically numbered.
16793  On screen it will be arabic,
16794  but will print as Roman.
16795 \end_layout
16796
16797 \begin_layout Itemize
16798
16799 \family sans
16800 ACT*
16801 \begin_inset space \hfill{}
16802 \end_inset
16803
16804 M-z S at
16805 \begin_inset Newline newline
16806 \end_inset
16807
16808
16809 \family default
16810 Subtitle for
16811 \family sans
16812 ACT.
16813
16814 \family default
16815  It is just centered text.
16816 \end_layout
16817
16818 \begin_layout Itemize
16819
16820 \family sans
16821 SCENE
16822 \begin_inset space \hfill{}
16823 \end_inset
16824
16825 M-z S-S
16826 \begin_inset Newline newline
16827 \end_inset
16828
16829
16830 \family default
16831 Not automatically numbered.
16832  You supply the number.
16833  This is because I couldn't figure out how.
16834 \end_layout
16835
16836 \begin_layout Itemize
16837
16838 \family sans
16839 AT_RISE:
16840 \begin_inset space \hfill{}
16841 \end_inset
16842
16843 M-z S-R
16844 \begin_inset Newline newline
16845 \end_inset
16846
16847
16848 \family default
16849 A special case of Narrative to describe the setting and action as the curtain rises.
16850 \end_layout
16851
16852 \begin_layout Itemize
16853
16854 \family sans
16855 Speaker
16856 \begin_inset space \hfill{}
16857 \end_inset
16858
16859 M-z s
16860 \begin_inset Newline newline
16861 \end_inset
16862
16863
16864 \family default
16865 The speaker's (actor's) title,
16866  centered in all CAPS.
16867 \end_layout
16868
16869 \begin_layout Itemize
16870
16871 \family sans
16872 Parenthetical
16873 \begin_inset space \hfill{}
16874 \end_inset
16875
16876 M-z p
16877 \begin_inset Newline newline
16878 \end_inset
16879
16880
16881 \family default
16882 Instructions to the speaker.
16883  The parentheses are automatically inserted.
16884  The ( will appear on screen,
16885  but both will be in the printed play.
16886  This environment is only used within
16887 \family sans
16888 Dialogue
16889 \family default
16890 .
16891 \end_layout
16892
16893 \begin_layout Itemize
16894
16895 \family sans
16896 Dialogue
16897 \begin_inset space \hfill{}
16898 \end_inset
16899
16900 M-z d
16901 \begin_inset Newline newline
16902 \end_inset
16903
16904
16905 \family default
16906 What the Speaker says.
16907 \end_layout
16908
16909 \begin_layout Itemize
16910
16911 \family sans
16912 CURTAIN
16913 \begin_inset space \hfill{}
16914 \end_inset
16915
16916 M-z S-C
16917 \begin_inset Newline newline
16918 \end_inset
16919
16920
16921 \family default
16922 The curtain comes down.
16923 \end_layout
16924
16925 \begin_layout Itemize
16926
16927 \family sans
16928 Title
16929 \begin_inset space \hfill{}
16930 \end_inset
16931
16932 M-z S-T
16933 \end_layout
16934
16935 \begin_layout Itemize
16936
16937 \family sans
16938 Author
16939 \begin_inset space \hfill{}
16940 \end_inset
16941
16942 M-z S-A
16943 \end_layout
16944
16945 \begin_layout Itemize
16946
16947 \family sans
16948 Right_Address
16949 \begin_inset space \hfill{}
16950 \end_inset
16951
16952 M-z r
16953 \end_layout
16954
16955 \begin_layout Standard
16956 Hello there.
16957 \end_layout
16958
16959 \begin_layout Subsection
16960
16961 \change_inserted -712698321 1673691551
16962 \begin_inset CommandInset label
16963 LatexCommand label
16964 name "subsec:Hollywood"
16965
16966 \end_inset
16967
16968
16969 \change_unchanged
16970 Hollywood (Hollywood spec scripts)
16971 \end_layout
16972
16973 \begin_layout Standard
16974 by
16975 \shape smallcaps
16976 Garst Reese
16977 \end_layout
16978
16979 \begin_layout Subsubsection
16980 Introduction
16981 \end_layout
16982
16983 \begin_layout Standard
16984 Getting the format of a Hollywood script right is a
16985 \begin_inset Quotes eld
16986 \end_inset
16987
16988 rite of passage.
16989 \begin_inset Quotes erd
16990 \end_inset
16991
16992  It is designed to make the readers focus on content and to be easy and familiar for the actors to read.
16993  Each page of a script should be one minute of film.
16994  Nothing goes in a script that you cannot see or hear on screen.
16995  The courier 12 pt font should be used throughout.
16996  No italics.
16997 \end_layout
16998
16999 \begin_layout Subsubsection
17000
17001 \change_inserted -712698321 1673691597
17002 \begin_inset CommandInset label
17003 LatexCommand label
17004 name "subsec:Special-problems-Hollywood"
17005
17006 \end_inset
17007
17008
17009 \change_unchanged
17010 Special problems
17011 \end_layout
17012
17013 \begin_layout Standard
17014 Speakers' lines should
17015 \change_deleted -712698321 1673691805
17016
17017 \emph on
17018 NEVER
17019 \change_inserted -712698321 1673691805
17020 never
17021 \change_unchanged
17022
17023 \emph default
17024  break in mid-sentence.
17025  If a speaker's lines continue over a page break,
17026  repeat the
17027 \family sans
17028 Speaker
17029 \family default
17030  title followed by (Cont'd).
17031 \end_layout
17032
17033 \begin_layout Subsubsection
17034 Special features
17035 \end_layout
17036
17037 \begin_layout Standard
17038 Insert the
17039 \family sans
17040 Speaker
17041 \family default
17042  names as labels then cross-reference the label to insert the name.
17043  The cross-reference dialog will show the current cast of characters.
17044  You can use this to insert the speaker name in narratives also.
17045 \end_layout
17046
17047 \begin_layout Subsubsection
17048 Paper size and Margins
17049 \end_layout
17050
17051 \begin_layout Standard
17052 USLetter,
17053  left 1.6in,
17054  right 0.75in,
17055  top 0.5in,
17056  bottom 0.75in
17057 \end_layout
17058
17059 \begin_layout Subsubsection
17060 Environments
17061 \end_layout
17062
17063 \begin_layout Standard
17064 The following environments are available.
17065  You can use
17066 \family typewriter
17067 hollywood.bind
17068 \family default
17069  to get the bind keys shown at the right.
17070 \end_layout
17071
17072 \begin_layout Itemize
17073
17074 \family sans
17075 Standard
17076 \begin_inset Newline newline
17077 \end_inset
17078
17079
17080 \family default
17081 Used where nothing else works.
17082  Try to avoid it.
17083 \end_layout
17084
17085 \begin_layout Itemize
17086
17087 \family sans
17088 FADE_IN
17089 \family default
17090 :
17091 \begin_inset space \hfill{}
17092 \end_inset
17093
17094
17095 \family sans
17096 M-z S-I
17097 \family default
17098
17099 \begin_inset Newline newline
17100 \end_inset
17101
17102 Usually followed by something like
17103 \begin_inset Quotes eld
17104 \end_inset
17105
17106 on Sally waking up.
17107 \begin_inset Quotes erd
17108 \end_inset
17109
17110
17111 \end_layout
17112
17113 \begin_layout Itemize
17114
17115 \family sans
17116 INT:
17117 \begin_inset space \hfill{}
17118 \end_inset
17119
17120 M-z i
17121 \begin_inset Newline newline
17122 \end_inset
17123
17124
17125 \family default
17126 Introduces a new INTERIOR camera set-up.
17127  Always followed by DAY or NIGHT,
17128  or something similar to define the lighting required.
17129  Everthing on this line in CAPS.
17130 \end_layout
17131
17132 \begin_layout Itemize
17133
17134 \family sans
17135 EXT:
17136 \begin_inset space \hfill{}
17137 \end_inset
17138
17139 M-z e
17140 \begin_inset Newline newline
17141 \end_inset
17142
17143
17144 \family default
17145 Introduces a new EXTERIOR camera set-up.
17146  Everthing on this line in CAPS.
17147 \end_layout
17148
17149 \begin_layout Itemize
17150
17151 \family sans
17152 Speaker
17153 \begin_inset space \hfill{}
17154 \end_inset
17155
17156 M-z s
17157 \begin_inset Newline newline
17158 \end_inset
17159
17160
17161 \family default
17162 The character speaking.
17163 \end_layout
17164
17165 \begin_layout Itemize
17166
17167 \family sans
17168 Parenthetical
17169 \begin_inset space \hfill{}
17170 \end_inset
17171
17172 M-z p
17173 \begin_inset Newline newline
17174 \end_inset
17175
17176
17177 \family default
17178 Instructions to the speaker.
17179  The () are automatically inserted.
17180 \end_layout
17181
17182 \begin_layout Itemize
17183
17184 \family sans
17185 Dialogue
17186 \begin_inset space \hfill{}
17187 \end_inset
17188
17189 M-z d
17190 \begin_inset Newline newline
17191 \end_inset
17192
17193
17194 \family default
17195 What the
17196 \family sans
17197 Speaker
17198 \family default
17199  says.
17200 \end_layout
17201
17202 \begin_layout Itemize
17203
17204 \family sans
17205 Transition
17206 \begin_inset space \hfill{}
17207 \end_inset
17208
17209 M-z t
17210 \begin_inset Newline newline
17211 \end_inset
17212
17213
17214 \family default
17215 Camera movement instruction.
17216  e.
17217 \begin_inset space \thinspace{}
17218 \end_inset
17219
17220 g.
17221 \begin_inset space \space{}
17222 \end_inset
17223
17224 CUT TO:
17225 \end_layout
17226
17227 \begin_layout Itemize
17228
17229 \family sans
17230 FADE OUT:
17231 \begin_inset space \hfill{}
17232 \end_inset
17233
17234 M-z S-I
17235 \end_layout
17236
17237 \begin_layout Itemize
17238
17239 \family sans
17240 Author
17241 \begin_inset space \hfill{}
17242 \end_inset
17243
17244 M-z S-A
17245 \end_layout
17246
17247 \begin_layout Itemize
17248
17249 \family sans
17250 Title
17251 \begin_inset space \hfill{}
17252 \end_inset
17253
17254 M-z S-T
17255 \end_layout
17256
17257 \begin_layout Itemize
17258
17259 \family sans
17260 Right_Address
17261 \begin_inset space \hfill{}
17262 \end_inset
17263
17264 M-z r
17265 \end_layout
17266
17267 \begin_layout Subsubsection
17268 Script jargon
17269 \end_layout
17270
17271 \begin_layout Itemize
17272 (O.S) —
17273  off screen
17274 \end_layout
17275
17276 \begin_layout Itemize
17277 (V.0) —
17278  voice over
17279 \end_layout
17280
17281 \begin_layout Itemize
17282 b.
17283 \begin_inset space \thinspace{}
17284 \end_inset
17285
17286 g.
17287  —
17288  background
17289 \end_layout
17290
17291 \begin_layout Itemize
17292 C.U.
17293  —
17294  close-up
17295 \end_layout
17296
17297 \begin_layout Itemize
17298 PAN —
17299  camera movement
17300 \end_layout
17301
17302 \begin_layout Itemize
17303 INSERT —
17304  cut to close-up of
17305 \end_layout
17306
17307 \begin_layout Chapter
17308
17309 \change_inserted 564990737 1671185876
17310 Modules
17311 \end_layout
17312
17313 \begin_layout Section
17314
17315 \change_inserted 564990737 1671716212
17316 Academic Field Specifics
17317 \end_layout
17318
17319 \begin_layout Subsection
17320
17321 \change_inserted 564990737 1671716212
17322 Chemistry:
17323  Hazard and Precautionary Statements
17324 \end_layout
17325
17326 \begin_layout Standard
17327
17328 \change_inserted 564990737 1671716212
17329 This module provides two insets
17330 \change_inserted -712698321 1673779038
17331 and a paragraph style
17332 \change_inserted 564990737 1671716212
17333 to typeset numbers and phrases of chemical hazard and precautionary statements.
17334  For a description see
17335 \family sans
17336 File\SpecialChar menuseparator
17337 Open Example\SpecialChar menuseparator
17338 Modules\SpecialChar menuseparator
17339 Hazard and Precautionary Statements
17340 \family default
17341  and
17342 \family sans
17343 Help\SpecialChar menuseparator
17344 Specific Manuals\SpecialChar menuseparator
17345 Hazard and Precautionary Statements
17346 \family default
17347 .
17348 \end_layout
17349
17350 \begin_layout Subsection
17351
17352 \change_inserted 564990737 1671716212
17353
17354 \series bold
17355 Chemistry:
17356  Risk and Safety Statements
17357 \end_layout
17358
17359 \begin_layout Standard
17360
17361 \change_inserted 564990737 1671716212
17362 This module provides two insets,
17363
17364 \family sans
17365 R-S number
17366 \family default
17367  and
17368 \family sans
17369 R-S phrase
17370 \family default
17371 ,
17372  accessible via the menu
17373 \family sans
17374 \bar under
17375 I
17376 \bar default
17377 nsert\SpecialChar menuseparator
17378 Custom
17379 \begin_inset space ~
17380 \end_inset
17381
17382 Insets
17383 \family default
17384  and an environment to typeset numbers and phrases of chemical risk and safety statements.
17385 \end_layout
17386
17387 \begin_layout Subsection
17388
17389 \change_inserted 564990737 1671716212
17390 Linguistics
17391 \end_layout
17392
17393 \begin_layout Standard
17394
17395 \change_inserted 564990737 1671716212
17396 This module
17397 \change_deleted -712698321 1673779847
17398 uses the
17399 \family sans
17400 covington.sty
17401 \family default
17402  package to add
17403 \change_inserted -712698321 1673779869
17404 provides specific
17405 \change_inserted 564990737 1671716212
17406  environments useful for linguistics (numbered examples,
17407  glosses,
17408  semantic markup,
17409
17410 \change_inserted -712698321 1673779891
17411 OT
17412 \change_inserted 564990737 1671716212
17413 tableau floats).
17414  You can obtain information about this module in
17415 \family sans
17416 \bar under
17417 H
17418 \bar default
17419 elp\SpecialChar menuseparator
17420 S
17421 \bar under
17422 p
17423 \bar default
17424 ecific
17425 \begin_inset space ~
17426 \end_inset
17427
17428 Manuals\SpecialChar menuseparator
17429
17430 \bar under
17431 L
17432 \bar default
17433 inguistics
17434 \family default
17435  and
17436 \family sans
17437 File\SpecialChar menuseparator
17438 Open Example\SpecialChar menuseparator
17439 Modules\SpecialChar menuseparator
17440 Linguistics
17441 \family default
17442 .
17443 \end_layout
17444
17445 \begin_layout Section
17446
17447 \change_inserted 564990737 1671788778
17448 Accessibility
17449 \end_layout
17450
17451 \begin_layout Subsection
17452
17453 \change_inserted 564990737 1671788778
17454 Braille
17455 \end_layout
17456
17457 \begin_layout Standard
17458
17459 \change_inserted 564990737 1671788778
17460 This module supports the Braille
17461 \change_deleted -712698321 1673779995
17462 writing system
17463 \change_inserted -712698321 1673779996
17464 script
17465 \change_inserted 564990737 1671788778
17466 .
17467  It requires the \SpecialChar LaTeX
17468  package
17469 \family typewriter
17470 braille.sty
17471 \family default
17472 .
17473  This and its documentation can be obtained from
17474 \begin_inset CommandInset href
17475 LatexCommand href
17476 name "CTAN"
17477 target "https://www.ctan.org/pkg/braille"
17478 literal "false"
17479
17480 \end_inset
17481
17482 .
17483
17484 \change_deleted -712698321 1673780105
17485 You do not have to reconfigure your system after installing it.
17486
17487 \change_inserted 564990737 1671788778
17488 See
17489 \family sans
17490 \bar under
17491 H
17492 \bar default
17493 elp\SpecialChar menuseparator
17494 S
17495 \bar under
17496 p
17497 \bar default
17498 ecific
17499 \begin_inset space ~
17500 \end_inset
17501
17502 Manuals\SpecialChar menuseparator
17503
17504 \bar under
17505 B
17506 \bar default
17507 raille
17508 \family default
17509  and
17510 \family sans
17511 File\SpecialChar menuseparator
17512 Open Example\SpecialChar menuseparator
17513 Modules\SpecialChar menuseparator
17514 Braille
17515 \family default
17516 .
17517 \end_layout
17518
17519 \begin_layout Section
17520
17521 \change_inserted 564990737 1671788778
17522 Annotation & Revision
17523 \end_layout
17524
17525 \begin_layout Subsection
17526
17527 \change_inserted 564990737 1671788778
17528 FiXme Notes
17529 \end_layout
17530
17531 \begin_layout Standard
17532
17533 \change_inserted 564990737 1671788778
17534 This module provides “FiXme” (marginal) annotations for document revision purposes.
17535  A list of annotations can be produced by using the “List of FIXMEs” paragraph style.
17536  The annotations are customizable via the LaTeX preamble.
17537  See the
17538 \change_inserted -712698321 1673780478
17539
17540 \family typewriter
17541 fix
17542 \change_deleted -712698321 1673780479
17543 FiX
17544 \change_inserted 564990737 1671788778
17545 me
17546 \family default
17547  documentation which can be obtained from
17548 \begin_inset CommandInset href
17549 LatexCommand href
17550 name "CTAN"
17551 target "http://mirrors.ctan.org/macros/latex/contrib/fixme/fixme.pdf"
17552 literal "false"
17553
17554 \end_inset
17555
17556 .
17557
17558 \end_layout
17559
17560 \begin_layout Paragraph
17561
17562 \change_inserted 564990737 1671788778
17563 Note:
17564 \end_layout
17565
17566 \begin_layout Standard
17567
17568 \change_inserted 564990737 1671788778
17569 by default,
17570  the notes are only displayed in “draft” mode (if the option “draft” has been inserted in
17571 \family sans
17572 Document\SpecialChar menuseparator
17573 Settings\SpecialChar menuseparator
17574 Document Class\SpecialChar menuseparator
17575 Class Options\SpecialChar menuseparator
17576 Custom
17577 \family default
17578 ).
17579  To display them always,
17580  insert
17581 \family typewriter
17582
17583 \backslash
17584 fxsetup{draft}
17585 \family default
17586  in
17587 \family sans
17588 Document\SpecialChar menuseparator
17589 Settings\SpecialChar menuseparator
17590 \SpecialChar LaTeX
17591  Preamble
17592 \family default
17593 .
17594
17595 \end_layout
17596
17597 \begin_layout Subsection
17598
17599 \change_inserted 564990737 1671788778
17600 PDF Comments
17601 \end_layout
17602
17603 \begin_layout Standard
17604
17605 \change_inserted 564990737 1671788778
17606 This module provides various kinds of annotations for PDF output.
17607  See
17608 \family sans
17609 Help\SpecialChar menuseparator
17610 Specific Manuals\SpecialChar menuseparator
17611 PDF comments
17612 \family default
17613 and
17614 \family sans
17615  File\SpecialChar menuseparator
17616 Open Example\SpecialChar menuseparator
17617 Modules\SpecialChar menuseparator
17618 PDF Comments
17619 \family default
17620 .
17621 \end_layout
17622
17623 \begin_layout Subsection
17624
17625 \change_inserted 564990737 1671788778
17626
17627 \series bold
17628 PDF Form
17629 \end_layout
17630
17631 \begin_layout Standard
17632
17633 \change_inserted 564990737 1671788778
17634 This module provides fields and buttons for PDF forms.
17635  See the
17636 \begin_inset CommandInset href
17637 LatexCommand href
17638 name "hyperref documentation"
17639 target "http://mirrors.ctan.org/macros/latex/contrib/hyperref/doc/hyperref-doc.pdf"
17640 literal "false"
17641
17642 \end_inset
17643
17644 ,
17645
17646 \family sans
17647 Help\SpecialChar menuseparator
17648 Specific Manuals\SpecialChar menuseparator
17649 PDF forms
17650 \family default
17651 and
17652 \family sans
17653  File\SpecialChar menuseparator
17654 Open Example\SpecialChar menuseparator
17655 Modules\SpecialChar menuseparator
17656 PDF Form
17657 \family default
17658 .
17659 \end_layout
17660
17661 \begin_layout Subsection
17662
17663 \change_inserted 564990737 1671788778
17664
17665 \series bold
17666 Ruby (Furigana)
17667 \end_layout
17668
17669 \begin_layout Standard
17670
17671 \change_inserted 564990737 1671788778
17672 This module defines an inset to typeset reading aids (ruby,
17673  furigana) to Chinese characters.
17674  It uses the
17675 \change_deleted -712698321 1673781076
17676 “
17677 \change_inserted 564990737 1671788778
17678
17679 \family typewriter
17680 okumakro
17681 \family default
17682 ,
17683 \change_deleted -712698321 1673781078
17684 ”
17685 \change_inserted 564990737 1671788778
17686
17687 \change_deleted -712698321 1673781079
17688 “
17689 \change_inserted 564990737 1671788778
17690
17691 \family typewriter
17692 luatexja-ruby
17693 \change_deleted -712698321 1673781080
17694
17695 \family default
17696 ”
17697 \change_inserted 564990737 1671788778
17698  or
17699 \change_deleted -712698321 1673781082
17700 “
17701 \change_inserted 564990737 1671788778
17702
17703 \family typewriter
17704 ruby
17705 \change_deleted -712698321 1673781083
17706
17707 \family default
17708 ”
17709 \change_inserted 564990737 1671788778
17710  package (depending on the TeX engine) or a fallback definition.
17711
17712 \end_layout
17713
17714 \begin_layout Subsection
17715
17716 \change_inserted 564990737 1671788778
17717
17718 \series bold
17719 TODO notes
17720 \end_layout
17721
17722 \begin_layout Standard
17723
17724 \change_inserted 564990737 1671788778
17725 This module provides custom insets to insert TODO items in your document.
17726  In order to generate a “List of TODOs,” the module provides a paragraph style.
17727  Inserting
17728 \change_deleted -712698321 1673781223
17729 “
17730 \change_inserted 564990737 1671788778
17731
17732 \family typewriter
17733 final
17734 \change_deleted -712698321 1673781224
17735
17736 \family default
17737 ”
17738 \change_inserted 564990737 1671788778
17739  in
17740 \family sans
17741 Document\SpecialChar menuseparator
17742 Settings\SpecialChar menuseparator
17743 Document Class\SpecialChar menuseparator
17744 Class Options\SpecialChar menuseparator
17745 Custom
17746 \family default
17747 ) suppresses the output of TODO notes.
17748  See the
17749 \begin_inset CommandInset href
17750 LatexCommand href
17751 name "todonotes documentation"
17752 target "http://mirrors.ctan.org/macros/latex/contrib/todonotes/todonotes.pdf"
17753 literal "false"
17754
17755 \end_inset
17756
17757 .
17758 \end_layout
17759
17760 \begin_layout Section
17761
17762 \change_inserted 564990737 1671829045
17763 Bibliography
17764 \end_layout
17765
17766 \begin_layout Subsection
17767
17768 \change_inserted 564990737 1671829045
17769 APA Style with Nat
17770 \change_deleted -712698321 1673781454
17771 B
17772 \change_inserted -712698321 1673781454
17773 b
17774 \change_inserted 564990737 1671829045
17775 ib
17776 \end_layout
17777
17778 \begin_layout Standard
17779
17780 \change_inserted 564990737 1671829045
17781 This module adds support for using natbib together with apacite (the bibliography style need not be
17782 \family typewriter
17783 apacite
17784 \family default
17785  —
17786  it could be
17787 \family typewriter
17788 apacite
17789 \family default
17790 ,
17791
17792 \family typewriter
17793 apacitex
17794 \family default
17795 ,
17796  or any bibliography that works with both the natbib and apacite packages.)
17797 \end_layout
17798
17799 \begin_layout Section
17800
17801 \change_inserted 564990737 1671829045
17802 Boxes
17803 \end_layout
17804
17805 \begin_layout Subsection
17806
17807 \change_inserted 564990737 1671829045
17808 Fancy Colored Boxes
17809 \end_layout
17810
17811 \begin_layout Standard
17812
17813 \change_inserted 564990737 1671829045
17814 This module adds ten custom insets that support colored boxes via the
17815 \family typewriter
17816 tcolorbox
17817 \family default
17818  package.
17819  See
17820 \family sans
17821 Help\SpecialChar menuseparator
17822 Specific Manuals\SpecialChar menuseparator
17823 Colored boxes
17824 \family default
17825 ,
17826
17827 \family sans
17828 File\SpecialChar menuseparator
17829 Open Example\SpecialChar menuseparator
17830 Modules\SpecialChar menuseparator
17831 Fancy Color Boxes
17832 \family default
17833
17834 \change_inserted -712698321 1673854244
17835 and
17836 \change_inserted 564990737 1671829045
17837 the
17838 \begin_inset CommandInset href
17839 LatexCommand href
17840 name "tcolorbox documentation"
17841 target "http://mirrors.ctan.org/macros/latex/contrib/tcolorbox/tcolorbox.pdf"
17842 literal "false"
17843
17844 \end_inset
17845
17846  for details.
17847
17848 \end_layout
17849
17850 \begin_layout Subsection
17851
17852 \change_inserted 564990737 1671829045
17853 Graphic boxes
17854 \end_layout
17855
17856 \begin_layout Standard
17857
17858 \change_inserted 564990737 1671829045
17859 This provides the custom insets
17860 \family sans
17861 Reflectbox
17862 \family default
17863 ,
17864
17865 \family sans
17866 Resizebox
17867 \family default
17868 ,
17869
17870 \family sans
17871 Rotatebox
17872 \family default
17873  and
17874 \family sans
17875 Scalebox
17876 \family default
17877  to scale and rotate its content.
17878 \end_layout
17879
17880 \begin_layout Standard
17881
17882 \change_inserted 564990737 1671829045
17883
17884 \family sans
17885 Reflectbox
17886 \family default
17887  is a simple way of reversing text without any other enhancement:
17888 \end_layout
17889
17890 \begin_layout Standard
17891
17892 \change_inserted 564990737 1671829045
17893 \begin_inset Flex Reflectbox
17894 status open
17895
17896 \begin_layout Plain Layout
17897
17898 \change_inserted 564990737 1671829045
17899 Great Western Railway
17900 \change_unchanged
17901
17902 \end_layout
17903
17904 \end_inset
17905
17906
17907 \end_layout
17908
17909 \begin_layout Standard
17910
17911 \change_inserted 564990737 1671829045
17912 (You will need to use Ctrl-R to see any of these examples.)
17913 \end_layout
17914
17915 \begin_layout Standard
17916
17917 \change_inserted 564990737 1671829045
17918
17919 \family sans
17920 Resizebox
17921 \family default
17922  allows you to specify the dimensions of the text or image;
17923  permissible units are em,
17924  ex,
17925  in,
17926  pt,
17927  pc,
17928  cm,
17929  mm,
17930  dd,
17931  cc,
17932  nd,
17933  nc,
17934  bp,
17935  or sp;
17936  if you enter
17937 \family typewriter
17938 !
17939
17940 \family default
17941  for
17942 \family typewriter
17943 Height
17944 \family default
17945  it scales by the width factor:
17946 \end_layout
17947
17948 \begin_layout Standard
17949
17950 \change_inserted 564990737 1671829045
17951 \begin_inset Flex Resizebox
17952 status open
17953
17954 \begin_layout Plain Layout
17955
17956 \change_inserted 564990737 1671829045
17957 \begin_inset Argument 1
17958 status open
17959
17960 \begin_layout Plain Layout
17961
17962 \change_inserted 564990737 1671829045
17963 48mm
17964 \change_unchanged
17965
17966 \end_layout
17967
17968 \end_inset
17969
17970
17971 \begin_inset Argument 2
17972 status open
17973
17974 \begin_layout Plain Layout
17975
17976 \change_inserted 564990737 1671829045
17977 !
17978 \change_unchanged
17979
17980 \end_layout
17981
17982 \end_inset
17983
17984 Great Western Railway
17985 \change_unchanged
17986
17987 \end_layout
17988
17989 \end_inset
17990
17991
17992 \end_layout
17993
17994 \begin_layout Standard
17995
17996 \change_inserted 564990737 1671829045
17997
17998 \family sans
17999 Rotatebox
18000 \family default
18001  allows you to rotate
18002 \change_deleted -712698321 1673856297
18003 text
18004 \change_inserted -712698321 1673856302
18005 its contents
18006 \change_inserted 564990737 1671829045
18007  around the reference point of the box.
18008  If you wish to rotate the box around a different origin,
18009  place the cursor inside the box and select Insert\SpecialChar menuseparator
18010 Origin;
18011  o
18012 \family typewriter
18013 rigin
18014 \family default
18015  is specified as
18016 \family typewriter
18017 c
18018 \family default
18019 ,
18020
18021 \family typewriter
18022  l
18023 \family default
18024 ,
18025
18026 \family typewriter
18027  r
18028 \family default
18029 ,
18030
18031 \family typewriter
18032  b
18033 \family default
18034 ,
18035
18036 \family typewriter
18037  t
18038 \family default
18039  or meaningful combinations of these and the counterclockwise rotation angle is expressed in degrees.
18040  For example:
18041 \end_layout
18042
18043 \begin_layout Standard
18044
18045 \change_inserted 564990737 1671829045
18046 \begin_inset Flex Rotatebox
18047 status open
18048
18049 \begin_layout Plain Layout
18050
18051 \change_inserted 564990737 1671829045
18052 \begin_inset Argument 1
18053 status open
18054
18055 \begin_layout Plain Layout
18056
18057 \change_inserted 274215730 1672888693
18058 origin
18059 \change_inserted 564990737 1671829045
18060 =c
18061 \change_unchanged
18062
18063 \end_layout
18064
18065 \end_inset
18066
18067
18068 \begin_inset Argument 2
18069 status open
18070
18071 \begin_layout Plain Layout
18072
18073 \change_inserted 564990737 1671829045
18074 30
18075 \change_unchanged
18076
18077 \end_layout
18078
18079 \end_inset
18080
18081 Great Western Railway
18082 \change_unchanged
18083
18084 \end_layout
18085
18086 \end_inset
18087
18088
18089 \end_layout
18090
18091 \begin_layout Standard
18092
18093 \change_inserted 564990737 1671829045
18094 You can combine boxes as in:
18095 \end_layout
18096
18097 \begin_layout Standard
18098
18099 \change_inserted 564990737 1671829045
18100 \begin_inset Flex Rotatebox
18101 status open
18102
18103 \begin_layout Plain Layout
18104
18105 \change_inserted 564990737 1671829045
18106 \begin_inset Argument 1
18107 status open
18108
18109 \begin_layout Plain Layout
18110
18111 \change_inserted 274215730 1672888702
18112 origin
18113 \change_inserted 564990737 1671829045
18114 =c
18115 \change_unchanged
18116
18117 \end_layout
18118
18119 \end_inset
18120
18121
18122 \begin_inset Argument 2
18123 status open
18124
18125 \begin_layout Plain Layout
18126
18127 \change_inserted 564990737 1671829045
18128 -15
18129 \change_unchanged
18130
18131 \end_layout
18132
18133 \end_inset
18134
18135
18136 \begin_inset Flex Resizebox
18137 status open
18138
18139 \begin_layout Plain Layout
18140
18141 \change_inserted 564990737 1671829045
18142 \begin_inset Argument 1
18143 status open
18144
18145 \begin_layout Plain Layout
18146
18147 \change_inserted 564990737 1671829045
18148 48mm
18149 \change_unchanged
18150
18151 \end_layout
18152
18153 \end_inset
18154
18155
18156 \begin_inset Argument 2
18157 status open
18158
18159 \begin_layout Plain Layout
18160
18161 \change_inserted 564990737 1671829045
18162 !
18163 \change_unchanged
18164
18165 \end_layout
18166
18167 \end_inset
18168
18169
18170 \begin_inset Flex Reflectbox
18171 status open
18172
18173 \begin_layout Plain Layout
18174
18175 \change_inserted 564990737 1671829045
18176 Great Western Railway
18177 \change_unchanged
18178
18179 \end_layout
18180
18181 \end_inset
18182
18183
18184 \change_unchanged
18185
18186 \end_layout
18187
18188 \end_inset
18189
18190
18191 \change_unchanged
18192
18193 \end_layout
18194
18195 \end_inset
18196
18197
18198 \end_layout
18199
18200 \begin_layout Standard
18201
18202 \change_inserted 564990737 1671829045
18203
18204 \family sans
18205 Scalebox
18206 \family default
18207  scales
18208 \change_deleted -712698321 1673856306
18209 text
18210 \change_inserted -712698321 1673856308
18211 its contents
18212 \change_inserted 564990737 1671829045
18213 ;
18214  select Insert\SpecialChar menuseparator
18215 V-Factor to add a vertical factor.
18216  If the vertical factor is omitted,
18217  the horizontal is used.
18218  Adding different horizontal and vertical values creates distortion as in
18219 \end_layout
18220
18221 \begin_layout Standard
18222
18223 \change_inserted 564990737 1671829045
18224
18225 \family typewriter
18226 \begin_inset Flex Scalebox
18227 status open
18228
18229 \begin_layout Plain Layout
18230
18231 \change_inserted 564990737 1671829045
18232 \begin_inset Argument 1
18233 status open
18234
18235 \begin_layout Plain Layout
18236
18237 \change_inserted 564990737 1671829045
18238 2
18239 \change_unchanged
18240
18241 \end_layout
18242
18243 \end_inset
18244
18245
18246 \begin_inset Argument 2
18247 status open
18248
18249 \begin_layout Plain Layout
18250
18251 \change_inserted 564990737 1671829045
18252 1.5
18253 \change_unchanged
18254
18255 \end_layout
18256
18257 \end_inset
18258
18259
18260 \family roman
18261 Great Western Railway
18262 \change_unchanged
18263
18264 \end_layout
18265
18266 \end_inset
18267
18268 .
18269 \end_layout
18270
18271 \begin_layout Standard
18272
18273 \change_inserted 564990737 1671829045
18274 A negative horizontal value reverses the text
18275 \change_inserted -712698321 1673856686
18276 on the horizontal axis,
18277
18278 \change_deleted -712698321 1673856688
18279 and
18280 \change_inserted 564990737 1671829045
18281 a negative vertical value
18282 \change_deleted -712698321 1673856694
18283 inverts
18284 \change_inserted -712698321 1673856702
18285  on the vertical axis,
18286
18287 \change_inserted 564990737 1671829045
18288
18289 \change_deleted -712698321 1673856704
18290 it
18291 \change_inserted 564990737 1671829045
18292 so that you get
18293 \end_layout
18294
18295 \begin_layout Standard
18296
18297 \change_inserted 564990737 1671829045
18298 \begin_inset Flex Scalebox
18299 status open
18300
18301 \begin_layout Plain Layout
18302
18303 \change_inserted 564990737 1671829045
18304 \begin_inset Argument 1
18305 status open
18306
18307 \begin_layout Plain Layout
18308
18309 \change_inserted 564990737 1671829045
18310 -1
18311 \change_unchanged
18312
18313 \end_layout
18314
18315 \end_inset
18316
18317
18318 \begin_inset Argument 2
18319 status open
18320
18321 \begin_layout Plain Layout
18322
18323 \change_inserted 564990737 1671829045
18324 1
18325 \change_unchanged
18326
18327 \end_layout
18328
18329 \end_inset
18330
18331 Great Western Railway
18332 \change_unchanged
18333
18334 \end_layout
18335
18336 \end_inset
18337
18338  and
18339 \begin_inset Flex Scalebox
18340 status open
18341
18342 \begin_layout Plain Layout
18343
18344 \change_inserted 564990737 1671829045
18345 \begin_inset Argument 1
18346 status open
18347
18348 \begin_layout Plain Layout
18349
18350 \change_inserted 564990737 1671829045
18351 1
18352 \change_unchanged
18353
18354 \end_layout
18355
18356 \end_inset
18357
18358
18359 \begin_inset Argument 2
18360 status open
18361
18362 \begin_layout Plain Layout
18363
18364 \change_inserted 564990737 1671829045
18365 -1
18366 \change_unchanged
18367
18368 \end_layout
18369
18370 \end_inset
18371
18372 Great Western Railway
18373 \change_unchanged
18374
18375 \end_layout
18376
18377 \end_inset
18378
18379 .
18380 \end_layout
18381
18382 \begin_layout Subsection
18383
18384 \change_inserted 564990737 1671884699
18385 Section Boxes
18386 \end_layout
18387
18388 \begin_layout Standard
18389
18390 \change_inserted 564990737 1671884699
18391 This module defines Boxes with section header.
18392  It is mainly intended for the SciPoster Document class.
18393
18394 \end_layout
18395
18396 \begin_layout Subsection
18397
18398 \change_inserted 564990737 1671884699
18399 Variable-width Minipages
18400 \end_layout
18401
18402 \begin_layout Standard
18403
18404 \change_inserted 564990737 1671884699
18405 This module adds a
18406 \family sans
18407 Minipage (Var.
18408 \begin_inset space \thinspace{}
18409 \end_inset
18410
18411 Width)
18412 \family default
18413  inset to
18414 \family sans
18415 Insert\SpecialChar menuseparator
18416 Custom Inset
18417 \family default
18418  using the
18419 \family typewriter
18420 varwidth
18421 \family default
18422  LaTeX package.
18423  The
18424 \family typewriter
18425 varwidth
18426 \family default
18427  package provides a variable-width minipage,
18428  whose resulting width is the width of its contents (if this does not exceed the specified maximum width).
18429  The inset has two optional arguments which can be added by placing the cursor inside the minipage and entering
18430 \family sans
18431 Insert\SpecialChar menuseparator
18432 Vert.
18433 \begin_inset space \thinspace{}
18434 \end_inset
18435
18436 Adjustment
18437 \family default
18438  (
18439 \family typewriter
18440 c|t|b
18441 \family default
18442 ) or
18443 \family sans
18444 Insert\SpecialChar menuseparator
18445 Max.
18446 \begin_inset space \thinspace{}
18447 \end_inset
18448
18449 Width
18450 \family default
18451  (defaults to
18452 \family typewriter
18453
18454 \backslash
18455 linewidth
18456 \family default
18457 ).
18458  See
18459 \family sans
18460 File\SpecialChar menuseparator
18461 Open Example\SpecialChar menuseparator
18462 Variable-width Minipages
18463 \family default
18464 .
18465
18466 \end_layout
18467
18468 \begin_layout Section
18469
18470 \change_inserted 564990737 1671884699
18471 Fixes & Hacks
18472 \end_layout
18473
18474 \begin_layout Subsection
18475
18476 \change_inserted 564990737 1671884699
18477 Fix Computer Modern Fonts
18478 \end_layout
18479
18480 \begin_layout Standard
18481
18482 \change_inserted 564990737 1671884699
18483 This module uses the
18484 \family sans
18485 fix-cm
18486 \family default
18487  package to improve the appearance of Computer Modern fonts and make them available with arbitrary sizes.
18488  See the
18489 \begin_inset CommandInset href
18490 LatexCommand href
18491 name "fix-cm documentation"
18492 target "http://mirrors.ctan.org/macros/latex/base/fix-cm.pdf"
18493 literal "false"
18494
18495 \end_inset
18496
18497 .
18498
18499 \end_layout
18500
18501 \begin_layout Subsection
18502
18503 \change_inserted 564990737 1671884699
18504 \SpecialChar LaTeX
18505  Kernel Fixes (Obsolete)
18506 \end_layout
18507
18508 \begin_layout Standard
18509
18510 \change_inserted 564990737 1671884699
18511 This module loads the \SpecialChar LaTeX
18512  package
18513 \family sans
18514 fixltx2e
18515 \family default
18516  which contains some bug fixes for \SpecialChar LaTeX
18517 .
18518  If you use this module your typeset document may look different when you process it,
18519  depending on the respective version of
18520 \family sans
18521 fixltx2e
18522 \family default
18523 .
18524
18525 \end_layout
18526
18527 \begin_layout Paragraph
18528
18529 \change_inserted 564990737 1671884699
18530 Note:
18531 \end_layout
18532
18533 \begin_layout Standard
18534
18535 \change_inserted 564990737 1671884699
18536 recent \SpecialChar LaTeX
18537  kernels (as of 2015/01/01) include the functionality of
18538 \family sans
18539 fixltx2e
18540 \family default
18541 ,
18542  so the
18543 \family sans
18544 fixltx2e
18545 \family default
18546  module is obsolete with newer \SpecialChar LaTeX
18547  distributions.
18548
18549 \change_deleted -712698321 1673857809
18550
18551 \change_inserted 564990737 1671884699
18552
18553 \end_layout
18554
18555 \begin_layout Subsection
18556
18557 \change_inserted 564990737 1671884699
18558 Minimalistic Insets
18559 \end_layout
18560
18561 \begin_layout Standard
18562
18563 \change_inserted 564990737 1671884699
18564 This module redefines several insets (Index,
18565  Branch,
18566  URL) as being Minimalistic.
18567 \end_layout
18568
18569 \begin_layout Subsection
18570
18571 \change_inserted 564990737 1671884699
18572 Title and Preamble Hacks
18573 \end_layout
18574
18575 \begin_layout Standard
18576
18577 \change_inserted 564990737 1671884699
18578 This module provides two new paragraph styles:
18579
18580 \end_layout
18581
18582 \begin_layout Enumerate
18583
18584 \change_inserted 564990737 1671884699
18585
18586 \family sans
18587 In Preamble
18588 \family default
18589  which puts whatever is entered into it into the preamble.
18590  This can be used,
18591  if one wishes,
18592  to include preamble code in the body of a LyX document.
18593
18594 \end_layout
18595
18596 \begin_layout Enumerate
18597
18598 \change_inserted 564990737 1671884699
18599
18600 \family sans
18601 In Title
18602 \family default
18603  which that will put its contents into the body of the LaTeX document,
18604  but before
18605 \family typewriter
18606
18607 \backslash
18608 maketitle
18609 \family default
18610  is issued.
18611  This is useful for making branches and notes in title-related material.
18612  (However,
18613  if you put these in a
18614 \family sans
18615 Standard
18616 \family default
18617  layout,
18618  this signals to LyX to output
18619 \family typewriter
18620
18621 \backslash
18622 maketitle
18623 \family default
18624 ,
18625  which may then come too early.)
18626 \end_layout
18627
18628 \begin_layout Section
18629
18630 \change_inserted 564990737 1672081439
18631 Floats & captions
18632 \end_layout
18633
18634 \begin_layout Subsection
18635
18636 \change_inserted 564990737 1672081439
18637 Algorithm2e Float
18638 \end_layout
18639
18640 \begin_layout Standard
18641
18642 \change_inserted 564990737 1672081439
18643 This module uses the
18644 \family sans
18645 algorithm2e
18646 \family default
18647  package for algorithm floats rather than LyX’s home-brewed algorithm floats.
18648  Use the Algorithm paragraph style to enter and indent the algorithm.
18649  See the
18650 \begin_inset CommandInset href
18651 LatexCommand href
18652 name "algorithm2e documentation"
18653 target "http://mirrors.ctan.org/macros/latex/contrib/algorithm2e/doc/algorithm2e.pdf"
18654 literal "false"
18655
18656 \end_inset
18657
18658 .
18659 \end_layout
18660
18661 \begin_layout Subsection
18662
18663 \change_inserted 564990737 1672081439
18664 Bilingual Captions AKA Multilingual Captions
18665 \end_layout
18666
18667 \begin_layout Standard
18668
18669 \change_inserted 564990737 1672081439
18670 This module provides the paragraph style
18671 \family sans
18672 Caption
18673 \begin_inset space ~
18674 \end_inset
18675
18676 setup
18677 \family default
18678  with which to typeset
18679 \change_deleted -712698321 1673859156
18680 mult
18681 \change_inserted -712698321 1673859156
18682 b
18683 \change_inserted 564990737 1672081439
18684 ilingual captions.
18685  Within this paragraph style
18686 \family sans
18687 Insert\SpecialChar menuseparator
18688 Language
18689 \family default
18690  allows you to enter the desired
18691 \change_inserted -712698321 1673859387
18692 second
18693 \change_inserted 564990737 1672081439
18694 language using one of the babel names.
18695  See
18696 \family sans
18697 File\SpecialChar menuseparator
18698 Open Example\SpecialChar menuseparator
18699
18700 \change_inserted -712698321 1673859558
18701 Modules\SpecialChar menuseparator
18702
18703 \change_inserted 564990737 1672081439
18704 Multilingual Captions
18705 \family default
18706  and
18707 \family sans
18708 Help\SpecialChar menuseparator
18709 Specific Manuals\SpecialChar menuseparator
18710 Multilingual Captions
18711 \family default
18712  further information on its use.
18713 \end_layout
18714
18715 \begin_layout Subsection
18716
18717 \change_inserted 564990737 1672081439
18718 Number Figures by Section
18719 \end_layout
18720
18721 \begin_layout Standard
18722
18723 \change_inserted 564990737 1672081439
18724 This module resets the figure number at section start and prepends the section number to the figure number,
18725  as in “Figure 2.1.” (By default book and report document classes number by Chapter and article document classes have a single sequence.)
18726 \end_layout
18727
18728 \begin_layout Subsection
18729
18730 \change_inserted 564990737 1672081439
18731 Number Tables by Section
18732 \end_layout
18733
18734 \begin_layout Standard
18735
18736 \change_inserted 564990737 1672081439
18737 This module resets the table number at section start and prepends the section number to the table number,
18738  as in “Table 2.1.” (By default book and report document classes number by Chapter and article document classes have a single sequence.)
18739 \end_layout
18740
18741 \begin_layout Section
18742
18743 \change_inserted 564990737 1672081439
18744 Foot- and Endnotes
18745 \end_layout
18746
18747 \begin_layout Subsection
18748
18749 \change_inserted 564990737 1672081439
18750 Endnotes (Basic)
18751 \end_layout
18752
18753 \begin_layout Standard
18754
18755 \change_inserted 564990737 1672081439
18756 This module adds an endnote inset,
18757  in addition to footnotes.
18758  This uses the
18759 \family sans
18760 endnotes
18761 \family default
18762  package,
18763  which has some limitations but works with older
18764 \change_deleted -712698321 1673861636
18765 LaTeX
18766 \change_inserted -712698321 1673861636
18767 \SpecialChar LaTeX
18768
18769 \change_inserted 564990737 1672081439
18770  distributions as well.
18771  Use
18772 \family sans
18773 Insert\SpecialChar menuseparator
18774 Custom Inset\SpecialChar menuseparator
18775 Endnote
18776 \family default
18777  to insert an endnote and
18778 \family sans
18779 Insert\SpecialChar menuseparator
18780 List/Contents/References\SpecialChar menuseparator
18781 Endnotes
18782 \family default
18783  to insert the endnotes list where you want the endnotes to appear.
18784  See also
18785 \family sans
18786 Help\SpecialChar menuseparator
18787 Embedded
18788 \change_deleted -712698321 1673861792
18789 \SpecialChar menuseparator
18790
18791 \change_inserted 564990737 1672081439
18792  Objects
18793 \change_deleted -712698321 1673861963
18794 \SpecialChar menuseparator
18795 Notes\SpecialChar menuseparator
18796 Footnotes
18797 \change_inserted -712698321 1673861963
18798
18799 \family default
18800 ,
18801  section
18802 \emph on
18803 4.2 Footnotes
18804 \change_inserted 564990737 1672081439
18805
18806 \emph default
18807 .
18808 \end_layout
18809
18810 \begin_layout Subsection
18811
18812 \change_inserted 564990737 1672081439
18813 Endnotes (Extended)
18814 \end_layout
18815
18816 \begin_layout Standard
18817
18818 \change_inserted 564990737 1672081439
18819 This module adds an endnote inset,
18820  in addition to footnotes.
18821  This uses the
18822 \family sans
18823 enotez
18824 \family default
18825  package which is more powerful and customizable than the
18826 \family sans
18827 endnotes
18828 \family default
18829  package,
18830  but requires a fairly modern
18831 \change_deleted -712698321 1673861643
18832 LaTeX
18833 \change_inserted -712698321 1673861643
18834 \SpecialChar LaTeX
18835
18836 \change_inserted 564990737 1672081439
18837  distribution (with
18838 \change_deleted -712698321 1673861645
18839 LaTeX
18840 \change_inserted -712698321 1673861645
18841 \SpecialChar LaTeX
18842
18843 \change_inserted 564990737 1672081439
18844 3).
18845  Use
18846 \family sans
18847 Insert\SpecialChar menuseparator
18848 Custom Inset\SpecialChar menuseparator
18849 Endnote
18850 \family default
18851  to insert an endnote and
18852 \family sans
18853 Insert\SpecialChar menuseparator
18854 List/Contents/References\SpecialChar menuseparator
18855 Endnotes
18856 \family default
18857  to insert the endnotes list where you want the endnotes to appear.
18858  See also
18859 \family sans
18860 Help\SpecialChar menuseparator
18861 Embedded
18862 \change_deleted -712698321 1673861798
18863 \SpecialChar menuseparator
18864
18865 \change_inserted 564990737 1672081439
18866  Objects
18867 \change_inserted -712698321 1673861924
18868
18869 \family default
18870 ,
18871  section
18872 \emph on
18873 4.2 Footnotes
18874 \emph default
18875 .
18876 \change_deleted -712698321 1673861927
18877
18878 \family sans
18879 \SpecialChar menuseparator
18880 Notes\SpecialChar menuseparator
18881 Footnotes
18882 \change_inserted 564990737 1672081439
18883
18884 \family default
18885 .
18886 \end_layout
18887
18888 \begin_layout Subsection
18889
18890 \change_inserted 564990737 1672081439
18891 Footnotes as Endnotes (Basic)
18892 \end_layout
18893
18894 \begin_layout Standard
18895
18896 \change_inserted 564990737 1672081439
18897 This module sets all footnotes as endnotes.
18898  This uses the
18899 \family sans
18900 endnotes
18901 \family default
18902  package,
18903  which has some limitations but works with older
18904 \change_deleted -712698321 1673861650
18905 LaTeX
18906 \change_inserted -712698321 1673861650
18907 \SpecialChar LaTeX
18908
18909 \change_inserted 564990737 1672081439
18910  distributions as well.
18911  Use
18912 \family sans
18913 Insert\SpecialChar menuseparator
18914 List/Contents/References\SpecialChar menuseparator
18915 Endnotes
18916 \family default
18917  to insert the endnotes list where you want the endnotes to appear.
18918  See also
18919 \family sans
18920 Help\SpecialChar menuseparator
18921 Embedded
18922 \change_deleted -712698321 1673861805
18923 \SpecialChar menuseparator
18924
18925 \change_inserted 564990737 1672081439
18926  Objects
18927 \change_deleted -712698321 1673861947
18928 \SpecialChar menuseparator
18929 Notes\SpecialChar menuseparator
18930 Footnotes
18931 \change_inserted -712698321 1673861947
18932
18933 \family default
18934 ,
18935  section
18936 \emph on
18937 4.2 Footnotes
18938 \change_inserted 564990737 1672081439
18939
18940 \emph default
18941 .
18942 \end_layout
18943
18944 \begin_layout Subsection
18945
18946 \change_inserted 564990737 1672081439
18947 Footnotes as Endnotes (Extended)
18948 \end_layout
18949
18950 \begin_layout Standard
18951
18952 \change_inserted 564990737 1672081439
18953 This module sets all footnotes as endnotes.
18954  This uses the
18955 \family sans
18956 enotez
18957 \family default
18958  package which is more powerful and customizable than then
18959 \family sans
18960 endnotes
18961 \family default
18962  package,
18963  but requires a fairly modern
18964 \change_deleted -712698321 1673861654
18965 LaTeX
18966 \change_inserted -712698321 1673861654
18967 \SpecialChar LaTeX
18968
18969 \change_inserted 564990737 1672081439
18970  distribution (with
18971 \change_deleted -712698321 1673861656
18972 LaTeX
18973 \change_inserted -712698321 1673861656
18974 \SpecialChar LaTeX
18975
18976 \change_inserted 564990737 1672081439
18977 3).
18978  Use
18979 \family sans
18980 Insert\SpecialChar menuseparator
18981 List/Contents/References\SpecialChar menuseparator
18982 Endnotes
18983 \family default
18984  to insert the endnotes list where you want the endnotes to appear.
18985  See also
18986 \family sans
18987 Help\SpecialChar menuseparator
18988 Embedded
18989 \change_deleted -712698321 1673861808
18990 \SpecialChar menuseparator
18991
18992 \change_inserted 564990737 1672081439
18993  Objects
18994 \change_deleted -712698321 1673861955
18995 \SpecialChar menuseparator
18996 Notes\SpecialChar menuseparator
18997 Footnotes
18998 \change_inserted -712698321 1673861989
18999
19000 \family default
19001 ,
19002  section
19003 \emph on
19004 4.2 Footnotes
19005 \emph default
19006 .
19007 \change_deleted -712698321 1673861956
19008 .
19009 \change_inserted 564990737 1672081439
19010
19011 \end_layout
19012
19013 \begin_layout Section
19014
19015 \change_inserted 564990737 1672081439
19016 Leisure,
19017  Sports and Music
19018 \end_layout
19019
19020 \begin_layout Subsection
19021
19022 \change_inserted 564990737 1672081439
19023 Chess Board
19024 \end_layout
19025
19026 \begin_layout Standard
19027
19028 \change_inserted 564990737 1672081439
19029 This module provides support for the
19030 \family sans
19031 chessboard
19032 \family default
19033  package to print chess games.
19034  See
19035 \family sans
19036 File\SpecialChar menuseparator
19037 Open Example\SpecialChar menuseparator
19038 Articles\SpecialChar menuseparator
19039 Chess
19040 \family default
19041  where you will find
19042 \family sans
19043 Game 1
19044 \family default
19045  and
19046 \family sans
19047 Game 2
19048 \family default
19049  and the
19050 \begin_inset CommandInset href
19051 LatexCommand href
19052 name "chessboard documentation"
19053 target "http://mirrors.ctan.org/macros/latex/contrib/chessboard/chessboard.pdf"
19054 literal "false"
19055
19056 \end_inset
19057
19058 .
19059 \end_layout
19060
19061 \begin_layout Subsection
19062
19063 \change_inserted 564990737 1672081439
19064 Lilypond Music Notation
19065 \end_layout
19066
19067 \begin_layout Standard
19068
19069 \change_inserted 564990737 1672081439
19070 This module provides an inset via
19071 \family sans
19072 \bar under
19073 I
19074 \bar default
19075 nsert\SpecialChar menuseparator
19076 Custom Inset\SpecialChar menuseparator
19077 Lilypond
19078 \family default
19079  in which to enter code for the LilyPond music editor.
19080  It will then be processed in the output.
19081  See
19082 \family sans
19083 Help\SpecialChar menuseparator
19084 Specific Manuals\SpecialChar menuseparator
19085 Lilypond
19086 \family default
19087  and
19088 \family sans
19089 File\SpecialChar menuseparator
19090 Open Example\SpecialChar menuseparator
19091 Modules\SpecialChar menuseparator
19092 Lilypond Book
19093 \family default
19094 .
19095  It cannot be used if the modules
19096 \family sans
19097 Rnw
19098 \begin_inset space \thinspace{}
19099 \end_inset
19100
19101 (knitr)
19102 \family default
19103 or
19104 \family sans
19105  Sweave
19106 \family default
19107  have been loaded.
19108 \end_layout
19109
19110 \begin_layout Section
19111
19112 \change_inserted 564990737 1672138150
19113 List enhancements
19114 \end_layout
19115
19116 \begin_layout Subsection
19117
19118 \change_inserted 564990737 1672138150
19119 Customizable Lists
19120 \begin_inset CommandInset label
19121 LatexCommand label
19122 name "subsec:Customizable-Lists"
19123
19124 \end_inset
19125
19126
19127 \end_layout
19128
19129 \begin_layout Standard
19130
19131 \change_inserted 564990737 1672138150
19132 This module uses the
19133 \family sans
19134  enumitem
19135 \family default
19136  package to enable the customization of various list environments.
19137 \end_layout
19138
19139 \begin_layout Subsubsection
19140
19141 \change_inserted 564990737 1672138150
19142 Custom Enumerate Lists
19143 \end_layout
19144
19145 \begin_layout Standard
19146 \noindent
19147
19148 \change_inserted 564990737 1672138150
19149 The default numbering of numbered lists can be changed by adding an optional argument (menu
19150 \family sans
19151 \bar under
19152 I
19153 \bar default
19154 nsert\SpecialChar menuseparator
19155
19156 \bar under
19157 S
19158 \bar default
19159 hort Title
19160 \family default
19161 ) to the first item of each level in the list.
19162  There you add the command
19163 \end_layout
19164
19165 \begin_layout Standard
19166
19167 \change_inserted 564990737 1672138150
19168
19169 \family sans
19170 label=
19171 \backslash
19172 roman{enumi}
19173 \end_layout
19174
19175 \begin_layout Standard
19176
19177 \change_inserted 564990737 1672138150
19178 in \SpecialChar TeX
19179  Code (shortcut
19180 \begin_inset Info
19181 type  "shortcut"
19182 arg   "ert-insert"
19183 \end_inset
19184
19185 ).
19186 \end_layout
19187
19188 \begin_layout Standard
19189
19190 \change_inserted 564990737 1672138150
19191
19192 \family sans
19193 enumi
19194 \family default
19195  is the first level counter of the enumeration.
19196  To change the numbering for the list sublevels,
19197  replace the “
19198 \family sans
19199 i
19200 \family default
19201 ” in the command by the small Roman numeral of the level (
19202 \family sans
19203 enumi
19204 \family default
19205 ,
19206
19207 \family sans
19208 enumii
19209 \family default
19210 ,
19211
19212 \family sans
19213 enumiii
19214 \family default
19215 ,
19216
19217 \family sans
19218 enumiv
19219 \family default
19220 ).
19221 \end_layout
19222
19223 \begin_layout Standard
19224
19225 \change_inserted 564990737 1672138150
19226 The command
19227 \family sans
19228
19229 \backslash
19230 roman
19231 \family default
19232  outputs the counter as a small Roman numeral.
19233  For capital Roman numerals replace
19234 \family sans
19235
19236 \backslash
19237 roman
19238 \family default
19239  with
19240 \family sans
19241
19242 \backslash
19243 Roman
19244 \family default
19245  in the command above.
19246  For Arabic numerals use
19247 \family sans
19248
19249 \backslash
19250 arabic
19251 \family default
19252 .
19253  To
19254 \begin_inset Quotes eld
19255 \end_inset
19256
19257 number
19258 \begin_inset Quotes erd
19259 \end_inset
19260
19261  items with capital or small Latin letters use
19262 \family sans
19263
19264 \backslash
19265 Alph
19266 \family default
19267  or
19268 \family sans
19269
19270 \backslash
19271 alph
19272 \family default
19273 ,
19274  respectively.
19275 \end_layout
19276
19277 \begin_layout Standard
19278 \noindent
19279
19280 \change_inserted 564990737 1672138150
19281 \begin_inset Note Greyedout
19282 status open
19283
19284 \begin_layout Plain Layout
19285
19286 \change_inserted 564990737 1672138150
19287
19288 \series bold
19289 Note:
19290
19291 \series default
19292  You can only number 26
19293 \begin_inset space ~
19294 \end_inset
19295
19296 items with Latin letters,
19297  because this numbering is limited to single letters.
19298 \end_layout
19299
19300 \end_inset
19301
19302
19303 \end_layout
19304
19305 \begin_layout Standard
19306
19307 \change_inserted 564990737 1672138150
19308 Here is a list with custom numbering:
19309 \end_layout
19310
19311 \begin_layout Enumerate
19312
19313 \change_inserted 564990737 1672138150
19314 \begin_inset Argument 1
19315 status collapsed
19316
19317 \begin_layout Plain Layout
19318
19319 \change_inserted 564990737 1672138150
19320 \begin_inset ERT
19321 status collapsed
19322
19323 \begin_layout Plain Layout
19324
19325 \change_inserted 564990737 1672138150
19326
19327 label=
19328 \backslash
19329 #
19330 \backslash
19331 Alph{enumi}
19332 \backslash
19333 #
19334 \end_layout
19335
19336 \end_inset
19337
19338
19339 \change_unchanged
19340
19341 \end_layout
19342
19343 \end_inset
19344
19345 Level 1
19346 \begin_inset Separator latexpar
19347 \end_inset
19348
19349
19350 \end_layout
19351
19352 \begin_deeper
19353 \begin_layout Enumerate
19354
19355 \change_inserted 564990737 1672138150
19356 \begin_inset Argument 1
19357 status collapsed
19358
19359 \begin_layout Plain Layout
19360
19361 \change_inserted 564990737 1672138150
19362 \begin_inset ERT
19363 status collapsed
19364
19365 \begin_layout Plain Layout
19366
19367 \change_inserted 564990737 1672138150
19368
19369 label=
19370 \backslash
19371 Alph{enumi}.
19372 \backslash
19373 arabic{enumii}
19374 \end_layout
19375
19376 \end_inset
19377
19378
19379 \change_unchanged
19380
19381 \end_layout
19382
19383 \end_inset
19384
19385 Level 2
19386 \end_layout
19387
19388 \begin_layout Enumerate
19389
19390 \change_inserted 564990737 1672138150
19391 Level 2
19392 \begin_inset Separator latexpar
19393 \end_inset
19394
19395
19396 \end_layout
19397
19398 \begin_deeper
19399 \begin_layout Enumerate
19400
19401 \change_inserted 564990737 1672138150
19402 \begin_inset Argument 1
19403 status collapsed
19404
19405 \begin_layout Plain Layout
19406
19407 \change_inserted 564990737 1672138150
19408 \begin_inset ERT
19409 status collapsed
19410
19411 \begin_layout Plain Layout
19412
19413 \change_inserted 564990737 1672138150
19414
19415 label=
19416 \change_deleted 274215730 1672889016
19417
19418 \backslash
19419 bf
19420 \change_inserted 274215730 1672889016
19421
19422 \backslash
19423 bfseries
19424 \change_inserted 564990737 1672138150
19425 {
19426 \backslash
19427 arabic{enumiii}}
19428 \end_layout
19429
19430 \end_inset
19431
19432
19433 \change_unchanged
19434
19435 \end_layout
19436
19437 \end_inset
19438
19439 Level 3
19440 \begin_inset Separator latexpar
19441 \end_inset
19442
19443
19444 \end_layout
19445
19446 \begin_deeper
19447 \begin_layout Enumerate
19448
19449 \change_inserted 564990737 1672138150
19450 \begin_inset Argument 1
19451 status collapsed
19452
19453 \begin_layout Plain Layout
19454
19455 \change_inserted 564990737 1672138150
19456 \begin_inset ERT
19457 status collapsed
19458
19459 \begin_layout Plain Layout
19460
19461 \change_inserted 564990737 1672138150
19462
19463 label=
19464 \backslash
19465 emph{
19466 \backslash
19467 roman{enumiv})}
19468 \end_layout
19469
19470 \end_inset
19471
19472
19473 \change_unchanged
19474
19475 \end_layout
19476
19477 \end_inset
19478
19479 Level 4
19480 \end_layout
19481
19482 \end_deeper
19483 \end_deeper
19484 \end_deeper
19485 \begin_layout Standard
19486
19487 \change_inserted 564990737 1672138150
19488 For this list these commands were used:
19489 \end_layout
19490
19491 \begin_layout Standard
19492 \noindent
19493
19494 \change_inserted 564990737 1672138150
19495
19496 \family sans
19497 label=
19498 \backslash
19499 #
19500 \backslash
19501 Alph{enumi}
19502 \backslash
19503 #
19504 \begin_inset Newline newline
19505 \end_inset
19506
19507 label=
19508 \backslash
19509 Alph{enumi}.
19510 \backslash
19511 arabic{enumii}
19512 \begin_inset Newline newline
19513 \end_inset
19514
19515 label=
19516 \change_deleted 274215730 1672889037
19517
19518 \backslash
19519 bf
19520 \change_inserted 274215730 1672889037
19521
19522 \backslash
19523 bfseries
19524 \change_inserted 564990737 1672138150
19525 {
19526 \backslash
19527 arabic{enumiii}}
19528 \begin_inset Newline newline
19529 \end_inset
19530
19531 label=
19532 \backslash
19533 emph{
19534 \backslash
19535 roman{enumiv})}
19536 \end_layout
19537
19538 \begin_layout Standard
19539
19540 \change_inserted 564990737 1672138150
19541 where the command
19542 \family sans
19543
19544 \backslash
19545 emph{}
19546 \family default
19547  makes the label emphasized and
19548 \change_deleted 274215730 1672889045
19549
19550 \family sans
19551
19552 \backslash
19553 bf{}
19554 \change_inserted 274215730 1672889046
19555
19556 \backslash
19557 bfseries{}
19558 \change_inserted 564990737 1672138150
19559
19560 \family default
19561  makes it bold.
19562 \end_layout
19563
19564 \begin_layout Standard
19565
19566 \change_inserted 564990737 1672138150
19567 \begin_inset Note Greyedout
19568 status collapsed
19569
19570 \begin_layout Plain Layout
19571
19572 \change_inserted 564990737 1672138150
19573
19574 \series bold
19575 Note:
19576
19577 \series default
19578  When you change the label of a list level,
19579  it will be used for all following lists until you change the definition.
19580 \end_layout
19581
19582 \end_inset
19583
19584
19585 \end_layout
19586
19587 \begin_layout Standard
19588
19589 \change_inserted 564990737 1672138150
19590 \begin_inset ERT
19591 status open
19592
19593 \begin_layout Plain Layout
19594
19595 \change_inserted 564990737 1672138150
19596
19597
19598 \backslash
19599 renewcommand{
19600 \backslash
19601 labelenumi}{
19602 \backslash
19603 thesection.
19604 \backslash
19605 arabic{enumi}}
19606 \end_layout
19607
19608 \end_inset
19609
19610
19611 \end_layout
19612
19613 \begin_layout Subsubsection
19614
19615 \change_inserted 564990737 1672138150
19616 Numbered Paragraphs in Reports
19617 \end_layout
19618
19619 \begin_layout Enumerate
19620
19621 \change_inserted 564990737 1672138213
19622 Official reports often include numbered paragraphs;
19623  you can achieve this with a variation on the approach outlined in
19624 \change_deleted -712698321 1674916429
19625 the
19626 \change_inserted 564990737 1672138213
19627
19628 \change_deleted -712698321 1674916431
19629 footnote
19630 \change_inserted -712698321 1674916432
19631 section
19632 \change_inserted 564990737 1672138213
19633
19634 \begin_inset space ~
19635 \end_inset
19636
19637
19638 \change_inserted -712698321 1674916425
19639
19640 \begin_inset CommandInset ref
19641 LatexCommand ref
19642 reference "sec:How-to-use"
19643
19644 \end_inset
19645
19646
19647 \change_deleted -712698321 1674916426
19648
19649 \begin_inset CommandInset ref
19650 LatexCommand ref
19651 reference "fn:If-you-really"
19652 plural "false"
19653 caps "false"
19654 noprefix "false"
19655 nolink "false"
19656
19657 \end_inset
19658
19659
19660 \change_inserted 564990737 1672138213
19661 .
19662  Replace
19663 \family sans
19664 item
19665 \family default
19666  in each command with
19667 \family sans
19668 enum
19669 \family default
19670 .
19671 \end_layout
19672
19673 \begin_layout Enumerate
19674
19675 \change_inserted 564990737 1672138150
19676 These numbered paragraphs were generated by inserting the \SpecialChar TeX
19677  Code
19678 \begin_inset Separator latexpar
19679 \end_inset
19680
19681
19682 \end_layout
19683
19684 \begin_deeper
19685 \begin_layout Standard
19686
19687 \change_inserted 564990737 1672138150
19688
19689 \family sans
19690
19691 \backslash
19692 renewcommand{
19693 \backslash
19694 labelenumi}{
19695 \backslash
19696 thesection.
19697 \backslash
19698 arabic{enumi}}
19699 \end_layout
19700
19701 \begin_layout Standard
19702
19703 \change_inserted 564990737 1672138150
19704 before the start of the section;
19705
19706 \family sans
19707
19708 \backslash
19709 thesection
19710 \family default
19711  uses the \SpecialChar LaTeX
19712  section counter to generate the first part of the number.
19713 \end_layout
19714
19715 \end_deeper
19716 \begin_layout Enumerate
19717
19718 \change_inserted 564990737 1672138150
19719 I have ignored the subsection heading in this example because,
19720  with paragraphs numbered in this way,
19721  subsections are less likely to be used.
19722 \end_layout
19723
19724 \begin_layout Subsubsection
19725
19726 \change_inserted 564990737 1672138150
19727 Resumed Enumeration
19728 \end_layout
19729
19730 \begin_layout Standard
19731
19732 \change_inserted 564990737 1672138150
19733 \begin_inset ERT
19734 status open
19735
19736 \begin_layout Plain Layout
19737
19738 \change_inserted 564990737 1672138150
19739
19740
19741 \backslash
19742 renewcommand{
19743 \backslash
19744 labelenumi}{
19745 \backslash
19746 arabic{enumi}}
19747 \end_layout
19748
19749 \end_inset
19750
19751
19752 \end_layout
19753
19754 \begin_layout Standard
19755
19756 \change_inserted 564990737 1672138150
19757 Enumerations can be resumed after intermediate paragraphs:
19758 \end_layout
19759
19760 \begin_layout Enumerate
19761
19762 \change_inserted 564990737 1672138150
19763 \begin_inset Argument 1
19764 status collapsed
19765
19766 \begin_layout Plain Layout
19767
19768 \change_inserted 564990737 1672138150
19769 \begin_inset ERT
19770 status collapsed
19771
19772 \begin_layout Plain Layout
19773
19774 \change_inserted 564990737 1672138150
19775
19776 label=
19777 \backslash
19778 arabic{enumi}.
19779 \end_layout
19780
19781 \end_inset
19782
19783
19784 \change_unchanged
19785
19786 \end_layout
19787
19788 \end_inset
19789
19790 first
19791 \begin_inset Note Note
19792 status collapsed
19793
19794 \begin_layout Plain Layout
19795
19796 \change_inserted 564990737 1672138150
19797 goes back to default numbering
19798 \end_layout
19799
19800 \end_inset
19801
19802
19803 \end_layout
19804
19805 \begin_layout Enumerate
19806
19807 \change_inserted 564990737 1672138150
19808 second
19809 \end_layout
19810
19811 \begin_layout Standard
19812
19813 \change_inserted 564990737 1672138150
19814 regular text
19815 \end_layout
19816
19817 \begin_layout Enumerate-Resume
19818
19819 \change_inserted 564990737 1672138150
19820 resumed
19821 \end_layout
19822
19823 \begin_layout Standard
19824
19825 \change_inserted 564990737 1672138150
19826 To resume an enumeration,
19827  use the style
19828 \family sans
19829 Enumerate-Resume
19830 \family default
19831 .
19832
19833 \change_deleted -712698321 1673882803
19834  Its numbering appears in blue within \SpecialChar LyX
19835  to indicate that it is a resumed list and that the numbering will not be correct in \SpecialChar LyX
19836 ,
19837  but in the output.
19838 \change_inserted 564990737 1672138150
19839
19840 \end_layout
19841
19842 \begin_layout Standard
19843
19844 \change_inserted 564990737 1672138150
19845 \begin_inset Note Greyedout
19846 status open
19847
19848 \begin_layout Plain Layout
19849
19850 \change_inserted 564990737 1672138150
19851
19852 \series bold
19853 Note:
19854
19855 \series default
19856  If there is no previous enumeration to resume,
19857  you will get a \SpecialChar LaTeX
19858  error.
19859 \end_layout
19860
19861 \end_inset
19862
19863
19864 \end_layout
19865
19866 \begin_layout Standard
19867
19868 \change_inserted 564990737 1672138150
19869 Perhaps you might want to resume the list with a different number from the next one.
19870  Or you want to start a new enumeration with a defined number.
19871  This is possible by adding an optional argument to the first list item of a normal enumeration.
19872  There,
19873  insert the command
19874 \end_layout
19875
19876 \begin_layout Standard
19877
19878 \change_inserted 564990737 1672138150
19879
19880 \family sans
19881 start=number
19882 \end_layout
19883
19884 \begin_layout Standard
19885
19886 \change_inserted 564990737 1672138150
19887 where
19888 \family sans
19889 number
19890 \family default
19891  is the number with which you want to resume the list.
19892  An example:
19893 \end_layout
19894
19895 \begin_layout Enumerate
19896
19897 \change_inserted 564990737 1672138150
19898 first item
19899 \end_layout
19900
19901 \begin_layout Enumerate
19902
19903 \change_inserted 564990737 1672138150
19904 second item
19905 \end_layout
19906
19907 \begin_layout Standard
19908
19909 \change_inserted 564990737 1672138150
19910 Enumeration starting at a given value:
19911 \end_layout
19912
19913 \begin_layout Enumerate
19914
19915 \change_inserted 564990737 1672138150
19916 \begin_inset Argument 1
19917 status open
19918
19919 \begin_layout Plain Layout
19920
19921 \change_inserted 564990737 1672138150
19922 \begin_inset ERT
19923 status collapsed
19924
19925 \begin_layout Plain Layout
19926
19927 \change_inserted 564990737 1672138150
19928
19929 start=4
19930 \end_layout
19931
19932 \end_inset
19933
19934
19935 \change_unchanged
19936
19937 \end_layout
19938
19939 \end_inset
19940
19941 This enumeration starts at 4
19942 \end_layout
19943
19944 \begin_layout Subsubsection
19945
19946 \change_inserted 564990737 1672138150
19947 List Spacing
19948 \begin_inset Index idx
19949 range none
19950 pageformat default
19951 status collapsed
19952
19953 \begin_layout Plain Layout
19954
19955 \change_inserted 564990737 1672138150
19956 Lists !
19957  Spacing
19958 \change_unchanged
19959
19960 \end_layout
19961
19962 \end_inset
19963
19964
19965 \end_layout
19966
19967 \begin_layout Standard
19968
19969 \change_inserted 564990737 1672138150
19970 In some cases you might want less or more vertical space between the items of a list.
19971  For example if the default space is too much in your opinion in this case:
19972 \end_layout
19973
19974 \begin_layout Itemize
19975
19976 \change_inserted 564990737 1672138150
19977 A bullet list
19978 \end_layout
19979
19980 \begin_layout Itemize
19981
19982 \change_inserted 564990737 1672138150
19983 with standard spacing
19984 \end_layout
19985
19986 \begin_layout Standard
19987
19988 \change_inserted 564990737 1672138150
19989 You can decrease the space by adding an optional argument to the first item of the list.
19990  Add there the command
19991 \family sans
19992 nolistsep
19993 \family default
19994  to get no additional list space like in this example:
19995 \end_layout
19996
19997 \begin_layout Itemize
19998
19999 \change_inserted 564990737 1672138150
20000 \begin_inset Argument 1
20001 status open
20002
20003 \begin_layout Plain Layout
20004
20005 \change_inserted 564990737 1672138150
20006 \begin_inset ERT
20007 status collapsed
20008
20009 \begin_layout Plain Layout
20010
20011 \change_inserted 564990737 1672138150
20012
20013 nolistsep
20014 \end_layout
20015
20016 \end_inset
20017
20018
20019 \change_unchanged
20020
20021 \end_layout
20022
20023 \end_inset
20024
20025 A bullet list
20026 \end_layout
20027
20028 \begin_layout Itemize
20029
20030 \change_inserted 564990737 1672138150
20031 without additional
20032 \end_layout
20033
20034 \begin_layout Itemize
20035
20036 \change_inserted 564990737 1672138150
20037 vertical space
20038 \end_layout
20039
20040 \begin_layout Standard
20041
20042 \change_inserted 564990737 1672138150
20043 To add space you can use several other commands provided by the
20044 \family sans
20045 enumitem
20046 \family default
20047
20048 \begin_inset Index idx
20049 range none
20050 pageformat default
20051 status collapsed
20052
20053 \begin_layout Plain Layout
20054
20055 \change_inserted 564990737 1672138150
20056 \SpecialChar LaTeX
20057 -packages !
20058  enumitem
20059 \change_unchanged
20060
20061 \end_layout
20062
20063 \end_inset
20064
20065  package.
20066  For more information see the
20067 \begin_inset CommandInset href
20068 LatexCommand href
20069 name "enumitem documentation"
20070 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
20071 literal "false"
20072
20073 \end_inset
20074
20075 .
20076 \end_layout
20077
20078 \begin_layout Standard
20079
20080 \change_inserted 564990737 1672138150
20081 There are also many commands available to change the horizontal spacing and indentation.
20082  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
20083 \begin_inset space \thinspace{}
20084 \end_inset
20085
20086 cm so that the number is in the page margin:
20087 \end_layout
20088
20089 \begin_layout Enumerate
20090
20091 \change_inserted 564990737 1672138150
20092 \begin_inset Argument 1
20093 status open
20094
20095 \begin_layout Plain Layout
20096
20097 \change_inserted 564990737 1672138150
20098 \begin_inset ERT
20099 status collapsed
20100
20101 \begin_layout Plain Layout
20102
20103 \change_inserted 564990737 1672138150
20104
20105 labelindent=
20106 \backslash
20107 parindent,
20108  labelsep=2cm
20109 \end_layout
20110
20111 \end_inset
20112
20113
20114 \change_unchanged
20115
20116 \end_layout
20117
20118 \end_inset
20119
20120 An enumeration
20121 \end_layout
20122
20123 \begin_layout Enumerate
20124
20125 \change_inserted 564990737 1672138150
20126 with negative indentation
20127 \end_layout
20128
20129 \begin_layout Subsubsection
20130
20131 \change_inserted 564990737 1672138150
20132 Further Customization
20133 \begin_inset Index idx
20134 range none
20135 pageformat default
20136 status collapsed
20137
20138 \begin_layout Plain Layout
20139
20140 \change_inserted 564990737 1672138150
20141 Lists !
20142  Customization
20143 \change_unchanged
20144
20145 \end_layout
20146
20147 \end_inset
20148
20149
20150 \end_layout
20151
20152 \begin_layout Standard
20153
20154 \change_inserted 564990737 1672138150
20155 You can also change the style of description lists.
20156  The command
20157 \end_layout
20158
20159 \begin_layout Standard
20160
20161 \change_inserted 564990737 1672138150
20162
20163 \family sans
20164 font=definition
20165 \end_layout
20166
20167 \begin_layout Standard
20168
20169 \change_inserted 564990737 1672138150
20170 changes the description label font,
20171  the command
20172 \end_layout
20173
20174 \begin_layout Standard
20175
20176 \change_inserted 564990737 1672138150
20177
20178 \family sans
20179 style=definitio
20180 \family default
20181 \series bold
20182 n
20183 \end_layout
20184
20185 \begin_layout Standard
20186
20187 \change_inserted 564990737 1672138150
20188 sets the list style.
20189 \end_layout
20190
20191 \begin_layout Standard
20192
20193 \change_inserted 564990737 1672138150
20194 An example where the command
20195 \end_layout
20196
20197 \begin_layout Standard
20198
20199 \change_inserted 564990737 1672138150
20200
20201 \family sans
20202 font=
20203 \backslash
20204 itshape,
20205  style=nextline
20206 \end_layout
20207
20208 \begin_layout Standard
20209
20210 \change_inserted 564990737 1672138150
20211 is used:
20212 \end_layout
20213
20214 \begin_layout Description
20215
20216 \change_inserted 564990737 1672138150
20217 Ionizing
20218 \begin_inset space ~
20219 \end_inset
20220
20221 radiation:
20222
20223 \begin_inset Argument 1
20224 status collapsed
20225
20226 \begin_layout Plain Layout
20227
20228 \change_inserted 564990737 1672138150
20229 \begin_inset ERT
20230 status collapsed
20231
20232 \begin_layout Plain Layout
20233
20234 \change_inserted 564990737 1672138150
20235
20236 labelindent=0pt,
20237  labelsep=1cm,
20238  font=
20239 \backslash
20240 itshape,
20241  style=nextline
20242 \end_layout
20243
20244 \end_inset
20245
20246
20247 \change_unchanged
20248
20249 \end_layout
20250
20251 \end_inset
20252
20253 Ionizing radiation consists of particles or electromagnetic waves that are energetic enough to detach electrons from atoms or molecules,
20254  therefore ionizing them.
20255 \end_layout
20256
20257 \begin_layout Description
20258
20259 \change_inserted 564990737 1672138150
20260 Reference
20261 \begin_inset space ~
20262 \end_inset
20263
20264 counting:
20265  In computer science,
20266  reference counting is a technique of storing the number of references,
20267  pointers,
20268  or handles to a resource such as an object,
20269  block of memory,
20270  disk space or other resource.
20271 \end_layout
20272
20273 \begin_layout Standard
20274
20275 \change_inserted 564990737 1672138150
20276 There are many more commands and features provided by the
20277 \family sans
20278 enumitem
20279 \family default
20280
20281 \begin_inset Index idx
20282 range none
20283 pageformat default
20284 status collapsed
20285
20286 \begin_layout Plain Layout
20287
20288 \change_inserted 564990737 1672138150
20289 \SpecialChar LaTeX
20290 -packages !
20291  enumitem
20292 \change_unchanged
20293
20294 \end_layout
20295
20296 \end_inset
20297
20298  package.
20299  For more information see the
20300 \begin_inset CommandInset href
20301 LatexCommand href
20302 name "enumitem documentation"
20303 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
20304 literal "false"
20305
20306 \end_inset
20307
20308 .
20309 \end_layout
20310
20311 \begin_layout Subsection
20312
20313 \change_inserted 564990737 1672138150
20314
20315 \series bold
20316 Paragraph Lists
20317 \end_layout
20318
20319 \begin_layout Standard
20320
20321 \change_inserted 564990737 1672138150
20322 This module uses the package
20323 \family sans
20324 paralist
20325 \family default
20326  to provide nine new list environments.
20327  Itemized and enumerated lists can be typeset within paragraphs,
20328  as paragraphs and in a compact version.
20329  Most environments have optional arguments to format the labels.
20330  Additionally,
20331  the \SpecialChar LaTeX
20332  list environments itemize and enumerate are extended to use a similar optional argument.
20333  For further details see
20334 \family sans
20335 File\SpecialChar menuseparator
20336 Open Example\SpecialChar menuseparator
20337 Modules\SpecialChar menuseparator
20338 Paragraph Lists (paralist)
20339 \family default
20340 ,
20341
20342 \family sans
20343 Help\SpecialChar menuseparator
20344 Specific Manuals\SpecialChar menuseparator
20345 Paralist
20346 \family default
20347  and the
20348 \begin_inset CommandInset href
20349 LatexCommand href
20350 name "paralist documentation"
20351 target "http://mirrors.ctan.org/macros/latex/contrib/paralist/paralist.pdf"
20352 literal "false"
20353
20354 \end_inset
20355
20356 .
20357 \end_layout
20358
20359 \begin_layout Section
20360
20361 \change_inserted 564990737 1672161542
20362 Literate Programming
20363 \change_deleted -712698321 1673885680
20364
20365 \change_inserted 564990737 1672161542
20366
20367 \end_layout
20368
20369 \begin_layout Subsection
20370
20371 \change_inserted 564990737 1672161542
20372 Noweb
20373 \end_layout
20374
20375 \begin_layout Standard
20376
20377 \change_inserted 564990737 1672161542
20378 This module allows the use of Noweb as a literate programming tool.
20379  The files and the documentation for Noweb can be obtained from
20380 \begin_inset CommandInset href
20381 LatexCommand href
20382 name "CTAN"
20383 target "https://www.ctan.org/pkg/noweb"
20384 literal "false"
20385
20386 \end_inset
20387
20388 .
20389  Literate programming is described in section
20390 \begin_inset space ~
20391 \end_inset
20392
20393
20394 \begin_inset CommandInset ref
20395 LatexCommand ref
20396 reference "sec:Literate-Programming"
20397 nolink "false"
20398
20399 \end_inset
20400
20401  and there are three example files:
20402
20403 \family sans
20404 File\SpecialChar menuseparator
20405 Open Example\SpecialChar menuseparator
20406 Modules\SpecialChar menuseparator
20407 Noweb
20408 \family default
20409 ,
20410
20411 \family sans
20412 File\SpecialChar menuseparator
20413 Open Example\SpecialChar menuseparator
20414 Modules\SpecialChar menuseparator
20415 Noweb Listerrors
20416 \family default
20417  and
20418 \family sans
20419 File\SpecialChar menuseparator
20420 Open Example\SpecialChar menuseparator
20421 Modules\SpecialChar menuseparator
20422 Noweb2\SpecialChar LyX
20423
20424 \family default
20425 .
20426 \end_layout
20427
20428 \begin_layout Subsection
20429
20430 \change_inserted 564990737 1672161542
20431 Rnw (knitr)
20432 \end_layout
20433
20434 \begin_layout Standard
20435
20436 \change_inserted 564990737 1672161542
20437 This module uses the
20438 \family typewriter
20439 knitr
20440 \family default
20441  and
20442 \family sans
20443 includernw
20444 \family default
20445  packages.
20446  The
20447 \begin_inset Flex Code
20448 status collapsed
20449
20450 \begin_layout Plain Layout
20451
20452 \change_inserted 564990737 1672161542
20453 knitr
20454 \change_unchanged
20455
20456 \end_layout
20457
20458 \end_inset
20459
20460  package in R for dynamic report generation has to be installed for this module to work:
20461
20462 \begin_inset Flex Code
20463 status collapsed
20464
20465 \begin_layout Plain Layout
20466
20467 \change_inserted 564990737 1672161542
20468 install.packages(“knitr”)
20469 \change_unchanged
20470
20471 \end_layout
20472
20473 \end_inset
20474
20475 .
20476
20477 \end_layout
20478
20479 \begin_layout Paragraph
20480
20481 \change_inserted 564990737 1672161542
20482 Note
20483 \end_layout
20484
20485 \begin_layout Itemize
20486
20487 \change_inserted 564990737 1672161542
20488 it depends on R >= 2.14.1.
20489  For more info see
20490 \begin_inset Flex URL
20491 status collapsed
20492
20493 \begin_layout Plain Layout
20494
20495 \change_inserted 564990737 1672161542
20496
20497 http://yihui.name/knitr
20498 \change_unchanged
20499
20500 \end_layout
20501
20502 \end_inset
20503
20504 .
20505
20506 \change_deleted -712698321 1673886383
20507
20508 \change_inserted 564990737 1672161542
20509
20510 \end_layout
20511
20512 \begin_layout Itemize
20513
20514 \change_inserted 564990737 1672161542
20515 The package
20516 \family sans
20517 includernw
20518 \family default
20519  also has to be installed.
20520
20521 \change_inserted -712698321 1673886396
20522
20523 \end_layout
20524
20525 \begin_layout Itemize
20526
20527 \change_inserted 564990737 1672161542
20528 It cannot be used if the modules
20529 \family sans
20530 LilyPond
20531 \begin_inset space ~
20532 \end_inset
20533
20534 Book
20535 \family default
20536  or
20537 \family sans
20538 Sweave
20539 \family default
20540  are loaded.
20541
20542 \change_deleted -712698321 1673886383
20543
20544 \change_inserted -712698321 1673886376
20545
20546 \end_layout
20547
20548 \begin_layout Standard
20549
20550 \change_inserted 564990737 1672161542
20551 See
20552 \family sans
20553 Help\SpecialChar menuseparator
20554 Specific Manuals\SpecialChar menuseparator
20555 Knitr
20556 \family default
20557 ,
20558
20559 \family sans
20560 File\SpecialChar menuseparator
20561 Open Example\SpecialChar menuseparator
20562 Modules\SpecialChar menuseparator
20563 Rnw (knitr)
20564 \family default
20565  and section
20566 \begin_inset space ~
20567 \end_inset
20568
20569
20570 \begin_inset CommandInset ref
20571 LatexCommand ref
20572 reference "sec:Literate-Programming"
20573 nolink "false"
20574
20575 \end_inset
20576
20577  for information about literate programming.
20578 \end_layout
20579
20580 \begin_layout Subsection
20581
20582 \change_inserted 564990737 1672161542
20583 Sweave
20584 \end_layout
20585
20586 \begin_layout Standard
20587
20588 \change_inserted 564990737 1672161542
20589 This module allows the use of the statistical language S/R as a literate programming tool.
20590  It requires the
20591 \family sans
20592 includernw
20593 \family default
20594  and
20595 \family sans
20596 fancyvrb
20597 \family default
20598  packages.
20599  Both
20600 \begin_inset CommandInset href
20601 LatexCommand href
20602 name "includernw"
20603 target "https://www.ctan.org/pkg/includernw"
20604 literal "false"
20605
20606 \end_inset
20607
20608  and
20609 \begin_inset CommandInset href
20610 LatexCommand href
20611 name "fancyvrb"
20612 target "https://www.ctan.org/pkg/fancyvrb"
20613 literal "false"
20614
20615 \end_inset
20616
20617  are available from CTAN.
20618  It cannot be used if the module
20619 \family sans
20620 LilyPond
20621 \begin_inset space ~
20622 \end_inset
20623
20624 Book
20625 \family default
20626  has been loaded.
20627  See
20628 \family sans
20629 Help\SpecialChar menuseparator
20630 Specific Manuals\SpecialChar menuseparator
20631 Sweave,
20632
20633 \family default
20634
20635 \family sans
20636 File\SpecialChar menuseparator
20637 Open Example\SpecialChar menuseparator
20638 Modules\SpecialChar menuseparator
20639 Sweave
20640 \family default
20641  and section
20642 \begin_inset space ~
20643 \end_inset
20644
20645
20646 \begin_inset CommandInset ref
20647 LatexCommand ref
20648 reference "sec:Literate-Programming"
20649 nolink "false"
20650
20651 \end_inset
20652
20653  for information about literate programming.
20654 \end_layout
20655
20656 \begin_layout Section
20657
20658 \change_inserted 564990737 1672224959
20659 Maths
20660 \end_layout
20661
20662 \begin_layout Subsection
20663
20664 \change_inserted 564990737 1672224959
20665 AMS Theorems
20666 \end_layout
20667
20668 \begin_layout Standard
20669
20670 \change_inserted 564990737 1672224959
20671 This modules defines theorem environments and the proof environment using the extended AMS machinery.
20672  Both numbered and unnumbered types are provided.
20673  By default,
20674  the theorems are numbered consecutively throughout the document.
20675  This can be changed by loading one of the
20676 \family sans
20677 AMS Theorems (Numbered by \SpecialChar ldots
20678 )
20679 \family default
20680  modules.
20681  It cannot be used if the modules
20682 \family sans
20683 Standard Theorems
20684 \family default
20685  or
20686 \family sans
20687 Standard Theorems (Unnumbered)
20688 \family default
20689  have been loaded.
20690 \end_layout
20691
20692 \begin_layout Subsection
20693
20694 \change_inserted 564990737 1672224959
20695 AMS Theorems (Extended)
20696 \end_layout
20697
20698 \begin_layout Standard
20699
20700 \change_inserted 564990737 1672224959
20701 This module defines some additional theorem environments for use with the
20702 \family sans
20703 AMS Theorems
20704 \family default
20705  package (which must be loaded).
20706  It includes
20707 \family sans
20708 Criterion
20709 \family default
20710 ,
20711
20712 \family sans
20713 Algorithm
20714 \family default
20715 ,
20716
20717 \family sans
20718 Axiom
20719 \family default
20720 ,
20721
20722 \family sans
20723 Condition
20724 \family default
20725 ,
20726
20727 \family sans
20728 Note
20729 \family default
20730 ,
20731
20732 \family sans
20733 Notation
20734 \family default
20735 ,
20736
20737 \family sans
20738 Summary
20739 \family default
20740 ,
20741
20742 \change_deleted -712698321 1675594790
20743
20744 \family sans
20745 Acknowledgement
20746 \family default
20747 ,
20748
20749 \change_inserted 564990737 1672224959
20750
20751 \family sans
20752 Conclusion
20753 \family default
20754 ,
20755
20756 \family sans
20757 Fact
20758 \family default
20759 ,
20760
20761 \family sans
20762 Assumption
20763 \family default
20764 ,
20765
20766 \family sans
20767 Case
20768 \family default
20769  and
20770 \family sans
20771 Question
20772 \family default
20773  in both numbered and unnumbered forms.
20774 \end_layout
20775
20776 \begin_layout Subsection
20777
20778 \change_inserted 564990737 1672224959
20779 AMS Theorems (Extended,
20780  Numbered by Type within Chapters)
20781 \end_layout
20782
20783 \begin_layout Standard
20784
20785 \change_inserted 564990737 1672224959
20786 This module defines some additional theorem environments for use with the
20787 \family sans
20788 AMS Theorems (Numbered by Type within Chapters)
20789 \family default
20790
20791 \change_deleted -712698321 1674898102
20792 package
20793 \change_inserted -712698321 1674898103
20794 module
20795 \change_inserted 564990737 1672224959
20796  (which must be loaded).
20797  It includes
20798 \family sans
20799 Criterion
20800 \family default
20801 ,
20802
20803 \family sans
20804 Algorithm
20805 \family default
20806 ,
20807
20808 \family sans
20809 Axiom
20810 \family default
20811 ,
20812
20813 \family sans
20814 Condition
20815 \family default
20816 ,
20817
20818 \family sans
20819 Note
20820 \family default
20821 ,
20822
20823 \family sans
20824 Notation
20825 \family default
20826 ,
20827
20828 \family sans
20829 Summary
20830 \family default
20831 ,
20832
20833 \change_deleted -712698321 1675594800
20834
20835 \family sans
20836 Acknowledgement
20837 \family default
20838 ,
20839
20840 \change_inserted 564990737 1672224959
20841
20842 \family sans
20843 Conclusion
20844 \family default
20845 ,
20846
20847 \family sans
20848 Assumption
20849 \family default
20850  and
20851 \family sans
20852 Case
20853 \family default
20854  in both numbered and unnumbered forms.
20855
20856 \change_inserted -712698321 1674898226
20857
20858 \end_layout
20859
20860 \begin_layout Standard
20861
20862 \change_inserted 564990737 1672224959
20863 Unlike the
20864 \family sans
20865 AMS Theorems (Extended)
20866 \family default
20867  module,
20868  the different theorem types provided here each have a separate counter,
20869  restarted with each new chapter (e.g.,
20870
20871 \change_deleted -712698321 1674898319
20872
20873 \emph on
20874 c
20875 \change_inserted -712698321 1674898319
20876 C
20877 \change_inserted 564990737 1672224959
20878 riterion 1.1
20879 \emph default
20880 ,
20881
20882 \change_deleted -712698321 1674898320
20883
20884 \emph on
20885 c
20886 \change_inserted -712698321 1674898321
20887 C
20888 \change_inserted 564990737 1672224959
20889 riterion 1.2
20890 \emph default
20891 ,
20892
20893 \change_deleted -712698321 1674898322
20894
20895 \emph on
20896 a
20897 \change_inserted -712698321 1674898322
20898 A
20899 \change_inserted 564990737 1672224959
20900 xiom 1.1
20901 \emph default
20902 ,
20903
20904 \change_deleted -712698321 1674898325
20905
20906 \emph on
20907 a
20908 \change_inserted -712698321 1674898325
20909 A
20910 \change_inserted 564990737 1672224959
20911 ssumption 1.1
20912 \emph default
20913 ,
20914
20915 \change_deleted -712698321 1674898327
20916
20917 \emph on
20918 c
20919 \change_inserted -712698321 1674898327
20920 C
20921 \change_inserted 564990737 1672224959
20922 riterion 2.1
20923 \emph default
20924 ,
20925
20926 \change_deleted -712698321 1674898329
20927
20928 \emph on
20929 c
20930 \change_inserted -712698321 1674898329
20931 C
20932 \change_inserted 564990737 1672224959
20933 riterion 2.2
20934 \emph default
20935 ,
20936
20937 \emph on
20938
20939 \change_deleted -712698321 1674898339
20940 a
20941 \change_inserted -712698321 1674898339
20942 A
20943 \change_inserted 564990737 1672224959
20944 xiom 2.1
20945 \change_inserted -712698321 1674898336
20946
20947 \emph default
20948 ,
20949
20950 \change_inserted 564990737 1672224959
20951 \SpecialChar ldots
20952 ,
20953  as opposed to
20954 \change_deleted -712698321 1674898342
20955 c
20956 \change_inserted -712698321 1674898342
20957
20958 \emph on
20959 C
20960 \change_inserted 564990737 1672224959
20961 riterion 1
20962 \emph default
20963 ,
20964
20965 \change_deleted -712698321 1674898344
20966 c
20967 \change_inserted -712698321 1674898344
20968
20969 \emph on
20970 C
20971 \change_inserted 564990737 1672224959
20972 riterion 2
20973 \emph default
20974 ,
20975
20976 \change_deleted -712698321 1674898346
20977 a
20978 \change_inserted -712698321 1674898347
20979
20980 \emph on
20981 A
20982 \change_inserted 564990737 1672224959
20983 xiom 3
20984 \emph default
20985 ,
20986
20987 \change_deleted -712698321 1674898348
20988 a
20989 \change_inserted -712698321 1674898348
20990
20991 \emph on
20992 A
20993 \change_inserted 564990737 1672224959
20994 ssumption 4
20995 \change_inserted -712698321 1674898350
20996
20997 \emph default
20998 ,
20999
21000 \change_deleted -712698321 1674898352
21001 ...
21002 \change_inserted -712698321 1674898353
21003 \SpecialChar ldots
21004
21005 \change_inserted 564990737 1672224959
21006 ).
21007 \end_layout
21008
21009 \begin_layout Subsection
21010
21011 \change_inserted 564990737 1672224959
21012 AMS Theorems (Extended,
21013  Numbered by Type)
21014 \end_layout
21015
21016 \begin_layout Standard
21017
21018 \change_inserted 564990737 1672224959
21019 This module defines some additional theorem environments for use with the
21020 \family sans
21021 AMS Theorems (Numbered by Type)
21022 \family default
21023  package (which must be loaded).
21024  It includes
21025 \family sans
21026 Criterion
21027 \family default
21028 ,
21029
21030 \family sans
21031 Algorithm
21032 \family default
21033 ,
21034
21035 \family sans
21036 Axiom
21037 \family default
21038 ,
21039
21040 \family sans
21041 Condition
21042 \family default
21043 ,
21044
21045 \family sans
21046 Note
21047 \family default
21048 ,
21049
21050 \family sans
21051 Notation
21052 \family default
21053 ,
21054
21055 \family sans
21056 Summary
21057 \family default
21058 ,
21059
21060 \change_deleted -712698321 1675594806
21061
21062 \family sans
21063 Acknowledgement
21064 \family default
21065 ,
21066
21067 \change_inserted 564990737 1672224959
21068
21069 \family sans
21070 Conclusion
21071 \family default
21072 ,
21073
21074 \family sans
21075 Assumption
21076 \family default
21077  and
21078 \family sans
21079 Case
21080 \family default
21081  in both numbered and unnumbered forms.
21082
21083 \change_inserted -712698321 1674898455
21084
21085 \end_layout
21086
21087 \begin_layout Standard
21088
21089 \change_inserted 564990737 1672224959
21090 Unlike the
21091 \family sans
21092 AMS Theorems (Extended)
21093 \family default
21094  module,
21095  the different theorem types provided here each have a separate counter (e.g.,
21096
21097 \change_deleted -712698321 1674898821
21098 c
21099 \change_inserted -712698321 1674898821
21100
21101 \emph on
21102 C
21103 \change_inserted 564990737 1672224959
21104 riterion 1
21105 \emph default
21106 ,
21107
21108 \change_deleted -712698321 1674898823
21109 c
21110 \change_inserted -712698321 1674898823
21111
21112 \emph on
21113 C
21114 \change_inserted 564990737 1672224959
21115 riterion 2
21116 \emph default
21117 ,
21118
21119 \change_deleted -712698321 1674898825
21120 a
21121 \change_inserted -712698321 1674898825
21122
21123 \emph on
21124 A
21125 \change_inserted 564990737 1672224959
21126 xiom 1
21127 \emph default
21128 ,
21129
21130 \change_deleted -712698321 1674898827
21131 a
21132 \change_inserted -712698321 1674898827
21133
21134 \emph on
21135 A
21136 \change_inserted 564990737 1672224959
21137 ssumption 1
21138 \emph default
21139 ,
21140
21141 \change_deleted -712698321 1674898830
21142 c
21143 \change_inserted -712698321 1674898830
21144
21145 \emph on
21146 C
21147 \change_inserted 564990737 1672224959
21148 riterion 3
21149 \emph default
21150 ,
21151  \SpecialChar ldots
21152 ,
21153  as opposed to
21154 \change_deleted -712698321 1674898832
21155 c
21156 \change_inserted -712698321 1674898832
21157
21158 \emph on
21159 C
21160 \change_inserted 564990737 1672224959
21161 riterion 1
21162 \emph default
21163 ,
21164
21165 \change_deleted -712698321 1674898834
21166 c
21167 \change_inserted -712698321 1674898834
21168
21169 \emph on
21170 C
21171 \change_inserted 564990737 1672224959
21172 riterion 2
21173 \emph default
21174 ,
21175
21176 \change_deleted -712698321 1674898836
21177 a
21178 \change_inserted -712698321 1674898836
21179
21180 \emph on
21181 A
21182 \change_inserted 564990737 1672224959
21183 xiom 3
21184 \emph default
21185 ,
21186
21187 \change_deleted -712698321 1674898838
21188 a
21189 \change_inserted -712698321 1674898838
21190
21191 \emph on
21192 A
21193 \change_inserted 564990737 1672224959
21194 ssumption 4
21195 \emph default
21196 ,
21197  \SpecialChar ldots
21198 ).
21199 \end_layout
21200
21201 \begin_layout Subsection
21202
21203 \change_inserted 564990737 1672224959
21204 AMS Theorems (Numbered by Type within Chapters)
21205 \end_layout
21206
21207 \begin_layout Standard
21208
21209 \change_inserted 564990737 1672224959
21210 This module defines theorem environments and the proof environment using the extended AMS machinery.
21211  Both numbered and unnumbered types are provided.
21212
21213 \change_inserted -712698321 1674901718
21214
21215 \end_layout
21216
21217 \begin_layout Standard
21218
21219 \change_inserted 564990737 1672224959
21220 Unlike the
21221 \family sans
21222 AMS Theorems
21223 \family default
21224  module,
21225  the different theorem types provided here each have a separate counter (e.g.,
21226
21227 \change_deleted -712698321 1674901843
21228 t
21229 \change_inserted -712698321 1674901843
21230
21231 \emph on
21232 T
21233 \change_inserted 564990737 1672224959
21234 heorem 1.1
21235 \emph default
21236 ,
21237
21238 \change_deleted -712698321 1674901845
21239 t
21240 \change_inserted -712698321 1674901845
21241
21242 \emph on
21243 T
21244 \change_inserted 564990737 1672224959
21245 heorem 1.2
21246 \emph default
21247 ,
21248
21249 \change_deleted -712698321 1674901847
21250
21251 \emph on
21252 l
21253 \change_inserted -712698321 1674901847
21254 L
21255 \change_inserted 564990737 1672224959
21256 emma 1.1
21257 \emph default
21258 ,
21259
21260 \change_inserted -712698321 1674901849
21261
21262 \emph on
21263 P
21264 \change_deleted -712698321 1674901849
21265 p
21266 \change_inserted 564990737 1672224959
21267 roposition 1.1
21268 \emph default
21269 ,
21270
21271 \change_inserted -712698321 1674901852
21272
21273 \emph on
21274 T
21275 \change_deleted -712698321 1674901852
21276 t
21277 \change_inserted 564990737 1672224959
21278 heorem 1.3
21279 \emph default
21280 ,
21281
21282 \change_inserted -712698321 1674901854
21283
21284 \emph on
21285 L
21286 \change_deleted -712698321 1674901854
21287 l
21288 \change_inserted 564990737 1672224959
21289 emma 1.2
21290 \emph default
21291 ,
21292  \SpecialChar ldots
21293 ,
21294  as opposed to
21295 \change_deleted -712698321 1674901859
21296 t
21297 \change_inserted -712698321 1674901859
21298
21299 \emph on
21300 T
21301 \change_inserted 564990737 1672224959
21302 heorem 1
21303 \emph default
21304 ,
21305
21306 \change_deleted -712698321 1674901861
21307 t
21308 \change_inserted -712698321 1674901861
21309
21310 \emph on
21311 T
21312 \change_inserted 564990737 1672224959
21313 heorem 2
21314 \emph default
21315 ,
21316
21317 \change_deleted -712698321 1674901863
21318 l
21319 \change_inserted -712698321 1674901863
21320
21321 \emph on
21322 L
21323 \change_inserted 564990737 1672224959
21324 emma 3
21325 \emph default
21326 ,
21327
21328 \change_deleted -712698321 1674901868
21329 p
21330 \change_inserted -712698321 1674901868
21331
21332 \emph on
21333 P
21334 \change_inserted 564990737 1672224959
21335 roposition 4
21336 \emph default
21337 ,
21338  \SpecialChar ldots
21339 ).
21340  The numbering restarts for each chapter:
21341
21342 \change_deleted -712698321 1674901871
21343 t
21344 \change_inserted -712698321 1674901871
21345
21346 \emph on
21347 T
21348 \change_inserted 564990737 1672224959
21349 heorem 1.1
21350 \emph default
21351 ,
21352
21353 \change_deleted -712698321 1674901873
21354 t
21355 \change_inserted -712698321 1674901873
21356
21357 \emph on
21358 T
21359 \change_inserted 564990737 1672224959
21360 heorem 2.1
21361 \emph default
21362 ,
21363  \SpecialChar ldots
21364
21365 \change_inserted -712698321 1674901725
21366
21367 \end_layout
21368
21369 \begin_layout Standard
21370
21371 \change_inserted 564990737 1672224959
21372 It cannot be used if the modules
21373 \family sans
21374 AMS Theorems
21375 \family default
21376 ,
21377
21378 \family sans
21379 Standard Theorems
21380 \family default
21381 ,
21382
21383 \family sans
21384  Standard Theorems (Numbered by Type)
21385 \family default
21386  or
21387 \family sans
21388  Standard Theorems (Unnumbered)
21389 \family default
21390  have been loaded.
21391 \end_layout
21392
21393 \begin_layout Subsection
21394
21395 \change_inserted 564990737 1672224959
21396 AMS Theorems (Numbered by Type)
21397 \end_layout
21398
21399 \begin_layout Standard
21400
21401 \change_inserted 564990737 1672224959
21402 This module defines theorem environments and the proof environment using the extended AMS machinery.
21403  Both numbered and unnumbered types are provided.
21404  Unlike the
21405 \family sans
21406 AMS Theorems
21407 \family default
21408  module,
21409  the different theorem types provided here each have a separate counter (e.g.,
21410
21411 \change_deleted -712698321 1674902051
21412 t
21413 \change_inserted -712698321 1674902051
21414
21415 \emph on
21416 T
21417 \change_inserted 564990737 1672224959
21418 heorem 1
21419 \emph default
21420 ,
21421
21422 \change_deleted -712698321 1674902053
21423 t
21424 \change_inserted -712698321 1674902053
21425
21426 \emph on
21427 T
21428 \change_inserted 564990737 1672224959
21429 heorem 2
21430 \emph default
21431 ,
21432
21433 \change_deleted -712698321 1674902055
21434 l
21435 \change_inserted -712698321 1674902055
21436
21437 \emph on
21438 L
21439 \change_inserted 564990737 1672224959
21440 emma 1
21441 \emph default
21442 ,
21443
21444 \change_inserted -712698321 1674902058
21445
21446 \emph on
21447 P
21448 \change_deleted -712698321 1674902058
21449 p
21450 \change_inserted 564990737 1672224959
21451 roposition 1
21452 \emph default
21453 ,
21454
21455 \change_inserted -712698321 1674902061
21456
21457 \emph on
21458 T
21459 \change_deleted -712698321 1674902060
21460 t
21461 \change_inserted 564990737 1672224959
21462 heorem 3
21463 \emph default
21464 ,
21465
21466 \change_deleted -712698321 1674902063
21467 l
21468 \change_inserted -712698321 1674902063
21469
21470 \emph on
21471 L
21472 \change_inserted 564990737 1672224959
21473 emma 2
21474 \emph default
21475 ,
21476  \SpecialChar ldots
21477 ,
21478  as opposed to
21479 \change_deleted -712698321 1674902066
21480 t
21481 \change_inserted -712698321 1674902067
21482
21483 \emph on
21484 T
21485 \change_inserted 564990737 1672224959
21486 heorem 1
21487 \emph default
21488 ,
21489
21490 \change_deleted -712698321 1674902069
21491 t
21492 \change_inserted -712698321 1674902069
21493
21494 \emph on
21495 T
21496 \change_inserted 564990737 1672224959
21497 heorem 2
21498 \emph default
21499 ,
21500
21501 \change_deleted -712698321 1674902071
21502 l
21503 \change_inserted -712698321 1674902071
21504
21505 \emph on
21506 L
21507 \change_inserted 564990737 1672224959
21508 emma 3
21509 \emph default
21510 ,
21511
21512 \change_deleted -712698321 1674902075
21513 p
21514 \change_inserted -712698321 1674902075
21515
21516 \emph on
21517 P
21518 \change_inserted 564990737 1672224959
21519 roposition 4
21520 \emph default
21521 ,
21522  \SpecialChar ldots
21523 ).
21524  The numbering’s scope is the whole document.
21525  For chapter- and section-wide numbering,
21526  use one of the ‘within Sections’/‘within Chapters’ modules,
21527  respectively.
21528
21529 \change_inserted -712698321 1674902047
21530
21531 \end_layout
21532
21533 \begin_layout Standard
21534
21535 \change_inserted 564990737 1672224959
21536 It cannot be used if the modules
21537 \family sans
21538 AMS Theorems
21539 \family default
21540 ,
21541
21542 \family sans
21543 Standard Theorems
21544 \family default
21545 ,
21546
21547 \family sans
21548  Standard Theorems (Numbered by Type)
21549 \family default
21550  or
21551 \family sans
21552  Standard Theorems (Unnumbered)
21553 \family default
21554  have been loaded.
21555 \end_layout
21556
21557 \begin_layout Subsection
21558
21559 \change_inserted 564990737 1672224959
21560 Number Equations by Section
21561 \end_layout
21562
21563 \begin_layout Standard
21564
21565 \change_inserted 564990737 1672224959
21566 This module resets the equation number at section start and prepends the section number to the equation number,
21567  as in
21568 \change_deleted -712698321 1674902160
21569 “
21570 \change_inserted 564990737 1672224959
21571
21572 \emph on
21573 (2.1)
21574 \emph default
21575 .
21576 \change_deleted -712698321 1674902162
21577 ”
21578 \change_inserted 564990737 1672224959
21579
21580 \end_layout
21581
21582 \begin_layout Subsection
21583
21584 \change_inserted 564990737 1672224959
21585 Standard Theorems
21586 \end_layout
21587
21588 \begin_layout Standard
21589
21590 \change_inserted 564990737 1672224959
21591 This module defines some theorem environments for use with non-AMS classes.
21592  By default,
21593  the theorems are numbered consecutively throughout the document.
21594  This can be changed by loading one of the
21595 \family sans
21596 Standard Theorems (Numbered by \SpecialChar ldots
21597 )
21598 \family default
21599  modules.
21600
21601 \change_inserted -712698321 1674902414
21602
21603 \end_layout
21604
21605 \begin_layout Standard
21606
21607 \change_inserted 564990737 1672224959
21608 It cannot be used if the modules
21609 \family sans
21610 AMS Theorems
21611 \family default
21612  or
21613 \family sans
21614  Standard Theorems (Unnumbered)
21615 \family default
21616  have been loaded.
21617
21618 \end_layout
21619
21620 \begin_layout Subsection
21621
21622 \change_inserted 564990737 1672224959
21623 Standard Theorems (Nameable)
21624 \end_layout
21625
21626 \begin_layout Standard
21627
21628 \change_inserted 564990737 1672224959
21629 This module facilitates the use of named theorems.
21630  The name of the theorem
21631 \change_deleted -712698321 1674902805
21632 goes into the
21633 \change_inserted -712698321 1674902825
21634 can be inserted via
21635 \family sans
21636 Insert\SpecialChar menuseparator
21637
21638 \change_deleted -712698321 1674902827
21639  “
21640 \change_inserted 564990737 1672224959
21641 Additional Theorem Text
21642 \change_deleted -712698321 1674902831
21643
21644 \family default
21645 ” argument
21646 \change_inserted 564990737 1672224959
21647 .
21648
21649 \end_layout
21650
21651 \begin_layout Subsection
21652
21653 \change_inserted 564990737 1672224959
21654 Standard Theorems (Numbered by Chapter)
21655 \end_layout
21656
21657 \begin_layout Standard
21658
21659 \change_inserted 564990737 1672224959
21660 This module numbers theorems and the like by chapter (i.e.,
21661  the counter is reset at each chapter start).
21662  Use this module only with document classes that provide a chapter environment.
21663
21664 \change_inserted -712698321 1674903079
21665
21666 \end_layout
21667
21668 \begin_layout Standard
21669
21670 \change_inserted 564990737 1672224959
21671 One of the modules
21672 \family sans
21673 AMS Theorems
21674 \family default
21675  or
21676 \family sans
21677 Standard Theorems
21678 \family default
21679  must be loaded.
21680
21681 \change_inserted -712698321 1674903082
21682
21683 \end_layout
21684
21685 \begin_layout Standard
21686
21687 \change_inserted 564990737 1672224959
21688 It cannot be used if the module
21689 \family sans
21690  Standard Theorems (Numbered by Section)
21691 \family default
21692  has been loaded.
21693 \end_layout
21694
21695 \begin_layout Subsection
21696
21697 \change_inserted 564990737 1672224959
21698 Standard Theorems (Numbered by Section)
21699 \end_layout
21700
21701 \begin_layout Standard
21702
21703 \change_inserted 564990737 1672224959
21704 This module numbers theorems and the like by section (i.e.,
21705  the counter is reset at each section start).
21706  One of the modules
21707 \family sans
21708 AMS Theorems
21709 \family default
21710  or
21711 \family sans
21712 Standard Theorems
21713 \family default
21714  must be loaded.
21715  It cannot be used if the module
21716 \family sans
21717  Standard Theorems (Numbered by Chapter)
21718 \family default
21719  has been loaded.
21720 \end_layout
21721
21722 \begin_layout Subsection
21723
21724 \change_inserted 564990737 1672224959
21725 Standard Theorems (Numbered by Type within Chapters)
21726 \end_layout
21727
21728 \begin_layout Standard
21729
21730 \change_inserted 564990737 1672224959
21731 This module defines some theorem environments for use with non-AMS classes.
21732  Unlike the
21733 \family sans
21734  AMS Theorems
21735 \family default
21736  and
21737 \family sans
21738 Standard Theorems
21739 \family default
21740  modules,
21741  the different theorem types provided here each have a separate counter (e.g.,
21742
21743 \change_deleted -712698321 1674903338
21744 t
21745 \change_inserted -712698321 1674903338
21746
21747 \emph on
21748 T
21749 \change_inserted 564990737 1672224959
21750 heorem 1
21751 \emph default
21752 ,
21753
21754 \change_deleted -712698321 1674903340
21755 t
21756 \change_inserted -712698321 1674903340
21757
21758 \emph on
21759 T
21760 \change_inserted 564990737 1672224959
21761 heorem 2
21762 \emph default
21763 ,
21764
21765 \change_deleted -712698321 1674903343
21766 l
21767 \change_inserted -712698321 1674903343
21768
21769 \emph on
21770 L
21771 \change_inserted 564990737 1672224959
21772 emma 1
21773 \emph default
21774 ,
21775
21776 \change_deleted -712698321 1674903346
21777 p
21778 \change_inserted -712698321 1674903346
21779
21780 \emph on
21781 P
21782 \change_inserted 564990737 1672224959
21783 roposition 1
21784 \emph default
21785 ,
21786
21787 \change_deleted -712698321 1674903348
21788 t
21789 \change_inserted -712698321 1674903348
21790
21791 \emph on
21792 T
21793 \change_inserted 564990737 1672224959
21794 heorem 3
21795 \emph default
21796 ,
21797
21798 \change_deleted -712698321 1674903351
21799 l
21800 \change_inserted -712698321 1674903351
21801
21802 \emph on
21803 L
21804 \change_inserted 564990737 1672224959
21805 emma 2
21806 \emph default
21807 ,
21808  \SpecialChar ldots
21809 ,
21810  as opposed to
21811 \change_deleted -712698321 1674903354
21812 t
21813 \change_inserted -712698321 1674903354
21814
21815 \emph on
21816 T
21817 \change_inserted 564990737 1672224959
21818 heorem 1
21819 \emph default
21820 ,
21821
21822 \change_deleted -712698321 1674903356
21823 t
21824 \change_inserted -712698321 1674903356
21825
21826 \emph on
21827 T
21828 \change_inserted 564990737 1672224959
21829 heorem 2
21830 \emph default
21831 ,
21832
21833 \change_deleted -712698321 1674903359
21834 l
21835 \change_inserted -712698321 1674903359
21836
21837 \emph on
21838 L
21839 \change_inserted 564990737 1672224959
21840 emma 3
21841 \emph default
21842 ,
21843
21844 \change_deleted -712698321 1674903361
21845 p
21846 \change_inserted -712698321 1674903361
21847
21848 \emph on
21849 P
21850 \change_inserted 564990737 1672224959
21851 roposition 4
21852 \emph default
21853 ,
21854  \SpecialChar ldots
21855 ).
21856  The numbering is reset at each chapter start.
21857
21858 \change_inserted -712698321 1674902715
21859
21860 \end_layout
21861
21862 \begin_layout Standard
21863
21864 \change_inserted 564990737 1672224959
21865 One of the modules
21866 \family sans
21867 AMS Theorems (Numbered by Type)
21868 \family default
21869  or
21870 \family sans
21871 Standard Theorems (Numbered by Type)
21872 \family default
21873  must be loaded.
21874
21875 \change_inserted -712698321 1674902717
21876
21877 \end_layout
21878
21879 \begin_layout Standard
21880
21881 \change_inserted 564990737 1672224959
21882 It cannot be used if any of the modules
21883 \family sans
21884  AMS Theorems
21885 \family default
21886 ,
21887
21888 \family sans
21889 Standard Theorems
21890 \family default
21891 ,
21892
21893 \family sans
21894 Standard Theorems (Unnumbered)
21895 \family default
21896 ,
21897
21898 \family sans
21899  Standard Theorems (Numbered by Sections)
21900 \family default
21901  or
21902 \family sans
21903 Standard Theorems (Numbered by Type within Sections)
21904 \family default
21905  have been loaded.
21906 \end_layout
21907
21908 \begin_layout Subsection
21909
21910 \change_inserted 564990737 1672224959
21911 Standard Theorems (Numbered by Type within Sections)
21912 \end_layout
21913
21914 \begin_layout Standard
21915
21916 \change_inserted 564990737 1672224959
21917 This module defines some theorem environments for use with non-AMS classes.
21918  Unlike the
21919 \family sans
21920  AMS Theorems
21921 \family default
21922  and
21923 \family sans
21924 Standard Theorems
21925 \family default
21926  modules,
21927  the different theorem types provided here each have a separate counter (e.g.,
21928
21929 \change_deleted -712698321 1674902520
21930 t
21931 \change_inserted -712698321 1674902520
21932
21933 \emph on
21934 T
21935 \change_inserted 564990737 1672224959
21936 heorem 1
21937 \emph default
21938 ,
21939
21940 \change_deleted -712698321 1674902522
21941 t
21942 \change_inserted -712698321 1674902522
21943
21944 \emph on
21945 T
21946 \change_inserted 564990737 1672224959
21947 heorem 2
21948 \emph default
21949 ,
21950
21951 \change_deleted -712698321 1674902527
21952 l
21953 \change_inserted -712698321 1674902527
21954
21955 \emph on
21956 L
21957 \change_inserted 564990737 1672224959
21958 emma 1
21959 \emph default
21960 ,
21961
21962 \change_inserted -712698321 1674902529
21963
21964 \emph on
21965 P
21966 \change_deleted -712698321 1674902529
21967 p
21968 \change_inserted 564990737 1672224959
21969 roposition 1
21970 \emph default
21971 ,
21972
21973 \change_deleted -712698321 1674902532
21974 t
21975 \change_inserted -712698321 1674902532
21976
21977 \emph on
21978 T
21979 \change_inserted 564990737 1672224959
21980 heorem 3
21981 \emph default
21982 ,
21983
21984 \change_inserted -712698321 1674902535
21985
21986 \emph on
21987 L
21988 \change_deleted -712698321 1674902534
21989 l
21990 \change_inserted 564990737 1672224959
21991 emma 2
21992 \emph default
21993 ,
21994  \SpecialChar ldots
21995 ,
21996  as opposed to
21997 \change_deleted -712698321 1674902538
21998 t
21999 \change_inserted -712698321 1674902538
22000
22001 \emph on
22002 T
22003 \change_inserted 564990737 1672224959
22004 heorem 1
22005 \emph default
22006 ,
22007
22008 \change_deleted -712698321 1674902540
22009 t
22010 \change_inserted -712698321 1674902540
22011
22012 \emph on
22013 T
22014 \change_inserted 564990737 1672224959
22015 heorem 2
22016 \emph default
22017 ,
22018
22019 \change_deleted -712698321 1674902543
22020 l
22021 \change_inserted -712698321 1674902543
22022
22023 \emph on
22024 L
22025 \change_inserted 564990737 1672224959
22026 emma 3
22027 \emph default
22028 ,
22029
22030 \change_inserted -712698321 1674902545
22031
22032 \emph on
22033 P
22034 \change_deleted -712698321 1674902545
22035 p
22036 \change_inserted 564990737 1672224959
22037 roposition 4
22038 \emph default
22039 ,
22040  \SpecialChar ldots
22041 ).
22042  The numbering is reset at each section start.
22043
22044 \change_inserted -712698321 1674902574
22045
22046 \end_layout
22047
22048 \begin_layout Standard
22049
22050 \change_inserted 564990737 1672224959
22051 One of the modules
22052 \family sans
22053 AMS Theorems (Numbered by Type)
22054 \family default
22055  or
22056 \family sans
22057 Standard Theorems (Numbered by Type)
22058 \family default
22059  must be loaded.
22060
22061 \change_inserted -712698321 1674902609
22062
22063 \end_layout
22064
22065 \begin_layout Standard
22066
22067 \change_inserted 564990737 1672224959
22068 It cannot be used if any of the modules
22069 \family sans
22070  AMS Theorems
22071 \family default
22072 ,
22073
22074 \family sans
22075 Standard Theorems
22076 \family default
22077 ,
22078
22079 \family sans
22080 Standard Theorems (Unnumbered)
22081 \family default
22082 ,
22083
22084 \family sans
22085  Standard Theorems (Numbered by Chapters)
22086 \family default
22087  or
22088 \family sans
22089 Standard Theorems (Numbered by Type within Chapters)
22090 \family default
22091  have been loaded.
22092 \end_layout
22093
22094 \begin_layout Subsection
22095
22096 \change_inserted 564990737 1672224959
22097 Standard Theorems (Numbered by Type)
22098 \end_layout
22099
22100 \begin_layout Standard
22101
22102 \change_inserted 564990737 1672224959
22103 This module defines some theorem environments for use with non-AMS classes.
22104  Unlike the
22105 \family sans
22106 AMS Theorems
22107 \family default
22108  and
22109 \family sans
22110 Standard Theorems
22111 \family default
22112  modules,
22113  the different theorem types provided here each have a separate counter (e.g.,
22114
22115 \change_deleted -712698321 1674903220
22116 t
22117 \change_inserted -712698321 1674903220
22118
22119 \emph on
22120 T
22121 \change_inserted 564990737 1672224959
22122 heorem 1
22123 \emph default
22124 ,
22125
22126 \change_deleted -712698321 1674903221
22127 t
22128 \change_inserted -712698321 1674903221
22129
22130 \emph on
22131 T
22132 \change_inserted 564990737 1672224959
22133 heorem 2
22134 \emph default
22135 ,
22136
22137 \change_deleted -712698321 1674903225
22138 l
22139 \change_inserted -712698321 1674903226
22140
22141 \emph on
22142 L
22143 \change_inserted 564990737 1672224959
22144 emma 1
22145 \emph default
22146 ,
22147
22148 \change_inserted -712698321 1674903228
22149
22150 \emph on
22151 P
22152 \change_deleted -712698321 1674903228
22153 p
22154 \change_inserted 564990737 1672224959
22155 roposition 1
22156 \emph default
22157 ,
22158
22159 \change_deleted -712698321 1674903231
22160 t
22161 \change_inserted -712698321 1674903232
22162
22163 \emph on
22164 T
22165 \change_inserted 564990737 1672224959
22166 heorem 3
22167 \emph default
22168 ,
22169
22170 \change_inserted -712698321 1674903261
22171
22172 \emph on
22173 L
22174 \change_deleted -712698321 1674903233
22175 l
22176 \change_inserted 564990737 1672224959
22177 emma 2
22178 \emph default
22179 ,
22180  \SpecialChar ldots
22181 ,
22182  as opposed to
22183 \change_deleted -712698321 1674903237
22184 t
22185 \change_inserted -712698321 1674903237
22186
22187 \emph on
22188 T
22189 \change_inserted 564990737 1672224959
22190 heorem 1
22191 \emph default
22192 ,
22193
22194 \change_deleted -712698321 1674903240
22195 t
22196 \change_inserted -712698321 1674903240
22197
22198 \emph on
22199 T
22200 \change_inserted 564990737 1672224959
22201 heorem 2
22202 \emph default
22203 ,
22204
22205 \change_deleted -712698321 1674903242
22206 l
22207 \change_inserted -712698321 1674903242
22208
22209 \emph on
22210 L
22211 \change_inserted 564990737 1672224959
22212 emma 3
22213 \emph default
22214 ,
22215
22216 \change_deleted -712698321 1674903246
22217 p
22218 \change_inserted -712698321 1674903246
22219
22220 \emph on
22221 P
22222 \change_inserted 564990737 1672224959
22223 roposition 4
22224 \emph default
22225 ,
22226  \SpecialChar ldots
22227 ).
22228  The numbering’s scope is the whole document.
22229  For chapter- and section-wide numbering,
22230  use one of the “within Chapters”/“within Sections” modules,
22231  respectively.
22232
22233 \change_inserted -712698321 1674903280
22234
22235 \end_layout
22236
22237 \begin_layout Standard
22238
22239 \change_inserted 564990737 1672224959
22240 It cannot be used if any of the modules
22241 \family sans
22242  AMS Theorems
22243 \family default
22244 ,
22245
22246 \family sans
22247 Standard Theorems
22248 \family default
22249 ,
22250
22251 \family sans
22252 Standard Theorems (Unnumbered)
22253 \family default
22254  or
22255 \family sans
22256  AMS Theorems (Numbered by Type)
22257 \family default
22258  have been loaded.
22259 \end_layout
22260
22261 \begin_layout Subsection
22262
22263 \change_inserted 564990737 1672224959
22264 Standard Theorems (Unnumbered)
22265 \end_layout
22266
22267 \begin_layout Standard
22268
22269 \change_inserted 564990737 1672224959
22270 This module defines only unnumbered theorem environments and the proof environment,
22271  using the extended AMS machinery.
22272  It cannot be used if either of the modules
22273 \family sans
22274  AMS Theorems
22275 \family default
22276  or
22277 \family sans
22278  Standard Theorems
22279 \family default
22280  have been loaded.
22281 \end_layout
22282
22283 \begin_layout Subsection
22284
22285 \change_inserted 564990737 1672224959
22286 Subequations
22287 \end_layout
22288
22289 \begin_layout Standard
22290
22291 \change_inserted 564990737 1672224959
22292 This module provides a straightforward way to segregate subequations in LyX.
22293  See
22294 \family sans
22295 Help\SpecialChar menuseparator
22296 Math\SpecialChar menuseparator
22297 Subnumbering
22298 \family default
22299 .
22300
22301 \end_layout
22302
22303 \begin_layout Section
22304
22305 \change_inserted 564990737 1672236008
22306 Page Layout
22307 \end_layout
22308
22309 \begin_layout Subsection
22310
22311 \change_inserted 564990737 1672236008
22312 Custom Header/Footer Text
22313 \end_layout
22314
22315 \begin_layout Standard
22316
22317 \change_inserted 564990737 1672236008
22318 This module requires the
22319 \family sans
22320 Page
22321 \begin_inset space ~
22322 \end_inset
22323
22324
22325 \bar under
22326 s
22327 \bar default
22328 tyle
22329 \family default
22330  option in the
22331 \family sans
22332 \bar under
22333 D
22334 \bar default
22335 ocument\SpecialChar menuseparator
22336
22337 \bar under
22338 S
22339 \bar default
22340 ettings\SpecialChar menuseparator
22341 Page
22342 \begin_inset space ~
22343 \end_inset
22344
22345 Layout
22346 \family default
22347  dialog to be set to
22348 \family typewriter
22349 fancy
22350 \family default
22351 .
22352  It adds six environments to document classes which support the
22353 \family typewriter
22354 fancyhdr
22355 \family default
22356  package:
22357 \end_layout
22358
22359 \begin_layout Itemize
22360
22361 \change_inserted 564990737 1672236008
22362
22363 \family sans
22364 Left Header
22365 \end_layout
22366
22367 \begin_layout Itemize
22368
22369 \change_inserted 564990737 1672236008
22370
22371 \family sans
22372 Center Header
22373 \end_layout
22374
22375 \begin_layout Itemize
22376
22377 \change_inserted 564990737 1672236008
22378
22379 \family sans
22380 Right Header
22381 \end_layout
22382
22383 \begin_layout Itemize
22384
22385 \change_inserted 564990737 1672236008
22386
22387 \family sans
22388 Left Footer
22389 \end_layout
22390
22391 \begin_layout Itemize
22392
22393 \change_inserted 564990737 1672236008
22394
22395 \family sans
22396 Center Footer
22397 \end_layout
22398
22399 \begin_layout Itemize
22400
22401 \change_inserted 564990737 1672236008
22402
22403 \family sans
22404 Right Footer
22405 \end_layout
22406
22407 \begin_layout Subsubsection
22408
22409 \change_inserted 564990737 1672236008
22410 Fancy Headers and Footers
22411 \end_layout
22412
22413 \begin_layout Standard
22414
22415 \change_inserted 564990737 1672236008
22416 The default page layout is rather plain;
22417  for an
22418 \change_deleted -712698321 1674910295
22419
22420 \begin_inset Flex Code
22421 status collapsed
22422
22423 \begin_layout Plain Layout
22424
22425 \change_inserted 564990737 1672236008
22426 article
22427 \change_unchanged
22428
22429 \end_layout
22430
22431 \end_inset
22432
22433
22434 \change_inserted 564990737 1672236008
22435
22436 \change_inserted -712698321 1674910328
22437
22438 \family sans
22439 Article (Standard Class)
22440 \family default
22441
22442 \change_inserted 564990737 1672236008
22443 document class,
22444  all you get is a centered page number at the bottom of the page.
22445  This document uses
22446 \change_inserted -712698321 1674910381
22447  the
22448 \change_inserted 564990737 1672236008
22449
22450 \change_deleted -712698321 1674910376
22451 KOMA-script’s book
22452 \change_inserted -712698321 1674910376
22453
22454 \family sans
22455 KOMA-Script Book
22456 \change_inserted 564990737 1672236008
22457
22458 \family default
22459  class;
22460  so it appears to be a bit fancier.
22461
22462 \change_inserted -712698321 1674910455
22463
22464 \end_layout
22465
22466 \begin_layout Standard
22467
22468 \change_inserted 564990737 1672236008
22469 Once the
22470 \family sans
22471 Page
22472 \begin_inset space ~
22473 \end_inset
22474
22475
22476 \bar under
22477 s
22478 \bar default
22479 tyle
22480 \family default
22481  in
22482 \family sans
22483 \bar under
22484 D
22485 \bar default
22486 ocument\SpecialChar menuseparator
22487
22488 \bar under
22489 S
22490 \bar default
22491 ettings\SpecialChar menuseparator
22492 Page Layout
22493 \family default
22494  is set to
22495 \begin_inset Quotes eld
22496 \end_inset
22497
22498 fancy
22499 \begin_inset Quotes erd
22500 \end_inset
22501
22502 ,
22503  you will find that the page header is divided into three fields,
22504  not surprisingly labeled
22505 \begin_inset Quotes eld
22506 \end_inset
22507
22508 left
22509 \begin_inset Quotes erd
22510 \end_inset
22511
22512 ,
22513
22514 \begin_inset Quotes eld
22515 \end_inset
22516
22517 center
22518 \begin_inset Quotes erd
22519 \end_inset
22520
22521 ,
22522  and
22523 \begin_inset Quotes eld
22524 \end_inset
22525
22526 right
22527 \begin_inset Quotes erd
22528 \end_inset
22529
22530 .
22531  The footer is also divided into these three fields.
22532  The \SpecialChar LaTeX
22533  commands to set these fields in the simplest manner are
22534 \family typewriter
22535
22536 \backslash
22537 lhead
22538 \family default
22539 ,
22540
22541 \family typewriter
22542
22543 \backslash
22544 chead
22545 \family default
22546 ,
22547
22548 \family typewriter
22549
22550 \backslash
22551 rhead
22552 \family default
22553 ,
22554
22555 \family typewriter
22556
22557 \backslash
22558 lfoot
22559 \family default
22560 ,
22561  etc.
22562  Suppose you wish to put your name in the upper left hand corner of each page.
22563  Simply insert the following command in the preamble:
22564
22565 \end_layout
22566
22567 \begin_layout LyX-Code
22568
22569 \change_inserted 564990737 1672236008
22570
22571 \backslash
22572 lhead{John Q.
22573  DocWriter}
22574 \end_layout
22575
22576 \begin_layout Standard
22577
22578 \change_inserted 564990737 1672236008
22579 You will now see your name in the upper left.
22580  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,
22581  e.
22582 \begin_inset space \thinspace{}
22583 \end_inset
22584
22585 g.:
22586 \end_layout
22587
22588 \begin_layout LyX-Code
22589
22590 \change_inserted 564990737 1672236008
22591
22592 \backslash
22593 cfoot{}
22594 \end_layout
22595
22596 \begin_layout Standard
22597
22598 \change_inserted 564990737 1672236008
22599 There is,
22600  however,
22601  an easier way to make simple changes.
22602  If you load the
22603 \family sans
22604 \bar under
22605 D
22606 \bar default
22607 ocument\SpecialChar menuseparator
22608
22609 \bar under
22610 S
22611 \bar default
22612 ettings\SpecialChar menuseparator
22613 Modules\SpecialChar menuseparator
22614 Page Layout\SpecialChar menuseparator
22615 Custom Header/Footer Text
22616 \family default
22617  module,
22618  you will find you have six new environments corresponding to the six fields described above.
22619 \end_layout
22620
22621 \begin_layout Standard
22622
22623 \change_inserted 564990737 1672236008
22624 Let's get really fancy:
22625  lets put the section number with the word
22626 \begin_inset Quotes eld
22627 \end_inset
22628
22629 Section
22630 \begin_inset Quotes erd
22631 \end_inset
22632
22633  (e.
22634 \begin_inset space \thinspace{}
22635 \end_inset
22636
22637 g.
22638 \begin_inset space \space{}
22639 \end_inset
22640
22641 Section 3) in the upper left,
22642  the page number (e.
22643 \begin_inset space \thinspace{}
22644 \end_inset
22645
22646 g.
22647 \begin_inset space \space{}
22648 \end_inset
22649
22650 Page 4) in the upper right,
22651  your name in the lower left,
22652  and the date in the lower right.
22653  Use your newly enabled environments to add these entries:
22654 \end_layout
22655
22656 \begin_layout Standard
22657
22658 \change_deleted -712698321 1674910975
22659 \begin_inset VSpace defskip
22660 \end_inset
22661
22662
22663 \change_inserted 564990737 1672236008
22664
22665 \end_layout
22666
22667 \begin_layout LyX-Code
22668
22669 \change_inserted 564990737 1672236008
22670
22671 \family sans
22672 Left
22673 \begin_inset space ~
22674 \end_inset
22675
22676 header:
22677
22678 \family default
22679 \series bold
22680
22681 \family roman
22682 \series default
22683 Section
22684 \family typewriter
22685
22686 \family default
22687
22688 \backslash
22689 thesection
22690 \end_layout
22691
22692 \begin_layout LyX-Code
22693
22694 \change_inserted 564990737 1672236008
22695
22696 \family sans
22697 Center header:
22698 \end_layout
22699
22700 \begin_layout LyX-Code
22701
22702 \change_inserted 564990737 1672236008
22703
22704 \family sans
22705 Right header:
22706
22707 \family default
22708
22709 \family roman
22710 Page
22711 \family typewriter
22712
22713 \family default
22714
22715 \backslash
22716 thepage
22717 \end_layout
22718
22719 \begin_layout LyX-Code
22720
22721 \change_inserted 564990737 1672236008
22722
22723 \family sans
22724 Left footer:
22725
22726 \family default
22727
22728 \family roman
22729 John Q.
22730  DocWriter
22731 \end_layout
22732
22733 \begin_layout LyX-Code
22734
22735 \change_inserted 564990737 1672236008
22736
22737 \family sans
22738 Center footer:
22739 \end_layout
22740
22741 \begin_layout LyX-Code
22742
22743 \change_inserted 564990737 1672236008
22744
22745 \family sans
22746 Right footer:
22747
22748 \family default
22749 \series bold
22750
22751 \series default
22752
22753 \backslash
22754 today
22755 \end_layout
22756
22757 \begin_layout Standard
22758
22759 \change_deleted -712698321 1674910976
22760 \begin_inset VSpace defskip
22761 \end_inset
22762
22763
22764 \change_inserted 564990737 1672236008
22765
22766 \end_layout
22767
22768 \begin_layout Standard
22769
22770 \change_inserted 564990737 1672236008
22771 Make sure you enter the commands
22772 \family typewriter
22773
22774 \backslash
22775 thesection
22776 \family default
22777 ,
22778
22779 \family typewriter
22780
22781 \backslash
22782 thepage
22783 \family default
22784  and
22785 \family typewriter
22786
22787 \backslash
22788 today
22789 \family default
22790  as \SpecialChar TeX
22791  Code commands
22792 \series bold
22793 .
22794
22795 \series default
22796  The commands
22797 \family typewriter
22798
22799 \backslash
22800 thesection
22801 \family default
22802  and
22803 \family typewriter
22804
22805 \backslash
22806 thepage
22807 \family default
22808  access \SpecialChar LaTeX
22809 ’s section and page counters,
22810  and so print out the current section and page numbers.
22811
22812 \family typewriter
22813
22814 \backslash
22815 today
22816 \family default
22817  simply prints out today’s date.
22818 \end_layout
22819
22820 \begin_layout Standard
22821
22822 \change_inserted 564990737 1672236008
22823 The thicknesses of the horizontal rules drawn beneath the header and above the footer can also be modified.
22824  If you don't want one of the rules,
22825  set its thickness to 0.
22826  The header rule has a default thickness of 0.4pt,
22827  the footer rule is 0pt.
22828  For this you will need to use \SpecialChar TeX
22829  Code commands like
22830 \end_layout
22831
22832 \begin_layout Standard
22833
22834 \change_inserted 564990737 1672236008
22835
22836 \family typewriter
22837
22838 \backslash
22839 renewcommand{
22840 \backslash
22841 headrulewidth}{0.4pt}
22842 \family default
22843  and
22844 \end_layout
22845
22846 \begin_layout Standard
22847
22848 \change_inserted 564990737 1672236008
22849
22850 \family typewriter
22851
22852 \backslash
22853 renewcommand{
22854 \backslash
22855 footrulewidth}{0.4pt}
22856 \family default
22857  to set the thicknesses.
22858 \end_layout
22859
22860 \begin_layout Standard
22861
22862 \change_inserted 564990737 1672236008
22863 You can switch the header/footer settings on and off for individual pages using \SpecialChar TeX
22864  Code commands like
22865 \family typewriter
22866
22867 \backslash
22868 thispagestyle{empty}
22869 \family default
22870 ,
22871
22872 \family typewriter
22873
22874 \backslash
22875 thispagestyle{plain}
22876 \family default
22877 ,
22878  and
22879 \family typewriter
22880
22881 \backslash
22882 thispagestyle{fancy}
22883 \family default
22884 .
22885  Simply insert them in the text on the page you want changed and mark them as \SpecialChar TeX
22886  code.
22887  In fact,
22888  title pages are marked as plain by default,
22889  while following pages are marked fancy when using the global fancy setting.
22890
22891 \end_layout
22892
22893 \begin_layout Standard
22894
22895 \change_inserted 564990737 1672236008
22896 If you want a header or footer to be on the outer side of a two sided document,
22897  you need to use something like:
22898 \end_layout
22899
22900 \begin_layout LyX-Code
22901
22902 \change_deleted -712698321 1674911361
22903
22904 \family sans
22905 \begin_inset Flex Strong
22906 status collapsed
22907
22908 \begin_layout Plain Layout
22909
22910 \change_inserted 564990737 1672236008
22911
22912 \family sans
22913 \series medium
22914
22915 \backslash
22916 fancyfoot{}
22917 \change_unchanged
22918
22919 \end_layout
22920
22921 \end_inset
22922
22923
22924 \change_inserted -712698321 1674911361
22925
22926 \family default
22927
22928 \backslash
22929 fancyfoot{}
22930 \change_unchanged
22931
22932 \end_layout
22933
22934 \begin_layout LyX-Code
22935
22936 \change_deleted -712698321 1674911364
22937
22938 \family sans
22939 \begin_inset Flex Strong
22940 status collapsed
22941
22942 \begin_layout Plain Layout
22943
22944 \change_inserted 564990737 1672236008
22945
22946 \family sans
22947 \series medium
22948
22949 \backslash
22950 fancyfoot[LE,RO]{
22951 \backslash
22952 thepage}
22953 \change_unchanged
22954
22955 \end_layout
22956
22957 \end_inset
22958
22959
22960 \change_inserted -712698321 1674911364
22961
22962 \family default
22963
22964 \backslash
22965 fancyfoot[LE,RO]{
22966 \backslash
22967 thepage}
22968 \change_unchanged
22969
22970 \end_layout
22971
22972 \begin_layout Standard
22973
22974 \change_inserted 564990737 1672236008
22975 The first command clears all existing footers avoiding any conflicts with your new command.
22976 \end_layout
22977
22978 \begin_layout Standard
22979
22980 \change_inserted 564990737 1672236008
22981 You can enter any of these commands,
22982  the simpler ones in any of your new environments,
22983  the more complex ones as \SpecialChar TeX
22984  Code commands,
22985  at any point in your document and they will take effect on the next page.
22986 \end_layout
22987
22988 \begin_layout Standard
22989
22990 \change_inserted 564990737 1672236008
22991 As a final example,
22992  it is possible to include an image in the header or footer.
22993  Suppose you want to put a company logo in the upper left hand corner.
22994  You might try something like
22995 \change_inserted -712698321 1674911745
22996  this in
22997 \family sans
22998 Document\SpecialChar menuseparator
22999 Settings\SpecialChar menuseparator
23000 LaTeX Preamble
23001 \family default
23002 :
23003 \change_inserted 564990737 1672236008
23004
23005 \end_layout
23006
23007 \begin_layout LyX-Code
23008
23009 \change_inserted 564990737 1672236008
23010
23011 \backslash
23012 lhead{
23013 \backslash
23014 resizebox{1in}{!}{
23015 \backslash
23016 includegraphics{logo.
23017 \change_deleted -712698321 1674911807
23018 eps
23019 \change_inserted -712698321 1674911807
23020 png
23021 \change_inserted 564990737 1672236008
23022 }}}
23023 \end_layout
23024
23025 \begin_layout Standard
23026 \noindent
23027
23028 \change_deleted -712698321 1674911836
23029 (y
23030 \change_inserted -712698321 1674911837
23031 Y
23032 \change_inserted 564990737 1672236008
23033 ou may need to preface this with
23034 \family typewriter
23035
23036 \backslash
23037 usepackage{graphics}
23038 \family default
23039  if you don't include graphics elsewhere in your document
23040 \change_deleted -712698321 1674911839
23041 )
23042 \change_inserted 564990737 1672236008
23043 .
23044 \end_layout
23045
23046 \begin_layout Standard
23047
23048 \change_inserted 564990737 1672236008
23049 For more information on fancy headers,
23050  you can get the
23051 \begin_inset Flex Code
23052 status collapsed
23053
23054 \begin_layout Plain Layout
23055
23056 \change_inserted 564990737 1672236008
23057 fancyhdr
23058 \change_unchanged
23059
23060 \end_layout
23061
23062 \end_inset
23063
23064  documentation from
23065 \begin_inset CommandInset href
23066 LatexCommand href
23067 name "CTAN"
23068 target "http://www.ctan.org/pkg/fancyhdr"
23069 literal "false"
23070
23071 \end_inset
23072
23073 .
23074
23075 \end_layout
23076
23077 \begin_layout Subsection
23078
23079 \change_inserted 564990737 1672236008
23080 Landscape Document Parts
23081 \end_layout
23082
23083 \begin_layout Standard
23084
23085 \change_inserted 564990737 1672236008
23086 This module outputs parts of the document in landscape mode using
23087 \family sans
23088 Insert\SpecialChar menuseparator
23089 Custom Insets\SpecialChar menuseparator
23090 Landscape
23091 \family default
23092  or
23093 \family sans
23094 Insert\SpecialChar menuseparator
23095 Custom Insets\SpecialChar menuseparator
23096 Landscape (Floating)
23097 \family default
23098 .
23099 \end_layout
23100
23101 \begin_layout Subsection
23102
23103 \change_inserted 564990737 1672236008
23104 \begin_inset CommandInset label
23105 LatexCommand label
23106 name "sec:Multiple-Columns"
23107
23108 \end_inset
23109
23110 Multiple Columns
23111 \end_layout
23112
23113 \begin_layout Standard
23114
23115 \change_inserted 564990737 1672236008
23116 This module uses the
23117 \family sans
23118 multicol
23119 \family default
23120
23121 \begin_inset Index idx
23122 range none
23123 pageformat default
23124 status collapsed
23125
23126 \begin_layout Plain Layout
23127
23128 \change_inserted 564990737 1672236008
23129 \SpecialChar LaTeX
23130 -packages !
23131  multicol
23132 \change_unchanged
23133
23134 \end_layout
23135
23136 \end_inset
23137
23138  package and is independent of the option
23139 \family sans
23140 Two-
23141 \bar under
23142 c
23143 \bar default
23144 olumn document
23145 \family default
23146  in the
23147 \family sans
23148 \bar under
23149 D
23150 \bar default
23151 ocument\SpecialChar menuseparator
23152
23153 \bar under
23154 S
23155 \bar default
23156 ettings\SpecialChar menuseparator
23157 Text
23158 \begin_inset space ~
23159 \end_inset
23160
23161 Layout
23162 \family default
23163  dialog.
23164  If you want to have two columns for the whole document,
23165  you are recommended to use the
23166 \family sans
23167 Two-
23168 \bar under
23169 c
23170 \bar default
23171 olumn document
23172 \family default
23173  option.
23174  For all other cases use this module.
23175 \change_deleted 564990737 1672236008
23176 Multiple Text Columns
23177 \end_layout
23178
23179 \begin_layout Standard
23180
23181 \change_deleted 564990737 1672236008
23182 This feature is independent of the option
23183 \family sans
23184 Two-column document
23185 \family default
23186  in the document settings under
23187 \family sans
23188 Text Layout
23189 \family default
23190 .
23191  If you want to have 2
23192 \begin_inset space ~
23193 \end_inset
23194
23195 columns for the whole document,
23196  it is recommended to use the
23197 \family sans
23198 Two-column document
23199 \family default
23200  option.
23201  For all other cases use this feature.
23202 \end_layout
23203
23204 \begin_layout Standard
23205
23206 \change_deleted 564990737 1672236008
23207 To use multiple text columns in your document,
23208  you have to load the module
23209 \family sans
23210 Multiple Columns
23211 \family default
23212  (menu
23213 \family sans
23214 Document\SpecialChar menuseparator
23215 Settings\SpecialChar menuseparator
23216 Modules
23217 \family default
23218 ) and must have the \SpecialChar LaTeX
23219 -package
23220 \begin_inset Flex Code
23221 status collapsed
23222
23223 \begin_layout Plain Layout
23224 multicol
23225 \end_layout
23226
23227 \end_inset
23228
23229  installed.
23230 \change_unchanged
23231
23232 \end_layout
23233
23234 \begin_layout Standard
23235 Footnotes within multiple columns will be placed at the bottom of the page and not under each column.
23236  Within the different columns you can use everything,
23237  with the limitation that for floats you need to
23238 \change_deleted 564990737 1672236179
23239 use the float option
23240 \family sans
23241 Span columns
23242 \change_inserted 564990737 1672236179
23243
23244 \family default
23245 check the option
23246 \family sans
23247 \bar under
23248 S
23249 \bar default
23250 pan
23251 \begin_inset space ~
23252 \end_inset
23253
23254 columns
23255 \family default
23256  in
23257 \family sans
23258 \bar under
23259 E
23260 \bar default
23261 dit\SpecialChar menuseparator
23262 Flo
23263 \bar under
23264 a
23265 \bar default
23266 t
23267 \begin_inset space ~
23268 \end_inset
23269
23270 Settings
23271 \change_unchanged
23272
23273 \family default
23274 .
23275 \end_layout
23276
23277 \begin_layout Subsubsection
23278 Basics
23279 \end_layout
23280
23281 \begin_layout Standard
23282 If you want to have
23283 \change_deleted -712698321 1674912320
23284 2
23285 \change_inserted -712698321 1674912321
23286 two
23287 \change_deleted -712698321 1674912322
23288
23289 \begin_inset space ~
23290 \end_inset
23291
23292
23293 \change_inserted -712698321 1674912322
23294
23295 \change_unchanged
23296 columns in your text,
23297  insert a multicolumn inset via the menu
23298 \family sans
23299 Insert\SpecialChar menuseparator
23300 Custom
23301 \begin_inset space ~
23302 \end_inset
23303
23304 Insets\SpecialChar menuseparator
23305 Multiple
23306 \begin_inset space ~
23307 \end_inset
23308
23309 Columns
23310 \family default
23311  where the columns should start.
23312  Write all text that should be printed in 2
23313 \begin_inset space ~
23314 \end_inset
23315
23316 columns into this inset.
23317 \end_layout
23318
23319 \begin_layout Standard
23320 Here is an example:
23321 \end_layout
23322
23323 \begin_layout Standard
23324 \noindent
23325 \begin_inset Flex Multiple Columns
23326 status open
23327
23328 \begin_layout Plain Layout
23329 \noindent
23330
23331 \series bold
23332 \size small
23333 The Adventure of the Empty House
23334 \series default
23335
23336 \begin_inset Newline newline
23337 \end_inset
23338
23339 by
23340 \noun on
23341 Sir Arthur Conan Doyle
23342 \end_layout
23343
23344 \begin_layout Plain Layout
23345
23346 \size small
23347 It was in the spring of the year 1894 that all London was interested,
23348  and the fashionable world dismayed,
23349  by the murder of the Honourable Ronald Adair under most unusual and inexplicable circumstances.
23350  The public has already learned those particulars of the crime which came out in the police investigation,
23351  but a good deal was suppressed upon that occasion,
23352  since the case for the prosecution was so overwhelmingly strong that it was not necessary to bring forward all the facts.
23353  Only now,
23354  at the end of nearly ten years,
23355  am I allowed to supply those missing links which make up the whole of that remarkable chain.
23356  The crime was of interest in itself,
23357  but that interest was as nothing to me compared to the inconceivable sequel,
23358  which afforded me the greatest shock and surprise of any event in my adventurous life.
23359  Even now,
23360  after this long interval,
23361  I find myself thrilling as I think of it,
23362  and feeling once more that sudden flood of joy,
23363  amazement,
23364  and incredulity which utterly submerged my mind.
23365  Let me say to that public,
23366  which has shown some interest in those glimpses which I have occasionally given them of the thoughts and actions of a very remarkable man,
23367  that they are not to blame me if I have not shared my knowledge with them,
23368  for I should have considered it my first duty to do so,
23369  had I not been barred by a positive prohibition from his own lips,
23370  which was only withdrawn upon the third of last month.
23371 \end_layout
23372
23373 \end_inset
23374
23375
23376 \end_layout
23377
23378 \begin_layout Standard
23379 To get 3 or more columns,
23380  set the cursor into the multicolumn inset and use the menu
23381 \family sans
23382 Insert\SpecialChar menuseparator
23383 Number
23384 \begin_inset space ~
23385 \end_inset
23386
23387 of
23388 \begin_inset space ~
23389 \end_inset
23390
23391 Columns
23392 \family default
23393 .
23394  The number of the desired columns is written into that inset (for 3
23395 \begin_inset space ~
23396 \end_inset
23397
23398 columns write
23399 \begin_inset Quotes eld
23400 \end_inset
23401
23402 3
23403 \begin_inset Quotes erd
23404 \end_inset
23405
23406 ).
23407 \begin_inset Newline newline
23408 \end_inset
23409
23410 Here is an example with 3
23411 \begin_inset space ~
23412 \end_inset
23413
23414 columns:
23415 \end_layout
23416
23417 \begin_layout Standard
23418 \begin_inset Flex Multiple Columns
23419 status open
23420
23421 \begin_layout Plain Layout
23422
23423 \size footnotesize
23424 \begin_inset Argument 1
23425 status open
23426
23427 \begin_layout Plain Layout
23428
23429 3
23430 \end_layout
23431
23432 \end_inset
23433
23434 It can be imagined that my close intimacy with Sherlock Holmes had interested me deeply in crime,
23435  and that after his disappearance I never failed to read with care the various problems which came before the public.
23436  And I even attempted,
23437  more than once,
23438  for my own private satisfaction,
23439  to employ his methods in their solution,
23440  though with indifferent success.
23441  There was none,
23442  however,
23443  which appealed to me like this tragedy of Ronald Adair.
23444  As I read the evidence at the inquest,
23445  which led up to a verdict of willful murder against some person or persons unknown,
23446  I realized more clearly than I had ever done the loss which the community had sustained by the death of Sherlock Holmes.
23447  There were points about this strange business which would,
23448  I was sure,
23449  have specially appealed to him,
23450  and the efforts of the police would have been supplemented,
23451  or more probably anticipated,
23452  by the trained observation and the alert mind of the first criminal agent in Europe.
23453  All day,
23454  as I drove upon my round,
23455  I turned over the case in my mind and found no explanation which appeared to me to be adequate.
23456  At the risk of telling a twice-told tale,
23457  I will recapitulate the facts as they were known to the public at the conclusion of the inquest.
23458 \end_layout
23459
23460 \end_inset
23461
23462
23463 \end_layout
23464
23465 \begin_layout Standard
23466 You can have up to 10
23467 \begin_inset space ~
23468 \end_inset
23469
23470 columns if you want to,
23471  but that might not be very pleasant for the readers of your document.
23472 \end_layout
23473
23474 \begin_layout Standard
23475
23476 \change_deleted 564990737 1672236245
23477 \begin_inset Newpage newpage
23478 \end_inset
23479
23480
23481 \change_unchanged
23482
23483 \end_layout
23484
23485 \begin_layout Subsubsection
23486 Columns inside Columns
23487 \end_layout
23488
23489 \begin_layout Standard
23490 You can also have columns inside columns:
23491 \end_layout
23492
23493 \begin_layout Standard
23494 \begin_inset Flex Multiple Columns
23495 status open
23496
23497 \begin_layout Plain Layout
23498
23499 \size footnotesize
23500 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
23501  at that time governor of one of the Australian colonies.
23502  Adair's mother had returned from Australia to undergo the operation for cataract,
23503  and she,
23504  her son Ronald,
23505  and her daughter Hilda were living together at 427 Park Lane.
23506 \end_layout
23507
23508 \begin_layout Plain Layout
23509 \begin_inset Flex Multiple Columns
23510 status open
23511
23512 \begin_layout Plain Layout
23513
23514 \size footnotesize
23515 The youth moved in the best society
23516 \begin_inset space ~
23517 \end_inset
23518
23519 – had,
23520  so far as was known,
23521  no enemies and no particular vices.
23522  He had been engaged to Miss Edith Woodley,
23523  of Carstairs,
23524  but the engagement had been broken off by mutual consent some months before,
23525  and there was no sign that it had left any very profound feeling behind it.
23526  For the rest {sic} the man's life moved in a narrow and conventional circle,
23527  for his habits were quiet and his nature unemotional.
23528  Yet it was upon this easy-going young aristocrat that death came,
23529  in most strange and unexpected form,
23530  between the hours of ten and eleven-twenty on the night of March 30,
23531  1894.
23532 \end_layout
23533
23534 \end_inset
23535
23536
23537 \end_layout
23538
23539 \begin_layout Plain Layout
23540
23541 \size footnotesize
23542 Ronald Adair was fond of cards
23543 \begin_inset space ~
23544 \end_inset
23545
23546 – playing continually,
23547  but never for such stakes as would hurt him.
23548  He was a member of the Baldwin,
23549  the Cavendish,
23550  and the Bagatelle card clubs.
23551  It was shown that,
23552  after dinner on the day of his death,
23553  he had played a rubber of whist at the latter club.
23554  He had also played there in the afternoon.
23555
23556 \size default
23557
23558 \size footnotesize
23559 The evidence of those who had played with him
23560 \begin_inset space ~
23561 \end_inset
23562
23563 – Mr.
23564  Murray,
23565  Sir John Hardy,
23566  and Colonel Moran
23567 \begin_inset space ~
23568 \end_inset
23569
23570 – showed that the game was whist,
23571  and that there was a fairly equal fall of the cards.
23572  Adair might have lost five pounds,
23573  but not more.
23574  His fortune was a considerable one,
23575  and such a loss could not in any way affect him.
23576  He had played nearly every day at one club or other,
23577  but he was a cautious player,
23578  and usually rose a winner.
23579  It came out in evidence that,
23580  in partnership with Colonel Moran,
23581  he had actually won as much as four hundred and twenty pounds in a sitting,
23582  some weeks before,
23583  from Godfrey Milner and Lord Balmoral.
23584  So much for his recent history as it came out at the inquest.
23585 \end_layout
23586
23587 \end_inset
23588
23589
23590 \end_layout
23591
23592 \begin_layout Subsubsection
23593 Advanced Examples
23594 \end_layout
23595
23596 \begin_layout Standard
23597 The examples in this section show some more special features of multiple columns.
23598 \end_layout
23599
23600 \begin_layout Standard
23601 For more features of multiple columns,
23602  have a look at the
23603 \begin_inset CommandInset href
23604 LatexCommand href
23605 name "documentation"
23606 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
23607 literal "false"
23608
23609 \end_inset
23610
23611  of the \SpecialChar LaTeX
23612 -package
23613 \begin_inset Flex Code
23614 status collapsed
23615
23616 \begin_layout Plain Layout
23617 multicol
23618 \end_layout
23619
23620 \end_inset
23621
23622 .
23623 \end_layout
23624
23625 \begin_layout Paragraph
23626 Preface
23627 \end_layout
23628
23629 \begin_layout Standard
23630 To add a preface text for multiple columns,
23631  set the cursor into the multicolumn inset and use the menu
23632 \family sans
23633 Insert\SpecialChar menuseparator
23634 Preface
23635 \family default
23636 .
23637  Write your preface text into that inset.
23638 \begin_inset Newline newline
23639 \end_inset
23640
23641 This is an example with some preface text:
23642 \end_layout
23643
23644 \begin_layout Standard
23645 \begin_inset VSpace bigskip
23646 \end_inset
23647
23648
23649 \end_layout
23650
23651 \begin_layout Standard
23652 \begin_inset Flex Multiple Columns
23653 status open
23654
23655 \begin_layout Plain Layout
23656 \begin_inset Argument 2
23657 status open
23658
23659 \begin_layout Plain Layout
23660 And the story continues and continues and continues and continues\SpecialChar ldots
23661
23662 \end_layout
23663
23664 \end_inset
23665
23666
23667 \size small
23668 On the evening of the crime,
23669  he returned from the club exactly at ten.
23670  His mother and sister were out spending the evening with a relation.
23671  The servant deposed that she heard him enter the front room on the second floor,
23672  generally used as his sitting-room.
23673  She had lit a fire there,
23674  and as it smoked she had opened the window.
23675  No sound was heard from the room until eleven-twenty,
23676  the hour of the return of Lady Maynooth and her daughter.
23677  Desiring to say good-night,
23678  she attempted to enter her son's room.
23679  The door was locked on the inside,
23680  and no answer could be got to their cries and knocking.
23681  Help was obtained,
23682  and the door forced.
23683  The unfortunate young man was found lying near the table.
23684  His head had been horribly mutilated by an expanding revolver bullet,
23685  but no weapon of any sort was to be found in the room.
23686 \end_layout
23687
23688 \end_inset
23689
23690
23691 \end_layout
23692
23693 \begin_layout Standard
23694 You can also use a section heading as the preface if you use a section command as \SpecialChar TeX
23695  Code.
23696  For example the command
23697 \end_layout
23698
23699 \begin_layout LyX-Code
23700
23701 \backslash
23702 subsection{subsection title}
23703 \end_layout
23704
23705 \begin_layout Standard
23706 creates a subsection.
23707  In this example the preface is a subsubsection:
23708 \end_layout
23709
23710 \begin_layout Standard
23711 \begin_inset Flex Multiple Columns
23712 status open
23713
23714 \begin_layout Plain Layout
23715 \begin_inset Argument 2
23716 status open
23717
23718 \begin_layout Plain Layout
23719 \begin_inset ERT
23720 status collapsed
23721
23722 \begin_layout Plain Layout
23723
23724
23725 \backslash
23726 subsubsection{
23727 \end_layout
23728
23729 \end_inset
23730
23731 This is a subsubsection heading as a preface
23732 \begin_inset ERT
23733 status collapsed
23734
23735 \begin_layout Plain Layout
23736
23737 }
23738 \end_layout
23739
23740 \end_inset
23741
23742
23743 \end_layout
23744
23745 \end_inset
23746
23747
23748 \size small
23749 A minute examination of the circumstances served only to make the case more complex.
23750  In the first place,
23751  no reason could be given why the young man should have fastened the door upon the inside.
23752  There was the possibility that the murderer had done this,
23753  and had afterwards escaped by the window.
23754  The drop was at least twenty feet,
23755  however,
23756  and a bed of crocuses in full bloom lay beneath.
23757  Neither the flowers nor the earth showed any sign of having been disturbed,
23758  nor were there any marks upon the narrow strip of grass which separated the house from the road.
23759  Apparently,
23760  therefore,
23761  it was the young man himself who had fastened the door.
23762  But how did he come by his death?
23763  No one could have climbed up to the window without leaving traces.
23764  Suppose a man had fired through the window,
23765  he would indeed be a remarkable shot who could with a revolver inflict so deadly a wound.
23766  Again,
23767  Park Lane is a frequented thoroughfare;
23768  there is a cab stand within a hundred yards of the house.
23769  No one had heard a shot.
23770 \end_layout
23771
23772 \end_inset
23773
23774
23775 \end_layout
23776
23777 \begin_layout Standard
23778 If there is less vertical space than
23779 \change_deleted -712698321 1674913194
23780 6
23781 \begin_inset space ~
23782 \end_inset
23783
23784
23785 \change_inserted -712698321 1674913195
23786 six
23787 \change_unchanged
23788 text lines is left on the page at the beginning of the multiple columns,
23789  a page break will be inserted before the multiple columns.
23790  Depending on the number of lines of the preface text,
23791  you might want to change this space.
23792  This is done by setting the cursor into the mulitcolumn inset behind the preface (if there is any) and using the menu
23793 \family sans
23794 Insert\SpecialChar menuseparator
23795 Space
23796 \begin_inset space ~
23797 \end_inset
23798
23799 Before
23800 \begin_inset space ~
23801 \end_inset
23802
23803 Page
23804 \begin_inset space ~
23805 \end_inset
23806
23807 Break
23808 \family default
23809 .
23810  Insert into that inset the amount of space like e.
23811 \begin_inset space \thinspace{}
23812 \end_inset
23813
23814 g.
23815 \begin_inset space \space{}
23816 \end_inset
23817
23818
23819 \begin_inset Quotes eld
23820 \end_inset
23821
23822 5cm
23823 \begin_inset Quotes erd
23824 \end_inset
23825
23826 .
23827 \begin_inset Newline newline
23828 \end_inset
23829
23830 In this example the space is set to 7
23831 \begin_inset space ~
23832 \end_inset
23833
23834 text lines by using
23835 \begin_inset Flex Code
23836 status collapsed
23837
23838 \begin_layout Plain Layout
23839 7
23840 \backslash
23841 baselineskip
23842 \end_layout
23843
23844 \end_inset
23845
23846  (where the command
23847 \begin_inset Flex Code
23848 status collapsed
23849
23850 \begin_layout Plain Layout
23851
23852 \backslash
23853 baselineskip
23854 \end_layout
23855
23856 \end_inset
23857
23858  needs to be inserted as \SpecialChar TeX
23859  code):
23860 \end_layout
23861
23862 \begin_layout Standard
23863 \begin_inset Flex Multiple Columns
23864 status open
23865
23866 \begin_layout Plain Layout
23867 \begin_inset Argument 3
23868 status open
23869
23870 \begin_layout Plain Layout
23871 7
23872 \begin_inset ERT
23873 status collapsed
23874
23875 \begin_layout Plain Layout
23876
23877
23878 \backslash
23879 baselineskip
23880 \end_layout
23881
23882 \end_inset
23883
23884
23885 \end_layout
23886
23887 \end_inset
23888
23889
23890 \size small
23891 On the evening of the crime,
23892  he returned from the club exactly at ten.
23893  His mother and sister were out spending the evening with a relation.
23894  The servant deposed that she heard him enter the front room on the second floor,
23895  generally used as his sitting-room.
23896  She had lit a fire there,
23897  and as it smoked she had opened the window.
23898  No sound was heard from the room until eleven-twenty,
23899  the hour of the return of Lady Maynooth and her daughter.
23900  Desiring to say good-night,
23901  she attempted to enter her son's room.
23902  The door was locked on the inside,
23903  and no answer could be got to their cries and knocking.
23904  Help was obtained,
23905  and the door forced.
23906  The unfortunate young man was found lying near the table.
23907  His head had been horribly mutilated by an expanding revolver bullet,
23908  but no weapon of any sort was to be found in the room.
23909 \end_layout
23910
23911 \end_inset
23912
23913
23914 \end_layout
23915
23916 \begin_layout Paragraph
23917 Surrounding Space
23918 \end_layout
23919
23920 \begin_layout Standard
23921 The amount of space before and after multiple columns can be changed by changing the length
23922 \begin_inset Flex Code
23923 status collapsed
23924
23925 \begin_layout Plain Layout
23926
23927 \backslash
23928 multicolsep
23929 \end_layout
23930
23931 \end_inset
23932
23933 .
23934  For example the command
23935 \end_layout
23936
23937 \begin_layout LyX-Code
23938
23939 \backslash
23940 setlength{
23941 \backslash
23942 multicolsep}{3cm}
23943 \end_layout
23944
23945 \begin_layout Standard
23946 in \SpecialChar TeX
23947  Code changes its value to 3
23948 \begin_inset space \thinspace{}
23949 \end_inset
23950
23951 cm.
23952  The change must be made before the multiple columns' start.
23953  The predefined value is 13
23954 \begin_inset space \thinspace{}
23955 \end_inset
23956
23957 pt.
23958 \end_layout
23959
23960 \begin_layout Standard
23961 For this example
23962 \begin_inset Flex Code
23963 status collapsed
23964
23965 \begin_layout Plain Layout
23966
23967 \backslash
23968 multicolsep
23969 \end_layout
23970
23971 \end_inset
23972
23973  was set to 2.5
23974 \begin_inset space \thinspace{}
23975 \end_inset
23976
23977 cm:
23978 \end_layout
23979
23980 \begin_layout Standard
23981 \begin_inset ERT
23982 status open
23983
23984 \begin_layout Plain Layout
23985
23986
23987 \backslash
23988 setlength{
23989 \backslash
23990 multicolsep}{2.5cm}
23991 \end_layout
23992
23993 \end_inset
23994
23995
23996 \end_layout
23997
23998 \begin_layout Standard
23999 \begin_inset Flex Multiple Columns
24000 status open
24001
24002 \begin_layout Plain Layout
24003
24004 \size small
24005 All day I turned these facts over in my mind,
24006  endeavouring to hit upon some theory which could reconcile them all,
24007  and to find that line of least resistance which my poor friend had declared to be the starting-point of every investigation.
24008  I confess that I made little progress.
24009  In the evening I strolled across the Park,
24010  and found myself about six o'clock at the Oxford Street end of Park Lane.
24011  A group of loafers upon the pavements,
24012  all staring up at a particular window,
24013  directed me to the house which I had come to see.
24014  A tall,
24015  thin man with coloured glasses,
24016  whom I strongly suspected of being a plain-clothes detective,
24017  was pointing out some theory of his own,
24018  while the others crowded round to listen to what he said.
24019  I got as near him as I could,
24020  but his observations seemed to me to be absurd,
24021  so I withdrew again in some disgust.
24022  As I did so I struck against an elderly,
24023  deformed man,
24024  who had been behind me,
24025  and I knocked down several books which he was carrying.
24026 \end_layout
24027
24028 \end_inset
24029
24030
24031 \end_layout
24032
24033 \begin_layout Standard
24034 \begin_inset Note Greyedout
24035 status open
24036
24037 \begin_layout Plain Layout
24038
24039 \series bold
24040 Note:
24041
24042 \series default
24043  The values you set with
24044 \begin_inset Flex Code
24045 status collapsed
24046
24047 \begin_layout Plain Layout
24048
24049 \backslash
24050 setlength
24051 \end_layout
24052
24053 \end_inset
24054
24055  will be used for all following multiple columns until you change them again.
24056 \end_layout
24057
24058 \end_inset
24059
24060
24061 \end_layout
24062
24063 \begin_layout Standard
24064 \begin_inset ERT
24065 status collapsed
24066
24067 \begin_layout Plain Layout
24068
24069
24070 \backslash
24071 setlength{
24072 \backslash
24073 multicolsep}{13pt}
24074 \end_layout
24075
24076 \end_inset
24077
24078
24079 \begin_inset Note Note
24080 status collapsed
24081
24082 \begin_layout Plain Layout
24083 go back to the default
24084 \end_layout
24085
24086 \end_inset
24087
24088
24089 \end_layout
24090
24091 \begin_layout Standard
24092
24093 \change_deleted 564990737 1672236355
24094 \begin_inset Newpage newpage
24095 \end_inset
24096
24097
24098 \change_unchanged
24099
24100 \end_layout
24101
24102 \begin_layout Paragraph
24103 Column Breaks
24104 \end_layout
24105
24106 \begin_layout Standard
24107 A column break can be forced by inserting the command
24108 \begin_inset Flex Code
24109 status collapsed
24110
24111 \begin_layout Plain Layout
24112
24113 \backslash
24114 columnbreak{}
24115 \end_layout
24116
24117 \end_inset
24118
24119  as \SpecialChar TeX
24120  Code to that position in the text where the column should be broken.
24121  Note that this leads in most cases to whitespace in the text.
24122 \begin_inset Newline newline
24123 \end_inset
24124
24125 Here is an example:
24126 \end_layout
24127
24128 \begin_layout Standard
24129 \begin_inset Flex Multiple Columns
24130 status open
24131
24132 \begin_layout Plain Layout
24133
24134 \size small
24135 \begin_inset Quotes eld
24136 \end_inset
24137
24138 You're surprised to see me,
24139  sir,
24140 \begin_inset Quotes erd
24141 \end_inset
24142
24143  said he,
24144  in a strange,
24145  croaking voice.
24146 \end_layout
24147
24148 \begin_layout Plain Layout
24149
24150 \size small
24151 I acknowledged that I was.
24152 \end_layout
24153
24154 \begin_layout Plain Layout
24155
24156 \size small
24157 \begin_inset Quotes eld
24158 \end_inset
24159
24160 Well,
24161  I've a conscience,
24162  sir,
24163  and when I chanced to see you go into this house,
24164  as I came hobbling after you,
24165  I thought to myself,
24166  I'll just step in and see that kind gentleman,
24167  and tell him that if I was a bit gruff in my manner there was not any harm meant,
24168  and that I am much obliged to him for picking up my books.
24169 \begin_inset Quotes erd
24170 \end_inset
24171
24172
24173 \end_layout
24174
24175 \begin_layout Plain Layout
24176
24177 \size small
24178 \begin_inset Quotes eld
24179 \end_inset
24180
24181 You make too much of a trifle,
24182 \begin_inset Quotes erd
24183 \end_inset
24184
24185  said I.
24186
24187 \begin_inset Quotes eld
24188 \end_inset
24189
24190 May I ask how you knew who I was?
24191 \begin_inset Quotes erd
24192 \end_inset
24193
24194  AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
24195 \begin_inset ERT
24196 status collapsed
24197
24198 \begin_layout Plain Layout
24199
24200
24201 \backslash
24202 columnbreak{}
24203 \end_layout
24204
24205 \end_inset
24206
24207
24208 \end_layout
24209
24210 \begin_layout Plain Layout
24211
24212 \size small
24213 \begin_inset Quotes eld
24214 \end_inset
24215
24216 Well,
24217  sir,
24218  if it isn't too great a liberty,
24219  I am a neighbour of yours,
24220  for you'll find my little bookshop at the corner of Church Street,
24221  and very happy to see you,
24222  I am sure.
24223  Maybe you collect yourself,
24224  sir.
24225  Here's
24226 \noun on
24227 British
24228 \begin_inset space ~
24229 \end_inset
24230
24231 Birds
24232 \noun default
24233 ,
24234  and
24235 \noun on
24236 Catullus
24237 \noun default
24238 ,
24239  and
24240 \noun on
24241 The Holy War
24242 \noun default
24243
24244 \begin_inset space ~
24245 \end_inset
24246
24247 – a bargain,
24248  every one of them.
24249  With five volumes you could just fill that gap on that second shelf.
24250  It looks untidy,
24251  does it not,
24252  sir?
24253 \begin_inset Quotes erd
24254 \end_inset
24255
24256
24257 \end_layout
24258
24259 \end_inset
24260
24261
24262 \end_layout
24263
24264 \begin_layout Paragraph
24265 Column Separation
24266 \end_layout
24267
24268 \begin_layout Standard
24269 The width of the columns is automatically calculated,
24270  but you can modify the space between the columns.
24271  This is done by changing the length
24272 \begin_inset Flex Code
24273 status collapsed
24274
24275 \begin_layout Plain Layout
24276
24277 \backslash
24278 columnsep
24279 \end_layout
24280
24281 \end_inset
24282
24283 .
24284  Its predefined value is 10
24285 \begin_inset space \thinspace{}
24286 \end_inset
24287
24288 pt.
24289  Here is an example where
24290 \begin_inset Flex Code
24291 status collapsed
24292
24293 \begin_layout Plain Layout
24294
24295 \backslash
24296 columnsep
24297 \end_layout
24298
24299 \end_inset
24300
24301  is set to 3
24302 \begin_inset space \thinspace{}
24303 \end_inset
24304
24305 cm:
24306 \end_layout
24307
24308 \begin_layout Standard
24309 \begin_inset ERT
24310 status open
24311
24312 \begin_layout Plain Layout
24313
24314
24315 \backslash
24316 setlength{
24317 \backslash
24318 columnsep}{3cm}
24319 \end_layout
24320
24321 \end_inset
24322
24323
24324 \end_layout
24325
24326 \begin_layout Standard
24327 \begin_inset Flex Multiple Columns
24328 status open
24329
24330 \begin_layout Plain Layout
24331
24332 \size small
24333 My observations of No.
24334 \begin_inset space \space{}
24335 \end_inset
24336
24337 427 Park Lane did little to clear up the problem in which I was interested.
24338  The house was separated from the street by a low wall and railing,
24339  the whole not more than five feet high.
24340  It was perfectly easy,
24341  therefore,
24342  for anyone to get into the garden,
24343  but the window was entirely inaccessible,
24344  since there was no water pipe or anything which could help the most active man to climb it.
24345  More puzzled than ever,
24346  I retraced my steps to Kensington.
24347  I had not been in my study five minutes when the maid entered to say that a person desired to see me.
24348  To my astonishment it was none other than my strange old book collector,
24349  his sharp,
24350  wizened face peering out from a frame of white hair,
24351  and his precious volumes,
24352  a dozen of them at least,
24353  wedged under his right arm.
24354 \end_layout
24355
24356 \end_inset
24357
24358
24359 \end_layout
24360
24361 \begin_layout Standard
24362 \begin_inset ERT
24363 status collapsed
24364
24365 \begin_layout Plain Layout
24366
24367
24368 \backslash
24369 setlength{
24370 \backslash
24371 columnsep}{10pt}
24372 \end_layout
24373
24374 \end_inset
24375
24376
24377 \begin_inset Note Note
24378 status collapsed
24379
24380 \begin_layout Plain Layout
24381 go back to the default
24382 \end_layout
24383
24384 \end_inset
24385
24386
24387 \end_layout
24388
24389 \begin_layout Paragraph
24390 Vertical Lines
24391 \end_layout
24392
24393 \begin_layout Standard
24394 Between the columns a rule with a width of the length
24395 \begin_inset Flex Code
24396 status collapsed
24397
24398 \begin_layout Plain Layout
24399
24400 \backslash
24401 columnseprule
24402 \end_layout
24403
24404 \end_inset
24405
24406  is placed.
24407  If this rule width is set to 0
24408 \begin_inset space \thinspace{}
24409 \end_inset
24410
24411 pt (this is the default),
24412  the rule is suppressed.
24413  In the following example the rule is 2
24414 \begin_inset space \thinspace{}
24415 \end_inset
24416
24417 pt wide:
24418 \end_layout
24419
24420 \begin_layout Standard
24421 \begin_inset ERT
24422 status open
24423
24424 \begin_layout Plain Layout
24425
24426
24427 \backslash
24428 setlength{
24429 \backslash
24430 columnseprule}{2pt}
24431 \end_layout
24432
24433 \end_inset
24434
24435
24436 \end_layout
24437
24438 \begin_layout Standard
24439 \begin_inset Flex Multiple Columns
24440 status open
24441
24442 \begin_layout Plain Layout
24443
24444 \size small
24445 \begin_inset Quotes eld
24446 \end_inset
24447
24448 You're surprised to see me,
24449  sir,
24450 \begin_inset Quotes erd
24451 \end_inset
24452
24453  said he,
24454  in a strange,
24455  croaking voice.
24456 \end_layout
24457
24458 \begin_layout Plain Layout
24459
24460 \size small
24461 I acknowledged that I was.
24462 \end_layout
24463
24464 \begin_layout Plain Layout
24465
24466 \size small
24467 \begin_inset Quotes eld
24468 \end_inset
24469
24470 Well,
24471  I've a conscience,
24472  sir,
24473  and when I chanced to see you go into this house,
24474  as I came hobbling after you,
24475  I thought to myself,
24476  I'll just step in and see that kind gentleman,
24477  and tell him that if I was a bit gruff in my manner there was not any harm meant,
24478  and that I am much obliged to him for picking up my books.
24479 \begin_inset Quotes erd
24480 \end_inset
24481
24482
24483 \end_layout
24484
24485 \begin_layout Plain Layout
24486
24487 \size small
24488 \begin_inset Quotes eld
24489 \end_inset
24490
24491 You make too much of a trifle,
24492 \begin_inset Quotes erd
24493 \end_inset
24494
24495  said I.
24496
24497 \begin_inset Quotes eld
24498 \end_inset
24499
24500 May I ask how you knew who I was?
24501 \begin_inset Quotes erd
24502 \end_inset
24503
24504
24505 \end_layout
24506
24507 \begin_layout Plain Layout
24508
24509 \size small
24510 \begin_inset Quotes eld
24511 \end_inset
24512
24513 Well,
24514  sir,
24515  if it isn't too great a liberty,
24516  I am a neighbour of yours,
24517  for you'll find my little bookshop at the corner of Church Street,
24518  and very happy to see you,
24519  I am sure.
24520  Maybe you collect yourself,
24521  sir.
24522  Here's
24523 \noun on
24524 British
24525 \begin_inset space ~
24526 \end_inset
24527
24528 Birds
24529 \noun default
24530 ,
24531  and
24532 \noun on
24533 Catullus
24534 \noun default
24535 ,
24536  and
24537 \noun on
24538 The Holy War
24539 \noun default
24540
24541 \begin_inset space ~
24542 \end_inset
24543
24544 – a bargain,
24545  every one of them.
24546  With five volumes you could just fill that gap on that second shelf.
24547  It looks untidy,
24548  does it not,
24549  sir?
24550 \begin_inset Quotes erd
24551 \end_inset
24552
24553
24554 \end_layout
24555
24556 \end_inset
24557
24558
24559 \end_layout
24560
24561 \begin_layout Standard
24562 \begin_inset VSpace defskip
24563 \end_inset
24564
24565
24566 \end_layout
24567
24568 \begin_layout Standard
24569 The rule can be colored by redefining the command
24570 \begin_inset Flex Code
24571 status collapsed
24572
24573 \begin_layout Plain Layout
24574
24575 \backslash
24576 columnseprulecolor
24577 \end_layout
24578
24579 \end_inset
24580
24581 .
24582  This is done by inserting the command
24583 \end_layout
24584
24585 \begin_layout LyX-Code
24586
24587 \backslash
24588 renewcommand{
24589 \backslash
24590 columnseprulecolor}{
24591 \backslash
24592 color{red}}
24593 \end_layout
24594
24595 \begin_layout Standard
24596 as \SpecialChar TeX
24597  Code before the multicolumn inset.
24598  Replace
24599 \begin_inset Flex Code
24600 status collapsed
24601
24602 \begin_layout Plain Layout
24603 red
24604 \end_layout
24605
24606 \end_inset
24607
24608  in this command by a color of your choice.
24609  You can use all pre- and self-defined colors.
24610  See the
24611 \emph on
24612 EmbeddedObjects
24613 \emph default
24614  manual,
24615  section
24616 \emph on
24617 Colored
24618 \begin_inset space ~
24619 \end_inset
24620
24621 Tables
24622 \emph default
24623  for more information about pre- and self-defined colors.
24624  To go back to the default color insert the command
24625 \end_layout
24626
24627 \begin_layout LyX-Code
24628
24629 \backslash
24630 renewcommand{
24631 \backslash
24632 columnseprulecolor}{
24633 \backslash
24634 normalcolor}
24635 \end_layout
24636
24637 \begin_layout Standard
24638 Here is the example with a cyan rule and 1
24639 \begin_inset space \thinspace{}
24640 \end_inset
24641
24642 cm column separation:
24643 \end_layout
24644
24645 \begin_layout Standard
24646 \begin_inset ERT
24647 status open
24648
24649 \begin_layout Plain Layout
24650
24651
24652 \backslash
24653 setlength{
24654 \backslash
24655 columnsep}{1cm}
24656 \end_layout
24657
24658 \begin_layout Plain Layout
24659
24660
24661 \backslash
24662 renewcommand{
24663 \backslash
24664 columnseprulecolor}{
24665 \backslash
24666 color{cyan}}
24667 \end_layout
24668
24669 \end_inset
24670
24671
24672 \end_layout
24673
24674 \begin_layout Standard
24675 \begin_inset Flex Multiple Columns
24676 status open
24677
24678 \begin_layout Plain Layout
24679
24680 \size small
24681 \begin_inset Quotes eld
24682 \end_inset
24683
24684 You're surprised to see me,
24685  sir,
24686 \begin_inset Quotes erd
24687 \end_inset
24688
24689  said he,
24690  in a strange,
24691  croaking voice.
24692 \end_layout
24693
24694 \begin_layout Plain Layout
24695
24696 \size small
24697 I acknowledged that I was.
24698 \end_layout
24699
24700 \begin_layout Plain Layout
24701
24702 \size small
24703 \begin_inset Quotes eld
24704 \end_inset
24705
24706 Well,
24707  I've a conscience,
24708  sir,
24709  and when I chanced to see you go into this house,
24710  as I came hobbling after you,
24711  I thought to myself,
24712  I'll just step in and see that kind gentleman,
24713  and tell him that if I was a bit gruff in my manner there was not any harm meant,
24714  and that I am much obliged to him for picking up my books.
24715 \begin_inset Quotes erd
24716 \end_inset
24717
24718
24719 \end_layout
24720
24721 \begin_layout Plain Layout
24722
24723 \size small
24724 \begin_inset Quotes eld
24725 \end_inset
24726
24727 You make too much of a trifle,
24728 \begin_inset Quotes erd
24729 \end_inset
24730
24731  said I.
24732
24733 \begin_inset Quotes eld
24734 \end_inset
24735
24736 May I ask how you knew who I was?
24737 \begin_inset Quotes erd
24738 \end_inset
24739
24740
24741 \end_layout
24742
24743 \begin_layout Plain Layout
24744
24745 \size small
24746 \begin_inset Quotes eld
24747 \end_inset
24748
24749 Well,
24750  sir,
24751  if it isn't too great a liberty,
24752  I am a neighbour of yours,
24753  for you'll find my little bookshop at the corner of Church Street,
24754  and very happy to see you,
24755  I am sure.
24756  Maybe you collect yourself,
24757  sir.
24758  Here's
24759 \noun on
24760 British
24761 \begin_inset space ~
24762 \end_inset
24763
24764 Birds
24765 \noun default
24766 ,
24767  and
24768 \noun on
24769 Catullus
24770 \noun default
24771 ,
24772  and
24773 \noun on
24774 The Holy War
24775 \noun default
24776
24777 \begin_inset space ~
24778 \end_inset
24779
24780 – a bargain,
24781  every one of them.
24782  With five volumes you could just fill that gap on that second shelf.
24783  It looks untidy,
24784  does it not,
24785  sir?
24786 \begin_inset Quotes erd
24787 \end_inset
24788
24789
24790 \end_layout
24791
24792 \end_inset
24793
24794
24795 \end_layout
24796
24797 \begin_layout Standard
24798 \begin_inset ERT
24799 status collapsed
24800
24801 \begin_layout Plain Layout
24802
24803
24804 \backslash
24805 setlength{
24806 \backslash
24807 columnseprule}{0pt}
24808 \end_layout
24809
24810 \begin_layout Plain Layout
24811
24812
24813 \backslash
24814 renewcommand{
24815 \backslash
24816 columnseprulecolor}{
24817 \backslash
24818 normalcolor}
24819 \end_layout
24820
24821 \end_inset
24822
24823
24824 \begin_inset Note Note
24825 status collapsed
24826
24827 \begin_layout Plain Layout
24828 go back to the default
24829 \end_layout
24830
24831 \end_inset
24832
24833
24834 \end_layout
24835
24836 \begin_layout Section
24837
24838 \change_inserted 564990737 1671270380
24839 Paragraph Styles
24840 \end_layout
24841
24842 \begin_layout Subsection
24843
24844 \change_inserted 564990737 1671270398
24845 Custom
24846 \change_deleted 564990737 1671270396
24847 Non-standard
24848 \change_unchanged
24849  Paragraph Shapes
24850 \end_layout
24851
24852 \begin_layout Standard
24853 \noindent
24854 \SpecialChar LaTeX
24855  as well as any other text processor uses by default rectangular paragraphs.
24856  For special cases like for example posters,
24857  invitation cards or poems you can modify the paragraph shape to one of your choice.
24858
24859 \change_deleted 564990737 1672311802
24860 This can be done by using the \SpecialChar LaTeX
24861 -package
24862 \begin_inset Flex Code
24863 status collapsed
24864
24865 \begin_layout Plain Layout
24866 shapepar
24867 \end_layout
24868
24869 \end_inset
24870
24871  which is loaded by using in the document settings the module
24872 \family sans
24873 Custom paragraph shapes
24874 \family default
24875 .
24876 \change_inserted 564990737 1672311802
24877 This module uses the
24878 \family sans
24879 shapepar
24880 \family default
24881  package to provide over a dozen paragraph shapes as well as commands to define custom shapes.
24882
24883 \change_unchanged
24884
24885 \end_layout
24886
24887 \begin_layout Subsubsection
24888 Predefined shapes
24889 \end_layout
24890
24891 \begin_layout Standard
24892
24893 \change_inserted -712698321 1674913874
24894
24895 \series bold
24896 The
24897 \change_unchanged
24898
24899 \family sans
24900 \series default
24901 shapepar
24902 \family default
24903
24904 \change_inserted -712698321 1674913877
24905 package
24906 \change_unchanged
24907 provides the following shapes:
24908 \end_layout
24909
24910 \begin_layout Standard
24911 \begin_inset Tabular
24912 <lyxtabular version="3" rows="13" columns="3">
24913 <features booktabs="true" islongtable="true" longtabularalignment="center">
24914 <column alignment="left" valignment="middle" width="16col%">
24915 <column alignment="left" valignment="middle" width="40col%">
24916 <column alignment="left" valignment="middle" width="35col%">
24917 <row endhead="true">
24918 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
24919 \begin_inset Text
24920
24921 \begin_layout Plain Layout
24922
24923 \series bold
24924 \size small
24925 Name
24926 \end_layout
24927
24928 \end_inset
24929 </cell>
24930 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
24931 \begin_inset Text
24932
24933 \begin_layout Plain Layout
24934
24935 \series bold
24936 \size small
24937 Description
24938 \end_layout
24939
24940 \end_inset
24941 </cell>
24942 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
24943 \begin_inset Text
24944
24945 \begin_layout Plain Layout
24946
24947 \series bold
24948 \size small
24949 Annotation
24950 \end_layout
24951
24952 \end_inset
24953 </cell>
24954 </row>
24955 <row interlinespace="default">
24956 <cell alignment="left" valignment="top" usebox="none">
24957 \begin_inset Text
24958
24959 \begin_layout Plain Layout
24960
24961 \size small
24962 CDlabel
24963 \end_layout
24964
24965 \end_inset
24966 </cell>
24967 <cell alignment="left" valignment="top" usebox="none">
24968 \begin_inset Text
24969
24970 \begin_layout Plain Layout
24971
24972 \size small
24973 Circle with circular hole (in the size of a CD/DVD)
24974 \end_layout
24975
24976 \end_inset
24977 </cell>
24978 <cell alignment="left" valignment="top" usebox="none">
24979 \begin_inset Text
24980
24981 \begin_layout Plain Layout
24982
24983 \size small
24984 Cannot be scaled,
24985  take care there is not too much text
24986 \end_layout
24987
24988 \end_inset
24989 </cell>
24990 </row>
24991 <row interlinespace="default">
24992 <cell alignment="left" valignment="top" usebox="none">
24993 \begin_inset Text
24994
24995 \begin_layout Plain Layout
24996
24997 \size small
24998 Circle
24999 \end_layout
25000
25001 \end_inset
25002 </cell>
25003 <cell alignment="left" valignment="top" usebox="none">
25004 \begin_inset Text
25005
25006 \begin_layout Plain Layout
25007
25008 \size small
25009 Circle
25010 \end_layout
25011
25012 \end_inset
25013 </cell>
25014 <cell alignment="left" valignment="top" usebox="none">
25015 \begin_inset Text
25016
25017 \begin_layout Plain Layout
25018
25019 \size small
25020 Fragile,
25021  calculation might fail
25022 \end_layout
25023
25024 \end_inset
25025 </cell>
25026 </row>
25027 <row interlinespace="default">
25028 <cell alignment="left" valignment="top" usebox="none">
25029 \begin_inset Text
25030
25031 \begin_layout Plain Layout
25032
25033 \size small
25034 Diamond
25035 \end_layout
25036
25037 \end_inset
25038 </cell>
25039 <cell alignment="left" valignment="top" usebox="none">
25040 \begin_inset Text
25041
25042 \begin_layout Plain Layout
25043
25044 \size small
25045 Rhomboid (symbolizing a
25046 \begin_inset Quotes eld
25047 \end_inset
25048
25049 diamond
25050 \begin_inset Quotes erd
25051 \end_inset
25052
25053 )
25054 \end_layout
25055
25056 \end_inset
25057 </cell>
25058 <cell alignment="left" valignment="top" usebox="none">
25059 \begin_inset Text
25060
25061 \begin_layout Plain Layout
25062
25063 \size small
25064 -
25065 \end_layout
25066
25067 \end_inset
25068 </cell>
25069 </row>
25070 <row interlinespace="default">
25071 <cell alignment="left" valignment="top" usebox="none">
25072 \begin_inset Text
25073
25074 \begin_layout Plain Layout
25075
25076 \size small
25077 Heart
25078 \end_layout
25079
25080 \end_inset
25081 </cell>
25082 <cell alignment="left" valignment="top" usebox="none">
25083 \begin_inset Text
25084
25085 \begin_layout Plain Layout
25086
25087 \size small
25088 Heart-like shape
25089 \end_layout
25090
25091 \end_inset
25092 </cell>
25093 <cell alignment="left" valignment="top" usebox="none">
25094 \begin_inset Text
25095
25096 \begin_layout Plain Layout
25097
25098 \size small
25099 -
25100 \end_layout
25101
25102 \end_inset
25103 </cell>
25104 </row>
25105 <row interlinespace="default">
25106 <cell alignment="left" valignment="top" usebox="none">
25107 \begin_inset Text
25108
25109 \begin_layout Plain Layout
25110
25111 \size small
25112 Hexagon
25113 \end_layout
25114
25115 \end_inset
25116 </cell>
25117 <cell alignment="left" valignment="top" usebox="none">
25118 \begin_inset Text
25119
25120 \begin_layout Plain Layout
25121
25122 \size small
25123 Hexagon
25124 \end_layout
25125
25126 \end_inset
25127 </cell>
25128 <cell alignment="left" valignment="top" usebox="none">
25129 \begin_inset Text
25130
25131 \begin_layout Plain Layout
25132
25133 \size small
25134 -
25135 \end_layout
25136
25137 \end_inset
25138 </cell>
25139 </row>
25140 <row interlinespace="default">
25141 <cell alignment="left" valignment="top" usebox="none">
25142 \begin_inset Text
25143
25144 \begin_layout Plain Layout
25145
25146 \size small
25147 Nut
25148 \end_layout
25149
25150 \end_inset
25151 </cell>
25152 <cell alignment="left" valignment="top" usebox="none">
25153 \begin_inset Text
25154
25155 \begin_layout Plain Layout
25156
25157 \size small
25158 Nut for bolt (hexagon with circular hole)
25159 \end_layout
25160
25161 \end_inset
25162 </cell>
25163 <cell alignment="left" valignment="top" usebox="none">
25164 \begin_inset Text
25165
25166 \begin_layout Plain Layout
25167
25168 \size small
25169 -
25170 \end_layout
25171
25172 \end_inset
25173 </cell>
25174 </row>
25175 <row interlinespace="default">
25176 <cell alignment="left" valignment="top" usebox="none">
25177 \begin_inset Text
25178
25179 \begin_layout Plain Layout
25180
25181 \size small
25182 Square
25183 \end_layout
25184
25185 \end_inset
25186 </cell>
25187 <cell alignment="left" valignment="top" usebox="none">
25188 \begin_inset Text
25189
25190 \begin_layout Plain Layout
25191
25192 \size small
25193 Square
25194 \end_layout
25195
25196 \end_inset
25197 </cell>
25198 <cell alignment="left" valignment="top" usebox="none">
25199 \begin_inset Text
25200
25201 \begin_layout Plain Layout
25202
25203 \size small
25204 -
25205 \end_layout
25206
25207 \end_inset
25208 </cell>
25209 </row>
25210 <row interlinespace="default">
25211 <cell alignment="left" valignment="top" usebox="none">
25212 \begin_inset Text
25213
25214 \begin_layout Plain Layout
25215
25216 \size small
25217 Star
25218 \end_layout
25219
25220 \end_inset
25221 </cell>
25222 <cell alignment="left" valignment="top" usebox="none">
25223 \begin_inset Text
25224
25225 \begin_layout Plain Layout
25226
25227 \size small
25228 Five-point star
25229 \end_layout
25230
25231 \end_inset
25232 </cell>
25233 <cell alignment="left" valignment="top" usebox="none">
25234 \begin_inset Text
25235
25236 \begin_layout Plain Layout
25237
25238 \size small
25239 -
25240 \end_layout
25241
25242 \end_inset
25243 </cell>
25244 </row>
25245 <row interlinespace="default">
25246 <cell alignment="left" valignment="top" usebox="none">
25247 \begin_inset Text
25248
25249 \begin_layout Plain Layout
25250
25251 \size small
25252 Candle
25253 \end_layout
25254
25255 \end_inset
25256 </cell>
25257 <cell alignment="left" valignment="top" usebox="none">
25258 \begin_inset Text
25259
25260 \begin_layout Plain Layout
25261
25262 \size small
25263 Burning candle
25264 \end_layout
25265
25266 \end_inset
25267 </cell>
25268 <cell alignment="left" valignment="top" usebox="none">
25269 \begin_inset Text
25270
25271 \begin_layout Plain Layout
25272
25273 \size small
25274 -
25275 \end_layout
25276
25277 \end_inset
25278 </cell>
25279 </row>
25280 <row interlinespace="default">
25281 <cell alignment="left" valignment="top" usebox="none">
25282 \begin_inset Text
25283
25284 \begin_layout Plain Layout
25285
25286 \size small
25287 Drop down/up
25288 \end_layout
25289
25290 \end_inset
25291 </cell>
25292 <cell alignment="left" valignment="top" usebox="none">
25293 \begin_inset Text
25294
25295 \begin_layout Plain Layout
25296
25297 \size small
25298 Normal/reversed rain drop
25299 \end_layout
25300
25301 \end_inset
25302 </cell>
25303 <cell alignment="left" valignment="top" usebox="none">
25304 \begin_inset Text
25305
25306 \begin_layout Plain Layout
25307
25308 \size small
25309 Fragile,
25310  calculation might fail
25311 \end_layout
25312
25313 \end_inset
25314 </cell>
25315 </row>
25316 <row interlinespace="default">
25317 <cell alignment="left" valignment="top" usebox="none">
25318 \begin_inset Text
25319
25320 \begin_layout Plain Layout
25321
25322 \size small
25323 \SpecialChar TeX
25324
25325 \end_layout
25326
25327 \end_inset
25328 </cell>
25329 <cell alignment="left" valignment="top" usebox="none">
25330 \begin_inset Text
25331
25332 \begin_layout Plain Layout
25333
25334 \size small
25335 The \SpecialChar TeX
25336  logo
25337 \end_layout
25338
25339 \end_inset
25340 </cell>
25341 <cell alignment="left" valignment="top" usebox="none">
25342 \begin_inset Text
25343
25344 \begin_layout Plain Layout
25345
25346 \size small
25347 -
25348 \end_layout
25349
25350 \end_inset
25351 </cell>
25352 </row>
25353 <row interlinespace="default">
25354 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
25355 \begin_inset Text
25356
25357 \begin_layout Plain Layout
25358
25359 \size small
25360 Triangle up/down/
25361 \begin_inset Newline newline
25362 \end_inset
25363
25364 left/right
25365 \end_layout
25366
25367 \end_inset
25368 </cell>
25369 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
25370 \begin_inset Text
25371
25372 \begin_layout Plain Layout
25373
25374 \size small
25375 Triangles in different orientations
25376 \end_layout
25377
25378 \end_inset
25379 </cell>
25380 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
25381 \begin_inset Text
25382
25383 \begin_layout Plain Layout
25384
25385 \size small
25386 -
25387 \end_layout
25388
25389 \end_inset
25390 </cell>
25391 </row>
25392 </lyxtabular>
25393
25394 \end_inset
25395
25396
25397 \end_layout
25398
25399 \begin_layout Standard
25400 To use a shape for your paragraph,
25401  simply select it in \SpecialChar LyX
25402 's pull-down box for environments in the toolbar.
25403 \end_layout
25404
25405 \begin_layout Standard
25406 \begin_inset Newpage newpage
25407 \end_inset
25408
25409
25410 \end_layout
25411
25412 \begin_layout Standard
25413 Here is an example paragraph in the shape of a nut:
25414 \end_layout
25415
25416 \begin_layout Standard
25417 \begin_inset VSpace bigskip
25418 \end_inset
25419
25420
25421 \end_layout
25422
25423 \begin_layout Nut
25424
25425 \lang latin
25426 Lorem ipsum dolor sit amet,
25427  consetetur sadipscing elitr,
25428  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
25429  sed diam voluptua.
25430  At vero eos et accusam et justo duo dolores et ea rebum.
25431  Stet clita kasd gubergren,
25432  no sea takimata sanctus est Lorem ipsum dolor sit amet.
25433  Lorem ipsum dolor sit amet,
25434  consetetur sadipscing elitr,
25435  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
25436  sed diam voluptua.
25437 \end_layout
25438
25439 \begin_layout Standard
25440 \begin_inset VSpace bigskip
25441 \end_inset
25442
25443
25444 \end_layout
25445
25446 \begin_layout Standard
25447 \begin_inset Note Greyedout
25448 status open
25449
25450 \begin_layout Plain Layout
25451
25452 \series bold
25453 Note
25454 \series default
25455 :
25456
25457 \family sans
25458 shapepar
25459 \family default
25460  paragraphs cannot run over a page break.
25461 \end_layout
25462
25463 \end_inset
25464
25465
25466 \end_layout
25467
25468 \begin_layout Standard
25469 \begin_inset VSpace bigskip
25470 \end_inset
25471
25472
25473 \end_layout
25474
25475 \begin_layout Standard
25476 The package
25477 \begin_inset Flex Code
25478 status collapsed
25479
25480 \begin_layout Plain Layout
25481 shapepar
25482 \end_layout
25483
25484 \end_inset
25485
25486  takes care that the shape will always be preserved,
25487  no matter how much text is in the paragraph.
25488  Therefore the paragraph size changes with the amount of contained text.
25489  This can lead to paragraph sizes exceeding the page margins.
25490  To demonstrate the size scaling,
25491  here is the same example paragraph but with twice as much text:
25492 \end_layout
25493
25494 \begin_layout Standard
25495 \begin_inset Newpage newpage
25496 \end_inset
25497
25498
25499 \end_layout
25500
25501 \begin_layout Nut
25502
25503 \lang latin
25504 Lorem ipsum dolor sit amet,
25505  consetetur sadipscing elitr,
25506  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
25507  sed diam voluptua.
25508  At vero eos et accusam et justo duo dolores et ea rebum.
25509  Stet clita kasd gubergren,
25510  no sea takimata sanctus est Lorem ipsum dolor sit amet.
25511  Lorem ipsum dolor sit amet,
25512  consetetur sadipscing elitr,
25513  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
25514  sed diam voluptua.
25515  Lorem ipsum dolor sit amet,
25516  consetetur sadipscing elitr,
25517  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
25518  sed diam voluptua.
25519  At vero eos et accusam et justo duo dolores et ea rebum.
25520  Stet clita kasd gubergren,
25521  no sea takimata sanctus est Lorem ipsum dolor sit amet.
25522  Lorem ipsum dolor sit amet,
25523  consetetur sadipscing elitr,
25524  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
25525  sed diam voluptua.
25526 \end_layout
25527
25528 \begin_layout Standard
25529 \begin_inset VSpace bigskip
25530 \end_inset
25531
25532
25533 \end_layout
25534
25535 \begin_layout Standard
25536 An exception is the shape
25537 \family sans
25538 CDlabel
25539 \family default
25540 .
25541  It cannot be scaled because it must fit the size of a CD/DVD.
25542  Therefore the amount of text that fits into the shape is limited.
25543 \change_deleted -712698321 1674914001
25544
25545 \begin_inset Newline newline
25546 \end_inset
25547
25548
25549 \change_inserted -712698321 1674914001
25550
25551 \end_layout
25552
25553 \begin_layout Standard
25554 The
25555 \family sans
25556 drop
25557 \family default
25558  shapes and the
25559 \family sans
25560 circle
25561 \family default
25562  shape are fragile,
25563  meaning that the calculation of their size can fail,
25564  depending on the amount of text.
25565  You will then get the \SpecialChar LaTeX
25566  error
25567 \begin_inset Quotes eld
25568 \end_inset
25569
25570 Arithmetic overflow
25571 \begin_inset Quotes erd
25572 \end_inset
25573
25574 .
25575  In this case one can try to remove or add some text;
25576  if nothing works one has to use another shape.
25577 \end_layout
25578
25579 \begin_layout Standard
25580
25581 \change_deleted -712698321 1674914021
25582 \begin_inset VSpace bigskip
25583 \end_inset
25584
25585
25586 \change_unchanged
25587
25588 \end_layout
25589
25590 \begin_layout Standard
25591 For shapes with tips you will maybe see that \SpecialChar LaTeX
25592 's hyphenation routine fails for text in the tips.
25593  Therefore it is often necessary to add hyphenation points
25594 \family sans
25595 (
25596 \begin_inset Info
25597 type  "shortcut"
25598 arg   "specialchar-insert hyphenation"
25599 \end_inset
25600
25601
25602 \family default
25603 ) to the corresponding text parts.
25604 \end_layout
25605
25606 \begin_layout Standard
25607
25608 \change_deleted -712698321 1674914022
25609 \begin_inset VSpace bigskip
25610 \end_inset
25611
25612
25613 \change_unchanged
25614
25615 \end_layout
25616
25617 \begin_layout Standard
25618 Shapepar paragraphs are either always centered or placed on the page so that their left border touches the left page margin.
25619  You can therefore not use the paragraph dialog to align such paragraphs.
25620  A solution is to put the paragraph into a minipage or parbox and align the box.
25621  The problem is hereby to find the right width for the box.
25622  Because if it is too wide and you center the box,
25623  the paragraph is not centered too because it sticks at the left side of the box.
25624  So you might have to play a bit with the width until it fits.
25625  Here are two heart-shaped paragraphs,
25626  the first one is not aligned,
25627  the second one is right-aligned:
25628 \end_layout
25629
25630 \begin_layout Standard
25631 \begin_inset Newpage newpage
25632 \end_inset
25633
25634
25635 \end_layout
25636
25637 \begin_layout Heart
25638 \noindent
25639
25640 \lang latin
25641 Lo\SpecialChar softhyphen
25642 rem ipsum dolor sit amet,
25643  consetetur sadipscing elitr,
25644  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
25645  sed diam voluptua.
25646  At vero eos et accusam et justo duo dolores et ea rebum.
25647  Stet clita kasd gubergren,
25648  no sea takimata sanctus est Lorem ipsum dolor sit amet.
25649 \end_layout
25650
25651 \begin_layout Standard
25652 \begin_inset VSpace bigskip
25653 \end_inset
25654
25655
25656 \end_layout
25657
25658 \begin_layout Standard
25659 \noindent
25660 \align right
25661 \begin_inset Box Frameless
25662 position "t"
25663 hor_pos "c"
25664 has_inner_box 1
25665 inner_pos "t"
25666 use_parbox 1
25667 use_makebox 0
25668 width "42col%"
25669 special "none"
25670 height "1in"
25671 height_special "totalheight"
25672 thickness "0.4pt"
25673 separation "3pt"
25674 shadowsize "4pt"
25675 framecolor "black"
25676 backgroundcolor "none"
25677 status open
25678
25679 \begin_layout Heart
25680 \noindent
25681
25682 \lang latin
25683 Lo\SpecialChar softhyphen
25684 rem ipsum dolor sit amet,
25685  consetetur sadipscing elitr,
25686  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
25687  sed diam voluptua.
25688  At vero eos et accusam et justo duo dolores et ea rebum.
25689  Stet clita kasd gubergren,
25690  no sea takimata sanctus est Lorem ipsum dolor sit amet.
25691 \end_layout
25692
25693 \end_inset
25694
25695
25696 \end_layout
25697
25698 \begin_layout Subsubsection
25699 Custom shapes
25700 \end_layout
25701
25702 \begin_layout Standard
25703 You can define any shape you want.
25704  Doing this manually is a lot of work because every coordinate must be specified.
25705  But there is a way to let the computer calculate the coordinates:
25706 \end_layout
25707
25708 \begin_layout Enumerate
25709 Install the program
25710 \begin_inset CommandInset href
25711 LatexCommand href
25712 name "Jpgfdraw"
25713 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
25714 literal "false"
25715
25716 \end_inset
25717
25718 .
25719 \end_layout
25720
25721 \begin_layout Enumerate
25722 In
25723 \family sans
25724 Jpgfdraw
25725 \family default
25726  go to the menu
25727 \family sans
25728 TeX/LaTeX\SpecialChar menuseparator
25729 Settings\SpecialChar menuseparator
25730 Set Normal Size
25731 \family default
25732  and select the font size you are using in your document.
25733  For example this document uses the size 12
25734 \begin_inset space \thinspace{}
25735 \end_inset
25736
25737 pt.
25738 \end_layout
25739
25740 \begin_layout Enumerate
25741 Draw a shape.
25742 \end_layout
25743
25744 \begin_layout Enumerate
25745 Use the menu
25746 \family sans
25747 TeX/LaTeX\SpecialChar menuseparator
25748 Shapepar
25749 \family default
25750  to export the shape to coordinates.
25751  In the appearing dialog use either the outline of your shape for the coordinates or the path itself.
25752 \begin_inset Foot
25753 status collapsed
25754
25755 \begin_layout Plain Layout
25756 For more information see
25757 \begin_inset CommandInset href
25758 LatexCommand href
25759 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
25760 literal "false"
25761
25762 \end_inset
25763
25764
25765 \end_layout
25766
25767 \end_inset
25768
25769
25770 \end_layout
25771
25772 \begin_layout Standard
25773 The coordinates are written into a \SpecialChar TeX
25774  file.
25775  To use it for your \SpecialChar LyX
25776  document
25777 \end_layout
25778
25779 \begin_layout Enumerate
25780 Place the cursor before the first character of your paragraph (or into a new empty one).
25781 \end_layout
25782
25783 \begin_layout Enumerate
25784 Open in \SpecialChar LyX
25785  the menu
25786 \family sans
25787 Insert\SpecialChar menuseparator
25788 File\SpecialChar menuseparator
25789 Child
25790 \begin_inset space ~
25791 \end_inset
25792
25793 Document
25794 \family default
25795 ,
25796  select the file and use
25797 \family sans
25798 Input
25799 \family default
25800  as
25801 \family sans
25802 Include Type.
25803 \end_layout
25804
25805 \begin_layout Standard
25806 \begin_inset VSpace defskip
25807 \end_inset
25808
25809
25810 \end_layout
25811
25812 \begin_layout Standard
25813 \begin_inset Note Greyedout
25814 status open
25815
25816 \begin_layout Plain Layout
25817
25818 \series bold
25819 Note
25820 \series default
25821 :
25822  The changed shape only applies to the current paragraph;
25823  everything is reset to normal for the next paragraph.
25824  Therefore the shape definition file must be input into every paragraph with the desired shape.
25825 \end_layout
25826
25827 \end_inset
25828
25829
25830 \end_layout
25831
25832 \begin_layout Standard
25833 \begin_inset VSpace bigskip
25834 \end_inset
25835
25836
25837 \end_layout
25838
25839 \begin_layout Standard
25840 Here is an example:
25841 \end_layout
25842
25843 \begin_layout Standard
25844 \begin_inset VSpace bigskip
25845 \end_inset
25846
25847
25848 \end_layout
25849
25850 \begin_layout Standard
25851 \begin_inset CommandInset include
25852 LatexCommand input
25853 filename "SpecialParagraphShape.tex"
25854 literal "true"
25855
25856 \end_inset
25857
25858
25859 \lang latin
25860 Lorem ipsum dolor sit amet,
25861  consetetur sadipscing elitr,
25862  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
25863  sed diam voluptua.
25864  At vero eos et accusam et justo duo dolores et ea rebum.
25865  Stet clita kasd gubergren,
25866  no sea takimata sanctus est Lorem ipsum dolor sit amet.
25867  Lorem ipsum dolor sit amet,
25868  consetetur sadipscing elitr,
25869  sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
25870  sed diam voluptua.
25871 \end_layout
25872
25873 \begin_layout Standard
25874 \begin_inset VSpace bigskip
25875 \end_inset
25876
25877
25878 \end_layout
25879
25880 \begin_layout Standard
25881
25882 \series bold
25883 A tip:
25884
25885 \series default
25886  to draw complexer shapes in
25887 \family sans
25888 Jpgfdraw
25889 \family default
25890  you can draw the shape in a program of your choice and import the resulting image to
25891 \family sans
25892 Jpgfdraw
25893 \family default
25894 .
25895  Then you only need to draw a line or spline along the outline of the image.
25896 \end_layout
25897
25898 \begin_layout Standard
25899
25900 \change_deleted -712698321 1674914114
25901 \begin_inset VSpace bigskip
25902 \end_inset
25903
25904
25905 \change_unchanged
25906
25907 \end_layout
25908
25909 \begin_layout Standard
25910 The module
25911 \family sans
25912 Custom paragraph shapes
25913 \family default
25914  also provides the two commands
25915 \family sans
25916 shapepar
25917 \family default
25918  and
25919 \family sans
25920 Shapepar
25921 \family default
25922  which can be used to define custom shapes coordinate by coordinate.
25923 \begin_inset Foot
25924 status collapsed
25925
25926 \begin_layout Plain Layout
25927 These commands are internally used for all shapes described here.
25928 \end_layout
25929
25930 \end_inset
25931
25932  For information how these styles are used and about further customization possibilities,
25933  have a look at the
25934 \begin_inset CommandInset href
25935 LatexCommand href
25936 name "documentation"
25937 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
25938 literal "false"
25939
25940 \end_inset
25941
25942  of the package
25943 \begin_inset Flex Code
25944 status collapsed
25945
25946 \begin_layout Plain Layout
25947 shapepar
25948 \end_layout
25949
25950 \end_inset
25951
25952 .
25953 \end_layout
25954
25955 \begin_layout Subsection
25956
25957 \change_inserted 564990737 1672311925
25958 Hanging Paragraphs
25959 \end_layout
25960
25961 \begin_layout Hanging
25962
25963 \change_inserted 564990737 1672311925
25964 This module adds the
25965 \family sans
25966 Hanging
25967 \family default
25968  paragraph style,
25969  that is,
25970  one where all but the first line of the paragraph is indented.
25971  This may not appear in your \SpecialChar LyX
25972  document but will appear in the final output.
25973 \end_layout
25974
25975 \begin_layout Subsection
25976
25977 \change_inserted 564990737 1672311925
25978 \begin_inset CommandInset label
25979 LatexCommand label
25980 name "subsec:Initials"
25981
25982 \end_inset
25983
25984 Initials (Drop Caps)
25985 \end_layout
25986
25987 \begin_layout Initial
25988
25989 \change_inserted 564990737 1672311925
25990 \begin_inset Argument 2
25991 status open
25992
25993 \begin_layout Plain Layout
25994
25995 \change_inserted 564990737 1672311925
25996 T
25997 \change_unchanged
25998
25999 \end_layout
26000
26001 \end_inset
26002
26003
26004 \begin_inset Argument 3
26005 status open
26006
26007 \begin_layout Plain Layout
26008
26009 \change_inserted 564990737 1672311925
26010 his
26011 \change_unchanged
26012
26013 \end_layout
26014
26015 \end_inset
26016
26017  module adds a drop capitals paragraph style
26018 \family sans
26019 Initials
26020 \family default
26021  for paragraph environments which you can use wherever you want to have drop capitals.
26022  You then have three more items in the
26023 \family sans
26024 Insert
26025 \family default
26026  menu:
26027 \end_layout
26028
26029 \begin_layout Itemize
26030
26031 \change_inserted 564990737 1672311925
26032
26033 \family sans
26034 Initial
26035 \family default
26036  which creates an inset for the drop capital
26037 \end_layout
26038
26039 \begin_layout Itemize
26040
26041 \change_inserted 564990737 1672311925
26042
26043 \family sans
26044 Rest of initial
26045 \family default
26046  which creates an inset for the rest of the word
26047 \end_layout
26048
26049 \begin_layout Itemize
26050
26051 \change_inserted 564990737 1672311925
26052
26053 \family sans
26054 Options
26055 \family default
26056  which allow you configure the formatting of the drop capital.
26057 \end_layout
26058
26059 \begin_layout Standard
26060
26061 \change_inserted 564990737 1672311925
26062 To customize the appearance of the style,
26063  see
26064 \family sans
26065 Help\SpecialChar menuseparator
26066 Embedded Objects\SpecialChar menuseparator
26067 Objects Surrounded by Text\SpecialChar menuseparator
26068 Initials
26069 \family default
26070 .
26071 \end_layout
26072
26073 \begin_layout Section
26074
26075 \change_inserted 564990737 1672312011
26076 Text Markup
26077 \end_layout
26078
26079 \begin_layout Subsection
26080
26081 \change_inserted 564990737 1672312011
26082 Hyphenatable Text Markup
26083 \change_inserted -712698321 1674915075
26084  (Soul)
26085 \change_inserted 564990737 1672312011
26086
26087 \end_layout
26088
26089 \begin_layout Standard
26090
26091 \change_inserted 564990737 1672312011
26092 This
26093 \change_deleted -712698321 1674915086
26094 package
26095 \change_inserted -712698321 1674915087
26096 modul
26097 \change_inserted 564990737 1672312011
26098  defines text styles to highlight,
26099  space-out,
26100  strike-through,
26101  underline and capitalize/small-cap text by means of the
26102 \family sans
26103 soul
26104 \family default
26105  package.
26106
26107 \change_inserted -712698321 1674915141
26108
26109 \end_layout
26110
26111 \begin_layout Standard
26112
26113 \change_inserted 564990737 1672312011
26114 As opposed to the markup provided by the Text Properties dialog,
26115  words marked-up with
26116 \family sans
26117 soul
26118 \family default
26119  are hyphenated.
26120  See the
26121 \begin_inset CommandInset href
26122 LatexCommand href
26123 name "soul documentation"
26124 target "http://mirrors.ctan.org/macros/generic/soul/soul.pdf"
26125 literal "false"
26126
26127 \end_inset
26128
26129 .
26130 \end_layout
26131
26132 \begin_layout Subsection
26133
26134 \change_inserted 564990737 1672312011
26135 Logical Markup
26136 \end_layout
26137
26138 \begin_layout Standard
26139
26140 \change_inserted 564990737 1672312011
26141 This module defines some character styles for logical markup:
26142
26143 \noun on
26144
26145 \begin_inset Flex Noun
26146 status collapsed
26147
26148 \begin_layout Plain Layout
26149
26150 \change_inserted 564990737 1672312011
26151
26152 \noun on
26153 noun
26154 \change_unchanged
26155
26156 \end_layout
26157
26158 \end_inset
26159
26160
26161 \noun default
26162 ,
26163
26164 \emph on
26165
26166 \begin_inset Flex Emph
26167 status collapsed
26168
26169 \begin_layout Plain Layout
26170
26171 \change_inserted 564990737 1672312011
26172
26173 \emph on
26174 emph
26175 \change_unchanged
26176
26177 \end_layout
26178
26179 \end_inset
26180
26181
26182 \emph default
26183 ,
26184
26185 \begin_inset Flex Strong
26186 status collapsed
26187
26188 \begin_layout Plain Layout
26189
26190 \change_inserted 564990737 1672312011
26191 strong
26192 \change_unchanged
26193
26194 \end_layout
26195
26196 \end_inset
26197
26198 ,
26199  and
26200 \begin_inset Flex Code
26201 status collapsed
26202
26203 \begin_layout Plain Layout
26204
26205 \change_inserted 564990737 1672312011
26206 code
26207 \change_unchanged
26208
26209 \end_layout
26210
26211 \end_inset
26212
26213  which are accessed via the
26214 \family sans
26215 \bar under
26216 E
26217 \bar default
26218 dit\SpecialChar menuseparator
26219 Custom
26220 \begin_inset space ~
26221 \end_inset
26222
26223 Text
26224 \begin_inset space ~
26225 \end_inset
26226
26227
26228 \bar under
26229 S
26230 \bar default
26231 tyles
26232 \family default
26233  menu.
26234 \end_layout
26235
26236 \begin_layout Chapter
26237
26238 \change_deleted 564990737 1671304317
26239 Customizing
26240 \change_unchanged
26241 Bibliograph
26242 \change_inserted 564990737 1671304322
26243 y
26244 \change_deleted 564990737 1671304331
26245 ies with Bib\SpecialChar TeX
26246  or Biblatex
26247 \change_unchanged
26248
26249 \end_layout
26250
26251 \begin_layout Standard
26252 The most basic information about how to use Bib\SpecialChar TeX
26253  or
26254 \family sans
26255 Biblatex
26256 \family default
26257  with \SpecialChar LyX
26258  is contained in the section
26259 \emph on
26260 Bibliography databases
26261 \emph default
26262  of the
26263 \emph on
26264 User's Guide
26265 \emph default
26266 .
26267  The following subsections explain special bibliography features supported by \SpecialChar LyX
26268 .
26269 \end_layout
26270
26271 \begin_layout Section
26272 Alternative Citation Styles
26273 \end_layout
26274
26275 \begin_layout Standard
26276 Standard Bib\SpecialChar TeX
26277  uses numbers (e.
26278 \begin_inset space \thinspace{}
26279 \end_inset
26280
26281 g.
26282 \begin_inset space \space{}
26283 \end_inset
26284
26285
26286 \begin_inset Quotes eld
26287 \end_inset
26288
26289 [12]
26290 \begin_inset Quotes erd
26291 \end_inset
26292
26293 ) to refer to a cited work.
26294  However,
26295  in many scientific disciplines,
26296  other citation styles are in use.
26297  The most common one is the author-year style (e.
26298 \begin_inset space \thinspace{}
26299 \end_inset
26300
26301 g.
26302 \begin_inset space \space{}
26303 \end_inset
26304
26305
26306 \begin_inset Quotes eld
26307 \end_inset
26308
26309 Knuth 1984a
26310 \begin_inset Quotes erd
26311 \end_inset
26312
26313 ).
26314  \SpecialChar LyX
26315  supports three packages that provide this style,
26316
26317 \begin_inset Flex Code
26318 status collapsed
26319
26320 \begin_layout Plain Layout
26321 biblatex
26322 \end_layout
26323
26324 \end_inset
26325
26326 ,
26327
26328 \begin_inset Flex Code
26329 status collapsed
26330
26331 \begin_layout Plain Layout
26332 natbib
26333 \end_layout
26334
26335 \end_inset
26336
26337 ,
26338  and
26339 \begin_inset Flex Code
26340 status collapsed
26341
26342 \begin_layout Plain Layout
26343 jurabib
26344 \end_layout
26345
26346 \end_inset
26347
26348 .
26349  Each of these packages has their pros and cons,
26350  which cannot be listed in detail.
26351  If you only want to have simple author-year (or author-numerical) style,
26352  or if you want to use one of the countless style files for
26353 \begin_inset Flex Code
26354 status collapsed
26355
26356 \begin_layout Plain Layout
26357 natbib
26358 \end_layout
26359
26360 \end_inset
26361
26362 ,
26363  then the established
26364 \begin_inset Flex Code
26365 status collapsed
26366
26367 \begin_layout Plain Layout
26368 natbib
26369 \end_layout
26370
26371 \end_inset
26372
26373  package is probably your choice.
26374  If you look for specific citation styles common in law studies,
26375  you might consider the
26376 \begin_inset Flex Code
26377 status collapsed
26378
26379 \begin_layout Plain Layout
26380 jurabib
26381 \end_layout
26382
26383 \end_inset
26384
26385  package.
26386  If you want to have full control over the formatting or look for advanced features such as ibidem,
26387  footnote citations,
26388  full title citations,
26389  advanced date formats (such as 400 BC) or full localization to other languages than English,
26390  you should definitely consider
26391 \begin_inset Flex Code
26392 status collapsed
26393
26394 \begin_layout Plain Layout
26395 biblatex
26396 \end_layout
26397
26398 \end_inset
26399
26400 ,
26401  which exceeds all other packages in terms of features,
26402  but is also quite heavy and more resource-hungry.
26403 \end_layout
26404
26405 \begin_layout Standard
26406 The handling of these packages in \SpecialChar LyX
26407  is basically the same.
26408  Go to
26409 \change_deleted -712698321 1674917685
26410
26411 \begin_inset Flex Noun
26412 status collapsed
26413
26414 \begin_layout Plain Layout
26415 Document\SpecialChar menuseparator
26416 Settings
26417 \end_layout
26418
26419 \end_inset
26420
26421
26422 \change_inserted -712698321 1674917685
26423
26424 \family sans
26425 Document\SpecialChar menuseparator
26426 Settings
26427 \change_unchanged
26428
26429 \family default
26430  and select under
26431 \change_deleted -712698321 1674917692
26432
26433 \begin_inset Flex Noun
26434 status collapsed
26435
26436 \begin_layout Plain Layout
26437 Bibliography
26438 \end_layout
26439
26440 \end_inset
26441
26442
26443 \change_inserted -712698321 1674917692
26444
26445 \family sans
26446 Bibliography
26447 \change_unchanged
26448
26449 \family default
26450  the
26451 \change_deleted -712698321 1674917696
26452
26453 \begin_inset Flex Noun
26454 status collapsed
26455
26456 \begin_layout Plain Layout
26457 Style Format
26458 \end_layout
26459
26460 \end_inset
26461
26462
26463 \change_inserted -712698321 1674917696
26464
26465 \family sans
26466 Style Format
26467 \change_unchanged
26468
26469 \family default
26470
26471 \change_deleted -712698321 1674917703
26472
26473 \begin_inset Flex Noun
26474 status collapsed
26475
26476 \begin_layout Plain Layout
26477 Basic (BibTeX)
26478 \end_layout
26479
26480 \end_inset
26481
26482
26483 \change_inserted -712698321 1674917703
26484
26485 \family sans
26486 Basic (BibTeX)
26487 \change_unchanged
26488
26489 \family default
26490 ,
26491
26492 \change_deleted -712698321 1674917708
26493
26494 \begin_inset Flex Noun
26495 status collapsed
26496
26497 \begin_layout Plain Layout
26498 Biblatex
26499 \end_layout
26500
26501 \end_inset
26502
26503
26504 \change_inserted -712698321 1674917708
26505
26506 \family sans
26507 Biblatex
26508 \change_unchanged
26509
26510 \family default
26511 ,
26512
26513 \change_deleted -712698321 1674917712
26514
26515 \begin_inset Flex Noun
26516 status collapsed
26517
26518 \begin_layout Plain Layout
26519 Biblatex (Natbib mode)
26520 \end_layout
26521
26522 \end_inset
26523
26524
26525 \change_inserted -712698321 1674917712
26526
26527 \family sans
26528 Biblatex (Natbib mode)
26529 \change_unchanged
26530
26531 \family default
26532 ,
26533
26534 \change_deleted -712698321 1674917718
26535
26536 \begin_inset Flex Noun
26537 status collapsed
26538
26539 \begin_layout Plain Layout
26540 Natbib (BibTeX)
26541 \end_layout
26542
26543 \end_inset
26544
26545
26546 \change_inserted -712698321 1674917718
26547
26548 \family sans
26549 Natbib (BibTeX)
26550 \change_unchanged
26551
26552 \family default
26553  or
26554 \change_deleted -712698321 1674917724
26555
26556 \begin_inset Flex Noun
26557 status collapsed
26558
26559 \begin_layout Plain Layout
26560 Jurabib (BibTeX)
26561 \end_layout
26562
26563 \end_inset
26564
26565
26566 \change_inserted -712698321 1674917724
26567
26568 \family sans
26569 Jurabib (BibTeX)
26570 \change_unchanged
26571
26572 \family default
26573  (see sec.
26574 \begin_inset space ~
26575 \end_inset
26576
26577 6.5.3 in the User's Guide for more information on these choices).
26578  With all these packages,
26579  you will get some extra features in the citation dialog and you can select the style of the reference (
26580 \begin_inset Quotes eld
26581 \end_inset
26582
26583 Knuth 1984
26584 \begin_inset Quotes erd
26585 \end_inset
26586
26587 ,
26588
26589 \begin_inset Quotes eld
26590 \end_inset
26591
26592 Knuth (1984)
26593 \begin_inset Quotes erd
26594 \end_inset
26595
26596 ,
26597
26598 \begin_inset Quotes eld
26599 \end_inset
26600
26601 Knuth,
26602  1984
26603 \begin_inset Quotes erd
26604 \end_inset
26605
26606 ,
26607
26608 \begin_inset Quotes eld
26609 \end_inset
26610
26611 1984
26612 \begin_inset Quotes erd
26613 \end_inset
26614
26615  etc.).
26616  Note that either package needs specifically designed style files.
26617  They all ship their own,
26618  but there are lots of additional style files,
26619  and there is even an interactive style file builder
26620 \begin_inset Foot
26621 status collapsed
26622
26623 \begin_layout Plain Layout
26624 See
26625 \begin_inset Flex URL
26626 status open
26627
26628 \begin_layout Plain Layout
26629
26630 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
26631 \end_layout
26632
26633 \end_inset
26634
26635
26636 \end_layout
26637
26638 \end_inset
26639
26640  for
26641 \begin_inset Flex Code
26642 status collapsed
26643
26644 \begin_layout Plain Layout
26645 natbib
26646 \end_layout
26647
26648 \end_inset
26649
26650 .
26651 \end_layout
26652
26653 \begin_layout Section
26654 Subdivided Bibliographies
26655 \end_layout
26656
26657 \begin_layout Standard
26658 Sometimes you might need to divide your bibliography into several sections.
26659  If you are for instance a historian,
26660  the possibility to separate sources and scientific works is most likely a
26661 \begin_inset Quotes eld
26662 \end_inset
26663
26664 must have
26665 \begin_inset Quotes erd
26666 \end_inset
26667
26668 .
26669  Unfortunately,
26670  Bib\SpecialChar TeX
26671  itself does not allow you to do this.
26672  But with the help of some \SpecialChar LaTeX
26673  packages,
26674  Bib\SpecialChar TeX
26675  can be extended to fit your needs.
26676 \end_layout
26677
26678 \begin_layout Standard
26679 \SpecialChar LyX
26680  provides native support for one of these packages,
26681
26682 \family typewriter
26683 bibtopic
26684 \family default
26685 .
26686 \begin_inset Foot
26687 status collapsed
26688
26689 \begin_layout Plain Layout
26690 Available from
26691 \begin_inset Flex URL
26692 status open
26693
26694 \begin_layout Plain Layout
26695
26696 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
26697 \end_layout
26698
26699 \end_inset
26700
26701
26702 \end_layout
26703
26704 \end_inset
26705
26706  The advantage of this package (compared to other packages such as
26707 \family typewriter
26708 multibib
26709 \family default
26710 ) is that you don't need to define new citation commands.
26711  Instead,
26712  you need to prepare different bibliographic databases which include the entries for the different sections of the bibliography.
26713  For example:
26714  If you want to divide your bibliography into the sections
26715 \begin_inset Quotes eld
26716 \end_inset
26717
26718 Sources
26719 \begin_inset Quotes erd
26720 \end_inset
26721
26722  and
26723 \begin_inset Quotes eld
26724 \end_inset
26725
26726 Scientific works
26727 \begin_inset Quotes erd
26728 \end_inset
26729
26730 ,
26731  you first need to create two bibliographic databases,
26732  e.
26733 \begin_inset space \thinspace{}
26734 \end_inset
26735
26736 g.
26737 \begin_inset space \space{}
26738 \end_inset
26739
26740
26741 \begin_inset Flex Code
26742 status collapsed
26743
26744 \begin_layout Plain Layout
26745 sources.bib
26746 \end_layout
26747
26748 \end_inset
26749
26750  and
26751 \begin_inset Flex Code
26752 status collapsed
26753
26754 \begin_layout Plain Layout
26755 scientific.bib
26756 \end_layout
26757
26758 \end_inset
26759
26760 .
26761
26762 \end_layout
26763
26764 \begin_layout Standard
26765 Go to
26766 \change_deleted -712698321 1674917736
26767
26768 \begin_inset Flex Noun
26769 status collapsed
26770
26771 \begin_layout Plain Layout
26772 Document\SpecialChar menuseparator
26773 Settings
26774 \end_layout
26775
26776 \end_inset
26777
26778
26779 \change_inserted -712698321 1674917736
26780
26781 \family sans
26782 Document\SpecialChar menuseparator
26783 Settings
26784 \change_unchanged
26785
26786 \family default
26787  and check under
26788 \change_deleted -712698321 1674917752
26789
26790 \begin_inset Flex Noun
26791 status collapsed
26792
26793 \begin_layout Plain Layout
26794 Bibliography
26795 \end_layout
26796
26797 \end_inset
26798
26799
26800 \change_inserted -712698321 1674917752
26801
26802 \family sans
26803 Bibliography
26804 \change_unchanged
26805
26806 \family default
26807  the option
26808 \change_deleted -712698321 1674917741
26809
26810 \family sans
26811
26812 \begin_inset Flex Noun
26813 status collapsed
26814
26815 \begin_layout Plain Layout
26816
26817 \family sans
26818 Subdivided bibliography
26819 \end_layout
26820
26821 \end_inset
26822
26823
26824 \change_inserted -712698321 1674917741
26825 Subdivided bibliography
26826 \change_unchanged
26827
26828 \family default
26829 .
26830  Now you can insert multiple Bib\SpecialChar TeX
26831  bibliographies,
26832  one for each section of your bibliography.
26833  Returning to our example:
26834  Insert the Bib\SpecialChar TeX
26835  bibliography
26836 \begin_inset Flex Code
26837 status collapsed
26838
26839 \begin_layout Plain Layout
26840 sources.bib
26841 \end_layout
26842
26843 \end_inset
26844
26845  and a second one for the database
26846 \begin_inset Flex Code
26847 status collapsed
26848
26849 \begin_layout Plain Layout
26850 scientific.bib
26851 \end_layout
26852
26853 \end_inset
26854
26855 .
26856  You are free to use the same or different styles for each section.
26857  Additionally,
26858  you can choose if the bibliography section should contain
26859 \begin_inset Quotes eld
26860 \end_inset
26861
26862 all cited references
26863 \begin_inset Quotes erd
26864 \end_inset
26865
26866  of the specified database(s) (which is the default),
26867
26868 \begin_inset Quotes eld
26869 \end_inset
26870
26871 all uncited references
26872 \begin_inset Quotes erd
26873 \end_inset
26874
26875  or even
26876 \begin_inset Quotes eld
26877 \end_inset
26878
26879 all references
26880 \begin_inset Quotes erd
26881 \end_inset
26882
26883 .
26884  This might be useful if you would like to separate your bibliography into three sections:
26885
26886 \begin_inset Quotes eld
26887 \end_inset
26888
26889 Cited sources
26890 \begin_inset Quotes erd
26891 \end_inset
26892
26893 ,
26894
26895 \begin_inset Quotes eld
26896 \end_inset
26897
26898 Uncited sources
26899 \begin_inset Quotes erd
26900 \end_inset
26901
26902 ,
26903  and
26904 \begin_inset Quotes eld
26905 \end_inset
26906
26907 Scientific works
26908 \begin_inset Quotes erd
26909 \end_inset
26910
26911 .
26912  The titles for the sections can be added as ordinary sections or subsections.
26913  Since
26914 \begin_inset Flex Code
26915 status collapsed
26916
26917 \begin_layout Plain Layout
26918 bibtopic
26919 \end_layout
26920
26921 \end_inset
26922
26923  removes the bibliography title,
26924  you have to manually re-add that,
26925  too (as a chapter* or section*,
26926  for instance).
26927 \end_layout
26928
26929 \begin_layout Standard
26930 With
26931 \family sans
26932 Biblatex
26933 \family default
26934 ,
26935  the procedure is a bit different.
26936  Since
26937 \family typewriter
26938 bibtopic
26939 \family default
26940  does not work with
26941 \family sans
26942 Biblatex
26943 \family default
26944 ,
26945  the aforementioned
26946 \begin_inset Flex Noun
26947 status collapsed
26948
26949 \begin_layout Plain Layout
26950 Subdivided bibliography
26951 \end_layout
26952
26953 \end_inset
26954
26955  option is disabled if you use
26956 \family sans
26957 Biblatex
26958 \family default
26959 .
26960  However,
26961
26962 \family sans
26963 Biblatex
26964 \family default
26965  provides its own means to generate subdivided bibliographies.
26966  You can either add keywords to bibliography entries via the
26967 \begin_inset Flex Code
26968 status collapsed
26969
26970 \begin_layout Plain Layout
26971 keywords
26972 \end_layout
26973
26974 \end_inset
26975
26976  entry option and then filter bibliography sections by keyword (by adding
26977 \begin_inset Flex Code
26978 status collapsed
26979
26980 \begin_layout Plain Layout
26981 keyword=mykeyword
26982 \end_layout
26983
26984 \end_inset
26985
26986  to the
26987 \begin_inset Flex Noun
26988 status collapsed
26989
26990 \begin_layout Plain Layout
26991 Options
26992 \end_layout
26993
26994 \end_inset
26995
26996  field of the dialog that opens if you left-click on the
26997 \begin_inset Flex Noun
26998 status collapsed
26999
27000 \begin_layout Plain Layout
27001 Biblatex Generated Bibliography
27002 \end_layout
27003
27004 \end_inset
27005
27006  button),
27007  or you can filter by entry types (such as
27008 \emph on
27009 book
27010 \emph default
27011  or
27012 \emph on
27013 article
27014 \emph default
27015 ) by entering e.
27016 \begin_inset space \thinspace{}
27017 \end_inset
27018
27019 g.
27020
27021 \begin_inset Flex Code
27022 status collapsed
27023
27024 \begin_layout Plain Layout
27025 type=book
27026 \end_layout
27027
27028 \end_inset
27029
27030  or
27031 \begin_inset Flex Code
27032 status collapsed
27033
27034 \begin_layout Plain Layout
27035 nottype=collection
27036 \end_layout
27037
27038 \end_inset
27039
27040  to the mentioned
27041 \begin_inset Flex Noun
27042 status collapsed
27043
27044 \begin_layout Plain Layout
27045 Options
27046 \end_layout
27047
27048 \end_inset
27049
27050  field,
27051  or you can create so-called
27052 \begin_inset Quotes eld
27053 \end_inset
27054
27055 Bibliography Categories
27056 \begin_inset Quotes erd
27057 \end_inset
27058
27059  to which you can assign individual entries.
27060  Please refer to the Biblatex manual,
27061  section
27062 \emph on
27063 Subdivided Bibliographies
27064 \emph default
27065 ,
27066  for details.
27067 \end_layout
27068
27069 \begin_layout Section
27070 Multiple Bibliographies
27071 \begin_inset CommandInset label
27072 LatexCommand label
27073 name "subsec:Multiple-Bibliographies"
27074
27075 \end_inset
27076
27077
27078 \end_layout
27079
27080 \begin_layout Standard
27081 Multiple bibliographies,
27082  e.
27083 \begin_inset space \thinspace{}
27084 \end_inset
27085
27086 g.
27087 \begin_inset space \space{}
27088 \end_inset
27089
27090 a bibliography for each part,
27091  chapter,
27092  section,
27093  subsection or child (sub-document) of the document,
27094  are also supported by \SpecialChar LyX
27095 .
27096  In order to enable it,
27097  go to
27098 \change_deleted -712698321 1674917759
27099
27100 \begin_inset Flex Noun
27101 status collapsed
27102
27103 \begin_layout Plain Layout
27104 Document\SpecialChar menuseparator
27105 Settings\SpecialChar menuseparator
27106 Bibliography
27107 \end_layout
27108
27109 \end_inset
27110
27111
27112 \change_inserted -712698321 1674917759
27113
27114 \family sans
27115 Document\SpecialChar menuseparator
27116 Settings\SpecialChar menuseparator
27117 Bibliography
27118 \change_unchanged
27119
27120 \family default
27121  and select the relevant unit (e.
27122 \begin_inset space \thinspace{}
27123 \end_inset
27124
27125 g.,
27126
27127 \begin_inset Quotes eld
27128 \end_inset
27129
27130 per section
27131 \begin_inset Quotes erd
27132 \end_inset
27133
27134 ) in the
27135 \begin_inset Flex Noun
27136 status collapsed
27137
27138 \begin_layout Plain Layout
27139 Multiple Bibliographies
27140 \end_layout
27141
27142 \end_inset
27143
27144  combo box.
27145  Then add a Bib(la)\SpecialChar TeX
27146  bibliography to each unit (e.
27147 \begin_inset space \thinspace{}
27148 \end_inset
27149
27150 g.,
27151  section) of your document.
27152  In the output,
27153  a separate bibliography,
27154  containing only the references done in the current unit is generated.
27155 \end_layout
27156
27157 \begin_layout Standard
27158 If you use Bib\SpecialChar TeX
27159 ,
27160  either the
27161 \begin_inset Flex Code
27162 status collapsed
27163
27164 \begin_layout Plain Layout
27165 chapterbib
27166 \end_layout
27167
27168 \end_inset
27169
27170  or the
27171 \begin_inset Flex Code
27172 status collapsed
27173
27174 \begin_layout Plain Layout
27175 bibtopic
27176 \end_layout
27177
27178 \end_inset
27179
27180  package is used to create multiple bibliographies.
27181  The former package is used if you select
27182 \begin_inset Quotes eld
27183 \end_inset
27184
27185 per child document
27186 \begin_inset Quotes erd
27187 \end_inset
27188
27189  and do
27190 \emph on
27191 not
27192 \emph default
27193  check
27194 \begin_inset Flex Noun
27195 status collapsed
27196
27197 \begin_layout Plain Layout
27198 Sectioned Bibliography
27199 \end_layout
27200
27201 \end_inset
27202
27203 .
27204  In all other cases,
27205
27206 \begin_inset Flex Code
27207 status collapsed
27208
27209 \begin_layout Plain Layout
27210 bibtopic
27211 \end_layout
27212
27213 \end_inset
27214
27215  is used.
27216 \begin_inset Foot
27217 status collapsed
27218
27219 \begin_layout Plain Layout
27220 An alternative approach,
27221  if you are willing to use some
27222 \begin_inset Flex Noun
27223 status collapsed
27224
27225 \begin_layout Plain Layout
27226 \SpecialChar TeX
27227  Code
27228 \end_layout
27229
27230 \end_inset
27231
27232  (see section
27233 \begin_inset space ~
27234 \end_inset
27235
27236
27237 \begin_inset CommandInset ref
27238 LatexCommand ref
27239 reference "sec:Inserting-TeX-Code"
27240 nolink "false"
27241
27242 \end_inset
27243
27244 ),
27245  is to use the
27246 \begin_inset Flex Code
27247 status collapsed
27248
27249 \begin_layout Plain Layout
27250 bibunits
27251 \end_layout
27252
27253 \end_inset
27254
27255  package.
27256 \end_layout
27257
27258 \end_inset
27259
27260  If
27261 \begin_inset Flex Code
27262 status collapsed
27263
27264 \begin_layout Plain Layout
27265 bibtopic
27266 \end_layout
27267
27268 \end_inset
27269
27270  is used,
27271  \SpecialChar LyX
27272  encloses the specified units in
27273 \begin_inset Flex Code
27274 status collapsed
27275
27276 \begin_layout Plain Layout
27277 bibtopic
27278 \end_layout
27279
27280 \end_inset
27281
27282 's
27283 \begin_inset Flex Code
27284 status collapsed
27285
27286 \begin_layout Plain Layout
27287
27288 \backslash
27289 begin{btUnit}
27290 \end_layout
27291
27292 \end_inset
27293
27294  and
27295 \begin_inset Flex Code
27296 status collapsed
27297
27298 \begin_layout Plain Layout
27299
27300 \backslash
27301 end{btUnit}
27302 \end_layout
27303
27304 \end_inset
27305
27306  in order to create the units.
27307  Note that this approach has some limitations.
27308  First,
27309  every citation reference has to be inside some
27310 \begin_inset Flex Code
27311 status collapsed
27312
27313 \begin_layout Plain Layout
27314 btUnit
27315 \end_layout
27316
27317 \end_inset
27318
27319 .
27320  So citations outside a defined unit (e.
27321 \begin_inset space \thinspace{}
27322 \end_inset
27323
27324 g.,
27325  before the first section if you use
27326 \begin_inset Quotes eld
27327 \end_inset
27328
27329 by section
27330 \begin_inset Quotes erd
27331 \end_inset
27332
27333 ) will appear as
27334 \begin_inset Quotes eld
27335 \end_inset
27336
27337 ???
27338 \begin_inset Quotes erd
27339 \end_inset
27340
27341 .
27342  You can also create your own units by entering
27343 \begin_inset Flex Code
27344 status collapsed
27345
27346 \begin_layout Plain Layout
27347
27348 \backslash
27349 begin{btUnit}
27350 \end_layout
27351
27352 \end_inset
27353
27354  and
27355 \begin_inset Flex Code
27356 status collapsed
27357
27358 \begin_layout Plain Layout
27359
27360 \backslash
27361 end{btUnit}
27362 \end_layout
27363
27364 \end_inset
27365
27366  as \SpecialChar TeX
27367  code (for instance to work around the mentioned limitation).
27368  Note,
27369  though,
27370  that
27371 \begin_inset Flex Code
27372 status collapsed
27373
27374 \begin_layout Plain Layout
27375 btUnit
27376 \end_layout
27377
27378 \end_inset
27379
27380 s cannot be nested.
27381  A second limitation is that
27382 \begin_inset Flex Code
27383 status collapsed
27384
27385 \begin_layout Plain Layout
27386 bibtopic
27387 \end_layout
27388
27389 \end_inset
27390
27391  always processes all references of a bibliography database,
27392  even if they are not cited.
27393  This can result in odd labels (e.
27394 \begin_inset space \thinspace{}
27395 \end_inset
27396
27397 g.
27398
27399 \begin_inset Quotes eld
27400 \end_inset
27401
27402 Miller 2014b
27403 \begin_inset Quotes erd
27404 \end_inset
27405
27406  if two works of this author from 2014 are in the database,
27407  even if only one is cited).
27408 \end_layout
27409
27410 \begin_layout Standard
27411 If you use
27412 \family sans
27413 Biblatex
27414 \family default
27415 ,
27416  the
27417 \begin_inset Flex Code
27418 status collapsed
27419
27420 \begin_layout Plain Layout
27421 refsection
27422 \end_layout
27423
27424 \end_inset
27425
27426  option is used instead.
27427  If you need specific units,
27428  you can start them with the \SpecialChar TeX
27429  code
27430 \begin_inset Flex Code
27431 status collapsed
27432
27433 \begin_layout Plain Layout
27434
27435 \backslash
27436 newrefsection
27437 \end_layout
27438
27439 \end_inset
27440
27441  or
27442 \begin_inset Flex Code
27443 status collapsed
27444
27445 \begin_layout Plain Layout
27446
27447 \backslash
27448 newrefsegment
27449 \end_layout
27450
27451 \end_inset
27452
27453 ,
27454  respectively.
27455  If you also want to control the end of the unit,
27456  use the environment
27457 \begin_inset Flex Code
27458 status collapsed
27459
27460 \begin_layout Plain Layout
27461
27462 \backslash
27463 begin{refsection}
27464 \end_layout
27465
27466 \end_inset
27467
27468  \SpecialChar ldots
27469
27470 \begin_inset Flex Code
27471 status collapsed
27472
27473 \begin_layout Plain Layout
27474
27475 \backslash
27476 end{refsection}
27477 \end_layout
27478
27479 \end_inset
27480
27481  instead.
27482  Note,
27483  though,
27484  that
27485 \begin_inset Flex Code
27486 status collapsed
27487
27488 \begin_layout Plain Layout
27489 refsection
27490 \end_layout
27491
27492 \end_inset
27493
27494 s cannot be nested.
27495  In addition to the individual bibliography of the current unit,
27496
27497 \family sans
27498 Biblatex
27499 \family default
27500  also provides an easy way to output all bibliographies,
27501  subsequently,
27502  at one place (e.
27503 \begin_inset space \thinspace{}
27504 \end_inset
27505
27506 g.,
27507  at the end of the document).
27508  Select
27509 \begin_inset Quotes eld
27510 \end_inset
27511
27512 all reference units
27513 \begin_inset Quotes erd
27514 \end_inset
27515
27516  from the Content combo box of the Bib(la)TeX inset dialog in order to achieve this.
27517  Please refer to the
27518 \family sans
27519 Biblatex
27520 \family default
27521  manual for more information on this topic.
27522 \end_layout
27523
27524 \begin_layout Chapter
27525
27526 \change_deleted 564990737 1671355654
27527 Itemize
27528 \change_unchanged
27529 Bullet
27530 \change_inserted 564990737 1671355667
27531 s
27532 \change_deleted 564990737 1671355661
27533  Selection
27534 \change_inserted 564990737 1671355684
27535
27536 \begin_inset CommandInset label
27537 LatexCommand label
27538 name "chap:bullets"
27539
27540 \end_inset
27541
27542
27543 \change_deleted 564990737 1671355684
27544
27545 \begin_inset CommandInset label
27546 LatexCommand label
27547 name "sec:bullet"
27548
27549 \end_inset
27550
27551
27552 \change_unchanged
27553
27554 \end_layout
27555
27556 \begin_layout Standard
27557 by
27558 \noun on
27559  Allan Rae
27560 \end_layout
27561
27562 \begin_layout Section
27563 Introduction
27564 \end_layout
27565
27566 \begin_layout Standard
27567 \SpecialChar LyX
27568  provides 216 bullet shapes that can be accessed from a simple dialog.
27569  Using this dialog you can easily specify what bullet shape to use at each level of an itemized list.
27570  These settings are document-wide so you won't be able to specify different sets of bullets for different paragraphs.
27571 \begin_inset Foot
27572 status collapsed
27573
27574 \begin_layout Plain Layout
27575 Well,
27576  actually you can but you'll have to do it by hand.
27577 \end_layout
27578
27579 \end_inset
27580
27581
27582 \end_layout
27583
27584 \begin_layout Section
27585 How it looks
27586 \end_layout
27587
27588 \begin_layout Standard
27589 Open the dialog by selecting the
27590 \change_deleted -712698321 1674916009
27591
27592 \begin_inset Flex Noun
27593 status collapsed
27594
27595 \begin_layout Plain Layout
27596 Document\SpecialChar menuseparator
27597 Settings
27598 \end_layout
27599
27600 \end_inset
27601
27602
27603 \change_inserted -712698321 1674916009
27604
27605 \family sans
27606 Document\SpecialChar menuseparator
27607 Settings
27608 \change_unchanged
27609
27610 \family default
27611  menu item and then select the
27612 \begin_inset Flex Noun
27613 status collapsed
27614
27615 \begin_layout Plain Layout
27616 Bullets
27617 \end_layout
27618
27619 \end_inset
27620
27621  tab.
27622 \end_layout
27623
27624 \begin_layout Standard
27625 The dialog provides you with a table of bullet shapes.
27626  A column of buttons on the left of the table provides access to the six different panels of bullet shapes.
27627  The row of buttons across the top is used to select which bullet depth you are changing.
27628 \change_inserted -712698321 1674916033
27629
27630 \end_layout
27631
27632 \begin_layout Standard
27633
27634 \change_inserted -712698321 1674916177
27635 If you select
27636 \family sans
27637 Custom bullet
27638 \family default
27639 ,
27640
27641 \change_deleted -712698321 1674916065
27642  A
27643 \change_inserted -712698321 1674916067
27644 a
27645 \change_unchanged
27646  text entry under the table
27647 \change_inserted -712698321 1674916074
27648 will be activated
27649 \change_deleted -712698321 1674916096
27650 shows the currently selected
27651 \change_inserted -712698321 1674916101
27652 in which you can enter a
27653 \change_unchanged
27654  bullet shape's \SpecialChar LaTeX
27655  equivalent
27656 \change_deleted -712698321 1674916109
27657  and this can be edited if desired
27658 \change_unchanged
27659 .
27660  If you do modify the text you will also need to specify any needed packages in the \SpecialChar LaTeX
27661  preamble.
27662 \end_layout
27663
27664 \begin_layout Standard
27665 The six panels are divided up by the packages they require.
27666  The following table shows the mappings from button name to \SpecialChar LaTeX
27667  package.
27668 \end_layout
27669
27670 \begin_layout Standard
27671 \align center
27672 \begin_inset Tabular
27673 <lyxtabular version="3" rows="7" columns="2">
27674 <features tabularvalignment="middle">
27675 <column alignment="center" valignment="top" width="0pt">
27676 <column alignment="center" valignment="top" width="0pt">
27677 <row>
27678 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
27679 \begin_inset Text
27680
27681 \begin_layout Plain Layout
27682
27683 \family roman
27684 \series medium
27685 \shape up
27686 \size normal
27687 \emph off
27688 \bar no
27689 \noun off
27690 \color none
27691 Button
27692 \end_layout
27693
27694 \end_inset
27695 </cell>
27696 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
27697 \begin_inset Text
27698
27699 \begin_layout Plain Layout
27700
27701 \family roman
27702 \series medium
27703 \shape up
27704 \size normal
27705 \emph off
27706 \bar no
27707 \noun off
27708 \color none
27709 Packages Required
27710 \end_layout
27711
27712 \end_inset
27713 </cell>
27714 </row>
27715 <row>
27716 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
27717 \begin_inset Text
27718
27719 \begin_layout Plain Layout
27720
27721 \family sans
27722 \series medium
27723 \shape up
27724 \size normal
27725 \emph off
27726 \bar no
27727 \noun off
27728 \color none
27729 Standard
27730 \end_layout
27731
27732 \end_inset
27733 </cell>
27734 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
27735 \begin_inset Text
27736
27737 \begin_layout Plain Layout
27738
27739 \series medium
27740 \shape up
27741 \size normal
27742 \emph off
27743 \bar no
27744 \noun off
27745 \color none
27746 base \SpecialChar LaTeX
27747
27748 \end_layout
27749
27750 \end_inset
27751 </cell>
27752 </row>
27753 <row>
27754 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
27755 \begin_inset Text
27756
27757 \begin_layout Plain Layout
27758
27759 \family sans
27760 \series medium
27761 \shape up
27762 \size normal
27763 \emph off
27764 \bar no
27765 \noun off
27766 \color none
27767 Maths
27768 \end_layout
27769
27770 \end_inset
27771 </cell>
27772 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
27773 \begin_inset Text
27774
27775 \begin_layout Plain Layout
27776
27777 \family typewriter
27778 \series medium
27779 \shape up
27780 \size normal
27781 \emph off
27782 \bar no
27783 \noun off
27784 \color none
27785 amssymb.sty
27786 \end_layout
27787
27788 \end_inset
27789 </cell>
27790 </row>
27791 <row>
27792 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
27793 \begin_inset Text
27794
27795 \begin_layout Plain Layout
27796
27797 \family sans
27798 \series medium
27799 \shape up
27800 \size normal
27801 \emph off
27802 \bar no
27803 \noun off
27804 \color none
27805 Ding1
27806 \end_layout
27807
27808 \end_inset
27809 </cell>
27810 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
27811 \begin_inset Text
27812
27813 \begin_layout Plain Layout
27814
27815 \family typewriter
27816 \series medium
27817 \shape up
27818 \size normal
27819 \emph off
27820 \bar no
27821 \noun off
27822 \color none
27823 pifont.sty
27824 \end_layout
27825
27826 \end_inset
27827 </cell>
27828 </row>
27829 <row>
27830 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
27831 \begin_inset Text
27832
27833 \begin_layout Plain Layout
27834
27835 \family sans
27836 \series medium
27837 \shape up
27838 \size normal
27839 \emph off
27840 \bar no
27841 \noun off
27842 \color none
27843 Ding2
27844 \end_layout
27845
27846 \end_inset
27847 </cell>
27848 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
27849 \begin_inset Text
27850
27851 \begin_layout Plain Layout
27852
27853 \family typewriter
27854 \series medium
27855 \shape up
27856 \size normal
27857 \emph off
27858 \bar no
27859 \noun off
27860 \color none
27861 pifont.sty
27862 \end_layout
27863
27864 \end_inset
27865 </cell>
27866 </row>
27867 <row>
27868 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
27869 \begin_inset Text
27870
27871 \begin_layout Plain Layout
27872
27873 \family sans
27874 \series medium
27875 \shape up
27876 \size normal
27877 \emph off
27878 \bar no
27879 \noun off
27880 \color none
27881 Ding3
27882 \end_layout
27883
27884 \end_inset
27885 </cell>
27886 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
27887 \begin_inset Text
27888
27889 \begin_layout Plain Layout
27890
27891 \family typewriter
27892 \series medium
27893 \shape up
27894 \size normal
27895 \emph off
27896 \bar no
27897 \noun off
27898 \color none
27899 pifont.sty
27900 \end_layout
27901
27902 \end_inset
27903 </cell>
27904 </row>
27905 <row>
27906 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
27907 \begin_inset Text
27908
27909 \begin_layout Plain Layout
27910
27911 \family sans
27912 \series medium
27913 \shape up
27914 \size normal
27915 \emph off
27916 \bar no
27917 \noun off
27918 \color none
27919 Ding4
27920 \end_layout
27921
27922 \end_inset
27923 </cell>
27924 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
27925 \begin_inset Text
27926
27927 \begin_layout Plain Layout
27928
27929 \family typewriter
27930 \series medium
27931 \shape up
27932 \size normal
27933 \emph off
27934 \bar no
27935 \noun off
27936 \color none
27937 pifont.sty
27938 \end_layout
27939
27940 \end_inset
27941 </cell>
27942 </row>
27943 </lyxtabular>
27944
27945 \end_inset
27946
27947
27948 \end_layout
27949
27950 \begin_layout Standard
27951 \SpecialChar LyX
27952  doesn't stop you using bullets from packages you don't have.
27953  If you get errors from \SpecialChar LaTeX
27954  when you try to view or print the file,
27955  then it is likely you are missing a package.
27956 \begin_inset Foot
27957 status collapsed
27958
27959 \begin_layout Plain Layout
27960 \SpecialChar LyX
27961  doesn't restrict your use since you may be editing locally and exporting elsewhere.
27962 \end_layout
27963
27964 \end_inset
27965
27966
27967 \end_layout
27968
27969 \begin_layout Section
27970
27971 \change_inserted -712698321 1674916414
27972 \begin_inset CommandInset label
27973 LatexCommand label
27974 name "sec:How-to-use"
27975
27976 \end_inset
27977
27978
27979 \change_unchanged
27980 How to use it
27981 \end_layout
27982
27983 \begin_layout Standard
27984 Select which bullet depth you want to change then select the bullet shape and size.
27985  Any changes will not be visible in \SpecialChar LyX
27986 ,
27987  but are visible when viewing the document.
27988 \end_layout
27989
27990 \begin_layout Standard
27991 You can reset a bullet shape to the default simply by clicking your right mouse button on the appropriate bullet depth button.
27992 \change_deleted -712698321 1674916288
27993
27994 \begin_inset Foot
27995 status collapsed
27996
27997 \begin_layout Plain Layout
27998
27999 \change_deleted -712698321 1674916287
28000 \begin_inset CommandInset label
28001 LatexCommand label
28002 name "fn:If-you-really"
28003
28004 \end_inset
28005
28006
28007 \change_unchanged
28008 If you
28009 \emph on
28010 really
28011 \emph default
28012  want to have multiple sets of paragraphs with different sets of bullets in each,
28013  then you're going to have to get your hands dirty with \SpecialChar TeX
28014  code.
28015  The bullet selection dialog can help though because it provides you with the \SpecialChar LaTeX
28016  code for a wide range of bullet shapes.
28017  To make your own custom paragraphs you have the following options:
28018 \end_layout
28019
28020 \begin_layout Plain Layout
28021 \begin_inset ERT
28022 status open
28023
28024 \begin_layout Plain Layout
28025
28026
28027 \backslash
28028 let
28029 \backslash
28030 savelabelitemi=
28031 \backslash
28032 labelitemi
28033 \end_layout
28034
28035 \end_inset
28036
28037
28038 \end_layout
28039
28040 \begin_layout Plain Layout
28041 \begin_inset ERT
28042 status open
28043
28044 \begin_layout Plain Layout
28045
28046
28047 \backslash
28048 renewcommand
28049 \backslash
28050 labelitemi[0]{
28051 \backslash
28052 small
28053 \backslash
28054 (
28055 \backslash
28056 sharp
28057 \backslash
28058 )}
28059 \end_layout
28060
28061 \end_inset
28062
28063
28064 \end_layout
28065
28066 \begin_layout Itemize
28067 Use the \SpecialChar LaTeX
28068  command
28069 \begin_inset Flex Code
28070 status collapsed
28071
28072 \begin_layout Plain Layout
28073
28074 \backslash
28075 renewcommand{}{}
28076 \end_layout
28077
28078 \end_inset
28079
28080  to specify a new bullet shape for a given depth.
28081  You'll also need to save the current bullet shape so you can restore it again afterwards.
28082  In this itemized list the following \SpecialChar LaTeX
28083  code was used to change the bullet used for the first depth.
28084 \end_layout
28085
28086 \begin_deeper
28087 \begin_layout LyX-Code
28088
28089 \backslash
28090 let
28091 \backslash
28092 savelabelitemi=
28093 \backslash
28094 labelitemi
28095 \end_layout
28096
28097 \begin_layout LyX-Code
28098
28099 \backslash
28100 renewcommand
28101 \backslash
28102 labelitemi[0]{
28103 \backslash
28104 small
28105 \backslash
28106 (
28107 \backslash
28108 sharp
28109 \backslash
28110 )}
28111 \end_layout
28112
28113 \end_deeper
28114 \begin_layout Itemize
28115 Note that the itemize depth is specified in Roman numerals as part of the
28116 \family typewriter
28117
28118 \backslash
28119 labelitem
28120 \family default
28121  command.
28122 \end_layout
28123
28124 \begin_layout Itemize
28125 \begin_inset Argument item:1
28126 status open
28127
28128 \begin_layout Plain Layout
28129 \begin_inset ERT
28130 status open
28131
28132 \begin_layout Plain Layout
28133
28134
28135 \backslash
28136 (
28137 \backslash
28138 star
28139 \backslash
28140 )
28141 \end_layout
28142
28143 \end_inset
28144
28145
28146 \end_layout
28147
28148 \end_inset
28149
28150  Specify each individual entry by starting each item with the bullet shape enclosed in a
28151 \begin_inset Quotes eld
28152 \end_inset
28153
28154 Custom Item
28155 \begin_inset Quotes erd
28156 \end_inset
28157
28158  inset (available at
28159 \family sans
28160 Insert\SpecialChar menuseparator
28161 Custom Item
28162 \family default
28163 ) and set as
28164 \begin_inset Flex Noun
28165 status collapsed
28166
28167 \begin_layout Plain Layout
28168 \SpecialChar TeX
28169  Code
28170 \end_layout
28171
28172 \end_inset
28173
28174 .
28175  For example,
28176  this item was started with
28177 \begin_inset Flex Code
28178 status collapsed
28179
28180 \begin_layout Plain Layout
28181
28182 \backslash
28183 (
28184 \backslash
28185 star
28186 \backslash
28187 )
28188 \end_layout
28189
28190 \end_inset
28191
28192 .
28193 \end_layout
28194
28195 \begin_layout Plain Layout
28196 \begin_inset ERT
28197 status open
28198
28199 \begin_layout Plain Layout
28200
28201
28202 \backslash
28203 renewcommand
28204 \backslash
28205 labelitemi[0]{
28206 \backslash
28207 savelabelitemi}
28208 \end_layout
28209
28210 \end_inset
28211
28212
28213 \end_layout
28214
28215 \begin_layout Plain Layout
28216 You'll also need to revert the labelitem back to its previous setting for the global bullet shape settings to remain in effect.
28217  The way used here was:
28218 \end_layout
28219
28220 \begin_layout LyX-Code
28221
28222 \backslash
28223 renewcommand
28224 \backslash
28225 labelitemi[0]{
28226 \backslash
28227 savelabelitemi}
28228 \end_layout
28229
28230 \end_inset
28231
28232
28233 \change_inserted -712698321 1674916331
28234
28235 \begin_inset CommandInset label
28236 LatexCommand label
28237 name "fn:If-you-really"
28238
28239 \end_inset
28240
28241
28242 \end_layout
28243
28244 \begin_layout Standard
28245
28246 \change_inserted -712698321 1674916288
28247 If you
28248 \emph on
28249 really
28250 \emph default
28251  want to have multiple sets of paragraphs with different sets of bullets in each,
28252  then you're going to have to get your hands dirty with \SpecialChar TeX
28253  code.
28254  The bullet selection dialog can help though because it provides you with the \SpecialChar LaTeX
28255  code for a wide range of bullet shapes.
28256  To make your own custom paragraphs you have the following options:
28257 \end_layout
28258
28259 \begin_layout Standard
28260
28261 \change_inserted -712698321 1674916288
28262 \begin_inset ERT
28263 status open
28264
28265 \begin_layout Plain Layout
28266
28267 \change_inserted -712698321 1674916288
28268
28269
28270 \backslash
28271 let
28272 \backslash
28273 savelabelitemi=
28274 \backslash
28275 labelitemi
28276 \end_layout
28277
28278 \end_inset
28279
28280
28281 \end_layout
28282
28283 \begin_layout Standard
28284
28285 \change_inserted -712698321 1674916288
28286 \begin_inset ERT
28287 status open
28288
28289 \begin_layout Plain Layout
28290
28291 \change_inserted -712698321 1674916288
28292
28293
28294 \backslash
28295 renewcommand
28296 \backslash
28297 labelitemi[0]{
28298 \backslash
28299 small
28300 \backslash
28301 (
28302 \backslash
28303 sharp
28304 \backslash
28305 )}
28306 \end_layout
28307
28308 \end_inset
28309
28310
28311 \end_layout
28312
28313 \begin_layout Itemize
28314
28315 \change_inserted -712698321 1674916288
28316 Use the \SpecialChar LaTeX
28317  command
28318 \begin_inset Flex Code
28319 status collapsed
28320
28321 \begin_layout Plain Layout
28322
28323 \change_inserted -712698321 1674916288
28324
28325 \backslash
28326 renewcommand
28327 \change_unchanged
28328
28329 \end_layout
28330
28331 \end_inset
28332
28333  to specify a new bullet shape for a given depth.
28334  You'll also need to save the current bullet shape so you can restore it again afterwards.
28335  In this itemized list the following \SpecialChar LaTeX
28336  code was used to change the bullet used for the first depth.
28337 \end_layout
28338
28339 \begin_deeper
28340 \begin_layout LyX-Code
28341
28342 \change_inserted -712698321 1674916288
28343
28344 \backslash
28345 let
28346 \backslash
28347 savelabelitemi=
28348 \backslash
28349 labelitemi
28350 \end_layout
28351
28352 \begin_layout LyX-Code
28353
28354 \change_inserted -712698321 1674916288
28355
28356 \backslash
28357 renewcommand
28358 \backslash
28359 labelitemi[0]{
28360 \backslash
28361 small
28362 \backslash
28363 (
28364 \backslash
28365 sharp
28366 \backslash
28367 )}
28368 \end_layout
28369
28370 \end_deeper
28371 \begin_layout Itemize
28372
28373 \change_inserted -712698321 1674916288
28374 Note that the itemize depth is specified in Roman numerals as part of the
28375 \family typewriter
28376
28377 \backslash
28378 labelitem
28379 \family default
28380  command.
28381 \end_layout
28382
28383 \begin_layout Itemize
28384
28385 \change_inserted -712698321 1674916288
28386 \begin_inset Argument item:1
28387 status open
28388
28389 \begin_layout Plain Layout
28390
28391 \change_inserted -712698321 1674916288
28392 \begin_inset ERT
28393 status open
28394
28395 \begin_layout Plain Layout
28396
28397 \change_inserted -712698321 1674916288
28398
28399
28400 \backslash
28401 (
28402 \backslash
28403 star
28404 \backslash
28405 )
28406 \end_layout
28407
28408 \end_inset
28409
28410
28411 \change_unchanged
28412
28413 \end_layout
28414
28415 \end_inset
28416
28417  Specify each individual entry by starting each item with the bullet shape enclosed in a
28418 \begin_inset Quotes eld
28419 \end_inset
28420
28421 Custom Item
28422 \begin_inset Quotes erd
28423 \end_inset
28424
28425  inset (available at
28426 \family sans
28427 Insert\SpecialChar menuseparator
28428 Custom Item
28429 \family default
28430 ) and set as
28431 \begin_inset Flex Noun
28432 status collapsed
28433
28434 \begin_layout Plain Layout
28435
28436 \change_inserted -712698321 1674916288
28437 \SpecialChar TeX
28438  Code
28439 \change_unchanged
28440
28441 \end_layout
28442
28443 \end_inset
28444
28445 .
28446  For example,
28447  this item was started with
28448 \begin_inset Flex Code
28449 status collapsed
28450
28451 \begin_layout Plain Layout
28452
28453 \change_inserted -712698321 1674916288
28454
28455 \backslash
28456 (
28457 \backslash
28458 star
28459 \backslash
28460 )
28461 \change_unchanged
28462
28463 \end_layout
28464
28465 \end_inset
28466
28467 .
28468 \end_layout
28469
28470 \begin_layout Standard
28471
28472 \change_inserted -712698321 1674916288
28473 \begin_inset ERT
28474 status open
28475
28476 \begin_layout Plain Layout
28477
28478 \change_inserted -712698321 1674916288
28479
28480
28481 \backslash
28482 renewcommand
28483 \backslash
28484 labelitemi[0]{
28485 \backslash
28486 savelabelitemi}
28487 \end_layout
28488
28489 \end_inset
28490
28491
28492 \end_layout
28493
28494 \begin_layout Standard
28495
28496 \change_inserted -712698321 1674916288
28497 You'll also need to revert the labelitem back to its previous setting for the global bullet shape settings to remain in effect.
28498  The way used here was:
28499 \end_layout
28500
28501 \begin_layout LyX-Code
28502
28503 \change_inserted -712698321 1674916288
28504
28505 \backslash
28506 renewcommand
28507 \backslash
28508 labelitemi[0]{
28509 \backslash
28510 savelabelitemi}
28511 \change_unchanged
28512
28513 \end_layout
28514
28515 \begin_layout Chapter
28516 Supplemental Tools
28517 \end_layout
28518
28519 \begin_layout Section
28520 Multipart Documents
28521 \end_layout
28522
28523 \begin_layout Subsection
28524 General Operation
28525 \end_layout
28526
28527 \begin_layout Standard
28528 When you are working on a large file with many sections,
28529  it is often convenient to break up the document into several files,
28530  or perhaps you have something where a table may change from time to time,
28531  but the preceding text does not.
28532  In these cases,
28533  you should seriously consider using multipart documents.
28534  For example,
28535  scientific papers often have five major sections:
28536  the introduction,
28537  observations,
28538  results,
28539  discussion,
28540  and conclusion.
28541  Each of these could be its own separate \SpecialChar LyX
28542  file,
28543  with one
28544 \begin_inset Quotes eld
28545 \end_inset
28546
28547 master
28548 \begin_inset Quotes erd
28549 \end_inset
28550
28551  file which contains the title,
28552  authors,
28553  abstract,
28554  references,
28555  etc.,
28556  plus the five included files.
28557  It is important to note that each of these files is a full \SpecialChar LyX
28558  file which can be formatted and printed on its own,
28559  as well as included in a master file.
28560  Each of these files must have the same document class,
28561  however—
28562 don't attempt to mix book classes with article classes.
28563  You may also include \SpecialChar LaTeX
28564  files;
28565  however,
28566  these files must not have their own preamble (i.
28567 \begin_inset space \thinspace{}
28568 \end_inset
28569
28570 e.
28571 \begin_inset space \space{}
28572 \end_inset
28573
28574 everything up to and including the
28575 \begin_inset Flex Code
28576 status collapsed
28577
28578 \begin_layout Plain Layout
28579
28580 \backslash
28581 begin{document}
28582 \end_layout
28583
28584 \end_inset
28585
28586  line as well as the
28587 \begin_inset Flex Code
28588 status collapsed
28589
28590 \begin_layout Plain Layout
28591
28592 \backslash
28593 end{document}
28594 \end_layout
28595
28596 \end_inset
28597
28598  line must be deleted) or else errors will be generated when you try to make a DVI file.
28599 \end_layout
28600
28601 \begin_layout Standard
28602 \SpecialChar LyX
28603  allows you to include files quite easily with
28604 \change_deleted -712698321 1674917774
28605
28606 \begin_inset Flex Noun
28607 status collapsed
28608
28609 \begin_layout Plain Layout
28610 Insert\SpecialChar menuseparator
28611 Child
28612 \begin_inset space ~
28613 \end_inset
28614
28615 Document
28616 \end_layout
28617
28618 \end_inset
28619
28620
28621 \change_inserted -712698321 1674917774
28622
28623 \family sans
28624 Insert\SpecialChar menuseparator
28625 Child
28626 \begin_inset space ~
28627 \end_inset
28628
28629 Document
28630 \change_unchanged
28631
28632 \family default
28633 .
28634  When you click on this selection a small box is inserted into the file at the current cursor location.
28635  Clicking on the box raises a dialog which allows you to select the file to be included,
28636  and the method of its inclusion.
28637
28638 \end_layout
28639
28640 \begin_layout Standard
28641 The file selection box should by now be obvious.
28642  The three inclusion methods are
28643 \begin_inset Quotes eld
28644 \end_inset
28645
28646 include
28647 \begin_inset Quotes erd
28648 \end_inset
28649
28650 ,
28651
28652 \begin_inset Quotes eld
28653 \end_inset
28654
28655 input
28656 \begin_inset Quotes erd
28657 \end_inset
28658
28659 ,
28660  and
28661 \begin_inset Quotes eld
28662 \end_inset
28663
28664 verbatim
28665 \begin_inset Quotes erd
28666 \end_inset
28667
28668 .
28669  The methods
28670 \begin_inset Quotes eld
28671 \end_inset
28672
28673 include
28674 \begin_inset Quotes erd
28675 \end_inset
28676
28677  and
28678 \begin_inset Quotes eld
28679 \end_inset
28680
28681 input
28682 \begin_inset Quotes erd
28683 \end_inset
28684
28685  are similar in many ways,
28686  but there are also some notable differences:
28687 \end_layout
28688
28689 \begin_layout Enumerate
28690 Files that are
28691 \begin_inset Quotes eld
28692 \end_inset
28693
28694 included
28695 \begin_inset Quotes erd
28696 \end_inset
28697
28698  are typeset beginning on a new page,
28699  while files that are
28700 \begin_inset Quotes eld
28701 \end_inset
28702
28703 inputted
28704 \begin_inset Quotes erd
28705 \end_inset
28706
28707  are typeset starting on the current page.
28708 \end_layout
28709
28710 \begin_layout Enumerate
28711 \begin_inset Quotes eld
28712 \end_inset
28713
28714 Included
28715 \begin_inset Quotes erd
28716 \end_inset
28717
28718  files cannot themselves
28719 \begin_inset Quotes eld
28720 \end_inset
28721
28722 include
28723 \begin_inset Quotes erd
28724 \end_inset
28725
28726  further files (
28727 \begin_inset Quotes eld
28728 \end_inset
28729
28730 grandchilds
28731 \begin_inset Quotes erd
28732 \end_inset
28733
28734 ).
28735  With
28736 \begin_inset Quotes eld
28737 \end_inset
28738
28739 input
28740 \begin_inset Quotes erd
28741 \end_inset
28742
28743 ,
28744  on the other hand,
28745  infinite sub-inputting is possible.
28746 \end_layout
28747
28748 \begin_layout Enumerate
28749 \begin_inset Quotes eld
28750 \end_inset
28751
28752 Include
28753 \begin_inset Quotes erd
28754 \end_inset
28755
28756  allow for the output of only selected
28757 \begin_inset Quotes eld
28758 \end_inset
28759
28760 included
28761 \begin_inset Quotes erd
28762 \end_inset
28763
28764  files,
28765  while maintaining the actual counters (pagination etc.) and references (please refer to the section
28766 \emph on
28767 Child
28768 \begin_inset space ~
28769 \end_inset
28770
28771 Documents
28772 \emph default
28773  of the
28774 \emph on
28775 Embedded
28776 \begin_inset space ~
28777 \end_inset
28778
28779 Objects
28780 \emph default
28781  manual for details).
28782 \end_layout
28783
28784 \begin_layout Standard
28785 Hence,
28786
28787 \begin_inset Quotes eld
28788 \end_inset
28789
28790 include
28791 \begin_inset Quotes erd
28792 \end_inset
28793
28794  is the preferred method for chapters that are outsourced to child documents,
28795  while
28796 \begin_inset Quotes eld
28797 \end_inset
28798
28799 input
28800 \begin_inset Quotes erd
28801 \end_inset
28802
28803  is more suitable for arbitrary file inheritance.
28804 \end_layout
28805
28806 \begin_layout Standard
28807 A
28808 \begin_inset Quotes eld
28809 \end_inset
28810
28811 verbatim
28812 \begin_inset Quotes erd
28813 \end_inset
28814
28815  included file allows you to include a file typeset exactly as it appears in the file,
28816  i.
28817 \begin_inset space \thinspace{}
28818 \end_inset
28819
28820 e.
28821 \begin_inset space \space{}
28822 \end_inset
28823
28824 in
28825 \begin_inset Flex Code
28826 status collapsed
28827
28828 \begin_layout Plain Layout
28829 verbatim
28830 \end_layout
28831
28832 \end_inset
28833
28834  mode,
28835  with the characters set in a fixed-width typewriter font.
28836  Normally,
28837  spaces in this file are invisible,
28838  though two consecutive spaces are conserved,
28839  unlike \SpecialChar LyX
28840 's normal treatment of spaces.
28841  However,
28842  setting the
28843 \begin_inset Flex Noun
28844 status collapsed
28845
28846 \begin_layout Plain Layout
28847 Mark
28848 \begin_inset space ~
28849 \end_inset
28850
28851 spaces
28852 \begin_inset space ~
28853 \end_inset
28854
28855 in
28856 \begin_inset space ~
28857 \end_inset
28858
28859 output
28860 \end_layout
28861
28862 \end_inset
28863
28864  checkbox typesets a mark to unambiguously define the presence of a space.
28865
28866 \end_layout
28867
28868 \begin_layout Standard
28869 Generally,
28870  the master file is converted into a full \SpecialChar LaTeX
28871  file before typesetting,
28872  while the included files are converted to \SpecialChar LaTeX
28873  files that do not have all the preamble information.
28874 \end_layout
28875
28876 \begin_layout Subsection
28877 Cross-References Between Files
28878 \end_layout
28879
28880 \begin_layout Standard
28881 \begin_inset Box Shadowbox
28882 position "t"
28883 hor_pos "c"
28884 has_inner_box 1
28885 inner_pos "t"
28886 use_parbox 0
28887 use_makebox 0
28888 width "100col%"
28889 special "none"
28890 height "1in"
28891 height_special "totalheight"
28892 thickness "0.4pt"
28893 separation "3pt"
28894 shadowsize "4pt"
28895 framecolor "black"
28896 backgroundcolor "none"
28897 status open
28898
28899 \begin_layout Plain Layout
28900 This section is somewhat out of date.
28901  Need to describe default master documents and how children are opened when the master is.
28902  [[FIXME]]
28903 \end_layout
28904
28905 \end_inset
28906
28907
28908 \end_layout
28909
28910 \begin_layout Standard
28911 It is possible to set up cross-references between the different files.
28912  First,
28913  open all the files in question:
28914  let's call them A and B in a two file example,
28915  where B is included in A.
28916  Let's say you insert a label in A,
28917  then want to reference it in B.
28918  Open the cross-reference dialog whilst in document B,
28919  and you can select the
28920 \begin_inset Quotes eld
28921 \end_inset
28922
28923 buffer
28924 \begin_inset Quotes erd
28925 \end_inset
28926
28927  to use.
28928 \end_layout
28929
28930 \begin_layout Subsection
28931 Bibliography Lists in all Subdocuments
28932 \end_layout
28933
28934 \begin_layout Standard
28935 If you work with child documents,
28936  you might want to have only one main bibliography at the end,
28937  but still be able to have a selected bibliography for the child if you output it on its own.
28938  Here is how to achieve this.
28939 \end_layout
28940
28941 \begin_layout Standard
28942 For the main document,
28943  you just insert a bibliography inset at the place where the main bibliography has to appear (within the master file or within a child).
28944  If the bibliography inset is in the master file,
28945  the references will be inherited by all children,
28946  so they are available in the citation dialog within each child.
28947 \end_layout
28948
28949 \begin_layout Standard
28950 For child-specific bibliographies,
28951  insert bibliography insets within the child documents,
28952  at the place where the bibliography should appear when the child is compiled separately.
28953  However,
28954  the trick is to insert them into a branch (
28955 \family sans
28956 Insert\SpecialChar menuseparator
28957 Branch\SpecialChar menuseparator
28958 Insert New Branch...
28959 \family default
28960 ),
28961  e.
28962 \begin_inset space \thinspace{}
28963 \end_inset
28964
28965 g.
28966  called
28967 \begin_inset Quotes eld
28968 \end_inset
28969
28970 Childonly
28971 \begin_inset Quotes erd
28972 \end_inset
28973
28974 .
28975  Within the children,
28976  activate the branch (
28977 \family sans
28978 Document\SpecialChar menuseparator
28979 Settings...\SpecialChar menuseparator
28980 Branches
28981 \family default
28982 ).
28983  Within the master,
28984  deactivate the branch (
28985 \family sans
28986 Document\SpecialChar menuseparator
28987 Settings...\SpecialChar menuseparator
28988 Branches
28989 \family default
28990 ).
28991  Now the child's bibliography will be ignored by the master,
28992  but considered by the child.
28993 \end_layout
28994
28995 \begin_layout Standard
28996 If you need multiple bibliographies (e.
28997 \begin_inset space \thinspace{}
28998 \end_inset
28999
29000 g.,
29001  one per child in the
29002 \emph on
29003 main document
29004 \emph default
29005 ),
29006  please refer to sec.
29007 \begin_inset space ~
29008 \end_inset
29009
29010
29011 \begin_inset CommandInset ref
29012 LatexCommand ref
29013 reference "subsec:Multiple-Bibliographies"
29014 nolink "false"
29015
29016 \end_inset
29017
29018 .
29019 \end_layout
29020
29021 \begin_layout Section
29022 \SpecialChar LyX
29023  Archives
29024 \end_layout
29025
29026 \begin_layout Standard
29027 Users sometimes need to be able to
29028 \begin_inset Quotes eld
29029 \end_inset
29030
29031 bundle
29032 \begin_inset Quotes erd
29033 \end_inset
29034
29035  a \SpecialChar LyX
29036  file together with all the images (and other files) on which it depends,
29037  either for sending to a publisher or for sharing with a co-author.
29038  \SpecialChar LyX
29039  includes a Python script (
29040 \begin_inset Flex Code
29041 status collapsed
29042
29043 \begin_layout Plain Layout
29044 lyxpak.py
29045 \end_layout
29046
29047 \end_inset
29048
29049 ) that automates this process.
29050  To use it,
29051  you must have either the
29052 \begin_inset Flex Code
29053 status collapsed
29054
29055 \begin_layout Plain Layout
29056 zipfile
29057 \end_layout
29058
29059 \end_inset
29060
29061  or
29062 \begin_inset Flex Code
29063 status collapsed
29064
29065 \begin_layout Plain Layout
29066 tarfile
29067 \end_layout
29068
29069 \end_inset
29070
29071  python modules installed on your system.
29072  By default,
29073  the script prefers the
29074 \begin_inset Flex Code
29075 status collapsed
29076
29077 \begin_layout Plain Layout
29078 gzip
29079 \end_layout
29080
29081 \end_inset
29082
29083 -compressed
29084 \begin_inset Flex Code
29085 status collapsed
29086
29087 \begin_layout Plain Layout
29088 tar
29089 \end_layout
29090
29091 \end_inset
29092
29093  format on Unix-like systems and the
29094 \begin_inset Flex Code
29095 status collapsed
29096
29097 \begin_layout Plain Layout
29098 zip
29099 \end_layout
29100
29101 \end_inset
29102
29103  format on Windows.
29104 \end_layout
29105
29106 \begin_layout Standard
29107 \SpecialChar LyX
29108 's configuration process will set the script up to export a `\SpecialChar LyX
29109  Archive',
29110  and this format will then be available under
29111 \change_deleted -712698321 1674917789
29112
29113 \begin_inset Flex Code
29114 status collapsed
29115
29116 \begin_layout Plain Layout
29117 File\SpecialChar menuseparator
29118 Export
29119 \end_layout
29120
29121 \end_inset
29122
29123
29124 \change_inserted -712698321 1674917789
29125
29126 \family sans
29127 File\SpecialChar menuseparator
29128 Export
29129 \change_unchanged
29130
29131 \family default
29132 .
29133 \end_layout
29134
29135 \begin_layout Standard
29136 Independently of the platform,
29137  the generation of a particular archive format can be forced by adding either the
29138 \begin_inset Flex Code
29139 status collapsed
29140
29141 \begin_layout Plain Layout
29142 -t
29143 \end_layout
29144
29145 \end_inset
29146
29147  (for the
29148 \begin_inset Flex Code
29149 status collapsed
29150
29151 \begin_layout Plain Layout
29152 tar
29153 \end_layout
29154
29155 \end_inset
29156
29157  format) or
29158 \begin_inset Flex Code
29159 status collapsed
29160
29161 \begin_layout Plain Layout
29162 -z
29163 \end_layout
29164
29165 \end_inset
29166
29167  (for the
29168 \begin_inset Flex Code
29169 status collapsed
29170
29171 \begin_layout Plain Layout
29172 zip
29173 \end_layout
29174
29175 \end_inset
29176
29177  format) switch to the
29178 \begin_inset Flex Code
29179 status collapsed
29180
29181 \begin_layout Plain Layout
29182 \SpecialChar LyX
29183
29184 \change_deleted -712698321 1674918890
29185 \SpecialChar menuseparator
29186
29187 \change_inserted -712698321 1674918890
29188 ->
29189 \change_unchanged
29190 \SpecialChar LyX
29191  Archive
29192 \end_layout
29193
29194 \end_inset
29195
29196  converter in
29197 \change_deleted -712698321 1674917814
29198
29199 \begin_inset Flex Code
29200 status collapsed
29201
29202 \begin_layout Plain Layout
29203 Tools\SpecialChar menuseparator
29204 Preferences\SpecialChar menuseparator
29205 File Handling\SpecialChar menuseparator
29206 Converters
29207 \end_layout
29208
29209 \end_inset
29210
29211
29212 \change_inserted -712698321 1674917814
29213
29214 \family sans
29215 Tools\SpecialChar menuseparator
29216 Preferences\SpecialChar menuseparator
29217 File Handling\SpecialChar menuseparator
29218 Converters
29219 \change_unchanged
29220
29221 \family default
29222 .
29223  (Make sure you add the switch after the script name,
29224  not before it.)
29225 \end_layout
29226
29227 \begin_layout Section
29228
29229 \change_deleted -712698321 1674910251
29230 Fancy Headers and Footers
29231 \end_layout
29232
29233 \begin_layout Standard
29234
29235 \change_deleted -712698321 1674910251
29236 The default page layout is rather plain;
29237  for an
29238 \begin_inset Flex Code
29239 status collapsed
29240
29241 \begin_layout Plain Layout
29242 article
29243 \end_layout
29244
29245 \end_inset
29246
29247  document class,
29248  all you get is a centered page number at the bottom of the page.
29249  This document uses KOMA-script's book class,
29250  so it appears to be a bit fancier.
29251  But to really put on a show,
29252  you need to set the document page style to
29253 \begin_inset Quotes eld
29254 \end_inset
29255
29256 fancy
29257 \begin_inset Quotes erd
29258 \end_inset
29259
29260 ,
29261  as mentioned in the
29262 \emph on
29263 User Guide
29264 \emph default
29265 .
29266  This section describes the \SpecialChar LaTeX
29267  code you need to insert in your \SpecialChar LaTeX
29268  preamble in order to get the desired effects.
29269 \end_layout
29270
29271 \begin_layout Standard
29272
29273 \change_deleted -712698321 1674910251
29274 For more information on fancy headers,
29275  see the
29276 \begin_inset Flex Code
29277 status collapsed
29278
29279 \begin_layout Plain Layout
29280 fancyhdr
29281 \end_layout
29282
29283 \end_inset
29284
29285  package documentation.
29286  (
29287 \begin_inset Flex URL
29288 status collapsed
29289
29290 \begin_layout Plain Layout
29291
29292 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
29293 \end_layout
29294
29295 \end_inset
29296
29297 )
29298 \end_layout
29299
29300 \begin_layout Standard
29301
29302 \change_deleted -712698321 1674910251
29303 The page header is divided into three fields,
29304  not surprisingly labeled
29305 \begin_inset Quotes eld
29306 \end_inset
29307
29308 left
29309 \begin_inset Quotes erd
29310 \end_inset
29311
29312 ,
29313
29314 \begin_inset Quotes eld
29315 \end_inset
29316
29317 center
29318 \begin_inset Quotes erd
29319 \end_inset
29320
29321 ,
29322  and
29323 \begin_inset Quotes eld
29324 \end_inset
29325
29326 right
29327 \begin_inset Quotes erd
29328 \end_inset
29329
29330 .
29331  The footer is also divided into these three fields.
29332  The \SpecialChar LaTeX
29333  commands to set these fields in the simplest manner are
29334 \begin_inset Flex Code
29335 status collapsed
29336
29337 \begin_layout Plain Layout
29338
29339 \backslash
29340 lhead
29341 \end_layout
29342
29343 \end_inset
29344
29345 ,
29346
29347 \begin_inset Flex Code
29348 status collapsed
29349
29350 \begin_layout Plain Layout
29351
29352 \backslash
29353 chead
29354 \end_layout
29355
29356 \end_inset
29357
29358 ,
29359
29360 \begin_inset Flex Code
29361 status collapsed
29362
29363 \begin_layout Plain Layout
29364
29365 \backslash
29366 rhead
29367 \end_layout
29368
29369 \end_inset
29370
29371 ,
29372
29373 \begin_inset Flex Code
29374 status collapsed
29375
29376 \begin_layout Plain Layout
29377
29378 \backslash
29379 lfoot
29380 \end_layout
29381
29382 \end_inset
29383
29384 ,
29385  etc.
29386  Suppose you wish to put your name in the upper left hand corner of each page.
29387  Simply insert the following command in the preamble:
29388
29389 \end_layout
29390
29391 \begin_layout Standard
29392
29393 \change_deleted -712698321 1674910251
29394
29395 \family typewriter
29396
29397 \backslash
29398 lhead{John Q.
29399  DocWriter}
29400 \end_layout
29401
29402 \begin_layout Standard
29403
29404 \change_deleted -712698321 1674910251
29405 You will now see your name in the upper left.
29406  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,
29407  e.
29408 \begin_inset space \thinspace{}
29409 \end_inset
29410
29411 g.:
29412 \end_layout
29413
29414 \begin_layout Standard
29415
29416 \change_deleted -712698321 1674910251
29417
29418 \family typewriter
29419
29420 \backslash
29421 cfoot{}
29422 \end_layout
29423
29424 \begin_layout Standard
29425
29426 \change_deleted -712698321 1674910251
29427 Let's get really fancy:
29428  lets put the section number with the word
29429 \begin_inset Quotes eld
29430 \end_inset
29431
29432 Section
29433 \begin_inset Quotes erd
29434 \end_inset
29435
29436  (e.
29437 \begin_inset space \thinspace{}
29438 \end_inset
29439
29440 g.
29441 \begin_inset space \space{}
29442 \end_inset
29443
29444 Section 3) in the upper left,
29445  the page number (e.
29446 \begin_inset space \thinspace{}
29447 \end_inset
29448
29449 g.
29450 \begin_inset space \space{}
29451 \end_inset
29452
29453 Page 4) in the upper right,
29454  your name in the lower left,
29455  and the date in the lower right.
29456  The following commands should now appear in the preamble:
29457 \end_layout
29458
29459 \begin_layout Standard
29460
29461 \change_deleted -712698321 1674910251
29462
29463 \family typewriter
29464
29465 \backslash
29466 lhead{Section
29467 \backslash
29468 thesection}
29469 \end_layout
29470
29471 \begin_layout Standard
29472
29473 \change_deleted -712698321 1674910251
29474
29475 \family typewriter
29476
29477 \backslash
29478 chead{}
29479 \end_layout
29480
29481 \begin_layout Standard
29482
29483 \change_deleted -712698321 1674910251
29484
29485 \family typewriter
29486
29487 \backslash
29488 rhead{Page
29489 \backslash
29490 thepage}
29491 \end_layout
29492
29493 \begin_layout Standard
29494
29495 \change_deleted -712698321 1674910251
29496
29497 \family typewriter
29498
29499 \backslash
29500 lfoot{John Q.
29501  DocWriter}
29502 \end_layout
29503
29504 \begin_layout Standard
29505
29506 \change_deleted -712698321 1674910251
29507
29508 \family typewriter
29509
29510 \backslash
29511 cfoot{}
29512 \end_layout
29513
29514 \begin_layout Standard
29515
29516 \change_deleted -712698321 1674910251
29517
29518 \family typewriter
29519
29520 \backslash
29521 rfoot{
29522 \backslash
29523 today}
29524 \end_layout
29525
29526 \begin_layout Standard
29527
29528 \change_deleted -712698321 1674910251
29529 The commands
29530 \begin_inset Flex Code
29531 status collapsed
29532
29533 \begin_layout Plain Layout
29534
29535 \backslash
29536 thesection
29537 \end_layout
29538
29539 \end_inset
29540
29541  and
29542 \begin_inset Flex Code
29543 status collapsed
29544
29545 \begin_layout Plain Layout
29546
29547 \backslash
29548 thepage
29549 \end_layout
29550
29551 \end_inset
29552
29553  access \SpecialChar LaTeX
29554 's section and page counters,
29555  and so print out the current section and page number.
29556
29557 \begin_inset Flex Code
29558 status collapsed
29559
29560 \begin_layout Plain Layout
29561
29562 \backslash
29563 today
29564 \end_layout
29565
29566 \end_inset
29567
29568  simply prints out today's date.
29569 \end_layout
29570
29571 \begin_layout Standard
29572
29573 \change_deleted -712698321 1674910251
29574 The thicknesses of the horizontal rules drawn beneath the header and above the footer can also be modified.
29575  If you don't want one of the rules,
29576  set its thickness to 0.
29577  The header rule has a default thickness of 0.4pt,
29578  the footer rule is 0pt.
29579  Use commands
29580 \family typewriter
29581
29582 \family default
29583 like
29584 \begin_inset Flex Code
29585 status collapsed
29586
29587 \begin_layout Plain Layout
29588
29589 \backslash
29590 renewcommand{
29591 \backslash
29592 headrulewidth}{0.4pt}
29593 \end_layout
29594
29595 \end_inset
29596
29597  and
29598 \begin_inset Flex Code
29599 status collapsed
29600
29601 \begin_layout Plain Layout
29602
29603 \backslash
29604 renewcommand{
29605 \backslash
29606 footrulewidth}{0.4pt}
29607 \end_layout
29608
29609 \end_inset
29610
29611  to set the thicknesses.
29612 \end_layout
29613
29614 \begin_layout Standard
29615
29616 \change_deleted -712698321 1674910251
29617 You can switch the header/footer settings on and off for individual pages using commands like
29618 \begin_inset Flex Code
29619 status collapsed
29620
29621 \begin_layout Plain Layout
29622
29623 \backslash
29624 thispagestyle{empty}
29625 \end_layout
29626
29627 \end_inset
29628
29629 ,
29630
29631 \begin_inset Flex Code
29632 status collapsed
29633
29634 \begin_layout Plain Layout
29635
29636 \backslash
29637 thispagestyle{plain}
29638 \end_layout
29639
29640 \end_inset
29641
29642 ,
29643  and
29644 \begin_inset Flex Code
29645 status collapsed
29646
29647 \begin_layout Plain Layout
29648
29649 \backslash
29650 thispagestyle{fancy}
29651 \end_layout
29652
29653 \end_inset
29654
29655 .
29656  Simply insert them in the text on the page you want changed and mark them as \SpecialChar TeX
29657  code.
29658  In fact,
29659  title pages are marked as plain by default,
29660  while following pages are marked fancy when using the global fancy setting.
29661 \end_layout
29662
29663 \begin_layout Standard
29664
29665 \change_deleted -712698321 1674910251
29666 As a final example,
29667  it is possible to include an image in the header or footer.
29668  Suppose you want to put a company logo in the upper lefthand corner.
29669  You might try something like
29670 \end_layout
29671
29672 \begin_layout Standard
29673
29674 \change_deleted -712698321 1674910251
29675
29676 \family typewriter
29677
29678 \backslash
29679 lhead{
29680 \backslash
29681 resizebox{1in}{!}{
29682 \backslash
29683 includegraphics{logo.eps}}}
29684 \end_layout
29685
29686 \begin_layout Standard
29687 \noindent
29688
29689 \change_deleted -712698321 1674910251
29690 (you may need to preface this with
29691 \begin_inset Flex Code
29692 status collapsed
29693
29694 \begin_layout Plain Layout
29695
29696 \backslash
29697 usepackage{graphics}
29698 \end_layout
29699
29700 \end_inset
29701
29702  if you don't include graphics elsewhere in your document).
29703 \change_unchanged
29704
29705 \end_layout
29706
29707 \begin_layout Chapter
29708 \SpecialChar LyX
29709  and the World Wide Web
29710 \end_layout
29711
29712 \begin_layout Standard
29713 \SpecialChar LyX
29714  has long supported the export of documents to various web-friendly formats,
29715  such as HTML.
29716  Before version 2.0,
29717  however,
29718  HTML export was always accomplished by the use of external converters.
29719 \begin_inset Foot
29720 status collapsed
29721
29722 \begin_layout Plain Layout
29723 For details on the use of external converters with \SpecialChar LyX
29724 ,
29725  see the
29726 \emph on
29727 Converters
29728 \emph default
29729  section of the Customization manual.
29730 \end_layout
29731
29732 \end_inset
29733
29734  These fall into two large groups:
29735  there are converters that use \SpecialChar LaTeX
29736  as an intermediate format,
29737  such as
29738 \begin_inset Flex Code
29739 status collapsed
29740
29741 \begin_layout Plain Layout
29742 htlatex
29743 \end_layout
29744
29745 \end_inset
29746
29747 ,
29748
29749 \begin_inset Flex Code
29750 status collapsed
29751
29752 \begin_layout Plain Layout
29753 html2latex
29754 \end_layout
29755
29756 \end_inset
29757
29758 ,
29759  and
29760 \begin_inset Flex Code
29761 status collapsed
29762
29763 \begin_layout Plain Layout
29764 plastex
29765 \end_layout
29766
29767 \end_inset
29768
29769 ,
29770  relying upon \SpecialChar LyX
29771  to produce the \SpecialChar LaTeX
29772 ;
29773  and there is a converter that works directly on \SpecialChar LyX
29774  files,
29775
29776 \begin_inset Flex Code
29777 status collapsed
29778
29779 \begin_layout Plain Layout
29780 e\SpecialChar LyX
29781 er
29782 \end_layout
29783
29784 \end_inset
29785
29786 .
29787  All of these have different advantages and disadvantages.
29788
29789 \end_layout
29790
29791 \begin_layout Standard
29792 The \SpecialChar LaTeX
29793 -based converters have the advantage that,
29794  in principle,
29795  they know everything about the exported document that \SpecialChar LaTeX
29796  does.
29797  Such converters do not care,
29798  for example,
29799  if a certain block of code was produced by \SpecialChar LyX
29800  or was Evil Red Text.
29801  These converters know about
29802 \begin_inset Flex Code
29803 status collapsed
29804
29805 \begin_layout Plain Layout
29806 aux
29807 \end_layout
29808
29809 \end_inset
29810
29811  files,
29812  counters,
29813  and references,
29814  and can often make use of the
29815 \begin_inset Flex Code
29816 status collapsed
29817
29818 \begin_layout Plain Layout
29819 bbl
29820 \end_layout
29821
29822 \end_inset
29823
29824  files generated by Bib\SpecialChar TeX
29825 .
29826  On the other hand,
29827  \SpecialChar LaTeX
29828  is a very hard language to parse—
29829 it is sometimes said that only \SpecialChar TeX
29830  itself understands \SpecialChar TeX
29831 —
29832 and \SpecialChar LaTeX
29833 -based converters will often choke on what seem to be quite simple constructs;
29834  complex ones can throw them completely,
29835  and as of this writing,
29836  for example,
29837  the
29838 \emph on
29839 Embedded Objects
29840 \emph default
29841  manual will not export with
29842 \begin_inset Flex Code
29843 status collapsed
29844
29845 \begin_layout Plain Layout
29846 htlatex
29847 \end_layout
29848
29849 \end_inset
29850
29851 ,
29852  though the others will.
29853  The other issue concerns how math is handled.
29854  These converters typically convert the formulae into little pictures that are then linked from the HTML document.
29855  Since these are actually generated by \SpecialChar LaTeX
29856 ,
29857  they are accurate.
29858  But they do not scale well,
29859  and just getting them to look as if they are actually meant to be in your document—
29860 so that the font sizes seem to be roughly the same—
29861 can be a challenge.
29862 \end_layout
29863
29864 \begin_layout Standard
29865 Alex Fernandez's
29866 \begin_inset Flex Code
29867 status collapsed
29868
29869 \begin_layout Plain Layout
29870 e\SpecialChar LyX
29871 er
29872 \end_layout
29873
29874 \end_inset
29875
29876  (
29877 \begin_inset CommandInset href
29878 LatexCommand href
29879 name "http://pinchito.es/elyxer/"
29880 target "http://pinchito.es/elyxer/"
29881 literal "false"
29882
29883 \end_inset
29884
29885 ) solves some of these problems.
29886  In particular,
29887  the formulae it produces scale perfectly,
29888  since it renders math using a combination of HTML and CSS rather than converting the formulae to images.
29889  But even moderately complex formula are rendered less well than with
29890 \begin_inset Flex Code
29891 status collapsed
29892
29893 \begin_layout Plain Layout
29894 htlatex
29895 \end_layout
29896
29897 \end_inset
29898
29899 ;
29900  this reflects the limitations of HTML.
29901 \begin_inset Foot
29902 status collapsed
29903
29904 \begin_layout Plain Layout
29905 That said,
29906
29907 \begin_inset Flex Code
29908 status collapsed
29909
29910 \begin_layout Plain Layout
29911 e\SpecialChar LyX
29912 er
29913 \end_layout
29914
29915 \end_inset
29916
29917  can also use jsMath and MathJax for equations,
29918  but this setting is only available globally and requires one to have access to a server that runs the backend.
29919 \end_layout
29920
29921 \end_inset
29922
29923  More importantly (as of version 1.1.1,
29924  at least),
29925
29926 \begin_inset Flex Code
29927 status collapsed
29928
29929 \begin_layout Plain Layout
29930 e\SpecialChar LyX
29931 er
29932 \end_layout
29933
29934 \end_inset
29935
29936  has limited support for math macros and no support for user-defined paragraph or character styles.
29937  These limitations make
29938 \begin_inset Flex Code
29939 status collapsed
29940
29941 \begin_layout Plain Layout
29942 e\SpecialChar LyX
29943 er
29944 \end_layout
29945
29946 \end_inset
29947
29948  unsuitable for many of the documents \SpecialChar LyX
29949  users produce.
29950  In principle,
29951  of course,
29952  these problems could be solved,
29953  but the \SpecialChar LyX
29954  developers have decided to follow a different path and have made \SpecialChar LyX
29955  itself capable of writing XHTML,
29956  just as it is capable of writing \SpecialChar LaTeX
29957 ,
29958  DocBook,
29959  and plaintext.
29960 \end_layout
29961
29962 \begin_layout Standard
29963 As of this writing,
29964  XHTML output remains under development and should probably be regarded as
29965 \begin_inset Quotes eld
29966 \end_inset
29967
29968 experimental
29969 \begin_inset Quotes erd
29970 \end_inset
29971
29972 .
29973 \begin_inset Foot
29974 status collapsed
29975
29976 \begin_layout Plain Layout
29977 The file
29978 \begin_inset Flex Code
29979 status collapsed
29980
29981 \begin_layout Plain Layout
29982 development/HTML/HTML.notes
29983 \end_layout
29984
29985 \end_inset
29986
29987 ,
29988  which can be found in the \SpecialChar LyX
29989  source tree or
29990 \begin_inset CommandInset href
29991 LatexCommand href
29992 name "accessed online"
29993 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
29994 literal "false"
29995
29996 \end_inset
29997
29998 ,
29999  usually contains up-to-date information about the state of XHTML output.
30000  See also the list of XHTML bugs on
30001 \begin_inset CommandInset href
30002 LatexCommand href
30003 name "the bug tracker"
30004 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"
30005 literal "false"
30006
30007 \end_inset
30008
30009 .
30010 \end_layout
30011
30012 \end_inset
30013
30014  Still,
30015  the developers have chosen this approach because it has several potential advantages over the other two.
30016 \end_layout
30017
30018 \begin_layout Standard
30019 These advantages are primarily due to the fact that the XHTML output routines,
30020  since they are part of \SpecialChar LyX
30021 ,
30022  know everything \SpecialChar LyX
30023  knows about the document being exported.
30024 \begin_inset Foot
30025 status collapsed
30026
30027 \begin_layout Plain Layout
30028 Another advantage is that,
30029  since these routines are internal to \SpecialChar LyX
30030 ,
30031  they are immune to changes in \SpecialChar LyX
30032 's file format,
30033  or to changes in the semantics of existing insets.
30034 \end_layout
30035
30036 \end_inset
30037
30038  So they know about the table of contents (as displayed in the outline),
30039  about the counters associated with different paragraph styles,
30040  and about user-defined styles.
30041  The XHTML output routines know what \SpecialChar LyX
30042  knows about internationalization,
30043  too,
30044  so they will output
30045 \begin_inset Quotes eld
30046 \end_inset
30047
30048 Chapter 1
30049 \begin_inset Quotes erd
30050 \end_inset
30051
30052  or
30053 \begin_inset Quotes eld
30054 \end_inset
30055
30056
30057 \lang ngerman
30058 Kapitel
30059 \lang english
30060  1
30061 \begin_inset Quotes erd
30062 \end_inset
30063
30064 ,
30065  depending upon the language in effect at the time.
30066
30067 \end_layout
30068
30069 \begin_layout Standard
30070 Quite generally,
30071  the output routines know what \SpecialChar LyX
30072  knows about document layout,
30073  that is,
30074  about how the document is to be rendered on screen.
30075  We use this information when we output the document as XHTML.
30076  In particular,
30077  \SpecialChar LyX
30078
30079 \emph on
30080 automatically
30081 \emph default
30082  generates CSS style information corresponding to the layout information it uses to render the document on screen:
30083  if section headings are supposed to be sans-serif and bold as seen in \SpecialChar LyX
30084 ,
30085  then (by default) they will be sans-serif and bold when viewed in a web browser,
30086  too.
30087  And this is true not just for pre-defined styles,
30088  like Section,
30089  but for any style,
30090  including user-defined styles.
30091  Indeed,
30092  the XHTML output routines make no distinction between user-defined paragraph and
30093 \change_deleted 244031559 1603876931
30094 character
30095 \change_inserted 244031559 1603876940
30096 text
30097 \change_unchanged
30098  styles and \SpecialChar LyX
30099 's own pre-defined styles:
30100  in each case,
30101  everything \SpecialChar LyX
30102  knows about the styles is contained in the layout files.
30103  And much the same is true as regards pre-defined textual insets,
30104  such as footnotes,
30105  and various custom insets.
30106
30107 \end_layout
30108
30109 \begin_layout Standard
30110 The result is that XHTML output can be customized and extended in exactly the same way \SpecialChar LaTeX
30111  output can be customized and extended:
30112  through layout files and modules.
30113  See chapter five of the
30114 \emph on
30115 Customization
30116 \emph default
30117 manual for the details.
30118 \end_layout
30119
30120 \begin_layout Standard
30121 The remainder of this chapter contains more detailed information on XHTML output,
30122  its limitations,
30123  and ways to work around those limitations.
30124 \end_layout
30125
30126 \begin_layout Section
30127 Math Output in XHTML
30128 \end_layout
30129
30130 \begin_layout Standard
30131 \SpecialChar LyX
30132  offers four choices for how math is rendered.
30133  These have various advantages and disadvantages:
30134 \end_layout
30135
30136 \begin_layout Itemize
30137 MathML
30138 \begin_inset Newline newline
30139 \end_inset
30140
30141 MathML is a dialect of XML designed specifically for mathematics on the web,
30142  and it typically renders very well in browsers that support it.
30143  The disadvantage is that not all browsers support MathML,
30144  and support is not complete even in the Gecko-based browsers,
30145  such as Firefox.
30146 \begin_inset Newline newline
30147 \end_inset
30148
30149 If \SpecialChar LyX
30150  is unable to render a formula as MathML—
30151 for example,
30152  if the formula uses the
30153 \begin_inset Flex Code
30154 status collapsed
30155
30156 \begin_layout Plain Layout
30157 xymatrix
30158 \end_layout
30159
30160 \end_inset
30161
30162  package or ERT—
30163 then it will instead output the formula as an image.
30164
30165 \end_layout
30166
30167 \begin_layout Itemize
30168 HTML
30169 \begin_inset Newline newline
30170 \end_inset
30171
30172 As mentioned above,
30173
30174 \begin_inset Flex Code
30175 status collapsed
30176
30177 \begin_layout Plain Layout
30178 elyxer
30179 \end_layout
30180
30181 \end_inset
30182
30183  outputs math as HTML,
30184  styled by CSS.
30185 \begin_inset Foot
30186 status collapsed
30187
30188 \begin_layout Plain Layout
30189 \SpecialChar LyX
30190  has borrowed some of the CSS for its HTML output from
30191 \begin_inset Flex Code
30192 status collapsed
30193
30194 \begin_layout Plain Layout
30195 elyxer
30196 \end_layout
30197
30198 \end_inset
30199
30200 .
30201 \end_layout
30202
30203 \end_inset
30204
30205  For simple formulae,
30206  this can work quite well,
30207  though with more complicated formulae it tends to break down.
30208  Still,
30209  this method has the advantage that it is very widely supported and so it may be appropriate for documents that contain only a little,
30210  fairly simple math.
30211 \begin_inset Newline newline
30212 \end_inset
30213
30214 If Lyx is unable to render a formula as HTML—
30215 for example,
30216  if the formula uses the
30217 \begin_inset Flex Code
30218 status collapsed
30219
30220 \begin_layout Plain Layout
30221 xymatrix
30222 \end_layout
30223
30224 \end_inset
30225
30226  package or ERT—
30227 then it will instead output the formula as an image.
30228
30229 \end_layout
30230
30231 \begin_layout Itemize
30232 Images
30233 \begin_inset Newline newline
30234 \end_inset
30235
30236 Like
30237 \begin_inset Flex Code
30238 status collapsed
30239
30240 \begin_layout Plain Layout
30241 htlatex
30242 \end_layout
30243
30244 \end_inset
30245
30246 ,
30247  \SpecialChar LyX
30248  will output formulae as images,
30249  the very same images,
30250  in fact,
30251  that are used for instant preview.
30252 \begin_inset Foot
30253 status collapsed
30254
30255 \begin_layout Plain Layout
30256 Instant preview does
30257 \emph on
30258 not
30259 \emph default
30260 have to be on for images to be output,
30261  however.
30262 \end_layout
30263
30264 \end_inset
30265
30266  The advantage to this method is that the images are simply generated by \SpecialChar LaTeX
30267 ,
30268  so they are very accurate.
30269  The disadvantage,
30270  as mentioned earlier,
30271  is that these are bitmapped images,
30272  so they do not scale terribly well,
30273  and one cannot copy them,
30274  etc.
30275 \begin_inset Newline newline
30276 \end_inset
30277
30278 The size of the images can be controlled by setting the
30279 \begin_inset Quotes eld
30280 \end_inset
30281
30282 Math Images Scaling
30283 \begin_inset Quotes erd
30284 \end_inset
30285
30286  parameter under
30287 \change_deleted -712698321 1674917822
30288
30289 \begin_inset Flex Noun
30290 status collapsed
30291
30292 \begin_layout Plain Layout
30293 Document\SpecialChar menuseparator
30294 Settings\SpecialChar menuseparator
30295 Formats
30296 \end_layout
30297
30298 \end_inset
30299
30300
30301 \change_inserted -712698321 1674917822
30302
30303 \family sans
30304 Document\SpecialChar menuseparator
30305 Settings\SpecialChar menuseparator
30306 Formats
30307 \change_unchanged
30308
30309 \family default
30310 .
30311 \begin_inset Foot
30312 status collapsed
30313
30314 \begin_layout Plain Layout
30315 For those who want to know,
30316  this controls the resolution of the image in dots per inch and is based upon a default of 75 dpi.
30317 \end_layout
30318
30319 \end_inset
30320
30321
30322 \begin_inset Newline newline
30323 \end_inset
30324
30325 If \SpecialChar LyX
30326  for some reason fails to create an image for a formula (e.g.,
30327  if a required \SpecialChar LaTeX
30328  package is not installed),
30329  then it will fall back to outputing the raw \SpecialChar LaTeX
30330 .
30331 \end_layout
30332
30333 \begin_layout Itemize
30334 \SpecialChar LaTeX
30335
30336 \begin_inset Newline newline
30337 \end_inset
30338
30339 Finally,
30340  \SpecialChar LyX
30341  will happily output math as \SpecialChar LaTeX
30342 .
30343  As well as being the output of last resort,
30344  this method can be used with such tools as
30345 \begin_inset CommandInset href
30346 LatexCommand href
30347 name "jsMath"
30348 target "http://www.math.union.edu/~dpvc/jsMath/"
30349 literal "false"
30350
30351 \end_inset
30352
30353 ,
30354  which uses JavaScript to render \SpecialChar LaTeX
30355  embedded in HTML documents.
30356  \SpecialChar LyX
30357  wraps the \SpecialChar LaTeX
30358  in either a
30359 \begin_inset Flex Code
30360 status collapsed
30361
30362 \begin_layout Plain Layout
30363 span
30364 \end_layout
30365
30366 \end_inset
30367
30368  (for inline formulas) or
30369 \begin_inset Flex Code
30370 status collapsed
30371
30372 \begin_layout Plain Layout
30373 div
30374 \end_layout
30375
30376 \end_inset
30377
30378  (for displayed formulas) with
30379 \begin_inset Flex Code
30380 status collapsed
30381
30382 \begin_layout Plain Layout
30383 class='math'
30384 \end_layout
30385
30386 \end_inset
30387
30388 ,
30389  as is required for jsMath.
30390 \end_layout
30391
30392 \begin_layout Standard
30393 One of these output methods must be selected under
30394 \change_deleted -712698321 1674917830
30395
30396 \begin_inset Flex Noun
30397 status collapsed
30398
30399 \begin_layout Plain Layout
30400 Document\SpecialChar menuseparator
30401 Settings\SpecialChar menuseparator
30402 Formats
30403 \end_layout
30404
30405 \end_inset
30406
30407
30408 \change_inserted -712698321 1674917830
30409
30410 \family sans
30411 Document\SpecialChar menuseparator
30412 Settings\SpecialChar menuseparator
30413 Formats
30414 \change_unchanged
30415
30416 \family default
30417 .
30418  By default,
30419  \SpecialChar LyX
30420  outputs MathML.
30421  This is a document-wide setting,
30422  therefore.
30423 \end_layout
30424
30425 \begin_layout Standard
30426 Eventually,
30427  \SpecialChar LyX
30428  will offer the user the option to select an alternate output method for a particular inset,
30429  say,
30430  one that isn't being rendered very well by MathML.
30431 \begin_inset Foot
30432 status collapsed
30433
30434 \begin_layout Plain Layout
30435 That said,
30436  since \SpecialChar LyX
30437  falls back to images if the inset contains ERT,
30438  then one can force output as an image by putting some harmless ERT into the math,
30439  for example:
30440
30441 \begin_inset Formula $a=b\relax$
30442 \end_inset
30443
30444 .
30445 \end_layout
30446
30447 \end_inset
30448
30449
30450 \end_layout
30451
30452 \begin_layout Section
30453 Bibliography and Citations
30454 \end_layout
30455
30456 \begin_layout Standard
30457 XHTML output fully supports bibliographies and citations.
30458
30459 \end_layout
30460
30461 \begin_layout Standard
30462 Citation labels are generated by the same machinery that generates \SpecialChar LyX
30463 's on-screen labels,
30464  so the labels will look in the output much as they do in \SpecialChar LyX
30465 ,
30466  though better.
30467  If you are using numerical citations,
30468  then \SpecialChar LyX
30469  will output numerical labels,
30470  such as [1] or [17],
30471  rather than simply showing the citation key in square brackets,
30472  as it does on-screen.
30473  If you are using author-year citations,
30474  then \SpecialChar LyX
30475  will add lowercase letters to the years,
30476  just as Bib\SpecialChar TeX
30477  does,
30478  if it finds more than one citation for a given author-year combination.
30479  The labels will be printed with the bibliography entries.
30480  Note that there is,
30481  at present,
30482  no way to customize the appearance of the labels,
30483  for example,
30484  to choose between square brackets and parentheses.
30485 \end_layout
30486
30487 \begin_layout Standard
30488 Bibliography output is handled by the same machinery that handles the presentation of reference information in the citation dialog,
30489  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.
30490  The formatting can be customized in your layout file or,
30491  preferably,
30492  in a module.
30493  See the
30494 \emph on
30495 Customization
30496 \emph default
30497  manual for the details.
30498 \end_layout
30499
30500 \begin_layout Standard
30501 The main defect at present is that cross-referenced information is printed with every entry with which it is associated.
30502  So you can see things like this:
30503 \end_layout
30504
30505 \begin_layout Quote
30506 Jason Stanley,
30507
30508 \begin_inset Quotes eld
30509 \end_inset
30510
30511 Context and Logical Form
30512 \begin_inset Quotes erd
30513 \end_inset
30514
30515 ,
30516  in
30517 \emph on
30518 Language in Context:
30519  Selected Essays
30520 \emph default
30521  (Oxford:
30522  Oxford University Press,
30523  2007),
30524  pp.
30525  30–68.
30526 \end_layout
30527
30528 \begin_layout Quote
30529 Jason Stanley,
30530
30531 \begin_inset Quotes eld
30532 \end_inset
30533
30534 Semantics in Context
30535 \begin_inset Quotes erd
30536 \end_inset
30537
30538 ,
30539  in
30540 \emph on
30541 Language in Context:
30542  Selected Essays
30543 \emph default
30544  (Oxford:
30545  Oxford University Press,
30546  2007),
30547  pp.
30548  201–30.
30549 \end_layout
30550
30551 \begin_layout Standard
30552 This should be fixed before long.
30553 \end_layout
30554
30555 \begin_layout Standard
30556 There is no support at present for sectioned bibliographies.
30557  If you have multiple bibliographies,
30558  then \SpecialChar LyX
30559  will print the same bibliography over and over.
30560 \end_layout
30561
30562 \begin_layout Section
30563 Indexes
30564 \end_layout
30565
30566 \begin_layout Standard
30567 \SpecialChar LyX
30568  will happily export indexes as XHTML,
30569  but with certain limitations at the moment.
30570 \end_layout
30571
30572 \begin_layout Standard
30573 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
30574 \emph on
30575 User's Guide
30576 \emph default
30577 .
30578 \begin_inset Foot
30579 status collapsed
30580
30581 \begin_layout Plain Layout
30582 The main issue here is that \SpecialChar LyX
30583  itself does not really handle these.
30584  It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
30585 .
30586 \end_layout
30587
30588 \end_inset
30589
30590  We'll describe how they are handled using the subsection headings from that section.
30591 \end_layout
30592
30593 \begin_layout Itemize
30594 Grouping Index Entries (aka,
30595  sub-entries):
30596  \SpecialChar LyX
30597  makes an effort to support these,
30598  but the entries must be separated by
30599 \begin_inset Quotes eld
30600 \end_inset
30601
30602  !
30603
30604 \begin_inset Quotes erd
30605 \end_inset
30606
30607 ,
30608  that is,
30609  there must be spaces around the exclamation point.
30610  This is because it is otherwise too difficult to check for escaped exclamation points,
30611  ones in math,
30612  and so forth.
30613 \end_layout
30614
30615 \begin_layout Itemize
30616 Page Ranges:
30617  There is no support at all for page ranges,
30618  since these make no sense with XHMTL.
30619  Instead,
30620  you will just get two index entries,
30621  one at either end.
30622 \end_layout
30623
30624 \begin_layout Itemize
30625 Cross-referencing:
30626  There is no support for cross-referencing.
30627  If \SpecialChar LyX
30628  finds an entry containing the
30629 \begin_inset Quotes eld
30630 \end_inset
30631
30632 |see\SpecialChar ldots
30633
30634 \begin_inset Quotes erd
30635 \end_inset
30636
30637  construct,
30638  it is just dropped,
30639  and the rest is treated as an ordinary index entry.
30640 \end_layout
30641
30642 \begin_layout Itemize
30643 Index Entry Order:
30644  \SpecialChar LyX
30645  does support attempts to fix the sorting order.
30646  It will take what is before the first `@' it finds and use that for sorting,
30647  taking what follows the first `@' to be the actual entry.
30648  At present,
30649  \SpecialChar LyX
30650  does not check for escaped `@',
30651  so do not try to index email addresses.
30652 \end_layout
30653
30654 \begin_layout Itemize
30655 Index Entry Layout:
30656  You can format entries by using the text style dialog,
30657  or by using any other method available within \SpecialChar LyX
30658  itself.
30659  There is no support for constructs like:
30660
30661 \begin_inset Quotes eld
30662 \end_inset
30663
30664 entry|textbf
30665 \begin_inset Quotes erd
30666 \end_inset
30667
30668 .
30669  Indeed,
30670  if \SpecialChar LyX
30671  finds a pipe symbol,
30672  `|',
30673  in an entry,
30674  it will delete it and everything that follows it.
30675 \end_layout
30676
30677 \begin_layout Itemize
30678 Multiple Indexes:
30679  There is no support for multiple indexes.
30680  Rather,
30681  all index entries will be printed as one large index.
30682  To avoid our printing several versions of the index,
30683  we print only the main index,
30684  so make sure you have one.
30685 \end_layout
30686
30687 \begin_layout Section
30688 Nomenclature and Glossary
30689 \end_layout
30690
30691 \begin_layout Standard
30692 There is at present no support for glossaries.
30693  Adding it would be fairly trivial,
30694  and welcome.
30695 \end_layout
30696
30697 \begin_layout Chapter
30698
30699 \change_inserted 1075283030 1616534180
30700 DocBook Output
30701 \end_layout
30702
30703 \begin_layout Standard
30704
30705 \change_inserted 1075283030 1616534386
30706 Apart from HTML,
30707  \SpecialChar LyX
30708  can generate documents in the DocBook XML vocabulary.
30709  With versions 2.3 and before,
30710  only select templates could be used to generate DocBook documents (only version 4).
30711  Starting with \SpecialChar LyX
30712  2.4,
30713  most \SpecialChar LyX
30714  layouts can generate valid DocBook documents (only version 5).
30715  This feature is built into \SpecialChar LyX
30716  and does not require the use of external tools.
30717 \end_layout
30718
30719 \begin_layout Standard
30720
30721 \change_inserted 1075283030 1616534437
30722 The result is that the DocBook output can be customized and extended in exactly the same way \SpecialChar LaTeX
30723  output can be customized and extended:
30724  through layout files and modules.
30725  See chapter five of the
30726 \emph on
30727 Customization
30728 \emph default
30729 manual for the details.
30730 \end_layout
30731
30732 \begin_layout Standard
30733
30734 \change_inserted 1075283030 1616534475
30735 Most \SpecialChar LyX
30736  features are supported with DocBook,
30737  like math output.
30738 \end_layout
30739
30740 \begin_layout Itemize
30741
30742 \change_inserted 1075283030 1616534741
30743 Math output is performed mostly in MathML (the major exception being constructions not supported by \SpecialChar LyX
30744 ,
30745  i.e.
30746  ERTs).
30747  All formulae are also available in raw \SpecialChar TeX
30748  in the DocBook output for further processing.
30749 \end_layout
30750
30751 \begin_layout Itemize
30752
30753 \change_inserted 1075283030 1616534852
30754 Bibliographies and citations are implemented,
30755  including with an external BibTeX file.
30756  Bibliography entries are not prerendered when the detailed information are available,
30757  but rather output with the standard DocBook constructs.
30758  The external DocBook processor is expected to handle the rendering of entries.
30759 \end_layout
30760
30761 \begin_layout Itemize
30762
30763 \change_inserted 1075283030 1616534863
30764 Indexes are supported,
30765  including multiple indices.
30766  Grouping (with
30767 \family typewriter
30768 !
30769 \family default
30770 ),
30771  page ranges,
30772  and cross-references (
30773 \family typewriter
30774 |see
30775 \family default
30776 ) are supported,
30777  with the exception of the same symbols escaped.
30778  Entry order (
30779 \family typewriter
30780 @
30781 \family default
30782 ) and layout (
30783 \family typewriter
30784 |mathbf
30785 \family default
30786 ) are not supported.
30787  There is no support for escaping of index entries.
30788 \end_layout
30789
30790 \begin_layout Itemize
30791
30792 \change_inserted 1075283030 1616534884
30793 Glossaries are implemented.
30794 \end_layout
30795
30796 \begin_layout Standard
30797
30798 \change_inserted 1075283030 1616534894
30799 Two major parameters can be set at the document level.
30800 \end_layout
30801
30802 \begin_layout Itemize
30803
30804 \change_inserted 1075283030 1616534948
30805 Format for tables:
30806  \SpecialChar LyX
30807  can generate tables either as HTML (default value) or CALS,
30808  depending on the user's requirements.
30809  Most DocBook processors accept both formats.
30810 \end_layout
30811
30812 \begin_layout Itemize
30813
30814 \change_inserted 1075283030 1616535006
30815 MathML prefix:
30816  in DocBook,
30817  MathML is included within its own name space,
30818  unlike HTML.
30819  The implication is that there must be an indication of the tags belonging to the MathML standard.
30820  Three choices are offered:
30821
30822 \end_layout
30823
30824 \begin_deeper
30825 \begin_layout Itemize
30826
30827 \change_inserted 1075283030 1616535044
30828 Inline:
30829  the MathML name space is defined for each formula (using the
30830 \family typewriter
30831 xmlns
30832 \family default
30833  attribute on each formula)
30834 \end_layout
30835
30836 \begin_layout Itemize
30837
30838 \change_inserted 1075283030 1616535090
30839 With the
30840 \family typewriter
30841 m
30842 \family default
30843  prefix (default):
30844  the MathML name space is defined at the document level (using the
30845 \family typewriter
30846 xmlns:m
30847 \family default
30848  attribute on the root element).
30849  Each MathML is prefixed with
30850 \family typewriter
30851 m
30852 \family default
30853 :
30854  for instance,
30855
30856 \family typewriter
30857 m:math
30858 \end_layout
30859
30860 \begin_layout Itemize
30861
30862 \change_inserted 1075283030 1616620405
30863 With the
30864 \family typewriter
30865 mml
30866 \family default
30867  prefix:
30868  similar to the
30869 \family typewriter
30870 m
30871 \family default
30872  option,
30873  but with
30874 \family typewriter
30875 mml
30876 \end_layout
30877
30878 \begin_layout Standard
30879
30880 \change_inserted 1075283030 1616620470
30881 This option is especially useful if you want \SpecialChar LyX
30882  to match your personal style or to work with buggy software that only accepts one prefix for MathML.
30883 \change_unchanged
30884
30885 \end_layout
30886
30887 \end_deeper
30888 \begin_layout Chapter
30889 The \SpecialChar LyX
30890  Server
30891 \end_layout
30892
30893 \begin_layout Section
30894 Introduction
30895 \end_layout
30896
30897 \begin_layout Standard
30898 The `\SpecialChar LyX
30899  server' allows other programs to talk to \SpecialChar LyX
30900 ,
30901  invoke \SpecialChar LyX
30902  commands,
30903  and retrieve information about the \SpecialChar LyX
30904  internal state.
30905  This is only intended for advanced users,
30906  but they should find it useful.
30907  It is by writing to the \SpecialChar LyX
30908  server,
30909  for example,
30910  that bibliography managers,
30911  such as JabRef,
30912  are able to
30913 \begin_inset Quotes eld
30914 \end_inset
30915
30916 push
30917 \begin_inset Quotes erd
30918 \end_inset
30919
30920  citations to \SpecialChar LyX
30921 .
30922 \end_layout
30923
30924 \begin_layout Section
30925 Starting the \SpecialChar LyX
30926  Server
30927 \begin_inset CommandInset label
30928 LatexCommand label
30929 name "sec:Starting-the-Server"
30930
30931 \end_inset
30932
30933
30934 \end_layout
30935
30936 \begin_layout Standard
30937 The \SpecialChar LyX
30938  server works through the use of a pair of named pipes.
30939  These are usually located in
30940 \begin_inset Flex Code
30941 status collapsed
30942
30943 \begin_layout Plain Layout
30944 UserDir
30945 \end_layout
30946
30947 \end_inset
30948
30949 ,
30950  (except on Windows,
30951  where
30952 \emph on
30953 local
30954 \emph default
30955  named pipes are special objects located in
30956 \begin_inset Flex Code
30957 status collapsed
30958
30959 \begin_layout Plain Layout
30960
30961 \backslash
30962
30963 \backslash
30964 .
30965 \backslash
30966 pipe
30967 \end_layout
30968
30969 \end_inset
30970
30971 ) and have the names
30972 \begin_inset Quotes eld
30973 \end_inset
30974
30975
30976 \begin_inset Flex Code
30977 status collapsed
30978
30979 \begin_layout Plain Layout
30980 lyxpipe.in
30981 \end_layout
30982
30983 \end_inset
30984
30985
30986 \begin_inset Quotes erd
30987 \end_inset
30988
30989  and
30990 \begin_inset Quotes eld
30991 \end_inset
30992
30993
30994 \begin_inset Flex Code
30995 status collapsed
30996
30997 \begin_layout Plain Layout
30998 lyxpipe.out
30999 \end_layout
31000
31001 \end_inset
31002
31003
31004 \begin_inset Quotes erd
31005 \end_inset
31006
31007 .
31008  External programs write into
31009 \begin_inset Flex Code
31010 status collapsed
31011
31012 \begin_layout Plain Layout
31013 lyxpipe.in
31014 \end_layout
31015
31016 \end_inset
31017
31018  and read back data from
31019 \begin_inset Flex Code
31020 status collapsed
31021
31022 \begin_layout Plain Layout
31023 lyxpipe.out
31024 \end_layout
31025
31026 \end_inset
31027
31028 .
31029  The stem of the pipe names can be defined in the
31030 \change_deleted -712698321 1674917840
31031
31032 \begin_inset Flex Noun
31033 status collapsed
31034
31035 \begin_layout Plain Layout
31036 Tools\SpecialChar menuseparator
31037 Preferences
31038 \end_layout
31039
31040 \end_inset
31041
31042
31043 \change_inserted -712698321 1674917840
31044
31045 \family sans
31046 Tools\SpecialChar menuseparator
31047 Preferences
31048 \change_unchanged
31049
31050 \family default
31051  dialog,
31052  for example
31053 \begin_inset Flex Code
31054 status collapsed
31055
31056 \begin_layout Plain Layout
31057 "/home/myhome/lyxpipe"
31058 \end_layout
31059
31060 \end_inset
31061
31062 ,
31063  or
31064 \begin_inset Flex Code
31065 status collapsed
31066
31067 \begin_layout Plain Layout
31068 "
31069 \backslash
31070
31071 \backslash
31072 .
31073 \backslash
31074 pipe
31075 \backslash
31076 lyxpipe"
31077 \end_layout
31078
31079 \end_inset
31080
31081  on Windows (where any working path instead of lyxpipe can be used,
31082  for example
31083 \begin_inset Flex Code
31084 status collapsed
31085
31086 \begin_layout Plain Layout
31087 "
31088 \backslash
31089
31090 \backslash
31091 .
31092 \backslash
31093 pipe
31094 \backslash
31095 my
31096 \backslash
31097 lyx
31098 \backslash
31099 pipe"
31100 \end_layout
31101
31102 \end_inset
31103
31104  would also work).
31105  You
31106 \emph on
31107 must
31108 \emph default
31109  configure this manually in order for the server to start.
31110 \end_layout
31111
31112 \begin_layout Standard
31113 \SpecialChar LyX
31114  will add the '
31115 \begin_inset Flex Code
31116 status collapsed
31117
31118 \begin_layout Plain Layout
31119 .in
31120 \end_layout
31121
31122 \end_inset
31123
31124 ' and '
31125 \begin_inset Flex Code
31126 status collapsed
31127
31128 \begin_layout Plain Layout
31129 .out
31130 \end_layout
31131
31132 \end_inset
31133
31134 ' to create the pipes.
31135  If one of the pipes already exists,
31136  \SpecialChar LyX
31137  will assume that another \SpecialChar LyX
31138  process is already running and will not start the server.
31139  On POSIX (Unix like) systems,
31140  if for some other reason,
31141  an unused
31142 \begin_inset Quotes eld
31143 \end_inset
31144
31145 stale
31146 \begin_inset Quotes erd
31147 \end_inset
31148
31149  pipe is left in existence when \SpecialChar LyX
31150  closes,
31151  then \SpecialChar LyX
31152  will try to delete it.
31153  If this fails for some reason,
31154  you will need to delete the pipes manually and then restart \SpecialChar LyX
31155 .
31156  On Windows,
31157  pipes are deleted by the OS on program termination or crash,
31158  so
31159 \begin_inset Quotes eld
31160 \end_inset
31161
31162 stale
31163 \begin_inset Quotes erd
31164 \end_inset
31165
31166  pipes should not be possible.
31167 \end_layout
31168
31169 \begin_layout Standard
31170 To have several \SpecialChar LyX
31171  processes with servers at the same time,
31172  you have to use different configurations,
31173  perhaps by using separate user directories,
31174  each with its own
31175 \begin_inset Flex Code
31176 status collapsed
31177
31178 \begin_layout Plain Layout
31179 preferences
31180 \end_layout
31181
31182 \end_inset
31183
31184  file,
31185  for each process.
31186 \end_layout
31187
31188 \begin_layout Standard
31189 If you are developing a client program,
31190  you might find it useful to enable debugging information from the \SpecialChar LyX
31191  server.
31192  Do this by starting \SpecialChar LyX
31193  as
31194 \begin_inset Flex Code
31195 status collapsed
31196
31197 \begin_layout Plain Layout
31198 lyx -dbg lyxserver
31199 \end_layout
31200
31201 \end_inset
31202
31203 .
31204 \end_layout
31205
31206 \begin_layout Standard
31207 You can find a complete example client written in C++ in the source distribution as
31208 \begin_inset Flex Code
31209 status collapsed
31210
31211 \begin_layout Plain Layout
31212 development/lyxserver/server_monitor.cpp
31213 \end_layout
31214
31215 \end_inset
31216
31217 .
31218 \end_layout
31219
31220 \begin_layout Standard
31221 Another useful tool is the command-line based client found in
31222 \begin_inset Flex Code
31223 status collapsed
31224
31225 \begin_layout Plain Layout
31226 src/client/lyxclient
31227 \end_layout
31228
31229 \end_inset
31230
31231 .
31232 \end_layout
31233
31234 \begin_layout Section
31235 Normal communication
31236 \end_layout
31237
31238 \begin_layout Standard
31239 To issue a \SpecialChar LyX
31240  call,
31241  the client writes a line of ASCII text into the input pipe.
31242  This line has the following format:
31243 \end_layout
31244
31245 \begin_layout Quote
31246 LYXCMD:
31247 \emph on
31248 clientname
31249 \emph default
31250 :
31251 \emph on
31252 function
31253 \emph default
31254 :
31255 \emph on
31256 argument
31257 \end_layout
31258
31259 \begin_layout Description
31260 clientname is a name that the client can choose arbitrarily.
31261  Its only use is that \SpecialChar LyX
31262  will echo it if it sends an answer—
31263 so a client can dispatch results from different requesters.
31264 \end_layout
31265
31266 \begin_layout Description
31267 function is the function you want \SpecialChar LyX
31268  to perform.
31269  It is the same as the commands you'd use in the minibuffer.
31270 \end_layout
31271
31272 \begin_layout Description
31273 argument is an optional argument which is meaningful only to some functions (for instance,
31274  the
31275 \begin_inset Quotes eld
31276 \end_inset
31277
31278 self-insert
31279 \begin_inset Quotes erd
31280 \end_inset
31281
31282  LFUN will insert the argument as text at the cursor position).
31283 \end_layout
31284
31285 \begin_layout Standard
31286 The answer from \SpecialChar LyX
31287  will arrive in the output pipe and be of the form
31288 \end_layout
31289
31290 \begin_layout Quote
31291 INFO:
31292 \emph on
31293 clientname
31294 \emph default
31295 :
31296 \emph on
31297 function
31298 \emph default
31299 :
31300 \emph on
31301 data
31302 \end_layout
31303
31304 \begin_layout Standard
31305 where
31306 \emph on
31307 clientname
31308 \emph default
31309  and
31310 \emph on
31311 function
31312 \emph default
31313  are just echoed from the command request,
31314  while
31315 \emph on
31316 data
31317 \emph default
31318  is more or less useful information filled according to how the command execution worked out.
31319  Some commands,
31320  such as
31321 \begin_inset Quotes eld
31322 \end_inset
31323
31324 font-state
31325 \begin_inset Quotes erd
31326 \end_inset
31327
31328 ,
31329  will return information about the internal state of \SpecialChar LyX
31330 ,
31331  while other will return an empty data-response.
31332  This means that the command execution went fine.
31333 \end_layout
31334
31335 \begin_layout Standard
31336 In case of errors,
31337  the response from \SpecialChar LyX
31338  will have this form
31339 \end_layout
31340
31341 \begin_layout Quote
31342 ERROR:
31343 \emph on
31344 clientname
31345 \emph default
31346 :
31347 \emph on
31348 function
31349 \emph default
31350 :
31351 \emph on
31352 error message
31353 \end_layout
31354
31355 \begin_layout Standard
31356 where the
31357 \emph on
31358 error message
31359 \emph default
31360  should contain an explanation of why the command failed.
31361 \end_layout
31362
31363 \begin_layout Standard
31364 Examples:
31365 \end_layout
31366
31367 \begin_layout LyX-Code
31368 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
31369 \begin_inset Newline newline
31370 \end_inset
31371
31372 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
31373 \begin_inset Newline newline
31374 \end_inset
31375
31376 read a <~/.lyxpipe.out
31377 \begin_inset Newline newline
31378 \end_inset
31379
31380 echo $a
31381 \end_layout
31382
31383 \begin_layout Subsection
31384 AppleScript (Mac OS X)
31385 \end_layout
31386
31387 \begin_layout Standard
31388 Since \SpecialChar LyX
31389  2.1,
31390  \SpecialChar LyX
31391  supports basic interactions with AppleScript for normal communication through the command run.
31392  This command takes a direct argument (the
31393 \series bold
31394 function
31395 \series default
31396  to perform) and an optional argument.
31397  It either returns the output of the function or triggers an error with the error message and code.
31398 \end_layout
31399
31400 \begin_layout Standard
31401 Example:
31402 \end_layout
31403
31404 \begin_layout LyX-Code
31405 tell application "\SpecialChar LyX
31406 "
31407 \end_layout
31408
31409 \begin_layout LyX-Code
31410   try
31411 \end_layout
31412
31413 \begin_layout LyX-Code
31414     -- Stores the current file name into f
31415 \end_layout
31416
31417 \begin_layout LyX-Code
31418     set f to (run "server-get-filename" with argument "")
31419 \end_layout
31420
31421 \begin_layout LyX-Code
31422     on error the error_message number the error_number
31423 \end_layout
31424
31425 \begin_layout LyX-Code
31426       display dialog "Error:
31427  " & the error_number & ".
31428  " ¬
31429 \end_layout
31430
31431 \begin_layout LyX-Code
31432               & the error_message buttons {"OK"} default button 1
31433 \end_layout
31434
31435 \begin_layout LyX-Code
31436   end try
31437 \end_layout
31438
31439 \begin_layout LyX-Code
31440 end tell
31441 \end_layout
31442
31443 \begin_layout Section
31444 Notification
31445 \end_layout
31446
31447 \begin_layout Standard
31448 \SpecialChar LyX
31449  can notify clients of events going on asynchronously.
31450  Currently it will only do this if the user binds a key sequence with the function
31451 \begin_inset Quotes eld
31452 \end_inset
31453
31454 notify
31455 \begin_inset Quotes erd
31456 \end_inset
31457
31458 .
31459  The format of the string \SpecialChar LyX
31460  sends is as follows:
31461 \end_layout
31462
31463 \begin_layout Quote
31464 \begin_inset Flex Code
31465 status collapsed
31466
31467 \begin_layout Plain Layout
31468 NOTIFY:
31469 \end_layout
31470
31471 \end_inset
31472
31473
31474 \emph on
31475 key-sequence
31476 \end_layout
31477
31478 \begin_layout Standard
31479 where
31480 \emph on
31481 key-sequence
31482 \emph default
31483  is the printed representation of the key sequence that was actually typed by the user.
31484 \end_layout
31485
31486 \begin_layout Standard
31487 This mechanism can be used to extend \SpecialChar LyX
31488 's command set and implement macros.
31489  Bind some key sequence to
31490 \begin_inset Quotes eld
31491 \end_inset
31492
31493 notify
31494 \begin_inset Quotes erd
31495 \end_inset
31496
31497 .
31498  Then start a client that listens on the output pipe,
31499  dispatches the command according to the sequence,
31500  and starts a function that may use \SpecialChar LyX
31501  calls and \SpecialChar LyX
31502  requests to issue a command or a series of commands to \SpecialChar LyX
31503 .
31504 \end_layout
31505
31506 \begin_layout Section
31507 The simple \SpecialChar LyX
31508  Server Protocol
31509 \end_layout
31510
31511 \begin_layout Standard
31512 \SpecialChar LyX
31513  implements a simple protocol that can be used for session management.
31514  All messages are of the form
31515 \end_layout
31516
31517 \begin_layout Quote
31518 LYXSRV:
31519 \emph on
31520 clientname
31521 \emph default
31522 :
31523 \emph on
31524 protocol message
31525 \end_layout
31526
31527 \begin_layout Standard
31528 where
31529 \emph on
31530 protocol message
31531 \emph default
31532  can be
31533 \begin_inset Quotes eld
31534 \end_inset
31535
31536 hello
31537 \begin_inset Quotes erd
31538 \end_inset
31539
31540  or
31541 \begin_inset Quotes eld
31542 \end_inset
31543
31544 bye
31545 \begin_inset Quotes erd
31546 \end_inset
31547
31548 .
31549  If
31550 \begin_inset Quotes eld
31551 \end_inset
31552
31553 hello
31554 \begin_inset Quotes erd
31555 \end_inset
31556
31557  is received from a client,
31558  \SpecialChar LyX
31559  will report back to inform the client that it's listening to it's messages,
31560  while
31561 \begin_inset Quotes eld
31562 \end_inset
31563
31564 bye
31565 \begin_inset Quotes erd
31566 \end_inset
31567
31568  sent from \SpecialChar LyX
31569  will inform clients that \SpecialChar LyX
31570  is closing.
31571 \end_layout
31572
31573 \begin_layout Section
31574 Reverse DVI/PDF search
31575 \end_layout
31576
31577 \begin_layout Standard
31578 Some DVI/PDF viewers
31579 \begin_inset Foot
31580 status collapsed
31581
31582 \begin_layout Plain Layout
31583 The following viewers offer the reverse PDF search feature:
31584  Okular on KDE/Linux,
31585  Qpdfview on Unix,
31586  Skim on Mac OSX and SumatraPDF on Windows.
31587 \end_layout
31588
31589 \end_inset
31590
31591  provide
31592 \emph on
31593 reverse search
31594 \emph default
31595  facility (also called
31596 \emph on
31597 inverse search
31598 \emph default
31599 ).
31600  This means that you can tell \SpecialChar LyX
31601  to put the cursor to a specific line in the document by clicking at the respective position in the DVI/PDF output.
31602  To achieve this,
31603  the viewer must be able to communicate with \SpecialChar LyX
31604 .
31605  This is done via the \SpecialChar LyX
31606  server either by using the named pipe (
31607 \emph on
31608 lyxpipe
31609 \emph default
31610 ),
31611  or the UNIX domain socket (
31612 \emph on
31613 lyxsocket
31614 \emph default
31615 ) that \SpecialChar LyX
31616  creates in its temporary directory (this is the way the
31617 \begin_inset Flex Code
31618 status collapsed
31619
31620 \begin_layout Plain Layout
31621 lyxclient
31622 \end_layout
31623
31624 \end_inset
31625
31626  program communicates with \SpecialChar LyX
31627 ).
31628  In some cases,
31629  you need a helper script that mediates between the viewer and \SpecialChar LyX
31630 ,
31631  in others,
31632  the viewer can communicate with \SpecialChar LyX
31633  directly.
31634  This depends on the selected viewer and on your operating system.
31635  The same applies to the way viewers need to be configured and the way the reverse search is actually performed.
31636  In what follows,
31637  we will thus describe how to setup reverse search for specific viewers.
31638  Before we turn to this,
31639  though,
31640  we will explain what needs to be done generally to enable reverse search in the DVI/PDF output.
31641 \end_layout
31642
31643 \begin_layout Subsection
31644 Automatic setup
31645 \begin_inset CommandInset label
31646 LatexCommand label
31647 name "subsec:rev-search"
31648
31649 \end_inset
31650
31651
31652 \end_layout
31653
31654 \begin_layout Standard
31655 In most cases \SpecialChar LyX
31656  will do the work for you by pressing the following button in the toolbar:
31657
31658 \begin_inset Info
31659 type  "icon"
31660 arg   "buffer-toggle-output-sync"
31661 \end_inset
31662
31663 .
31664  Alternatively,
31665  you can also enable the feature by checking
31666 \family sans
31667 Synchronize with Output
31668 \family default
31669  in
31670 \change_deleted -712698321 1674917848
31671
31672 \begin_inset Flex Noun
31673 status collapsed
31674
31675 \begin_layout Plain Layout
31676 Document\SpecialChar menuseparator
31677 Settings\SpecialChar menuseparator
31678 Formats
31679 \end_layout
31680
31681 \end_inset
31682
31683
31684 \change_inserted -712698321 1674917848
31685
31686 \family sans
31687 Document\SpecialChar menuseparator
31688 Settings\SpecialChar menuseparator
31689 Formats
31690 \change_unchanged
31691
31692 \family default
31693 .
31694  In such a case \SpecialChar LyX
31695  will automatically insert the necessary Sync\SpecialChar TeX
31696  macro (for PDF) or load the srcltx package (for DVI) respectively.
31697  This option can be easily reached also on
31698 \begin_inset Flex Code
31699 status collapsed
31700
31701 \begin_layout Plain Layout
31702 View/Update
31703 \end_layout
31704
31705 \end_inset
31706
31707  Toolbar.
31708 \end_layout
31709
31710 \begin_layout Standard
31711 If you need a different setting,
31712  you can select or input a custom macro from the drop down box just below
31713 \change_deleted -712698321 1674917855
31714
31715 \begin_inset Flex Noun
31716 status collapsed
31717
31718 \begin_layout Plain Layout
31719 Document\SpecialChar menuseparator
31720 Settings\SpecialChar menuseparator
31721 Output\SpecialChar menuseparator
31722 Synchronize with Output
31723 \end_layout
31724
31725 \end_inset
31726
31727
31728 \change_inserted -712698321 1674917855
31729
31730 \family sans
31731 Document\SpecialChar menuseparator
31732 Settings\SpecialChar menuseparator
31733 Output\SpecialChar menuseparator
31734 Synchronize with Output
31735 \change_unchanged
31736
31737 \family default
31738 .
31739 \end_layout
31740
31741 \begin_layout Standard
31742 Note that the method
31743 \begin_inset Flex Code
31744 status collapsed
31745
31746 \begin_layout Plain Layout
31747
31748 \backslash
31749 synctex=1
31750 \end_layout
31751
31752 \end_inset
31753
31754  enables gzip compression.
31755  If your viewer does not support it,
31756  you should instead use
31757 \begin_inset Flex Code
31758 status collapsed
31759
31760 \begin_layout Plain Layout
31761
31762 \backslash
31763 synctex=-1
31764 \end_layout
31765
31766 \end_inset
31767
31768 .
31769 \end_layout
31770
31771 \begin_layout Standard
31772 Please also note that including the
31773 \begin_inset Flex Code
31774 status collapsed
31775
31776 \begin_layout Plain Layout
31777 srcltx
31778 \end_layout
31779
31780 \end_inset
31781
31782  package or
31783 \begin_inset Flex Code
31784 status collapsed
31785
31786 \begin_layout Plain Layout
31787 src-specials
31788 \end_layout
31789
31790 \end_inset
31791
31792  sometimes has an undesired impact on the typesetting.
31793  Thus,
31794  you should switch output synchronization off for the final typesetting if you use the
31795 \begin_inset Flex Code
31796 status collapsed
31797
31798 \begin_layout Plain Layout
31799 srcltx
31800 \end_layout
31801
31802 \end_inset
31803
31804  package or
31805 \begin_inset Flex Code
31806 status collapsed
31807
31808 \begin_layout Plain Layout
31809 src-specials
31810 \end_layout
31811
31812 \end_inset
31813
31814 .
31815
31816 \end_layout
31817
31818 \begin_layout Standard
31819 In case you need some more special settings that are not covered by the automatic settings,
31820  read the next section about how to set up output synchronization manually.
31821  If the automatic setup suits your needs,
31822  you can readily jump to section
31823 \begin_inset space ~
31824 \end_inset
31825
31826
31827 \begin_inset CommandInset ref
31828 LatexCommand ref
31829 reference "subsec:configuring-viewers"
31830 nolink "false"
31831
31832 \end_inset
31833
31834 ,
31835  where the necessary configuration steps in your viewer – needed both with the automatic and the manual setup – are described.
31836 \end_layout
31837
31838 \begin_layout Subsection
31839 Manual setup
31840 \end_layout
31841
31842 \begin_layout Standard
31843 \SpecialChar LaTeX
31844  provides several different methods for reverse search.
31845  Some are built-in in the
31846 \begin_inset Flex Code
31847 status collapsed
31848
31849 \begin_layout Plain Layout
31850 latex/pdflatex
31851 \end_layout
31852
31853 \end_inset
31854
31855  program,
31856  some are provided by external packages.
31857  Your choice depends on whether your \SpecialChar LaTeX
31858  distribution already provides a given method (the built-in methods are rather new) and whether your viewer can cope with it.
31859  The available methods are described in the following.
31860 \end_layout
31861
31862 \begin_layout Subsubsection*
31863 Built-in DVI-search via src-specials (DVI only)
31864 \end_layout
31865
31866 \begin_layout Standard
31867 This method provides the DVI file with the necessary information for reverse search.
31868  It is available in \SpecialChar LaTeX
31869  since quite some time (any somewhat recent \SpecialChar LaTeX
31870  distribution should include it),
31871  and it works reliably.
31872  To enable it,
31873  change the
31874 \begin_inset Flex Noun
31875 status collapsed
31876
31877 \begin_layout Plain Layout
31878 La
31879 \family sans
31880 TeX
31881 \family default
31882  (plain)->DVI
31883 \end_layout
31884
31885 \end_inset
31886
31887  or
31888 \begin_inset Flex Noun
31889 status collapsed
31890
31891 \begin_layout Plain Layout
31892 La
31893 \family sans
31894 TeX
31895 \family default
31896  (plain)->DraftDVI
31897 \end_layout
31898
31899 \end_inset
31900
31901  converter in
31902 \change_deleted -712698321 1674917875
31903
31904 \begin_inset Flex Noun
31905 status collapsed
31906
31907 \begin_layout Plain Layout
31908 Preferences\SpecialChar menuseparator
31909 File Handling\SpecialChar menuseparator
31910 Converters
31911 \end_layout
31912
31913 \end_inset
31914
31915
31916 \change_inserted -712698321 1674917875
31917
31918 \family sans
31919 Preferences\SpecialChar menuseparator
31920 File Handling\SpecialChar menuseparator
31921 Converters
31922 \change_unchanged
31923
31924 \family default
31925  to
31926 \begin_inset Flex Code
31927 status collapsed
31928
31929 \begin_layout Plain Layout
31930 latex -src-specials $$i
31931 \end_layout
31932
31933 \end_inset
31934
31935 .
31936  If this doesn't work,
31937  check if your \SpecialChar TeX
31938  engine needs different options (the syntax might differ in some distributions).
31939 \end_layout
31940
31941 \begin_layout Subsubsection*
31942 External Packages (PDFSync and scrltx)
31943 \end_layout
31944
31945 \begin_layout Standard
31946 The packages
31947 \emph on
31948 pdfsync
31949 \emph default
31950  and
31951 \emph on
31952 scrltx
31953 \emph default
31954  provide reverse search facility for PDF output (via pdflatex) and DVI output,
31955  respectively.
31956  In order to enable it,
31957  load the packages in the \SpecialChar LyX
31958  preamble:
31959
31960 \end_layout
31961
31962 \begin_layout Itemize
31963 \begin_inset Flex Code
31964 status collapsed
31965
31966 \begin_layout Plain Layout
31967
31968 \backslash
31969 usepackage{pdfsync}
31970 \end_layout
31971
31972 \end_inset
31973
31974  for reverse PDF search,
31975 \end_layout
31976
31977 \begin_layout Itemize
31978 \begin_inset Flex Code
31979 status collapsed
31980
31981 \begin_layout Plain Layout
31982
31983 \backslash
31984 usepackage[active]{srcltx}
31985 \end_layout
31986
31987 \end_inset
31988
31989  for reverse DVI search.
31990 \end_layout
31991
31992 \begin_layout Standard
31993 If you want to be able to perform both DVI and PDF reverse searches,
31994  you can also insert in the preamble the following lines
31995 \end_layout
31996
31997 \begin_layout LyX-Code
31998
31999 \backslash
32000 usepackage{ifpdf}
32001 \begin_inset Newline newline
32002 \end_inset
32003
32004
32005 \backslash
32006 ifpdf
32007 \begin_inset Newline newline
32008 \end_inset
32009
32010
32011 \backslash
32012 usepackage{pdfsync}
32013 \begin_inset Newline newline
32014 \end_inset
32015
32016
32017 \backslash
32018 else
32019 \begin_inset Newline newline
32020 \end_inset
32021
32022
32023 \backslash
32024 usepackage[active]{srcltx}
32025 \begin_inset Newline newline
32026 \end_inset
32027
32028
32029 \backslash
32030 fi
32031 \end_layout
32032
32033 \begin_layout Standard
32034 This way,
32035  you can preview the file as either DVI or PDF (pdflatex) and the right package will be used.
32036 \end_layout
32037
32038 \begin_layout Standard
32039 Note that PDFSync might affect the output layout of your document.
32040  It is therefore advised to disable PDFsync for final documents.
32041 \end_layout
32042
32043 \begin_layout Subsubsection*
32044 Built-in reverse search via Sync\SpecialChar TeX
32045  (DVI and PDF)
32046 \end_layout
32047
32048 \begin_layout Standard
32049 Recent versions of
32050 \begin_inset Flex Code
32051 status collapsed
32052
32053 \begin_layout Plain Layout
32054 (pdf)latex
32055 \end_layout
32056
32057 \end_inset
32058
32059  have built-in support for both PDF and DVI reverse search.
32060  This so-called
32061 \emph on
32062 Sync\SpecialChar TeX
32063
32064 \emph default
32065  facility is basically the result of the integration of the PDFSync package to the pdftex program and its merge with the
32066 \emph on
32067 scr-specials
32068 \emph default
32069  approach.
32070  You need at least \SpecialChar TeX
32071 Live 2008 or a recent Mik\SpecialChar TeX
32072  distribution in order to use it.
32073 \begin_inset Foot
32074 status collapsed
32075
32076 \begin_layout Plain Layout
32077 For some reason,
32078  Mik\SpecialChar TeX
32079  does not understand/obey the command \SpecialChar LyX
32080  inserts into the preamble when you check the "Enable Forward/Reverse Search" button in the toolbar and does not generate the necessary info.
32081 \end_layout
32082
32083 \begin_layout Plain Layout
32084 The generation of the required info can be forced by changing the converter "\SpecialChar LaTeX
32085  (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e.,
32086  by adding the -synctex=1 switch).
32087 \end_layout
32088
32089 \end_inset
32090
32091  Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
32092  Skim on the Mac,
32093  SumatraPDF on Windows;
32094  see the next section for details) already provide Sync\SpecialChar TeX
32095  support.
32096 \end_layout
32097
32098 \begin_layout Standard
32099 To enable Sync\SpecialChar TeX
32100  for DVI output,
32101  change the
32102 \begin_inset Flex Noun
32103 status collapsed
32104
32105 \begin_layout Plain Layout
32106 La
32107 \family sans
32108 TeX
32109 \family default
32110  (plain) -> DVI
32111 \end_layout
32112
32113 \end_inset
32114
32115  or
32116 \begin_inset Flex Noun
32117 status collapsed
32118
32119 \begin_layout Plain Layout
32120 La
32121 \family sans
32122 TeX
32123 \family default
32124  (plain) -> DraftDVI
32125 \end_layout
32126
32127 \end_inset
32128
32129  converter in
32130 \change_deleted -712698321 1674917887
32131
32132 \begin_inset Flex Noun
32133 status collapsed
32134
32135 \begin_layout Plain Layout
32136 Preferences\SpecialChar menuseparator
32137 File Handling\SpecialChar menuseparator
32138 Converters
32139 \end_layout
32140
32141 \end_inset
32142
32143
32144 \change_inserted -712698321 1674917887
32145
32146 \family sans
32147 Preferences\SpecialChar menuseparator
32148 File Handling\SpecialChar menuseparator
32149 Converters
32150 \change_unchanged
32151
32152 \family default
32153 to
32154 \begin_inset Flex Code
32155 status collapsed
32156
32157 \begin_layout Plain Layout
32158 latex -synctex=1 $$i
32159 \end_layout
32160
32161 \end_inset
32162
32163 ,
32164  and for PDF output,
32165  change the
32166 \begin_inset Flex Noun
32167 status collapsed
32168
32169 \begin_layout Plain Layout
32170 La
32171 \family sans
32172 TeX
32173 \family default
32174  (pdflatex) -> PDF (pdflatex)
32175 \end_layout
32176
32177 \end_inset
32178
32179  converter to
32180 \begin_inset Flex Code
32181 status collapsed
32182
32183 \begin_layout Plain Layout
32184 pdflatex -synctex=1 $$i
32185 \end_layout
32186
32187 \end_inset
32188
32189 .
32190  Should your viewer not be considered in the following description,
32191  or in case of missing success,
32192  please check the documentation of your viewer whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
32193 .
32194 \begin_inset Foot
32195 status collapsed
32196
32197 \begin_layout Plain Layout
32198 Note that the option
32199 \begin_inset Flex Code
32200 status collapsed
32201
32202 \begin_layout Plain Layout
32203 -synctex=1
32204 \end_layout
32205
32206 \end_inset
32207
32208  option enables gzip compression.
32209  If your viewer does not support it,
32210  you should instead use
32211 \begin_inset Flex Code
32212 status collapsed
32213
32214 \begin_layout Plain Layout
32215 -synctex=-1
32216 \end_layout
32217
32218 \end_inset
32219
32220 .
32221 \end_layout
32222
32223 \end_inset
32224
32225
32226 \end_layout
32227
32228 \begin_layout Subsection
32229 Configuring and using specific viewers
32230 \begin_inset CommandInset label
32231 LatexCommand label
32232 name "subsec:configuring-viewers"
32233
32234 \end_inset
32235
32236
32237 \end_layout
32238
32239 \begin_layout Subsubsection*
32240 Xdvi (all platforms)
32241 \end_layout
32242
32243 \begin_layout Standard
32244 If you use
32245 \begin_inset Flex Code
32246 status collapsed
32247
32248 \begin_layout Plain Layout
32249 xdvi
32250 \end_layout
32251
32252 \end_inset
32253
32254 ,
32255  you don't need to do anything else for performing a reverse DVI search,
32256  as \SpecialChar LyX
32257  already provides the necessary hooks for automatically using the
32258 \begin_inset Flex Code
32259 status collapsed
32260
32261 \begin_layout Plain Layout
32262 lyxclient
32263 \end_layout
32264
32265 \end_inset
32266
32267  program.
32268  Just setup your document as described above (reverse search is triggered by Ctrl-click or Alt-click on Mac OSX,
32269  respectively).
32270 \end_layout
32271
32272 \begin_layout Standard
32273 However,
32274  if for whatever reason you want to use the named pipe instead of the socket for communicating with \SpecialChar LyX
32275 ,
32276  simply change the DVI viewer in
32277 \change_deleted -712698321 1674917897
32278
32279 \begin_inset Flex Noun
32280 status collapsed
32281
32282 \begin_layout Plain Layout
32283 Preferences\SpecialChar menuseparator
32284 File Handling\SpecialChar menuseparator
32285 File formats
32286 \end_layout
32287
32288 \end_inset
32289
32290
32291 \change_inserted -712698321 1674917897
32292
32293 \family sans
32294 Preferences\SpecialChar menuseparator
32295 File Handling\SpecialChar menuseparator
32296 File formats
32297 \change_unchanged
32298
32299 \family default
32300  to
32301 \begin_inset Foot
32302 status collapsed
32303
32304 \begin_layout Plain Layout
32305 On Mac OSX you have to use
32306 \begin_inset Flex Code
32307 status collapsed
32308
32309 \begin_layout Plain Layout
32310 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
32311 \end_layout
32312
32313 \end_inset
32314
32315
32316 \end_layout
32317
32318 \end_inset
32319
32320
32321 \begin_inset Flex Code
32322 status collapsed
32323
32324 \begin_layout Plain Layout
32325 xdvi -editor "lyxeditor.sh %f %l"
32326 \end_layout
32327
32328 \end_inset
32329
32330 ,
32331  where
32332 \begin_inset Flex Code
32333 status collapsed
32334
32335 \begin_layout Plain Layout
32336 lyxeditor.sh
32337 \end_layout
32338
32339 \end_inset
32340
32341  is a suitable script.
32342  For example,
32343  a minimal shell script is the following one:
32344 \end_layout
32345
32346 \begin_layout LyX-Code
32347 #!/bin/sh
32348 \begin_inset Newline newline
32349 \end_inset
32350
32351 LYXPIPE="/path/to/lyxpipe"
32352 \begin_inset Newline newline
32353 \end_inset
32354
32355 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
32356 \begin_inset Newline newline
32357 \end_inset
32358
32359 echo "$COMMAND" > "${LYXPIPE}".in || exit
32360 \begin_inset Newline newline
32361 \end_inset
32362
32363 read TMP < "${LYXPIPE}".out || exit
32364 \end_layout
32365
32366 \begin_layout Standard
32367 where
32368 \begin_inset Flex Code
32369 status collapsed
32370
32371 \begin_layout Plain Layout
32372 /path/to/lyxpipe
32373 \end_layout
32374
32375 \end_inset
32376
32377  is the LyXServer pipe path specified in
32378 \change_deleted -712698321 1674917907
32379
32380 \begin_inset Flex Noun
32381 status collapsed
32382
32383 \begin_layout Plain Layout
32384 Preferences\SpecialChar menuseparator
32385 Paths
32386 \end_layout
32387
32388 \end_inset
32389
32390
32391 \change_inserted -712698321 1674917907
32392
32393 \family sans
32394 Preferences\SpecialChar menuseparator
32395 Paths
32396 \change_unchanged
32397
32398 \family default
32399 .
32400 \begin_inset Foot
32401 status collapsed
32402
32403 \begin_layout Plain Layout
32404 In the
32405 \begin_inset Flex Code
32406 status collapsed
32407
32408 \begin_layout Plain Layout
32409 development/tools
32410 \end_layout
32411
32412 \end_inset
32413
32414  folder of a source distribution you can find a
32415 \begin_inset Flex Code
32416 status collapsed
32417
32418 \begin_layout Plain Layout
32419 lyxeditor
32420 \end_layout
32421
32422 \end_inset
32423
32424  script which is able to locate the
32425 \emph on
32426 lyxpipe
32427 \emph default
32428  based on your preferences.
32429 \end_layout
32430
32431 \end_inset
32432
32433
32434 \end_layout
32435
32436 \begin_layout Subsubsection*
32437 MacDviX (Mac OSX)
32438 \end_layout
32439
32440 \begin_layout Standard
32441 At the end of
32442 \begin_inset Flex Code
32443 status collapsed
32444
32445 \begin_layout Plain Layout
32446 /Applications/MacDviX_Folder/calleditor.script
32447 \end_layout
32448
32449 \end_inset
32450
32451 ,
32452  add the following lines:
32453 \end_layout
32454
32455 \begin_layout LyX-Code
32456 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
32457 \begin_inset Newline newline
32458 \end_inset
32459
32460 exit 1
32461 \end_layout
32462
32463 \begin_layout Standard
32464 Modify the lines accordingly if you install \SpecialChar LyX
32465  somewhere else than in the Applications folder.
32466 \end_layout
32467
32468 \begin_layout Standard
32469 Reverse search is triggered by Alt-click (OPTION-click).
32470 \end_layout
32471
32472 \begin_layout Subsubsection*
32473 Skim (Mac OSX)
32474 \end_layout
32475
32476 \begin_layout Standard
32477 Enter
32478 \begin_inset Flex Code
32479 status collapsed
32480
32481 \begin_layout Plain Layout
32482 open -a Skim.app $$i
32483 \end_layout
32484
32485 \end_inset
32486
32487  to the viewer setting in
32488 \change_deleted -712698321 1674917916
32489
32490 \begin_inset Flex Noun
32491 status collapsed
32492
32493 \begin_layout Plain Layout
32494 Preferences\SpecialChar menuseparator
32495 File Handling\SpecialChar menuseparator
32496 File formats\SpecialChar menuseparator
32497 PDF (pdflatex)
32498 \end_layout
32499
32500 \end_inset
32501
32502
32503 \change_inserted -712698321 1674917916
32504
32505 \family sans
32506 Preferences\SpecialChar menuseparator
32507 File Handling\SpecialChar menuseparator
32508 File formats\SpecialChar menuseparator
32509 PDF (pdflatex)
32510 \change_unchanged
32511
32512 \family default
32513 ,
32514  and then in
32515 \change_deleted -712698321 1674917924
32516
32517 \begin_inset Flex Noun
32518 status collapsed
32519
32520 \begin_layout Plain Layout
32521 Skim\SpecialChar menuseparator
32522 Preferences\SpecialChar menuseparator
32523 Sync
32524 \end_layout
32525
32526 \end_inset
32527
32528
32529 \change_inserted -712698321 1674917924
32530
32531 \family sans
32532 Skim\SpecialChar menuseparator
32533 Preferences\SpecialChar menuseparator
32534 Sync
32535 \change_unchanged
32536
32537 \family default
32538  choose
32539 \change_deleted -712698321 1674917931
32540
32541 \begin_inset Flex Noun
32542 status collapsed
32543
32544 \begin_layout Plain Layout
32545 custom
32546 \end_layout
32547
32548 \end_inset
32549
32550
32551 \change_inserted -712698321 1674917931
32552
32553 \family sans
32554 custom
32555 \change_unchanged
32556
32557 \family default
32558  preset and enter command
32559 \begin_inset Flex Noun
32560 status collapsed
32561
32562 \begin_layout Plain Layout
32563 /Applications/\SpecialChar LyX
32564 .app/Contents/MacOS/lyxeditor
32565 \end_layout
32566
32567 \end_inset
32568
32569 .
32570 \end_layout
32571
32572 \begin_layout Standard
32573 Reverse search is triggered by COMMAND-SHIFT-click
32574 \end_layout
32575
32576 \begin_layout Subsubsection*
32577 Evince (GNOME)
32578 \end_layout
32579
32580 \begin_layout Standard
32581 Reverse search with evince does not work out of the box,
32582  but it can be achieved by means of some third party helper scripts.
32583  Please refer to
32584 \begin_inset CommandInset href
32585 LatexCommand href
32586 target "https://wiki.lyx.org/LyX/SyncTeX"
32587 literal "false"
32588
32589 \end_inset
32590
32591  for details.
32592 \end_layout
32593
32594 \begin_layout Subsubsection*
32595 Okular (KDE)
32596 \end_layout
32597
32598 \begin_layout Standard
32599 Go to
32600 \change_deleted -712698321 1674917941
32601
32602 \begin_inset Flex Noun
32603 status collapsed
32604
32605 \begin_layout Plain Layout
32606 Settings\SpecialChar menuseparator
32607 Configure Okular\SpecialChar menuseparator
32608 Editor
32609 \end_layout
32610
32611 \end_inset
32612
32613
32614 \change_inserted -712698321 1674917941
32615
32616 \family sans
32617 Settings\SpecialChar menuseparator
32618 Configure Okular\SpecialChar menuseparator
32619 Editor
32620 \change_unchanged
32621
32622 \family default
32623  and select LyX
32624 \begin_inset Quotes erd
32625 \end_inset
32626
32627  as editor.
32628  This inserts the appropriate command (
32629 \begin_inset Flex Code
32630 status collapsed
32631
32632 \begin_layout Plain Layout
32633 lyxclient -g %f %l
32634 \end_layout
32635
32636 \end_inset
32637
32638 ).
32639 \end_layout
32640
32641 \begin_layout Standard
32642 Reverse search is triggered by SHIFT-click.
32643
32644 \change_inserted -712698321 1578211026
32645  Note that this only works if Okular is in
32646 \begin_inset Quotes eld
32647 \end_inset
32648
32649 Browse
32650 \begin_inset Quotes erd
32651 \end_inset
32652
32653  mode (i.
32654 \begin_inset space \thinspace{}
32655 \end_inset
32656
32657 e.,
32658  the hand symbol is clicked).
32659 \change_unchanged
32660
32661 \end_layout
32662
32663 \begin_layout Subsubsection*
32664 Qpdfview (Unix)
32665 \end_layout
32666
32667 \begin_layout Standard
32668 Qpdfview supports Sync\SpecialChar TeX
32669  since version 0.3.5.
32670  Go to
32671 \change_deleted -712698321 1674917949
32672
32673 \begin_inset Flex Noun
32674 status collapsed
32675
32676 \begin_layout Plain Layout
32677 Edit\SpecialChar menuseparator
32678 Settings\SpecialChar menuseparator
32679 Behavior
32680 \end_layout
32681
32682 \end_inset
32683
32684
32685 \change_inserted -712698321 1674917949
32686
32687 \family sans
32688 Edit\SpecialChar menuseparator
32689 Settings\SpecialChar menuseparator
32690 Behavior
32691 \change_unchanged
32692
32693 \family default
32694 ,
32695  click on the input field of the
32696 \begin_inset Quotes eld
32697 \end_inset
32698
32699 Source editor
32700 \begin_inset Quotes erd
32701 \end_inset
32702
32703  item and add the command
32704 \begin_inset Flex Code
32705 status collapsed
32706
32707 \begin_layout Plain Layout
32708 lyxclient -g %1 %2
32709 \end_layout
32710
32711 \end_inset
32712
32713 .
32714 \end_layout
32715
32716 \begin_layout Standard
32717 Reverse search is triggered by double-click or,
32718  in more recent versions,
32719  by context menu.
32720 \end_layout
32721
32722 \begin_layout Subsubsection*
32723 YAP (Windows)
32724 \end_layout
32725
32726 \begin_layout Standard
32727 Launch yap,
32728  choose its
32729 \change_deleted -712698321 1674917958
32730
32731 \begin_inset Flex Noun
32732 status collapsed
32733
32734 \begin_layout Plain Layout
32735 View\SpecialChar menuseparator
32736 Options
32737 \end_layout
32738
32739 \end_inset
32740
32741
32742 \change_inserted -712698321 1674917958
32743
32744 \family sans
32745 View\SpecialChar menuseparator
32746 Options
32747 \change_unchanged
32748
32749 \family default
32750  menu and select the
32751 \begin_inset Quotes eld
32752 \end_inset
32753
32754 Inverse DVI Search
32755 \begin_inset Quotes erd
32756 \end_inset
32757
32758  tab.
32759  Click on the
32760 \begin_inset Quotes eld
32761 \end_inset
32762
32763 New\SpecialChar ldots
32764
32765 \begin_inset Quotes erd
32766 \end_inset
32767
32768  button and,
32769  in the window that opens,
32770  enter
32771 \begin_inset Quotes eld
32772 \end_inset
32773
32774 \SpecialChar LyX
32775  Editor
32776 \begin_inset Quotes erd
32777 \end_inset
32778
32779  (or any other name you like) in the
32780 \begin_inset Quotes eld
32781 \end_inset
32782
32783 Name:
32784 \begin_inset Quotes erd
32785 \end_inset
32786
32787  field.
32788  Now click on the button labeled
32789 \begin_inset Quotes eld
32790 \end_inset
32791
32792 \SpecialChar ldots
32793
32794 \begin_inset Quotes erd
32795 \end_inset
32796
32797  to open a file dialog and navigate to the directory containing the batch file
32798 \begin_inset Flex Code
32799 status collapsed
32800
32801 \begin_layout Plain Layout
32802 lyxeditor.bat
32803 \end_layout
32804
32805 \end_inset
32806
32807  (see below).
32808  Select
32809 \begin_inset Flex Code
32810 status collapsed
32811
32812 \begin_layout Plain Layout
32813 lyxeditor.bat
32814 \end_layout
32815
32816 \end_inset
32817
32818  and then specify the program arguments as
32819 \begin_inset Flex Code
32820 status collapsed
32821
32822 \begin_layout Plain Layout
32823 %f %l
32824 \end_layout
32825
32826 \end_inset
32827
32828 .
32829  The
32830 \begin_inset Flex Code
32831 status collapsed
32832
32833 \begin_layout Plain Layout
32834 lyxeditor.bat
32835 \end_layout
32836
32837 \end_inset
32838
32839  wrapper is used for communicating with \SpecialChar LyX
32840  through the
32841 \emph on
32842 lyxpipe
32843 \emph default
32844  and is as follows:
32845 \end_layout
32846
32847 \begin_layout LyX-Code
32848 @echo off
32849 \begin_inset Newline newline
32850 \end_inset
32851
32852 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
32853 \backslash
32854
32855 \backslash
32856 .
32857 \backslash
32858 pipe
32859 \backslash
32860 lyxpipe.in
32861 \begin_inset Newline newline
32862 \end_inset
32863
32864 type
32865 \backslash
32866
32867 \backslash
32868 .
32869 \backslash
32870 pipe
32871 \backslash
32872 lyxpipe.out
32873 \end_layout
32874
32875 \begin_layout Standard
32876 Make sure that the \SpecialChar LyX
32877 Server pipe path you specified in \SpecialChar LyX
32878  is
32879 \begin_inset Flex Code
32880 status collapsed
32881
32882 \begin_layout Plain Layout
32883
32884 \backslash
32885
32886 \backslash
32887 .
32888 \backslash
32889 pipe
32890 \backslash
32891 lyxpipe
32892 \end_layout
32893
32894 \end_inset
32895
32896 ,
32897  otherwise change the
32898 \begin_inset Flex Code
32899 status collapsed
32900
32901 \begin_layout Plain Layout
32902 lyxeditor.bat
32903 \end_layout
32904
32905 \end_inset
32906
32907  wrapper accordingly.
32908 \end_layout
32909
32910 \begin_layout Standard
32911 In yap,
32912  reverse search is triggered by double-click.
32913 \end_layout
32914
32915 \begin_layout Subsubsection*
32916 SumatraPDF (Windows)
32917 \end_layout
32918
32919 \begin_layout Standard
32920 In order to use SumatraPDF for inverse search,
32921  enter
32922 \begin_inset Flex Code
32923 status collapsed
32924
32925 \begin_layout Plain Layout
32926 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
32927 \end_layout
32928
32929 \end_inset
32930
32931  in the viewer setting in
32932 \change_deleted -712698321 1674917965
32933
32934 \begin_inset Flex Noun
32935 status collapsed
32936
32937 \begin_layout Plain Layout
32938 Preferences\SpecialChar menuseparator
32939 File Handling\SpecialChar menuseparator
32940 File formats\SpecialChar menuseparator
32941 PDF (pdflatex)
32942 \end_layout
32943
32944 \end_inset
32945
32946
32947 \change_inserted -712698321 1674917965
32948
32949 \family sans
32950 Preferences\SpecialChar menuseparator
32951 File Handling\SpecialChar menuseparator
32952 File formats\SpecialChar menuseparator
32953 PDF (pdflatex)
32954 \change_unchanged
32955
32956 \family default
32957 ,
32958  where
32959 \begin_inset Flex Code
32960 status collapsed
32961
32962 \begin_layout Plain Layout
32963 lyxeditor.bat
32964 \end_layout
32965
32966 \end_inset
32967
32968  is the previous wrapper.
32969  If SumatraPDF.exe is not in your command PATH,
32970  use its full file name.
32971 \end_layout
32972
32973 \begin_layout Standard
32974 Reverse search is triggered by double-click.
32975 \end_layout
32976
32977 \begin_layout Subsubsection*
32978 YAP (Cygwin)
32979 \end_layout
32980
32981 \begin_layout Standard
32982 First of all,
32983  make sure that yap is your default DVI viewer in the Windows environment,
32984  then launch it,
32985  choose its
32986 \change_deleted -712698321 1674917973
32987
32988 \begin_inset Flex Noun
32989 status collapsed
32990
32991 \begin_layout Plain Layout
32992 View\SpecialChar menuseparator
32993 Options
32994 \end_layout
32995
32996 \end_inset
32997
32998
32999 \change_inserted -712698321 1674917973
33000
33001 \family sans
33002 View\SpecialChar menuseparator
33003 Options
33004 \change_unchanged
33005
33006 \family default
33007  menu and select the
33008 \begin_inset Quotes eld
33009 \end_inset
33010
33011 Inverse DVI Search
33012 \begin_inset Quotes erd
33013 \end_inset
33014
33015  tab.
33016  Click on the
33017 \begin_inset Quotes eld
33018 \end_inset
33019
33020 New\SpecialChar ldots
33021
33022 \begin_inset Quotes erd
33023 \end_inset
33024
33025  button and,
33026  in the window that opens,
33027  enter
33028 \begin_inset Quotes eld
33029 \end_inset
33030
33031 \SpecialChar LyX
33032  Editor
33033 \begin_inset Quotes erd
33034 \end_inset
33035
33036  (or any other name you like) in the
33037 \begin_inset Quotes eld
33038 \end_inset
33039
33040 Name:
33041 \begin_inset Quotes erd
33042 \end_inset
33043
33044  field.
33045  Now click on the button labeled
33046 \begin_inset Quotes eld
33047 \end_inset
33048
33049 \SpecialChar ldots
33050
33051 \begin_inset Quotes erd
33052 \end_inset
33053
33054  to open a file dialog and navigate to the directory containing the
33055 \begin_inset Flex Code
33056 status collapsed
33057
33058 \begin_layout Plain Layout
33059 lyxeditor.exe
33060 \end_layout
33061
33062 \end_inset
33063
33064  program (which is installed by default on Cygwin along with the \SpecialChar LyX
33065  executable).
33066  Select
33067 \begin_inset Flex Code
33068 status collapsed
33069
33070 \begin_layout Plain Layout
33071 lyxeditor.exe
33072 \end_layout
33073
33074 \end_inset
33075
33076  and then specify the program arguments as
33077 \begin_inset Flex Code
33078 status collapsed
33079
33080 \begin_layout Plain Layout
33081 -g %f %l
33082 \end_layout
33083
33084 \end_inset
33085
33086 .
33087  In this way,
33088  you will be using the
33089 \emph on
33090 lyxsocket
33091 \emph default
33092  for communicating with \SpecialChar LyX
33093 .
33094  If,
33095  for whatever reason,
33096  you want to use the
33097 \emph on
33098 lyxpipe
33099 \emph default
33100 ,
33101  omit the
33102 \begin_inset Flex Code
33103 status collapsed
33104
33105 \begin_layout Plain Layout
33106 -g
33107 \end_layout
33108
33109 \end_inset
33110
33111  option and be sure to specify the \SpecialChar LyX
33112 Server pipe path in the \SpecialChar LyX
33113  preferences.
33114 \end_layout
33115
33116 \begin_layout Standard
33117 In yap,
33118  reverse search is triggered by double-click.
33119 \end_layout
33120
33121 \begin_layout Subsubsection*
33122 SumatraPDF (Cygwin)
33123 \end_layout
33124
33125 \begin_layout Standard
33126 In order to use SumatraPDF for inverse search,
33127  enter
33128 \begin_inset Flex Code
33129 status collapsed
33130
33131 \begin_layout Plain Layout
33132 SumatraPDF -inverse-search "lyxeditor -g %f %l"
33133 \end_layout
33134
33135 \end_inset
33136
33137  in the viewer setting in
33138 \change_deleted -712698321 1674917986
33139
33140 \begin_inset Flex Noun
33141 status collapsed
33142
33143 \begin_layout Plain Layout
33144 Preferences\SpecialChar menuseparator
33145 File Handling\SpecialChar menuseparator
33146 File formats\SpecialChar menuseparator
33147 PDF (pdflatex)
33148 \end_layout
33149
33150 \end_inset
33151
33152
33153 \change_inserted -712698321 1674917986
33154
33155 \family sans
33156 Preferences\SpecialChar menuseparator
33157 File Handling\SpecialChar menuseparator
33158 File formats\SpecialChar menuseparator
33159 PDF (pdflatex)
33160 \change_unchanged
33161
33162 \family default
33163 .
33164  If SumatraPDF.exe is not in your command PATH,
33165  use its full posix path.
33166  The
33167 \begin_inset Flex Code
33168 status collapsed
33169
33170 \begin_layout Plain Layout
33171 -g
33172 \end_layout
33173
33174 \end_inset
33175
33176  enables communication via the
33177 \emph on
33178 lyxsocket
33179 \emph default
33180 .
33181  Again,
33182  omit the
33183 \begin_inset Flex Code
33184 status collapsed
33185
33186 \begin_layout Plain Layout
33187 -g
33188 \end_layout
33189
33190 \end_inset
33191
33192  option if you want to use the
33193 \emph on
33194 lyxpipe
33195 \emph default
33196 ,
33197  and be sure to specify the \SpecialChar LyX
33198 Server pipe path in the \SpecialChar LyX
33199  preferences.
33200 \end_layout
33201
33202 \begin_layout Standard
33203 Reverse search is triggered by double-click.
33204 \end_layout
33205
33206 \begin_layout Section
33207 Forward search
33208 \end_layout
33209
33210 \begin_layout Standard
33211 Forward search is,
33212  as the name implies,
33213  in a sense the
33214 \begin_inset Quotes eld
33215 \end_inset
33216
33217 opposite
33218 \begin_inset Quotes erd
33219 \end_inset
33220
33221  of reverse search.
33222  It allows you to let the viewer jump to a given position from within \SpecialChar LyX
33223 .
33224  If forward search is set up (as described in what follows),
33225  you can put the cursor anywhere in your \SpecialChar LyX
33226  document,
33227  and hit
33228 \change_deleted -712698321 1674917994
33229
33230 \begin_inset Flex Noun
33231 status collapsed
33232
33233 \begin_layout Plain Layout
33234 Navigate\SpecialChar menuseparator
33235 Forward search
33236 \end_layout
33237
33238 \end_inset
33239
33240
33241 \change_inserted -712698321 1674917994
33242
33243 \family sans
33244 Navigate\SpecialChar menuseparator
33245 Forward search
33246 \change_unchanged
33247
33248 \family default
33249  (or select
33250 \change_deleted -712698321 1674918002
33251
33252 \family sans
33253
33254 \begin_inset Flex Noun
33255 status collapsed
33256
33257 \begin_layout Plain Layout
33258
33259 \family sans
33260 Forward search
33261 \end_layout
33262
33263 \end_inset
33264
33265
33266 \change_inserted -712698321 1674918002
33267 Forward search
33268 \change_unchanged
33269
33270 \family default
33271  in the context menu via right mouse click),
33272  and then the viewer will jump to that position as well.
33273  This implies,
33274  of course,
33275  that your viewer supports this function.
33276 \end_layout
33277
33278 \begin_layout Standard
33279 To make forward search possible,
33280  you first need to provide the generated output PDF/DVI file with additional information about the \SpecialChar TeX
33281  sources.
33282  This can be done via the methods described in the section
33283 \begin_inset CommandInset ref
33284 LatexCommand ref
33285 reference "subsec:rev-search"
33286 nolink "false"
33287
33288 \end_inset
33289
33290 .
33291 \end_layout
33292
33293 \begin_layout Standard
33294 Additionally,
33295  you need to configure \SpecialChar LyX
33296  for using your viewers in
33297 \change_deleted -712698321 1674918011
33298
33299 \begin_inset Flex Noun
33300 status collapsed
33301
33302 \begin_layout Plain Layout
33303 Tools\SpecialChar menuseparator
33304 Preferences\SpecialChar menuseparator
33305 Output\SpecialChar menuseparator
33306 General
33307 \end_layout
33308
33309 \end_inset
33310
33311
33312 \change_inserted -712698321 1674918011
33313
33314 \family sans
33315 Tools\SpecialChar menuseparator
33316 Preferences\SpecialChar menuseparator
33317 Output\SpecialChar menuseparator
33318 General
33319 \change_unchanged
33320
33321 \family default
33322 .
33323  We provide a range of tested configurations for some viewers,
33324  which you can select from the drop down list.
33325  If none of these configurations suits you,
33326  you have to find out and enter a suitable configuration yourself.
33327  The definition syntax uses the following placeholders:
33328 \end_layout
33329
33330 \begin_layout Itemize
33331 \noindent
33332 \begin_inset Flex Code
33333 status collapsed
33334
33335 \begin_layout Plain Layout
33336 $$n
33337 \end_layout
33338
33339 \end_inset
33340
33341 :
33342  row number
33343 \end_layout
33344
33345 \begin_layout Itemize
33346 \noindent
33347 \begin_inset Flex Code
33348 status collapsed
33349
33350 \begin_layout Plain Layout
33351 $$t
33352 \end_layout
33353
33354 \end_inset
33355
33356 :
33357  name of the (temporary) exported .tex file (without path)
33358 \end_layout
33359
33360 \begin_layout Itemize
33361 \noindent
33362 \begin_inset Flex Code
33363 status collapsed
33364
33365 \begin_layout Plain Layout
33366 $$f
33367 \end_layout
33368
33369 \end_inset
33370
33371 :
33372  name of the (temporary) exported .tex file (including path)
33373 \end_layout
33374
33375 \begin_layout Itemize
33376 \noindent
33377 \begin_inset Flex Code
33378 status collapsed
33379
33380 \begin_layout Plain Layout
33381 $$o
33382 \end_layout
33383
33384 \end_inset
33385
33386 :
33387  name of the exported output file (either dvi or pdf,
33388  depending on which one exists in the temporary directory)
33389 \end_layout
33390
33391 \begin_layout Standard
33392 Note that only some of the viewers provide full and usable forward search functionality out of the box,
33393  among them yap,
33394  xdvi,
33395  okular
33396 \begin_inset Foot
33397 status collapsed
33398
33399 \begin_layout Plain Layout
33400 You might want to set
33401 \begin_inset Flex Code
33402 status collapsed
33403
33404 \begin_layout Plain Layout
33405 okular --unique
33406 \end_layout
33407
33408 \end_inset
33409
33410  in
33411 \change_deleted -712698321 1674918020
33412
33413 \begin_inset Flex Noun
33414 status collapsed
33415
33416 \begin_layout Plain Layout
33417 Tools\SpecialChar menuseparator
33418 Preferences\SpecialChar menuseparator
33419 File Handling\SpecialChar menuseparator
33420 File
33421 \begin_inset space ~
33422 \end_inset
33423
33424 Formats
33425 \end_layout
33426
33427 \end_inset
33428
33429
33430 \change_inserted -712698321 1674918020
33431
33432 \family sans
33433 Tools\SpecialChar menuseparator
33434 Preferences\SpecialChar menuseparator
33435 File Handling\SpecialChar menuseparator
33436 File
33437 \begin_inset space ~
33438 \end_inset
33439
33440 Formats
33441 \change_unchanged
33442
33443 \end_layout
33444
33445 \end_inset
33446
33447 ,
33448  qpdfview,
33449  and SumatraPDF
33450 \begin_inset Foot
33451 status collapsed
33452
33453 \begin_layout Plain Layout
33454 SumatraPDF can also use DDE commands through the external program CMCDDE —
33455  downloadable from
33456 \begin_inset CommandInset href
33457 LatexCommand href
33458 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
33459 literal "false"
33460
33461 \end_inset
33462
33463
33464 \end_layout
33465
33466 \end_inset
33467
33468 .
33469  Others,
33470  such as evince
33471 \begin_inset Foot
33472 status collapsed
33473
33474 \begin_layout Plain Layout
33475 Forward search with evince can be achieved by means of third party helper scripts.
33476  Please refer to
33477 \begin_inset CommandInset href
33478 LatexCommand href
33479 target "https://wiki.lyx.org/LyX/SyncTeX"
33480 literal "false"
33481
33482 \end_inset
33483
33484  for details.
33485 \end_layout
33486
33487 \end_inset
33488
33489 ,
33490  require some extra tools in order to use forward search.
33491  While many of the widespread PDF viewers (most notably Adobe Reader) do not support forward search at all,
33492  some other viewers – e.
33493 \begin_inset space \thinspace{}
33494 \end_inset
33495
33496 g.
33497  xpdf – allow at least to reload the document and jump to a specific page of the file,
33498  so you can at least navigate
33499 \begin_inset Quotes eld
33500 \end_inset
33501
33502 near
33503 \begin_inset Quotes erd
33504 \end_inset
33505
33506 .
33507  This latter functionality is provided by an external call of synctex (see the predefined example configurations).
33508
33509 \end_layout
33510
33511 \begin_layout Standard
33512 Forward search works both with DVI and PDF output.
33513  \SpecialChar LyX
33514  simply checks which preview format you have used before (i.
33515 \begin_inset space \thinspace{}
33516 \end_inset
33517
33518 e.,
33519  which format is already there in the temporary directory) and chooses the appropriate configuration for the respective format.
33520 \change_deleted 564990737 1672743015
33521
33522 \end_layout
33523
33524 \begin_layout Standard
33525
33526 \change_deleted 564990737 1672743015
33527 Special Document Classes
33528 \end_layout
33529
33530 \begin_layout Standard
33531
33532 \change_deleted 564990737 1669742044
33533 A&A Paper
33534 \end_layout
33535
33536 \begin_layout Standard
33537
33538 \change_deleted 564990737 1669742044
33539 by
33540 \noun on
33541 Peter Sütterlin
33542 \end_layout
33543
33544 \begin_layout Standard
33545
33546 \change_deleted 564990737 1669742044
33547 Introduction
33548 \end_layout
33549
33550 \begin_layout Standard
33551
33552 \change_deleted 564990737 1669742044
33553 This section describes how \SpecialChar LyX
33554  can be used to write articles for submission to the scientific journal
33555 \emph on
33556 Astronomy and Astrophysics
33557 \emph default
33558  (
33559 \begin_inset Flex URL
33560 status collapsed
33561
33562 \begin_layout Plain Layout
33563
33564 https://www.aanda.org/
33565 \end_layout
33566
33567 \end_inset
33568
33569 ) using Version 5.01 of the document class
33570 \family typewriter
33571 aa.cls
33572 \family default
33573 .
33574  This package can be downloaded from the ftp site
33575 \end_layout
33576
33577 \begin_layout Standard
33578
33579 \change_deleted 564990737 1669742044
33580 \begin_inset VSpace medskip
33581 \end_inset
33582
33583
33584 \end_layout
33585
33586 \begin_layout Standard
33587 \align center
33588
33589 \change_deleted 564990737 1669742044
33590 \begin_inset Flex URL
33591 status collapsed
33592
33593 \begin_layout Plain Layout
33594
33595 ftp://ftp.edpsciences.org/pub/aa/readme.html
33596 \end_layout
33597
33598 \end_inset
33599
33600
33601 \end_layout
33602
33603 \begin_layout Standard
33604
33605 \change_deleted 564990737 1669742044
33606 \begin_inset VSpace medskip
33607 \end_inset
33608
33609
33610 \end_layout
33611
33612 \begin_layout Standard
33613
33614 \change_deleted 564990737 1669742044
33615 A manual comes together with that package,
33616  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.
33617
33618 \end_layout
33619
33620 \begin_layout Standard
33621
33622 \change_deleted 564990737 1669742044
33623 Please note that the publisher of the journal was changed from Springer to EDP Sciences starting January 1,
33624  2001.
33625  That change involved also some slight changes to the style files,
33626  namely the removal of the thesaurus command.
33627  The \SpecialChar LyX
33628  class aa supports the newest version of these style files,
33629  V 5.01.
33630  If you have an older version installed,
33631  please upgrade.
33632  For compatibility,
33633  the old (version 4) layout has been kept as
33634 \family sans
33635 article (A&A V4)
33636 \family default
33637 .
33638  Please refer to the comments in
33639 \family typewriter
33640 \SpecialChar LyX
33641 Dir/layouts/aapaper.layout
33642 \family default
33643 .
33644 \end_layout
33645
33646 \begin_layout Standard
33647
33648 \change_deleted 564990737 1669742044
33649 Getting started
33650 \end_layout
33651
33652 \begin_layout Standard
33653
33654 \change_deleted 564990737 1669742044
33655 It is recommended you start from the example template distributed with \SpecialChar LyX
33656 .
33657  If you are not using a template,
33658  note the following settings:
33659 \end_layout
33660
33661 \begin_layout Itemize
33662
33663 \change_deleted 564990737 1669742044
33664 Select
33665 \family sans
33666 article (A&A)
33667 \family default
33668  in the
33669 \family sans
33670 Document\SpecialChar menuseparator
33671 Settings
33672 \family default
33673  dialog (OK,
33674  that one was obvious).
33675 \end_layout
33676
33677 \begin_layout Itemize
33678
33679 \change_deleted 564990737 1669742044
33680 Don't change the option
33681 \family sans
33682 Page
33683 \begin_inset space ~
33684 \end_inset
33685
33686 style
33687 \family default
33688 :
33689  Leave it set to
33690 \family sans
33691 default
33692 \family default
33693 .
33694  The whole layout is done by the macros,
33695  you shouldn't change anything.
33696 \end_layout
33697
33698 \begin_layout Standard
33699
33700 \change_deleted 564990737 1669742044
33701 The header block
33702 \end_layout
33703
33704 \begin_layout Standard
33705
33706 \change_deleted 564990737 1669742044
33707 First thing to enter is the header information.
33708  It consists of seven entries,
33709  of which some are optional.
33710  They are
33711 \end_layout
33712
33713 \begin_layout Itemize
33714
33715 \change_deleted 564990737 1669742044
33716
33717 \family sans
33718 Title
33719 \family default
33720 :
33721  [required]
33722 \end_layout
33723
33724 \begin_layout Itemize
33725
33726 \change_deleted 564990737 1669742044
33727
33728 \family sans
33729 Subtitle
33730 \family default
33731 :
33732  [optional]
33733 \end_layout
33734
33735 \begin_layout Itemize
33736
33737 \change_deleted 564990737 1669742044
33738
33739 \family sans
33740 Author
33741 \family default
33742 :
33743  [required]
33744 \end_layout
33745
33746 \begin_layout Itemize
33747
33748 \change_deleted 564990737 1669742044
33749
33750 \family sans
33751 Address
33752 \family default
33753 :
33754  [required]
33755 \end_layout
33756
33757 \begin_layout Itemize
33758
33759 \change_deleted 564990737 1669742044
33760
33761 \family sans
33762 Offprints
33763 \family default
33764 :
33765  [optional] if more than one author:
33766  whom to contact for offprint requests.
33767 \end_layout
33768
33769 \begin_layout Itemize
33770
33771 \change_deleted 564990737 1669742044
33772
33773 \family sans
33774 Mail
33775 \family default
33776 :
33777  [optional] mail address for contacts.
33778 \end_layout
33779
33780 \begin_layout Itemize
33781
33782 \change_deleted 564990737 1669742044
33783
33784 \family sans
33785 Date
33786 \family default
33787 :
33788  [required].
33789  Suggested format is
33790 \family typewriter
33791 Received:
33792  <date>;
33793  Accepted <date>
33794 \end_layout
33795
33796 \begin_layout Standard
33797
33798 \change_deleted 564990737 1669742044
33799 There is no need to issue the
33800 \family typewriter
33801
33802 \backslash
33803 maketitle
33804 \family default
33805  command,
33806  this is done automatically by \SpecialChar LyX
33807  when the header is finished.
33808  Although the order of the single header entries doesn't matter it is advised to keep the above sequence,
33809  just to get the best optics and meets the layout of the real document.
33810 \end_layout
33811
33812 \begin_layout Standard
33813
33814 \change_deleted 564990737 1669742044
33815 If you want to place footnotes in the header block,
33816  e.
33817 \begin_inset space \thinspace{}
33818 \end_inset
33819
33820 g.
33821 \begin_inset space \space{}
33822 \end_inset
33823
33824 to state your present address,
33825  just use the standard footnote via the menu
33826 \family sans
33827 Insert\SpecialChar menuseparator
33828 Footnote.
33829
33830 \family default
33831  \SpecialChar LyX
33832  will automagically use the term
33833 \family typewriter
33834
33835 \backslash
33836 thanks{}
33837 \family default
33838  in that case.
33839 \end_layout
33840
33841 \begin_layout Standard
33842
33843 \change_deleted 564990737 1669742044
33844 Under
33845 \family sans
33846 Edit\SpecialChar menuseparator
33847 Text Style
33848 \family default
33849 ,
33850  you'll find two insets which are relevant for the titling:
33851 \end_layout
33852
33853 \begin_layout Itemize
33854
33855 \change_deleted 564990737 1669742044
33856
33857 \family sans
33858 Institute
33859 \family typewriter
33860
33861 \family default
33862 to mark corresponding author\SpecialChar breakableslash
33863 institute pairs.
33864  The institutes are numbered sequentially as they appear in the
33865 \family sans
33866 Address
33867 \family default
33868  field,
33869  so you have to put a marker to each author.
33870 \end_layout
33871
33872 \begin_layout Itemize
33873
33874 \change_deleted 564990737 1669742044
33875
33876 \family sans
33877 Email
33878 \family default
33879  to supply an email address for fast contact.
33880 \end_layout
33881
33882 \begin_layout Standard
33883
33884 \change_deleted 564990737 1669742044
33885 In addition to these topics,
33886  the macros use one additional \SpecialChar LaTeX
33887  command that has no counterpart in \SpecialChar LyX
33888 :
33889 \end_layout
33890
33891 \begin_layout Itemize
33892
33893 \change_deleted 564990737 1669742044
33894
33895 \family typewriter
33896
33897 \backslash
33898 and
33899 \family default
33900  to separate different names for more than one author and institute,
33901  respectively.
33902 \end_layout
33903
33904 \begin_layout Standard
33905
33906 \change_deleted 564990737 1669742044
33907 The appropriate command has to be entered in \SpecialChar LyX
33908  and marked as \SpecialChar LaTeX
33909  code.
33910  See the examples.
33911
33912 \end_layout
33913
33914 \begin_layout Standard
33915
33916 \change_deleted 564990737 1669742044
33917 The abstract
33918 \end_layout
33919
33920 \begin_layout Standard
33921
33922 \change_deleted 564990737 1669742044
33923 The abstract should immediately follow the header block.
33924  With version 5 the abstract environment was changed to a command,
33925  and there is now a restriction to only one paragraph.
33926  In addition,
33927  it should contain an entry with the keywords.
33928  This is done via the paragraph style
33929 \family sans
33930 Keywords
33931 \family default
33932 .
33933  Refer to the example paper.
33934 \end_layout
33935
33936 \begin_layout Standard
33937
33938 \change_deleted 564990737 1669742044
33939 Supported environments
33940 \end_layout
33941
33942 \begin_layout Standard
33943
33944 \change_deleted 564990737 1669742044
33945 The A&A paper layout supports the following environments for structuring your text:
33946 \end_layout
33947
33948 \begin_layout Itemize
33949
33950 \change_deleted 564990737 1669742044
33951
33952 \family sans
33953 Standard
33954 \end_layout
33955
33956 \begin_layout Itemize
33957
33958 \change_deleted 564990737 1669742044
33959
33960 \family sans
33961 Section
33962 \end_layout
33963
33964 \begin_layout Itemize
33965
33966 \change_deleted 564990737 1669742044
33967
33968 \family sans
33969 Subsection
33970 \end_layout
33971
33972 \begin_layout Itemize
33973
33974 \change_deleted 564990737 1669742044
33975
33976 \family sans
33977 Subsubsection
33978 \end_layout
33979
33980 \begin_layout Itemize
33981
33982 \change_deleted 564990737 1669742044
33983
33984 \family sans
33985 Itemize
33986 \end_layout
33987
33988 \begin_layout Itemize
33989
33990 \change_deleted 564990737 1669742044
33991
33992 \family sans
33993 Enumerate
33994 \end_layout
33995
33996 \begin_layout Itemize
33997
33998 \change_deleted 564990737 1669742044
33999
34000 \family sans
34001 Description
34002 \end_layout
34003
34004 \begin_layout Itemize
34005
34006 \change_deleted 564990737 1669742044
34007
34008 \family sans
34009 Caption
34010 \end_layout
34011
34012 \begin_layout Itemize
34013
34014 \change_deleted 564990737 1669742044
34015
34016 \family sans
34017 Abstract
34018 \end_layout
34019
34020 \begin_layout Itemize
34021
34022 \change_deleted 564990737 1669742044
34023
34024 \family sans
34025 Acknowledgment
34026 \end_layout
34027
34028 \begin_layout Itemize
34029
34030 \change_deleted 564990737 1669742044
34031
34032 \family sans
34033 Bibliography
34034 \end_layout
34035
34036 \begin_layout Itemize
34037
34038 \change_deleted 564990737 1669742044
34039
34040 \family sans
34041 \SpecialChar LaTeX
34042
34043 \end_layout
34044
34045 \begin_layout Standard
34046
34047 \change_deleted 564990737 1669742044
34048 Commands not supported by \SpecialChar LyX
34049
34050 \end_layout
34051
34052 \begin_layout Standard
34053
34054 \change_deleted 564990737 1669742044
34055 Some commands are not yet supported by the
34056 \family sans
34057 paper (A&A)
34058 \family default
34059  layout for \SpecialChar LyX
34060 .
34061  Some have already been mentioned.
34062  For the sake of completeness,
34063  they are listed all together here:
34064 \end_layout
34065
34066 \begin_layout Itemize
34067
34068 \change_deleted 564990737 1669742044
34069
34070 \family typewriter
34071
34072 \backslash
34073 and
34074 \end_layout
34075
34076 \begin_layout Itemize
34077
34078 \change_deleted 564990737 1669742044
34079
34080 \family typewriter
34081
34082 \backslash
34083 authorrunning
34084 \end_layout
34085
34086 \begin_layout Itemize
34087
34088 \change_deleted 564990737 1669742044
34089
34090 \family typewriter
34091
34092 \backslash
34093 object{}
34094 \end_layout
34095
34096 \begin_layout Itemize
34097
34098 \change_deleted 564990737 1669742044
34099
34100 \family typewriter
34101
34102 \backslash
34103 titlerunning{}
34104 \end_layout
34105
34106 \begin_layout Standard
34107
34108 \change_deleted 564990737 1669742044
34109 If you want to use any of these commands,
34110  you have to enter them yourself.
34111
34112 \series bold
34113 Do not forget to mark them as \SpecialChar LaTeX
34114  code!
34115 \end_layout
34116
34117 \begin_layout Standard
34118
34119 \change_deleted 564990737 1669742044
34120 Figure and Table Floats
34121 \end_layout
34122
34123 \begin_layout Standard
34124
34125 \change_deleted 564990737 1669742044
34126 \SpecialChar LyX
34127  provides support for the necessary float environments
34128 \family sans
34129 figure,
34130  figure*,
34131  table
34132 \family default
34133  and
34134 \family sans
34135 table*
34136 \family default
34137 ,
34138  therefore we won't tell much about it here.
34139  Refer to the
34140 \emph on
34141 User's
34142 \begin_inset space ~
34143 \end_inset
34144
34145 Guide
34146 \emph default
34147 .
34148  Just remember that tables should be left-aligned.
34149  For that,
34150  select the table and change the alignment in
34151 \family sans
34152 Edit\SpecialChar menuseparator
34153 Paragraph
34154 \begin_inset space ~
34155 \end_inset
34156
34157 Settings.
34158 \end_layout
34159
34160 \begin_layout Standard
34161
34162 \change_deleted 564990737 1669742044
34163 There is only one special thing:
34164  the figures with caption besides the figure.
34165  To create such a figure,
34166  you have to do the following:
34167 \end_layout
34168
34169 \begin_layout Enumerate
34170
34171 \change_deleted 564990737 1669742044
34172 Create a wide figure float:
34173
34174 \family sans
34175 Insert\SpecialChar menuseparator
34176 Float\SpecialChar menuseparator
34177 Figure
34178 \family default
34179 ,
34180  then right click in the figure and select
34181 \family sans
34182 Span
34183 \begin_inset space ~
34184 \end_inset
34185
34186 columns
34187 \family default
34188 .
34189 \end_layout
34190
34191 \begin_layout Enumerate
34192
34193 \change_deleted 564990737 1669742044
34194 Enter your caption text.
34195 \end_layout
34196
34197 \begin_layout Enumerate
34198
34199 \change_deleted 564990737 1669742044
34200 Press
34201 \family sans
34202 Return
34203 \family default
34204  to move the cursor above the caption.
34205 \end_layout
34206
34207 \begin_layout Enumerate
34208
34209 \change_deleted 564990737 1669742044
34210 Insert your figure
34211 \end_layout
34212
34213 \begin_layout Enumerate
34214
34215 \change_deleted 564990737 1669742044
34216 Position the cursor behind the figure and insert a horizontal fill:
34217
34218 \family sans
34219 Insert\SpecialChar menuseparator
34220 Special
34221 \begin_inset space ~
34222 \end_inset
34223
34224 Character\SpecialChar menuseparator
34225 Horizontal
34226 \begin_inset space ~
34227 \end_inset
34228
34229 Fill
34230 \family default
34231 .
34232 \end_layout
34233
34234 \begin_layout Enumerate
34235
34236 \change_deleted 564990737 1669742044
34237 Switch to \SpecialChar LaTeX
34238  mode:
34239
34240 \family sans
34241 M-c
34242 \begin_inset space ~
34243 \end_inset
34244
34245 t
34246 \family default
34247 .
34248 \end_layout
34249
34250 \begin_layout Enumerate
34251
34252 \change_deleted 564990737 1669742044
34253 Enter
34254 \family typewriter
34255
34256 \backslash
34257 parbox[b]{55mm}{
34258 \family default
34259 .
34260
34261 \series bold
34262 Do not close the brace!
34263 \end_layout
34264
34265 \begin_layout Enumerate
34266
34267 \change_deleted 564990737 1669742044
34268 Position the cursor behind the caption text,
34269  switch to \SpecialChar LaTeX
34270  mode and insert the closing brace:
34271
34272 \family sans
34273 M-c
34274 \begin_inset space ~
34275 \end_inset
34276
34277 t
34278 \family default
34279
34280 \family typewriter
34281 }
34282 \family default
34283 .
34284 \end_layout
34285
34286 \begin_layout Standard
34287
34288 \change_deleted 564990737 1669742044
34289 Also,
34290  refer to the figures in the example paper.
34291 \end_layout
34292
34293 \begin_layout Standard
34294
34295 \change_deleted 564990737 1669742044
34296 Referee layout
34297 \end_layout
34298
34299 \begin_layout Standard
34300
34301 \change_deleted 564990737 1669742044
34302 For submission,
34303  the paper has to be formated in a special double-spacing layout.
34304  For this purpose,
34305  you have to give the option
34306 \family typewriter
34307 referee
34308 \family default
34309  to the document class.
34310  This must be done using the custom class options field in the
34311 \family sans
34312 Document\SpecialChar menuseparator
34313 Settings
34314 \family default
34315  dialog.
34316  Just enter the string
34317 \family typewriter
34318 referee
34319 \family default
34320  there.
34321 \end_layout
34322
34323 \begin_layout Standard
34324
34325 \change_deleted 564990737 1669742044
34326 The example paper
34327 \end_layout
34328
34329 \begin_layout Standard
34330
34331 \change_deleted 564990737 1669742044
34332 The
34333 \family sans
34334 Examples
34335 \family default
34336  directory contains an example paper written with \SpecialChar LyX
34337 .
34338  It is the example paper from the original macro package,
34339  translated to \SpecialChar LyX
34340 .
34341  Use it for inspiration,
34342  and compare the original \SpecialChar LaTeX
34343  code with \SpecialChar LyX
34344  way of writing.
34345 \end_layout
34346
34347 \begin_layout Standard
34348
34349 \change_deleted 564990737 1671097429
34350 Dinbrief
34351 \end_layout
34352
34353 \begin_layout Standard
34354
34355 \change_deleted 564990737 1671097429
34356 The document class
34357 \family sans
34358 dinbrief
34359 \family default
34360  can be used to type letters according to German conventions.
34361  A template file is included in
34362 \family typewriter
34363 .../lyx/share/templates
34364 \family default
34365  for you to use as a starting point.
34366 \end_layout
34367
34368 \begin_layout Standard
34369
34370 \change_deleted 564990737 1671097429
34371 Elsevier Journals
34372 \end_layout
34373
34374 \begin_layout Standard
34375
34376 \change_deleted 564990737 1671097429
34377 See the \SpecialChar LyX
34378  template file
34379 \family typewriter
34380 elsarticle.lyx
34381 \family default
34382 .
34383  It contains all infos you need.
34384 \end_layout
34385
34386 \begin_layout Standard
34387
34388 \change_deleted 564990737 1669755802
34389 ijmpc and ijmpd
34390 \end_layout
34391
34392 \begin_layout Standard
34393
34394 \change_deleted 564990737 1669755802
34395 by
34396 \noun on
34397 Panayotis Papasotiriou
34398 \end_layout
34399
34400 \begin_layout Standard
34401
34402 \change_deleted 564990737 1669755802
34403 Overview
34404 \end_layout
34405
34406 \begin_layout Standard
34407
34408 \change_deleted 564990737 1669755802
34409 The ijmpc package is a set of macros that facilitates electronic manuscript submission to the
34410 \emph on
34411 International Journal of Modern Physics C
34412 \emph default
34413 .
34414  Similarly,
34415  the ijmpd package is for creating manuscripts to be submitted to the
34416 \emph on
34417 International Journal of Modern Physics D
34418 \emph default
34419 .
34420  Both journals are published by World Scientific.
34421  The corresponding document classes are named
34422 \family typewriter
34423 ws-ijmpc.cls
34424 \family default
34425  and
34426 \family typewriter
34427 ws-ijmpd.cls
34428 \family default
34429 ,
34430  respectively.
34431  These files,
34432  together with instructions for the authors,
34433  can be downloaded from the sites
34434 \begin_inset Flex URL
34435 status collapsed
34436
34437 \begin_layout Plain Layout
34438
34439 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
34440 \end_layout
34441
34442 \end_inset
34443
34444  and
34445 \begin_inset Flex URL
34446 status collapsed
34447
34448 \begin_layout Plain Layout
34449
34450 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
34451 \end_layout
34452
34453 \end_inset
34454
34455 .
34456  Both packages are modified versions of the standard
34457 \begin_inset Quotes eld
34458 \end_inset
34459
34460 article
34461 \begin_inset Quotes erd
34462 \end_inset
34463
34464  package,
34465  and they are almost (but not exactly) identical.
34466  Most of their features are supported by \SpecialChar LyX
34467 .
34468  I have used \SpecialChar LyX
34469  successfully to write articles submitted to both journals without any problem.
34470 \end_layout
34471
34472 \begin_layout Standard
34473
34474 \change_deleted 564990737 1669755802
34475 Writing a paper
34476 \end_layout
34477
34478 \begin_layout Standard
34479
34480 \change_deleted 564990737 1669755802
34481 As usual,
34482  the easiest way to write a paper is to start with a template.
34483  Click on
34484 \family sans
34485 File\SpecialChar menuseparator
34486 New from
34487 \family default
34488
34489 \family sans
34490 Template
34491 \family default
34492 ,
34493  then choose the
34494 \family typewriter
34495 ijmpc.lyx
34496 \family default
34497  or
34498 \family typewriter
34499 ijmpd.lyx
34500 \family default
34501  template.
34502  This will give an (almost) empty document that includes the most common fields found in a manuscript.
34503  Simply overwrite the existing text (including the brackets,
34504
34505 \family typewriter
34506 <>
34507 \family default
34508 ) with your text.
34509  You should keep in mind the following remarks.
34510 \end_layout
34511
34512 \begin_layout Enumerate
34513
34514 \change_deleted 564990737 1669755802
34515 \SpecialChar LyX
34516  won't let you change the font size and the page style of the document,
34517  because such modifications are not allowed by both packages.
34518 \end_layout
34519
34520 \begin_layout Enumerate
34521
34522 \change_deleted 564990737 1669755802
34523 The language of the document should not be changed.
34524  Before previewing your paper,
34525  be sure that the babel package is not used.
34526  To do this,
34527  click on
34528 \begin_inset Info
34529 type  "menu"
34530 arg   "dialog-show document"
34531 \end_inset
34532
34533
34534 \family sans
34535 \SpecialChar menuseparator
34536 Language
34537 \family default
34538 ,
34539  and select
34540 \begin_inset Quotes eld
34541 \end_inset
34542
34543 None
34544 \begin_inset Quotes erd
34545 \end_inset
34546
34547  as
34548 \family sans
34549 Language Package
34550 \family default
34551 .
34552 \end_layout
34553
34554 \begin_layout Enumerate
34555
34556 \change_deleted 564990737 1669755802
34557 The
34558 \begin_inset Quotes eld
34559 \end_inset
34560
34561 Keywords
34562 \begin_inset Quotes erd
34563 \end_inset
34564
34565  style must be used to define keywords.
34566 \end_layout
34567
34568 \begin_layout Enumerate
34569
34570 \change_deleted 564990737 1669755802
34571 The ijmpc package provides a style named
34572 \begin_inset Quotes eld
34573 \end_inset
34574
34575 Classification Codes
34576 \begin_inset Quotes erd
34577 \end_inset
34578
34579 ,
34580  which can be used to define classification codes,
34581  such as PACS numbers.
34582  Note that this facility is not supported by the ijmpd package.
34583 \end_layout
34584
34585 \begin_layout Enumerate
34586
34587 \change_deleted 564990737 1669755802
34588 Several new environments are available:
34589
34590 \begin_inset Quotes eld
34591 \end_inset
34592
34593 Definition
34594 \begin_inset Quotes erd
34595 \end_inset
34596
34597 ,
34598
34599 \begin_inset Quotes eld
34600 \end_inset
34601
34602 Step
34603 \begin_inset Quotes erd
34604 \end_inset
34605
34606 ,
34607
34608 \begin_inset Quotes eld
34609 \end_inset
34610
34611 Example
34612 \begin_inset Quotes erd
34613 \end_inset
34614
34615 ,
34616
34617 \begin_inset Quotes eld
34618 \end_inset
34619
34620 Remark
34621 \begin_inset Quotes erd
34622 \end_inset
34623
34624 ,
34625
34626 \begin_inset Quotes eld
34627 \end_inset
34628
34629 Notation
34630 \begin_inset Quotes erd
34631 \end_inset
34632
34633 ,
34634
34635 \begin_inset Quotes eld
34636 \end_inset
34637
34638 Theorem
34639 \begin_inset Quotes erd
34640 \end_inset
34641
34642 ,
34643
34644 \begin_inset Quotes eld
34645 \end_inset
34646
34647 Proof
34648 \begin_inset Quotes erd
34649 \end_inset
34650
34651 ,
34652
34653 \begin_inset Quotes eld
34654 \end_inset
34655
34656 Corollary
34657 \begin_inset Quotes erd
34658 \end_inset
34659
34660 ,
34661
34662 \begin_inset Quotes eld
34663 \end_inset
34664
34665 Lemma
34666 \begin_inset Quotes erd
34667 \end_inset
34668
34669 ,
34670
34671 \begin_inset Quotes eld
34672 \end_inset
34673
34674 Proposition
34675 \begin_inset Quotes erd
34676 \end_inset
34677
34678 ,
34679
34680 \begin_inset Quotes eld
34681 \end_inset
34682
34683 Prop
34684 \begin_inset Quotes erd
34685 \end_inset
34686
34687 ,
34688
34689 \begin_inset Quotes eld
34690 \end_inset
34691
34692 Question
34693 \begin_inset Quotes erd
34694 \end_inset
34695
34696 ,
34697
34698 \begin_inset Quotes eld
34699 \end_inset
34700
34701 Claim
34702 \begin_inset Quotes erd
34703 \end_inset
34704
34705 ,
34706  and
34707 \begin_inset Quotes eld
34708 \end_inset
34709
34710 Conjecture
34711 \begin_inset Quotes erd
34712 \end_inset
34713
34714 .
34715  Their use is more or less obvious.
34716  \SpecialChar LyX
34717  supports all these environments;
34718  it will use the proper label,
34719  text style,
34720  and numbering scheme for each of them.
34721 \end_layout
34722
34723 \begin_layout Enumerate
34724
34725 \change_deleted 564990737 1669755802
34726 Both packages use basic citations;
34727  the natbib package should not be used.
34728  In \SpecialChar LyX
34729 ,
34730  citation references are shown as usual;
34731  in the output,
34732  citations are shown as superscripts.
34733  If you want to use a citation as normal text,
34734  you should use the
34735 \family typewriter
34736 refcite
34737 \family default
34738  command,
34739  e.
34740 \begin_inset space \thinspace{}
34741 \end_inset
34742
34743 g.
34744 \begin_inset space \space{}
34745 \end_inset
34746
34747
34748 \begin_inset Quotes eld
34749 \end_inset
34750
34751 See Ref.
34752 \begin_inset space \space{}
34753 \end_inset
34754
34755
34756 \family typewriter
34757
34758 \backslash
34759 refcite{key}
34760 \family default
34761
34762 \begin_inset Quotes erd
34763 \end_inset
34764
34765 .
34766 \end_layout
34767
34768 \begin_layout Enumerate
34769
34770 \change_deleted 564990737 1669755802
34771 There is no
34772 \begin_inset Quotes eld
34773 \end_inset
34774
34775 Acknowledgments
34776 \begin_inset Quotes erd
34777 \end_inset
34778
34779  section in both packages.
34780  To put acknowledgments,
34781  just use the
34782 \begin_inset Quotes eld
34783 \end_inset
34784
34785 Section*
34786 \begin_inset Quotes erd
34787 \end_inset
34788
34789  environment.
34790 \end_layout
34791
34792 \begin_layout Enumerate
34793
34794 \change_deleted 564990737 1669755802
34795 Appendices may be added to the paper,
34796
34797 \emph on
34798 after
34799 \emph default
34800  the Acknowledgments and
34801 \shape italic
34802 before
34803 \shape default
34804  the References.
34805  \SpecialChar LyX
34806  provides a special environment,
34807  called
34808 \begin_inset Quotes eld
34809 \end_inset
34810
34811 Appendices Section
34812 \begin_inset Quotes erd
34813 \end_inset
34814
34815  which marks the beginning of the appendices.
34816  This environment should be left blank;
34817  it just sends a \SpecialChar LaTeX
34818  command,
34819  but nothing is really printed.
34820  In \SpecialChar LyX
34821 ,
34822  the word
34823 \begin_inset Quotes eld
34824 \end_inset
34825
34826 Appendix
34827 \begin_inset Quotes erd
34828 \end_inset
34829
34830  is printed with blue letters,
34831  as a signal that all sections after that point are appendices.
34832  To write an appendix,
34833  use the
34834 \begin_inset Quotes eld
34835 \end_inset
34836
34837 Appendix
34838 \begin_inset Quotes erd
34839 \end_inset
34840
34841  environment.
34842  \SpecialChar LyX
34843  will number each appendix with capital letters,
34844  as required by both journals.
34845  Note that
34846 \begin_inset Quotes eld
34847 \end_inset
34848
34849 Appendices Section
34850 \begin_inset Quotes erd
34851 \end_inset
34852
34853
34854 \emph on
34855 must
34856 \emph default
34857  be present before the first appendix;
34858  if not,
34859  all appendices will be numbered as normal sections in the output.
34860 \end_layout
34861
34862 \begin_layout Enumerate
34863
34864 \change_deleted 564990737 1669755802
34865 The ijmpc and the ijmpd packages use the
34866 \family typewriter
34867 tbl
34868 \family default
34869  command to implement table captions.
34870  As a result,
34871  a table created by \SpecialChar LyX
34872  is printed correctly,
34873  but its caption is ignored.
34874  However,
34875  you can use some \SpecialChar TeX
34876  code to overcome this problem,
34877  so that captions are printed as expected.
34878  To do so,
34879  create a float table as usual,
34880  remove the caption,
34881  and replace it with the \SpecialChar TeX
34882  code
34883 \family typewriter
34884
34885 \backslash
34886 tbl{
34887 \emph on
34888 your table caption
34889 \emph default
34890 }{
34891 \family default
34892  (sic);
34893  you must also the \SpecialChar TeX
34894  code
34895 \family typewriter
34896 }
34897 \family default
34898  immediately after the tabular material.
34899  Study the example table included in the template files to see how this trick is implemented.
34900  Alternatively,
34901  If you need table captions,
34902  you should implement the whole table float in a
34903 \family typewriter
34904 .tex
34905 \family default
34906  file,
34907  then include this file to the \SpecialChar LyX
34908  document (
34909 \family sans
34910 Insert\SpecialChar menuseparator
34911 File\SpecialChar menuseparator
34912 Child
34913 \begin_inset space ~
34914 \end_inset
34915
34916 Document
34917 \family default
34918 ).
34919  Details on how to create a table float can be found in the files
34920 \family typewriter
34921 ws-ijmpc.tex
34922 \family default
34923  and
34924 \family typewriter
34925 ws-ijmpd.tex
34926 \family default
34927 ,
34928  included in the corresponding packages.
34929 \end_layout
34930
34931 \begin_layout Standard
34932
34933 \change_deleted 564990737 1669755802
34934 Preparing a paper for submission
34935 \end_layout
34936
34937 \begin_layout Standard
34938
34939 \change_deleted 564990737 1669755802
34940 Before you submit your paper you must export the \SpecialChar LyX
34941  document as a \SpecialChar LaTeX
34942  file (
34943 \family sans
34944 File\SpecialChar menuseparator
34945 Export\SpecialChar menuseparator
34946 \SpecialChar LaTeX
34947
34948 \family default
34949 )
34950 \begin_inset Foot
34951 status open
34952
34953 \begin_layout Plain Layout
34954 Actually you have the choice between \SpecialChar LaTeX
34955  (plain) and pdflatex.
34956  If you intend to use pdflatex to prepare the paper,
34957  you should use the pdflatex option so that included graphics are converted to PDF format,
34958  ready for use by pdflatex.
34959 \end_layout
34960
34961 \end_inset
34962
34963 ,
34964  then make the following changes to the resulting
34965 \family typewriter
34966 .tex
34967 \family default
34968  file.
34969 \end_layout
34970
34971 \begin_layout Enumerate
34972
34973 \change_deleted 564990737 1669755802
34974 Remove the comment lines before the
34975 \family typewriter
34976
34977 \backslash
34978 documentclass
34979 \family default
34980  command.
34981 \end_layout
34982
34983 \begin_layout Enumerate
34984
34985 \change_deleted 564990737 1669755802
34986 Remove everything between (and including) the
34987 \family typewriter
34988
34989 \backslash
34990 makeatletter
34991 \family default
34992  and
34993 \family typewriter
34994
34995 \backslash
34996 makeatother
34997 \family default
34998  commands,
34999  except for any commands you specifically put into the \SpecialChar LaTeX
35000  preamble.
35001 \end_layout
35002
35003 \begin_layout Standard
35004
35005 \change_deleted 564990737 1672743015
35006 The modified
35007 \family typewriter
35008 .tex
35009 \family default
35010  file should be saved and processed through \SpecialChar LaTeX
35011  as many times as necessary.
35012  You may also want to check the resulting
35013 \family typewriter
35014 .dvi
35015 \family default
35016  document.
35017 \end_layout
35018
35019 \begin_layout Standard
35020
35021 \change_deleted 564990737 1669801478
35022 iopart
35023 \end_layout
35024
35025 \begin_layout Standard
35026
35027 \change_deleted 564990737 1669801478
35028 by
35029 \noun on
35030 Uwe Stöhr
35031 \end_layout
35032
35033 \begin_layout Standard
35034
35035 \change_deleted 564990737 1669801478
35036 Overview
35037 \end_layout
35038
35039 \begin_layout Standard
35040
35041 \change_deleted 564990737 1669801478
35042 The iopart package provides a document class to create electronic manuscript submission to the journals published by the Institute of Physics.
35043  Instructions for the authors how to create a paper using the iopart class can be downloaded together with the iopart package from the site
35044 \begin_inset Flex URL
35045 status collapsed
35046
35047 \begin_layout Plain Layout
35048
35049 ftp://ftp.iop.org/pub/journals/latex2e
35050 \end_layout
35051
35052 \end_inset
35053
35054 .
35055 \end_layout
35056
35057 \begin_layout Standard
35058
35059 \change_deleted 564990737 1669801478
35060 Writing a paper
35061 \end_layout
35062
35063 \begin_layout Standard
35064
35065 \change_deleted 564990737 1669801478
35066 The easiest way to write a paper is to start with the template
35067 \emph on
35068 IOP-article.lyx
35069 \emph default
35070  that is available via
35071 \family sans
35072 File\SpecialChar menuseparator
35073 New From Template
35074 \family default
35075  The template explains how to use the special text environments.
35076  Here are the most important advices:
35077 \end_layout
35078
35079 \begin_layout Itemize
35080
35081 \change_deleted 564990737 1669801478
35082 To be able to compile your document to a PDF,
35083  PS,
35084  or DVI,
35085  ensure that the no AMS packages are loaded in
35086 \family sans
35087 Document\SpecialChar menuseparator
35088 Settings\SpecialChar menuseparator
35089 Math Options
35090 \family default
35091 !
35092 \end_layout
35093
35094 \begin_layout Itemize
35095
35096 \change_deleted 564990737 1669801478
35097
35098 \size normal
35099 The title environment defines the kind of your paper.
35100  So use one of the following environments for the title:
35101 \end_layout
35102
35103 \begin_deeper
35104 \begin_layout Itemize
35105
35106 \change_deleted 564990737 1669801478
35107
35108 \family sans
35109 \size normal
35110 Title
35111 \family default
35112  for a Paper
35113 \end_layout
35114
35115 \begin_layout Itemize
35116
35117 \change_deleted 564990737 1669801478
35118
35119 \family sans
35120 \size normal
35121 Review
35122 \family default
35123  for a Review
35124 \end_layout
35125
35126 \begin_layout Itemize
35127
35128 \change_deleted 564990737 1669801478
35129
35130 \family sans
35131 \size normal
35132 Topical
35133 \family default
35134  for a Topical review
35135 \end_layout
35136
35137 \begin_layout Itemize
35138
35139 \change_deleted 564990737 1669801478
35140
35141 \family sans
35142 \size normal
35143 Comment
35144 \family default
35145  for a Comment
35146 \end_layout
35147
35148 \begin_layout Itemize
35149
35150 \change_deleted 564990737 1669801478
35151
35152 \family sans
35153 \size normal
35154 Note
35155 \family default
35156  for a Note
35157 \end_layout
35158
35159 \begin_layout Itemize
35160
35161 \change_deleted 564990737 1669801478
35162
35163 \family sans
35164 \size normal
35165 Paper
35166 \family default
35167  for a Paper (same as Title)
35168 \end_layout
35169
35170 \begin_layout Itemize
35171
35172 \change_deleted 564990737 1669801478
35173
35174 \family sans
35175 \size normal
35176 Prelim
35177 \family default
35178  for a Preliminary communication
35179 \end_layout
35180
35181 \begin_layout Itemize
35182
35183 \change_deleted 564990737 1669801478
35184
35185 \family sans
35186 \size normal
35187 Rapid
35188 \family default
35189  for a Rapid communication
35190 \end_layout
35191
35192 \begin_layout Itemize
35193
35194 \change_deleted 564990737 1669801478
35195
35196 \family sans
35197 \size normal
35198 Letter
35199 \family default
35200  for a Letter to the editor
35201 \end_layout
35202
35203 \end_deeper
35204 \begin_layout Itemize
35205
35206 \change_deleted 564990737 1669801478
35207
35208 \size normal
35209 All title environments except of
35210 \family sans
35211 Letter
35212 \family default
35213  can have an optional short title.
35214 \end_layout
35215
35216 \begin_layout Itemize
35217
35218 \change_deleted 564990737 1669801478
35219 There is a general title environment
35220 \family sans
35221 Article
35222 \family default
35223  which is not directly supported by \SpecialChar LyX
35224 .
35225  This can be used as \SpecialChar TeX
35226  code when your document doesn't fit into one of the other title types.
35227 \end_layout
35228
35229 \begin_layout Standard
35230
35231 \change_deleted 564990737 1672743015
35232 For more informations like hints for special table and formula formatting,
35233  look at the IOP author guidelines.
35234 \end_layout
35235
35236 \begin_layout Standard
35237
35238 \change_deleted 564990737 1670317155
35239 Kluwer
35240 \end_layout
35241
35242 \begin_layout Standard
35243
35244 \change_deleted 564990737 1670317155
35245 by
35246 \noun on
35247 Panayotis Papasotiriou
35248 \end_layout
35249
35250 \begin_layout Standard
35251
35252 \change_deleted 564990737 1670317155
35253 Overview
35254 \end_layout
35255
35256 \begin_layout Standard
35257
35258 \change_deleted 564990737 1670317155
35259 The Kluwer package is a set of macros produced by Kluwer Academic Publishers that facilitates electronic manuscript submission to the journals they publish.
35260  Most known of them (at least in my domain of interest) are
35261 \emph on
35262 Astrophysics and Space Science
35263 \emph default
35264  and
35265 \emph on
35266 Solar Physics
35267 \emph default
35268 ,
35269  but there are many others (see a complete list at
35270 \begin_inset Flex URL
35271 status collapsed
35272
35273 \begin_layout Plain Layout
35274
35275 http://www.wkap.nl/jrnllist.htm/JRNLHOME
35276 \end_layout
35277
35278 \end_inset
35279
35280 ).
35281  The Kluwer package may be downloaded from the site
35282 \begin_inset Flex URL
35283 status collapsed
35284
35285 \begin_layout Plain Layout
35286
35287 http://www.wkap.nl/kaphtml.htm/STYLEFILES
35288 \end_layout
35289
35290 \end_inset
35291
35292 .
35293  A complete user guide is contained in that package (but it can also be downloaded separately).
35294 \end_layout
35295
35296 \begin_layout Standard
35297
35298 \change_deleted 564990737 1670317155
35299 \SpecialChar LyX
35300  supports many features of the package but not everything.
35301  However,
35302  the \SpecialChar TeX
35303  code needed is reduced to some
35304 \begin_inset Quotes eld
35305 \end_inset
35306
35307 peculiar
35308 \begin_inset Quotes erd
35309 \end_inset
35310
35311  commands of the package (see
35312 \begin_inset space ~
35313 \end_inset
35314
35315
35316 \begin_inset CommandInset ref
35317 LatexCommand ref
35318 reference "subsec:kluwer_peculiarities"
35319 nolink "false"
35320
35321 \end_inset
35322
35323 ).
35324  I have recently used \SpecialChar LyX
35325  to write an article submitted to the
35326 \emph on
35327 Astrophysics and Space Science
35328 \emph default
35329  without any problem.
35330 \end_layout
35331
35332 \begin_layout Standard
35333
35334 \change_deleted 564990737 1670317155
35335 Writing a paper
35336 \end_layout
35337
35338 \begin_layout Standard
35339
35340 \change_deleted 564990737 1670317155
35341 The easiest way to write a paper is to start with the Kluwer template file.
35342  Click on
35343 \family sans
35344 File\SpecialChar menuseparator
35345 New from
35346 \family default
35347
35348 \family sans
35349 Template
35350 \family default
35351 ,
35352  then choose the
35353 \family typewriter
35354 kluwer.lyx
35355 \family default
35356  template.
35357  This will give an (almost) empty document that includes the most common fields found in a manuscript and a short description of their use.
35358  As in most templates,
35359  simply overwrite the existing text (including the brackets,
35360
35361 \family typewriter
35362 <>
35363 \family default
35364 ) with the correct information.
35365 \end_layout
35366
35367 \begin_layout Standard
35368
35369 \change_deleted 564990737 1670317155
35370 Preparing a paper for submission
35371 \end_layout
35372
35373 \begin_layout Standard
35374
35375 \change_deleted 564990737 1670317155
35376 As in the AAS\SpecialChar TeX
35377  package,
35378  before you submit your paper to a journal you must
35379 \begin_inset Quotes eld
35380 \end_inset
35381
35382 postprocess
35383 \begin_inset Quotes erd
35384 \end_inset
35385
35386  it as follows.
35387 \end_layout
35388
35389 \begin_layout Enumerate
35390
35391 \change_deleted 564990737 1670317155
35392 Export your paper as a \SpecialChar LaTeX
35393  file.
35394  To do this,
35395  click on
35396 \family sans
35397 File\SpecialChar menuseparator
35398 Export\SpecialChar menuseparator
35399 \SpecialChar LaTeX
35400
35401 \family default
35402 .
35403
35404 \end_layout
35405
35406 \begin_layout Enumerate
35407
35408 \change_deleted 564990737 1670317155
35409 Edit the resulting
35410 \family typewriter
35411 .tex
35412 \family default
35413  file with a text editor and make the following changes
35414 \end_layout
35415
35416 \begin_deeper
35417 \begin_layout Enumerate
35418
35419 \change_deleted 564990737 1670317155
35420 remove the comment lines before the
35421 \family typewriter
35422
35423 \backslash
35424 documentclass
35425 \family default
35426  command,
35427 \end_layout
35428
35429 \begin_layout Enumerate
35430
35431 \change_deleted 564990737 1670317155
35432 remove everything between (and including) the
35433 \family typewriter
35434
35435 \backslash
35436 makeatletter
35437 \family default
35438  and
35439 \family typewriter
35440
35441 \backslash
35442 makeatother
35443 \family default
35444  commands,
35445  except for any commands you specifically put into the \SpecialChar LaTeX
35446  preamble.
35447 \end_layout
35448
35449 \begin_layout Standard
35450
35451 \change_deleted 564990737 1670317155
35452 Save the resulting
35453 \family typewriter
35454 .tex
35455 \family default
35456  file.
35457 \end_layout
35458
35459 \end_deeper
35460 \begin_layout Enumerate
35461
35462 \change_deleted 564990737 1670317155
35463 Run the
35464 \family typewriter
35465 .tex
35466 \family default
35467  file through \SpecialChar LaTeX
35468  as many times as necessary (usually up to three).
35469 \end_layout
35470
35471 \begin_layout Enumerate
35472
35473 \change_deleted 564990737 1670317155
35474 View the resulting
35475 \family typewriter
35476 .dvi
35477 \family default
35478  document using,
35479  e.
35480 \begin_inset space \thinspace{}
35481 \end_inset
35482
35483 g.
35484 \begin_inset space \space{}
35485 \end_inset
35486
35487
35488 \family sans
35489 xdvi
35490 \family default
35491 ,
35492  and check if everything is OK (it should,
35493  if you didn't make any mistake).
35494 \end_layout
35495
35496 \begin_layout Standard
35497
35498 \change_deleted 564990737 1670317155
35499 \begin_inset Quotes eld
35500 \end_inset
35501
35502 Peculiarities
35503 \begin_inset Quotes erd
35504 \end_inset
35505
35506  of the Kluwer package
35507 \begin_inset CommandInset label
35508 LatexCommand label
35509 name "subsec:kluwer_peculiarities"
35510
35511 \end_inset
35512
35513
35514 \end_layout
35515
35516 \begin_layout Standard
35517
35518 \change_deleted 564990737 1670317155
35519 The Kluwer package has the following
35520 \begin_inset Quotes eld
35521 \end_inset
35522
35523 peculiarities
35524 \begin_inset Quotes erd
35525 \end_inset
35526
35527 .
35528 \end_layout
35529
35530 \begin_layout Enumerate
35531
35532 \change_deleted 564990737 1670317155
35533 It is possible to write multiple articles in the same \SpecialChar LaTeX
35534  file
35535 \begin_inset Foot
35536 status collapsed
35537
35538 \begin_layout Plain Layout
35539 I can't imagine any good reason to do this.
35540 \end_layout
35541
35542 \end_inset
35543
35544 .
35545  Each article must be included in the environment
35546 \begin_inset Quotes eld
35547 \end_inset
35548
35549 article
35550 \begin_inset Quotes erd
35551 \end_inset
35552
35553 .
35554  Unfortunately,
35555  this environment cannot be omitted,
35556  even if you write just one article.
35557  Therefore,
35558  each article starts with the command
35559 \family typewriter
35560
35561 \backslash
35562 begin{article}
35563 \family default
35564  and,
35565  obviously,
35566  ends with the command
35567 \family typewriter
35568
35569 \backslash
35570 end{article}
35571 \family default
35572 .
35573  Although this can be implemented in \SpecialChar LyX
35574 ,
35575  I didn't included it,
35576  since it looks ugly and can confuse the novice user.
35577  Therefore,
35578  you need to enter them directly and mark them as \SpecialChar LaTeX
35579  code (the well-known
35580 \begin_inset Quotes eld
35581 \end_inset
35582
35583 \SpecialChar TeX
35584  code
35585 \begin_inset Quotes erd
35586 \end_inset
35587
35588 ).
35589 \end_layout
35590
35591 \begin_layout Enumerate
35592
35593 \change_deleted 564990737 1670317155
35594 Information given at the beginning of the article (i.
35595 \begin_inset space \thinspace{}
35596 \end_inset
35597
35598 e.
35599 \begin_inset space \space{}
35600 \end_inset
35601
35602 title,
35603  subtitle,
35604  author,
35605  institution,
35606  running title,
35607  running author,
35608  abstract and keywords) must be included in an environment called
35609 \begin_inset Quotes eld
35610 \end_inset
35611
35612 opening
35613 \begin_inset Quotes erd
35614 \end_inset
35615
35616 .
35617  This is not implemented in \SpecialChar LyX
35618 ,
35619  so you must enter title,
35620  subtitle etc.
35621 \begin_inset space ~
35622 \end_inset
35623
35624 between two \SpecialChar TeX
35625  code lines (
35626 \family typewriter
35627
35628 \backslash
35629 begin{opening}
35630 \family default
35631  and
35632 \family typewriter
35633
35634 \backslash
35635 end{opening}
35636 \family default
35637 ).
35638 \end_layout
35639
35640 \begin_layout Enumerate
35641
35642 \change_deleted 564990737 1670317155
35643 According to the user manual,
35644  the label of each bibliography item must be written as
35645 \family typewriter
35646
35647 \backslash
35648 protect
35649 \backslash
35650 citeauthoryear{
35651 \family default
35652 \emph on
35653 author(s)
35654 \family typewriter
35655 \emph default
35656 }{
35657 \family default
35658 \emph on
35659 year
35660 \family typewriter
35661 \emph default
35662 }
35663 \family default
35664 .
35665 \end_layout
35666
35667 \begin_layout Standard
35668
35669 \change_deleted 564990737 1670317155
35670 The
35671 \family typewriter
35672 kluwer.lyx
35673 \family default
35674  template takes care of all these
35675 \begin_inset Quotes eld
35676 \end_inset
35677
35678 peculiarities
35679 \begin_inset Quotes erd
35680 \end_inset
35681
35682 .
35683  If you start a new paper using this template you don't need to do anything special.
35684  Just
35685 \end_layout
35686
35687 \begin_layout Enumerate
35688
35689 \change_deleted 564990737 1670317155
35690 don't delete the \SpecialChar TeX
35691  code included in the template,
35692  and
35693 \end_layout
35694
35695 \begin_layout Enumerate
35696
35697 \change_deleted 564990737 1670317155
35698 copy the example bibliography item included in the template and modify it as necessary to enter new bibliography items.
35699 \end_layout
35700
35701 \begin_layout Standard
35702
35703 \change_deleted 564990737 1671097446
35704 Paper
35705 \end_layout
35706
35707 \begin_layout Standard
35708
35709 \change_deleted 564990737 1671097446
35710 The document class
35711 \family sans
35712 paper
35713 \family default
35714  provides an alternative to the standard
35715 \family sans
35716 article
35717 \family default
35718  class.
35719  It provides similar functionality,
35720  but you might prefer this layout with sans serif sections,
35721  headings,
35722  and more.
35723 \end_layout
35724
35725 \begin_layout Standard
35726
35727 \change_deleted 564990737 1671097446
35728 Springer Journals (
35729 \family sans
35730 svjour
35731 \family default
35732 )
35733 \end_layout
35734
35735 \begin_layout Standard
35736
35737 \change_deleted 564990737 1671097446
35738 by
35739 \noun on
35740 Martin Vermeer
35741 \end_layout
35742
35743 \begin_layout Standard
35744
35745 \change_deleted 564990737 1671097446
35746 Description
35747 \end_layout
35748
35749 \begin_layout Standard
35750
35751 \change_deleted 564990737 1671097446
35752 These are the layout files for some of the journal formats used by Springer Verlag and listed on
35753 \begin_inset Flex URL
35754 status collapsed
35755
35756 \begin_layout Plain Layout
35757
35758 http://www.springer.de/author/tex/help-journals.html
35759 \end_layout
35760
35761 \end_inset
35762
35763 ,
35764  where you should also go to fetch the class files (yes,
35765  these are \SpecialChar LaTeX2e
35766  now!).
35767  It is a modular system:
35768  the things common to all journals are implemented in
35769 \family typewriter
35770 svjour.inc
35771 \family default
35772 ,
35773  which journal-specific layout files (such as,
35774  e.
35775 \begin_inset space \thinspace{}
35776 \end_inset
35777
35778 g.
35779 \begin_inset space \space{}
35780 \end_inset
35781
35782
35783 \family typewriter
35784 svjog.layout
35785 \family default
35786  for Journal of Geodesy) can include.
35787 \end_layout
35788
35789 \begin_layout Standard
35790
35791 \change_deleted 564990737 1671097446
35792 This means that implementing support for any other Springer journal on this list is as simple as writing your own
35793 \family typewriter
35794 sv
35795 \family default
35796 <myjournal>
35797 \family typewriter
35798 .layout
35799 \family default
35800  file following the outline given in
35801 \family typewriter
35802 svjog.layout
35803 \family default
35804 .
35805
35806 \end_layout
35807
35808 \begin_layout Standard
35809
35810 \change_deleted 564990737 1671097446
35811 It is reasonably well tested only for the Journal of Geodesy.
35812
35813 \family typewriter
35814 svjour
35815 \family default
35816  and
35817 \family typewriter
35818 svjog
35819 \family default
35820  come with the standard \SpecialChar LyX
35821  distribution.
35822  Install the relevant class file (downloaded from Springer) in a proper directory,
35823  reconfigure \SpecialChar LaTeX
35824  (in the te\SpecialChar TeX
35825  case by running
35826 \family typewriter
35827 texhash
35828 \family default
35829 ,
35830  as root if necessary —
35831  doesn't \SpecialChar LyX
35832  take care of this?),
35833  reconfigure \SpecialChar LyX
35834  and it should work.
35835 \end_layout
35836
35837 \begin_layout Standard
35838
35839 \change_deleted 564990737 1671097446
35840 New styles
35841 \end_layout
35842
35843 \begin_layout Standard
35844
35845 \change_deleted 564990737 1671097446
35846 A large number of theorem-like styles —
35847
35848 \family sans
35849 Claim,
35850  Conjecture,
35851
35852 \family default
35853
35854 \family sans
35855 \SpecialChar ldots
35856 Theorem
35857 \family default
35858 .
35859 \end_layout
35860
35861 \begin_layout Standard
35862
35863 \change_deleted 564990737 1671097446
35864
35865 \family sans
35866 Headnote,
35867  Dedication,
35868  Subtitle,
35869  Running_\SpecialChar LaTeX
35870 _Title,
35871  Author_Running,
35872  Institute,
35873  Mail,
35874  Offprints,
35875  Keywords,
35876  Acknowledgements,
35877  Acknowledgement
35878 \family default
35879 .
35880  See the Springer class file documentation for details.
35881 \end_layout
35882
35883 \begin_layout Standard
35884
35885 \change_deleted 564990737 1671097446
35886 Supported journals
35887 \end_layout
35888
35889 \begin_layout Itemize
35890
35891 \change_deleted 564990737 1671097446
35892
35893 \emph on
35894 Journal of Geodesy
35895 \emph default
35896 :
35897
35898 \family typewriter
35899 svjog.layout
35900 \family default
35901  —
35902  Martin Vermeer
35903 \end_layout
35904
35905 \begin_layout Itemize
35906
35907 \change_deleted 564990737 1671097446
35908
35909 \emph on
35910 Probability Theory and Related Fields
35911 \emph default
35912 :
35913
35914 \family typewriter
35915 svprobth.layout
35916 \family default
35917  —
35918  Jean-Marc Lasgouttes
35919 \end_layout
35920
35921 \begin_layout Standard
35922
35923 \change_deleted 564990737 1671097446
35924 Add your own,
35925  it isn't so hard!
35926 \end_layout
35927
35928 \begin_layout Standard
35929
35930 \change_deleted 564990737 1671097446
35931 Credits
35932 \end_layout
35933
35934 \begin_layout Standard
35935
35936 \change_deleted 564990737 1671097446
35937 These files are partly based on the older
35938 \family typewriter
35939 ejour2.layout
35940 \family default
35941 ,
35942  which was again based on a tinkered-with version of an old \SpecialChar LaTeX
35943  2.09 style file from Springer.
35944  All this,
35945  and the
35946 \family typewriter
35947 ejour2
35948 \family default
35949  layout,
35950  are now defunct.
35951  Jean-Marc Lasgouttes helped out big in making me find my way around the \SpecialChar LyX
35952  layout file mechanism.
35953 \end_layout
35954
35955 \begin_layout Standard
35956
35957 \change_deleted 564990737 1671097446
35958 Bugs
35959 \end_layout
35960
35961 \begin_layout Standard
35962
35963 \change_deleted 564990737 1671097446
35964 Probably.
35965  But probably less than in the old hacked-\SpecialChar LaTeX
35966
35967 \family typewriter
35968 ejour2
35969 \family default
35970 .
35971 \end_layout
35972
35973 \begin_layout Chapter
35974 \SpecialChar LyX
35975  Features needing Extra Software
35976 \end_layout
35977
35978 \begin_layout Section
35979 Checking \SpecialChar TeX
35980
35981 \end_layout
35982
35983 \begin_layout Standard
35984 by
35985 \noun on
35986 Asger Alstrup
35987 \end_layout
35988
35989 \begin_layout Subsection
35990 Introduction
35991 \end_layout
35992
35993 \begin_layout Standard
35994 If you have the
35995 \family typewriter
35996 chktex
35997 \family default
35998  program installed
35999 \begin_inset Foot
36000 status collapsed
36001
36002 \begin_layout Plain Layout
36003
36004 \family typewriter
36005 chktex
36006 \family default
36007  is not yet available when you are using the \SpecialChar LaTeX
36008  distribution MiK\SpecialChar TeX
36009 .
36010 \end_layout
36011
36012 \end_inset
36013
36014 ,
36015  you'll find in the
36016 \family sans
36017 Tools
36018 \family default
36019  menu the entry:
36020
36021 \family sans
36022 Check
36023 \begin_inset space ~
36024 \end_inset
36025
36026 TeX
36027 \family default
36028 .
36029  You can get
36030 \family typewriter
36031 chktex
36032 \family default
36033  from CTAN,
36034 \begin_inset Newline newline
36035 \end_inset
36036
36037
36038 \begin_inset CommandInset href
36039 LatexCommand href
36040 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
36041 literal "false"
36042
36043 \end_inset
36044
36045 .
36046 \end_layout
36047
36048 \begin_layout Standard
36049 The
36050 \family sans
36051 Chk\SpecialChar TeX
36052
36053 \family default
36054  package is a program that was written by
36055 \begin_inset Flex Noun
36056 status collapsed
36057
36058 \begin_layout Plain Layout
36059 Jens T.
36060 \begin_inset space ~
36061 \end_inset
36062
36063 Berger Thielemann
36064 \end_layout
36065
36066 \end_inset
36067
36068  in frustration because some constructs in \SpecialChar LaTeX
36069  are sometimes non-intuitive,
36070  and easy to forget.
36071  The program runs over your \SpecialChar LaTeX
36072  file,
36073  checks the integrity of the file,
36074  and flags some common errors.
36075  In other technical words,
36076  it is
36077 \family typewriter
36078 lint
36079 \family default
36080  for \SpecialChar LaTeX
36081 .
36082 \end_layout
36083
36084 \begin_layout Standard
36085 Well,
36086  what is a syntax checker doing in \SpecialChar LyX
36087  which is supposed to produce correct \SpecialChar LaTeX
36088  anyways?
36089  The answer is simple:
36090  Just as
36091 \family typewriter
36092 Lint
36093 \family default
36094  not only checks the
36095 \emph on
36096 syntax
36097 \emph default
36098  of C programs,
36099  but also does
36100 \emph on
36101 semantic
36102 \emph default
36103  checks for type-errors,
36104
36105 \family sans
36106 Chk\SpecialChar TeX
36107
36108 \family default
36109  catches some common
36110 \emph on
36111 typographic
36112 \emph default
36113  errors,
36114  in addition to the syntactical ones.
36115  Specifically,
36116
36117 \family sans
36118 Chk\SpecialChar TeX
36119
36120 \family default
36121  is capable of detecting several common errors,
36122  such as
36123 \end_layout
36124
36125 \begin_layout Itemize
36126 Ellipsis detection:
36127 \begin_inset Newline newline
36128 \end_inset
36129
36130 Use \SpecialChar ldots
36131  instead of ...
36132 \end_layout
36133
36134 \begin_layout Itemize
36135 No space in front of/after parenthesis:
36136 \begin_inset Newline newline
36137 \end_inset
36138
36139 ( wrong spacing )
36140 \end_layout
36141
36142 \begin_layout Itemize
36143 Enforcement of normal space after common abbreviations:
36144 \begin_inset Newline newline
36145 \end_inset
36146
36147 e.
36148 \begin_inset space \thinspace{}
36149 \end_inset
36150
36151 g.
36152 \begin_inset space \space{}
36153 \end_inset
36154
36155 is too wide spacing.
36156 \end_layout
36157
36158 \begin_layout Itemize
36159 Enforcement of end-of-sentence space when the last sentence ends with a capital letter:
36160 \begin_inset Newline newline
36161 \end_inset
36162
36163 This is a TEST.
36164  And this is wrong spacing.
36165 \end_layout
36166
36167 \begin_layout Itemize
36168 Space in front of labels and similar commands:
36169 \begin_inset Newline newline
36170 \end_inset
36171
36172 The label should stick right up to the text to avoid falling to a wrong page.
36173
36174 \begin_inset CommandInset label
36175 LatexCommand label
36176 name "sec:chktex"
36177
36178 \end_inset
36179
36180
36181 \begin_inset Foot
36182 status collapsed
36183
36184 \begin_layout Plain Layout
36185 This footnote is in danger of falling off to a wrong page
36186 \end_layout
36187
36188 \end_inset
36189
36190  The label is separated too much.
36191 \end_layout
36192
36193 \begin_layout Itemize
36194 Space in front of references,
36195  instead of hard spaces:
36196 \begin_inset Newline newline
36197 \end_inset
36198
36199 If you have bad luck,
36200  the text will break right between the referenced text and reference number,
36201  and that's a pity.
36202  See section
36203 \begin_inset CommandInset ref
36204 LatexCommand ref
36205 reference "sec:chktex"
36206 nolink "false"
36207
36208 \end_inset
36209
36210 .
36211 \end_layout
36212
36213 \begin_layout Itemize
36214 Use of
36215 \begin_inset Quotes eld
36216 \end_inset
36217
36218 x
36219 \begin_inset Quotes erd
36220 \end_inset
36221
36222  instead of
36223 \begin_inset Formula $\times$
36224 \end_inset
36225
36226  between numbers:
36227 \begin_inset Newline newline
36228 \end_inset
36229
36230 2x2 looks cheap compared to
36231 \begin_inset Formula $2\times2$
36232 \end_inset
36233
36234 .
36235 \end_layout
36236
36237 \begin_layout Standard
36238 and more \SpecialChar ldots
36239  It is an invaluable tool when you are
36240 \begin_inset Quotes eld
36241 \end_inset
36242
36243 finishing up
36244 \begin_inset Quotes erd
36245 \end_inset
36246
36247  your document before printing,
36248  and you should run it right after the obligatory spelling check,
36249  and before you go fine tuning the typesetting.
36250 \end_layout
36251
36252 \begin_layout Subsection
36253 How to use it
36254 \end_layout
36255
36256 \begin_layout Standard
36257 If you have the program installed,
36258  usage is as simple as choosing
36259 \family sans
36260 Tools\SpecialChar menuseparator
36261 Check
36262 \begin_inset space ~
36263 \end_inset
36264
36265 TeX
36266 \family default
36267 .
36268  This will make \SpecialChar LyX
36269  generate a \SpecialChar LaTeX
36270  file of your document,
36271  start
36272 \family sans
36273 Chk\SpecialChar TeX
36274
36275 \family default
36276  to check it,
36277  and then make \SpecialChar LyX
36278  insert
36279 \begin_inset Quotes eld
36280 \end_inset
36281
36282 error boxes
36283 \begin_inset Quotes erd
36284 \end_inset
36285
36286  with the warnings from
36287 \family sans
36288 Chk\SpecialChar TeX
36289
36290 \family default
36291 ,
36292  if there were any.
36293  The warnings will be placed close to the point of the mistake,
36294  and you can quickly find them by using the
36295 \family sans
36296 Navigate\SpecialChar menuseparator
36297 Error
36298 \family default
36299  menu item,
36300  or the shortcut key
36301 \family sans
36302 C-g
36303 \family default
36304  from the default
36305 \family typewriter
36306 cua
36307 \family default
36308  bind file.
36309  Open the error boxes by clicking on them with the mouse,
36310  or use the shortcut key
36311 \family sans
36312 C-i
36313 \family default
36314  from
36315 \family typewriter
36316 cua
36317 \family default
36318  bindings,
36319  or the corresponding
36320 \family sans
36321 C-o
36322 \family default
36323  for the alternate
36324 \family typewriter
36325 emacs
36326 \family default
36327  bind file.
36328  Read the warning and correct the mistake,
36329  if it is a mistake.
36330  If you have trouble understanding what the warning is about,
36331  you can safely ignore it.
36332  Remember that there is a hidden layer between the document on screen and the technical details in invoking
36333 \family sans
36334 Chk\SpecialChar TeX
36335
36336 \family default
36337 ,
36338  and this gap can make some warnings seem arcane or just plain silly.
36339 \end_layout
36340
36341 \begin_layout Standard
36342 This document is an excellent testing bed for the feature,
36343  and it should provide quite a few warnings for you to fiddle with.
36344  Since computers are only so smart,
36345  expect most of the warnings to be false alarms,
36346  though.
36347 \end_layout
36348
36349 \begin_layout Subsection
36350 How to fine tune it
36351 \end_layout
36352
36353 \begin_layout Standard
36354 Sometimes,
36355  you'll find that
36356 \family sans
36357 Chk\SpecialChar TeX
36358
36359 \family default
36360  makes more noise than suits your mood.
36361  Then you can choose not to use it,
36362  wait until your mood changes,
36363  or try to customize
36364 \family sans
36365 Chk\SpecialChar TeX
36366
36367 \family default
36368  to get better along with you.
36369 \end_layout
36370
36371 \begin_layout Standard
36372 Although
36373 \family sans
36374 Chk\SpecialChar TeX
36375
36376 \family default
36377
36378 \emph on
36379 is
36380 \emph default
36381  very configurable and extensible,
36382  you should not expect to solve all problems with
36383 \family sans
36384 Chk\SpecialChar TeX
36385
36386 \family default
36387  in \SpecialChar LyX
36388  this way.
36389  Since \SpecialChar LyX
36390  has to generate a somewhat special \SpecialChar LaTeX
36391  file to be able to match the line numbers from the
36392 \family sans
36393 Chk\SpecialChar TeX
36394
36395 \family default
36396  output
36397 \begin_inset Foot
36398 status collapsed
36399
36400 \begin_layout Plain Layout
36401 You can inspect the specific output from
36402 \family sans
36403 chktex
36404 \family default
36405  by using
36406 \family sans
36407 Document\SpecialChar menuseparator
36408 \SpecialChar LaTeX
36409
36410 \begin_inset space ~
36411 \end_inset
36412
36413 Log
36414 \family default
36415  right after a
36416 \family sans
36417 chktex
36418 \family default
36419  run.
36420 \end_layout
36421
36422 \end_inset
36423
36424  to the internal document structure,
36425  some of the warnings will not appear correctly.
36426  There are two things you can do about this:
36427 \end_layout
36428
36429 \begin_layout Itemize
36430 Fine tune the
36431 \family sans
36432 Chk\SpecialChar TeX
36433
36434 \family default
36435  invocation command line in
36436 \change_deleted -712698321 1674918035
36437
36438 \begin_inset Flex Noun
36439 status collapsed
36440
36441 \begin_layout Plain Layout
36442 Tools\SpecialChar menuseparator
36443 Preferences\SpecialChar menuseparator
36444 Output\SpecialChar menuseparator
36445 LaTeX\SpecialChar menuseparator
36446 CheckTeX command
36447 \end_layout
36448
36449 \end_inset
36450
36451
36452 \change_inserted -712698321 1674918035
36453
36454 \family sans
36455 Tools\SpecialChar menuseparator
36456 Preferences\SpecialChar menuseparator
36457 Output\SpecialChar menuseparator
36458 LaTeX\SpecialChar menuseparator
36459 CheckTeX command
36460 \change_unchanged
36461
36462 \family default
36463 ,
36464  or the global
36465 \family sans
36466 Chk\SpecialChar TeX
36467
36468 \family default
36469  installation configuration file (usually with the file
36470 \family typewriter
36471 chktexrc
36472 \family default
36473 ).
36474  See below to learn what warnings can be enabled and disabled on the command line.
36475 \end_layout
36476
36477 \begin_layout Itemize
36478 Export your document as a raw \SpecialChar LaTeX
36479  file using
36480 \family sans
36481 File\SpecialChar menuseparator
36482 Export\SpecialChar menuseparator
36483 \SpecialChar LaTeX
36484
36485 \family default
36486  and run
36487 \family typewriter
36488 chktex
36489 \family default
36490  manually on that.
36491  Invoked in this way,
36492  it can be a hassle to find the corresponding place in the document inside \SpecialChar LyX
36493 ,
36494  but with a little patience,
36495  you should be able to do it.
36496 \end_layout
36497
36498 \begin_layout Standard
36499 Here follows the warning messages that can be enabled and disabled in
36500 \family sans
36501 Preferences
36502 \family default
36503 .
36504  Use
36505 \family typewriter
36506 -n#
36507 \family default
36508  to disable a warning,
36509  and
36510 \family typewriter
36511 -w#
36512 \family default
36513  to enable a warning.
36514  The emphasized entries are disabled by default,
36515  because the default is "
36516 \family typewriter
36517 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
36518 \family default
36519 ".
36520 \end_layout
36521
36522 \begin_layout Standard
36523 Notice that you should only use the options that enable and disable warnings,
36524  because \SpecialChar LyX
36525  relies on some of the other command line parameters to be set in a specific way to have a chance to communicate with
36526 \family typewriter
36527 chktex
36528 \family default
36529 .
36530 \end_layout
36531
36532 \begin_layout Enumerate
36533
36534 \size small
36535 \emph on
36536 Command terminated with space.
36537 \end_layout
36538
36539 \begin_layout Enumerate
36540
36541 \size small
36542 Non-breaking space (
36543 \begin_inset Quotes eld
36544 \end_inset
36545
36546
36547 \family typewriter
36548 ~
36549 \family default
36550
36551 \begin_inset Quotes erd
36552 \end_inset
36553
36554 ) should have been used.
36555 \end_layout
36556
36557 \begin_layout Enumerate
36558
36559 \size small
36560 \emph on
36561 You should enclose the previous parenthesis with
36562 \begin_inset Quotes eld
36563 \end_inset
36564
36565
36566 \family typewriter
36567 {}
36568 \family default
36569
36570 \begin_inset Quotes erd
36571 \end_inset
36572
36573 .
36574 \end_layout
36575
36576 \begin_layout Enumerate
36577
36578 \size small
36579 Italic correction (
36580 \begin_inset Quotes eld
36581 \end_inset
36582
36583
36584 \family typewriter
36585
36586 \backslash
36587 /
36588 \family default
36589
36590 \begin_inset Quotes erd
36591 \end_inset
36592
36593 ) found in non-italic buffer.
36594 \end_layout
36595
36596 \begin_layout Enumerate
36597
36598 \size small
36599 Italic correction (
36600 \begin_inset Quotes eld
36601 \end_inset
36602
36603
36604 \family typewriter
36605
36606 \backslash
36607 /
36608 \family default
36609
36610 \begin_inset Quotes erd
36611 \end_inset
36612
36613 ) found more than once.
36614 \end_layout
36615
36616 \begin_layout Enumerate
36617
36618 \size small
36619 \emph on
36620 No italic correction (
36621 \begin_inset Quotes eld
36622 \end_inset
36623
36624
36625 \family typewriter
36626
36627 \backslash
36628 /
36629 \family default
36630
36631 \begin_inset Quotes erd
36632 \end_inset
36633
36634 ) found.
36635 \end_layout
36636
36637 \begin_layout Enumerate
36638
36639 \size small
36640 Accent command
36641 \begin_inset Quotes eld
36642 \end_inset
36643
36644
36645 \family typewriter
36646 cmd
36647 \family default
36648
36649 \begin_inset Quotes erd
36650 \end_inset
36651
36652  needs use of
36653 \begin_inset Quotes eld
36654 \end_inset
36655
36656
36657 \family typewriter
36658 cmd
36659 \family default
36660
36661 \begin_inset Quotes erd
36662 \end_inset
36663
36664 .
36665 \end_layout
36666
36667 \begin_layout Enumerate
36668
36669 \size small
36670 Wrong length of dash may have been used.
36671 \end_layout
36672
36673 \begin_layout Enumerate
36674
36675 \size small
36676 \emph on
36677 \begin_inset Quotes eld
36678 \end_inset
36679
36680
36681 \family typewriter
36682 %s
36683 \family default
36684
36685 \begin_inset Quotes erd
36686 \end_inset
36687
36688  expected,
36689  found
36690 \begin_inset Quotes eld
36691 \end_inset
36692
36693
36694 \family typewriter
36695 %s
36696 \family default
36697
36698 \begin_inset Quotes erd
36699 \end_inset
36700
36701 .
36702 \end_layout
36703
36704 \begin_layout Enumerate
36705
36706 \size small
36707 Solo
36708 \begin_inset Quotes eld
36709 \end_inset
36710
36711
36712 \family typewriter
36713 %s
36714 \family default
36715
36716 \begin_inset Quotes erd
36717 \end_inset
36718
36719  found.
36720 \end_layout
36721
36722 \begin_layout Enumerate
36723
36724 \size small
36725 You should use
36726 \begin_inset Quotes eld
36727 \end_inset
36728
36729
36730 \family typewriter
36731 %s
36732 \family default
36733
36734 \begin_inset Quotes erd
36735 \end_inset
36736
36737  to achieve an ellipsis.
36738 \end_layout
36739
36740 \begin_layout Enumerate
36741
36742 \size small
36743 Inter-word spacing (
36744 \begin_inset Quotes eld
36745 \end_inset
36746
36747
36748 \family typewriter
36749
36750 \backslash
36751
36752 \family default
36753
36754 \begin_inset Quotes eld
36755 \end_inset
36756
36757 ) should perhaps be used.
36758 \end_layout
36759
36760 \begin_layout Enumerate
36761
36762 \size small
36763 Inter-sentence spacing (
36764 \begin_inset Quotes eld
36765 \end_inset
36766
36767
36768 \family typewriter
36769
36770 \backslash
36771 @
36772 \family default
36773
36774 \begin_inset Quotes erd
36775 \end_inset
36776
36777 ) should perhaps be used.
36778 \end_layout
36779
36780 \begin_layout Enumerate
36781
36782 \size small
36783 Could not find argument for command.
36784 \end_layout
36785
36786 \begin_layout Enumerate
36787
36788 \size small
36789 No match found for
36790 \begin_inset Quotes eld
36791 \end_inset
36792
36793
36794 \family typewriter
36795 %s
36796 \family default
36797
36798 \begin_inset Quotes erd
36799 \end_inset
36800
36801 .
36802 \end_layout
36803
36804 \begin_layout Enumerate
36805
36806 \size small
36807 Math mode still on at end of \SpecialChar LaTeX
36808  file.
36809 \end_layout
36810
36811 \begin_layout Enumerate
36812
36813 \size small
36814 Number of
36815 \begin_inset Quotes eld
36816 \end_inset
36817
36818
36819 \family typewriter
36820 char
36821 \family default
36822
36823 \begin_inset Quotes erd
36824 \end_inset
36825
36826  doesn't match the number of
36827 \begin_inset Quotes eld
36828 \end_inset
36829
36830
36831 \family typewriter
36832 char
36833 \family default
36834
36835 \begin_inset Quotes erd
36836 \end_inset
36837
36838 .
36839 \end_layout
36840
36841 \begin_layout Enumerate
36842
36843 \size small
36844 You should use either
36845 \family typewriter
36846
36847 \begin_inset Quotes eld
36848 \end_inset
36849
36850
36851 \family default
36852  or
36853 \family typewriter
36854
36855 \begin_inset Quotes erd
36856 \end_inset
36857
36858
36859 \family default
36860  as an alternative to
36861 \begin_inset Quotes eld
36862 \end_inset
36863
36864
36865 \family typewriter
36866 "
36867 \family default
36868
36869 \begin_inset Quotes erd
36870 \end_inset
36871
36872 .
36873 \end_layout
36874
36875 \begin_layout Enumerate
36876
36877 \size small
36878 You should use "
36879 \family typewriter
36880 '
36881 \family default
36882 " (ASCII 39) instead of "
36883 \family typewriter
36884 ´
36885 \family default
36886 " (ASCII 180).
36887 \end_layout
36888
36889 \begin_layout Enumerate
36890
36891 \size small
36892 User-specified pattern found.
36893 \end_layout
36894
36895 \begin_layout Enumerate
36896
36897 \size small
36898 This command might not be intended.
36899 \end_layout
36900
36901 \begin_layout Enumerate
36902
36903 \size small
36904 \emph on
36905 Comment displayed.
36906 \end_layout
36907
36908 \begin_layout Enumerate
36909
36910 \size small
36911 Either
36912 \family typewriter
36913 ''
36914 \backslash
36915 ,'
36916 \family default
36917  or
36918 \family typewriter
36919 '
36920 \backslash
36921 ,''
36922 \family default
36923  will look better.
36924 \end_layout
36925
36926 \begin_layout Enumerate
36927
36928 \size small
36929 Delete this space to maintain correct page references.
36930 \end_layout
36931
36932 \begin_layout Enumerate
36933
36934 \size small
36935 \emph on
36936 You might wish to put this between a pair of
36937 \begin_inset Quotes eld
36938 \end_inset
36939
36940
36941 \family typewriter
36942 {}
36943 \family default
36944
36945 \begin_inset Quotes erd
36946 \end_inset
36947
36948 .
36949 \end_layout
36950
36951 \begin_layout Enumerate
36952
36953 \size small
36954 You ought to remove spaces in front of punctuation.
36955 \end_layout
36956
36957 \begin_layout Enumerate
36958
36959 \size small
36960 Could not execute \SpecialChar LaTeX
36961  command.
36962 \end_layout
36963
36964 \begin_layout Enumerate
36965
36966 \size small
36967 Don't use
36968 \family typewriter
36969
36970 \backslash
36971 /
36972 \family default
36973  in front of small punctuation.
36974 \end_layout
36975
36976 \begin_layout Enumerate
36977
36978 \family typewriter
36979 \size small
36980 $
36981 \backslash
36982 times$
36983 \family default
36984  may look prettier here.
36985 \end_layout
36986
36987 \begin_layout Enumerate
36988
36989 \size small
36990 \emph on
36991 Multiple spaces detected in output.
36992 \end_layout
36993
36994 \begin_layout Enumerate
36995
36996 \size small
36997 This text may be ignored.
36998 \end_layout
36999
37000 \begin_layout Enumerate
37001
37002 \size small
37003 Use
37004 \family typewriter
37005
37006 \begin_inset Quotes eld
37007 \end_inset
37008
37009
37010 \family default
37011  to begin quotation,
37012  not
37013 \family typewriter
37014 '
37015 \family default
37016 .
37017 \end_layout
37018
37019 \begin_layout Enumerate
37020
37021 \size small
37022 Use
37023 \family typewriter
37024 '
37025 \family default
37026  to end quotation,
37027  not
37028 \family typewriter
37029
37030 \begin_inset Quotes eld
37031 \end_inset
37032
37033
37034 \family default
37035 .
37036 \end_layout
37037
37038 \begin_layout Enumerate
37039
37040 \size small
37041 Don't mix quotes.
37042 \end_layout
37043
37044 \begin_layout Enumerate
37045
37046 \size small
37047 You should perhaps use
37048 \begin_inset Quotes eld
37049 \end_inset
37050
37051
37052 \family typewriter
37053 cmd
37054 \family default
37055
37056 \begin_inset Quotes erd
37057 \end_inset
37058
37059  instead.
37060 \end_layout
37061
37062 \begin_layout Enumerate
37063
37064 \size small
37065 You should put a space in front of/after parenthesis.
37066 \end_layout
37067
37068 \begin_layout Enumerate
37069
37070 \size small
37071 You should avoid spaces in front of/after parenthesis.
37072 \end_layout
37073
37074 \begin_layout Enumerate
37075
37076 \size small
37077 \emph on
37078 You should not use punctuation in front of/after quotes.
37079 \end_layout
37080
37081 \begin_layout Enumerate
37082
37083 \size small
37084 Double space found.
37085 \end_layout
37086
37087 \begin_layout Enumerate
37088
37089 \size small
37090 You should put punctuation outside inner/inside display math mode.
37091 \end_layout
37092
37093 \begin_layout Enumerate
37094
37095 \size small
37096 You ought to not use primitive \SpecialChar TeX
37097  in \SpecialChar LaTeX
37098  code.
37099 \end_layout
37100
37101 \begin_layout Enumerate
37102
37103 \size small
37104 You should remove spaces in front of
37105 \begin_inset Quotes eld
37106 \end_inset
37107
37108
37109 \family typewriter
37110 %s
37111 \family default
37112
37113 \begin_inset Quotes erd
37114 \end_inset
37115
37116
37117 \end_layout
37118
37119 \begin_layout Enumerate
37120
37121 \size small
37122 \begin_inset Quotes eld
37123 \end_inset
37124
37125
37126 \family typewriter
37127 %s
37128 \family default
37129
37130 \begin_inset Quotes erd
37131 \end_inset
37132
37133  is normally not followed by
37134 \begin_inset Quotes eld
37135 \end_inset
37136
37137
37138 \family typewriter
37139 %c
37140 \family default
37141
37142 \begin_inset Quotes erd
37143 \end_inset
37144
37145 .
37146 \end_layout
37147
37148 \begin_layout Standard
37149 In later versions of \SpecialChar LyX
37150 ,
37151  we hope to provide a more complete interface to this tool (and it's smaller cousin
37152 \family typewriter
37153 lacheck
37154 \family default
37155 ) to exploit the full power of it.
37156  But it's not exactly useless as it is now:
37157  go try it on one of your existing documents of a certain length and be surprised.
37158 \end_layout
37159
37160 \begin_layout Section
37161 Version Control in \SpecialChar LyX
37162
37163 \end_layout
37164
37165 \begin_layout Standard
37166 by
37167 \noun on
37168  Lars Gullik Bjønnes
37169 \noun default
37170 and
37171 \noun on
37172 Pavel Sanda
37173 \end_layout
37174
37175 \begin_layout Subsection
37176 Introduction
37177 \end_layout
37178
37179 \begin_layout Standard
37180 \SpecialChar LyX
37181  supports some of the most basic RCS/CVS/SVN/GIT commands.
37182  If you need something a bit more sophisticated you will have to do that manually in a terminal.
37183 \end_layout
37184
37185 \begin_layout Standard
37186 Also note that CVS support is not as good as subversion support,
37187  so we advise using SVN instead.
37188  A good place to start learning Subversion is the SVN Book
37189 \begin_inset Foot
37190 status collapsed
37191
37192 \begin_layout Plain Layout
37193 \begin_inset CommandInset href
37194 LatexCommand href
37195 target "http://svnbook.red-bean.com/"
37196 literal "false"
37197
37198 \end_inset
37199
37200
37201 \end_layout
37202
37203 \end_inset
37204
37205 .
37206  In the case of RCS you should read
37207 \begin_inset Quotes eld
37208 \end_inset
37209
37210 rcsintro
37211 \begin_inset Quotes erd
37212 \end_inset
37213
37214  (a man file,
37215  read it with
37216 \family typewriter
37217 man rcsintro
37218 \family default
37219 ).
37220  This file describes all the basic features of RCS.
37221  You should especially notice the comment about a RCS directory,
37222  and the notion of a master RCS file (the file ending in
37223 \family typewriter
37224 ,v
37225 \family default
37226 ).
37227 \end_layout
37228
37229 \begin_layout Standard
37230 Before you begin to use the version control features in \SpecialChar LyX
37231 ,
37232  you should be familiar with RCS/CVS/SVN/GIT usage.
37233  The implementation in \SpecialChar LyX
37234  assumes a recent version of the GNU RCS or CVS/SVN package —
37235  no guarantees are made for older versions.
37236  Most of the log messages are not currently displayed after operations —
37237  you can check them in the Messages pane if you are unsure.
37238  Regular users of version control will appreciate the VC toolbar,
37239  which can be enabled via
37240 \family sans
37241 View\SpecialChar menuseparator
37242 Toolbars\SpecialChar menuseparator
37243 Version
37244 \begin_inset space ~
37245 \end_inset
37246
37247 Control
37248 \family default
37249 .
37250 \end_layout
37251
37252 \begin_layout Standard
37253 For introducing your own external commands consult
37254 \begin_inset Flex Code
37255 status collapsed
37256
37257 \begin_layout Plain Layout
37258 vc-command
37259 \end_layout
37260
37261 \end_inset
37262
37263  in the manual
37264 \emph on
37265 \SpecialChar LyX
37266  Functions
37267 \emph default
37268 .
37269 \end_layout
37270
37271 \begin_layout Standard
37272 It is strongly recommended to store documents in uncompressed format if using version control (uncheck
37273 \family sans
37274 Document\SpecialChar menuseparator
37275 Compressed
37276 \family default
37277  if it is checked):
37278  Uncompressed LyX documents are text files and therefore for merging two different versions by version control systems.
37279  Compressed LyX documents are binary files,
37280  which cannot be merged by version control systems.
37281 \end_layout
37282
37283 \begin_layout Subsection
37284 RCS commands in \SpecialChar LyX
37285
37286 \end_layout
37287
37288 \begin_layout Standard
37289 The following sections describe the RCS commands supported by \SpecialChar LyX
37290 .
37291  You can find them in the
37292 \family sans
37293 File\SpecialChar menuseparator
37294 Version
37295 \begin_inset space ~
37296 \end_inset
37297
37298 Control
37299 \family default
37300  submenu.
37301  \SpecialChar LyX
37302  was tested against RCS 5.7/5.8.
37303 \end_layout
37304
37305 \begin_layout Subsubsection
37306
37307 \family sans
37308 Register
37309 \end_layout
37310
37311 \begin_layout Standard
37312 If your document is not under revision control,
37313  this is the only item shown in the menu.
37314  And if it is under revision control,
37315  the
37316 \family sans
37317 Register
37318 \family default
37319  item is not visible.
37320
37321 \end_layout
37322
37323 \begin_layout Standard
37324 This command registers your document with RCS (unless you are under the directory managed by CVS)\SpecialChar endofsentence
37325  You are asked interactively to supply an initial description of the document.
37326  The document is now set in Read-Only mode and you have to
37327 \family sans
37328 Check
37329 \begin_inset space ~
37330 \end_inset
37331
37332 Out
37333 \begin_inset space ~
37334 \end_inset
37335
37336 For
37337 \begin_inset space ~
37338 \end_inset
37339
37340 Edit
37341 \family default
37342 ,
37343  before making any changes to it.
37344  A document under revision control has a
37345 \begin_inset Quotes eld
37346 \end_inset
37347
37348 [RCS:<version> <locker>]
37349 \begin_inset Quotes erd
37350 \end_inset
37351
37352  item tagged to the filename in the minibuffer.
37353 \end_layout
37354
37355 \begin_layout Standard
37356 RCS command that is run:
37357 \end_layout
37358
37359 \begin_layout LyX-Code
37360
37361 \family typewriter
37362 ci -q -u -i -t-"<initial description>" <file-name>
37363 \end_layout
37364
37365 \begin_layout Standard
37366 Read
37367 \family typewriter
37368 man ci
37369 \family default
37370  to understand the switches.
37371
37372 \end_layout
37373
37374 \begin_layout Subsubsection
37375
37376 \family sans
37377 Check In Changes
37378 \end_layout
37379
37380 \begin_layout Standard
37381 When you are finished editing a file,
37382  you check in your changes.
37383  When you do this,
37384  you are asked for a description of the changes.
37385  This is stored in the history log.
37386  The version number is bumped,
37387  your changes are applied to the master RCS file,
37388  the document is unlocked and set to Read-Only mode.
37389 \end_layout
37390
37391 \begin_layout Itemize
37392 RCS command:
37393
37394 \family typewriter
37395 ci -q -u -m"<description>" <file-name>
37396 \end_layout
37397
37398 \begin_layout Subsubsection
37399
37400 \family sans
37401 Check Out For Edit
37402 \end_layout
37403
37404 \begin_layout Standard
37405 By doing this you lock the document so that only you can edit it.
37406  This will also make the document Read-Write only for you.
37407  You will usually continue editing for a while and when you are finished you check in your changes.
37408  The status line is changed to reflect that you have locked the file.
37409 \end_layout
37410
37411 \begin_layout Itemize
37412 RCS command:
37413
37414 \family typewriter
37415 co -q -l <file-name>
37416 \end_layout
37417
37418 \begin_layout Subsubsection
37419
37420 \family sans
37421 Revert To Repository Version
37422 \end_layout
37423
37424 \begin_layout Standard
37425 This will discard all changes made to the document since the last check in.
37426  You get a warning before changes are discarded.
37427 \end_layout
37428
37429 \begin_layout Itemize
37430 RCS command:
37431
37432 \family typewriter
37433 co -f -u<version> <file-name>
37434 \end_layout
37435
37436 \begin_layout Subsubsection
37437
37438 \family sans
37439 Copy
37440 \end_layout
37441
37442 \begin_layout Standard
37443 This will create a copy of the current document.
37444  Since RCS does not support copy operations natively,
37445  the version history is not preserved,
37446  and the copy is added as a new file.
37447  It requires a clean document without any changes since the last checkin.
37448  You are asked for a file name and a description of the copy operation.
37449  After that the copy is created,
37450  both locally and in the repository.
37451  If the parent directories of the copied and original document differ,
37452  all relative paths of included files of the copy are adjusted (like in
37453 \family sans
37454 File\SpecialChar menuseparator
37455 Save As
37456 \family default
37457 \SpecialChar ldots
37458 ).
37459  Finally,
37460  the copy is loaded instead of the original document.
37461 \end_layout
37462
37463 \begin_layout Labeling
37464 \labelwidthstring 00.00.0000
37465 RCS
37466 \begin_inset space ~
37467 \end_inset
37468
37469 commands:
37470
37471 \begin_inset space ~
37472 \end_inset
37473
37474
37475 \begin_inset Newline newline
37476 \end_inset
37477
37478 Copy
37479 \begin_inset Flex Code
37480 status collapsed
37481
37482 \begin_layout Plain Layout
37483
37484 \family typewriter
37485 \begin_inset Quotes qld
37486 \end_inset
37487
37488 <file-name>
37489 \begin_inset Quotes qld
37490 \end_inset
37491
37492
37493 \end_layout
37494
37495 \end_inset
37496
37497  to
37498 \begin_inset Flex Code
37499 status collapsed
37500
37501 \begin_layout Plain Layout
37502
37503 \family typewriter
37504 \begin_inset Quotes qld
37505 \end_inset
37506
37507 <new-file-name>
37508 \begin_inset Quotes qld
37509 \end_inset
37510
37511
37512 \end_layout
37513
37514 \end_inset
37515
37516
37517 \begin_inset Newline newline
37518 \end_inset
37519
37520
37521 \begin_inset Flex Code
37522 status collapsed
37523
37524 \begin_layout Plain Layout
37525 ci -q -u
37526 \family typewriter
37527 -i
37528 \begin_inset Quotes qld
37529 \end_inset
37530
37531 <new-file-name>
37532 \begin_inset Quotes qld
37533 \end_inset
37534
37535
37536 \end_layout
37537
37538 \end_inset
37539
37540
37541 \end_layout
37542
37543 \begin_layout Subsubsection
37544
37545 \family sans
37546 Undo Last Checkin
37547 \end_layout
37548
37549 \begin_layout Standard
37550 This makes as if the last check in never happened.
37551  No changes are made to the document loaded into \SpecialChar LyX
37552 ,
37553  but the last version is removed from the master RCS file.
37554 \end_layout
37555
37556 \begin_layout Itemize
37557 RCS command:
37558
37559 \family typewriter
37560 rcs -o<version> <file-name>
37561 \end_layout
37562
37563 \begin_layout Subsubsection
37564
37565 \family sans
37566 Show History
37567 \end_layout
37568
37569 \begin_layout Standard
37570 This shows the complete history of the RCS document.
37571  The output of
37572 \family typewriter
37573 rlog <file-name>
37574 \family default
37575  is shown in a browser.
37576  See
37577 \family typewriter
37578 man rlog
37579 \family default
37580  for more info.
37581 \end_layout
37582
37583 \begin_layout Subsubsection
37584 Revision info
37585 \end_layout
37586
37587 \begin_layout Standard
37588 \SpecialChar LyX
37589  supports RCS version number,
37590  author name,
37591  date and time of last commit.
37592  All those are extracted from
37593 \family typewriter
37594 rlog -r <file-name>
37595 \family default
37596 .
37597  See
37598 \begin_inset CommandInset ref
37599 LatexCommand ref
37600 reference "subsec:VCS-Revision-Information"
37601 nolink "false"
37602
37603 \end_inset
37604
37605  for details.
37606 \end_layout
37607
37608 \begin_layout Subsection
37609 CVS commands in \SpecialChar LyX
37610
37611 \end_layout
37612
37613 \begin_layout Standard
37614 A subset of CVS operations is supported by \SpecialChar LyX
37615 .
37616  You can find the commands in the
37617 \family sans
37618 File\SpecialChar menuseparator
37619 Version
37620 \begin_inset space ~
37621 \end_inset
37622
37623 Control
37624 \family default
37625  submenu.
37626  The version control system SVN is more powerful,
37627  so please use it instead of CVS if possible.
37628 \end_layout
37629
37630 \begin_layout Subsubsection
37631
37632 \family sans
37633 General CVS usage
37634 \end_layout
37635
37636 \begin_layout Standard
37637 If you start from scratch with CVS you have to create your repository and checkout the working copy with external tools.
37638  If you're using a client-server setup you may need to login before doing the first repository checkout.
37639 \end_layout
37640
37641 \begin_layout Standard
37642 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.
37643  Standard CVS repositories don't operate with a file locking mechanism.
37644  This may be surprising,
37645  but conflicts only occur if people disagree on the proper content of the same part of a document.
37646  So,
37647  if co-workers are used to communicate regularly,
37648  these conflicts occur rarely.
37649  If they don't communicate they have a fundamental problem anyway.
37650  Nevertheless some people like to work with so called
37651 \begin_inset Quotes eld
37652 \end_inset
37653
37654 reserved checkouts
37655 \begin_inset Quotes erd
37656 \end_inset
37657
37658 .
37659  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.
37660  When the changes are checked in the working copy returns to readonly state.
37661  With \SpecialChar LyX
37662  one has to edit the
37663 \begin_inset Flex Code
37664 status collapsed
37665
37666 \begin_layout Plain Layout
37667 .cvsrc
37668 \end_layout
37669
37670 \end_inset
37671
37672  file and add the line
37673 \begin_inset Flex Code
37674 status collapsed
37675
37676 \begin_layout Plain Layout
37677 cvs -r
37678 \end_layout
37679
37680 \end_inset
37681
37682  to work with reserved checkouts.
37683  The benefit is the possibility to see who is using a writable copy of some document.
37684  It's not guaranteed only one user makes a copy writable.
37685 \end_layout
37686
37687 \begin_layout Standard
37688 \SpecialChar LyX
37689  tries to guess if you're using reserved or non-reserved checkouts.
37690  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.
37691  When a reserved checkout is detected you have to use
37692 \begin_inset Flex Noun
37693 status collapsed
37694
37695 \begin_layout Plain Layout
37696 Check Out
37697 \end_layout
37698
37699 \end_inset
37700
37701  to make your working copy writable if it's readonly.
37702  After doing so the
37703 \begin_inset Flex Noun
37704 status collapsed
37705
37706 \begin_layout Plain Layout
37707 Check In
37708 \end_layout
37709
37710 \end_inset
37711
37712  operation is possible and that makes your working copy readonly again after transferring your changes to the repository.
37713 \end_layout
37714
37715 \begin_layout Standard
37716 More information about CVS can be found here
37717 \begin_inset Flex URL
37718 status collapsed
37719
37720 \begin_layout Plain Layout
37721
37722 http://www.nongnu.org/cvs
37723 \end_layout
37724
37725 \end_inset
37726
37727  and here
37728 \begin_inset Flex URL
37729 status collapsed
37730
37731 \begin_layout Plain Layout
37732
37733 http://ximbiot.com/cvs
37734 \end_layout
37735
37736 \end_inset
37737
37738 .
37739 \end_layout
37740
37741 \begin_layout Standard
37742 Read
37743 \family typewriter
37744 man cvs
37745 \family default
37746  to understand the sub-commands and the switches mentioned below.
37747 \end_layout
37748
37749 \begin_layout Subsubsection
37750
37751 \family sans
37752 Register
37753 \end_layout
37754
37755 \begin_layout Standard
37756 If your document is not under revision control,
37757  this is the only item shown in the menu.
37758  And if it is under revision control,
37759  the
37760 \family sans
37761 Register
37762 \family default
37763  item is not visible.
37764
37765 \end_layout
37766
37767 \begin_layout Standard
37768 This command registers in CVS your document
37769 \begin_inset Flex Strong
37770 status collapsed
37771
37772 \begin_layout Plain Layout
37773
37774 \emph on
37775 only
37776 \end_layout
37777
37778 \end_inset
37779
37780  in the case you have already the documents directory under CVS control (in particular
37781 \family typewriter
37782 CVS/Entries
37783 \family default
37784  file exists).
37785  This means you have to create or checkout the archive by yourself using external tools.
37786  (In case you forget that step \SpecialChar LyX
37787  registers the document with RCS.)
37788 \end_layout
37789
37790 \begin_layout Standard
37791 Then you are asked interactively to supply an initial description of the document.
37792  Don't forget that registered file is not yet checked in.
37793 \end_layout
37794
37795 \begin_layout Standard
37796 CVS command that is run:
37797
37798 \family typewriter
37799 cvs -q add -m"<entered message>" "<file-name>"
37800 \end_layout
37801
37802 \begin_layout Standard
37803 The term
37804 \family typewriter
37805 "<file-name>"
37806 \family default
37807  above and for all other CVS commands is an abbreviation for
37808 \begin_inset Quotes eld
37809 \end_inset
37810
37811 change the current working directory to file location and use the file name without path component as argument
37812 \begin_inset Quotes erd
37813 \end_inset
37814
37815 .
37816 \end_layout
37817
37818 \begin_layout Subsubsection
37819
37820 \family sans
37821 Check In Changes
37822 \end_layout
37823
37824 \begin_layout Standard
37825 When you are finished editing a file,
37826  you commit your changes.
37827  When you do this and you had changed the document,
37828  you are asked for a description of the changes.
37829  After that changes are written to the repository.
37830  In case you didn't change the document and a reserved checkout is detected the reservation made on
37831 \begin_inset Flex Noun
37832 status collapsed
37833
37834 \begin_layout Plain Layout
37835 Check Out
37836 \end_layout
37837
37838 \end_inset
37839
37840  is undone.
37841 \end_layout
37842
37843 \begin_layout Labeling
37844 \labelwidthstring 00.00.0000
37845 CVS
37846 \begin_inset space ~
37847 \end_inset
37848
37849 command:
37850
37851 \begin_inset space ~
37852 \end_inset
37853
37854
37855 \begin_inset Newline newline
37856 \end_inset
37857
37858
37859 \begin_inset Flex Code
37860 status collapsed
37861
37862 \begin_layout Plain Layout
37863 cvs
37864 \family typewriter
37865 -q commit -m"<description>" "<file-name>"
37866 \end_layout
37867
37868 \end_inset
37869
37870  or
37871 \begin_inset Newline newline
37872 \end_inset
37873
37874
37875 \begin_inset Flex Code
37876 status collapsed
37877
37878 \begin_layout Plain Layout
37879 cvs -q unedit
37880 \family typewriter
37881 "<file-name>"
37882 \end_layout
37883
37884 \end_inset
37885
37886
37887 \end_layout
37888
37889 \begin_layout Subsubsection
37890
37891 \family sans
37892 Check Out Changes
37893 \end_layout
37894
37895 \begin_layout Standard
37896 When you are sharing a repository with others,
37897  you may have to incorporate their changes into your working copy.
37898 \end_layout
37899
37900 \begin_layout Standard
37901 CVS command:
37902
37903 \family typewriter
37904 cvs -q update "<file-name>"
37905 \end_layout
37906
37907 \begin_layout Standard
37908 If a readonly checkout is detected the working copy is made writable and reserved.
37909 \end_layout
37910
37911 \begin_layout Standard
37912 CVS command:
37913
37914 \family typewriter
37915 cvs -q edit "<file-name>"
37916 \end_layout
37917
37918 \begin_layout Subsubsection
37919
37920 \family sans
37921 Revert To Repository Version
37922 \end_layout
37923
37924 \begin_layout Standard
37925 This will discard all changes made to the document since the last check in.
37926  You get a warning before changes are discarded.
37927  Firstly the file is deleted,
37928  secondly CVS update command is run.
37929 \end_layout
37930
37931 \begin_layout Standard
37932 CVS command:
37933
37934 \family typewriter
37935 cvs -q update "<file-name>"
37936 \end_layout
37937
37938 \begin_layout Standard
37939 If a reserved checkout is detected and the working copy has no changes only the reservation is undone.
37940 \end_layout
37941
37942 \begin_layout Standard
37943 CVS command:
37944
37945 \family typewriter
37946 cvs -q unedit "<file-name>"
37947 \end_layout
37948
37949 \begin_layout Subsubsection
37950
37951 \family sans
37952 Copy
37953 \end_layout
37954
37955 \begin_layout Standard
37956 This will create a copy of the current document.
37957  Since CVS does not support copy operations natively,
37958  the version history is not preserved,
37959  and the copy is added as a new file.
37960  It requires a clean document without any changes since the last checkin.
37961  You are asked for a file name and a description of the copy operation.
37962  After that the copy is created,
37963  both locally and in the repository.
37964  If the parent directories of the copied and original document differ,
37965  all relative paths of included files of the copy are adjusted (like in
37966 \family sans
37967 File\SpecialChar menuseparator
37968 Save As
37969 \family default
37970 \SpecialChar ldots
37971 ).
37972  Finally,
37973  the copy is loaded instead of the original document.
37974 \end_layout
37975
37976 \begin_layout Labeling
37977 \labelwidthstring 00.00.0000
37978 CVS
37979 \begin_inset space ~
37980 \end_inset
37981
37982 commands:
37983
37984 \begin_inset space ~
37985 \end_inset
37986
37987
37988 \begin_inset Newline newline
37989 \end_inset
37990
37991 Copy
37992 \begin_inset Flex Code
37993 status collapsed
37994
37995 \begin_layout Plain Layout
37996 "<file-name>"
37997 \end_layout
37998
37999 \end_inset
38000
38001  to
38002 \begin_inset Flex Code
38003 status collapsed
38004
38005 \begin_layout Plain Layout
38006 "<new-file-name>"
38007 \end_layout
38008
38009 \end_inset
38010
38011
38012 \begin_inset Newline newline
38013 \end_inset
38014
38015
38016 \begin_inset Flex Code
38017 status collapsed
38018
38019 \begin_layout Plain Layout
38020 cvs -q add "<new-file-name>"
38021 \end_layout
38022
38023 \end_inset
38024
38025
38026 \end_layout
38027
38028 \begin_layout Subsubsection
38029
38030 \family sans
38031 Rename
38032 \end_layout
38033
38034 \begin_layout Standard
38035 This will rename the current document.
38036  Since CVS does not support rename operations natively,
38037  the version history is not preserved,
38038  the renamed document is added as a new file,
38039  and the original document is deleted.
38040  It requires a clean document without any changes since the last checkin.
38041  You are asked for a file name and a description of the rename operation.
38042  After that the document is renamed,
38043  both locally and in the repository.
38044  If the parent directories of the new and old file names differ,
38045  all relative paths of included files are adjusted (like in
38046 \family sans
38047 File\SpecialChar menuseparator
38048 Save As
38049 \family default
38050 \SpecialChar ldots
38051 ).
38052  Finally,
38053  the document is reloaded using the new name.
38054 \end_layout
38055
38056 \begin_layout Labeling
38057 \labelwidthstring 00.00.0000
38058 CVS
38059 \begin_inset space ~
38060 \end_inset
38061
38062 commands:
38063
38064 \begin_inset space ~
38065 \end_inset
38066
38067
38068 \begin_inset Newline newline
38069 \end_inset
38070
38071 Rename
38072 \begin_inset Flex Code
38073 status collapsed
38074
38075 \begin_layout Plain Layout
38076 "<file-name>"
38077 \end_layout
38078
38079 \end_inset
38080
38081  to
38082 \begin_inset Flex Code
38083 status collapsed
38084
38085 \begin_layout Plain Layout
38086 "<new-file-name>"
38087 \end_layout
38088
38089 \end_inset
38090
38091
38092 \begin_inset Newline newline
38093 \end_inset
38094
38095
38096 \begin_inset Flex Code
38097 status collapsed
38098
38099 \begin_layout Plain Layout
38100 cvs -q add "<new-file-name>"
38101 \end_layout
38102
38103 \end_inset
38104
38105
38106 \begin_inset Newline newline
38107 \end_inset
38108
38109
38110 \begin_inset Flex Code
38111 status collapsed
38112
38113 \begin_layout Plain Layout
38114 cvs -q remove "<file-name>"
38115 \end_layout
38116
38117 \end_inset
38118
38119
38120 \end_layout
38121
38122 \begin_layout Subsubsection
38123 Update of the local directory checkout from repository
38124 \end_layout
38125
38126 \begin_layout Standard
38127 Once your documents gets more complex,
38128  containing sub-documents and pictures,
38129  including external
38130 \begin_inset Flex Code
38131 status collapsed
38132
38133 \begin_layout Plain Layout
38134 .tex
38135 \end_layout
38136
38137 \end_inset
38138
38139  files and so on using version control becomes more complicated.
38140  \SpecialChar LyX
38141  supports updating the whole tree in which resides the document.
38142  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.
38143  You have to organize the files structure so that all external files are in the same directory or subdirectories of the document.
38144  It's good practice anyway to store multipart documents in an extra directory.
38145 \end_layout
38146
38147 \begin_layout Standard
38148 The
38149 \begin_inset Flex Code
38150 status collapsed
38151
38152 \begin_layout Plain Layout
38153 Update local directory from repository
38154 \end_layout
38155
38156 \end_inset
38157
38158  command updates the whole directory.
38159  If local changes are detected user is warned before update starts.
38160  In case of merge conflicts both versions of the conflicting document parts are placed in the final document.
38161  You have to review and correct the result of the merge.
38162  You'll find the conflicts enclosed in pairs of
38163 \begin_inset Flex Code
38164 status collapsed
38165
38166 \begin_layout Plain Layout
38167 <<<<<<<
38168 \end_layout
38169
38170 \end_inset
38171
38172  and
38173 \begin_inset Flex Code
38174 status collapsed
38175
38176 \begin_layout Plain Layout
38177 >>>>>>>
38178 \end_layout
38179
38180 \end_inset
38181
38182  separated by
38183 \begin_inset Flex Code
38184 status collapsed
38185
38186 \begin_layout Plain Layout
38187 =======
38188 \end_layout
38189
38190 \end_inset
38191
38192 .
38193  The first part is your version as before the update operation with the document name prepended.
38194  The second one is the repository version with the version number after the sequence of
38195 \begin_inset Flex Code
38196 status collapsed
38197
38198 \begin_layout Plain Layout
38199 >
38200 \end_layout
38201
38202 \end_inset
38203
38204  signs.
38205 \end_layout
38206
38207 \begin_layout Labeling
38208 \labelwidthstring 00.00.0000
38209 CVS
38210 \begin_inset space ~
38211 \end_inset
38212
38213 commands:
38214
38215 \begin_inset space ~
38216 \end_inset
38217
38218
38219 \begin_inset Newline newline
38220 \end_inset
38221
38222
38223 \begin_inset Flex Code
38224 status collapsed
38225
38226 \begin_layout Plain Layout
38227 cd $path;
38228  cvs diff
38229 \family typewriter
38230 "."
38231 \end_layout
38232
38233 \end_inset
38234
38235  (Ask if changes are detected.)
38236 \begin_inset Newline newline
38237 \end_inset
38238
38239
38240 \begin_inset Flex Code
38241 status collapsed
38242
38243 \begin_layout Plain Layout
38244 cd $path;
38245  cvs -q update
38246 \family typewriter
38247 "."
38248 \end_layout
38249
38250 \end_inset
38251
38252
38253 \end_layout
38254
38255 \begin_layout Standard
38256 where
38257 \begin_inset Flex Code
38258 status collapsed
38259
38260 \begin_layout Plain Layout
38261 $path
38262 \end_layout
38263
38264 \end_inset
38265
38266  stands for the path to the document.
38267 \end_layout
38268
38269 \begin_layout Subsubsection
38270
38271 \family sans
38272 Show History
38273 \end_layout
38274
38275 \begin_layout Standard
38276 This shows the complete history of the CVS document.
38277  The output of
38278 \family typewriter
38279 cvs log "<file-name>"
38280 \family default
38281  is shown in a browser.
38282 \end_layout
38283
38284 \begin_layout Subsubsection
38285 Revision info
38286 \end_layout
38287
38288 \begin_layout Standard
38289 \SpecialChar LyX
38290  supports CVS version number,
38291  author name,
38292  date and time of last commit.
38293  All those are extracted from
38294 \family typewriter
38295 cvs log -r <file-name>
38296 \family default
38297 .
38298  See
38299 \begin_inset CommandInset ref
38300 LatexCommand ref
38301 reference "subsec:VCS-Revision-Information"
38302 nolink "false"
38303
38304 \end_inset
38305
38306  for details.
38307 \end_layout
38308
38309 \begin_layout Subsection
38310 SVN commands in \SpecialChar LyX
38311
38312 \end_layout
38313
38314 \begin_layout Standard
38315 SVN is now partially supported by \SpecialChar LyX
38316 .
38317  You can find the commands in the
38318 \family sans
38319 File\SpecialChar menuseparator
38320 Version
38321 \begin_inset space ~
38322 \end_inset
38323
38324 Control
38325 \family default
38326  submenu.
38327  Please note that if you use password protected access to repository via ssh,
38328  you will be asked in terminal window.
38329  \SpecialChar LyX
38330  was tested against SVN 1.5,
38331  1.6,
38332  1.7 and 1.8
38333 \begin_inset Foot
38334 status collapsed
38335
38336 \begin_layout Plain Layout
38337 Most of the commands will work with 1.4 too,
38338  see
38339 \begin_inset CommandInset ref
38340 LatexCommand ref
38341 reference "subsec:SVN-Repo-Update"
38342 nolink "false"
38343
38344 \end_inset
38345
38346 .
38347  There seems to be currently unresolved permissions problem under SVN 1.8 with reverting changes when file is locked.
38348 \end_layout
38349
38350 \end_inset
38351
38352
38353 \end_layout
38354
38355 \begin_layout Subsubsection
38356
38357 \family sans
38358 Register
38359 \end_layout
38360
38361 \begin_layout Standard
38362 If your document is not under revision control,
38363  this is the only item shown in the menu.
38364  And if it is under revision control,
38365  the
38366 \family sans
38367 Register
38368 \family default
38369  item is not visible.
38370 \end_layout
38371
38372 \begin_layout Standard
38373 This command registers in SVN your document ONLY in case you have already the documents directory under SVN control (in particular
38374 \family typewriter
38375 .svn/entries
38376 \family default
38377  file exists).
38378  This means you have to checkout the archive by yourself.
38379 \end_layout
38380
38381 \begin_layout Standard
38382 Then you are asked interactively to supply an initial description of the document.
38383  Don't forget that registered file is not yet commited.
38384 \end_layout
38385
38386 \begin_layout Standard
38387 SVN command that is run:
38388
38389 \family typewriter
38390 svn add -q
38391 \begin_inset Quotes qld
38392 \end_inset
38393
38394 <file-name>
38395 \begin_inset Quotes qld
38396 \end_inset
38397
38398
38399 \end_layout
38400
38401 \begin_layout Standard
38402 Read
38403 \family typewriter
38404 man svn
38405 \family default
38406  to understand the switches.
38407 \end_layout
38408
38409 \begin_layout Subsubsection
38410
38411 \family sans
38412 Check In Changes
38413 \end_layout
38414
38415 \begin_layout Standard
38416 When you are finished editing a file,
38417  you commit your changes.
38418  When you do this,
38419  you are asked for a description of the changes.
38420  After that changes are commited.
38421 \end_layout
38422
38423 \begin_layout Standard
38424 SVN command:
38425 \begin_inset Foot
38426 status collapsed
38427
38428 \begin_layout Plain Layout
38429 In case locking is not enabled.
38430  See Section
38431 \begin_inset CommandInset ref
38432 LatexCommand ref
38433 reference "subsec:SVN-File-Locking"
38434 nolink "false"
38435
38436 \end_inset
38437
38438 .
38439 \end_layout
38440
38441 \end_inset
38442
38443
38444 \family typewriter
38445 svn commit -q -m"<description>" <file-name>
38446 \end_layout
38447
38448 \begin_layout Subsubsection
38449
38450 \family sans
38451 Check Out For Edit
38452 \end_layout
38453
38454 \begin_layout Standard
38455 Updates the changes of this file from the repository.
38456  Be sure you understand SVN merging and conflicts resolving before using this function,
38457  because all conflicts has to be resolved manually by you!
38458 \end_layout
38459
38460 \begin_layout Standard
38461 SVN command:
38462 \begin_inset Foot
38463 status collapsed
38464
38465 \begin_layout Plain Layout
38466 Ditto.
38467 \end_layout
38468
38469 \end_inset
38470
38471
38472 \family typewriter
38473 svn update --non-interactive
38474 \begin_inset Quotes qld
38475 \end_inset
38476
38477 <file-name>
38478 \begin_inset Quotes qld
38479 \end_inset
38480
38481
38482 \end_layout
38483
38484 \begin_layout Subsubsection
38485
38486 \family sans
38487 Revert To Repository Version
38488 \end_layout
38489
38490 \begin_layout Standard
38491 This will discard all changes made to the document since the last check in.
38492  You get a warning before changes are discarded.
38493 \end_layout
38494
38495 \begin_layout Standard
38496 SVN command:
38497
38498 \family typewriter
38499 svn revert -q
38500 \begin_inset Quotes qld
38501 \end_inset
38502
38503 <file-name>
38504 \begin_inset Quotes qld
38505 \end_inset
38506
38507
38508 \end_layout
38509
38510 \begin_layout Subsubsection
38511
38512 \family sans
38513 Copy
38514 \end_layout
38515
38516 \begin_layout Standard
38517 This will create a copy of the current document including the version history.
38518  It requires a clean document without any changes since the last checkin.
38519  You are asked for a file name and a description of the copy operation.
38520  After that the copy is created,
38521  both locally and in the repository.
38522  If the parent directories of the copied and original document differ,
38523  all relative paths of included files of the copy are adjusted (like in
38524 \family sans
38525 File\SpecialChar menuseparator
38526 Save As
38527 \family default
38528 \SpecialChar ldots
38529 ).
38530  Finally,
38531  the copy is loaded instead of the original document.
38532 \end_layout
38533
38534 \begin_layout Labeling
38535 \labelwidthstring 00.00.0000
38536 SVN
38537 \begin_inset space ~
38538 \end_inset
38539
38540 commands:
38541
38542 \begin_inset space ~
38543 \end_inset
38544
38545
38546 \begin_inset Newline newline
38547 \end_inset
38548
38549
38550 \begin_inset Flex Code
38551 status collapsed
38552
38553 \begin_layout Plain Layout
38554 svn copy -q
38555 \family typewriter
38556
38557 \begin_inset Quotes qld
38558 \end_inset
38559
38560 <file-name>
38561 \begin_inset Quotes qld
38562 \end_inset
38563
38564
38565 \begin_inset Quotes qld
38566 \end_inset
38567
38568 <new-file-name>
38569 \begin_inset Quotes qld
38570 \end_inset
38571
38572
38573 \end_layout
38574
38575 \end_inset
38576
38577
38578 \begin_inset Newline newline
38579 \end_inset
38580
38581
38582 \begin_inset Flex Code
38583 status collapsed
38584
38585 \begin_layout Plain Layout
38586 svn commit
38587 \end_layout
38588
38589 \end_inset
38590
38591
38592 \end_layout
38593
38594 \begin_layout Subsubsection
38595
38596 \family sans
38597 Rename
38598 \end_layout
38599
38600 \begin_layout Standard
38601 This will rename the current document including the version history.
38602  It requires a clean document without any changes since the last checkin.
38603  You are asked for a file name and a description of the rename operation.
38604  After that the document is renamed,
38605  both locally and in the repository.
38606  If the parent directories of the new and old file names differ,
38607  all relative paths of included files are adjusted (like in
38608 \family sans
38609 File\SpecialChar menuseparator
38610 Save As
38611 \family default
38612 \SpecialChar ldots
38613 ).
38614  Finally,
38615  the document is reloaded using the new name.
38616 \end_layout
38617
38618 \begin_layout Labeling
38619 \labelwidthstring 00.00.0000
38620 SVN
38621 \begin_inset space ~
38622 \end_inset
38623
38624 commands:
38625
38626 \begin_inset space ~
38627 \end_inset
38628
38629
38630 \begin_inset Newline newline
38631 \end_inset
38632
38633
38634 \begin_inset Flex Code
38635 status collapsed
38636
38637 \begin_layout Plain Layout
38638 svn move -q
38639 \family typewriter
38640
38641 \begin_inset Quotes qld
38642 \end_inset
38643
38644 <file-name>
38645 \begin_inset Quotes qld
38646 \end_inset
38647
38648
38649 \begin_inset Quotes qld
38650 \end_inset
38651
38652 <new-file-name>
38653 \begin_inset Quotes qld
38654 \end_inset
38655
38656
38657 \end_layout
38658
38659 \end_inset
38660
38661
38662 \begin_inset Newline newline
38663 \end_inset
38664
38665
38666 \begin_inset Flex Code
38667 status collapsed
38668
38669 \begin_layout Plain Layout
38670 svn commit
38671 \end_layout
38672
38673 \end_inset
38674
38675
38676 \end_layout
38677
38678 \begin_layout Subsubsection
38679 \begin_inset CommandInset label
38680 LatexCommand label
38681 name "subsec:SVN-Repo-Update"
38682
38683 \end_inset
38684
38685 Update of the local directory checkout from repository
38686 \begin_inset Foot
38687 status collapsed
38688
38689 \begin_layout Plain Layout
38690 Note that this command will work only with subversion
38691 \begin_inset Formula $\geqq1.5$
38692 \end_inset
38693
38694
38695 \end_layout
38696
38697 \end_inset
38698
38699
38700 \end_layout
38701
38702 \begin_layout Standard
38703 All the commands above have one shortcoming – they deal with the current document only.
38704  Once your document contains pictures,
38705  includes external
38706 \begin_inset Flex Code
38707 status collapsed
38708
38709 \begin_layout Plain Layout
38710 .tex
38711 \end_layout
38712
38713 \end_inset
38714
38715  files and so on administration becomes more complicated.
38716  \SpecialChar LyX
38717  now supports updating the whole tree in which resides the document
38718 \begin_inset Foot
38719 status collapsed
38720
38721 \begin_layout Plain Layout
38722 One need to organize the files structure so that all external files are in the same directory or subdirectories of the document.
38723
38724 \end_layout
38725
38726 \end_inset
38727
38728 .
38729  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.
38730
38731 \end_layout
38732
38733 \begin_layout Standard
38734 \begin_inset Flex Code
38735 status collapsed
38736
38737 \begin_layout Plain Layout
38738 Update local directory from repository
38739 \end_layout
38740
38741 \end_inset
38742
38743  command updates the whole directory and in case of merge conflicts local version of the files are left,
38744  so no unintended data loss occurs.
38745  If local changes are detected user is warned before update starts.
38746 \end_layout
38747
38748 \begin_layout Labeling
38749 \labelwidthstring 00.00.0000
38750 SVN
38751 \begin_inset space ~
38752 \end_inset
38753
38754 commands:
38755
38756 \begin_inset space ~
38757 \end_inset
38758
38759
38760 \begin_inset Newline newline
38761 \end_inset
38762
38763
38764 \begin_inset Flex Code
38765 status collapsed
38766
38767 \begin_layout Plain Layout
38768 svn diff $path
38769 \end_layout
38770
38771 \end_inset
38772
38773  (Ask if changes are detected.)
38774 \begin_inset Newline newline
38775 \end_inset
38776
38777
38778 \begin_inset Flex Code
38779 status collapsed
38780
38781 \begin_layout Plain Layout
38782 svn update --accept mine-full $path
38783 \end_layout
38784
38785 \end_inset
38786
38787
38788 \end_layout
38789
38790 \begin_layout Standard
38791 where
38792 \begin_inset Flex Code
38793 status collapsed
38794
38795 \begin_layout Plain Layout
38796 $path
38797 \end_layout
38798
38799 \end_inset
38800
38801  stands for the path to the document.
38802 \end_layout
38803
38804 \begin_layout Subsubsection
38805
38806 \family sans
38807 Show History
38808 \end_layout
38809
38810 \begin_layout Standard
38811 This shows the complete history of the SVN document.
38812  The output of
38813 \family typewriter
38814 svn log
38815 \begin_inset Quotes qld
38816 \end_inset
38817
38818 <file-name>
38819 \begin_inset Quotes qld
38820 \end_inset
38821
38822
38823 \family default
38824  is shown in a browser.
38825 \end_layout
38826
38827 \begin_layout Subsubsection
38828 File Locking
38829 \begin_inset CommandInset label
38830 LatexCommand label
38831 name "subsec:SVN-File-Locking"
38832
38833 \end_inset
38834
38835
38836 \end_layout
38837
38838 \begin_layout Standard
38839 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.
38840  When such a conflict happens it needs manual resolving and one reasonable alternative is to provide some kind of locking mechanism,
38841  which guarantees that only one user is allowed to edit file at the given time.
38842 \end_layout
38843
38844 \begin_layout Standard
38845 SVN has two such mechanisms to provide mutual exclusivity for file access – locks and automatic setting of write permissions (see sec.
38846
38847 \begin_inset CommandInset ref
38848 LatexCommand ref
38849 reference "subsec:Automatical-Locking-Property"
38850 nolink "false"
38851
38852 \end_inset
38853
38854 ) based on
38855 \begin_inset Flex Code
38856 status collapsed
38857
38858 \begin_layout Plain Layout
38859 svn:needs-lock
38860 \end_layout
38861
38862 \end_inset
38863
38864  file svn property
38865 \begin_inset Foot
38866 status collapsed
38867
38868 \begin_layout Plain Layout
38869 \begin_inset Flex URL
38870 status open
38871
38872 \begin_layout Plain Layout
38873
38874 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
38875 \end_layout
38876
38877 \end_inset
38878
38879
38880 \end_layout
38881
38882 \end_inset
38883
38884 .
38885  If this property is detected for a given document \SpecialChar LyX
38886  starts to use SVN locks for document editing automatically and the whole check-in/out mechanism switches to the same regimen as for RCS.
38887  This in particular means there are two different modes of file use in \SpecialChar LyX
38888 :
38889 \end_layout
38890
38891 \begin_layout Itemize
38892 Unlocked state.
38893  The loaded file is in the read-only mode.
38894  For editing on needs to check-out.
38895
38896 \emph on
38897 Check-out
38898 \emph default
38899  consists of updating from the repository and gaining write lock.
38900  If the lock is not possible to obtain,
38901  we remain in unlocked state.
38902 \end_layout
38903
38904 \begin_layout Itemize
38905 Locked state.
38906  The loaded file is in the
38907 \begin_inset Quotes els
38908 \end_inset
38909
38910 normal
38911 \begin_inset Quotes ers
38912 \end_inset
38913
38914  edit mode.
38915  No other user is allowed to edit the file.
38916
38917 \emph on
38918 Check-in
38919 \emph default
38920  consists of commiting changes and releasing write-lock.
38921  If no changes have been made to the document,
38922  no commit will be produced
38923 \begin_inset Foot
38924 status collapsed
38925
38926 \begin_layout Plain Layout
38927 Don't be puzzled by the fact that you will be asked for commit message anyway.
38928 \end_layout
38929
38930 \end_inset
38931
38932  and only the write-lock will be released.
38933 \end_layout
38934
38935 \begin_layout Standard
38936 SVN commands:
38937 \end_layout
38938
38939 \begin_layout Labeling
38940 \labelwidthstring 00.00.0000
38941 Check-in:
38942
38943 \family typewriter
38944  svn commit -q -m"<description>" "<file-name>"
38945 \begin_inset Newline newline
38946 \end_inset
38947
38948 svn unlock "<file-name>"
38949 \end_layout
38950
38951 \begin_layout Labeling
38952 \labelwidthstring 00.00.0000
38953 Check-out:
38954
38955 \family typewriter
38956 svn update "<file-name>"
38957 \begin_inset Newline newline
38958 \end_inset
38959
38960 svn lock "<file-name>"
38961 \end_layout
38962
38963 \begin_layout Subsubsection
38964
38965 \family typewriter
38966 \begin_inset CommandInset label
38967 LatexCommand label
38968 name "subsec:Automatical-Locking-Property"
38969
38970 \end_inset
38971
38972
38973 \family default
38974 Automatic Locking Property
38975 \end_layout
38976
38977 \begin_layout Standard
38978 The above mentioned automatic setting of write permissions of the .lyx file can be set through
38979 \family sans
38980  File\SpecialChar menuseparator
38981 Version
38982 \begin_inset space ~
38983 \end_inset
38984
38985 Control\SpecialChar menuseparator
38986 Use Locking Property
38987 \family default
38988 .
38989  This command is active only when the file is not locked on the svn server (i.e.
38990  you need to check-out before proceeding).
38991 \end_layout
38992
38993 \begin_layout Labeling
38994 \labelwidthstring 00.00.0000
38995 SVN
38996 \begin_inset space ~
38997 \end_inset
38998
38999 commands:
39000 \end_layout
39001
39002 \begin_layout Labeling
39003 \labelwidthstring 00.00.0000
39004 Set:
39005
39006 \family typewriter
39007  svn propset svn:needs-lock ON "<file-name>"
39008 \end_layout
39009
39010 \begin_layout Labeling
39011 \labelwidthstring 00.00.0000
39012 Unset:
39013
39014 \family typewriter
39015 svn propdel svn:needs-lock "<file-name>"
39016 \end_layout
39017
39018 \begin_layout Subsubsection
39019 \begin_inset CommandInset label
39020 LatexCommand label
39021 name "subsec:VCS-Revision-Information"
39022
39023 \end_inset
39024
39025 Revision Information in Documents
39026 \end_layout
39027
39028 \begin_layout Standard
39029 There are more possibilities how to activate revision information in our document.
39030 \end_layout
39031
39032 \begin_layout Itemize
39033 \SpecialChar LyX
39034  supports directly:
39035 \end_layout
39036
39037 \begin_deeper
39038 \begin_layout Itemize
39039 tree revision information (
39040 \begin_inset Flex Code
39041 status collapsed
39042
39043 \begin_layout Plain Layout
39044 vcs-tree-revision
39045 \end_layout
39046
39047 \end_inset
39048
39049 ).
39050  The result is the output of the
39051 \begin_inset Flex Code
39052 status collapsed
39053
39054 \begin_layout Plain Layout
39055 svnversion
39056 \end_layout
39057
39058 \end_inset
39059
39060  command,
39061  the following table gives you an idea,
39062  how to read the results.
39063 \end_layout
39064
39065 \begin_layout Standard
39066 \align center
39067 \begin_inset Tabular
39068 <lyxtabular version="3" rows="6" columns="2">
39069 <features tabularvalignment="middle">
39070 <column alignment="left" valignment="top">
39071 <column alignment="left" valignment="top">
39072 <row>
39073 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
39074 \begin_inset Text
39075
39076 \begin_layout Plain Layout
39077
39078 \series bold
39079 Output
39080 \end_layout
39081
39082 \end_inset
39083 </cell>
39084 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
39085 \begin_inset Text
39086
39087 \begin_layout Plain Layout
39088
39089 \series bold
39090 Meaning
39091 \end_layout
39092
39093 \end_inset
39094 </cell>
39095 </row>
39096 <row>
39097 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
39098 \begin_inset Text
39099
39100 \begin_layout Plain Layout
39101 4123:4168
39102 \end_layout
39103
39104 \end_inset
39105 </cell>
39106 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
39107 \begin_inset Text
39108
39109 \begin_layout Plain Layout
39110 mixed revision working copy
39111 \end_layout
39112
39113 \end_inset
39114 </cell>
39115 </row>
39116 <row>
39117 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
39118 \begin_inset Text
39119
39120 \begin_layout Plain Layout
39121 4168M
39122 \end_layout
39123
39124 \end_inset
39125 </cell>
39126 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
39127 \begin_inset Text
39128
39129 \begin_layout Plain Layout
39130 modified working copy
39131 \end_layout
39132
39133 \end_inset
39134 </cell>
39135 </row>
39136 <row>
39137 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
39138 \begin_inset Text
39139
39140 \begin_layout Plain Layout
39141 4123S
39142 \end_layout
39143
39144 \end_inset
39145 </cell>
39146 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
39147 \begin_inset Text
39148
39149 \begin_layout Plain Layout
39150 switched working copy
39151 \end_layout
39152
39153 \end_inset
39154 </cell>
39155 </row>
39156 <row>
39157 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
39158 \begin_inset Text
39159
39160 \begin_layout Plain Layout
39161 4123P
39162 \end_layout
39163
39164 \end_inset
39165 </cell>
39166 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
39167 \begin_inset Text
39168
39169 \begin_layout Plain Layout
39170 partial working copy,
39171  from a sparse checkout
39172 \end_layout
39173
39174 \end_inset
39175 </cell>
39176 </row>
39177 <row>
39178 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
39179 \begin_inset Text
39180
39181 \begin_layout Plain Layout
39182 4123:4168MS
39183 \end_layout
39184
39185 \end_inset
39186 </cell>
39187 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
39188 \begin_inset Text
39189
39190 \begin_layout Plain Layout
39191 mixed revision,
39192  modified,
39193  switched working copy
39194 \end_layout
39195
39196 \end_inset
39197 </cell>
39198 </row>
39199 </lyxtabular>
39200
39201 \end_inset
39202
39203
39204 \end_layout
39205
39206 \begin_layout Itemize
39207 file revision information.
39208  The result comes from parsing the output of
39209 \begin_inset Flex Code
39210 status collapsed
39211
39212 \begin_layout Plain Layout
39213 svn
39214 \begin_inset space ~
39215 \end_inset
39216
39217 info
39218 \begin_inset space ~
39219 \end_inset
39220
39221 --xml
39222 \begin_inset space ~
39223 \end_inset
39224
39225 file.lyx
39226 \end_layout
39227
39228 \end_inset
39229
39230 .
39231  Supported flags are:
39232 \end_layout
39233
39234 \begin_deeper
39235 \begin_layout Itemize
39236 version number of the last commit (
39237 \begin_inset Flex Code
39238 status collapsed
39239
39240 \begin_layout Plain Layout
39241 vcs-revision
39242 \end_layout
39243
39244 \end_inset
39245
39246 )
39247 \end_layout
39248
39249 \begin_layout Itemize
39250 author of the last commit (
39251 \begin_inset Flex Code
39252 status collapsed
39253
39254 \begin_layout Plain Layout
39255 vcs-author
39256 \end_layout
39257
39258 \end_inset
39259
39260 )
39261 \end_layout
39262
39263 \begin_layout Itemize
39264 date of the last commit (
39265 \begin_inset Flex Code
39266 status collapsed
39267
39268 \begin_layout Plain Layout
39269 vcs-date
39270 \end_layout
39271
39272 \end_inset
39273
39274 )
39275 \end_layout
39276
39277 \begin_layout Itemize
39278 time of the last commit (
39279 \begin_inset Flex Code
39280 status collapsed
39281
39282 \begin_layout Plain Layout
39283 vcs-time
39284 \end_layout
39285
39286 \end_inset
39287
39288 )
39289 \end_layout
39290
39291 \end_deeper
39292 \begin_layout Standard
39293 You can obtain this info via InsetInfo (
39294 \change_inserted 5863208 1564400022
39295
39296 \family sans
39297 Insert\SpecialChar menuseparator
39298 Field\SpecialChar menuseparator
39299 Version Control Revision
39300 \change_deleted 5863208 1564399852
39301
39302 \family default
39303 e.g.
39304
39305 \begin_inset Flex Code
39306 status collapsed
39307
39308 \begin_layout Plain Layout
39309 info-insert buffer vcs-date
39310 \end_layout
39311
39312 \end_inset
39313
39314
39315 \change_unchanged
39316 ).
39317  The information will be available only when you have the file stored under svn managment (i.e.
39318  the
39319 \begin_inset Flex Code
39320 status collapsed
39321
39322 \begin_layout Plain Layout
39323 .svn
39324 \end_layout
39325
39326 \end_inset
39327
39328  directory is available with your document).
39329 \end_layout
39330
39331 \end_deeper
39332 \begin_layout Itemize
39333 Another—
39334 a hacking one—
39335 possibility is to use svn keywords
39336 \begin_inset Foot
39337 status collapsed
39338
39339 \begin_layout Plain Layout
39340 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
39341 \end_layout
39342
39343 \end_inset
39344
39345 .
39346  In short – you set file keywords property (e.g.
39347
39348 \family sans
39349 svn propset svn:keywords 'Rev' file.lyx
39350 \family default
39351 ) and then paste keyword \SpecialChar TeX
39352  code
39353 \begin_inset Foot
39354 status collapsed
39355
39356 \begin_layout Plain Layout
39357 This is an easy way how to ensure that \SpecialChar LyX
39358  won't break the line in the middle of keyword tag.
39359 \end_layout
39360
39361 \end_inset
39362
39363  tag in your document (e.g.
39364
39365 \begin_inset Flex Code
39366 status collapsed
39367
39368 \begin_layout Plain Layout
39369 $Rev$
39370 \end_layout
39371
39372 \end_inset
39373
39374 ).
39375  This way svn client will automatically substitute revision number (e.g.
39376
39377 \begin_inset Flex Code
39378 status collapsed
39379
39380 \begin_layout Plain Layout
39381 $Rev:
39382  59 $
39383 \end_layout
39384
39385 \end_inset
39386
39387 ) after each update and commit.
39388  There are more problems with this approach.
39389  Firstly,
39390  the '$' character is used in \SpecialChar TeX
39391  world for math equations,
39392  so any occurence of math formula
39393 \begin_inset Formula $Rev$
39394 \end_inset
39395
39396  become
39397 \begin_inset Formula $Rev:59$
39398 \end_inset
39399
39400  in your \SpecialChar LyX
39401  document.
39402  Similarly for other keywords like Id,
39403  Date,
39404  Author,
39405  etc.
39406  Secondly svn output is dependent on your locales,
39407  so its very easy that svn would produce some problematic strings once Date is used.
39408  Thirdly you get the whole 'Rev:
39409  59' string in your document instead of the plain number.
39410  Until subversion implements user's custom keywords it will be hard to use this approach reliably or let \SpecialChar LyX
39411  to support it directly.
39412 \end_layout
39413
39414 \begin_layout Subsection
39415 SVN and Windows Environment
39416 \end_layout
39417
39418 \begin_layout Quote
39419 My inclination is to say that if the user cannot figure out the command line operations on their own fairly quickly,
39420  they would be well advised to use TortoiseSVN.
39421  —
39422 P.
39423  A.
39424  Rubin
39425 \end_layout
39426
39427 \begin_layout Subsubsection
39428 Preparation
39429 \end_layout
39430
39431 \begin_layout Standard
39432 In addition to installing \SpecialChar LyX
39433 ,
39434  and having access to a Subversion repository,
39435  the user will need to install the Subversion client program.
39436  A Windows installer for the client program is available from
39437 \begin_inset CommandInset href
39438 LatexCommand href
39439 name "CollabNet"
39440 target "http://www.collab.net/nonav/downloads/subversion/"
39441 literal "false"
39442
39443 \end_inset
39444
39445 .
39446  The user may also want to install
39447 \begin_inset CommandInset href
39448 LatexCommand href
39449 name "TortoiseSVN"
39450 target "http://tortoisesvn.tigris.org/"
39451 literal "false"
39452
39453 \end_inset
39454
39455 ,
39456  which integrates Subversion operations into the context (rightclick) menu of Windows Explorer.
39457  Operations done outside \SpecialChar LyX
39458  will typically be more convenient using the Explorer context menu.
39459  Note that TortoiseSVN is not a replacement for the client program,
39460  which is what \SpecialChar LyX
39461  itself will use.
39462 \end_layout
39463
39464 \begin_layout Subsubsection
39465 Bringing a document under Subversion control
39466 \end_layout
39467
39468 \begin_layout Standard
39469 Before a \SpecialChar LyX
39470  document can be brought under version control in Subversion,
39471  its parent directory needs to be under version control.
39472  If the document is being added to a project already in the repository,
39473  this is accomplished by checking the project out to the directory where the new document will be placed.
39474  If the project itself is not yet under version control (for instance,
39475  if this document starts a new project),
39476  the directory must be imported into the repository.
39477  This is done outside \SpecialChar LyX
39478 .
39479  Both import and checkout are easily accomplished from the Explorer context menu using TortoiseSVN,
39480  or alternatively can be done using the command line client at a DOS prompt.
39481  The procedure for importing the project using TortoiseSVN is described below,
39482  assuming an existing repository and a new project being started in
39483 \family typewriter
39484 C:
39485 \backslash
39486 new project
39487 \family default
39488 .
39489  For information on using the Subversion client program,
39490  run
39491 \family typewriter
39492 svn --help
39493 \family default
39494 in a DOS shell.
39495 \end_layout
39496
39497 \begin_layout Enumerate
39498 Locate
39499 \family typewriter
39500 C:
39501 \backslash
39502 new project
39503 \family default
39504 in Windows Explorer,
39505  right click it,
39506  and select
39507 \family sans
39508 TortoiseSVN\SpecialChar menuseparator
39509 Repo-browser
39510 \family default
39511 .
39512  If necessary,
39513  adjust the URL for the repository,
39514  then click OK.
39515 \end_layout
39516
39517 \begin_layout Enumerate
39518 Right click the level of the repository under which you want to place the new project folder (typically the top level) and click
39519 \family sans
39520 Create folder
39521 \family default
39522  Supply a name for the project folder and click OK.
39523  Add a message for the log file if desired,
39524  then click OK again.
39525  The new project folder should appear in the repository.
39526  Finally,
39527  click OK again to exit the repository browser.
39528 \end_layout
39529
39530 \begin_layout Enumerate
39531 Once again right click
39532 \family typewriter
39533 C:
39534 \backslash
39535 new project
39536 \family default
39537 ,
39538  this time selecting SVN Checkout\SpecialChar ldots
39539  Select the URL of the project folder you just created in the repository,
39540  and set the checkout directory to
39541 \family typewriter
39542 C:
39543 \backslash
39544 new project.
39545
39546 \family default
39547  Click OK.
39548  You will be warned about a non-empty folder;
39549  click OK to proceed.
39550  You should now have a
39551 \family typewriter
39552 .svn
39553 \family default
39554  directory under
39555 \family typewriter
39556 C:
39557 \backslash
39558 new project.
39559 \end_layout
39560
39561 \begin_layout Enumerate
39562 Create or open your document in \SpecialChar LyX
39563  and click
39564 \family sans
39565 File\SpecialChar menuseparator
39566 Version
39567 \begin_inset space ~
39568 \end_inset
39569
39570 Control\SpecialChar menuseparator
39571 Register.
39572
39573 \family default
39574 Add a log message and click OK to commit the document to version control.
39575 \end_layout
39576
39577 \begin_layout Standard
39578 From this point onward,
39579  you should have full functionality in the
39580 \family sans
39581 File\SpecialChar menuseparator
39582 Version
39583 \begin_inset space ~
39584 \end_inset
39585
39586 Control
39587 \family default
39588  menu.
39589  You also have the option of checking the document in and out,
39590  viewing its history,
39591  etc.
39592  using the TortoiseSVN context menu in Windows Explorer or the Subversion client program from a command prompt.
39593 \end_layout
39594
39595 \begin_layout Subsubsection
39596 SSH tunnel used with SVN under Windows
39597 \end_layout
39598
39599 \begin_layout Standard
39600 Compared with Linux setting up an svn client to communicate over ssh under Windows is a rather troublesome task.
39601  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,
39602  also be prepared for a great deal of frustration\SpecialChar ldots
39603
39604 \end_layout
39605
39606 \begin_layout Enumerate
39607 Get an svn client for windows,
39608  as described in the previous sections.
39609  When it is a fresh install run some svn command (e.g.
39610
39611 \begin_inset Flex Code
39612 status collapsed
39613
39614 \begin_layout Plain Layout
39615 svn --version
39616 \end_layout
39617
39618 \end_inset
39619
39620 ) to create config files,
39621  which you will need to change later on.
39622 \end_layout
39623
39624 \begin_layout Enumerate
39625 Choose an ssh client for Windows.
39626  There are several possibilities,
39627  we will use the one from Putty tools
39628 \begin_inset Foot
39629 status collapsed
39630
39631 \begin_layout Plain Layout
39632 \begin_inset Flex URL
39633 status collapsed
39634
39635 \begin_layout Plain Layout
39636
39637 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
39638 \end_layout
39639
39640 \end_inset
39641
39642
39643 \end_layout
39644
39645 \end_inset
39646
39647 .
39648  You will need to set the connection up so that the client doesn't ask for any password from you.
39649  To keep things easy we will use only keys without any additional password protection etc.
39650 \end_layout
39651
39652 \begin_deeper
39653 \begin_layout Enumerate
39654 Generate keys by
39655 \begin_inset Flex Code
39656 status collapsed
39657
39658 \begin_layout Plain Layout
39659 puttygen
39660 \end_layout
39661
39662 \end_inset
39663
39664 .
39665  Save your private .ppk key file and put the public one on the server side.
39666  If the SVN server runs on Linux,
39667  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
39668 \begin_inset Quotes eld
39669 \end_inset
39670
39671
39672 \emph on
39673 Public key for pasting into OpenSSH authorized_keys file
39674 \emph default
39675 :
39676 \begin_inset Quotes erd
39677 \end_inset
39678
39679  edit field into the server's
39680 \begin_inset Flex Code
39681 status collapsed
39682
39683 \begin_layout Plain Layout
39684 ~/.ssh/authorized_keys
39685 \end_layout
39686
39687 \end_inset
39688
39689  /
39690 \begin_inset Flex Code
39691 status collapsed
39692
39693 \begin_layout Plain Layout
39694 authorized_keys2
39695 \end_layout
39696
39697 \end_inset
39698
39699  file.
39700 \end_layout
39701
39702 \begin_layout Enumerate
39703 Get the Putty's
39704 \begin_inset Flex Code
39705 status collapsed
39706
39707 \begin_layout Plain Layout
39708 plink
39709 \end_layout
39710
39711 \end_inset
39712
39713 .
39714  In the SVN config file
39715 \begin_inset Foot
39716 status collapsed
39717
39718 \begin_layout Plain Layout
39719 Exact path depends on Windows version,
39720  usually somewhere around
39721 \begin_inset Flex Code
39722 status collapsed
39723
39724 \begin_layout Plain Layout
39725 c:
39726 \backslash
39727 Documents and Settings
39728 \backslash
39729 user
39730 \backslash
39731 Application Data
39732 \backslash
39733 Subversion
39734 \backslash
39735 config
39736 \end_layout
39737
39738 \end_inset
39739
39740  /
39741 \begin_inset Flex Code
39742 status collapsed
39743
39744 \begin_layout Plain Layout
39745 AppData
39746 \backslash
39747 Roaming
39748 \backslash
39749 Subversion
39750 \end_layout
39751
39752 \end_inset
39753
39754 .
39755 \end_layout
39756
39757 \end_inset
39758
39759 ,
39760  section [tunnels],
39761  setup ssh command,
39762  e.g.
39763
39764 \begin_inset Flex Code
39765 status collapsed
39766
39767 \begin_layout Plain Layout
39768 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
39769 \end_layout
39770
39771 \end_inset
39772
39773 .
39774 \begin_inset Foot
39775 status collapsed
39776
39777 \begin_layout Plain Layout
39778 It will usually take a lot of time to get exact command right and it depends on many things.
39779  For example do not have some remote server saved as a default session in Putty etc.
39780  If things fail,
39781  try to connect via plink without SVN first.
39782 \end_layout
39783
39784 \end_inset
39785
39786
39787 \end_layout
39788
39789 \end_deeper
39790 \begin_layout Enumerate
39791 Checkout the SVN archive,
39792  e.
39793 \begin_inset space \thinspace{}
39794 \end_inset
39795
39796 g.
39797 \begin_inset Newline newline
39798 \end_inset
39799
39800
39801 \begin_inset Flex Code
39802 status collapsed
39803
39804 \begin_layout Plain Layout
39805 svn co svn+ssh://user@server/repository_path
39806 \end_layout
39807
39808 \end_inset
39809
39810 .
39811 \end_layout
39812
39813 \begin_layout Subsubsection
39814 End-of-Line Conversions
39815 \end_layout
39816
39817 \begin_layout Standard
39818 When the collaborators are mixing Linux and Windows environments,
39819  \SpecialChar LyX
39820  will use different line endings inside the .lyx files.
39821  This is not a problem as far as \SpecialChar LyX
39822  functionality is concerned,
39823  but the commit diffs will be huge and merge-conflicts prone.
39824  Fortunately SVN itself knows
39825 \begin_inset Foot
39826 status collapsed
39827
39828 \begin_layout Plain Layout
39829 \begin_inset Flex URL
39830 status collapsed
39831
39832 \begin_layout Plain Layout
39833
39834 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
39835 \end_layout
39836
39837 \end_inset
39838
39839
39840 \end_layout
39841
39842 \end_inset
39843
39844  how to deal with CR/LF problems when switching .lyx files to the
39845 \begin_inset Flex Code
39846 status collapsed
39847
39848 \begin_layout Plain Layout
39849 native
39850 \end_layout
39851
39852 \end_inset
39853
39854  mode.
39855 \begin_inset Foot
39856 status collapsed
39857
39858 \begin_layout Plain Layout
39859 For the lazy guys:
39860
39861 \begin_inset Flex Code
39862 status collapsed
39863
39864 \begin_layout Plain Layout
39865 svn propset svn:eol-style native FILE_NAME
39866 \end_layout
39867
39868 \end_inset
39869
39870
39871 \end_layout
39872
39873 \end_inset
39874
39875
39876 \end_layout
39877
39878 \begin_layout Subsection
39879 GIT commands in \SpecialChar LyX
39880
39881 \end_layout
39882
39883 \begin_layout Standard
39884 A minimal subset of GIT commands is now supported by \SpecialChar LyX
39885 .
39886  You can find the commands in the
39887 \family sans
39888 File\SpecialChar menuseparator
39889 Version
39890 \begin_inset space ~
39891 \end_inset
39892
39893 Control
39894 \family default
39895  submenu.
39896  Please note that if you use password protected access to repository via ssh,
39897  you will be asked in terminal window.
39898  \SpecialChar LyX
39899  was tested against GIT 1.7.
39900 \begin_inset Foot
39901 status collapsed
39902
39903 \begin_layout Plain Layout
39904 Windows users please note that you need to ensure that git is on the path.
39905  This can be set from within \SpecialChar LyX
39906  at
39907 \family sans
39908 Tools\SpecialChar menuseparator
39909 Preferences\SpecialChar menuseparator
39910 Paths\SpecialChar menuseparator
39911 PATH prefix
39912 \family default
39913 .
39914 \end_layout
39915
39916 \end_inset
39917
39918
39919 \end_layout
39920
39921 \begin_layout Standard
39922 One big difference of GIT and the other supported version control systems is the distributed nature of GIT:
39923  With traditional version control systems there is one central server which hosts the repository.
39924  Users commit their changes to the server,
39925  and get updates made by other users from it.
39926  With GIT,
39927  users commit to a local repository.
39928  The local repository can be synchronized with one or more remote repositories using the
39929 \begin_inset Flex Code
39930 status collapsed
39931
39932 \begin_layout Plain Layout
39933 pull
39934 \end_layout
39935
39936 \end_inset
39937
39938  and
39939 \begin_inset Flex Code
39940 status collapsed
39941
39942 \begin_layout Plain Layout
39943 push
39944 \end_layout
39945
39946 \end_inset
39947
39948  GIT commands.
39949  \SpecialChar LyX
39950  does not interact in any way with remote GIT repositories.
39951  It works exclusively with the local repository in a very similar way as with a central CVS or SVN repository.
39952  If you use remote GIT repositories you need to do the
39953 \begin_inset Flex Code
39954 status collapsed
39955
39956 \begin_layout Plain Layout
39957 pull
39958 \end_layout
39959
39960 \end_inset
39961
39962  and
39963 \begin_inset Flex Code
39964 status collapsed
39965
39966 \begin_layout Plain Layout
39967 push
39968 \end_layout
39969
39970 \end_inset
39971
39972  operations with your favourite GIT client.
39973 \end_layout
39974
39975 \begin_layout Subsubsection
39976
39977 \family sans
39978 Register
39979 \end_layout
39980
39981 \begin_layout Standard
39982 If your document is not under revision control,
39983  this is the only item shown in the menu.
39984  And if it is under revision control,
39985  the
39986 \family sans
39987 Register
39988 \family default
39989  item is not visible.
39990 \end_layout
39991
39992 \begin_layout Standard
39993 This command registers in GIT your document ONLY in case you have already the documents directory under GIT control (in particular
39994 \family typewriter
39995 .git/index
39996 \family default
39997  file exists).
39998  This means you have to checkout the archive by yourself.
39999 \end_layout
40000
40001 \begin_layout Standard
40002 Then you are asked interactively to supply an initial description of the document.
40003  Don't forget that registered file is not yet committed.
40004 \end_layout
40005
40006 \begin_layout Standard
40007 GIT command that is run:
40008
40009 \family typewriter
40010 git add
40011 \begin_inset Quotes qld
40012 \end_inset
40013
40014 <file-name>
40015 \begin_inset Quotes qld
40016 \end_inset
40017
40018
40019 \end_layout
40020
40021 \begin_layout Standard
40022 Read
40023 \family typewriter
40024 man git
40025 \family default
40026  to understand the switches.
40027 \end_layout
40028
40029 \begin_layout Subsubsection
40030
40031 \family sans
40032 Check In Changes
40033 \end_layout
40034
40035 \begin_layout Standard
40036 When you are finished editing a file,
40037  you commit your changes.
40038  When you do this,
40039  you are asked for a description of the changes.
40040  After that changes are committed.
40041 \end_layout
40042
40043 \begin_layout Standard
40044 GIT command:
40045
40046 \family typewriter
40047 git commit -q -m"<description>" <file-name>
40048 \end_layout
40049
40050 \begin_layout Subsubsection
40051
40052 \family sans
40053 Revert To Repository Version
40054 \end_layout
40055
40056 \begin_layout Standard
40057 This will discard all changes made to the document since the last check in.
40058  You get a warning before changes are discarded.
40059 \end_layout
40060
40061 \begin_layout Standard
40062 GIT command:
40063
40064 \family typewriter
40065 git checkout -q
40066 \begin_inset Quotes qld
40067 \end_inset
40068
40069 <file-name>
40070 \begin_inset Quotes qld
40071 \end_inset
40072
40073
40074 \end_layout
40075
40076 \begin_layout Subsubsection
40077
40078 \family sans
40079 Rename
40080 \end_layout
40081
40082 \begin_layout Standard
40083 This will rename the current document including the version history.
40084  It requires a clean document without any changes since the last checkin.
40085  You are asked for a file name and a description of the rename operation.
40086  After that the document is renamed,
40087  both locally and in the repository.
40088  If the parent directories of the new and old file names differ,
40089  all relative paths of included files are adjusted (like in
40090 \family sans
40091 File\SpecialChar menuseparator
40092 Save As
40093 \family default
40094 \SpecialChar ldots
40095 ).
40096  Finally,
40097  the document is reloaded using the new name.
40098 \end_layout
40099
40100 \begin_layout Labeling
40101 \labelwidthstring 00.00.0000
40102 GIT
40103 \begin_inset space ~
40104 \end_inset
40105
40106 commands:
40107
40108 \begin_inset space ~
40109 \end_inset
40110
40111
40112 \begin_inset Newline newline
40113 \end_inset
40114
40115
40116 \begin_inset Flex Code
40117 status collapsed
40118
40119 \begin_layout Plain Layout
40120 git mv
40121 \family typewriter
40122
40123 \begin_inset Quotes qld
40124 \end_inset
40125
40126 <file-name>
40127 \begin_inset Quotes qld
40128 \end_inset
40129
40130
40131 \begin_inset Quotes qld
40132 \end_inset
40133
40134 <new-file-name>
40135 \begin_inset Quotes qld
40136 \end_inset
40137
40138
40139 \end_layout
40140
40141 \end_inset
40142
40143
40144 \begin_inset Newline newline
40145 \end_inset
40146
40147
40148 \begin_inset Flex Code
40149 status collapsed
40150
40151 \begin_layout Plain Layout
40152 git commit
40153 \end_layout
40154
40155 \end_inset
40156
40157
40158 \end_layout
40159
40160 \begin_layout Subsubsection
40161
40162 \family sans
40163 Show History
40164 \end_layout
40165
40166 \begin_layout Standard
40167 This shows the complete history of the GIT document.
40168  The output of
40169 \family typewriter
40170 git log
40171 \begin_inset Quotes qld
40172 \end_inset
40173
40174 <file-name>
40175 \begin_inset Quotes qld
40176 \end_inset
40177
40178
40179 \family default
40180  is shown in a browser.
40181 \end_layout
40182
40183 \begin_layout Subsubsection
40184 Version Info
40185 \end_layout
40186
40187 \begin_layout Standard
40188 \SpecialChar LyX
40189  supports GIT hash number of the last commit to the file,
40190
40191 \change_inserted 1119979965 1564297456
40192 its abbreviated form,
40193
40194 \change_unchanged
40195 author name,
40196  date and time of last commit.
40197  All those are extracted from
40198 \family typewriter
40199 git log -n 1 --pretty=format:%H%n
40200 \change_inserted 1119979965 1564297427
40201 %h%n
40202 \change_unchanged
40203 %an%n%ai
40204 \family default
40205 .
40206  Tree version information is obtained via
40207 \family typewriter
40208 git describe --abbrev --dirty --long
40209 \family default
40210 .
40211  See
40212 \begin_inset CommandInset ref
40213 LatexCommand ref
40214 reference "subsec:VCS-Revision-Information"
40215 nolink "false"
40216
40217 \end_inset
40218
40219  for other details.
40220 \end_layout
40221
40222 \begin_layout Subsection
40223 Further tuning
40224 \end_layout
40225
40226 \begin_layout Standard
40227 With the recent addition of the
40228 \begin_inset Flex Code
40229 status collapsed
40230
40231 \begin_layout Plain Layout
40232 vc-command
40233 \end_layout
40234
40235 \end_inset
40236
40237  function \SpecialChar LyX
40238  power users are allowed to create their own commands for revision control.
40239 \end_layout
40240
40241 \begin_layout Standard
40242 As an example you can see how two TortoiseSVN commands could be integrated directly:
40243 \end_layout
40244
40245 \begin_layout Description
40246 Commit:
40247
40248 \begin_inset Flex Code
40249 status collapsed
40250
40251 \begin_layout Plain Layout
40252 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
40253 \end_layout
40254
40255 \end_inset
40256
40257
40258 \end_layout
40259
40260 \begin_layout Description
40261 Revert:
40262
40263 \begin_inset Flex Code
40264 status collapsed
40265
40266 \begin_layout Plain Layout
40267 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
40268 \end_layout
40269
40270 \end_inset
40271
40272
40273 \end_layout
40274
40275 \begin_layout Subsection
40276 Version control and Document comparison
40277 \end_layout
40278
40279 \begin_layout Standard
40280 One of the typical uses of version control is to inspect the changes between revisions,
40281  usually by creating
40282 \begin_inset Flex Code
40283 status collapsed
40284
40285 \begin_layout Plain Layout
40286 diff
40287 \end_layout
40288
40289 \end_inset
40290
40291  dumps.
40292  While this is useful for plain text files,
40293  it is much less useful in the case of \SpecialChar LyX
40294  files,
40295  which have more a complicated structure.
40296  Hence we provide binding to the Document comparison feature.
40297  There are two ways of calling this feature – either by direct call of
40298 \begin_inset Flex Code
40299 status collapsed
40300
40301 \begin_layout Plain Layout
40302 vc-compare
40303 \end_layout
40304
40305 \end_inset
40306
40307  \SpecialChar LyX
40308  function (for details see \SpecialChar LyX
40309  functions manual) or by the toolbar icon
40310 \begin_inset Info
40311 type  "icon"
40312 arg   "vc-compare"
40313 \end_inset
40314
40315  or the menu item
40316 \begin_inset Info
40317 type  "menu"
40318 arg   "vc-compare"
40319 \end_inset
40320
40321 ,
40322  respectively.
40323  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 '
40324 \begin_inset Flex Noun
40325 status collapsed
40326
40327 \begin_layout Plain Layout
40328 0
40329 \end_layout
40330
40331 \end_inset
40332
40333 ' revisions back means comparison of the edited file with last commited revision).
40334
40335 \end_layout
40336
40337 \begin_layout Standard
40338 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,
40339  numbers always point to the last number in RCS revision number,
40340  i.e.
40341  '35' in '1.2.35'.
40342  We don't currently support GIT addressing of revisions,
40343  one can just compare edited document with its revision X steps backs,
40344  where X is addressed as
40345 \begin_inset Flex Code
40346 status collapsed
40347
40348 \begin_layout Plain Layout
40349 HEAD~X
40350 \end_layout
40351
40352 \end_inset
40353
40354 .
40355 \end_layout
40356
40357 \begin_layout Section
40358
40359 \change_inserted 564990737 1672161575
40360 \begin_inset CommandInset label
40361 LatexCommand label
40362 name "sec:Literate-Programming"
40363
40364 \end_inset
40365
40366
40367 \change_unchanged
40368 Literate Programming
40369 \end_layout
40370
40371 \begin_layout Standard
40372 Updated by
40373 \noun on
40374 Kayvan Sylvan
40375 \noun default
40376 (kayvan@sylvan.com)
40377 \noun on
40378 ,
40379
40380 \noun default
40381 original documentation written by
40382 \noun on
40383 Edmar Wienskoski Jr.
40384
40385 \noun default
40386  (edmar-w-jr@technologist.com)
40387 \end_layout
40388
40389 \begin_layout Subsection
40390 Introduction
40391 \end_layout
40392
40393 \begin_layout Standard
40394 The main purpose of this documentation is to show you how to use \SpecialChar LyX
40395  for literate programming,
40396  where it is assumed that you are familiar with this programming technique,
40397  and know what
40398 \begin_inset Quotes eld
40399 \end_inset
40400
40401 tangling
40402 \begin_inset Quotes erd
40403 \end_inset
40404
40405  and
40406 \begin_inset Quotes eld
40407 \end_inset
40408
40409 weaving
40410 \begin_inset Quotes erd
40411 \end_inset
40412
40413  means.
40414  If that is not the case,
40415  please follow the web links provided in the following sections.
40416  There is a lot of good documentation out there covering old development history to the latest tools tips.
40417 \end_layout
40418
40419 \begin_layout Standard
40420 It is also assumed that you are familiar with \SpecialChar LyX
40421  itself to a point that you are comfortable changing your \SpecialChar LyX
40422  preferences,
40423  and X resources file.
40424  If that is not the case please refer to other \SpecialChar LyX
40425  documentation to cover your specific needs.
40426 \end_layout
40427
40428 \begin_layout Subsection
40429 Literate Programming
40430 \end_layout
40431
40432 \begin_layout Standard
40433 From the Literate Programming FAQ:
40434
40435 \end_layout
40436
40437 \begin_layout Quotation
40438 Literate programming is the combination of documentation and source together in a fashion suited for reading by human beings.
40439  In fact,
40440  literate programs should be enjoyable reading,
40441  even inviting!
40442  (Sorry Bob,
40443  I couldn't resist!) In general,
40444  literate programs combine source and documentation in a single file.
40445  Literate programming tools then parse the file to produce either readable documentation or compilable source.
40446  The WEB style of literate programming was created by D.
40447 \begin_inset space \thinspace{}
40448 \end_inset
40449
40450 E.
40451  Knuth during the development of his \SpecialChar TeX
40452  typesetting software.
40453
40454 \end_layout
40455
40456 \begin_layout Standard
40457 Another excerpt says:
40458 \end_layout
40459
40460 \begin_layout Quotation
40461
40462 \emph on
40463 How is literate programming different from verbose commenting?
40464 \end_layout
40465
40466 \begin_layout Quotation
40467 There are three distinguishing characteristics.
40468  In order of importance,
40469  they are:
40470
40471 \end_layout
40472
40473 \begin_deeper
40474 \begin_layout Itemize
40475 flexible order of elaboration
40476 \end_layout
40477
40478 \begin_layout Itemize
40479 automatic support for browsing
40480 \end_layout
40481
40482 \begin_layout Itemize
40483 typeset documentation,
40484  especially diagrams and mathematics
40485 \end_layout
40486
40487 \end_deeper
40488 \begin_layout Standard
40489 Now that I sparked your curiosity,
40490  take a look in the references.
40491 \end_layout
40492
40493 \begin_layout Subsubsection
40494 References
40495 \end_layout
40496
40497 \begin_layout Standard
40498 The complete Literate Programming FAQ can be found at:
40499 \end_layout
40500
40501 \begin_layout Quote
40502 Literate Programming FAQ
40503 \begin_inset Flex URL
40504 status open
40505
40506 \begin_layout Plain Layout
40507
40508 http://www.literateprogramming.com/lpfaq.pdf
40509 \end_layout
40510
40511 \end_inset
40512
40513
40514 \end_layout
40515
40516 \begin_layout Standard
40517 The FAQ lists 23 (twenty three!) different literate programming tools.
40518  Where some are specialized or
40519 \begin_inset Quotes eld
40520 \end_inset
40521
40522 tailored
40523 \begin_inset Quotes erd
40524 \end_inset
40525
40526  for particular programming languages,
40527  while other have general scope.
40528  I selected
40529 \noun on
40530 Noweb
40531 \noun default
40532  for my own use for several reasons:
40533 \end_layout
40534
40535 \begin_layout Itemize
40536 It can generate the documentation either in \SpecialChar LaTeX
40537  or HTML.
40538 \end_layout
40539
40540 \begin_layout Itemize
40541 It has a open architecture,
40542  i.
40543 \begin_inset space \thinspace{}
40544 \end_inset
40545
40546 e.
40547 \begin_inset space \space{}
40548 \end_inset
40549
40550 it is easy to plug in new filters
40551 \begin_inset Foot
40552 status collapsed
40553
40554 \begin_layout Plain Layout
40555
40556 \emph on
40557 Filters
40558 \emph default
40559 are programs that read a given data stream and output a manipulated data stream.
40560  That way,
40561  a WEB file (consisting of literate code) can be turned into a file consisting only of C program code or \SpecialChar LaTeX
40562  code.
40563 \end_layout
40564
40565 \end_inset
40566
40567  and to perform special processing that you may need.
40568
40569 \end_layout
40570
40571 \begin_layout Itemize
40572 There is a good selection of filters available already (the HTML is one of them).
40573 \end_layout
40574
40575 \begin_layout Itemize
40576 It is free.
40577 \end_layout
40578
40579 \begin_layout Standard
40580 The Noweb web page can be found at:
40581
40582 \end_layout
40583
40584 \begin_layout Quote
40585 Noweb home page
40586 \begin_inset Flex URL
40587 status collapsed
40588
40589 \begin_layout Plain Layout
40590
40591 https://www.cs.tufts.edu/~nr/noweb/
40592 \end_layout
40593
40594 \end_inset
40595
40596
40597 \end_layout
40598
40599 \begin_layout Standard
40600 Starting from there you can reach many other interesting links and even some literate program examples.
40601 \end_layout
40602
40603 \begin_layout Subsection
40604 \SpecialChar LyX
40605  and Literate Programming with Noweb
40606 \end_layout
40607
40608 \begin_layout Standard
40609 The \SpecialChar LyX
40610  support for Literate Programming is provided by using the generic \SpecialChar LyX
40611  converters mechanism.
40612  This support is provided in a
40613 \begin_inset Quotes eld
40614 \end_inset
40615
40616 Noweb independent
40617 \begin_inset Quotes erd
40618 \end_inset
40619
40620  way,
40621  i.
40622 \begin_inset space \thinspace{}
40623 \end_inset
40624
40625 e.
40626 \begin_inset space \space{}
40627 \end_inset
40628
40629 you will be able to use this new \SpecialChar LyX
40630  feature with some other literate programming tool of your choice by just changing your \SpecialChar LyX
40631  preferences.
40632 \end_layout
40633
40634 \begin_layout Subsubsection
40635 Generating documents and code (weaving and tangling)
40636 \end_layout
40637
40638 \begin_layout Paragraph
40639 Using the noweb module
40640 \end_layout
40641
40642 \begin_layout Standard
40643 If you have installed Noweb and \SpecialChar LyX
40644  successfully,
40645  whenever you open a new document,
40646  after you have chosen its document class,
40647  use the
40648 \family sans
40649 Document\SpecialChar menuseparator
40650 Settings
40651 \family default
40652  menu to add the
40653 \begin_inset Quotes eld
40654 \end_inset
40655
40656 noweb
40657 \begin_inset Quotes erd
40658 \end_inset
40659
40660  module.
40661  If Noweb is correctly installed,
40662  when you click on the
40663 \begin_inset Quotes eld
40664 \end_inset
40665
40666 Modules
40667 \begin_inset Quotes erd
40668 \end_inset
40669
40670  link,
40671  you will see the
40672 \begin_inset Quotes eld
40673 \end_inset
40674
40675 noweb
40676 \begin_inset Quotes erd
40677 \end_inset
40678
40679  module in the available list and you can add it to your document.
40680 \end_layout
40681
40682 \begin_layout Paragraph
40683 Typing code in
40684 \end_layout
40685
40686 \begin_layout Standard
40687 \SpecialChar LyX
40688  enables you to write code with a custom inset named
40689 \begin_inset Flex Noun
40690 status collapsed
40691
40692 \begin_layout Plain Layout
40693 Chunk
40694 \end_layout
40695
40696 \end_inset
40697
40698 .
40699  Noweb delimits chunks like this:
40700 \end_layout
40701
40702 \begin_layout LyX-Code
40703 <<My code>>=
40704 \end_layout
40705
40706 \begin_layout LyX-Code
40707   code
40708 \end_layout
40709
40710 \begin_layout LyX-Code
40711   more code
40712 \end_layout
40713
40714 \begin_layout LyX-Code
40715   even more code
40716 \end_layout
40717
40718 \begin_layout LyX-Code
40719   @
40720 \end_layout
40721
40722 \begin_layout Standard
40723 The problem is that whatever is written in between the << and the
40724 \family typewriter
40725 @
40726 \family default
40727  must be taken literally,
40728  i.
40729 \begin_inset space \thinspace{}
40730 \end_inset
40731
40732 e.
40733 \begin_inset space \space{}
40734 \end_inset
40735
40736 \SpecialChar LyX
40737  should be prevented from making any special interpretation of what has been written.
40738  This is also handled by
40739 \begin_inset Flex Noun
40740 status collapsed
40741
40742 \begin_layout Plain Layout
40743 Chunk
40744 \end_layout
40745
40746 \end_inset
40747
40748 ,
40749  that works like a normal text inset but has a free spacing capability.
40750 \end_layout
40751
40752 \begin_layout Standard
40753 As a special note,
40754  you can also use the
40755 \begin_inset Quotes eld
40756 \end_inset
40757
40758 %def
40759 \begin_inset Quotes erd
40760 \end_inset
40761
40762  construct of Noweb in your chunks to add items to Noweb's identifier cross-reference:
40763 \end_layout
40764
40765 \begin_layout LyX-Code
40766 <<My chunk>>=
40767 \end_layout
40768
40769 \begin_layout LyX-Code
40770 def some_function(args):
40771 \end_layout
40772
40773 \begin_layout LyX-Code
40774    "This is the doc string for this function."
40775 \end_layout
40776
40777 \begin_layout LyX-Code
40778    print "My args:
40779  ",
40780  args
40781 \end_layout
40782
40783 \begin_layout LyX-Code
40784 @ %def some_function
40785 \end_layout
40786
40787 \begin_layout Standard
40788 For an example of this usage and the resulting cross-reference output,
40789  look at the Literate python program in
40790 \emph on
40791 LIBDIR/examples/listerrors.lyx
40792 \emph default
40793  which should make this all clear.
40794 \end_layout
40795
40796 \begin_layout Paragraph
40797 Generating the documentation
40798 \end_layout
40799
40800 \begin_layout Standard
40801 At this point you already have a new document file with a proper document class,
40802  and with some code and text on it.
40803  How do I print it?
40804  The answer is simple,
40805  you select
40806 \family sans
40807 View\SpecialChar menuseparator
40808 DVI,
40809
40810 \family default
40811  etc.
40812  Just like you would do for a plain document.
40813  No special procedure is required.
40814 \end_layout
40815
40816 \begin_layout Standard
40817 To help orientate you,
40818  I will now explain what happens inside \SpecialChar LyX
40819 :
40820 \end_layout
40821
40822 \begin_layout Enumerate
40823 When the
40824 \family sans
40825 Update\SpecialChar menuseparator
40826 DVI
40827 \family default
40828  menu option is chosen,
40829  a \SpecialChar LaTeX
40830  file is generated.
40831
40832 \end_layout
40833
40834 \begin_deeper
40835 \begin_layout Standard
40836 If the document is of any literate class the generated file will be named with an extension name defined by the
40837 \begin_inset Quotes eld
40838 \end_inset
40839
40840 literate
40841 \begin_inset Quotes erd
40842 \end_inset
40843
40844  format (defined in the Preferences panel),
40845  otherwise the file will have the usual
40846 \family typewriter
40847 .tex
40848 \family default
40849  extension.
40850 \end_layout
40851
40852 \end_deeper
40853 \begin_layout Enumerate
40854 Note that the only difference so far is in the name of the file,
40855  no special processing is required by \SpecialChar LyX
40856 .
40857  Given that you formatted the code using the
40858 \begin_inset Flex Noun
40859 status collapsed
40860
40861 \begin_layout Plain Layout
40862 Chunk
40863 \end_layout
40864
40865 \end_inset
40866
40867  inset that,
40868  by itself,
40869  takes care of the business.
40870 \end_layout
40871
40872 \begin_layout Enumerate
40873 If the document is of any literate class \SpecialChar LyX
40874  will then use the internal \SpecialChar LyX
40875  to Noweb converter,
40876  followed by the Noweb to \SpecialChar LaTeX
40877  converter
40878 \begin_inset Foot
40879 status collapsed
40880
40881 \begin_layout Plain Layout
40882 The converters are defined in the
40883 \family sans
40884 Tools\SpecialChar menuseparator
40885 Preferences
40886 \family default
40887  panel,
40888  under the
40889 \begin_inset Quotes eld
40890 \end_inset
40891
40892 Conversion
40893 \begin_inset Quotes erd
40894 \end_inset
40895
40896  tab.
40897  See section
40898 \emph on
40899 Converters
40900 \emph default
40901  of the
40902 \emph on
40903 Customization
40904 \emph default
40905  manual for general information about converters.
40906 \end_layout
40907
40908 \end_inset
40909
40910  to generate the \SpecialChar LaTeX
40911  file.
40912 \end_layout
40913
40914 \begin_deeper
40915 \begin_layout Standard
40916 Otherwise it will just skip this step.
40917 \end_layout
40918
40919 \end_deeper
40920 \begin_layout Enumerate
40921 Finally,
40922  \SpecialChar LaTeX
40923  is invoked and the regular post processing continues as in a plain document.
40924 \end_layout
40925
40926 \begin_layout Standard
40927 Independence from a particular
40928 \begin_inset Quotes eld
40929 \end_inset
40930
40931 literate tool
40932 \begin_inset Quotes erd
40933 \end_inset
40934
40935  is easily achieved by changing the commands that are run by the various converters.
40936 \end_layout
40937
40938 \begin_layout Paragraph
40939 Generating the code
40940 \end_layout
40941
40942 \begin_layout Standard
40943 When the build menu option is chosen or the corresponding button in the toolbar is pressed,
40944  a \SpecialChar LaTeX
40945  file is generated just like step 1 above.
40946  Next,
40947  \SpecialChar LyX
40948  invokes the
40949 \family typewriter
40950 Noweb->Program
40951 \family default
40952  converter.
40953  This converter needs to be defined by the user and is not installed by default,
40954  though the Program format is.
40955  This converter (like any other converter) will have two parts:
40956 \end_layout
40957
40958 \begin_layout Enumerate
40959 The converter program itself.
40960  This program performs the conversion from the one format to the other (in this case,
40961  from the Noweb format to the Program pseudo-format).
40962 \end_layout
40963
40964 \begin_layout Enumerate
40965 The error log parser.
40966  This is a program whose sole purpose is to rewrite error messages in a format that \SpecialChar LyX
40967  understands.
40968  This makes it possible for \SpecialChar LyX
40969  to place error boxes in the right places in the file buffer.
40970 \end_layout
40971
40972 \begin_layout Standard
40973 The first part,
40974  the
40975 \begin_inset Quotes eld
40976 \end_inset
40977
40978 Converter
40979 \begin_inset Quotes erd
40980 \end_inset
40981
40982  setting,
40983  should be set to
40984 \end_layout
40985
40986 \begin_layout LyX-Code
40987
40988 \family typewriter
40989 build-script $$i
40990 \family default
40991  $$r
40992 \end_layout
40993
40994 \begin_layout Standard
40995 This basically means that \SpecialChar LyX
40996  will call
40997 \begin_inset Quotes eld
40998 \end_inset
40999
41000 build-script
41001 \begin_inset Quotes erd
41002 \end_inset
41003
41004  (a program or script) with the name of the Noweb file (normally a file in the \SpecialChar LyX
41005  temp directory) and the directory path of the original \SpecialChar LyX
41006  file.
41007
41008 \end_layout
41009
41010 \begin_layout Standard
41011 This is an implementation of
41012 \begin_inset Quotes eld
41013 \end_inset
41014
41015 build-script
41016 \begin_inset Quotes erd
41017 \end_inset
41018
41019  that you can place in a directory on your path:
41020 \end_layout
41021
41022 \begin_layout LyX-Code
41023
41024 \family sans
41025 #!/bin/sh
41026 \end_layout
41027
41028 \begin_layout LyX-Code
41029
41030 \family sans
41031 #
41032 \end_layout
41033
41034 \begin_layout LyX-Code
41035
41036 \family sans
41037 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
41038 \end_layout
41039
41040 \begin_layout Standard
41041 The next part of the converter setting is the
41042 \begin_inset Quotes eld
41043 \end_inset
41044
41045 Flags
41046 \begin_inset Quotes erd
41047 \end_inset
41048
41049  which is to be set to
41050 \end_layout
41051
41052 \begin_layout LyX-Code
41053
41054 \family typewriter
41055 parselog=$$s/scripts/listerrors
41056 \end_layout
41057
41058 \begin_layout Standard
41059 This will run any errors that are generated by the
41060 \begin_inset Quotes eld
41061 \end_inset
41062
41063 build-script
41064 \begin_inset Quotes erd
41065 \end_inset
41066
41067  process through the
41068 \begin_inset Quotes eld
41069 \end_inset
41070
41071 listerrors
41072 \begin_inset Quotes erd
41073 \end_inset
41074
41075  program.
41076 \end_layout
41077
41078 \begin_layout Standard
41079 The build will normally take place in \SpecialChar LyX
41080 's temporary directory,
41081  so the files produced by the conversion will be in that directory.
41082  \SpecialChar LyX
41083  will copy out what it regards as the `main' file,
41084  but the
41085 \family typewriter
41086 Noweb->Program
41087 \family default
41088  conversion may produce several files,
41089  and so most of these would then be deleted when \SpecialChar LyX
41090  was closed.
41091  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.
41092 \end_layout
41093
41094 \begin_layout Paragraph
41095 Build instructions in the document
41096 \end_layout
41097
41098 \begin_layout Standard
41099 The last piece of the integration between \SpecialChar LyX
41100  and noweb is the
41101 \begin_inset Quotes eld
41102 \end_inset
41103
41104 build-script
41105 \begin_inset Quotes erd
41106 \end_inset
41107
41108  chunk.
41109  Generally,
41110  the instructions for building your program should be embedded in a chunk of its own.
41111  The noweb-specific
41112 \begin_inset Quotes eld
41113 \end_inset
41114
41115 build-script
41116 \begin_inset Quotes erd
41117 \end_inset
41118
41119  above uses the notangle command to look for this chunk (called
41120 \begin_inset Quotes eld
41121 \end_inset
41122
41123 build-script
41124 \begin_inset Quotes erd
41125 \end_inset
41126
41127 ) and runs its contents through
41128 \begin_inset Quotes eld
41129 \end_inset
41130
41131 sh
41132 \begin_inset Quotes erd
41133 \end_inset
41134
41135 .
41136 \end_layout
41137
41138 \begin_layout Standard
41139 Typically,
41140  such a chunk would look something like this:
41141 \end_layout
41142
41143 \begin_layout LyX-Code
41144 <<build-script>>=
41145 \end_layout
41146
41147 \begin_layout LyX-Code
41148 #!/bin/sh
41149 \begin_inset Newline newline
41150 \end_inset
41151
41152 if [ -z "${NOWEB_SOURCE}" ]
41153 \begin_inset Newline newline
41154 \end_inset
41155
41156 then
41157 \end_layout
41158
41159 \begin_layout LyX-Code
41160 NOWEB_SOURCE=myfile.nw
41161 \begin_inset Newline newline
41162 \end_inset
41163
41164 fi
41165 \begin_inset Newline newline
41166 \end_inset
41167
41168 [...
41169  code to extract files ...
41170  use NOWEB_OUTPUT_DIR here ...]
41171 \begin_inset Newline newline
41172 \end_inset
41173
41174 [...
41175  code to compile files ...]
41176 \begin_inset Newline newline
41177 \end_inset
41178
41179 @
41180 \end_layout
41181
41182 \begin_layout Standard
41183 Look in
41184 \change_deleted 564990737 1672161716
41185
41186 \emph on
41187 LIBDIR/examples/listerrors.lyx
41188 \emph default
41189  or in
41190 \emph on
41191 LIBDIR/examples/Literate.lyx
41192 \change_inserted 564990737 1672161716
41193
41194 \family sans
41195 \emph default
41196 File\SpecialChar menuseparator
41197 Open Example\SpecialChar menuseparator
41198 Modules\SpecialChar menuseparator
41199 Noweb Listerrors
41200 \change_unchanged
41201
41202 \family default
41203
41204 \change_inserted -712698321 1674917096
41205 or in
41206 \family sans
41207 File\SpecialChar menuseparator
41208 Open Example\SpecialChar menuseparator
41209 Modules\SpecialChar menuseparator
41210 Noweb2LyX
41211 \family default
41212
41213 \change_unchanged
41214 which implement
41215 \change_deleted 564990737 1672161729
41216 two
41217 \change_unchanged
41218 versions of the
41219 \begin_inset Quotes eld
41220 \end_inset
41221
41222 listerrors
41223 \begin_inset Quotes erd
41224 \end_inset
41225
41226  program for some illustrations of how all of these pieces go together
41227 \change_deleted -712698321 1674917093
41228 or in
41229 \change_deleted 564990737 1672161756
41230
41231 \emph on
41232 LIBDIR/examples/noweb2lyx.lyx
41233 \change_deleted -712698321 1674917093
41234
41235 \family sans
41236 \emph default
41237 File\SpecialChar menuseparator
41238 Open Example\SpecialChar menuseparator
41239 Modules\SpecialChar menuseparator
41240 Noweb2\SpecialChar LyX
41241
41242 \change_unchanged
41243
41244 \family default
41245 \emph on
41246 .
41247
41248 \emph default
41249  Interestingly,
41250  these
41251 \change_deleted 564990737 1672161767
41252 three
41253 \change_unchanged
41254 files show off the language-indepence of the \SpecialChar LyX
41255  literate programming support since they are written in Python
41256 \change_deleted 564990737 1672161782
41257 ,
41258  C
41259 \change_unchanged
41260  and Perl respectively.
41261 \end_layout
41262
41263 \begin_layout Subsubsection
41264 Configuring \SpecialChar LyX
41265
41266 \end_layout
41267
41268 \begin_layout Standard
41269 All the Literate Programming support is configured by the
41270 \family sans
41271 Tools\SpecialChar menuseparator
41272 Preferences
41273 \family default
41274  panel in the
41275 \begin_inset Quotes eld
41276 \end_inset
41277
41278 File Handling
41279 \begin_inset Quotes erd
41280 \end_inset
41281
41282  tab.
41283  The important parts are:
41284 \end_layout
41285
41286 \begin_layout Description
41287 the
41288 \begin_inset space ~
41289 \end_inset
41290
41291
41292 \begin_inset Quotes eld
41293 \end_inset
41294
41295 NoWeb
41296 \begin_inset Quotes erd
41297 \end_inset
41298
41299
41300 \begin_inset space ~
41301 \end_inset
41302
41303 format Set up via the File Formats tab,
41304  this is where the Noweb-specific pieces are set up.
41305  The
41306 \family sans
41307 GUI Name
41308 \family default
41309  is set to
41310 \family typewriter
41311 NoWeb
41312 \family default
41313 ,
41314  the file extension is set to
41315 \family typewriter
41316 .nw
41317 \family default
41318 .
41319  This tells \SpecialChar LyX
41320  to create a file with a
41321 \family typewriter
41322 .nw
41323 \family default
41324  extension in the first step of the conversion process.
41325 \end_layout
41326
41327 \begin_layout Description
41328 the
41329 \begin_inset space ~
41330 \end_inset
41331
41332
41333 \family sans
41334 Program
41335 \family default
41336
41337 \begin_inset space ~
41338 \end_inset
41339
41340 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).
41341 \end_layout
41342
41343 \begin_layout Description
41344
41345 \family sans
41346 NoWeb
41347 \family default
41348 ->
41349 \family sans
41350 \SpecialChar LaTeX
41351
41352 \family default
41353  This converter performs the
41354 \begin_inset Quotes eld
41355 \end_inset
41356
41357 weaving
41358 \begin_inset Quotes erd
41359 \end_inset
41360
41361  of the literate document.
41362  For Noweb,
41363  it is set to
41364 \begin_inset Quotes eld
41365 \end_inset
41366
41367
41368 \family typewriter
41369 noweave -delay -index $$i > $$o
41370 \family default
41371
41372 \begin_inset Quotes erd
41373 \end_inset
41374
41375
41376 \end_layout
41377
41378 \begin_layout Description
41379
41380 \family sans
41381 NoWeb
41382 \family default
41383 ->
41384 \family sans
41385 Program
41386 \family default
41387  This performs the
41388 \begin_inset Quotes eld
41389 \end_inset
41390
41391 tangling step
41392 \begin_inset Quotes erd
41393 \end_inset
41394
41395 .
41396  As stated above,
41397  the Converter is set to
41398 \begin_inset Quotes eld
41399 \end_inset
41400
41401
41402 \family typewriter
41403 build-script $$i
41404 \family default
41405  $$r
41406 \begin_inset Quotes erd
41407 \end_inset
41408
41409 ,
41410  with Flags set to
41411 \begin_inset Newline newline
41412 \end_inset
41413
41414
41415 \begin_inset Quotes eld
41416 \end_inset
41417
41418
41419 \family typewriter
41420 parselog=$$s/scripts/listerrors
41421 \family default
41422
41423 \begin_inset Quotes erd
41424 \end_inset
41425
41426 .
41427 \end_layout
41428
41429 \begin_layout Subsubsection
41430 Debug extensions
41431 \end_layout
41432
41433 \begin_layout Standard
41434 There is also a new function implemented in the \SpecialChar LyX
41435  server,
41436  the
41437 \begin_inset Quotes eld
41438 \end_inset
41439
41440 server-goto-file-row" function,
41441  to be used with ddd/gdb or other debugger.
41442
41443 \end_layout
41444
41445 \begin_layout Standard
41446 When debugging code with ddd/gdb,
41447  it is possible to invoke a text editor at the current execution position with a single key stroke.
41448  The default ddd configuration for that is shift-ctrl-V.
41449  It happens that you can define the editor command line invocation in ddd by accessing the
41450 \family sans
41451 Edit\SpecialChar menuseparator
41452 Preferences\SpecialChar menuseparator
41453 Helpers
41454 \family default
41455  dialog and changing the "Edit Sources" entry.
41456 \end_layout
41457
41458 \begin_layout Standard
41459 I take advantage of the newly created \SpecialChar LyX
41460  server function and this ddd feature,
41461  and set
41462 \begin_inset Quotes eld
41463 \end_inset
41464
41465 Edit Sources
41466 \begin_inset Quotes erd
41467 \end_inset
41468
41469  to:
41470 \end_layout
41471
41472 \begin_layout LyX-Code
41473 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
41474 \end_layout
41475
41476 \begin_layout Standard
41477 With this,
41478  whenever you are using ddd and find a point in the program that you want to edit,
41479  you just press shift-ctrl-V (in the ddd window),
41480  and ddd will forward this information to \SpecialChar LyX
41481  through the \SpecialChar LyX
41482  server and then the \SpecialChar LyX
41483  window will show the same file with the cursor at the same position ddd was pointing to.
41484  No more guessing or long scrolling to locate a point in the program back from debugging !
41485 \end_layout
41486
41487 \begin_layout Standard
41488 Note however that you must enable the \SpecialChar LyX
41489  server to get this feature working (it is disabled by default).
41490  Sec.
41491 \begin_inset space ~
41492 \end_inset
41493
41494
41495 \begin_inset CommandInset ref
41496 LatexCommand ref
41497 reference "sec:Starting-the-Server"
41498 nolink "false"
41499
41500 \end_inset
41501
41502  explains how to do that.
41503 \end_layout
41504
41505 \begin_layout Subsubsection
41506 Toolbar extensions
41507 \end_layout
41508
41509 \begin_layout Standard
41510 There are six new buttons that can be added to your \SpecialChar LyX
41511  toolbar.
41512  Four of these buttons are short cuts to layout styles:
41513
41514 \family sans
41515 Standard
41516 \family default
41517 ,
41518
41519 \family sans
41520 Section
41521 \family default
41522 ,
41523
41524 \family sans
41525 \SpecialChar LaTeX
41526
41527 \family default
41528 ,
41529  and
41530 \family sans
41531 \SpecialChar LyX
41532 -Code
41533 \family default
41534 ,
41535  one for the custom inset
41536 \family sans
41537 Chunk
41538 \family default
41539 .
41540  The last one is a short cut to the
41541 \begin_inset Quotes eld
41542 \end_inset
41543
41544 Build Program
41545 \begin_inset Quotes erd
41546 \end_inset
41547
41548  File menu entry.
41549
41550 \end_layout
41551
41552 \begin_layout Standard
41553 \SpecialChar LyX
41554  has a range of buttons that are available for tool bar customization.
41555  In my toolbar I like to combine the six short cuts above with two more:
41556  One for
41557 \family sans
41558 Document
41559 \family default
41560 \SpecialChar menuseparator
41561
41562 \family sans
41563 Update
41564 \family default
41565 \SpecialChar menuseparator
41566
41567 \family sans
41568 DVI
41569 \family default
41570  and the other for
41571 \family sans
41572 Document\SpecialChar menuseparator
41573 View\SpecialChar menuseparator
41574 DVI
41575 \family default
41576  File menu entries.
41577  Here is how it looks like:
41578 \end_layout
41579
41580 \begin_layout LyX-Code
41581 Toolbar
41582 \end_layout
41583
41584 \begin_layout LyX-Code
41585   Layouts
41586 \end_layout
41587
41588 \begin_layout LyX-Code
41589   Icon "layout Standard"
41590 \end_layout
41591
41592 \begin_layout LyX-Code
41593   Icon "layout Section"
41594 \end_layout
41595
41596 \begin_layout LyX-Code
41597   Icon "layout \SpecialChar LaTeX
41598 "
41599 \end_layout
41600
41601 \begin_layout LyX-Code
41602   Icon "layout \SpecialChar LyX
41603 -Code"
41604 \end_layout
41605
41606 \begin_layout LyX-Code
41607   Icon "flex.insert Chunk"
41608 \end_layout
41609
41610 \begin_layout LyX-Code
41611   Separator
41612 \end_layout
41613
41614 \begin_layout LyX-Code
41615   Icon "buffer-view"
41616 \end_layout
41617
41618 \begin_layout LyX-Code
41619   Icon "buffer-typeset"
41620 \end_layout
41621
41622 \begin_layout LyX-Code
41623   Icon "build-program"
41624 \end_layout
41625
41626 \begin_layout LyX-Code
41627   Separator
41628 \end_layout
41629
41630 \begin_layout LyX-Code
41631 .
41632 \end_layout
41633
41634 \begin_layout LyX-Code
41635 .
41636 \end_layout
41637
41638 \begin_layout LyX-Code
41639 .
41640 \end_layout
41641
41642 \begin_layout LyX-Code
41643 End
41644 \end_layout
41645
41646 \begin_layout Subsubsection
41647 Colors customization
41648 \end_layout
41649
41650 \begin_layout Standard
41651 There are a number of colors in \SpecialChar LyX
41652  that can be customized in
41653 \family sans
41654 Preferences
41655 \family default
41656 .
41657  One of the things that bothers people is the \SpecialChar LaTeX
41658  font color.
41659  The default color is red,
41660  since the chunks uses \SpecialChar LaTeX
41661  font,
41662  and there is a lot of chunks in literate documents,
41663  you may get tired of seeing everything in red.
41664  You can change it by going to the tabs
41665 \family sans
41666 Look&Feel
41667 \family default
41668 ,
41669
41670 \family sans
41671 Colors.
41672 \end_layout
41673
41674 \begin_layout Standard
41675 The next thing is the visible presence of the newline character in the screen.
41676  You can choose the color of this particular character and make it blend in the background.
41677  I recommend you choosing a color that is close to the background but not equal,
41678  that way you still can see it is there,
41679  but it is not bothering you anymore.
41680 \end_layout
41681
41682 \begin_layout Subsection
41683 \SpecialChar LyX
41684  and knitr/Sweave
41685 \end_layout
41686
41687 \begin_layout Standard
41688 Support for
41689 \family sans
41690 knitr
41691 \family default
41692  and
41693 \family sans
41694 Sweave
41695 \family default
41696  is documented in
41697 \change_inserted 564990737 1672161863
41698
41699 \family sans
41700 Help\SpecialChar menuseparator
41701 Specific Manuals\SpecialChar menuseparator
41702 Knitr
41703 \family default
41704  and
41705 \change_unchanged
41706
41707 \change_deleted 564990737 1671643409
41708 the
41709 \emph on
41710 knitr.lyx
41711 \emph default
41712  example file
41713 \change_inserted 564990737 1672161856
41714
41715 \family sans
41716 File\SpecialChar menuseparator
41717 Open Example\SpecialChar menuseparator
41718 Modules\SpecialChar menuseparator
41719 Rnw (knitr)
41720 \change_unchanged
41721
41722 \family default
41723  and in
41724 \change_deleted 564990737 1671643461
41725 the Sweave manual (menu
41726 \family sans
41727 Help\SpecialChar menuseparator
41728 Specific Manuals
41729 \family default
41730 )
41731 \change_inserted 564990737 1672161856
41732
41733 \family sans
41734 Help\SpecialChar menuseparator
41735 Specific Manuals\SpecialChar menuseparator
41736 Sweave
41737 \change_deleted 564990737 1672161921
41738
41739 \family default
41740 .
41741
41742 \change_inserted 564990737 1672161917
41743  and
41744 \family sans
41745 File\SpecialChar menuseparator
41746 Open Example\SpecialChar menuseparator
41747 Modules\SpecialChar menuseparator
41748 Sweave
41749 \family default
41750 .
41751 \change_deleted 564990737 1672742969
41752
41753 \end_layout
41754
41755 \begin_layout Standard
41756
41757 \change_deleted 564990737 1671355343
41758 Special features
41759 \end_layout
41760
41761 \begin_layout Standard
41762
41763 \change_deleted 564990737 1671355343
41764 You can do everything with \SpecialChar LyX
41765  that you can do with \SpecialChar LaTeX
41766 .
41767  However,
41768  \SpecialChar LyX
41769  cannot support every \SpecialChar LaTeX
41770  feature directly.
41771  But you can always use \SpecialChar TeX
41772  Code.
41773  This chapter shows you some more special things you might want to use.
41774  For other special things you can do with figures,
41775  tables,
41776  floats,
41777  boxes and notes,
41778  have a look at the
41779 \emph on
41780 Embedded
41781 \begin_inset space ~
41782 \end_inset
41783
41784 Objects
41785 \emph default
41786  manual.
41787 \change_inserted -712698321 1674917293
41788
41789 \end_layout
41790
41791 \begin_layout Standard
41792
41793 \change_inserted -712698321 1674917303
41794 \begin_inset CommandInset index_print
41795 LatexCommand printindex
41796 type "idx"
41797 name "Index"
41798
41799 \end_inset
41800
41801
41802 \change_unchanged
41803
41804 \end_layout
41805
41806 \end_body
41807 \end_document