lib/doc/Customization.lyx

   1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
   2 \lyxformat 578
   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 this document prints
  12 % out as advertised. If you mess with this preamble,
  13 % parts of this document may not print out as expected.  If you
  14 % have problems LaTeXing this file, please contact
  15 % the documentation team
  16 % email: lyx-docs@lists.lyx.org
  17
  18 % the pages of the TOC is numbered roman
  19 % and a pdf-bookmark for the TOC is added
  20 \let\myTOC\tableofcontents
  21 \renewcommand\tableofcontents{%
  22   \frontmatter
  23   \pdfbookmark[1]{\contentsname}{}
  24   \myTOC
  25   \mainmatter }
  26
  27 % increase link area for cross-references and autoname them,
  28 \AtBeginDocument{\renewcommand{\ref}[1]{\mbox{\autoref{#1}}}}
  29 \@ifundefined{extrasenglish}{\usepackage[english]{babel}}{}
  30 \@ifpackageloaded{babel}{
  31  \addto\extrasenglish{%
  32   \renewcommand*{\equationautorefname}[1]{}%
  33   \renewcommand{\sectionautorefname}{sec.\negthinspace}%
  34   \renewcommand{\subsectionautorefname}{sec.\negthinspace}%
  35   \renewcommand{\subsubsectionautorefname}{sec.\negthinspace}%
  36  }
  37 }{}
  38 \end_preamble
  39 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
  40 \use_default_options false
  41 \begin_modules
  42 logicalmkup
  43 \end_modules
  44 \maintain_unincluded_children false
  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_osf false
  57 \font_sf_scale 100 100
  58 \font_tt_scale 100 100
  59 \use_microtype false
  60 \use_dash_ligatures true
  61 \graphics default
  62 \default_output_format pdf2
  63 \output_sync 0
  64 \bibtex_command default
  65 \index_command default
  66 \paperfontsize 12
  67 \spacing single
  68 \use_hyperref true
  69 \pdf_title "LyX Configuration Manual"
  70 \pdf_author "LyX Team"
  71 \pdf_subject "LyX-documentation Customization"
  72 \pdf_keywords "LyX, documentation, customization"
  73 \pdf_bookmarks true
  74 \pdf_bookmarksnumbered true
  75 \pdf_bookmarksopen true
  76 \pdf_bookmarksopenlevel 1
  77 \pdf_breaklinks false
  78 \pdf_pdfborder false
  79 \pdf_colorlinks true
  80 \pdf_backref false
  81 \pdf_pdfusetitle false
  82 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
  83 \papersize default
  84 \use_geometry false
  85 \use_package amsmath 1
  86 \use_package amssymb 1
  87 \use_package cancel 1
  88 \use_package esint 1
  89 \use_package mathdots 1
  90 \use_package mathtools 1
  91 \use_package mhchem 1
  92 \use_package stackrel 1
  93 \use_package stmaryrd 1
  94 \use_package undertilde 1
  95 \cite_engine basic
  96 \cite_engine_type default
  97 \biblio_style plain
  98 \use_bibtopic false
  99 \use_indices false
 100 \paperorientation portrait
 101 \suppress_date false
 102 \justification true
 103 \use_refstyle 0
 104 \use_minted 0
 105 \use_lineno 0
 106 \notefontcolor #0000ff
 107 \branch OutDated
 108 \selected 0
 109 \filename_suffix 0
 110 \color #f5fae7
 111 \end_branch
 112 \index Index
 113 \shortcut idx
 114 \color #008000
 115 \end_index
 116 \secnumdepth 3
 117 \tocdepth 3
 118 \paragraph_separation indent
 119 \paragraph_indentation default
 120 \is_math_indent 1
 121 \math_indentation default
 122 \math_numbering_side default
 123 \quotes_style english
 124 \dynamic_quotes 0
 125 \papercolumns 1
 126 \papersides 2
 127 \paperpagestyle headings
 128 \tablestyle default
 129 \tracking_changes true
 130 \output_changes false
 131 \html_math_output 0
 132 \html_css_as_file 0
 133 \html_be_strict true
 134 \author -712698321 "Jürgen Spitzmüller"
 135 \author -495245474 "Jean-Marc Lasgouttes"
 136 \author 731793113 "Richard Kimberly Heck" rikiheck@lyx.org
 137 \end_header
 138
 139 \begin_body
 140
 141 \begin_layout Title
 142 Customizing \SpecialChar LyX
 143 : Features for the Advanced User
 144 \end_layout
 145
 146 \begin_layout Author
 147 by the \SpecialChar LyX
 148  Team
 149 \begin_inset Foot
 150 status collapsed
 151
 152 \begin_layout Plain Layout
 153 \noindent
 154 If you have comments or error corrections, please send them to the \SpecialChar LyX
 155  Documentatio
 156 n mailing list,
 157 \begin_inset CommandInset href
 158 LatexCommand href
 159 target "lyx-docs@lists.lyx.org"
 160 type "mailto:"
 161 literal "false"
 162
 163 \end_inset
 164
 165 .
 166  Include
 167 \begin_inset Quotes eld
 168 \end_inset
 169
 170 [Customization]
 171 \begin_inset Quotes erd
 172 \end_inset
 173
 174  in the subject header, and please cc the current maintainer of this file,
 175  Richard Heck <rgheck@comcast.net>.
 176 \end_layout
 177
 178 \end_inset
 179
 180
 181 \begin_inset Newline newline
 182 \end_inset
 183
 184
 185 \begin_inset Newline newline
 186 \end_inset
 187
 188 Version 2.3.x
 189 \end_layout
 190
 191 \begin_layout Standard
 192 \begin_inset CommandInset toc
 193 LatexCommand tableofcontents
 194
 195 \end_inset
 196
 197
 198 \end_layout
 199
 200 \begin_layout Standard
 201 \begin_inset Note Note
 202 status open
 203
 204 \begin_layout Plain Layout
 205 Please use change tracking when modifying this document.
 206  This makes it easier for our translators to recognize things that have
 207  been changed, and it helps the maintainer keep up-to-date with what's been
 208  done.
 209 \end_layout
 210
 211 \end_inset
 212
 213
 214 \end_layout
 215
 216 \begin_layout Chapter
 217 Introduction
 218 \end_layout
 219
 220 \begin_layout Standard
 221 This manual covers the customization features present in \SpecialChar LyX
 222 .
 223  In it, we discuss issues like keyboard shortcuts, screen previewing options,
 224  printer options, sending commands to \SpecialChar LyX
 225  via the \SpecialChar LyX
 226  Server, internationalization,
 227  installing new \SpecialChar LaTeX
 228  classes and \SpecialChar LyX
 229  layouts, etc.
 230  We can't possibly hope to touch on everything you can change—our developers
 231  add new features faster than we can document them—but we will explain the
 232  most common customizations and hopefully point you in the right direction
 233  for some of the more obscure ones.
 234 \end_layout
 235
 236 \begin_layout Standard
 237 \begin_inset Branch OutDated
 238 inverted 0
 239 status collapsed
 240
 241 \begin_layout Standard
 242 Information from previous versions of this document that now seems to be
 243  outdated is contained in the OutDated branch of this document.
 244  By default, this information will not appear in the \SpecialChar LaTeX
 245  output.
 246 \end_layout
 247
 248 \end_inset
 249
 250
 251 \end_layout
 252
 253 \begin_layout Chapter
 254 \SpecialChar LyX
 255  configuration files
 256 \end_layout
 257
 258 \begin_layout Standard
 259 This chapter aims to help you to find your way through the \SpecialChar LyX
 260  configuration
 261  files.
 262  Before continuing to read this chapter, you should find out where your
 263  \SpecialChar LyX
 264  library and user directories are by using
 265 \begin_inset Flex Noun
 266 status collapsed
 267
 268 \begin_layout Plain Layout
 269 Help\SpecialChar menuseparator
 270 About
 271 \begin_inset space ~
 272 \end_inset
 273
 274 LyX
 275 \end_layout
 276
 277 \end_inset
 278
 279 .
 280  The library directory is the place where \SpecialChar LyX
 281  places its system-wide configuration
 282  files; the user directory is where you can place your modified versions.
 283  We will call the former
 284 \begin_inset Flex Code
 285 status collapsed
 286
 287 \begin_layout Plain Layout
 288 LyXDir
 289 \end_layout
 290
 291 \end_inset
 292
 293  and the latter
 294 \begin_inset Flex Noun
 295 status collapsed
 296
 297 \begin_layout Plain Layout
 298 UserDir
 299 \end_layout
 300
 301 \end_inset
 302
 303  in the remainder of this document.
 304
 305 \end_layout
 306
 307 \begin_layout Section
 308 What's in
 309 \begin_inset Flex Code
 310 status collapsed
 311
 312 \begin_layout Plain Layout
 313 LyXDir
 314 \end_layout
 315
 316 \end_inset
 317
 318 ?
 319 \end_layout
 320
 321 \begin_layout Standard
 322 \begin_inset Flex Code
 323 status collapsed
 324
 325 \begin_layout Plain Layout
 326 LyXDir
 327 \end_layout
 328
 329 \end_inset
 330
 331  and its sub-directories contain a number of files and that can be used
 332  to customize \SpecialChar LyX
 333 's behavior.
 334  You can change many of these files from within \SpecialChar LyX
 335  itself through the
 336 \begin_inset Flex Noun
 337 status collapsed
 338
 339 \begin_layout Plain Layout
 340 Tools\SpecialChar menuseparator
 341 Preferences
 342 \end_layout
 343
 344 \end_inset
 345
 346  dialog.
 347  Most customization that you will want to do in \SpecialChar LyX
 348  is possible through this
 349  dialog.
 350  However, many other inner aspects of \SpecialChar LyX
 351  can be customized by modifying the
 352  files in
 353 \begin_inset Flex Code
 354 status collapsed
 355
 356 \begin_layout Plain Layout
 357 LyXDir
 358 \end_layout
 359
 360 \end_inset
 361
 362 .
 363  These files fall in different categories, described in the following subsection
 364 s.
 365 \end_layout
 366
 367 \begin_layout Subsection
 368 Automatically generated files
 369 \end_layout
 370
 371 \begin_layout Standard
 372 The files, which are to be found in
 373 \begin_inset Flex Noun
 374 status collapsed
 375
 376 \begin_layout Plain Layout
 377 UserDir
 378 \end_layout
 379
 380 \end_inset
 381
 382 , are generated when you configure \SpecialChar LyX
 383 .
 384  They contain various default values that are guessed by inspection.
 385  In general, it is not a good idea to modify them, since they might be overwritt
 386 en at any time.
 387 \end_layout
 388
 389 \begin_layout Labeling
 390 \labelwidthstring 00.00.0000
 391 \begin_inset Flex Code
 392 status collapsed
 393
 394 \begin_layout Plain Layout
 395 lyxrc.defaults
 396 \end_layout
 397
 398 \end_inset
 399
 400  contains defaults for various commands.
 401 \end_layout
 402
 403 \begin_layout Labeling
 404 \labelwidthstring 00.00.0000
 405 \begin_inset Flex Code
 406 status collapsed
 407
 408 \begin_layout Plain Layout
 409 packages.lst
 410 \end_layout
 411
 412 \end_inset
 413
 414  contains the list of packages that have been recognized by \SpecialChar LyX
 415 .
 416  It is currently unused by the \SpecialChar LyX
 417  program itself, but the information extracted,
 418  and more, is made available with
 419 \begin_inset Flex Noun
 420 status collapsed
 421
 422 \begin_layout Plain Layout
 423 Help\SpecialChar menuseparator
 424 \SpecialChar LaTeX
 425
 426 \begin_inset space ~
 427 \end_inset
 428
 429 Configuration
 430 \end_layout
 431
 432 \end_inset
 433
 434 .
 435 \end_layout
 436
 437 \begin_layout Labeling
 438 \labelwidthstring 00.00.0000
 439 \begin_inset Flex Code
 440 status collapsed
 441
 442 \begin_layout Plain Layout
 443 textclass.lst
 444 \end_layout
 445
 446 \end_inset
 447
 448  the list of text classes that have been found in your
 449 \begin_inset Flex Code
 450 status collapsed
 451
 452 \begin_layout Plain Layout
 453 layout/
 454 \end_layout
 455
 456 \end_inset
 457
 458  directories, along with the associated \SpecialChar LaTeX
 459  document class and their description.
 460 \end_layout
 461
 462 \begin_layout Labeling
 463 \labelwidthstring 00.00.0000
 464 \begin_inset Flex Code
 465 status collapsed
 466
 467 \begin_layout Plain Layout
 468 lyxmodules.lst
 469 \end_layout
 470
 471 \end_inset
 472
 473  the list of layout modules found in your
 474 \begin_inset Flex Code
 475 status collapsed
 476
 477 \begin_layout Plain Layout
 478 layout/
 479 \end_layout
 480
 481 \end_inset
 482
 483  directories
 484 \end_layout
 485
 486 \begin_layout Labeling
 487 \labelwidthstring 00.00.0000
 488 \begin_inset Flex Code
 489 status collapsed
 490
 491 \begin_layout Plain Layout
 492 *files.lst
 493 \end_layout
 494
 495 \end_inset
 496
 497  lists of various sorts of \SpecialChar LaTeX
 498 -related files found on your system
 499 \end_layout
 500
 501 \begin_layout Labeling
 502 \labelwidthstring 00.00.0000
 503 \begin_inset Flex Code
 504 status collapsed
 505
 506 \begin_layout Plain Layout
 507 doc/\SpecialChar LaTeX
 508 Config.lyx
 509 \end_layout
 510
 511 \end_inset
 512
 513  is automatically generated during configuration from the file
 514 \begin_inset Flex Code
 515 status collapsed
 516
 517 \begin_layout Plain Layout
 518 \SpecialChar LaTeX
 519 Config.lyx.in
 520 \end_layout
 521
 522 \end_inset
 523
 524 .
 525  It contains information on your \SpecialChar LaTeX
 526  configuration.
 527 \end_layout
 528
 529 \begin_layout Subsection
 530 Directories
 531 \end_layout
 532
 533 \begin_layout Standard
 534 These directories are duplicated between
 535 \begin_inset Flex Code
 536 status collapsed
 537
 538 \begin_layout Plain Layout
 539 LyXDir
 540 \end_layout
 541
 542 \end_inset
 543
 544  and
 545 \begin_inset Flex Code
 546 status collapsed
 547
 548 \begin_layout Plain Layout
 549 UserDir
 550 \end_layout
 551
 552 \end_inset
 553
 554 .
 555  If a particular files exists in both places, the one in
 556 \begin_inset Flex Code
 557 status collapsed
 558
 559 \begin_layout Plain Layout
 560 UserDir
 561 \end_layout
 562
 563 \end_inset
 564
 565  will be used.
 566 \end_layout
 567
 568 \begin_layout Labeling
 569 \labelwidthstring 00.00.0000
 570 \begin_inset Flex Code
 571 status collapsed
 572
 573 \begin_layout Plain Layout
 574 bind/
 575 \end_layout
 576
 577 \end_inset
 578
 579  this directory contains files with the extension
 580 \begin_inset Flex Code
 581 status collapsed
 582
 583 \begin_layout Plain Layout
 584 .bind
 585 \end_layout
 586
 587 \end_inset
 588
 589  that define the keybindings used in \SpecialChar LyX
 590 .
 591  If there exists an internationalized version of the bind file named
 592 \begin_inset Flex Code
 593 status collapsed
 594
 595 \begin_layout Plain Layout
 596 $LANG_xxx.bind
 597 \end_layout
 598
 599 \end_inset
 600
 601 , that will be used first.
 602 \end_layout
 603
 604 \begin_layout Labeling
 605 \labelwidthstring 00.00.0000
 606 \begin_inset Flex Code
 607 status collapsed
 608
 609 \begin_layout Plain Layout
 610 citeengines/
 611 \end_layout
 612
 613 \end_inset
 614
 615  contains files with the extension
 616 \begin_inset Flex Code
 617 status collapsed
 618
 619 \begin_layout Plain Layout
 620 .citeengine
 621 \end_layout
 622
 623 \end_inset
 624
 625  which define the diverse citation possibilities (natbib, biblatex etc.).
 626  See
 627 \begin_inset CommandInset ref
 628 LatexCommand ref
 629 reference "subsec:Cite-Engine-Files"
 630 plural "false"
 631 caps "false"
 632 noprefix "false"
 633
 634 \end_inset
 635
 636  for details.
 637 \end_layout
 638
 639 \begin_layout Labeling
 640 \labelwidthstring 00.00.0000
 641 \begin_inset Flex Code
 642 status collapsed
 643
 644 \begin_layout Plain Layout
 645 clipart/
 646 \end_layout
 647
 648 \end_inset
 649
 650  contains graphics files that can be included in documents.
 651
 652 \end_layout
 653
 654 \begin_layout Labeling
 655 \labelwidthstring 00.00.0000
 656 \begin_inset Flex Code
 657 status collapsed
 658
 659 \begin_layout Plain Layout
 660 doc/
 661 \end_layout
 662
 663 \end_inset
 664
 665  contains \SpecialChar LyX
 666  documentation files (including the one you are currently reading).
 667  The file
 668 \begin_inset Flex Code
 669 status collapsed
 670
 671 \begin_layout Plain Layout
 672 \SpecialChar LaTeX
 673 Config.lyx
 674 \end_layout
 675
 676 \end_inset
 677
 678  deserves special attention, as noted above.
 679  The internationalized help docs are in subdirectories
 680 \begin_inset Flex Code
 681 status collapsed
 682
 683 \begin_layout Plain Layout
 684 doc/xx
 685 \end_layout
 686
 687 \end_inset
 688
 689  where
 690 \begin_inset Quotes eld
 691 \end_inset
 692
 693 xx
 694 \begin_inset Quotes erd
 695 \end_inset
 696
 697  is the ISO language code.
 698  See
 699 \begin_inset CommandInset ref
 700 LatexCommand ref
 701 reference "cha:Internationalizing-LyX"
 702
 703 \end_inset
 704
 705  for details.
 706 \end_layout
 707
 708 \begin_layout Labeling
 709 \labelwidthstring 00.00.0000
 710 \begin_inset Flex Code
 711 status collapsed
 712
 713 \begin_layout Plain Layout
 714 examples/
 715 \end_layout
 716
 717 \end_inset
 718
 719  contains example files that explain how to use some features.
 720  In the file browser, press the
 721 \begin_inset Flex Noun
 722 status collapsed
 723
 724 \begin_layout Plain Layout
 725 Examples
 726 \end_layout
 727
 728 \end_inset
 729
 730  button to get there.
 731 \end_layout
 732
 733 \begin_layout Labeling
 734 \labelwidthstring 00.00.0000
 735 \begin_inset Flex Code
 736 status collapsed
 737
 738 \begin_layout Plain Layout
 739 images/
 740 \end_layout
 741
 742 \end_inset
 743
 744  contains image files that are used by the
 745 \begin_inset Flex Noun
 746 status collapsed
 747
 748 \begin_layout Plain Layout
 749 Document
 750 \end_layout
 751
 752 \end_inset
 753
 754  dialog.
 755  In addition, it also contains the individual icons used in the toolbar
 756  and the banners that can be shown when \SpecialChar LyX
 757  is launched.
 758 \end_layout
 759
 760 \begin_layout Labeling
 761 \labelwidthstring 00.00.0000
 762 \begin_inset Flex Code
 763 status collapsed
 764
 765 \begin_layout Plain Layout
 766 kbd/
 767 \end_layout
 768
 769 \end_inset
 770
 771  contains keyboard keymapping files.
 772  See
 773 \begin_inset CommandInset ref
 774 LatexCommand ref
 775 reference "sec:International-Keymap-Stuff"
 776
 777 \end_inset
 778
 779  for details.
 780 \end_layout
 781
 782 \begin_layout Labeling
 783 \labelwidthstring 00.00.0000
 784 \begin_inset Flex Code
 785 status collapsed
 786
 787 \begin_layout Plain Layout
 788 layouts/
 789 \end_layout
 790
 791 \end_inset
 792
 793  contains the text class and module files described in
 794 \begin_inset CommandInset ref
 795 LatexCommand ref
 796 reference "cha:Installing-New-Document"
 797
 798 \end_inset
 799
 800 .
 801 \end_layout
 802
 803 \begin_layout Labeling
 804 \labelwidthstring 00.00.0000
 805 \begin_inset Flex Code
 806 status collapsed
 807
 808 \begin_layout Plain Layout
 809 lyx2lyx
 810 \end_layout
 811
 812 \end_inset
 813
 814  contains the
 815 \begin_inset Flex Code
 816 status collapsed
 817
 818 \begin_layout Plain Layout
 819 lyx2lyx
 820 \end_layout
 821
 822 \end_inset
 823
 824  Python scripts used to convert between \SpecialChar LyX
 825  versions.
 826  These can be run from the command line if, say, you want to batch-convert
 827  files.
 828 \end_layout
 829
 830 \begin_layout Labeling
 831 \labelwidthstring 00.00.0000
 832 \begin_inset Flex Code
 833 status collapsed
 834
 835 \begin_layout Plain Layout
 836 scripts/
 837 \end_layout
 838
 839 \end_inset
 840
 841  contains some files that demonstrate the capabilities of the
 842 \begin_inset Flex Noun
 843 status collapsed
 844
 845 \begin_layout Plain Layout
 846 External
 847 \begin_inset space ~
 848 \end_inset
 849
 850 Template
 851 \end_layout
 852
 853 \end_inset
 854
 855  feature.
 856  Also contains some scripts used by \SpecialChar LyX
 857  itself.
 858 \end_layout
 859
 860 \begin_layout Labeling
 861 \labelwidthstring 00.00.0000
 862 \begin_inset Flex Code
 863 status collapsed
 864
 865 \begin_layout Plain Layout
 866 templates/
 867 \end_layout
 868
 869 \end_inset
 870
 871  contains the standard \SpecialChar LyX
 872  template files described in
 873 \begin_inset CommandInset ref
 874 LatexCommand ref
 875 reference "subsec:Creating-Templates"
 876
 877 \end_inset
 878
 879 .
 880 \end_layout
 881
 882 \begin_layout Labeling
 883 \labelwidthstring 00.00.0000
 884 \begin_inset Flex Code
 885 status collapsed
 886
 887 \begin_layout Plain Layout
 888 ui/
 889 \end_layout
 890
 891 \end_inset
 892
 893  contains files with the extension
 894 \begin_inset Flex Code
 895 status collapsed
 896
 897 \begin_layout Plain Layout
 898 .ui
 899 \end_layout
 900
 901 \end_inset
 902
 903  that define the user interface to \SpecialChar LyX
 904 .
 905  That is, the files define which items appear in which menus and the items
 906  appearing on the toolbar.
 907 \end_layout
 908
 909 \begin_layout Labeling
 910 \labelwidthstring 00.00.0000
 911 \begin_inset Flex Code
 912 status collapsed
 913
 914 \begin_layout Plain Layout
 915 xtemplates/
 916 \end_layout
 917
 918 \end_inset
 919
 920  contains files with the extension
 921 \begin_inset Flex Code
 922 status collapsed
 923
 924 \begin_layout Plain Layout
 925 .xtemplate
 926 \end_layout
 927
 928 \end_inset
 929
 930  which define the templates for the insertion of external material to a
 931  \SpecialChar LyX
 932  document; see
 933 \begin_inset CommandInset ref
 934 LatexCommand ref
 935 reference "chap:Including-External-Material"
 936
 937 \end_inset
 938
 939 .
 940 \end_layout
 941
 942 \begin_layout Subsection
 943 Files you don't want to modify
 944 \end_layout
 945
 946 \begin_layout Standard
 947 These files are used internally by \SpecialChar LyX
 948  and you generally do not need to modify
 949  them unless you are a developer.
 950 \end_layout
 951
 952 \begin_layout Labeling
 953 \labelwidthstring 00.00.0000
 954 \begin_inset Flex Code
 955 status collapsed
 956
 957 \begin_layout Plain Layout
 958 CREDITS
 959 \end_layout
 960
 961 \end_inset
 962
 963  this file contains the list of \SpecialChar LyX
 964  developers.
 965  The contents are displayed with the menu entry
 966 \begin_inset Flex Noun
 967 status collapsed
 968
 969 \begin_layout Plain Layout
 970 Help\SpecialChar menuseparator
 971 About
 972 \begin_inset space ~
 973 \end_inset
 974
 975 LyX
 976 \end_layout
 977
 978 \end_inset
 979
 980 .
 981 \end_layout
 982
 983 \begin_layout Labeling
 984 \labelwidthstring 00.00.0000
 985 \begin_inset Flex Code
 986 status collapsed
 987
 988 \begin_layout Plain Layout
 989 chkconfig.ltx
 990 \end_layout
 991
 992 \end_inset
 993
 994  this is a \SpecialChar LaTeX
 995  script used during the configuration process.
 996  Do not run directly.
 997 \end_layout
 998
 999 \begin_layout Labeling
1000 \labelwidthstring 00.00.0000
1001 \begin_inset Flex Code
1002 status collapsed
1003
1004 \begin_layout Plain Layout
1005 configure.py
1006 \end_layout
1007
1008 \end_inset
1009
1010  this is a Python script that is used to re-configure \SpecialChar LyX
1011 .
1012  It creates configuration files in the directory it was run from.
1013 \end_layout
1014
1015 \begin_layout Subsection
1016 Other files needing a line or two
1017 \end_layout
1018
1019 \begin_layout Labeling
1020 \labelwidthstring 00.00.0000
1021 \begin_inset Flex Code
1022 status collapsed
1023
1024 \begin_layout Plain Layout
1025 encodings
1026 \end_layout
1027
1028 \end_inset
1029
1030  this contains tables describing how different character encodings can be
1031  mapped to Unicode
1032 \end_layout
1033
1034 \begin_layout Labeling
1035 \labelwidthstring 00.00.0000
1036 \begin_inset Flex Code
1037 status collapsed
1038
1039 \begin_layout Plain Layout
1040 languages
1041 \end_layout
1042
1043 \end_inset
1044
1045  this file contains a list of all the languages currently supported by \SpecialChar LyX
1046 .
1047 \end_layout
1048
1049 \begin_layout Labeling
1050 \labelwidthstring 00.00.0000
1051 \begin_inset Flex Code
1052 status collapsed
1053
1054 \begin_layout Plain Layout
1055 latexfonts
1056 \end_layout
1057
1058 \end_inset
1059
1060  contains information about the supported fonts.
1061 \end_layout
1062
1063 \begin_layout Labeling
1064 \labelwidthstring 00.00.0000
1065 \begin_inset Flex Code
1066 status collapsed
1067
1068 \begin_layout Plain Layout
1069 layouttranslations
1070 \end_layout
1071
1072 \end_inset
1073
1074  this file contains translations for internationalized paragraph styles
1075  (see
1076 \begin_inset CommandInset ref
1077 LatexCommand ref
1078 reference "subsec:I18n"
1079
1080 \end_inset
1081
1082 ).
1083 \end_layout
1084
1085 \begin_layout Labeling
1086 \labelwidthstring 00.00.0000
1087 \begin_inset Flex Code
1088 status collapsed
1089
1090 \begin_layout Plain Layout
1091 unicodesymbols
1092 \end_layout
1093
1094 \end_inset
1095
1096  this file contains information about Unicode-encoded glyphs and the way
1097  they are supported by \SpecialChar LyX
1098  via \SpecialChar LaTeX
1099 .
1100 \end_layout
1101
1102 \begin_layout Section
1103 Your local configuration directory
1104 \end_layout
1105
1106 \begin_layout Standard
1107 Even if you are using \SpecialChar LyX
1108  as an unprivileged user, you might want to change
1109  \SpecialChar LyX
1110  configuration for your own use.
1111  The
1112 \begin_inset Flex Code
1113 status collapsed
1114
1115 \begin_layout Plain Layout
1116 UserDir
1117 \end_layout
1118
1119 \end_inset
1120
1121  directory contains all your personal configuration files.
1122  This is the directory described as
1123 \begin_inset Quotes eld
1124 \end_inset
1125
1126 user directory
1127 \begin_inset Quotes erd
1128 \end_inset
1129
1130  in
1131 \begin_inset Flex Noun
1132 status collapsed
1133
1134 \begin_layout Plain Layout
1135 Help\SpecialChar menuseparator
1136 About
1137 \begin_inset space ~
1138 \end_inset
1139
1140 LyX
1141 \end_layout
1142
1143 \end_inset
1144
1145 .
1146  This directory is used as a mirror of
1147 \begin_inset Flex Code
1148 status collapsed
1149
1150 \begin_layout Plain Layout
1151 LyXDir
1152 \end_layout
1153
1154 \end_inset
1155
1156 , which means that every file in
1157 \begin_inset Flex Code
1158 status collapsed
1159
1160 \begin_layout Plain Layout
1161 UserDir
1162 \end_layout
1163
1164 \end_inset
1165
1166  is a replacement for the corresponding file in
1167 \begin_inset Flex Code
1168 status collapsed
1169
1170 \begin_layout Plain Layout
1171 LyXDir
1172 \end_layout
1173
1174 \end_inset
1175
1176 .
1177  Any configuration file described in the above sections can be placed either
1178  in the system-wide directory, in which case it will affect all users, or
1179  in your local directory for your own use.
1180 \end_layout
1181
1182 \begin_layout Standard
1183 To make things clearer, let's provide a few examples:
1184 \end_layout
1185
1186 \begin_layout Itemize
1187 The preferences set in the
1188 \begin_inset Flex Noun
1189 status collapsed
1190
1191 \begin_layout Plain Layout
1192 Tools\SpecialChar menuseparator
1193 Preferences
1194 \end_layout
1195
1196 \end_inset
1197
1198  dialog are saved to a file
1199 \begin_inset Flex Code
1200 status collapsed
1201
1202 \begin_layout Plain Layout
1203 preferences
1204 \end_layout
1205
1206 \end_inset
1207
1208  in
1209 \begin_inset Flex Code
1210 status collapsed
1211
1212 \begin_layout Plain Layout
1213 UserDir
1214 \end_layout
1215
1216 \end_inset
1217
1218 .
1219 \end_layout
1220
1221 \begin_layout Itemize
1222 When you reconfigure using
1223 \begin_inset Flex Noun
1224 status collapsed
1225
1226 \begin_layout Plain Layout
1227 Tools\SpecialChar menuseparator
1228 Reconfigure
1229 \end_layout
1230
1231 \end_inset
1232
1233 , \SpecialChar LyX
1234  runs the
1235 \begin_inset Flex Code
1236 status collapsed
1237
1238 \begin_layout Plain Layout
1239 configure.py
1240 \end_layout
1241
1242 \end_inset
1243
1244  script, and the resulting files are written in your local configuration
1245  directory.
1246  This means that any additional text class file that you might have added
1247  in
1248 \begin_inset Flex Code
1249 status collapsed
1250
1251 \begin_layout Plain Layout
1252 UserDir/layouts
1253 \end_layout
1254
1255 \end_inset
1256
1257  will be added to the list of classes in the
1258 \begin_inset Flex Noun
1259 status collapsed
1260
1261 \begin_layout Plain Layout
1262 Document\SpecialChar menuseparator
1263 Settings
1264 \end_layout
1265
1266 \end_inset
1267
1268  dialog.
1269 \end_layout
1270
1271 \begin_layout Itemize
1272 If you get some updated documentation from \SpecialChar LyX
1273  ftp site and cannot install
1274  it because you do not have sysadmin rights on your system, you can just
1275  copy the files in
1276 \begin_inset Flex Code
1277 status collapsed
1278
1279 \begin_layout Plain Layout
1280 UserDir/doc/
1281 \end_layout
1282
1283 \end_inset
1284
1285  and the items in the
1286 \begin_inset Flex Noun
1287 status collapsed
1288
1289 \begin_layout Plain Layout
1290 Help
1291 \end_layout
1292
1293 \end_inset
1294
1295  menu will open them!
1296 \end_layout
1297
1298 \begin_layout Section
1299 Running \SpecialChar LyX
1300  with multiple configurations
1301 \end_layout
1302
1303 \begin_layout Standard
1304 The configuration freedom of the local configuration directory may not suffice
1305  if you want to have more than one configuration at your disposal.
1306  For example, you may want to be use different key bindings or printer settings
1307  at different times.
1308  You can achieve this by having several such directories.
1309  You then specify which directory to use at run-time.
1310 \end_layout
1311
1312 \begin_layout Standard
1313 Invoking \SpecialChar LyX
1314  with the command line switch
1315 \begin_inset Flex Code
1316 status collapsed
1317
1318 \begin_layout Plain Layout
1319 -userdir
1320 \end_layout
1321
1322 \end_inset
1323
1324
1325 \emph on
1326 <some directory>
1327 \emph default
1328  instructs the program to read the configuration from that directory, and
1329  not from the default directory.
1330  (You can determine the default directory by running \SpecialChar LyX
1331  without the
1332 \begin_inset Flex Code
1333 status collapsed
1334
1335 \begin_layout Plain Layout
1336 -userdir
1337 \end_layout
1338
1339 \end_inset
1340
1341  switch.) If the specified directory does not exist, \SpecialChar LyX
1342  offers to create it
1343  for you, just like it does for the default directory on the first time
1344  you run the program.
1345  You can modify the configuration options in this additional user directory
1346  exactly as you would for the default directory.
1347  These directories are completely independent (but read on).
1348  Note that setting the environment variable
1349 \begin_inset Flex Code
1350 status collapsed
1351
1352 \begin_layout Plain Layout
1353 LYX_USERDIR_VER
1354 \end_layout
1355
1356 \end_inset
1357
1358  to some value has exactly the same effect.
1359 \end_layout
1360
1361 \begin_layout Standard
1362 Having several configurations also requires more maintenance: if you want
1363  to add a new layout to
1364 \begin_inset Flex Code
1365 status collapsed
1366
1367 \begin_layout Plain Layout
1368 NewUserDir/layouts
1369 \end_layout
1370
1371 \end_inset
1372
1373  which you want available from all your configurations, you must add it
1374  to each directory separately.
1375  You can avoid this with the following trick: after \SpecialChar LyX
1376  creates the additional
1377  directory, most of the subdirectories (see above) are empty.
1378  If you want the new configuration to mirror an existing one, replace the
1379  empty subdirectory with a symbolic link to the matching subdirectory in
1380  the existing configuration.
1381  Take care with the
1382 \begin_inset Flex Code
1383 status collapsed
1384
1385 \begin_layout Plain Layout
1386 doc/
1387 \end_layout
1388
1389 \end_inset
1390
1391  subdirectory, however, since it contains a file written by the configuration
1392  script (also accessible through
1393 \begin_inset Flex Noun
1394 status collapsed
1395
1396 \begin_layout Plain Layout
1397 Tools\SpecialChar menuseparator
1398 Reconfigure
1399 \end_layout
1400
1401 \end_inset
1402
1403 ) which is configuration-specific.
1404 \end_layout
1405
1406 \begin_layout Chapter
1407 The Preferences dialog
1408 \end_layout
1409
1410 \begin_layout Standard
1411 All options of the preferences dialog are described in the Appendix
1412 \emph on
1413 The Preferences Dialog
1414 \emph default
1415  in the
1416 \emph on
1417 User's Guide
1418 \emph default
1419 .
1420  For some options you might find here more details.
1421 \end_layout
1422
1423 \begin_layout Section
1424 Formats
1425 \begin_inset CommandInset label
1426 LatexCommand label
1427 name "sec:Formats"
1428
1429 \end_inset
1430
1431
1432 \end_layout
1433
1434 \begin_layout Standard
1435 The first step is to define your file formats if they are not already defined.
1436  To do so, open the
1437 \begin_inset Flex Noun
1438 status collapsed
1439
1440 \begin_layout Plain Layout
1441 Tools\SpecialChar menuseparator
1442 Preferences
1443 \end_layout
1444
1445 \end_inset
1446
1447  dialog.
1448  Under
1449 \begin_inset Flex Noun
1450 status collapsed
1451
1452 \begin_layout Plain Layout
1453 File Handling\SpecialChar menuseparator
1454 File formats
1455 \end_layout
1456
1457 \end_inset
1458
1459  press the
1460 \begin_inset Flex Noun
1461 status collapsed
1462
1463 \begin_layout Plain Layout
1464 New
1465 \end_layout
1466
1467 \end_inset
1468
1469  button to define your new format.
1470  The
1471 \begin_inset Flex Noun
1472 status collapsed
1473
1474 \begin_layout Plain Layout
1475 Format
1476 \end_layout
1477
1478 \end_inset
1479
1480  field contains the name used to identify the format in the GUI.
1481  The
1482 \begin_inset Flex Noun
1483 status collapsed
1484
1485 \begin_layout Plain Layout
1486 Short Name
1487 \end_layout
1488
1489 \end_inset
1490
1491  is used to identify the format internally.
1492  You will also need to enter a file extension.
1493  These are all required.
1494  The optional
1495 \begin_inset Flex Noun
1496 status collapsed
1497
1498 \begin_layout Plain Layout
1499 Shortcut
1500 \end_layout
1501
1502 \end_inset
1503
1504  field is used to provide a keyboard shortcut on the menus.
1505  (For example, pressing
1506 \begin_inset Flex Noun
1507 status collapsed
1508
1509 \begin_layout Plain Layout
1510 Ctrl+D
1511 \end_layout
1512
1513 \end_inset
1514
1515  will
1516 \begin_inset Flex Noun
1517 status collapsed
1518
1519 \begin_layout Plain Layout
1520 Document\SpecialChar menuseparator
1521 View (Other Formats)\SpecialChar menuseparator
1522 DVI
1523 \end_layout
1524
1525 \end_inset
1526
1527 .)
1528 \end_layout
1529
1530 \begin_layout Standard
1531 A Format can have a
1532 \begin_inset Flex Noun
1533 status collapsed
1534
1535 \begin_layout Plain Layout
1536 Viewer
1537 \end_layout
1538
1539 \end_inset
1540
1541  and an
1542 \begin_inset Flex Noun
1543 status collapsed
1544
1545 \begin_layout Plain Layout
1546 Editor
1547 \end_layout
1548
1549 \end_inset
1550
1551  associated with it.
1552  For example, you might want to use
1553 \begin_inset Flex Noun
1554 status collapsed
1555
1556 \begin_layout Plain Layout
1557 Ghostview
1558 \end_layout
1559
1560 \end_inset
1561
1562  to view PostScript files.
1563  You can enter the command needed to start the program in the corresponding
1564  fields.
1565  In defining this command, you can use the four variables listed in the
1566  next section.
1567  The viewer is launched when you view an image in \SpecialChar LyX
1568  or use the
1569 \begin_inset Flex Noun
1570 status collapsed
1571
1572 \begin_layout Plain Layout
1573 Document\SpecialChar menuseparator
1574 View
1575 \end_layout
1576
1577 \end_inset
1578
1579  menu.
1580  The editor is for example launched when you right-click on an image and
1581  choose
1582 \begin_inset Flex Noun
1583 status collapsed
1584
1585 \begin_layout Plain Layout
1586 Edit externally
1587 \end_layout
1588
1589 \end_inset
1590
1591  in the appearing context menu.
1592 \end_layout
1593
1594 \begin_layout Standard
1595 The
1596 \begin_inset Flex Noun
1597 status collapsed
1598
1599 \begin_layout Plain Layout
1600 MIME
1601 \end_layout
1602
1603 \end_inset
1604
1605  type of a format is optional, but if it is specified, it must be unique
1606  across all formats.
1607  It is used to detect files of this format from the file contents.
1608  For some important file formats there is no MIME type officially registered
1609  with the
1610 \begin_inset CommandInset href
1611 LatexCommand href
1612 name "IANA"
1613 target "http://www.iana.org/assignments/media-types/"
1614 literal "false"
1615
1616 \end_inset
1617
1618 .
1619  Therefore \SpecialChar LyX
1620  uses the extended list of MIME types as specified by
1621 \begin_inset CommandInset href
1622 LatexCommand href
1623 name "freedesktop.org"
1624 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1625 literal "false"
1626
1627 \end_inset
1628
1629 .
1630 \end_layout
1631
1632 \begin_layout Standard
1633 The
1634 \begin_inset Flex Noun
1635 status collapsed
1636
1637 \begin_layout Plain Layout
1638 Document format
1639 \end_layout
1640
1641 \end_inset
1642
1643  option tells \SpecialChar LyX
1644  that a format is suitable for document export.
1645  If this is set and if a suitable conversion route exists (see
1646 \begin_inset CommandInset ref
1647 LatexCommand ref
1648 reference "sec:Converters"
1649
1650 \end_inset
1651
1652 ), the format will appear in the
1653 \begin_inset Flex Noun
1654 status collapsed
1655
1656 \begin_layout Plain Layout
1657 File\SpecialChar menuseparator
1658 Export
1659 \end_layout
1660
1661 \end_inset
1662
1663  menu.
1664  The format will also appear in the
1665 \begin_inset Flex Noun
1666 status collapsed
1667
1668 \begin_layout Plain Layout
1669 Document\SpecialChar menuseparator
1670 View
1671 \end_layout
1672
1673 \end_inset
1674
1675  menu if a viewer is specified for the format.
1676  Pure image formats, such as
1677 \begin_inset Flex Code
1678 status collapsed
1679
1680 \begin_layout Plain Layout
1681 png
1682 \end_layout
1683
1684 \end_inset
1685
1686 , should not use this option.
1687  Formats that can both represent vector graphics and documents like
1688 \begin_inset Flex Code
1689 status collapsed
1690
1691 \begin_layout Plain Layout
1692 pdf
1693 \end_layout
1694
1695 \end_inset
1696
1697  should use it.
1698 \end_layout
1699
1700 \begin_layout Standard
1701 The option
1702 \begin_inset Flex Noun
1703 status collapsed
1704
1705 \begin_layout Plain Layout
1706 Vector graphics format
1707 \end_layout
1708
1709 \end_inset
1710
1711  tells \SpecialChar LyX
1712  that a format can contain vector graphics.
1713  This information is used to determine the target format of included graphics
1714  for
1715 \begin_inset Flex Noun
1716 status collapsed
1717
1718 \begin_layout Plain Layout
1719 pdflatex
1720 \end_layout
1721
1722 \end_inset
1723
1724  export.
1725  Included graphics may need to be converted to either
1726 \begin_inset Flex Noun
1727 status collapsed
1728
1729 \begin_layout Plain Layout
1730 pdf
1731 \end_layout
1732
1733 \end_inset
1734
1735 ,
1736 \begin_inset Flex Noun
1737 status collapsed
1738
1739 \begin_layout Plain Layout
1740 png
1741 \end_layout
1742
1743 \end_inset
1744
1745 , or
1746 \begin_inset Flex Noun
1747 status collapsed
1748
1749 \begin_layout Plain Layout
1750 jpg
1751 \end_layout
1752
1753 \end_inset
1754
1755 , since
1756 \begin_inset Flex Noun
1757 status collapsed
1758
1759 \begin_layout Plain Layout
1760 pdflatex
1761 \end_layout
1762
1763 \end_inset
1764
1765  cannot handle other image formats.
1766  If an included graphic is not already in
1767 \begin_inset Flex Noun
1768 status collapsed
1769
1770 \begin_layout Plain Layout
1771 pdf
1772 \end_layout
1773
1774 \end_inset
1775
1776 ,
1777 \begin_inset Flex Noun
1778 status collapsed
1779
1780 \begin_layout Plain Layout
1781 png
1782 \end_layout
1783
1784 \end_inset
1785
1786 , or
1787 \begin_inset Flex Noun
1788 status collapsed
1789
1790 \begin_layout Plain Layout
1791 jpg
1792 \end_layout
1793
1794 \end_inset
1795
1796  format, it is converted to
1797 \begin_inset Flex Noun
1798 status collapsed
1799
1800 \begin_layout Plain Layout
1801 pdf
1802 \end_layout
1803
1804 \end_inset
1805
1806  if the vector format option is set, and otherwise to
1807 \begin_inset Flex Noun
1808 status collapsed
1809
1810 \begin_layout Plain Layout
1811 png
1812 \end_layout
1813
1814 \end_inset
1815
1816 .
1817 \end_layout
1818
1819 \begin_layout Section
1820 Copiers
1821 \end_layout
1822
1823 \begin_layout Standard
1824 Since all conversions from one format to another take place in \SpecialChar LyX
1825 's temporary
1826  directory, it is sometimes necessary to modify a file before copying it
1827  to the temporary directory in order that the conversion may be performed.
1828 \begin_inset Foot
1829 status collapsed
1830
1831 \begin_layout Plain Layout
1832 For example, the file may refer to other files—images, for example—using
1833  relative file names, and these may become invalid when the file is copied
1834  to the temporary directory.
1835 \end_layout
1836
1837 \end_inset
1838
1839  This is done by a Copier: It copies a file to (or from) the temporary directory
1840  and may modify it in the process.
1841 \end_layout
1842
1843 \begin_layout Standard
1844 The definitions of the copiers may use eight variables:
1845 \end_layout
1846
1847 \begin_layout Labeling
1848 \labelwidthstring 00.00.0000
1849 \begin_inset Flex Code
1850 status collapsed
1851
1852 \begin_layout Plain Layout
1853 $$s
1854 \end_layout
1855
1856 \end_inset
1857
1858  The \SpecialChar LyX
1859  system directory (e.
1860 \begin_inset space \thinspace{}
1861 \end_inset
1862
1863 g.
1864 \begin_inset space \space{}
1865 \end_inset
1866
1867
1868 \begin_inset Flex Noun
1869 status collapsed
1870
1871 \begin_layout Plain Layout
1872 /usr/share/lyx
1873 \end_layout
1874
1875 \end_inset
1876
1877 ).
1878 \end_layout
1879
1880 \begin_layout Labeling
1881 \labelwidthstring 00.00.0000
1882 \begin_inset Flex Code
1883 status collapsed
1884
1885 \begin_layout Plain Layout
1886 $$i
1887 \end_layout
1888
1889 \end_inset
1890
1891  The input file
1892 \end_layout
1893
1894 \begin_layout Labeling
1895 \labelwidthstring 00.00.0000
1896 \begin_inset Flex Code
1897 status collapsed
1898
1899 \begin_layout Plain Layout
1900 $$o
1901 \end_layout
1902
1903 \end_inset
1904
1905  The output file
1906 \end_layout
1907
1908 \begin_layout Labeling
1909 \labelwidthstring 00.00.0000
1910 \begin_inset Flex Code
1911 status collapsed
1912
1913 \begin_layout Plain Layout
1914 $$b
1915 \end_layout
1916
1917 \end_inset
1918
1919  The base name (without filename extension) in the \SpecialChar LyX
1920  temporary directory
1921 \end_layout
1922
1923 \begin_layout Labeling
1924 \labelwidthstring 00.00.0000
1925 \begin_inset Flex Code
1926 status collapsed
1927
1928 \begin_layout Plain Layout
1929 $$p
1930 \end_layout
1931
1932 \end_inset
1933
1934  The full directory path of the \SpecialChar LyX
1935  temporary directory
1936 \end_layout
1937
1938 \begin_layout Labeling
1939 \labelwidthstring 00.00.0000
1940 \begin_inset Flex Code
1941 status collapsed
1942
1943 \begin_layout Plain Layout
1944 $$r
1945 \end_layout
1946
1947 \end_inset
1948
1949  The full pathname to the original \SpecialChar LyX
1950  file being processed
1951 \end_layout
1952
1953 \begin_layout Labeling
1954 \labelwidthstring 00.00.0000
1955 \begin_inset Flex Code
1956 status collapsed
1957
1958 \begin_layout Plain Layout
1959 $$f
1960 \end_layout
1961
1962 \end_inset
1963
1964  The filename (without any directory path) of the \SpecialChar LyX
1965  file.
1966 \end_layout
1967
1968 \begin_layout Labeling
1969 \labelwidthstring 00.00.0000
1970 \begin_inset Flex Code
1971 status collapsed
1972
1973 \begin_layout Plain Layout
1974 $$l
1975 \end_layout
1976
1977 \end_inset
1978
1979  The `\SpecialChar LaTeX
1980  name'
1981 \end_layout
1982
1983 \begin_layout Standard
1984 The latter should be the filename as it would be used in a \SpecialChar LaTeX
1985 's
1986 \series bold
1987
1988 \backslash
1989 include
1990 \series default
1991  command.
1992  It is relevant only when exporting files suitable for such inclusion.
1993 \end_layout
1994
1995 \begin_layout Standard
1996 Copiers can be used to do almost anything with output files.
1997  For example, suppose you want generated pdf files to be copied to a special
1998  directory,
1999 \begin_inset Flex Code
2000 status collapsed
2001
2002 \begin_layout Plain Layout
2003 /home/you/pdf/
2004 \end_layout
2005
2006 \end_inset
2007
2008 .
2009  Then you could write a shell script such as this one:
2010 \end_layout
2011
2012 \begin_layout Standard
2013 \begin_inset listings
2014 inline false
2015 status open
2016
2017 \begin_layout Plain Layout
2018
2019 #!/bin/bash
2020 \end_layout
2021
2022 \begin_layout Plain Layout
2023
2024 FROMFILE=$1
2025 \end_layout
2026
2027 \begin_layout Plain Layout
2028
2029 TOFILE=`basename $2`
2030 \end_layout
2031
2032 \begin_layout Plain Layout
2033
2034 cp $FROMFILE /home/you/pdf/$TOFILE
2035 \end_layout
2036
2037 \end_inset
2038
2039 Save it in your local \SpecialChar LyX
2040  directory—say,
2041 \begin_inset Flex Code
2042 status collapsed
2043
2044 \begin_layout Plain Layout
2045 /home/you/.lyx/scripts/pdfcopier.sh
2046 \end_layout
2047
2048 \end_inset
2049
2050 —and make it executable, if you need to do so on your platform.
2051  Then, in the
2052 \begin_inset Flex Noun
2053 status collapsed
2054
2055 \begin_layout Plain Layout
2056 Tools\SpecialChar menuseparator
2057 Preferences
2058 \end_layout
2059
2060 \end_inset
2061
2062  dialog, select under
2063 \begin_inset Flex Noun
2064 status collapsed
2065
2066 \begin_layout Plain Layout
2067 File Handling\SpecialChar menuseparator
2068 File formats
2069 \end_layout
2070
2071 \end_inset
2072
2073  the
2074 \begin_inset Flex Noun
2075 status collapsed
2076
2077 \begin_layout Plain Layout
2078 PDF(pdflatex)
2079 \end_layout
2080
2081 \end_inset
2082
2083  format—or one of the other pdf formats—and enter
2084 \begin_inset Flex Code
2085 status collapsed
2086
2087 \begin_layout Plain Layout
2088 pdfcopier.sh $$i $$o
2089 \end_layout
2090
2091 \end_inset
2092
2093  into the
2094 \begin_inset Flex Noun
2095 status collapsed
2096
2097 \begin_layout Plain Layout
2098 Copier
2099 \end_layout
2100
2101 \end_inset
2102
2103  field.
2104
2105 \end_layout
2106
2107 \begin_layout Standard
2108 Copiers are used by \SpecialChar LyX
2109  in various of its own conversions.
2110  For example, if appropriate programs are found, \SpecialChar LyX
2111  will automatically install
2112  copiers for the
2113 \begin_inset Flex Noun
2114 status collapsed
2115
2116 \begin_layout Plain Layout
2117 HTML
2118 \end_layout
2119
2120 \end_inset
2121
2122  and
2123 \begin_inset Flex Noun
2124 status collapsed
2125
2126 \begin_layout Plain Layout
2127 HTML
2128 \begin_inset space ~
2129 \end_inset
2130
2131 (MS Word)
2132 \end_layout
2133
2134 \end_inset
2135
2136  formats.
2137  When these formats are exported, the copier sees that not just the main
2138  HTML file but various associated files (style files, images, etc.) are also
2139  copied.
2140  All these files are written to a subdirectory of the directory in which
2141  the original \SpecialChar LyX
2142  file was found.
2143 \begin_inset Foot
2144 status collapsed
2145
2146 \begin_layout Plain Layout
2147 This copier can be customized.
2148  The optional
2149 \begin_inset Quotes eld
2150 \end_inset
2151
2152 -e
2153 \begin_inset Quotes erd
2154 \end_inset
2155
2156  argument takes a comma-separated list of extensions to be copied; if it
2157  is omitted, all files will be copied.
2158  The
2159 \begin_inset Quotes eld
2160 \end_inset
2161
2162 -t
2163 \begin_inset Quotes erd
2164 \end_inset
2165
2166  argument determines the extension added to the generated directory.
2167  By default, it is
2168 \begin_inset Quotes eld
2169 \end_inset
2170
2171
2172 \begin_inset Flex Noun
2173 status collapsed
2174
2175 \begin_layout Plain Layout
2176 LyXconv
2177 \end_layout
2178
2179 \end_inset
2180
2181
2182 \begin_inset Quotes erd
2183 \end_inset
2184
2185 , so HTML generated from
2186 \begin_inset Flex Noun
2187 status collapsed
2188
2189 \begin_layout Plain Layout
2190 /path/to/filename.lyx
2191 \end_layout
2192
2193 \end_inset
2194
2195  will end up in
2196 \begin_inset Flex Noun
2197 status collapsed
2198
2199 \begin_layout Plain Layout
2200 /path/to/filename.html.LyXconv
2201 \end_layout
2202
2203 \end_inset
2204
2205 .
2206
2207 \end_layout
2208
2209 \end_inset
2210
2211
2212 \end_layout
2213
2214 \begin_layout Section
2215 Converters
2216 \begin_inset CommandInset label
2217 LatexCommand label
2218 name "sec:Converters"
2219
2220 \end_inset
2221
2222
2223 \end_layout
2224
2225 \begin_layout Standard
2226 You can define your own Converters to convert files between different formats.
2227  This is done in the
2228 \begin_inset Flex Noun
2229 status collapsed
2230
2231 \begin_layout Plain Layout
2232 Tools\SpecialChar menuseparator
2233 Preferences\SpecialChar menuseparator
2234 File Handling\SpecialChar menuseparator
2235 Converters
2236 \end_layout
2237
2238 \end_inset
2239
2240  dialog.
2241 \end_layout
2242
2243 \begin_layout Standard
2244 To define a new converter, select the
2245 \begin_inset Flex Noun
2246 status collapsed
2247
2248 \begin_layout Plain Layout
2249 From
2250 \begin_inset space ~
2251 \end_inset
2252
2253 format
2254 \end_layout
2255
2256 \end_inset
2257
2258  and
2259 \begin_inset Flex Noun
2260 status collapsed
2261
2262 \begin_layout Plain Layout
2263 To
2264 \begin_inset space ~
2265 \end_inset
2266
2267 format
2268 \end_layout
2269
2270 \end_inset
2271
2272  from the drop-down lists, enter the command needed for the conversion,
2273  and then press the
2274 \begin_inset Flex Noun
2275 status collapsed
2276
2277 \begin_layout Plain Layout
2278 Add
2279 \end_layout
2280
2281 \end_inset
2282
2283  button.
2284  Several variables can be used in the definition of converters:
2285 \end_layout
2286
2287 \begin_layout Labeling
2288 \labelwidthstring 00.00.0000
2289 \begin_inset Flex Code
2290 status collapsed
2291
2292 \begin_layout Plain Layout
2293 $$s
2294 \end_layout
2295
2296 \end_inset
2297
2298  The \SpecialChar LyX
2299  system directory
2300 \end_layout
2301
2302 \begin_layout Labeling
2303 \labelwidthstring 00.00.0000
2304 \begin_inset Flex Code
2305 status collapsed
2306
2307 \begin_layout Plain Layout
2308 $$i
2309 \end_layout
2310
2311 \end_inset
2312
2313  The input file
2314 \end_layout
2315
2316 \begin_layout Labeling
2317 \labelwidthstring 00.00.0000
2318 \begin_inset Flex Code
2319 status collapsed
2320
2321 \begin_layout Plain Layout
2322 $$o
2323 \end_layout
2324
2325 \end_inset
2326
2327  The output file
2328 \end_layout
2329
2330 \begin_layout Labeling
2331 \labelwidthstring 00.00.0000
2332 \begin_inset Flex Code
2333 status collapsed
2334
2335 \begin_layout Plain Layout
2336 $$b
2337 \end_layout
2338
2339 \end_inset
2340
2341  The base filename of the input file (i.
2342 \begin_inset space \thinspace{}
2343 \end_inset
2344
2345 g., without the extension)
2346 \end_layout
2347
2348 \begin_layout Labeling
2349 \labelwidthstring 00.00.0000
2350 \begin_inset Flex Code
2351 status collapsed
2352
2353 \begin_layout Plain Layout
2354 $$p
2355 \end_layout
2356
2357 \end_inset
2358
2359  The path to the input file
2360 \end_layout
2361
2362 \begin_layout Labeling
2363 \labelwidthstring 00.00.0000
2364 \begin_inset Flex Code
2365 status collapsed
2366
2367 \begin_layout Plain Layout
2368 $$r
2369 \end_layout
2370
2371 \end_inset
2372
2373  The path to the original input file (this is different from $$p when a
2374  chain of converters is called)
2375 \end_layout
2376
2377 \begin_layout Labeling
2378 \labelwidthstring 00.00.0000
2379 \begin_inset Flex Code
2380 status collapsed
2381
2382 \begin_layout Plain Layout
2383 $$e
2384 \end_layout
2385
2386 \end_inset
2387
2388  The iconv name for the encoding of the document.
2389 \end_layout
2390
2391 \begin_layout Standard
2392 In the
2393 \begin_inset Flex Noun
2394 status collapsed
2395
2396 \begin_layout Plain Layout
2397 Extra
2398 \begin_inset space ~
2399 \end_inset
2400
2401 Flag
2402 \end_layout
2403
2404 \end_inset
2405
2406  field you can enter the following flags, separated by commas:
2407 \end_layout
2408
2409 \begin_layout Labeling
2410 \labelwidthstring 00.00.0000
2411 \begin_inset Flex Code
2412 status collapsed
2413
2414 \begin_layout Plain Layout
2415 latex
2416 \change_inserted -712698321 1524656940
2417 =flavor
2418 \change_unchanged
2419
2420 \end_layout
2421
2422 \end_inset
2423
2424  This converter runs some form of \SpecialChar LaTeX
2425 .
2426  This will make \SpecialChar LyX
2427 's \SpecialChar LaTeX
2428  error logs available.
2429
2430 \change_inserted -712698321 1524657018
2431  The optional
2432 \begin_inset Flex Code
2433 status open
2434
2435 \begin_layout Plain Layout
2436
2437 \change_inserted -712698321 1524657012
2438 flavor
2439 \change_unchanged
2440
2441 \end_layout
2442
2443 \end_inset
2444
2445  value specifies the form of \SpecialChar LaTeX
2446  that is run (
2447 \begin_inset Flex Code
2448 status open
2449
2450 \begin_layout Plain Layout
2451
2452 \change_inserted -712698321 1524657005
2453 latex, pdflatex, platex, xetex, luatex
2454 \change_unchanged
2455
2456 \end_layout
2457
2458 \end_inset
2459
2460 ).
2461  If no value is specified,
2462 \begin_inset Flex Code
2463 status open
2464
2465 \begin_layout Plain Layout
2466
2467 \change_inserted -712698321 1524657018
2468 latex
2469 \change_unchanged
2470
2471 \end_layout
2472
2473 \end_inset
2474
2475  is used.
2476 \change_unchanged
2477
2478 \end_layout
2479
2480 \begin_layout Labeling
2481 \labelwidthstring 00.00.0000
2482 \begin_inset Flex Code
2483 status collapsed
2484
2485 \begin_layout Plain Layout
2486 needaux
2487 \change_inserted -712698321 1524656935
2488 =flavor
2489 \change_unchanged
2490
2491 \end_layout
2492
2493 \end_inset
2494
2495  Needs the \SpecialChar LaTeX
2496
2497 \begin_inset Flex Noun
2498 status collapsed
2499
2500 \begin_layout Plain Layout
2501 .aux
2502 \end_layout
2503
2504 \end_inset
2505
2506  file for the conversion.
2507
2508 \change_inserted -712698321 1524657047
2509  The optional
2510 \begin_inset Flex Code
2511 status open
2512
2513 \begin_layout Plain Layout
2514
2515 \change_inserted -712698321 1524657030
2516 flavor
2517 \end_layout
2518
2519 \end_inset
2520
2521  value specifies the form of \SpecialChar LaTeX
2522  that is run in order to generate the
2523 \begin_inset Flex Noun
2524 status collapsed
2525
2526 \begin_layout Plain Layout
2527
2528 \change_inserted -712698321 1524657047
2529 .aux
2530 \end_layout
2531
2532 \end_inset
2533
2534  file (
2535 \begin_inset Flex Code
2536 status open
2537
2538 \begin_layout Plain Layout
2539
2540 \change_inserted -712698321 1524657030
2541 latex, pdflatex, platex, xetex, luatex
2542 \end_layout
2543
2544 \end_inset
2545
2546 ).
2547  If no value is specified,
2548 \begin_inset Flex Code
2549 status open
2550
2551 \begin_layout Plain Layout
2552
2553 \change_inserted -712698321 1524657030
2554 latex
2555 \end_layout
2556
2557 \end_inset
2558
2559  is used.
2560 \change_unchanged
2561
2562 \end_layout
2563
2564 \begin_layout Labeling
2565 \labelwidthstring 00.00.0000
2566 \begin_inset Flex Code
2567 status collapsed
2568
2569 \begin_layout Plain Layout
2570 nice
2571 \end_layout
2572
2573 \end_inset
2574
2575  Needs a
2576 \begin_inset Quotes eld
2577 \end_inset
2578
2579 nice
2580 \begin_inset Quotes erd
2581 \end_inset
2582
2583  file from the backend, which in practice means a \SpecialChar LaTeX
2584  file like the one we
2585  would export, without
2586 \begin_inset Flex Code
2587 status collapsed
2588
2589 \begin_layout Plain Layout
2590 input@path
2591 \end_layout
2592
2593 \end_inset
2594
2595 .
2596 \end_layout
2597
2598 \begin_layout Labeling
2599 \labelwidthstring 00.00.0000
2600 \begin_inset Flex Code
2601 status collapsed
2602
2603 \begin_layout Plain Layout
2604 xml
2605 \end_layout
2606
2607 \end_inset
2608
2609  Output is XML.
2610 \end_layout
2611
2612 \begin_layout Standard
2613 The following three flags are not really flags at all because they take
2614  an argument in the
2615 \begin_inset Flex Noun
2616 status collapsed
2617
2618 \begin_layout Plain Layout
2619 key
2620 \begin_inset space ~
2621 \end_inset
2622
2623 =
2624 \begin_inset space ~
2625 \end_inset
2626
2627 value
2628 \end_layout
2629
2630 \end_inset
2631
2632  format:
2633 \end_layout
2634
2635 \begin_layout Labeling
2636 \labelwidthstring 00.00.0000
2637
2638 \change_inserted -712698321 1523206314
2639 \begin_inset Flex Code
2640 status collapsed
2641
2642 \begin_layout Plain Layout
2643
2644 \change_inserted -712698321 1523206193
2645 hyperref-driver
2646 \end_layout
2647
2648 \end_inset
2649
2650  The name of the driver that needs to be loaded with the
2651 \family sans
2652 hyperref
2653 \family default
2654  package for this converter.
2655  The loading of the correct driver is necessary to get some PDF-specific
2656  features.
2657  See the
2658 \family sans
2659 hyperref
2660 \family default
2661  manual for details.
2662 \end_layout
2663
2664 \begin_layout Labeling
2665 \labelwidthstring 00.00.0000
2666 \begin_inset Flex Code
2667 status collapsed
2668
2669 \begin_layout Plain Layout
2670 parselog
2671 \end_layout
2672
2673 \end_inset
2674
2675  If set, the converter's standard error will be redirected to a file
2676 \begin_inset Flex Code
2677 status collapsed
2678
2679 \begin_layout Plain Layout
2680 infile.out
2681 \end_layout
2682
2683 \end_inset
2684
2685 , and the script given as argument will be run as:
2686 \begin_inset Flex Code
2687 status collapsed
2688
2689 \begin_layout Plain Layout
2690 script < infile.out > infile.log
2691 \end_layout
2692
2693 \end_inset
2694
2695 .
2696  The argument may contain
2697 \begin_inset Flex Code
2698 status collapsed
2699
2700 \begin_layout Plain Layout
2701 $$s
2702 \end_layout
2703
2704 \end_inset
2705
2706 .
2707 \end_layout
2708
2709 \begin_layout Labeling
2710 \labelwidthstring 00.00.0000
2711 \begin_inset Flex Code
2712 status collapsed
2713
2714 \begin_layout Plain Layout
2715 resultdir
2716 \end_layout
2717
2718 \end_inset
2719
2720  The name of the directory in which the converter will dump the generated
2721  files.
2722  \SpecialChar LyX
2723  will not create this directory, and it does not copy anything into it,
2724  though it will copy this directory to the destination.
2725  The argument may contain
2726 \begin_inset Flex Code
2727 status collapsed
2728
2729 \begin_layout Plain Layout
2730 $$b
2731 \end_layout
2732
2733 \end_inset
2734
2735 , which will be replaced by the base name of the input and output files,
2736  respectively, when the directory is copied.
2737 \begin_inset Newline newline
2738 \end_inset
2739
2740 Note that resultdir and usetempdir make no sense together.
2741  The latter will be ignored if the former is given.
2742 \end_layout
2743
2744 \begin_layout Labeling
2745 \labelwidthstring 00.00.0000
2746 \begin_inset Flex Code
2747 status collapsed
2748
2749 \begin_layout Plain Layout
2750 resultfile
2751 \end_layout
2752
2753 \end_inset
2754
2755  Determines the output file name and may, contain
2756 \begin_inset Flex Code
2757 status collapsed
2758
2759 \begin_layout Plain Layout
2760 $$b
2761 \end_layout
2762
2763 \end_inset
2764
2765 .
2766  Sensible only with resultdir and optional even then; if not given, it defaults
2767  to `index'.
2768 \end_layout
2769
2770 \begin_layout Standard
2771
2772 \change_inserted -712698321 1523206384
2773 A suitable hyperref-driver is set for some converters that are installed
2774  with \SpecialChar LyX
2775 .
2776
2777 \change_deleted -712698321 1523206388
2778 None of these
2779 \change_inserted -712698321 1523206389
2780 The
2781 \change_unchanged
2782  last three
2783 \change_inserted -712698321 1523206400
2784  flags, however,
2785 \change_unchanged
2786  are presently
2787 \change_inserted -712698321 1523206407
2788 not
2789 \change_unchanged
2790 used in any of the
2791 \change_inserted -712698321 1523206437
2792 pre-installed
2793 \change_unchanged
2794 converters
2795 \change_deleted -712698321 1523206442
2796  that are installed with \SpecialChar LyX
2797
2798 \change_unchanged
2799 .
2800
2801 \end_layout
2802
2803 \begin_layout Standard
2804 You do not have to define converters for all formats between which you want
2805  to convert.
2806  For example, you will note that there is no `\SpecialChar LyX
2807  to PostScript' converter,
2808  but \SpecialChar LyX
2809  will export PostScript.
2810  It does so by first creating a \SpecialChar LaTeX
2811  file (no converter needs to be defined
2812  for this) which is then converted to DVI using the `\SpecialChar LaTeX
2813  to DVI' converter,
2814  and finally converting the resulting DVI file to PostScript.
2815  \SpecialChar LyX
2816  finds such `chains' of converters automatically, and it will always choose
2817  the shortest possible chain.
2818  You can, though, still define multiple conversion methods between file
2819  formats.
2820  For example, the standard \SpecialChar LyX
2821  configuration provides five ways to convert
2822  \SpecialChar LaTeX
2823  to PDF:
2824 \end_layout
2825
2826 \begin_layout Enumerate
2827 Directly, using
2828 \begin_inset Flex Noun
2829 status collapsed
2830
2831 \begin_layout Plain Layout
2832 pdflatex
2833 \end_layout
2834
2835 \end_inset
2836
2837
2838 \end_layout
2839
2840 \begin_layout Enumerate
2841 via (DVI and) PostScript, using
2842 \begin_inset Flex Noun
2843 status collapsed
2844
2845 \begin_layout Plain Layout
2846 ps2pdf
2847 \end_layout
2848
2849 \end_inset
2850
2851
2852 \end_layout
2853
2854 \begin_layout Enumerate
2855 via DVI, using
2856 \begin_inset Flex Noun
2857 status collapsed
2858
2859 \begin_layout Plain Layout
2860 dvipdfm
2861 \end_layout
2862
2863 \end_inset
2864
2865
2866 \end_layout
2867
2868 \begin_layout Enumerate
2869 directly using
2870 \begin_inset Flex Noun
2871 status collapsed
2872
2873 \begin_layout Plain Layout
2874 Xe\SpecialChar TeX
2875
2876 \end_layout
2877
2878 \end_inset
2879
2880
2881 \end_layout
2882
2883 \begin_layout Enumerate
2884 directly using
2885 \begin_inset Flex Noun
2886 status collapsed
2887
2888 \begin_layout Plain Layout
2889 Lua\SpecialChar TeX
2890
2891 \end_layout
2892
2893 \end_inset
2894
2895
2896 \end_layout
2897
2898 \begin_layout Standard
2899 To define such alternate chains, you must define multiple target `file formats',
2900  as described in
2901 \begin_inset CommandInset ref
2902 LatexCommand ref
2903 reference "sec:Formats"
2904
2905 \end_inset
2906
2907 .
2908  For example, in the standard configuration, the formats named
2909 \begin_inset Flex Noun
2910 status collapsed
2911
2912 \begin_layout Plain Layout
2913 pdf
2914 \end_layout
2915
2916 \end_inset
2917
2918  (for
2919 \begin_inset Flex Noun
2920 status collapsed
2921
2922 \begin_layout Plain Layout
2923 ps2pdf
2924 \end_layout
2925
2926 \end_inset
2927
2928 ),
2929 \begin_inset Flex Noun
2930 status collapsed
2931
2932 \begin_layout Plain Layout
2933 pdf2
2934 \end_layout
2935
2936 \end_inset
2937
2938  (for
2939 \begin_inset Flex Noun
2940 status collapsed
2941
2942 \begin_layout Plain Layout
2943 pdflatex
2944 \end_layout
2945
2946 \end_inset
2947
2948 ),
2949 \begin_inset Flex Noun
2950 status collapsed
2951
2952 \begin_layout Plain Layout
2953 pdf3
2954 \end_layout
2955
2956 \end_inset
2957
2958  (for
2959 \begin_inset Flex Noun
2960 status collapsed
2961
2962 \begin_layout Plain Layout
2963 dvipdfm
2964 \end_layout
2965
2966 \end_inset
2967
2968 ),
2969 \begin_inset Flex Noun
2970 status collapsed
2971
2972 \begin_layout Plain Layout
2973 pdf4
2974 \end_layout
2975
2976 \end_inset
2977
2978  (for
2979 \begin_inset Flex Noun
2980 status collapsed
2981
2982 \begin_layout Plain Layout
2983 Xe\SpecialChar TeX
2984
2985 \end_layout
2986
2987 \end_inset
2988
2989 ), and
2990 \begin_inset Flex Noun
2991 status collapsed
2992
2993 \begin_layout Plain Layout
2994 pdf5
2995 \end_layout
2996
2997 \end_inset
2998
2999  (for
3000 \begin_inset Flex Noun
3001 status collapsed
3002
3003 \begin_layout Plain Layout
3004 Lua\SpecialChar TeX
3005
3006 \end_layout
3007
3008 \end_inset
3009
3010 ) are defined, all of which share the extension
3011 \begin_inset Flex Noun
3012 status collapsed
3013
3014 \begin_layout Plain Layout
3015 .pdf
3016 \end_layout
3017
3018 \end_inset
3019
3020 , and which correspond to the conversion methods just mentioned.
3021 \end_layout
3022
3023 \begin_layout Chapter
3024 Internationalizing \SpecialChar LyX
3025
3026 \begin_inset CommandInset label
3027 LatexCommand label
3028 name "cha:Internationalizing-LyX"
3029
3030 \end_inset
3031
3032
3033 \end_layout
3034
3035 \begin_layout Standard
3036 \SpecialChar LyX
3037  supports using a translated interface.
3038  Last time we checked, \SpecialChar LyX
3039  provided text in thirty languages.
3040  The language of choice is called your
3041 \emph on
3042 locale
3043 \emph default
3044 .
3045  (For further reading on locale settings, see also the documentation for
3046  locale that comes with your operating system.
3047  For Linux, the manual page for
3048 \begin_inset Flex Code
3049 status collapsed
3050
3051 \begin_layout Plain Layout
3052 locale(5)
3053 \end_layout
3054
3055 \end_inset
3056
3057  could be a good place to start).
3058 \end_layout
3059
3060 \begin_layout Standard
3061 Notice that these translations will work, but do contain a few flaws.
3062  In particular, all dialogs have been designed with the English text in
3063  mind, which means that some of the translated text will be too large to
3064  fit within the space allocated.
3065  This is only a display problem and will not cause any harm.
3066  Also, you will find that some of the translations do not define shortcut
3067  keys for everything.
3068  Sometimes, there are simply not enough free letters to do it.
3069  Other times, the translator just hasn't got around to doing it yet.
3070  Our localization team, which you may wish to join,
3071 \begin_inset Foot
3072 status collapsed
3073
3074 \begin_layout Plain Layout
3075 If you are a fluent speaker of a language other than English, joining these
3076  teams is a great way to give back to the \SpecialChar LyX
3077  community!
3078 \end_layout
3079
3080 \end_inset
3081
3082  will of course try to fix these shortcomings in future versions of \SpecialChar LyX
3083 .
3084 \end_layout
3085
3086 \begin_layout Section
3087 Translating \SpecialChar LyX
3088
3089 \end_layout
3090
3091 \begin_layout Subsection
3092 Translating the graphical user interface (text messages).
3093 \end_layout
3094
3095 \begin_layout Standard
3096 \SpecialChar LyX
3097  uses the GNU
3098 \begin_inset Flex Code
3099 status collapsed
3100
3101 \begin_layout Plain Layout
3102 gettext
3103 \end_layout
3104
3105 \end_inset
3106
3107  library to handle the internationalization of the interface.
3108  To have \SpecialChar LyX
3109  speak your favorite language in all menus and dialogs, you need
3110  a
3111 \begin_inset Flex Code
3112 status collapsed
3113
3114 \begin_layout Plain Layout
3115 po
3116 \end_layout
3117
3118 \end_inset
3119
3120 -file for that language.
3121  When this is available, you'll have to generate a
3122 \begin_inset Flex Code
3123 status collapsed
3124
3125 \begin_layout Plain Layout
3126 mo
3127 \end_layout
3128
3129 \end_inset
3130
3131 -file from it and install the
3132 \begin_inset Flex Code
3133 status collapsed
3134
3135 \begin_layout Plain Layout
3136 mo
3137 \end_layout
3138
3139 \end_inset
3140
3141 -file.
3142  The process of doing all of this is explained in the documentation for
3143  GNU
3144 \begin_inset Flex Code
3145 status collapsed
3146
3147 \begin_layout Plain Layout
3148 gettext
3149 \end_layout
3150
3151 \end_inset
3152
3153 .
3154  It is possible to do this just for yourself, but if you're going to do
3155  it, you might as well share the results of your labors with the rest of
3156  the \SpecialChar LyX
3157  community.
3158  Send a message to the \SpecialChar LyX
3159  developers' list for more information about how
3160  to proceed.
3161 \end_layout
3162
3163 \begin_layout Standard
3164 In short, this is what you should do (xx denotes the language code):
3165 \end_layout
3166
3167 \begin_layout Itemize
3168 Check out the \SpecialChar LyX
3169  source code.
3170  (See the
3171 \begin_inset CommandInset href
3172 LatexCommand href
3173 name "information on the web"
3174 target "https://www.lyx.org/HowToUseGIT"
3175 literal "false"
3176
3177 \end_inset
3178
3179 .)
3180 \end_layout
3181
3182 \begin_layout Itemize
3183 Copy the file
3184 \begin_inset Flex Code
3185 status collapsed
3186
3187 \begin_layout Plain Layout
3188 lyx.pot
3189 \end_layout
3190
3191 \end_inset
3192
3193  to the folder of the
3194 \begin_inset Flex Code
3195 status collapsed
3196
3197 \begin_layout Plain Layout
3198 **.po
3199 \end_layout
3200
3201 \end_inset
3202
3203  files.
3204  Then rename it to
3205 \begin_inset Flex Code
3206 status collapsed
3207
3208 \begin_layout Plain Layout
3209 xx.po
3210 \end_layout
3211
3212 \end_inset
3213
3214 .
3215  (If
3216 \begin_inset Flex Code
3217 status collapsed
3218
3219 \begin_layout Plain Layout
3220 lyx.pot
3221 \end_layout
3222
3223 \end_inset
3224
3225  doesn't exist anywhere, it can be remade with the console command
3226 \begin_inset Flex Code
3227 status collapsed
3228
3229 \begin_layout Plain Layout
3230 make lyx.pot
3231 \end_layout
3232
3233 \end_inset
3234
3235  in that directory, or you can use an existing po-file for some other language
3236  as a template).
3237 \end_layout
3238
3239 \begin_layout Itemize
3240 Edit
3241 \begin_inset Flex Code
3242 status collapsed
3243
3244 \begin_layout Plain Layout
3245 xx.po
3246 \end_layout
3247
3248 \end_inset
3249
3250 .
3251 \begin_inset Foot
3252 status collapsed
3253
3254 \begin_layout Plain Layout
3255 This is just a text file, so it can be edited in any text editor.
3256  But there are also specialized programs that support such editing, such
3257  as
3258 \family typewriter
3259 Poedit
3260 \family default
3261  (for all platforms) or
3262 \family typewriter
3263 KBabel
3264 \family default
3265  (for KDE).
3266
3267 \family typewriter
3268 Emacs
3269 \family default
3270  contains a `mode' for editing
3271 \begin_inset Flex Code
3272 status collapsed
3273
3274 \begin_layout Plain Layout
3275 po
3276 \end_layout
3277
3278 \end_inset
3279
3280  files, as well, see
3281 \begin_inset Flex URL
3282 status open
3283
3284 \begin_layout Plain Layout
3285
3286 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html#PO-Mode
3287 \end_layout
3288
3289 \end_inset
3290
3291 .
3292 \end_layout
3293
3294 \end_inset
3295
3296  For some menu- and widget-labels, there are also shortcut keys that should
3297  be translated.
3298  Those keys are marked after a `|', and should be translated according to
3299  the words and phrases of the language.
3300  You should also fill also out the information at the beginning of the new
3301
3302 \begin_inset Flex Code
3303 status collapsed
3304
3305 \begin_layout Plain Layout
3306 po
3307 \end_layout
3308
3309 \end_inset
3310
3311 -file with your email-address, etc., so people know where to reach you with
3312  suggestions and entertaining flames.
3313 \end_layout
3314
3315 \begin_layout Standard
3316 If you are just doing this on your own, then:
3317 \end_layout
3318
3319 \begin_layout Itemize
3320 Generate
3321 \begin_inset Flex Code
3322 status collapsed
3323
3324 \begin_layout Plain Layout
3325 xx.mo
3326 \end_layout
3327
3328 \end_inset
3329
3330 .
3331  This can be done with
3332 \begin_inset Flex Code
3333 status collapsed
3334
3335 \begin_layout Plain Layout
3336 msgfmt -o xx.mo < xx.po
3337 \end_layout
3338
3339 \end_inset
3340
3341 .
3342 \end_layout
3343
3344 \begin_layout Itemize
3345 Copy the
3346 \begin_inset Flex Code
3347 status collapsed
3348
3349 \begin_layout Plain Layout
3350 mo
3351 \end_layout
3352
3353 \end_inset
3354
3355 -file to your locale-tree, at the correct directory for application messages
3356  for the language
3357 \series bold
3358
3359 \series default
3360 xx, and under the name
3361 \begin_inset Flex Code
3362 status collapsed
3363
3364 \begin_layout Plain Layout
3365 lyx.mo
3366 \end_layout
3367
3368 \end_inset
3369
3370  (e.
3371 \begin_inset space \thinspace{}
3372 \end_inset
3373
3374 g.
3375 \begin_inset space \space{}
3376 \end_inset
3377
3378
3379 \begin_inset Flex Code
3380 status collapsed
3381
3382 \begin_layout Plain Layout
3383 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3384 \end_layout
3385
3386 \end_inset
3387
3388
3389 \series bold
3390 .
3391 \end_layout
3392
3393 \begin_layout Standard
3394 As said, however, it would be best if the new
3395 \begin_inset Flex Code
3396 status collapsed
3397
3398 \begin_layout Plain Layout
3399 po
3400 \end_layout
3401
3402 \end_inset
3403
3404  file could be added to the \SpecialChar LyX
3405  distribution, so others can use it.
3406  Adding it involves making additional changes to \SpecialChar LyX
3407 .
3408  So send an email to the developers' mailing list if you're interested in
3409  doing that.
3410 \end_layout
3411
3412 \begin_layout Subsubsection
3413 Ambiguous messages
3414 \end_layout
3415
3416 \begin_layout Standard
3417 Sometimes it turns out that one English message needs to be translated into
3418  different messages in the target language.
3419  One example is the message
3420 \begin_inset Flex Code
3421 status collapsed
3422
3423 \begin_layout Plain Layout
3424 To
3425 \end_layout
3426
3427 \end_inset
3428
3429  which has the German translation
3430 \lang german
3431 Nach
3432 \lang english
3433  or
3434 \lang german
3435 Bis
3436 \lang english
3437 , depending upon exactly what the English
3438 \begin_inset Quotes eld
3439 \end_inset
3440
3441 to
3442 \begin_inset Quotes erd
3443 \end_inset
3444
3445  means.
3446  GNU
3447 \begin_inset Flex Code
3448 status collapsed
3449
3450 \begin_layout Plain Layout
3451 gettext
3452 \end_layout
3453
3454 \end_inset
3455
3456  does not handle such ambiguous translations.
3457  Therefore you have to add some context information to the message: Instead
3458  of
3459 \begin_inset Flex Code
3460 status collapsed
3461
3462 \begin_layout Plain Layout
3463 To
3464 \end_layout
3465
3466 \end_inset
3467
3468  it becomes
3469 \begin_inset Flex Code
3470 status collapsed
3471
3472 \begin_layout Plain Layout
3473 To[[as in 'From format x to format y']]
3474 \end_layout
3475
3476 \end_inset
3477
3478  and
3479 \begin_inset Flex Code
3480 status collapsed
3481
3482 \begin_layout Plain Layout
3483 To[[as in 'From page x to page y']].
3484 \end_layout
3485
3486 \end_inset
3487
3488  Now the two occurrences of
3489 \begin_inset Flex Code
3490 status collapsed
3491
3492 \begin_layout Plain Layout
3493 To
3494 \end_layout
3495
3496 \end_inset
3497
3498  are different for
3499 \begin_inset Flex Code
3500 status collapsed
3501
3502 \begin_layout Plain Layout
3503 gettext
3504 \end_layout
3505
3506 \end_inset
3507
3508  and can be translated correctly to
3509 \lang german
3510 Nach
3511 \lang english
3512  and
3513 \lang german
3514 Bis
3515 \lang english
3516 , respectively.
3517 \end_layout
3518
3519 \begin_layout Standard
3520 Of course the context information needs to be stripped off the original
3521  message when no translation is used.
3522  Therefore you have to put it in double square brackets at the end of the
3523  message (see the example above).
3524  The translation mechanism of \SpecialChar LyX
3525  ensures that everything in double square
3526  brackets at the end of messages is removed before displaying the message.
3527 \end_layout
3528
3529 \begin_layout Subsection
3530 Translating the documentation.
3531 \end_layout
3532
3533 \begin_layout Standard
3534 The online documentation (in the
3535 \begin_inset Flex Noun
3536 status collapsed
3537
3538 \begin_layout Plain Layout
3539 Help
3540 \end_layout
3541
3542 \end_inset
3543
3544 -menu) can (and should!) be translated.
3545  If there are translated versions of the documentation available
3546 \begin_inset Foot
3547 status collapsed
3548
3549 \begin_layout Plain Layout
3550 As of March 2008, at least some of the documents have been translated into
3551  fourteen languages, with the Tutorial available in a few more.
3552 \end_layout
3553
3554 \end_inset
3555
3556  and the locale is set accordingly, these will be used automagically by
3557  \SpecialChar LyX
3558 .
3559  \SpecialChar LyX
3560  looks for translated versions as
3561 \begin_inset Flex Code
3562 status collapsed
3563
3564 \begin_layout Plain Layout
3565 LyXDir/doc/xx/DocName.lyx
3566 \end_layout
3567
3568 \end_inset
3569
3570 , where
3571 \begin_inset Flex Code
3572 status collapsed
3573
3574 \begin_layout Plain Layout
3575 xx
3576 \end_layout
3577
3578 \end_inset
3579
3580  is the code for the language currently in use.
3581  If there are no translated documents, the default English versions will
3582  be displayed.
3583  Note that the translated versions must have the same filenames (
3584 \begin_inset Flex Code
3585 status collapsed
3586
3587 \begin_layout Plain Layout
3588 DocName
3589 \end_layout
3590
3591 \end_inset
3592
3593  above) as the original.
3594  If you feel up to translating the documentation (an excellent way to proof-read
3595  the original documentation by the way!), there are a few things you should
3596  do right away:
3597 \end_layout
3598
3599 \begin_layout Itemize
3600 Check out the documentation translation web page at
3601 \begin_inset CommandInset href
3602 LatexCommand href
3603 name "https://www.lyx.org/Translation"
3604 target "https://www.lyx.org/Translation"
3605 literal "false"
3606
3607 \end_inset
3608
3609 .
3610  That way, you can find out which (if any) documents have already been translate
3611 d into your language.
3612  You can also find out who (if anyone) is organizing the effort to translate
3613  the documentation into your language.
3614  If no one is organizing the effort, please let us know that you're interested.
3615 \end_layout
3616
3617 \begin_layout Standard
3618 Once you get to actually translating, here's a few hints for you that may
3619  save you trouble:
3620 \end_layout
3621
3622 \begin_layout Itemize
3623 Join the documentation team! There is information on how to do that in
3624 \begin_inset Flex Code
3625 status collapsed
3626
3627 \begin_layout Plain Layout
3628 Intro.lyx
3629 \end_layout
3630
3631 \end_inset
3632
3633  (
3634 \begin_inset Flex Noun
3635 status collapsed
3636
3637 \begin_layout Plain Layout
3638 Help\SpecialChar menuseparator
3639 Introduction
3640 \end_layout
3641
3642 \end_inset
3643
3644 ), which by the way is the first document you should translate.
3645 \end_layout
3646
3647 \begin_layout Itemize
3648 Learn the typographic conventions for the language you are translating to.
3649  Typography is an ancient art and over the centuries, a great variety of
3650  conventions have developed throughout different parts of the world.
3651  Also study the professional terminology amongst typographers in your country.
3652  Inventing your own terminology will only confuse the users.
3653
3654 \emph on
3655 (Warning! Typography is addictive!)
3656 \end_layout
3657
3658 \begin_layout Itemize
3659 Make a copy of the document.
3660  This will be your working copy.
3661  You can use this as your personal translated help-file by placing it in
3662  your
3663 \begin_inset Flex Code
3664 status collapsed
3665
3666 \begin_layout Plain Layout
3667 UserDir/doc/xx/
3668 \end_layout
3669
3670 \end_inset
3671
3672  directory.
3673 \begin_inset Note Greyedout
3674 status open
3675
3676 \begin_layout Plain Layout
3677
3678 \series bold
3679 Note:
3680 \series default
3681  For a complex document with external material (images, etc.), if you make
3682  a copy e.
3683 \begin_inset space \thinspace{}
3684 \end_inset
3685
3686 g.
3687 \begin_inset space \space{}
3688 \end_inset
3689
3690 in a temp dir, beware that the links to external material may be broken
3691  when the document is moved to a different place.
3692  The best way is to retrieve the \SpecialChar LyX
3693  tree from git (see
3694 \begin_inset Flex URL
3695 status collapsed
3696
3697 \begin_layout Plain Layout
3698
3699 https://www.lyx.org/HowToUseGIT
3700 \end_layout
3701
3702 \end_inset
3703
3704 ) and to edit the doc file in place.
3705 \end_layout
3706
3707 \end_inset
3708
3709
3710 \end_layout
3711
3712 \begin_layout Itemize
3713 Sometimes the original document (from the \SpecialChar LyX
3714  team) will be updated.
3715  Use the source viewer at
3716 \begin_inset CommandInset href
3717 LatexCommand href
3718 name "https://www.lyx.org/trac/timeline"
3719 target "https://www.lyx.org/trac/timeline"
3720 literal "false"
3721
3722 \end_inset
3723
3724  to see what has been changed.
3725  That way you can easily see which parts of the translated document need
3726  to be updated.
3727 \end_layout
3728
3729 \begin_layout Standard
3730 If you ever find an error in the original document, fix it and notify the
3731  rest of the documentation team of the changes! (You didn't forget to join
3732  the documentation team, did you?)
3733 \end_layout
3734
3735 \begin_layout Standard
3736 \begin_inset Branch OutDated
3737 inverted 0
3738 status collapsed
3739
3740 \begin_layout Section
3741 International Keyboard Support
3742 \end_layout
3743
3744 \begin_layout Standard
3745
3746 \emph on
3747 [Editor's Note: The following section is by
3748 \emph default
3749
3750 \shape smallcaps
3751 \emph on
3752 Ivan Schreter
3753 \shape default
3754 .
3755  It needs to be fixed to conform to the new Documentation Style sheet and
3756  to make use of the new v1.0 features.
3757  The whole thing also needs to be merged with the section following it.-jw
3758  It may also be badly out of date.-rh (2008)]
3759 \end_layout
3760
3761 \begin_layout Subsection
3762 Defining Own Keymaps: Keymap File Format
3763 \end_layout
3764
3765 \begin_layout Standard
3766 Let's look at a keyboard definition file a little closer.
3767  It is a plain text file defining
3768 \end_layout
3769
3770 \begin_layout Itemize
3771 key-to-key or key-to-string translations
3772 \end_layout
3773
3774 \begin_layout Itemize
3775 dead keys
3776 \end_layout
3777
3778 \begin_layout Itemize
3779 dead keys exceptions
3780 \end_layout
3781
3782 \begin_layout Standard
3783 To define key-to-key or key-to-string translation, use this command:
3784 \end_layout
3785
3786 \begin_layout Quotation
3787 \begin_inset Flex Code
3788 status collapsed
3789
3790 \begin_layout Plain Layout
3791
3792 \backslash
3793 kmap
3794 \end_layout
3795
3796 \end_inset
3797
3798
3799 \begin_inset Flex Code
3800 status collapsed
3801
3802 \begin_layout Plain Layout
3803 key
3804 \end_layout
3805
3806 \end_inset
3807
3808  outstring
3809 \end_layout
3810
3811 \begin_layout Standard
3812 where
3813 \begin_inset Flex Code
3814 status collapsed
3815
3816 \begin_layout Plain Layout
3817 key
3818 \end_layout
3819
3820 \end_inset
3821
3822  is the key to be translated and
3823 \begin_inset Flex Code
3824 status collapsed
3825
3826 \begin_layout Plain Layout
3827 outstring
3828 \end_layout
3829
3830 \end_inset
3831
3832  is the string to be inserted into the document.
3833  To define dead keys, use:
3834 \end_layout
3835
3836 \begin_layout Quotation
3837 \begin_inset Flex Code
3838 status collapsed
3839
3840 \begin_layout Plain Layout
3841
3842 \backslash
3843 kmod
3844 \end_layout
3845
3846 \end_inset
3847
3848
3849 \begin_inset Flex Code
3850 status collapsed
3851
3852 \begin_layout Plain Layout
3853 key
3854 \end_layout
3855
3856 \end_inset
3857
3858  deadkey
3859 \end_layout
3860
3861 \begin_layout Standard
3862 where
3863 \begin_inset Flex Code
3864 status collapsed
3865
3866 \begin_layout Plain Layout
3867 key
3868 \end_layout
3869
3870 \end_inset
3871
3872  is a keyboard key and
3873 \begin_inset Flex Code
3874 status collapsed
3875
3876 \begin_layout Plain Layout
3877 deadkey
3878 \end_layout
3879
3880 \end_inset
3881
3882  is dead key name.
3883  The following dead keys are supported (shortcut name is in parentheses):
3884 \end_layout
3885
3886 \begin_layout Quotation
3887
3888 \emph on
3889 Name
3890 \begin_inset space \hfill{}
3891 \end_inset
3892
3893 Example
3894 \end_layout
3895
3896 \begin_layout Quotation
3897 acute (acu)
3898 \begin_inset space \hfill{}
3899 \end_inset
3900
3901 áéíóú
3902 \end_layout
3903
3904 \begin_layout Quotation
3905 grave (gra)
3906 \begin_inset space \hfill{}
3907 \end_inset
3908
3909 àèìòù
3910 \end_layout
3911
3912 \begin_layout Quotation
3913 macron (mac)
3914 \begin_inset space \hfill{}
3915 \end_inset
3916
3917  ō
3918 \end_layout
3919
3920 \begin_layout Quotation
3921 tilde (til)
3922 \begin_inset space \hfill{}
3923 \end_inset
3924
3925 ñÑ
3926 \end_layout
3927
3928 \begin_layout Quotation
3929 underbar (underb)
3930 \begin_inset space \hfill{}
3931 \end_inset
3932
3933
3934 \begin_inset ERT
3935 status open
3936
3937 \begin_layout Plain Layout
3938
3939
3940 \backslash
3941 b o
3942 \end_layout
3943
3944 \end_inset
3945
3946
3947 \end_layout
3948
3949 \begin_layout Quotation
3950 cedilla (ced)
3951 \begin_inset space \hfill{}
3952 \end_inset
3953
3954 çÇ
3955 \end_layout
3956
3957 \begin_layout Quotation
3958 underdot (underd)
3959 \begin_inset space \hfill{}
3960 \end_inset
3961
3962
3963 \begin_inset ERT
3964 status open
3965
3966 \begin_layout Plain Layout
3967
3968
3969 \backslash
3970 d o
3971 \end_layout
3972
3973 \end_inset
3974
3975
3976 \end_layout
3977
3978 \begin_layout Quotation
3979 circumflex (circu)
3980 \begin_inset space \hfill{}
3981 \end_inset
3982
3983 âêîôû
3984 \end_layout
3985
3986 \begin_layout Quotation
3987 circle (circl)
3988 \begin_inset space \hfill{}
3989 \end_inset
3990
3991 ÅůŮ
3992 \end_layout
3993
3994 \begin_layout Quotation
3995 tie (tie)
3996 \begin_inset space \hfill{}
3997 \end_inset
3998
3999
4000 \begin_inset ERT
4001 status open
4002
4003 \begin_layout Plain Layout
4004
4005
4006 \backslash
4007 t o
4008 \end_layout
4009
4010 \end_inset
4011
4012
4013 \end_layout
4014
4015 \begin_layout Quotation
4016 breve (bre)
4017 \begin_inset space \hfill{}
4018 \end_inset
4019
4020 ă
4021 \begin_inset ERT
4022 status open
4023
4024 \begin_layout Plain Layout
4025
4026
4027 \backslash
4028 u o
4029 \end_layout
4030
4031 \end_inset
4032
4033
4034 \end_layout
4035
4036 \begin_layout Quotation
4037 caron (car)
4038 \begin_inset space \hfill{}
4039 \end_inset
4040
4041 čšž
4042 \end_layout
4043
4044 \begin_layout Quotation
4045 hungarian umlaut (hug)
4046 \begin_inset space \hfill{}
4047 \end_inset
4048
4049 őű
4050 \end_layout
4051
4052 \begin_layout Quotation
4053 umlaut (uml)
4054 \begin_inset space \hfill{}
4055 \end_inset
4056
4057 äöü
4058 \end_layout
4059
4060 \begin_layout Quotation
4061 dot (dot)
4062 \begin_inset space \hfill{}
4063 \end_inset
4064
4065 ż
4066 \begin_inset ERT
4067 status open
4068
4069 \begin_layout Plain Layout
4070
4071
4072 \backslash
4073 .s
4074 \end_layout
4075
4076 \end_inset
4077
4078
4079 \end_layout
4080
4081 \begin_layout Standard
4082 Since in many international keyboards there are exceptions to what some
4083  dead keys should do, you can define them using
4084 \end_layout
4085
4086 \begin_layout Quotation
4087 \begin_inset Flex Code
4088 status collapsed
4089
4090 \begin_layout Plain Layout
4091
4092 \backslash
4093 kxmod
4094 \end_layout
4095
4096 \end_inset
4097
4098  deadkey key outstring
4099 \end_layout
4100
4101 \begin_layout Standard
4102 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
4103 , so you put in
4104 \end_layout
4105
4106 \begin_layout Quotation
4107 \begin_inset Flex Code
4108 status collapsed
4109
4110 \begin_layout Plain Layout
4111
4112 \backslash
4113 kxmod
4114 \end_layout
4115
4116 \end_inset
4117
4118  caron o "
4119 \backslash
4120 ^o"
4121 \end_layout
4122
4123 \begin_layout Standard
4124 to make it work correctly.
4125  Also, you have to define as exceptions dead keys over i and j, to remove
4126  the dot from them before inserting an accent mark.
4127  I will change this when the time comes, but so far I haven't had time.
4128 \end_layout
4129
4130 \begin_layout Standard
4131 Oh, and about characters: backslash is escaped, so to enter it, you'll need
4132  double backslash.
4133  Also, quotes and
4134 \begin_inset Flex Code
4135 status collapsed
4136
4137 \begin_layout Plain Layout
4138 #
4139 \end_layout
4140
4141 \end_inset
4142
4143  have different meaning.
4144
4145 \begin_inset Flex Code
4146 status collapsed
4147
4148 \begin_layout Plain Layout
4149 #
4150 \end_layout
4151
4152 \end_inset
4153
4154  marks comments, quotes start and end \SpecialChar LaTeX
4155 -style commands.
4156  To enter quote, you'll need to use
4157 \begin_inset Flex Code
4158 status collapsed
4159
4160 \begin_layout Plain Layout
4161
4162 \backslash
4163 "
4164 \end_layout
4165
4166 \end_inset
4167
4168 , to enter
4169 \begin_inset Flex Code
4170 status collapsed
4171
4172 \begin_layout Plain Layout
4173 #
4174 \end_layout
4175
4176 \end_inset
4177
4178 , use
4179 \begin_inset Flex Code
4180 status collapsed
4181
4182 \begin_layout Plain Layout
4183
4184 \backslash
4185 #
4186 \end_layout
4187
4188 \end_inset
4189
4190 .
4191 \end_layout
4192
4193 \begin_layout Standard
4194 If you make a keyboard description file that works for your language, please
4195  mail it to me, so I can include it in the next keymap distribution.
4196 \end_layout
4197
4198 \begin_layout Standard
4199 More keywords will be supported in keymap configuration file in future,
4200  like
4201 \end_layout
4202
4203 \begin_layout Itemize
4204 \begin_inset Flex Code
4205 status collapsed
4206
4207 \begin_layout Plain Layout
4208
4209 \backslash
4210 kinclude filename
4211 \end_layout
4212
4213 \end_inset
4214
4215
4216 \emph on
4217
4218 \begin_inset space \hfill{}
4219 \end_inset
4220
4221
4222 \begin_inset Flex Code
4223 status collapsed
4224
4225 \begin_layout Plain Layout
4226 include
4227 \end_layout
4228
4229 \end_inset
4230
4231  another file
4232 \end_layout
4233
4234 \begin_layout Itemize
4235 \begin_inset Flex Code
4236 status collapsed
4237
4238 \begin_layout Plain Layout
4239
4240 \backslash
4241 kprog program
4242 \end_layout
4243
4244 \end_inset
4245
4246
4247 \emph on
4248
4249 \begin_inset space \hfill{}
4250 \end_inset
4251
4252
4253 \begin_inset Flex Code
4254 status collapsed
4255
4256 \begin_layout Plain Layout
4257 define
4258 \end_layout
4259
4260 \end_inset
4261
4262  an external keymap translation program
4263 \end_layout
4264
4265 \begin_layout Standard
4266 Also, it should look into
4267 \begin_inset Flex Code
4268 status collapsed
4269
4270 \begin_layout Plain Layout
4271 lyxrc
4272 \end_layout
4273
4274 \end_inset
4275
4276  file for defaults, too (for example, a
4277 \begin_inset Flex Code
4278 status collapsed
4279
4280 \begin_layout Plain Layout
4281
4282 \backslash
4283 kinclude
4284 \end_layout
4285
4286 \end_inset
4287
4288  option to include default keyboard).
4289 \end_layout
4290
4291 \end_inset
4292
4293
4294 \end_layout
4295
4296 \begin_layout Section
4297 International Keymap Stuff
4298 \begin_inset CommandInset label
4299 LatexCommand label
4300 name "sec:International-Keymap-Stuff"
4301
4302 \end_inset
4303
4304
4305 \end_layout
4306
4307 \begin_layout Standard
4308 \begin_inset Note Note
4309 status open
4310
4311 \begin_layout Plain Layout
4312 In doing the revisions on this document in March 2008, I did not look over
4313  this stuff, as I do not understand it.
4314  It would be good if someone else could do so.
4315  (RH)
4316 \end_layout
4317
4318 \end_inset
4319
4320
4321 \end_layout
4322
4323 \begin_layout Standard
4324 The next two sections describe the
4325 \begin_inset Flex Code
4326 status collapsed
4327
4328 \begin_layout Plain Layout
4329
4330 \shape up
4331 .kmap
4332 \end_layout
4333
4334 \end_inset
4335
4336  and
4337 \begin_inset Flex Code
4338 status collapsed
4339
4340 \begin_layout Plain Layout
4341
4342 \shape up
4343 .cdef
4344 \end_layout
4345
4346 \end_inset
4347
4348  file syntax in detail.
4349  These sections should help you design your own key map if the ones provided
4350  do not meet your needs.
4351 \end_layout
4352
4353 \begin_layout Subsection
4354 The .kmap File
4355 \end_layout
4356
4357 \begin_layout Standard
4358 A
4359 \shape up
4360 .
4361 \begin_inset Flex Code
4362 status collapsed
4363
4364 \begin_layout Plain Layout
4365 kmap
4366 \end_layout
4367
4368 \end_inset
4369
4370  file maps keystrokes to characters or strings.
4371  As the name suggests, it sets a keyboard mapping.
4372  The
4373 \begin_inset Flex Code
4374 status collapsed
4375
4376 \begin_layout Plain Layout
4377 .kmap
4378 \end_layout
4379
4380 \end_inset
4381
4382
4383 \shape default
4384  file keywords
4385 \shape up
4386
4387 \begin_inset Flex Code
4388 status collapsed
4389
4390 \begin_layout Plain Layout
4391
4392 \shape up
4393 kmap
4394 \end_layout
4395
4396 \end_inset
4397
4398
4399 \shape default
4400 ,
4401 \shape up
4402
4403 \shape default
4404
4405 \begin_inset Flex Code
4406 status collapsed
4407
4408 \begin_layout Plain Layout
4409
4410 \shape up
4411 kmod
4412 \end_layout
4413
4414 \end_inset
4415
4416 ,
4417 \shape up
4418
4419 \shape default
4420
4421 \begin_inset Flex Code
4422 status collapsed
4423
4424 \begin_layout Plain Layout
4425
4426 \shape up
4427 kxmod
4428 \end_layout
4429
4430 \end_inset
4431
4432 , and
4433 \begin_inset Flex Code
4434 status collapsed
4435
4436 \begin_layout Plain Layout
4437
4438 \shape up
4439 kcomb
4440 \end_layout
4441
4442 \end_inset
4443
4444  are described in this section.
4445 \end_layout
4446
4447 \begin_layout Labeling
4448 \labelwidthstring 00.00.0000
4449 \begin_inset Flex Code
4450 status collapsed
4451
4452 \begin_layout Plain Layout
4453
4454 \shape up
4455 kmap
4456 \end_layout
4457
4458 \end_inset
4459
4460  Map a character to a string
4461 \end_layout
4462
4463 \begin_layout LyX-Code
4464
4465 \backslash
4466 kmap
4467 \family roman
4468 \emph on
4469 char
4470 \family default
4471 \emph default
4472
4473 \family roman
4474 \emph on
4475 string
4476 \end_layout
4477
4478 \begin_layout Standard
4479 This will ma
4480 \family roman
4481 p
4482 \family default
4483
4484 \family roman
4485 \emph on
4486 char
4487 \family default
4488 \emph default
4489
4490 \family roman
4491 to
4492 \family default
4493
4494 \family roman
4495 \emph on
4496 string
4497 \emph default
4498 .
4499  Note that in
4500 \family default
4501
4502 \family roman
4503 \emph on
4504 string
4505 \emph default
4506 ,
4507 \family default
4508
4509 \family roman
4510 \shape up
4511 the double-quote (")
4512 \family default
4513 \shape default
4514
4515 \family roman
4516 and
4517 \family default
4518
4519 \family roman
4520 \shape up
4521 the backslash (
4522 \backslash
4523 )
4524 \family default
4525 \shape default
4526
4527 \family roman
4528 must be escaped with a preceding backslash (
4529 \shape up
4530
4531 \backslash
4532
4533 \shape default
4534 )
4535 \family default
4536 .
4537 \end_layout
4538
4539 \begin_layout Standard
4540 An example of a
4541 \begin_inset Flex Noun
4542 status collapsed
4543
4544 \begin_layout Plain Layout
4545
4546 \shape up
4547 kmap
4548 \end_layout
4549
4550 \end_inset
4551
4552  statement to cause the symbol
4553 \begin_inset Flex Noun
4554 status collapsed
4555
4556 \begin_layout Plain Layout
4557
4558 \shape up
4559 /
4560 \end_layout
4561
4562 \end_inset
4563
4564  to be output for the keystroke
4565 \begin_inset Flex Noun
4566 status collapsed
4567
4568 \begin_layout Plain Layout
4569
4570 \shape up
4571 &
4572 \end_layout
4573
4574 \end_inset
4575
4576  is:
4577 \end_layout
4578
4579 \begin_layout LyX-Code
4580
4581 \backslash
4582 kmap & /
4583 \end_layout
4584
4585 \begin_layout Labeling
4586 \labelwidthstring 00.00.0000
4587 \begin_inset Flex Code
4588 status collapsed
4589
4590 \begin_layout Plain Layout
4591
4592 \shape up
4593 kmod
4594 \end_layout
4595
4596 \end_inset
4597
4598  Specify an accent character
4599 \end_layout
4600
4601 \begin_layout LyX-Code
4602
4603 \backslash
4604 kmod
4605 \family roman
4606 \emph on
4607 char accent allowed
4608 \end_layout
4609
4610 \begin_layout Standard
4611 This will make the cha
4612 \family roman
4613 racter
4614 \family default
4615
4616 \family roman
4617 \emph on
4618 char
4619 \family default
4620 \emph default
4621
4622 \family roman
4623 \shape up
4624 \emph on
4625 be an accent
4626 \family default
4627 \shape default
4628 \emph default
4629
4630 \family roman
4631 \shape up
4632 on the
4633 \family default
4634 \shape default
4635
4636 \family roman
4637 \shape up
4638 \emph on
4639 allowed
4640 \family default
4641 \shape default
4642 \emph default
4643
4644 \family roman
4645 \shape up
4646 cha
4647 \family default
4648 racter(s).
4649  This is the dead key
4650 \begin_inset Foot
4651 status collapsed
4652
4653 \begin_layout Plain Layout
4654 The term
4655 \family roman
4656 \emph on
4657 dead key
4658 \family default
4659 \emph default
4660  refers to a key that does not produce a character by itself, but when followed
4661  with another key, produces the desired accent character.
4662  For example, a German characte
4663 \family roman
4664 r with an umlaut like
4665 \family default
4666
4667 \family roman
4668 \emph on
4669 ä
4670 \family default
4671 \emph default
4672
4673 \family roman
4674 can be produced in this manner.
4675 \end_layout
4676
4677 \end_inset
4678
4679  mechanism.
4680
4681 \end_layout
4682
4683 \begin_layout Standard
4684 If you
4685 \family roman
4686 hit
4687 \family default
4688
4689 \family roman
4690 \emph on
4691 char
4692 \family default
4693 \emph default
4694
4695 \family roman
4696 and then another key not in
4697 \family default
4698
4699 \family roman
4700 \emph on
4701 allowed
4702 \emph default
4703 , you will get a
4704 \family default
4705
4706 \family roman
4707 \emph on
4708 char
4709 \family default
4710 \emph default
4711
4712 \family roman
4713 followed by the other, not allowed key, as output.
4714
4715 \family default
4716  Note that a
4717 \begin_inset Flex Noun
4718 status collapsed
4719
4720 \begin_layout Plain Layout
4721
4722 \shape up
4723 Backspace
4724 \end_layout
4725
4726 \end_inset
4727
4728  cancels a dead key, so if
4729 \family roman
4730 you hit
4731 \family default
4732
4733 \family roman
4734 \emph on
4735 char
4736 \family default
4737 \emph default
4738
4739 \begin_inset Flex Noun
4740 status collapsed
4741
4742 \begin_layout Plain Layout
4743
4744 \shape up
4745 \emph on
4746 Backspace
4747 \end_layout
4748
4749 \end_inset
4750
4751 , the cursor will not go one position backwards but will instead cancel
4752  the effect t
4753 \family roman
4754 hat
4755 \family default
4756
4757 \family roman
4758 \shape up
4759 \emph on
4760 char
4761 \family default
4762 \shape default
4763 \emph default
4764
4765 \family roman
4766 \shape up
4767 might have had on the next keystroke.
4768
4769 \end_layout
4770
4771 \begin_layout Standard
4772 The following example specifies that the character ' is to be an acute accent,
4773  allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4774 \end_layout
4775
4776 \begin_layout LyX-Code
4777
4778 \backslash
4779 kmod ' acute aeiouAEIOU
4780 \end_layout
4781
4782 \begin_layout Labeling
4783 \labelwidthstring 00.00.0000
4784 \begin_inset Flex Code
4785 status collapsed
4786
4787 \begin_layout Plain Layout
4788 kxmod
4789 \end_layout
4790
4791 \end_inset
4792
4793  Specify an exception to the accent character
4794 \end_layout
4795
4796 \begin_layout LyX-Code
4797
4798 \backslash
4799 kxmod
4800 \family roman
4801 \emph on
4802 accent char result
4803 \end_layout
4804
4805 \begin_layout Standard
4806 This defines an exce
4807 \family roman
4808 ption for
4809 \family default
4810
4811 \family roman
4812 \emph on
4813 accent
4814 \family default
4815 \emph default
4816
4817 \family roman
4818 on
4819 \family default
4820
4821 \family roman
4822 \emph on
4823 char
4824 \emph default
4825 .
4826  T
4827 \shape up
4828 he
4829 \family default
4830 \shape default
4831
4832 \family roman
4833 \shape up
4834 \emph on
4835 accent
4836 \family default
4837 \shape default
4838 \emph default
4839
4840 \family roman
4841 \shape up
4842 must
4843 \family default
4844 \shape default
4845
4846 \shape up
4847 have been assigned a keystroke with a previous
4848 \shape default
4849
4850 \begin_inset Flex Code
4851 status collapsed
4852
4853 \begin_layout Plain Layout
4854
4855 \shape up
4856
4857 \backslash
4858 kmo
4859 \shape default
4860 d
4861 \end_layout
4862
4863 \end_inset
4864
4865  declar
4866 \family roman
4867 ation and
4868 \family default
4869
4870 \family roman
4871 \emph on
4872 char
4873 \family default
4874 \emph default
4875
4876 \family roman
4877 must not belong in the
4878 \family default
4879
4880 \family roman
4881 \emph on
4882 allowed
4883 \family default
4884 \emph default
4885
4886 \family roman
4887 set of
4888 \family default
4889
4890 \family roman
4891 \emph on
4892 accent
4893 \emph default
4894 .
4895  When
4896 \family default
4897
4898 \family roman
4899 \shape up
4900 you enter the
4901 \family default
4902 \shape default
4903
4904 \family roman
4905 \shape up
4906 \emph on
4907 accent char
4908 \family default
4909 \shape default
4910 \emph default
4911
4912 \family roman
4913 \shape up
4914 sequence,
4915 \family default
4916 \shape default
4917
4918 \family roman
4919 \shape up
4920 \emph on
4921 result
4922 \emph default
4923  is produced.
4924  If such a declaration does not exist in
4925 \family default
4926 \shape default
4927
4928 \shape up
4929 the
4930 \shape default
4931
4932 \begin_inset Flex Code
4933 status collapsed
4934
4935 \begin_layout Plain Layout
4936
4937 \shape up
4938 .kmap
4939 \end_layout
4940
4941 \end_inset
4942
4943  file and yo
4944 \family roman
4945 u enter
4946 \family default
4947
4948 \family roman
4949 \emph on
4950 accent char
4951 \emph default
4952 , you get
4953 \family default
4954
4955 \family roman
4956 \emph on
4957 accent_key char
4958 \emph default
4959  where
4960 \family default
4961
4962 \family roman
4963 \emph on
4964 accent_key
4965 \emph default
4966  is the first arg
4967 \family default
4968 ument of the
4969 \begin_inset Flex Code
4970 status collapsed
4971
4972 \begin_layout Plain Layout
4973
4974 \shape up
4975
4976 \backslash
4977 kmod
4978 \end_layout
4979
4980 \end_inset
4981
4982  declaration.
4983
4984 \end_layout
4985
4986 \begin_layout Standard
4987 The following command produces causes äi to be produced when you enter acute-i
4988  ('i):
4989 \end_layout
4990
4991 \begin_layout LyX-Code
4992
4993 \backslash
4994 kxmod acute i "
4995 \backslash
4996
4997 \backslash
4998 '{
4999 \backslash
5000
5001 \backslash
5002 i}"
5003 \end_layout
5004
5005 \begin_layout Labeling
5006 \labelwidthstring 00.00.0000
5007 \begin_inset Flex Code
5008 status collapsed
5009
5010 \begin_layout Plain Layout
5011 kcomb
5012 \end_layout
5013
5014 \end_inset
5015
5016  Combine two accent characters
5017 \end_layout
5018
5019 \begin_layout LyX-Code
5020
5021 \backslash
5022 kcomb
5023 \family roman
5024 \emph on
5025 accent1 accent2 allowed
5026 \end_layout
5027
5028 \begin_layout Standard
5029 This one is getting pretty esoteric.
5030  It allows you to combine the effect
5031 \family roman
5032 of
5033 \family default
5034
5035 \family roman
5036 \emph on
5037 accent1
5038 \family default
5039 \emph default
5040
5041 \family roman
5042 and
5043 \family default
5044
5045 \family roman
5046 \emph on
5047 accent2
5048 \family default
5049 \emph default
5050
5051 \family roman
5052 (in that order!) on
5053 \family default
5054
5055 \family roman
5056 \emph on
5057 allowed
5058 \family default
5059 \emph default
5060
5061 \family roman
5062 chars.
5063  The keystrokes for
5064 \family default
5065
5066 \family roman
5067 \emph on
5068 accent1
5069 \family default
5070 \emph default
5071
5072 \family roman
5073 and
5074 \family default
5075
5076 \family roman
5077 \emph on
5078 accent2
5079 \family default
5080 \emph default
5081
5082 \family roman
5083 must have be
5084 \family default
5085 en set with a
5086 \begin_inset Flex Code
5087 status collapsed
5088
5089 \begin_layout Plain Layout
5090
5091 \shape up
5092
5093 \backslash
5094 kmod
5095 \end_layout
5096
5097 \end_inset
5098
5099  command at
5100 \family roman
5101 a
5102 \family default
5103
5104 \family roman
5105 \emph on
5106 previous
5107 \family default
5108 \emph default
5109
5110 \family roman
5111 point in the
5112 \family default
5113  file.
5114
5115 \end_layout
5116
5117 \begin_layout Standard
5118 Consider this example from the
5119 \begin_inset Flex Code
5120 status collapsed
5121
5122 \begin_layout Plain Layout
5123
5124 \shape up
5125 greek.kmap
5126 \end_layout
5127
5128 \end_inset
5129
5130  file:
5131 \end_layout
5132
5133 \begin_layout LyX-Code
5134
5135 \backslash
5136 kmod ; acute aeioyvhAEIOYVH
5137 \backslash
5138 kmod : umlaut iyIY
5139 \backslash
5140 kcomb acute umlaut iyIY
5141 \end_layout
5142
5143 \begin_layout Standard
5144 This allows you to press
5145 \begin_inset Flex Noun
5146 status collapsed
5147
5148 \begin_layout Plain Layout
5149
5150 \shape up
5151 ;:i
5152 \end_layout
5153
5154 \end_inset
5155
5156  and get the effect of
5157 \begin_inset Flex Code
5158 status collapsed
5159
5160 \begin_layout Plain Layout
5161
5162 \shape up
5163
5164 \backslash
5165 '{
5166 \backslash
5167 "{i}}
5168 \end_layout
5169
5170 \end_inset
5171
5172 .
5173
5174 \family roman
5175 \shape up
5176 A backspace
5177 \family default
5178 \shape default
5179  in this case cancels the last dead key, so if you press
5180 \begin_inset Flex Noun
5181 status collapsed
5182
5183 \begin_layout Plain Layout
5184
5185 \shape up
5186 ;: Backspace i
5187 \end_layout
5188
5189 \end_inset
5190
5191  you get
5192 \begin_inset Flex Code
5193 status collapsed
5194
5195 \begin_layout Plain Layout
5196
5197 \shape up
5198
5199 \backslash
5200 '{i}
5201 \end_layout
5202
5203 \end_inset
5204
5205 .
5206 \end_layout
5207
5208 \begin_layout Subsection
5209 The .cdef File
5210 \end_layout
5211
5212 \begin_layout Standard
5213 After the
5214 \begin_inset Flex Code
5215 status collapsed
5216
5217 \begin_layout Plain Layout
5218
5219 \shape up
5220 .kmap
5221 \end_layout
5222
5223 \end_inset
5224
5225  mapping is performed, a
5226 \begin_inset Flex Code
5227 status collapsed
5228
5229 \begin_layout Plain Layout
5230
5231 \shape up
5232 .cde
5233 \shape default
5234 f
5235 \end_layout
5236
5237 \end_inset
5238
5239  file maps the strings that the symbols generate to characters in the current
5240  font.
5241  The \SpecialChar LyX
5242  distribution currently includes at least the
5243 \begin_inset Flex Code
5244 status collapsed
5245
5246 \begin_layout Plain Layout
5247
5248 \shape up
5249 iso8859-1.cdef
5250 \end_layout
5251
5252 \end_inset
5253
5254  and
5255 \begin_inset Flex Code
5256 status collapsed
5257
5258 \begin_layout Plain Layout
5259
5260 \shape up
5261 iso8859-2.cdef
5262 \end_layout
5263
5264 \end_inset
5265
5266  files.
5267 \end_layout
5268
5269 \begin_layout Standard
5270 In general the
5271 \begin_inset Flex Code
5272 status collapsed
5273
5274 \begin_layout Plain Layout
5275
5276 \shape up
5277 .cdef
5278 \end_layout
5279
5280 \end_inset
5281
5282  file is a sequence of declarations of the form
5283 \end_layout
5284
5285 \begin_layout LyX-Code
5286
5287 \family roman
5288 \emph on
5289 char_index_in_set
5290 \family default
5291 \emph default
5292
5293 \family roman
5294 \emph on
5295  string
5296 \end_layout
5297
5298 \begin_layout Standard
5299 For example, in order to map
5300 \begin_inset Flex Noun
5301 status collapsed
5302
5303 \begin_layout Plain Layout
5304
5305 \shape up
5306
5307 \backslash
5308 '{e}
5309 \end_layout
5310
5311 \end_inset
5312
5313  to the corresponding character in the iso-8859-1 set (233), the following
5314  declaration is used
5315 \end_layout
5316
5317 \begin_layout LyX-Code
5318 233 "
5319 \backslash
5320
5321 \backslash
5322 '{e}"
5323 \end_layout
5324
5325 \begin_layout Standard
5326 with
5327 \begin_inset Flex Code
5328 status collapsed
5329
5330 \begin_layout Plain Layout
5331
5332 \backslash
5333
5334 \end_layout
5335
5336 \end_inset
5337
5338  and
5339 \begin_inset Flex Code
5340 status collapsed
5341
5342 \begin_layout Plain Layout
5343 "
5344 \end_layout
5345
5346 \end_inset
5347
5348  being escap
5349 \family roman
5350 ed in
5351 \family default
5352
5353 \family roman
5354 \emph on
5355 string
5356 \emph default
5357 .
5358  Note that
5359 \family default
5360  the same character can apply to more than one string.
5361  In the
5362 \begin_inset Flex Code
5363 status collapsed
5364
5365 \begin_layout Plain Layout
5366 i
5367 \shape up
5368 so-8859-7.cdef
5369 \end_layout
5370
5371 \end_inset
5372
5373  file you have
5374 \end_layout
5375
5376 \begin_layout LyX-Code
5377 192 "
5378 \backslash
5379
5380 \backslash
5381 '{
5382 \backslash
5383
5384 \backslash
5385
5386 \backslash
5387 "{i}}"
5388 \begin_inset Newline newline
5389 \end_inset
5390
5391 192 "
5392 \backslash
5393
5394 \backslash
5395
5396 \backslash
5397 "{
5398 \backslash
5399
5400 \backslash
5401 '{i}}"
5402 \end_layout
5403
5404 \begin_layout Standard
5405 If \SpecialChar LyX
5406  cannot find a mapping for the string produced by the keystroke or a
5407  deadkey sequence, it will check if it looks like an accented char and try
5408  to draw an accent over the character on screen.
5409 \end_layout
5410
5411 \begin_layout Subsection
5412 Dead Keys
5413 \end_layout
5414
5415 \begin_layout Standard
5416 There is a second way to add support for international characters through
5417  so-called dead-keys.
5418  A dead-key works in combination with a letter to produce an accented character.
5419  Here, we'll explain how to create a really simple dead-key to illustrate
5420  how they work.
5421 \end_layout
5422
5423 \begin_layout Standard
5424 Suppose you happen to need the circumflex character,
5425 \begin_inset Quotes eld
5426 \end_inset
5427
5428  ̂
5429 \begin_inset Quotes erd
5430 \end_inset
5431
5432 .
5433  You could bind the
5434 \begin_inset Flex Noun
5435 status collapsed
5436
5437 \begin_layout Plain Layout
5438 ^
5439 \end_layout
5440
5441 \end_inset
5442
5443 -key [a.k.a.
5444 \begin_inset space ~
5445 \end_inset
5446
5447
5448 \begin_inset Flex Noun
5449 status collapsed
5450
5451 \begin_layout Plain Layout
5452 Shift-6
5453 \end_layout
5454
5455 \end_inset
5456
5457 ] to the \SpecialChar LyX
5458  command
5459 \begin_inset Flex Code
5460 status collapsed
5461
5462 \begin_layout Plain Layout
5463 accent-circumflex
5464 \end_layout
5465
5466 \end_inset
5467
5468  in your
5469 \begin_inset Flex Code
5470 status collapsed
5471
5472 \begin_layout Plain Layout
5473 lyxrc
5474 \end_layout
5475
5476 \end_inset
5477
5478  file.
5479  Now, whenever you type the
5480 \begin_inset Flex Noun
5481 status collapsed
5482
5483 \begin_layout Plain Layout
5484 ^
5485 \end_layout
5486
5487 \end_inset
5488
5489 -key followed by a letter, that letter will have a circumflex accent on
5490  it.
5491  For example, the sequence
5492 \begin_inset Quotes eld
5493 \end_inset
5494
5495
5496 \begin_inset Flex Noun
5497 status collapsed
5498
5499 \begin_layout Plain Layout
5500 ^e
5501 \end_layout
5502
5503 \end_inset
5504
5505
5506 \begin_inset Quotes erd
5507 \end_inset
5508
5509  produces the letter:
5510 \begin_inset Quotes eld
5511 \end_inset
5512
5513 ê
5514 \begin_inset Quotes erd
5515 \end_inset
5516
5517 .
5518  If you tried to type
5519 \begin_inset Quotes eld
5520 \end_inset
5521
5522
5523 \begin_inset Flex Noun
5524 status collapsed
5525
5526 \begin_layout Plain Layout
5527 ^t
5528 \end_layout
5529
5530 \end_inset
5531
5532
5533 \begin_inset Quotes erd
5534 \end_inset
5535
5536 , however, \SpecialChar LyX
5537  will complain with a beep, since a
5538 \begin_inset Quotes eld
5539 \end_inset
5540
5541
5542 \begin_inset Flex Noun
5543 status collapsed
5544
5545 \begin_layout Plain Layout
5546 t
5547 \end_layout
5548
5549 \end_inset
5550
5551
5552 \begin_inset Quotes erd
5553 \end_inset
5554
5555  never takes a circumflex accent.
5556  Hitting
5557 \begin_inset Flex Noun
5558 status collapsed
5559
5560 \begin_layout Plain Layout
5561 Space
5562 \end_layout
5563
5564 \end_inset
5565
5566  after a dead-key produces the bare-accent.
5567  Please note this last point! If you bind a key to a dead-key, you'll need
5568  to rebind the character on that key to yet another key.
5569  Binding the
5570 \begin_inset Flex Noun
5571 status collapsed
5572
5573 \begin_layout Plain Layout
5574 ,-key
5575 \end_layout
5576
5577 \end_inset
5578
5579  to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5580 \end_layout
5581
5582 \begin_layout Standard
5583 One common way to bind dead-keys is to use
5584 \begin_inset Flex Noun
5585 status collapsed
5586
5587 \begin_layout Plain Layout
5588 Meta-
5589 \end_layout
5590
5591 \end_inset
5592
5593 ,
5594 \begin_inset Flex Noun
5595 status collapsed
5596
5597 \begin_layout Plain Layout
5598 Ctrl-
5599 \end_layout
5600
5601 \end_inset
5602
5603 , and
5604 \begin_inset Flex Noun
5605 status collapsed
5606
5607 \begin_layout Plain Layout
5608 Shift-
5609 \end_layout
5610
5611 \end_inset
5612
5613  in combination with an accent, like
5614 \begin_inset Quotes eld
5615 \end_inset
5616
5617
5618 \begin_inset Flex Noun
5619 status collapsed
5620
5621 \begin_layout Plain Layout
5622 ~
5623 \end_layout
5624
5625 \end_inset
5626
5627
5628 \begin_inset Quotes erd
5629 \end_inset
5630
5631  or
5632 \begin_inset Quotes eld
5633 \end_inset
5634
5635
5636 \begin_inset Flex Noun
5637 status collapsed
5638
5639 \begin_layout Plain Layout
5640 ,
5641 \end_layout
5642
5643 \end_inset
5644
5645
5646 \begin_inset Quotes erd
5647 \end_inset
5648
5649  or
5650 \begin_inset Quotes eld
5651 \end_inset
5652
5653
5654 \begin_inset Flex Noun
5655 status collapsed
5656
5657 \begin_layout Plain Layout
5658 ^
5659 \end_layout
5660
5661 \end_inset
5662
5663
5664 \begin_inset Quotes erd
5665 \end_inset
5666
5667 .
5668  Another way involves using
5669 \begin_inset Flex Code
5670 status collapsed
5671
5672 \begin_layout Plain Layout
5673 xmodmap
5674 \end_layout
5675
5676 \end_inset
5677
5678  and
5679 \begin_inset Flex Code
5680 status collapsed
5681
5682 \begin_layout Plain Layout
5683 xkeycaps
5684 \end_layout
5685
5686 \end_inset
5687
5688  to set up the special
5689 \begin_inset Flex Code
5690 status collapsed
5691
5692 \begin_layout Plain Layout
5693 Mode_Switch
5694 \end_layout
5695
5696 \end_inset
5697
5698  key.
5699  The
5700 \begin_inset Flex Code
5701 status collapsed
5702
5703 \begin_layout Plain Layout
5704 Mode_Switch
5705 \end_layout
5706
5707 \end_inset
5708
5709  acts in some ways just like
5710 \begin_inset Flex Noun
5711 status collapsed
5712
5713 \begin_layout Plain Layout
5714 Shift
5715 \end_layout
5716
5717 \end_inset
5718
5719  and permits you to bind keys to accented characters.
5720  You can also turn keys into dead-keys by binding them to something like
5721
5722 \begin_inset Flex Code
5723 status collapsed
5724
5725 \begin_layout Plain Layout
5726 usldead_cedilla
5727 \end_layout
5728
5729 \end_inset
5730
5731  and then binding this symbolic key to the corresponding \SpecialChar LyX
5732  command.
5733 \begin_inset Foot
5734 status collapsed
5735
5736 \begin_layout Plain Layout
5737 Note from
5738 \noun on
5739 John Weiss
5740 \noun default
5741 : This is exactly what I do in my
5742 \begin_inset Flex Code
5743 status collapsed
5744
5745 \begin_layout Plain Layout
5746 ~/.lyx/lyxrc
5747 \end_layout
5748
5749 \end_inset
5750
5751  and my
5752 \begin_inset Flex Code
5753 status collapsed
5754
5755 \begin_layout Plain Layout
5756 ~/.xmodmap
5757 \end_layout
5758
5759 \end_inset
5760
5761  files.
5762  I have my
5763 \begin_inset Flex Noun
5764 status collapsed
5765
5766 \begin_layout Plain Layout
5767 Scroll
5768 \begin_inset space ~
5769 \end_inset
5770
5771 Lock
5772 \end_layout
5773
5774 \end_inset
5775
5776  key set up as
5777 \begin_inset Flex Code
5778 status collapsed
5779
5780 \begin_layout Plain Layout
5781 Mode_Shift
5782 \end_layout
5783
5784 \end_inset
5785
5786  and a bunch of these
5787 \begin_inset Quotes eld
5788 \end_inset
5789
5790
5791 \begin_inset Flex Code
5792 status collapsed
5793
5794 \begin_layout Plain Layout
5795 usldead_*
5796 \end_layout
5797
5798 \end_inset
5799
5800
5801 \begin_inset Quotes erd
5802 \end_inset
5803
5804  symbolic keys bound such things as
5805 \begin_inset Flex Noun
5806 status collapsed
5807
5808 \begin_layout Plain Layout
5809 Scroll
5810 \begin_inset space ~
5811 \end_inset
5812
5813 Lock-^
5814 \end_layout
5815
5816 \end_inset
5817
5818  and
5819 \begin_inset Flex Noun
5820 status collapsed
5821
5822 \begin_layout Plain Layout
5823 Scroll
5824 \begin_inset space ~
5825 \end_inset
5826
5827 Lock-~
5828 \end_layout
5829
5830 \end_inset
5831
5832 .
5833  This is how I produce my accented characters.
5834 \end_layout
5835
5836 \end_inset
5837
5838  You can make just about anything into the
5839 \begin_inset Flex Code
5840 status collapsed
5841
5842 \begin_layout Plain Layout
5843 Mode_Switch
5844 \end_layout
5845
5846 \end_inset
5847
5848  key: One of the
5849 \begin_inset Flex Noun
5850 status collapsed
5851
5852 \begin_layout Plain Layout
5853 Ctrl-
5854 \end_layout
5855
5856 \end_inset
5857
5858  keys, a spare function key, etc.
5859  As for the \SpecialChar LyX
5860  commands that produce accents, check the entry for
5861 \begin_inset Flex Code
5862 status collapsed
5863
5864 \begin_layout Plain Layout
5865 accent-acute
5866 \end_layout
5867
5868 \end_inset
5869
5870  in the
5871 \emph on
5872 Reference Manual
5873 \emph default
5874 .
5875  You'll find the complete list there.
5876 \end_layout
5877
5878 \begin_layout Subsection
5879 Saving your Language Configuration
5880 \end_layout
5881
5882 \begin_layout Standard
5883 You can edit your preferences so that your desired language environment
5884  is automatically configured when \SpecialChar LyX
5885  starts up, via the
5886 \begin_inset Flex Noun
5887 status collapsed
5888
5889 \begin_layout Plain Layout
5890 Edit\SpecialChar menuseparator
5891 Preferences
5892 \end_layout
5893
5894 \end_inset
5895
5896  dialog.
5897 \end_layout
5898
5899 \begin_layout Chapter
5900 Installing New Document Classes, Layouts, and Templates
5901 \begin_inset CommandInset label
5902 LatexCommand label
5903 name "cha:Installing-New-Document"
5904
5905 \end_inset
5906
5907
5908 \begin_inset Argument 1
5909 status collapsed
5910
5911 \begin_layout Plain Layout
5912 Installing New Document Classes
5913 \end_layout
5914
5915 \end_inset
5916
5917
5918 \end_layout
5919
5920 \begin_layout Standard
5921 In this chapter, we describe the procedures for creating and installing
5922  new \SpecialChar LyX
5923  layout and template files, as well as offer a refresher on correctly
5924  installing new \SpecialChar LaTeX
5925  document classes.
5926
5927 \end_layout
5928
5929 \begin_layout Standard
5930 First, let us a say a few words about how one ought to think about the relation
5931  between \SpecialChar LyX
5932  and \SpecialChar LaTeX
5933 .
5934  The thing to understand is that, in a certain sense, \SpecialChar LyX
5935  doesn't know anything
5936  about \SpecialChar LaTeX
5937 .
5938  Indeed, from \SpecialChar LyX
5939 's point of view, \SpecialChar LaTeX
5940  is just one of several
5941 \begin_inset Quotes eld
5942 \end_inset
5943
5944 backend formats
5945 \begin_inset Quotes erd
5946 \end_inset
5947
5948  in which it is capable of producing output.
5949  Other such formats are DocBook, plaintext, and XHTML.
5950  \SpecialChar LaTeX
5951  is, of course, a particularly important format, but very little of the
5952  information \SpecialChar LyX
5953  has about \SpecialChar LaTeX
5954  is actually contained in the program itself.
5955 \begin_inset Foot
5956 status collapsed
5957
5958 \begin_layout Plain Layout
5959 Some commands are sufficiently complex that they are
5960 \begin_inset Quotes eld
5961 \end_inset
5962
5963 hardcoded
5964 \begin_inset Quotes erd
5965 \end_inset
5966
5967  into \SpecialChar LyX
5968 .
5969  But the developers generally regard this as a Bad Thing.
5970 \end_layout
5971
5972 \end_inset
5973
5974  Rather, that information, even for the standard classes like
5975 \begin_inset Flex Code
5976 status collapsed
5977
5978 \begin_layout Plain Layout
5979 article.cls
5980 \end_layout
5981
5982 \end_inset
5983
5984 , is contained in `layout files'.
5985  Similarly, \SpecialChar LyX
5986  itself does not know much about DocBook or XHTML.
5987  What it knows is contained in layout files.
5988 \end_layout
5989
5990 \begin_layout Standard
5991 You can think of the layout file for a given document class as a translation
5992  manual between \SpecialChar LyX
5993  constructs—paragraphs with their corresponding styles,
5994  certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
5995 , DocBook, or XHTML
5996  constructs.
5997  Almost everything \SpecialChar LyX
5998  knows about
5999 \begin_inset Flex Code
6000 status collapsed
6001
6002 \begin_layout Plain Layout
6003 article.cls
6004 \end_layout
6005
6006 \end_inset
6007
6008 , for example, is contained in the file
6009 \begin_inset Flex Code
6010 status collapsed
6011
6012 \begin_layout Plain Layout
6013 article.layout
6014 \end_layout
6015
6016 \end_inset
6017
6018  and in various other files it includes.
6019  For this reason, anyone intending to write layout files should plan to
6020  study the existing files.
6021  A good place to start is with
6022 \begin_inset Flex Code
6023 status collapsed
6024
6025 \begin_layout Plain Layout
6026 stdsections.inc
6027 \end_layout
6028
6029 \end_inset
6030
6031 , which is included in
6032 \begin_inset Flex Code
6033 status collapsed
6034
6035 \begin_layout Plain Layout
6036 article.layout
6037 \end_layout
6038
6039 \end_inset
6040
6041 ,
6042 \begin_inset Flex Code
6043 status collapsed
6044
6045 \begin_layout Plain Layout
6046 book.layout
6047 \end_layout
6048
6049 \end_inset
6050
6051 , and many of the other layout files for document classes.
6052  This file is where sections and the like are defined:
6053 \begin_inset Flex Code
6054 status collapsed
6055
6056 \begin_layout Plain Layout
6057 stdsections.inc
6058 \end_layout
6059
6060 \end_inset
6061
6062  tells \SpecialChar LyX
6063  how paragraphs that are marked with the Section, Subsection, etc,
6064  styles can be translated into corresponding \SpecialChar LaTeX
6065 , DocBook, and XHTML commands
6066  and tags.
6067  The
6068 \begin_inset Flex Code
6069 status collapsed
6070
6071 \begin_layout Plain Layout
6072 article.layout
6073 \end_layout
6074
6075 \end_inset
6076
6077  file basically just includes several of these
6078 \begin_inset Flex Code
6079 status collapsed
6080
6081 \begin_layout Plain Layout
6082 std*.inc
6083 \end_layout
6084
6085 \end_inset
6086
6087  files.
6088 \end_layout
6089
6090 \begin_layout Standard
6091 Defining the \SpecialChar LyX
6092 –\SpecialChar LaTeX
6093  correspondence is not the only thing layout files do, though.
6094  Their other job is to define how the \SpecialChar LyX
6095  constructs themselves will appear
6096  on-screen.
6097  The fact that layout files have these two jobs is often a source of confusion,
6098  because they are completely separate.
6099  Telling \SpecialChar LyX
6100  how to translate a certain paragraph style into \SpecialChar LaTeX
6101  does not tell
6102  \SpecialChar LyX
6103  how to display it; conversely, telling \SpecialChar LyX
6104  how to display a certain paragraph
6105  style does not tell \SpecialChar LyX
6106  how to translate it into \SpecialChar LaTeX
6107  (let alone tell \SpecialChar LaTeX
6108  how to
6109  display it).
6110  So, in general, when you define a new \SpecialChar LyX
6111  construct, you must always do two
6112  quite separate things: (i)
6113 \begin_inset space ~
6114 \end_inset
6115
6116 tell \SpecialChar LyX
6117  how to translate it into \SpecialChar LaTeX
6118  and (ii)
6119 \begin_inset space ~
6120 \end_inset
6121
6122 tell \SpecialChar LyX
6123  how to display it.
6124 \end_layout
6125
6126 \begin_layout Standard
6127 Much the same is true, of course, as regards \SpecialChar LyX
6128 's other backend formats, though
6129  XHTML is in some ways different, because in that case \SpecialChar LyX
6130
6131 \emph on
6132 is
6133 \emph default
6134  able, to some extent, to use information about how it should display a
6135  paragraph on the screen to output information (in the form of CSS) about
6136  how the paragraph should be displayed in a browser.
6137  Even in this case, however, the distinction between what \SpecialChar LyX
6138  does internally
6139  and how things are rendered externally remains in force, and the two can
6140  be controlled separately.
6141  See
6142 \begin_inset CommandInset ref
6143 LatexCommand ref
6144 reference "sec:Tags-for-XHTML"
6145
6146 \end_inset
6147
6148  for the details.
6149 \end_layout
6150
6151 \begin_layout Section
6152 Installing new \SpecialChar LaTeX
6153  files
6154 \end_layout
6155
6156 \begin_layout Standard
6157 Some installations may not include a \SpecialChar LaTeX
6158  package or class file that you would
6159  like to use within \SpecialChar LyX
6160 .
6161  For example, you might need Foil\SpecialChar TeX
6162 , a package for preparing slides for overhead
6163  projectors.
6164  Modern \SpecialChar LaTeX
6165  distributions like \SpecialChar TeX
6166 Live (2008 or newer) or MiK\SpecialChar TeX
6167  provide a user interface
6168  for installing such packages.
6169  For example, with MiK\SpecialChar TeX
6170 , you start the program
6171 \begin_inset Quotes eld
6172 \end_inset
6173
6174 Package
6175 \begin_inset space ~
6176 \end_inset
6177
6178 Manager
6179 \begin_inset Quotes erd
6180 \end_inset
6181
6182  to get a list of available packages.
6183  To install one of them, right click on it or use the corresponding toolbar
6184  button.
6185 \end_layout
6186
6187 \begin_layout Standard
6188 If your \SpecialChar LaTeX
6189  distribution does not provide such a `package manager', or if the
6190  package is not available from your distribution, then follow these steps
6191  to install it manually:
6192 \end_layout
6193
6194 \begin_layout Enumerate
6195 Get the package from
6196 \begin_inset CommandInset href
6197 LatexCommand href
6198 name "CTAN"
6199 target "http://www.ctan.org/"
6200 literal "false"
6201
6202 \end_inset
6203
6204  or wherever.
6205 \end_layout
6206
6207 \begin_layout Enumerate
6208 If the package contains a file with the ending
6209 \begin_inset Quotes eld
6210 \end_inset
6211
6212
6213 \begin_inset Flex Code
6214 status collapsed
6215
6216 \begin_layout Plain Layout
6217 .ins
6218 \end_layout
6219
6220 \end_inset
6221
6222
6223 \begin_inset Quotes erd
6224 \end_inset
6225
6226  (is the case for Foil\SpecialChar TeX
6227 ) then open a console, change to the folder of this
6228  file and execute the command
6229 \begin_inset Flex Code
6230 status collapsed
6231
6232 \begin_layout Plain Layout
6233 latex foiltex.ins
6234 \end_layout
6235
6236 \end_inset
6237
6238 .
6239  You have now unpacked the package and have all files to install it.
6240  Most \SpecialChar LaTeX
6241 -packages are not packed and you can skip this step.
6242 \end_layout
6243
6244 \begin_layout Enumerate
6245 Now you need to decide if the package should be available for all users
6246  or only for you.
6247 \end_layout
6248
6249 \begin_deeper
6250 \begin_layout Enumerate
6251 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6252  for all users on your system, then install it in your `local' \SpecialChar TeX
6253  tree, otherwise
6254  install it in your own `user' \SpecialChar TeX
6255  tree.
6256  Where these trees should be created, if they do not already exist, depends
6257  on your system.
6258  To find this out, look in the file
6259 \begin_inset Flex Code
6260 status collapsed
6261
6262 \begin_layout Plain Layout
6263 texmf.cnf
6264 \end_layout
6265
6266 \end_inset
6267
6268 .
6269 \begin_inset Foot
6270 status collapsed
6271
6272 \begin_layout Plain Layout
6273 This is usually in the directory
6274 \begin_inset Flex Code
6275 status collapsed
6276
6277 \begin_layout Plain Layout
6278 $TEXMF/web2c
6279 \end_layout
6280
6281 \end_inset
6282
6283 , though you can execute the command
6284 \begin_inset Flex Code
6285 status collapsed
6286
6287 \begin_layout Plain Layout
6288 kpsewhich texmf.cnf
6289 \end_layout
6290
6291 \end_inset
6292
6293  to locate it.
6294 \end_layout
6295
6296 \end_inset
6297
6298  The location of the `local' \SpecialChar TeX
6299  tree is defined by the
6300 \begin_inset Flex Code
6301 status collapsed
6302
6303 \begin_layout Plain Layout
6304 TEXMFLOCAL
6305 \end_layout
6306
6307 \end_inset
6308
6309  variable; this is usually somewhere like
6310 \begin_inset Flex Code
6311 status collapsed
6312
6313 \begin_layout Plain Layout
6314 /usr/local/share/texmf
6315 \end_layout
6316
6317 \end_inset
6318
6319  or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6320 Live
6321  distribution.
6322  The location of the `user' \SpecialChar TeX
6323  tree is defined by
6324 \begin_inset Flex Code
6325 status collapsed
6326
6327 \begin_layout Plain Layout
6328 TEXMFHOME
6329 \end_layout
6330
6331 \end_inset
6332
6333  and is commonly
6334 \begin_inset Flex Code
6335 status collapsed
6336
6337 \begin_layout Plain Layout
6338 $HOME/texmf
6339 \end_layout
6340
6341 \end_inset
6342
6343  or
6344 \begin_inset Flex Code
6345 status collapsed
6346
6347 \begin_layout Plain Layout
6348
6349 \family sans
6350 $HOME/.texliveXXXX
6351 \end_layout
6352
6353 \end_inset
6354
6355 .
6356  (If these variables are not predefined, you have to define them.) You'll
6357  probably need root permissions to create or modify the `local' tree, but
6358  not for your `user' tree.
6359 \begin_inset Newline newline
6360 \end_inset
6361
6362 In general, it is recommended to install in the user tree because your user
6363  will not be modified or even overwritten when you upgrade your system.
6364  It will typically also be backed up together with everything else when
6365  you backup your home directory (which, of course, you do on a regular basis).
6366 \end_layout
6367
6368 \begin_layout Enumerate
6369 On Windows, if you want the new package to be available for all users on
6370  your system, change to the folder where \SpecialChar LaTeX
6371  is installed and then change to
6372  the subfolder
6373 \begin_inset Flex Code
6374 status collapsed
6375
6376 \begin_layout Plain Layout
6377 ~
6378 \backslash
6379 tex
6380 \backslash
6381 latex
6382 \end_layout
6383
6384 \end_inset
6385
6386 .
6387  (For MiK\SpecialChar TeX
6388 , this would be by default the folder
6389 \begin_inset Flex Code
6390 status collapsed
6391
6392 \begin_layout Plain Layout
6393 ~:
6394 \backslash
6395 Programs
6396 \backslash
6397 MiKTeX
6398 \backslash
6399 tex
6400 \backslash
6401 latex
6402 \end_layout
6403
6404 \end_inset
6405
6406 .)
6407 \begin_inset Foot
6408 status collapsed
6409
6410 \begin_layout Plain Layout
6411 Note that this will be the correct path only on English installations.
6412  On a German one, it would be
6413 \begin_inset Flex Code
6414 status collapsed
6415
6416 \begin_layout Plain Layout
6417 ~:
6418 \backslash
6419 Programme
6420 \backslash
6421 MiKTeX
6422 \backslash
6423 tex
6424 \backslash
6425 latex
6426 \end_layout
6427
6428 \end_inset
6429
6430 , and similarly for other languages.
6431 \end_layout
6432
6433 \end_inset
6434
6435  Create there a new folder
6436 \begin_inset Flex Code
6437 status collapsed
6438
6439 \begin_layout Plain Layout
6440 foiltex
6441 \end_layout
6442
6443 \end_inset
6444
6445  and copy all files of the package into it.
6446
6447 \begin_inset Newline newline
6448 \end_inset
6449
6450 If the package should only available for you or you don't have admin permissions
6451 , do the same, but in the local \SpecialChar LaTeX
6452  folder.
6453  E.
6454 \begin_inset space \thinspace{}
6455 \end_inset
6456
6457 g., for MiK\SpecialChar TeX
6458
6459 \begin_inset space ~
6460 \end_inset
6461
6462 2.8 under Windows XP, this would be the folder:
6463 \begin_inset Newline newline
6464 \end_inset
6465
6466
6467 \family sans
6468
6469 \begin_inset Flex Code
6470 status collapsed
6471
6472 \begin_layout Plain Layout
6473 ~:
6474 \backslash
6475 Documents and Settings
6476 \backslash
6477 <username>
6478 \backslash
6479 Application Data
6480 \backslash
6481
6482 \end_layout
6483
6484 \end_inset
6485
6486
6487 \begin_inset Newline newline
6488 \end_inset
6489
6490
6491 \family default
6492
6493 \begin_inset Phantom HPhantom
6494 status open
6495
6496 \begin_layout Plain Layout
6497
6498 \family sans
6499 ~:
6500 \backslash
6501
6502 \end_layout
6503
6504 \end_inset
6505
6506
6507 \begin_inset Flex Code
6508 status collapsed
6509
6510 \begin_layout Plain Layout
6511 MiKTeX
6512 \backslash
6513 2.8
6514 \backslash
6515 tex
6516 \backslash
6517 latex
6518 \end_layout
6519
6520 \end_inset
6521
6522
6523 \begin_inset Newline newline
6524 \end_inset
6525
6526 On Vista, it would be:
6527 \begin_inset Newline newline
6528 \end_inset
6529
6530
6531 \begin_inset Flex Code
6532 status collapsed
6533
6534 \begin_layout Plain Layout
6535 ~:
6536 \backslash
6537 Users
6538 \backslash
6539 <username>
6540 \backslash
6541 AppData
6542 \backslash
6543 Roaming
6544 \backslash
6545 2.8
6546 \backslash
6547 MiKTeX
6548 \backslash
6549 tex
6550 \backslash
6551 latex
6552 \end_layout
6553
6554 \end_inset
6555
6556
6557 \end_layout
6558
6559 \end_deeper
6560 \begin_layout Enumerate
6561 Now one only need to tell \SpecialChar LaTeX
6562  that there are new files.
6563  This depends on the used \SpecialChar LaTeX
6564 -Distribution:
6565 \end_layout
6566
6567 \begin_deeper
6568 \begin_layout Enumerate
6569 For \SpecialChar TeX
6570 Live execute the command
6571 \begin_inset Flex Code
6572 status collapsed
6573
6574 \begin_layout Plain Layout
6575 texhash
6576 \end_layout
6577
6578 \end_inset
6579
6580  from a console.
6581  If you installed the package for all users, then you will probably need
6582  to have root permissions for that.
6583 \end_layout
6584
6585 \begin_layout Enumerate
6586 For MiK\SpecialChar TeX
6587 , if you have installed the package for all users, start the program
6588
6589 \begin_inset Quotes eld
6590 \end_inset
6591
6592 Settings
6593 \begin_inset space ~
6594 \end_inset
6595
6596 (Admin)
6597 \begin_inset Quotes erd
6598 \end_inset
6599
6600  and press the button marked
6601 \begin_inset Quotes eld
6602 \end_inset
6603
6604 Refresh FNDB
6605 \begin_inset Quotes erd
6606 \end_inset
6607
6608 .
6609  Otherwise start the program
6610 \begin_inset Quotes eld
6611 \end_inset
6612
6613 Settings
6614 \begin_inset Quotes erd
6615 \end_inset
6616
6617  and do the same.
6618 \end_layout
6619
6620 \end_deeper
6621 \begin_layout Enumerate
6622 Finally, you need to tell \SpecialChar LyX
6623  that there are new packages available.
6624  So, in \SpecialChar LyX
6625 , use the menu
6626 \begin_inset Flex Noun
6627 status collapsed
6628
6629 \begin_layout Plain Layout
6630 Tools
6631 \family sans
6632 \SpecialChar menuseparator
6633 Reconfigure
6634 \end_layout
6635
6636 \end_inset
6637
6638  and then restart \SpecialChar LyX
6639 .
6640 \end_layout
6641
6642 \begin_layout Standard
6643 Now the package is installed.
6644  In our example, the document class
6645 \begin_inset Flex Code
6646 status collapsed
6647
6648 \begin_layout Plain Layout
6649 FoilTex
6650 \end_layout
6651
6652 \end_inset
6653
6654  will now be available under
6655 \begin_inset Flex Noun
6656 status collapsed
6657
6658 \begin_layout Plain Layout
6659 Document\SpecialChar menuseparator
6660 Settings\SpecialChar menuseparator
6661 Document Class
6662 \end_layout
6663
6664 \end_inset
6665
6666  (in the
6667 \begin_inset Quotes eld
6668 \end_inset
6669
6670 Presentations
6671 \begin_inset Quotes erd
6672 \end_inset
6673
6674  category).
6675
6676 \end_layout
6677
6678 \begin_layout Standard
6679 If you would like to use a \SpecialChar LaTeX
6680  document class that is not even listed in the
6681  menu
6682 \begin_inset Flex Noun
6683 status collapsed
6684
6685 \begin_layout Plain Layout
6686 Document\SpecialChar menuseparator
6687 Settings\SpecialChar menuseparator
6688 Document Class
6689 \end_layout
6690
6691 \end_inset
6692
6693 , then you need to create a `layout' file for it.
6694  That is the topic of the next section.
6695 \end_layout
6696
6697 \begin_layout Section
6698 Types of layout files
6699 \end_layout
6700
6701 \begin_layout Standard
6702 This section describes the various sorts of \SpecialChar LyX
6703  files that contain layout informati
6704 on.
6705  These files describe various paragraph and character styles, determining
6706  how \SpecialChar LyX
6707  should display them and how they should be translated into \SpecialChar LaTeX
6708 , DocBook,
6709  XHTML, or whatever output format is being used.
6710
6711 \end_layout
6712
6713 \begin_layout Standard
6714 We shall try to provide a thorough description of the process of writing
6715  layout files here.
6716  However, there are so many different types of documents supported even
6717  by just \SpecialChar LaTeX
6718  that we can't hope to cover every different possibility or problem
6719  you might encounter.
6720  The \SpecialChar LyX
6721  users' list is frequented by people with lots of experience with layout
6722  design who are willing to share what they've learned, so please feel free
6723  to ask questions there.
6724 \end_layout
6725
6726 \begin_layout Standard
6727 As you prepare to write a new layout, it is extremely helpful to look at
6728  the layouts distributed with \SpecialChar LyX
6729 .
6730  If you write a \SpecialChar LyX
6731  layout for a \SpecialChar LaTeX
6732  document class that might also be used by
6733  others, or write a module that might be useful to others, then you should
6734  consider posting your layout to the
6735 \begin_inset CommandInset href
6736 LatexCommand href
6737 name "layout section on the LyX wiki"
6738 target "https://wiki.lyx.org/Layouts/Layouts"
6739 literal "false"
6740
6741 \end_inset
6742
6743  or even to the \SpecialChar LyX
6744  developers' list, so that it might be included in \SpecialChar LyX
6745  itself.
6746 \begin_inset Foot
6747 status collapsed
6748
6749 \begin_layout Plain Layout
6750 Note that \SpecialChar LyX
6751  is licensed under the General Public License, so any material
6752  that is contributed to \SpecialChar LyX
6753  must be similarly licensed.
6754 \end_layout
6755
6756 \end_inset
6757
6758
6759 \end_layout
6760
6761 \begin_layout Subsection
6762 Layout modules
6763 \begin_inset CommandInset label
6764 LatexCommand label
6765 name "subsec:Layout-modules"
6766
6767 \end_inset
6768
6769
6770 \end_layout
6771
6772 \begin_layout Standard
6773 We have spoken to this point about `layout files'.
6774  But there are different sorts of files that contain layout information.
6775  Layout files, strictly so called, have the
6776 \begin_inset Flex Code
6777 status collapsed
6778
6779 \begin_layout Plain Layout
6780 .layout
6781 \end_layout
6782
6783 \end_inset
6784
6785  extension and provide \SpecialChar LyX
6786  with information about document classes.
6787  Since \SpecialChar LyX
6788  1.6 layout information can also be contained in layout
6789 \emph on
6790 modules
6791 \emph default
6792 , which have the
6793 \begin_inset Flex Code
6794 status collapsed
6795
6796 \begin_layout Plain Layout
6797 .module
6798 \end_layout
6799
6800 \end_inset
6801
6802  extension.
6803  Modules are to \SpecialChar LaTeX
6804  packages much as layouts are to \SpecialChar LaTeX
6805  classes, and some modules—such
6806  as the
6807 \begin_inset Flex Code
6808 status collapsed
6809
6810 \begin_layout Plain Layout
6811 endnotes
6812 \end_layout
6813
6814 \end_inset
6815
6816  module—specifically provide support for one package.
6817  In a sense, layout modules are similar to included
6818 \begin_inset Foot
6819 status collapsed
6820
6821 \begin_layout Plain Layout
6822 These can have any extension, but by convention have the
6823 \begin_inset Flex Code
6824 status collapsed
6825
6826 \begin_layout Plain Layout
6827 .inc
6828 \end_layout
6829
6830 \end_inset
6831
6832  extension.
6833 \end_layout
6834
6835 \end_inset
6836
6837  files—files like
6838 \begin_inset Flex Code
6839 status collapsed
6840
6841 \begin_layout Plain Layout
6842 stdsections.inc
6843 \end_layout
6844
6845 \end_inset
6846
6847 —in that modules are not specific to a given document class but may be used
6848  with many different classes.
6849  The difference is that using an included file with
6850 \begin_inset Flex Code
6851 status collapsed
6852
6853 \begin_layout Plain Layout
6854 article.cls
6855 \end_layout
6856
6857 \end_inset
6858
6859  requires editing that file.
6860  Modules, by contrast, are selected in the
6861 \begin_inset Flex Noun
6862 status collapsed
6863
6864 \begin_layout Plain Layout
6865 Document\SpecialChar menuseparator
6866 Settings
6867 \end_layout
6868
6869 \end_inset
6870
6871  dialog.
6872 \end_layout
6873
6874 \begin_layout Standard
6875 Building modules is the easiest way to get started with layout editing,
6876  since it can be as simple as adding a single new paragraph style or flex
6877  inset.
6878  But modules may, in principle, contain anything a layout file can contain.
6879 \end_layout
6880
6881 \begin_layout Standard
6882 After creating a new module and copying it to the
6883 \begin_inset Flex Code
6884 status collapsed
6885
6886 \begin_layout Plain Layout
6887 layouts/
6888 \end_layout
6889
6890 \end_inset
6891
6892  folder, you will need to reconfigure and then restart \SpecialChar LyX
6893  for the module to
6894  appear in the menu.
6895  However, changes you make to the module will be seen immediately, if you
6896  open
6897 \begin_inset Flex Noun
6898 status collapsed
6899
6900 \begin_layout Plain Layout
6901 Document\SpecialChar menuseparator
6902 Settings
6903 \end_layout
6904
6905 \end_inset
6906
6907 , highlight something, and then hit
6908 \begin_inset Quotes eld
6909 \end_inset
6910
6911 OK
6912 \begin_inset Quotes erd
6913 \end_inset
6914
6915 .
6916
6917 \emph on
6918 It is strongly recommended that you save your work before doing this
6919 \emph default
6920 .
6921  In fact,
6922 \emph on
6923 it is strongly recommended that you not attempt to edit modules while simultaneo
6924 usly working on actual documents
6925 \emph default
6926 .
6927  Though of course the developers strive to keep \SpecialChar LyX
6928  stable in such situations,
6929  syntax errors and the like in your module file could cause strange behavior.
6930 \end_layout
6931
6932 \begin_layout Subsubsection
6933 Local Layout
6934 \end_layout
6935
6936 \begin_layout Standard
6937 Modules are to \SpecialChar LyX
6938  as packages are to \SpecialChar LaTeX
6939 .
6940  Sometimes, however, you find yourself wanting a specific inset or character
6941  style just for one document and writing a module that will also be available
6942  to other documents makes little sense.
6943  What you need is \SpecialChar LyX
6944 's
6945 \begin_inset Quotes eld
6946 \end_inset
6947
6948 Local Layout
6949 \begin_inset Quotes erd
6950 \end_inset
6951
6952 .
6953 \end_layout
6954
6955 \begin_layout Standard
6956 You will find it under
6957 \family sans
6958 Document\SpecialChar menuseparator
6959 Settings\SpecialChar menuseparator
6960 Local Layout
6961 \family default
6962 .
6963  The large text box allows you to enter anything that you might enter in
6964  a layout file or module.
6965  You can think of a document's local layout, in fact, as a module that belongs
6966  just to it.
6967  So, in particular, you must enter a
6968 \begin_inset Flex Code
6969 status collapsed
6970
6971 \begin_layout Plain Layout
6972 Format
6973 \end_layout
6974
6975 \end_inset
6976
6977  tag.
6978  Any format is acceptable, but one would normally use the format current
6979  at the time.
6980  (In \SpecialChar LyX
6981
6982 \begin_inset Info
6983 type  "lyxinfo"
6984 arg   "version"
6985 \end_inset
6986
6987 , the current layout format is
6988 \begin_inset Info
6989 type  "lyxinfo"
6990 arg   "layoutformat"
6991 \end_inset
6992
6993 .)
6994 \end_layout
6995
6996 \begin_layout Standard
6997 When you have entered something in the
6998 \begin_inset Flex Code
6999 status collapsed
7000
7001 \begin_layout Plain Layout
7002 Local Layout
7003 \end_layout
7004
7005 \end_inset
7006
7007  pane, \SpecialChar LyX
7008  will enable the
7009 \begin_inset Quotes eld
7010 \end_inset
7011
7012 Validate
7013 \begin_inset Quotes erd
7014 \end_inset
7015
7016  button at the bottom.
7017  Clicking this button will cause \SpecialChar LyX
7018  to determine whether what you have entered
7019  is valid layout information for the chosen format.
7020  \SpecialChar LyX
7021  will report the result but, unfortunately, will not tell you what errors
7022  there might have been.
7023  These will be written to the terminal, however, if \SpecialChar LyX
7024  is started from a terminal.
7025  You will not be permitted to save your local layout until you have entered
7026  something valid.
7027 \end_layout
7028
7029 \begin_layout Standard
7030 The warnings at the end of the previous section apply here, too.
7031  Do not play with local layout while you are actually working, especially
7032  if you have not saved your document.
7033  That said, using local layout with a test document can be a very convenient
7034  way to try out layout ideas, or even to start developing a module.
7035 \end_layout
7036
7037 \begin_layout Subsection
7038 Layout for
7039 \begin_inset Flex Noun
7040 status collapsed
7041
7042 \begin_layout Plain Layout
7043 .sty
7044 \end_layout
7045
7046 \end_inset
7047
7048  files
7049 \end_layout
7050
7051 \begin_layout Standard
7052 There are two situations you are likely to encounter when wanting to support
7053  a new \SpecialChar LaTeX
7054  document class, involving style (
7055 \begin_inset Flex Code
7056 status collapsed
7057
7058 \begin_layout Plain Layout
7059 .sty
7060 \end_layout
7061
7062 \end_inset
7063
7064 ) files and \SpecialChar LaTeX2e
7065  class (
7066 \begin_inset Flex Code
7067 status collapsed
7068
7069 \begin_layout Plain Layout
7070 .cls
7071 \end_layout
7072
7073 \end_inset
7074
7075 ) .
7076  Supporting a style file is usually fairly easy.
7077  Supporting a new class file is a bit harder.
7078  We'll discuss the former in this section and the latter in the next.
7079  Similar remarks apply, of course, if you want to support a new DocBook
7080  DTD.
7081 \end_layout
7082
7083 \begin_layout Standard
7084 The easier case is the one in which your new document class is provided
7085  as a style file that is to be used in conjunction with an already supported
7086  document class.
7087  For the sake of the example, we'll assume that the style file is called
7088
7089 \begin_inset Flex Noun
7090 status collapsed
7091
7092 \begin_layout Plain Layout
7093 myclass.sty
7094 \end_layout
7095
7096 \end_inset
7097
7098  and that it is meant to be used with
7099 \begin_inset Flex Noun
7100 status collapsed
7101
7102 \begin_layout Plain Layout
7103 report.cls
7104 \end_layout
7105
7106 \end_inset
7107
7108 , which is a standard class.
7109
7110 \end_layout
7111
7112 \begin_layout Standard
7113 Start by copying the existing class's layout file into your local directory:
7114 \begin_inset Foot
7115 status collapsed
7116
7117 \begin_layout Plain Layout
7118 Of course, which directory is your local directory will vary by platform,
7119  and \SpecialChar LyX
7120  allows you to specify your local directory on startup, too, using
7121  the
7122 \begin_inset Flex Code
7123 status collapsed
7124
7125 \begin_layout Plain Layout
7126 -userdir
7127 \end_layout
7128
7129 \end_inset
7130
7131  option.
7132 \end_layout
7133
7134 \end_inset
7135
7136
7137 \end_layout
7138
7139 \begin_layout LyX-Code
7140 cp report.layout ~/.lyx/layouts/myclass.layout
7141 \end_layout
7142
7143 \begin_layout Standard
7144 Then edit
7145 \begin_inset Flex Code
7146 status collapsed
7147
7148 \begin_layout Plain Layout
7149 myclass.layout
7150 \end_layout
7151
7152 \end_inset
7153
7154  and change the line:
7155 \end_layout
7156
7157 \begin_layout LyX-Code
7158
7159 \backslash
7160 DeclareLaTeXClass{Report (Standard Class)}
7161 \end_layout
7162
7163 \begin_layout Standard
7164 to read
7165 \end_layout
7166
7167 \begin_layout LyX-Code
7168
7169 \backslash
7170 DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
7171 \end_layout
7172
7173 \begin_layout Standard
7174 Then add:
7175 \end_layout
7176
7177 \begin_layout LyX-Code
7178 Preamble
7179 \begin_inset Newline newline
7180 \end_inset
7181
7182
7183 \backslash
7184 usepackage{myclass}
7185 \begin_inset Newline newline
7186 \end_inset
7187
7188 EndPreamble
7189 \end_layout
7190
7191 \begin_layout Standard
7192 near the top of the file.
7193 \end_layout
7194
7195 \begin_layout Standard
7196 Start \SpecialChar LyX
7197  and select
7198 \begin_inset Flex Noun
7199 status collapsed
7200
7201 \begin_layout Plain Layout
7202 Tools\SpecialChar menuseparator
7203 Reconfigure
7204 \end_layout
7205
7206 \end_inset
7207
7208 .
7209  Then restart \SpecialChar LyX
7210  and try creating a new document.
7211  You should see "
7212 \begin_inset Flex Noun
7213 status collapsed
7214
7215 \begin_layout Plain Layout
7216 Report (My Class)
7217 \end_layout
7218
7219 \end_inset
7220
7221 " as a document class option in the
7222 \begin_inset Flex Noun
7223 status collapsed
7224
7225 \begin_layout Plain Layout
7226 Document\SpecialChar menuseparator
7227 Settings
7228 \end_layout
7229
7230 \end_inset
7231
7232  dialog.
7233  It is likely that some of the sectioning commands and such in your new
7234  class will work differently from how they worked in the base class—
7235 \begin_inset Flex Code
7236 status collapsed
7237
7238 \begin_layout Plain Layout
7239 report
7240 \end_layout
7241
7242 \end_inset
7243
7244  in this example—so you can fiddle around with the settings for the different
7245  sections if you wish.
7246  The layout information for sections is contained in
7247 \begin_inset Flex Code
7248 status collapsed
7249
7250 \begin_layout Plain Layout
7251 stdsections.inc
7252 \end_layout
7253
7254 \end_inset
7255
7256 , but you do not need to copy and change this file.
7257  Instead, you can simply add your changes to your layout file, after the
7258  line
7259 \begin_inset Flex Code
7260 status collapsed
7261
7262 \begin_layout Plain Layout
7263 Input stdclass.inc
7264 \end_layout
7265
7266 \end_inset
7267
7268 , which itself includes
7269 \begin_inset Flex Code
7270 status collapsed
7271
7272 \begin_layout Plain Layout
7273 stdsections.inc
7274 \end_layout
7275
7276 \end_inset
7277
7278 .
7279  For example, you might add these lines:
7280 \end_layout
7281
7282 \begin_layout LyX-Code
7283 Style Chapter
7284 \end_layout
7285
7286 \begin_layout LyX-Code
7287     Font
7288 \end_layout
7289
7290 \begin_layout LyX-Code
7291         Family Sans
7292 \end_layout
7293
7294 \begin_layout LyX-Code
7295     EndFont
7296 \end_layout
7297
7298 \begin_layout LyX-Code
7299 End
7300 \end_layout
7301
7302 \begin_layout Standard
7303 to change the font for chapter headings to sans-serif.
7304  This will override (or, in this case, add to) the existing declaration
7305  for the Chapter style.
7306
7307 \end_layout
7308
7309 \begin_layout Standard
7310 Your new package may also provide commands or environments not present in
7311  the base class.
7312  In this case, you will want to add these to the layout file.
7313  See
7314 \begin_inset CommandInset ref
7315 LatexCommand ref
7316 reference "sec:TextClass"
7317
7318 \end_inset
7319
7320  for information on how to do so.
7321 \end_layout
7322
7323 \begin_layout Standard
7324 If
7325 \begin_inset Flex Noun
7326 status collapsed
7327
7328 \begin_layout Plain Layout
7329 myclass.sty
7330 \end_layout
7331
7332 \end_inset
7333
7334  can be used with several different document classes, and even if it cannot,
7335  you might find it easiest just to write a module that you can load with
7336  the base class.
7337  The simplest possible such module would be:
7338 \end_layout
7339
7340 \begin_layout LyX-Code
7341 #
7342 \backslash
7343 DeclareLyXModule{My Class}
7344 \end_layout
7345
7346 \begin_layout LyX-Code
7347 #DescriptionBegin
7348 \end_layout
7349
7350 \begin_layout LyX-Code
7351 #Support for myclass.sty.
7352 \end_layout
7353
7354 \begin_layout LyX-Code
7355 #DescriptionEnd
7356 \begin_inset Newline newline
7357 \end_inset
7358
7359
7360 \end_layout
7361
7362 \begin_layout LyX-Code
7363 Format
7364 \begin_inset Info
7365 type  "lyxinfo"
7366 arg   "layoutformat"
7367 \end_inset
7368
7369
7370 \begin_inset Newline newline
7371 \end_inset
7372
7373
7374 \end_layout
7375
7376 \begin_layout LyX-Code
7377 Preamble
7378 \begin_inset Newline newline
7379 \end_inset
7380
7381
7382 \backslash
7383 usepackage{myclass}
7384 \begin_inset Newline newline
7385 \end_inset
7386
7387 EndPreamble
7388 \end_layout
7389
7390 \begin_layout Standard
7391 A more complex module might modify the behavior of some existing constructs
7392  or define some new ones.
7393  Again, see
7394 \begin_inset CommandInset ref
7395 LatexCommand ref
7396 reference "sec:TextClass"
7397
7398 \end_inset
7399
7400  for discussion.
7401 \end_layout
7402
7403 \begin_layout Subsection
7404 Layout for
7405 \begin_inset Flex Noun
7406 status collapsed
7407
7408 \begin_layout Plain Layout
7409 .cls
7410 \end_layout
7411
7412 \end_inset
7413
7414  files
7415 \end_layout
7416
7417 \begin_layout Standard
7418 There are two possibilities here.
7419  One is that the class file is itself based upon an existing document class.
7420  For example, many thesis classes are based upon
7421 \begin_inset Flex Noun
7422 status collapsed
7423
7424 \begin_layout Plain Layout
7425 book.cls
7426 \end_layout
7427
7428 \end_inset
7429
7430 .
7431  To see whether yours is, look for a line like
7432 \end_layout
7433
7434 \begin_layout LyX-Code
7435
7436 \backslash
7437 LoadClass{book}
7438 \end_layout
7439
7440 \begin_layout Standard
7441 in the file.
7442  If so, then you may proceed largely as in the previous section, though
7443  the
7444 \begin_inset Flex Code
7445 status collapsed
7446
7447 \begin_layout Plain Layout
7448 Declare\SpecialChar LaTeX
7449 Class
7450 \end_layout
7451
7452 \end_inset
7453
7454  line will be different.
7455  If your new class is
7456 \begin_inset Flex Code
7457 status collapsed
7458
7459 \begin_layout Plain Layout
7460 thesis
7461 \end_layout
7462
7463 \end_inset
7464
7465  and it is based upon
7466 \begin_inset Flex Code
7467 status collapsed
7468
7469 \begin_layout Plain Layout
7470 book
7471 \end_layout
7472
7473 \end_inset
7474
7475 , then the line should read:
7476 \begin_inset Foot
7477 status collapsed
7478
7479 \begin_layout Plain Layout
7480 And it will be easiest if you save the file to
7481 \begin_inset Flex Code
7482 status collapsed
7483
7484 \begin_layout Plain Layout
7485 thesis.layout
7486 \end_layout
7487
7488 \end_inset
7489
7490 : \SpecialChar LyX
7491  assumes that the document class has the same name as the layout file.
7492
7493 \end_layout
7494
7495 \end_inset
7496
7497
7498 \end_layout
7499
7500 \begin_layout LyX-Code
7501
7502 \backslash
7503 DeclareLaTeXClass[thesis,book]{thesis}
7504 \end_layout
7505
7506 \begin_layout Standard
7507 If, on the other hand, the new class is not based upon an existing class,
7508  you will probably have to
7509 \begin_inset Quotes eld
7510 \end_inset
7511
7512 roll your own
7513 \begin_inset Quotes erd
7514 \end_inset
7515
7516  layout.
7517  We strongly suggest copying an existing layout file which uses a similar
7518  \SpecialChar LaTeX
7519  class and then modifying it, if you can do so.
7520  At least use an existing file as a starting point so you can find out what
7521  items you need to worry about.
7522  Again, the specifics are covered below.
7523 \end_layout
7524
7525 \begin_layout Subsection
7526 Creating templates
7527 \begin_inset CommandInset label
7528 LatexCommand label
7529 name "subsec:Creating-Templates"
7530
7531 \end_inset
7532
7533
7534 \end_layout
7535
7536 \begin_layout Standard
7537 Once you have written a layout file for a new document class, you might
7538  want to consider writing a
7539 \emph on
7540 template
7541 \emph default
7542  for it, too.
7543  A template acts as a kind of tutorial for your layout, showing how it might
7544  be used, though containing dummy content.
7545  You can of course look at the various templates included with \SpecialChar LyX
7546  for ideas.
7547 \end_layout
7548
7549 \begin_layout Standard
7550 Templates are created just like usual documents: using \SpecialChar LyX
7551 .
7552  The only difference is that usual documents contain all possible settings,
7553  including the font scheme and the paper size.
7554  Usually a user doesn't want a template to overwrite his preferred settings
7555  for such parameters.
7556  For that reason, the designer of a template should remove the corresponding
7557  commands like
7558 \begin_inset Flex Code
7559 status collapsed
7560
7561 \begin_layout Plain Layout
7562
7563 \backslash
7564 font_roman
7565 \end_layout
7566
7567 \end_inset
7568
7569  or
7570 \begin_inset Flex Code
7571 status collapsed
7572
7573 \begin_layout Plain Layout
7574
7575 \backslash
7576 papersize
7577 \end_layout
7578
7579 \end_inset
7580
7581  from the template \SpecialChar LyX
7582  file.
7583  This can be done with any simple text-editor, for example
7584 \begin_inset Flex Code
7585 status collapsed
7586
7587 \begin_layout Plain Layout
7588 vi
7589 \end_layout
7590
7591 \end_inset
7592
7593  or
7594 \begin_inset Flex Code
7595 status collapsed
7596
7597 \begin_layout Plain Layout
7598 notepad
7599 \end_layout
7600
7601 \end_inset
7602
7603 .
7604 \end_layout
7605
7606 \begin_layout Standard
7607 Put the edited template files you create in
7608 \begin_inset Flex Code
7609 status collapsed
7610
7611 \begin_layout Plain Layout
7612 UserDir/templates/
7613 \end_layout
7614
7615 \end_inset
7616
7617 , copy the ones you use from the global template directory in
7618 \begin_inset Flex Code
7619 status collapsed
7620
7621 \begin_layout Plain Layout
7622 LyXDir/templates/
7623 \end_layout
7624
7625 \end_inset
7626
7627  to the same place, and redefine the template path in the
7628 \begin_inset Flex Noun
7629 status collapsed
7630
7631 \begin_layout Plain Layout
7632 Tools\SpecialChar menuseparator
7633 Preferences\SpecialChar menuseparator
7634 Paths
7635 \end_layout
7636
7637 \end_inset
7638
7639  dialog.
7640 \end_layout
7641
7642 \begin_layout Standard
7643 Note, by the way, that there is a template which has a particular meaning:
7644 \begin_inset Newline linebreak
7645 \end_inset
7646
7647
7648 \begin_inset Flex Code
7649 status collapsed
7650
7651 \begin_layout Plain Layout
7652 defaults.lyx
7653 \end_layout
7654
7655 \end_inset
7656
7657 .
7658  This template is loaded every time you create a new document with
7659 \begin_inset Flex Noun
7660 status collapsed
7661
7662 \begin_layout Plain Layout
7663 File\SpecialChar menuseparator
7664 New
7665 \end_layout
7666
7667 \end_inset
7668
7669  in order to provide useful defaults.
7670  To create this template from inside \SpecialChar LyX
7671 , all you have to do is to open a document
7672  with the correct settings, and use the
7673 \begin_inset Flex Noun
7674 status collapsed
7675
7676 \begin_layout Plain Layout
7677 Save as Document Defaults
7678 \end_layout
7679
7680 \end_inset
7681
7682  button.
7683 \end_layout
7684
7685 \begin_layout Subsection
7686 Upgrading old layout files
7687 \end_layout
7688
7689 \begin_layout Standard
7690 The format of layout files changes with each \SpecialChar LyX
7691  release, so old layout files
7692  need to be converted to the new format.
7693  If \SpecialChar LyX
7694  reads a layout file in an older format, it automatically calls the
7695  script
7696 \begin_inset Flex Code
7697 status collapsed
7698
7699 \begin_layout Plain Layout
7700 layout2layout.py
7701 \end_layout
7702
7703 \end_inset
7704
7705  to convert it to a temporary file in current format.
7706  The original file is left untouched.
7707  If you use the layout file often, then, you may want to convert it permanently,
7708  so that \SpecialChar LyX
7709  does not have to do so itself every time.
7710  To do this, you can call the converter manually:
7711 \end_layout
7712
7713 \begin_layout Enumerate
7714 rename the file
7715 \begin_inset Flex Code
7716 status collapsed
7717
7718 \begin_layout Plain Layout
7719 myclass.layout
7720 \end_layout
7721
7722 \end_inset
7723
7724  to
7725 \begin_inset Flex Code
7726 status collapsed
7727
7728 \begin_layout Plain Layout
7729 myclass.old
7730 \end_layout
7731
7732 \end_inset
7733
7734
7735 \end_layout
7736
7737 \begin_layout Enumerate
7738 Call the command
7739 \begin_inset Newline newline
7740 \end_inset
7741
7742
7743 \begin_inset Flex Code
7744 status collapsed
7745
7746 \begin_layout Plain Layout
7747 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7748 \end_layout
7749
7750 \end_inset
7751
7752
7753 \begin_inset Newline newline
7754 \end_inset
7755
7756 where
7757 \begin_inset Flex Code
7758 status collapsed
7759
7760 \begin_layout Plain Layout
7761 LyXDir
7762 \end_layout
7763
7764 \end_inset
7765
7766  is the name of your \SpecialChar LyX
7767  system directory.
7768 \end_layout
7769
7770 \begin_layout Standard
7771 Note that manual conversion does not affect included files, so these will
7772  have to be converted separately.
7773 \end_layout
7774
7775 \begin_layout Subsection
7776 \begin_inset CommandInset label
7777 LatexCommand label
7778 name "subsec:Cite-Engine-Files"
7779
7780 \end_inset
7781
7782 Cite engine files
7783 \end_layout
7784
7785 \begin_layout Standard
7786 A specific form of layout files are the so-called
7787 \begin_inset Flex Code
7788 status collapsed
7789
7790 \begin_layout Plain Layout
7791 *.citeengine
7792 \end_layout
7793
7794 \end_inset
7795
7796  files that are located in the
7797 \begin_inset Flex Code
7798 status collapsed
7799
7800 \begin_layout Plain Layout
7801 citeengines/
7802 \end_layout
7803
7804 \end_inset
7805
7806  sub-directory.
7807  Their purpose is to define the specifics of \SpecialChar LaTeX
7808  packages aimed at bibliography
7809  generation, such as
7810 \family sans
7811 natbib
7812 \family default
7813 ,
7814 \family sans
7815  jurabib
7816 \family default
7817  or
7818 \family sans
7819 biblatex
7820 \family default
7821 , but also the way how normal Bib\SpecialChar TeX
7822  citations (without additional packages)
7823  are handled in \SpecialChar LyX
7824  is defined in such a file.
7825
7826 \end_layout
7827
7828 \begin_layout Standard
7829 More specifically, it is defined which packages \SpecialChar LyX
7830  needs to load, which citation
7831  commands are available, how these are to be displayed in \SpecialChar LyX
7832  (in the workarea,
7833  the dialogs, the context menus) as well as in the XHTML and plain text
7834  output.
7835  Furthermore, the files specify available style variants (author-year, numerical
7836 , etc.) and their specifics.
7837  The cite engine files are also used to generate the options that are available
7838  in
7839 \family sans
7840 Document\SpecialChar menuseparator
7841 Settings\SpecialChar menuseparator
7842 Bibliography\SpecialChar menuseparator
7843 Style engine
7844 \family default
7845 .
7846 \end_layout
7847
7848 \begin_layout Standard
7849 Even though a cite engine file is essentially a normal layout file that
7850  could theoretically include any layout information, it usually primarily
7851  includes some specific parameters such as
7852 \begin_inset Flex Code
7853 status collapsed
7854
7855 \begin_layout Plain Layout
7856 MaxCiteNames
7857 \end_layout
7858
7859 \end_inset
7860
7861 ,
7862 \begin_inset Flex Code
7863 status collapsed
7864
7865 \begin_layout Plain Layout
7866 CiteFramework
7867 \end_layout
7868
7869 \end_inset
7870
7871 ,
7872 \begin_inset Flex Code
7873 status collapsed
7874
7875 \begin_layout Plain Layout
7876 CiteEngine
7877 \end_layout
7878
7879 \end_inset
7880
7881  and
7882 \begin_inset Flex Code
7883 status collapsed
7884
7885 \begin_layout Plain Layout
7886 CiteFormat
7887 \end_layout
7888
7889 \end_inset
7890
7891  blocks.
7892  The syntax of the latter two is described in
7893 \begin_inset CommandInset ref
7894 LatexCommand ref
7895 reference "subsec:Citation-engine-description"
7896 plural "false"
7897 caps "false"
7898 noprefix "false"
7899
7900 \end_inset
7901
7902  and
7903 \begin_inset CommandInset ref
7904 LatexCommand ref
7905 reference "subsec:Citation-format-description"
7906
7907 \end_inset
7908
7909 , as well as in the files themselves.
7910 \end_layout
7911
7912 \begin_layout Section
7913 \begin_inset CommandInset label
7914 LatexCommand label
7915 name "sec:TextClass"
7916
7917 \end_inset
7918
7919 The layout file format
7920 \end_layout
7921
7922 \begin_layout Standard
7923 The following sections describe how layout files are structured and written.
7924  Our advice is to go slowly, save and test often.
7925  It is really not that hard, except that the multitude of options can become
7926  overwhelming, especially if you try to check out too many at once.
7927  It becomes easier if you use existing layouts of \SpecialChar LyX
7928  as examples/reference
7929  or if you modify an existing layout to your needs.
7930 \end_layout
7931
7932 \begin_layout Standard
7933 Note that all the tags used in layout files are case-insensitive.
7934  This means that
7935 \begin_inset Flex Code
7936 status collapsed
7937
7938 \begin_layout Plain Layout
7939 Style
7940 \end_layout
7941
7942 \end_inset
7943
7944 ,
7945 \begin_inset Flex Code
7946 status collapsed
7947
7948 \begin_layout Plain Layout
7949 style
7950 \end_layout
7951
7952 \end_inset
7953
7954  and
7955 \begin_inset Flex Code
7956 status collapsed
7957
7958 \begin_layout Plain Layout
7959 StYlE
7960 \end_layout
7961
7962 \end_inset
7963
7964  are really the same tag.
7965  The possible arguments are printed in brackets after the tag's name.
7966  The default argument is typeset
7967 \begin_inset Flex Code
7968 status collapsed
7969
7970 \begin_layout Plain Layout
7971
7972 \emph on
7973 emphasized
7974 \end_layout
7975
7976 \end_inset
7977
7978 .
7979  If the argument has a data type like
7980 \begin_inset Quotes eld
7981 \end_inset
7982
7983 string
7984 \begin_inset Quotes erd
7985 \end_inset
7986
7987  or
7988 \begin_inset Quotes eld
7989 \end_inset
7990
7991 float
7992 \begin_inset Quotes erd
7993 \end_inset
7994
7995 , the default is shown like this:
7996 \begin_inset Flex Code
7997 status collapsed
7998
7999 \begin_layout Plain Layout
8000 float=
8001 \emph on
8002 default
8003 \end_layout
8004
8005 \end_inset
8006
8007 .
8008 \end_layout
8009
8010 \begin_layout Subsection
8011 The document class declaration and classification
8012 \end_layout
8013
8014 \begin_layout Standard
8015 Lines in a layout file which begin with
8016 \begin_inset Flex Code
8017 status collapsed
8018
8019 \begin_layout Plain Layout
8020 #
8021 \end_layout
8022
8023 \end_inset
8024
8025  are comments.
8026  There is one exception to this rule.
8027  All
8028 \begin_inset Flex Code
8029 status collapsed
8030
8031 \begin_layout Plain Layout
8032 *.layout
8033 \end_layout
8034
8035 \end_inset
8036
8037  files should begin with lines like:
8038 \end_layout
8039
8040 \begin_layout LyX-Code
8041
8042 \size small
8043 #% Do not delete the line below; configure depends on this
8044 \end_layout
8045
8046 \begin_layout LyX-Code
8047
8048 \size small
8049 #
8050 \backslash
8051 DeclareLaTeXClass{Article (Standard Class)}
8052 \end_layout
8053
8054 \begin_layout LyX-Code
8055
8056 \size small
8057 #
8058 \backslash
8059 DeclareCategory{Articles}
8060 \end_layout
8061
8062 \begin_layout Standard
8063 The second and third lines are used when you (re)configure \SpecialChar LyX
8064 .
8065  The layout file is read by the \SpecialChar LaTeX
8066  script
8067 \begin_inset Flex Code
8068 status collapsed
8069
8070 \begin_layout Plain Layout
8071 chkconfig.ltx
8072 \end_layout
8073
8074 \end_inset
8075
8076 , in a special mode where
8077 \begin_inset Flex Code
8078 status collapsed
8079
8080 \begin_layout Plain Layout
8081 #
8082 \end_layout
8083
8084 \end_inset
8085
8086  is ignored.
8087  The first line is just a \SpecialChar LaTeX
8088  comment, the second one contains the mandatory
8089  declaration of the text class and the third line contains the optional
8090  classification of the class.
8091  If these lines appear in a file named
8092 \begin_inset Flex Code
8093 status collapsed
8094
8095 \begin_layout Plain Layout
8096 article.layout
8097 \end_layout
8098
8099 \end_inset
8100
8101 , then they define a text class of name
8102 \begin_inset Flex Code
8103 status collapsed
8104
8105 \begin_layout Plain Layout
8106 article
8107 \end_layout
8108
8109 \end_inset
8110
8111  (the name of the layout file) which uses the \SpecialChar LaTeX
8112  document class
8113 \begin_inset Flex Code
8114 status collapsed
8115
8116 \begin_layout Plain Layout
8117 article.cls
8118 \end_layout
8119
8120 \end_inset
8121
8122  (the default is to use the same name as the layout).
8123  The string
8124 \begin_inset Quotes eld
8125 \end_inset
8126
8127 Article (Standard Class)
8128 \begin_inset Quotes erd
8129 \end_inset
8130
8131  that appears above is used as a description of the text class in the
8132 \begin_inset Flex Noun
8133 status collapsed
8134
8135 \begin_layout Plain Layout
8136 Document\SpecialChar menuseparator
8137 Settings
8138 \end_layout
8139
8140 \end_inset
8141
8142  dialog.
8143  The category (
8144 \begin_inset Quotes eld
8145 \end_inset
8146
8147 Articles
8148 \begin_inset Quotes erd
8149 \end_inset
8150
8151  in the example) is also used in the
8152 \begin_inset Flex Noun
8153 status collapsed
8154
8155 \begin_layout Plain Layout
8156 Document\SpecialChar menuseparator
8157 Settings
8158 \end_layout
8159
8160 \end_inset
8161
8162  dialog: the text classes are grouped by these categories (which are usually
8163  genres, so typical categories are
8164 \begin_inset Quotes eld
8165 \end_inset
8166
8167 Articles
8168 \begin_inset Quotes erd
8169 \end_inset
8170
8171 ,
8172 \begin_inset Quotes eld
8173 \end_inset
8174
8175 Books
8176 \begin_inset Quotes erd
8177 \end_inset
8178
8179 ,
8180 \begin_inset Quotes eld
8181 \end_inset
8182
8183 Reports
8184 \begin_inset Quotes erd
8185 \end_inset
8186
8187 ,
8188 \begin_inset Quotes eld
8189 \end_inset
8190
8191 Letters
8192 \begin_inset Quotes erd
8193 \end_inset
8194
8195 ,
8196 \begin_inset Quotes eld
8197 \end_inset
8198
8199 Presentations
8200 \begin_inset Quotes erd
8201 \end_inset
8202
8203 ,
8204 \begin_inset Quotes eld
8205 \end_inset
8206
8207 Curricula Vitae
8208 \begin_inset Quotes erd
8209 \end_inset
8210
8211  etc.).
8212  If no category has been declared, the class will be put in the
8213 \begin_inset Quotes eld
8214 \end_inset
8215
8216 Uncategorized
8217 \begin_inset Quotes erd
8218 \end_inset
8219
8220  group.
8221 \end_layout
8222
8223 \begin_layout Standard
8224 Let's assume that you wrote your own text class that uses the
8225 \begin_inset Flex Code
8226 status collapsed
8227
8228 \begin_layout Plain Layout
8229 article.cls
8230 \end_layout
8231
8232 \end_inset
8233
8234  document class, but where you changed the appearance of the section headings.
8235  If you put it in a file
8236 \begin_inset Flex Code
8237 status collapsed
8238
8239 \begin_layout Plain Layout
8240 myarticle.layout
8241 \end_layout
8242
8243 \end_inset
8244
8245 , the header of this file should be:
8246 \end_layout
8247
8248 \begin_layout LyX-Code
8249
8250 \size small
8251 #% Do not delete the line below; configure depends on this
8252 \end_layout
8253
8254 \begin_layout LyX-Code
8255
8256 \size small
8257 #
8258 \backslash
8259 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8260 \end_layout
8261
8262 \begin_layout LyX-Code
8263
8264 \size small
8265 #
8266 \backslash
8267 DeclareCategory{Articles}
8268 \end_layout
8269
8270 \begin_layout Standard
8271 This declares a text class
8272 \begin_inset Flex Code
8273 status collapsed
8274
8275 \begin_layout Plain Layout
8276 myarticle
8277 \end_layout
8278
8279 \end_inset
8280
8281 , associated with the \SpecialChar LaTeX
8282  document class
8283 \begin_inset Flex Code
8284 status collapsed
8285
8286 \begin_layout Plain Layout
8287 article.cls
8288 \end_layout
8289
8290 \end_inset
8291
8292  and described as
8293 \begin_inset Quotes eld
8294 \end_inset
8295
8296 Article (with My Own Headings)
8297 \begin_inset Quotes erd
8298 \end_inset
8299
8300 .
8301  If your text class depends on several packages, you can declare it as:
8302 \end_layout
8303
8304 \begin_layout LyX-Code
8305
8306 \size small
8307 #% Do not delete the line below; configure depends on this
8308 \end_layout
8309
8310 \begin_layout LyX-Code
8311
8312 \size small
8313 #
8314 \backslash
8315 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8316 \end_layout
8317
8318 \begin_layout LyX-Code
8319
8320 \size small
8321 #
8322 \backslash
8323 DeclareCategory{Articles}
8324 \end_layout
8325
8326 \begin_layout Standard
8327 This indicates that your text class uses the
8328 \begin_inset Flex Code
8329 status collapsed
8330
8331 \begin_layout Plain Layout
8332 foo.sty
8333 \end_layout
8334
8335 \end_inset
8336
8337  package.
8338  Finally, it is also possible to declare classes for DocBook code.
8339  Typical declarations will look like:
8340 \end_layout
8341
8342 \begin_layout LyX-Code
8343
8344 \size small
8345 #% Do not delete the line below; configure depends on this
8346 \end_layout
8347
8348 \begin_layout LyX-Code
8349
8350 \size small
8351 #
8352 \backslash
8353 DeclareDocBookClass[article]{SGML (DocBook Article)}
8354 \end_layout
8355
8356 \begin_layout LyX-Code
8357
8358 \size small
8359 #
8360 \backslash
8361 DeclareCategory{Articles (DocBook)}
8362 \end_layout
8363
8364 \begin_layout Standard
8365 Note that these declarations can also be given an optional parameter declaring
8366  the name of the document class (but not a list).
8367 \end_layout
8368
8369 \begin_layout Standard
8370 So, to be as explicit as possible, the form of the layout declaration is:
8371 \end_layout
8372
8373 \begin_layout LyX-Code
8374
8375 \size small
8376 #
8377 \backslash
8378 DeclareLaTeXClass[class,package.sty]{layout description}
8379 \end_layout
8380
8381 \begin_layout LyX-Code
8382
8383 \size small
8384 #
8385 \backslash
8386 DeclareCategory{category}
8387 \end_layout
8388
8389 \begin_layout Standard
8390 The class need only be specified if the name of the \SpecialChar LaTeX
8391  class file and the
8392  name of the layout file are different or if there are packages to load.
8393  If the name of the class file is not specified, then \SpecialChar LyX
8394  will simply assume
8395  that it is the same as the name of the layout file.
8396 \end_layout
8397
8398 \begin_layout Standard
8399 When the text class has been modified to your taste, all you have to do
8400  is to copy it either to
8401 \begin_inset Flex Code
8402 status collapsed
8403
8404 \begin_layout Plain Layout
8405 LyXDir/layouts/
8406 \end_layout
8407
8408 \end_inset
8409
8410  or to
8411 \begin_inset Flex Code
8412 status collapsed
8413
8414 \begin_layout Plain Layout
8415 UserDir/layouts
8416 \end_layout
8417
8418 \end_inset
8419
8420 , run
8421 \begin_inset Flex Noun
8422 status collapsed
8423
8424 \begin_layout Plain Layout
8425 Tools\SpecialChar menuseparator
8426 Reconfigure
8427 \end_layout
8428
8429 \end_inset
8430
8431 , exit \SpecialChar LyX
8432  and restart.
8433  Then your new text class should be available along with the others.
8434 \end_layout
8435
8436 \begin_layout Standard
8437 Once the layout file is installed, you can edit it and see your changes
8438  without having to reconfigure or to restart \SpecialChar LyX
8439 .
8440 \begin_inset Foot
8441 status collapsed
8442
8443 \begin_layout Plain Layout
8444 In versions of \SpecialChar LyX
8445  prior to 1.6, this was not true.
8446  As a result, editing layout files was very time consuming, since you had
8447  constantly to restart \SpecialChar LyX
8448  to see changes.
8449 \end_layout
8450
8451 \end_inset
8452
8453  You can force a reload of the current layout by using the \SpecialChar LyX
8454  function
8455 \begin_inset Flex Noun
8456 status collapsed
8457
8458 \begin_layout Plain Layout
8459 layout-reload
8460 \end_layout
8461
8462 \end_inset
8463
8464 .
8465  There is no default binding for this function—though, of course, you can
8466  bind it to a key yourself.
8467  But you will normally use this function simply by entering it in the mini-buffe
8468 r.
8469
8470 \end_layout
8471
8472 \begin_layout Standard
8473
8474 \emph on
8475 Warning
8476 \emph default
8477 :
8478 \begin_inset Flex Noun
8479 status collapsed
8480
8481 \begin_layout Plain Layout
8482 layout-reload
8483 \end_layout
8484
8485 \end_inset
8486
8487  is very much an `advanced feature'.
8488  It is
8489 \emph on
8490 strongly
8491 \emph default
8492  recommended that you save your work before using this function.
8493  In fact, it is
8494 \emph on
8495 strongly
8496 \emph default
8497  recommended that you not attempt to edit layout information while simultaneousl
8498 y working on a document that you care about.
8499  Use a test document.
8500  Syntax errors and the like in your layout file could cause peculiar behavior.
8501  In particular, such errors could cause \SpecialChar LyX
8502  to regard the current layout as
8503  invalid and to attempt to switch to some other layout.
8504 \begin_inset Foot
8505 status collapsed
8506
8507 \begin_layout Plain Layout
8508 Really bad syntax errors may even caused \SpecialChar LyX
8509  to exit.
8510  This is because certain sorts of errors may make \SpecialChar LyX
8511  unable to read
8512 \emph on
8513 any
8514 \emph default
8515  layout information.
8516  Please be careful.
8517 \end_layout
8518
8519 \end_inset
8520
8521  The \SpecialChar LyX
8522  team strives to keep \SpecialChar LyX
8523  stable in such situations, but safe is better
8524  than sorry.
8525 \begin_inset Foot
8526 status collapsed
8527
8528 \begin_layout Plain Layout
8529 While we're giving advice: make regular backups.
8530  And be nice to your mother.
8531 \end_layout
8532
8533 \end_inset
8534
8535
8536 \end_layout
8537
8538 \begin_layout Subsection
8539 The Module declaration
8540 \end_layout
8541
8542 \begin_layout Standard
8543 A module must begin with a line like the following:
8544 \end_layout
8545
8546 \begin_layout LyX-Code
8547 #
8548 \backslash
8549 DeclareLyXModule[endnotes.sty]{Endnotes}
8550 \change_inserted -712698321 1554395911
8551
8552 \end_layout
8553
8554 \begin_layout LyX-Code
8555
8556 \change_inserted -712698321 1554395924
8557
8558 \size small
8559 #
8560 \backslash
8561 DeclareCategory{Foot- and Endnotes}
8562 \change_deleted -712698321 1554395911
8563
8564 \size default
8565
8566 \change_unchanged
8567
8568 \end_layout
8569
8570 \begin_layout Standard
8571 The mandatory argument
8572 \change_inserted -712698321 1554395956
8573  of
8574 \family typewriter
8575
8576 \backslash
8577 DeclareLyXModule
8578 \change_unchanged
8579
8580 \family default
8581 , in curly brackets, is the name of the module, as it should appear in
8582 \begin_inset Flex Noun
8583 status collapsed
8584
8585 \begin_layout Plain Layout
8586 Document\SpecialChar menuseparator
8587 Settings\SpecialChar menuseparator
8588 Modules
8589 \end_layout
8590
8591 \end_inset
8592
8593 .
8594  The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8595  packages
8596  on which the module depends.
8597  It is also possible to use the form
8598 \begin_inset Flex Noun
8599 status collapsed
8600
8601 \begin_layout Plain Layout
8602 from->to
8603 \end_layout
8604
8605 \end_inset
8606
8607  as an optional argument, which declares that the module can only be used
8608  when there exists a conversion chain between the formats `
8609 \begin_inset Flex Code
8610 status collapsed
8611
8612 \begin_layout Plain Layout
8613 from
8614 \end_layout
8615
8616 \end_inset
8617
8618 ' and `
8619 \begin_inset Flex Code
8620 status collapsed
8621
8622 \begin_layout Plain Layout
8623 to
8624 \end_layout
8625
8626 \end_inset
8627
8628 '.
8629
8630 \change_inserted -712698321 1554396133
8631  The
8632 \family typewriter
8633
8634 \backslash
8635 DeclareCategory
8636 \family default
8637  declaration is not strictly mandatory, but you should add it, since it
8638  is helpful to find the module.
8639  Please have a look at the existing module categories and if appropriate,
8640  use one of those.
8641 \change_unchanged
8642
8643 \end_layout
8644
8645 \begin_layout Standard
8646 The module
8647 \change_inserted -712698321 1554395988
8648 and category
8649 \change_unchanged
8650 declaration should then be followed by lines like the following:
8651 \begin_inset Foot
8652 status collapsed
8653
8654 \begin_layout Plain Layout
8655 Preferably in English if the module should be published with \SpecialChar LyX
8656 .
8657  This description will appear in the list of messages to be translated and
8658  will be thus translated with the next interface update.
8659 \end_layout
8660
8661 \end_inset
8662
8663
8664 \end_layout
8665
8666 \begin_layout LyX-Code
8667 #DescriptionBegin
8668 \end_layout
8669
8670 \begin_layout LyX-Code
8671 #Adds an endnote command, in addition to footnotes.
8672
8673 \end_layout
8674
8675 \begin_layout LyX-Code
8676 #You will need to add
8677 \backslash
8678 theendnotes in TeX code where you
8679 \end_layout
8680
8681 \begin_layout LyX-Code
8682 #want the endnotes to appear.
8683
8684 \end_layout
8685
8686 \begin_layout LyX-Code
8687 #DescriptionEnd
8688 \end_layout
8689
8690 \begin_layout LyX-Code
8691 #Requires: somemodule | othermodule
8692 \end_layout
8693
8694 \begin_layout LyX-Code
8695 #Excludes: badmodule
8696 \end_layout
8697
8698 \begin_layout Standard
8699 The description is used in
8700 \begin_inset Flex Noun
8701 status collapsed
8702
8703 \begin_layout Plain Layout
8704 Document\SpecialChar menuseparator
8705 Settings\SpecialChar menuseparator
8706 Modules
8707 \end_layout
8708
8709 \end_inset
8710
8711  to provide the user with information about what the module does.
8712  The
8713 \begin_inset Flex Code
8714 status collapsed
8715
8716 \begin_layout Plain Layout
8717 Requires
8718 \end_layout
8719
8720 \end_inset
8721
8722  line is used to identify other modules with which this one must be used;
8723  the
8724 \begin_inset Flex Code
8725 status collapsed
8726
8727 \begin_layout Plain Layout
8728 Excludes
8729 \end_layout
8730
8731 \end_inset
8732
8733  line is used to identify modules with which this one may not be used.
8734  Both are optional, and, as shown, multiple modules should be separated
8735  with the pipe symbol: |.
8736  Note that the required modules are treated disjunctively:
8737 \emph on
8738 at least one
8739 \emph default
8740  of the required modules must be used.
8741  Similarly,
8742 \emph on
8743 no
8744 \emph default
8745  excluded module may be used.
8746  Note that modules are identified here by their filenames without the
8747 \begin_inset Flex Code
8748 status collapsed
8749
8750 \begin_layout Plain Layout
8751 .module
8752 \end_layout
8753
8754 \end_inset
8755
8756  extension.
8757  So
8758 \begin_inset Flex Code
8759 status collapsed
8760
8761 \begin_layout Plain Layout
8762 somemodule
8763 \end_layout
8764
8765 \end_inset
8766
8767  is really
8768 \begin_inset Flex Code
8769 status collapsed
8770
8771 \begin_layout Plain Layout
8772 somemodule.module
8773 \end_layout
8774
8775 \end_inset
8776
8777 .
8778 \end_layout
8779
8780 \begin_layout Subsection
8781 The CiteEngine file declaration
8782 \end_layout
8783
8784 \begin_layout Standard
8785 A cite engine file must begin with a line like the following:
8786 \end_layout
8787
8788 \begin_layout LyX-Code
8789 #
8790 \backslash
8791 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
8792 \end_layout
8793
8794 \begin_layout Standard
8795 The mandatory argument, in curly brackets, is the name of the cite style,
8796  as it should appear in
8797 \begin_inset Flex Noun
8798 status collapsed
8799
8800 \begin_layout Plain Layout
8801 Document\SpecialChar menuseparator
8802 Settings\SpecialChar menuseparator
8803 Bibliography
8804 \end_layout
8805
8806 \end_inset
8807
8808 .
8809  The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8810  packages
8811  on which the cite engine depends.
8812 \end_layout
8813
8814 \begin_layout Standard
8815 The cite engine declaration should then be followed by lines like the following:
8816 \begin_inset Foot
8817 status collapsed
8818
8819 \begin_layout Plain Layout
8820 Preferably in English if the module should be published with \SpecialChar LyX
8821 .
8822  This description will appear in the list of messages to be translated and
8823  will be thus translated with the next interface update.
8824 \end_layout
8825
8826 \end_inset
8827
8828
8829 \end_layout
8830
8831 \begin_layout LyX-Code
8832 # DescriptionBegin
8833 \end_layout
8834
8835 \begin_layout LyX-Code
8836 #   Biblatex supports many author-year and numerical styles.
8837 \end_layout
8838
8839 \begin_layout LyX-Code
8840 #   It is mainly aimed at the Humanities.
8841  It is highly
8842 \end_layout
8843
8844 \begin_layout LyX-Code
8845 #   customizable, fully localized and provides many features
8846 \end_layout
8847
8848 \begin_layout LyX-Code
8849 #   that are not possible with BibTeX.
8850  The use of 'biber' as
8851 \end_layout
8852
8853 \begin_layout LyX-Code
8854 #   bibliography processor is advised.
8855 \end_layout
8856
8857 \begin_layout LyX-Code
8858 # DescriptionEnd
8859 \end_layout
8860
8861 \begin_layout Standard
8862 The description is used in
8863 \begin_inset Flex Noun
8864 status collapsed
8865
8866 \begin_layout Plain Layout
8867 Document\SpecialChar menuseparator
8868 Settings\SpecialChar menuseparator
8869 Bibliography
8870 \end_layout
8871
8872 \end_inset
8873
8874  to provide the user with information about the cite engine.
8875 \end_layout
8876
8877 \begin_layout Subsection
8878 Format number
8879 \end_layout
8880
8881 \begin_layout Standard
8882 The first non-comment line of any layout file, included file, or module
8883
8884 \emph on
8885 must
8886 \emph default
8887  contain the file format number:
8888 \end_layout
8889
8890 \begin_layout Description
8891 \begin_inset Flex Code
8892 status collapsed
8893
8894 \begin_layout Plain Layout
8895 Format
8896 \end_layout
8897
8898 \end_inset
8899
8900  [
8901 \begin_inset Flex Code
8902 status collapsed
8903
8904 \begin_layout Plain Layout
8905 int
8906 \end_layout
8907
8908 \end_inset
8909
8910 ] The format number of the layout file.
8911 \end_layout
8912
8913 \begin_layout Standard
8914 This tag was introduced with \SpecialChar LyX
8915
8916 \begin_inset space ~
8917 \end_inset
8918
8919 1.4.0.
8920  Layout files from older \SpecialChar LyX
8921  versions do not have an explicit file format and
8922  are considered to have
8923 \begin_inset Flex Code
8924 status collapsed
8925
8926 \begin_layout Plain Layout
8927 Format
8928 \begin_inset space ~
8929 \end_inset
8930
8931 1
8932 \end_layout
8933
8934 \end_inset
8935
8936 .
8937  The format for the present version of \SpecialChar LyX
8938  is format 60.
8939  But each version of \SpecialChar LyX
8940  is capable of reading earlier versions' layout files,
8941  just as they are capable of reading files produced by earlier versions
8942  of \SpecialChar LyX
8943 .
8944  There is, however, no provision for converting to earlier formats.
8945 \end_layout
8946
8947 \begin_layout Subsection
8948 \begin_inset CommandInset label
8949 LatexCommand label
8950 name "subsec:General-text-class"
8951
8952 \end_inset
8953
8954 General text class parameters
8955 \end_layout
8956
8957 \begin_layout Standard
8958 These are general parameters that govern the behavior of an entire document
8959  class.
8960  (This does
8961 \emph on
8962 not
8963 \emph default
8964  mean that they must appear in
8965 \begin_inset Flex Code
8966 status collapsed
8967
8968 \begin_layout Plain Layout
8969 .layout
8970 \end_layout
8971
8972 \end_inset
8973
8974  files rather than in modules.
8975  A module can contain any layout tag.)
8976 \end_layout
8977
8978 \begin_layout Description
8979
8980 \change_inserted -712698321 1526899478
8981 \begin_inset Flex Code
8982 status collapsed
8983
8984 \begin_layout Plain Layout
8985
8986 \change_inserted -712698321 1526898610
8987 AddToCiteEngine <engine>
8988 \end_layout
8989
8990 \end_inset
8991
8992  Extends the possibilities for displaying citation references.
8993  See
8994 \begin_inset CommandInset ref
8995 LatexCommand ref
8996 reference "subsec:Citation-engine-description"
8997 plural "false"
8998 caps "false"
8999 noprefix "false"
9000
9001 \end_inset
9002
9003  for details.
9004  Must end with
9005 \begin_inset Flex Code
9006 status collapsed
9007
9008 \begin_layout Plain Layout
9009
9010 \change_inserted -712698321 1526898823
9011 End
9012 \change_unchanged
9013
9014 \end_layout
9015
9016 \end_inset
9017
9018 .
9019 \end_layout
9020
9021 \begin_layout Description
9022 \begin_inset Flex Code
9023 status collapsed
9024
9025 \begin_layout Plain Layout
9026 AddToHTMLPreamble
9027 \end_layout
9028
9029 \end_inset
9030
9031  Adds information that will be output in the
9032 \begin_inset Flex Code
9033 status collapsed
9034
9035 \begin_layout Plain Layout
9036 <head>
9037 \end_layout
9038
9039 \end_inset
9040
9041  block when the document is output to XHTML.
9042  Typically, this would be used to output CSS style information, but it can
9043  be used for anything that can appear in
9044 \begin_inset Flex Code
9045 status collapsed
9046
9047 \begin_layout Plain Layout
9048 <head>
9049 \end_layout
9050
9051 \end_inset
9052
9053 .
9054  Must end with
9055 \begin_inset Quotes eld
9056 \end_inset
9057
9058
9059 \begin_inset Flex Code
9060 status collapsed
9061
9062 \begin_layout Plain Layout
9063 EndPreamble
9064 \end_layout
9065
9066 \end_inset
9067
9068
9069 \begin_inset Quotes erd
9070 \end_inset
9071
9072 .
9073 \end_layout
9074
9075 \begin_layout Description
9076 \begin_inset Flex Code
9077 status collapsed
9078
9079 \begin_layout Plain Layout
9080 AddToPreamble
9081 \end_layout
9082
9083 \end_inset
9084
9085  Adds information to the document preamble.
9086  Must end with
9087 \begin_inset Newline newline
9088 \end_inset
9089
9090
9091 \begin_inset Quotes eld
9092 \end_inset
9093
9094
9095 \begin_inset Flex Code
9096 status collapsed
9097
9098 \begin_layout Plain Layout
9099 EndPreamble
9100 \end_layout
9101
9102 \end_inset
9103
9104
9105 \begin_inset Quotes erd
9106 \end_inset
9107
9108 .
9109 \change_inserted -712698321 1562592950
9110
9111 \end_layout
9112
9113 \begin_layout Description
9114
9115 \change_inserted -712698321 1562593040
9116 \begin_inset Flex Code
9117 status collapsed
9118
9119 \begin_layout Plain Layout
9120
9121 \change_inserted -712698321 1562592954
9122 BibInToc
9123 \end_layout
9124
9125 \end_inset
9126
9127  [
9128 \begin_inset Flex Code
9129 status collapsed
9130
9131 \begin_layout Plain Layout
9132
9133 \change_inserted -712698321 1562592950
9134
9135 \emph on
9136 0
9137 \end_layout
9138
9139 \end_inset
9140
9141 ,
9142 \begin_inset space \thinspace{}
9143 \end_inset
9144
9145
9146 \begin_inset Flex Code
9147 status collapsed
9148
9149 \begin_layout Plain Layout
9150
9151 \change_inserted -712698321 1562592950
9152 1
9153 \end_layout
9154
9155 \end_inset
9156
9157 ] If the document class adds the bibliography to the table of contents,
9158  add this option with value
9159 \begin_inset Flex Code
9160 status collapsed
9161
9162 \begin_layout Plain Layout
9163
9164 \change_inserted -712698321 1562592996
9165 1
9166 \change_unchanged
9167
9168 \end_layout
9169
9170 \end_inset
9171
9172  (or
9173 \begin_inset Flex Code
9174 status collapsed
9175
9176 \begin_layout Plain Layout
9177
9178 \change_inserted -712698321 1562593006
9179 true
9180 \change_unchanged
9181
9182 \end_layout
9183
9184 \end_inset
9185
9186 ).
9187  This prevents the bibliography from being added twice.
9188 \change_unchanged
9189
9190 \end_layout
9191
9192 \begin_layout Description
9193 \begin_inset Flex Code
9194 status collapsed
9195
9196 \begin_layout Plain Layout
9197 CiteEngine <engine>
9198 \end_layout
9199
9200 \end_inset
9201
9202  Defines the possibilities for displaying citation references.
9203  See
9204 \begin_inset CommandInset ref
9205 LatexCommand ref
9206 reference "subsec:Citation-engine-description"
9207 plural "false"
9208 caps "false"
9209 noprefix "false"
9210
9211 \end_inset
9212
9213  for details.
9214  Must end with
9215 \begin_inset Quotes eld
9216 \end_inset
9217
9218
9219 \begin_inset Flex Code
9220 status collapsed
9221
9222 \begin_layout Plain Layout
9223 End
9224 \end_layout
9225
9226 \end_inset
9227
9228
9229 \begin_inset Quotes erd
9230 \end_inset
9231
9232 .
9233  Primarily used in cite engine files (see
9234 \begin_inset CommandInset ref
9235 LatexCommand ref
9236 reference "subsec:Cite-Engine-Files"
9237 plural "false"
9238 caps "false"
9239 noprefix "false"
9240
9241 \end_inset
9242
9243 ).
9244
9245 \change_inserted -712698321 1526898530
9246  Note that if you specify this in a layout file or module, any cite engine
9247  definition will be overridden.
9248  Also see
9249 \begin_inset Flex Code
9250 status collapsed
9251
9252 \begin_layout Plain Layout
9253
9254 \change_inserted -712698321 1526898530
9255 AddToCiteEngine
9256 \change_unchanged
9257
9258 \end_layout
9259
9260 \end_inset
9261
9262 .
9263 \change_unchanged
9264
9265 \end_layout
9266
9267 \begin_layout Description
9268 \begin_inset Flex Code
9269 status collapsed
9270
9271 \begin_layout Plain Layout
9272 CiteFormat
9273 \end_layout
9274
9275 \end_inset
9276
9277  Defines formats for use in the display of bibliographic information.
9278  See
9279 \begin_inset CommandInset ref
9280 LatexCommand ref
9281 reference "subsec:Citation-format-description"
9282
9283 \end_inset
9284
9285  for details.
9286  Must end with
9287 \begin_inset Quotes eld
9288 \end_inset
9289
9290
9291 \begin_inset Flex Code
9292 status collapsed
9293
9294 \begin_layout Plain Layout
9295 End
9296 \end_layout
9297
9298 \end_inset
9299
9300
9301 \begin_inset Quotes erd
9302 \end_inset
9303
9304 .
9305  Primarily used in cite engine files (see
9306 \begin_inset CommandInset ref
9307 LatexCommand ref
9308 reference "subsec:Cite-Engine-Files"
9309 plural "false"
9310 caps "false"
9311 noprefix "false"
9312
9313 \end_inset
9314
9315 ).
9316
9317 \change_inserted -712698321 1526898585
9318  A cite format defined in a layout or module will override the cite engine
9319  definition.
9320 \change_unchanged
9321
9322 \end_layout
9323
9324 \begin_layout Description
9325 \begin_inset Flex Code
9326 status collapsed
9327
9328 \begin_layout Plain Layout
9329 CiteFramework
9330 \end_layout
9331
9332 \end_inset
9333
9334  [
9335 \begin_inset Flex Code
9336 status collapsed
9337
9338 \begin_layout Plain Layout
9339
9340 \emph on
9341 bibtex
9342 \end_layout
9343
9344 \end_inset
9345
9346 ,
9347 \begin_inset Flex Code
9348 status collapsed
9349
9350 \begin_layout Plain Layout
9351 biblatex
9352 \end_layout
9353
9354 \end_inset
9355
9356 ] Determines whether
9357 \family sans
9358 Biblatex
9359 \family default
9360  or Bib\SpecialChar TeX
9361  is used to generate a Bibliography.
9362  Primarily used in cite engine files (see
9363 \begin_inset CommandInset ref
9364 LatexCommand ref
9365 reference "subsec:Cite-Engine-Files"
9366 plural "false"
9367 caps "false"
9368 noprefix "false"
9369
9370 \end_inset
9371
9372 ).
9373 \end_layout
9374
9375 \begin_layout Description
9376 \begin_inset Flex Code
9377 status collapsed
9378
9379 \begin_layout Plain Layout
9380 ClassOptions
9381 \end_layout
9382
9383 \end_inset
9384
9385  Describes various global options supported by the document class.
9386  See
9387 \begin_inset CommandInset ref
9388 LatexCommand ref
9389 reference "subsec:ClassOptions"
9390
9391 \end_inset
9392
9393  for a description.
9394  Must end with
9395 \begin_inset Quotes eld
9396 \end_inset
9397
9398
9399 \begin_inset Flex Code
9400 status collapsed
9401
9402 \begin_layout Plain Layout
9403 End
9404 \end_layout
9405
9406 \end_inset
9407
9408
9409 \begin_inset Quotes erd
9410 \end_inset
9411
9412 .
9413 \end_layout
9414
9415 \begin_layout Description
9416 \begin_inset Flex Code
9417 status collapsed
9418
9419 \begin_layout Plain Layout
9420 Columns
9421 \end_layout
9422
9423 \end_inset
9424
9425  [
9426 \begin_inset Flex Code
9427 status collapsed
9428
9429 \begin_layout Plain Layout
9430
9431 \emph on
9432 1
9433 \end_layout
9434
9435 \end_inset
9436
9437 ,
9438 \begin_inset space \thinspace{}
9439 \end_inset
9440
9441
9442 \begin_inset Flex Code
9443 status collapsed
9444
9445 \begin_layout Plain Layout
9446 2
9447 \end_layout
9448
9449 \end_inset
9450
9451 ] Whether the class should
9452 \emph on
9453 default
9454 \emph default
9455  to having one or two columns.
9456  Can be changed in the
9457 \begin_inset Flex Noun
9458 status collapsed
9459
9460 \begin_layout Plain Layout
9461 Document\SpecialChar menuseparator
9462 Settings
9463 \end_layout
9464
9465 \end_inset
9466
9467  dialog.
9468 \end_layout
9469
9470 \begin_layout Description
9471 \begin_inset Flex Code
9472 status collapsed
9473
9474 \begin_layout Plain Layout
9475 Counter
9476 \end_layout
9477
9478 \end_inset
9479
9480  [
9481 \begin_inset Flex Code
9482 status collapsed
9483
9484 \begin_layout Plain Layout
9485 string
9486 \end_layout
9487
9488 \end_inset
9489
9490 ] This sequence defines the properties for a counter.
9491  If the counter does not yet exist, it is created; if it does exist, it
9492  is modified.
9493  Must end with
9494 \begin_inset Quotes eld
9495 \end_inset
9496
9497
9498 \begin_inset Flex Code
9499 status collapsed
9500
9501 \begin_layout Plain Layout
9502 End
9503 \end_layout
9504
9505 \end_inset
9506
9507
9508 \begin_inset Quotes erd
9509 \end_inset
9510
9511 .
9512 \begin_inset Newline newline
9513 \end_inset
9514
9515 See
9516 \begin_inset CommandInset ref
9517 LatexCommand ref
9518 reference "subsec:Counters"
9519
9520 \end_inset
9521
9522  for details on counters.
9523 \end_layout
9524
9525 \begin_layout Description
9526 \begin_inset Flex Code
9527 status collapsed
9528
9529 \begin_layout Plain Layout
9530 DefaultFont
9531 \end_layout
9532
9533 \end_inset
9534
9535  Sets the default font used to display the document.
9536  See
9537 \begin_inset CommandInset ref
9538 LatexCommand ref
9539 reference "subsec:Font-description"
9540
9541 \end_inset
9542
9543  for how to declare fonts.
9544  Must end with
9545 \begin_inset Quotes eld
9546 \end_inset
9547
9548
9549 \begin_inset Flex Code
9550 status collapsed
9551
9552 \begin_layout Plain Layout
9553 EndFont
9554 \end_layout
9555
9556 \end_inset
9557
9558
9559 \begin_inset Quotes erd
9560 \end_inset
9561
9562 .
9563 \end_layout
9564
9565 \begin_layout Description
9566 \begin_inset Flex Code
9567 status collapsed
9568
9569 \begin_layout Plain Layout
9570 DefaultModule
9571 \end_layout
9572
9573 \end_inset
9574
9575  [
9576 \begin_inset Flex Code
9577 status collapsed
9578
9579 \begin_layout Plain Layout
9580 <module>
9581 \end_layout
9582
9583 \end_inset
9584
9585 ] Specifies a module to be included by default with this document class.
9586  The module is specified as filename without the
9587 \begin_inset Flex Code
9588 status collapsed
9589
9590 \begin_layout Plain Layout
9591 .module
9592 \end_layout
9593
9594 \end_inset
9595
9596  extension.
9597  The user can still remove the module, but it will be active at the outset.
9598  (This applies only when new files are created, or when this class is chosen
9599  for an existing document.)
9600 \end_layout
9601
9602 \begin_layout Description
9603 \begin_inset Flex Code
9604 status collapsed
9605
9606 \begin_layout Plain Layout
9607 DefaultStyle
9608 \end_layout
9609
9610 \end_inset
9611
9612  [
9613 \begin_inset Flex Code
9614 status collapsed
9615
9616 \begin_layout Plain Layout
9617 <style>
9618 \end_layout
9619
9620 \end_inset
9621
9622 ] This is the style that will be assigned to new paragraphs, usually
9623 \begin_inset Flex Noun
9624 status collapsed
9625
9626 \begin_layout Plain Layout
9627 Standard
9628 \end_layout
9629
9630 \end_inset
9631
9632 .
9633  This will default to the first defined style if not given, but you are
9634  encouraged to use this directive.
9635 \end_layout
9636
9637 \begin_layout Description
9638 \begin_inset Flex Code
9639 status collapsed
9640
9641 \begin_layout Plain Layout
9642 ExcludesModule
9643 \end_layout
9644
9645 \end_inset
9646
9647  [
9648 \begin_inset Flex Code
9649 status collapsed
9650
9651 \begin_layout Plain Layout
9652 <module>
9653 \end_layout
9654
9655 \end_inset
9656
9657 ] This tag indicates that the module (which is specified by filename without
9658  the
9659 \begin_inset Flex Code
9660 status collapsed
9661
9662 \begin_layout Plain Layout
9663 .module
9664 \end_layout
9665
9666 \end_inset
9667
9668  extension) cannot be used with this document class.
9669  This might be used in a journal-specific layout file to prevent, say, the
9670  use of the
9671 \begin_inset Flex Code
9672 status collapsed
9673
9674 \begin_layout Plain Layout
9675 theorems-sec
9676 \end_layout
9677
9678 \end_inset
9679
9680  module that numbers theorems by section.
9681  This tag may
9682 \emph on
9683 not
9684 \emph default
9685  be used in a module.
9686  Modules have their own way of excluding other modules (see
9687 \begin_inset CommandInset ref
9688 LatexCommand ref
9689 reference "subsec:Layout-modules"
9690
9691 \end_inset
9692
9693 ).
9694 \end_layout
9695
9696 \begin_layout Description
9697 \begin_inset Flex Code
9698 status collapsed
9699
9700 \begin_layout Plain Layout
9701 Float
9702 \end_layout
9703
9704 \end_inset
9705
9706  Defines a new float.
9707  See
9708 \begin_inset CommandInset ref
9709 LatexCommand ref
9710 reference "subsec:Floats"
9711
9712 \end_inset
9713
9714  for details.
9715  Must end with
9716 \begin_inset Quotes eld
9717 \end_inset
9718
9719
9720 \begin_inset Flex Code
9721 status collapsed
9722
9723 \begin_layout Plain Layout
9724 End
9725 \end_layout
9726
9727 \end_inset
9728
9729
9730 \begin_inset Quotes erd
9731 \end_inset
9732
9733 .
9734 \end_layout
9735
9736 \begin_layout Description
9737 \begin_inset Flex Code
9738 status collapsed
9739
9740 \begin_layout Plain Layout
9741 HTMLPreamble
9742 \end_layout
9743
9744 \end_inset
9745
9746  Sets the information that will be output in the
9747 \begin_inset Flex Code
9748 status collapsed
9749
9750 \begin_layout Plain Layout
9751 <head>
9752 \end_layout
9753
9754 \end_inset
9755
9756  block when this document class is output to XHTML.
9757  Note that this will completely override any prior
9758 \begin_inset Flex Code
9759 status collapsed
9760
9761 \begin_layout Plain Layout
9762 HTMLPreamble
9763 \end_layout
9764
9765 \end_inset
9766
9767  or
9768 \begin_inset Flex Code
9769 status collapsed
9770
9771 \begin_layout Plain Layout
9772 AddToHTMLPreamble
9773 \end_layout
9774
9775 \end_inset
9776
9777  declarations.
9778  (Use
9779 \begin_inset Newline newline
9780 \end_inset
9781
9782
9783 \begin_inset Flex Code
9784 status collapsed
9785
9786 \begin_layout Plain Layout
9787 AddToHTMLPreamble
9788 \end_layout
9789
9790 \end_inset
9791
9792  if you just want to add material to the preamble.) Must end with
9793 \begin_inset Quotes eld
9794 \end_inset
9795
9796
9797 \begin_inset Flex Code
9798 status collapsed
9799
9800 \begin_layout Plain Layout
9801 EndPreamble
9802 \end_layout
9803
9804 \end_inset
9805
9806
9807 \begin_inset Quotes erd
9808 \end_inset
9809
9810 .
9811 \end_layout
9812
9813 \begin_layout Description
9814 \begin_inset Flex Code
9815 status collapsed
9816
9817 \begin_layout Plain Layout
9818 HTMLTOCSection
9819 \end_layout
9820
9821 \end_inset
9822
9823  [
9824 \begin_inset Flex Code
9825 status collapsed
9826
9827 \begin_layout Plain Layout
9828 <style>
9829 \end_layout
9830
9831 \end_inset
9832
9833 ] The style to use for the table of contents, bibliography, and so forth,
9834  when the document is output to HTML.
9835  For articles, this should normally be
9836 \begin_inset Flex Code
9837 status collapsed
9838
9839 \begin_layout Plain Layout
9840 Section
9841 \end_layout
9842
9843 \end_inset
9844
9845 ; for books
9846 \begin_inset Flex Code
9847 status collapsed
9848
9849 \begin_layout Plain Layout
9850 Chapter
9851 \end_layout
9852
9853 \end_inset
9854
9855 .
9856  If it is not given, then \SpecialChar LyX
9857  will attempt to figure out which layout to use.
9858 \end_layout
9859
9860 \begin_layout Description
9861 \begin_inset Flex Code
9862 status collapsed
9863
9864 \begin_layout Plain Layout
9865 IfCounter
9866 \end_layout
9867
9868 \end_inset
9869
9870  [
9871 \begin_inset Flex Code
9872 status collapsed
9873
9874 \begin_layout Plain Layout
9875 <counter>
9876 \end_layout
9877
9878 \end_inset
9879
9880 ] Modifies the properties of the given counter.
9881  If the counter does not exist, the statement is ignored.
9882  Must end with
9883 \begin_inset Quotes eld
9884 \end_inset
9885
9886
9887 \begin_inset Flex Code
9888 status collapsed
9889
9890 \begin_layout Plain Layout
9891 End
9892 \end_layout
9893
9894 \end_inset
9895
9896
9897 \begin_inset Quotes erd
9898 \end_inset
9899
9900 .
9901 \begin_inset Newline newline
9902 \end_inset
9903
9904 See
9905 \begin_inset CommandInset ref
9906 LatexCommand ref
9907 reference "subsec:Counters"
9908
9909 \end_inset
9910
9911  for details on counters.
9912 \end_layout
9913
9914 \begin_layout Description
9915 \begin_inset Flex Code
9916 status collapsed
9917
9918 \begin_layout Plain Layout
9919 Input
9920 \end_layout
9921
9922 \end_inset
9923
9924  [
9925 \begin_inset Flex Code
9926 status collapsed
9927
9928 \begin_layout Plain Layout
9929 <filename>
9930 \end_layout
9931
9932 \end_inset
9933
9934 ] This allows you to include another layout definition file within yours
9935  to avoid duplicating commands.
9936  Common examples are the standard layout files, for example,
9937 \begin_inset Flex Code
9938 status collapsed
9939
9940 \begin_layout Plain Layout
9941 stdclass.inc
9942 \end_layout
9943
9944 \end_inset
9945
9946 , which contains most of the basic layouts.
9947 \end_layout
9948
9949 \begin_layout Description
9950 \begin_inset Flex Code
9951 status collapsed
9952
9953 \begin_layout Plain Layout
9954 InsetLayout
9955 \end_layout
9956
9957 \end_inset
9958
9959  [
9960 \begin_inset Flex Code
9961 status collapsed
9962
9963 \begin_layout Plain Layout
9964 <type>
9965 \end_layout
9966
9967 \end_inset
9968
9969 ] This section (re-)defines the layout of an inset.
9970  It can be applied to an existing inset or to a new, user-defined inset,
9971  e.g., a new character style.
9972  Must end with
9973 \begin_inset Quotes eld
9974 \end_inset
9975
9976
9977 \begin_inset Flex Code
9978 status collapsed
9979
9980 \begin_layout Plain Layout
9981 End
9982 \end_layout
9983
9984 \end_inset
9985
9986
9987 \begin_inset Quotes erd
9988 \end_inset
9989
9990 .
9991 \begin_inset Newline newline
9992 \end_inset
9993
9994 See
9995 \begin_inset CommandInset ref
9996 LatexCommand ref
9997 reference "subsec:Flex-insets-and"
9998
9999 \end_inset
10000
10001  for more information.
10002
10003 \end_layout
10004
10005 \begin_layout Description
10006 \begin_inset Flex Code
10007 status collapsed
10008
10009 \begin_layout Plain Layout
10010 LeftMargin
10011 \end_layout
10012
10013 \end_inset
10014
10015  [
10016 \begin_inset Flex Code
10017 status collapsed
10018
10019 \begin_layout Plain Layout
10020 string
10021 \end_layout
10022
10023 \end_inset
10024
10025 ] A string that indicates the width of the left margin on the screen, for
10026  example,
10027 \begin_inset Quotes eld
10028 \end_inset
10029
10030
10031 \begin_inset Flex Code
10032 status collapsed
10033
10034 \begin_layout Plain Layout
10035 MMMMM
10036 \end_layout
10037
10038 \end_inset
10039
10040
10041 \begin_inset Quotes erd
10042 \end_inset
10043
10044 .
10045  (Note that this is not a `length', like
10046 \begin_inset Quotes eld
10047 \end_inset
10048
10049 2ex
10050 \begin_inset Quotes erd
10051 \end_inset
10052
10053 .)
10054 \end_layout
10055
10056 \begin_layout Description
10057 \begin_inset Flex Code
10058 status collapsed
10059
10060 \begin_layout Plain Layout
10061 MaxCiteNames
10062 \end_layout
10063
10064 \end_inset
10065
10066  [
10067 \begin_inset Flex Code
10068 status collapsed
10069
10070 \begin_layout Plain Layout
10071 integer
10072 \end_layout
10073
10074 \end_inset
10075
10076 ] An integer that determines the maximal number of names displayed in an
10077  author-year citation before the citation switches to
10078 \begin_inset Quotes eld
10079 \end_inset
10080
10081 FirstAuthor et al.
10082 \begin_inset Quotes erd
10083 \end_inset
10084
10085 .
10086  Primarily used in cite engine files (see
10087 \begin_inset CommandInset ref
10088 LatexCommand ref
10089 reference "subsec:Cite-Engine-Files"
10090 plural "false"
10091 caps "false"
10092 noprefix "false"
10093
10094 \end_inset
10095
10096 ).
10097 \end_layout
10098
10099 \begin_layout Description
10100 \begin_inset Flex Code
10101 status collapsed
10102
10103 \begin_layout Plain Layout
10104 ModifyStyle
10105 \end_layout
10106
10107 \end_inset
10108
10109  [
10110 \begin_inset Flex Code
10111 status collapsed
10112
10113 \begin_layout Plain Layout
10114 <style>
10115 \end_layout
10116
10117 \end_inset
10118
10119 ] Modifies the properties of the given paragraph style.
10120  If the style does not exist, this section is ignored.
10121  Must end with
10122 \begin_inset Quotes eld
10123 \end_inset
10124
10125
10126 \begin_inset Flex Code
10127 status collapsed
10128
10129 \begin_layout Plain Layout
10130 End
10131 \end_layout
10132
10133 \end_inset
10134
10135
10136 \begin_inset Quotes erd
10137 \end_inset
10138
10139 .
10140 \end_layout
10141
10142 \begin_layout Description
10143 \begin_inset Flex Code
10144 status collapsed
10145
10146 \begin_layout Plain Layout
10147 NoCounter
10148 \end_layout
10149
10150 \end_inset
10151
10152  [
10153 \begin_inset Flex Code
10154 status collapsed
10155
10156 \begin_layout Plain Layout
10157 <counter>
10158 \end_layout
10159
10160 \end_inset
10161
10162 ] Deletes an existing counter, usually one defined in an included file.
10163 \end_layout
10164
10165 \begin_layout Description
10166 \begin_inset Flex Code
10167 status collapsed
10168
10169 \begin_layout Plain Layout
10170 NoFloat
10171 \end_layout
10172
10173 \end_inset
10174
10175  [
10176 \begin_inset Flex Code
10177 status collapsed
10178
10179 \begin_layout Plain Layout
10180 <float>
10181 \end_layout
10182
10183 \end_inset
10184
10185 ] Deletes an existing float.
10186  This is particularly useful when you want to suppress a float that has
10187  been defined in an input file.
10188 \end_layout
10189
10190 \begin_layout Description
10191 \begin_inset Flex Code
10192 status collapsed
10193
10194 \begin_layout Plain Layout
10195 NoStyle
10196 \end_layout
10197
10198 \end_inset
10199
10200  [
10201 \begin_inset Flex Code
10202 status collapsed
10203
10204 \begin_layout Plain Layout
10205 <style>
10206 \end_layout
10207
10208 \end_inset
10209
10210 ] Deletes an existing style.
10211 \end_layout
10212
10213 \begin_layout Description
10214 \begin_inset Flex Code
10215 status collapsed
10216
10217 \begin_layout Plain Layout
10218 OutlinerName
10219 \end_layout
10220
10221 \end_inset
10222
10223  [
10224 \begin_inset Flex Code
10225 status collapsed
10226
10227 \begin_layout Plain Layout
10228 <type>
10229 \end_layout
10230
10231 \end_inset
10232
10233 ] [
10234 \begin_inset Flex Code
10235 status collapsed
10236
10237 \begin_layout Plain Layout
10238 <string>
10239 \end_layout
10240
10241 \end_inset
10242
10243 ] Define a new table of contents with type
10244 \begin_inset Flex Code
10245 status collapsed
10246
10247 \begin_layout Plain Layout
10248 <type>
10249 \end_layout
10250
10251 \end_inset
10252
10253  and name
10254 \begin_inset Flex Code
10255 status collapsed
10256
10257 \begin_layout Plain Layout
10258 <string>
10259 \end_layout
10260
10261 \end_inset
10262
10263 .
10264  See also the AddToToc commands.
10265 \end_layout
10266
10267 \begin_layout Description
10268 \begin_inset Flex Code
10269 status collapsed
10270
10271 \begin_layout Plain Layout
10272 OutputFormat
10273 \end_layout
10274
10275 \end_inset
10276
10277  [
10278 \begin_inset Flex Code
10279 status collapsed
10280
10281 \begin_layout Plain Layout
10282 <format>
10283 \end_layout
10284
10285 \end_inset
10286
10287 ] The file format (as defined in the \SpecialChar LyX
10288  preferences) produced by this document
10289  class.
10290  It is mainly useful when
10291 \begin_inset Flex Code
10292 status collapsed
10293
10294 \begin_layout Plain Layout
10295 OutputType
10296 \end_layout
10297
10298 \end_inset
10299
10300  is
10301 \begin_inset Flex Code
10302 status collapsed
10303
10304 \begin_layout Plain Layout
10305 literate
10306 \end_layout
10307
10308 \end_inset
10309
10310  and one wants to define a new type of literate document.
10311  The format is reset to
10312 \begin_inset Quotes eld
10313 \end_inset
10314
10315
10316 \begin_inset Flex Code
10317 status collapsed
10318
10319 \begin_layout Plain Layout
10320 docbook
10321 \end_layout
10322
10323 \end_inset
10324
10325
10326 \begin_inset Quotes erd
10327 \end_inset
10328
10329  or
10330 \begin_inset Quotes eld
10331 \end_inset
10332
10333
10334 \begin_inset Flex Code
10335 status collapsed
10336
10337 \begin_layout Plain Layout
10338 latex
10339 \end_layout
10340
10341 \end_inset
10342
10343
10344 \begin_inset Quotes erd
10345 \end_inset
10346
10347  when the corresponding
10348 \begin_inset Flex Code
10349 status collapsed
10350
10351 \begin_layout Plain Layout
10352 OutputType
10353 \end_layout
10354
10355 \end_inset
10356
10357  parameter is encountered.
10358 \end_layout
10359
10360 \begin_layout Description
10361 \begin_inset Flex Code
10362 status collapsed
10363
10364 \begin_layout Plain Layout
10365 OutputType
10366 \end_layout
10367
10368 \end_inset
10369
10370  [
10371 \begin_inset Flex Code
10372 status collapsed
10373
10374 \begin_layout Plain Layout
10375
10376 \emph on
10377 lat
10378 \emph default
10379 ex
10380 \end_layout
10381
10382 \end_inset
10383
10384 ,
10385 \begin_inset Flex Code
10386 status collapsed
10387
10388 \begin_layout Plain Layout
10389 docbook
10390 \end_layout
10391
10392 \end_inset
10393
10394 ,
10395 \begin_inset Flex Code
10396 status collapsed
10397
10398 \begin_layout Plain Layout
10399 literate
10400 \end_layout
10401
10402 \end_inset
10403
10404 ] Specifies what sort of output documents using this class will produce.
10405 \end_layout
10406
10407 \begin_layout Description
10408 \begin_inset Flex Code
10409 status collapsed
10410
10411 \begin_layout Plain Layout
10412 PackageOptions
10413 \end_layout
10414
10415 \end_inset
10416
10417  [
10418 \begin_inset Flex Code
10419 status collapsed
10420
10421 \begin_layout Plain Layout
10422 string
10423 \end_layout
10424
10425 \end_inset
10426
10427
10428 \begin_inset Flex Code
10429 status collapsed
10430
10431 \begin_layout Plain Layout
10432 string
10433 \end_layout
10434
10435 \end_inset
10436
10437 ] Specifies options, given in the second string, for the package named by
10438  the first string.
10439  For example,
10440 \begin_inset Quotes eld
10441 \end_inset
10442
10443
10444 \begin_inset Flex Code
10445 status collapsed
10446
10447 \begin_layout Plain Layout
10448 PackageOptions natbib square
10449 \end_layout
10450
10451 \end_inset
10452
10453
10454 \begin_inset Quotes erd
10455 \end_inset
10456
10457  will cause
10458 \begin_inset Flex Code
10459 status collapsed
10460
10461 \begin_layout Plain Layout
10462 natbib
10463 \end_layout
10464
10465 \end_inset
10466
10467  to be loaded with the
10468 \begin_inset Flex Code
10469 status collapsed
10470
10471 \begin_layout Plain Layout
10472 square
10473 \end_layout
10474
10475 \end_inset
10476
10477  option.
10478  (For \SpecialChar TeX
10479 perts, this causes \SpecialChar LyX
10480  to output:
10481 \begin_inset Flex Code
10482 status collapsed
10483
10484 \begin_layout Plain Layout
10485
10486 \backslash
10487 PassOptionsToPackage{natbib}{square}
10488 \end_layout
10489
10490 \end_inset
10491
10492  prior to loading
10493 \begin_inset Flex Code
10494 status collapsed
10495
10496 \begin_layout Plain Layout
10497 natbib
10498 \end_layout
10499
10500 \end_inset
10501
10502 .)
10503 \end_layout
10504
10505 \begin_layout Description
10506 \begin_inset Flex Code
10507 status collapsed
10508
10509 \begin_layout Plain Layout
10510 PageStyle
10511 \end_layout
10512
10513 \end_inset
10514
10515  [
10516 \begin_inset Flex Code
10517 status collapsed
10518
10519 \begin_layout Plain Layout
10520
10521 \emph on
10522 plain
10523 \end_layout
10524
10525 \end_inset
10526
10527 ,
10528 \begin_inset Flex Code
10529 status collapsed
10530
10531 \begin_layout Plain Layout
10532 empty
10533 \end_layout
10534
10535 \end_inset
10536
10537 ,
10538 \begin_inset Flex Code
10539 status collapsed
10540
10541 \begin_layout Plain Layout
10542 headings
10543 \end_layout
10544
10545 \end_inset
10546
10547 ] The default pagestyle.
10548  Can be changed in the
10549 \begin_inset Flex Noun
10550 status collapsed
10551
10552 \begin_layout Plain Layout
10553 Document\SpecialChar menuseparator
10554 Settings
10555 \end_layout
10556
10557 \end_inset
10558
10559  dialog.
10560 \end_layout
10561
10562 \begin_layout Description
10563 \begin_inset Flex Code
10564 status collapsed
10565
10566 \begin_layout Plain Layout
10567 Preamble
10568 \end_layout
10569
10570 \end_inset
10571
10572  Sets the preamble for the \SpecialChar LaTeX
10573  document.
10574  Note that this will completely override any prior
10575 \begin_inset Flex Code
10576 status collapsed
10577
10578 \begin_layout Plain Layout
10579 Preamble
10580 \end_layout
10581
10582 \end_inset
10583
10584  or
10585 \begin_inset Flex Code
10586 status collapsed
10587
10588 \begin_layout Plain Layout
10589 AddToPreamble
10590 \end_layout
10591
10592 \end_inset
10593
10594  declarations.
10595  (Use
10596 \begin_inset Flex Code
10597 status collapsed
10598
10599 \begin_layout Plain Layout
10600 AddToPreamble
10601 \end_layout
10602
10603 \end_inset
10604
10605  if you just want to add material to the preamble.) Must end with
10606 \begin_inset Quotes eld
10607 \end_inset
10608
10609
10610 \begin_inset Flex Code
10611 status collapsed
10612
10613 \begin_layout Plain Layout
10614 EndPreamble
10615 \end_layout
10616
10617 \end_inset
10618
10619
10620 \begin_inset Quotes erd
10621 \end_inset
10622
10623 .
10624 \end_layout
10625
10626 \begin_layout Description
10627 \begin_inset Flex Code
10628 status collapsed
10629
10630 \begin_layout Plain Layout
10631 Provides
10632 \end_layout
10633
10634 \end_inset
10635
10636  [
10637 \begin_inset Flex Code
10638 status collapsed
10639
10640 \begin_layout Plain Layout
10641 string
10642 \end_layout
10643
10644 \end_inset
10645
10646 ] [
10647 \begin_inset Flex Code
10648 status collapsed
10649
10650 \begin_layout Plain Layout
10651
10652 \emph on
10653 0
10654 \end_layout
10655
10656 \end_inset
10657
10658 ,
10659 \begin_inset space \thinspace{}
10660 \end_inset
10661
10662
10663 \begin_inset Flex Code
10664 status collapsed
10665
10666 \begin_layout Plain Layout
10667 1
10668 \end_layout
10669
10670 \end_inset
10671
10672 ] Whether the class already provides the feature
10673 \begin_inset Flex Code
10674 status collapsed
10675
10676 \begin_layout Plain Layout
10677 string
10678 \end_layout
10679
10680 \end_inset
10681
10682 .
10683  A feature is in general the name of a package (e.
10684 \begin_inset space \thinspace{}
10685 \end_inset
10686
10687 g.
10688 \begin_inset space \space{}
10689 \end_inset
10690
10691
10692 \begin_inset Flex Code
10693 status collapsed
10694
10695 \begin_layout Plain Layout
10696 amsmath
10697 \end_layout
10698
10699 \end_inset
10700
10701  or
10702 \begin_inset Flex Code
10703 status collapsed
10704
10705 \begin_layout Plain Layout
10706 makeidx
10707 \end_layout
10708
10709 \end_inset
10710
10711 ) or a macro (e.
10712 \begin_inset space \thinspace{}
10713 \end_inset
10714
10715 g.
10716 \begin_inset space \space{}
10717 \end_inset
10718
10719
10720 \begin_inset Flex Code
10721 status collapsed
10722
10723 \begin_layout Plain Layout
10724 url
10725 \end_layout
10726
10727 \end_inset
10728
10729  or
10730 \begin_inset Flex Code
10731 status collapsed
10732
10733 \begin_layout Plain Layout
10734 boldsymbol
10735 \end_layout
10736
10737 \end_inset
10738
10739 ).
10740  See
10741 \begin_inset CommandInset ref
10742 LatexCommand ref
10743 reference "chap:List-of-functions"
10744
10745 \end_inset
10746
10747  for the list of features.
10748 \end_layout
10749
10750 \begin_layout Description
10751 \begin_inset Flex Code
10752 status collapsed
10753
10754 \begin_layout Plain Layout
10755 ProvidesModule
10756 \end_layout
10757
10758 \end_inset
10759
10760  [
10761 \begin_inset Flex Code
10762 status collapsed
10763
10764 \begin_layout Plain Layout
10765 string
10766 \end_layout
10767
10768 \end_inset
10769
10770 ] Indicates that this layout provides the functionality of the module mentioned,
10771  which should be specified by the filename without the
10772 \begin_inset Flex Code
10773 status collapsed
10774
10775 \begin_layout Plain Layout
10776 .module
10777 \end_layout
10778
10779 \end_inset
10780
10781  extension.
10782  This will typically be used if the layout includes the module directly,
10783  rather than using the
10784 \begin_inset Flex Code
10785 status collapsed
10786
10787 \begin_layout Plain Layout
10788 DefaultModule
10789 \end_layout
10790
10791 \end_inset
10792
10793  tag to indicate that it ought to be used.
10794  It could also be used in a module that provided an alternate implementation
10795  of the same functionality.
10796 \end_layout
10797
10798 \begin_layout Description
10799 \begin_inset Flex Code
10800 status collapsed
10801
10802 \begin_layout Plain Layout
10803 ProvideStyle
10804 \end_layout
10805
10806 \end_inset
10807
10808  [
10809 \begin_inset Flex Code
10810 status collapsed
10811
10812 \begin_layout Plain Layout
10813 <style>
10814 \end_layout
10815
10816 \end_inset
10817
10818 ] Creates a new paragraph style if it does not already exist.
10819  If the style does exist, this section is ignored.
10820  Must end with
10821 \begin_inset Quotes eld
10822 \end_inset
10823
10824
10825 \begin_inset Flex Code
10826 status collapsed
10827
10828 \begin_layout Plain Layout
10829 End
10830 \end_layout
10831
10832 \end_inset
10833
10834
10835 \begin_inset Quotes erd
10836 \end_inset
10837
10838 .
10839 \end_layout
10840
10841 \begin_layout Description
10842 \begin_inset Flex Code
10843 status collapsed
10844
10845 \begin_layout Plain Layout
10846 Requires
10847 \end_layout
10848
10849 \end_inset
10850
10851  [
10852 \begin_inset Flex Code
10853 status collapsed
10854
10855 \begin_layout Plain Layout
10856 string
10857 \end_layout
10858
10859 \end_inset
10860
10861 ] Whether the class requires the feature
10862 \begin_inset Flex Code
10863 status collapsed
10864
10865 \begin_layout Plain Layout
10866 string
10867 \end_layout
10868
10869 \end_inset
10870
10871 .
10872  Multiple features must be separated by commas.
10873  Note that you can only request supported features.
10874  (See
10875 \begin_inset CommandInset ref
10876 LatexCommand ref
10877 reference "chap:List-of-functions"
10878
10879 \end_inset
10880
10881  for the list of features.).
10882  If you require a package with specific options, you can additionally use
10883
10884 \begin_inset Flex Code
10885 status collapsed
10886
10887 \begin_layout Plain Layout
10888 PackageOptions
10889 \end_layout
10890
10891 \end_inset
10892
10893 .
10894 \end_layout
10895
10896 \begin_layout Description
10897 \begin_inset Flex Code
10898 status collapsed
10899
10900 \begin_layout Plain Layout
10901 RightMargin
10902 \end_layout
10903
10904 \end_inset
10905
10906  [
10907 \begin_inset Flex Code
10908 status collapsed
10909
10910 \begin_layout Plain Layout
10911 string
10912 \end_layout
10913
10914 \end_inset
10915
10916 ] A string that indicates the width of the right margin on the screen, for
10917  example,
10918 \begin_inset Quotes eld
10919 \end_inset
10920
10921
10922 \begin_inset Flex Code
10923 status collapsed
10924
10925 \begin_layout Plain Layout
10926 MMMMM
10927 \end_layout
10928
10929 \end_inset
10930
10931
10932 \begin_inset Quotes erd
10933 \end_inset
10934
10935 .
10936 \end_layout
10937
10938 \begin_layout Description
10939 \begin_inset Flex Code
10940 status collapsed
10941
10942 \begin_layout Plain Layout
10943 SecNumDepth
10944 \end_layout
10945
10946 \end_inset
10947
10948  [
10949 \begin_inset Flex Code
10950 status collapsed
10951
10952 \begin_layout Plain Layout
10953 int=3
10954 \end_layout
10955
10956 \end_inset
10957
10958 ] Sets which divisions get numbered.
10959  Corresponds to the
10960 \begin_inset Newline newline
10961 \end_inset
10962
10963
10964 \begin_inset Flex Code
10965 status collapsed
10966
10967 \begin_layout Plain Layout
10968 secnumdepth
10969 \end_layout
10970
10971 \end_inset
10972
10973  counter in \SpecialChar LaTeX
10974 .
10975 \end_layout
10976
10977 \begin_layout Description
10978 \begin_inset Flex Code
10979 status collapsed
10980
10981 \begin_layout Plain Layout
10982 Sides
10983 \end_layout
10984
10985 \end_inset
10986
10987  [
10988 \begin_inset Flex Code
10989 status collapsed
10990
10991 \begin_layout Plain Layout
10992
10993 \emph on
10994 1
10995 \end_layout
10996
10997 \end_inset
10998
10999 ,
11000 \begin_inset space \thinspace{}
11001 \end_inset
11002
11003
11004 \begin_inset Flex Code
11005 status collapsed
11006
11007 \begin_layout Plain Layout
11008 2
11009 \end_layout
11010
11011 \end_inset
11012
11013 ] Whether the class-default should be printing on one or both sides of the
11014  paper.
11015  Can be changed in the
11016 \begin_inset Flex Noun
11017 status collapsed
11018
11019 \begin_layout Plain Layout
11020 Document\SpecialChar menuseparator
11021 Settings
11022 \end_layout
11023
11024 \end_inset
11025
11026  dialog.
11027 \end_layout
11028
11029 \begin_layout Description
11030 \begin_inset Flex Code
11031 status collapsed
11032
11033 \begin_layout Plain Layout
11034 Style
11035 \end_layout
11036
11037 \end_inset
11038
11039  [
11040 \begin_inset Flex Code
11041 status collapsed
11042
11043 \begin_layout Plain Layout
11044 <name>
11045 \end_layout
11046
11047 \end_inset
11048
11049 ] This sequence defines a paragraph style.
11050  If the style does not yet exist, it is created; if it does exist, its parameter
11051 s are modified.
11052  Must end with
11053 \begin_inset Quotes eld
11054 \end_inset
11055
11056
11057 \begin_inset Flex Code
11058 status collapsed
11059
11060 \begin_layout Plain Layout
11061 End
11062 \end_layout
11063
11064 \end_inset
11065
11066
11067 \begin_inset Quotes erd
11068 \end_inset
11069
11070 .
11071 \begin_inset Newline newline
11072 \end_inset
11073
11074 See
11075 \begin_inset CommandInset ref
11076 LatexCommand ref
11077 reference "subsec:Paragraph-Styles"
11078
11079 \end_inset
11080
11081  for details on paragraph styles.
11082 \change_inserted -712698321 1553617804
11083
11084 \end_layout
11085
11086 \begin_layout Description
11087
11088 \change_inserted -712698321 1553617862
11089 \begin_inset Flex Code
11090 status collapsed
11091
11092 \begin_layout Plain Layout
11093
11094 \change_inserted -712698321 1553617809
11095 TableStyle
11096 \end_layout
11097
11098 \end_inset
11099
11100  [
11101 \begin_inset Flex Code
11102 status collapsed
11103
11104 \begin_layout Plain Layout
11105
11106 \change_inserted -712698321 1553617805
11107 <name>
11108 \end_layout
11109
11110 \end_inset
11111
11112 ] defines the default table style that is used when inserting a table.
11113  The following styles are available:
11114 \end_layout
11115
11116 \begin_deeper
11117 \begin_layout Itemize
11118
11119 \change_inserted -712698321 1554308039
11120 \begin_inset Flex Code
11121 status collapsed
11122
11123 \begin_layout Plain Layout
11124
11125 \change_inserted -712698321 1554307928
11126 Formal_with_Footline
11127 \change_unchanged
11128
11129 \end_layout
11130
11131 \end_inset
11132
11133 : formal (
11134 \begin_inset Quotes eld
11135 \end_inset
11136
11137 booktabs
11138 \begin_inset Quotes erd
11139 \end_inset
11140
11141 ) style with horizontal lines only, using a bold top and bottom line, the
11142  first and last row are additionally separated from the table body with
11143  a thin middle line.
11144 \end_layout
11145
11146 \begin_layout Itemize
11147
11148 \change_inserted -712698321 1554308087
11149 \begin_inset Flex Code
11150 status collapsed
11151
11152 \begin_layout Plain Layout
11153
11154 \change_inserted -712698321 1554308042
11155 Formal_without_Footline
11156 \end_layout
11157
11158 \end_inset
11159
11160 : same as the above, but the last row is not separated with a middle line
11161  from the body.
11162 \end_layout
11163
11164 \begin_layout Itemize
11165
11166 \change_inserted -712698321 1553618031
11167 \begin_inset Flex Code
11168 status collapsed
11169
11170 \begin_layout Plain Layout
11171
11172 \change_inserted -712698321 1553618006
11173 Simple_Grid
11174 \end_layout
11175
11176 \end_inset
11177
11178 : Simple table lines.
11179 \end_layout
11180
11181 \begin_layout Itemize
11182
11183 \change_inserted -712698321 1553618309
11184 \begin_inset Flex Code
11185 status collapsed
11186
11187 \begin_layout Plain Layout
11188
11189 \change_inserted -712698321 1553618031
11190 Grid_with_Head
11191 \end_layout
11192
11193 \end_inset
11194
11195 : Like
11196 \begin_inset Flex Code
11197 status collapsed
11198
11199 \begin_layout Plain Layout
11200
11201 \change_inserted -712698321 1553618043
11202 Simple_Grid
11203 \end_layout
11204
11205 \end_inset
11206
11207 , but with the header column offset with a second horizontal line.
11208  This is also the default style of \SpecialChar LyX
11209 .
11210 \end_layout
11211
11212 \begin_layout Itemize
11213
11214 \change_inserted -712698321 1553618280
11215 \begin_inset Flex Code
11216 status collapsed
11217
11218 \begin_layout Plain Layout
11219
11220 \change_inserted -712698321 1553618261
11221 No_Borders
11222 \end_layout
11223
11224 \end_inset
11225
11226 : Table without lines.
11227 \change_unchanged
11228
11229 \end_layout
11230
11231 \end_deeper
11232 \begin_layout Description
11233 \begin_inset Flex Code
11234 status collapsed
11235
11236 \begin_layout Plain Layout
11237 TitleLatexName
11238 \end_layout
11239
11240 \end_inset
11241
11242  [
11243 \begin_inset Flex Code
11244 status collapsed
11245
11246 \begin_layout Plain Layout
11247 string="maketitle"
11248 \end_layout
11249
11250 \end_inset
11251
11252 ] The name of the command or environment to be used with
11253 \begin_inset Flex Code
11254 status collapsed
11255
11256 \begin_layout Plain Layout
11257 TitleLatexType
11258 \end_layout
11259
11260 \end_inset
11261
11262 .
11263 \end_layout
11264
11265 \begin_layout Description
11266 \begin_inset Flex Code
11267 status collapsed
11268
11269 \begin_layout Plain Layout
11270 TitleLatexType
11271 \end_layout
11272
11273 \end_inset
11274
11275  [
11276 \begin_inset Flex Code
11277 status collapsed
11278
11279 \begin_layout Plain Layout
11280
11281 \emph on
11282 CommandAfter
11283 \end_layout
11284
11285 \end_inset
11286
11287 ,
11288 \begin_inset Flex Code
11289 status collapsed
11290
11291 \begin_layout Plain Layout
11292 Environment
11293 \end_layout
11294
11295 \end_inset
11296
11297 ] Indicates what kind of markup is used to define the title of a document.
11298
11299 \begin_inset Flex Code
11300 status collapsed
11301
11302 \begin_layout Plain Layout
11303 CommandAfter
11304 \end_layout
11305
11306 \end_inset
11307
11308  means that the macro with name
11309 \begin_inset Flex Code
11310 status collapsed
11311
11312 \begin_layout Plain Layout
11313 TitleLatexName
11314 \end_layout
11315
11316 \end_inset
11317
11318  will be inserted after the last layout which has
11319 \begin_inset Quotes eld
11320 \end_inset
11321
11322
11323 \begin_inset Flex Code
11324 status collapsed
11325
11326 \begin_layout Plain Layout
11327 InTitle
11328 \begin_inset space ~
11329 \end_inset
11330
11331 1
11332 \end_layout
11333
11334 \end_inset
11335
11336
11337 \begin_inset Quotes erd
11338 \end_inset
11339
11340 .
11341
11342 \begin_inset Flex Code
11343 status collapsed
11344
11345 \begin_layout Plain Layout
11346 Environment
11347 \end_layout
11348
11349 \end_inset
11350
11351  corresponds to the case where all layouts which have
11352 \begin_inset Quotes eld
11353 \end_inset
11354
11355
11356 \begin_inset Flex Code
11357 status collapsed
11358
11359 \begin_layout Plain Layout
11360 InTitle
11361 \begin_inset space ~
11362 \end_inset
11363
11364 1
11365 \end_layout
11366
11367 \end_inset
11368
11369
11370 \begin_inset Quotes erd
11371 \end_inset
11372
11373  should be enclosed into the
11374 \begin_inset Flex Code
11375 status collapsed
11376
11377 \begin_layout Plain Layout
11378 TitleLatexName
11379 \end_layout
11380
11381 \end_inset
11382
11383  environment.
11384 \end_layout
11385
11386 \begin_layout Description
11387 \begin_inset Flex Code
11388 status collapsed
11389
11390 \begin_layout Plain Layout
11391 TocDepth
11392 \end_layout
11393
11394 \end_inset
11395
11396  [
11397 \begin_inset Flex Code
11398 status collapsed
11399
11400 \begin_layout Plain Layout
11401 int=3
11402 \end_layout
11403
11404 \end_inset
11405
11406 ] Sets which divisions are included in the table of contents.
11407  Corresponds to the
11408 \begin_inset Flex Code
11409 status collapsed
11410
11411 \begin_layout Plain Layout
11412 tocdepth
11413 \end_layout
11414
11415 \end_inset
11416
11417  counter in \SpecialChar LaTeX
11418 .
11419 \end_layout
11420
11421 \begin_layout Subsection
11422 \begin_inset Flex Code
11423 status collapsed
11424
11425 \begin_layout Plain Layout
11426 ClassOptions
11427 \end_layout
11428
11429 \end_inset
11430
11431  section
11432 \begin_inset CommandInset label
11433 LatexCommand label
11434 name "subsec:ClassOptions"
11435
11436 \end_inset
11437
11438
11439 \end_layout
11440
11441 \begin_layout Standard
11442 The
11443 \begin_inset Flex Code
11444 status collapsed
11445
11446 \begin_layout Plain Layout
11447 ClassOptions
11448 \end_layout
11449
11450 \end_inset
11451
11452  section can contain the following entries:
11453 \end_layout
11454
11455 \begin_layout Description
11456 \begin_inset Flex Code
11457 status collapsed
11458
11459 \begin_layout Plain Layout
11460 FontSize
11461 \end_layout
11462
11463 \end_inset
11464
11465  [
11466 \begin_inset Flex Code
11467 status collapsed
11468
11469 \begin_layout Plain Layout
11470 string="10|11|12"
11471 \end_layout
11472
11473 \end_inset
11474
11475 ] The list of available font sizes for the document's main font, separated
11476  by
11477 \begin_inset Quotes eld
11478 \end_inset
11479
11480
11481 \begin_inset Flex Code
11482 status collapsed
11483
11484 \begin_layout Plain Layout
11485 |
11486 \end_layout
11487
11488 \end_inset
11489
11490
11491 \begin_inset Quotes erd
11492 \end_inset
11493
11494 .
11495 \end_layout
11496
11497 \begin_layout Description
11498 \begin_inset Flex Code
11499 status collapsed
11500
11501 \begin_layout Plain Layout
11502 Header
11503 \end_layout
11504
11505 \end_inset
11506
11507  Used to set the DTD line with XML-based output classes.
11508  E.
11509 \begin_inset space \thinspace{}
11510 \end_inset
11511
11512 g.: PUBLIC
11513 \begin_inset Quotes eld
11514 \end_inset
11515
11516 -//OASIS//DTD DocBook V4.2//EN
11517 \begin_inset Quotes erd
11518 \end_inset
11519
11520 .
11521 \end_layout
11522
11523 \begin_layout Description
11524 \begin_inset Flex Code
11525 status collapsed
11526
11527 \begin_layout Plain Layout
11528 PageStyle
11529 \end_layout
11530
11531 \end_inset
11532
11533  [
11534 \begin_inset Flex Code
11535 status collapsed
11536
11537 \begin_layout Plain Layout
11538 string="empty|plain|headings|fancy"
11539 \end_layout
11540
11541 \end_inset
11542
11543 ] The list of available page sty\SpecialChar softhyphen
11544 les, separated by
11545 \begin_inset Quotes eld
11546 \end_inset
11547
11548
11549 \begin_inset Flex Code
11550 status collapsed
11551
11552 \begin_layout Plain Layout
11553 |
11554 \end_layout
11555
11556 \end_inset
11557
11558
11559 \begin_inset Quotes erd
11560 \end_inset
11561
11562 .
11563 \end_layout
11564
11565 \begin_layout Description
11566 \begin_inset Flex Code
11567 status collapsed
11568
11569 \begin_layout Plain Layout
11570 Other
11571 \end_layout
11572
11573 \end_inset
11574
11575  [
11576 \begin_inset Flex Code
11577 status collapsed
11578
11579 \begin_layout Plain Layout
11580 string=""
11581 \end_layout
11582
11583 \end_inset
11584
11585 ] Some document class options, separated by a comma, that will be added
11586  to the optional part of the
11587 \begin_inset Flex Code
11588 status collapsed
11589
11590 \begin_layout Plain Layout
11591
11592 \backslash
11593 documentclass
11594 \end_layout
11595
11596 \end_inset
11597
11598  command.
11599 \end_layout
11600
11601 \begin_layout Standard
11602 The
11603 \begin_inset Flex Code
11604 status collapsed
11605
11606 \begin_layout Plain Layout
11607 ClassOptions
11608 \end_layout
11609
11610 \end_inset
11611
11612  section must end with
11613 \begin_inset Quotes eld
11614 \end_inset
11615
11616
11617 \begin_inset Flex Code
11618 status collapsed
11619
11620 \begin_layout Plain Layout
11621 End
11622 \end_layout
11623
11624 \end_inset
11625
11626
11627 \begin_inset Quotes erd
11628 \end_inset
11629
11630 .
11631 \end_layout
11632
11633 \begin_layout Subsection
11634 Paragraph styles
11635 \begin_inset CommandInset label
11636 LatexCommand label
11637 name "subsec:Paragraph-Styles"
11638
11639 \end_inset
11640
11641
11642 \end_layout
11643
11644 \begin_layout Standard
11645 A paragraph style description looks like this:
11646 \begin_inset Foot
11647 status collapsed
11648
11649 \begin_layout Plain Layout
11650 Note that this will either define a new style or modify an existing one.
11651 \end_layout
11652
11653 \end_inset
11654
11655
11656 \end_layout
11657
11658 \begin_layout LyX-Code
11659 Style
11660 \family roman
11661 \emph on
11662 name
11663 \end_layout
11664
11665 \begin_layout LyX-Code
11666  ...
11667 \end_layout
11668
11669 \begin_layout LyX-Code
11670 End
11671 \end_layout
11672
11673 \begin_layout Standard
11674 where the following commands are allowed:
11675 \end_layout
11676
11677 \begin_layout Description
11678 \begin_inset Flex Code
11679 status collapsed
11680
11681 \begin_layout Plain Layout
11682 AddToToc
11683 \end_layout
11684
11685 \end_inset
11686
11687  [
11688 \begin_inset Flex Code
11689 status collapsed
11690
11691 \begin_layout Plain Layout
11692 string
11693 \end_layout
11694
11695 \end_inset
11696
11697 =""] This paragraph will appear in the table of contents of the given type.
11698  An empty string disables.
11699  See also the OutlinerName and the IsTocCaption commands.
11700  Default: disabled.
11701 \end_layout
11702
11703 \begin_layout Description
11704 \begin_inset Flex Code
11705 status collapsed
11706
11707 \begin_layout Plain Layout
11708 Align
11709 \end_layout
11710
11711 \end_inset
11712
11713  [
11714 \begin_inset Flex Code
11715 status collapsed
11716
11717 \begin_layout Plain Layout
11718
11719 \emph on
11720 block
11721 \emph default
11722 , left, right, center
11723 \end_layout
11724
11725 \end_inset
11726
11727 ] Paragraph alignment.
11728 \end_layout
11729
11730 \begin_layout Description
11731 \begin_inset Flex Code
11732 status collapsed
11733
11734 \begin_layout Plain Layout
11735 AlignPossible
11736 \end_layout
11737
11738 \end_inset
11739
11740  [
11741 \begin_inset Flex Code
11742 status collapsed
11743
11744 \begin_layout Plain Layout
11745
11746 \emph on
11747 block
11748 \emph default
11749 , left, right, center
11750 \end_layout
11751
11752 \end_inset
11753
11754 ] A comma separated list of permitted alignments.
11755  (Some \SpecialChar LaTeX
11756  styles prohibit certain alignments, since those wouldn't make sense.
11757  For example a right-aligned or centered enumeration isn't possible.)
11758 \end_layout
11759
11760 \begin_layout Description
11761 \begin_inset Flex Code
11762 status collapsed
11763
11764 \begin_layout Plain Layout
11765 Argument
11766 \end_layout
11767
11768 \end_inset
11769
11770  [
11771 \begin_inset Flex Code
11772 status collapsed
11773
11774 \begin_layout Plain Layout
11775 int
11776 \end_layout
11777
11778 \end_inset
11779
11780 ] Defines argument number <int> of a command\SpecialChar breakableslash
11781 environment associated with
11782  the current style.
11783  This is useful for things like section headings, and only makes sense with
11784  \SpecialChar LaTeX
11785 .
11786  Every (optional or required) argument of a command or environment – except
11787  for the required argument that is associated with the content of the paragraph
11788  itself – has a separate definition, where the number specifies the order
11789  of the arguments.
11790  The definition must end with
11791 \begin_inset Flex Code
11792 status collapsed
11793
11794 \begin_layout Plain Layout
11795 EndArgument
11796 \end_layout
11797
11798 \end_inset
11799
11800 .
11801  So a command with two optional arguments has:
11802 \end_layout
11803
11804 \begin_deeper
11805 \begin_layout Quote
11806
11807 \family typewriter
11808 Argument 1
11809 \end_layout
11810
11811 \begin_layout Quote
11812
11813 \family typewriter
11814 ...
11815 \end_layout
11816
11817 \begin_layout Quote
11818
11819 \family typewriter
11820 EndArgument
11821 \end_layout
11822
11823 \begin_layout Quote
11824
11825 \family typewriter
11826 Argument 2
11827 \end_layout
11828
11829 \begin_layout Quote
11830
11831 \family typewriter
11832 ...
11833 \end_layout
11834
11835 \begin_layout Quote
11836
11837 \family typewriter
11838 EndArgument
11839 \end_layout
11840
11841 \begin_layout Standard
11842 Inside the
11843 \begin_inset Flex Code
11844 status collapsed
11845
11846 \begin_layout Plain Layout
11847 Argument
11848 \end_layout
11849
11850 \end_inset
11851
11852  definition, the following specifications are possible:
11853 \end_layout
11854
11855 \begin_layout Itemize
11856 \begin_inset Flex Code
11857 status collapsed
11858
11859 \begin_layout Plain Layout
11860 LabelString
11861 \end_layout
11862
11863 \end_inset
11864
11865
11866 \begin_inset Flex Code
11867 status collapsed
11868
11869 \begin_layout Plain Layout
11870 [string]
11871 \end_layout
11872
11873 \end_inset
11874
11875  The string that will appear both in the menu (to insert this argument)
11876  and on the argument inset button (unless you also specify a separate
11877 \begin_inset Flex Code
11878 status collapsed
11879
11880 \begin_layout Plain Layout
11881 MenuString
11882 \end_layout
11883
11884 \end_inset
11885
11886 ).
11887  For the menu, you can define an accelerator by appending the respective
11888  character to the string, divided by
11889 \begin_inset Quotes eld
11890 \end_inset
11891
11892 |
11893 \begin_inset Quotes erd
11894 \end_inset
11895
11896  (e.
11897 \begin_inset space \thinspace{}
11898 \end_inset
11899
11900 g.
11901 \begin_inset space \space{}
11902 \end_inset
11903
11904
11905 \begin_inset Quotes eld
11906 \end_inset
11907
11908
11909 \begin_inset Flex Code
11910 status collapsed
11911
11912 \begin_layout Plain Layout
11913 Short Title|S
11914 \end_layout
11915
11916 \end_inset
11917
11918
11919 \begin_inset Quotes erd
11920 \end_inset
11921
11922 ).
11923 \end_layout
11924
11925 \begin_layout Itemize
11926 \begin_inset Flex Code
11927 status collapsed
11928
11929 \begin_layout Plain Layout
11930 MenuString
11931 \end_layout
11932
11933 \end_inset
11934
11935
11936 \begin_inset Flex Code
11937 status collapsed
11938
11939 \begin_layout Plain Layout
11940 [string]
11941 \end_layout
11942
11943 \end_inset
11944
11945  A separate string for the menu.
11946  You can define an accelerator by appending the respective character to
11947  the string, divided by
11948 \begin_inset Quotes eld
11949 \end_inset
11950
11951 |
11952 \begin_inset Quotes erd
11953 \end_inset
11954
11955  (e.
11956 \begin_inset space \thinspace{}
11957 \end_inset
11958
11959 g.
11960 \begin_inset space \space{}
11961 \end_inset
11962
11963
11964 \begin_inset Quotes eld
11965 \end_inset
11966
11967
11968 \begin_inset Flex Code
11969 status collapsed
11970
11971 \begin_layout Plain Layout
11972 Short Title|S
11973 \end_layout
11974
11975 \end_inset
11976
11977
11978 \begin_inset Quotes erd
11979 \end_inset
11980
11981 ).
11982  This specification is optional.
11983  If it is not given the
11984 \begin_inset Flex Code
11985 status collapsed
11986
11987 \begin_layout Plain Layout
11988 LabelString
11989 \end_layout
11990
11991 \end_inset
11992
11993  will be used instead for the menu.
11994 \end_layout
11995
11996 \begin_layout Itemize
11997 \begin_inset Flex Code
11998 status collapsed
11999
12000 \begin_layout Plain Layout
12001 Tooltip
12002 \end_layout
12003
12004 \end_inset
12005
12006
12007 \begin_inset Flex Code
12008 status collapsed
12009
12010 \begin_layout Plain Layout
12011 [string]
12012 \end_layout
12013
12014 \end_inset
12015
12016  A longer explanatory text that appears in the tooltip when hovering over
12017  the argument inset.
12018 \end_layout
12019
12020 \begin_layout Itemize
12021 \begin_inset Flex Code
12022 status collapsed
12023
12024 \begin_layout Plain Layout
12025 Mandatory
12026 \end_layout
12027
12028 \end_inset
12029
12030  [
12031 \begin_inset Flex Code
12032 status collapsed
12033
12034 \begin_layout Plain Layout
12035
12036 \emph on
12037 0
12038 \end_layout
12039
12040 \end_inset
12041
12042 ,
12043 \begin_inset space \thinspace{}
12044 \end_inset
12045
12046
12047 \begin_inset Flex Code
12048 status collapsed
12049
12050 \begin_layout Plain Layout
12051 1
12052 \end_layout
12053
12054 \end_inset
12055
12056 ] Declare if this is a mandatory (1) or an optional (0) argument.
12057  Mandatory arguments will be output empty if not given, while optional arguments
12058  will not be output at all.
12059  By default, mandatory arguments are delimited by
12060 \begin_inset Flex Code
12061 status collapsed
12062
12063 \begin_layout Plain Layout
12064 {...}
12065 \end_layout
12066
12067 \end_inset
12068
12069 , while optional arguments are delimited by
12070 \begin_inset Flex Code
12071 status collapsed
12072
12073 \begin_layout Plain Layout
12074 [...]
12075 \end_layout
12076
12077 \end_inset
12078
12079
12080 \change_inserted -712698321 1555579782
12081
12082 \end_layout
12083
12084 \begin_layout Itemize
12085
12086 \change_inserted -712698321 1555579780
12087 \begin_inset Flex Code
12088 status collapsed
12089
12090 \begin_layout Plain Layout
12091
12092 \change_inserted -712698321 1555579780
12093 NewlineCmd
12094 \end_layout
12095
12096 \end_inset
12097
12098
12099 \begin_inset Flex Code
12100 status collapsed
12101
12102 \begin_layout Plain Layout
12103
12104 \change_inserted -712698321 1555579780
12105 [string]
12106 \end_layout
12107
12108 \end_inset
12109
12110  Option to define a different command (from the default
12111 \begin_inset Flex Code
12112 status collapsed
12113
12114 \begin_layout Plain Layout
12115
12116 \change_inserted -712698321 1555579780
12117
12118 \backslash
12119
12120 \backslash
12121
12122 \end_layout
12123
12124 \end_inset
12125
12126 ) to be used for line breaks.
12127  The initial backslash must not be specified.
12128 \change_unchanged
12129
12130 \end_layout
12131
12132 \begin_layout Itemize
12133 \begin_inset Flex Code
12134 status collapsed
12135
12136 \begin_layout Plain Layout
12137 Requires
12138 \end_layout
12139
12140 \end_inset
12141
12142
12143 \begin_inset Flex Code
12144 status collapsed
12145
12146 \begin_layout Plain Layout
12147 [int=0]
12148 \end_layout
12149
12150 \end_inset
12151
12152  defines another argument (by its number) which this argument requires to
12153  be output if it is itself output.
12154  E.
12155 \begin_inset space \thinspace{}
12156 \end_inset
12157
12158 g., in \SpecialChar LaTeX
12159  commands, optional arguments often require previous optional arguments
12160  to be output (at least empty), as in
12161 \begin_inset Flex Code
12162 status collapsed
12163
12164 \begin_layout Plain Layout
12165
12166 \backslash
12167 command[][argument]{text}
12168 \end_layout
12169
12170 \end_inset
12171
12172 .
12173  This can be achieved by the statement
12174 \begin_inset Flex Code
12175 status collapsed
12176
12177 \begin_layout Plain Layout
12178 Requires 1
12179 \end_layout
12180
12181 \end_inset
12182
12183  within
12184 \begin_inset Flex Code
12185 status collapsed
12186
12187 \begin_layout Plain Layout
12188 Argument 2
12189 \end_layout
12190
12191 \end_inset
12192
12193 .
12194 \end_layout
12195
12196 \begin_layout Itemize
12197 \begin_inset Flex Code
12198 status collapsed
12199
12200 \begin_layout Plain Layout
12201 LeftDelim
12202 \end_layout
12203
12204 \end_inset
12205
12206
12207 \begin_inset Flex Code
12208 status collapsed
12209
12210 \begin_layout Plain Layout
12211 [string]
12212 \end_layout
12213
12214 \end_inset
12215
12216  defines a custom left delimiter (instead of
12217 \begin_inset Flex Code
12218 status collapsed
12219
12220 \begin_layout Plain Layout
12221 {
12222 \end_layout
12223
12224 \end_inset
12225
12226  or
12227 \begin_inset Flex Code
12228 status collapsed
12229
12230 \begin_layout Plain Layout
12231 [
12232 \end_layout
12233
12234 \end_inset
12235
12236 ).
12237  A line break in the output can be indicated by
12238 \begin_inset Flex Code
12239 status collapsed
12240
12241 \begin_layout Plain Layout
12242 <br/>
12243 \end_layout
12244
12245 \end_inset
12246
12247 .
12248 \end_layout
12249
12250 \begin_layout Itemize
12251 \begin_inset Flex Code
12252 status collapsed
12253
12254 \begin_layout Plain Layout
12255 RightDelim
12256 \end_layout
12257
12258 \end_inset
12259
12260
12261 \begin_inset Flex Code
12262 status collapsed
12263
12264 \begin_layout Plain Layout
12265 [string]
12266 \end_layout
12267
12268 \end_inset
12269
12270  defines a custom right delimiter (instead of
12271 \begin_inset Flex Code
12272 status collapsed
12273
12274 \begin_layout Plain Layout
12275 }
12276 \end_layout
12277
12278 \end_inset
12279
12280  or
12281 \begin_inset Flex Code
12282 status collapsed
12283
12284 \begin_layout Plain Layout
12285 ]
12286 \end_layout
12287
12288 \end_inset
12289
12290 ).
12291  A line break in the output can be indicated by
12292 \begin_inset Flex Code
12293 status collapsed
12294
12295 \begin_layout Plain Layout
12296 <br/>
12297 \end_layout
12298
12299 \end_inset
12300
12301 .
12302 \end_layout
12303
12304 \begin_layout Itemize
12305 \begin_inset Flex Code
12306 status collapsed
12307
12308 \begin_layout Plain Layout
12309 DefaultArg
12310 \end_layout
12311
12312 \end_inset
12313
12314
12315 \begin_inset Flex Code
12316 status collapsed
12317
12318 \begin_layout Plain Layout
12319 [string]
12320 \end_layout
12321
12322 \end_inset
12323
12324  defines an argument that is inserted if and only if no user-specified arguments
12325  were given, i.
12326 \begin_inset space \thinspace{}
12327 \end_inset
12328
12329 e.
12330 \begin_inset space \space{}
12331 \end_inset
12332
12333 if no argument inset has been inserted (note that also an empty argument
12334  inset omits the DefaultArg).
12335  Multiple arguments need to be separated by comma.
12336 \end_layout
12337
12338 \begin_layout Itemize
12339 \begin_inset Flex Code
12340 status collapsed
12341
12342 \begin_layout Plain Layout
12343 PresetArg
12344 \end_layout
12345
12346 \end_inset
12347
12348
12349 \begin_inset Flex Code
12350 status collapsed
12351
12352 \begin_layout Plain Layout
12353 [string]
12354 \end_layout
12355
12356 \end_inset
12357
12358  defines an argument that is inserted in any case (alone or in addition
12359  to user-specified arguments).
12360  Multiple arguments need to be separated by comma.
12361 \end_layout
12362
12363 \begin_layout Itemize
12364 \begin_inset Flex Code
12365 status collapsed
12366
12367 \begin_layout Plain Layout
12368 Font
12369 \end_layout
12370
12371 \end_inset
12372
12373  The font used for the argument content, see
12374 \begin_inset CommandInset ref
12375 LatexCommand ref
12376 reference "subsec:Font-description"
12377
12378 \end_inset
12379
12380 .
12381 \change_inserted -712698321 1559484228
12382
12383 \end_layout
12384
12385 \begin_layout Itemize
12386
12387 \change_inserted -712698321 1559484228
12388 \begin_inset Flex Code
12389 status collapsed
12390
12391 \begin_layout Plain Layout
12392
12393 \change_inserted -712698321 1559484228
12394 FreeSpacing
12395 \end_layout
12396
12397 \end_inset
12398
12399  [
12400 \begin_inset Flex Code
12401 status collapsed
12402
12403 \begin_layout Plain Layout
12404
12405 \change_inserted -712698321 1559484228
12406
12407 \emph on
12408 0
12409 \end_layout
12410
12411 \end_inset
12412
12413 ,
12414 \begin_inset space \thinspace{}
12415 \end_inset
12416
12417
12418 \begin_inset Flex Code
12419 status collapsed
12420
12421 \begin_layout Plain Layout
12422
12423 \change_inserted -712698321 1559484228
12424 1
12425 \end_layout
12426
12427 \end_inset
12428
12429 ] As with paragraph styles, see
12430 \begin_inset CommandInset ref
12431 LatexCommand ref
12432 reference "subsec:Paragraph-Styles"
12433
12434 \end_inset
12435
12436 .
12437 \change_unchanged
12438
12439 \end_layout
12440
12441 \begin_layout Itemize
12442 \begin_inset Flex Code
12443 status collapsed
12444
12445 \begin_layout Plain Layout
12446 LabelFont
12447 \end_layout
12448
12449 \end_inset
12450
12451  The font used for the label; see
12452 \begin_inset CommandInset ref
12453 LatexCommand ref
12454 reference "subsec:Font-description"
12455
12456 \end_inset
12457
12458 .
12459 \end_layout
12460
12461 \begin_layout Itemize
12462 \begin_inset Flex Code
12463 status collapsed
12464
12465 \begin_layout Plain Layout
12466 Decoration
12467 \end_layout
12468
12469 \end_inset
12470
12471  [
12472 \begin_inset Flex Code
12473 status collapsed
12474
12475 \begin_layout Plain Layout
12476
12477 \emph on
12478 Classic
12479 \emph default
12480 , Minimalistic, Conglomerate
12481 \end_layout
12482
12483 \end_inset
12484
12485 ] describes the rendering style used for the inset's frame and buttons.
12486 \end_layout
12487
12488 \begin_layout Itemize
12489 \begin_inset Flex Code
12490 status collapsed
12491
12492 \begin_layout Plain Layout
12493 AutoInsert
12494 \end_layout
12495
12496 \end_inset
12497
12498
12499 \begin_inset Flex Code
12500 status collapsed
12501
12502 \begin_layout Plain Layout
12503 [int=0]
12504 \end_layout
12505
12506 \end_inset
12507
12508  If this is set to
12509 \begin_inset Flex Code
12510 status collapsed
12511
12512 \begin_layout Plain Layout
12513 1
12514 \end_layout
12515
12516 \end_inset
12517
12518 , this argument is automatically inserted when the respective style is selected.
12519
12520 \change_deleted -712698321 1559484200
12521  Currently, only one argument per style\SpecialChar breakableslash
12522 layout can be automatically inserted.
12523 \change_unchanged
12524
12525 \end_layout
12526
12527 \begin_layout Itemize
12528
12529 \change_inserted -712698321 1559491402
12530 \begin_inset Flex Code
12531 status collapsed
12532
12533 \begin_layout Plain Layout
12534
12535 \change_inserted -712698321 1559490711
12536 InsertOnNewline
12537 \end_layout
12538
12539 \end_inset
12540
12541
12542 \begin_inset Flex Code
12543 status collapsed
12544
12545 \begin_layout Plain Layout
12546
12547 \change_inserted -712698321 1559490703
12548 [int=0]
12549 \end_layout
12550
12551 \end_inset
12552
12553  If this is set to
12554 \begin_inset Flex Code
12555 status collapsed
12556
12557 \begin_layout Plain Layout
12558
12559 \change_inserted -712698321 1559490703
12560 1
12561 \end_layout
12562
12563 \end_inset
12564
12565 , this argument will be inserted on a new line with
12566 \begin_inset Flex Code
12567 status collapsed
12568
12569 \begin_layout Plain Layout
12570
12571 \change_inserted -712698321 1559491402
12572 AutoInsert
12573 \end_layout
12574
12575 \end_inset
12576
12577  (only available within Flex insets).
12578 \end_layout
12579
12580 \begin_layout Itemize
12581 \begin_inset Flex Code
12582 status collapsed
12583
12584 \begin_layout Plain Layout
12585 InsertCotext
12586 \end_layout
12587
12588 \end_inset
12589
12590
12591 \begin_inset Flex Code
12592 status collapsed
12593
12594 \begin_layout Plain Layout
12595 [int=0]
12596 \end_layout
12597
12598 \end_inset
12599
12600  If this is set to
12601 \begin_inset Flex Code
12602 status collapsed
12603
12604 \begin_layout Plain Layout
12605 1
12606 \end_layout
12607
12608 \end_inset
12609
12610 , this argument will be inserted with a copy of the co-text (either selected
12611  text or the whole paragraph) as content.
12612 \end_layout
12613
12614 \begin_layout Itemize
12615 \begin_inset Flex Code
12616 status collapsed
12617
12618 \begin_layout Plain Layout
12619 PassThru
12620 \end_layout
12621
12622 \end_inset
12623
12624  [
12625 \begin_inset Flex Code
12626 status collapsed
12627
12628 \begin_layout Plain Layout
12629
12630 \emph on
12631 inherited
12632 \emph default
12633 , true, false
12634 \end_layout
12635
12636 \end_inset
12637
12638 ] Whether the contents of this argument should be output in raw form, meaning
12639  without special translations that \SpecialChar LaTeX
12640  would require.
12641  By default, the
12642 \begin_inset Flex Code
12643 status collapsed
12644
12645 \begin_layout Plain Layout
12646 PassThru
12647 \end_layout
12648
12649 \end_inset
12650
12651  status is inherited by the inset or paragraph layout the argument belongs
12652  to, true and false change the status for the given argument only.
12653 \end_layout
12654
12655 \begin_layout Itemize
12656 \begin_inset Flex Code
12657 status collapsed
12658
12659 \begin_layout Plain Layout
12660 PassThruChars
12661 \end_layout
12662
12663 \end_inset
12664
12665  [
12666 \begin_inset Flex Code
12667 status collapsed
12668
12669 \begin_layout Plain Layout
12670 string of characters
12671 \end_layout
12672
12673 \end_inset
12674
12675 ]
12676 \family typewriter
12677
12678 \family default
12679 Defines individual characters
12680 \begin_inset Newline linebreak
12681 \end_inset
12682
12683 that should be output in raw form, meaning without special translations
12684  that \SpecialChar LaTeX
12685  would require.
12686  Note that, contrary to PassThru, this needs to be explicitly defined for
12687  arguments.
12688  That is, arguments do not inherit PassThruChars from their parent inset
12689  or layout.
12690 \end_layout
12691
12692 \begin_layout Itemize
12693 \begin_inset Flex Code
12694 status collapsed
12695
12696 \begin_layout Plain Layout
12697 IsTocCaption
12698 \end_layout
12699
12700 \end_inset
12701
12702  [
12703 \begin_inset Flex Code
12704 status collapsed
12705
12706 \begin_layout Plain Layout
12707
12708 \emph on
12709 0
12710 \end_layout
12711
12712 \end_inset
12713
12714 ,
12715 \begin_inset space \thinspace{}
12716 \end_inset
12717
12718
12719 \begin_inset Flex Code
12720 status collapsed
12721
12722 \begin_layout Plain Layout
12723 1
12724 \end_layout
12725
12726 \end_inset
12727
12728 ] If this is set to 1, the argument will output its content in the corresponding
12729  item in the table of contents.
12730  See AddToToc.
12731 \end_layout
12732
12733 \begin_layout Standard
12734 By default, the text entered in the \SpecialChar LyX
12735  workarea in the respective layout is
12736  the last (mandatory) argument of a command if the
12737 \begin_inset Flex Code
12738 status collapsed
12739
12740 \begin_layout Plain Layout
12741 LatexType
12742 \end_layout
12743
12744 \end_inset
12745
12746  is
12747 \begin_inset Flex Code
12748 status collapsed
12749
12750 \begin_layout Plain Layout
12751 Command
12752 \end_layout
12753
12754 \end_inset
12755
12756 .
12757  However, arguments with the prefix
12758 \begin_inset Flex Code
12759 status collapsed
12760
12761 \begin_layout Plain Layout
12762 post:
12763 \end_layout
12764
12765 \end_inset
12766
12767  are output after this workarea argument.
12768  Note that post-argument numbering restarts at 1, so the first argument
12769  following the workarea argument is
12770 \begin_inset Flex Code
12771 status collapsed
12772
12773 \begin_layout Plain Layout
12774 post:1
12775 \end_layout
12776
12777 \end_inset
12778
12779 .
12780  Post-arguments are ignored in any other
12781 \begin_inset Flex Code
12782 status collapsed
12783
12784 \begin_layout Plain Layout
12785 LatexType
12786 \end_layout
12787
12788 \end_inset
12789
12790  than
12791 \begin_inset Flex Code
12792 status collapsed
12793
12794 \begin_layout Plain Layout
12795 Command
12796 \end_layout
12797
12798 \end_inset
12799
12800 .
12801 \end_layout
12802
12803 \begin_layout Standard
12804 Arguments for list
12805 \begin_inset Flex Code
12806 status collapsed
12807
12808 \begin_layout Plain Layout
12809
12810 \backslash
12811 item
12812 \end_layout
12813
12814 \end_inset
12815
12816 s (as in
12817 \begin_inset Flex Code
12818 status collapsed
12819
12820 \begin_layout Plain Layout
12821
12822 \backslash
12823 item[foo]
12824 \end_layout
12825
12826 \end_inset
12827
12828 ) have the prefix
12829 \begin_inset Flex Code
12830 status collapsed
12831
12832 \begin_layout Plain Layout
12833 item:
12834 \end_layout
12835
12836 \end_inset
12837
12838  followed by the number (e.
12839 \begin_inset space \thinspace{}
12840 \end_inset
12841
12842 g.
12843 \begin_inset space \space{}
12844 \end_inset
12845
12846
12847 \begin_inset Flex Code
12848 status collapsed
12849
12850 \begin_layout Plain Layout
12851 Argument item:1
12852 \end_layout
12853
12854 \end_inset
12855
12856 ).
12857 \change_inserted -712698321 1534487781
12858
12859 \end_layout
12860
12861 \begin_layout Standard
12862
12863 \change_inserted -712698321 1534488561
12864 Finally, there is a special argument type with the prefix
12865 \begin_inset Flex Code
12866 status collapsed
12867
12868 \begin_layout Plain Layout
12869
12870 \change_inserted -712698321 1534487844
12871 listpreamble:
12872 \change_unchanged
12873
12874 \end_layout
12875
12876 \end_inset
12877
12878 .
12879  It is not really an argument, but uses the argument interface (thus, the
12880  prefix is also followed by a number, e.
12881 \begin_inset space \thinspace{}
12882 \end_inset
12883
12884 g.
12885
12886 \begin_inset Flex Code
12887 status collapsed
12888
12889 \begin_layout Plain Layout
12890
12891 \change_inserted -712698321 1534488412
12892 Argument listpreamble:1
12893 \end_layout
12894
12895 \end_inset
12896
12897 ).
12898  As the name implies, it is targeted at lists such as
12899 \family sans
12900 Itemize
12901 \family default
12902 ,
12903 \family sans
12904 Enumerate
12905 \family default
12906 ,
12907 \family sans
12908 Description
12909 \family default
12910 , or
12911 \family sans
12912 Bibliography
12913 \family default
12914 .
12915  Its content will be output at the list start, before the first
12916 \begin_inset Flex Code
12917 status collapsed
12918
12919 \begin_layout Plain Layout
12920
12921 \change_inserted -712698321 1534488058
12922
12923 \backslash
12924 item
12925 \change_unchanged
12926
12927 \end_layout
12928
12929 \end_inset
12930
12931 , on an own line (a place that is otherwise not accessible in \SpecialChar LyX
12932 ).
12933  This way, users can insert redefinitions (of lengths etc.) to individual
12934  lists.
12935  By default, these arguments do not have a delimiter.
12936 \change_unchanged
12937
12938 \end_layout
12939
12940 \end_deeper
12941 \begin_layout Description
12942 \begin_inset Flex Code
12943 status collapsed
12944
12945 \begin_layout Plain Layout
12946 AutoNests
12947 \end_layout
12948
12949 \end_inset
12950
12951  Includes a comma-separated list of layouts that should be nested in and
12952  after the current layout.
12953  Only makes sense for nestable layouts (such as environments).
12954  Must be ended by
12955 \begin_inset Quotes eld
12956 \end_inset
12957
12958
12959 \begin_inset Flex Code
12960 status collapsed
12961
12962 \begin_layout Plain Layout
12963 EndAutoNests
12964 \end_layout
12965
12966 \end_inset
12967
12968
12969 \begin_inset Quotes erd
12970 \end_inset
12971
12972 .
12973  See also
12974 \begin_inset Flex Code
12975 status collapsed
12976
12977 \begin_layout Plain Layout
12978 IsAutoNestedBy
12979 \end_layout
12980
12981 \end_inset
12982
12983 .
12984 \end_layout
12985
12986 \begin_layout Description
12987 \begin_inset Flex Code
12988 status collapsed
12989
12990 \begin_layout Plain Layout
12991 BabelPreamble
12992 \end_layout
12993
12994 \end_inset
12995
12996  Note that this will completely override any prior
12997 \begin_inset Flex Code
12998 status collapsed
12999
13000 \begin_layout Plain Layout
13001 BabelPreamble
13002 \end_layout
13003
13004 \end_inset
13005
13006  declaration for this style.
13007  Must end with
13008 \begin_inset Quotes eld
13009 \end_inset
13010
13011
13012 \begin_inset Flex Code
13013 status collapsed
13014
13015 \begin_layout Plain Layout
13016 EndBabelPreamble
13017 \end_layout
13018
13019 \end_inset
13020
13021
13022 \begin_inset Quotes erd
13023 \end_inset
13024
13025 .
13026  See
13027 \begin_inset CommandInset ref
13028 LatexCommand ref
13029 reference "subsec:I18n"
13030
13031 \end_inset
13032
13033  for details on its use.
13034 \end_layout
13035
13036 \begin_layout Description
13037 \begin_inset Flex Code
13038 status collapsed
13039
13040 \begin_layout Plain Layout
13041 BottomSep
13042 \end_layout
13043
13044 \end_inset
13045
13046  [
13047 \begin_inset Flex Code
13048 status collapsed
13049
13050 \begin_layout Plain Layout
13051 float=0
13052 \end_layout
13053
13054 \end_inset
13055
13056 ]
13057 \begin_inset Foot
13058 status collapsed
13059
13060 \begin_layout Plain Layout
13061 Note that a `float' here is a real number, such as: 1.5.
13062 \end_layout
13063
13064 \end_inset
13065
13066  The vertical space with which the last of a chain of paragraphs with this
13067  style is separated from the following paragraph.
13068  If the next paragraph has another style, the separations are not simply
13069  added, but the maximum is taken.
13070 \end_layout
13071
13072 \begin_layout Description
13073 \begin_inset Flex Code
13074 status collapsed
13075
13076 \begin_layout Plain Layout
13077 Category
13078 \end_layout
13079
13080 \end_inset
13081
13082  [
13083 \begin_inset Flex Code
13084 status collapsed
13085
13086 \begin_layout Plain Layout
13087 string
13088 \end_layout
13089
13090 \end_inset
13091
13092 ] The category for this style.
13093  This is used to group related styles in the style combobox on the toolbar.
13094  Any string can be used, but you may want to use existing categories with
13095  your own styles.
13096
13097 \end_layout
13098
13099 \begin_layout Description
13100 \begin_inset Flex Code
13101 status collapsed
13102
13103 \begin_layout Plain Layout
13104 CommandDepth
13105 \end_layout
13106
13107 \end_inset
13108
13109  Depth of XML command.
13110  Used only with XML-type formats.
13111 \end_layout
13112
13113 \begin_layout Description
13114 \begin_inset Flex Code
13115 status collapsed
13116
13117 \begin_layout Plain Layout
13118 CopyStyle
13119 \end_layout
13120
13121 \end_inset
13122
13123  [
13124 \begin_inset Flex Code
13125 status collapsed
13126
13127 \begin_layout Plain Layout
13128 string
13129 \end_layout
13130
13131 \end_inset
13132
13133 ] Copies all the features of an existing style into the current one.
13134
13135 \end_layout
13136
13137 \begin_layout Description
13138 \begin_inset Flex Code
13139 status collapsed
13140
13141 \begin_layout Plain Layout
13142 DependsOn
13143 \end_layout
13144
13145 \end_inset
13146
13147  [
13148 \begin_inset Flex Code
13149 status collapsed
13150
13151 \begin_layout Plain Layout
13152 <name>
13153 \end_layout
13154
13155 \end_inset
13156
13157 ] The name of a style whose preamble should be output
13158 \emph on
13159 before
13160 \emph default
13161  this one.
13162  This allows to ensure some ordering of the preamble snippets when macros
13163  definitions depend on one another.
13164 \begin_inset Foot
13165 status collapsed
13166
13167 \begin_layout Plain Layout
13168 Note that, besides that functionality, there is no way to ensure any ordering
13169  of preambles.
13170  The ordering that you see in a given version of \SpecialChar LyX
13171  may change without warning
13172  in later versions.
13173 \end_layout
13174
13175 \end_inset
13176
13177
13178 \end_layout
13179
13180 \begin_layout Description
13181 \begin_inset Flex Code
13182 status collapsed
13183
13184 \begin_layout Plain Layout
13185 EndLabeltype
13186 \end_layout
13187
13188 \end_inset
13189
13190  [
13191 \begin_inset Flex Code
13192 status collapsed
13193
13194 \begin_layout Plain Layout
13195
13196 \emph on
13197 No_Label
13198 \emph default
13199 , Box, Filled_Box, Static
13200 \end_layout
13201
13202 \end_inset
13203
13204 ] The type of label that stands at the end of the paragraph (or sequence
13205  of paragraphs if
13206 \begin_inset Flex Code
13207 status collapsed
13208
13209 \begin_layout Plain Layout
13210 LatexType
13211 \end_layout
13212
13213 \end_inset
13214
13215  is
13216 \begin_inset Newline newline
13217 \end_inset
13218
13219
13220 \begin_inset Flex Code
13221 status collapsed
13222
13223 \begin_layout Plain Layout
13224 Environment
13225 \end_layout
13226
13227 \end_inset
13228
13229 ,
13230 \begin_inset Flex Code
13231 status collapsed
13232
13233 \begin_layout Plain Layout
13234 Item_Environment
13235 \end_layout
13236
13237 \end_inset
13238
13239  or
13240 \begin_inset Flex Code
13241 status collapsed
13242
13243 \begin_layout Plain Layout
13244 List_Environment
13245 \end_layout
13246
13247 \end_inset
13248
13249 ).
13250
13251 \begin_inset Flex Code
13252 status collapsed
13253
13254 \begin_layout Plain Layout
13255 No_Label
13256 \end_layout
13257
13258 \end_inset
13259
13260  means
13261 \begin_inset Quotes eld
13262 \end_inset
13263
13264 nothing
13265 \begin_inset Quotes erd
13266 \end_inset
13267
13268 ,
13269 \begin_inset Flex Code
13270 status collapsed
13271
13272 \begin_layout Plain Layout
13273 Box
13274 \end_layout
13275
13276 \end_inset
13277
13278  (resp.
13279 \begin_inset space \space{}
13280 \end_inset
13281
13282
13283 \begin_inset Flex Code
13284 status collapsed
13285
13286 \begin_layout Plain Layout
13287 Filled_Box
13288 \end_layout
13289
13290 \end_inset
13291
13292 ) is a white (resp.
13293 \begin_inset space ~
13294 \end_inset
13295
13296 black) square suitable for end of proof markers,
13297 \begin_inset Flex Code
13298 status collapsed
13299
13300 \begin_layout Plain Layout
13301 Static
13302 \end_layout
13303
13304 \end_inset
13305
13306  is an explicit text string.
13307 \end_layout
13308
13309 \begin_layout Description
13310 \begin_inset Flex Code
13311 status collapsed
13312
13313 \begin_layout Plain Layout
13314 EndLabelString
13315 \end_layout
13316
13317 \end_inset
13318
13319  [
13320 \begin_inset Flex Code
13321 status collapsed
13322
13323 \begin_layout Plain Layout
13324 string=""
13325 \end_layout
13326
13327 \end_inset
13328
13329 ] The string used for a label with a
13330 \begin_inset Flex Code
13331 status collapsed
13332
13333 \begin_layout Plain Layout
13334 Static
13335 \end_layout
13336
13337 \end_inset
13338
13339
13340 \begin_inset Newline newline
13341 \end_inset
13342
13343
13344 \begin_inset Flex Code
13345 status collapsed
13346
13347 \begin_layout Plain Layout
13348 EndLabelType
13349 \end_layout
13350
13351 \end_inset
13352
13353 .
13354
13355 \end_layout
13356
13357 \begin_layout Description
13358 \begin_inset Flex Code
13359 status collapsed
13360
13361 \begin_layout Plain Layout
13362 Font
13363 \end_layout
13364
13365 \end_inset
13366
13367  The font used for both the text body
13368 \emph on
13369 and
13370 \emph default
13371  the label.
13372  See
13373 \begin_inset CommandInset ref
13374 LatexCommand ref
13375 reference "subsec:Font-description"
13376
13377 \end_inset
13378
13379 .
13380  Note that defining this font automatically defines the
13381 \begin_inset Flex Code
13382 status collapsed
13383
13384 \begin_layout Plain Layout
13385 LabelFont
13386 \end_layout
13387
13388 \end_inset
13389
13390  to the same value.
13391  So you should define this one first if you also want to define
13392 \begin_inset Flex Code
13393 status collapsed
13394
13395 \begin_layout Plain Layout
13396 LabelFont
13397 \end_layout
13398
13399 \end_inset
13400
13401 .
13402 \end_layout
13403
13404 \begin_layout Description
13405 \begin_inset Flex Code
13406 status collapsed
13407
13408 \begin_layout Plain Layout
13409 ForceLocal
13410 \end_layout
13411
13412 \end_inset
13413
13414  [
13415 \begin_inset Flex Code
13416 status collapsed
13417
13418 \begin_layout Plain Layout
13419 int=0
13420 \end_layout
13421
13422 \end_inset
13423
13424 ] Used for backporting new styles to stable \SpecialChar LyX
13425  versions.
13426  The first stable version that supports this tag is \SpecialChar LyX
13427  2.1.0.
13428  The argument is a number which may either be 0, -1 or any value greater
13429  than zero.
13430  If the
13431 \begin_inset Flex Code
13432 status collapsed
13433
13434 \begin_layout Plain Layout
13435 ForceLocal
13436 \end_layout
13437
13438 \end_inset
13439
13440  flag of a style is greater than zero, it will always be written to the
13441  document header.
13442  If a .lyx file is read, the style definitions from the document header are
13443  added to the document class.
13444  Therefore even older \SpecialChar LyX
13445  versions can handle the style.
13446  The argument of
13447 \begin_inset Flex Code
13448 status collapsed
13449
13450 \begin_layout Plain Layout
13451 ForceLocal
13452 \end_layout
13453
13454 \end_inset
13455
13456  is a version number: if the style is read, and the version number is less
13457  than the version number of the already existing style in the document class,
13458  the new style is ignored.
13459  If the version number is greater, the new style replaces the existing style.
13460  A value of -1 means an infinite version number, i.
13461 \begin_inset space \thinspace{}
13462 \end_inset
13463
13464 e.
13465 \begin_inset space \space{}
13466 \end_inset
13467
13468 the style is always used.
13469 \end_layout
13470
13471 \begin_layout Description
13472 \begin_inset Flex Code
13473 status collapsed
13474
13475 \begin_layout Plain Layout
13476 FreeSpacing
13477 \end_layout
13478
13479 \end_inset
13480
13481  [
13482 \begin_inset Flex Code
13483 status collapsed
13484
13485 \begin_layout Plain Layout
13486
13487 \emph on
13488 0
13489 \end_layout
13490
13491 \end_inset
13492
13493 ,
13494 \begin_inset space \thinspace{}
13495 \end_inset
13496
13497
13498 \begin_inset Flex Code
13499 status collapsed
13500
13501 \begin_layout Plain Layout
13502 1
13503 \end_layout
13504
13505 \end_inset
13506
13507 ] Usually \SpecialChar LyX
13508  does not allow you to insert more than one space between words,
13509  since a space is considered as the separation between two words, not a
13510  character or symbol of its own.
13511  This is a very fine thing but sometimes annoying, for example, when typing
13512  program code or plain \SpecialChar LaTeX
13513  code.
13514  For this reason,
13515 \begin_inset Flex Code
13516 status collapsed
13517
13518 \begin_layout Plain Layout
13519 FreeSpacing
13520 \end_layout
13521
13522 \end_inset
13523
13524  can be enabled.
13525
13526 \change_deleted -495245474 1550490105
13527 Note that
13528 \change_unchanged
13529 \SpecialChar LyX
13530  will create protected blanks for the additional blanks when in
13531 \change_inserted -495245474 1550490096
13532
13533 \begin_inset Flex Code
13534 status collapsed
13535
13536 \begin_layout Plain Layout
13537
13538 \change_inserted -495245474 1550490089
13539 Passthru 1
13540 \end_layout
13541
13542 \end_inset
13543
13544  is not specified.
13545 \change_deleted -495245474 1550490116
13546 another mode than \SpecialChar LaTeX
13547 -mode.
13548
13549 \change_inserted -495245474 1550247760
13550  Note that
13551 \begin_inset Flex Code
13552 status collapsed
13553
13554 \begin_layout Plain Layout
13555
13556 \change_inserted -495245474 1550247736
13557 FreeSpacing
13558 \end_layout
13559
13560 \end_inset
13561
13562  implies
13563 \begin_inset Flex Code
13564 status collapsed
13565
13566 \begin_layout Plain Layout
13567
13568 \change_inserted -495245474 1550247755
13569 KeepEmpty
13570 \end_layout
13571
13572 \end_inset
13573
13574 .
13575 \change_unchanged
13576
13577 \end_layout
13578
13579 \begin_layout Description
13580 \begin_inset Flex Code
13581 status collapsed
13582
13583 \begin_layout Plain Layout
13584 HTML*
13585 \end_layout
13586
13587 \end_inset
13588
13589  These tags are used with XHTML output.
13590  See
13591 \begin_inset CommandInset ref
13592 LatexCommand ref
13593 reference "subsec:Paragraph-Style-XHTML"
13594
13595 \end_inset
13596
13597 .
13598 \end_layout
13599
13600 \begin_layout Description
13601 \begin_inset Flex Code
13602 status collapsed
13603
13604 \begin_layout Plain Layout
13605 InnerTag
13606 \end_layout
13607
13608 \end_inset
13609
13610  [FIXME] (Used only with XML-type formats.)
13611 \end_layout
13612
13613 \begin_layout Description
13614 \begin_inset Flex Code
13615 status collapsed
13616
13617 \begin_layout Plain Layout
13618 InPreamble
13619 \end_layout
13620
13621 \end_inset
13622
13623  [
13624 \begin_inset Flex Code
13625 status collapsed
13626
13627 \begin_layout Plain Layout
13628
13629 \emph on
13630 0
13631 \end_layout
13632
13633 \end_inset
13634
13635 ,
13636 \begin_inset space \thinspace{}
13637 \end_inset
13638
13639
13640 \begin_inset Flex Code
13641 status collapsed
13642
13643 \begin_layout Plain Layout
13644 1
13645 \end_layout
13646
13647 \end_inset
13648
13649 ] If
13650 \begin_inset Flex Code
13651 status collapsed
13652
13653 \begin_layout Plain Layout
13654 1
13655 \end_layout
13656
13657 \end_inset
13658
13659 , marks the style as to be included in the document preamble and not in
13660  the document body.
13661  This is useful for document classes that want such information as the title
13662  and author to appear in the preamble.
13663  Note that this works only for styles for which the
13664 \begin_inset Flex Code
13665 status collapsed
13666
13667 \begin_layout Plain Layout
13668 LatexType
13669 \end_layout
13670
13671 \end_inset
13672
13673  is
13674 \begin_inset Flex Code
13675 status collapsed
13676
13677 \begin_layout Plain Layout
13678 Command
13679 \end_layout
13680
13681 \end_inset
13682
13683  or
13684 \begin_inset Flex Code
13685 status collapsed
13686
13687 \begin_layout Plain Layout
13688 Paragraph
13689 \end_layout
13690
13691 \end_inset
13692
13693 .
13694 \end_layout
13695
13696 \begin_layout Description
13697 \begin_inset Flex Code
13698 status collapsed
13699
13700 \begin_layout Plain Layout
13701 InTitle
13702 \end_layout
13703
13704 \end_inset
13705
13706  [
13707 \begin_inset Flex Code
13708 status collapsed
13709
13710 \begin_layout Plain Layout
13711
13712 \emph on
13713 0
13714 \end_layout
13715
13716 \end_inset
13717
13718 ,
13719 \begin_inset space \thinspace{}
13720 \end_inset
13721
13722
13723 \begin_inset Flex Code
13724 status collapsed
13725
13726 \begin_layout Plain Layout
13727 1
13728 \end_layout
13729
13730 \end_inset
13731
13732 ] If
13733 \begin_inset Flex Code
13734 status collapsed
13735
13736 \begin_layout Plain Layout
13737 1
13738 \end_layout
13739
13740 \end_inset
13741
13742 , marks the style as being part of a title block (see also the
13743 \begin_inset Flex Code
13744 status collapsed
13745
13746 \begin_layout Plain Layout
13747 TitleLatexType
13748 \end_layout
13749
13750 \end_inset
13751
13752  and
13753 \begin_inset Flex Code
13754 status collapsed
13755
13756 \begin_layout Plain Layout
13757 TitleLatexName
13758 \end_layout
13759
13760 \end_inset
13761
13762  global entries).
13763 \end_layout
13764
13765 \begin_layout Description
13766 \begin_inset Flex Code
13767 status collapsed
13768
13769 \begin_layout Plain Layout
13770 IsAutoNestedBy
13771 \end_layout
13772
13773 \end_inset
13774
13775  Includes a comma-separated list of layouts after which this one should
13776  be nested.
13777  Only makes sense with regard to nestable layouts (such as environments).
13778  Must be ended by
13779 \begin_inset Quotes eld
13780 \end_inset
13781
13782
13783 \begin_inset Flex Code
13784 status collapsed
13785
13786 \begin_layout Plain Layout
13787 EndIsAutoNestedBy
13788 \end_layout
13789
13790 \end_inset
13791
13792
13793 \begin_inset Quotes erd
13794 \end_inset
13795
13796 .
13797  See also
13798 \begin_inset Flex Code
13799 status collapsed
13800
13801 \begin_layout Plain Layout
13802 AutoNests
13803 \end_layout
13804
13805 \end_inset
13806
13807 .
13808 \end_layout
13809
13810 \begin_layout Description
13811 \begin_inset Flex Code
13812 status collapsed
13813
13814 \begin_layout Plain Layout
13815 IsTocCaption
13816 \end_layout
13817
13818 \end_inset
13819
13820  [
13821 \begin_inset Flex Code
13822 status collapsed
13823
13824 \begin_layout Plain Layout
13825
13826 \emph on
13827 0
13828 \end_layout
13829
13830 \end_inset
13831
13832 ,
13833 \begin_inset space \thinspace{}
13834 \end_inset
13835
13836
13837 \begin_inset Flex Code
13838 status collapsed
13839
13840 \begin_layout Plain Layout
13841 1
13842 \end_layout
13843
13844 \end_inset
13845
13846 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
13847  of its contents in its item in the table of contents.
13848  Otherwise, only the label, if it exists, appears.
13849 \end_layout
13850
13851 \begin_layout Description
13852 \begin_inset Flex Code
13853 status collapsed
13854
13855 \begin_layout Plain Layout
13856 ItemCommand
13857 \end_layout
13858
13859 \end_inset
13860
13861  [
13862 \begin_inset Flex Code
13863 status collapsed
13864
13865 \begin_layout Plain Layout
13866 string="item"
13867 \end_layout
13868
13869 \end_inset
13870
13871 ] The \SpecialChar LaTeX
13872  command sequence declaring an item in a list.
13873  The command is to be defined without the preceding backslash (the default
13874  is
13875 \begin_inset Quotes eld
13876 \end_inset
13877
13878 item
13879 \begin_inset Quotes erd
13880 \end_inset
13881
13882 , resulting in
13883 \begin_inset Flex Code
13884 status collapsed
13885
13886 \begin_layout Plain Layout
13887
13888 \backslash
13889 item
13890 \end_layout
13891
13892 \end_inset
13893
13894  in the \SpecialChar LaTeX
13895  output).
13896 \end_layout
13897
13898 \begin_layout Description
13899 \begin_inset Flex Code
13900 status collapsed
13901
13902 \begin_layout Plain Layout
13903 ItemSep
13904 \end_layout
13905
13906 \end_inset
13907
13908  [
13909 \begin_inset Flex Code
13910 status collapsed
13911
13912 \begin_layout Plain Layout
13913 float=0
13914 \end_layout
13915
13916 \end_inset
13917
13918 ] This provides extra space between paragraphs that have the same style.
13919  If you put other styles into an environment, each is separated with the
13920  environment's
13921 \begin_inset Flex Code
13922 status collapsed
13923
13924 \begin_layout Plain Layout
13925 ParSep
13926 \end_layout
13927
13928 \end_inset
13929
13930 .
13931  But the whole items of the environment are additionally separated with
13932  this
13933 \begin_inset Flex Code
13934 status collapsed
13935
13936 \begin_layout Plain Layout
13937 ItemSep
13938 \end_layout
13939
13940 \end_inset
13941
13942 .
13943  Note that this is a
13944 \emph on
13945  multiplier.
13946 \end_layout
13947
13948 \begin_layout Description
13949 \begin_inset Flex Code
13950 status collapsed
13951
13952 \begin_layout Plain Layout
13953 ItemTag
13954 \end_layout
13955
13956 \end_inset
13957
13958  [FIXME] (Used only with XML-type formats.)
13959 \end_layout
13960
13961 \begin_layout Description
13962 \begin_inset Flex Code
13963 status collapsed
13964
13965 \begin_layout Plain Layout
13966 KeepEmpty
13967 \end_layout
13968
13969 \end_inset
13970
13971  [
13972 \begin_inset Flex Code
13973 status collapsed
13974
13975 \begin_layout Plain Layout
13976
13977 \emph on
13978 0
13979 \end_layout
13980
13981 \end_inset
13982
13983 ,
13984 \begin_inset space \thinspace{}
13985 \end_inset
13986
13987
13988 \begin_inset Flex Code
13989 status collapsed
13990
13991 \begin_layout Plain Layout
13992 1
13993 \end_layout
13994
13995 \end_inset
13996
13997 ] Usually \SpecialChar LyX
13998  does not allow you to leave a paragraph empty, since it would
13999  lead to empty \SpecialChar LaTeX
14000  output.
14001  There are some cases where this could be desirable however: in a letter
14002  template, the required fields can be provided as empty fields, so that
14003  people do not forget them; in some special classes, a style can be used
14004  as some kind of break, which does not contain actual text.
14005 \end_layout
14006
14007 \begin_layout Description
14008 \begin_inset Flex Code
14009 status collapsed
14010
14011 \begin_layout Plain Layout
14012 LabelBottomsep
14013 \end_layout
14014
14015 \end_inset
14016
14017  [
14018 \begin_inset Flex Code
14019 status collapsed
14020
14021 \begin_layout Plain Layout
14022 float=0
14023 \end_layout
14024
14025 \end_inset
14026
14027 ] The vertical space between the label and the text body.
14028  Only used for labels that are above the text body (
14029 \begin_inset Flex Code
14030 status collapsed
14031
14032 \begin_layout Plain Layout
14033 Top_Environment
14034 \end_layout
14035
14036 \end_inset
14037
14038  and
14039 \begin_inset Newline newline
14040 \end_inset
14041
14042
14043 \begin_inset Flex Code
14044 status collapsed
14045
14046 \begin_layout Plain Layout
14047 Centered_Top_Environment
14048 \end_layout
14049
14050 \end_inset
14051
14052 ).
14053 \end_layout
14054
14055 \begin_layout Description
14056 \begin_inset Flex Code
14057 status collapsed
14058
14059 \begin_layout Plain Layout
14060 LabelCounter
14061 \end_layout
14062
14063 \end_inset
14064
14065  [
14066 \begin_inset Flex Code
14067 status collapsed
14068
14069 \begin_layout Plain Layout
14070 string=""
14071 \end_layout
14072
14073 \end_inset
14074
14075 ] The name of the counter for automatic numbering.
14076  In order to have the counter appear with your label, you will need to reference
14077  it in the
14078 \begin_inset Flex Code
14079 status collapsed
14080
14081 \begin_layout Plain Layout
14082
14083 \family typewriter
14084 LabelString
14085 \end_layout
14086
14087 \end_inset
14088
14089 .
14090  This will work with
14091 \begin_inset Flex Code
14092 status collapsed
14093
14094 \begin_layout Plain Layout
14095 LabelType
14096 \end_layout
14097
14098 \end_inset
14099
14100 s,
14101 \begin_inset Flex Code
14102 status collapsed
14103
14104 \begin_layout Plain Layout
14105 Static
14106 \end_layout
14107
14108 \end_inset
14109
14110 ,
14111 \begin_inset Flex Code
14112 status collapsed
14113
14114 \begin_layout Plain Layout
14115 Above
14116 \end_layout
14117
14118 \end_inset
14119
14120  and
14121 \begin_inset Flex Code
14122 status collapsed
14123
14124 \begin_layout Plain Layout
14125 Centered
14126 \end_layout
14127
14128 \end_inset
14129
14130 , at least.
14131 \begin_inset Newline newline
14132 \end_inset
14133
14134 This
14135 \emph on
14136 may
14137 \emph default
14138  also be given if
14139 \begin_inset Flex Code
14140 status collapsed
14141
14142 \begin_layout Plain Layout
14143 LabelType
14144 \end_layout
14145
14146 \end_inset
14147
14148  is
14149 \begin_inset Flex Code
14150 status collapsed
14151
14152 \begin_layout Plain Layout
14153 Enumerate
14154 \end_layout
14155
14156 \end_inset
14157
14158 , though this case is a bit complicated.
14159  Suppose you declare
14160 \begin_inset Quotes eld
14161 \end_inset
14162
14163
14164 \begin_inset Flex Code
14165 status collapsed
14166
14167 \begin_layout Plain Layout
14168 LabelCounter myenum
14169 \end_layout
14170
14171 \end_inset
14172
14173
14174 \begin_inset Quotes erd
14175 \end_inset
14176
14177 .
14178  Then the actual counters used are
14179 \begin_inset Flex Code
14180 status collapsed
14181
14182 \begin_layout Plain Layout
14183 myenumi
14184 \end_layout
14185
14186 \end_inset
14187
14188 ,
14189 \begin_inset Flex Code
14190 status collapsed
14191
14192 \begin_layout Plain Layout
14193 myenumii
14194 \end_layout
14195
14196 \end_inset
14197
14198 ,
14199 \begin_inset Flex Code
14200 status collapsed
14201
14202 \begin_layout Plain Layout
14203 myenumiii
14204 \end_layout
14205
14206 \end_inset
14207
14208  and
14209 \begin_inset Flex Code
14210 status collapsed
14211
14212 \begin_layout Plain Layout
14213 myenumiv
14214 \end_layout
14215
14216 \end_inset
14217
14218 , much as in \SpecialChar LaTeX
14219 .
14220  These counters must all be declared separately.
14221 \begin_inset Newline newline
14222 \end_inset
14223
14224 See
14225 \begin_inset CommandInset ref
14226 LatexCommand ref
14227 reference "subsec:Counters"
14228
14229 \end_inset
14230
14231  for details on counters.
14232 \end_layout
14233
14234 \begin_layout Description
14235 \begin_inset Flex Code
14236 status collapsed
14237
14238 \begin_layout Plain Layout
14239 LabelFont
14240 \end_layout
14241
14242 \end_inset
14243
14244  The font used for the label.
14245  See
14246 \begin_inset CommandInset ref
14247 LatexCommand ref
14248 reference "subsec:Font-description"
14249
14250 \end_inset
14251
14252 .
14253 \end_layout
14254
14255 \begin_layout Description
14256 \begin_inset Flex Code
14257 status collapsed
14258
14259 \begin_layout Plain Layout
14260 LabelIndent
14261 \end_layout
14262
14263 \end_inset
14264
14265  [
14266 \begin_inset Flex Code
14267 status collapsed
14268
14269 \begin_layout Plain Layout
14270 string=""
14271 \end_layout
14272
14273 \end_inset
14274
14275 ] Text that indicates how far a label should be indented.
14276 \end_layout
14277
14278 \begin_layout Description
14279 \begin_inset Flex Code
14280 status collapsed
14281
14282 \begin_layout Plain Layout
14283 LabelSep
14284 \end_layout
14285
14286 \end_inset
14287
14288  [
14289 \begin_inset Flex Code
14290 status collapsed
14291
14292 \begin_layout Plain Layout
14293 string=""
14294 \end_layout
14295
14296 \end_inset
14297
14298 ] Text that indicates the amount of horizontal space between the label and
14299  the text body.
14300  Only used for labels that are not above the text body.
14301 \end_layout
14302
14303 \begin_layout Description
14304 \begin_inset Flex Code
14305 status collapsed
14306
14307 \begin_layout Plain Layout
14308 LabelString
14309 \end_layout
14310
14311 \end_inset
14312
14313  [
14314 \begin_inset Flex Code
14315 status collapsed
14316
14317 \begin_layout Plain Layout
14318 string=""
14319 \end_layout
14320
14321 \end_inset
14322
14323 ] The string used for the label.
14324  When
14325 \begin_inset Flex Code
14326 status collapsed
14327
14328 \begin_layout Plain Layout
14329 LabelCounter
14330 \end_layout
14331
14332 \end_inset
14333
14334  is set, this string can be contain the special formatting commands described
14335  in
14336 \begin_inset CommandInset ref
14337 LatexCommand ref
14338 reference "subsec:Counters"
14339
14340 \end_inset
14341
14342 .
14343 \end_layout
14344
14345 \begin_layout Description
14346 \begin_inset Flex Code
14347 status collapsed
14348
14349 \begin_layout Plain Layout
14350 LabelStringAppendix
14351 \end_layout
14352
14353 \end_inset
14354
14355  [
14356 \begin_inset Flex Code
14357 status collapsed
14358
14359 \begin_layout Plain Layout
14360 string=""
14361 \end_layout
14362
14363 \end_inset
14364
14365 ] This is used inside the appendix instead of
14366 \begin_inset Newline newline
14367 \end_inset
14368
14369
14370 \begin_inset Flex Code
14371 status collapsed
14372
14373 \begin_layout Plain Layout
14374 LabelString
14375 \end_layout
14376
14377 \end_inset
14378
14379 .
14380  Note that every
14381 \begin_inset Flex Code
14382 status collapsed
14383
14384 \begin_layout Plain Layout
14385 LabelString
14386 \end_layout
14387
14388 \end_inset
14389
14390  statement resets
14391 \begin_inset Newline newline
14392 \end_inset
14393
14394
14395 \begin_inset Flex Code
14396 status collapsed
14397
14398 \begin_layout Plain Layout
14399 LabelStringAppendix
14400 \end_layout
14401
14402 \end_inset
14403
14404  too.
14405 \end_layout
14406
14407 \begin_layout Description
14408 \begin_inset Flex Code
14409 status collapsed
14410
14411 \begin_layout Plain Layout
14412 LabelTag
14413 \end_layout
14414
14415 \end_inset
14416
14417  [FIXME] (Used only with XML-type formats.)
14418 \end_layout
14419
14420 \begin_layout Description
14421 \begin_inset Flex Code
14422 status collapsed
14423
14424 \begin_layout Plain Layout
14425 LabelType
14426 \end_layout
14427
14428 \end_inset
14429
14430  [
14431 \begin_inset Flex Code
14432 status collapsed
14433
14434 \begin_layout Plain Layout
14435
14436 \emph on
14437 No_Label
14438 \emph default
14439 , Manual, Static, Above,
14440 \begin_inset Newline newline
14441 \end_inset
14442
14443 Centered, Sensitive, Enumerate,
14444 \begin_inset Newline newline
14445 \end_inset
14446
14447 Itemize, Bibliography
14448 \end_layout
14449
14450 \end_inset
14451
14452 ]
14453 \end_layout
14454
14455 \begin_deeper
14456 \begin_layout Description
14457 \begin_inset Flex Code
14458 status collapsed
14459
14460 \begin_layout Plain Layout
14461 Manual
14462 \end_layout
14463
14464 \end_inset
14465
14466  means the label is the very first word (up to the first real blank).
14467  Use protected spaces if you want more than one word as the label.
14468
14469 \end_layout
14470
14471 \begin_layout Description
14472 \begin_inset Flex Code
14473 status collapsed
14474
14475 \begin_layout Plain Layout
14476 Static
14477 \end_layout
14478
14479 \end_inset
14480
14481  means the label is simply what is declared as
14482 \begin_inset Flex Code
14483 status collapsed
14484
14485 \begin_layout Plain Layout
14486 LabelString
14487 \end_layout
14488
14489 \end_inset
14490
14491 .
14492  This will be displayed
14493 \begin_inset Quotes eld
14494 \end_inset
14495
14496 inline
14497 \begin_inset Quotes erd
14498 \end_inset
14499
14500 , at the beginning of the paragraph.
14501  If the
14502 \begin_inset Flex Code
14503 status collapsed
14504
14505 \begin_layout Plain Layout
14506 LatexType
14507 \end_layout
14508
14509 \end_inset
14510
14511  is
14512 \begin_inset Flex Code
14513 status collapsed
14514
14515 \begin_layout Plain Layout
14516 Environment
14517 \end_layout
14518
14519 \end_inset
14520
14521 , then it will be displayed only in the first paragraph of any sequence
14522  of paragraphs with the same
14523 \begin_inset Flex Code
14524 status collapsed
14525
14526 \begin_layout Plain Layout
14527 Style
14528 \end_layout
14529
14530 \end_inset
14531
14532 .
14533 \end_layout
14534
14535 \begin_layout Description
14536 \begin_inset Flex Code
14537 status collapsed
14538
14539 \begin_layout Plain Layout
14540 Above
14541 \end_layout
14542
14543 \end_inset
14544
14545
14546 \begin_inset space ~
14547 \end_inset
14548
14549 and
14550 \begin_inset space ~
14551 \end_inset
14552
14553
14554 \begin_inset Flex Code
14555 status collapsed
14556
14557 \begin_layout Plain Layout
14558 Centered
14559 \end_layout
14560
14561 \end_inset
14562
14563  are special cases of
14564 \begin_inset Flex Code
14565 status collapsed
14566
14567 \begin_layout Plain Layout
14568 Static
14569 \end_layout
14570
14571 \end_inset
14572
14573 .
14574  The label will be printed above the paragraph either at the beginning of
14575  the line or centered.
14576 \end_layout
14577
14578 \begin_layout Description
14579 \begin_inset Flex Code
14580 status collapsed
14581
14582 \begin_layout Plain Layout
14583 Sensitive
14584 \end_layout
14585
14586 \end_inset
14587
14588  is a special case for the caption-labels
14589 \begin_inset Quotes eld
14590 \end_inset
14591
14592 Figure
14593 \begin_inset Quotes erd
14594 \end_inset
14595
14596  and
14597 \begin_inset Quotes eld
14598 \end_inset
14599
14600 Table
14601 \begin_inset Quotes erd
14602 \end_inset
14603
14604 .
14605 \begin_inset Newline newline
14606 \end_inset
14607
14608
14609 \begin_inset Flex Code
14610 status collapsed
14611
14612 \begin_layout Plain Layout
14613 Sensitive
14614 \end_layout
14615
14616 \end_inset
14617
14618  means the (hardcoded) label string depends on the kind of float: It is
14619  hardcoded to be `FloatType N', where N is the value of the counter associated
14620  with the float.
14621  For the case that a caption is inserted outside of a float the
14622 \begin_inset Flex Code
14623 status collapsed
14624
14625 \begin_layout Plain Layout
14626 LabelString
14627 \end_layout
14628
14629 \end_inset
14630
14631  will appear as
14632 \begin_inset Quotes eld
14633 \end_inset
14634
14635 Senseless!
14636 \begin_inset Quotes erd
14637 \end_inset
14638
14639 .
14640 \end_layout
14641
14642 \begin_layout Description
14643 \begin_inset Flex Code
14644 status collapsed
14645
14646 \begin_layout Plain Layout
14647 Enumerate
14648 \end_layout
14649
14650 \end_inset
14651
14652  produces the usual sort of enumeration labels.
14653  The number type needs to be set in the
14654 \family sans
14655 Counter
14656 \family default
14657 , see
14658 \begin_inset CommandInset ref
14659 LatexCommand ref
14660 reference "subsec:Counters"
14661
14662 \end_inset
14663
14664 .
14665 \end_layout
14666
14667 \begin_layout Description
14668 \begin_inset Flex Code
14669 status collapsed
14670
14671 \begin_layout Plain Layout
14672 Itemize
14673 \end_layout
14674
14675 \end_inset
14676
14677  produces various bullets at the different levels.
14678  The bullet types displayed can be set via
14679 \begin_inset Flex Noun
14680 status collapsed
14681
14682 \begin_layout Plain Layout
14683 Document\SpecialChar menuseparator
14684 Settings\SpecialChar menuseparator
14685 Bullets
14686 \end_layout
14687
14688 \end_inset
14689
14690 .
14691 \end_layout
14692
14693 \begin_layout Description
14694 \begin_inset Flex Code
14695 status collapsed
14696
14697 \begin_layout Plain Layout
14698 Bibliography
14699 \end_layout
14700
14701 \end_inset
14702
14703  should be used only with
14704 \begin_inset Flex Code
14705 status collapsed
14706
14707 \begin_layout Plain Layout
14708 LatexType BibEnvironment
14709 \end_layout
14710
14711 \end_inset
14712
14713 .
14714 \end_layout
14715
14716 \end_deeper
14717 \begin_layout Description
14718 \begin_inset Flex Code
14719 status collapsed
14720
14721 \begin_layout Plain Layout
14722 LangPreamble
14723 \end_layout
14724
14725 \end_inset
14726
14727  Note that this will completely override any prior
14728 \begin_inset Flex Code
14729 status collapsed
14730
14731 \begin_layout Plain Layout
14732 LangPreamble
14733 \end_layout
14734
14735 \end_inset
14736
14737  declaration for this style.
14738  Must end with
14739 \begin_inset Quotes eld
14740 \end_inset
14741
14742
14743 \begin_inset Flex Code
14744 status collapsed
14745
14746 \begin_layout Plain Layout
14747 EndLangPreamble
14748 \end_layout
14749
14750 \end_inset
14751
14752
14753 \begin_inset Quotes erd
14754 \end_inset
14755
14756 .
14757  See
14758 \begin_inset CommandInset ref
14759 LatexCommand ref
14760 reference "subsec:I18n"
14761
14762 \end_inset
14763
14764  for details on its use.
14765 \end_layout
14766
14767 \begin_layout Description
14768 \begin_inset Flex Code
14769 status collapsed
14770
14771 \begin_layout Plain Layout
14772 LatexName
14773 \end_layout
14774
14775 \end_inset
14776
14777  [
14778 \begin_inset Flex Code
14779 status collapsed
14780
14781 \begin_layout Plain Layout
14782 <name>
14783 \end_layout
14784
14785 \end_inset
14786
14787 ] The name of the corresponding \SpecialChar LaTeX
14788  stuff.
14789  Either the environment or command name.
14790 \end_layout
14791
14792 \begin_layout Description
14793 \begin_inset Flex Code
14794 status collapsed
14795
14796 \begin_layout Plain Layout
14797 LatexParam
14798 \end_layout
14799
14800 \end_inset
14801
14802  [
14803 \begin_inset Flex Code
14804 status collapsed
14805
14806 \begin_layout Plain Layout
14807 <parameter>
14808 \end_layout
14809
14810 \end_inset
14811
14812 ] An optional parameter for the corresponding
14813 \begin_inset Flex Code
14814 status collapsed
14815
14816 \begin_layout Plain Layout
14817 LatexName
14818 \end_layout
14819
14820 \end_inset
14821
14822  stuff.
14823  This parameter cannot be changed from within \SpecialChar LyX
14824  (use
14825 \begin_inset Flex Code
14826 status collapsed
14827
14828 \begin_layout Plain Layout
14829 Argument
14830 \end_layout
14831
14832 \end_inset
14833
14834  for customizable parameters).
14835  This will be output as is after all \SpecialChar LaTeX
14836
14837 \begin_inset Flex Code
14838 status collapsed
14839
14840 \begin_layout Plain Layout
14841 Argument
14842 \end_layout
14843
14844 \end_inset
14845
14846 s.
14847 \end_layout
14848
14849 \begin_layout Description
14850 \begin_inset Flex Code
14851 status collapsed
14852
14853 \begin_layout Plain Layout
14854 LatexType
14855 \end_layout
14856
14857 \end_inset
14858
14859  [
14860 \begin_inset Flex Code
14861 status collapsed
14862
14863 \begin_layout Plain Layout
14864
14865 \emph on
14866 Paragraph
14867 \emph default
14868 , Command, Environment, Item_Environment,
14869 \begin_inset Newline newline
14870 \end_inset
14871
14872 List_Environment, Bib_Environment
14873 \end_layout
14874
14875 \end_inset
14876
14877 ] How the style should be translated into \SpecialChar LaTeX
14878 .
14879 \begin_inset Foot
14880 status collapsed
14881
14882 \begin_layout Plain Layout
14883 \begin_inset Flex Code
14884 status collapsed
14885
14886 \begin_layout Plain Layout
14887 LatexType
14888 \end_layout
14889
14890 \end_inset
14891
14892  is perhaps a bit misleading, since these rules apply to SGML classes, too.
14893  Visit the SGML class files for specific examples.
14894 \end_layout
14895
14896 \end_inset
14897
14898
14899 \end_layout
14900
14901 \begin_deeper
14902 \begin_layout Description
14903 \begin_inset Flex Code
14904 status collapsed
14905
14906 \begin_layout Plain Layout
14907 Paragraph
14908 \end_layout
14909
14910 \end_inset
14911
14912  means nothing special.
14913 \end_layout
14914
14915 \begin_layout Description
14916 \begin_inset Flex Code
14917 status collapsed
14918
14919 \begin_layout Plain Layout
14920 Command
14921 \end_layout
14922
14923 \end_inset
14924
14925  means
14926 \begin_inset Flex Code
14927 status collapsed
14928
14929 \begin_layout Plain Layout
14930
14931 \backslash
14932
14933 \emph on
14934 LatexName
14935 \emph default
14936 {\SpecialChar ldots
14937 }
14938 \end_layout
14939
14940 \end_inset
14941
14942 .
14943 \end_layout
14944
14945 \begin_layout Description
14946 \begin_inset Flex Code
14947 status collapsed
14948
14949 \begin_layout Plain Layout
14950 Environment
14951 \end_layout
14952
14953 \end_inset
14954
14955  means
14956 \begin_inset Flex Code
14957 status collapsed
14958
14959 \begin_layout Plain Layout
14960
14961 \backslash
14962 begin{
14963 \emph on
14964 LatexName
14965 \emph default
14966 }\SpecialChar ldots
14967
14968 \backslash
14969 end{
14970 \emph on
14971 LatexName
14972 \emph default
14973 }
14974 \end_layout
14975
14976 \end_inset
14977
14978 .
14979
14980 \end_layout
14981
14982 \begin_layout Description
14983 \begin_inset Flex Code
14984 status collapsed
14985
14986 \begin_layout Plain Layout
14987 Item_Environment
14988 \end_layout
14989
14990 \end_inset
14991
14992  is the same as
14993 \begin_inset Flex Code
14994 status collapsed
14995
14996 \begin_layout Plain Layout
14997 Environment
14998 \end_layout
14999
15000 \end_inset
15001
15002 , except that an
15003 \begin_inset Flex Code
15004 status collapsed
15005
15006 \begin_layout Plain Layout
15007
15008 \backslash
15009 item
15010 \end_layout
15011
15012 \end_inset
15013
15014  is generated for each paragraph of this environment.
15015
15016 \end_layout
15017
15018 \begin_layout Description
15019 \begin_inset Flex Code
15020 status collapsed
15021
15022 \begin_layout Plain Layout
15023 List_Environment
15024 \end_layout
15025
15026 \end_inset
15027
15028  is the same as
15029 \begin_inset Flex Code
15030 status collapsed
15031
15032 \begin_layout Plain Layout
15033 Item_Environment
15034 \end_layout
15035
15036 \end_inset
15037
15038 , except that
15039 \begin_inset Newline newline
15040 \end_inset
15041
15042
15043 \begin_inset Flex Code
15044 status collapsed
15045
15046 \begin_layout Plain Layout
15047 LabelWidthString
15048 \end_layout
15049
15050 \end_inset
15051
15052  is passed as an argument to the environment.
15053 \begin_inset Newline newline
15054 \end_inset
15055
15056
15057 \begin_inset Flex Code
15058 status collapsed
15059
15060 \begin_layout Plain Layout
15061 LabelWidthString
15062 \end_layout
15063
15064 \end_inset
15065
15066  can be defined in the
15067 \begin_inset Flex Noun
15068 status collapsed
15069
15070 \begin_layout Plain Layout
15071 Edit\SpecialChar menuseparator
15072 Paragraph
15073 \begin_inset space ~
15074 \end_inset
15075
15076 settings
15077 \end_layout
15078
15079 \end_inset
15080
15081  dialog.
15082 \end_layout
15083
15084 \begin_layout Description
15085 \begin_inset Flex Code
15086 status collapsed
15087
15088 \begin_layout Plain Layout
15089 Bib_Environment
15090 \end_layout
15091
15092 \end_inset
15093
15094  is like
15095 \begin_inset Flex Code
15096 status collapsed
15097
15098 \begin_layout Plain Layout
15099 Environment
15100 \end_layout
15101
15102 \end_inset
15103
15104  but adds the necessary mandatory argument (the longest label) to the begin
15105  statement of the bibliography environment:
15106 \begin_inset Newline newline
15107 \end_inset
15108
15109
15110 \begin_inset Flex Code
15111 status collapsed
15112
15113 \begin_layout Plain Layout
15114
15115 \backslash
15116 begin{thebibliography}{99}
15117 \end_layout
15118
15119 \end_inset
15120
15121 .
15122  It is therefore only useful for bibliography environments.
15123  The default longest label
15124 \begin_inset Quotes eld
15125 \end_inset
15126
15127 99
15128 \begin_inset Quotes erd
15129 \end_inset
15130
15131  can be changed by the user in the paragraph settings of a bibliography
15132  item.
15133 \end_layout
15134
15135 \begin_layout Standard
15136 Putting the last few things together, the \SpecialChar LaTeX
15137  output will be either:
15138 \end_layout
15139
15140 \begin_layout LyX-Code
15141
15142 \backslash
15143 LatexName[LatexParam]{\SpecialChar ldots
15144 }
15145 \end_layout
15146
15147 \begin_layout Standard
15148 or:
15149 \end_layout
15150
15151 \begin_layout LyX-Code
15152
15153 \backslash
15154 begin{LatexName}[LatexParam] \SpecialChar ldots
15155
15156 \backslash
15157 end{LatexName}.
15158 \end_layout
15159
15160 \begin_layout Standard
15161 depending upon the \SpecialChar LaTeX
15162  type.
15163 \end_layout
15164
15165 \end_deeper
15166 \begin_layout Description
15167 \begin_inset Flex Code
15168 status collapsed
15169
15170 \begin_layout Plain Layout
15171 LeftDelim
15172 \end_layout
15173
15174 \end_inset
15175
15176  [
15177 \begin_inset Flex Code
15178 status collapsed
15179
15180 \begin_layout Plain Layout
15181 string
15182 \end_layout
15183
15184 \end_inset
15185
15186 ] A string that is put at the beginning of the style content.
15187  A line break in the output can be indicated by
15188 \begin_inset Flex Code
15189 status collapsed
15190
15191 \begin_layout Plain Layout
15192 <br/>
15193 \end_layout
15194
15195 \end_inset
15196
15197 .
15198 \end_layout
15199
15200 \begin_layout Description
15201 \begin_inset Flex Code
15202 status collapsed
15203
15204 \begin_layout Plain Layout
15205 LeftMargin
15206 \end_layout
15207
15208 \end_inset
15209
15210  [
15211 \begin_inset Flex Code
15212 status collapsed
15213
15214 \begin_layout Plain Layout
15215 string=""
15216 \end_layout
15217
15218 \end_inset
15219
15220 ] If you put styles into environments, the different
15221 \begin_inset Flex Code
15222 status collapsed
15223
15224 \begin_layout Plain Layout
15225 LeftMargin
15226 \end_layout
15227
15228 \end_inset
15229
15230  are not simply added, but added with a factor
15231 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
15232 \end_inset
15233
15234 .
15235  Note that this parameter is also used when
15236 \begin_inset Flex Code
15237 status collapsed
15238
15239 \begin_layout Plain Layout
15240 Margin
15241 \end_layout
15242
15243 \end_inset
15244
15245  is defined as
15246 \begin_inset Flex Code
15247 status collapsed
15248
15249 \begin_layout Plain Layout
15250 Manual
15251 \end_layout
15252
15253 \end_inset
15254
15255  or
15256 \begin_inset Flex Code
15257 status collapsed
15258
15259 \begin_layout Plain Layout
15260 Dynamic
15261 \end_layout
15262
15263 \end_inset
15264
15265 .
15266  Then it is added to the manual or dynamic margin.
15267 \begin_inset Newline newline
15268 \end_inset
15269
15270 For example
15271 \begin_inset Quotes eld
15272 \end_inset
15273
15274
15275 \begin_inset Flex Code
15276 status collapsed
15277
15278 \begin_layout Plain Layout
15279 MM
15280 \end_layout
15281
15282 \end_inset
15283
15284
15285 \begin_inset Quotes erd
15286 \end_inset
15287
15288  means that the paragraph is indented with the width of
15289 \begin_inset Quotes eld
15290 \end_inset
15291
15292
15293 \begin_inset Flex Code
15294 status collapsed
15295
15296 \begin_layout Plain Layout
15297 MM
15298 \end_layout
15299
15300 \end_inset
15301
15302
15303 \begin_inset Quotes erd
15304 \end_inset
15305
15306  in the normal font.
15307  You can get a negative width by prefixing the string with
15308 \begin_inset Quotes eld
15309 \end_inset
15310
15311
15312 \begin_inset Flex Code
15313 status collapsed
15314
15315 \begin_layout Plain Layout
15316 -
15317 \end_layout
15318
15319 \end_inset
15320
15321
15322 \begin_inset Quotes erd
15323 \end_inset
15324
15325 .
15326  This way was chosen so that the look is the same with each used screen
15327  font.
15328 \end_layout
15329
15330 \begin_layout Description
15331 \begin_inset Flex Code
15332 status collapsed
15333
15334 \begin_layout Plain Layout
15335 Margin
15336 \end_layout
15337
15338 \end_inset
15339
15340  [
15341 \begin_inset Flex Code
15342 status collapsed
15343
15344 \begin_layout Plain Layout
15345
15346 \emph on
15347 Static
15348 \emph default
15349 , Manual, Dynamic, First_Dynamic, Right_Address_Box
15350 \end_layout
15351
15352 \end_inset
15353
15354 ]
15355 \begin_inset Newline newline
15356 \end_inset
15357
15358 The kind of margin that the style has on the left side.
15359 \end_layout
15360
15361 \begin_deeper
15362 \begin_layout Description
15363 \begin_inset Flex Code
15364 status collapsed
15365
15366 \begin_layout Plain Layout
15367 Static
15368 \end_layout
15369
15370 \end_inset
15371
15372  just means a fixed margin.
15373 \end_layout
15374
15375 \begin_layout Description
15376 \begin_inset Flex Code
15377 status collapsed
15378
15379 \begin_layout Plain Layout
15380 Manual
15381 \end_layout
15382
15383 \end_inset
15384
15385  means that the left margin depends on the string entered in the
15386 \begin_inset Flex Noun
15387 status collapsed
15388
15389 \begin_layout Plain Layout
15390 Edit\SpecialChar menuseparator
15391 Paragraph
15392 \begin_inset space ~
15393 \end_inset
15394
15395 Settings
15396 \end_layout
15397
15398 \end_inset
15399
15400  dialog.
15401  This is used to typeset nice lists without tabulators.
15402 \end_layout
15403
15404 \begin_layout Description
15405 \begin_inset Flex Code
15406 status collapsed
15407
15408 \begin_layout Plain Layout
15409 Dynamic
15410 \end_layout
15411
15412 \end_inset
15413
15414  means that the margin depends on the size of the label.
15415  This is used for automatic enumerated headlines.
15416  It is obvious that the headline
15417 \begin_inset Quotes eld
15418 \end_inset
15419
15420 5.4.3.2.1 Very long headline
15421 \begin_inset Quotes erd
15422 \end_inset
15423
15424  must have a wider left margin (as wide as
15425 \begin_inset Quotes eld
15426 \end_inset
15427
15428 5.4.3.2.1
15429 \begin_inset Quotes erd
15430 \end_inset
15431
15432  plus the space) than
15433 \begin_inset Quotes eld
15434 \end_inset
15435
15436 3.2 Very long headline
15437 \begin_inset Quotes erd
15438 \end_inset
15439
15440 , even if standard
15441 \begin_inset Quotes eld
15442 \end_inset
15443
15444 word processors
15445 \begin_inset Quotes erd
15446 \end_inset
15447
15448  are not able to do this.
15449 \end_layout
15450
15451 \begin_layout Description
15452 \begin_inset Flex Code
15453 status collapsed
15454
15455 \begin_layout Plain Layout
15456 First_Dynamic
15457 \end_layout
15458
15459 \end_inset
15460
15461  is similar, but only the very first row of the paragraph is dynamic, while
15462  the others are static; this is used, for example, for descriptions.
15463 \end_layout
15464
15465 \begin_layout Description
15466 \begin_inset Flex Code
15467 status collapsed
15468
15469 \begin_layout Plain Layout
15470 Right_Address_Box
15471 \end_layout
15472
15473 \end_inset
15474
15475  means the margin is chosen in a way that the longest row of this paragraph
15476  fits to the right margin.
15477  This is used to typeset an address on the right edge of the page.
15478 \end_layout
15479
15480 \end_deeper
15481 \begin_layout Description
15482 \begin_inset Flex Code
15483 status collapsed
15484
15485 \begin_layout Plain Layout
15486 NeedProtect
15487 \end_layout
15488
15489 \end_inset
15490
15491  [
15492 \begin_inset Flex Code
15493 status collapsed
15494
15495 \begin_layout Plain Layout
15496
15497 \emph on
15498 0
15499 \end_layout
15500
15501 \end_inset
15502
15503 ,
15504 \begin_inset space \thinspace{}
15505 \end_inset
15506
15507
15508 \begin_inset Flex Code
15509 status collapsed
15510
15511 \begin_layout Plain Layout
15512 1
15513 \end_layout
15514
15515 \end_inset
15516
15517 ] Whether fragile commands in this style should be
15518 \begin_inset Flex Code
15519 status collapsed
15520
15521 \begin_layout Plain Layout
15522
15523 \backslash
15524 protect
15525 \end_layout
15526
15527 \end_inset
15528
15529 'ed.
15530  (Note: This is
15531 \emph on
15532 not
15533 \emph default
15534  whether this command should itself be protected.)
15535 \change_inserted -712698321 1523696949
15536
15537 \end_layout
15538
15539 \begin_layout Description
15540
15541 \change_inserted -712698321 1552395557
15542 \begin_inset Flex Code
15543 status collapsed
15544
15545 \begin_layout Plain Layout
15546
15547 \change_inserted -712698321 1523696950
15548 NeedCProtect
15549 \end_layout
15550
15551 \end_inset
15552
15553  [
15554 \begin_inset Flex Code
15555 status collapsed
15556
15557 \begin_layout Plain Layout
15558
15559 \change_inserted -712698321 1523696950
15560
15561 \emph on
15562 0
15563 \end_layout
15564
15565 \end_inset
15566
15567 ,
15568 \begin_inset space \thinspace{}
15569 \end_inset
15570
15571
15572 \begin_inset Flex Code
15573 status collapsed
15574
15575 \begin_layout Plain Layout
15576
15577 \change_inserted -712698321 1523696950
15578 1
15579 \end_layout
15580
15581 \end_inset
15582
15583 ] This causes macros that contain this layout to be protected with
15584 \begin_inset Flex Code
15585 status collapsed
15586
15587 \begin_layout Plain Layout
15588
15589 \change_inserted -712698321 1523696950
15590
15591 \backslash
15592 cprotect
15593 \end_layout
15594
15595 \end_inset
15596
15597  (cf.
15598  package
15599 \family sans
15600 cprotect
15601 \family default
15602 ) if necessary and thus allows (some) verbatim stuff in macros.
15603 \end_layout
15604
15605 \begin_layout Description
15606
15607 \change_inserted -712698321 1552395844
15608 \begin_inset Flex Code
15609 status collapsed
15610
15611 \begin_layout Plain Layout
15612
15613 \change_inserted -712698321 1552395561
15614 NeedMBoxProtect
15615 \end_layout
15616
15617 \end_inset
15618
15619  [
15620 \begin_inset Flex Code
15621 status collapsed
15622
15623 \begin_layout Plain Layout
15624
15625 \change_inserted -712698321 1552395557
15626
15627 \emph on
15628 0
15629 \end_layout
15630
15631 \end_inset
15632
15633 ,
15634 \begin_inset space \thinspace{}
15635 \end_inset
15636
15637
15638 \begin_inset Flex Code
15639 status collapsed
15640
15641 \begin_layout Plain Layout
15642
15643 \change_inserted -712698321 1552395557
15644 1
15645 \end_layout
15646
15647 \end_inset
15648
15649 ] Whether specific commands in this style (such as
15650 \begin_inset Flex Code
15651 status collapsed
15652
15653 \begin_layout Plain Layout
15654
15655 \change_inserted -712698321 1552395655
15656
15657 \backslash
15658 cite
15659 \change_unchanged
15660
15661 \end_layout
15662
15663 \end_inset
15664
15665  and
15666 \begin_inset Flex Code
15667 status collapsed
15668
15669 \begin_layout Plain Layout
15670
15671 \change_inserted -712698321 1552395661
15672
15673 \backslash
15674 ref
15675 \change_unchanged
15676
15677 \end_layout
15678
15679 \end_inset
15680
15681 ) should be protected in an
15682 \begin_inset Flex Code
15683 status collapsed
15684
15685 \begin_layout Plain Layout
15686
15687 \change_inserted -712698321 1552395631
15688
15689 \backslash
15690 mbox
15691 \change_unchanged
15692
15693 \end_layout
15694
15695 \end_inset
15696
15697 .
15698  This is particularly needed for styles that draw on
15699 \family sans
15700 ulem
15701 \family default
15702  or
15703 \family sans
15704 soul
15705 \family default
15706  commands which parse their content in complex ways.
15707 \change_unchanged
15708
15709 \end_layout
15710
15711 \begin_layout Description
15712 \begin_inset Flex Code
15713 status collapsed
15714
15715 \begin_layout Plain Layout
15716 Newline
15717 \end_layout
15718
15719 \end_inset
15720
15721  [
15722 \begin_inset Flex Code
15723 status collapsed
15724
15725 \begin_layout Plain Layout
15726 0
15727 \end_layout
15728
15729 \end_inset
15730
15731 ,
15732 \begin_inset space \thinspace{}
15733 \end_inset
15734
15735
15736 \begin_inset Flex Code
15737 status collapsed
15738
15739 \begin_layout Plain Layout
15740
15741 \emph on
15742 1
15743 \end_layout
15744
15745 \end_inset
15746
15747 ] Whether newlines are translated into \SpecialChar LaTeX
15748  newlines (
15749 \begin_inset Flex Code
15750 status collapsed
15751
15752 \begin_layout Plain Layout
15753
15754 \backslash
15755
15756 \backslash
15757
15758 \end_layout
15759
15760 \end_inset
15761
15762 ) or not.
15763  The translation can be switched off to allow more comfortable \SpecialChar LaTeX
15764  editing
15765  inside \SpecialChar LyX
15766 .
15767 \end_layout
15768
15769 \begin_layout Description
15770 \begin_inset Flex Code
15771 status collapsed
15772
15773 \begin_layout Plain Layout
15774 NextNoIndent
15775 \end_layout
15776
15777 \end_inset
15778
15779  [
15780 \begin_inset Flex Code
15781 status collapsed
15782
15783 \begin_layout Plain Layout
15784
15785 \emph on
15786 0
15787 \end_layout
15788
15789 \end_inset
15790
15791 ,
15792 \begin_inset space \thinspace{}
15793 \end_inset
15794
15795
15796 \begin_inset Flex Code
15797 status collapsed
15798
15799 \begin_layout Plain Layout
15800 1
15801 \end_layout
15802
15803 \end_inset
15804
15805 ] If set to true, and if
15806 \begin_inset Flex Code
15807 status collapsed
15808
15809 \begin_layout Plain Layout
15810 DefaultStyle
15811 \end_layout
15812
15813 \end_inset
15814
15815  (usually
15816 \begin_inset Flex Code
15817 status collapsed
15818
15819 \begin_layout Plain Layout
15820 Standard
15821 \end_layout
15822
15823 \end_inset
15824
15825 ) paragraphs are being indented, then the indentation of such a paragraph
15826  following one of this type will be suppressed.
15827  (So this will not affect the display of non-default paragraphs.)
15828 \end_layout
15829
15830 \begin_layout Description
15831 \begin_inset Flex Code
15832 status collapsed
15833
15834 \begin_layout Plain Layout
15835 ObsoletedBy
15836 \end_layout
15837
15838 \end_inset
15839
15840  [
15841 \begin_inset Flex Code
15842 status collapsed
15843
15844 \begin_layout Plain Layout
15845 <name>
15846 \end_layout
15847
15848 \end_inset
15849
15850 ] Name of a style that has replaced this style.
15851  This is used to rename a style, while keeping backward compatibility.
15852 \end_layout
15853
15854 \begin_layout Description
15855 \begin_inset Flex Code
15856 status collapsed
15857
15858 \begin_layout Plain Layout
15859 ParagraphGroup
15860 \end_layout
15861
15862 \end_inset
15863
15864  [
15865 \begin_inset Flex Code
15866 status collapsed
15867
15868 \begin_layout Plain Layout
15869 0
15870 \end_layout
15871
15872 \end_inset
15873
15874 ,
15875 \begin_inset space \thinspace{}
15876 \end_inset
15877
15878
15879 \begin_inset Flex Code
15880 status collapsed
15881
15882 \begin_layout Plain Layout
15883 1
15884 \end_layout
15885
15886 \end_inset
15887
15888 ] Determines whether consecutive paragraphs of the same type are treated
15889  as belonging together.
15890  This has the effect that the
15891 \begin_inset Flex Code
15892 status collapsed
15893
15894 \begin_layout Plain Layout
15895 GuiLabel
15896 \end_layout
15897
15898 \end_inset
15899
15900  is only printed once before such a group.
15901  By default, this is true for
15902 \begin_inset Flex Code
15903 status collapsed
15904
15905 \begin_layout Plain Layout
15906 LaTeXType
15907 \end_layout
15908
15909 \end_inset
15910
15911
15912 \begin_inset Flex Code
15913 status collapsed
15914
15915 \begin_layout Plain Layout
15916 Environment
15917 \end_layout
15918
15919 \end_inset
15920
15921  and
15922 \begin_inset Flex Code
15923 status collapsed
15924
15925 \begin_layout Plain Layout
15926 Bib_Environment
15927 \end_layout
15928
15929 \end_inset
15930
15931  and false for all other types.
15932 \end_layout
15933
15934 \begin_layout Description
15935 \begin_inset Flex Code
15936 status collapsed
15937
15938 \begin_layout Plain Layout
15939 ParbreakIsNewline
15940 \end_layout
15941
15942 \end_inset
15943
15944  [
15945 \begin_inset Flex Code
15946 status collapsed
15947
15948 \begin_layout Plain Layout
15949
15950 \emph on
15951 0
15952 \end_layout
15953
15954 \end_inset
15955
15956 ,
15957 \begin_inset space \thinspace{}
15958 \end_inset
15959
15960
15961 \begin_inset Flex Code
15962 status collapsed
15963
15964 \begin_layout Plain Layout
15965 1
15966 \end_layout
15967
15968 \end_inset
15969
15970 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
15971  output,
15972  but only by a line break; together with
15973 \begin_inset Flex Code
15974 status collapsed
15975
15976 \begin_layout Plain Layout
15977 PassThru 1
15978 \end_layout
15979
15980 \end_inset
15981
15982 , this allows to emulate a plain text editor (like the ERT inset).
15983 \end_layout
15984
15985 \begin_layout Description
15986 \begin_inset Flex Code
15987 status collapsed
15988
15989 \begin_layout Plain Layout
15990 ParIndent
15991 \end_layout
15992
15993 \end_inset
15994
15995  [
15996 \begin_inset Flex Code
15997 status collapsed
15998
15999 \begin_layout Plain Layout
16000 string=""
16001 \end_layout
16002
16003 \end_inset
16004
16005 ] The indent of the very first line of a paragraph.
16006  The
16007 \begin_inset Newline newline
16008 \end_inset
16009
16010
16011 \begin_inset Flex Code
16012 status collapsed
16013
16014 \begin_layout Plain Layout
16015 Parindent
16016 \end_layout
16017
16018 \end_inset
16019
16020  will be fixed for a certain style.
16021  The exception is the default style, since the indentation for these paragraphs
16022  can be prohibited with
16023 \begin_inset Flex Code
16024 status collapsed
16025
16026 \begin_layout Plain Layout
16027 NextNoIndent
16028 \end_layout
16029
16030 \end_inset
16031
16032 .
16033  Also,
16034 \begin_inset Flex Code
16035 status collapsed
16036
16037 \begin_layout Plain Layout
16038 Standard
16039 \end_layout
16040
16041 \end_inset
16042
16043  style paragraphs inside environments use the
16044 \begin_inset Flex Code
16045 status collapsed
16046
16047 \begin_layout Plain Layout
16048 Parindent
16049 \end_layout
16050
16051 \end_inset
16052
16053  of the environment, not their native one.
16054  For example,
16055 \begin_inset Flex Code
16056 status collapsed
16057
16058 \begin_layout Plain Layout
16059 Standard
16060 \end_layout
16061
16062 \end_inset
16063
16064  paragraphs inside an enumeration are not indented.
16065 \end_layout
16066
16067 \begin_layout Description
16068 \begin_inset Flex Code
16069 status collapsed
16070
16071 \begin_layout Plain Layout
16072 ParSep
16073 \end_layout
16074
16075 \end_inset
16076
16077  [
16078 \begin_inset Flex Code
16079 status collapsed
16080
16081 \begin_layout Plain Layout
16082 float=0
16083 \end_layout
16084
16085 \end_inset
16086
16087 ] The vertical space between two paragraphs of this style.
16088 \end_layout
16089
16090 \begin_layout Description
16091 \begin_inset Flex Code
16092 status collapsed
16093
16094 \begin_layout Plain Layout
16095 Parskip
16096 \end_layout
16097
16098 \end_inset
16099
16100  [
16101 \begin_inset Flex Code
16102 status collapsed
16103
16104 \begin_layout Plain Layout
16105 float=0
16106 \end_layout
16107
16108 \end_inset
16109
16110 ] \SpecialChar LyX
16111  allows the user to choose either
16112 \begin_inset Quotes eld
16113 \end_inset
16114
16115 indent
16116 \begin_inset Quotes erd
16117 \end_inset
16118
16119  or
16120 \begin_inset Quotes eld
16121 \end_inset
16122
16123 skip
16124 \begin_inset Quotes erd
16125 \end_inset
16126
16127  to separate paragraphs.
16128  When
16129 \begin_inset Quotes eld
16130 \end_inset
16131
16132 indent
16133 \begin_inset Quotes erd
16134 \end_inset
16135
16136  is chosen,
16137 \begin_inset Flex Code
16138 status collapsed
16139
16140 \begin_layout Plain Layout
16141 Parskip
16142 \end_layout
16143
16144 \end_inset
16145
16146  is ignored.
16147  When
16148 \begin_inset Quotes eld
16149 \end_inset
16150
16151 skip
16152 \begin_inset Quotes erd
16153 \end_inset
16154
16155  is chosen,
16156 \begin_inset Flex Code
16157 status collapsed
16158
16159 \begin_layout Plain Layout
16160 ParIndent
16161 \end_layout
16162
16163 \end_inset
16164
16165  is ignored and all paragraphs are separated by the
16166 \begin_inset Flex Code
16167 status collapsed
16168
16169 \begin_layout Plain Layout
16170 Parskip
16171 \end_layout
16172
16173 \end_inset
16174
16175  argument.
16176  The vertical space is calculated with
16177 \begin_inset Flex Code
16178 status collapsed
16179
16180 \begin_layout Plain Layout
16181 Parskip
16182 \begin_inset space ~
16183 \end_inset
16184
16185 * DefaultHeight
16186 \end_layout
16187
16188 \end_inset
16189
16190  where
16191 \begin_inset Flex Code
16192 status collapsed
16193
16194 \begin_layout Plain Layout
16195 DefaultHeight
16196 \end_layout
16197
16198 \end_inset
16199
16200  is the height of a row with the normal font.
16201  This way, the look stays the same with different screen fonts.
16202 \end_layout
16203
16204 \begin_layout Description
16205 \begin_inset Flex Code
16206 status collapsed
16207
16208 \begin_layout Plain Layout
16209 PassThru
16210 \end_layout
16211
16212 \end_inset
16213
16214  [
16215 \begin_inset Flex Code
16216 status collapsed
16217
16218 \begin_layout Plain Layout
16219
16220 \emph on
16221 0
16222 \end_layout
16223
16224 \end_inset
16225
16226 ,
16227 \begin_inset space \thinspace{}
16228 \end_inset
16229
16230
16231 \begin_inset Flex Code
16232 status collapsed
16233
16234 \begin_layout Plain Layout
16235 1
16236 \end_layout
16237
16238 \end_inset
16239
16240 ] Whether the contents of this paragraph should be output in raw form, meaning
16241  without special translations that \SpecialChar LaTeX
16242  would require.
16243 \end_layout
16244
16245 \begin_layout Description
16246 \begin_inset Flex Code
16247 status collapsed
16248
16249 \begin_layout Plain Layout
16250 PassThruChars
16251 \end_layout
16252
16253 \end_inset
16254
16255  [
16256 \begin_inset Flex Code
16257 status collapsed
16258
16259 \begin_layout Plain Layout
16260 string
16261 \end_layout
16262
16263 \end_inset
16264
16265 ]
16266 \family typewriter
16267
16268 \family default
16269 Defines individual characters that should be output in raw form, meaning
16270  without special translations that \SpecialChar LaTeX
16271  would require.
16272 \end_layout
16273
16274 \begin_layout Description
16275 \begin_inset Flex Code
16276 status collapsed
16277
16278 \begin_layout Plain Layout
16279 Preamble
16280 \end_layout
16281
16282 \end_inset
16283
16284  Information to be included in the \SpecialChar LaTeX
16285  preamble when this style is used.
16286  Used to define macros, load packages, etc., required by this particular
16287  style.
16288  Must end with
16289 \begin_inset Quotes eld
16290 \end_inset
16291
16292
16293 \begin_inset Flex Code
16294 status collapsed
16295
16296 \begin_layout Plain Layout
16297 EndPreamble
16298 \end_layout
16299
16300 \end_inset
16301
16302
16303 \begin_inset Quotes erd
16304 \end_inset
16305
16306 .
16307 \end_layout
16308
16309 \begin_layout Description
16310 \begin_inset Flex Code
16311 status collapsed
16312
16313 \begin_layout Plain Layout
16314 RefPrefix
16315 \end_layout
16316
16317 \end_inset
16318
16319  [
16320 \begin_inset Flex Code
16321 status collapsed
16322
16323 \begin_layout Plain Layout
16324 string
16325 \end_layout
16326
16327 \end_inset
16328
16329 ] The prefix to use when creating labels referring to paragraphs of this
16330  type.
16331  This allows the use of formatted references.
16332 \end_layout
16333
16334 \begin_layout Description
16335 \begin_inset Flex Code
16336 status collapsed
16337
16338 \begin_layout Plain Layout
16339 Requires
16340 \end_layout
16341
16342 \end_inset
16343
16344  [
16345 \begin_inset Flex Code
16346 status collapsed
16347
16348 \begin_layout Plain Layout
16349 string
16350 \end_layout
16351
16352 \end_inset
16353
16354 ] Whether the style requires the feature
16355 \begin_inset Flex Code
16356 status collapsed
16357
16358 \begin_layout Plain Layout
16359 string
16360 \end_layout
16361
16362 \end_inset
16363
16364  (see
16365 \begin_inset CommandInset ref
16366 LatexCommand ref
16367 reference "chap:List-of-functions"
16368
16369 \end_inset
16370
16371  for the list of features).
16372  If you require a package with specific options, you can additionally use
16373
16374 \begin_inset Flex Code
16375 status collapsed
16376
16377 \begin_layout Plain Layout
16378 PackageOptions
16379 \end_layout
16380
16381 \end_inset
16382
16383  as a general text class parameter (see
16384 \begin_inset CommandInset ref
16385 LatexCommand ref
16386 reference "subsec:General-text-class"
16387
16388 \end_inset
16389
16390 ).
16391 \end_layout
16392
16393 \begin_layout Description
16394 \begin_inset Flex Code
16395 status collapsed
16396
16397 \begin_layout Plain Layout
16398 ResetArgs
16399 \end_layout
16400
16401 \end_inset
16402
16403  [
16404 \begin_inset Flex Code
16405 status collapsed
16406
16407 \begin_layout Plain Layout
16408
16409 \emph on
16410 0
16411 \end_layout
16412
16413 \end_inset
16414
16415 ,
16416 \begin_inset Flex Code
16417 status collapsed
16418
16419 \begin_layout Plain Layout
16420 1
16421 \end_layout
16422
16423 \end_inset
16424
16425 ] Resets the \SpecialChar LaTeX
16426  arguments of this style (as defined via the
16427 \begin_inset Flex Code
16428 status collapsed
16429
16430 \begin_layout Plain Layout
16431 Argument
16432 \end_layout
16433
16434 \end_inset
16435
16436  tag).
16437  This is useful if you have copied a style via
16438 \begin_inset Flex Code
16439 status collapsed
16440
16441 \begin_layout Plain Layout
16442 CopyStyle
16443 \end_layout
16444
16445 \end_inset
16446
16447 , but you do not want to inherit its (required and optional) arguments.
16448 \end_layout
16449
16450 \begin_layout Description
16451 \begin_inset Flex Code
16452 status collapsed
16453
16454 \begin_layout Plain Layout
16455 ResumeCounter
16456 \end_layout
16457
16458 \end_inset
16459
16460  [
16461 \begin_inset Flex Code
16462 status collapsed
16463
16464 \begin_layout Plain Layout
16465
16466 \emph on
16467 0
16468 \end_layout
16469
16470 \end_inset
16471
16472 ,
16473 \begin_inset Flex Code
16474 status collapsed
16475
16476 \begin_layout Plain Layout
16477 1
16478 \end_layout
16479
16480 \end_inset
16481
16482 ] Resumes a counter that is usually reset at each new sequence of layouts.
16483  This is currently only useful when
16484 \begin_inset Flex Code
16485 status collapsed
16486
16487 \begin_layout Plain Layout
16488 LabelType
16489 \end_layout
16490
16491 \end_inset
16492
16493  is
16494 \begin_inset Flex Code
16495 status collapsed
16496
16497 \begin_layout Plain Layout
16498 Enumerate
16499 \end_layout
16500
16501 \end_inset
16502
16503 .
16504 \end_layout
16505
16506 \begin_layout Description
16507 \begin_inset Flex Code
16508 status collapsed
16509
16510 \begin_layout Plain Layout
16511 RightDelim
16512 \end_layout
16513
16514 \end_inset
16515
16516  [
16517 \begin_inset Flex Code
16518 status collapsed
16519
16520 \begin_layout Plain Layout
16521 string
16522 \end_layout
16523
16524 \end_inset
16525
16526 ] A string that is put at the end of the layout content.
16527  A line break in the output can be indicated by
16528 \begin_inset Flex Code
16529 status collapsed
16530
16531 \begin_layout Plain Layout
16532 <br/>
16533 \end_layout
16534
16535 \end_inset
16536
16537 .
16538 \end_layout
16539
16540 \begin_layout Description
16541 \begin_inset Flex Code
16542 status collapsed
16543
16544 \begin_layout Plain Layout
16545 RightMargin
16546 \end_layout
16547
16548 \end_inset
16549
16550  [
16551 \begin_inset Flex Code
16552 status collapsed
16553
16554 \begin_layout Plain Layout
16555 string=""
16556 \end_layout
16557
16558 \end_inset
16559
16560 ] Similar to
16561 \begin_inset Flex Code
16562 status collapsed
16563
16564 \begin_layout Plain Layout
16565 LeftMargin
16566 \end_layout
16567
16568 \end_inset
16569
16570 .
16571 \end_layout
16572
16573 \begin_layout Description
16574 \begin_inset Flex Code
16575 status collapsed
16576
16577 \begin_layout Plain Layout
16578 Spacing
16579 \end_layout
16580
16581 \end_inset
16582
16583  [
16584 \begin_inset Flex Code
16585 status collapsed
16586
16587 \begin_layout Plain Layout
16588
16589 \emph on
16590 single
16591 \end_layout
16592
16593 \end_inset
16594
16595 ,
16596 \begin_inset Flex Code
16597 status collapsed
16598
16599 \begin_layout Plain Layout
16600 onehalf
16601 \end_layout
16602
16603 \end_inset
16604
16605 ,
16606 \begin_inset Flex Code
16607 status collapsed
16608
16609 \begin_layout Plain Layout
16610 double
16611 \end_layout
16612
16613 \end_inset
16614
16615 ,
16616 \begin_inset Flex Code
16617 status collapsed
16618
16619 \begin_layout Plain Layout
16620 other
16621 \begin_inset space ~
16622 \end_inset
16623
16624 <value>
16625 \end_layout
16626
16627 \end_inset
16628
16629 ] This defines what the default spacing should be in the style.
16630  The arguments
16631 \begin_inset Flex Code
16632 status collapsed
16633
16634 \begin_layout Plain Layout
16635 single
16636 \end_layout
16637
16638 \end_inset
16639
16640 ,
16641 \begin_inset Flex Code
16642 status collapsed
16643
16644 \begin_layout Plain Layout
16645 onehalf
16646 \end_layout
16647
16648 \end_inset
16649
16650  and
16651 \begin_inset Flex Code
16652 status collapsed
16653
16654 \begin_layout Plain Layout
16655 double
16656 \end_layout
16657
16658 \end_inset
16659
16660  correspond respectively to a multiplier value of 1, 1.25 and 1.667.
16661  If you specify the argument
16662 \begin_inset Flex Code
16663 status collapsed
16664
16665 \begin_layout Plain Layout
16666 other
16667 \end_layout
16668
16669 \end_inset
16670
16671 , then you must also provide a value argument which will be the actual multiplie
16672 r value.
16673  Note that, contrary to other parameters,
16674 \begin_inset Flex Code
16675 status collapsed
16676
16677 \begin_layout Plain Layout
16678 Spacing
16679 \end_layout
16680
16681 \end_inset
16682
16683  implies the generation of specific \SpecialChar LaTeX
16684  code, using the \SpecialChar LaTeX
16685  package
16686 \family roman
16687
16688 \begin_inset Flex Code
16689 status collapsed
16690
16691 \begin_layout Plain Layout
16692 setspace
16693 \end_layout
16694
16695 \end_inset
16696
16697 .
16698 \end_layout
16699
16700 \begin_layout Description
16701 \begin_inset Flex Code
16702 status collapsed
16703
16704 \begin_layout Plain Layout
16705 Spellcheck
16706 \end_layout
16707
16708 \end_inset
16709
16710  [
16711 \begin_inset Flex Code
16712 status collapsed
16713
16714 \begin_layout Plain Layout
16715 0
16716 \end_layout
16717
16718 \end_inset
16719
16720 ,
16721 \begin_inset space \thinspace{}
16722 \end_inset
16723
16724
16725 \begin_inset Flex Code
16726 status collapsed
16727
16728 \begin_layout Plain Layout
16729
16730 \emph on
16731 1
16732 \end_layout
16733
16734 \end_inset
16735
16736 ] Allow spell-checking paragraphs of this style.
16737  Default is true.
16738 \end_layout
16739
16740 \begin_layout Description
16741 \begin_inset Flex Code
16742 status collapsed
16743
16744 \begin_layout Plain Layout
16745 StepMasterCounter
16746 \end_layout
16747
16748 \end_inset
16749
16750  [
16751 \begin_inset Flex Code
16752 status collapsed
16753
16754 \begin_layout Plain Layout
16755
16756 \emph on
16757 0
16758 \end_layout
16759
16760 \end_inset
16761
16762 ,
16763 \begin_inset Flex Code
16764 status collapsed
16765
16766 \begin_layout Plain Layout
16767 1
16768 \end_layout
16769
16770 \end_inset
16771
16772 ] Steps the master counter of a given counter at the beginning of a new
16773  sequence of layouts.
16774  This is currently only useful when
16775 \begin_inset Flex Code
16776 status collapsed
16777
16778 \begin_layout Plain Layout
16779 LabelType
16780 \end_layout
16781
16782 \end_inset
16783
16784  is
16785 \begin_inset Flex Code
16786 status collapsed
16787
16788 \begin_layout Plain Layout
16789 Enumerate
16790 \end_layout
16791
16792 \end_inset
16793
16794 .
16795 \end_layout
16796
16797 \begin_layout Description
16798 \begin_inset Flex Code
16799 status collapsed
16800
16801 \begin_layout Plain Layout
16802 TextFont
16803 \end_layout
16804
16805 \end_inset
16806
16807  The font used for the text body .
16808  See
16809 \begin_inset CommandInset ref
16810 LatexCommand ref
16811 reference "subsec:Font-description"
16812
16813 \end_inset
16814
16815 .
16816 \end_layout
16817
16818 \begin_layout Description
16819 \begin_inset Flex Code
16820 status collapsed
16821
16822 \begin_layout Plain Layout
16823 TocLevel
16824 \end_layout
16825
16826 \end_inset
16827
16828
16829 \series medium
16830  [
16831 \begin_inset Flex Code
16832 status collapsed
16833
16834 \begin_layout Plain Layout
16835
16836 \series medium
16837 int=3
16838 \end_layout
16839
16840 \end_inset
16841
16842 ]
16843 \series default
16844  The level of the style in the table of contents.
16845  This is used for automatic numbering of section headings.
16846 \end_layout
16847
16848 \begin_layout Description
16849 \begin_inset Flex Code
16850 status collapsed
16851
16852 \begin_layout Plain Layout
16853 ToggleIndent
16854 \end_layout
16855
16856 \end_inset
16857
16858  [
16859 \emph on
16860
16861 \begin_inset Flex Code
16862 status collapsed
16863
16864 \begin_layout Plain Layout
16865
16866 \emph on
16867 default
16868 \end_layout
16869
16870 \end_inset
16871
16872
16873 \emph default
16874 ,
16875 \begin_inset Flex Code
16876 status collapsed
16877
16878 \begin_layout Plain Layout
16879 always
16880 \end_layout
16881
16882 \end_inset
16883
16884 ,
16885 \begin_inset Flex Code
16886 status collapsed
16887
16888 \begin_layout Plain Layout
16889 never
16890 \end_layout
16891
16892 \end_inset
16893
16894 ] This tag determines whether the first line indentation of this paragraph
16895  can be toggled via the Paragraph settings dialog.
16896  If
16897 \emph on
16898
16899 \begin_inset Flex Code
16900 status collapsed
16901
16902 \begin_layout Plain Layout
16903
16904 \emph off
16905 default
16906 \end_layout
16907
16908 \end_inset
16909
16910
16911 \emph default
16912  is set, indentation can be toggled if the document settings use
16913 \begin_inset Quotes eld
16914 \end_inset
16915
16916 indent
16917 \begin_inset Quotes erd
16918 \end_inset
16919
16920  paragraph style, with
16921 \begin_inset Flex Code
16922 status collapsed
16923
16924 \begin_layout Plain Layout
16925 always
16926 \end_layout
16927
16928 \end_inset
16929
16930 , indentation can always be toggled, notwithstanding the document settings,
16931  with
16932 \begin_inset Flex Code
16933 status collapsed
16934
16935 \begin_layout Plain Layout
16936 never
16937 \end_layout
16938
16939 \end_inset
16940
16941 , indentation can never be toggled.
16942 \end_layout
16943
16944 \begin_layout Description
16945 \begin_inset Flex Code
16946 status collapsed
16947
16948 \begin_layout Plain Layout
16949 TopSep
16950 \end_layout
16951
16952 \end_inset
16953
16954  [
16955 \begin_inset Flex Code
16956 status collapsed
16957
16958 \begin_layout Plain Layout
16959 float=0
16960 \end_layout
16961
16962 \end_inset
16963
16964 ] The vertical space with which the very first of a chain of paragraphs
16965  with this style is separated from the previous paragraph.
16966  If the previous paragraph has another style, the separations are not simply
16967  added, but the maximum is taken.
16968 \end_layout
16969
16970 \begin_layout Subsection
16971 \begin_inset CommandInset label
16972 LatexCommand label
16973 name "subsec:I18n"
16974
16975 \end_inset
16976
16977 Internationalization of Paragraph Styles
16978 \end_layout
16979
16980 \begin_layout Standard
16981 \SpecialChar LyX
16982  has long supported internationalization of layout information, but, until
16983  version 2.0, this applied only to the user interface and not to, say, PDF
16984  output.
16985  Thus, French authors were forced to resort to ugly hacks if they wanted
16986  `
16987 \lang french
16988 Théorème
16989 \lang english
16990  1' instead of `Theorem 1'.
16991  Thanks to Georg Baum, that is no longer the case.
16992 \end_layout
16993
16994 \begin_layout Standard
16995 If a
16996 \begin_inset Flex Code
16997 status collapsed
16998
16999 \begin_layout Plain Layout
17000 Style
17001 \end_layout
17002
17003 \end_inset
17004
17005  defines text that is to appear in the typeset document, it may use
17006 \begin_inset Flex Code
17007 status collapsed
17008
17009 \begin_layout Plain Layout
17010 LangPreamble
17011 \end_layout
17012
17013 \end_inset
17014
17015  and
17016 \begin_inset Flex Code
17017 status collapsed
17018
17019 \begin_layout Plain Layout
17020 BabelPreamble
17021 \end_layout
17022
17023 \end_inset
17024
17025  to support non-English and even multi-language documents correctly.
17026  The following excerpt (from the
17027 \begin_inset Flex Code
17028 status collapsed
17029
17030 \begin_layout Plain Layout
17031 theorems-ams.inc
17032 \end_layout
17033
17034 \end_inset
17035
17036  file) shows how this works:
17037 \end_layout
17038
17039 \begin_layout LyX-Code
17040 Preamble
17041 \end_layout
17042
17043 \begin_deeper
17044 \begin_layout LyX-Code
17045
17046 \backslash
17047 theoremstyle{remark}
17048 \end_layout
17049
17050 \begin_layout LyX-Code
17051
17052 \backslash
17053 newtheorem{claim}[thm]{
17054 \backslash
17055 protect
17056 \backslash
17057 claimname}
17058 \end_layout
17059
17060 \begin_layout LyX-Code
17061 EndPreamble
17062 \end_layout
17063
17064 \begin_layout LyX-Code
17065 LangPreamble
17066 \end_layout
17067
17068 \begin_layout LyX-Code
17069
17070 \backslash
17071 providecommand{
17072 \backslash
17073 claimname}{_(Claim)}
17074 \end_layout
17075
17076 \begin_layout LyX-Code
17077 EndLangPreamble
17078 \end_layout
17079
17080 \begin_layout LyX-Code
17081 BabelPreamble
17082 \end_layout
17083
17084 \begin_layout LyX-Code
17085
17086 \backslash
17087 addto
17088 \backslash
17089 captions$$lang{
17090 \backslash
17091 renewcommand{
17092 \backslash
17093 claimname}{_(Claim)}}
17094 \end_layout
17095
17096 \begin_layout LyX-Code
17097 EndBabelPreamble
17098 \end_layout
17099
17100 \end_deeper
17101 \begin_layout Standard
17102 In principle, any legal \SpecialChar LaTeX
17103  may appear in the
17104 \begin_inset Flex Code
17105 status collapsed
17106
17107 \begin_layout Plain Layout
17108 LangPreamble
17109 \end_layout
17110
17111 \end_inset
17112
17113  and
17114 \begin_inset Flex Code
17115 status collapsed
17116
17117 \begin_layout Plain Layout
17118 BabelPreamble
17119 \end_layout
17120
17121 \end_inset
17122
17123  tags, but in practice they will typically look as they do here.
17124  The key to correct translation of the typeset text is the definition of
17125  the \SpecialChar LaTeX
17126  command
17127 \begin_inset Flex Code
17128 status collapsed
17129
17130 \begin_layout Plain Layout
17131
17132 \backslash
17133 claimname
17134 \end_layout
17135
17136 \end_inset
17137
17138  and its use in
17139 \begin_inset Flex Code
17140 status collapsed
17141
17142 \begin_layout Plain Layout
17143
17144 \backslash
17145 newtheorem
17146 \end_layout
17147
17148 \end_inset
17149
17150 .
17151
17152 \end_layout
17153
17154 \begin_layout Standard
17155 The
17156 \begin_inset Flex Code
17157 status collapsed
17158
17159 \begin_layout Plain Layout
17160 LangPreamble
17161 \end_layout
17162
17163 \end_inset
17164
17165  tag provides for internationalization based upon the overall language of
17166  the document.
17167  The contents of the tag will be included in the preamble, just as with
17168  the
17169 \begin_inset Flex Code
17170 status collapsed
17171
17172 \begin_layout Plain Layout
17173 Preamble
17174 \end_layout
17175
17176 \end_inset
17177
17178  tag.
17179  What makes it special is the use of the
17180 \begin_inset Quotes eld
17181 \end_inset
17182
17183 function
17184 \begin_inset Quotes erd
17185 \end_inset
17186
17187
17188 \begin_inset Flex Code
17189 status collapsed
17190
17191 \begin_layout Plain Layout
17192 _()
17193 \end_layout
17194
17195 \end_inset
17196
17197 , which will be replaced, when \SpecialChar LyX
17198  produces \SpecialChar LaTeX
17199  output, with the translation of
17200  its argument into the document language.
17201 \end_layout
17202
17203 \begin_layout Standard
17204 The
17205 \begin_inset Flex Code
17206 status collapsed
17207
17208 \begin_layout Plain Layout
17209 BabelPreamble
17210 \end_layout
17211
17212 \end_inset
17213
17214  tag is more complex, since it is meant to provide support for multi-language
17215  documents and so offers an interface to the
17216 \begin_inset Flex Code
17217 status collapsed
17218
17219 \begin_layout Plain Layout
17220 babel
17221 \end_layout
17222
17223 \end_inset
17224
17225  package.
17226  Its contents will be added to the preamble once for each language that
17227  appears in the document.
17228  In this case, the argument to
17229 \begin_inset Flex Code
17230 status collapsed
17231
17232 \begin_layout Plain Layout
17233 _()
17234 \end_layout
17235
17236 \end_inset
17237
17238  will be replaced with its translation into the language in question; the
17239  expression
17240 \begin_inset Flex Code
17241 status collapsed
17242
17243 \begin_layout Plain Layout
17244 $$lang
17245 \end_layout
17246
17247 \end_inset
17248
17249  is replaced by the language name (as used by the babel package).
17250 \end_layout
17251
17252 \begin_layout Standard
17253 A German document that also included a French section would thus have the
17254  following in the preamble:
17255 \end_layout
17256
17257 \begin_layout LyX-Code
17258
17259 \backslash
17260 addto
17261 \backslash
17262 captionsfrench{
17263 \backslash
17264 renewcommand{
17265 \backslash
17266 claimname}{Affirmation}}
17267 \begin_inset Newline newline
17268 \end_inset
17269
17270
17271 \backslash
17272 addto
17273 \backslash
17274 captionsngerman{
17275 \backslash
17276 renewcommand{
17277 \backslash
17278 claimname}{Behauptung}}
17279 \begin_inset Newline newline
17280 \end_inset
17281
17282
17283 \backslash
17284 providecommand{
17285 \backslash
17286 claimname}{Behauptung}
17287 \end_layout
17288
17289 \begin_layout Standard
17290 \SpecialChar LaTeX
17291  and
17292 \begin_inset Flex Code
17293 status collapsed
17294
17295 \begin_layout Plain Layout
17296 babel
17297 \end_layout
17298
17299 \end_inset
17300
17301  will then conspire to produce the correct text in the output.
17302 \end_layout
17303
17304 \begin_layout Standard
17305 One important point to note here is that the translations are provided by
17306  \SpecialChar LyX
17307  itself, through the file
17308 \begin_inset Flex Code
17309 status collapsed
17310
17311 \begin_layout Plain Layout
17312 layouttranslations
17313 \end_layout
17314
17315 \end_inset
17316
17317 .
17318  This means, in effect, that
17319 \begin_inset Flex Code
17320 status collapsed
17321
17322 \begin_layout Plain Layout
17323 LangPreamble
17324 \end_layout
17325
17326 \end_inset
17327
17328  and
17329 \begin_inset Flex Code
17330 status collapsed
17331
17332 \begin_layout Plain Layout
17333 BabelPreamble
17334 \end_layout
17335
17336 \end_inset
17337
17338  are really only of use in layout files that are provided with \SpecialChar LyX
17339 , since text
17340  entered in user-created layout files will not be seen by \SpecialChar LyX
17341 's internationalizatio
17342 n routines unless the
17343 \begin_inset Flex Code
17344 status collapsed
17345
17346 \begin_layout Plain Layout
17347 layouttranslations
17348 \end_layout
17349
17350 \end_inset
17351
17352  file is modified accordingly.
17353  That said, however, any layout created with the intention that it will
17354  be included with \SpecialChar LyX
17355  should use these tags where appropriate.
17356  Please note that the paragraph style translations provided by \SpecialChar LyX
17357  will never
17358  change with a minor update (e.
17359 \begin_inset space \thinspace{}
17360 \end_inset
17361
17362 g.
17363 \begin_inset space \space{}
17364 \end_inset
17365
17366 from version 2.1.x to 2.1.y).
17367  It is however quite likely that a major update (e.
17368 \begin_inset space \thinspace{}
17369 \end_inset
17370
17371 g.
17372 \begin_inset space \space{}
17373 \end_inset
17374
17375 from 2.0.x to 2.1.0) will introduce new translations or corrections.
17376 \end_layout
17377
17378 \begin_layout Subsection
17379 Floats
17380 \begin_inset CommandInset label
17381 LatexCommand label
17382 name "subsec:Floats"
17383
17384 \end_inset
17385
17386
17387 \end_layout
17388
17389 \begin_layout Standard
17390 It is necessary to define the floats (
17391 \begin_inset Flex Noun
17392 status collapsed
17393
17394 \begin_layout Plain Layout
17395 figure
17396 \end_layout
17397
17398 \end_inset
17399
17400 ,
17401 \begin_inset Flex Noun
17402 status collapsed
17403
17404 \begin_layout Plain Layout
17405 table
17406 \end_layout
17407
17408 \end_inset
17409
17410 , \SpecialChar ldots
17411 ) in the text class itself.
17412  Standard floats are included in the file
17413 \begin_inset Flex Code
17414 status collapsed
17415
17416 \begin_layout Plain Layout
17417 stdfloats.inc
17418 \end_layout
17419
17420 \end_inset
17421
17422 , so you may have to do no more than add
17423 \end_layout
17424
17425 \begin_layout LyX-Code
17426 Input stdfloats.inc
17427 \end_layout
17428
17429 \begin_layout Standard
17430 to your layout file.
17431  If you want to implement a text class that proposes some other float types
17432  (like the AGU class bundled with \SpecialChar LyX
17433 ), the information below will hopefully
17434  help you:
17435 \end_layout
17436
17437 \begin_layout Description
17438 \begin_inset Flex Code
17439 status collapsed
17440
17441 \begin_layout Plain Layout
17442 AllowedPlacement
17443 \end_layout
17444
17445 \end_inset
17446
17447  [
17448 \begin_inset Flex Code
17449 status collapsed
17450
17451 \begin_layout Plain Layout
17452 string
17453 \end_layout
17454
17455 \end_inset
17456
17457 =!htbpH] Allowed placement options for this float type.
17458  The value is a string of placement characters.
17459  Possible characters include:
17460 \emph on
17461 h
17462 \emph default
17463  (
17464 \begin_inset Quotes eld
17465 \end_inset
17466
17467 here if possible
17468 \begin_inset Quotes erd
17469 \end_inset
17470
17471 ),
17472 \emph on
17473 t
17474 \emph default
17475  (
17476 \begin_inset Quotes eld
17477 \end_inset
17478
17479 top of page
17480 \begin_inset Quotes erd
17481 \end_inset
17482
17483 ),
17484 \emph on
17485 b
17486 \emph default
17487  (
17488 \begin_inset Quotes eld
17489 \end_inset
17490
17491 bottom of page
17492 \begin_inset Quotes erd
17493 \end_inset
17494
17495 ),
17496 \emph on
17497 p
17498 \emph default
17499  (
17500 \begin_inset Quotes eld
17501 \end_inset
17502
17503 page of floats
17504 \begin_inset Quotes erd
17505 \end_inset
17506
17507 ),
17508 \emph on
17509 H
17510 \emph default
17511  (
17512 \begin_inset Quotes eld
17513 \end_inset
17514
17515 here definitely
17516 \begin_inset Quotes erd
17517 \end_inset
17518
17519 ) and
17520 \emph on
17521 !
17522 \emph default
17523  (
17524 \begin_inset Quotes eld
17525 \end_inset
17526
17527 ignore LaTeX rules
17528 \begin_inset Quotes erd
17529 \end_inset
17530
17531 ).
17532  The order of the characters in the string does not matter.
17533  If no placement options are allowed, use the string
17534 \emph on
17535 none
17536 \emph default
17537 .
17538 \end_layout
17539
17540 \begin_layout Description
17541 \begin_inset Flex Code
17542 status collapsed
17543
17544 \begin_layout Plain Layout
17545 AllowsSideways
17546 \end_layout
17547
17548 \end_inset
17549
17550  [
17551 \begin_inset Flex Code
17552 status collapsed
17553
17554 \begin_layout Plain Layout
17555
17556 \emph off
17557 0
17558 \end_layout
17559
17560 \end_inset
17561
17562 ,
17563 \begin_inset space \thinspace{}
17564 \end_inset
17565
17566
17567 \emph on
17568
17569 \begin_inset Flex Code
17570 status collapsed
17571
17572 \begin_layout Plain Layout
17573
17574 \emph on
17575 1
17576 \end_layout
17577
17578 \end_inset
17579
17580
17581 \emph default
17582 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
17583 -package
17584 \family typewriter
17585 rotfloat
17586 \family default
17587  (sidewaysfloat).
17588  Set to
17589 \begin_inset Flex Code
17590 status collapsed
17591
17592 \begin_layout Plain Layout
17593 0
17594 \end_layout
17595
17596 \end_inset
17597
17598  if the float does not support this feature.
17599 \end_layout
17600
17601 \begin_layout Description
17602 \begin_inset Flex Code
17603 status collapsed
17604
17605 \begin_layout Plain Layout
17606 AllowsWide
17607 \end_layout
17608
17609 \end_inset
17610
17611  [
17612 \begin_inset Flex Code
17613 status collapsed
17614
17615 \begin_layout Plain Layout
17616
17617 \emph off
17618 0
17619 \end_layout
17620
17621 \end_inset
17622
17623 ,
17624 \begin_inset space \thinspace{}
17625 \end_inset
17626
17627
17628 \emph on
17629
17630 \begin_inset Flex Code
17631 status collapsed
17632
17633 \begin_layout Plain Layout
17634
17635 \emph on
17636 1
17637 \end_layout
17638
17639 \end_inset
17640
17641
17642 \emph default
17643 ] Defines whether the float has a starred variant that spans columns in
17644  a two column paragraph.
17645  Set to
17646 \begin_inset Flex Code
17647 status collapsed
17648
17649 \begin_layout Plain Layout
17650 0
17651 \end_layout
17652
17653 \end_inset
17654
17655  if the float does not support this feature.
17656 \end_layout
17657
17658 \begin_layout Description
17659 \begin_inset Flex Code
17660 status collapsed
17661
17662 \begin_layout Plain Layout
17663 Extension
17664 \end_layout
17665
17666 \end_inset
17667
17668  [
17669 \begin_inset Flex Code
17670 status collapsed
17671
17672 \begin_layout Plain Layout
17673 string
17674 \end_layout
17675
17676 \end_inset
17677
17678 =
17679 \begin_inset Quotes erd
17680 \end_inset
17681
17682
17683 \begin_inset Quotes erd
17684 \end_inset
17685
17686 ] The file name extension of an auxiliary file for the list of figures (or
17687  whatever).
17688  \SpecialChar LaTeX
17689  writes the captions to this file.
17690 \end_layout
17691
17692 \begin_layout Description
17693 \begin_inset Flex Code
17694 status collapsed
17695
17696 \begin_layout Plain Layout
17697 GuiName
17698 \end_layout
17699
17700 \end_inset
17701
17702  [
17703 \begin_inset Flex Code
17704 status collapsed
17705
17706 \begin_layout Plain Layout
17707 string
17708 \end_layout
17709
17710 \end_inset
17711
17712 =
17713 \begin_inset Quotes erd
17714 \end_inset
17715
17716
17717 \begin_inset Quotes erd
17718 \end_inset
17719
17720 ] The string that will be used in the menus and also for the caption.
17721  This is translated to the current language if babel is used.
17722 \end_layout
17723
17724 \begin_layout Description
17725 \begin_inset Flex Code
17726 status collapsed
17727
17728 \begin_layout Plain Layout
17729 HTML*
17730 \end_layout
17731
17732 \end_inset
17733
17734  These tags control the XHTML output.
17735  See
17736 \begin_inset CommandInset ref
17737 LatexCommand ref
17738 reference "sec:Tags-for-XHTML"
17739
17740 \end_inset
17741
17742 .
17743 \end_layout
17744
17745 \begin_layout Description
17746 \begin_inset Flex Code
17747 status collapsed
17748
17749 \begin_layout Plain Layout
17750 IsPredefined
17751 \end_layout
17752
17753 \end_inset
17754
17755  [
17756 \emph on
17757
17758 \begin_inset Flex Code
17759 status collapsed
17760
17761 \begin_layout Plain Layout
17762 0
17763 \end_layout
17764
17765 \end_inset
17766
17767
17768 \emph default
17769 ,
17770 \begin_inset space \thinspace{}
17771 \end_inset
17772
17773
17774 \begin_inset Flex Code
17775 status collapsed
17776
17777 \begin_layout Plain Layout
17778 1
17779 \end_layout
17780
17781 \end_inset
17782
17783 ] Indicates whether the float is already defined in the document class or
17784  if instead the \SpecialChar LaTeX
17785  package
17786 \begin_inset Flex Code
17787 status collapsed
17788
17789 \begin_layout Plain Layout
17790 float
17791 \end_layout
17792
17793 \end_inset
17794
17795  needs to be loaded to define it on-the-fly.
17796  The default is
17797 \begin_inset Flex Code
17798 status collapsed
17799
17800 \begin_layout Plain Layout
17801 0
17802 \end_layout
17803
17804 \end_inset
17805
17806 , which means:
17807 \begin_inset Flex Code
17808 status collapsed
17809
17810 \begin_layout Plain Layout
17811 float
17812 \end_layout
17813
17814 \end_inset
17815
17816  is used.
17817  It should be set to
17818 \begin_inset Flex Code
17819 status collapsed
17820
17821 \begin_layout Plain Layout
17822 1
17823 \end_layout
17824
17825 \end_inset
17826
17827  if the float is already defined by the \SpecialChar LaTeX
17828  document class.
17829 \end_layout
17830
17831 \begin_layout Description
17832 \begin_inset Flex Code
17833 status collapsed
17834
17835 \begin_layout Plain Layout
17836 ListCommand
17837 \end_layout
17838
17839 \end_inset
17840
17841  [
17842 \begin_inset Flex Code
17843 status collapsed
17844
17845 \begin_layout Plain Layout
17846 string
17847 \end_layout
17848
17849 \end_inset
17850
17851 =
17852 \begin_inset Quotes erd
17853 \end_inset
17854
17855
17856 \begin_inset Quotes erd
17857 \end_inset
17858
17859 ] The command used to generate a list of floats of this type; the leading
17860  `
17861 \backslash
17862 ' must be omitted.
17863  This
17864 \emph on
17865 must
17866 \emph default
17867  be given if
17868 \begin_inset Flex Code
17869 status collapsed
17870
17871 \begin_layout Plain Layout
17872 UsesFloatPkg
17873 \end_layout
17874
17875 \end_inset
17876
17877  is false, since there is no standard way to generate this command.
17878  It is ignored if
17879 \begin_inset Flex Code
17880 status collapsed
17881
17882 \begin_layout Plain Layout
17883 UsesFloatPkg
17884 \end_layout
17885
17886 \end_inset
17887
17888  is true, since in that case there is a standard way to define the command.
17889 \end_layout
17890
17891 \begin_layout Description
17892 \begin_inset Flex Code
17893 status collapsed
17894
17895 \begin_layout Plain Layout
17896 ListName
17897 \end_layout
17898
17899 \end_inset
17900
17901  [
17902 \begin_inset Flex Code
17903 status collapsed
17904
17905 \begin_layout Plain Layout
17906 string
17907 \end_layout
17908
17909 \end_inset
17910
17911 =
17912 \begin_inset Quotes erd
17913 \end_inset
17914
17915
17916 \begin_inset Quotes erd
17917 \end_inset
17918
17919 ] A title for a list of floats of this kind (list of figures, tables, or
17920  whatever).
17921  It is used for the screen label within \SpecialChar LyX
17922 , it is used by \SpecialChar LaTeX
17923  for the title and
17924  it is used as the title in the XHTML output.
17925  It will be translated to the document language.
17926 \end_layout
17927
17928 \begin_layout Description
17929 \begin_inset Flex Code
17930 status collapsed
17931
17932 \begin_layout Plain Layout
17933 NumberWithin
17934 \end_layout
17935
17936 \end_inset
17937
17938  [
17939 \begin_inset Flex Code
17940 status collapsed
17941
17942 \begin_layout Plain Layout
17943 string
17944 \end_layout
17945
17946 \end_inset
17947
17948 =
17949 \begin_inset Quotes erd
17950 \end_inset
17951
17952
17953 \begin_inset Quotes erd
17954 \end_inset
17955
17956 ] This (optional) argument determines whether floats of this class will
17957  be numbered within some sectional unit of the document.
17958  For example, if
17959 \begin_inset Flex Code
17960 status collapsed
17961
17962 \begin_layout Plain Layout
17963 NumberWithin
17964 \end_layout
17965
17966 \end_inset
17967
17968  is set to
17969 \begin_inset Quotes eld
17970 \end_inset
17971
17972
17973 \begin_inset Flex Code
17974 status collapsed
17975
17976 \begin_layout Plain Layout
17977 chapter
17978 \end_layout
17979
17980 \end_inset
17981
17982
17983 \begin_inset Quotes erd
17984 \end_inset
17985
17986 , the floats will be numbered within chapters.
17987
17988 \end_layout
17989
17990 \begin_layout Description
17991 \begin_inset Flex Code
17992 status collapsed
17993
17994 \begin_layout Plain Layout
17995 Placement
17996 \end_layout
17997
17998 \end_inset
17999
18000  [
18001 \begin_inset Flex Code
18002 status collapsed
18003
18004 \begin_layout Plain Layout
18005 string
18006 \end_layout
18007
18008 \end_inset
18009
18010 =
18011 \begin_inset Quotes erd
18012 \end_inset
18013
18014
18015 \begin_inset Quotes erd
18016 \end_inset
18017
18018 ] The default placement for the given class of floats.
18019  The string should be as in standard \SpecialChar LaTeX
18020 :
18021 \begin_inset Flex Code
18022 status collapsed
18023
18024 \begin_layout Plain Layout
18025 t
18026 \end_layout
18027
18028 \end_inset
18029
18030 ,
18031 \begin_inset Flex Code
18032 status collapsed
18033
18034 \begin_layout Plain Layout
18035 b
18036 \end_layout
18037
18038 \end_inset
18039
18040 ,
18041 \begin_inset Flex Code
18042 status collapsed
18043
18044 \begin_layout Plain Layout
18045 p
18046 \end_layout
18047
18048 \end_inset
18049
18050  and
18051 \begin_inset Flex Code
18052 status collapsed
18053
18054 \begin_layout Plain Layout
18055 h
18056 \end_layout
18057
18058 \end_inset
18059
18060  for top, bottom, page, and here, respectively.
18061 \begin_inset Foot
18062 status collapsed
18063
18064 \begin_layout Plain Layout
18065 Note that the order of these letters in the string is irrelevant, like in
18066  \SpecialChar LaTeX
18067 .
18068 \end_layout
18069
18070 \end_inset
18071
18072  On top of that there is a new type,
18073 \begin_inset Flex Code
18074 status collapsed
18075
18076 \begin_layout Plain Layout
18077 H
18078 \end_layout
18079
18080 \end_inset
18081
18082 , which does not really correspond to a float, since it means: put it
18083 \begin_inset Quotes eld
18084 \end_inset
18085
18086 here
18087 \begin_inset Quotes erd
18088 \end_inset
18089
18090  and nowhere else.
18091  Note however that the
18092 \begin_inset Flex Code
18093 status collapsed
18094
18095 \begin_layout Plain Layout
18096 H
18097 \end_layout
18098
18099 \end_inset
18100
18101  specifier is special and, because of implementation details, cannot be
18102  used in non-built in float types.
18103  If you do not understand what this means, just use
18104 \begin_inset Quotes eld
18105 \end_inset
18106
18107
18108 \begin_inset Flex Code
18109 status collapsed
18110
18111 \begin_layout Plain Layout
18112 tbp
18113 \end_layout
18114
18115 \end_inset
18116
18117
18118 \begin_inset Quotes erd
18119 \end_inset
18120
18121 .
18122 \end_layout
18123
18124 \begin_layout Description
18125 \begin_inset Flex Code
18126 status collapsed
18127
18128 \begin_layout Plain Layout
18129 RefPrefix
18130 \end_layout
18131
18132 \end_inset
18133
18134  [
18135 \begin_inset Flex Code
18136 status collapsed
18137
18138 \begin_layout Plain Layout
18139 string
18140 \end_layout
18141
18142 \end_inset
18143
18144 ] The prefix to use when creating labels referring to floats of this type.
18145  This allows the use of formatted references.
18146  Note that you can remove any
18147 \begin_inset Flex Code
18148 status collapsed
18149
18150 \begin_layout Plain Layout
18151 RefPrefix
18152 \end_layout
18153
18154 \end_inset
18155
18156  set by a copied style by using the special value
18157 \begin_inset Quotes eld
18158 \end_inset
18159
18160 OFF
18161 \begin_inset Quotes erd
18162 \end_inset
18163
18164 , which must be all caps.
18165 \end_layout
18166
18167 \begin_layout Description
18168 \begin_inset Flex Code
18169 status collapsed
18170
18171 \begin_layout Plain Layout
18172 Style
18173 \end_layout
18174
18175 \end_inset
18176
18177  [
18178 \begin_inset Flex Code
18179 status collapsed
18180
18181 \begin_layout Plain Layout
18182 string
18183 \end_layout
18184
18185 \end_inset
18186
18187 =
18188 \begin_inset Quotes erd
18189 \end_inset
18190
18191
18192 \begin_inset Quotes erd
18193 \end_inset
18194
18195 ] The style used when defining the float using
18196 \begin_inset Flex Code
18197 status collapsed
18198
18199 \begin_layout Plain Layout
18200
18201 \backslash
18202 newfloat
18203 \end_layout
18204
18205 \end_inset
18206
18207 .
18208 \end_layout
18209
18210 \begin_layout Description
18211 \begin_inset Flex Code
18212 status collapsed
18213
18214 \begin_layout Plain Layout
18215 Type
18216 \end_layout
18217
18218 \end_inset
18219
18220  [
18221 \begin_inset Flex Code
18222 status collapsed
18223
18224 \begin_layout Plain Layout
18225 string
18226 \end_layout
18227
18228 \end_inset
18229
18230 =
18231 \begin_inset Quotes erd
18232 \end_inset
18233
18234
18235 \begin_inset Quotes erd
18236 \end_inset
18237
18238 ] The
18239 \begin_inset Quotes eld
18240 \end_inset
18241
18242 type
18243 \begin_inset Quotes erd
18244 \end_inset
18245
18246  of the new class of floats, like program or algorithm.
18247  After the appropriate
18248 \begin_inset Flex Code
18249 status collapsed
18250
18251 \begin_layout Plain Layout
18252
18253 \backslash
18254 newfloat
18255 \end_layout
18256
18257 \end_inset
18258
18259 , commands such as
18260 \begin_inset Flex Code
18261 status collapsed
18262
18263 \begin_layout Plain Layout
18264
18265 \backslash
18266 begin{program}
18267 \end_layout
18268
18269 \end_inset
18270
18271  or
18272 \begin_inset Flex Code
18273 status collapsed
18274
18275 \begin_layout Plain Layout
18276
18277 \backslash
18278 end{algorithm*}
18279 \end_layout
18280
18281 \end_inset
18282
18283  will be available.
18284 \end_layout
18285
18286 \begin_layout Description
18287 \begin_inset Flex Code
18288 status collapsed
18289
18290 \begin_layout Plain Layout
18291 UsesFloatPkg
18292 \end_layout
18293
18294 \end_inset
18295
18296  [
18297 \begin_inset Flex Code
18298 status collapsed
18299
18300 \begin_layout Plain Layout
18301 0
18302 \end_layout
18303
18304 \end_inset
18305
18306 ,
18307 \begin_inset space \thinspace{}
18308 \end_inset
18309
18310
18311 \begin_inset Flex Code
18312 status collapsed
18313
18314 \begin_layout Plain Layout
18315
18316 \emph on
18317 1
18318 \end_layout
18319
18320 \end_inset
18321
18322 ] Specifies whether this float is defined using the \SpecialChar LaTeX
18323  package
18324 \begin_inset Flex Code
18325 status collapsed
18326
18327 \begin_layout Plain Layout
18328 float
18329 \end_layout
18330
18331 \end_inset
18332
18333 , either by the class file, another package or on-the-fly by \SpecialChar LyX
18334  itself.
18335 \end_layout
18336
18337 \begin_layout Standard
18338 Note that defining a float with type
18339 \begin_inset Flex Code
18340 status collapsed
18341
18342 \begin_layout Plain Layout
18343
18344 \emph on
18345 type
18346 \end_layout
18347
18348 \end_inset
18349
18350  automatically defines the corresponding counter with name
18351 \begin_inset Flex Code
18352 status collapsed
18353
18354 \begin_layout Plain Layout
18355
18356 \emph on
18357 type
18358 \end_layout
18359
18360 \end_inset
18361
18362 .
18363 \end_layout
18364
18365 \begin_layout Subsection
18366 Flex insets and InsetLayout
18367 \begin_inset CommandInset label
18368 LatexCommand label
18369 name "subsec:Flex-insets-and"
18370
18371 \end_inset
18372
18373
18374 \end_layout
18375
18376 \begin_layout Standard
18377 Flex insets come in three different kinds:
18378 \end_layout
18379
18380 \begin_layout Itemize
18381 character style (
18382 \begin_inset Flex Code
18383 status collapsed
18384
18385 \begin_layout Plain Layout
18386 CharStyle
18387 \end_layout
18388
18389 \end_inset
18390
18391 ): These define semantic markup corresponding to such \SpecialChar LaTeX
18392  commands as
18393 \begin_inset Flex Code
18394 status collapsed
18395
18396 \begin_layout Plain Layout
18397
18398 \backslash
18399 noun
18400 \end_layout
18401
18402 \end_inset
18403
18404  and
18405 \begin_inset Flex Code
18406 status collapsed
18407
18408 \begin_layout Plain Layout
18409
18410 \backslash
18411 code
18412 \end_layout
18413
18414 \end_inset
18415
18416 .
18417 \end_layout
18418
18419 \begin_layout Itemize
18420 user custom (
18421 \begin_inset Flex Code
18422 status collapsed
18423
18424 \begin_layout Plain Layout
18425 Custom
18426 \end_layout
18427
18428 \end_inset
18429
18430 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
18431  code,
18432  footnote, and the like.
18433  An obvious example is an endnote inset, which is defined in the
18434 \begin_inset Flex Code
18435 status collapsed
18436
18437 \begin_layout Plain Layout
18438 endnote
18439 \end_layout
18440
18441 \end_inset
18442
18443  module.
18444 \end_layout
18445
18446 \begin_layout Itemize
18447 XML elements (
18448 \begin_inset Flex Code
18449 status collapsed
18450
18451 \begin_layout Plain Layout
18452 Element
18453 \end_layout
18454
18455 \end_inset
18456
18457 ): For use with DocBook classes.
18458 \end_layout
18459
18460 \begin_layout Standard
18461 Flex insets are defined using the
18462 \begin_inset Flex Code
18463 status collapsed
18464
18465 \begin_layout Plain Layout
18466 InsetLayout
18467 \end_layout
18468
18469 \end_inset
18470
18471  tag, which shall be explained in a moment.
18472 \end_layout
18473
18474 \begin_layout Standard
18475 The
18476 \begin_inset Flex Code
18477 status collapsed
18478
18479 \begin_layout Plain Layout
18480 InsetLayout
18481 \end_layout
18482
18483 \end_inset
18484
18485  tag also serves another function: It can be used to customize the general
18486  layout of many different types of insets.
18487  Currently,
18488 \begin_inset Flex Code
18489 status collapsed
18490
18491 \begin_layout Plain Layout
18492 InsetLayout
18493 \end_layout
18494
18495 \end_inset
18496
18497  can be used to customize the layout parameters for footnotes, marginal
18498  notes, note insets, \SpecialChar TeX
18499  code (ERT) insets, branches, listings, indexes, boxes,
18500  tables, algorithms, URLs, and captions, as well as to define Flex insets.
18501 \end_layout
18502
18503 \begin_layout Standard
18504 The
18505 \begin_inset Flex Code
18506 status collapsed
18507
18508 \begin_layout Plain Layout
18509 InsetLayout
18510 \end_layout
18511
18512 \end_inset
18513
18514  definition must begin with a line of the form:
18515 \end_layout
18516
18517 \begin_layout LyX-Code
18518 InsetLayout <type>
18519 \end_layout
18520
18521 \begin_layout Standard
18522 Here
18523 \begin_inset Flex Code
18524 status collapsed
18525
18526 \begin_layout Plain Layout
18527 <Type>
18528 \end_layout
18529
18530 \end_inset
18531
18532  indicates the inset whose layout is being defined, and here there are four
18533  cases.
18534 \end_layout
18535
18536 \begin_layout Enumerate
18537 The layout for a pre-existing inset is being modified.
18538  In this case, can be
18539 \begin_inset Flex Code
18540 status collapsed
18541
18542 \begin_layout Plain Layout
18543 <Type>
18544 \end_layout
18545
18546 \end_inset
18547
18548  any one of the following:
18549 \begin_inset Flex Code
18550 status collapsed
18551
18552 \begin_layout Plain Layout
18553 Algorithm
18554 \end_layout
18555
18556 \end_inset
18557
18558 ,
18559 \begin_inset Flex Code
18560 status collapsed
18561
18562 \begin_layout Plain Layout
18563 Branch
18564 \end_layout
18565
18566 \end_inset
18567
18568 ,
18569 \begin_inset Flex Code
18570 status collapsed
18571
18572 \begin_layout Plain Layout
18573 Box
18574 \end_layout
18575
18576 \end_inset
18577
18578 ,
18579 \begin_inset Flex Code
18580 status collapsed
18581
18582 \begin_layout Plain Layout
18583 Box:shaded
18584 \end_layout
18585
18586 \end_inset
18587
18588 ,
18589 \begin_inset Flex Code
18590 status collapsed
18591
18592 \begin_layout Plain Layout
18593 Caption:Standard
18594 \end_layout
18595
18596 \end_inset
18597
18598 ,
18599 \begin_inset Flex Code
18600 status collapsed
18601
18602 \begin_layout Plain Layout
18603 ERT
18604 \end_layout
18605
18606 \end_inset
18607
18608 ,
18609 \begin_inset Flex Code
18610 status collapsed
18611
18612 \begin_layout Plain Layout
18613 Figure
18614 \end_layout
18615
18616 \end_inset
18617
18618 ,
18619 \begin_inset Flex Code
18620 status collapsed
18621
18622 \begin_layout Plain Layout
18623 Foot
18624 \end_layout
18625
18626 \end_inset
18627
18628 ,
18629 \begin_inset Flex Code
18630 status collapsed
18631
18632 \begin_layout Plain Layout
18633 Index
18634 \end_layout
18635
18636 \end_inset
18637
18638 ,
18639 \begin_inset Flex Code
18640 status collapsed
18641
18642 \begin_layout Plain Layout
18643 Info
18644 \end_layout
18645
18646 \end_inset
18647
18648 ,
18649 \begin_inset Flex Code
18650 status collapsed
18651
18652 \begin_layout Plain Layout
18653 Info:menu
18654 \end_layout
18655
18656 \end_inset
18657
18658 ,
18659 \begin_inset Flex Code
18660 status collapsed
18661
18662 \begin_layout Plain Layout
18663 Info:shortcut
18664 \end_layout
18665
18666 \end_inset
18667
18668 ,
18669 \begin_inset Flex Code
18670 status collapsed
18671
18672 \begin_layout Plain Layout
18673 Info:shortcuts
18674 \end_layout
18675
18676 \end_inset
18677
18678 ,
18679 \begin_inset Flex Code
18680 status collapsed
18681
18682 \begin_layout Plain Layout
18683 Listings
18684 \end_layout
18685
18686 \end_inset
18687
18688 ,
18689 \begin_inset Flex Code
18690 status collapsed
18691
18692 \begin_layout Plain Layout
18693 Marginal
18694 \end_layout
18695
18696 \end_inset
18697
18698 ,
18699 \begin_inset Flex Code
18700 status collapsed
18701
18702 \begin_layout Plain Layout
18703 Note:Comment
18704 \end_layout
18705
18706 \end_inset
18707
18708 ,
18709 \begin_inset Flex Code
18710 status collapsed
18711
18712 \begin_layout Plain Layout
18713 Note:Note
18714 \end_layout
18715
18716 \end_inset
18717
18718 ,
18719 \begin_inset Flex Code
18720 status collapsed
18721
18722 \begin_layout Plain Layout
18723 Note:Greyedout
18724 \end_layout
18725
18726 \end_inset
18727
18728 ,
18729 \begin_inset Flex Code
18730 status collapsed
18731
18732 \begin_layout Plain Layout
18733 Table
18734 \end_layout
18735
18736 \end_inset
18737
18738 , or
18739 \begin_inset Flex Code
18740 status collapsed
18741
18742 \begin_layout Plain Layout
18743 URL
18744 \end_layout
18745
18746 \end_inset
18747
18748 .
18749 \end_layout
18750
18751 \begin_layout Enumerate
18752 The layout for a Flex inset is being defined.
18753  In this case,
18754 \begin_inset Flex Code
18755 status collapsed
18756
18757 \begin_layout Plain Layout
18758 <Type>
18759 \end_layout
18760
18761 \end_inset
18762
18763  must be of the form
18764 \begin_inset Quotes eld
18765 \end_inset
18766
18767
18768 \begin_inset Flex Code
18769 status collapsed
18770
18771 \begin_layout Plain Layout
18772 Flex:<name>
18773 \end_layout
18774
18775 \end_inset
18776
18777
18778 \begin_inset Quotes erd
18779 \end_inset
18780
18781 , where
18782 \begin_inset Flex Code
18783 status collapsed
18784
18785 \begin_layout Plain Layout
18786 name
18787 \end_layout
18788
18789 \end_inset
18790
18791  may be be any valid identifier not used by a pre-existing Flex inset.
18792  The identifier may include spaces, but in that case the whole thing must
18793  be wrapped in quotes.
18794  Note that the definition of a flex inset
18795 \emph on
18796 must
18797 \emph default
18798 also include a
18799 \begin_inset Flex Code
18800 status collapsed
18801
18802 \begin_layout Plain Layout
18803 LyXType
18804 \end_layout
18805
18806 \end_inset
18807
18808  entry, declaring which type of inset it defines.
18809 \end_layout
18810
18811 \begin_layout Enumerate
18812 The layout for user specific branch is being defined.
18813  In this case,
18814 \begin_inset Flex Code
18815 status collapsed
18816
18817 \begin_layout Plain Layout
18818 <Type>
18819 \end_layout
18820
18821 \end_inset
18822
18823  must be of the form
18824 \begin_inset Quotes eld
18825 \end_inset
18826
18827
18828 \begin_inset Flex Code
18829 status collapsed
18830
18831 \begin_layout Plain Layout
18832 Branch:<name>
18833 \end_layout
18834
18835 \end_inset
18836
18837
18838 \begin_inset Quotes erd
18839 \end_inset
18840
18841 , where
18842 \begin_inset Flex Code
18843 status collapsed
18844
18845 \begin_layout Plain Layout
18846 name
18847 \end_layout
18848
18849 \end_inset
18850
18851  may be be any valid identifier of branch defined in user's document.
18852  The identifier may include spaces, but in that case the whole thing must
18853  be wrapped in quotes.
18854  The main purpose of this feature is to allow \SpecialChar LaTeX
18855  wrapping around specific
18856  branches as user needs.
18857 \end_layout
18858
18859 \begin_layout Enumerate
18860 The layout of a user (or class) specific caption is being defined.
18861  In this case,
18862 \begin_inset Flex Code
18863 status collapsed
18864
18865 \begin_layout Plain Layout
18866 <Type>
18867 \end_layout
18868
18869 \end_inset
18870
18871  must be of the form
18872 \begin_inset Quotes eld
18873 \end_inset
18874
18875
18876 \begin_inset Flex Code
18877 status collapsed
18878
18879 \begin_layout Plain Layout
18880 Caption:<name>
18881 \end_layout
18882
18883 \end_inset
18884
18885
18886 \begin_inset Quotes erd
18887 \end_inset
18888
18889 , where
18890 \begin_inset Flex Code
18891 status collapsed
18892
18893 \begin_layout Plain Layout
18894 name
18895 \end_layout
18896
18897 \end_inset
18898
18899  specifies the name of the caption as it appears in the menu.
18900  Have a look at the standard caption (
18901 \begin_inset Flex Code
18902 status collapsed
18903
18904 \begin_layout Plain Layout
18905 Caption:Standard
18906 \end_layout
18907
18908 \end_inset
18909
18910 ), the specific captions of the KOMA-Script classes (
18911 \begin_inset Flex Code
18912 status collapsed
18913
18914 \begin_layout Plain Layout
18915 Caption:Above
18916 \end_layout
18917
18918 \end_inset
18919
18920 ,
18921 \begin_inset Flex Code
18922 status collapsed
18923
18924 \begin_layout Plain Layout
18925 Caption:Below
18926 \end_layout
18927
18928 \end_inset
18929
18930 ) or the module
18931 \family sans
18932 Multilingual
18933 \begin_inset space ~
18934 \end_inset
18935
18936 Captions
18937 \begin_inset Newline linebreak
18938 \end_inset
18939
18940
18941 \family default
18942 (
18943 \begin_inset Flex Code
18944 status collapsed
18945
18946 \begin_layout Plain Layout
18947 Caption:Bicaption
18948 \end_layout
18949
18950 \end_inset
18951
18952 ) for applications.
18953 \end_layout
18954
18955 \begin_layout Standard
18956 The
18957 \begin_inset Flex Code
18958 status collapsed
18959
18960 \begin_layout Plain Layout
18961 InsetLayout
18962 \end_layout
18963
18964 \end_inset
18965
18966  definition can contain the following entries:
18967 \end_layout
18968
18969 \begin_layout Description
18970 \begin_inset Flex Code
18971 status collapsed
18972
18973 \begin_layout Plain Layout
18974 AddToToc
18975 \end_layout
18976
18977 \end_inset
18978
18979  [
18980 \begin_inset Flex Code
18981 status collapsed
18982
18983 \begin_layout Plain Layout
18984 string
18985 \end_layout
18986
18987 \end_inset
18988
18989 =""] This inset will appear in the table of contents of the given type.
18990  An empty string disables.
18991  See also the OutlinerName and the IsTocCaption commands.
18992  This is only implemented for Flex insets.
18993  Default: disabled.
18994 \end_layout
18995
18996 \begin_layout Description
18997 \begin_inset Flex Code
18998 status collapsed
18999
19000 \begin_layout Plain Layout
19001 Argument
19002 \end_layout
19003
19004 \end_inset
19005
19006  [
19007 \begin_inset Flex Code
19008 status collapsed
19009
19010 \begin_layout Plain Layout
19011 int
19012 \end_layout
19013
19014 \end_inset
19015
19016 ] Defines argument number of a command\SpecialChar breakableslash
19017 environment associated with the current
19018  layout.
19019  The definition must end with
19020 \begin_inset Flex Code
19021 status collapsed
19022
19023 \begin_layout Plain Layout
19024 EndArgument
19025 \end_layout
19026
19027 \end_inset
19028
19029 .
19030  See
19031 \begin_inset CommandInset ref
19032 LatexCommand ref
19033 reference "subsec:Paragraph-Styles"
19034
19035 \end_inset
19036
19037  for details.
19038 \end_layout
19039
19040 \begin_layout Description
19041 \begin_inset Flex Code
19042 status collapsed
19043
19044 \begin_layout Plain Layout
19045 BabelPreamble
19046 \end_layout
19047
19048 \end_inset
19049
19050  Preamble for changing language commands; see
19051 \begin_inset CommandInset ref
19052 LatexCommand ref
19053 reference "subsec:I18n"
19054
19055 \end_inset
19056
19057 .
19058 \end_layout
19059
19060 \begin_layout Description
19061 \begin_inset Flex Code
19062 status collapsed
19063
19064 \begin_layout Plain Layout
19065 BgColor
19066 \end_layout
19067
19068 \end_inset
19069
19070  [
19071 \begin_inset Flex Code
19072 status collapsed
19073
19074 \begin_layout Plain Layout
19075 <name>
19076 \end_layout
19077
19078 \end_inset
19079
19080 ] The color for the inset's background.
19081  See
19082 \begin_inset CommandInset ref
19083 LatexCommand ref
19084 reference "chap:Names-of-colors"
19085
19086 \end_inset
19087
19088  for a list of the available color names.
19089 \end_layout
19090
19091 \begin_layout Description
19092 \begin_inset Flex Code
19093 status collapsed
19094
19095 \begin_layout Plain Layout
19096 ContentAsLabel
19097 \end_layout
19098
19099 \end_inset
19100
19101  [
19102 \begin_inset Flex Code
19103 status collapsed
19104
19105 \begin_layout Plain Layout
19106
19107 \emph on
19108 0
19109 \end_layout
19110
19111 \end_inset
19112
19113 ,
19114 \begin_inset space \thinspace{}
19115 \end_inset
19116
19117
19118 \begin_inset Flex Code
19119 status collapsed
19120
19121 \begin_layout Plain Layout
19122 1
19123 \end_layout
19124
19125 \end_inset
19126
19127 ] Whether to use the content of the inset as the label, when the inset is
19128  closed.
19129  Default is false.
19130 \end_layout
19131
19132 \begin_layout Description
19133 \begin_inset Flex Code
19134 status collapsed
19135
19136 \begin_layout Plain Layout
19137 CopyStyle
19138 \end_layout
19139
19140 \end_inset
19141
19142  [
19143 \begin_inset Flex Code
19144 status collapsed
19145
19146 \begin_layout Plain Layout
19147 <type>
19148 \end_layout
19149
19150 \end_inset
19151
19152 ] As with paragraph styles, see
19153 \begin_inset CommandInset ref
19154 LatexCommand ref
19155 reference "subsec:Paragraph-Styles"
19156
19157 \end_inset
19158
19159 .
19160  Note that you need to specify the complete type, e.
19161 \begin_inset space \thinspace{}
19162 \end_inset
19163
19164 g.
19165 \begin_inset space ~
19166 \end_inset
19167
19168
19169 \begin_inset Flex Code
19170 status collapsed
19171
19172 \begin_layout Plain Layout
19173 CopyStyle Flex:<name>
19174 \end_layout
19175
19176 \end_inset
19177
19178 .
19179 \end_layout
19180
19181 \begin_layout Description
19182 \begin_inset Flex Code
19183 status collapsed
19184
19185 \begin_layout Plain Layout
19186 CustomPars
19187 \end_layout
19188
19189 \end_inset
19190
19191  [
19192 \begin_inset Flex Code
19193 status collapsed
19194
19195 \begin_layout Plain Layout
19196
19197 \emph on
19198 0
19199 \end_layout
19200
19201 \end_inset
19202
19203 ,
19204 \begin_inset space \thinspace{}
19205 \end_inset
19206
19207
19208 \begin_inset Flex Code
19209 status collapsed
19210
19211 \begin_layout Plain Layout
19212 1
19213 \end_layout
19214
19215 \end_inset
19216
19217 ] Indicates whether the user may employ the Paragraph Settings dialog to
19218  customize the paragraph.
19219 \end_layout
19220
19221 \begin_layout Description
19222 \begin_inset Flex Code
19223 status collapsed
19224
19225 \begin_layout Plain Layout
19226 Decoration
19227 \end_layout
19228
19229 \end_inset
19230
19231  can be
19232 \begin_inset Flex Code
19233 status collapsed
19234
19235 \begin_layout Plain Layout
19236 Classic
19237 \end_layout
19238
19239 \end_inset
19240
19241 ,
19242 \begin_inset Flex Code
19243 status collapsed
19244
19245 \begin_layout Plain Layout
19246 Minimalistic
19247 \end_layout
19248
19249 \end_inset
19250
19251 , or
19252 \begin_inset Flex Code
19253 status collapsed
19254
19255 \begin_layout Plain Layout
19256 Conglomerate
19257 \end_layout
19258
19259 \end_inset
19260
19261 , describing the rendering style used for the inset's frame and buttons.
19262  Footnotes generally use
19263 \begin_inset Flex Code
19264 status collapsed
19265
19266 \begin_layout Plain Layout
19267 Classic
19268 \end_layout
19269
19270 \end_inset
19271
19272 , ERT insets generally
19273 \begin_inset Flex Code
19274 status collapsed
19275
19276 \begin_layout Plain Layout
19277 Minimalistic
19278 \end_layout
19279
19280 \end_inset
19281
19282 , and character styles
19283 \begin_inset Flex Code
19284 status collapsed
19285
19286 \begin_layout Plain Layout
19287 Conglomerate
19288 \end_layout
19289
19290 \end_inset
19291
19292 .
19293 \end_layout
19294
19295 \begin_layout Description
19296 \begin_inset Flex Code
19297 status collapsed
19298
19299 \begin_layout Plain Layout
19300 Display
19301 \end_layout
19302
19303 \end_inset
19304
19305  [
19306 \begin_inset Flex Code
19307 status collapsed
19308
19309 \begin_layout Plain Layout
19310 0
19311 \end_layout
19312
19313 \end_inset
19314
19315 ,
19316 \emph on
19317
19318 \begin_inset space \thinspace{}
19319 \end_inset
19320
19321
19322 \emph default
19323
19324 \begin_inset Flex Code
19325 status collapsed
19326
19327 \begin_layout Plain Layout
19328
19329 \emph on
19330 1
19331 \end_layout
19332
19333 \end_inset
19334
19335 ] Only useful if
19336 \begin_inset Flex Code
19337 status collapsed
19338
19339 \begin_layout Plain Layout
19340 LatexType
19341 \end_layout
19342
19343 \end_inset
19344
19345  is
19346 \begin_inset Flex Code
19347 status collapsed
19348
19349 \begin_layout Plain Layout
19350 Environment
19351 \end_layout
19352
19353 \end_inset
19354
19355 .
19356  Indicates whether the environment will stand on its own in the output or
19357  will appear inline with the surrounding text.
19358  If set to false, it is supposed that the \SpecialChar LaTeX
19359  environment ignores white space
19360  (including one newline character) after the
19361 \begin_inset Flex Code
19362 status collapsed
19363
19364 \begin_layout Plain Layout
19365
19366 \backslash
19367 begin{
19368 \emph on
19369 LatexName
19370 \emph default
19371 }
19372 \end_layout
19373
19374 \end_inset
19375
19376  and
19377 \begin_inset Flex Code
19378 status collapsed
19379
19380 \begin_layout Plain Layout
19381
19382 \backslash
19383 end{
19384 \emph on
19385 LatexName
19386 \emph default
19387 }
19388 \end_layout
19389
19390 \end_inset
19391
19392  tags.
19393  Default is true.
19394 \change_inserted 731793113 1538674858
19395
19396 \end_layout
19397
19398 \begin_layout Description
19399
19400 \change_inserted 731793113 1538674891
19401 \begin_inset Flex Code
19402 status open
19403
19404 \begin_layout Plain Layout
19405
19406 \change_inserted 731793113 1538674863
19407 EditExternal
19408 \change_unchanged
19409
19410 \end_layout
19411
19412 \end_inset
19413
19414  [
19415 \emph on
19416 0
19417 \emph default
19418 ,1] Allow the contents of the inset to be edited externally (using whatever
19419  editor is defined for the document's output format).
19420 \change_unchanged
19421
19422 \end_layout
19423
19424 \begin_layout Description
19425 \begin_inset Flex Code
19426 status collapsed
19427
19428 \begin_layout Plain Layout
19429 End
19430 \end_layout
19431
19432 \end_inset
19433
19434  Required at the end of the
19435 \begin_inset Flex Code
19436 status collapsed
19437
19438 \begin_layout Plain Layout
19439 InsetLayout
19440 \end_layout
19441
19442 \end_inset
19443
19444  declarations.
19445 \end_layout
19446
19447 \begin_layout Description
19448 \begin_inset Flex Code
19449 status collapsed
19450
19451 \begin_layout Plain Layout
19452 Font
19453 \end_layout
19454
19455 \end_inset
19456
19457  The font used for both the text body
19458 \emph on
19459 and
19460 \emph default
19461  the label.
19462  See
19463 \begin_inset CommandInset ref
19464 LatexCommand ref
19465 reference "subsec:Font-description"
19466
19467 \end_inset
19468
19469 .
19470  Note that defining this font automatically defines the
19471 \begin_inset Flex Code
19472 status collapsed
19473
19474 \begin_layout Plain Layout
19475 LabelFont
19476 \end_layout
19477
19478 \end_inset
19479
19480  to the same value, so define this first and define
19481 \begin_inset Flex Code
19482 status collapsed
19483
19484 \begin_layout Plain Layout
19485 LabelFont
19486 \end_layout
19487
19488 \end_inset
19489
19490  later if you want them to be different.
19491 \end_layout
19492
19493 \begin_layout Description
19494 \begin_inset Flex Code
19495 status collapsed
19496
19497 \begin_layout Plain Layout
19498 FixedWidthPreambleEncoding
19499 \end_layout
19500
19501 \end_inset
19502
19503  [
19504 \begin_inset Flex Code
19505 status collapsed
19506
19507 \begin_layout Plain Layout
19508
19509 \emph on
19510 0
19511 \end_layout
19512
19513 \end_inset
19514
19515 ,
19516 \begin_inset space \thinspace{}
19517 \end_inset
19518
19519
19520 \begin_inset Flex Code
19521 status collapsed
19522
19523 \begin_layout Plain Layout
19524 1
19525 \end_layout
19526
19527 \end_inset
19528
19529 ] Force a fixed width encoding for the translated contents of
19530 \begin_inset Flex Code
19531 status collapsed
19532
19533 \begin_layout Plain Layout
19534 BabelPreamble
19535 \end_layout
19536
19537 \end_inset
19538
19539  and
19540 \begin_inset Flex Code
19541 status collapsed
19542
19543 \begin_layout Plain Layout
19544 LangPreamble
19545 \end_layout
19546
19547 \end_inset
19548
19549  code generated by this layout.
19550  This is needed for special \SpecialChar LaTeX
19551 -packages like
19552 \family typewriter
19553 listings
19554 \family default
19555  that do not work with variable width encodings such as
19556 \family sans
19557 utf8
19558 \family default
19559 .
19560  This setting is ignored if fully Unicode aware \SpecialChar LaTeX
19561  backends such as Xe\SpecialChar TeX
19562  or
19563  Lua\SpecialChar TeX
19564  are used.
19565 \end_layout
19566
19567 \begin_layout Description
19568 \begin_inset Flex Code
19569 status collapsed
19570
19571 \begin_layout Plain Layout
19572 ForceLocalFontSwitch
19573 \end_layout
19574
19575 \end_inset
19576
19577  [
19578 \begin_inset Flex Code
19579 status collapsed
19580
19581 \begin_layout Plain Layout
19582
19583 \emph on
19584 0
19585 \end_layout
19586
19587 \end_inset
19588
19589 ,
19590 \begin_inset space \thinspace{}
19591 \end_inset
19592
19593
19594 \begin_inset Flex Code
19595 status collapsed
19596
19597 \begin_layout Plain Layout
19598 1
19599 \end_layout
19600
19601 \end_inset
19602
19603 ] When using babel, always use a local font switch (
19604 \begin_inset Flex Code
19605 status collapsed
19606
19607 \begin_layout Plain Layout
19608
19609 \backslash
19610 foreignlanguage
19611 \end_layout
19612
19613 \end_inset
19614
19615 ), never a global one (such as
19616 \begin_inset Flex Code
19617 status collapsed
19618
19619 \begin_layout Plain Layout
19620
19621 \backslash
19622 selectlanguage
19623 \end_layout
19624
19625 \end_inset
19626
19627 ).
19628 \end_layout
19629
19630 \begin_layout Description
19631 \begin_inset Flex Code
19632 status collapsed
19633
19634 \begin_layout Plain Layout
19635 ForceLTR
19636 \end_layout
19637
19638 \end_inset
19639
19640  [
19641 \begin_inset Flex Code
19642 status collapsed
19643
19644 \begin_layout Plain Layout
19645
19646 \emph on
19647 0
19648 \end_layout
19649
19650 \end_inset
19651
19652 ,
19653 \begin_inset space \thinspace{}
19654 \end_inset
19655
19656
19657 \begin_inset Flex Code
19658 status collapsed
19659
19660 \begin_layout Plain Layout
19661 1
19662 \end_layout
19663
19664 \end_inset
19665
19666 ] Force the
19667 \begin_inset Quotes eld
19668 \end_inset
19669
19670 latex
19671 \begin_inset Quotes erd
19672 \end_inset
19673
19674  language, leading to Left-to-Right (Latin) output, e.
19675 \begin_inset space \thinspace{}
19676 \end_inset
19677
19678 g.
19679 \begin_inset space \space{}
19680 \end_inset
19681
19682 in \SpecialChar TeX
19683  code or URL.
19684  A kludge.
19685 \end_layout
19686
19687 \begin_layout Description
19688 \begin_inset Flex Code
19689 status collapsed
19690
19691 \begin_layout Plain Layout
19692 ForceOwnlines
19693 \end_layout
19694
19695 \end_inset
19696
19697  [
19698 \begin_inset Flex Code
19699 status collapsed
19700
19701 \begin_layout Plain Layout
19702
19703 \emph on
19704 0
19705 \end_layout
19706
19707 \end_inset
19708
19709 ,
19710 \begin_inset space \thinspace{}
19711 \end_inset
19712
19713
19714 \begin_inset Flex Code
19715 status collapsed
19716
19717 \begin_layout Plain Layout
19718 1
19719 \end_layout
19720
19721 \end_inset
19722
19723 ] Force a a line break in the \SpecialChar LaTeX
19724  output before the inset starts and after
19725  the inset ends.
19726  This assures the inset itself is output on its own lines, for parsing purposes.
19727 \end_layout
19728
19729 \begin_layout Description
19730 \begin_inset Flex Code
19731 status collapsed
19732
19733 \begin_layout Plain Layout
19734 ForcePlain
19735 \end_layout
19736
19737 \end_inset
19738
19739  [
19740 \begin_inset Flex Code
19741 status collapsed
19742
19743 \begin_layout Plain Layout
19744
19745 \emph on
19746 0
19747 \end_layout
19748
19749 \end_inset
19750
19751 ,
19752 \begin_inset space \thinspace{}
19753 \end_inset
19754
19755
19756 \begin_inset Flex Code
19757 status collapsed
19758
19759 \begin_layout Plain Layout
19760 1
19761 \end_layout
19762
19763 \end_inset
19764
19765 ] Indicates whether the
19766 \begin_inset Flex Code
19767 status collapsed
19768
19769 \begin_layout Plain Layout
19770 PlainLayout
19771 \end_layout
19772
19773 \end_inset
19774
19775  should be used or, instead, the user can change the paragraph style used
19776  in the inset.
19777  Default is false.
19778 \end_layout
19779
19780 \begin_layout Description
19781 \begin_inset Flex Code
19782 status collapsed
19783
19784 \begin_layout Plain Layout
19785 FreeSpacing
19786 \end_layout
19787
19788 \end_inset
19789
19790  [
19791 \begin_inset Flex Code
19792 status collapsed
19793
19794 \begin_layout Plain Layout
19795
19796 \emph on
19797 0
19798 \end_layout
19799
19800 \end_inset
19801
19802 ,
19803 \begin_inset space \thinspace{}
19804 \end_inset
19805
19806
19807 \begin_inset Flex Code
19808 status collapsed
19809
19810 \begin_layout Plain Layout
19811 1
19812 \end_layout
19813
19814 \end_inset
19815
19816 ] As with paragraph styles, see
19817 \begin_inset CommandInset ref
19818 LatexCommand ref
19819 reference "subsec:Paragraph-Styles"
19820
19821 \end_inset
19822
19823 .
19824 \end_layout
19825
19826 \begin_layout Description
19827 \begin_inset Flex Code
19828 status collapsed
19829
19830 \begin_layout Plain Layout
19831 HTML*
19832 \end_layout
19833
19834 \end_inset
19835
19836  These tags control the XHTML output.
19837  See
19838 \begin_inset CommandInset ref
19839 LatexCommand ref
19840 reference "sec:Tags-for-XHTML"
19841
19842 \end_inset
19843
19844 .
19845 \end_layout
19846
19847 \begin_layout Description
19848 \begin_inset Flex Code
19849 status collapsed
19850
19851 \begin_layout Plain Layout
19852 InToc
19853 \end_layout
19854
19855 \end_inset
19856
19857  [
19858 \begin_inset Flex Code
19859 status collapsed
19860
19861 \begin_layout Plain Layout
19862
19863 \emph on
19864 0
19865 \end_layout
19866
19867 \end_inset
19868
19869 ,
19870 \begin_inset space \thinspace{}
19871 \end_inset
19872
19873
19874 \begin_inset Flex Code
19875 status collapsed
19876
19877 \begin_layout Plain Layout
19878 1
19879 \end_layout
19880
19881 \end_inset
19882
19883 ] Whether to include the contents of this inset in the strings generated
19884  for the `Outline' pane for all table of contents, regardless of the AddToToc
19885  setting.
19886  One would not, for example, want the content of a footnote in a section
19887  header to be included in the TOC displayed in the outline, but one would
19888  normally want the content of a character style displayed.
19889  Default is false: not to include.
19890 \end_layout
19891
19892 \begin_layout Description
19893 \begin_inset Flex Code
19894 status collapsed
19895
19896 \begin_layout Plain Layout
19897 IsTocCaption
19898 \end_layout
19899
19900 \end_inset
19901
19902  [
19903 \begin_inset Flex Code
19904 status collapsed
19905
19906 \begin_layout Plain Layout
19907
19908 \emph on
19909 0
19910 \end_layout
19911
19912 \end_inset
19913
19914 ,
19915 \begin_inset space \thinspace{}
19916 \end_inset
19917
19918
19919 \begin_inset Flex Code
19920 status collapsed
19921
19922 \begin_layout Plain Layout
19923 1
19924 \end_layout
19925
19926 \end_inset
19927
19928 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
19929  of its contents in its item in the table of contents.
19930  Otherwise, only the label appears.
19931 \end_layout
19932
19933 \begin_layout Description
19934 \begin_inset Flex Code
19935 status collapsed
19936
19937 \begin_layout Plain Layout
19938 KeepEmpty
19939 \end_layout
19940
19941 \end_inset
19942
19943  [
19944 \emph on
19945
19946 \begin_inset Flex Code
19947 status collapsed
19948
19949 \begin_layout Plain Layout
19950 0
19951 \end_layout
19952
19953 \end_inset
19954
19955
19956 \emph default
19957 ,
19958 \begin_inset space \thinspace{}
19959 \end_inset
19960
19961
19962 \begin_inset Flex Code
19963 status collapsed
19964
19965 \begin_layout Plain Layout
19966 1
19967 \end_layout
19968
19969 \end_inset
19970
19971 ] As with paragraph styles, see
19972 \begin_inset CommandInset ref
19973 LatexCommand ref
19974 reference "subsec:Paragraph-Styles"
19975
19976 \end_inset
19977
19978 .
19979 \end_layout
19980
19981 \begin_layout Description
19982 \begin_inset Flex Code
19983 status collapsed
19984
19985 \begin_layout Plain Layout
19986 LabelFont
19987 \end_layout
19988
19989 \end_inset
19990
19991  The font used for the label.
19992  See
19993 \begin_inset CommandInset ref
19994 LatexCommand ref
19995 reference "subsec:Font-description"
19996
19997 \end_inset
19998
19999 .
20000  Note that this definition can never appear before
20001 \begin_inset Flex Code
20002 status collapsed
20003
20004 \begin_layout Plain Layout
20005 Font
20006 \end_layout
20007
20008 \end_inset
20009
20010 , lest it be ineffective.
20011 \end_layout
20012
20013 \begin_layout Description
20014 \begin_inset Flex Code
20015 status collapsed
20016
20017 \begin_layout Plain Layout
20018 LabelString
20019 \end_layout
20020
20021 \end_inset
20022
20023  [
20024 \begin_inset Flex Code
20025 status collapsed
20026
20027 \begin_layout Plain Layout
20028 string
20029 \end_layout
20030
20031 \end_inset
20032
20033 =
20034 \begin_inset Quotes erd
20035 \end_inset
20036
20037
20038 \begin_inset Quotes erd
20039 \end_inset
20040
20041 ] What will be displayed on the button or elsewhere as the inset label.
20042  Some inset types (
20043 \begin_inset Flex Code
20044 status collapsed
20045
20046 \begin_layout Plain Layout
20047 \SpecialChar TeX
20048  code
20049 \end_layout
20050
20051 \end_inset
20052
20053  and
20054 \begin_inset Flex Code
20055 status collapsed
20056
20057 \begin_layout Plain Layout
20058 Branch
20059 \end_layout
20060
20061 \end_inset
20062
20063 ) modify this label on the fly.
20064 \end_layout
20065
20066 \begin_layout Description
20067 \begin_inset Flex Code
20068 status collapsed
20069
20070 \begin_layout Plain Layout
20071 LangPreamble
20072 \end_layout
20073
20074 \end_inset
20075
20076  Language dependent preamble; see
20077 \begin_inset CommandInset ref
20078 LatexCommand ref
20079 reference "subsec:I18n"
20080
20081 \end_inset
20082
20083 .
20084 \end_layout
20085
20086 \begin_layout Description
20087 \begin_inset Flex Code
20088 status collapsed
20089
20090 \begin_layout Plain Layout
20091 LatexName
20092 \end_layout
20093
20094 \end_inset
20095
20096  [
20097 \begin_inset Flex Code
20098 status collapsed
20099
20100 \begin_layout Plain Layout
20101 <name>
20102 \end_layout
20103
20104 \end_inset
20105
20106 ] The name of the corresponding \SpecialChar LaTeX
20107  stuff.
20108  Either the environment or command name.
20109 \end_layout
20110
20111 \begin_layout Description
20112 \begin_inset Flex Code
20113 status collapsed
20114
20115 \begin_layout Plain Layout
20116 LatexParam
20117 \end_layout
20118
20119 \end_inset
20120
20121  [
20122 \begin_inset Flex Code
20123 status collapsed
20124
20125 \begin_layout Plain Layout
20126 <parameter>
20127 \end_layout
20128
20129 \end_inset
20130
20131 ] The optional parameter for the corresponding
20132 \begin_inset Flex Code
20133 status collapsed
20134
20135 \begin_layout Plain Layout
20136 LatexName
20137 \end_layout
20138
20139 \end_inset
20140
20141  stuff, including possible bracket pairs like
20142 \begin_inset Flex Code
20143 status collapsed
20144
20145 \begin_layout Plain Layout
20146 []
20147 \end_layout
20148
20149 \end_inset
20150
20151 .
20152  This parameter cannot be changed from within \SpecialChar LyX
20153  (use
20154 \begin_inset Flex Code
20155 status collapsed
20156
20157 \begin_layout Plain Layout
20158 Argument
20159 \end_layout
20160
20161 \end_inset
20162
20163  for customizable parameters).
20164  It will be output as is after all \SpecialChar LaTeX
20165
20166 \begin_inset Flex Code
20167 status collapsed
20168
20169 \begin_layout Plain Layout
20170 Argument
20171 \end_layout
20172
20173 \end_inset
20174
20175 s.
20176 \end_layout
20177
20178 \begin_layout Description
20179 \begin_inset Flex Code
20180 status collapsed
20181
20182 \begin_layout Plain Layout
20183 LatexType
20184 \end_layout
20185
20186 \end_inset
20187
20188  [
20189 \begin_inset Flex Code
20190 status collapsed
20191
20192 \begin_layout Plain Layout
20193 Command, Environment, None
20194 \end_layout
20195
20196 \end_inset
20197
20198 ] How the style should be translated into \SpecialChar LaTeX
20199 .
20200 \begin_inset Foot
20201 status collapsed
20202
20203 \begin_layout Plain Layout
20204 \begin_inset Flex Code
20205 status collapsed
20206
20207 \begin_layout Plain Layout
20208 LatexType
20209 \end_layout
20210
20211 \end_inset
20212
20213  is perhaps a bit misleading, since these rules apply to SGML classes too.
20214  Visit the SGML class files for specific examples.
20215 \end_layout
20216
20217 \end_inset
20218
20219
20220 \end_layout
20221
20222 \begin_deeper
20223 \begin_layout Description
20224 \begin_inset Flex Code
20225 status collapsed
20226
20227 \begin_layout Plain Layout
20228 None
20229 \end_layout
20230
20231 \end_inset
20232
20233  means nothing special
20234 \end_layout
20235
20236 \begin_layout Description
20237 \begin_inset Flex Code
20238 status collapsed
20239
20240 \begin_layout Plain Layout
20241 Command
20242 \end_layout
20243
20244 \end_inset
20245
20246  means
20247 \begin_inset Flex Code
20248 status collapsed
20249
20250 \begin_layout Plain Layout
20251
20252 \backslash
20253
20254 \emph on
20255 LatexName
20256 \emph default
20257 {\SpecialChar ldots
20258 }
20259 \end_layout
20260
20261 \end_inset
20262
20263
20264 \end_layout
20265
20266 \begin_layout Description
20267 \begin_inset Flex Code
20268 status collapsed
20269
20270 \begin_layout Plain Layout
20271 Environment
20272 \end_layout
20273
20274 \end_inset
20275
20276  means
20277 \begin_inset Flex Code
20278 status collapsed
20279
20280 \begin_layout Plain Layout
20281
20282 \backslash
20283 begin{
20284 \emph on
20285 LatexName
20286 \emph default
20287 }\SpecialChar ldots
20288
20289 \backslash
20290 end{
20291 \emph on
20292 LatexName
20293 \emph default
20294 }
20295 \end_layout
20296
20297 \end_inset
20298
20299
20300 \end_layout
20301
20302 \begin_layout Standard
20303 Putting the last few things together, the \SpecialChar LaTeX
20304  output will be either:
20305 \end_layout
20306
20307 \begin_layout LyX-Code
20308
20309 \backslash
20310 LatexName[LatexParam]{\SpecialChar ldots
20311 }
20312 \end_layout
20313
20314 \begin_layout Standard
20315 or:
20316 \end_layout
20317
20318 \begin_layout LyX-Code
20319
20320 \backslash
20321 begin{LatexName}[LatexParam] \SpecialChar ldots
20322
20323 \backslash
20324 end{LatexName}
20325 \end_layout
20326
20327 \begin_layout Standard
20328 depending upon the \SpecialChar LaTeX
20329  type.
20330 \end_layout
20331
20332 \end_deeper
20333 \begin_layout Description
20334 \begin_inset Flex Code
20335 status collapsed
20336
20337 \begin_layout Plain Layout
20338 LeftDelim
20339 \end_layout
20340
20341 \end_inset
20342
20343  [
20344 \begin_inset Flex Code
20345 status collapsed
20346
20347 \begin_layout Plain Layout
20348 string
20349 \end_layout
20350
20351 \end_inset
20352
20353 ] A string that is put at the beginning of the layout content.
20354  A line break in the output can be indicated by
20355 \begin_inset Flex Code
20356 status collapsed
20357
20358 \begin_layout Plain Layout
20359 <br/>
20360 \end_layout
20361
20362 \end_inset
20363
20364 .
20365 \end_layout
20366
20367 \begin_layout Description
20368 \begin_inset Flex Code
20369 status collapsed
20370
20371 \begin_layout Plain Layout
20372 LyxType
20373 \end_layout
20374
20375 \end_inset
20376
20377  Can be
20378 \begin_inset Flex Code
20379 status collapsed
20380
20381 \begin_layout Plain Layout
20382 charstyle
20383 \end_layout
20384
20385 \end_inset
20386
20387 ,
20388 \begin_inset Flex Code
20389 status collapsed
20390
20391 \begin_layout Plain Layout
20392 custom
20393 \end_layout
20394
20395 \end_inset
20396
20397 ,
20398 \begin_inset Flex Code
20399 status collapsed
20400
20401 \begin_layout Plain Layout
20402 element
20403 \end_layout
20404
20405 \end_inset
20406
20407  or
20408 \begin_inset Flex Code
20409 status collapsed
20410
20411 \begin_layout Plain Layout
20412 end
20413 \end_layout
20414
20415 \end_inset
20416
20417  (indicating a dummy definition ending definitions of charstyles, etc).
20418  This entry is required in and is only meaningful for Flex insets.
20419  Among other things, it determines on which menu this inset will appear.
20420  Setting
20421 \begin_inset Flex Code
20422 status collapsed
20423
20424 \begin_layout Plain Layout
20425 LyxType
20426 \end_layout
20427
20428 \end_inset
20429
20430  to
20431 \begin_inset Flex Code
20432 status collapsed
20433
20434 \begin_layout Plain Layout
20435 charstyle
20436 \end_layout
20437
20438 \end_inset
20439
20440  will automatically set
20441 \begin_inset Flex Code
20442 status collapsed
20443
20444 \begin_layout Plain Layout
20445 MultiPar
20446 \end_layout
20447
20448 \end_inset
20449
20450  to false and
20451 \begin_inset Flex Code
20452 status collapsed
20453
20454 \begin_layout Plain Layout
20455 ForcePlain
20456 \end_layout
20457
20458 \end_inset
20459
20460  to true.
20461
20462 \begin_inset Flex Code
20463 status collapsed
20464
20465 \begin_layout Plain Layout
20466 MultiPar
20467 \end_layout
20468
20469 \end_inset
20470
20471  can be set to true, or
20472 \begin_inset Flex Code
20473 status collapsed
20474
20475 \begin_layout Plain Layout
20476 ForcePlain
20477 \end_layout
20478
20479 \end_inset
20480
20481  to false, for
20482 \begin_inset Flex Code
20483 status collapsed
20484
20485 \begin_layout Plain Layout
20486 charstyle
20487 \end_layout
20488
20489 \end_inset
20490
20491  insets by setting it
20492 \emph on
20493 after
20494 \emph default
20495  you set the
20496 \begin_inset Flex Code
20497 status collapsed
20498
20499 \begin_layout Plain Layout
20500 LyxType
20501 \end_layout
20502
20503 \end_inset
20504
20505 .
20506 \change_inserted -712698321 1555575738
20507
20508 \end_layout
20509
20510 \begin_layout Description
20511
20512 \change_inserted -712698321 1555575844
20513 \begin_inset Flex Code
20514 status collapsed
20515
20516 \begin_layout Plain Layout
20517
20518 \change_inserted -712698321 1555575740
20519 MenuString
20520 \end_layout
20521
20522 \end_inset
20523
20524
20525 \begin_inset Flex Code
20526 status collapsed
20527
20528 \begin_layout Plain Layout
20529
20530 \change_inserted -712698321 1555575740
20531 [string]
20532 \end_layout
20533
20534 \end_inset
20535
20536  A dedicated string for the menu.
20537  You can define an accelerator by appending the respective character to
20538  the string, divided by
20539 \begin_inset Quotes eld
20540 \end_inset
20541
20542 |
20543 \begin_inset Quotes erd
20544 \end_inset
20545
20546  (e.
20547 \begin_inset space \thinspace{}
20548 \end_inset
20549
20550 g.
20551 \begin_inset space \space{}
20552 \end_inset
20553
20554
20555 \begin_inset Quotes eld
20556 \end_inset
20557
20558
20559 \begin_inset Flex Code
20560 status collapsed
20561
20562 \begin_layout Plain Layout
20563
20564 \change_inserted -712698321 1555575781
20565 My Inset|M
20566 \end_layout
20567
20568 \end_inset
20569
20570
20571 \begin_inset Quotes erd
20572 \end_inset
20573
20574 ).
20575  This specification is optional.
20576  If it is not given the inset name as specified in the type declaration
20577  will be used instead for the menu.
20578 \change_unchanged
20579
20580 \end_layout
20581
20582 \begin_layout Description
20583 \begin_inset Flex Code
20584 status collapsed
20585
20586 \begin_layout Plain Layout
20587 MultiPar
20588 \end_layout
20589
20590 \end_inset
20591
20592  [
20593 \begin_inset Flex Code
20594 status collapsed
20595
20596 \begin_layout Plain Layout
20597
20598 \emph on
20599 0
20600 \end_layout
20601
20602 \end_inset
20603
20604 ,
20605 \begin_inset space \thinspace{}
20606 \end_inset
20607
20608
20609 \begin_inset Flex Code
20610 status collapsed
20611
20612 \begin_layout Plain Layout
20613 1
20614 \end_layout
20615
20616 \end_inset
20617
20618 ] Whether multiple paragraphs are permitted in this inset.
20619  This will also set
20620 \begin_inset Flex Code
20621 status collapsed
20622
20623 \begin_layout Plain Layout
20624 CustomPars
20625 \end_layout
20626
20627 \end_inset
20628
20629  to the same value and
20630 \begin_inset Flex Code
20631 status collapsed
20632
20633 \begin_layout Plain Layout
20634 ForcePlain
20635 \end_layout
20636
20637 \end_inset
20638
20639  to the opposite value.
20640  These can be reset to other values, if they are used
20641 \emph on
20642 after
20643 \emph default
20644
20645 \begin_inset Flex Code
20646 status collapsed
20647
20648 \begin_layout Plain Layout
20649 MultiPar
20650 \end_layout
20651
20652 \end_inset
20653
20654 .
20655  Default is true.
20656 \end_layout
20657
20658 \begin_layout Description
20659 \begin_inset Flex Code
20660 status collapsed
20661
20662 \begin_layout Plain Layout
20663 NeedProtect
20664 \end_layout
20665
20666 \end_inset
20667
20668  [
20669 \begin_inset Flex Code
20670 status collapsed
20671
20672 \begin_layout Plain Layout
20673
20674 \emph on
20675 0
20676 \end_layout
20677
20678 \end_inset
20679
20680 ,
20681 \begin_inset space \thinspace{}
20682 \end_inset
20683
20684
20685 \begin_inset Flex Code
20686 status collapsed
20687
20688 \begin_layout Plain Layout
20689 1
20690 \end_layout
20691
20692 \end_inset
20693
20694 ] Whether fragile commands in this inset should be
20695 \begin_inset Flex Code
20696 status collapsed
20697
20698 \begin_layout Plain Layout
20699
20700 \backslash
20701 protect
20702 \end_layout
20703
20704 \end_inset
20705
20706 'ed.
20707  (Note: This is
20708 \emph on
20709 not
20710 \emph default
20711  whether the command should itself be protected.) Default is false.
20712 \change_inserted -712698321 1523633958
20713
20714 \end_layout
20715
20716 \begin_layout Description
20717
20718 \change_inserted -712698321 1552395786
20719 \begin_inset Flex Code
20720 status collapsed
20721
20722 \begin_layout Plain Layout
20723
20724 \change_inserted -712698321 1523633961
20725 NeedCProtect
20726 \end_layout
20727
20728 \end_inset
20729
20730  [
20731 \begin_inset Flex Code
20732 status collapsed
20733
20734 \begin_layout Plain Layout
20735
20736 \change_inserted -712698321 1523633958
20737
20738 \emph on
20739 0
20740 \end_layout
20741
20742 \end_inset
20743
20744 ,
20745 \begin_inset space \thinspace{}
20746 \end_inset
20747
20748
20749 \begin_inset Flex Code
20750 status collapsed
20751
20752 \begin_layout Plain Layout
20753
20754 \change_inserted -712698321 1523633958
20755 1
20756 \end_layout
20757
20758 \end_inset
20759
20760 ] This causes macros that contain this inset to be protected with
20761 \begin_inset Flex Code
20762 status collapsed
20763
20764 \begin_layout Plain Layout
20765
20766 \change_inserted -712698321 1523634038
20767
20768 \backslash
20769 cprotect
20770 \change_unchanged
20771
20772 \end_layout
20773
20774 \end_inset
20775
20776  (cf.
20777  package
20778 \family sans
20779 cprotect
20780 \family default
20781 ) if necessary and thus allows (some) verbatim stuff in macros.
20782  Default is false.
20783 \end_layout
20784
20785 \begin_layout Description
20786
20787 \change_inserted -712698321 1555579651
20788 \begin_inset Flex Code
20789 status collapsed
20790
20791 \begin_layout Plain Layout
20792
20793 \change_inserted -712698321 1552395787
20794 NeedMBoxProtect
20795 \end_layout
20796
20797 \end_inset
20798
20799  [
20800 \begin_inset Flex Code
20801 status collapsed
20802
20803 \begin_layout Plain Layout
20804
20805 \change_inserted -712698321 1552395787
20806
20807 \emph on
20808 0
20809 \end_layout
20810
20811 \end_inset
20812
20813 ,
20814 \begin_inset space \thinspace{}
20815 \end_inset
20816
20817
20818 \begin_inset Flex Code
20819 status collapsed
20820
20821 \begin_layout Plain Layout
20822
20823 \change_inserted -712698321 1552395787
20824 1
20825 \end_layout
20826
20827 \end_inset
20828
20829 ] Whether specific commands in this inset (such as
20830 \begin_inset Flex Code
20831 status collapsed
20832
20833 \begin_layout Plain Layout
20834
20835 \change_inserted -712698321 1552395787
20836
20837 \backslash
20838 cite
20839 \end_layout
20840
20841 \end_inset
20842
20843  and
20844 \begin_inset Flex Code
20845 status collapsed
20846
20847 \begin_layout Plain Layout
20848
20849 \change_inserted -712698321 1552395787
20850
20851 \backslash
20852 ref
20853 \end_layout
20854
20855 \end_inset
20856
20857 ) should be protected in an
20858 \begin_inset Flex Code
20859 status collapsed
20860
20861 \begin_layout Plain Layout
20862
20863 \change_inserted -712698321 1552395787
20864
20865 \backslash
20866 mbox
20867 \end_layout
20868
20869 \end_inset
20870
20871 .
20872  This is particularly needed for insets that draw on
20873 \family sans
20874 ulem
20875 \family default
20876  or
20877 \family sans
20878 soul
20879 \family default
20880  commands which parse their content in complex ways.
20881  Default is false.
20882 \end_layout
20883
20884 \begin_layout Description
20885
20886 \change_inserted -712698321 1555579742
20887 \begin_inset Flex Code
20888 status collapsed
20889
20890 \begin_layout Plain Layout
20891
20892 \change_inserted -712698321 1555579658
20893 NewlineCmd
20894 \end_layout
20895
20896 \end_inset
20897
20898
20899 \begin_inset Flex Code
20900 status collapsed
20901
20902 \begin_layout Plain Layout
20903
20904 \change_inserted -712698321 1555579651
20905 [string]
20906 \end_layout
20907
20908 \end_inset
20909
20910  Option to define a different command (from the default
20911 \begin_inset Flex Code
20912 status collapsed
20913
20914 \begin_layout Plain Layout
20915
20916 \change_inserted -712698321 1555579742
20917
20918 \backslash
20919
20920 \backslash
20921
20922 \change_unchanged
20923
20924 \end_layout
20925
20926 \end_inset
20927
20928 ) to be used for line breaks.
20929  The initial backslash must not be specified.
20930 \change_unchanged
20931
20932 \end_layout
20933
20934 \begin_layout Description
20935 \begin_inset Flex Code
20936 status collapsed
20937
20938 \begin_layout Plain Layout
20939 NoInsetLayout
20940 \end_layout
20941
20942 \end_inset
20943
20944  [
20945 \begin_inset Flex Code
20946 status collapsed
20947
20948 \begin_layout Plain Layout
20949 <layout>
20950 \end_layout
20951
20952 \end_inset
20953
20954 ] Deletes an existing
20955 \begin_inset Flex Code
20956 status collapsed
20957
20958 \begin_layout Plain Layout
20959 InsetLayout
20960 \end_layout
20961
20962 \end_inset
20963
20964 .
20965 \end_layout
20966
20967 \begin_layout Description
20968 \begin_inset Flex Code
20969 status collapsed
20970
20971 \begin_layout Plain Layout
20972 ObsoletedBy
20973 \end_layout
20974
20975 \end_inset
20976
20977  [
20978 \begin_inset Flex Code
20979 status collapsed
20980
20981 \begin_layout Plain Layout
20982 <layout>
20983 \end_layout
20984
20985 \end_inset
20986
20987 ] Name of an
20988 \begin_inset Flex Code
20989 status collapsed
20990
20991 \begin_layout Plain Layout
20992 InsetLayout
20993 \end_layout
20994
20995 \end_inset
20996
20997  that has replaced this
20998 \begin_inset Flex Code
20999 status collapsed
21000
21001 \begin_layout Plain Layout
21002 InsetLayout
21003 \end_layout
21004
21005 \end_inset
21006
21007 .
21008  This is used to rename an
21009 \begin_inset Flex Code
21010 status collapsed
21011
21012 \begin_layout Plain Layout
21013 InsetLayout
21014 \end_layout
21015
21016 \end_inset
21017
21018 , while keeping backward compatibility.
21019 \change_inserted -712698321 1559491850
21020
21021 \end_layout
21022
21023 \begin_layout Description
21024
21025 \change_inserted -712698321 1559492002
21026 \begin_inset Flex Code
21027 status collapsed
21028
21029 \begin_layout Plain Layout
21030
21031 \change_inserted -712698321 1559491854
21032 ParbreakIgnored
21033 \end_layout
21034
21035 \end_inset
21036
21037  [
21038 \begin_inset Flex Code
21039 status collapsed
21040
21041 \begin_layout Plain Layout
21042
21043 \change_inserted -712698321 1559491850
21044
21045 \emph on
21046 0
21047 \end_layout
21048
21049 \end_inset
21050
21051 ,
21052 \begin_inset space \thinspace{}
21053 \end_inset
21054
21055
21056 \begin_inset Flex Code
21057 status collapsed
21058
21059 \begin_layout Plain Layout
21060
21061 \change_inserted -712698321 1559491850
21062 1
21063 \end_layout
21064
21065 \end_inset
21066
21067 ] If this is set to
21068 \begin_inset Flex Code
21069 status collapsed
21070
21071 \begin_layout Plain Layout
21072
21073 \change_inserted -712698321 1559491881
21074 1
21075 \change_unchanged
21076
21077 \end_layout
21078
21079 \end_inset
21080
21081 , paragraph breaks will be ignored in the output.
21082  This might be useful for insets where the content should be alignable on
21083  different lines only in the \SpecialChar LyX
21084  workarea, without any effect in the output.
21085 \change_unchanged
21086
21087 \end_layout
21088
21089 \begin_layout Description
21090 \begin_inset Flex Code
21091 status collapsed
21092
21093 \begin_layout Plain Layout
21094 ParbreakIsNewline
21095 \end_layout
21096
21097 \end_inset
21098
21099  [
21100 \begin_inset Flex Code
21101 status collapsed
21102
21103 \begin_layout Plain Layout
21104
21105 \emph on
21106 0
21107 \end_layout
21108
21109 \end_inset
21110
21111 ,
21112 \begin_inset space \thinspace{}
21113 \end_inset
21114
21115
21116 \begin_inset Flex Code
21117 status collapsed
21118
21119 \begin_layout Plain Layout
21120 1
21121 \end_layout
21122
21123 \end_inset
21124
21125 ] As with paragraph styles, see
21126 \begin_inset CommandInset ref
21127 LatexCommand ref
21128 reference "subsec:Paragraph-Styles"
21129
21130 \end_inset
21131
21132 .
21133  Default is false.
21134 \end_layout
21135
21136 \begin_layout Description
21137 \begin_inset Flex Code
21138 status collapsed
21139
21140 \begin_layout Plain Layout
21141 PassThru
21142 \end_layout
21143
21144 \end_inset
21145
21146  [
21147 \begin_inset Flex Code
21148 status collapsed
21149
21150 \begin_layout Plain Layout
21151
21152 \emph on
21153 0
21154 \end_layout
21155
21156 \end_inset
21157
21158 ,
21159 \begin_inset space \thinspace{}
21160 \end_inset
21161
21162
21163 \begin_inset Flex Code
21164 status collapsed
21165
21166 \begin_layout Plain Layout
21167 1
21168 \end_layout
21169
21170 \end_inset
21171
21172 ] As with paragraph styles, see
21173 \begin_inset CommandInset ref
21174 LatexCommand ref
21175 reference "subsec:Paragraph-Styles"
21176
21177 \end_inset
21178
21179 .
21180  Default is false.
21181 \end_layout
21182
21183 \begin_layout Description
21184 \begin_inset Flex Code
21185 status collapsed
21186
21187 \begin_layout Plain Layout
21188 Preamble
21189 \end_layout
21190
21191 \end_inset
21192
21193  As with paragraph styles, see
21194 \begin_inset CommandInset ref
21195 LatexCommand ref
21196 reference "subsec:Paragraph-Styles"
21197
21198 \end_inset
21199
21200 .
21201 \end_layout
21202
21203 \begin_layout Description
21204 \begin_inset Flex Code
21205 status collapsed
21206
21207 \begin_layout Plain Layout
21208 RefPrefix
21209 \end_layout
21210
21211 \end_inset
21212
21213  [
21214 \begin_inset Flex Code
21215 status collapsed
21216
21217 \begin_layout Plain Layout
21218 string
21219 \end_layout
21220
21221 \end_inset
21222
21223 ] The prefix to use when creating labels referring to insets of this type.
21224  This allows the use of formatted references.
21225 \end_layout
21226
21227 \begin_layout Description
21228 \begin_inset Flex Code
21229 status collapsed
21230
21231 \begin_layout Plain Layout
21232 Requires
21233 \end_layout
21234
21235 \end_inset
21236
21237  [
21238 \begin_inset Flex Code
21239 status collapsed
21240
21241 \begin_layout Plain Layout
21242 string
21243 \end_layout
21244
21245 \end_inset
21246
21247 ] As with paragraph styles, see
21248 \begin_inset CommandInset ref
21249 LatexCommand ref
21250 reference "subsec:Paragraph-Styles"
21251
21252 \end_inset
21253
21254 .
21255 \end_layout
21256
21257 \begin_layout Description
21258 \begin_inset Flex Code
21259 status collapsed
21260
21261 \begin_layout Plain Layout
21262 ResetArgs
21263 \end_layout
21264
21265 \end_inset
21266
21267  [
21268 \begin_inset Flex Code
21269 status collapsed
21270
21271 \begin_layout Plain Layout
21272
21273 \emph on
21274 0
21275 \end_layout
21276
21277 \end_inset
21278
21279 ,
21280 \begin_inset space \thinspace{}
21281 \end_inset
21282
21283
21284 \begin_inset Flex Code
21285 status collapsed
21286
21287 \begin_layout Plain Layout
21288 1
21289 \end_layout
21290
21291 \end_inset
21292
21293 ] Resets the \SpecialChar LaTeX
21294  arguments of this layout (as defined via the
21295 \begin_inset Flex Code
21296 status collapsed
21297
21298 \begin_layout Plain Layout
21299 Argument
21300 \end_layout
21301
21302 \end_inset
21303
21304  tag).
21305  This is useful if you have copied a style via
21306 \begin_inset Flex Code
21307 status collapsed
21308
21309 \begin_layout Plain Layout
21310 CopyStyle
21311 \end_layout
21312
21313 \end_inset
21314
21315 , but you do not want to inherit its (required and optional) arguments.
21316 \end_layout
21317
21318 \begin_layout Description
21319 \begin_inset Flex Code
21320 status collapsed
21321
21322 \begin_layout Plain Layout
21323 ResetsFont
21324 \end_layout
21325
21326 \end_inset
21327
21328  [
21329 \begin_inset Flex Code
21330 status collapsed
21331
21332 \begin_layout Plain Layout
21333 0
21334 \end_layout
21335
21336 \end_inset
21337
21338 ,
21339 \begin_inset space \thinspace{}
21340 \end_inset
21341
21342
21343 \begin_inset Flex Code
21344 status collapsed
21345
21346 \begin_layout Plain Layout
21347
21348 \emph on
21349 1
21350 \end_layout
21351
21352 \end_inset
21353
21354 ] Whether this inset should use the font of its surrounding environment
21355  or uses its own.
21356  Default is false: use the font of the surrounding environment.
21357 \end_layout
21358
21359 \begin_layout Description
21360 \begin_inset Flex Code
21361 status collapsed
21362
21363 \begin_layout Plain Layout
21364 RightDelim
21365 \end_layout
21366
21367 \end_inset
21368
21369  [
21370 \begin_inset Flex Code
21371 status collapsed
21372
21373 \begin_layout Plain Layout
21374 string
21375 \end_layout
21376
21377 \end_inset
21378
21379 ] A string that is put at the end of the layout content.
21380  A line break in the output can be indicated by
21381 \begin_inset Flex Code
21382 status collapsed
21383
21384 \begin_layout Plain Layout
21385 <br/>
21386 \end_layout
21387
21388 \end_inset
21389
21390 .
21391 \end_layout
21392
21393 \begin_layout Description
21394 \begin_inset Flex Code
21395 status collapsed
21396
21397 \begin_layout Plain Layout
21398 Spellcheck
21399 \end_layout
21400
21401 \end_inset
21402
21403  [
21404 \begin_inset Flex Code
21405 status collapsed
21406
21407 \begin_layout Plain Layout
21408 0
21409 \end_layout
21410
21411 \end_inset
21412
21413 ,
21414 \begin_inset space \thinspace{}
21415 \end_inset
21416
21417
21418 \begin_inset Flex Code
21419 status collapsed
21420
21421 \begin_layout Plain Layout
21422
21423 \emph on
21424 1
21425 \end_layout
21426
21427 \end_inset
21428
21429 ] Allow spell-checking the contents of this inset.
21430  Default is true.
21431 \end_layout
21432
21433 \begin_layout Subsection
21434 Counters
21435 \begin_inset CommandInset label
21436 LatexCommand label
21437 name "subsec:Counters"
21438
21439 \end_inset
21440
21441
21442 \end_layout
21443
21444 \begin_layout Standard
21445 It is necessary to define the counters (
21446 \begin_inset Flex Noun
21447 status collapsed
21448
21449 \begin_layout Plain Layout
21450 chapter
21451 \end_layout
21452
21453 \end_inset
21454
21455 ,
21456 \begin_inset Flex Noun
21457 status collapsed
21458
21459 \begin_layout Plain Layout
21460 figure
21461 \end_layout
21462
21463 \end_inset
21464
21465 , \SpecialChar ldots
21466 ) in the text class itself.
21467  The standard counters are defined in the file
21468 \begin_inset Flex Code
21469 status collapsed
21470
21471 \begin_layout Plain Layout
21472 stdcounters.inc
21473 \end_layout
21474
21475 \end_inset
21476
21477 , so you may have to do no more than add
21478 \end_layout
21479
21480 \begin_layout LyX-Code
21481 Input stdcounters.inc
21482 \end_layout
21483
21484 \begin_layout Standard
21485 to your layout file to get them to work.
21486  But if you want to define custom counters, then you can do so.
21487  The counter declaration must begin with:
21488 \end_layout
21489
21490 \begin_layout LyX-Code
21491 Counter CounterName
21492 \end_layout
21493
21494 \begin_layout Standard
21495 where of course `
21496 \begin_inset Flex Code
21497 status collapsed
21498
21499 \begin_layout Plain Layout
21500 CounterName
21501 \end_layout
21502
21503 \end_inset
21504
21505 ' is replaced by the name of the counter.
21506  And it must end with
21507 \begin_inset Quotes eld
21508 \end_inset
21509
21510
21511 \begin_inset Flex Code
21512 status collapsed
21513
21514 \begin_layout Plain Layout
21515 End
21516 \end_layout
21517
21518 \end_inset
21519
21520
21521 \begin_inset Quotes erd
21522 \end_inset
21523
21524 .
21525  The following parameters can also be used:
21526 \end_layout
21527
21528 \begin_layout Description
21529 \begin_inset Flex Code
21530 status collapsed
21531
21532 \begin_layout Plain Layout
21533 InitialValue
21534 \end_layout
21535
21536 \end_inset
21537
21538  [
21539 \begin_inset Flex Code
21540 status collapsed
21541
21542 \begin_layout Plain Layout
21543 int=1
21544 \end_layout
21545
21546 \end_inset
21547
21548 ] Sets the initial value for the counter, to which it will be reset whenever
21549  that happens.
21550  Normally, one will want the default, 1.
21551 \end_layout
21552
21553 \begin_layout Description
21554 \begin_inset Flex Code
21555 status collapsed
21556
21557 \begin_layout Plain Layout
21558 LabelString
21559 \end_layout
21560
21561 \end_inset
21562
21563  [
21564 \begin_inset Flex Code
21565 status collapsed
21566
21567 \begin_layout Plain Layout
21568 string
21569 \end_layout
21570
21571 \end_inset
21572
21573 =
21574 \begin_inset Quotes erd
21575 \end_inset
21576
21577
21578 \begin_inset Quotes erd
21579 \end_inset
21580
21581 ] When defined, this string defines how the counter is displayed.
21582  Setting this value sets
21583 \begin_inset Flex Code
21584 status collapsed
21585
21586 \begin_layout Plain Layout
21587 LabelStringAppendix
21588 \end_layout
21589
21590 \end_inset
21591
21592  to the same value.
21593  The following special constructs can be used in the string:
21594 \end_layout
21595
21596 \begin_deeper
21597 \begin_layout Itemize
21598 \begin_inset Flex Code
21599 status collapsed
21600
21601 \begin_layout Plain Layout
21602
21603 \backslash
21604 thecounter
21605 \end_layout
21606
21607 \end_inset
21608
21609  will be replaced by the expansion of the
21610 \begin_inset Flex Code
21611 status collapsed
21612
21613 \begin_layout Plain Layout
21614 LabelString
21615 \end_layout
21616
21617 \end_inset
21618
21619  (or
21620 \begin_inset Flex Code
21621 status collapsed
21622
21623 \begin_layout Plain Layout
21624 LabelStringAppendix
21625 \end_layout
21626
21627 \end_inset
21628
21629 ) of the counter
21630 \begin_inset Flex Code
21631 status collapsed
21632
21633 \begin_layout Plain Layout
21634 counter
21635 \end_layout
21636
21637 \end_inset
21638
21639 .
21640
21641 \end_layout
21642
21643 \begin_layout Itemize
21644 counter values can be expressed using \SpecialChar LaTeX
21645 -like macros
21646 \begin_inset Newline newline
21647 \end_inset
21648
21649
21650 \begin_inset Flex Code
21651 status collapsed
21652
21653 \begin_layout Plain Layout
21654
21655 \backslash
21656
21657 \emph on
21658 numbertype
21659 \emph default
21660 {
21661 \emph on
21662 counter
21663 \emph default
21664 }
21665 \end_layout
21666
21667 \end_inset
21668
21669 , where
21670 \begin_inset Flex Code
21671 status collapsed
21672
21673 \begin_layout Plain Layout
21674
21675 \emph on
21676 numbertype
21677 \end_layout
21678
21679 \end_inset
21680
21681  can be:
21682 \begin_inset Foot
21683 status collapsed
21684
21685 \begin_layout Plain Layout
21686
21687 \family roman
21688 \series medium
21689 \shape up
21690 \size normal
21691 \emph off
21692 \bar no
21693 \noun off
21694 \color none
21695 Actually, the situation is a bit more complicated: any
21696 \family default
21697 \series default
21698 \shape default
21699 \emph default
21700 \bar default
21701
21702 \size default
21703 \emph on
21704 \noun default
21705 \color inherit
21706 numbertype
21707 \family roman
21708 \series medium
21709 \shape up
21710 \size normal
21711 \emph off
21712 \bar no
21713 \noun off
21714  other than those described below will produce arabic numerals.
21715  It would not be surprising to see this change in the future.
21716 \end_layout
21717
21718 \end_inset
21719
21720
21721 \begin_inset Flex Code
21722 status collapsed
21723
21724 \begin_layout Plain Layout
21725 arabic
21726 \end_layout
21727
21728 \end_inset
21729
21730 : 1, 2, 3,\SpecialChar ldots
21731 ;
21732 \begin_inset Flex Code
21733 status collapsed
21734
21735 \begin_layout Plain Layout
21736 alph
21737 \end_layout
21738
21739 \end_inset
21740
21741  for lower-case letters: a, b, c, \SpecialChar ldots
21742 ;
21743 \begin_inset Flex Code
21744 status collapsed
21745
21746 \begin_layout Plain Layout
21747 Alph
21748 \end_layout
21749
21750 \end_inset
21751
21752  for upper-case letters: A, B, C, \SpecialChar ldots
21753 ;
21754 \begin_inset Flex Code
21755 status collapsed
21756
21757 \begin_layout Plain Layout
21758 roman
21759 \end_layout
21760
21761 \end_inset
21762
21763  for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
21764 ;
21765 \begin_inset Flex Code
21766 status collapsed
21767
21768 \begin_layout Plain Layout
21769 Roman
21770 \end_layout
21771
21772 \end_inset
21773
21774  for upper-case roman numerals: I, II, III\SpecialChar ldots
21775 ;
21776 \begin_inset Flex Code
21777 status collapsed
21778
21779 \begin_layout Plain Layout
21780 hebrew
21781 \end_layout
21782
21783 \end_inset
21784
21785  for hebrew numerals.
21786 \end_layout
21787
21788 \end_deeper
21789 \begin_layout Standard
21790 If LabelString is not defined, a default value is constructed as follows:
21791  if the counter has a master counter
21792 \begin_inset Flex Code
21793 status collapsed
21794
21795 \begin_layout Plain Layout
21796 master
21797 \end_layout
21798
21799 \end_inset
21800
21801  (defined via
21802 \begin_inset Flex Code
21803 status collapsed
21804
21805 \begin_layout Plain Layout
21806 Within
21807 \end_layout
21808
21809 \end_inset
21810
21811 ), the string
21812 \begin_inset Newline newline
21813 \end_inset
21814
21815
21816 \begin_inset Flex Code
21817 status collapsed
21818
21819 \begin_layout Plain Layout
21820
21821 \backslash
21822 themaster.
21823 \backslash
21824 arabic{counter}
21825 \end_layout
21826
21827 \end_inset
21828
21829  is used; otherwise the string
21830 \begin_inset Flex Code
21831 status collapsed
21832
21833 \begin_layout Plain Layout
21834
21835 \backslash
21836 arabic{counter}
21837 \end_layout
21838
21839 \end_inset
21840
21841  is used.
21842 \end_layout
21843
21844 \begin_layout Description
21845 \begin_inset Flex Code
21846 status collapsed
21847
21848 \begin_layout Plain Layout
21849 LabelStringAppendix
21850 \end_layout
21851
21852 \end_inset
21853
21854  [
21855 \begin_inset Flex Code
21856 status collapsed
21857
21858 \begin_layout Plain Layout
21859 string
21860 \end_layout
21861
21862 \end_inset
21863
21864 =
21865 \begin_inset Quotes erd
21866 \end_inset
21867
21868
21869 \begin_inset Quotes erd
21870 \end_inset
21871
21872 ] Same as
21873 \begin_inset Flex Code
21874 status collapsed
21875
21876 \begin_layout Plain Layout
21877 LabelString
21878 \end_layout
21879
21880 \end_inset
21881
21882 , but for use in the Appendix.
21883 \end_layout
21884
21885 \begin_layout Description
21886 \begin_inset Flex Code
21887 status collapsed
21888
21889 \begin_layout Plain Layout
21890 PrettyFormat
21891 \end_layout
21892
21893 \end_inset
21894
21895  [
21896 \begin_inset Flex Code
21897 status collapsed
21898
21899 \begin_layout Plain Layout
21900 string
21901 \end_layout
21902
21903 \end_inset
21904
21905 =
21906 \begin_inset Quotes erd
21907 \end_inset
21908
21909
21910 \begin_inset Quotes erd
21911 \end_inset
21912
21913 ] A format for use with formatted references to this counter.
21914  For example, one might want to have references to section numbers appear
21915  as
21916 \begin_inset Quotes eld
21917 \end_inset
21918
21919 Section 2.4
21920 \begin_inset Quotes erd
21921 \end_inset
21922
21923 .
21924  The string should contain
21925 \begin_inset Quotes eld
21926 \end_inset
21927
21928 ##
21929 \begin_inset Quotes erd
21930 \end_inset
21931
21932 .
21933  This will be replaced by the counter number itself.
21934  So, for sections, it would be: Section ##.
21935 \end_layout
21936
21937 \begin_layout Description
21938 \begin_inset Flex Code
21939 status collapsed
21940
21941 \begin_layout Plain Layout
21942 Within
21943 \end_layout
21944
21945 \end_inset
21946
21947  [
21948 \begin_inset Flex Code
21949 status collapsed
21950
21951 \begin_layout Plain Layout
21952 string
21953 \end_layout
21954
21955 \end_inset
21956
21957 =
21958 \begin_inset Quotes erd
21959 \end_inset
21960
21961
21962 \begin_inset Quotes erd
21963 \end_inset
21964
21965 ] If this is set to the name of another counter, the present counter will
21966  be reset every time the other one is increased.
21967  For example,
21968 \begin_inset Flex Code
21969 status collapsed
21970
21971 \begin_layout Plain Layout
21972 subsection
21973 \end_layout
21974
21975 \end_inset
21976
21977  is numbered inside
21978 \begin_inset Flex Code
21979 status collapsed
21980
21981 \begin_layout Plain Layout
21982 section
21983 \end_layout
21984
21985 \end_inset
21986
21987 .
21988 \end_layout
21989
21990 \begin_layout Subsection
21991 Font description
21992 \begin_inset CommandInset label
21993 LatexCommand label
21994 name "subsec:Font-description"
21995
21996 \end_inset
21997
21998
21999 \end_layout
22000
22001 \begin_layout Standard
22002 A font description looks like this:
22003 \end_layout
22004
22005 \begin_layout LyX-Code
22006 Font
22007 \family roman
22008 \emph on
22009 or
22010 \family default
22011 \emph default
22012  LabelFont
22013 \emph on
22014
22015 \family roman
22016 or
22017 \family default
22018 \emph default
22019  DefaultFont
22020 \end_layout
22021
22022 \begin_layout LyX-Code
22023  ...
22024 \end_layout
22025
22026 \begin_layout LyX-Code
22027 EndFont
22028 \end_layout
22029
22030 \begin_layout Standard
22031 The following commands are available:
22032 \end_layout
22033
22034 \begin_layout Description
22035 \begin_inset Flex Code
22036 status collapsed
22037
22038 \begin_layout Plain Layout
22039 Color
22040 \end_layout
22041
22042 \end_inset
22043
22044  [
22045 \begin_inset Flex Code
22046 status collapsed
22047
22048 \begin_layout Plain Layout
22049
22050 \emph on
22051 none
22052 \end_layout
22053
22054 \end_inset
22055
22056 ,
22057 \begin_inset Flex Code
22058 status collapsed
22059
22060 \begin_layout Plain Layout
22061 black
22062 \end_layout
22063
22064 \end_inset
22065
22066 ,
22067 \begin_inset Flex Code
22068 status collapsed
22069
22070 \begin_layout Plain Layout
22071 white
22072 \end_layout
22073
22074 \end_inset
22075
22076 ,
22077 \begin_inset Flex Code
22078 status collapsed
22079
22080 \begin_layout Plain Layout
22081 red
22082 \end_layout
22083
22084 \end_inset
22085
22086 ,
22087 \begin_inset Flex Code
22088 status collapsed
22089
22090 \begin_layout Plain Layout
22091 green
22092 \end_layout
22093
22094 \end_inset
22095
22096 ,
22097 \begin_inset Flex Code
22098 status collapsed
22099
22100 \begin_layout Plain Layout
22101 blue
22102 \end_layout
22103
22104 \end_inset
22105
22106 ,
22107 \begin_inset Flex Code
22108 status collapsed
22109
22110 \begin_layout Plain Layout
22111 cyan
22112 \end_layout
22113
22114 \end_inset
22115
22116 ,
22117 \begin_inset Flex Code
22118 status collapsed
22119
22120 \begin_layout Plain Layout
22121 magenta
22122 \end_layout
22123
22124 \end_inset
22125
22126 ,
22127 \begin_inset Flex Code
22128 status collapsed
22129
22130 \begin_layout Plain Layout
22131 yellow
22132 \end_layout
22133
22134 \end_inset
22135
22136 ,
22137 \begin_inset Flex Code
22138 status collapsed
22139
22140 \begin_layout Plain Layout
22141 brown
22142 \end_layout
22143
22144 \end_inset
22145
22146 ,
22147 \begin_inset Flex Code
22148 status collapsed
22149
22150 \begin_layout Plain Layout
22151 darkgray
22152 \end_layout
22153
22154 \end_inset
22155
22156 ,
22157 \begin_inset Flex Code
22158 status collapsed
22159
22160 \begin_layout Plain Layout
22161 gray
22162 \end_layout
22163
22164 \end_inset
22165
22166 ,
22167 \begin_inset Flex Code
22168 status collapsed
22169
22170 \begin_layout Plain Layout
22171 lightgray
22172 \end_layout
22173
22174 \end_inset
22175
22176 ,
22177 \begin_inset Flex Code
22178 status collapsed
22179
22180 \begin_layout Plain Layout
22181 lime
22182 \end_layout
22183
22184 \end_inset
22185
22186 ,
22187 \begin_inset Flex Code
22188 status collapsed
22189
22190 \begin_layout Plain Layout
22191 orange
22192 \end_layout
22193
22194 \end_inset
22195
22196 ,
22197 \begin_inset Flex Code
22198 status collapsed
22199
22200 \begin_layout Plain Layout
22201 olive
22202 \end_layout
22203
22204 \end_inset
22205
22206 ,
22207 \begin_inset Flex Code
22208 status collapsed
22209
22210 \begin_layout Plain Layout
22211 pink
22212 \end_layout
22213
22214 \end_inset
22215
22216 ,
22217 \begin_inset Flex Code
22218 status collapsed
22219
22220 \begin_layout Plain Layout
22221 purple
22222 \end_layout
22223
22224 \end_inset
22225
22226 ,
22227 \begin_inset Flex Code
22228 status collapsed
22229
22230 \begin_layout Plain Layout
22231 teal
22232 \end_layout
22233
22234 \end_inset
22235
22236 ,
22237 \begin_inset Flex Code
22238 status collapsed
22239
22240 \begin_layout Plain Layout
22241 violet
22242 \end_layout
22243
22244 \end_inset
22245
22246 ]
22247 \end_layout
22248
22249 \begin_layout Description
22250 \begin_inset Flex Code
22251 status collapsed
22252
22253 \begin_layout Plain Layout
22254 Family
22255 \end_layout
22256
22257 \end_inset
22258
22259  [
22260 \begin_inset Flex Code
22261 status collapsed
22262
22263 \begin_layout Plain Layout
22264
22265 \emph on
22266 Roman
22267 \end_layout
22268
22269 \end_inset
22270
22271 ,
22272 \begin_inset Flex Code
22273 status collapsed
22274
22275 \begin_layout Plain Layout
22276 Sans
22277 \end_layout
22278
22279 \end_inset
22280
22281 ,
22282 \begin_inset Flex Code
22283 status collapsed
22284
22285 \begin_layout Plain Layout
22286 Typewriter
22287 \end_layout
22288
22289 \end_inset
22290
22291 ]
22292 \end_layout
22293
22294 \begin_layout Description
22295 \begin_inset Flex Code
22296 status collapsed
22297
22298 \begin_layout Plain Layout
22299 Misc
22300 \end_layout
22301
22302 \end_inset
22303
22304  [
22305 \begin_inset Flex Code
22306 status collapsed
22307
22308 \begin_layout Plain Layout
22309 string
22310 \end_layout
22311
22312 \end_inset
22313
22314 ] Valid arguments are:
22315 \begin_inset Flex Code
22316 status collapsed
22317
22318 \begin_layout Plain Layout
22319 emph
22320 \end_layout
22321
22322 \end_inset
22323
22324 ,
22325 \begin_inset Flex Code
22326 status collapsed
22327
22328 \begin_layout Plain Layout
22329 noun
22330 \end_layout
22331
22332 \end_inset
22333
22334 ,
22335 \begin_inset Flex Code
22336 status collapsed
22337
22338 \begin_layout Plain Layout
22339 strikeout
22340 \end_layout
22341
22342 \end_inset
22343
22344 ,
22345 \begin_inset Flex Code
22346 status collapsed
22347
22348 \begin_layout Plain Layout
22349 underbar
22350 \end_layout
22351
22352 \end_inset
22353
22354 ,
22355 \begin_inset Flex Code
22356 status collapsed
22357
22358 \begin_layout Plain Layout
22359 uuline
22360 \end_layout
22361
22362 \end_inset
22363
22364 ,
22365 \begin_inset Flex Code
22366 status collapsed
22367
22368 \begin_layout Plain Layout
22369 uwave
22370 \end_layout
22371
22372 \end_inset
22373
22374 ,
22375 \begin_inset Flex Code
22376 status collapsed
22377
22378 \begin_layout Plain Layout
22379 no_emph
22380 \end_layout
22381
22382 \end_inset
22383
22384 ,
22385 \begin_inset Flex Code
22386 status collapsed
22387
22388 \begin_layout Plain Layout
22389 no_noun
22390 \end_layout
22391
22392 \end_inset
22393
22394 ,
22395 \begin_inset Flex Code
22396 status collapsed
22397
22398 \begin_layout Plain Layout
22399 no_strikeout
22400 \end_layout
22401
22402 \end_inset
22403
22404 ,
22405 \begin_inset Flex Code
22406 status collapsed
22407
22408 \begin_layout Plain Layout
22409 no_bar
22410 \end_layout
22411
22412 \end_inset
22413
22414 ,
22415 \begin_inset Flex Code
22416 status collapsed
22417
22418 \begin_layout Plain Layout
22419 no_uuline
22420 \end_layout
22421
22422 \end_inset
22423
22424  and
22425 \begin_inset Flex Code
22426 status collapsed
22427
22428 \begin_layout Plain Layout
22429 no_uwave
22430 \end_layout
22431
22432 \end_inset
22433
22434 .
22435  Each of these turns on or off the corresponding attribute.
22436  For example,
22437 \begin_inset Flex Code
22438 status collapsed
22439
22440 \begin_layout Plain Layout
22441 emph
22442 \end_layout
22443
22444 \end_inset
22445
22446  turns on emphasis, and
22447 \begin_inset Flex Code
22448 status collapsed
22449
22450 \begin_layout Plain Layout
22451 no_emph
22452 \end_layout
22453
22454 \end_inset
22455
22456  turns it off.
22457
22458 \begin_inset Newline newline
22459 \end_inset
22460
22461 If the latter seems puzzling, remember that the font settings for the present
22462  context are generally inherited from the surrounding context.
22463  So
22464 \begin_inset Flex Code
22465 status collapsed
22466
22467 \begin_layout Plain Layout
22468 no_emph
22469 \end_layout
22470
22471 \end_inset
22472
22473  would turn off the emphasis that was anyway in effect, say, in a theorem
22474  environment.
22475 \end_layout
22476
22477 \begin_layout Description
22478 \begin_inset Flex Code
22479 status collapsed
22480
22481 \begin_layout Plain Layout
22482 Series
22483 \end_layout
22484
22485 \end_inset
22486
22487  [
22488 \begin_inset Flex Code
22489 status collapsed
22490
22491 \begin_layout Plain Layout
22492
22493 \emph on
22494 Medium
22495 \end_layout
22496
22497 \end_inset
22498
22499 ,
22500 \begin_inset Flex Code
22501 status collapsed
22502
22503 \begin_layout Plain Layout
22504 Bold
22505 \end_layout
22506
22507 \end_inset
22508
22509 ]
22510 \end_layout
22511
22512 \begin_layout Description
22513 \begin_inset Flex Code
22514 status collapsed
22515
22516 \begin_layout Plain Layout
22517 Shape
22518 \end_layout
22519
22520 \end_inset
22521
22522  [
22523 \begin_inset Flex Code
22524 status collapsed
22525
22526 \begin_layout Plain Layout
22527
22528 \emph on
22529 Up
22530 \end_layout
22531
22532 \end_inset
22533
22534 ,
22535 \begin_inset Flex Code
22536 status collapsed
22537
22538 \begin_layout Plain Layout
22539 Italic
22540 \end_layout
22541
22542 \end_inset
22543
22544 ,
22545 \begin_inset Flex Code
22546 status collapsed
22547
22548 \begin_layout Plain Layout
22549 SmallCaps
22550 \end_layout
22551
22552 \end_inset
22553
22554 ,
22555 \begin_inset Flex Code
22556 status collapsed
22557
22558 \begin_layout Plain Layout
22559 Slanted
22560 \end_layout
22561
22562 \end_inset
22563
22564 ]
22565 \end_layout
22566
22567 \begin_layout Description
22568 \begin_inset Flex Code
22569 status collapsed
22570
22571 \begin_layout Plain Layout
22572 Size
22573 \end_layout
22574
22575 \end_inset
22576
22577  [
22578 \begin_inset Flex Code
22579 status collapsed
22580
22581 \begin_layout Plain Layout
22582 tiny
22583 \end_layout
22584
22585 \end_inset
22586
22587 ,
22588 \begin_inset Flex Code
22589 status collapsed
22590
22591 \begin_layout Plain Layout
22592 small
22593 \end_layout
22594
22595 \end_inset
22596
22597 ,
22598 \begin_inset Flex Code
22599 status collapsed
22600
22601 \begin_layout Plain Layout
22602
22603 \emph on
22604 normal
22605 \end_layout
22606
22607 \end_inset
22608
22609 ,
22610 \begin_inset Flex Code
22611 status collapsed
22612
22613 \begin_layout Plain Layout
22614 large
22615 \end_layout
22616
22617 \end_inset
22618
22619 ,
22620 \begin_inset Flex Code
22621 status collapsed
22622
22623 \begin_layout Plain Layout
22624 larger
22625 \end_layout
22626
22627 \end_inset
22628
22629 ,
22630 \begin_inset Flex Code
22631 status collapsed
22632
22633 \begin_layout Plain Layout
22634 largest
22635 \end_layout
22636
22637 \end_inset
22638
22639 ,
22640 \begin_inset Flex Code
22641 status collapsed
22642
22643 \begin_layout Plain Layout
22644 huge
22645 \end_layout
22646
22647 \end_inset
22648
22649 ,
22650 \begin_inset Flex Code
22651 status collapsed
22652
22653 \begin_layout Plain Layout
22654 giant
22655 \end_layout
22656
22657 \end_inset
22658
22659 ]
22660 \end_layout
22661
22662 \begin_layout Subsection
22663 \begin_inset CommandInset label
22664 LatexCommand label
22665 name "subsec:Citation-engine-description"
22666
22667 \end_inset
22668
22669 Cite engine description
22670 \end_layout
22671
22672 \begin_layout Standard
22673 The
22674 \begin_inset Flex Code
22675 status collapsed
22676
22677 \begin_layout Plain Layout
22678 CiteEngine
22679 \end_layout
22680
22681 \end_inset
22682
22683  blocks, as used mainly in cite engine files (see
22684 \begin_inset CommandInset ref
22685 LatexCommand ref
22686 reference "subsec:Cite-Engine-Files"
22687 plural "false"
22688 caps "false"
22689 noprefix "false"
22690
22691 \end_inset
22692
22693 ), define the citation commands provided by a specific
22694 \begin_inset Quotes eld
22695 \end_inset
22696
22697 cite engine
22698 \begin_inset Quotes erd
22699 \end_inset
22700
22701 .
22702  A cite engine, in \SpecialChar LyX
22703  terms, is way specific way to format citations, using
22704  numbers, author names and/or years.
22705  Currently, \SpecialChar LyX
22706  supports three such engine types, namely:
22707 \end_layout
22708
22709 \begin_layout Enumerate
22710 \begin_inset Flex Code
22711 status collapsed
22712
22713 \begin_layout Plain Layout
22714 default
22715 \end_layout
22716
22717 \end_inset
22718
22719 : the default Bib\SpecialChar TeX
22720  way to format citations, a simple numeric style (e.
22721 \begin_inset space \thinspace{}
22722 \end_inset
22723
22724 g.,
22725 \begin_inset Quotes eld
22726 \end_inset
22727
22728 [1]
22729 \begin_inset Quotes erd
22730 \end_inset
22731
22732 )
22733 \end_layout
22734
22735 \begin_layout Enumerate
22736 \begin_inset Flex Code
22737 status collapsed
22738
22739 \begin_layout Plain Layout
22740 authoryear
22741 \end_layout
22742
22743 \end_inset
22744
22745 : Harvard-styled citations using author names and publication year (e.
22746 \begin_inset space \thinspace{}
22747 \end_inset
22748
22749 g.,
22750 \begin_inset Quotes eld
22751 \end_inset
22752
22753 Smith and Miller (2017b)
22754 \begin_inset Quotes erd
22755 \end_inset
22756
22757 )
22758 \end_layout
22759
22760 \begin_layout Enumerate
22761 \begin_inset Flex Code
22762 status collapsed
22763
22764 \begin_layout Plain Layout
22765 numerical
22766 \end_layout
22767
22768 \end_inset
22769
22770 : extended numerical citations that also allow for author or title next
22771  to the number (e.
22772 \begin_inset space \thinspace{}
22773 \end_inset
22774
22775 g.,
22776 \begin_inset Quotes eld
22777 \end_inset
22778
22779 Smith and Miller [1]
22780 \begin_inset Quotes erd
22781 \end_inset
22782
22783 )
22784 \end_layout
22785
22786 \begin_layout Standard
22787 \begin_inset Flex Code
22788 status collapsed
22789
22790 \begin_layout Plain Layout
22791 CiteEngine
22792 \end_layout
22793
22794 \end_inset
22795
22796  blocks look like this:
22797 \end_layout
22798
22799 \begin_layout LyX-Code
22800 CiteEngine default
22801 \end_layout
22802
22803 \begin_layout LyX-Code
22804  cite
22805 \end_layout
22806
22807 \begin_layout LyX-Code
22808  Citep*[][]
22809 \end_layout
22810
22811 \begin_layout LyX-Code
22812  citeyearpar[][]=parencite*
22813 \end_layout
22814
22815 \begin_layout LyX-Code
22816  ...
22817 \end_layout
22818
22819 \begin_layout LyX-Code
22820 End
22821 \end_layout
22822
22823 \begin_layout Standard
22824 The tag following
22825 \begin_inset Flex Code
22826 status collapsed
22827
22828 \begin_layout Plain Layout
22829 CiteEngine
22830 \end_layout
22831
22832 \end_inset
22833
22834  denotes the engine.
22835  The individual lines respectively define a cite command or cite command
22836  paradigm supported by this engine.
22837  The line can be as simple as a cite command that is used both to name the
22838  respective \SpecialChar LyX
22839  command and the \SpecialChar LaTeX
22840  output or more complex in order to differentiate
22841  things.
22842  The full syntax is:
22843 \end_layout
22844
22845 \begin_layout LyX-Code
22846 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
22847 \end_layout
22848
22849 \begin_layout Itemize
22850 \begin_inset Flex Code
22851 status collapsed
22852
22853 \begin_layout Plain Layout
22854 LyXName
22855 \end_layout
22856
22857 \end_inset
22858
22859 : The name as used in the
22860 \begin_inset Flex Code
22861 status collapsed
22862
22863 \begin_layout Plain Layout
22864 *.lyx
22865 \end_layout
22866
22867 \end_inset
22868
22869  file.
22870 \end_layout
22871
22872 \begin_deeper
22873 \begin_layout Standard
22874 For portability reasons, we try to use the same name for same-formatted
22875  commands in different cite packages (thus many names stem from natbib,
22876  and thus we need to differentiate a
22877 \begin_inset Flex Code
22878 status collapsed
22879
22880 \begin_layout Plain Layout
22881 latexcmd
22882 \end_layout
22883
22884 \end_inset
22885
22886  sometimes, if the \SpecialChar LaTeX
22887  command names differ).
22888 \end_layout
22889
22890 \end_deeper
22891 \begin_layout Itemize
22892 \begin_inset Flex Code
22893 status collapsed
22894
22895 \begin_layout Plain Layout
22896 alias
22897 \end_layout
22898
22899 \end_inset
22900
22901 : a (comma-separated) list of commands that fall back to the given
22902 \begin_inset Flex Code
22903 status collapsed
22904
22905 \begin_layout Plain Layout
22906 LyXName
22907 \end_layout
22908
22909 \end_inset
22910
22911  in the current engine.
22912  This eases the switch of citation packages and engines.
22913  The
22914 \begin_inset Flex Code
22915 status collapsed
22916
22917 \begin_layout Plain Layout
22918 alias
22919 \end_layout
22920
22921 \end_inset
22922
22923  can be compared to
22924 \begin_inset Flex Code
22925 status collapsed
22926
22927 \begin_layout Plain Layout
22928 ObsoletedBy
22929 \end_layout
22930
22931 \end_inset
22932
22933  in layout definitions.
22934 \end_layout
22935
22936 \begin_layout Itemize
22937 \begin_inset Flex Code
22938 status collapsed
22939
22940 \begin_layout Plain Layout
22941 latexcmd
22942 \end_layout
22943
22944 \end_inset
22945
22946 : The actual \SpecialChar LaTeX
22947  command that is output.
22948
22949 \end_layout
22950
22951 \begin_layout Standard
22952 \begin_inset Flex Code
22953 status collapsed
22954
22955 \begin_layout Plain Layout
22956 Alias
22957 \end_layout
22958
22959 \end_inset
22960
22961  and
22962 \begin_inset Flex Code
22963 status collapsed
22964
22965 \begin_layout Plain Layout
22966 latexcmd
22967 \end_layout
22968
22969 \end_inset
22970
22971  are optional.
22972  If no
22973 \begin_inset Flex Code
22974 status collapsed
22975
22976 \begin_layout Plain Layout
22977 latexcmd
22978 \end_layout
22979
22980 \end_inset
22981
22982  is given, the
22983 \begin_inset Flex Code
22984 status collapsed
22985
22986 \begin_layout Plain Layout
22987 LyXName
22988 \end_layout
22989
22990 \end_inset
22991
22992  will be output to \SpecialChar LaTeX
22993 .
22994 \end_layout
22995
22996 \begin_layout Standard
22997 Note further:
22998 \end_layout
22999
23000 \begin_layout Itemize
23001 Capitalization indicates that the command also has a capitalized form (
23002 \begin_inset Flex Code
23003 status collapsed
23004
23005 \begin_layout Plain Layout
23006
23007 \backslash
23008 Latexcmd
23009 \end_layout
23010
23011 \end_inset
23012
23013  vs.
23014
23015 \begin_inset Flex Code
23016 status collapsed
23017
23018 \begin_layout Plain Layout
23019
23020 \backslash
23021 latexcmd
23022 \end_layout
23023
23024 \end_inset
23025
23026 ).
23027  These usually enforce up-casing of name prefixes (
23028 \emph on
23029 von Goethe
23030 \emph default
23031
23032 \begin_inset Formula $\Rightarrow$
23033 \end_inset
23034
23035
23036 \emph on
23037 Von Goethe
23038 \emph default
23039 ).
23040 \end_layout
23041
23042 \begin_layout Itemize
23043 Brackets
23044 \begin_inset Flex Code
23045 status collapsed
23046
23047 \begin_layout Plain Layout
23048 []
23049 \end_layout
23050
23051 \end_inset
23052
23053  indicate the number of optional arguments (there can be 0–2).
23054 \end_layout
23055
23056 \begin_layout Itemize
23057 A star
23058 \begin_inset Flex Code
23059 status collapsed
23060
23061 \begin_layout Plain Layout
23062 *
23063 \end_layout
23064
23065 \end_inset
23066
23067  indicates there is a starred version of the command (
23068 \begin_inset Flex Code
23069 status collapsed
23070
23071 \begin_layout Plain Layout
23072
23073 \backslash
23074 latexcmd*
23075 \end_layout
23076
23077 \end_inset
23078
23079  vs.
23080
23081 \begin_inset Flex Code
23082 status collapsed
23083
23084 \begin_layout Plain Layout
23085
23086 \backslash
23087 latexcmd
23088 \end_layout
23089
23090 \end_inset
23091
23092 ).
23093
23094 \end_layout
23095
23096 \begin_deeper
23097 \begin_layout Standard
23098 By default, the starred version means: Output all authors even if it should
23099  be shortened with
23100 \begin_inset Quotes eld
23101 \end_inset
23102
23103 et al.
23104 \begin_inset Quotes erd
23105 \end_inset
23106
23107  due to the
23108 \begin_inset Flex Code
23109 status collapsed
23110
23111 \begin_layout Plain Layout
23112 MaxCiteNames
23113 \end_layout
23114
23115 \end_inset
23116
23117  threshold.
23118 \end_layout
23119
23120 \begin_layout Standard
23121 If the star has a different meaning for a given command, it can be specified
23122  in angle brackets:
23123 \begin_inset Flex Code
23124 status collapsed
23125
23126 \begin_layout Plain Layout
23127 <!_stardesc!_stardesctooltip>
23128 \end_layout
23129
23130 \end_inset
23131
23132 .
23133  Maximal two translatable macro keywords, marked by the prefix
23134 \begin_inset Flex Code
23135 status collapsed
23136
23137 \begin_layout Plain Layout
23138 !_
23139 \end_layout
23140
23141 \end_inset
23142
23143 , can be given.
23144  The first points to the string that replaces the
23145 \begin_inset Quotes eld
23146 \end_inset
23147
23148 Full aut&hor list
23149 \begin_inset Quotes erd
23150 \end_inset
23151
23152  checkbox label in the citation dialog, the second one to an optional tool
23153  tip for this checkbox.
23154
23155 \end_layout
23156
23157 \begin_layout Standard
23158 Note that these two macros have to be defined in a
23159 \begin_inset Flex Code
23160 status collapsed
23161
23162 \begin_layout Plain Layout
23163 CiteFormat
23164 \end_layout
23165
23166 \end_inset
23167
23168  (see next section), dropping the
23169 \begin_inset Flex Code
23170 status collapsed
23171
23172 \begin_layout Plain Layout
23173 !
23174 \end_layout
23175
23176 \end_inset
23177
23178  from the prefix, like this:
23179 \end_layout
23180
23181 \begin_layout LyX-Code
23182 _stardesc Sta&rred command label
23183 \end_layout
23184
23185 \begin_layout LyX-Code
23186 _stardesctooltip Tooltip for the starred command checkbox.
23187 \end_layout
23188
23189 \end_deeper
23190 \begin_layout Itemize
23191 A dollar sign
23192 \begin_inset Flex Code
23193 status collapsed
23194
23195 \begin_layout Plain Layout
23196 $
23197 \end_layout
23198
23199 \end_inset
23200
23201  indicates that this command features
23202 \begin_inset Quotes eld
23203 \end_inset
23204
23205 qualified citation lists
23206 \begin_inset Quotes erd
23207 \end_inset
23208
23209 .
23210  This is a
23211 \family sans
23212 Biblatex
23213 \family default
23214 -specific feature for multi-reference citations where an individual pre-
23215  and postnote can be given to each reference in the list.
23216  Please refer to the
23217 \family sans
23218 Biblatex
23219 \family default
23220  manual for details.
23221 \change_inserted -712698321 1526898670
23222
23223 \end_layout
23224
23225 \begin_layout Standard
23226
23227 \change_inserted -712698321 1526899524
23228 If you want to add a cite command to a cite engine (e.
23229 \begin_inset space \thinspace{}
23230 \end_inset
23231
23232 g., add a specific command provided by a class), you can use
23233 \begin_inset Flex Code
23234 status collapsed
23235
23236 \begin_layout Plain Layout
23237
23238 \change_inserted -712698321 1526898768
23239 AddToCiteEngine <engine type> \SpecialChar ldots
23240  End
23241 \change_unchanged
23242
23243 \end_layout
23244
23245 \end_inset
23246
23247 .
23248  Note that only cite commands that do not exist yet are added.
23249 \change_unchanged
23250
23251 \end_layout
23252
23253 \begin_layout Subsection
23254 \begin_inset CommandInset label
23255 LatexCommand label
23256 name "subsec:Citation-format-description"
23257
23258 \end_inset
23259
23260 Cite format description
23261 \end_layout
23262
23263 \begin_layout Standard
23264 The
23265 \begin_inset Flex Code
23266 status collapsed
23267
23268 \begin_layout Plain Layout
23269 CiteFormat
23270 \end_layout
23271
23272 \end_inset
23273
23274  blocks are used to describe how bibliographic information should be displayed,
23275  both within \SpecialChar LyX
23276  itself (in the citation dialog and in tooltips, for example)
23277  and in XHTML output.
23278  Such a block might look like this:
23279 \end_layout
23280
23281 \begin_layout LyX-Code
23282 CiteFormat
23283 \end_layout
23284
23285 \begin_layout LyX-Code
23286  article ...
23287 \end_layout
23288
23289 \begin_layout LyX-Code
23290  book ...
23291 \end_layout
23292
23293 \begin_layout LyX-Code
23294 End
23295 \end_layout
23296
23297 \begin_layout Standard
23298 or
23299 \end_layout
23300
23301 \begin_layout LyX-Code
23302 CiteFormat
23303 \end_layout
23304
23305 \begin_layout LyX-Code
23306  cite ...
23307 \end_layout
23308
23309 \begin_layout LyX-Code
23310  citet*[][] ...
23311 \end_layout
23312
23313 \begin_layout LyX-Code
23314 End
23315 \end_layout
23316
23317 \begin_layout Standard
23318 In the first case, the individual lines define how the bibliographic information
23319  associated with an article or book, respectively, is to be displayed, and
23320  such a definition can be given for any
23321 \begin_inset Quotes els
23322 \end_inset
23323
23324 entry type
23325 \begin_inset Quotes ers
23326 \end_inset
23327
23328  that might be present in a Bib\SpecialChar TeX
23329  file.
23330  \SpecialChar LyX
23331  defines a default format in the source code that will be used if no specific
23332  definition has been given.
23333  \SpecialChar LyX
23334  predefines several formats in the file
23335 \begin_inset Flex Code
23336 status collapsed
23337
23338 \begin_layout Plain Layout
23339 stdciteformats.inc
23340 \end_layout
23341
23342 \end_inset
23343
23344 , which is included in most of \SpecialChar LyX
23345 's document classes.
23346 \end_layout
23347
23348 \begin_layout Standard
23349 In the second case, the lines define how a specific citation command (in
23350  the example
23351 \begin_inset Flex Code
23352 status collapsed
23353
23354 \begin_layout Plain Layout
23355
23356 \backslash
23357 cite
23358 \end_layout
23359
23360 \end_inset
23361
23362 ,
23363 \begin_inset Flex Code
23364 status collapsed
23365
23366 \begin_layout Plain Layout
23367
23368 \backslash
23369 citet
23370 \end_layout
23371
23372 \end_inset
23373
23374 ) is to be displayed on the citation inset label, in the citation dialog,
23375  menu or XHTML output.
23376  \SpecialChar LyX
23377  defines such formats for the citation style variants it supports via
23378 \family sans
23379 Document\SpecialChar menuseparator
23380 Setting\SpecialChar menuseparator
23381 Bibliography\SpecialChar ldots
23382
23383 \family default
23384  in specific
23385 \begin_inset Flex Code
23386 status collapsed
23387
23388 \begin_layout Plain Layout
23389 *.citeengine
23390 \end_layout
23391
23392 \end_inset
23393
23394  files that are shipped with \SpecialChar LyX
23395  (see
23396 \begin_inset CommandInset ref
23397 LatexCommand ref
23398 reference "subsec:Cite-Engine-Files"
23399 plural "false"
23400 caps "false"
23401 noprefix "false"
23402
23403 \end_inset
23404
23405 ).
23406 \end_layout
23407
23408 \begin_layout Standard
23409 The definitions use a simple language that allows Bib\SpecialChar TeX
23410  keys to be replaced
23411  with their values.
23412  Keys should be enclosed in
23413 \begin_inset Flex Code
23414 status collapsed
23415
23416 \begin_layout Plain Layout
23417 %
23418 \end_layout
23419
23420 \end_inset
23421
23422  signs, e.g.:
23423 \begin_inset Flex Code
23424 status collapsed
23425
23426 \begin_layout Plain Layout
23427 %author%
23428 \end_layout
23429
23430 \end_inset
23431
23432 .
23433  So a simple definition might look like this:
23434 \end_layout
23435
23436 \begin_layout LyX-Code
23437 misc %author%,
23438 \begin_inset Quotes eld
23439 \end_inset
23440
23441 %title%
23442 \begin_inset Quotes erd
23443 \end_inset
23444
23445 .
23446 \end_layout
23447
23448 \begin_layout Standard
23449 This would print the author, followed by a comma, followed by the title,
23450  in quotes, followed by a period.
23451 \end_layout
23452
23453 \begin_layout Standard
23454 Of course, sometimes you may want to print a key only if it exists.
23455  This can be done by using a conditional construction, such as:
23456 \begin_inset Flex Code
23457 status collapsed
23458
23459 \begin_layout Plain Layout
23460 {%volume%[[vol.
23461 \begin_inset space ~
23462 \end_inset
23463
23464 %volume%]]}
23465 \end_layout
23466
23467 \end_inset
23468
23469 .
23470  This says: If the
23471 \begin_inset Flex Code
23472 status collapsed
23473
23474 \begin_layout Plain Layout
23475 volume
23476 \end_layout
23477
23478 \end_inset
23479
23480  key exists, then print
23481 \begin_inset Quotes eld
23482 \end_inset
23483
23484 vol.
23485 \begin_inset space ~
23486 \end_inset
23487
23488
23489 \begin_inset Quotes erd
23490 \end_inset
23491
23492  followed by the volume key.
23493  It is also possible to have an else clause in the conditional, such as:
23494 \begin_inset Newline newline
23495 \end_inset
23496
23497
23498 \begin_inset Flex Code
23499 status collapsed
23500
23501 \begin_layout Plain Layout
23502 {%author%[[%author%]][[%editor%, ed.]]}
23503 \end_layout
23504
23505 \end_inset
23506
23507 .
23508 \begin_inset Newline newline
23509 \end_inset
23510
23511 Here, the
23512 \begin_inset Flex Code
23513 status collapsed
23514
23515 \begin_layout Plain Layout
23516 author
23517 \end_layout
23518
23519 \end_inset
23520
23521  key is printed if it exists; otherwise, the editor key is printed, followed
23522  by
23523 \begin_inset Quotes eld
23524 \end_inset
23525
23526 ,
23527 \begin_inset space ~
23528 \end_inset
23529
23530 ed.
23531 \begin_inset Quotes erd
23532 \end_inset
23533
23534  Note that the key is again enclosed in
23535 \begin_inset Flex Code
23536 status collapsed
23537
23538 \begin_layout Plain Layout
23539 %
23540 \end_layout
23541
23542 \end_inset
23543
23544  signs; the entire conditional is enclosed in braces; and the if and else
23545  clauses are enclosed in double brackets,
23546 \begin_inset Quotes eld
23547 \end_inset
23548
23549
23550 \begin_inset Flex Code
23551 status collapsed
23552
23553 \begin_layout Plain Layout
23554 [[
23555 \end_layout
23556
23557 \end_inset
23558
23559
23560 \begin_inset Quotes eld
23561 \end_inset
23562
23563  and
23564 \begin_inset Quotes eld
23565 \end_inset
23566
23567
23568 \begin_inset Flex Code
23569 status collapsed
23570
23571 \begin_layout Plain Layout
23572 ]]
23573 \end_layout
23574
23575 \end_inset
23576
23577
23578 \begin_inset Quotes erd
23579 \end_inset
23580
23581 .
23582  There must be no space between any of these.
23583 \end_layout
23584
23585 \begin_layout Standard
23586 Next to the entry keys, there are some special keys that can be used for
23587  these conditionals:
23588 \end_layout
23589
23590 \begin_layout Itemize
23591 \begin_inset Flex Code
23592 status collapsed
23593
23594 \begin_layout Plain Layout
23595 {%dialog%[[true]][[false]]}
23596 \end_layout
23597
23598 \end_inset
23599
23600 : process the
23601 \begin_inset Quotes eld
23602 \end_inset
23603
23604 true
23605 \begin_inset Quotes erd
23606 \end_inset
23607
23608  part for dialogs and menus, the
23609 \begin_inset Quotes eld
23610 \end_inset
23611
23612 false
23613 \begin_inset Quotes erd
23614 \end_inset
23615
23616  part for other contexts (workarea, export)
23617 \end_layout
23618
23619 \begin_layout Itemize
23620 \begin_inset Flex Code
23621 status collapsed
23622
23623 \begin_layout Plain Layout
23624 {%export%[[true]][[false]]}
23625 \end_layout
23626
23627 \end_inset
23628
23629 : process the
23630 \begin_inset Quotes eld
23631 \end_inset
23632
23633 true
23634 \begin_inset Quotes erd
23635 \end_inset
23636
23637  part for export and menus, the
23638 \begin_inset Quotes eld
23639 \end_inset
23640
23641 false
23642 \begin_inset Quotes erd
23643 \end_inset
23644
23645  part for other contexts (workarea, dialog)
23646 \end_layout
23647
23648 \begin_layout Itemize
23649 \begin_inset Flex Code
23650 status collapsed
23651
23652 \begin_layout Plain Layout
23653 {%next%[[true]]}
23654 \end_layout
23655
23656 \end_inset
23657
23658 : process the
23659 \begin_inset Quotes eld
23660 \end_inset
23661
23662 true
23663 \begin_inset Quotes erd
23664 \end_inset
23665
23666  part if another item follows (e.
23667 \begin_inset space \thinspace{}
23668 \end_inset
23669
23670 g., in a citation with multiple keys)
23671 \end_layout
23672
23673 \begin_layout Itemize
23674 \begin_inset Flex Code
23675 status collapsed
23676
23677 \begin_layout Plain Layout
23678 {%second%[[true]][[false]]}
23679 \end_layout
23680
23681 \end_inset
23682
23683 : process the
23684 \begin_inset Quotes eld
23685 \end_inset
23686
23687 true
23688 \begin_inset Quotes erd
23689 \end_inset
23690
23691  if this is the second of multiple items, else the
23692 \begin_inset Quotes eld
23693 \end_inset
23694
23695 false
23696 \begin_inset Quotes erd
23697 \end_inset
23698
23699  part
23700 \end_layout
23701
23702 \begin_layout Itemize
23703 \begin_inset Flex Code
23704 status collapsed
23705
23706 \begin_layout Plain Layout
23707 {%ifstar%[[true]][[false]]}
23708 \end_layout
23709
23710 \end_inset
23711
23712 : process the
23713 \begin_inset Quotes eld
23714 \end_inset
23715
23716 true
23717 \begin_inset Quotes erd
23718 \end_inset
23719
23720  part for starred citation commands (such as
23721 \begin_inset Flex Code
23722 status collapsed
23723
23724 \begin_layout Plain Layout
23725
23726 \backslash
23727 cite*
23728 \end_layout
23729
23730 \end_inset
23731
23732 ), the false part for unstarred
23733 \end_layout
23734
23735 \begin_layout Itemize
23736 \begin_inset Flex Code
23737 status collapsed
23738
23739 \begin_layout Plain Layout
23740 {%ifentrytype:<type>%[[true]][[false]]}
23741 \end_layout
23742
23743 \end_inset
23744
23745 : process the
23746 \begin_inset Quotes eld
23747 \end_inset
23748
23749 true
23750 \begin_inset Quotes erd
23751 \end_inset
23752
23753  if the current entry type matches
23754 \begin_inset Flex Code
23755 status collapsed
23756
23757 \begin_layout Plain Layout
23758 <type>
23759 \end_layout
23760
23761 \end_inset
23762
23763 , else the false part (e.g., in a citation definition:
23764 \begin_inset Flex Code
23765 status collapsed
23766
23767 \begin_layout Plain Layout
23768 {%ifentrytype:book%[[this is a book]][[this is no book]]}
23769 \end_layout
23770
23771 \end_inset
23772
23773 )
23774 \end_layout
23775
23776 \begin_layout Itemize
23777 \begin_inset Flex Code
23778 status collapsed
23779
23780 \begin_layout Plain Layout
23781 {%ifmultiple:<authortype>%[[true]][[false]]}
23782 \end_layout
23783
23784 \end_inset
23785
23786 : process the
23787 \begin_inset Quotes eld
23788 \end_inset
23789
23790 true
23791 \begin_inset Quotes erd
23792 \end_inset
23793
23794  if the current author type (author, editor etc.) has multiple authors, else
23795  the false part (e.g., in a bibliography definition:
23796 \begin_inset Flex Code
23797 status collapsed
23798
23799 \begin_layout Plain Layout
23800 {%ifmultiple:editor%[[eds.]][[ed.]]}
23801 \end_layout
23802
23803 \end_inset
23804
23805 )
23806 \end_layout
23807
23808 \begin_layout Itemize
23809 \begin_inset Flex Code
23810 status collapsed
23811
23812 \begin_layout Plain Layout
23813 {%ifqualified%[[true]][[false]]}
23814 \end_layout
23815
23816 \end_inset
23817
23818 : process the
23819 \begin_inset Quotes eld
23820 \end_inset
23821
23822 true
23823 \begin_inset Quotes erd
23824 \end_inset
23825
23826  part if the current citation is a qualified citation list (a specific
23827 \family sans
23828 Biblatex
23829 \family default
23830  format for multi-reference citations), the false part if this is not the
23831  case.
23832 \end_layout
23833
23834 \begin_layout Standard
23835 We said that
23836 \begin_inset Flex Code
23837 status collapsed
23838
23839 \begin_layout Plain Layout
23840 %author%
23841 \end_layout
23842
23843 \end_inset
23844
23845  prints the author key as it is recorded in the bibliography file.
23846  This might not be what you want, since it will result in a string such
23847  as
23848 \begin_inset Quotes eld
23849 \end_inset
23850
23851 Miller, Peter and Smith, Mary and White, Jane
23852 \begin_inset Quotes erd
23853 \end_inset
23854
23855  (since
23856 \begin_inset Quotes eld
23857 \end_inset
23858
23859 and
23860 \begin_inset Quotes erd
23861 \end_inset
23862
23863  is used by Bib\SpecialChar TeX
23864  to delimit authors).
23865  \SpecialChar LyX
23866  therefore provides some methods to get properly formatted name lists (which
23867  will also get translated).
23868  The following keys are provided:
23869 \end_layout
23870
23871 \begin_layout Enumerate
23872 For name lists with pre- and surname, suitable for the main authors/editors
23873  of a bibliography item.
23874  The
23875 \begin_inset Flex Code
23876 status collapsed
23877
23878 \begin_layout Plain Layout
23879 <nametype>
23880 \end_layout
23881
23882 \end_inset
23883
23884  part denotes the kind of list that is requested (e.g.
23885
23886 \begin_inset Flex Code
23887 status collapsed
23888
23889 \begin_layout Plain Layout
23890 <nametype:author>
23891 \end_layout
23892
23893 \end_inset
23894
23895 ):
23896 \end_layout
23897
23898 \begin_deeper
23899 \begin_layout Itemize
23900 \begin_inset Flex Code
23901 status collapsed
23902
23903 \begin_layout Plain Layout
23904 %abbrvnames:<nametype>%
23905 \end_layout
23906
23907 \end_inset
23908
23909 : Provides a name list which is abbreviated (with
23910 \begin_inset Quotes eld
23911 \end_inset
23912
23913 et al.
23914 \begin_inset Quotes erd
23915 \end_inset
23916
23917 ) when
23918 \begin_inset Flex Code
23919 status collapsed
23920
23921 \begin_layout Plain Layout
23922 MaxCiteNames
23923 \end_layout
23924
23925 \end_inset
23926
23927  is reached.
23928 \end_layout
23929
23930 \begin_layout Itemize
23931 \begin_inset Flex Code
23932 status collapsed
23933
23934 \begin_layout Plain Layout
23935 %fullnames:<nametype>%
23936 \end_layout
23937
23938 \end_inset
23939
23940 : Provides a full name list (never abbreviated with
23941 \begin_inset Quotes eld
23942 \end_inset
23943
23944 et al.
23945 \begin_inset Quotes erd
23946 \end_inset
23947
23948 ).
23949 \end_layout
23950
23951 \begin_layout Itemize
23952 \begin_inset Flex Code
23953 status collapsed
23954
23955 \begin_layout Plain Layout
23956 %forceabbrvnames:<nametype>%
23957 \end_layout
23958
23959 \end_inset
23960
23961 : Provides a name list which is always abbreviated (with
23962 \begin_inset Quotes eld
23963 \end_inset
23964
23965 et al.
23966 \begin_inset Quotes erd
23967 \end_inset
23968
23969 ) irrespective of
23970 \begin_inset Flex Code
23971 status collapsed
23972
23973 \begin_layout Plain Layout
23974 MaxCiteNames
23975 \end_layout
23976
23977 \end_inset
23978
23979 .
23980 \end_layout
23981
23982 \end_deeper
23983 \begin_layout Enumerate
23984 Alternative name lists with pre- and surname, if the order of pre- and surname
23985  inside the bibliography item differs (as in:
23986 \begin_inset Quotes eld
23987 \end_inset
23988
23989 Miller, John: Some text, in: Mary Smith, ed.: A volume
23990 \begin_inset Quotes erd
23991 \end_inset
23992
23993 ):
23994 \end_layout
23995
23996 \begin_deeper
23997 \begin_layout Itemize
23998 \begin_inset Flex Code
23999 status collapsed
24000
24001 \begin_layout Plain Layout
24002 %abbrvbynames:<nametype>%
24003 \end_layout
24004
24005 \end_inset
24006
24007 : Provides a name list which is abbreviated (with
24008 \begin_inset Quotes eld
24009 \end_inset
24010
24011 et al.
24012 \begin_inset Quotes erd
24013 \end_inset
24014
24015 ) when
24016 \begin_inset Flex Code
24017 status collapsed
24018
24019 \begin_layout Plain Layout
24020 MaxCiteNames
24021 \end_layout
24022
24023 \end_inset
24024
24025  is reached.
24026 \end_layout
24027
24028 \begin_layout Itemize
24029 \begin_inset Flex Code
24030 status collapsed
24031
24032 \begin_layout Plain Layout
24033 %fullbynames:<nametype>%
24034 \end_layout
24035
24036 \end_inset
24037
24038 : Provides a full name list (never abbreviated with
24039 \begin_inset Quotes eld
24040 \end_inset
24041
24042 et al.
24043 \begin_inset Quotes erd
24044 \end_inset
24045
24046 ).
24047 \end_layout
24048
24049 \begin_layout Itemize
24050 \begin_inset Flex Code
24051 status collapsed
24052
24053 \begin_layout Plain Layout
24054 %forceabbrvbynames:<nametype>%
24055 \end_layout
24056
24057 \end_inset
24058
24059 : Provides a name list which is always abbreviated (with
24060 \begin_inset Quotes eld
24061 \end_inset
24062
24063 et al.
24064 \begin_inset Quotes erd
24065 \end_inset
24066
24067 ) irrespective of
24068 \begin_inset Flex Code
24069 status collapsed
24070
24071 \begin_layout Plain Layout
24072 MaxCiteNames
24073 \end_layout
24074
24075 \end_inset
24076
24077 .
24078 \end_layout
24079
24080 \end_deeper
24081 \begin_layout Enumerate
24082 And finally name lists which consist of family names only, as used in author-yea
24083 r citation labels.
24084  These do not take a
24085 \begin_inset Flex Code
24086 status collapsed
24087
24088 \begin_layout Plain Layout
24089 <nametype>
24090 \end_layout
24091
24092 \end_inset
24093
24094  part, but always return either an author list or, if this does not exist,
24095  an editor list (as common in author-year labels):
24096 \end_layout
24097
24098 \begin_deeper
24099 \begin_layout Itemize
24100 \begin_inset Flex Code
24101 status collapsed
24102
24103 \begin_layout Plain Layout
24104 %abbrvciteauthor%
24105 \end_layout
24106
24107 \end_inset
24108
24109 : Provides a name list which is abbreviated (with
24110 \begin_inset Quotes eld
24111 \end_inset
24112
24113 et al.
24114 \begin_inset Quotes erd
24115 \end_inset
24116
24117 ) when
24118 \begin_inset Flex Code
24119 status collapsed
24120
24121 \begin_layout Plain Layout
24122 MaxCiteNames
24123 \end_layout
24124
24125 \end_inset
24126
24127  is reached.
24128 \end_layout
24129
24130 \begin_layout Itemize
24131 \begin_inset Flex Code
24132 status collapsed
24133
24134 \begin_layout Plain Layout
24135 %fullciteauthor%
24136 \end_layout
24137
24138 \end_inset
24139
24140 : Provides a full name list (never abbreviated with
24141 \begin_inset Quotes eld
24142 \end_inset
24143
24144 et al.
24145 \begin_inset Quotes erd
24146 \end_inset
24147
24148 ).
24149 \end_layout
24150
24151 \begin_layout Itemize
24152 \begin_inset Flex Code
24153 status collapsed
24154
24155 \begin_layout Plain Layout
24156 %forceabbrvciteauthor%
24157 \end_layout
24158
24159 \end_inset
24160
24161 : Provides a name list which is always abbreviated (with
24162 \begin_inset Quotes eld
24163 \end_inset
24164
24165 et al.
24166 \begin_inset Quotes erd
24167 \end_inset
24168
24169 ) irrespective of
24170 \begin_inset Flex Code
24171 status collapsed
24172
24173 \begin_layout Plain Layout
24174 MaxCiteNames
24175 \end_layout
24176
24177 \end_inset
24178
24179 .
24180 \end_layout
24181
24182 \end_deeper
24183 \begin_layout Standard
24184 The order of pre- and surname in the former two lists can be adjusted by
24185  these macros:
24186 \end_layout
24187
24188 \begin_layout Itemize
24189 \begin_inset Flex Code
24190 status collapsed
24191
24192 \begin_layout Plain Layout
24193 !firstnameform %surname%, %prename%
24194 \end_layout
24195
24196 \end_inset
24197
24198  (first author in lists of type 1)
24199 \end_layout
24200
24201 \begin_layout Itemize
24202 \begin_inset Flex Code
24203 status collapsed
24204
24205 \begin_layout Plain Layout
24206 !othernameform %surname%, %prename%
24207 \end_layout
24208
24209 \end_inset
24210
24211  (other authors in lists of type 1)
24212 \end_layout
24213
24214 \begin_layout Itemize
24215 \begin_inset Flex Code
24216 status collapsed
24217
24218 \begin_layout Plain Layout
24219 !firstbynameform %prename% %surname%
24220 \end_layout
24221
24222 \end_inset
24223
24224  (first author in lists of type 2)
24225 \end_layout
24226
24227 \begin_layout Itemize
24228 \begin_inset Flex Code
24229 status collapsed
24230
24231 \begin_layout Plain Layout
24232 !otherbynameform %prename% %surname%
24233 \end_layout
24234
24235 \end_inset
24236
24237  (other authors in lists of type 2)
24238 \end_layout
24239
24240 \begin_layout Standard
24241 This allows you to configure namings like
24242 \begin_inset Quotes eld
24243 \end_inset
24244
24245 Miller, Peter and Mary Smith: \SpecialChar ldots
24246 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
24247
24248 \begin_inset Quotes erd
24249 \end_inset
24250
24251 .
24252 \end_layout
24253
24254 \begin_layout Standard
24255 There is one other piece of syntax available in definitions, which looks
24256  like this:
24257 \begin_inset Flex Code
24258 status collapsed
24259
24260 \begin_layout Plain Layout
24261 {!<i>!}
24262 \end_layout
24263
24264 \end_inset
24265
24266 .
24267  This defines a piece of formatting information that is to be used when
24268  creating
24269 \begin_inset Quotes eld
24270 \end_inset
24271
24272 rich text
24273 \begin_inset Quotes erd
24274 \end_inset
24275
24276 .
24277  Obviously, we do not want to output HTML tags when writing plain text,
24278  so they should be wrapped in
24279 \begin_inset Quotes eld
24280 \end_inset
24281
24282 {!
24283 \begin_inset Quotes erd
24284 \end_inset
24285
24286  and
24287 \begin_inset Quotes eld
24288 \end_inset
24289
24290 !}
24291 \begin_inset Quotes erd
24292 \end_inset
24293
24294 .
24295 \end_layout
24296
24297 \begin_layout Standard
24298 Two special sorts of definitions are also possible in a
24299 \begin_inset Flex Code
24300 status collapsed
24301
24302 \begin_layout Plain Layout
24303 CiteFormat
24304 \end_layout
24305
24306 \end_inset
24307
24308  block.
24309  An example of the first would be:
24310 \end_layout
24311
24312 \begin_layout LyX-Code
24313 !quotetitle
24314 \begin_inset Quotes eld
24315 \end_inset
24316
24317 %title%
24318 \begin_inset Quotes erd
24319 \end_inset
24320
24321
24322 \end_layout
24323
24324 \begin_layout Standard
24325 This is an abbreviation, or macro, and it can be used by treating it as
24326  if it were a key:
24327 \begin_inset Flex Code
24328 status collapsed
24329
24330 \begin_layout Plain Layout
24331 %!quotetitle%
24332 \end_layout
24333
24334 \end_inset
24335
24336 .
24337  \SpecialChar LyX
24338  will treat
24339 \begin_inset Flex Code
24340 status collapsed
24341
24342 \begin_layout Plain Layout
24343 %!quotetitle%
24344 \end_layout
24345
24346 \end_inset
24347
24348  exactly as it would treat its definition.
24349  So, let us issue the obvious
24350 \emph on
24351 warning
24352 \emph default
24353 .
24354  Do not do this:
24355 \end_layout
24356
24357 \begin_layout LyX-Code
24358 !funfun %funfun%
24359 \end_layout
24360
24361 \begin_layout Standard
24362 or anything like it.
24363  \SpecialChar LyX
24364  shouldn't go into an infinite loop, but it may go into a long one before
24365  it gives up.
24366 \end_layout
24367
24368 \begin_layout Standard
24369 The second sort of special definition might look like this:
24370 \end_layout
24371
24372 \begin_layout LyX-Code
24373 B_pptext pp.
24374 \end_layout
24375
24376 \begin_layout Standard
24377 This defines a translatable piece of text, which allows relevant parts of
24378  the bibliography or citation to be translated.
24379  It can be included in a definition by treating it as a key:
24380 \begin_inset Flex Code
24381 status collapsed
24382
24383 \begin_layout Plain Layout
24384 %B_pptext%
24385 \end_layout
24386
24387 \end_inset
24388
24389 .
24390  Note that there are two different translation paths: All definitions starting
24391  with
24392 \begin_inset Flex Code
24393 status collapsed
24394
24395 \begin_layout Plain Layout
24396 B_
24397 \end_layout
24398
24399 \end_inset
24400
24401 , such as in the example above, will be translated to the currently active
24402  buffer language (so the translation will match the generated document).
24403  All definitions starting with underscore only will be translated to the
24404  GUI language.
24405  This is the proper translation for strings that only occur in the dialogs
24406  or on buttons, such as this one:
24407 \end_layout
24408
24409 \begin_layout LyX-Code
24410 _addtobib Add to bibliography only.
24411 \end_layout
24412
24413 \begin_layout Standard
24414 Several of these translatable strings are predefined in
24415 \begin_inset Flex Code
24416 status collapsed
24417
24418 \begin_layout Plain Layout
24419 stdciteformats.inc
24420 \end_layout
24421
24422 \end_inset
24423
24424  and the diverse
24425 \begin_inset Flex Code
24426 status collapsed
24427
24428 \begin_layout Plain Layout
24429 *.citeengine
24430 \end_layout
24431
24432 \end_inset
24433
24434  files.
24435  Note that these are not macros, in the sense just defined.
24436  They will not be expanded.
24437 \end_layout
24438
24439 \begin_layout Standard
24440 So here then is an example that uses several of these features:
24441 \begin_inset VSpace defskip
24442 \end_inset
24443
24444
24445 \end_layout
24446
24447 \begin_layout Standard
24448 \noindent
24449
24450 \family sans
24451 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
24452 \end_layout
24453
24454 \begin_layout Standard
24455 \begin_inset VSpace defskip
24456 \end_inset
24457
24458 This defines a macro that prints the author, followed by a comma, if the
24459
24460 \begin_inset Flex Code
24461 status collapsed
24462
24463 \begin_layout Plain Layout
24464 author
24465 \end_layout
24466
24467 \end_inset
24468
24469  key is defined, or else prints the name of the editor, followed by the
24470
24471 \begin_inset Flex Code
24472 status collapsed
24473
24474 \begin_layout Plain Layout
24475 B_edtext
24476 \end_layout
24477
24478 \end_inset
24479
24480  or its translation (it is by default
24481 \begin_inset Quotes eld
24482 \end_inset
24483
24484 ed.
24485 \begin_inset Quotes erd
24486 \end_inset
24487
24488 ), if the
24489 \begin_inset Flex Code
24490 status collapsed
24491
24492 \begin_layout Plain Layout
24493 editor
24494 \end_layout
24495
24496 \end_inset
24497
24498  key is defined.
24499  Note that this is in fact defined in
24500 \begin_inset Flex Code
24501 status collapsed
24502
24503 \begin_layout Plain Layout
24504 stdciteformats.inc
24505 \end_layout
24506
24507 \end_inset
24508
24509 , so you can use it in your own definitions, or re-definitions, if you load
24510  that file first.
24511 \end_layout
24512
24513 \begin_layout Section
24514 \begin_inset CommandInset label
24515 LatexCommand label
24516 name "sec:Tags-for-XHTML"
24517
24518 \end_inset
24519
24520 Tags for XHTML output
24521 \end_layout
24522
24523 \begin_layout Standard
24524 As with \SpecialChar LaTeX
24525  or DocBook, the format of \SpecialChar LyX
24526 's XHTML output is also controlled by
24527  layout information.
24528  In general, \SpecialChar LyX
24529  provides sensible defaults and, as mentioned earlier, it will
24530  even construct default CSS style rules from the other layout tags.
24531  For example, \SpecialChar LyX
24532  will attempt to use the information provided in the
24533 \begin_inset Flex Code
24534 status collapsed
24535
24536 \begin_layout Plain Layout
24537 Font
24538 \end_layout
24539
24540 \end_inset
24541
24542  declaration for the Chapter style to write CSS that will appropriately
24543  format chapter headings.
24544 \end_layout
24545
24546 \begin_layout Standard
24547 In many cases, then, you may not have to do anything at all to get acceptable
24548  XHTML output for your own environments, custom insets, and so forth.
24549  But in some cases you will, and so \SpecialChar LyX
24550  provides a number of layout tags that
24551  can be used to customize the XHTML and CSS that are generated.
24552 \end_layout
24553
24554 \begin_layout Standard
24555 Note that there are two tags,
24556 \begin_inset Flex Code
24557 status collapsed
24558
24559 \begin_layout Plain Layout
24560 HTMLPreamble
24561 \end_layout
24562
24563 \end_inset
24564
24565  and
24566 \begin_inset Flex Code
24567 status collapsed
24568
24569 \begin_layout Plain Layout
24570 AddToHTMLPreamble
24571 \end_layout
24572
24573 \end_inset
24574
24575  that may appear outside style and inset declarations.
24576  See
24577 \begin_inset CommandInset ref
24578 LatexCommand ref
24579 reference "subsec:General-text-class"
24580
24581 \end_inset
24582
24583  for details on these.
24584 \end_layout
24585
24586 \begin_layout Subsection
24587 \begin_inset CommandInset label
24588 LatexCommand label
24589 name "subsec:Paragraph-Style-XHTML"
24590
24591 \end_inset
24592
24593 Paragraph styles
24594 \end_layout
24595
24596 \begin_layout Standard
24597 The sort of XHTML \SpecialChar LyX
24598  outputs for a paragraph depends upon whether we are dealing
24599  with a normal paragraph, a command, or an environment, where this is itself
24600  determined by the contents of the corresponding
24601 \begin_inset Flex Code
24602 status collapsed
24603
24604 \begin_layout Plain Layout
24605 \SpecialChar LaTeX
24606 Type
24607 \end_layout
24608
24609 \end_inset
24610
24611  tag.
24612
24613 \end_layout
24614
24615 \begin_layout Standard
24616 For a command or normal paragraph, the output XHTML has the following form:
24617 \end_layout
24618
24619 \begin_layout LyX-Code
24620
24621 \family sans
24622 <tag attr=
24623 \begin_inset Quotes erd
24624 \end_inset
24625
24626 value
24627 \begin_inset Quotes erd
24628 \end_inset
24629
24630 >
24631 \end_layout
24632
24633 \begin_layout LyX-Code
24634
24635 \family sans
24636 <labeltag attr=
24637 \begin_inset Quotes erd
24638 \end_inset
24639
24640 value
24641 \begin_inset Quotes erd
24642 \end_inset
24643
24644 >Label</labeltag>
24645 \end_layout
24646
24647 \begin_layout LyX-Code
24648
24649 \family sans
24650 Contents of the paragraph.
24651 \end_layout
24652
24653 \begin_layout LyX-Code
24654
24655 \family sans
24656 </tag>
24657 \end_layout
24658
24659 \begin_layout Standard
24660 The label tags are of course omitted if the paragraph does not have a label.
24661 \end_layout
24662
24663 \begin_layout Standard
24664 For an environment that is not some sort of list, the XHTML takes this form:
24665 \end_layout
24666
24667 \begin_layout LyX-Code
24668
24669 \family sans
24670 <tag attr=
24671 \begin_inset Quotes erd
24672 \end_inset
24673
24674 value
24675 \begin_inset Quotes erd
24676 \end_inset
24677
24678 >
24679 \end_layout
24680
24681 \begin_layout LyX-Code
24682
24683 \family sans
24684 <itemtag attr=
24685 \begin_inset Quotes erd
24686 \end_inset
24687
24688 value
24689 \begin_inset Quotes erd
24690 \end_inset
24691
24692 ><labeltag attr=
24693 \begin_inset Quotes erd
24694 \end_inset
24695
24696 value
24697 \begin_inset Quotes erd
24698 \end_inset
24699
24700 >Environment Label</labeltag>First paragraph.</itemtag>
24701 \end_layout
24702
24703 \begin_layout LyX-Code
24704
24705 \family sans
24706 <itemtag>Second paragraph.</itemtag>
24707 \end_layout
24708
24709 \begin_layout LyX-Code
24710
24711 \family sans
24712 </tag>
24713 \end_layout
24714
24715 \begin_layout Standard
24716 Note that the label is output only for the first paragraph, as it should
24717  be for a theorem, for example.
24718
24719 \end_layout
24720
24721 \begin_layout Standard
24722 For a list, we have one of these forms:
24723 \end_layout
24724
24725 \begin_layout LyX-Code
24726
24727 \family sans
24728 <tag attr=
24729 \begin_inset Quotes erd
24730 \end_inset
24731
24732 value
24733 \begin_inset Quotes erd
24734 \end_inset
24735
24736 >
24737 \end_layout
24738
24739 \begin_layout LyX-Code
24740
24741 \family sans
24742 <itemtag attr=
24743 \begin_inset Quotes erd
24744 \end_inset
24745
24746 value
24747 \begin_inset Quotes erd
24748 \end_inset
24749
24750 ><labeltag attr=
24751 \begin_inset Quotes erd
24752 \end_inset
24753
24754 value
24755 \begin_inset Quotes erd
24756 \end_inset
24757
24758 >List Label</labeltag>First item.</itemtag>
24759 \end_layout
24760
24761 \begin_layout LyX-Code
24762
24763 \family sans
24764 <itemtag attr=
24765 \begin_inset Quotes erd
24766 \end_inset
24767
24768 value
24769 \begin_inset Quotes erd
24770 \end_inset
24771
24772 ><labeltag attr=
24773 \begin_inset Quotes erd
24774 \end_inset
24775
24776 value
24777 \begin_inset Quotes erd
24778 \end_inset
24779
24780 >List Label</labeltag>Second item.</itemtag>
24781 \end_layout
24782
24783 \begin_layout LyX-Code
24784
24785 \family sans
24786 </tag>
24787 \end_layout
24788
24789 \begin_layout LyX-Code
24790
24791 \end_layout
24792
24793 \begin_layout LyX-Code
24794
24795 \family sans
24796 <tag attr=
24797 \begin_inset Quotes erd
24798 \end_inset
24799
24800 value
24801 \begin_inset Quotes erd
24802 \end_inset
24803
24804 >
24805 \end_layout
24806
24807 \begin_layout LyX-Code
24808
24809 \family sans
24810 <labeltag attr=
24811 \begin_inset Quotes erd
24812 \end_inset
24813
24814 value
24815 \begin_inset Quotes erd
24816 \end_inset
24817
24818 >List Label</labeltag><itemtag attr=
24819 \begin_inset Quotes erd
24820 \end_inset
24821
24822 value
24823 \begin_inset Quotes erd
24824 \end_inset
24825
24826 >First item.</itemtag>
24827 \end_layout
24828
24829 \begin_layout LyX-Code
24830
24831 \family sans
24832 <labeltag attr=
24833 \begin_inset Quotes erd
24834 \end_inset
24835
24836 value
24837 \begin_inset Quotes erd
24838 \end_inset
24839
24840 >List Label</labeltag><itemtag attr=
24841 \begin_inset Quotes erd
24842 \end_inset
24843
24844 value
24845 \begin_inset Quotes erd
24846 \end_inset
24847
24848 >Second item.</itemtag>
24849 \end_layout
24850
24851 \begin_layout LyX-Code
24852
24853 \family sans
24854 </tag>
24855 \end_layout
24856
24857 \begin_layout Standard
24858 Note the different orders of
24859 \begin_inset Flex Code
24860 status collapsed
24861
24862 \begin_layout Plain Layout
24863 labeltag
24864 \end_layout
24865
24866 \end_inset
24867
24868  and
24869 \begin_inset Flex Code
24870 status collapsed
24871
24872 \begin_layout Plain Layout
24873 itemtag
24874 \end_layout
24875
24876 \end_inset
24877
24878 .
24879  Which order we get depends upon the setting of
24880 \begin_inset Flex Code
24881 status collapsed
24882
24883 \begin_layout Plain Layout
24884 HTMLLabelFirst
24885 \end_layout
24886
24887 \end_inset
24888
24889 : If
24890 \begin_inset Flex Code
24891 status collapsed
24892
24893 \begin_layout Plain Layout
24894 HTMLLabelFirst
24895 \end_layout
24896
24897 \end_inset
24898
24899  is false (the default), you get the first of these, with the label within
24900  the item; if true, you get the second, with the label outside the item.
24901 \end_layout
24902
24903 \begin_layout Standard
24904 The specific tags and attributes output for each paragraph type can be controlle
24905 d by means of the layout tags we are about to describe.
24906  As mentioned earlier, however, \SpecialChar LyX
24907  uses sensible defaults for many of these,
24908  so you often may not need to do very much to get good XHTML output.
24909  Think of the available tags as there so you can tweak things to your liking.
24910 \end_layout
24911
24912 \begin_layout Description
24913 \begin_inset Flex Code
24914 status collapsed
24915
24916 \begin_layout Plain Layout
24917 HTMLAttr
24918 \end_layout
24919
24920 \end_inset
24921
24922  [
24923 \begin_inset Flex Code
24924 status collapsed
24925
24926 \begin_layout Plain Layout
24927 string
24928 \end_layout
24929
24930 \end_inset
24931
24932 ] Specifies attribute information to be output with the main tag.
24933  For example,
24934 \begin_inset Quotes eld
24935 \end_inset
24936
24937
24938 \begin_inset Flex Code
24939 status collapsed
24940
24941 \begin_layout Plain Layout
24942 class=`mydiv'
24943 \end_layout
24944
24945 \end_inset
24946
24947
24948 \begin_inset Quotes erd
24949 \end_inset
24950
24951 .
24952  By default, \SpecialChar LyX
24953  will output
24954 \begin_inset Quotes eld
24955 \end_inset
24956
24957
24958 \begin_inset Flex Code
24959 status collapsed
24960
24961 \begin_layout Plain Layout
24962 class=`layoutname'
24963 \end_layout
24964
24965 \end_inset
24966
24967
24968 \begin_inset Quotes erd
24969 \end_inset
24970
24971 , where
24972 \begin_inset Flex Code
24973 status collapsed
24974
24975 \begin_layout Plain Layout
24976 layoutname
24977 \end_layout
24978
24979 \end_inset
24980
24981  is the \SpecialChar LyX
24982  name of the layout, made lowercase, for example: chapter.
24983  This should
24984 \emph on
24985 not
24986 \emph default
24987  contain any style information.
24988  Use
24989 \begin_inset Flex Code
24990 status collapsed
24991
24992 \begin_layout Plain Layout
24993 HTMLStyle
24994 \end_layout
24995
24996 \end_inset
24997
24998  for that purpose.
24999 \end_layout
25000
25001 \begin_layout Description
25002 \begin_inset Flex Code
25003 status collapsed
25004
25005 \begin_layout Plain Layout
25006 HTMLForceCSS
25007 \end_layout
25008
25009 \end_inset
25010
25011  [
25012 \begin_inset Flex Code
25013 status collapsed
25014
25015 \begin_layout Plain Layout
25016
25017 \emph on
25018 0
25019 \emph default
25020 ,1
25021 \end_layout
25022
25023 \end_inset
25024
25025 ] Whether to output the default CSS information \SpecialChar LyX
25026  generates for this layout,
25027  even if additional information is explicitly provided via
25028 \begin_inset Flex Code
25029 status collapsed
25030
25031 \begin_layout Plain Layout
25032 HTMLStyle
25033 \end_layout
25034
25035 \end_inset
25036
25037 .
25038  Setting this to
25039 \begin_inset Flex Code
25040 status collapsed
25041
25042 \begin_layout Plain Layout
25043 1
25044 \end_layout
25045
25046 \end_inset
25047
25048  allows you to alter or augment the generated CSS, rather than to override
25049  it completely.
25050  Default is
25051 \begin_inset Flex Code
25052 status collapsed
25053
25054 \begin_layout Plain Layout
25055 0
25056 \end_layout
25057
25058 \end_inset
25059
25060 .
25061 \end_layout
25062
25063 \begin_layout Description
25064 \begin_inset Flex Code
25065 status collapsed
25066
25067 \begin_layout Plain Layout
25068 HTMLItem
25069 \end_layout
25070
25071 \end_inset
25072
25073  [
25074 \begin_inset Flex Code
25075 status collapsed
25076
25077 \begin_layout Plain Layout
25078 string
25079 \end_layout
25080
25081 \end_inset
25082
25083 ] The tag to be used for individual paragraphs of environments, replacing
25084
25085 \begin_inset Flex Code
25086 status collapsed
25087
25088 \begin_layout Plain Layout
25089 itemtag
25090 \end_layout
25091
25092 \end_inset
25093
25094  in the examples above.
25095  Defaults to
25096 \begin_inset Flex Code
25097 status collapsed
25098
25099 \begin_layout Plain Layout
25100 div
25101 \end_layout
25102
25103 \end_inset
25104
25105 .
25106 \end_layout
25107
25108 \begin_layout Description
25109 \begin_inset Flex Code
25110 status collapsed
25111
25112 \begin_layout Plain Layout
25113 HTMLItemAttr
25114 \end_layout
25115
25116 \end_inset
25117
25118  [
25119 \begin_inset Flex Code
25120 status collapsed
25121
25122 \begin_layout Plain Layout
25123 string
25124 \end_layout
25125
25126 \end_inset
25127
25128 ] Attributes for the item tag.
25129  Defaults to
25130 \begin_inset Newline newline
25131 \end_inset
25132
25133
25134 \begin_inset Quotes eld
25135 \end_inset
25136
25137
25138 \begin_inset Flex Code
25139 status collapsed
25140
25141 \begin_layout Plain Layout
25142 class=`layoutname_item'
25143 \end_layout
25144
25145 \end_inset
25146
25147
25148 \begin_inset Quotes erd
25149 \end_inset
25150
25151 .
25152  This should
25153 \emph on
25154 not
25155 \emph default
25156  contain any style information.
25157  Use
25158 \begin_inset Flex Code
25159 status collapsed
25160
25161 \begin_layout Plain Layout
25162 HTMLStyle
25163 \end_layout
25164
25165 \end_inset
25166
25167  for that purpose.
25168 \end_layout
25169
25170 \begin_layout Description
25171 \begin_inset Flex Code
25172 status collapsed
25173
25174 \begin_layout Plain Layout
25175 HTMLLabel
25176 \end_layout
25177
25178 \end_inset
25179
25180  [
25181 \begin_inset Flex Code
25182 status collapsed
25183
25184 \begin_layout Plain Layout
25185 string
25186 \end_layout
25187
25188 \end_inset
25189
25190 ] The tag to be used for paragraph and item labels, replacing
25191 \begin_inset Flex Code
25192 status collapsed
25193
25194 \begin_layout Plain Layout
25195 labeltag
25196 \end_layout
25197
25198 \end_inset
25199
25200  in the examples above.
25201  Defaults to
25202 \begin_inset Flex Code
25203 status collapsed
25204
25205 \begin_layout Plain Layout
25206 span
25207 \end_layout
25208
25209 \end_inset
25210
25211 , unless
25212 \begin_inset Flex Code
25213 status collapsed
25214
25215 \begin_layout Plain Layout
25216 LabelType
25217 \end_layout
25218
25219 \end_inset
25220
25221  is either
25222 \begin_inset Flex Code
25223 status collapsed
25224
25225 \begin_layout Plain Layout
25226 Top_Environment
25227 \end_layout
25228
25229 \end_inset
25230
25231  or
25232 \begin_inset Flex Code
25233 status collapsed
25234
25235 \begin_layout Plain Layout
25236 Centered_Top_Environment
25237 \end_layout
25238
25239 \end_inset
25240
25241 , in which case it defaults to
25242 \begin_inset Flex Code
25243 status collapsed
25244
25245 \begin_layout Plain Layout
25246 div
25247 \end_layout
25248
25249 \end_inset
25250
25251 .
25252 \end_layout
25253
25254 \begin_layout Description
25255 \begin_inset Flex Code
25256 status collapsed
25257
25258 \begin_layout Plain Layout
25259 HTMLLabelAttr
25260 \end_layout
25261
25262 \end_inset
25263
25264  [
25265 \begin_inset Flex Code
25266 status collapsed
25267
25268 \begin_layout Plain Layout
25269 string
25270 \end_layout
25271
25272 \end_inset
25273
25274 ] Attributes for the label tag.
25275  Defaults to
25276 \begin_inset Newline newline
25277 \end_inset
25278
25279
25280 \begin_inset Quotes eld
25281 \end_inset
25282
25283
25284 \begin_inset Flex Code
25285 status collapsed
25286
25287 \begin_layout Plain Layout
25288 class=`layoutname_label'
25289 \end_layout
25290
25291 \end_inset
25292
25293
25294 \begin_inset Quotes erd
25295 \end_inset
25296
25297 .
25298  This should
25299 \emph on
25300 not
25301 \emph default
25302  contain any style information.
25303  Use
25304 \begin_inset Flex Code
25305 status collapsed
25306
25307 \begin_layout Plain Layout
25308 HTMLStyle
25309 \end_layout
25310
25311 \end_inset
25312
25313  for that purpose.
25314 \end_layout
25315
25316 \begin_layout Description
25317 \begin_inset Flex Code
25318 status collapsed
25319
25320 \begin_layout Plain Layout
25321 HTMLLabelFirst
25322 \end_layout
25323
25324 \end_inset
25325
25326  [
25327 \begin_inset Flex Code
25328 status collapsed
25329
25330 \begin_layout Plain Layout
25331
25332 \emph on
25333 0
25334 \emph default
25335 ,1
25336 \end_layout
25337
25338 \end_inset
25339
25340 ] Meaningful only for list-like environments, this tag controls whether
25341  the label tag is output before or inside the item tag.
25342  This is used, for example, in the description environment, where we want
25343  `
25344 \begin_inset Flex Code
25345 status collapsed
25346
25347 \begin_layout Plain Layout
25348 <dt>\SpecialChar ldots
25349 </dt><dd>\SpecialChar ldots
25350 </dd>
25351 \end_layout
25352
25353 \end_inset
25354
25355 .
25356  Default is
25357 \begin_inset Flex Code
25358 status collapsed
25359
25360 \begin_layout Plain Layout
25361 0
25362 \end_layout
25363
25364 \end_inset
25365
25366 : The label tag is output inside the item tag.
25367 \end_layout
25368
25369 \begin_layout Description
25370 \begin_inset Flex Code
25371 status collapsed
25372
25373 \begin_layout Plain Layout
25374 HTMLPreamble
25375 \end_layout
25376
25377 \end_inset
25378
25379  Information to be output in the
25380 \begin_inset Flex Code
25381 status collapsed
25382
25383 \begin_layout Plain Layout
25384 <head>
25385 \end_layout
25386
25387 \end_inset
25388
25389  section when this style is used.
25390  This might, for example, be used to include a
25391 \begin_inset Flex Code
25392 status collapsed
25393
25394 \begin_layout Plain Layout
25395 <script>
25396 \end_layout
25397
25398 \end_inset
25399
25400  block defining an
25401 \begin_inset Flex Code
25402 status collapsed
25403
25404 \begin_layout Plain Layout
25405 onclick
25406 \end_layout
25407
25408 \end_inset
25409
25410  handler.
25411 \end_layout
25412
25413 \begin_layout Description
25414 \begin_inset Flex Code
25415 status collapsed
25416
25417 \begin_layout Plain Layout
25418 HTMLStyle
25419 \end_layout
25420
25421 \end_inset
25422
25423  CSS style information to be included when this style is used.
25424  Note that this will automatically be wrapped in a layout-generated
25425 \begin_inset Flex Code
25426 status collapsed
25427
25428 \begin_layout Plain Layout
25429 <style>
25430 \end_layout
25431
25432 \end_inset
25433
25434  block, so only the CSS itself need be included.
25435  Must end with
25436 \begin_inset Flex Code
25437 status collapsed
25438
25439 \begin_layout Plain Layout
25440 EndHTMLStyle
25441 \end_layout
25442
25443 \end_inset
25444
25445 .
25446 \end_layout
25447
25448 \begin_layout Description
25449 \begin_inset Flex Code
25450 status collapsed
25451
25452 \begin_layout Plain Layout
25453 HTMLTag
25454 \end_layout
25455
25456 \end_inset
25457
25458  [
25459 \begin_inset Flex Code
25460 status collapsed
25461
25462 \begin_layout Plain Layout
25463 string
25464 \end_layout
25465
25466 \end_inset
25467
25468 ] The tag to be used for the main label, replacing
25469 \begin_inset Flex Code
25470 status collapsed
25471
25472 \begin_layout Plain Layout
25473 tag
25474 \end_layout
25475
25476 \end_inset
25477
25478  in the examples above.
25479  Defaults to
25480 \begin_inset Flex Code
25481 status collapsed
25482
25483 \begin_layout Plain Layout
25484 div
25485 \end_layout
25486
25487 \end_inset
25488
25489 .
25490 \end_layout
25491
25492 \begin_layout Description
25493 \begin_inset Flex Code
25494 status collapsed
25495
25496 \begin_layout Plain Layout
25497 HTMLTitle
25498 \end_layout
25499
25500 \end_inset
25501
25502  [
25503 \begin_inset Flex Code
25504 status collapsed
25505
25506 \begin_layout Plain Layout
25507
25508 \emph on
25509 0
25510 \emph default
25511 ,1
25512 \end_layout
25513
25514 \end_inset
25515
25516 ] Marks this style as the one to be used to generate the
25517 \begin_inset Flex Code
25518 status collapsed
25519
25520 \begin_layout Plain Layout
25521 <title>
25522 \end_layout
25523
25524 \end_inset
25525
25526  tag for the XHTML file.
25527  By default, it is false.
25528  The
25529 \begin_inset Flex Code
25530 status collapsed
25531
25532 \begin_layout Plain Layout
25533 stdtitle.inc
25534 \end_layout
25535
25536 \end_inset
25537
25538  file sets it to true for the
25539 \begin_inset Flex Code
25540 status collapsed
25541
25542 \begin_layout Plain Layout
25543 title
25544 \end_layout
25545
25546 \end_inset
25547
25548  environment.
25549
25550 \end_layout
25551
25552 \begin_layout Subsection
25553 InsetLayout XHTML
25554 \end_layout
25555
25556 \begin_layout Standard
25557 The XHTML output of insets can also be controlled by information in layout
25558  files.
25559 \begin_inset Foot
25560 status collapsed
25561
25562 \begin_layout Plain Layout
25563 At present, this is true only for
25564 \begin_inset Quotes eld
25565 \end_inset
25566
25567 text
25568 \begin_inset Quotes erd
25569 \end_inset
25570
25571  insets (insets you can type into) and is not true for
25572 \begin_inset Quotes eld
25573 \end_inset
25574
25575 command
25576 \begin_inset Quotes erd
25577 \end_inset
25578
25579  insets (insets that are associated with dialog boxes).
25580 \end_layout
25581
25582 \end_inset
25583
25584  Here, too, \SpecialChar LyX
25585  tries to provide sensible defaults, and it constructs default
25586  CSS style rules.
25587  But everything can be customized.
25588 \end_layout
25589
25590 \begin_layout Standard
25591 The XHTML \SpecialChar LyX
25592  outputs for an inset has the following form:
25593 \end_layout
25594
25595 \begin_layout LyX-Code
25596 <tag attr=
25597 \begin_inset Quotes erd
25598 \end_inset
25599
25600 value
25601 \begin_inset Quotes erd
25602 \end_inset
25603
25604 >
25605 \end_layout
25606
25607 \begin_layout LyX-Code
25608 <labeltag>Label</labeltag>
25609 \end_layout
25610
25611 \begin_layout LyX-Code
25612 <innertag attr=
25613 \begin_inset Quotes erd
25614 \end_inset
25615
25616 value
25617 \begin_inset Quotes erd
25618 \end_inset
25619
25620 >Contents of the inset.</innertag>
25621 \end_layout
25622
25623 \begin_layout LyX-Code
25624 </tag>
25625 \end_layout
25626
25627 \begin_layout Standard
25628 If the inset permits multiple paragraphs—that is, if
25629 \begin_inset Flex Code
25630 status collapsed
25631
25632 \begin_layout Plain Layout
25633 MultiPar
25634 \end_layout
25635
25636 \end_inset
25637
25638  is true—then the contents of the inset will itself be output as paragraphs
25639  formatted according to the styles used for those paragraphs (standard,
25640  quote, and the like).
25641  The label tag is of course omitted if the paragraph does not have a label
25642  and, at present, is always
25643 \begin_inset Flex Code
25644 status collapsed
25645
25646 \begin_layout Plain Layout
25647 span
25648 \end_layout
25649
25650 \end_inset
25651
25652 .
25653  The inner tag is optional and, by default, does not appear.
25654 \end_layout
25655
25656 \begin_layout Standard
25657 The specific tags and attributes output for each inset can be controlled
25658  by means of the following layout tags.
25659 \end_layout
25660
25661 \begin_layout Description
25662 \begin_inset Flex Code
25663 status collapsed
25664
25665 \begin_layout Plain Layout
25666 HTMLAttr
25667 \end_layout
25668
25669 \end_inset
25670
25671  [
25672 \begin_inset Flex Code
25673 status collapsed
25674
25675 \begin_layout Plain Layout
25676 string
25677 \end_layout
25678
25679 \end_inset
25680
25681 ] Specifies attribute information to be output with the main tag.
25682  For example,
25683 \begin_inset Quotes eld
25684 \end_inset
25685
25686
25687 \begin_inset Flex Code
25688 status collapsed
25689
25690 \begin_layout Plain Layout
25691 class=`myinset' onclick=`\SpecialChar ldots
25692 '
25693 \end_layout
25694
25695 \end_inset
25696
25697
25698 \begin_inset Quotes erd
25699 \end_inset
25700
25701 .
25702  By default, \SpecialChar LyX
25703  will output
25704 \begin_inset Quotes eld
25705 \end_inset
25706
25707
25708 \begin_inset Flex Code
25709 status collapsed
25710
25711 \begin_layout Plain Layout
25712 class=`insetname'
25713 \end_layout
25714
25715 \end_inset
25716
25717
25718 \begin_inset Quotes erd
25719 \end_inset
25720
25721 , where
25722 \begin_inset Flex Code
25723 status collapsed
25724
25725 \begin_layout Plain Layout
25726 insetname
25727 \end_layout
25728
25729 \end_inset
25730
25731  is the \SpecialChar LyX
25732  name of the inset, made lowercase and with non-alphanumeric characters
25733  converted to underscores, for example: footnote.
25734 \end_layout
25735
25736 \begin_layout Description
25737 \begin_inset Flex Code
25738 status collapsed
25739
25740 \begin_layout Plain Layout
25741 HTMLForceCSS
25742 \end_layout
25743
25744 \end_inset
25745
25746  [
25747 \begin_inset Flex Code
25748 status collapsed
25749
25750 \begin_layout Plain Layout
25751
25752 \emph on
25753 0
25754 \emph default
25755 ,1
25756 \end_layout
25757
25758 \end_inset
25759
25760 ] Whether to output the default CSS information \SpecialChar LyX
25761  generates for this layout,
25762  even if additional information is explicitly provided via
25763 \begin_inset Flex Code
25764 status collapsed
25765
25766 \begin_layout Plain Layout
25767 HTMLStyle
25768 \end_layout
25769
25770 \end_inset
25771
25772 .
25773  Setting this to
25774 \begin_inset Flex Code
25775 status collapsed
25776
25777 \begin_layout Plain Layout
25778 1
25779 \end_layout
25780
25781 \end_inset
25782
25783  allows you to alter or augment the generated CSS, rather than to override
25784  it completely.
25785  Default is 0.
25786 \end_layout
25787
25788 \begin_layout Description
25789 \begin_inset Flex Code
25790 status collapsed
25791
25792 \begin_layout Plain Layout
25793 HTMLInnerAttr
25794 \end_layout
25795
25796 \end_inset
25797
25798  [
25799 \begin_inset Flex Code
25800 status collapsed
25801
25802 \begin_layout Plain Layout
25803 string
25804 \end_layout
25805
25806 \end_inset
25807
25808 ] Attributes for the inner tag.
25809  Defaults to
25810 \begin_inset Newline newline
25811 \end_inset
25812
25813
25814 \begin_inset Quotes eld
25815 \end_inset
25816
25817
25818 \begin_inset Flex Code
25819 status collapsed
25820
25821 \begin_layout Plain Layout
25822 class=`insetname_inner'
25823 \end_layout
25824
25825 \end_inset
25826
25827
25828 \begin_inset Quotes erd
25829 \end_inset
25830
25831 .
25832 \end_layout
25833
25834 \begin_layout Description
25835 \begin_inset Flex Code
25836 status collapsed
25837
25838 \begin_layout Plain Layout
25839 HTMLInnerTag
25840 \end_layout
25841
25842 \end_inset
25843
25844  [
25845 \begin_inset Flex Code
25846 status collapsed
25847
25848 \begin_layout Plain Layout
25849 string
25850 \end_layout
25851
25852 \end_inset
25853
25854 ] The inner tag, replacing
25855 \begin_inset Flex Code
25856 status collapsed
25857
25858 \begin_layout Plain Layout
25859 innertag
25860 \end_layout
25861
25862 \end_inset
25863
25864  in the examples above.
25865  By default, there is none.
25866 \end_layout
25867
25868 \begin_layout Description
25869 \begin_inset Flex Code
25870 status collapsed
25871
25872 \begin_layout Plain Layout
25873 HTMLIsBlock
25874 \end_layout
25875
25876 \end_inset
25877
25878  [
25879 \begin_inset Flex Code
25880 status collapsed
25881
25882 \begin_layout Plain Layout
25883 0,
25884 \emph on
25885 1
25886 \end_layout
25887
25888 \end_inset
25889
25890 ] Whether this inset represents a standalone block of text (such as a footnote)
25891  or instead represents material that is included in the surrounding text
25892  (such as a branch).
25893  Defaults to 1.
25894 \end_layout
25895
25896 \begin_layout Description
25897 \begin_inset Flex Code
25898 status collapsed
25899
25900 \begin_layout Plain Layout
25901 HTMLLabel
25902 \end_layout
25903
25904 \end_inset
25905
25906  [
25907 \begin_inset Flex Code
25908 status collapsed
25909
25910 \begin_layout Plain Layout
25911 string
25912 \end_layout
25913
25914 \end_inset
25915
25916 ] A label for this inset, possibly including a reference to a counter.
25917  For example, for footnote, it might be:
25918 \begin_inset Flex Code
25919 status collapsed
25920
25921 \begin_layout Plain Layout
25922
25923 \backslash
25924 arabic{footnote}
25925 \end_layout
25926
25927 \end_inset
25928
25929 .
25930  This is optional, and there is no default.
25931 \end_layout
25932
25933 \begin_layout Description
25934 \begin_inset Flex Code
25935 status collapsed
25936
25937 \begin_layout Plain Layout
25938 HTMLPreamble
25939 \end_layout
25940
25941 \end_inset
25942
25943  Information to be output in the
25944 \begin_inset Flex Code
25945 status collapsed
25946
25947 \begin_layout Plain Layout
25948 <head>
25949 \end_layout
25950
25951 \end_inset
25952
25953  section when this style is used.
25954  This might, for example, be used to include a
25955 \begin_inset Flex Code
25956 status collapsed
25957
25958 \begin_layout Plain Layout
25959 <script>
25960 \end_layout
25961
25962 \end_inset
25963
25964  block defining an
25965 \begin_inset Flex Code
25966 status collapsed
25967
25968 \begin_layout Plain Layout
25969 onclick
25970 \end_layout
25971
25972 \end_inset
25973
25974  handler.
25975 \end_layout
25976
25977 \begin_layout Description
25978 \begin_inset Flex Code
25979 status collapsed
25980
25981 \begin_layout Plain Layout
25982 HTMLStyle
25983 \end_layout
25984
25985 \end_inset
25986
25987  CSS style information to be included when this style is used.
25988  Note that this will automatically be wrapped in a layout-generated
25989 \begin_inset Flex Code
25990 status collapsed
25991
25992 \begin_layout Plain Layout
25993 <style>
25994 \end_layout
25995
25996 \end_inset
25997
25998  block, so only the CSS itself need be included.
25999 \end_layout
26000
26001 \begin_layout Description
26002 \begin_inset Flex Code
26003 status collapsed
26004
26005 \begin_layout Plain Layout
26006 HTMLTag
26007 \end_layout
26008
26009 \end_inset
26010
26011  [
26012 \begin_inset Flex Code
26013 status collapsed
26014
26015 \begin_layout Plain Layout
26016 string
26017 \end_layout
26018
26019 \end_inset
26020
26021 ] The tag to be used for the main label, replacing
26022 \begin_inset Flex Code
26023 status collapsed
26024
26025 \begin_layout Plain Layout
26026 tag
26027 \end_layout
26028
26029 \end_inset
26030
26031  in the examples above.
26032  The default depends upon the setting of
26033 \begin_inset Flex Code
26034 status collapsed
26035
26036 \begin_layout Plain Layout
26037 MultiPar
26038 \end_layout
26039
26040 \end_inset
26041
26042 : If
26043 \begin_inset Flex Code
26044 status collapsed
26045
26046 \begin_layout Plain Layout
26047 MultiPar
26048 \end_layout
26049
26050 \end_inset
26051
26052  is true, the default is
26053 \begin_inset Flex Code
26054 status collapsed
26055
26056 \begin_layout Plain Layout
26057 div
26058 \end_layout
26059
26060 \end_inset
26061
26062 ; if it is false, the default is
26063 \begin_inset Flex Code
26064 status collapsed
26065
26066 \begin_layout Plain Layout
26067 span
26068 \end_layout
26069
26070 \end_inset
26071
26072 .
26073 \end_layout
26074
26075 \begin_layout Subsection
26076 Float XHTML
26077 \end_layout
26078
26079 \begin_layout Standard
26080 The XHTML output for floats too can be controlled by layout information.
26081  The output has the following form:
26082 \end_layout
26083
26084 \begin_layout LyX-Code
26085 <tag attr=
26086 \begin_inset Quotes erd
26087 \end_inset
26088
26089 value
26090 \begin_inset Quotes erd
26091 \end_inset
26092
26093 >
26094 \end_layout
26095
26096 \begin_layout LyX-Code
26097 Contents of the float.
26098 \end_layout
26099
26100 \begin_layout LyX-Code
26101 </tag>
26102 \end_layout
26103
26104 \begin_layout Standard
26105 The caption, if there is one, is a separate inset and will be output as
26106  such.
26107  Its appearance can be controlled via the InsetLayout for caption insets.
26108
26109 \end_layout
26110
26111 \begin_layout Description
26112 \begin_inset Flex Code
26113 status collapsed
26114
26115 \begin_layout Plain Layout
26116 HTMLAttr
26117 \end_layout
26118
26119 \end_inset
26120
26121  [
26122 \begin_inset Flex Code
26123 status collapsed
26124
26125 \begin_layout Plain Layout
26126 string
26127 \end_layout
26128
26129 \end_inset
26130
26131 ] Specifies attribute information to be output with the main tag.
26132  For example,
26133 \begin_inset Quotes eld
26134 \end_inset
26135
26136
26137 \begin_inset Flex Code
26138 status collapsed
26139
26140 \begin_layout Plain Layout
26141 class=`myfloat' onclick=`\SpecialChar ldots
26142 '
26143 \end_layout
26144
26145 \end_inset
26146
26147
26148 \begin_inset Quotes erd
26149 \end_inset
26150
26151 .
26152  By default, \SpecialChar LyX
26153  will output
26154 \begin_inset Quotes eld
26155 \end_inset
26156
26157
26158 \begin_inset Flex Code
26159 status collapsed
26160
26161 \begin_layout Plain Layout
26162 class=`float float-floattype'
26163 \end_layout
26164
26165 \end_inset
26166
26167
26168 \begin_inset Quotes erd
26169 \end_inset
26170
26171 , where
26172 \begin_inset Flex Code
26173 status collapsed
26174
26175 \begin_layout Plain Layout
26176 floattype
26177 \end_layout
26178
26179 \end_inset
26180
26181  is \SpecialChar LyX
26182 's name for this type of float, as determined by the float declaration
26183  (see
26184 \begin_inset CommandInset ref
26185 LatexCommand ref
26186 reference "subsec:Floats"
26187
26188 \end_inset
26189
26190 ), though made lowercase and with non-alphanumeric characters converted
26191  to underscores, for example: float-table.
26192 \end_layout
26193
26194 \begin_layout Description
26195 \begin_inset Flex Code
26196 status collapsed
26197
26198 \begin_layout Plain Layout
26199 HTMLStyle
26200 \end_layout
26201
26202 \end_inset
26203
26204  CSS style information to be included when this float is used.
26205  Note that this will automatically be wrapped in a layout-generated
26206 \begin_inset Flex Code
26207 status collapsed
26208
26209 \begin_layout Plain Layout
26210 <style>
26211 \end_layout
26212
26213 \end_inset
26214
26215  block, so only the CSS itself need be included.
26216 \end_layout
26217
26218 \begin_layout Description
26219 \begin_inset Flex Code
26220 status collapsed
26221
26222 \begin_layout Plain Layout
26223 HTMLTag
26224 \end_layout
26225
26226 \end_inset
26227
26228  [
26229 \begin_inset Flex Code
26230 status collapsed
26231
26232 \begin_layout Plain Layout
26233 string
26234 \end_layout
26235
26236 \end_inset
26237
26238 ] The tag to be used for this float, replacing
26239 \begin_inset Quotes eld
26240 \end_inset
26241
26242
26243 \begin_inset Flex Code
26244 status collapsed
26245
26246 \begin_layout Plain Layout
26247 tag
26248 \end_layout
26249
26250 \end_inset
26251
26252
26253 \begin_inset Quotes erd
26254 \end_inset
26255
26256  in the example above.
26257  The default is
26258 \begin_inset Flex Code
26259 status collapsed
26260
26261 \begin_layout Plain Layout
26262 div
26263 \end_layout
26264
26265 \end_inset
26266
26267  and will rarely need changing.
26268 \end_layout
26269
26270 \begin_layout Subsection
26271 Bibliography formatting
26272 \end_layout
26273
26274 \begin_layout Standard
26275 The bibliography can be formatted using
26276 \begin_inset Flex Code
26277 status collapsed
26278
26279 \begin_layout Plain Layout
26280 CiteFormat
26281 \end_layout
26282
26283 \end_inset
26284
26285  blocks.
26286  See
26287 \begin_inset CommandInset ref
26288 LatexCommand ref
26289 reference "subsec:Citation-format-description"
26290
26291 \end_inset
26292
26293  for the details.
26294 \end_layout
26295
26296 \begin_layout Subsection
26297 \SpecialChar LyX
26298 -generated CSS
26299 \end_layout
26300
26301 \begin_layout Standard
26302 We have several times mentioned that \SpecialChar LyX
26303  will generate default CSS style rules
26304  for both insets and paragraph styles, based upon the other layout information
26305  that is provided.
26306  In this section, we shall say a word about which layout information \SpecialChar LyX
26307  uses
26308  and how.
26309 \end_layout
26310
26311 \begin_layout Standard
26312 At present, \SpecialChar LyX
26313  auto-generates CSS only for font information, making use of
26314  the
26315 \begin_inset Flex Code
26316 status collapsed
26317
26318 \begin_layout Plain Layout
26319 Family
26320 \end_layout
26321
26322 \end_inset
26323
26324 ,
26325 \begin_inset Flex Code
26326 status collapsed
26327
26328 \begin_layout Plain Layout
26329 Series
26330 \end_layout
26331
26332 \end_inset
26333
26334 ,
26335 \begin_inset Flex Code
26336 status collapsed
26337
26338 \begin_layout Plain Layout
26339 Shape
26340 \end_layout
26341
26342 \end_inset
26343
26344 , and
26345 \begin_inset Flex Code
26346 status collapsed
26347
26348 \begin_layout Plain Layout
26349 Size
26350 \end_layout
26351
26352 \end_inset
26353
26354  specified in the
26355 \begin_inset Flex Code
26356 status collapsed
26357
26358 \begin_layout Plain Layout
26359 Font
26360 \end_layout
26361
26362 \end_inset
26363
26364  declaration (see
26365 \begin_inset CommandInset ref
26366 LatexCommand ref
26367 reference "subsec:Font-description"
26368
26369 \end_inset
26370
26371 ).
26372  The translation is mostly straightforward and obvious.
26373  For example,
26374 \begin_inset Quotes eld
26375 \end_inset
26376
26377
26378 \begin_inset Flex Code
26379 status collapsed
26380
26381 \begin_layout Plain Layout
26382 Family Sans
26383 \end_layout
26384
26385 \end_inset
26386
26387
26388 \begin_inset Quotes erd
26389 \end_inset
26390
26391  becomes
26392 \begin_inset Quotes eld
26393 \end_inset
26394
26395
26396 \begin_inset Flex Code
26397 status collapsed
26398
26399 \begin_layout Plain Layout
26400 font-family: sans-serif;
26401 \end_layout
26402
26403 \end_inset
26404
26405
26406 \begin_inset Quotes erd
26407 \end_inset
26408
26409 .
26410  The correspondence of \SpecialChar LyX
26411  sizes and CSS sizes is a little less obvious but
26412  nonetheless intuitive.
26413  See the
26414 \begin_inset Flex Code
26415 status collapsed
26416
26417 \begin_layout Plain Layout
26418 getSizeCSS()
26419 \end_layout
26420
26421 \end_inset
26422
26423  function in
26424 \begin_inset Flex URL
26425 status collapsed
26426
26427 \begin_layout Plain Layout
26428
26429 src/FontInfo.cpp
26430 \end_layout
26431
26432 \end_inset
26433
26434  for the details.
26435 \end_layout
26436
26437 \begin_layout Chapter
26438 Including External Material
26439 \begin_inset CommandInset label
26440 LatexCommand label
26441 name "chap:Including-External-Material"
26442
26443 \end_inset
26444
26445
26446 \end_layout
26447
26448 \begin_layout Standard
26449 \begin_inset Box Shadowbox
26450 position "t"
26451 hor_pos "c"
26452 has_inner_box 1
26453 inner_pos "t"
26454 use_parbox 0
26455 use_makebox 0
26456 width "100col%"
26457 special "none"
26458 height "1in"
26459 height_special "totalheight"
26460 thickness "0.4pt"
26461 separation "3pt"
26462 shadowsize "4pt"
26463 framecolor "black"
26464 backgroundcolor "none"
26465 status open
26466
26467 \begin_layout Plain Layout
26468 WARNING: This portion of the documentation has not been updated for some
26469  time.
26470  We certainly hope that it is still accurate, but there are no guarantees.
26471 \end_layout
26472
26473 \end_inset
26474
26475
26476 \end_layout
26477
26478 \begin_layout Standard
26479 The use of material from sources external to \SpecialChar LyX
26480  is covered in detail in the
26481
26482 \emph on
26483 Embedded Objects
26484 \emph default
26485  manual.
26486  This part of the manual covers what needs to happen behind the scenes for
26487  new sorts of material to be included.
26488 \end_layout
26489
26490 \begin_layout Section
26491 How does it work?
26492 \end_layout
26493
26494 \begin_layout Standard
26495 The external material feature is based on the concept of a
26496 \emph on
26497 template
26498 \emph default
26499 .
26500  A template is a specification of how \SpecialChar LyX
26501  should interface with a certain kind
26502  of material.
26503  As bundled, \SpecialChar LyX
26504  comes with predefined templates for Xfig figures, various
26505  raster format images, chess diagrams, and LilyPond music notation.
26506  You can check the actual list by using the menu
26507 \begin_inset Flex Noun
26508 status collapsed
26509
26510 \begin_layout Plain Layout
26511 Insert\SpecialChar menuseparator
26512 File\SpecialChar menuseparator
26513 External Material
26514 \end_layout
26515
26516 \end_inset
26517
26518 .
26519  Furthermore, it is possible to roll your own template to support a specific
26520  kind of material.
26521  Later we'll describe in more detail what is involved, and hopefully you
26522  will submit all the templates you create so we can include them in a later
26523  \SpecialChar LyX
26524  version.
26525 \end_layout
26526
26527 \begin_layout Standard
26528 Another basic idea of the external material feature is to distinguish between
26529  the original file that serves as a base for final material and the produced
26530  file that is included in your exported or printed document.
26531  For example, consider the case of a figure produced with
26532 \begin_inset Flex Code
26533 status collapsed
26534
26535 \begin_layout Plain Layout
26536 Xfig
26537 \end_layout
26538
26539 \end_inset
26540
26541 .
26542  The Xfig application itself works on an original file with the
26543 \begin_inset Flex Code
26544 status collapsed
26545
26546 \begin_layout Plain Layout
26547 .fig
26548 \end_layout
26549
26550 \end_inset
26551
26552  extension.
26553  Within Xfig, you create and change your figure, and when you are done,
26554  you save the
26555 \begin_inset Flex Code
26556 status collapsed
26557
26558 \begin_layout Plain Layout
26559 fig
26560 \end_layout
26561
26562 \end_inset
26563
26564 -file.
26565  When you want to include the figure in your document, you invoke
26566 \begin_inset Flex Code
26567 status collapsed
26568
26569 \begin_layout Plain Layout
26570 transfig
26571 \end_layout
26572
26573 \end_inset
26574
26575  in order to create a PostScript file that can readily be included in your
26576  \SpecialChar LaTeX
26577  file.
26578  In this case, the
26579 \begin_inset Flex Code
26580 status collapsed
26581
26582 \begin_layout Plain Layout
26583 .fig
26584 \end_layout
26585
26586 \end_inset
26587
26588  file is the original file, and the PostScript file is the produced file.
26589 \end_layout
26590
26591 \begin_layout Standard
26592 This distinction is important in order to allow updating of the material
26593  while you are in the process of writing the document.
26594  Furthermore, it provides us with the flexibility that is needed to support
26595  multiple export formats.
26596  For instance, in the case of a plain text file, it is not exactly an award-winn
26597 ing idea to include the figure as raw PostScript.
26598  Instead, you would either prefer to just include a reference to the figure
26599  or try to invoke some graphics to ASCII converter to make the final result
26600  look similar to the real graphics.
26601  The external material management allows you to do this, because it is parametri
26602 zed on the different export formats that \SpecialChar LyX
26603  supports.
26604 \end_layout
26605
26606 \begin_layout Standard
26607 Besides supporting the production of different products according to the
26608  exported format, it supports tight integration with editing and viewing
26609  applications.
26610  In the case of an Xfig figure, you are able to invoke Xfig on the original
26611  file with a single click from within the external material dialog in \SpecialChar LyX
26612 ,
26613  and also preview the produced PostScript file with Ghostview with another
26614  click.
26615  No more fiddling around with the command line and/or file browsers to locate
26616  and manipulate the original or produced files.
26617  In this way, you are finally able to take full advantage of the many different
26618  applications that are relevant to use when you write your documents, and
26619  ultimately be more productive.
26620 \end_layout
26621
26622 \begin_layout Section
26623 The external template configuration files
26624 \end_layout
26625
26626 \begin_layout Standard
26627 It is relatively easy to add custom external template definitions to \SpecialChar LyX
26628 .
26629  However, be aware that doing this in an careless manner most probably
26630 \emph on
26631 will
26632 \emph default
26633  introduce an easily exploitable security hole.
26634  So before you do this, please read the discussion about security in
26635 \begin_inset CommandInset ref
26636 LatexCommand ref
26637 reference "sec:Security-discussion"
26638
26639 \end_inset
26640
26641 .
26642 \end_layout
26643
26644 \begin_layout Standard
26645 Having said that, we encourage you to submit any interesting templates that
26646  you create.
26647
26648 \end_layout
26649
26650 \begin_layout Standard
26651 The external templates are defined in the
26652 \begin_inset Flex Code
26653 status collapsed
26654
26655 \begin_layout Plain Layout
26656 *.xtemplate
26657 \end_layout
26658
26659 \end_inset
26660
26661  files that are stored in the
26662 \begin_inset Flex Code
26663 status collapsed
26664
26665 \begin_layout Plain Layout
26666 LyXDir/lib/xtemplates/
26667 \end_layout
26668
26669 \end_inset
26670
26671  directory.
26672  Each template is defined in a file of its own.
26673  You can place your own templates in
26674 \begin_inset Flex Code
26675 status collapsed
26676
26677 \begin_layout Plain Layout
26678 UserDir/xtemplates/
26679 \end_layout
26680
26681 \end_inset
26682
26683  or copy existing templates to that directory in order to modify them.
26684 \end_layout
26685
26686 \begin_layout Standard
26687 A typical template looks like this:
26688 \end_layout
26689
26690 \begin_layout LyX-Code
26691 Template XFig
26692 \end_layout
26693
26694 \begin_layout LyX-Code
26695 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
26696 \end_layout
26697
26698 \begin_layout LyX-Code
26699 HelpText
26700 \end_layout
26701
26702 \begin_layout LyX-Code
26703 An XFig figure.
26704 \end_layout
26705
26706 \begin_layout LyX-Code
26707 HelpTextEnd
26708 \end_layout
26709
26710 \begin_layout LyX-Code
26711 InputFormat fig
26712 \end_layout
26713
26714 \begin_layout LyX-Code
26715 FileFilter "*.fig"
26716 \end_layout
26717
26718 \begin_layout LyX-Code
26719 AutomaticProduction true
26720 \end_layout
26721
26722 \begin_layout LyX-Code
26723 Transform Rotate
26724 \end_layout
26725
26726 \begin_layout LyX-Code
26727 Transform Resize
26728 \end_layout
26729
26730 \begin_layout LyX-Code
26731 Format LaTeX
26732 \end_layout
26733
26734 \begin_layout LyX-Code
26735 TransformCommand Rotate RotationLatexCommand
26736 \end_layout
26737
26738 \begin_layout LyX-Code
26739 TransformCommand Resize ResizeLatexCommand
26740 \end_layout
26741
26742 \begin_layout LyX-Code
26743 Product "$$RotateFront$$ResizeFront
26744 \end_layout
26745
26746 \begin_layout LyX-Code
26747
26748 \backslash
26749
26750 \backslash
26751 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
26752 \end_layout
26753
26754 \begin_layout LyX-Code
26755          $$ResizeBack$$RotateBack"
26756 \end_layout
26757
26758 \begin_layout LyX-Code
26759 UpdateFormat pstex
26760 \end_layout
26761
26762 \begin_layout LyX-Code
26763 UpdateResult "$$AbsPath$$Basename.pstex_t"
26764 \end_layout
26765
26766 \begin_layout LyX-Code
26767 Requirement "graphicx"
26768 \end_layout
26769
26770 \begin_layout LyX-Code
26771 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
26772 \end_layout
26773
26774 \begin_layout LyX-Code
26775 ReferencedFile latex "$$AbsPath$$Basename.eps"
26776 \end_layout
26777
26778 \begin_layout LyX-Code
26779 ReferencedFile dvi "$$AbsPath$$Basename.eps"
26780 \end_layout
26781
26782 \begin_layout LyX-Code
26783 FormatEnd
26784 \end_layout
26785
26786 \begin_layout LyX-Code
26787 Format PDFLaTeX
26788 \end_layout
26789
26790 \begin_layout LyX-Code
26791 TransformCommand Rotate RotationLatexCommand
26792 \end_layout
26793
26794 \begin_layout LyX-Code
26795 TransformCommand Resize ResizeLatexCommand
26796 \end_layout
26797
26798 \begin_layout LyX-Code
26799 Product "$$RotateFront$$ResizeFront
26800 \end_layout
26801
26802 \begin_layout LyX-Code
26803
26804 \backslash
26805
26806 \backslash
26807 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
26808 \end_layout
26809
26810 \begin_layout LyX-Code
26811          $$ResizeBack$$RotateBack"
26812 \end_layout
26813
26814 \begin_layout LyX-Code
26815 UpdateFormat pdftex
26816 \end_layout
26817
26818 \begin_layout LyX-Code
26819 UpdateResult "$$AbsPath$$Basename.pdftex_t"
26820 \end_layout
26821
26822 \begin_layout LyX-Code
26823 Requirement "graphicx"
26824 \end_layout
26825
26826 \begin_layout LyX-Code
26827 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
26828 \end_layout
26829
26830 \begin_layout LyX-Code
26831 ReferencedFile latex "$$AbsPath$$Basename.pdf"
26832 \end_layout
26833
26834 \begin_layout LyX-Code
26835 FormatEnd
26836 \end_layout
26837
26838 \begin_layout LyX-Code
26839 Format Ascii
26840 \end_layout
26841
26842 \begin_layout LyX-Code
26843 Product "[XFig: $$FName]"
26844 \end_layout
26845
26846 \begin_layout LyX-Code
26847 FormatEnd
26848 \end_layout
26849
26850 \begin_layout LyX-Code
26851 Format DocBook
26852 \end_layout
26853
26854 \begin_layout LyX-Code
26855 Product "<graphic fileref=
26856 \backslash
26857 "$$AbsOrRelPathMaster$$Basename.eps
26858 \backslash
26859 ">
26860 \end_layout
26861
26862 \begin_layout LyX-Code
26863          </graphic>"
26864 \end_layout
26865
26866 \begin_layout LyX-Code
26867 UpdateFormat eps
26868 \end_layout
26869
26870 \begin_layout LyX-Code
26871 UpdateResult "$$AbsPath$$Basename.eps"
26872 \end_layout
26873
26874 \begin_layout LyX-Code
26875 ReferencedFile docbook "$$AbsPath$$Basename.eps"
26876 \end_layout
26877
26878 \begin_layout LyX-Code
26879 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
26880 \end_layout
26881
26882 \begin_layout LyX-Code
26883 FormatEnd
26884 \end_layout
26885
26886 \begin_layout LyX-Code
26887 TemplateEnd
26888 \end_layout
26889
26890 \begin_layout Standard
26891 As you can see, the template is enclosed in
26892 \begin_inset Flex Code
26893 status collapsed
26894
26895 \begin_layout Plain Layout
26896 Template
26897 \end_layout
26898
26899 \end_inset
26900
26901  \SpecialChar ldots
26902
26903 \begin_inset Flex Code
26904 status collapsed
26905
26906 \begin_layout Plain Layout
26907 TemplateEnd
26908 \end_layout
26909
26910 \end_inset
26911
26912 .
26913  It contains a header specifying some general settings and, for each supported
26914  primary document file format, a section
26915 \begin_inset Flex Code
26916 status collapsed
26917
26918 \begin_layout Plain Layout
26919 Format
26920 \end_layout
26921
26922 \end_inset
26923
26924  \SpecialChar ldots
26925
26926 \begin_inset Flex Code
26927 status collapsed
26928
26929 \begin_layout Plain Layout
26930 FormatEnd
26931 \end_layout
26932
26933 \end_inset
26934
26935 .
26936 \end_layout
26937
26938 \begin_layout Subsection
26939 The template header
26940 \end_layout
26941
26942 \begin_layout Description
26943 \begin_inset Flex Code
26944 status collapsed
26945
26946 \begin_layout Plain Layout
26947 AutomaticProduction
26948 \begin_inset space ~
26949 \end_inset
26950
26951 true|false
26952 \end_layout
26953
26954 \end_inset
26955
26956  Whether the file represented by the template must be generated by \SpecialChar LyX
26957 .
26958  This command must occur exactly once.
26959 \end_layout
26960
26961 \begin_layout Description
26962 \begin_inset Flex Code
26963 status collapsed
26964
26965 \begin_layout Plain Layout
26966 FileFilter
26967 \begin_inset space ~
26968 \end_inset
26969
26970 <pattern>
26971 \end_layout
26972
26973 \end_inset
26974
26975  A glob pattern that is used in the file dialog to filter out the desired
26976  files.
26977  If there is more than one possible file extension (e.
26978 \begin_inset space \thinspace{}
26979 \end_inset
26980
26981 g.
26982 \begin_inset space \space{}
26983 \end_inset
26984
26985 tgif has
26986 \begin_inset Flex Code
26987 status collapsed
26988
26989 \begin_layout Plain Layout
26990 .obj
26991 \end_layout
26992
26993 \end_inset
26994
26995  and
26996 \begin_inset Flex Code
26997 status collapsed
26998
26999 \begin_layout Plain Layout
27000 .tgo
27001 \end_layout
27002
27003 \end_inset
27004
27005 ), use something like
27006 \begin_inset Flex Code
27007 status collapsed
27008
27009 \begin_layout Plain Layout
27010 "*.{obj,tgo}"
27011 \end_layout
27012
27013 \end_inset
27014
27015 .
27016  This command must occur exactly once.
27017 \end_layout
27018
27019 \begin_layout Description
27020 \begin_inset Flex Code
27021 status collapsed
27022
27023 \begin_layout Plain Layout
27024 GuiName
27025 \begin_inset space ~
27026 \end_inset
27027
27028 <guiname>
27029 \end_layout
27030
27031 \end_inset
27032
27033  The text that is displayed on the button.
27034  This command must occur exactly once.
27035 \end_layout
27036
27037 \begin_layout Description
27038 \begin_inset Flex Code
27039 status collapsed
27040
27041 \begin_layout Plain Layout
27042 HelpText
27043 \begin_inset space ~
27044 \end_inset
27045
27046 <text>
27047 \begin_inset space ~
27048 \end_inset
27049
27050 HelpTextEnd
27051 \end_layout
27052
27053 \end_inset
27054
27055  The help text that is used in the External dialog.
27056  Provide enough information to explain to the user just what the template
27057  can provide him with.
27058  This command must occur exactly once.
27059 \end_layout
27060
27061 \begin_layout Description
27062 \begin_inset Flex Code
27063 status collapsed
27064
27065 \begin_layout Plain Layout
27066 InputFormat
27067 \begin_inset space ~
27068 \end_inset
27069
27070 <format>
27071 \end_layout
27072
27073 \end_inset
27074
27075  The file format of the original file.
27076  This must be the name of a format that is known to \SpecialChar LyX
27077  (see
27078 \begin_inset CommandInset ref
27079 LatexCommand ref
27080 reference "sec:Formats"
27081
27082 \end_inset
27083
27084 ).
27085  Use
27086 \begin_inset Quotes eld
27087 \end_inset
27088
27089
27090 \begin_inset Flex Code
27091 status collapsed
27092
27093 \begin_layout Plain Layout
27094 *
27095 \end_layout
27096
27097 \end_inset
27098
27099
27100 \begin_inset Quotes erd
27101 \end_inset
27102
27103  if the template can handle original files of more than one format.
27104  \SpecialChar LyX
27105  will attempt to interrogate the file itself in order to deduce its format
27106  in this case.
27107  This command must occur exactly once.
27108 \end_layout
27109
27110 \begin_layout Description
27111 \begin_inset Flex Code
27112 status collapsed
27113
27114 \begin_layout Plain Layout
27115 Template
27116 \begin_inset space ~
27117 \end_inset
27118
27119 <id>
27120 \end_layout
27121
27122 \end_inset
27123
27124  A unique name for the template.
27125  It must not contain substitution macros (see below).
27126 \end_layout
27127
27128 \begin_layout Description
27129 \begin_inset Flex Code
27130 status collapsed
27131
27132 \begin_layout Plain Layout
27133 Transform
27134 \begin_inset space ~
27135 \end_inset
27136
27137 Rotate|Resize|Clip|Extra
27138 \end_layout
27139
27140 \end_inset
27141
27142  This command specifies which transformations are supported by this template.
27143  It may occur zero or more times.
27144  This command enables the corresponding tabs in the external dialog.
27145  Each
27146 \begin_inset Flex Code
27147 status collapsed
27148
27149 \begin_layout Plain Layout
27150 Transform
27151 \end_layout
27152
27153 \end_inset
27154
27155  command must have either a corresponding
27156 \begin_inset Flex Code
27157 status collapsed
27158
27159 \begin_layout Plain Layout
27160 TransformCommand
27161 \end_layout
27162
27163 \end_inset
27164
27165  or a
27166 \begin_inset Flex Code
27167 status collapsed
27168
27169 \begin_layout Plain Layout
27170 TransformOption
27171 \end_layout
27172
27173 \end_inset
27174
27175  command in the
27176 \begin_inset Flex Code
27177 status collapsed
27178
27179 \begin_layout Plain Layout
27180 Format
27181 \end_layout
27182
27183 \end_inset
27184
27185  section.
27186  Otherwise the transformation will not be supported by that format.
27187 \end_layout
27188
27189 \begin_layout Subsection
27190 The Format section
27191 \end_layout
27192
27193 \begin_layout Description
27194 \begin_inset Flex Code
27195 status collapsed
27196
27197 \begin_layout Plain Layout
27198 Format
27199 \begin_inset space ~
27200 \end_inset
27201
27202 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
27203 \end_layout
27204
27205 \end_inset
27206
27207  The primary document file format that this format definition is for.
27208  Not every template has a sensible representation in all document file formats.
27209  Please define nevertheless a
27210 \begin_inset Flex Code
27211 status collapsed
27212
27213 \begin_layout Plain Layout
27214 Format
27215 \end_layout
27216
27217 \end_inset
27218
27219  section for all templates.
27220  Use a dummy text when no representation is available.
27221  Then you can at least see a reference to the external material in the exported
27222  document.
27223 \end_layout
27224
27225 \begin_layout Description
27226 \begin_inset Flex Code
27227 status collapsed
27228
27229 \begin_layout Plain Layout
27230 Option
27231 \begin_inset space ~
27232 \end_inset
27233
27234 <name>
27235 \begin_inset space ~
27236 \end_inset
27237
27238 <value>
27239 \end_layout
27240
27241 \end_inset
27242
27243  This command defines an additional macro
27244 \begin_inset Flex Code
27245 status collapsed
27246
27247 \begin_layout Plain Layout
27248 $$<name>
27249 \end_layout
27250
27251 \end_inset
27252
27253  for substitution in
27254 \begin_inset Flex Code
27255 status collapsed
27256
27257 \begin_layout Plain Layout
27258 Product
27259 \end_layout
27260
27261 \end_inset
27262
27263 .
27264
27265 \begin_inset Flex Code
27266 status collapsed
27267
27268 \begin_layout Plain Layout
27269 <value>
27270 \end_layout
27271
27272 \end_inset
27273
27274  itself may contain substitution macros.
27275  The advantage over using
27276 \begin_inset Flex Code
27277 status collapsed
27278
27279 \begin_layout Plain Layout
27280 <value>
27281 \end_layout
27282
27283 \end_inset
27284
27285  directly in
27286 \begin_inset Flex Code
27287 status collapsed
27288
27289 \begin_layout Plain Layout
27290 Product
27291 \end_layout
27292
27293 \end_inset
27294
27295  is that the substituted value of
27296 \begin_inset Flex Code
27297 status collapsed
27298
27299 \begin_layout Plain Layout
27300 $$<name>
27301 \end_layout
27302
27303 \end_inset
27304
27305  is sanitized so that it is a valid optional argument in the document format.
27306  This command may occur zero or more times.
27307 \end_layout
27308
27309 \begin_layout Description
27310 \begin_inset Flex Code
27311 status collapsed
27312
27313 \begin_layout Plain Layout
27314 Product
27315 \begin_inset space ~
27316 \end_inset
27317
27318 <text>
27319 \end_layout
27320
27321 \end_inset
27322
27323  The text that is inserted in the exported document.
27324  This is actually the most important command and can be quite complex.
27325  This command must occur exactly once.
27326 \end_layout
27327
27328 \begin_layout Description
27329 \begin_inset Flex Code
27330 status collapsed
27331
27332 \begin_layout Plain Layout
27333 Preamble
27334 \begin_inset space ~
27335 \end_inset
27336
27337 <name>
27338 \end_layout
27339
27340 \end_inset
27341
27342  This command specifies a preamble snippet that will be included in the
27343  \SpecialChar LaTeX
27344  preamble.
27345  It has to be defined using
27346 \begin_inset Flex Code
27347 status collapsed
27348
27349 \begin_layout Plain Layout
27350 PreambleDef
27351 \end_layout
27352
27353 \end_inset
27354
27355  \SpecialChar ldots
27356
27357 \begin_inset Flex Code
27358 status collapsed
27359
27360 \begin_layout Plain Layout
27361 PreambleDefEnd
27362 \end_layout
27363
27364 \end_inset
27365
27366 .
27367  This command may occur zero or more times.
27368 \end_layout
27369
27370 \begin_layout Description
27371 \begin_inset Flex Code
27372 status collapsed
27373
27374 \begin_layout Plain Layout
27375 ReferencedFile
27376 \begin_inset space ~
27377 \end_inset
27378
27379 <format>
27380 \begin_inset space ~
27381 \end_inset
27382
27383 <filename>
27384 \end_layout
27385
27386 \end_inset
27387
27388  This command denotes files that are created by the conversion process and
27389  are needed for a particular export format.
27390  If the filename is relative, it is interpreted relative to the master document.
27391  This command may be given zero or more times.
27392 \end_layout
27393
27394 \begin_layout Description
27395 \begin_inset Flex Code
27396 status collapsed
27397
27398 \begin_layout Plain Layout
27399 Requirement
27400 \begin_inset space ~
27401 \end_inset
27402
27403 <package>
27404 \end_layout
27405
27406 \end_inset
27407
27408  The name of a required \SpecialChar LaTeX
27409  package.
27410  The package is included via
27411 \begin_inset Flex Code
27412 status collapsed
27413
27414 \begin_layout Plain Layout
27415
27416 \backslash
27417 usepackage{}
27418 \end_layout
27419
27420 \end_inset
27421
27422  in the \SpecialChar LaTeX
27423  preamble.
27424  This command may occur zero or more times.
27425 \end_layout
27426
27427 \begin_layout Description
27428 \begin_inset Flex Code
27429 status collapsed
27430
27431 \begin_layout Plain Layout
27432 TransformCommand
27433 \begin_inset space ~
27434 \end_inset
27435
27436 Rotate
27437 \begin_inset space ~
27438 \end_inset
27439
27440 RotationLatexCommand
27441 \end_layout
27442
27443 \end_inset
27444
27445  This command specifies that the built in \SpecialChar LaTeX
27446  command should be used for rotation.
27447  This command may occur once or not at all.
27448 \end_layout
27449
27450 \begin_layout Description
27451 \begin_inset Flex Code
27452 status collapsed
27453
27454 \begin_layout Plain Layout
27455 TransformCommand
27456 \begin_inset space ~
27457 \end_inset
27458
27459 Resize
27460 \begin_inset space ~
27461 \end_inset
27462
27463 ResizeLatexCommand
27464 \end_layout
27465
27466 \end_inset
27467
27468  This command specifies that the built in \SpecialChar LaTeX
27469  command should be used for resizing.
27470  This command may occur once or not at all.
27471 \end_layout
27472
27473 \begin_layout Description
27474 \begin_inset Flex Code
27475 status collapsed
27476
27477 \begin_layout Plain Layout
27478 TransformOption
27479 \begin_inset space ~
27480 \end_inset
27481
27482 Rotate
27483 \begin_inset space ~
27484 \end_inset
27485
27486 RotationLatexOption
27487 \end_layout
27488
27489 \end_inset
27490
27491  This command specifies that rotation is done via an optional argument.
27492  This command may occur once or not at all.
27493 \end_layout
27494
27495 \begin_layout Description
27496 \begin_inset Flex Code
27497 status collapsed
27498
27499 \begin_layout Plain Layout
27500 TransformOption
27501 \begin_inset space ~
27502 \end_inset
27503
27504 Resize
27505 \begin_inset space ~
27506 \end_inset
27507
27508 ResizeLatexOption
27509 \end_layout
27510
27511 \end_inset
27512
27513  This command specifies that resizing is done via an optional argument.
27514  This command may occur once or not at all.
27515 \end_layout
27516
27517 \begin_layout Description
27518 \begin_inset Flex Code
27519 status collapsed
27520
27521 \begin_layout Plain Layout
27522 TransformOption
27523 \begin_inset space ~
27524 \end_inset
27525
27526 Clip
27527 \begin_inset space ~
27528 \end_inset
27529
27530 ClipLatexOption
27531 \end_layout
27532
27533 \end_inset
27534
27535  This command specifies that clipping is done via an optional argument.
27536  This command may occur once or not at all.
27537 \end_layout
27538
27539 \begin_layout Description
27540 \begin_inset Flex Code
27541 status collapsed
27542
27543 \begin_layout Plain Layout
27544 TransformOption
27545 \begin_inset space ~
27546 \end_inset
27547
27548 Extra
27549 \begin_inset space ~
27550 \end_inset
27551
27552 ExtraLatexOption
27553 \end_layout
27554
27555 \end_inset
27556
27557  This command specifies that an extra optional argument is used.
27558  This command may occur once or not at all.
27559 \end_layout
27560
27561 \begin_layout Description
27562 \begin_inset Flex Code
27563 status collapsed
27564
27565 \begin_layout Plain Layout
27566 UpdateFormat
27567 \begin_inset space ~
27568 \end_inset
27569
27570 <format>
27571 \end_layout
27572
27573 \end_inset
27574
27575  The file format of the converted file.
27576  This must be the name of a format that is known to \SpecialChar LyX
27577  (see the
27578 \begin_inset Flex Noun
27579 status collapsed
27580
27581 \begin_layout Plain Layout
27582 Tools\SpecialChar menuseparator
27583 Preferences\SpecialChar menuseparator
27584 File Handling\SpecialChar menuseparator
27585 File Format
27586 \end_layout
27587
27588 \end_inset
27589
27590  dialog).
27591  This command must occur exactly once.
27592  If the resulting file format is PDF, you need to specify the format
27593 \begin_inset Flex Code
27594 status collapsed
27595
27596 \begin_layout Plain Layout
27597 pdf6
27598 \end_layout
27599
27600 \end_inset
27601
27602 .
27603  This is the PDF format used for including graphics.
27604  The other defined PDF formats are for document export.
27605 \end_layout
27606
27607 \begin_layout Description
27608 \begin_inset Flex Code
27609 status collapsed
27610
27611 \begin_layout Plain Layout
27612 UpdateResult
27613 \begin_inset space ~
27614 \end_inset
27615
27616 <filename>
27617 \end_layout
27618
27619 \end_inset
27620
27621  The file name of the converted file.
27622  The file name must be absolute.
27623  This command must occur exactly once.
27624 \end_layout
27625
27626 \begin_layout Subsection
27627 Preamble definitions
27628 \end_layout
27629
27630 \begin_layout Standard
27631 The external template configuration file may contain additional preamble
27632  definitions enclosed by
27633 \begin_inset Flex Code
27634 status collapsed
27635
27636 \begin_layout Plain Layout
27637 PreambleDef
27638 \end_layout
27639
27640 \end_inset
27641
27642  \SpecialChar ldots
27643
27644 \begin_inset Flex Code
27645 status collapsed
27646
27647 \begin_layout Plain Layout
27648 PreambleDefEnd
27649 \end_layout
27650
27651 \end_inset
27652
27653 .
27654  They can be used by the templates in the
27655 \begin_inset Flex Code
27656 status collapsed
27657
27658 \begin_layout Plain Layout
27659 Format
27660 \end_layout
27661
27662 \end_inset
27663
27664  section.
27665 \end_layout
27666
27667 \begin_layout Section
27668 The substitution mechanism
27669 \end_layout
27670
27671 \begin_layout Standard
27672 When the external material facility invokes an external program, it is done
27673  on the basis of a command defined in the template configuration file.
27674  These commands can contain various macros that are expanded before execution.
27675  Execution always take place in the directory of the containing document.
27676 \end_layout
27677
27678 \begin_layout Standard
27679 Also, whenever external material is to be displayed, the name will be produced
27680  by the substitution mechanism, and most other commands in the template
27681  definition support substitution as well.
27682 \end_layout
27683
27684 \begin_layout Standard
27685 The available macros are the following:
27686 \end_layout
27687
27688 \begin_layout Description
27689 \begin_inset Flex Code
27690 status collapsed
27691
27692 \begin_layout Plain Layout
27693 $$AbsOrRelPathMaster
27694 \end_layout
27695
27696 \end_inset
27697
27698  The file path, absolute or relative to the master \SpecialChar LyX
27699  document.
27700 \end_layout
27701
27702 \begin_layout Description
27703 \begin_inset Flex Code
27704 status collapsed
27705
27706 \begin_layout Plain Layout
27707 $$AbsOrRelPathParent
27708 \end_layout
27709
27710 \end_inset
27711
27712  The file path, absolute or relative to the \SpecialChar LyX
27713  document.
27714 \end_layout
27715
27716 \begin_layout Description
27717 \begin_inset Flex Code
27718 status collapsed
27719
27720 \begin_layout Plain Layout
27721 $$AbsPath
27722 \end_layout
27723
27724 \end_inset
27725
27726  The absolute file path.
27727 \end_layout
27728
27729 \begin_layout Description
27730 \begin_inset Flex Code
27731 status collapsed
27732
27733 \begin_layout Plain Layout
27734 $$Basename
27735 \end_layout
27736
27737 \end_inset
27738
27739  The filename without path and without the extension.
27740 \end_layout
27741
27742 \begin_layout Description
27743 \begin_inset Flex Code
27744 status collapsed
27745
27746 \begin_layout Plain Layout
27747 $$Contents(
27748 \begin_inset Quotes eld
27749 \end_inset
27750
27751 filename.ext
27752 \begin_inset Quotes erd
27753 \end_inset
27754
27755 )
27756 \end_layout
27757
27758 \end_inset
27759
27760  This macro will expand to the contents of the file with the name
27761 \begin_inset Flex Code
27762 status collapsed
27763
27764 \begin_layout Plain Layout
27765 filename.ext
27766 \end_layout
27767
27768 \end_inset
27769
27770 .
27771 \end_layout
27772
27773 \begin_layout Description
27774 \begin_inset Flex Code
27775 status collapsed
27776
27777 \begin_layout Plain Layout
27778 $$Extension
27779 \end_layout
27780
27781 \end_inset
27782
27783  The file extension (including the dot).
27784 \end_layout
27785
27786 \begin_layout Description
27787 \begin_inset Flex Code
27788 status collapsed
27789
27790 \begin_layout Plain Layout
27791 $$pngOrjpg
27792 \end_layout
27793
27794 \end_inset
27795
27796  This will be the string
27797 \begin_inset Quotes eld
27798 \end_inset
27799
27800 jpg
27801 \begin_inset Quotes erd
27802 \end_inset
27803
27804  if the file is in JPEG format, otherwise it will be the string
27805 \begin_inset Quotes eld
27806 \end_inset
27807
27808 png
27809 \begin_inset Quotes erd
27810 \end_inset
27811
27812 .
27813  This is useful to avoid uneeded conversions for output formats that support
27814  both PNG and JPEG fomats.
27815  The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
27816  output
27817  format.
27818 \end_layout
27819
27820 \begin_layout Description
27821 \begin_inset Flex Code
27822 status collapsed
27823
27824 \begin_layout Plain Layout
27825 $$FName
27826 \end_layout
27827
27828 \end_inset
27829
27830  The filename of the file specified in the external material dialog.
27831  This is either an absolute name, or it is relative to the \SpecialChar LyX
27832  document.
27833 \end_layout
27834
27835 \begin_layout Description
27836 \begin_inset Flex Code
27837 status collapsed
27838
27839 \begin_layout Plain Layout
27840 $$FPath
27841 \end_layout
27842
27843 \end_inset
27844
27845  The path part of
27846 \begin_inset Flex Code
27847 status collapsed
27848
27849 \begin_layout Plain Layout
27850 $$FName
27851 \end_layout
27852
27853 \end_inset
27854
27855  (absolute name or relative to the \SpecialChar LyX
27856  document).
27857 \end_layout
27858
27859 \begin_layout Description
27860 \begin_inset Flex Code
27861 status collapsed
27862
27863 \begin_layout Plain Layout
27864 $$RelPathMaster
27865 \end_layout
27866
27867 \end_inset
27868
27869  The file path, relative to the master \SpecialChar LyX
27870  document.
27871 \end_layout
27872
27873 \begin_layout Description
27874 \begin_inset Flex Code
27875 status collapsed
27876
27877 \begin_layout Plain Layout
27878 $$RelPathParent
27879 \end_layout
27880
27881 \end_inset
27882
27883  The file path, relative to the \SpecialChar LyX
27884  document.
27885 \end_layout
27886
27887 \begin_layout Description
27888 \begin_inset Flex Code
27889 status collapsed
27890
27891 \begin_layout Plain Layout
27892 $$Sysdir
27893 \end_layout
27894
27895 \end_inset
27896
27897  This macro will expand to the absolute path of the system directory.
27898  This is typically used to point to the various helper scripts that are
27899  bundled with \SpecialChar LyX
27900 .
27901 \end_layout
27902
27903 \begin_layout Description
27904 \begin_inset Flex Code
27905 status collapsed
27906
27907 \begin_layout Plain Layout
27908 $$Tempname
27909 \end_layout
27910
27911 \end_inset
27912
27913  A name and full path to a temporary file which will be automatically deleted
27914  whenever the containing document is closed, or the external material insertion
27915  deleted.
27916 \end_layout
27917
27918 \begin_layout Standard
27919 All path macros contain a trailing directory separator, so you can construct
27920  e.
27921 \begin_inset space \thinspace{}
27922 \end_inset
27923
27924 g.
27925 \begin_inset space \space{}
27926 \end_inset
27927
27928 the absolute filename with
27929 \begin_inset Flex Code
27930 status collapsed
27931
27932 \begin_layout Plain Layout
27933 $$AbsPath$$Basename$$Extension
27934 \end_layout
27935
27936 \end_inset
27937
27938 .
27939 \end_layout
27940
27941 \begin_layout Standard
27942 The macros above are substituted in all commands unless otherwise noted.
27943  The command
27944 \begin_inset Flex Code
27945 status collapsed
27946
27947 \begin_layout Plain Layout
27948 Product
27949 \end_layout
27950
27951 \end_inset
27952
27953  supports additionally the following substitutions if they are enabled by
27954  the
27955 \begin_inset Flex Code
27956 status collapsed
27957
27958 \begin_layout Plain Layout
27959 Transform
27960 \end_layout
27961
27962 \end_inset
27963
27964  and
27965 \begin_inset Flex Code
27966 status collapsed
27967
27968 \begin_layout Plain Layout
27969 TransformCommand
27970 \end_layout
27971
27972 \end_inset
27973
27974  commands:
27975 \end_layout
27976
27977 \begin_layout Description
27978 \begin_inset Flex Code
27979 status collapsed
27980
27981 \begin_layout Plain Layout
27982 $$ResizeFront
27983 \end_layout
27984
27985 \end_inset
27986
27987  The front part of the resize command.
27988 \end_layout
27989
27990 \begin_layout Description
27991 \begin_inset Flex Code
27992 status collapsed
27993
27994 \begin_layout Plain Layout
27995 $$ResizeBack
27996 \end_layout
27997
27998 \end_inset
27999
28000  The back part of the resize command.
28001 \end_layout
28002
28003 \begin_layout Description
28004 \begin_inset Flex Code
28005 status collapsed
28006
28007 \begin_layout Plain Layout
28008 $$RotateFront
28009 \end_layout
28010
28011 \end_inset
28012
28013  The front part of the rotation command.
28014 \end_layout
28015
28016 \begin_layout Description
28017 \begin_inset Flex Code
28018 status collapsed
28019
28020 \begin_layout Plain Layout
28021 $$RotateBack
28022 \end_layout
28023
28024 \end_inset
28025
28026  The back part of the rotation command.
28027 \end_layout
28028
28029 \begin_layout Standard
28030 The value string of the
28031 \begin_inset Flex Code
28032 status collapsed
28033
28034 \begin_layout Plain Layout
28035 Option
28036 \end_layout
28037
28038 \end_inset
28039
28040  command supports additionally the following substitutions if they are enabled
28041  by the
28042 \begin_inset Flex Code
28043 status collapsed
28044
28045 \begin_layout Plain Layout
28046 Transform
28047 \end_layout
28048
28049 \end_inset
28050
28051  and
28052 \begin_inset Flex Code
28053 status collapsed
28054
28055 \begin_layout Plain Layout
28056 TransformOption
28057 \end_layout
28058
28059 \end_inset
28060
28061  commands:
28062 \end_layout
28063
28064 \begin_layout Description
28065 \begin_inset Flex Code
28066 status collapsed
28067
28068 \begin_layout Plain Layout
28069 $$Clip
28070 \end_layout
28071
28072 \end_inset
28073
28074  The clip option.
28075 \end_layout
28076
28077 \begin_layout Description
28078 \begin_inset Flex Code
28079 status collapsed
28080
28081 \begin_layout Plain Layout
28082 $$Extra
28083 \end_layout
28084
28085 \end_inset
28086
28087  The extra option.
28088 \end_layout
28089
28090 \begin_layout Description
28091 \begin_inset Flex Code
28092 status collapsed
28093
28094 \begin_layout Plain Layout
28095 $$Resize
28096 \end_layout
28097
28098 \end_inset
28099
28100  The resize option.
28101 \end_layout
28102
28103 \begin_layout Description
28104 \begin_inset Flex Code
28105 status collapsed
28106
28107 \begin_layout Plain Layout
28108 $$Rotate
28109 \end_layout
28110
28111 \end_inset
28112
28113  The rotation option.
28114 \end_layout
28115
28116 \begin_layout Standard
28117 You may ask why there are so many path macros.
28118  There are mainly two reasons:
28119 \end_layout
28120
28121 \begin_layout Enumerate
28122 Relative and absolute file names should remain relative or absolute, respectivel
28123 y.
28124  Users may have reasons to prefer either form.
28125  Relative names are useful for portable documents that should work on different
28126  machines, for example.
28127  Absolute names may be required by some programs.
28128 \end_layout
28129
28130 \begin_layout Enumerate
28131 \SpecialChar LaTeX
28132  treats relative file names differently than \SpecialChar LyX
28133  and other programs in nested
28134  included files.
28135  For \SpecialChar LyX
28136 , a relative file name is always relative to the document that contains
28137  the file name.
28138  For \SpecialChar LaTeX
28139 , it is always relative to the master document.
28140  These two definitions are identical if you have only one document, but
28141  differ if you have a master document that includes part documents.
28142  That means that relative filenames must be transformed when presented to
28143  \SpecialChar LaTeX
28144 .
28145  Fortunately \SpecialChar LyX
28146  does this automatically for you if you choose the right macros.
28147 \end_layout
28148
28149 \begin_layout Standard
28150 So which path macro should be used in new template definitions? The rule
28151  is not difficult:
28152 \end_layout
28153
28154 \begin_layout Itemize
28155 Use
28156 \begin_inset Flex Code
28157 status collapsed
28158
28159 \begin_layout Plain Layout
28160 $$AbsPath
28161 \end_layout
28162
28163 \end_inset
28164
28165  if an absolute path is required.
28166 \end_layout
28167
28168 \begin_layout Itemize
28169 Use
28170 \begin_inset Flex Code
28171 status collapsed
28172
28173 \begin_layout Plain Layout
28174 $$AbsOrRelPathMaster
28175 \end_layout
28176
28177 \end_inset
28178
28179  if the substituted string is some kind of \SpecialChar LaTeX
28180  input.
28181 \end_layout
28182
28183 \begin_layout Itemize
28184 Else use
28185 \begin_inset Flex Code
28186 status collapsed
28187
28188 \begin_layout Plain Layout
28189 $$AbsOrRelPathParent
28190 \end_layout
28191
28192 \end_inset
28193
28194  in order to preserve the user's choice.
28195 \end_layout
28196
28197 \begin_layout Standard
28198 There are special cases where this rule does not work and e.
28199 \begin_inset space \thinspace{}
28200 \end_inset
28201
28202 g.
28203 \begin_inset space \space{}
28204 \end_inset
28205
28206 relative names are needed, but normally it will work just fine.
28207  One example for such a case is the command
28208 \begin_inset Flex Code
28209 status collapsed
28210
28211 \begin_layout Plain Layout
28212 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
28213 \end_layout
28214
28215 \end_inset
28216
28217  in the XFig template above: We can't use the absolute name because the
28218  copier for
28219 \begin_inset Flex Code
28220 status collapsed
28221
28222 \begin_layout Plain Layout
28223 .pstex_t
28224 \end_layout
28225
28226 \end_inset
28227
28228  files needs the relative name in order to rewrite the file content.
28229 \end_layout
28230
28231 \begin_layout Section
28232 Security discussion
28233 \begin_inset CommandInset label
28234 LatexCommand label
28235 name "sec:Security-discussion"
28236
28237 \end_inset
28238
28239
28240 \end_layout
28241
28242 \begin_layout Standard
28243 The external material feature interfaces with a lot of external programs
28244  and does so automatically, so we have to consider the security implications
28245  of this.
28246  In particular, since you have the option of including your own filenames
28247  and/or parameter strings and those are expanded into a command, it seems
28248  that it would be possible to create a malicious document which executes
28249  arbitrary commands when a user views or prints the document.
28250  This is something we definitely want to avoid.
28251 \end_layout
28252
28253 \begin_layout Standard
28254 However, since the external program commands are specified in the template
28255  configuration file only, there are no security issues if \SpecialChar LyX
28256  is properly configure
28257 d with safe templates only.
28258  This is so because the external programs are invoked with the
28259 \begin_inset Flex Code
28260 status collapsed
28261
28262 \begin_layout Plain Layout
28263 execvp
28264 \end_layout
28265
28266 \end_inset
28267
28268 -system call rather than the
28269 \begin_inset Flex Code
28270 status collapsed
28271
28272 \begin_layout Plain Layout
28273 system
28274 \end_layout
28275
28276 \end_inset
28277
28278  system-call, so it's not possible to execute arbitrary commands from the
28279  filename or parameter section via the shell.
28280 \end_layout
28281
28282 \begin_layout Standard
28283 This also implies that you are restricted in what command strings you can
28284  use in the external material templates.
28285  In particular, pipes and redirection are not readily available.
28286  This has to be so if \SpecialChar LyX
28287  should remain safe.
28288  If you want to use some of the shell features, you should write a safe
28289  script to do this in a controlled manner, and then invoke the script from
28290  the command string.
28291
28292 \end_layout
28293
28294 \begin_layout Standard
28295 It is possible to design a template that interacts directly with the shell,
28296  but since this would allow a malicious user to execute arbitrary commands
28297  by writing clever filenames and/or parameters, we generally recommend that
28298  you only use safe scripts that work with the
28299 \begin_inset Flex Code
28300 status collapsed
28301
28302 \begin_layout Plain Layout
28303 execvp
28304 \end_layout
28305
28306 \end_inset
28307
28308  system call in a controlled manner.
28309  Of course, for use in a controlled environment, it can be tempting to just
28310  fall back to use ordinary shell scripts.
28311  If you do so, be aware that you
28312 \emph on
28313 will
28314 \emph default
28315  provide an easily exploitable security hole in your system.
28316  Of course it stands to reason that such unsafe templates will never be
28317  included in the standard \SpecialChar LyX
28318  distribution, although we do encourage people
28319  to submit new templates in the open source tradition.
28320  But \SpecialChar LyX
28321  as shipped from the official distribution channels will never have
28322  unsafe templates.
28323 \end_layout
28324
28325 \begin_layout Standard
28326 Including external material provides a lot of power, and you have to be
28327  careful not to introduce security hazards with this power.
28328  A subtle error in a single line in an innocent looking script can open
28329  the door to huge security problems.
28330  So if you do not fully understand the issues, we recommend that you consult
28331  a knowledgeable security professional or the \SpecialChar LyX
28332  development team if you have
28333  any questions about whether a given template is safe or not.
28334  And do this before you use it in an uncontrolled environment.
28335 \end_layout
28336
28337 \begin_layout Chapter
28338 \start_of_appendix
28339 List of supported \SpecialChar LyX
28340  functions to be used in layouts
28341 \begin_inset CommandInset label
28342 LatexCommand label
28343 name "chap:List-of-functions"
28344
28345 \end_inset
28346
28347
28348 \end_layout
28349
28350 \begin_layout Standard
28351 \align center
28352 \begin_inset Tabular
28353 <lyxtabular version="3" rows="11" columns="8">
28354 <features tabularvalignment="middle">
28355 <column alignment="left" valignment="top">
28356 <column alignment="left" valignment="top">
28357 <column alignment="left" valignment="top">
28358 <column alignment="left" valignment="top">
28359 <column alignment="left" valignment="top">
28360 <column alignment="left" valignment="top">
28361 <column alignment="left" valignment="top">
28362 <column alignment="left" valignment="top">
28363 <row>
28364 <cell alignment="left" valignment="top" usebox="none">
28365 \begin_inset Text
28366
28367 \begin_layout Plain Layout
28368 accents
28369 \end_layout
28370
28371 \end_inset
28372 </cell>
28373 <cell alignment="left" valignment="top" usebox="none">
28374 \begin_inset Text
28375
28376 \begin_layout Plain Layout
28377 booktabs
28378 \end_layout
28379
28380 \end_inset
28381 </cell>
28382 <cell alignment="left" valignment="top" usebox="none">
28383 \begin_inset Text
28384
28385 \begin_layout Plain Layout
28386 feyn
28387 \end_layout
28388
28389 \end_inset
28390 </cell>
28391 <cell alignment="left" valignment="top" usebox="none">
28392 \begin_inset Text
28393
28394 \begin_layout Plain Layout
28395 listings
28396 \end_layout
28397
28398 \end_inset
28399 </cell>
28400 <cell alignment="center" valignment="top" usebox="none">
28401 \begin_inset Text
28402
28403 \begin_layout Plain Layout
28404 natbib
28405 \end_layout
28406
28407 \end_inset
28408 </cell>
28409 <cell alignment="center" valignment="top" usebox="none">
28410 \begin_inset Text
28411
28412 \begin_layout Plain Layout
28413 rotfloat
28414 \end_layout
28415
28416 \end_inset
28417 </cell>
28418 <cell alignment="center" valignment="top" usebox="none">
28419 \begin_inset Text
28420
28421 \begin_layout Plain Layout
28422 tfrupee
28423 \end_layout
28424
28425 \end_inset
28426 </cell>
28427 <cell alignment="center" valignment="top" usebox="none">
28428 \begin_inset Text
28429
28430 \begin_layout Plain Layout
28431 wasysym
28432 \end_layout
28433
28434 \end_inset
28435 </cell>
28436 </row>
28437 <row>
28438 <cell alignment="left" valignment="top" usebox="none">
28439 \begin_inset Text
28440
28441 \begin_layout Plain Layout
28442 amsbsy
28443 \end_layout
28444
28445 \end_inset
28446 </cell>
28447 <cell alignment="left" valignment="top" usebox="none">
28448 \begin_inset Text
28449
28450 \begin_layout Plain Layout
28451 calc
28452 \end_layout
28453
28454 \end_inset
28455 </cell>
28456 <cell alignment="left" valignment="top" usebox="none">
28457 \begin_inset Text
28458
28459 \begin_layout Plain Layout
28460 fixltx2e
28461 \end_layout
28462
28463 \end_inset
28464 </cell>
28465 <cell alignment="left" valignment="top" usebox="none">
28466 \begin_inset Text
28467
28468 \begin_layout Plain Layout
28469 longtable
28470 \end_layout
28471
28472 \end_inset
28473 </cell>
28474 <cell alignment="center" valignment="top" usebox="none">
28475 \begin_inset Text
28476
28477 \begin_layout Plain Layout
28478 nomencl
28479 \end_layout
28480
28481 \end_inset
28482 </cell>
28483 <cell alignment="center" valignment="top" usebox="none">
28484 \begin_inset Text
28485
28486 \begin_layout Plain Layout
28487 rsphrase
28488 \end_layout
28489
28490 \end_inset
28491 </cell>
28492 <cell alignment="center" valignment="top" usebox="none">
28493 \begin_inset Text
28494
28495 \begin_layout Plain Layout
28496 tipa
28497 \end_layout
28498
28499 \end_inset
28500 </cell>
28501 <cell alignment="center" valignment="top" usebox="none">
28502 \begin_inset Text
28503
28504 \begin_layout Plain Layout
28505 wrapfig
28506 \end_layout
28507
28508 \end_inset
28509 </cell>
28510 </row>
28511 <row>
28512 <cell alignment="left" valignment="top" usebox="none">
28513 \begin_inset Text
28514
28515 \begin_layout Plain Layout
28516 amscd
28517 \end_layout
28518
28519 \end_inset
28520 </cell>
28521 <cell alignment="left" valignment="top" usebox="none">
28522 \begin_inset Text
28523
28524 \begin_layout Plain Layout
28525 CJK
28526 \end_layout
28527
28528 \end_inset
28529 </cell>
28530 <cell alignment="left" valignment="top" usebox="none">
28531 \begin_inset Text
28532
28533 \begin_layout Plain Layout
28534 float
28535 \end_layout
28536
28537 \end_inset
28538 </cell>
28539 <cell alignment="left" valignment="top" usebox="none">
28540 \begin_inset Text
28541
28542 \begin_layout Plain Layout
28543 lyxskak
28544 \end_layout
28545
28546 \end_inset
28547 </cell>
28548 <cell alignment="center" valignment="top" usebox="none">
28549 \begin_inset Text
28550
28551 \begin_layout Plain Layout
28552 pdfcolmk
28553 \end_layout
28554
28555 \end_inset
28556 </cell>
28557 <cell alignment="center" valignment="top" usebox="none">
28558 \begin_inset Text
28559
28560 \begin_layout Plain Layout
28561 setspace
28562 \end_layout
28563
28564 \end_inset
28565 </cell>
28566 <cell alignment="center" valignment="top" usebox="none">
28567 \begin_inset Text
28568
28569 \begin_layout Plain Layout
28570 tipx
28571 \end_layout
28572
28573 \end_inset
28574 </cell>
28575 <cell alignment="center" valignment="top" usebox="none">
28576 \begin_inset Text
28577
28578 \begin_layout Plain Layout
28579 xargs
28580 \end_layout
28581
28582 \end_inset
28583 </cell>
28584 </row>
28585 <row>
28586 <cell alignment="left" valignment="top" usebox="none">
28587 \begin_inset Text
28588
28589 \begin_layout Plain Layout
28590 amsmath
28591 \end_layout
28592
28593 \end_inset
28594 </cell>
28595 <cell alignment="left" valignment="top" usebox="none">
28596 \begin_inset Text
28597
28598 \begin_layout Plain Layout
28599 color
28600 \end_layout
28601
28602 \end_inset
28603 </cell>
28604 <cell alignment="left" valignment="top" usebox="none">
28605 \begin_inset Text
28606
28607 \begin_layout Plain Layout
28608 framed
28609 \end_layout
28610
28611 \end_inset
28612 </cell>
28613 <cell alignment="left" valignment="top" usebox="none">
28614 \begin_inset Text
28615
28616 \begin_layout Plain Layout
28617 makeidx
28618 \end_layout
28619
28620 \end_inset
28621 </cell>
28622 <cell alignment="center" valignment="top" usebox="none">
28623 \begin_inset Text
28624
28625 \begin_layout Plain Layout
28626 pdfpages
28627 \end_layout
28628
28629 \end_inset
28630 </cell>
28631 <cell alignment="center" valignment="top" usebox="none">
28632 \begin_inset Text
28633
28634 \begin_layout Plain Layout
28635 shapepar
28636 \end_layout
28637
28638 \end_inset
28639 </cell>
28640 <cell alignment="center" valignment="top" usebox="none">
28641 \begin_inset Text
28642
28643 \begin_layout Plain Layout
28644 tone
28645 \end_layout
28646
28647 \end_inset
28648 </cell>
28649 <cell alignment="center" valignment="top" usebox="none">
28650 \begin_inset Text
28651
28652 \begin_layout Plain Layout
28653 xcolor
28654 \end_layout
28655
28656 \end_inset
28657 </cell>
28658 </row>
28659 <row>
28660 <cell alignment="left" valignment="top" usebox="none">
28661 \begin_inset Text
28662
28663 \begin_layout Plain Layout
28664 amssymb
28665 \end_layout
28666
28667 \end_inset
28668 </cell>
28669 <cell alignment="left" valignment="top" usebox="none">
28670 \begin_inset Text
28671
28672 \begin_layout Plain Layout
28673 covington
28674 \end_layout
28675
28676 \end_inset
28677 </cell>
28678 <cell alignment="left" valignment="top" usebox="none">
28679 \begin_inset Text
28680
28681 \begin_layout Plain Layout
28682 graphicx
28683 \end_layout
28684
28685 \end_inset
28686 </cell>
28687 <cell alignment="left" valignment="top" usebox="none">
28688 \begin_inset Text
28689
28690 \begin_layout Plain Layout
28691 marvosym
28692 \end_layout
28693
28694 \end_inset
28695 </cell>
28696 <cell alignment="center" valignment="top" usebox="none">
28697 \begin_inset Text
28698
28699 \begin_layout Plain Layout
28700 pifont
28701 \end_layout
28702
28703 \end_inset
28704 </cell>
28705 <cell alignment="center" valignment="top" usebox="none">
28706 \begin_inset Text
28707
28708 \begin_layout Plain Layout
28709 slashed
28710 \end_layout
28711
28712 \end_inset
28713 </cell>
28714 <cell alignment="center" valignment="top" usebox="none">
28715 \begin_inset Text
28716
28717 \begin_layout Plain Layout
28718 txfonts
28719 \end_layout
28720
28721 \end_inset
28722 </cell>
28723 <cell alignment="center" valignment="top" usebox="none">
28724 \begin_inset Text
28725
28726 \begin_layout Plain Layout
28727 xy
28728 \end_layout
28729
28730 \end_inset
28731 </cell>
28732 </row>
28733 <row>
28734 <cell alignment="left" valignment="top" usebox="none">
28735 \begin_inset Text
28736
28737 \begin_layout Plain Layout
28738 amstext
28739 \end_layout
28740
28741 \end_inset
28742 </cell>
28743 <cell alignment="left" valignment="top" usebox="none">
28744 \begin_inset Text
28745
28746 \begin_layout Plain Layout
28747 csquotes
28748 \end_layout
28749
28750 \end_inset
28751 </cell>
28752 <cell alignment="left" valignment="top" usebox="none">
28753 \begin_inset Text
28754
28755 \begin_layout Plain Layout
28756 hhline
28757 \end_layout
28758
28759 \end_inset
28760 </cell>
28761 <cell alignment="left" valignment="top" usebox="none">
28762 \begin_inset Text
28763
28764 \begin_layout Plain Layout
28765 mathdesign
28766 \end_layout
28767
28768 \end_inset
28769 </cell>
28770 <cell alignment="center" valignment="top" usebox="none">
28771 \begin_inset Text
28772
28773 \begin_layout Plain Layout
28774 pmboxdraw
28775 \end_layout
28776
28777 \end_inset
28778 </cell>
28779 <cell alignment="center" valignment="top" usebox="none">
28780 \begin_inset Text
28781
28782 \begin_layout Plain Layout
28783 soul
28784 \end_layout
28785
28786 \end_inset
28787 </cell>
28788 <cell alignment="center" valignment="top" usebox="none">
28789 \begin_inset Text
28790
28791 \begin_layout Plain Layout
28792 ulem
28793 \end_layout
28794
28795 \end_inset
28796 </cell>
28797 <cell alignment="center" valignment="top" usebox="none">
28798 \begin_inset Text
28799
28800 \begin_layout Plain Layout
28801 yhmath
28802 \end_layout
28803
28804 \end_inset
28805 </cell>
28806 </row>
28807 <row>
28808 <cell alignment="left" valignment="top" usebox="none">
28809 \begin_inset Text
28810
28811 \begin_layout Plain Layout
28812 amsthm
28813 \end_layout
28814
28815 \end_inset
28816 </cell>
28817 <cell alignment="left" valignment="top" usebox="none">
28818 \begin_inset Text
28819
28820 \begin_layout Plain Layout
28821 dvipost
28822 \end_layout
28823
28824 \end_inset
28825 </cell>
28826 <cell alignment="left" valignment="top" usebox="none">
28827 \begin_inset Text
28828
28829 \begin_layout Plain Layout
28830 hyperref
28831 \end_layout
28832
28833 \end_inset
28834 </cell>
28835 <cell alignment="left" valignment="top" usebox="none">
28836 \begin_inset Text
28837
28838 \begin_layout Plain Layout
28839 mathdots
28840 \end_layout
28841
28842 \end_inset
28843 </cell>
28844 <cell alignment="center" valignment="top" usebox="none">
28845 \begin_inset Text
28846
28847 \begin_layout Plain Layout
28848 polyglossia
28849 \end_layout
28850
28851 \end_inset
28852 </cell>
28853 <cell alignment="center" valignment="top" usebox="none">
28854 \begin_inset Text
28855
28856 \begin_layout Plain Layout
28857 splitidx
28858 \end_layout
28859
28860 \end_inset
28861 </cell>
28862 <cell alignment="center" valignment="top" usebox="none">
28863 \begin_inset Text
28864
28865 \begin_layout Plain Layout
28866 undertilde
28867 \end_layout
28868
28869 \end_inset
28870 </cell>
28871 <cell alignment="center" valignment="top" usebox="none">
28872 \begin_inset Text
28873
28874 \begin_layout Plain Layout
28875
28876 \end_layout
28877
28878 \end_inset
28879 </cell>
28880 </row>
28881 <row>
28882 <cell alignment="left" valignment="top" usebox="none">
28883 \begin_inset Text
28884
28885 \begin_layout Plain Layout
28886 array
28887 \end_layout
28888
28889 \end_inset
28890 </cell>
28891 <cell alignment="left" valignment="top" usebox="none">
28892 \begin_inset Text
28893
28894 \begin_layout Plain Layout
28895 endnotes
28896 \end_layout
28897
28898 \end_inset
28899 </cell>
28900 <cell alignment="left" valignment="top" usebox="none">
28901 \begin_inset Text
28902
28903 \begin_layout Plain Layout
28904 ifsym
28905 \end_layout
28906
28907 \end_inset
28908 </cell>
28909 <cell alignment="left" valignment="top" usebox="none">
28910 \begin_inset Text
28911
28912 \begin_layout Plain Layout
28913 mathrsfs
28914 \end_layout
28915
28916 \end_inset
28917 </cell>
28918 <cell alignment="center" valignment="top" usebox="none">
28919 \begin_inset Text
28920
28921 \begin_layout Plain Layout
28922 prettyref
28923 \end_layout
28924
28925 \end_inset
28926 </cell>
28927 <cell alignment="center" valignment="top" usebox="none">
28928 \begin_inset Text
28929
28930 \begin_layout Plain Layout
28931 subfig
28932 \end_layout
28933
28934 \end_inset
28935 </cell>
28936 <cell alignment="center" valignment="top" usebox="none">
28937 \begin_inset Text
28938
28939 \begin_layout Plain Layout
28940 units
28941 \end_layout
28942
28943 \end_inset
28944 </cell>
28945 <cell alignment="center" valignment="top" usebox="none">
28946 \begin_inset Text
28947
28948 \begin_layout Plain Layout
28949
28950 \end_layout
28951
28952 \end_inset
28953 </cell>
28954 </row>
28955 <row>
28956 <cell alignment="left" valignment="top" usebox="none">
28957 \begin_inset Text
28958
28959 \begin_layout Plain Layout
28960 ascii
28961 \end_layout
28962
28963 \end_inset
28964 </cell>
28965 <cell alignment="left" valignment="top" usebox="none">
28966 \begin_inset Text
28967
28968 \begin_layout Plain Layout
28969 enumitem
28970 \end_layout
28971
28972 \end_inset
28973 </cell>
28974 <cell alignment="left" valignment="top" usebox="none">
28975 \begin_inset Text
28976
28977 \begin_layout Plain Layout
28978 ifthen
28979 \end_layout
28980
28981 \end_inset
28982 </cell>
28983 <cell alignment="left" valignment="top" usebox="none">
28984 \begin_inset Text
28985
28986 \begin_layout Plain Layout
28987 mhchem
28988 \end_layout
28989
28990 \end_inset
28991 </cell>
28992 <cell alignment="center" valignment="top" usebox="none">
28993 \begin_inset Text
28994
28995 \begin_layout Plain Layout
28996 pxfonts
28997 \end_layout
28998
28999 \end_inset
29000 </cell>
29001 <cell alignment="center" valignment="top" usebox="none">
29002 \begin_inset Text
29003
29004 \begin_layout Plain Layout
29005 subscript
29006 \end_layout
29007
29008 \end_inset
29009 </cell>
29010 <cell alignment="center" valignment="top" usebox="none">
29011 \begin_inset Text
29012
29013 \begin_layout Plain Layout
29014 url
29015 \end_layout
29016
29017 \end_inset
29018 </cell>
29019 <cell alignment="center" valignment="top" usebox="none">
29020 \begin_inset Text
29021
29022 \begin_layout Plain Layout
29023
29024 \end_layout
29025
29026 \end_inset
29027 </cell>
29028 </row>
29029 <row>
29030 <cell alignment="left" valignment="top" usebox="none">
29031 \begin_inset Text
29032
29033 \begin_layout Plain Layout
29034 bbding
29035 \end_layout
29036
29037 \end_inset
29038 </cell>
29039 <cell alignment="left" valignment="top" usebox="none">
29040 \begin_inset Text
29041
29042 \begin_layout Plain Layout
29043 esint
29044 \end_layout
29045
29046 \end_inset
29047 </cell>
29048 <cell alignment="left" valignment="top" usebox="none">
29049 \begin_inset Text
29050
29051 \begin_layout Plain Layout
29052 jurabib
29053 \end_layout
29054
29055 \end_inset
29056 </cell>
29057 <cell alignment="left" valignment="top" usebox="none">
29058 \begin_inset Text
29059
29060 \begin_layout Plain Layout
29061 multicol
29062 \end_layout
29063
29064 \end_inset
29065 </cell>
29066 <cell alignment="center" valignment="top" usebox="none">
29067 \begin_inset Text
29068
29069 \begin_layout Plain Layout
29070 refstyle
29071 \end_layout
29072
29073 \end_inset
29074 </cell>
29075 <cell alignment="center" valignment="top" usebox="none">
29076 \begin_inset Text
29077
29078 \begin_layout Plain Layout
29079 textcomp
29080 \end_layout
29081
29082 \end_inset
29083 </cell>
29084 <cell alignment="center" valignment="top" usebox="none">
29085 \begin_inset Text
29086
29087 \begin_layout Plain Layout
29088 varioref
29089 \end_layout
29090
29091 \end_inset
29092 </cell>
29093 <cell alignment="center" valignment="top" usebox="none">
29094 \begin_inset Text
29095
29096 \begin_layout Plain Layout
29097
29098 \end_layout
29099
29100 \end_inset
29101 </cell>
29102 </row>
29103 <row>
29104 <cell alignment="center" valignment="top" usebox="none">
29105 \begin_inset Text
29106
29107 \begin_layout Plain Layout
29108 bm
29109 \end_layout
29110
29111 \end_inset
29112 </cell>
29113 <cell alignment="center" valignment="top" usebox="none">
29114 \begin_inset Text
29115
29116 \begin_layout Plain Layout
29117 fancybox
29118 \end_layout
29119
29120 \end_inset
29121 </cell>
29122 <cell alignment="center" valignment="top" usebox="none">
29123 \begin_inset Text
29124
29125 \begin_layout Plain Layout
29126 latexsym
29127 \end_layout
29128
29129 \end_inset
29130 </cell>
29131 <cell alignment="center" valignment="top" usebox="none">
29132 \begin_inset Text
29133
29134 \begin_layout Plain Layout
29135 multirow
29136 \end_layout
29137
29138 \end_inset
29139 </cell>
29140 <cell alignment="center" valignment="top" usebox="none">
29141 \begin_inset Text
29142
29143 \begin_layout Plain Layout
29144 rotating
29145 \end_layout
29146
29147 \end_inset
29148 </cell>
29149 <cell alignment="center" valignment="top" usebox="none">
29150 \begin_inset Text
29151
29152 \begin_layout Plain Layout
29153 textgreek
29154 \end_layout
29155
29156 \end_inset
29157 </cell>
29158 <cell alignment="center" valignment="top" usebox="none">
29159 \begin_inset Text
29160
29161 \begin_layout Plain Layout
29162 verbatim
29163 \end_layout
29164
29165 \end_inset
29166 </cell>
29167 <cell alignment="center" valignment="top" usebox="none">
29168 \begin_inset Text
29169
29170 \begin_layout Plain Layout
29171
29172 \end_layout
29173
29174 \end_inset
29175 </cell>
29176 </row>
29177 </lyxtabular>
29178
29179 \end_inset
29180
29181
29182 \end_layout
29183
29184 \begin_layout Chapter
29185 Names of available colors to be used in layouts
29186 \begin_inset CommandInset label
29187 LatexCommand label
29188 name "chap:Names-of-colors"
29189
29190 \end_inset
29191
29192
29193 \end_layout
29194
29195 \begin_layout Standard
29196 The colors listed below are the standard colors and those that you can adjust
29197  in the \SpecialChar LyX
29198  preferences.
29199 \end_layout
29200
29201 \begin_layout Section
29202 Color functions
29203 \end_layout
29204
29205 \begin_layout Standard
29206 The following are no real colors, but rather act on color definitions:
29207 \end_layout
29208
29209 \begin_layout Description
29210 ignore The color is ignored
29211 \end_layout
29212
29213 \begin_layout Description
29214 inherit The color is inherited
29215 \end_layout
29216
29217 \begin_layout Description
29218 none
29219 \family roman
29220 \series medium
29221 \shape up
29222 \size normal
29223 \emph off
29224 \bar no
29225 \strikeout off
29226 \uuline off
29227 \uwave off
29228 \noun off
29229 \color none
29230  No particular color – clear or default
29231 \end_layout
29232
29233 \begin_layout Section
29234 Static colors
29235 \end_layout
29236
29237 \begin_layout Standard
29238 These are fixed colors that cannot me customized:
29239 \end_layout
29240
29241 \begin_layout Description
29242 black
29243 \end_layout
29244
29245 \begin_layout Description
29246 white
29247 \end_layout
29248
29249 \begin_layout Description
29250 blue
29251 \end_layout
29252
29253 \begin_layout Description
29254 brown
29255 \end_layout
29256
29257 \begin_layout Description
29258 cyan
29259 \end_layout
29260
29261 \begin_layout Description
29262 darkgray
29263 \end_layout
29264
29265 \begin_layout Description
29266 gray
29267 \end_layout
29268
29269 \begin_layout Description
29270 green
29271 \end_layout
29272
29273 \begin_layout Description
29274 lightgray
29275 \end_layout
29276
29277 \begin_layout Description
29278 lime
29279 \end_layout
29280
29281 \begin_layout Description
29282 magenta
29283 \end_layout
29284
29285 \begin_layout Description
29286 olive
29287 \end_layout
29288
29289 \begin_layout Description
29290 orange
29291 \end_layout
29292
29293 \begin_layout Description
29294 pink
29295 \end_layout
29296
29297 \begin_layout Description
29298 purple
29299 \end_layout
29300
29301 \begin_layout Description
29302 red
29303 \end_layout
29304
29305 \begin_layout Description
29306 teal
29307 \end_layout
29308
29309 \begin_layout Description
29310 violet
29311 \end_layout
29312
29313 \begin_layout Description
29314 yellow
29315 \end_layout
29316
29317 \begin_layout Section
29318 Dynamic colors
29319 \end_layout
29320
29321 \begin_layout Standard
29322 These are the colors allocated to specific elements in
29323 \begin_inset Info
29324 type  "menu"
29325 arg   "dialog-show prefs"
29326 \end_inset
29327
29328 :
29329 \end_layout
29330
29331 \begin_layout Description
29332 added_space Added space color
29333 \end_layout
29334
29335 \begin_layout Description
29336 addedtext Added text color
29337 \end_layout
29338
29339 \begin_layout Description
29340 appendix Appendix marker color
29341 \end_layout
29342
29343 \begin_layout Description
29344 background Background color
29345 \end_layout
29346
29347 \begin_layout Description
29348 bottomarea Bottom area color
29349 \end_layout
29350
29351 \begin_layout Description
29352 branchlabel Label color for branches
29353 \end_layout
29354
29355 \begin_layout Description
29356 buttonbg Color used for button background
29357 \end_layout
29358
29359 \begin_layout Description
29360 buttonframe Color for inset button frames
29361 \end_layout
29362
29363 \begin_layout Description
29364 buttonhoverbg Color used for button background under focus
29365 \end_layout
29366
29367 \begin_layout Description
29368 changebar Changebar color
29369 \end_layout
29370
29371 \begin_layout Description
29372 changedtextauthor1 Changed text color author 1
29373 \end_layout
29374
29375 \begin_layout Description
29376 changedtextauthor2 Changed text color author 2
29377 \end_layout
29378
29379 \begin_layout Description
29380 changedtextauthor3 Changed text color author 3
29381 \end_layout
29382
29383 \begin_layout Description
29384 changedtextauthor4 Changed text color author 4
29385 \end_layout
29386
29387 \begin_layout Description
29388 changedtextauthor5 Changed text color author 5
29389 \end_layout
29390
29391 \begin_layout Description
29392 collapsible Collapsible insets text color
29393 \end_layout
29394
29395 \begin_layout Description
29396 collapsibleframe Collapsible insets framecolor
29397 \end_layout
29398
29399 \begin_layout Description
29400 command Text color for command insets
29401 \end_layout
29402
29403 \begin_layout Description
29404 commandbg Background color for command insets
29405 \end_layout
29406
29407 \begin_layout Description
29408 commandframe Frame color for command insets
29409 \end_layout
29410
29411 \begin_layout Description
29412 comment Label color for comments
29413 \end_layout
29414
29415 \begin_layout Description
29416 commentbg Background color of comments
29417 \end_layout
29418
29419 \begin_layout Description
29420 cursor Cursor color
29421 \end_layout
29422
29423 \begin_layout Description
29424 deletedtext Deleted text color
29425 \end_layout
29426
29427 \begin_layout Description
29428 deletedtextmodifier Deleted text modifying color
29429 \end_layout
29430
29431 \begin_layout Description
29432 depthbar Color for the depth bars in the margin
29433 \end_layout
29434
29435 \begin_layout Description
29436 eolmarker End of line marker color
29437 \end_layout
29438
29439 \begin_layout Description
29440 error Color of the \SpecialChar LaTeX
29441  error box
29442 \end_layout
29443
29444 \begin_layout Description
29445 footlabel Label color for footnotes
29446 \end_layout
29447
29448 \begin_layout Description
29449 foreground Foreground color
29450 \end_layout
29451
29452 \begin_layout Description
29453 graphicsbg Graphics inset background color
29454 \end_layout
29455
29456 \begin_layout Description
29457 greyedoutbg Background color of greyedout inset
29458 \end_layout
29459
29460 \begin_layout Description
29461 greyedoutlabel Label color for greyedout insets
29462 \end_layout
29463
29464 \begin_layout Description
29465 greyedouttext Color for greyedout inset text
29466 \end_layout
29467
29468 \begin_layout Description
29469 indexlabel Label color for index insets
29470 \end_layout
29471
29472 \begin_layout Description
29473 inlinecompletion Inline completion color
29474 \end_layout
29475
29476 \begin_layout Description
29477 insetbg Inset marker background color
29478 \end_layout
29479
29480 \begin_layout Description
29481 insetframe Inset marker frame color
29482 \end_layout
29483
29484 \begin_layout Description
29485 language Color for marking foreign language words
29486 \end_layout
29487
29488 \begin_layout Description
29489 latex Text color in \SpecialChar LaTeX
29490  mode
29491 \end_layout
29492
29493 \begin_layout Description
29494 listingsbg Background color of listings inset
29495 \end_layout
29496
29497 \begin_layout Description
29498 marginlabel Label color for margin notes
29499 \end_layout
29500
29501 \begin_layout Description
29502 math Math inset text color
29503 \end_layout
29504
29505 \begin_layout Description
29506 mathbg Math inset background color
29507 \end_layout
29508
29509 \begin_layout Description
29510 mathcorners Math inset frame color not under focus
29511 \end_layout
29512
29513 \begin_layout Description
29514 mathframe Math inset frame color under focus
29515 \end_layout
29516
29517 \begin_layout Description
29518 mathline Math line color
29519 \end_layout
29520
29521 \begin_layout Description
29522 mathmacrobg Macro math inset background color
29523 \end_layout
29524
29525 \begin_layout Description
29526 mathmacroblend Macro math blended color
29527 \end_layout
29528
29529 \begin_layout Description
29530 mathmacroframe Macro math frame color
29531 \end_layout
29532
29533 \begin_layout Description
29534 mathmacrohoverbg Macro math inset background color hovered
29535 \end_layout
29536
29537 \begin_layout Description
29538 mathmacrolabel Macro math label color
29539 \end_layout
29540
29541 \begin_layout Description
29542 mathmacronewarg Macro template color for new parameters
29543 \end_layout
29544
29545 \begin_layout Description
29546 mathmacrooldarg Macro template color for old parameters
29547 \end_layout
29548
29549 \begin_layout Description
29550 newpage New page color
29551 \end_layout
29552
29553 \begin_layout Description
29554 nonunique_inlinecompletion Inline completion color for the non-unique part
29555 \end_layout
29556
29557 \begin_layout Description
29558 note Label color for notes
29559 \end_layout
29560
29561 \begin_layout Description
29562 notebg Background color of notes
29563 \end_layout
29564
29565 \begin_layout Description
29566 pagebreak Page break/line break color
29567 \end_layout
29568
29569 \begin_layout Description
29570 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
29571 \end_layout
29572
29573 \begin_layout Description
29574 phantomtext Text color for phantom insets
29575 \end_layout
29576
29577 \begin_layout Description
29578 preview The color used for previews
29579 \end_layout
29580
29581 \begin_layout Description
29582 previewframe Preview frame color
29583 \end_layout
29584
29585 \begin_layout Description
29586 regexpframe Color for regexp frame
29587 \end_layout
29588
29589 \begin_layout Description
29590 scroll Color that indicates when a row can be scrolled
29591 \end_layout
29592
29593 \begin_layout Description
29594 selection Background color of selected text
29595 \end_layout
29596
29597 \begin_layout Description
29598 selectiontext Foreground color of selected text
29599 \end_layout
29600
29601 \begin_layout Description
29602 shadedbg Background color of shaded box
29603 \end_layout
29604
29605 \begin_layout Description
29606 special Special chars text color
29607 \end_layout
29608
29609 \begin_layout Description
29610 tabularline Table line color
29611 \end_layout
29612
29613 \begin_layout Description
29614 tabularonoffline Table line color
29615 \end_layout
29616
29617 \begin_layout Description
29618 urllabel Label color for URL insets
29619 \end_layout
29620
29621 \begin_layout Description
29622 urltext Color for URL inset text
29623 \end_layout
29624
29625 \end_body
29626 \end_document