lib/doc/Customization.lyx

   1 #LyX 2.2 created this file. For more info see http://www.lyx.org/
   2 \lyxformat 503
   3 \begin_document
   4 \begin_header
   5 \origin unavailable
   6 \textclass scrbook
   7 \begin_preamble
   8 % DO NOT ALTER THIS PREAMBLE!!!
   9 %
  10 % This preamble is designed to ensure that this document prints
  11 % out as advertised. If you mess with this preamble,
  12 % parts of this document may not print out as expected.  If you
  13 % have problems LaTeXing this file, please contact
  14 % the documentation team
  15 % email: lyx-docs@lists.lyx.org
  16
  17 \usepackage{ifpdf} % part of the hyperref bundle
  18 \ifpdf % if pdflatex is used
  19
  20  % set fonts for nicer pdf view
  21  \IfFileExists{lmodern.sty}
  22   {\usepackage{lmodern}}{}
  23
  24 \fi % end if pdflatex is used
  25
  26 % the pages of the TOC is numbered roman
  27 % and a pdf-bookmark for the TOC is added
  28 \let\myTOC\tableofcontents
  29 \renewcommand\tableofcontents{%
  30   \frontmatter
  31   \pdfbookmark[1]{\contentsname}{}
  32   \myTOC
  33   \mainmatter }
  34
  35 % increase link area for cross-references and autoname them,
  36 \AtBeginDocument{\renewcommand{\ref}[1]{\mbox{\autoref{#1}}}}
  37 \@ifundefined{extrasenglish}{\usepackage[english]{babel}}{}
  38 \@ifpackageloaded{babel}{
  39  \addto\extrasenglish{%
  40   \renewcommand*{\equationautorefname}[1]{}%
  41   \renewcommand{\sectionautorefname}{sec.\negthinspace}%
  42   \renewcommand{\subsectionautorefname}{sec.\negthinspace}%
  43   \renewcommand{\subsubsectionautorefname}{sec.\negthinspace}%
  44  }
  45 }{}
  46 \end_preamble
  47 \options fleqn,bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
  48 \use_default_options false
  49 \begin_modules
  50 logicalmkup
  51 \end_modules
  52 \maintain_unincluded_children false
  53 \begin_local_layout
  54 Format 35
  55 InsetLayout Flex:MenuItem
  56 LyxType               charstyle
  57 LabelString           menu
  58 LatexType             command
  59 LatexName             menuitem
  60 Font
  61 Family              Sans
  62 EndFont
  63 Preamble
  64 \newcommand*{\menuitem}[1]{{\sffamily #1}}
  65 EndPreamble
  66 End
  67 # In case we need to do with sans...
  68 #InsetLayout CharStyle:Code
  69 #Font
  70 #Family              Sans
  71 #EndFont
  72 #Preamble
  73 #\renewcommand{\code}[1]{{\sffamily #1}}
  74 #EndPreamble
  75 #End
  76 \end_local_layout
  77 \language english
  78 \language_package default
  79 \inputencoding auto
  80 \fontencoding global
  81 \font_roman "default" "default"
  82 \font_sans "default" "default"
  83 \font_typewriter "default" "default"
  84 \font_math "auto" "auto"
  85 \font_default_family default
  86 \use_non_tex_fonts false
  87 \font_sc false
  88 \font_osf false
  89 \font_sf_scale 100 100
  90 \font_tt_scale 100 100
  91 \graphics default
  92 \default_output_format default
  93 \output_sync 0
  94 \bibtex_command default
  95 \index_command default
  96 \paperfontsize 12
  97 \spacing single
  98 \use_hyperref true
  99 \pdf_title "LyX Configuration Manual"
 100 \pdf_author "LyX Team"
 101 \pdf_subject "LyX-documentation Customization"
 102 \pdf_keywords "LyX, documentation, customization"
 103 \pdf_bookmarks true
 104 \pdf_bookmarksnumbered true
 105 \pdf_bookmarksopen true
 106 \pdf_bookmarksopenlevel 1
 107 \pdf_breaklinks false
 108 \pdf_pdfborder false
 109 \pdf_colorlinks true
 110 \pdf_backref false
 111 \pdf_pdfusetitle false
 112 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
 113 \papersize default
 114 \use_geometry false
 115 \use_package amsmath 0
 116 \use_package amssymb 0
 117 \use_package cancel 0
 118 \use_package esint 0
 119 \use_package mathdots 1
 120 \use_package mathtools 0
 121 \use_package mhchem 0
 122 \use_package stackrel 0
 123 \use_package stmaryrd 0
 124 \use_package undertilde 0
 125 \cite_engine basic
 126 \cite_engine_type default
 127 \biblio_style plain
 128 \use_bibtopic false
 129 \use_indices false
 130 \paperorientation portrait
 131 \suppress_date false
 132 \justification true
 133 \use_refstyle 0
 134 \branch OutDated
 135 \selected 0
 136 \filename_suffix 0
 137 \color #f5fae7
 138 \end_branch
 139 \index Index
 140 \shortcut idx
 141 \color #008000
 142 \end_index
 143 \secnumdepth 3
 144 \tocdepth 3
 145 \paragraph_separation indent
 146 \paragraph_indentation default
 147 \quotes_language english
 148 \papercolumns 1
 149 \papersides 2
 150 \paperpagestyle headings
 151 \tracking_changes true
 152 \output_changes false
 153 \html_math_output 0
 154 \html_css_as_file 0
 155 \html_be_strict true
 156 \author -712698321 "Jürgen Spitzmüller"
 157 \author -195340706 "Georg Baum"
 158 \author 274215730 "scott"
 159 \end_header
 160
 161 \begin_body
 162
 163 \begin_layout Title
 164 Customizing \SpecialChar LyX
 165 : Features for the Advanced User
 166 \end_layout
 167
 168 \begin_layout Author
 169 by the \SpecialChar LyX
 170  Team
 171 \begin_inset Foot
 172 status collapsed
 173
 174 \begin_layout Plain Layout
 175 \noindent
 176 If you have comments or error corrections, please send them to the \SpecialChar LyX
 177  Documentatio
 178 n mailing list,
 179 \begin_inset CommandInset href
 180 LatexCommand href
 181 target "lyx-docs@lists.lyx.org"
 182 type "mailto:"
 183
 184 \end_inset
 185
 186 .
 187  Include
 188 \begin_inset Quotes eld
 189 \end_inset
 190
 191 [Customization]
 192 \begin_inset Quotes erd
 193 \end_inset
 194
 195  in the subject header, and please cc the current maintainer of this file,
 196  Richard Heck <rgheck@comcast.net>.
 197 \end_layout
 198
 199 \end_inset
 200
 201
 202 \begin_inset Newline newline
 203 \end_inset
 204
 205
 206 \begin_inset Newline newline
 207 \end_inset
 208
 209 Version 2.1.x
 210 \end_layout
 211
 212 \begin_layout Standard
 213 \begin_inset CommandInset toc
 214 LatexCommand tableofcontents
 215
 216 \end_inset
 217
 218
 219 \end_layout
 220
 221 \begin_layout Standard
 222 \begin_inset Note Note
 223 status open
 224
 225 \begin_layout Plain Layout
 226 Please use change tracking when modifying this document.
 227  This makes it easier for our translators to recognize things that have
 228  been changed, and it helps the maintainer keep up-to-date with what's been
 229  done.
 230 \end_layout
 231
 232 \end_inset
 233
 234
 235 \end_layout
 236
 237 \begin_layout Chapter
 238 Introduction
 239 \end_layout
 240
 241 \begin_layout Standard
 242 This manual covers the customization features present in \SpecialChar LyX
 243 .
 244  In it, we discuss issues like keyboard shortcuts, screen previewing options,
 245  printer options, sending commands to \SpecialChar LyX
 246  via the \SpecialChar LyX
 247  Server, internationalization,
 248  installing new \SpecialChar LaTeX
 249  classes and \SpecialChar LyX
 250  layouts, etc.
 251  We can't possibly hope to touch on everything you can change—our developers
 252  add new features faster than we can document them—but we will explain the
 253  most common customizations and hopefully point you in the right direction
 254  for some of the more obscure ones.
 255 \end_layout
 256
 257 \begin_layout Standard
 258 \begin_inset Branch OutDated
 259 status collapsed
 260
 261 \begin_layout Standard
 262 Information from previous versions of this document that now seems to be
 263  outdated is contained in the OutDated branch of this document.
 264  By default, this information will not appear in the \SpecialChar LaTeX
 265  output.
 266 \end_layout
 267
 268 \end_inset
 269
 270
 271 \end_layout
 272
 273 \begin_layout Chapter
 274 \SpecialChar LyX
 275  configuration files
 276 \end_layout
 277
 278 \begin_layout Standard
 279 This chapter aims to help you to find your way through the \SpecialChar LyX
 280  configuration
 281  files.
 282  Before continuing to read this chapter, you should find out where your
 283  \SpecialChar LyX
 284  library and user directories are by using
 285 \begin_inset Flex MenuItem
 286 status collapsed
 287
 288 \begin_layout Plain Layout
 289 Help\SpecialChar menuseparator
 290 About
 291 \begin_inset space ~
 292 \end_inset
 293
 294 LyX
 295 \end_layout
 296
 297 \end_inset
 298
 299 .
 300  The library directory is the place where \SpecialChar LyX
 301  places its system-wide configuration
 302  files; the user directory is where you can place your modified versions.
 303  We will call the former
 304 \begin_inset Flex Code
 305 status collapsed
 306
 307 \begin_layout Plain Layout
 308 LyXDir
 309 \end_layout
 310
 311 \end_inset
 312
 313  and the latter
 314 \begin_inset Flex MenuItem
 315 status collapsed
 316
 317 \begin_layout Plain Layout
 318 UserDir
 319 \end_layout
 320
 321 \end_inset
 322
 323  in the remainder of this document.
 324
 325 \end_layout
 326
 327 \begin_layout Section
 328 What's in
 329 \begin_inset Flex Code
 330 status collapsed
 331
 332 \begin_layout Plain Layout
 333 LyXDir
 334 \end_layout
 335
 336 \end_inset
 337
 338 ?
 339 \end_layout
 340
 341 \begin_layout Standard
 342 \begin_inset Flex Code
 343 status collapsed
 344
 345 \begin_layout Plain Layout
 346 LyXDir
 347 \end_layout
 348
 349 \end_inset
 350
 351  and its sub-directories contain a number of files and that can be used
 352  to customize \SpecialChar LyX
 353 's behavior.
 354  You can change many of these files from within \SpecialChar LyX
 355  itself through the
 356 \begin_inset Flex MenuItem
 357 status collapsed
 358
 359 \begin_layout Plain Layout
 360 Tools\SpecialChar menuseparator
 361 Preferences
 362 \end_layout
 363
 364 \end_inset
 365
 366  dialog.
 367  Most customization that you will want to do in \SpecialChar LyX
 368  is possible through this
 369  dialog.
 370  However, many other inner aspects of \SpecialChar LyX
 371  can be customized by modifying the
 372  files in
 373 \begin_inset Flex Code
 374 status collapsed
 375
 376 \begin_layout Plain Layout
 377 LyXDir
 378 \end_layout
 379
 380 \end_inset
 381
 382 .
 383  These files fall in different categories, described in the following subsection
 384 s.
 385 \end_layout
 386
 387 \begin_layout Subsection
 388 Automatically generated files
 389 \end_layout
 390
 391 \begin_layout Standard
 392 The files, which are to be found in
 393 \begin_inset Flex MenuItem
 394 status collapsed
 395
 396 \begin_layout Plain Layout
 397 UserDir
 398 \end_layout
 399
 400 \end_inset
 401
 402 , are generated when you configure \SpecialChar LyX
 403 .
 404  They contain various default values that are guessed by inspection.
 405  In general, it is not a good idea to modify them, since they might be overwritt
 406 en at any time.
 407 \end_layout
 408
 409 \begin_layout Labeling
 410 \labelwidthstring 00.00.0000
 411 \begin_inset Flex Code
 412 status collapsed
 413
 414 \begin_layout Plain Layout
 415 lyxrc.defaults
 416 \end_layout
 417
 418 \end_inset
 419
 420  contains defaults for various commands.
 421 \end_layout
 422
 423 \begin_layout Labeling
 424 \labelwidthstring 00.00.0000
 425 \begin_inset Flex Code
 426 status collapsed
 427
 428 \begin_layout Plain Layout
 429 packages.lst
 430 \end_layout
 431
 432 \end_inset
 433
 434  contains the list of packages that have been recognized by \SpecialChar LyX
 435 .
 436  It is currently unused by the \SpecialChar LyX
 437  program itself, but the information extracted,
 438  and more, is made available with
 439 \begin_inset Flex MenuItem
 440 status collapsed
 441
 442 \begin_layout Plain Layout
 443 Help\SpecialChar menuseparator
 444 \SpecialChar LaTeX
 445
 446 \begin_inset space ~
 447 \end_inset
 448
 449 Configuration
 450 \end_layout
 451
 452 \end_inset
 453
 454 .
 455 \end_layout
 456
 457 \begin_layout Labeling
 458 \labelwidthstring 00.00.0000
 459 \begin_inset Flex Code
 460 status collapsed
 461
 462 \begin_layout Plain Layout
 463 textclass.lst
 464 \end_layout
 465
 466 \end_inset
 467
 468  the list of text classes that have been found in your
 469 \begin_inset Flex Code
 470 status collapsed
 471
 472 \begin_layout Plain Layout
 473 layout/
 474 \end_layout
 475
 476 \end_inset
 477
 478  directories, along with the associated \SpecialChar LaTeX
 479  document class and their description.
 480 \end_layout
 481
 482 \begin_layout Labeling
 483 \labelwidthstring 00.00.0000
 484 \begin_inset Flex Code
 485 status collapsed
 486
 487 \begin_layout Plain Layout
 488 lyxmodules.lst
 489 \end_layout
 490
 491 \end_inset
 492
 493  the list of layout modules found in your
 494 \begin_inset Flex Code
 495 status collapsed
 496
 497 \begin_layout Plain Layout
 498 layout/
 499 \end_layout
 500
 501 \end_inset
 502
 503  directories
 504 \end_layout
 505
 506 \begin_layout Labeling
 507 \labelwidthstring 00.00.0000
 508 \begin_inset Flex Code
 509 status collapsed
 510
 511 \begin_layout Plain Layout
 512 *files.lst
 513 \end_layout
 514
 515 \end_inset
 516
 517  lists of various sorts of \SpecialChar LaTeX
 518 -related files found on your system
 519 \end_layout
 520
 521 \begin_layout Labeling
 522 \labelwidthstring 00.00.0000
 523 \begin_inset Flex Code
 524 status collapsed
 525
 526 \begin_layout Plain Layout
 527 doc/\SpecialChar LaTeX
 528 Config.lyx
 529 \end_layout
 530
 531 \end_inset
 532
 533  is automatically generated during configuration from the file
 534 \begin_inset Flex Code
 535 status collapsed
 536
 537 \begin_layout Plain Layout
 538 \SpecialChar LaTeX
 539 Config.lyx.in
 540 \end_layout
 541
 542 \end_inset
 543
 544 .
 545  It contains information on your \SpecialChar LaTeX
 546  configuration.
 547 \end_layout
 548
 549 \begin_layout Subsection
 550 Directories
 551 \end_layout
 552
 553 \begin_layout Standard
 554 These directories are duplicated between
 555 \begin_inset Flex Code
 556 status collapsed
 557
 558 \begin_layout Plain Layout
 559 LyXDir
 560 \end_layout
 561
 562 \end_inset
 563
 564  and
 565 \begin_inset Flex Code
 566 status collapsed
 567
 568 \begin_layout Plain Layout
 569 UserDir
 570 \end_layout
 571
 572 \end_inset
 573
 574 .
 575  If a particular files exists in both places, the one in
 576 \begin_inset Flex Code
 577 status collapsed
 578
 579 \begin_layout Plain Layout
 580 UserDir
 581 \end_layout
 582
 583 \end_inset
 584
 585  will be used.
 586 \end_layout
 587
 588 \begin_layout Labeling
 589 \labelwidthstring 00.00.0000
 590 \begin_inset Flex Code
 591 status collapsed
 592
 593 \begin_layout Plain Layout
 594 bind/
 595 \end_layout
 596
 597 \end_inset
 598
 599  this directory contains files with the extension
 600 \begin_inset Flex Code
 601 status collapsed
 602
 603 \begin_layout Plain Layout
 604 .bind
 605 \end_layout
 606
 607 \end_inset
 608
 609  that define the keybindings used in \SpecialChar LyX
 610 .
 611  If there exists an internationalized version of the bind file named
 612 \begin_inset Flex Code
 613 status collapsed
 614
 615 \begin_layout Plain Layout
 616 $LANG_xxx.bind
 617 \end_layout
 618
 619 \end_inset
 620
 621 , that will be used first.
 622 \end_layout
 623
 624 \begin_layout Labeling
 625 \labelwidthstring 00.00.0000
 626 \begin_inset Flex Code
 627 status collapsed
 628
 629 \begin_layout Plain Layout
 630 clipart/
 631 \end_layout
 632
 633 \end_inset
 634
 635  contains graphics files that can be included in documents.
 636
 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 doc/
 646 \end_layout
 647
 648 \end_inset
 649
 650  contains \SpecialChar LyX
 651  documentation files (including the one you are currently reading).
 652  The file
 653 \begin_inset Flex Code
 654 status collapsed
 655
 656 \begin_layout Plain Layout
 657 \SpecialChar LaTeX
 658 Config.lyx
 659 \end_layout
 660
 661 \end_inset
 662
 663  deserves special attention, as noted above.
 664  The internationalized help docs are in subdirectories
 665 \begin_inset Flex Code
 666 status collapsed
 667
 668 \begin_layout Plain Layout
 669 doc/xx
 670 \end_layout
 671
 672 \end_inset
 673
 674  where
 675 \begin_inset Quotes eld
 676 \end_inset
 677
 678 xx
 679 \begin_inset Quotes erd
 680 \end_inset
 681
 682  is the ISO language code.
 683  See
 684 \begin_inset CommandInset ref
 685 LatexCommand ref
 686 reference "cha:Internationalizing-LyX"
 687
 688 \end_inset
 689
 690  for details.
 691 \end_layout
 692
 693 \begin_layout Labeling
 694 \labelwidthstring 00.00.0000
 695 \begin_inset Flex Code
 696 status collapsed
 697
 698 \begin_layout Plain Layout
 699 examples/
 700 \end_layout
 701
 702 \end_inset
 703
 704  contains example files that explain how to use some features.
 705  In the file browser, press the
 706 \begin_inset Flex MenuItem
 707 status collapsed
 708
 709 \begin_layout Plain Layout
 710 Examples
 711 \end_layout
 712
 713 \end_inset
 714
 715  button to get there.
 716 \end_layout
 717
 718 \begin_layout Labeling
 719 \labelwidthstring 00.00.0000
 720 \begin_inset Flex Code
 721 status collapsed
 722
 723 \begin_layout Plain Layout
 724 images/
 725 \end_layout
 726
 727 \end_inset
 728
 729  contains image files that are used by the
 730 \begin_inset Flex MenuItem
 731 status collapsed
 732
 733 \begin_layout Plain Layout
 734 Document
 735 \end_layout
 736
 737 \end_inset
 738
 739  dialog.
 740  In addition, it also contains the individual icons used in the toolbar
 741  and the banners that can be shown when \SpecialChar LyX
 742  is launched.
 743 \end_layout
 744
 745 \begin_layout Labeling
 746 \labelwidthstring 00.00.0000
 747 \begin_inset Flex Code
 748 status collapsed
 749
 750 \begin_layout Plain Layout
 751 kbd/
 752 \end_layout
 753
 754 \end_inset
 755
 756  contains keyboard keymapping files.
 757  See
 758 \begin_inset CommandInset ref
 759 LatexCommand ref
 760 reference "sec:International-Keymap-Stuff"
 761
 762 \end_inset
 763
 764  for details.
 765 \end_layout
 766
 767 \begin_layout Labeling
 768 \labelwidthstring 00.00.0000
 769 \begin_inset Flex Code
 770 status collapsed
 771
 772 \begin_layout Plain Layout
 773 layouts/
 774 \end_layout
 775
 776 \end_inset
 777
 778  contains the text class and module files described in
 779 \begin_inset CommandInset ref
 780 LatexCommand ref
 781 reference "cha:Installing-New-Document"
 782
 783 \end_inset
 784
 785 .
 786 \end_layout
 787
 788 \begin_layout Labeling
 789 \labelwidthstring 00.00.0000
 790 \begin_inset Flex Code
 791 status collapsed
 792
 793 \begin_layout Plain Layout
 794 lyx2lyx
 795 \end_layout
 796
 797 \end_inset
 798
 799  contains the
 800 \begin_inset Flex Code
 801 status collapsed
 802
 803 \begin_layout Plain Layout
 804 lyx2lyx
 805 \end_layout
 806
 807 \end_inset
 808
 809  Python scripts used to convert between \SpecialChar LyX
 810  versions.
 811  These can be run from the command line if, say, you want to batch-convert
 812  files.
 813 \end_layout
 814
 815 \begin_layout Labeling
 816 \labelwidthstring 00.00.0000
 817 \begin_inset Flex Code
 818 status collapsed
 819
 820 \begin_layout Plain Layout
 821 scripts/
 822 \end_layout
 823
 824 \end_inset
 825
 826  contains some files that demonstrate the capabilities of the
 827 \begin_inset Flex MenuItem
 828 status collapsed
 829
 830 \begin_layout Plain Layout
 831 External
 832 \begin_inset space ~
 833 \end_inset
 834
 835 Template
 836 \end_layout
 837
 838 \end_inset
 839
 840  feature.
 841  Also contains some scripts used by \SpecialChar LyX
 842  itself.
 843 \end_layout
 844
 845 \begin_layout Labeling
 846 \labelwidthstring 00.00.0000
 847 \begin_inset Flex Code
 848 status collapsed
 849
 850 \begin_layout Plain Layout
 851 templates/
 852 \end_layout
 853
 854 \end_inset
 855
 856  contains the standard \SpecialChar LyX
 857  template files described in
 858 \begin_inset CommandInset ref
 859 LatexCommand ref
 860 reference "subsec:Creating-Templates"
 861
 862 \end_inset
 863
 864 .
 865 \end_layout
 866
 867 \begin_layout Labeling
 868 \labelwidthstring 00.00.0000
 869 \begin_inset Flex Code
 870 status collapsed
 871
 872 \begin_layout Plain Layout
 873 ui/
 874 \end_layout
 875
 876 \end_inset
 877
 878  contains files with the extension
 879 \begin_inset Flex Code
 880 status collapsed
 881
 882 \begin_layout Plain Layout
 883 .ui
 884 \end_layout
 885
 886 \end_inset
 887
 888  that define the user interface to \SpecialChar LyX
 889 .
 890  That is, the files define which items appear in which menus and the items
 891  appearing on the toolbar.
 892 \end_layout
 893
 894 \begin_layout Subsection
 895 Files you don't want to modify
 896 \end_layout
 897
 898 \begin_layout Standard
 899 These files are used internally by \SpecialChar LyX
 900  and you generally do not need to modify
 901  them unless you are a developer.
 902 \end_layout
 903
 904 \begin_layout Labeling
 905 \labelwidthstring 00.00.0000
 906 \begin_inset Flex Code
 907 status collapsed
 908
 909 \begin_layout Plain Layout
 910 CREDITS
 911 \end_layout
 912
 913 \end_inset
 914
 915  this file contains the list of \SpecialChar LyX
 916  developers.
 917  The contents are displayed with the menu entry
 918 \begin_inset Flex MenuItem
 919 status collapsed
 920
 921 \begin_layout Plain Layout
 922 Help\SpecialChar menuseparator
 923 About
 924 \begin_inset space ~
 925 \end_inset
 926
 927 LyX
 928 \end_layout
 929
 930 \end_inset
 931
 932 .
 933 \end_layout
 934
 935 \begin_layout Labeling
 936 \labelwidthstring 00.00.0000
 937 \begin_inset Flex Code
 938 status collapsed
 939
 940 \begin_layout Plain Layout
 941 chkconfig.ltx
 942 \end_layout
 943
 944 \end_inset
 945
 946  this is a \SpecialChar LaTeX
 947  script used during the configuration process.
 948  Do not run directly.
 949 \end_layout
 950
 951 \begin_layout Labeling
 952 \labelwidthstring 00.00.0000
 953 \begin_inset Flex Code
 954 status collapsed
 955
 956 \begin_layout Plain Layout
 957 configure.py
 958 \end_layout
 959
 960 \end_inset
 961
 962  this is a Python script that is used to re-configure \SpecialChar LyX
 963 .
 964  It creates configuration files in the directory it was run from.
 965 \end_layout
 966
 967 \begin_layout Subsection
 968 Other files needing a line or two
 969 \end_layout
 970
 971 \begin_layout Labeling
 972 \labelwidthstring 00.00.0000
 973 \begin_inset Flex Code
 974 status collapsed
 975
 976 \begin_layout Plain Layout
 977 encodings
 978 \end_layout
 979
 980 \end_inset
 981
 982  this contains tables describing how different character encodings can be
 983  mapped to Unicode
 984 \end_layout
 985
 986 \begin_layout Labeling
 987 \labelwidthstring 00.00.0000
 988 \begin_inset Flex Code
 989 status collapsed
 990
 991 \begin_layout Plain Layout
 992 external_templates
 993 \end_layout
 994
 995 \end_inset
 996
 997  this file contains the templates available to the new
 998 \begin_inset Flex MenuItem
 999 status collapsed
1000
1001 \begin_layout Plain Layout
1002 External
1003 \begin_inset space ~
1004 \end_inset
1005
1006 Template
1007 \end_layout
1008
1009 \end_inset
1010
1011  feature, see
1012 \begin_inset CommandInset ref
1013 LatexCommand ref
1014 reference "chap:Including-External-Material"
1015
1016 \end_inset
1017
1018 .
1019 \end_layout
1020
1021 \begin_layout Labeling
1022 \labelwidthstring 00.00.0000
1023 \begin_inset Flex Code
1024 status collapsed
1025
1026 \begin_layout Plain Layout
1027 languages
1028 \end_layout
1029
1030 \end_inset
1031
1032  this file contains a list of all the languages currently supported by \SpecialChar LyX
1033 .
1034 \end_layout
1035
1036 \begin_layout Labeling
1037 \labelwidthstring 00.00.0000
1038 \begin_inset Flex Code
1039 status collapsed
1040
1041 \begin_layout Plain Layout
1042 latexfonts
1043 \end_layout
1044
1045 \end_inset
1046
1047  contains information about the supported fonts.
1048 \end_layout
1049
1050 \begin_layout Labeling
1051 \labelwidthstring 00.00.0000
1052 \begin_inset Flex Code
1053 status collapsed
1054
1055 \begin_layout Plain Layout
1056 layouttranslations
1057 \end_layout
1058
1059 \end_inset
1060
1061  this file contains translations for internationalized paragraph styles
1062  (see
1063 \begin_inset CommandInset ref
1064 LatexCommand ref
1065 reference "subsec:I18n"
1066
1067 \end_inset
1068
1069 ).
1070 \end_layout
1071
1072 \begin_layout Labeling
1073 \labelwidthstring 00.00.0000
1074 \begin_inset Flex Code
1075 status collapsed
1076
1077 \begin_layout Plain Layout
1078 unicodesymbols
1079 \end_layout
1080
1081 \end_inset
1082
1083  this file contains information about unicode-encoded glyphs and the way
1084  they are supported by \SpecialChar LyX
1085  via \SpecialChar LaTeX
1086 .
1087 \end_layout
1088
1089 \begin_layout Section
1090 Your local configuration directory
1091 \end_layout
1092
1093 \begin_layout Standard
1094 Even if you are using \SpecialChar LyX
1095  as an unprivileged user, you might want to change
1096  \SpecialChar LyX
1097  configuration for your own use.
1098  The
1099 \begin_inset Flex Code
1100 status collapsed
1101
1102 \begin_layout Plain Layout
1103 UserDir
1104 \end_layout
1105
1106 \end_inset
1107
1108  directory contains all your personal configuration files.
1109  This is the directory described as
1110 \begin_inset Quotes eld
1111 \end_inset
1112
1113 user directory
1114 \begin_inset Quotes erd
1115 \end_inset
1116
1117  in
1118 \begin_inset Flex MenuItem
1119 status collapsed
1120
1121 \begin_layout Plain Layout
1122 Help\SpecialChar menuseparator
1123 About
1124 \begin_inset space ~
1125 \end_inset
1126
1127 LyX
1128 \end_layout
1129
1130 \end_inset
1131
1132 .
1133  This directory is used as a mirror of
1134 \begin_inset Flex Code
1135 status collapsed
1136
1137 \begin_layout Plain Layout
1138 LyXDir
1139 \end_layout
1140
1141 \end_inset
1142
1143 , which means that every file in
1144 \begin_inset Flex Code
1145 status collapsed
1146
1147 \begin_layout Plain Layout
1148 UserDir
1149 \end_layout
1150
1151 \end_inset
1152
1153  is a replacement for the corresponding file in
1154 \begin_inset Flex Code
1155 status collapsed
1156
1157 \begin_layout Plain Layout
1158 LyXDir
1159 \end_layout
1160
1161 \end_inset
1162
1163 .
1164  Any configuration file described in the above sections can be placed either
1165  in the system-wide directory, in which case it will affect all users, or
1166  in your local directory for your own use.
1167 \end_layout
1168
1169 \begin_layout Standard
1170 To make things clearer, let's provide a few examples:
1171 \end_layout
1172
1173 \begin_layout Itemize
1174 The preferences set in the
1175 \begin_inset Flex MenuItem
1176 status collapsed
1177
1178 \begin_layout Plain Layout
1179 Tools\SpecialChar menuseparator
1180 Preferences
1181 \end_layout
1182
1183 \end_inset
1184
1185  dialog are saved to a file
1186 \begin_inset Flex Code
1187 status collapsed
1188
1189 \begin_layout Plain Layout
1190 preferences
1191 \end_layout
1192
1193 \end_inset
1194
1195  in
1196 \begin_inset Flex Code
1197 status collapsed
1198
1199 \begin_layout Plain Layout
1200 UserDir
1201 \end_layout
1202
1203 \end_inset
1204
1205 .
1206 \end_layout
1207
1208 \begin_layout Itemize
1209 When you reconfigure using
1210 \begin_inset Flex MenuItem
1211 status collapsed
1212
1213 \begin_layout Plain Layout
1214 Tools\SpecialChar menuseparator
1215 Reconfigure
1216 \end_layout
1217
1218 \end_inset
1219
1220 , \SpecialChar LyX
1221  runs the
1222 \begin_inset Flex Code
1223 status collapsed
1224
1225 \begin_layout Plain Layout
1226 configure.py
1227 \end_layout
1228
1229 \end_inset
1230
1231  script, and the resulting files are written in your local configuration
1232  directory.
1233  This means that any additional text class file that you might have added
1234  in
1235 \begin_inset Flex Code
1236 status collapsed
1237
1238 \begin_layout Plain Layout
1239 UserDir/layouts
1240 \end_layout
1241
1242 \end_inset
1243
1244  will be added to the list of classes in the
1245 \begin_inset Flex MenuItem
1246 status collapsed
1247
1248 \begin_layout Plain Layout
1249 Document\SpecialChar menuseparator
1250 Settings
1251 \end_layout
1252
1253 \end_inset
1254
1255  dialog.
1256 \end_layout
1257
1258 \begin_layout Itemize
1259 If you get some updated documentation from \SpecialChar LyX
1260  ftp site and cannot install
1261  it because you do not have sysadmin rights on your system, you can just
1262  copy the files in
1263 \begin_inset Flex Code
1264 status collapsed
1265
1266 \begin_layout Plain Layout
1267 UserDir/doc/
1268 \end_layout
1269
1270 \end_inset
1271
1272  and the items in the
1273 \begin_inset Flex MenuItem
1274 status collapsed
1275
1276 \begin_layout Plain Layout
1277 Help
1278 \end_layout
1279
1280 \end_inset
1281
1282  menu will open them!
1283 \end_layout
1284
1285 \begin_layout Section
1286 Running \SpecialChar LyX
1287  with multiple configurations
1288 \end_layout
1289
1290 \begin_layout Standard
1291 The configuration freedom of the local configuration directory may not suffice
1292  if you want to have more than one configuration at your disposal.
1293  For example, you may want to be use different key bindings or printer settings
1294  at different times.
1295  You can achieve this by having several such directories.
1296  You then specify which directory to use at run-time.
1297 \end_layout
1298
1299 \begin_layout Standard
1300 Invoking \SpecialChar LyX
1301  with the command line switch
1302 \begin_inset Flex Code
1303 status collapsed
1304
1305 \begin_layout Plain Layout
1306 -userdir
1307 \end_layout
1308
1309 \end_inset
1310
1311
1312 \emph on
1313 <some directory>
1314 \emph default
1315  instructs the program to read the configuration from that directory, and
1316  not from the default directory.
1317  (You can determine the default directory by running \SpecialChar LyX
1318  without the
1319 \begin_inset Flex Code
1320 status collapsed
1321
1322 \begin_layout Plain Layout
1323 -userdir
1324 \end_layout
1325
1326 \end_inset
1327
1328  switch.) If the specified directory does not exist, \SpecialChar LyX
1329  offers to create it
1330  for you, just like it does for the default directory on the first time
1331  you run the program.
1332  You can modify the configuration options in this additional user directory
1333  exactly as you would for the default directory.
1334  These directories are completely independent (but read on).
1335  Note that setting the environment variable
1336 \begin_inset Flex Code
1337 status collapsed
1338
1339 \begin_layout Plain Layout
1340 LYX_USERDIR_VER
1341 \end_layout
1342
1343 \end_inset
1344
1345  to some value has exactly the same effect.
1346 \end_layout
1347
1348 \begin_layout Standard
1349 Having several configurations also requires more maintenance: if you want
1350  to add a new layout to
1351 \begin_inset Flex Code
1352 status collapsed
1353
1354 \begin_layout Plain Layout
1355 NewUserDir/layouts
1356 \end_layout
1357
1358 \end_inset
1359
1360  which you want available from all your configurations, you must add it
1361  to each directory separately.
1362  You can avoid this with the following trick: after \SpecialChar LyX
1363  creates the additional
1364  directory, most of the subdirectories (see above) are empty.
1365  If you want the new configuration to mirror an existing one, replace the
1366  empty subdirectory with a symbolic link to the matching subdirectory in
1367  the existing configuration.
1368  Take care with the
1369 \begin_inset Flex Code
1370 status collapsed
1371
1372 \begin_layout Plain Layout
1373 doc/
1374 \end_layout
1375
1376 \end_inset
1377
1378  subdirectory, however, since it contains a file written by the configuration
1379  script (also accessible through
1380 \begin_inset Flex MenuItem
1381 status collapsed
1382
1383 \begin_layout Plain Layout
1384 Tools\SpecialChar menuseparator
1385 Reconfigure
1386 \end_layout
1387
1388 \end_inset
1389
1390 ) which is configuration-specific.
1391 \end_layout
1392
1393 \begin_layout Chapter
1394 The Preferences dialog
1395 \end_layout
1396
1397 \begin_layout Standard
1398 All options of the preferences dialog are described in the Appendix
1399 \emph on
1400 The Preferences Dialog
1401 \emph default
1402  in the
1403 \emph on
1404 User's Guide
1405 \emph default
1406 .
1407  For some options you might find here more details.
1408 \end_layout
1409
1410 \begin_layout Section
1411 Formats
1412 \begin_inset CommandInset label
1413 LatexCommand label
1414 name "sec:Formats"
1415
1416 \end_inset
1417
1418
1419 \end_layout
1420
1421 \begin_layout Standard
1422 The first step is to define your file formats if they are not already defined.
1423  To do so, open the
1424 \begin_inset Flex MenuItem
1425 status collapsed
1426
1427 \begin_layout Plain Layout
1428 Tools\SpecialChar menuseparator
1429 Preferences
1430 \end_layout
1431
1432 \end_inset
1433
1434  dialog.
1435  Under
1436 \begin_inset Flex MenuItem
1437 status collapsed
1438
1439 \begin_layout Plain Layout
1440 File Handling\SpecialChar menuseparator
1441 File formats
1442 \end_layout
1443
1444 \end_inset
1445
1446  press the
1447 \begin_inset Flex MenuItem
1448 status collapsed
1449
1450 \begin_layout Plain Layout
1451 New
1452 \end_layout
1453
1454 \end_inset
1455
1456  button to define your new format.
1457  The
1458 \begin_inset Flex MenuItem
1459 status collapsed
1460
1461 \begin_layout Plain Layout
1462 Format
1463 \end_layout
1464
1465 \end_inset
1466
1467  field contains the name used to identify the format in the GUI.
1468  The
1469 \begin_inset Flex MenuItem
1470 status collapsed
1471
1472 \begin_layout Plain Layout
1473 Short Name
1474 \end_layout
1475
1476 \end_inset
1477
1478  is used to identify the format internally.
1479  You will also need to enter a file extension.
1480  These are all required.
1481  The optional
1482 \begin_inset Flex MenuItem
1483 status collapsed
1484
1485 \begin_layout Plain Layout
1486 Shortcut
1487 \end_layout
1488
1489 \end_inset
1490
1491  field is used to provide a keyboard shortcut on the menus.
1492  (For example, pressing
1493 \begin_inset Flex MenuItem
1494 status collapsed
1495
1496 \begin_layout Plain Layout
1497 Ctrl+D
1498 \end_layout
1499
1500 \end_inset
1501
1502  will
1503 \begin_inset Flex MenuItem
1504 status collapsed
1505
1506 \begin_layout Plain Layout
1507 Document\SpecialChar menuseparator
1508 View (Other Formats)\SpecialChar menuseparator
1509 DVI
1510 \end_layout
1511
1512 \end_inset
1513
1514 .)
1515 \end_layout
1516
1517 \begin_layout Standard
1518 A Format can have a
1519 \begin_inset Flex MenuItem
1520 status collapsed
1521
1522 \begin_layout Plain Layout
1523 Viewer
1524 \end_layout
1525
1526 \end_inset
1527
1528  and an
1529 \begin_inset Flex MenuItem
1530 status collapsed
1531
1532 \begin_layout Plain Layout
1533 Editor
1534 \end_layout
1535
1536 \end_inset
1537
1538  associated with it.
1539  For example, you might want to use
1540 \begin_inset Flex MenuItem
1541 status collapsed
1542
1543 \begin_layout Plain Layout
1544 Ghostview
1545 \end_layout
1546
1547 \end_inset
1548
1549  to view PostScript files.
1550  You can enter the command needed to start the program in the corresponding
1551  fields.
1552  In defining this command, you can use the four variables listed in the
1553  next section.
1554  The viewer is launched when you view an image in \SpecialChar LyX
1555  or use the
1556 \begin_inset Flex MenuItem
1557 status collapsed
1558
1559 \begin_layout Plain Layout
1560 Document\SpecialChar menuseparator
1561 View
1562 \end_layout
1563
1564 \end_inset
1565
1566  menu.
1567  The editor is for example launched when you right-click on an image and
1568  choose
1569 \begin_inset Flex MenuItem
1570 status collapsed
1571
1572 \begin_layout Plain Layout
1573 Edit externally
1574 \end_layout
1575
1576 \end_inset
1577
1578  in the appearing context menu.
1579 \end_layout
1580
1581 \begin_layout Standard
1582 The
1583 \begin_inset Flex MenuItem
1584 status collapsed
1585
1586 \begin_layout Plain Layout
1587 MIME
1588 \end_layout
1589
1590 \end_inset
1591
1592  type of a format is optional, but if it is specified, it must be unique
1593  across all formats.
1594  It is used to detect files of this format from the file contents.
1595  For some important file formats there is no MIME type officially registered
1596  with the
1597 \begin_inset CommandInset href
1598 LatexCommand href
1599 name "IANA"
1600 target "http://www.iana.org/assignments/media-types/"
1601
1602 \end_inset
1603
1604 .
1605  Therefore \SpecialChar LyX
1606  uses the extended list of MIME types as specified by
1607 \begin_inset CommandInset href
1608 LatexCommand href
1609 name "freedesktop.org"
1610 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1611
1612 \end_inset
1613
1614 .
1615 \end_layout
1616
1617 \begin_layout Standard
1618 The
1619 \begin_inset Flex MenuItem
1620 status collapsed
1621
1622 \begin_layout Plain Layout
1623 Document format
1624 \end_layout
1625
1626 \end_inset
1627
1628  option tells \SpecialChar LyX
1629  that a format is suitable for document export.
1630  If this is set and if a suitable conversion route exists (see
1631 \begin_inset CommandInset ref
1632 LatexCommand ref
1633 reference "sec:Converters"
1634
1635 \end_inset
1636
1637 ), the format will appear in the
1638 \begin_inset Flex MenuItem
1639 status collapsed
1640
1641 \begin_layout Plain Layout
1642 File\SpecialChar menuseparator
1643 Export
1644 \end_layout
1645
1646 \end_inset
1647
1648  menu.
1649  The format will also appear in the
1650 \begin_inset Flex MenuItem
1651 status collapsed
1652
1653 \begin_layout Plain Layout
1654 Document\SpecialChar menuseparator
1655 View
1656 \end_layout
1657
1658 \end_inset
1659
1660  menu if a viewer is specified for the format.
1661  Pure image formats, such as
1662 \begin_inset Flex Code
1663 status collapsed
1664
1665 \begin_layout Plain Layout
1666 png
1667 \end_layout
1668
1669 \end_inset
1670
1671 , should not use this option.
1672  Formats that can both represent vector graphics and documents like
1673 \begin_inset Flex Code
1674 status collapsed
1675
1676 \begin_layout Plain Layout
1677 pdf
1678 \end_layout
1679
1680 \end_inset
1681
1682  should use it.
1683 \end_layout
1684
1685 \begin_layout Standard
1686 The option
1687 \begin_inset Flex MenuItem
1688 status collapsed
1689
1690 \begin_layout Plain Layout
1691 Vector graphics format
1692 \end_layout
1693
1694 \end_inset
1695
1696  tells \SpecialChar LyX
1697  that a format can contain vector graphics.
1698  This information is used to determine the target format of included graphics
1699  for
1700 \begin_inset Flex MenuItem
1701 status collapsed
1702
1703 \begin_layout Plain Layout
1704 pdflatex
1705 \end_layout
1706
1707 \end_inset
1708
1709  export.
1710  Included graphics may need to be converted to either
1711 \begin_inset Flex MenuItem
1712 status collapsed
1713
1714 \begin_layout Plain Layout
1715 pdf
1716 \end_layout
1717
1718 \end_inset
1719
1720 ,
1721 \begin_inset Flex MenuItem
1722 status collapsed
1723
1724 \begin_layout Plain Layout
1725 png
1726 \end_layout
1727
1728 \end_inset
1729
1730 , or
1731 \begin_inset Flex MenuItem
1732 status collapsed
1733
1734 \begin_layout Plain Layout
1735 jpg
1736 \end_layout
1737
1738 \end_inset
1739
1740 , since
1741 \begin_inset Flex MenuItem
1742 status collapsed
1743
1744 \begin_layout Plain Layout
1745 pdflatex
1746 \end_layout
1747
1748 \end_inset
1749
1750  cannot handle other image formats.
1751  If an included graphic is not already in
1752 \begin_inset Flex MenuItem
1753 status collapsed
1754
1755 \begin_layout Plain Layout
1756 pdf
1757 \end_layout
1758
1759 \end_inset
1760
1761 ,
1762 \begin_inset Flex MenuItem
1763 status collapsed
1764
1765 \begin_layout Plain Layout
1766 png
1767 \end_layout
1768
1769 \end_inset
1770
1771 , or
1772 \begin_inset Flex MenuItem
1773 status collapsed
1774
1775 \begin_layout Plain Layout
1776 jpg
1777 \end_layout
1778
1779 \end_inset
1780
1781  format, it is converted to
1782 \begin_inset Flex MenuItem
1783 status collapsed
1784
1785 \begin_layout Plain Layout
1786 pdf
1787 \end_layout
1788
1789 \end_inset
1790
1791  if the vector format option is set, and otherwise to
1792 \begin_inset Flex MenuItem
1793 status collapsed
1794
1795 \begin_layout Plain Layout
1796 png
1797 \end_layout
1798
1799 \end_inset
1800
1801 .
1802 \end_layout
1803
1804 \begin_layout Section
1805 Copiers
1806 \end_layout
1807
1808 \begin_layout Standard
1809 Since all conversions from one format to another take place in \SpecialChar LyX
1810 's temporary
1811  directory, it is sometimes necessary to modify a file before copying it
1812  to the temporary directory in order that the conversion may be performed.
1813 \begin_inset Foot
1814 status collapsed
1815
1816 \begin_layout Plain Layout
1817 For example, the file may refer to other files—images, for example—using
1818  relative file names, and these may become invalid when the file is copied
1819  to the temporary directory.
1820 \end_layout
1821
1822 \end_inset
1823
1824  This is done by a Copier: It copies a file to (or from) the temporary directory
1825  and may modify it in the process.
1826 \end_layout
1827
1828 \begin_layout Standard
1829 The definitions of the copiers may use four variables:
1830 \end_layout
1831
1832 \begin_layout Labeling
1833 \labelwidthstring 00.00.0000
1834 \begin_inset Flex Code
1835 status collapsed
1836
1837 \begin_layout Plain Layout
1838 $$s
1839 \end_layout
1840
1841 \end_inset
1842
1843  The \SpecialChar LyX
1844  system directory (e.
1845 \begin_inset space \thinspace{}
1846 \end_inset
1847
1848 g.
1849 \begin_inset space \space{}
1850 \end_inset
1851
1852
1853 \begin_inset Flex MenuItem
1854 status collapsed
1855
1856 \begin_layout Plain Layout
1857 /usr/share/lyx
1858 \end_layout
1859
1860 \end_inset
1861
1862 ).
1863 \end_layout
1864
1865 \begin_layout Labeling
1866 \labelwidthstring 00.00.0000
1867 \begin_inset Flex Code
1868 status collapsed
1869
1870 \begin_layout Plain Layout
1871 $$i
1872 \end_layout
1873
1874 \end_inset
1875
1876  The input file
1877 \end_layout
1878
1879 \begin_layout Labeling
1880 \labelwidthstring 00.00.0000
1881 \begin_inset Flex Code
1882 status collapsed
1883
1884 \begin_layout Plain Layout
1885 $$o
1886 \end_layout
1887
1888 \end_inset
1889
1890  The output file
1891 \end_layout
1892
1893 \begin_layout Labeling
1894 \labelwidthstring 00.00.0000
1895 \begin_inset Flex Code
1896 status collapsed
1897
1898 \begin_layout Plain Layout
1899 $$b
1900 \end_layout
1901
1902 \end_inset
1903
1904  The base name (without filename extension) in the \SpecialChar LyX
1905  temporary directory
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 $$p
1915 \end_layout
1916
1917 \end_inset
1918
1919  The full directory path of 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 $$r
1930 \end_layout
1931
1932 \end_inset
1933
1934  The full pathname to the original \SpecialChar LyX
1935  file being processed
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 $$f
1945 \end_layout
1946
1947 \end_inset
1948
1949  The filename (without any directory path) of the \SpecialChar LyX
1950  file.
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 $$l
1960 \end_layout
1961
1962 \end_inset
1963
1964  The `\SpecialChar LaTeX
1965  name'
1966 \end_layout
1967
1968 \begin_layout Standard
1969 The latter should be the filename as it would be used in a \SpecialChar LaTeX
1970 's
1971 \series bold
1972
1973 \backslash
1974 include
1975 \series default
1976  command.
1977  It is relevant only when exporting files suitable for such inclusion.
1978 \end_layout
1979
1980 \begin_layout Standard
1981 Copiers can be used to do almost anything with output files.
1982  For example, suppose you want generated pdf files to be copied to a special
1983  directory,
1984 \begin_inset Flex Code
1985 status collapsed
1986
1987 \begin_layout Plain Layout
1988 /home/you/pdf/
1989 \end_layout
1990
1991 \end_inset
1992
1993 .
1994  Then you could write a shell script such as this one:
1995 \end_layout
1996
1997 \begin_layout Standard
1998 \begin_inset listings
1999 inline false
2000 status open
2001
2002 \begin_layout Plain Layout
2003
2004 #!/bin/bash
2005 \end_layout
2006
2007 \begin_layout Plain Layout
2008
2009 FROMFILE=$1
2010 \end_layout
2011
2012 \begin_layout Plain Layout
2013
2014 TOFILE=`basename $2`
2015 \end_layout
2016
2017 \begin_layout Plain Layout
2018
2019 cp $FROMFILE /home/you/pdf/$TOFILE
2020 \end_layout
2021
2022 \end_inset
2023
2024 Save it in your local \SpecialChar LyX
2025  directory—say,
2026 \begin_inset Flex Code
2027 status collapsed
2028
2029 \begin_layout Plain Layout
2030 /home/you/.lyx/scripts/pdfcopier.sh
2031 \end_layout
2032
2033 \end_inset
2034
2035 —and make it executable, if you need to do so on your platform.
2036  Then, in the
2037 \begin_inset Flex MenuItem
2038 status collapsed
2039
2040 \begin_layout Plain Layout
2041 Tools\SpecialChar menuseparator
2042 Preferences
2043 \end_layout
2044
2045 \end_inset
2046
2047  dialog, select under
2048 \begin_inset Flex MenuItem
2049 status collapsed
2050
2051 \begin_layout Plain Layout
2052 File Handling\SpecialChar menuseparator
2053 File formats
2054 \end_layout
2055
2056 \end_inset
2057
2058  the
2059 \begin_inset Flex MenuItem
2060 status collapsed
2061
2062 \begin_layout Plain Layout
2063 PDF(pdflatex)
2064 \end_layout
2065
2066 \end_inset
2067
2068  format—or one of the other pdf formats—and enter
2069 \begin_inset Flex Code
2070 status collapsed
2071
2072 \begin_layout Plain Layout
2073 pdfcopier.sh $$i $$o
2074 \end_layout
2075
2076 \end_inset
2077
2078  into the
2079 \begin_inset Flex MenuItem
2080 status collapsed
2081
2082 \begin_layout Plain Layout
2083 Copier
2084 \end_layout
2085
2086 \end_inset
2087
2088  field.
2089
2090 \end_layout
2091
2092 \begin_layout Standard
2093 Copiers are used by \SpecialChar LyX
2094  in various of its own conversions.
2095  For example, if appropriate programs are found, \SpecialChar LyX
2096  will automatically install
2097  copiers for the
2098 \begin_inset Flex MenuItem
2099 status collapsed
2100
2101 \begin_layout Plain Layout
2102 HTML
2103 \end_layout
2104
2105 \end_inset
2106
2107  and
2108 \begin_inset Flex MenuItem
2109 status collapsed
2110
2111 \begin_layout Plain Layout
2112 HTML
2113 \begin_inset space ~
2114 \end_inset
2115
2116 (MS Word)
2117 \end_layout
2118
2119 \end_inset
2120
2121  formats.
2122  When these formats are exported, the copier sees that not just the main
2123  HTML file but various associated files (style files, images, etc.) are also
2124  copied.
2125  All these files are written to a subdirectory of the directory in which
2126  the original \SpecialChar LyX
2127  file was found.
2128 \begin_inset Foot
2129 status collapsed
2130
2131 \begin_layout Plain Layout
2132 This copier can be customized.
2133  The optional
2134 \begin_inset Quotes eld
2135 \end_inset
2136
2137 -e
2138 \begin_inset Quotes erd
2139 \end_inset
2140
2141  argument takes a comma-separated list of extensions to be copied; if it
2142  is omitted, all files will be copied.
2143  The
2144 \begin_inset Quotes eld
2145 \end_inset
2146
2147 -t
2148 \begin_inset Quotes erd
2149 \end_inset
2150
2151  argument determines the extension added to the generated directory.
2152  By default, it is
2153 \begin_inset Quotes eld
2154 \end_inset
2155
2156
2157 \begin_inset Flex MenuItem
2158 status collapsed
2159
2160 \begin_layout Plain Layout
2161 LyXconv
2162 \end_layout
2163
2164 \end_inset
2165
2166
2167 \begin_inset Quotes erd
2168 \end_inset
2169
2170 , so HTML generated from
2171 \begin_inset Flex MenuItem
2172 status collapsed
2173
2174 \begin_layout Plain Layout
2175 /path/to/filename.lyx
2176 \end_layout
2177
2178 \end_inset
2179
2180  will end up in
2181 \begin_inset Flex MenuItem
2182 status collapsed
2183
2184 \begin_layout Plain Layout
2185 /path/to/filename.html.LyXconv
2186 \end_layout
2187
2188 \end_inset
2189
2190 .
2191
2192 \end_layout
2193
2194 \end_inset
2195
2196
2197 \end_layout
2198
2199 \begin_layout Section
2200 Converters
2201 \begin_inset CommandInset label
2202 LatexCommand label
2203 name "sec:Converters"
2204
2205 \end_inset
2206
2207
2208 \end_layout
2209
2210 \begin_layout Standard
2211 You can define your own Converters to convert files between different formats.
2212  This is done in the
2213 \begin_inset Flex MenuItem
2214 status collapsed
2215
2216 \begin_layout Plain Layout
2217 Tools\SpecialChar menuseparator
2218 Preferences\SpecialChar menuseparator
2219 File Handling\SpecialChar menuseparator
2220 Converters
2221 \end_layout
2222
2223 \end_inset
2224
2225  dialog.
2226 \end_layout
2227
2228 \begin_layout Standard
2229 To define a new converter, select the
2230 \begin_inset Flex MenuItem
2231 status collapsed
2232
2233 \begin_layout Plain Layout
2234 From
2235 \begin_inset space ~
2236 \end_inset
2237
2238 format
2239 \end_layout
2240
2241 \end_inset
2242
2243  and
2244 \begin_inset Flex MenuItem
2245 status collapsed
2246
2247 \begin_layout Plain Layout
2248 To
2249 \begin_inset space ~
2250 \end_inset
2251
2252 format
2253 \end_layout
2254
2255 \end_inset
2256
2257  from the drop-down lists, enter the command needed for the conversion,
2258  and then press the
2259 \begin_inset Flex MenuItem
2260 status collapsed
2261
2262 \begin_layout Plain Layout
2263 Add
2264 \end_layout
2265
2266 \end_inset
2267
2268  button.
2269  Several variables can be used in the definition of converters:
2270 \end_layout
2271
2272 \begin_layout Labeling
2273 \labelwidthstring 00.00.0000
2274 \begin_inset Flex Code
2275 status collapsed
2276
2277 \begin_layout Plain Layout
2278 $$s
2279 \end_layout
2280
2281 \end_inset
2282
2283  The \SpecialChar LyX
2284  system directory
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 $$i
2294 \end_layout
2295
2296 \end_inset
2297
2298  The input file
2299 \end_layout
2300
2301 \begin_layout Labeling
2302 \labelwidthstring 00.00.0000
2303 \begin_inset Flex Code
2304 status collapsed
2305
2306 \begin_layout Plain Layout
2307 $$o
2308 \end_layout
2309
2310 \end_inset
2311
2312  The output file
2313 \end_layout
2314
2315 \begin_layout Labeling
2316 \labelwidthstring 00.00.0000
2317 \begin_inset Flex Code
2318 status collapsed
2319
2320 \begin_layout Plain Layout
2321 $$b
2322 \end_layout
2323
2324 \end_inset
2325
2326  The base filename of the input file (i.
2327 \begin_inset space \thinspace{}
2328 \end_inset
2329
2330 g., without the extension)
2331 \end_layout
2332
2333 \begin_layout Labeling
2334 \labelwidthstring 00.00.0000
2335 \begin_inset Flex Code
2336 status collapsed
2337
2338 \begin_layout Plain Layout
2339 $$p
2340 \end_layout
2341
2342 \end_inset
2343
2344  The path to the input file
2345 \end_layout
2346
2347 \begin_layout Labeling
2348 \labelwidthstring 00.00.0000
2349 \begin_inset Flex Code
2350 status collapsed
2351
2352 \begin_layout Plain Layout
2353 $$r
2354 \end_layout
2355
2356 \end_inset
2357
2358  The path to the original input file (this is different from $$p when a
2359  chain of converters is called)
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 $$e
2369 \end_layout
2370
2371 \end_inset
2372
2373  The iconv name for the encoding of the document.
2374 \end_layout
2375
2376 \begin_layout Standard
2377 In the
2378 \begin_inset Flex MenuItem
2379 status collapsed
2380
2381 \begin_layout Plain Layout
2382 Extra
2383 \begin_inset space ~
2384 \end_inset
2385
2386 Flag
2387 \end_layout
2388
2389 \end_inset
2390
2391  field you can enter the following flags, separated by commas:
2392 \end_layout
2393
2394 \begin_layout Labeling
2395 \labelwidthstring 00.00.0000
2396 \begin_inset Flex Code
2397 status collapsed
2398
2399 \begin_layout Plain Layout
2400 latex
2401 \end_layout
2402
2403 \end_inset
2404
2405  This converter runs some form of \SpecialChar LaTeX
2406 .
2407  This will make \SpecialChar LyX
2408 's \SpecialChar LaTeX
2409  error logs available.
2410 \end_layout
2411
2412 \begin_layout Labeling
2413 \labelwidthstring 00.00.0000
2414 \begin_inset Flex Code
2415 status collapsed
2416
2417 \begin_layout Plain Layout
2418 needaux
2419 \end_layout
2420
2421 \end_inset
2422
2423  Needs the \SpecialChar LaTeX
2424
2425 \begin_inset Flex MenuItem
2426 status collapsed
2427
2428 \begin_layout Plain Layout
2429 .aux
2430 \end_layout
2431
2432 \end_inset
2433
2434  file for the conversion.
2435 \end_layout
2436
2437 \begin_layout Labeling
2438 \labelwidthstring 00.00.0000
2439 \begin_inset Flex Code
2440 status collapsed
2441
2442 \begin_layout Plain Layout
2443 nice
2444 \end_layout
2445
2446 \end_inset
2447
2448  Needs a
2449 \begin_inset Quotes eld
2450 \end_inset
2451
2452 nice
2453 \begin_inset Quotes erd
2454 \end_inset
2455
2456  file from the backend, which in practice means a \SpecialChar LaTeX
2457  file like the one we
2458  would export, without
2459 \begin_inset Flex Code
2460 status collapsed
2461
2462 \begin_layout Plain Layout
2463 input@path
2464 \end_layout
2465
2466 \end_inset
2467
2468 .
2469 \end_layout
2470
2471 \begin_layout Labeling
2472 \labelwidthstring 00.00.0000
2473 \begin_inset Flex Code
2474 status collapsed
2475
2476 \begin_layout Plain Layout
2477 xml
2478 \end_layout
2479
2480 \end_inset
2481
2482  Output is XML.
2483 \end_layout
2484
2485 \begin_layout Standard
2486 The following three flags are not really flags at all because they take
2487  an argument in the
2488 \begin_inset Flex MenuItem
2489 status collapsed
2490
2491 \begin_layout Plain Layout
2492 key
2493 \begin_inset space ~
2494 \end_inset
2495
2496 =
2497 \begin_inset space ~
2498 \end_inset
2499
2500 value
2501 \end_layout
2502
2503 \end_inset
2504
2505  format:
2506 \end_layout
2507
2508 \begin_layout Labeling
2509 \labelwidthstring 00.00.0000
2510 \begin_inset Flex Code
2511 status collapsed
2512
2513 \begin_layout Plain Layout
2514 parselog
2515 \end_layout
2516
2517 \end_inset
2518
2519  If set, the converter's standard error will be redirected to a file
2520 \begin_inset Flex Code
2521 status collapsed
2522
2523 \begin_layout Plain Layout
2524 infile.out
2525 \end_layout
2526
2527 \end_inset
2528
2529 , and the script given as argument will be run as:
2530 \begin_inset Flex Code
2531 status collapsed
2532
2533 \begin_layout Plain Layout
2534 script < infile.out > infile.log
2535 \end_layout
2536
2537 \end_inset
2538
2539 .
2540  The argument may contain
2541 \begin_inset Flex Code
2542 status collapsed
2543
2544 \begin_layout Plain Layout
2545 $$s
2546 \end_layout
2547
2548 \end_inset
2549
2550 .
2551 \end_layout
2552
2553 \begin_layout Labeling
2554 \labelwidthstring 00.00.0000
2555 \begin_inset Flex Code
2556 status collapsed
2557
2558 \begin_layout Plain Layout
2559 resultdir
2560 \end_layout
2561
2562 \end_inset
2563
2564  The name of the directory in which the converter will dump the generated
2565  files.
2566  \SpecialChar LyX
2567  will not create this directory, and it does not copy anything into it,
2568  though it will copy this directory to the destination.
2569  The argument may contain
2570 \begin_inset Flex Code
2571 status collapsed
2572
2573 \begin_layout Plain Layout
2574 $$b
2575 \end_layout
2576
2577 \end_inset
2578
2579 , which will be replaced by the base name of the input and output files,
2580  respectively, when the directory is copied.
2581 \begin_inset Newline newline
2582 \end_inset
2583
2584 Note that resultdir and usetempdir make no sense together.
2585  The latter will be ignored if the former is given.
2586 \end_layout
2587
2588 \begin_layout Labeling
2589 \labelwidthstring 00.00.0000
2590 \begin_inset Flex Code
2591 status collapsed
2592
2593 \begin_layout Plain Layout
2594 resultfile
2595 \end_layout
2596
2597 \end_inset
2598
2599  Determines the output file name and may, contain
2600 \begin_inset Flex Code
2601 status collapsed
2602
2603 \begin_layout Plain Layout
2604 $$b
2605 \end_layout
2606
2607 \end_inset
2608
2609 .
2610  Sensible only with resultdir and optional even then; if not given, it defaults
2611  to `index'.
2612 \end_layout
2613
2614 \begin_layout Standard
2615 None of these last three are presently used in any of the converters that
2616  are installed with \SpecialChar LyX
2617 .
2618
2619 \end_layout
2620
2621 \begin_layout Standard
2622 You do not have to define converters for all formats between which you want
2623  to convert.
2624  For example, you will note that there is no `\SpecialChar LyX
2625  to PostScript' converter,
2626  but \SpecialChar LyX
2627  will export PostScript.
2628  It does so by first creating a \SpecialChar LaTeX
2629  file (no converter needs to be defined
2630  for this) which is then converted to DVI using the `\SpecialChar LaTeX
2631  to DVI' converter,
2632  and finally converting the resulting DVI file to PostScript.
2633  \SpecialChar LyX
2634  finds such `chains' of converters automatically, and it will always choose
2635  the shortest possible chain.
2636  You can, though, still define multiple conversion methods between file
2637  formats.
2638  For example, the standard \SpecialChar LyX
2639  configuration provides five ways to convert
2640  \SpecialChar LaTeX
2641  to PDF:
2642 \end_layout
2643
2644 \begin_layout Enumerate
2645 Directly, using
2646 \begin_inset Flex MenuItem
2647 status collapsed
2648
2649 \begin_layout Plain Layout
2650 pdflatex
2651 \end_layout
2652
2653 \end_inset
2654
2655
2656 \end_layout
2657
2658 \begin_layout Enumerate
2659 via (DVI and) PostScript, using
2660 \begin_inset Flex MenuItem
2661 status collapsed
2662
2663 \begin_layout Plain Layout
2664 ps2pdf
2665 \end_layout
2666
2667 \end_inset
2668
2669
2670 \end_layout
2671
2672 \begin_layout Enumerate
2673 via DVI, using
2674 \begin_inset Flex MenuItem
2675 status collapsed
2676
2677 \begin_layout Plain Layout
2678 dvipdfm
2679 \end_layout
2680
2681 \end_inset
2682
2683
2684 \end_layout
2685
2686 \begin_layout Enumerate
2687 directly using
2688 \begin_inset Flex MenuItem
2689 status collapsed
2690
2691 \begin_layout Plain Layout
2692 Xe\SpecialChar TeX
2693
2694 \end_layout
2695
2696 \end_inset
2697
2698
2699 \end_layout
2700
2701 \begin_layout Enumerate
2702 directly using
2703 \begin_inset Flex MenuItem
2704 status collapsed
2705
2706 \begin_layout Plain Layout
2707 Lua\SpecialChar TeX
2708
2709 \end_layout
2710
2711 \end_inset
2712
2713
2714 \end_layout
2715
2716 \begin_layout Standard
2717 To define such alternate chains, you must define multiple target `file formats',
2718  as described in
2719 \begin_inset CommandInset ref
2720 LatexCommand ref
2721 reference "sec:Formats"
2722
2723 \end_inset
2724
2725 .
2726  For example, in the standard configuration, the formats named
2727 \begin_inset Flex MenuItem
2728 status collapsed
2729
2730 \begin_layout Plain Layout
2731 pdf
2732 \end_layout
2733
2734 \end_inset
2735
2736  (for
2737 \begin_inset Flex MenuItem
2738 status collapsed
2739
2740 \begin_layout Plain Layout
2741 ps2pdf
2742 \end_layout
2743
2744 \end_inset
2745
2746 ),
2747 \begin_inset Flex MenuItem
2748 status collapsed
2749
2750 \begin_layout Plain Layout
2751 pdf2
2752 \end_layout
2753
2754 \end_inset
2755
2756  (for
2757 \begin_inset Flex MenuItem
2758 status collapsed
2759
2760 \begin_layout Plain Layout
2761 pdflatex
2762 \end_layout
2763
2764 \end_inset
2765
2766 ),
2767 \begin_inset Flex MenuItem
2768 status collapsed
2769
2770 \begin_layout Plain Layout
2771 pdf3
2772 \end_layout
2773
2774 \end_inset
2775
2776  (for
2777 \begin_inset Flex MenuItem
2778 status collapsed
2779
2780 \begin_layout Plain Layout
2781 dvipdfm
2782 \end_layout
2783
2784 \end_inset
2785
2786 ),
2787 \begin_inset Flex MenuItem
2788 status collapsed
2789
2790 \begin_layout Plain Layout
2791 pdf4
2792 \end_layout
2793
2794 \end_inset
2795
2796  (for
2797 \begin_inset Flex MenuItem
2798 status collapsed
2799
2800 \begin_layout Plain Layout
2801 Xe\SpecialChar TeX
2802
2803 \end_layout
2804
2805 \end_inset
2806
2807 ), and
2808 \begin_inset Flex MenuItem
2809 status collapsed
2810
2811 \begin_layout Plain Layout
2812 pdf5
2813 \end_layout
2814
2815 \end_inset
2816
2817  (for
2818 \begin_inset Flex MenuItem
2819 status collapsed
2820
2821 \begin_layout Plain Layout
2822 Lua\SpecialChar TeX
2823
2824 \end_layout
2825
2826 \end_inset
2827
2828 ) are defined, all of which share the extension
2829 \begin_inset Flex MenuItem
2830 status collapsed
2831
2832 \begin_layout Plain Layout
2833 .pdf
2834 \end_layout
2835
2836 \end_inset
2837
2838 , and which correspond to the conversion methods just mentioned.
2839 \end_layout
2840
2841 \begin_layout Chapter
2842 Internationalizing \SpecialChar LyX
2843
2844 \begin_inset CommandInset label
2845 LatexCommand label
2846 name "cha:Internationalizing-LyX"
2847
2848 \end_inset
2849
2850
2851 \end_layout
2852
2853 \begin_layout Standard
2854 \SpecialChar LyX
2855  supports using a translated interface.
2856  Last time we checked, \SpecialChar LyX
2857  provided text in thirty languages.
2858  The language of choice is called your
2859 \emph on
2860 locale
2861 \emph default
2862 .
2863  (For further reading on locale settings, see also the documentation for
2864  locale that comes with your operating system.
2865  For Linux, the manual page for
2866 \begin_inset Flex Code
2867 status collapsed
2868
2869 \begin_layout Plain Layout
2870 locale(5)
2871 \end_layout
2872
2873 \end_inset
2874
2875  could be a good place to start).
2876 \end_layout
2877
2878 \begin_layout Standard
2879 Notice that these translations will work, but do contain a few flaws.
2880  In particular, all dialogs have been designed with the English text in
2881  mind, which means that some of the translated text will be too large to
2882  fit within the space allocated.
2883  This is only a display problem and will not cause any harm.
2884  Also, you will find that some of the translations do not define shortcut
2885  keys for everything.
2886  Sometimes, there are simply not enough free letters to do it.
2887  Other times, the translator just hasn't got around to doing it yet.
2888  Our localization team, which you may wish to join,
2889 \begin_inset Foot
2890 status collapsed
2891
2892 \begin_layout Plain Layout
2893 If you are a fluent speaker of a language other than English, joining these
2894  teams is a great way to give back to the \SpecialChar LyX
2895  community!
2896 \end_layout
2897
2898 \end_inset
2899
2900  will of course try to fix these shortcomings in future versions of \SpecialChar LyX
2901 .
2902 \end_layout
2903
2904 \begin_layout Section
2905 Translating \SpecialChar LyX
2906
2907 \end_layout
2908
2909 \begin_layout Subsection
2910 Translating the graphical user interface (text messages).
2911 \end_layout
2912
2913 \begin_layout Standard
2914 \SpecialChar LyX
2915  uses the GNU
2916 \begin_inset Flex Code
2917 status collapsed
2918
2919 \begin_layout Plain Layout
2920 gettext
2921 \end_layout
2922
2923 \end_inset
2924
2925  library to handle the internationalization of the interface.
2926  To have \SpecialChar LyX
2927  speak your favorite language in all menus and dialogs, you need
2928  a
2929 \begin_inset Flex Code
2930 status collapsed
2931
2932 \begin_layout Plain Layout
2933 po
2934 \end_layout
2935
2936 \end_inset
2937
2938 -file for that language.
2939  When this is available, you'll have to generate a
2940 \begin_inset Flex Code
2941 status collapsed
2942
2943 \begin_layout Plain Layout
2944 mo
2945 \end_layout
2946
2947 \end_inset
2948
2949 -file from it and install the
2950 \begin_inset Flex Code
2951 status collapsed
2952
2953 \begin_layout Plain Layout
2954 mo
2955 \end_layout
2956
2957 \end_inset
2958
2959 -file.
2960  The process of doing all of this is explained in the documentation for
2961  GNU
2962 \begin_inset Flex Code
2963 status collapsed
2964
2965 \begin_layout Plain Layout
2966 gettext
2967 \end_layout
2968
2969 \end_inset
2970
2971 .
2972  It is possible to do this just for yourself, but if you're going to do
2973  it, you might as well share the results of your labors with the rest of
2974  the \SpecialChar LyX
2975  community.
2976  Send a message to the \SpecialChar LyX
2977  developers' list for more information about how
2978  to proceed.
2979 \end_layout
2980
2981 \begin_layout Standard
2982 In short, this is what you should do (xx denotes the language code):
2983 \end_layout
2984
2985 \begin_layout Itemize
2986 Check out the \SpecialChar LyX
2987  source code.
2988  (See the
2989 \begin_inset CommandInset href
2990 LatexCommand href
2991 name "information on the web"
2992 target "http://www.lyx.org/HowToUseSVN"
2993
2994 \end_inset
2995
2996 .)
2997 \end_layout
2998
2999 \begin_layout Itemize
3000 Copy the file
3001 \begin_inset Flex Code
3002 status collapsed
3003
3004 \begin_layout Plain Layout
3005 lyx.pot
3006 \end_layout
3007
3008 \end_inset
3009
3010  to the folder of the
3011 \begin_inset Flex Code
3012 status collapsed
3013
3014 \begin_layout Plain Layout
3015 **.po
3016 \end_layout
3017
3018 \end_inset
3019
3020  files.
3021  Then rename it to
3022 \begin_inset Flex Code
3023 status collapsed
3024
3025 \begin_layout Plain Layout
3026 xx.po
3027 \end_layout
3028
3029 \end_inset
3030
3031 .
3032  (If
3033 \begin_inset Flex Code
3034 status collapsed
3035
3036 \begin_layout Plain Layout
3037 lyx.pot
3038 \end_layout
3039
3040 \end_inset
3041
3042  doesn't exist anywhere, it can be remade with the console command
3043 \begin_inset Flex Code
3044 status collapsed
3045
3046 \begin_layout Plain Layout
3047 make lyx.pot
3048 \end_layout
3049
3050 \end_inset
3051
3052  in that directory, or you can use an existing po-file for some other language
3053  as a template).
3054 \end_layout
3055
3056 \begin_layout Itemize
3057 Edit
3058 \begin_inset Flex Code
3059 status collapsed
3060
3061 \begin_layout Plain Layout
3062 xx.po
3063 \end_layout
3064
3065 \end_inset
3066
3067 .
3068 \begin_inset Foot
3069 status collapsed
3070
3071 \begin_layout Plain Layout
3072 This is just a text file, so it can be edited in any text editor.
3073  But there are also specialized programs that support such editing, such
3074  as
3075 \family typewriter
3076 Poedit
3077 \family default
3078  (for all platforms) or
3079 \family typewriter
3080 KBabel
3081 \family default
3082  (for KDE).
3083
3084 \family typewriter
3085 Emacs
3086 \family default
3087  contains a `mode' for editing
3088 \begin_inset Flex Code
3089 status collapsed
3090
3091 \begin_layout Plain Layout
3092 po
3093 \end_layout
3094
3095 \end_inset
3096
3097  files, as well.
3098 \end_layout
3099
3100 \end_inset
3101
3102  For some menu- and widget-labels, there are also shortcut keys that should
3103  be translated.
3104  Those keys are marked after a `|', and should be translated according to
3105  the words and phrases of the language.
3106  You should also fill also out the information at the beginning of the new
3107
3108 \begin_inset Flex Code
3109 status collapsed
3110
3111 \begin_layout Plain Layout
3112 po
3113 \end_layout
3114
3115 \end_inset
3116
3117 -file with your email-address, etc., so people know where to reach you with
3118  suggestions and entertaining flames.
3119 \end_layout
3120
3121 \begin_layout Standard
3122 If you are just doing this on your own, then:
3123 \end_layout
3124
3125 \begin_layout Itemize
3126 Generate
3127 \begin_inset Flex Code
3128 status collapsed
3129
3130 \begin_layout Plain Layout
3131 xx.mo
3132 \end_layout
3133
3134 \end_inset
3135
3136 .
3137  This can be done with
3138 \begin_inset Flex Code
3139 status collapsed
3140
3141 \begin_layout Plain Layout
3142 msgfmt -o xx.mo < xx.po
3143 \end_layout
3144
3145 \end_inset
3146
3147 .
3148 \end_layout
3149
3150 \begin_layout Itemize
3151 Copy the
3152 \begin_inset Flex Code
3153 status collapsed
3154
3155 \begin_layout Plain Layout
3156 mo
3157 \end_layout
3158
3159 \end_inset
3160
3161 -file to your locale-tree, at the correct directory for application messages
3162  for the language
3163 \series bold
3164
3165 \series default
3166 xx, and under the name
3167 \begin_inset Flex Code
3168 status collapsed
3169
3170 \begin_layout Plain Layout
3171 lyx.mo
3172 \end_layout
3173
3174 \end_inset
3175
3176  (e.
3177 \begin_inset space \thinspace{}
3178 \end_inset
3179
3180 g.
3181 \begin_inset space \space{}
3182 \end_inset
3183
3184
3185 \begin_inset Flex Code
3186 status collapsed
3187
3188 \begin_layout Plain Layout
3189 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3190 \end_layout
3191
3192 \end_inset
3193
3194
3195 \series bold
3196 .
3197 \end_layout
3198
3199 \begin_layout Standard
3200 As said, however, it would be best if the new
3201 \begin_inset Flex Code
3202 status collapsed
3203
3204 \begin_layout Plain Layout
3205 po
3206 \end_layout
3207
3208 \end_inset
3209
3210  file could be added to the \SpecialChar LyX
3211  distribution, so others can use it.
3212  Adding it involves making additional changes to \SpecialChar LyX
3213 .
3214  So send an email to the developers' mailing list if you're interested in
3215  doing that.
3216 \end_layout
3217
3218 \begin_layout Subsubsection
3219 Ambiguous messages
3220 \end_layout
3221
3222 \begin_layout Standard
3223 Sometimes it turns out that one English message needs to be translated into
3224  different messages in the target language.
3225  One example is the message
3226 \begin_inset Flex Code
3227 status collapsed
3228
3229 \begin_layout Plain Layout
3230 To
3231 \end_layout
3232
3233 \end_inset
3234
3235  which has the German translation
3236 \lang german
3237 Nach
3238 \lang english
3239  or
3240 \lang german
3241 Bis
3242 \lang english
3243 , depending upon exactly what the English
3244 \begin_inset Quotes eld
3245 \end_inset
3246
3247 to
3248 \begin_inset Quotes erd
3249 \end_inset
3250
3251  means.
3252  GNU
3253 \begin_inset Flex Code
3254 status collapsed
3255
3256 \begin_layout Plain Layout
3257 gettext
3258 \end_layout
3259
3260 \end_inset
3261
3262  does not handle such ambiguous translations.
3263  Therefore you have to add some context information to the message: Instead
3264  of
3265 \begin_inset Flex Code
3266 status collapsed
3267
3268 \begin_layout Plain Layout
3269 To
3270 \end_layout
3271
3272 \end_inset
3273
3274  it becomes
3275 \begin_inset Flex Code
3276 status collapsed
3277
3278 \begin_layout Plain Layout
3279 To[[as in 'From format x to format y']]
3280 \end_layout
3281
3282 \end_inset
3283
3284  and
3285 \begin_inset Flex Code
3286 status collapsed
3287
3288 \begin_layout Plain Layout
3289 To[[as in 'From page x to page y']].
3290 \end_layout
3291
3292 \end_inset
3293
3294  Now the two occurrences of
3295 \begin_inset Flex Code
3296 status collapsed
3297
3298 \begin_layout Plain Layout
3299 To
3300 \end_layout
3301
3302 \end_inset
3303
3304  are different for
3305 \begin_inset Flex Code
3306 status collapsed
3307
3308 \begin_layout Plain Layout
3309 gettext
3310 \end_layout
3311
3312 \end_inset
3313
3314  and can be translated correctly to
3315 \lang german
3316 Nach
3317 \lang english
3318  and
3319 \lang german
3320 Bis
3321 \lang english
3322 , respectively.
3323 \end_layout
3324
3325 \begin_layout Standard
3326 Of course the context information needs to be stripped off the original
3327  message when no translation is used.
3328  Therefore you have to put it in double square brackets at the end of the
3329  message (see the example above).
3330  The translation mechanism of \SpecialChar LyX
3331  ensures that everything in double square
3332  brackets at the end of messages is removed before displaying the message.
3333 \end_layout
3334
3335 \begin_layout Subsection
3336 Translating the documentation.
3337 \end_layout
3338
3339 \begin_layout Standard
3340 The online documentation (in the
3341 \begin_inset Flex MenuItem
3342 status collapsed
3343
3344 \begin_layout Plain Layout
3345 Help
3346 \end_layout
3347
3348 \end_inset
3349
3350 -menu) can (and should!) be translated.
3351  If there are translated versions of the documentation available
3352 \begin_inset Foot
3353 status collapsed
3354
3355 \begin_layout Plain Layout
3356 As of March 2008, at least some of the documents have been translated into
3357  fourteen languages, with the Tutorial available in a few more.
3358 \end_layout
3359
3360 \end_inset
3361
3362  and the locale is set accordingly, these will be used automagically by
3363  \SpecialChar LyX
3364 .
3365  \SpecialChar LyX
3366  looks for translated versions as
3367 \begin_inset Flex Code
3368 status collapsed
3369
3370 \begin_layout Plain Layout
3371 LyXDir/doc/xx/DocName.lyx
3372 \end_layout
3373
3374 \end_inset
3375
3376 , where
3377 \begin_inset Flex Code
3378 status collapsed
3379
3380 \begin_layout Plain Layout
3381 xx
3382 \end_layout
3383
3384 \end_inset
3385
3386  is the code for the language currently in use.
3387  If there are no translated documents, the default English versions will
3388  be displayed.
3389  Note that the translated versions must have the same filenames (
3390 \begin_inset Flex Code
3391 status collapsed
3392
3393 \begin_layout Plain Layout
3394 DocName
3395 \end_layout
3396
3397 \end_inset
3398
3399  above) as the original.
3400  If you feel up to translating the documentation (an excellent way to proof-read
3401  the original documentation by the way!), there are a few things you should
3402  do right away:
3403 \end_layout
3404
3405 \begin_layout Itemize
3406 Check out the documentation translation web page at
3407 \begin_inset CommandInset href
3408 LatexCommand href
3409 name "http://www.lyx.org/Translation"
3410 target "http://www.lyx.org/Translation"
3411
3412 \end_inset
3413
3414 .
3415  That way, you can find out which (if any) documents have already been translate
3416 d into your language.
3417  You can also find out who (if anyone) is organizing the effort to translate
3418  the documentation into your language.
3419  If no one is organizing the effort, please let us know that you're interested.
3420 \end_layout
3421
3422 \begin_layout Standard
3423 Once you get to actually translating, here's a few hints for you that may
3424  save you trouble:
3425 \end_layout
3426
3427 \begin_layout Itemize
3428 Join the documentation team! There is information on how to do that in
3429 \begin_inset Flex Code
3430 status collapsed
3431
3432 \begin_layout Plain Layout
3433 Intro.lyx
3434 \end_layout
3435
3436 \end_inset
3437
3438  (
3439 \begin_inset Flex MenuItem
3440 status collapsed
3441
3442 \begin_layout Plain Layout
3443 Help\SpecialChar menuseparator
3444 Introduction
3445 \end_layout
3446
3447 \end_inset
3448
3449 ), which by the way is the first document you should translate.
3450 \end_layout
3451
3452 \begin_layout Itemize
3453 Learn the typographic conventions for the language you are translating to.
3454  Typography is an ancient art and over the centuries, a great variety of
3455  conventions have developed throughout different parts of the world.
3456  Also study the professional terminology amongst typographers in your country.
3457  Inventing your own terminology will only confuse the users.
3458
3459 \emph on
3460 (Warning! Typography is addictive!)
3461 \end_layout
3462
3463 \begin_layout Itemize
3464 Make a copy of the document.
3465  This will be your working copy.
3466  You can use this as your personal translated help-file by placing it in
3467  your
3468 \begin_inset Flex Code
3469 status collapsed
3470
3471 \begin_layout Plain Layout
3472 UserDir/doc/xx/
3473 \end_layout
3474
3475 \end_inset
3476
3477  directory.
3478 \end_layout
3479
3480 \begin_layout Itemize
3481 Sometimes the original document (from the \SpecialChar LyX
3482  team) will be updated.
3483  Use the source viewer at
3484 \begin_inset CommandInset href
3485 LatexCommand href
3486 name "http://www.lyx.org/trac/timeline"
3487 target "http://www.lyx.org/trac/timeline"
3488
3489 \end_inset
3490
3491  to see what has been changed.
3492  That way you can easily see which parts of the translated document need
3493  to be updated.
3494 \end_layout
3495
3496 \begin_layout Standard
3497 If you ever find an error in the original document, fix it and notify the
3498  rest of the documentation team of the changes! (You didn't forget to join
3499  the documentation team, did you?)
3500 \end_layout
3501
3502 \begin_layout Standard
3503 \begin_inset Branch OutDated
3504 status collapsed
3505
3506 \begin_layout Section
3507 International Keyboard Support
3508 \end_layout
3509
3510 \begin_layout Standard
3511
3512 \emph on
3513 [Editor's Note: The following section is by
3514 \emph default
3515
3516 \shape smallcaps
3517 \emph on
3518 Ivan Schreter
3519 \shape default
3520 .
3521  It needs to be fixed to conform to the new Documentation Style sheet and
3522  to make use of the new v1.0 features.
3523  The whole thing also needs to be merged with the section following it.-jw
3524  It may also be badly out of date.-rh (2008)]
3525 \end_layout
3526
3527 \begin_layout Subsection
3528 Defining Own Keymaps: Keymap File Format
3529 \end_layout
3530
3531 \begin_layout Standard
3532 Let's look at a keyboard definition file a little closer.
3533  It is a plain text file defining
3534 \end_layout
3535
3536 \begin_layout Itemize
3537 key-to-key or key-to-string translations
3538 \end_layout
3539
3540 \begin_layout Itemize
3541 dead keys
3542 \end_layout
3543
3544 \begin_layout Itemize
3545 dead keys exceptions
3546 \end_layout
3547
3548 \begin_layout Standard
3549 To define key-to-key or key-to-string translation, use this command:
3550 \end_layout
3551
3552 \begin_layout Quotation
3553 \begin_inset Flex Code
3554 status collapsed
3555
3556 \begin_layout Plain Layout
3557
3558 \backslash
3559 kmap
3560 \end_layout
3561
3562 \end_inset
3563
3564
3565 \begin_inset Flex Code
3566 status collapsed
3567
3568 \begin_layout Plain Layout
3569 key
3570 \end_layout
3571
3572 \end_inset
3573
3574  outstring
3575 \end_layout
3576
3577 \begin_layout Standard
3578 where
3579 \begin_inset Flex Code
3580 status collapsed
3581
3582 \begin_layout Plain Layout
3583 key
3584 \end_layout
3585
3586 \end_inset
3587
3588  is the key to be translated and
3589 \begin_inset Flex Code
3590 status collapsed
3591
3592 \begin_layout Plain Layout
3593 outstring
3594 \end_layout
3595
3596 \end_inset
3597
3598  is the string to be inserted into the document.
3599  To define dead keys, use:
3600 \end_layout
3601
3602 \begin_layout Quotation
3603 \begin_inset Flex Code
3604 status collapsed
3605
3606 \begin_layout Plain Layout
3607
3608 \backslash
3609 kmod
3610 \end_layout
3611
3612 \end_inset
3613
3614
3615 \begin_inset Flex Code
3616 status collapsed
3617
3618 \begin_layout Plain Layout
3619 key
3620 \end_layout
3621
3622 \end_inset
3623
3624  deadkey
3625 \end_layout
3626
3627 \begin_layout Standard
3628 where
3629 \begin_inset Flex Code
3630 status collapsed
3631
3632 \begin_layout Plain Layout
3633 key
3634 \end_layout
3635
3636 \end_inset
3637
3638  is a keyboard key and
3639 \begin_inset Flex Code
3640 status collapsed
3641
3642 \begin_layout Plain Layout
3643 deadkey
3644 \end_layout
3645
3646 \end_inset
3647
3648  is dead key name.
3649  The following dead keys are supported (shortcut name is in parentheses):
3650 \end_layout
3651
3652 \begin_layout Quotation
3653
3654 \emph on
3655 Name
3656 \begin_inset space \hfill{}
3657 \end_inset
3658
3659 Example
3660 \end_layout
3661
3662 \begin_layout Quotation
3663 acute (acu)
3664 \begin_inset space \hfill{}
3665 \end_inset
3666
3667 áéíóú
3668 \end_layout
3669
3670 \begin_layout Quotation
3671 grave (gra)
3672 \begin_inset space \hfill{}
3673 \end_inset
3674
3675 àèìòù
3676 \end_layout
3677
3678 \begin_layout Quotation
3679 macron (mac)
3680 \begin_inset space \hfill{}
3681 \end_inset
3682
3683  ō
3684 \end_layout
3685
3686 \begin_layout Quotation
3687 tilde (til)
3688 \begin_inset space \hfill{}
3689 \end_inset
3690
3691 ñÑ
3692 \end_layout
3693
3694 \begin_layout Quotation
3695 underbar (underb)
3696 \begin_inset space \hfill{}
3697 \end_inset
3698
3699
3700 \begin_inset ERT
3701 status open
3702
3703 \begin_layout Plain Layout
3704
3705
3706 \backslash
3707 b o
3708 \end_layout
3709
3710 \end_inset
3711
3712
3713 \end_layout
3714
3715 \begin_layout Quotation
3716 cedilla (ced)
3717 \begin_inset space \hfill{}
3718 \end_inset
3719
3720 çÇ
3721 \end_layout
3722
3723 \begin_layout Quotation
3724 underdot (underd)
3725 \begin_inset space \hfill{}
3726 \end_inset
3727
3728
3729 \begin_inset ERT
3730 status open
3731
3732 \begin_layout Plain Layout
3733
3734
3735 \backslash
3736 d o
3737 \end_layout
3738
3739 \end_inset
3740
3741
3742 \end_layout
3743
3744 \begin_layout Quotation
3745 circumflex (circu)
3746 \begin_inset space \hfill{}
3747 \end_inset
3748
3749 âêîôû
3750 \end_layout
3751
3752 \begin_layout Quotation
3753 circle (circl)
3754 \begin_inset space \hfill{}
3755 \end_inset
3756
3757 ÅůŮ
3758 \end_layout
3759
3760 \begin_layout Quotation
3761 tie (tie)
3762 \begin_inset space \hfill{}
3763 \end_inset
3764
3765
3766 \begin_inset ERT
3767 status open
3768
3769 \begin_layout Plain Layout
3770
3771
3772 \backslash
3773 t o
3774 \end_layout
3775
3776 \end_inset
3777
3778
3779 \end_layout
3780
3781 \begin_layout Quotation
3782 breve (bre)
3783 \begin_inset space \hfill{}
3784 \end_inset
3785
3786 ă
3787 \begin_inset ERT
3788 status open
3789
3790 \begin_layout Plain Layout
3791
3792
3793 \backslash
3794 u o
3795 \end_layout
3796
3797 \end_inset
3798
3799
3800 \end_layout
3801
3802 \begin_layout Quotation
3803 caron (car)
3804 \begin_inset space \hfill{}
3805 \end_inset
3806
3807 čšž
3808 \end_layout
3809
3810 \begin_layout Quotation
3811 hungarian umlaut (hug)
3812 \begin_inset space \hfill{}
3813 \end_inset
3814
3815 őű
3816 \end_layout
3817
3818 \begin_layout Quotation
3819 umlaut (uml)
3820 \begin_inset space \hfill{}
3821 \end_inset
3822
3823 äöü
3824 \end_layout
3825
3826 \begin_layout Quotation
3827 dot (dot)
3828 \begin_inset space \hfill{}
3829 \end_inset
3830
3831 ż
3832 \begin_inset ERT
3833 status open
3834
3835 \begin_layout Plain Layout
3836
3837
3838 \backslash
3839 .s
3840 \end_layout
3841
3842 \end_inset
3843
3844
3845 \end_layout
3846
3847 \begin_layout Standard
3848 Since in many international keyboards there are exceptions to what some
3849  dead keys should do, you can define them using
3850 \end_layout
3851
3852 \begin_layout Quotation
3853 \begin_inset Flex Code
3854 status collapsed
3855
3856 \begin_layout Plain Layout
3857
3858 \backslash
3859 kxmod
3860 \end_layout
3861
3862 \end_inset
3863
3864  deadkey key outstring
3865 \end_layout
3866
3867 \begin_layout Standard
3868 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
3869 , so you put in
3870 \end_layout
3871
3872 \begin_layout Quotation
3873 \begin_inset Flex Code
3874 status collapsed
3875
3876 \begin_layout Plain Layout
3877
3878 \backslash
3879 kxmod
3880 \end_layout
3881
3882 \end_inset
3883
3884  caron o "
3885 \backslash
3886 ^o"
3887 \end_layout
3888
3889 \begin_layout Standard
3890 to make it work correctly.
3891  Also, you have to define as exceptions dead keys over i and j, to remove
3892  the dot from them before inserting an accent mark.
3893  I will change this when the time comes, but so far I haven't had time.
3894 \end_layout
3895
3896 \begin_layout Standard
3897 Oh, and about characters: backslash is escaped, so to enter it, you'll need
3898  double backslash.
3899  Also, quotes and
3900 \begin_inset Flex Code
3901 status collapsed
3902
3903 \begin_layout Plain Layout
3904 #
3905 \end_layout
3906
3907 \end_inset
3908
3909  have different meaning.
3910
3911 \begin_inset Flex Code
3912 status collapsed
3913
3914 \begin_layout Plain Layout
3915 #
3916 \end_layout
3917
3918 \end_inset
3919
3920  marks comments, quotes start and end \SpecialChar LaTeX
3921 -style commands.
3922  To enter quote, you'll need to use
3923 \begin_inset Flex Code
3924 status collapsed
3925
3926 \begin_layout Plain Layout
3927
3928 \backslash
3929 "
3930 \end_layout
3931
3932 \end_inset
3933
3934 , to enter
3935 \begin_inset Flex Code
3936 status collapsed
3937
3938 \begin_layout Plain Layout
3939 #
3940 \end_layout
3941
3942 \end_inset
3943
3944 , use
3945 \begin_inset Flex Code
3946 status collapsed
3947
3948 \begin_layout Plain Layout
3949
3950 \backslash
3951 #
3952 \end_layout
3953
3954 \end_inset
3955
3956 .
3957 \end_layout
3958
3959 \begin_layout Standard
3960 If you make a keyboard description file that works for your language, please
3961  mail it to me, so I can include it in the next keymap distribution.
3962 \end_layout
3963
3964 \begin_layout Standard
3965 More keywords will be supported in keymap configuration file in future,
3966  like
3967 \end_layout
3968
3969 \begin_layout Itemize
3970 \begin_inset Flex Code
3971 status collapsed
3972
3973 \begin_layout Plain Layout
3974
3975 \backslash
3976 kinclude filename
3977 \end_layout
3978
3979 \end_inset
3980
3981
3982 \emph on
3983
3984 \begin_inset space \hfill{}
3985 \end_inset
3986
3987
3988 \begin_inset Flex Code
3989 status collapsed
3990
3991 \begin_layout Plain Layout
3992 include
3993 \end_layout
3994
3995 \end_inset
3996
3997  another file
3998 \end_layout
3999
4000 \begin_layout Itemize
4001 \begin_inset Flex Code
4002 status collapsed
4003
4004 \begin_layout Plain Layout
4005
4006 \backslash
4007 kprog program
4008 \end_layout
4009
4010 \end_inset
4011
4012
4013 \emph on
4014
4015 \begin_inset space \hfill{}
4016 \end_inset
4017
4018
4019 \begin_inset Flex Code
4020 status collapsed
4021
4022 \begin_layout Plain Layout
4023 define
4024 \end_layout
4025
4026 \end_inset
4027
4028  an external keymap translation program
4029 \end_layout
4030
4031 \begin_layout Standard
4032 Also, it should look into
4033 \begin_inset Flex Code
4034 status collapsed
4035
4036 \begin_layout Plain Layout
4037 lyxrc
4038 \end_layout
4039
4040 \end_inset
4041
4042  file for defaults, too (for example, a
4043 \begin_inset Flex Code
4044 status collapsed
4045
4046 \begin_layout Plain Layout
4047
4048 \backslash
4049 kinclude
4050 \end_layout
4051
4052 \end_inset
4053
4054  option to include default keyboard).
4055 \end_layout
4056
4057 \end_inset
4058
4059
4060 \end_layout
4061
4062 \begin_layout Section
4063 International Keymap Stuff
4064 \begin_inset CommandInset label
4065 LatexCommand label
4066 name "sec:International-Keymap-Stuff"
4067
4068 \end_inset
4069
4070
4071 \end_layout
4072
4073 \begin_layout Standard
4074 \begin_inset Note Note
4075 status open
4076
4077 \begin_layout Plain Layout
4078 In doing the revisions on this document in March 2008, I did not look over
4079  this stuff, as I do not understand it.
4080  It would be good if someone else could do so.
4081  (RH)
4082 \end_layout
4083
4084 \end_inset
4085
4086
4087 \end_layout
4088
4089 \begin_layout Standard
4090 The next two sections describe the
4091 \begin_inset Flex Code
4092 status collapsed
4093
4094 \begin_layout Plain Layout
4095
4096 \shape up
4097 .kmap
4098 \end_layout
4099
4100 \end_inset
4101
4102  and
4103 \begin_inset Flex Code
4104 status collapsed
4105
4106 \begin_layout Plain Layout
4107
4108 \shape up
4109 .cdef
4110 \end_layout
4111
4112 \end_inset
4113
4114  file syntax in detail.
4115  These sections should help you design your own key map if the ones provided
4116  do not meet your needs.
4117 \end_layout
4118
4119 \begin_layout Subsection
4120 The .kmap File
4121 \end_layout
4122
4123 \begin_layout Standard
4124 A
4125 \shape up
4126 .
4127 \begin_inset Flex Code
4128 status collapsed
4129
4130 \begin_layout Plain Layout
4131 kmap
4132 \end_layout
4133
4134 \end_inset
4135
4136  file maps keystrokes to characters or strings.
4137  As the name suggests, it sets a keyboard mapping.
4138  The
4139 \begin_inset Flex Code
4140 status collapsed
4141
4142 \begin_layout Plain Layout
4143 .kmap
4144 \end_layout
4145
4146 \end_inset
4147
4148
4149 \shape default
4150  file keywords
4151 \shape up
4152
4153 \begin_inset Flex Code
4154 status collapsed
4155
4156 \begin_layout Plain Layout
4157
4158 \shape up
4159 kmap
4160 \end_layout
4161
4162 \end_inset
4163
4164
4165 \shape default
4166 ,
4167 \shape up
4168
4169 \shape default
4170
4171 \begin_inset Flex Code
4172 status collapsed
4173
4174 \begin_layout Plain Layout
4175
4176 \shape up
4177 kmod
4178 \end_layout
4179
4180 \end_inset
4181
4182 ,
4183 \shape up
4184
4185 \shape default
4186
4187 \begin_inset Flex Code
4188 status collapsed
4189
4190 \begin_layout Plain Layout
4191
4192 \shape up
4193 kxmod
4194 \end_layout
4195
4196 \end_inset
4197
4198 , and
4199 \begin_inset Flex Code
4200 status collapsed
4201
4202 \begin_layout Plain Layout
4203
4204 \shape up
4205 kcomb
4206 \end_layout
4207
4208 \end_inset
4209
4210  are described in this section.
4211 \end_layout
4212
4213 \begin_layout Labeling
4214 \labelwidthstring 00.00.0000
4215 \begin_inset Flex Code
4216 status collapsed
4217
4218 \begin_layout Plain Layout
4219
4220 \shape up
4221 kmap
4222 \end_layout
4223
4224 \end_inset
4225
4226  Map a character to a string
4227 \end_layout
4228
4229 \begin_layout LyX-Code
4230
4231 \backslash
4232 kmap
4233 \family roman
4234 \emph on
4235 char
4236 \family default
4237 \emph default
4238
4239 \family roman
4240 \emph on
4241 string
4242 \end_layout
4243
4244 \begin_layout Standard
4245 This will ma
4246 \family roman
4247 p
4248 \family default
4249
4250 \family roman
4251 \emph on
4252 char
4253 \family default
4254 \emph default
4255
4256 \family roman
4257 to
4258 \family default
4259
4260 \family roman
4261 \emph on
4262 string
4263 \emph default
4264 .
4265  Note that in
4266 \family default
4267
4268 \family roman
4269 \emph on
4270 string
4271 \emph default
4272 ,
4273 \family default
4274
4275 \family roman
4276 \shape up
4277 the double-quote (")
4278 \family default
4279 \shape default
4280
4281 \family roman
4282 and
4283 \family default
4284
4285 \family roman
4286 \shape up
4287 the backslash (
4288 \backslash
4289 )
4290 \family default
4291 \shape default
4292
4293 \family roman
4294 must be escaped with a preceding backslash (
4295 \shape up
4296
4297 \backslash
4298
4299 \shape default
4300 )
4301 \family default
4302 .
4303 \end_layout
4304
4305 \begin_layout Standard
4306 An example of a
4307 \begin_inset Flex MenuItem
4308 status collapsed
4309
4310 \begin_layout Plain Layout
4311
4312 \shape up
4313 kmap
4314 \end_layout
4315
4316 \end_inset
4317
4318  statement to cause the symbol
4319 \begin_inset Flex MenuItem
4320 status collapsed
4321
4322 \begin_layout Plain Layout
4323
4324 \shape up
4325 /
4326 \end_layout
4327
4328 \end_inset
4329
4330  to be output for the keystroke
4331 \begin_inset Flex MenuItem
4332 status collapsed
4333
4334 \begin_layout Plain Layout
4335
4336 \shape up
4337 &
4338 \end_layout
4339
4340 \end_inset
4341
4342  is:
4343 \end_layout
4344
4345 \begin_layout LyX-Code
4346
4347 \backslash
4348 kmap & /
4349 \end_layout
4350
4351 \begin_layout Labeling
4352 \labelwidthstring 00.00.0000
4353 \begin_inset Flex Code
4354 status collapsed
4355
4356 \begin_layout Plain Layout
4357
4358 \shape up
4359 kmod
4360 \end_layout
4361
4362 \end_inset
4363
4364  Specify an accent character
4365 \end_layout
4366
4367 \begin_layout LyX-Code
4368
4369 \backslash
4370 kmod
4371 \family roman
4372 \emph on
4373 char accent allowed
4374 \end_layout
4375
4376 \begin_layout Standard
4377 This will make the cha
4378 \family roman
4379 racter
4380 \family default
4381
4382 \family roman
4383 \emph on
4384 char
4385 \family default
4386 \emph default
4387
4388 \family roman
4389 \shape up
4390 \emph on
4391 be an accent
4392 \family default
4393 \shape default
4394 \emph default
4395
4396 \family roman
4397 \shape up
4398 on the
4399 \family default
4400 \shape default
4401
4402 \family roman
4403 \shape up
4404 \emph on
4405 allowed
4406 \family default
4407 \shape default
4408 \emph default
4409
4410 \family roman
4411 \shape up
4412 cha
4413 \family default
4414 racter(s).
4415  This is the dead key
4416 \begin_inset Foot
4417 status collapsed
4418
4419 \begin_layout Plain Layout
4420 The term
4421 \family roman
4422 \emph on
4423 dead key
4424 \family default
4425 \emph default
4426  refers to a key that does not produce a character by itself, but when followed
4427  with another key, produces the desired accent character.
4428  For example, a German characte
4429 \family roman
4430 r with an umlaut like
4431 \family default
4432
4433 \family roman
4434 \emph on
4435 ä
4436 \family default
4437 \emph default
4438
4439 \family roman
4440 can be produced in this manner.
4441 \end_layout
4442
4443 \end_inset
4444
4445  mechanism.
4446
4447 \end_layout
4448
4449 \begin_layout Standard
4450 If you
4451 \family roman
4452 hit
4453 \family default
4454
4455 \family roman
4456 \emph on
4457 char
4458 \family default
4459 \emph default
4460
4461 \family roman
4462 and then another key not in
4463 \family default
4464
4465 \family roman
4466 \emph on
4467 allowed
4468 \emph default
4469 , you will get a
4470 \family default
4471
4472 \family roman
4473 \emph on
4474 char
4475 \family default
4476 \emph default
4477
4478 \family roman
4479 followed by the other, not allowed key, as output.
4480
4481 \family default
4482  Note that a
4483 \begin_inset Flex MenuItem
4484 status collapsed
4485
4486 \begin_layout Plain Layout
4487
4488 \shape up
4489 Backspace
4490 \end_layout
4491
4492 \end_inset
4493
4494  cancels a dead key, so if
4495 \family roman
4496 you hit
4497 \family default
4498
4499 \family roman
4500 \emph on
4501 char
4502 \family default
4503 \emph default
4504
4505 \begin_inset Flex MenuItem
4506 status collapsed
4507
4508 \begin_layout Plain Layout
4509
4510 \shape up
4511 \emph on
4512 Backspace
4513 \end_layout
4514
4515 \end_inset
4516
4517 , the cursor will not go one position backwards but will instead cancel
4518  the effect t
4519 \family roman
4520 hat
4521 \family default
4522
4523 \family roman
4524 \shape up
4525 \emph on
4526 char
4527 \family default
4528 \shape default
4529 \emph default
4530
4531 \family roman
4532 \shape up
4533 might have had on the next keystroke.
4534
4535 \end_layout
4536
4537 \begin_layout Standard
4538 The following example specifies that the character ' is to be an acute accent,
4539  allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4540 \end_layout
4541
4542 \begin_layout LyX-Code
4543
4544 \backslash
4545 kmod ' acute aeiouAEIOU
4546 \end_layout
4547
4548 \begin_layout Labeling
4549 \labelwidthstring 00.00.0000
4550 \begin_inset Flex Code
4551 status collapsed
4552
4553 \begin_layout Plain Layout
4554 kxmod
4555 \end_layout
4556
4557 \end_inset
4558
4559  Specify an exception to the accent character
4560 \end_layout
4561
4562 \begin_layout LyX-Code
4563
4564 \backslash
4565 kxmod
4566 \family roman
4567 \emph on
4568 accent char result
4569 \end_layout
4570
4571 \begin_layout Standard
4572 This defines an exce
4573 \family roman
4574 ption for
4575 \family default
4576
4577 \family roman
4578 \emph on
4579 accent
4580 \family default
4581 \emph default
4582
4583 \family roman
4584 on
4585 \family default
4586
4587 \family roman
4588 \emph on
4589 char
4590 \emph default
4591 .
4592  T
4593 \shape up
4594 he
4595 \family default
4596 \shape default
4597
4598 \family roman
4599 \shape up
4600 \emph on
4601 accent
4602 \family default
4603 \shape default
4604 \emph default
4605
4606 \family roman
4607 \shape up
4608 must
4609 \family default
4610 \shape default
4611
4612 \shape up
4613 have been assigned a keystroke with a previous
4614 \shape default
4615
4616 \begin_inset Flex Code
4617 status collapsed
4618
4619 \begin_layout Plain Layout
4620
4621 \shape up
4622
4623 \backslash
4624 kmo
4625 \shape default
4626 d
4627 \end_layout
4628
4629 \end_inset
4630
4631  declar
4632 \family roman
4633 ation and
4634 \family default
4635
4636 \family roman
4637 \emph on
4638 char
4639 \family default
4640 \emph default
4641
4642 \family roman
4643 must not belong in the
4644 \family default
4645
4646 \family roman
4647 \emph on
4648 allowed
4649 \family default
4650 \emph default
4651
4652 \family roman
4653 set of
4654 \family default
4655
4656 \family roman
4657 \emph on
4658 accent
4659 \emph default
4660 .
4661  When
4662 \family default
4663
4664 \family roman
4665 \shape up
4666 you enter the
4667 \family default
4668 \shape default
4669
4670 \family roman
4671 \shape up
4672 \emph on
4673 accent char
4674 \family default
4675 \shape default
4676 \emph default
4677
4678 \family roman
4679 \shape up
4680 sequence,
4681 \family default
4682 \shape default
4683
4684 \family roman
4685 \shape up
4686 \emph on
4687 result
4688 \emph default
4689  is produced.
4690  If such a declaration does not exist in
4691 \family default
4692 \shape default
4693
4694 \shape up
4695 the
4696 \shape default
4697
4698 \begin_inset Flex Code
4699 status collapsed
4700
4701 \begin_layout Plain Layout
4702
4703 \shape up
4704 .kmap
4705 \end_layout
4706
4707 \end_inset
4708
4709  file and yo
4710 \family roman
4711 u enter
4712 \family default
4713
4714 \family roman
4715 \emph on
4716 accent char
4717 \emph default
4718 , you get
4719 \family default
4720
4721 \family roman
4722 \emph on
4723 accent_key char
4724 \emph default
4725  where
4726 \family default
4727
4728 \family roman
4729 \emph on
4730 accent_key
4731 \emph default
4732  is the first arg
4733 \family default
4734 ument of the
4735 \begin_inset Flex Code
4736 status collapsed
4737
4738 \begin_layout Plain Layout
4739
4740 \shape up
4741
4742 \backslash
4743 kmod
4744 \end_layout
4745
4746 \end_inset
4747
4748  declaration.
4749
4750 \end_layout
4751
4752 \begin_layout Standard
4753 The following command produces causes äi to be produced when you enter acute-i
4754  ('i):
4755 \end_layout
4756
4757 \begin_layout LyX-Code
4758
4759 \backslash
4760 kxmod acute i "
4761 \backslash
4762
4763 \backslash
4764 '{
4765 \backslash
4766
4767 \backslash
4768 i}"
4769 \end_layout
4770
4771 \begin_layout Labeling
4772 \labelwidthstring 00.00.0000
4773 \begin_inset Flex Code
4774 status collapsed
4775
4776 \begin_layout Plain Layout
4777 kcomb
4778 \end_layout
4779
4780 \end_inset
4781
4782  Combine two accent characters
4783 \end_layout
4784
4785 \begin_layout LyX-Code
4786
4787 \backslash
4788 kcomb
4789 \family roman
4790 \emph on
4791 accent1 accent2 allowed
4792 \end_layout
4793
4794 \begin_layout Standard
4795 This one is getting pretty esoteric.
4796  It allows you to combine the effect
4797 \family roman
4798 of
4799 \family default
4800
4801 \family roman
4802 \emph on
4803 accent1
4804 \family default
4805 \emph default
4806
4807 \family roman
4808 and
4809 \family default
4810
4811 \family roman
4812 \emph on
4813 accent2
4814 \family default
4815 \emph default
4816
4817 \family roman
4818 (in that order!) on
4819 \family default
4820
4821 \family roman
4822 \emph on
4823 allowed
4824 \family default
4825 \emph default
4826
4827 \family roman
4828 chars.
4829  The keystrokes for
4830 \family default
4831
4832 \family roman
4833 \emph on
4834 accent1
4835 \family default
4836 \emph default
4837
4838 \family roman
4839 and
4840 \family default
4841
4842 \family roman
4843 \emph on
4844 accent2
4845 \family default
4846 \emph default
4847
4848 \family roman
4849 must have be
4850 \family default
4851 en set with a
4852 \begin_inset Flex Code
4853 status collapsed
4854
4855 \begin_layout Plain Layout
4856
4857 \shape up
4858
4859 \backslash
4860 kmod
4861 \end_layout
4862
4863 \end_inset
4864
4865  command at
4866 \family roman
4867 a
4868 \family default
4869
4870 \family roman
4871 \emph on
4872 previous
4873 \family default
4874 \emph default
4875
4876 \family roman
4877 point in the
4878 \family default
4879  file.
4880
4881 \end_layout
4882
4883 \begin_layout Standard
4884 Consider this example from the
4885 \begin_inset Flex Code
4886 status collapsed
4887
4888 \begin_layout Plain Layout
4889
4890 \shape up
4891 greek.kmap
4892 \end_layout
4893
4894 \end_inset
4895
4896  file:
4897 \end_layout
4898
4899 \begin_layout LyX-Code
4900
4901 \backslash
4902 kmod ; acute aeioyvhAEIOYVH
4903 \backslash
4904 kmod : umlaut iyIY
4905 \backslash
4906 kcomb acute umlaut iyIY
4907 \end_layout
4908
4909 \begin_layout Standard
4910 This allows you to press
4911 \begin_inset Flex MenuItem
4912 status collapsed
4913
4914 \begin_layout Plain Layout
4915
4916 \shape up
4917 ;:i
4918 \end_layout
4919
4920 \end_inset
4921
4922  and get the effect of
4923 \begin_inset Flex Code
4924 status collapsed
4925
4926 \begin_layout Plain Layout
4927
4928 \shape up
4929
4930 \backslash
4931 '{
4932 \backslash
4933 "{i}}
4934 \end_layout
4935
4936 \end_inset
4937
4938 .
4939
4940 \family roman
4941 \shape up
4942 A backspace
4943 \family default
4944 \shape default
4945  in this case cancels the last dead key, so if you press
4946 \begin_inset Flex MenuItem
4947 status collapsed
4948
4949 \begin_layout Plain Layout
4950
4951 \shape up
4952 ;: Backspace i
4953 \end_layout
4954
4955 \end_inset
4956
4957  you get
4958 \begin_inset Flex Code
4959 status collapsed
4960
4961 \begin_layout Plain Layout
4962
4963 \shape up
4964
4965 \backslash
4966 '{i}
4967 \end_layout
4968
4969 \end_inset
4970
4971 .
4972 \end_layout
4973
4974 \begin_layout Subsection
4975 The .cdef File
4976 \end_layout
4977
4978 \begin_layout Standard
4979 After the
4980 \begin_inset Flex Code
4981 status collapsed
4982
4983 \begin_layout Plain Layout
4984
4985 \shape up
4986 .kmap
4987 \end_layout
4988
4989 \end_inset
4990
4991  mapping is performed, a
4992 \begin_inset Flex Code
4993 status collapsed
4994
4995 \begin_layout Plain Layout
4996
4997 \shape up
4998 .cde
4999 \shape default
5000 f
5001 \end_layout
5002
5003 \end_inset
5004
5005  file maps the strings that the symbols generate to characters in the current
5006  font.
5007  The \SpecialChar LyX
5008  distribution currently includes at least the
5009 \begin_inset Flex Code
5010 status collapsed
5011
5012 \begin_layout Plain Layout
5013
5014 \shape up
5015 iso8859-1.cdef
5016 \end_layout
5017
5018 \end_inset
5019
5020  and
5021 \begin_inset Flex Code
5022 status collapsed
5023
5024 \begin_layout Plain Layout
5025
5026 \shape up
5027 iso8859-2.cdef
5028 \end_layout
5029
5030 \end_inset
5031
5032  files.
5033 \end_layout
5034
5035 \begin_layout Standard
5036 In general the
5037 \begin_inset Flex Code
5038 status collapsed
5039
5040 \begin_layout Plain Layout
5041
5042 \shape up
5043 .cdef
5044 \end_layout
5045
5046 \end_inset
5047
5048  file is a sequence of declarations of the form
5049 \end_layout
5050
5051 \begin_layout LyX-Code
5052
5053 \family roman
5054 \emph on
5055 char_index_in_set
5056 \family default
5057 \emph default
5058
5059 \family roman
5060 \emph on
5061  string
5062 \end_layout
5063
5064 \begin_layout Standard
5065 For example, in order to map
5066 \begin_inset Flex MenuItem
5067 status collapsed
5068
5069 \begin_layout Plain Layout
5070
5071 \shape up
5072
5073 \backslash
5074 '{e}
5075 \end_layout
5076
5077 \end_inset
5078
5079  to the corresponding character in the iso-8859-1 set (233), the following
5080  declaration is used
5081 \end_layout
5082
5083 \begin_layout LyX-Code
5084 233 "
5085 \backslash
5086
5087 \backslash
5088 '{e}"
5089 \end_layout
5090
5091 \begin_layout Standard
5092 with
5093 \begin_inset Flex Code
5094 status collapsed
5095
5096 \begin_layout Plain Layout
5097
5098 \backslash
5099
5100 \end_layout
5101
5102 \end_inset
5103
5104  and
5105 \begin_inset Flex Code
5106 status collapsed
5107
5108 \begin_layout Plain Layout
5109 "
5110 \end_layout
5111
5112 \end_inset
5113
5114  being escap
5115 \family roman
5116 ed in
5117 \family default
5118
5119 \family roman
5120 \emph on
5121 string
5122 \emph default
5123 .
5124  Note that
5125 \family default
5126  the same character can apply to more than one string.
5127  In the
5128 \begin_inset Flex Code
5129 status collapsed
5130
5131 \begin_layout Plain Layout
5132 i
5133 \shape up
5134 so-8859-7.cdef
5135 \end_layout
5136
5137 \end_inset
5138
5139  file you have
5140 \end_layout
5141
5142 \begin_layout LyX-Code
5143 192 "
5144 \backslash
5145
5146 \backslash
5147 '{
5148 \backslash
5149
5150 \backslash
5151
5152 \backslash
5153 "{i}}"
5154 \begin_inset Newline newline
5155 \end_inset
5156
5157 192 "
5158 \backslash
5159
5160 \backslash
5161
5162 \backslash
5163 "{
5164 \backslash
5165
5166 \backslash
5167 '{i}}"
5168 \end_layout
5169
5170 \begin_layout Standard
5171 If \SpecialChar LyX
5172  cannot find a mapping for the string produced by the keystroke or a
5173  deadkey sequence, it will check if it looks like an accented char and try
5174  to draw an accent over the character on screen.
5175 \end_layout
5176
5177 \begin_layout Subsection
5178 Dead Keys
5179 \end_layout
5180
5181 \begin_layout Standard
5182 There is a second way to add support for international characters through
5183  so-called dead-keys.
5184  A dead-key works in combination with a letter to produce an accented character.
5185  Here, we'll explain how to create a really simple dead-key to illustrate
5186  how they work.
5187 \end_layout
5188
5189 \begin_layout Standard
5190 Suppose you happen to need the circumflex character,
5191 \begin_inset Quotes eld
5192 \end_inset
5193
5194  ̂
5195 \begin_inset Quotes erd
5196 \end_inset
5197
5198 .
5199  You could bind the
5200 \begin_inset Flex MenuItem
5201 status collapsed
5202
5203 \begin_layout Plain Layout
5204 ^
5205 \end_layout
5206
5207 \end_inset
5208
5209 -key [a.k.a.
5210 \begin_inset space ~
5211 \end_inset
5212
5213
5214 \begin_inset Flex MenuItem
5215 status collapsed
5216
5217 \begin_layout Plain Layout
5218 Shift-6
5219 \end_layout
5220
5221 \end_inset
5222
5223 ] to the \SpecialChar LyX
5224  command
5225 \begin_inset Flex Code
5226 status collapsed
5227
5228 \begin_layout Plain Layout
5229 accent-circumflex
5230 \end_layout
5231
5232 \end_inset
5233
5234  in your
5235 \begin_inset Flex Code
5236 status collapsed
5237
5238 \begin_layout Plain Layout
5239 lyxrc
5240 \end_layout
5241
5242 \end_inset
5243
5244  file.
5245  Now, whenever you type the
5246 \begin_inset Flex MenuItem
5247 status collapsed
5248
5249 \begin_layout Plain Layout
5250 ^
5251 \end_layout
5252
5253 \end_inset
5254
5255 -key followed by a letter, that letter will have a circumflex accent on
5256  it.
5257  For example, the sequence
5258 \begin_inset Quotes eld
5259 \end_inset
5260
5261
5262 \begin_inset Flex MenuItem
5263 status collapsed
5264
5265 \begin_layout Plain Layout
5266 ^e
5267 \end_layout
5268
5269 \end_inset
5270
5271
5272 \begin_inset Quotes erd
5273 \end_inset
5274
5275  produces the letter:
5276 \begin_inset Quotes eld
5277 \end_inset
5278
5279 ê
5280 \begin_inset Quotes erd
5281 \end_inset
5282
5283 .
5284  If you tried to type
5285 \begin_inset Quotes eld
5286 \end_inset
5287
5288
5289 \begin_inset Flex MenuItem
5290 status collapsed
5291
5292 \begin_layout Plain Layout
5293 ^t
5294 \end_layout
5295
5296 \end_inset
5297
5298
5299 \begin_inset Quotes erd
5300 \end_inset
5301
5302 , however, \SpecialChar LyX
5303  will complain with a beep, since a
5304 \begin_inset Quotes eld
5305 \end_inset
5306
5307
5308 \begin_inset Flex MenuItem
5309 status collapsed
5310
5311 \begin_layout Plain Layout
5312 t
5313 \end_layout
5314
5315 \end_inset
5316
5317
5318 \begin_inset Quotes erd
5319 \end_inset
5320
5321  never takes a circumflex accent.
5322  Hitting
5323 \begin_inset Flex MenuItem
5324 status collapsed
5325
5326 \begin_layout Plain Layout
5327 Space
5328 \end_layout
5329
5330 \end_inset
5331
5332  after a dead-key produces the bare-accent.
5333  Please note this last point! If you bind a key to a dead-key, you'll need
5334  to rebind the character on that key to yet another key.
5335  Binding the
5336 \begin_inset Flex MenuItem
5337 status collapsed
5338
5339 \begin_layout Plain Layout
5340 ,-key
5341 \end_layout
5342
5343 \end_inset
5344
5345  to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5346 \end_layout
5347
5348 \begin_layout Standard
5349 One common way to bind dead-keys is to use
5350 \begin_inset Flex MenuItem
5351 status collapsed
5352
5353 \begin_layout Plain Layout
5354 Meta-
5355 \end_layout
5356
5357 \end_inset
5358
5359 ,
5360 \begin_inset Flex MenuItem
5361 status collapsed
5362
5363 \begin_layout Plain Layout
5364 Ctrl-
5365 \end_layout
5366
5367 \end_inset
5368
5369 , and
5370 \begin_inset Flex MenuItem
5371 status collapsed
5372
5373 \begin_layout Plain Layout
5374 Shift-
5375 \end_layout
5376
5377 \end_inset
5378
5379  in combination with an accent, like
5380 \begin_inset Quotes eld
5381 \end_inset
5382
5383
5384 \begin_inset Flex MenuItem
5385 status collapsed
5386
5387 \begin_layout Plain Layout
5388 ~
5389 \end_layout
5390
5391 \end_inset
5392
5393
5394 \begin_inset Quotes erd
5395 \end_inset
5396
5397  or
5398 \begin_inset Quotes eld
5399 \end_inset
5400
5401
5402 \begin_inset Flex MenuItem
5403 status collapsed
5404
5405 \begin_layout Plain Layout
5406 ,
5407 \end_layout
5408
5409 \end_inset
5410
5411
5412 \begin_inset Quotes erd
5413 \end_inset
5414
5415  or
5416 \begin_inset Quotes eld
5417 \end_inset
5418
5419
5420 \begin_inset Flex MenuItem
5421 status collapsed
5422
5423 \begin_layout Plain Layout
5424 ^
5425 \end_layout
5426
5427 \end_inset
5428
5429
5430 \begin_inset Quotes erd
5431 \end_inset
5432
5433 .
5434  Another way involves using
5435 \begin_inset Flex Code
5436 status collapsed
5437
5438 \begin_layout Plain Layout
5439 xmodmap
5440 \end_layout
5441
5442 \end_inset
5443
5444  and
5445 \begin_inset Flex Code
5446 status collapsed
5447
5448 \begin_layout Plain Layout
5449 xkeycaps
5450 \end_layout
5451
5452 \end_inset
5453
5454  to set up the special
5455 \begin_inset Flex Code
5456 status collapsed
5457
5458 \begin_layout Plain Layout
5459 Mode_Switch
5460 \end_layout
5461
5462 \end_inset
5463
5464  key.
5465  The
5466 \begin_inset Flex Code
5467 status collapsed
5468
5469 \begin_layout Plain Layout
5470 Mode_Switch
5471 \end_layout
5472
5473 \end_inset
5474
5475  acts in some ways just like
5476 \begin_inset Flex MenuItem
5477 status collapsed
5478
5479 \begin_layout Plain Layout
5480 Shift
5481 \end_layout
5482
5483 \end_inset
5484
5485  and permits you to bind keys to accented characters.
5486  You can also turn keys into dead-keys by binding them to something like
5487
5488 \begin_inset Flex Code
5489 status collapsed
5490
5491 \begin_layout Plain Layout
5492 usldead_cedilla
5493 \end_layout
5494
5495 \end_inset
5496
5497  and then binding this symbolic key to the corresponding \SpecialChar LyX
5498  command.
5499 \begin_inset Foot
5500 status collapsed
5501
5502 \begin_layout Plain Layout
5503 Note from
5504 \noun on
5505 John Weiss
5506 \noun default
5507 : This is exactly what I do in my
5508 \begin_inset Flex Code
5509 status collapsed
5510
5511 \begin_layout Plain Layout
5512 ~/.lyx/lyxrc
5513 \end_layout
5514
5515 \end_inset
5516
5517  and my
5518 \begin_inset Flex Code
5519 status collapsed
5520
5521 \begin_layout Plain Layout
5522 ~/.xmodmap
5523 \end_layout
5524
5525 \end_inset
5526
5527  files.
5528  I have my
5529 \begin_inset Flex MenuItem
5530 status collapsed
5531
5532 \begin_layout Plain Layout
5533 Scroll
5534 \begin_inset space ~
5535 \end_inset
5536
5537 Lock
5538 \end_layout
5539
5540 \end_inset
5541
5542  key set up as
5543 \begin_inset Flex Code
5544 status collapsed
5545
5546 \begin_layout Plain Layout
5547 Mode_Shift
5548 \end_layout
5549
5550 \end_inset
5551
5552  and a bunch of these
5553 \begin_inset Quotes eld
5554 \end_inset
5555
5556
5557 \begin_inset Flex Code
5558 status collapsed
5559
5560 \begin_layout Plain Layout
5561 usldead_*
5562 \end_layout
5563
5564 \end_inset
5565
5566
5567 \begin_inset Quotes erd
5568 \end_inset
5569
5570  symbolic keys bound such things as
5571 \begin_inset Flex MenuItem
5572 status collapsed
5573
5574 \begin_layout Plain Layout
5575 Scroll
5576 \begin_inset space ~
5577 \end_inset
5578
5579 Lock-^
5580 \end_layout
5581
5582 \end_inset
5583
5584  and
5585 \begin_inset Flex MenuItem
5586 status collapsed
5587
5588 \begin_layout Plain Layout
5589 Scroll
5590 \begin_inset space ~
5591 \end_inset
5592
5593 Lock-~
5594 \end_layout
5595
5596 \end_inset
5597
5598 .
5599  This is how I produce my accented characters.
5600 \end_layout
5601
5602 \end_inset
5603
5604  You can make just about anything into the
5605 \begin_inset Flex Code
5606 status collapsed
5607
5608 \begin_layout Plain Layout
5609 Mode_Switch
5610 \end_layout
5611
5612 \end_inset
5613
5614  key: One of the
5615 \begin_inset Flex MenuItem
5616 status collapsed
5617
5618 \begin_layout Plain Layout
5619 Ctrl-
5620 \end_layout
5621
5622 \end_inset
5623
5624  keys, a spare function key, etc.
5625  As for the \SpecialChar LyX
5626  commands that produce accents, check the entry for
5627 \begin_inset Flex Code
5628 status collapsed
5629
5630 \begin_layout Plain Layout
5631 accent-acute
5632 \end_layout
5633
5634 \end_inset
5635
5636  in the
5637 \emph on
5638 Reference Manual
5639 \emph default
5640 .
5641  You'll find the complete list there.
5642 \end_layout
5643
5644 \begin_layout Subsection
5645 Saving your Language Configuration
5646 \end_layout
5647
5648 \begin_layout Standard
5649 You can edit your preferences so that your desired language environment
5650  is automatically configured when \SpecialChar LyX
5651  starts up, via the
5652 \begin_inset Flex MenuItem
5653 status collapsed
5654
5655 \begin_layout Plain Layout
5656 Edit\SpecialChar menuseparator
5657 Preferences
5658 \end_layout
5659
5660 \end_inset
5661
5662  dialog.
5663 \end_layout
5664
5665 \begin_layout Chapter
5666 Installing New Document Classes, Layouts, and Templates
5667 \begin_inset CommandInset label
5668 LatexCommand label
5669 name "cha:Installing-New-Document"
5670
5671 \end_inset
5672
5673
5674 \begin_inset Argument 1
5675 status collapsed
5676
5677 \begin_layout Plain Layout
5678 Installing New Document Classes
5679 \end_layout
5680
5681 \end_inset
5682
5683
5684 \end_layout
5685
5686 \begin_layout Standard
5687 In this chapter, we describe the procedures for creating and installing
5688  new \SpecialChar LyX
5689  layout and template files, as well as offer a refresher on correctly
5690  installing new \SpecialChar LaTeX
5691  document classes.
5692
5693 \end_layout
5694
5695 \begin_layout Standard
5696 First, let us a say a few words about how one ought to think about the relation
5697  between \SpecialChar LyX
5698  and \SpecialChar LaTeX
5699 .
5700  The thing to understand is that, in a certain sense, \SpecialChar LyX
5701  doesn't know anything
5702  about \SpecialChar LaTeX
5703 .
5704  Indeed, from \SpecialChar LyX
5705 's point of view, \SpecialChar LaTeX
5706  is just one of several
5707 \begin_inset Quotes eld
5708 \end_inset
5709
5710 backend formats
5711 \begin_inset Quotes erd
5712 \end_inset
5713
5714  in which it is capable of producing output.
5715  Other such formats are DocBook, plaintext, and XHTML.
5716  \SpecialChar LaTeX
5717  is, of course, a particularly important format, but very little of the
5718  information \SpecialChar LyX
5719  has about \SpecialChar LaTeX
5720  is actually contained in the program itself.
5721 \begin_inset Foot
5722 status collapsed
5723
5724 \begin_layout Plain Layout
5725 Some commands are sufficiently complex that they are
5726 \begin_inset Quotes eld
5727 \end_inset
5728
5729 hardcoded
5730 \begin_inset Quotes erd
5731 \end_inset
5732
5733  into \SpecialChar LyX
5734 .
5735  But the developers generally regard this as a Bad Thing.
5736 \end_layout
5737
5738 \end_inset
5739
5740  Rather, that information, even for the standard classes like
5741 \begin_inset Flex Code
5742 status collapsed
5743
5744 \begin_layout Plain Layout
5745 article.cls
5746 \end_layout
5747
5748 \end_inset
5749
5750 , is contained in `layout files'.
5751  Similarly, \SpecialChar LyX
5752  itself does not know much about DocBook or XHTML.
5753  What it knows is contained in layout files.
5754 \end_layout
5755
5756 \begin_layout Standard
5757 You can think of the layout file for a given document class as a translation
5758  manual between \SpecialChar LyX
5759  constructs—paragraphs with their corresponding styles,
5760  certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
5761 , DocBook, or XHTML
5762  constructs.
5763  Almost everything \SpecialChar LyX
5764  knows about
5765 \begin_inset Flex Code
5766 status collapsed
5767
5768 \begin_layout Plain Layout
5769 article.cls
5770 \end_layout
5771
5772 \end_inset
5773
5774 , for example, is contained in the file
5775 \begin_inset Flex Code
5776 status collapsed
5777
5778 \begin_layout Plain Layout
5779 article.layout
5780 \end_layout
5781
5782 \end_inset
5783
5784  and in various other files it includes.
5785  For this reason, anyone intending to write layout files should plan to
5786  study the existing files.
5787  A good place to start is with
5788 \begin_inset Flex Code
5789 status collapsed
5790
5791 \begin_layout Plain Layout
5792 stdsections.inc
5793 \end_layout
5794
5795 \end_inset
5796
5797 , which is included in
5798 \begin_inset Flex Code
5799 status collapsed
5800
5801 \begin_layout Plain Layout
5802 article.layout
5803 \end_layout
5804
5805 \end_inset
5806
5807 ,
5808 \begin_inset Flex Code
5809 status collapsed
5810
5811 \begin_layout Plain Layout
5812 book.layout
5813 \end_layout
5814
5815 \end_inset
5816
5817 , and many of the other layout files for document classes.
5818  This file is where sections and the like are defined:
5819 \begin_inset Flex Code
5820 status collapsed
5821
5822 \begin_layout Plain Layout
5823 stdsections.inc
5824 \end_layout
5825
5826 \end_inset
5827
5828  tells \SpecialChar LyX
5829  how paragraphs that are marked with the Section, Subsection, etc,
5830  styles can be translated into corresponding \SpecialChar LaTeX
5831 , DocBook, and XHTML commands
5832  and tags.
5833  The
5834 \begin_inset Flex Code
5835 status collapsed
5836
5837 \begin_layout Plain Layout
5838 article.layout
5839 \end_layout
5840
5841 \end_inset
5842
5843  file basically just includes several of these
5844 \begin_inset Flex Code
5845 status collapsed
5846
5847 \begin_layout Plain Layout
5848 std*.inc
5849 \end_layout
5850
5851 \end_inset
5852
5853  files.
5854 \end_layout
5855
5856 \begin_layout Standard
5857 Defining the \SpecialChar LyX
5858 –\SpecialChar LaTeX
5859  correspondence is not the only thing layout files do, though.
5860  Their other job is to define how the \SpecialChar LyX
5861  constructs themselves will appear
5862  on-screen.
5863  The fact that layout files have these two jobs is often a source of confusion,
5864  because they are completely separate.
5865  Telling \SpecialChar LyX
5866  how to translate a certain paragraph style into \SpecialChar LaTeX
5867  does not tell
5868  \SpecialChar LyX
5869  how to display it; conversely, telling \SpecialChar LyX
5870  how to display a certain paragraph
5871  style does not tell \SpecialChar LyX
5872  how to translate it into \SpecialChar LaTeX
5873  (let alone tell \SpecialChar LaTeX
5874  how to
5875  display it).
5876  So, in general, when you define a new \SpecialChar LyX
5877  construct, you must always do two
5878  quite separate things: (i)
5879 \begin_inset space ~
5880 \end_inset
5881
5882 tell \SpecialChar LyX
5883  how to translate it into \SpecialChar LaTeX
5884  and (ii)
5885 \begin_inset space ~
5886 \end_inset
5887
5888 tell \SpecialChar LyX
5889  how to display it.
5890 \end_layout
5891
5892 \begin_layout Standard
5893 Much the same is true, of course, as regards \SpecialChar LyX
5894 's other backend formats, though
5895  XHTML is in some ways different, because in that case \SpecialChar LyX
5896
5897 \emph on
5898 is
5899 \emph default
5900  able, to some extent, to use information about how it should display a
5901  paragraph on the screen to output information (in the form of CSS) about
5902  how the paragraph should be displayed in a browser.
5903  Even in this case, however, the distinction between what \SpecialChar LyX
5904  does internally
5905  and how things are rendered externally remains in force, and the two can
5906  be controlled separately.
5907  See
5908 \begin_inset CommandInset ref
5909 LatexCommand ref
5910 reference "sec:Tags-for-XHTML"
5911
5912 \end_inset
5913
5914  for the details.
5915 \end_layout
5916
5917 \begin_layout Section
5918 Installing new \SpecialChar LaTeX
5919  files
5920 \end_layout
5921
5922 \begin_layout Standard
5923 Some installations may not include a \SpecialChar LaTeX
5924  package or class file that you would
5925  like to use within \SpecialChar LyX
5926 .
5927  For example, you might need Foil\SpecialChar TeX
5928 , a package for preparing slides for overhead
5929  projectors.
5930  Modern \SpecialChar LaTeX
5931  distributions like \SpecialChar TeX
5932 Live (2008 or newer) or MiK\SpecialChar TeX
5933  provide a user interface
5934  for installing such packages.
5935  For example, with MiK\SpecialChar TeX
5936 , you start the program
5937 \begin_inset Quotes eld
5938 \end_inset
5939
5940 Package
5941 \begin_inset space ~
5942 \end_inset
5943
5944 Manager
5945 \begin_inset Quotes erd
5946 \end_inset
5947
5948  to get a list of available packages.
5949  To install one of them, right click on it or use the corresponding toolbar
5950  button.
5951 \end_layout
5952
5953 \begin_layout Standard
5954 If your \SpecialChar LaTeX
5955  distribution does not provide such a `package manager', or if the
5956  package is not available from your distribution, then follow these steps
5957  to install it manually:
5958 \end_layout
5959
5960 \begin_layout Enumerate
5961 Get the package from
5962 \begin_inset CommandInset href
5963 LatexCommand href
5964 name "CTAN"
5965 target "http://www.ctan.org/"
5966
5967 \end_inset
5968
5969  or wherever.
5970 \end_layout
5971
5972 \begin_layout Enumerate
5973 If the package contains a file with the ending
5974 \begin_inset Quotes eld
5975 \end_inset
5976
5977
5978 \begin_inset Flex Code
5979 status collapsed
5980
5981 \begin_layout Plain Layout
5982 .ins
5983 \end_layout
5984
5985 \end_inset
5986
5987
5988 \begin_inset Quotes erd
5989 \end_inset
5990
5991  (is the case for Foil\SpecialChar TeX
5992 ) then open a console, change to the folder of this
5993  file and execute the command
5994 \begin_inset Flex Code
5995 status collapsed
5996
5997 \begin_layout Plain Layout
5998 latex foiltex.ins
5999 \end_layout
6000
6001 \end_inset
6002
6003 .
6004  You have now unpacked the package and have all files to install it.
6005  Most \SpecialChar LaTeX
6006 -packages are not packed and you can skip this step.
6007 \end_layout
6008
6009 \begin_layout Enumerate
6010 Now you need to decide if the package should be available for all users
6011  or only for you.
6012 \begin_inset Separator parbreak
6013 \end_inset
6014
6015
6016 \end_layout
6017
6018 \begin_deeper
6019 \begin_layout Enumerate
6020 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6021  for all users on your system, then install it in your `local' \SpecialChar TeX
6022  tree, otherwise
6023  install it in your own `user' \SpecialChar TeX
6024  tree.
6025  Where these trees should be created, if they do not already exist, depends
6026  on your system.
6027  To find this out, look in the file
6028 \begin_inset Flex Code
6029 status collapsed
6030
6031 \begin_layout Plain Layout
6032 texmf.cnf
6033 \end_layout
6034
6035 \end_inset
6036
6037 .
6038 \begin_inset Foot
6039 status collapsed
6040
6041 \begin_layout Plain Layout
6042 This is usually in the directory
6043 \begin_inset Flex Code
6044 status collapsed
6045
6046 \begin_layout Plain Layout
6047 $TEXMF/web2c
6048 \end_layout
6049
6050 \end_inset
6051
6052 , though you can execute the command
6053 \begin_inset Flex Code
6054 status collapsed
6055
6056 \begin_layout Plain Layout
6057 kpsewhich texmf.cnf
6058 \end_layout
6059
6060 \end_inset
6061
6062  to locate it.
6063 \end_layout
6064
6065 \end_inset
6066
6067  The location of the `local' \SpecialChar TeX
6068  tree is defined by the
6069 \begin_inset Flex Code
6070 status collapsed
6071
6072 \begin_layout Plain Layout
6073 TEXMFLOCAL
6074 \end_layout
6075
6076 \end_inset
6077
6078  variable; this is usually somewhere like
6079 \begin_inset Flex Code
6080 status collapsed
6081
6082 \begin_layout Plain Layout
6083 /usr/local/share/texmf
6084 \end_layout
6085
6086 \end_inset
6087
6088 .
6089  The location of the `user' \SpecialChar TeX
6090  tree is defined by
6091 \begin_inset Flex Code
6092 status collapsed
6093
6094 \begin_layout Plain Layout
6095 TEXMFHOME
6096 \end_layout
6097
6098 \end_inset
6099
6100  and is commonly
6101 \begin_inset Flex Code
6102 status collapsed
6103
6104 \begin_layout Plain Layout
6105 $HOME/texmf
6106 \end_layout
6107
6108 \end_inset
6109
6110 .
6111  (If these variables are not predefined, you have to define them.) You'll
6112  probably need root permissions to create or modify the `local' tree, but
6113  not for your `user' tree.
6114 \begin_inset Newline newline
6115 \end_inset
6116
6117 In general, it is recommended to install in the user tree because your user
6118  will not be modified or even overwritten when you upgrade your system.
6119  It will typically also be backed up together with everything else when
6120  you backup your home directory (which, of course, you do on a regular basis).
6121 \end_layout
6122
6123 \begin_layout Enumerate
6124 On Windows, if you want the new package to be available for all users on
6125  your system, change to the folder where \SpecialChar LaTeX
6126  is installed and then change to
6127  the subfolder
6128 \begin_inset Flex Code
6129 status collapsed
6130
6131 \begin_layout Plain Layout
6132 ~
6133 \backslash
6134 tex
6135 \backslash
6136 latex
6137 \end_layout
6138
6139 \end_inset
6140
6141 .
6142  (For MiK\SpecialChar TeX
6143 , this would be by default the folder
6144 \begin_inset Flex Code
6145 status collapsed
6146
6147 \begin_layout Plain Layout
6148 ~:
6149 \backslash
6150 Programs
6151 \backslash
6152 MiKTeX
6153 \backslash
6154 tex
6155 \backslash
6156 latex
6157 \end_layout
6158
6159 \end_inset
6160
6161 .)
6162 \begin_inset Foot
6163 status open
6164
6165 \begin_layout Plain Layout
6166 Note that this will be the correct path only on English installations.
6167  On a German one, it would be
6168 \begin_inset Flex Code
6169 status collapsed
6170
6171 \begin_layout Plain Layout
6172 ~:
6173 \backslash
6174 Programme
6175 \backslash
6176 MiKTeX
6177 \backslash
6178 tex
6179 \backslash
6180 latex
6181 \end_layout
6182
6183 \end_inset
6184
6185 , and similarly for other languages.
6186 \end_layout
6187
6188 \end_inset
6189
6190  Create there a new folder
6191 \begin_inset Flex Code
6192 status collapsed
6193
6194 \begin_layout Plain Layout
6195 foiltex
6196 \end_layout
6197
6198 \end_inset
6199
6200  and copy all files of the package into it.
6201
6202 \begin_inset Newline newline
6203 \end_inset
6204
6205 If the package should only available for you or you don't have admin permissions
6206 , do the same, but in the local \SpecialChar LaTeX
6207  folder.
6208  E.
6209 \begin_inset space \thinspace{}
6210 \end_inset
6211
6212 g., for MiK\SpecialChar TeX
6213
6214 \begin_inset space ~
6215 \end_inset
6216
6217 2.8 under Windows XP, this would be the folder:
6218 \begin_inset Newline newline
6219 \end_inset
6220
6221
6222 \family sans
6223
6224 \begin_inset Flex Code
6225 status collapsed
6226
6227 \begin_layout Plain Layout
6228 ~:
6229 \backslash
6230 Documents and Settings
6231 \backslash
6232 <username>
6233 \backslash
6234 Application Data
6235 \backslash
6236
6237 \end_layout
6238
6239 \end_inset
6240
6241
6242 \begin_inset Newline newline
6243 \end_inset
6244
6245
6246 \family default
6247
6248 \begin_inset Phantom HPhantom
6249 status open
6250
6251 \begin_layout Plain Layout
6252
6253 \family sans
6254 ~:
6255 \backslash
6256
6257 \end_layout
6258
6259 \end_inset
6260
6261
6262 \begin_inset Flex Code
6263 status collapsed
6264
6265 \begin_layout Plain Layout
6266 MiKTeX
6267 \backslash
6268 2.8
6269 \backslash
6270 tex
6271 \backslash
6272 latex
6273 \end_layout
6274
6275 \end_inset
6276
6277
6278 \begin_inset Newline newline
6279 \end_inset
6280
6281 On Vista, it would be:
6282 \begin_inset Newline newline
6283 \end_inset
6284
6285
6286 \begin_inset Flex Code
6287 status collapsed
6288
6289 \begin_layout Plain Layout
6290 ~:
6291 \backslash
6292 Users
6293 \backslash
6294 <username>
6295 \backslash
6296 AppData
6297 \backslash
6298 Roaming
6299 \backslash
6300 2.8
6301 \backslash
6302 MiKTeX
6303 \backslash
6304 tex
6305 \backslash
6306 latex
6307 \end_layout
6308
6309 \end_inset
6310
6311
6312 \end_layout
6313
6314 \end_deeper
6315 \begin_layout Enumerate
6316 Now one only need to tell \SpecialChar LaTeX
6317  that there are new files.
6318  This depends on the used \SpecialChar LaTeX
6319 -Distribution:
6320 \begin_inset Separator parbreak
6321 \end_inset
6322
6323
6324 \end_layout
6325
6326 \begin_deeper
6327 \begin_layout Enumerate
6328 For \SpecialChar TeX
6329 Live execute the command
6330 \begin_inset Flex Code
6331 status collapsed
6332
6333 \begin_layout Plain Layout
6334 texhash
6335 \end_layout
6336
6337 \end_inset
6338
6339  from a console.
6340  If you installed the package for all users, then you will probably need
6341  to have root permissions for that.
6342 \end_layout
6343
6344 \begin_layout Enumerate
6345 For MiK\SpecialChar TeX
6346 , if you have installed the package for all users, start the program
6347
6348 \begin_inset Quotes eld
6349 \end_inset
6350
6351 Settings
6352 \begin_inset space ~
6353 \end_inset
6354
6355 (Admin)
6356 \begin_inset Quotes erd
6357 \end_inset
6358
6359  and press the button marked
6360 \begin_inset Quotes eld
6361 \end_inset
6362
6363 Refresh FNDB
6364 \begin_inset Quotes erd
6365 \end_inset
6366
6367 .
6368  Otherwise start the program
6369 \begin_inset Quotes eld
6370 \end_inset
6371
6372 Settings
6373 \begin_inset Quotes erd
6374 \end_inset
6375
6376  and do the same.
6377 \end_layout
6378
6379 \end_deeper
6380 \begin_layout Enumerate
6381 Finally, you need to tell \SpecialChar LyX
6382  that there are new packages available.
6383  So, in \SpecialChar LyX
6384 , use the menu
6385 \begin_inset Flex MenuItem
6386 status collapsed
6387
6388 \begin_layout Plain Layout
6389 Tools
6390 \family sans
6391 \SpecialChar menuseparator
6392 Reconfigure
6393 \end_layout
6394
6395 \end_inset
6396
6397  and then restart \SpecialChar LyX
6398 .
6399 \end_layout
6400
6401 \begin_layout Standard
6402 Now the package is installed.
6403  In our example, the document class
6404 \begin_inset Flex Code
6405 status collapsed
6406
6407 \begin_layout Plain Layout
6408 Slides
6409 \begin_inset space ~
6410 \end_inset
6411
6412 (FoilTex)
6413 \end_layout
6414
6415 \end_inset
6416
6417  will now be available under
6418 \begin_inset Flex MenuItem
6419 status collapsed
6420
6421 \begin_layout Plain Layout
6422 Document\SpecialChar menuseparator
6423 Settings\SpecialChar menuseparator
6424 Document Class
6425 \end_layout
6426
6427 \end_inset
6428
6429 .
6430
6431 \end_layout
6432
6433 \begin_layout Standard
6434 If you would like to use a \SpecialChar LaTeX
6435  document class that is not even listed in the
6436  menu
6437 \begin_inset Flex MenuItem
6438 status collapsed
6439
6440 \begin_layout Plain Layout
6441 Document\SpecialChar menuseparator
6442 Settings\SpecialChar menuseparator
6443 Document Class
6444 \end_layout
6445
6446 \end_inset
6447
6448 , then you need to create a `layout' file for it.
6449  That is the topic of the next section.
6450 \end_layout
6451
6452 \begin_layout Section
6453 Types of layout files
6454 \end_layout
6455
6456 \begin_layout Standard
6457 This section describes the various sorts of \SpecialChar LyX
6458  files that contain layout informati
6459 on.
6460  These files describe various paragraph and character styles, determining
6461  how \SpecialChar LyX
6462  should display them and how they should be translated into \SpecialChar LaTeX
6463 , DocBook,
6464  XHTML, or whatever output format is being used.
6465
6466 \end_layout
6467
6468 \begin_layout Standard
6469 We shall try to provide a thorough description of the process of writing
6470  layout files here.
6471  However, there are so many different types of documents supported even
6472  by just \SpecialChar LaTeX
6473  that we can't hope to cover every different possibility or problem
6474  you might encounter.
6475  The \SpecialChar LyX
6476  users' list is frequented by people with lots of experience with layout
6477  design who are willing to share what they've learned, so please feel free
6478  to ask questions there.
6479 \end_layout
6480
6481 \begin_layout Standard
6482 As you prepare to write a new layout, it is extremely helpful to look at
6483  the layouts distributed with \SpecialChar LyX
6484 .
6485  If you write a \SpecialChar LyX
6486  layout for a \SpecialChar LaTeX
6487  document class that might also be used by
6488  others, or write a module that might be useful to others, then you should
6489  consider posting your layout to the
6490 \begin_inset CommandInset href
6491 LatexCommand href
6492 name "layout section on the LyX wiki"
6493 target "http://wiki.lyx.org/Layouts/Layouts"
6494
6495 \end_inset
6496
6497  or even to the \SpecialChar LyX
6498  developers' list, so that it might be included in \SpecialChar LyX
6499  itself.
6500 \begin_inset Foot
6501 status collapsed
6502
6503 \begin_layout Plain Layout
6504 Note that \SpecialChar LyX
6505  is licensed under the General Public License, so any material
6506  that is contributed to \SpecialChar LyX
6507  must be similarly licensed.
6508 \end_layout
6509
6510 \end_inset
6511
6512
6513 \end_layout
6514
6515 \begin_layout Subsection
6516 Layout modules
6517 \begin_inset CommandInset label
6518 LatexCommand label
6519 name "subsec:Layout-modules"
6520
6521 \end_inset
6522
6523
6524 \end_layout
6525
6526 \begin_layout Standard
6527 We have spoken to this point about `layout files'.
6528  But there are different sorts of files that contain layout information.
6529  Layout files, strictly so called, have the
6530 \begin_inset Flex Code
6531 status collapsed
6532
6533 \begin_layout Plain Layout
6534 .layout
6535 \end_layout
6536
6537 \end_inset
6538
6539  extension and provide \SpecialChar LyX
6540  with information about document classes.
6541  Since \SpecialChar LyX
6542  1.6 layout information can also be contained in layout
6543 \emph on
6544 modules
6545 \emph default
6546 , which have the
6547 \begin_inset Flex Code
6548 status collapsed
6549
6550 \begin_layout Plain Layout
6551 .module
6552 \end_layout
6553
6554 \end_inset
6555
6556  extension.
6557  Modules are to \SpecialChar LaTeX
6558  packages much as layouts are to \SpecialChar LaTeX
6559  classes, and some modules—such
6560  as the
6561 \begin_inset Flex Code
6562 status collapsed
6563
6564 \begin_layout Plain Layout
6565 endnotes
6566 \end_layout
6567
6568 \end_inset
6569
6570  module—specifically provide support for one package.
6571  In a sense, layout modules are similar to included
6572 \begin_inset Foot
6573 status collapsed
6574
6575 \begin_layout Plain Layout
6576 These can have any extension, but by convention have the
6577 \begin_inset Flex Code
6578 status collapsed
6579
6580 \begin_layout Plain Layout
6581 .inc
6582 \end_layout
6583
6584 \end_inset
6585
6586  extension.
6587 \end_layout
6588
6589 \end_inset
6590
6591  files—files like
6592 \begin_inset Flex Code
6593 status collapsed
6594
6595 \begin_layout Plain Layout
6596 stdsections.inc
6597 \end_layout
6598
6599 \end_inset
6600
6601 —in that modules are not specific to a given document class but may be used
6602  with many different classes.
6603  The difference is that using an included file with
6604 \begin_inset Flex Code
6605 status collapsed
6606
6607 \begin_layout Plain Layout
6608 article.cls
6609 \end_layout
6610
6611 \end_inset
6612
6613  requires editing that file.
6614  Modules, by contrast, are selected in the
6615 \begin_inset Flex MenuItem
6616 status collapsed
6617
6618 \begin_layout Plain Layout
6619 Document\SpecialChar menuseparator
6620 Settings
6621 \end_layout
6622
6623 \end_inset
6624
6625  dialog.
6626 \end_layout
6627
6628 \begin_layout Standard
6629 Building modules is the easiest way to get started with layout editing,
6630  since it can be as simple as adding a single new paragraph style or flex
6631  inset.
6632  But modules may, in principle, contain anything a layout file can contain.
6633 \end_layout
6634
6635 \begin_layout Standard
6636 After creating a new module and copying it to the
6637 \begin_inset Flex Code
6638 status collapsed
6639
6640 \begin_layout Plain Layout
6641 layouts/
6642 \end_layout
6643
6644 \end_inset
6645
6646  folder, you will need to reconfigure and then restart \SpecialChar LyX
6647  for the module to
6648  appear in the menu.
6649  However, changes you make to the module will be seen immediately, if you
6650  open
6651 \begin_inset Flex MenuItem
6652 status collapsed
6653
6654 \begin_layout Plain Layout
6655 Document\SpecialChar menuseparator
6656 Settings
6657 \end_layout
6658
6659 \end_inset
6660
6661 , highlight something, and then hit
6662 \begin_inset Quotes eld
6663 \end_inset
6664
6665 OK
6666 \begin_inset Quotes erd
6667 \end_inset
6668
6669 .
6670
6671 \emph on
6672 It is strongly recommended that you save your work before doing this
6673 \emph default
6674 .
6675  In fact,
6676 \emph on
6677 it is strongly recommended that you not attempt to edit modules while simultaneo
6678 usly working on actual documents
6679 \emph default
6680 .
6681  Though of course the developers strive to keep \SpecialChar LyX
6682  stable in such situations,
6683  syntax errors and the like in your module file could cause strange behavior.
6684 \end_layout
6685
6686 \begin_layout Subsubsection
6687 Local Layout
6688 \end_layout
6689
6690 \begin_layout Standard
6691 Modules are to \SpecialChar LyX
6692  as packages are to \SpecialChar LaTeX
6693 .
6694  Sometimes, however, you find yourself wanting a specific inset or character
6695  style just for one document and writing a module that will also be available
6696  to other documents makes little sense.
6697  What you need is \SpecialChar LyX
6698 's
6699 \begin_inset Quotes eld
6700 \end_inset
6701
6702 Local Layout
6703 \begin_inset Quotes erd
6704 \end_inset
6705
6706 .
6707 \end_layout
6708
6709 \begin_layout Standard
6710 You will find it under
6711 \family sans
6712 Document\SpecialChar menuseparator
6713 Settings\SpecialChar menuseparator
6714 Local Layout
6715 \family default
6716 .
6717  The large text box allows you to enter anything that you might enter in
6718  a layout file or module.
6719  You can think of a document's local layout, in fact, as a module that belongs
6720  just to it.
6721  So, in particular, you must enter a
6722 \begin_inset Flex Code
6723 status collapsed
6724
6725 \begin_layout Plain Layout
6726 Format
6727 \end_layout
6728
6729 \end_inset
6730
6731  tag.
6732  Any format is acceptable, but one would normally use the format current
6733  at the time.
6734  (In \SpecialChar LyX
6735  2.1, the current layout format is 48.) You should be aware that local
6736  layout is not supported by versions of \SpecialChar LyX
6737  prior to 1.6, so you should not
6738  use it if you want to be able to export your document to \SpecialChar LyX
6739  1.5 or earlier
6740  (without, that is, losing the local layout information).
6741  If you wish to be able to export to 1.6—local layout is supported in 1.6,
6742  though there is no UI for it—then you should use format 11 and, of course,
6743  use only layout constructs that were available in \SpecialChar LyX
6744  1.6.
6745 \end_layout
6746
6747 \begin_layout Standard
6748 When you have entered something in the
6749 \begin_inset Flex Code
6750 status collapsed
6751
6752 \begin_layout Plain Layout
6753 Local Layout
6754 \end_layout
6755
6756 \end_inset
6757
6758  pane, \SpecialChar LyX
6759  will enable the
6760 \begin_inset Quotes eld
6761 \end_inset
6762
6763 Validate
6764 \begin_inset Quotes erd
6765 \end_inset
6766
6767  button at the bottom.
6768  Clicking this button will cause \SpecialChar LyX
6769  to determine whether what you have entered
6770  is valid layout information for the chosen format.
6771  \SpecialChar LyX
6772  will report the result but, unfortunately, will not tell you what errors
6773  there might have been.
6774  These will be written to the terminal, however, if \SpecialChar LyX
6775  is started from a terminal.
6776  You will not be permitted to save your local layout until you have entered
6777  something valid.
6778 \end_layout
6779
6780 \begin_layout Standard
6781 The warnings at the end of the previous section apply here, too.
6782  Do not play with local layout while you are actually working, especially
6783  if you have not saved your document.
6784  That said, using local layout with a test document can be a very convenient
6785  way to try out layout ideas, or even to start developing a module.
6786 \end_layout
6787
6788 \begin_layout Subsection
6789 Layout for
6790 \begin_inset Flex MenuItem
6791 status collapsed
6792
6793 \begin_layout Plain Layout
6794 .sty
6795 \end_layout
6796
6797 \end_inset
6798
6799  files
6800 \end_layout
6801
6802 \begin_layout Standard
6803 There are two situations you are likely to encounter when wanting to support
6804  a new \SpecialChar LaTeX
6805  document class, involving style (
6806 \begin_inset Flex Code
6807 status collapsed
6808
6809 \begin_layout Plain Layout
6810 .sty
6811 \end_layout
6812
6813 \end_inset
6814
6815 ) files and \SpecialChar LaTeX2e
6816  class (
6817 \begin_inset Flex Code
6818 status collapsed
6819
6820 \begin_layout Plain Layout
6821 .cls
6822 \end_layout
6823
6824 \end_inset
6825
6826 ) .
6827  Supporting a style file is usually fairly easy.
6828  Supporting a new class file is a bit harder.
6829  We'll discuss the former in this section and the latter in the next.
6830  Similar remarks apply, of course, if you want to support a new DocBook
6831  DTD.
6832 \end_layout
6833
6834 \begin_layout Standard
6835 The easier case is the one in which your new document class is provided
6836  as a style file that is to be used in conjunction with an already supported
6837  document class.
6838  For the sake of the example, we'll assume that the style file is called
6839
6840 \begin_inset Flex MenuItem
6841 status collapsed
6842
6843 \begin_layout Plain Layout
6844 myclass.sty
6845 \end_layout
6846
6847 \end_inset
6848
6849  and that it is meant to be used with
6850 \begin_inset Flex MenuItem
6851 status collapsed
6852
6853 \begin_layout Plain Layout
6854 report.cls
6855 \end_layout
6856
6857 \end_inset
6858
6859 , which is a standard class.
6860
6861 \end_layout
6862
6863 \begin_layout Standard
6864 Start by copying the existing class's layout file into your local directory:
6865 \begin_inset Foot
6866 status collapsed
6867
6868 \begin_layout Plain Layout
6869 Of course, which directory is your local directory will vary by platform,
6870  and \SpecialChar LyX
6871  allows you to specify your local directory on startup, too, using
6872  the
6873 \begin_inset Flex Code
6874 status collapsed
6875
6876 \begin_layout Plain Layout
6877 -userdir
6878 \end_layout
6879
6880 \end_inset
6881
6882  option.
6883 \end_layout
6884
6885 \end_inset
6886
6887
6888 \end_layout
6889
6890 \begin_layout LyX-Code
6891 cp report.layout ~/.lyx/layouts/myclass.layout
6892 \end_layout
6893
6894 \begin_layout Standard
6895 Then edit
6896 \begin_inset Flex Code
6897 status collapsed
6898
6899 \begin_layout Plain Layout
6900 myclass.layout
6901 \end_layout
6902
6903 \end_inset
6904
6905  and change the line:
6906 \end_layout
6907
6908 \begin_layout LyX-Code
6909
6910 \backslash
6911 Declare\SpecialChar LaTeX
6912 Class{report}
6913 \end_layout
6914
6915 \begin_layout Standard
6916 to read
6917 \end_layout
6918
6919 \begin_layout LyX-Code
6920
6921 \backslash
6922 Declare\SpecialChar LaTeX
6923 Class[report, myclass.sty]{report (myclass)}
6924 \end_layout
6925
6926 \begin_layout Standard
6927 Then add:
6928 \end_layout
6929
6930 \begin_layout LyX-Code
6931 Preamble
6932 \begin_inset Newline newline
6933 \end_inset
6934
6935
6936 \backslash
6937 usepackage{myclass}
6938 \begin_inset Newline newline
6939 \end_inset
6940
6941 EndPreamble
6942 \end_layout
6943
6944 \begin_layout Standard
6945 near the top of the file.
6946 \end_layout
6947
6948 \begin_layout Standard
6949 Start \SpecialChar LyX
6950  and select
6951 \begin_inset Flex MenuItem
6952 status collapsed
6953
6954 \begin_layout Plain Layout
6955 Tools\SpecialChar menuseparator
6956 Reconfigure
6957 \end_layout
6958
6959 \end_inset
6960
6961 .
6962  Then restart \SpecialChar LyX
6963  and try creating a new document.
6964  You should see "
6965 \begin_inset Flex MenuItem
6966 status collapsed
6967
6968 \begin_layout Plain Layout
6969 report (myclass)
6970 \end_layout
6971
6972 \end_inset
6973
6974 " as a document class option in the
6975 \begin_inset Flex MenuItem
6976 status collapsed
6977
6978 \begin_layout Plain Layout
6979 Document\SpecialChar menuseparator
6980 Settings
6981 \end_layout
6982
6983 \end_inset
6984
6985  dialog.
6986  It is likely that some of the sectioning commands and such in your new
6987  class will work differently from how they worked in the base class—
6988 \begin_inset Flex Code
6989 status collapsed
6990
6991 \begin_layout Plain Layout
6992 report
6993 \end_layout
6994
6995 \end_inset
6996
6997  in this example—so you can fiddle around with the settings for the different
6998  sections if you wish.
6999  The layout information for sections is contained in
7000 \begin_inset Flex Code
7001 status collapsed
7002
7003 \begin_layout Plain Layout
7004 stdsections.inc
7005 \end_layout
7006
7007 \end_inset
7008
7009 , but you do not need to copy and change this file.
7010  Instead, you can simply add your changes to your layout file, after the
7011  line
7012 \begin_inset Flex Code
7013 status collapsed
7014
7015 \begin_layout Plain Layout
7016 Input stdclass.inc
7017 \end_layout
7018
7019 \end_inset
7020
7021 , which itself includes
7022 \begin_inset Flex Code
7023 status collapsed
7024
7025 \begin_layout Plain Layout
7026 stdsections.inc
7027 \end_layout
7028
7029 \end_inset
7030
7031 .
7032  For example, you might add these lines:
7033 \end_layout
7034
7035 \begin_layout LyX-Code
7036 Style Chapter
7037 \end_layout
7038
7039 \begin_layout LyX-Code
7040     Font
7041 \end_layout
7042
7043 \begin_layout LyX-Code
7044         Family Sans
7045 \end_layout
7046
7047 \begin_layout LyX-Code
7048     EndFont
7049 \end_layout
7050
7051 \begin_layout LyX-Code
7052 End
7053 \end_layout
7054
7055 \begin_layout Standard
7056 to change the font for chapter headings to sans-serif.
7057  This will override (or, in this case, add to) the existing declaration
7058  for the Chapter style.
7059
7060 \end_layout
7061
7062 \begin_layout Standard
7063 Your new package may also provide commands or environments not present in
7064  the base class.
7065  In this case, you will want to add these to the layout file.
7066  See
7067 \begin_inset CommandInset ref
7068 LatexCommand ref
7069 reference "sec:TextClass"
7070
7071 \end_inset
7072
7073  for information on how to do so.
7074 \end_layout
7075
7076 \begin_layout Standard
7077 If
7078 \begin_inset Flex MenuItem
7079 status collapsed
7080
7081 \begin_layout Plain Layout
7082 myclass.sty
7083 \end_layout
7084
7085 \end_inset
7086
7087  can be used with several different document classes, and even if it cannot,
7088  you might find it easiest just to write a module that you can load with
7089  the base class.
7090  The simplest possible such module would be:
7091 \end_layout
7092
7093 \begin_layout LyX-Code
7094 #
7095 \backslash
7096 DeclareLyXModule{My Package}
7097 \end_layout
7098
7099 \begin_layout LyX-Code
7100 #DescriptionBegin
7101 \end_layout
7102
7103 \begin_layout LyX-Code
7104 #Support for mypkg.sty.
7105 \end_layout
7106
7107 \begin_layout LyX-Code
7108 #DescriptionEnd
7109 \begin_inset Newline newline
7110 \end_inset
7111
7112
7113 \end_layout
7114
7115 \begin_layout LyX-Code
7116 Format 35
7117 \begin_inset Newline newline
7118 \end_inset
7119
7120
7121 \end_layout
7122
7123 \begin_layout LyX-Code
7124 Preamble
7125 \begin_inset Newline newline
7126 \end_inset
7127
7128
7129 \backslash
7130 usepackage{mypkg}
7131 \begin_inset Newline newline
7132 \end_inset
7133
7134 EndPreamble
7135 \end_layout
7136
7137 \begin_layout Standard
7138 A more complex module might modify the behavior of some existing constructs
7139  or define some new ones.
7140  Again, see
7141 \begin_inset CommandInset ref
7142 LatexCommand ref
7143 reference "sec:TextClass"
7144
7145 \end_inset
7146
7147  for discussion.
7148 \end_layout
7149
7150 \begin_layout Subsection
7151 Layout for
7152 \begin_inset Flex MenuItem
7153 status collapsed
7154
7155 \begin_layout Plain Layout
7156 .cls
7157 \end_layout
7158
7159 \end_inset
7160
7161  files
7162 \end_layout
7163
7164 \begin_layout Standard
7165 There are two possibilities here.
7166  One is that the class file is itself based upon an existing document class.
7167  For example, many thesis classes are based upon
7168 \begin_inset Flex MenuItem
7169 status collapsed
7170
7171 \begin_layout Plain Layout
7172 book.cls
7173 \end_layout
7174
7175 \end_inset
7176
7177 .
7178  To see whether yours is, look for a line like
7179 \end_layout
7180
7181 \begin_layout LyX-Code
7182
7183 \backslash
7184 LoadClass{book}
7185 \end_layout
7186
7187 \begin_layout Standard
7188 in the file.
7189  If so, then you may proceed largely as in the previous section, though
7190  the
7191 \begin_inset Flex Code
7192 status collapsed
7193
7194 \begin_layout Plain Layout
7195 Declare\SpecialChar LaTeX
7196 Class
7197 \end_layout
7198
7199 \end_inset
7200
7201  line will be different.
7202  If your new class is
7203 \begin_inset Flex Code
7204 status collapsed
7205
7206 \begin_layout Plain Layout
7207 thesis
7208 \end_layout
7209
7210 \end_inset
7211
7212  and it is based upon
7213 \begin_inset Flex Code
7214 status collapsed
7215
7216 \begin_layout Plain Layout
7217 book
7218 \end_layout
7219
7220 \end_inset
7221
7222 , then the line should read:
7223 \begin_inset Foot
7224 status collapsed
7225
7226 \begin_layout Plain Layout
7227 And it will be easiest if you save the file to
7228 \begin_inset Flex Code
7229 status collapsed
7230
7231 \begin_layout Plain Layout
7232 thesis.layout
7233 \end_layout
7234
7235 \end_inset
7236
7237 : \SpecialChar LyX
7238  assumes that the document class has the same name as the layout file.
7239
7240 \end_layout
7241
7242 \end_inset
7243
7244
7245 \end_layout
7246
7247 \begin_layout LyX-Code
7248
7249 \backslash
7250 Declare\SpecialChar LaTeX
7251 Class[thesis,book]{thesis}
7252 \end_layout
7253
7254 \begin_layout Standard
7255 If, on the other hand, the new class is not based upon an existing class,
7256  you will probably have to
7257 \begin_inset Quotes eld
7258 \end_inset
7259
7260 roll your own
7261 \begin_inset Quotes erd
7262 \end_inset
7263
7264  layout.
7265  We strongly suggest copying an existing layout file which uses a similar
7266  \SpecialChar LaTeX
7267  class and then modifying it, if you can do so.
7268  At least use an existing file as a starting point so you can find out what
7269  items you need to worry about.
7270  Again, the specifics are covered below.
7271 \end_layout
7272
7273 \begin_layout Subsection
7274 Creating templates
7275 \begin_inset CommandInset label
7276 LatexCommand label
7277 name "subsec:Creating-Templates"
7278
7279 \end_inset
7280
7281
7282 \end_layout
7283
7284 \begin_layout Standard
7285 Once you have written a layout file for a new document class, you might
7286  want to consider writing a
7287 \emph on
7288 template
7289 \emph default
7290  for it, too.
7291  A template acts as a kind of tutorial for your layout, showing how it might
7292  be used, though containing dummy content.
7293  You can of course look at the various templates included with \SpecialChar LyX
7294  for ideas.
7295 \end_layout
7296
7297 \begin_layout Standard
7298 Templates are created just like usual documents: using \SpecialChar LyX
7299 .
7300  The only difference is that usual documents contain all possible settings,
7301  including the font scheme and the paper size.
7302  Usually a user doesn't want a template to overwrite his preferred settings
7303  for such parameters.
7304  For that reason, the designer of a template should remove the corresponding
7305  commands like
7306 \begin_inset Flex Code
7307 status collapsed
7308
7309 \begin_layout Plain Layout
7310
7311 \backslash
7312 font_roman
7313 \end_layout
7314
7315 \end_inset
7316
7317  or
7318 \begin_inset Flex Code
7319 status collapsed
7320
7321 \begin_layout Plain Layout
7322
7323 \backslash
7324 papersize
7325 \end_layout
7326
7327 \end_inset
7328
7329  from the template \SpecialChar LyX
7330  file.
7331  This can be done with any simple text-editor, for example
7332 \begin_inset Flex Code
7333 status collapsed
7334
7335 \begin_layout Plain Layout
7336 vi
7337 \end_layout
7338
7339 \end_inset
7340
7341  or
7342 \begin_inset Flex Code
7343 status collapsed
7344
7345 \begin_layout Plain Layout
7346 notepad
7347 \end_layout
7348
7349 \end_inset
7350
7351 .
7352 \end_layout
7353
7354 \begin_layout Standard
7355 Put the edited template files you create in
7356 \begin_inset Flex Code
7357 status collapsed
7358
7359 \begin_layout Plain Layout
7360 UserDir/templates/
7361 \end_layout
7362
7363 \end_inset
7364
7365 , copy the ones you use from the global template directory in
7366 \begin_inset Flex Code
7367 status collapsed
7368
7369 \begin_layout Plain Layout
7370 LyXDir/templates/
7371 \end_layout
7372
7373 \end_inset
7374
7375  to the same place, and redefine the template path in the
7376 \begin_inset Flex MenuItem
7377 status collapsed
7378
7379 \begin_layout Plain Layout
7380 Tools\SpecialChar menuseparator
7381 Preferences\SpecialChar menuseparator
7382 Paths
7383 \end_layout
7384
7385 \end_inset
7386
7387  dialog.
7388 \end_layout
7389
7390 \begin_layout Standard
7391 Note, by the way, that there is a template which has a particular meaning:
7392
7393 \begin_inset Flex Code
7394 status collapsed
7395
7396 \begin_layout Plain Layout
7397 defaults.lyx
7398 \end_layout
7399
7400 \end_inset
7401
7402 .
7403  This template is loaded every time you create a new document with
7404 \begin_inset Flex MenuItem
7405 status collapsed
7406
7407 \begin_layout Plain Layout
7408 File\SpecialChar menuseparator
7409 New
7410 \end_layout
7411
7412 \end_inset
7413
7414  in order to provide useful defaults.
7415  To create this template from inside \SpecialChar LyX
7416 , all you have to do is to open a document
7417  with the correct settings, and use the
7418 \begin_inset Flex MenuItem
7419 status collapsed
7420
7421 \begin_layout Plain Layout
7422 Save as Document Defaults
7423 \end_layout
7424
7425 \end_inset
7426
7427  button.
7428 \end_layout
7429
7430 \begin_layout Subsection
7431 Upgrading old layout files
7432 \end_layout
7433
7434 \begin_layout Standard
7435 The format of layout files changes with each \SpecialChar LyX
7436  release, so old layout files
7437  need to be converted to the new format.
7438  If \SpecialChar LyX
7439  reads a layout file in an older format, it automatically calls the
7440  script
7441 \begin_inset Flex Code
7442 status collapsed
7443
7444 \begin_layout Plain Layout
7445 layout2layout.py
7446 \end_layout
7447
7448 \end_inset
7449
7450  to convert it to a temporary file in current format.
7451  The original file is left untouched.
7452  If you use the layout file often, then, you may want to convert it permanently,
7453  so that \SpecialChar LyX
7454  does not have to do so itself every time.
7455  To do this, you can call the converter manually:
7456 \end_layout
7457
7458 \begin_layout Enumerate
7459 rename the file
7460 \begin_inset Flex Code
7461 status collapsed
7462
7463 \begin_layout Plain Layout
7464 myclass.layout
7465 \end_layout
7466
7467 \end_inset
7468
7469  to
7470 \begin_inset Flex Code
7471 status collapsed
7472
7473 \begin_layout Plain Layout
7474 myclass.old
7475 \end_layout
7476
7477 \end_inset
7478
7479
7480 \end_layout
7481
7482 \begin_layout Enumerate
7483 Call the command
7484 \begin_inset Newline newline
7485 \end_inset
7486
7487
7488 \begin_inset Flex Code
7489 status collapsed
7490
7491 \begin_layout Plain Layout
7492 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7493 \end_layout
7494
7495 \end_inset
7496
7497
7498 \begin_inset Newline newline
7499 \end_inset
7500
7501 where
7502 \begin_inset Flex Code
7503 status collapsed
7504
7505 \begin_layout Plain Layout
7506 LyXDir
7507 \end_layout
7508
7509 \end_inset
7510
7511  is the name of your \SpecialChar LyX
7512  system directory.
7513 \end_layout
7514
7515 \begin_layout Standard
7516 Note that manual conversion does not affect included files, so these will
7517  have to be converted separately.
7518 \end_layout
7519
7520 \begin_layout Section
7521 \begin_inset CommandInset label
7522 LatexCommand label
7523 name "sec:TextClass"
7524
7525 \end_inset
7526
7527 The layout file format
7528 \end_layout
7529
7530 \begin_layout Standard
7531 The following sections describe how layout files are structured and written.
7532  Our advice is to go slowly, save and test often.
7533  It is really not that hard, except that the multitude of options can become
7534  overwhelming, especially if you try to check out too many at once.
7535  It becomes easier if you use existing layouts of \SpecialChar LyX
7536  as examples/reference
7537  or if you modify an existing layout to your needs.
7538 \end_layout
7539
7540 \begin_layout Standard
7541 Note that all the tags used in layout files are case-insensitive.
7542  This means that
7543 \begin_inset Flex Code
7544 status collapsed
7545
7546 \begin_layout Plain Layout
7547 Style
7548 \end_layout
7549
7550 \end_inset
7551
7552 ,
7553 \begin_inset Flex Code
7554 status collapsed
7555
7556 \begin_layout Plain Layout
7557 style
7558 \end_layout
7559
7560 \end_inset
7561
7562  and
7563 \begin_inset Flex Code
7564 status collapsed
7565
7566 \begin_layout Plain Layout
7567 StYlE
7568 \end_layout
7569
7570 \end_inset
7571
7572  are really the same tag.
7573  The possible arguments are printed in brackets after the tag's name.
7574  The default argument is typeset
7575 \begin_inset Flex Code
7576 status collapsed
7577
7578 \begin_layout Plain Layout
7579
7580 \emph on
7581 emphasized
7582 \end_layout
7583
7584 \end_inset
7585
7586 .
7587  If the argument has a data type like
7588 \begin_inset Quotes eld
7589 \end_inset
7590
7591 string
7592 \begin_inset Quotes erd
7593 \end_inset
7594
7595  or
7596 \begin_inset Quotes eld
7597 \end_inset
7598
7599 float
7600 \begin_inset Quotes erd
7601 \end_inset
7602
7603 , the default is shown like this:
7604 \begin_inset Flex Code
7605 status collapsed
7606
7607 \begin_layout Plain Layout
7608 float=
7609 \emph on
7610 default
7611 \end_layout
7612
7613 \end_inset
7614
7615 .
7616 \end_layout
7617
7618 \begin_layout Subsection
7619 The document class declaration and classification
7620 \end_layout
7621
7622 \begin_layout Standard
7623 Lines in a layout file which begin with
7624 \begin_inset Flex Code
7625 status collapsed
7626
7627 \begin_layout Plain Layout
7628 #
7629 \end_layout
7630
7631 \end_inset
7632
7633  are comments.
7634  There is one exception to this rule.
7635  All
7636 \begin_inset Flex Code
7637 status collapsed
7638
7639 \begin_layout Plain Layout
7640 *.layout
7641 \end_layout
7642
7643 \end_inset
7644
7645  files should begin with lines like:
7646 \end_layout
7647
7648 \begin_layout LyX-Code
7649
7650 \size small
7651 #% Do not delete the line below; configure depends on this
7652 \end_layout
7653
7654 \begin_layout LyX-Code
7655
7656 \size small
7657 #
7658 \backslash
7659 DeclareLaTeXClass{Article (Standard Class)}
7660 \end_layout
7661
7662 \begin_layout LyX-Code
7663
7664 \size small
7665 #
7666 \backslash
7667 DeclareCategory{Articles}
7668 \end_layout
7669
7670 \begin_layout Standard
7671 The second and third lines are used when you (re)configure \SpecialChar LyX
7672 .
7673  The layout file is read by the \SpecialChar LaTeX
7674  script
7675 \begin_inset Flex Code
7676 status collapsed
7677
7678 \begin_layout Plain Layout
7679 chkconfig.ltx
7680 \end_layout
7681
7682 \end_inset
7683
7684 , in a special mode where
7685 \begin_inset Flex Code
7686 status collapsed
7687
7688 \begin_layout Plain Layout
7689 #
7690 \end_layout
7691
7692 \end_inset
7693
7694  is ignored.
7695  The first line is just a \SpecialChar LaTeX
7696  comment, the second one contains the mandatory
7697  declaration of the text class and the third line contains the optional
7698  classification of the class.
7699  If these lines appear in a file named
7700 \begin_inset Flex Code
7701 status collapsed
7702
7703 \begin_layout Plain Layout
7704 article.layout
7705 \end_layout
7706
7707 \end_inset
7708
7709 , then they define a text class of name
7710 \begin_inset Flex Code
7711 status collapsed
7712
7713 \begin_layout Plain Layout
7714 article
7715 \end_layout
7716
7717 \end_inset
7718
7719  (the name of the layout file) which uses the \SpecialChar LaTeX
7720  document class
7721 \begin_inset Flex Code
7722 status collapsed
7723
7724 \begin_layout Plain Layout
7725 article.cls
7726 \end_layout
7727
7728 \end_inset
7729
7730  (the default is to use the same name as the layout).
7731  The string
7732 \begin_inset Quotes eld
7733 \end_inset
7734
7735 Article (Standard Class)
7736 \begin_inset Quotes erd
7737 \end_inset
7738
7739  that appears above is used as a description of the text class in the
7740 \begin_inset Flex MenuItem
7741 status collapsed
7742
7743 \begin_layout Plain Layout
7744 Document\SpecialChar menuseparator
7745 Settings
7746 \end_layout
7747
7748 \end_inset
7749
7750  dialog.
7751  The category (
7752 \begin_inset Quotes eld
7753 \end_inset
7754
7755 Articles
7756 \begin_inset Quotes erd
7757 \end_inset
7758
7759  in the example) is also used in the
7760 \begin_inset Flex MenuItem
7761 status collapsed
7762
7763 \begin_layout Plain Layout
7764 Document\SpecialChar menuseparator
7765 Settings
7766 \end_layout
7767
7768 \end_inset
7769
7770  dialog: the text classes are grouped by these categories (which are usually
7771  genres, so typical categories are
7772 \begin_inset Quotes eld
7773 \end_inset
7774
7775 Articles
7776 \begin_inset Quotes erd
7777 \end_inset
7778
7779 ,
7780 \begin_inset Quotes eld
7781 \end_inset
7782
7783 Books
7784 \begin_inset Quotes erd
7785 \end_inset
7786
7787 ,
7788 \begin_inset Quotes eld
7789 \end_inset
7790
7791 Reports
7792 \begin_inset Quotes erd
7793 \end_inset
7794
7795 ,
7796 \begin_inset Quotes eld
7797 \end_inset
7798
7799 Letters
7800 \begin_inset Quotes erd
7801 \end_inset
7802
7803 ,
7804 \begin_inset Quotes eld
7805 \end_inset
7806
7807 Presentations
7808 \begin_inset Quotes erd
7809 \end_inset
7810
7811 ,
7812 \begin_inset Quotes eld
7813 \end_inset
7814
7815 Curricula Vitae
7816 \begin_inset Quotes erd
7817 \end_inset
7818
7819  etc.).
7820  If no category has been declared, the class will be put in the
7821 \begin_inset Quotes eld
7822 \end_inset
7823
7824 Uncategorized
7825 \begin_inset Quotes erd
7826 \end_inset
7827
7828  group.
7829 \end_layout
7830
7831 \begin_layout Standard
7832 Let's assume that you wrote your own text class that uses the
7833 \begin_inset Flex Code
7834 status collapsed
7835
7836 \begin_layout Plain Layout
7837 article.cls
7838 \end_layout
7839
7840 \end_inset
7841
7842  document class, but where you changed the appearance of the section headings.
7843  If you put it in a file
7844 \begin_inset Flex Code
7845 status collapsed
7846
7847 \begin_layout Plain Layout
7848 myarticle.layout
7849 \end_layout
7850
7851 \end_inset
7852
7853 , the header of this file should be:
7854 \end_layout
7855
7856 \begin_layout LyX-Code
7857
7858 \size small
7859 #% Do not delete the line below; configure depends on this
7860 \end_layout
7861
7862 \begin_layout LyX-Code
7863
7864 \size small
7865 #
7866 \backslash
7867 DeclareLaTeXClass[article]{Article (with My Own Headings)}
7868 \end_layout
7869
7870 \begin_layout LyX-Code
7871
7872 \size small
7873 #
7874 \backslash
7875 DeclareCategory{Articles}
7876 \end_layout
7877
7878 \begin_layout Standard
7879 This declares a text class
7880 \begin_inset Flex Code
7881 status collapsed
7882
7883 \begin_layout Plain Layout
7884 myarticle
7885 \end_layout
7886
7887 \end_inset
7888
7889 , associated with the \SpecialChar LaTeX
7890  document class
7891 \begin_inset Flex Code
7892 status collapsed
7893
7894 \begin_layout Plain Layout
7895 article.cls
7896 \end_layout
7897
7898 \end_inset
7899
7900  and described as
7901 \begin_inset Quotes eld
7902 \end_inset
7903
7904 Article (with My Own Headings)
7905 \begin_inset Quotes erd
7906 \end_inset
7907
7908 .
7909  If your text class depends on several packages, you can declare it as:
7910 \end_layout
7911
7912 \begin_layout LyX-Code
7913
7914 \size small
7915 #% Do not delete the line below; configure depends on this
7916 \end_layout
7917
7918 \begin_layout LyX-Code
7919
7920 \size small
7921 #
7922 \backslash
7923 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
7924 \end_layout
7925
7926 \begin_layout LyX-Code
7927
7928 \size small
7929 #
7930 \backslash
7931 DeclareCategory{Articles}
7932 \end_layout
7933
7934 \begin_layout Standard
7935 This indicates that your text class uses the
7936 \begin_inset Flex Code
7937 status collapsed
7938
7939 \begin_layout Plain Layout
7940 foo.sty
7941 \end_layout
7942
7943 \end_inset
7944
7945  package.
7946  Finally, it is also possible to declare classes for DocBook code.
7947  Typical declarations will look like:
7948 \end_layout
7949
7950 \begin_layout LyX-Code
7951
7952 \size small
7953 #% Do not delete the line below; configure depends on this
7954 \end_layout
7955
7956 \begin_layout LyX-Code
7957
7958 \size small
7959 #
7960 \backslash
7961 DeclareDocBookClass[article]{SGML (DocBook Article)}
7962 \end_layout
7963
7964 \begin_layout LyX-Code
7965
7966 \size small
7967 #
7968 \backslash
7969 DeclareCategory{Articles (DocBook)}
7970 \end_layout
7971
7972 \begin_layout Standard
7973 Note that these declarations can also be given an optional parameter declaring
7974  the name of the document class (but not a list).
7975 \end_layout
7976
7977 \begin_layout Standard
7978 So, to be as explicit as possible, the form of the layout declaration is:
7979 \end_layout
7980
7981 \begin_layout LyX-Code
7982
7983 \size small
7984 #
7985 \backslash
7986 DeclareLaTeXClass[class,package.sty]{layout description}
7987 \end_layout
7988
7989 \begin_layout LyX-Code
7990
7991 \size small
7992 #
7993 \backslash
7994 DeclareCategory{category}
7995 \end_layout
7996
7997 \begin_layout Standard
7998 The class need only be specified if the name of the \SpecialChar LaTeX
7999  class file and the
8000  name of the layout file are different or if there are packages to load.
8001  If the name of the class file is not specified, then \SpecialChar LyX
8002  will simply assume
8003  that it is the same as the name of the layout file.
8004 \end_layout
8005
8006 \begin_layout Standard
8007 When the text class has been modified to your taste, all you have to do
8008  is to copy it either to
8009 \begin_inset Flex Code
8010 status collapsed
8011
8012 \begin_layout Plain Layout
8013 LyXDir/layouts/
8014 \end_layout
8015
8016 \end_inset
8017
8018  or to
8019 \begin_inset Flex Code
8020 status collapsed
8021
8022 \begin_layout Plain Layout
8023 UserDir/layouts
8024 \end_layout
8025
8026 \end_inset
8027
8028 , run
8029 \begin_inset Flex MenuItem
8030 status collapsed
8031
8032 \begin_layout Plain Layout
8033 Tools\SpecialChar menuseparator
8034 Reconfigure
8035 \end_layout
8036
8037 \end_inset
8038
8039 , exit \SpecialChar LyX
8040  and restart.
8041  Then your new text class should be available along with the others.
8042 \end_layout
8043
8044 \begin_layout Standard
8045 Once the layout file is installed, you can edit it and see your changes
8046  without having to reconfigure or to restart \SpecialChar LyX
8047 .
8048
8049 \begin_inset Foot
8050 status collapsed
8051
8052 \begin_layout Plain Layout
8053 In versions of \SpecialChar LyX
8054  prior to 1.6, this was not true.
8055  As a result, editing layout files was very time consuming, since you had
8056  constantly to restart \SpecialChar LyX
8057  to see changes.
8058 \end_layout
8059
8060 \end_inset
8061
8062  You can force a reload of the current layout by using the \SpecialChar LyX
8063  function
8064 \begin_inset Flex MenuItem
8065 status collapsed
8066
8067 \begin_layout Plain Layout
8068 layout-reload
8069 \end_layout
8070
8071 \end_inset
8072
8073 .
8074  There is no default binding for this function—though, of course, you can
8075  bind it to a key yourself.
8076  But you will normally use this function simply by entering it in the mini-buffe
8077 r.
8078
8079 \end_layout
8080
8081 \begin_layout Standard
8082
8083 \emph on
8084 Warning
8085 \emph default
8086 :
8087 \begin_inset Flex MenuItem
8088 status collapsed
8089
8090 \begin_layout Plain Layout
8091 layout-reload
8092 \end_layout
8093
8094 \end_inset
8095
8096  is very much an `advanced feature'.
8097  It is
8098 \emph on
8099 strongly
8100 \emph default
8101  recommended that you save your work before using this function.
8102  In fact, it is
8103 \emph on
8104 strongly
8105 \emph default
8106  recommended that you not attempt to edit layout information while simultaneousl
8107 y working on a document that you care about.
8108  Use a test document.
8109  Syntax errors and the like in your layout file could cause peculiar behavior.
8110  In particular, such errors could cause \SpecialChar LyX
8111  to regard the current layout as
8112  invalid and to attempt to switch to some other layout.
8113 \begin_inset Foot
8114 status collapsed
8115
8116 \begin_layout Plain Layout
8117 Really bad syntax errors may even caused \SpecialChar LyX
8118  to exit.
8119  This is because certain sorts of errors may make \SpecialChar LyX
8120  unable to read
8121 \emph on
8122 any
8123 \emph default
8124  layout information.
8125  Please be careful.
8126 \end_layout
8127
8128 \end_inset
8129
8130  The \SpecialChar LyX
8131  team strives to keep \SpecialChar LyX
8132  stable in such situations, but safe is better
8133  than sorry.
8134 \begin_inset Foot
8135 status collapsed
8136
8137 \begin_layout Plain Layout
8138 While we're giving advice: make regular backups.
8139  And be nice to your mother.
8140 \end_layout
8141
8142 \end_inset
8143
8144
8145 \end_layout
8146
8147 \begin_layout Subsection
8148 The Module declaration
8149 \end_layout
8150
8151 \begin_layout Standard
8152 A module must begin with a line like the following:
8153 \end_layout
8154
8155 \begin_layout LyX-Code
8156 #
8157 \backslash
8158 DeclareLyXModule[endnotes.sty]{Endnotes}
8159 \end_layout
8160
8161 \begin_layout Standard
8162 The mandatory argument, in curly brackets, is the name of the module, as
8163  it should appear in
8164 \begin_inset Flex MenuItem
8165 status collapsed
8166
8167 \begin_layout Plain Layout
8168 Document\SpecialChar menuseparator
8169 Settings\SpecialChar menuseparator
8170 Modules
8171 \end_layout
8172
8173 \end_inset
8174
8175 .
8176  The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8177  packages
8178  on which the module depends.
8179  It is also possible to use the form
8180 \begin_inset Flex MenuItem
8181 status collapsed
8182
8183 \begin_layout Plain Layout
8184 from->to
8185 \end_layout
8186
8187 \end_inset
8188
8189  as an optional argument, which declares that the module can only be used
8190  when there exists a conversion chain between the formats `
8191 \begin_inset Flex Code
8192 status collapsed
8193
8194 \begin_layout Plain Layout
8195 from
8196 \end_layout
8197
8198 \end_inset
8199
8200 ' and `
8201 \begin_inset Flex Code
8202 status collapsed
8203
8204 \begin_layout Plain Layout
8205 to
8206 \end_layout
8207
8208 \end_inset
8209
8210 '.
8211 \end_layout
8212
8213 \begin_layout Standard
8214 The module declaration should then be followed by lines like the following
8215 \begin_inset Foot
8216 status collapsed
8217
8218 \begin_layout Plain Layout
8219 Preferably in English if the module should be published with \SpecialChar LyX
8220 .
8221  This description will appear in the list of messages to be translated and
8222  will be thus translated with the next interface update.
8223 \end_layout
8224
8225 \end_inset
8226
8227 :
8228 \end_layout
8229
8230 \begin_layout LyX-Code
8231 #DescriptionBegin
8232 \end_layout
8233
8234 \begin_layout LyX-Code
8235 #Adds an endnote command, in addition to footnotes.
8236
8237 \end_layout
8238
8239 \begin_layout LyX-Code
8240 #You will need to add
8241 \backslash
8242 theendnotes in TeX code where you
8243 \end_layout
8244
8245 \begin_layout LyX-Code
8246 #want the endnotes to appear.
8247
8248 \end_layout
8249
8250 \begin_layout LyX-Code
8251 #DescriptionEnd
8252 \end_layout
8253
8254 \begin_layout LyX-Code
8255 #Requires: somemodule | othermodule
8256 \end_layout
8257
8258 \begin_layout LyX-Code
8259 #Excludes: badmodule
8260 \end_layout
8261
8262 \begin_layout Standard
8263 The description is used in
8264 \begin_inset Flex MenuItem
8265 status collapsed
8266
8267 \begin_layout Plain Layout
8268 Document\SpecialChar menuseparator
8269 Settings\SpecialChar menuseparator
8270 Modules
8271 \end_layout
8272
8273 \end_inset
8274
8275  to provide the user with information about what the module does.
8276  The
8277 \begin_inset Flex Code
8278 status collapsed
8279
8280 \begin_layout Plain Layout
8281 Requires
8282 \end_layout
8283
8284 \end_inset
8285
8286  line is used to identify other modules with which this one must be used;
8287  the
8288 \begin_inset Flex Code
8289 status collapsed
8290
8291 \begin_layout Plain Layout
8292 Excludes
8293 \end_layout
8294
8295 \end_inset
8296
8297  line is used to identify modules with which this one may not be used.
8298  Both are optional, and, as shown, multiple modules should be separated
8299  with the pipe symbol: |.
8300  Note that the required modules are treated disjunctively:
8301 \emph on
8302 at least one
8303 \emph default
8304  of the required modules must be used.
8305  Similarly,
8306 \emph on
8307 no
8308 \emph default
8309  excluded module may be used.
8310  Note that modules are identified here by their filenames without the
8311 \begin_inset Flex Code
8312 status collapsed
8313
8314 \begin_layout Plain Layout
8315 .module
8316 \end_layout
8317
8318 \end_inset
8319
8320  extension.
8321  So
8322 \begin_inset Flex Code
8323 status collapsed
8324
8325 \begin_layout Plain Layout
8326 somemodule
8327 \end_layout
8328
8329 \end_inset
8330
8331  is really
8332 \begin_inset Flex Code
8333 status collapsed
8334
8335 \begin_layout Plain Layout
8336 somemodule.module
8337 \end_layout
8338
8339 \end_inset
8340
8341 .
8342 \end_layout
8343
8344 \begin_layout Subsection
8345 Format number
8346 \end_layout
8347
8348 \begin_layout Standard
8349 The first non-comment line of any layout file, included file, or module
8350
8351 \emph on
8352 must
8353 \emph default
8354  contain the file format number:
8355 \end_layout
8356
8357 \begin_layout Description
8358 \begin_inset Flex Code
8359 status collapsed
8360
8361 \begin_layout Plain Layout
8362 Format
8363 \end_layout
8364
8365 \end_inset
8366
8367  [
8368 \begin_inset Flex Code
8369 status collapsed
8370
8371 \begin_layout Plain Layout
8372 int
8373 \end_layout
8374
8375 \end_inset
8376
8377 ] The format number of the layout file.
8378 \end_layout
8379
8380 \begin_layout Standard
8381 This tag was introduced with \SpecialChar LyX
8382
8383 \begin_inset space ~
8384 \end_inset
8385
8386 1.4.0.
8387  Layout files from older \SpecialChar LyX
8388  versions do not have an explicit file format and
8389  are considered to have
8390 \begin_inset Flex Code
8391 status collapsed
8392
8393 \begin_layout Plain Layout
8394 Format
8395 \begin_inset space ~
8396 \end_inset
8397
8398 1
8399 \end_layout
8400
8401 \end_inset
8402
8403 .
8404  The format for the present version of \SpecialChar LyX
8405  is format 35.
8406  But each version of \SpecialChar LyX
8407  is capable of reading earlier versions' layout files,
8408  just as they are capable of reading files produced by earlier versions
8409  of \SpecialChar LyX
8410 .
8411  There is, however, no provision for converting to earlier formats.
8412 \end_layout
8413
8414 \begin_layout Subsection
8415 \begin_inset CommandInset label
8416 LatexCommand label
8417 name "subsec:General-text-class"
8418
8419 \end_inset
8420
8421 General text class parameters
8422 \end_layout
8423
8424 \begin_layout Standard
8425 These are general parameters that govern the behavior of an entire document
8426  class.
8427  (This does
8428 \emph on
8429 not
8430 \emph default
8431  mean that they must appear in
8432 \begin_inset Flex Code
8433 status collapsed
8434
8435 \begin_layout Plain Layout
8436 .layout
8437 \end_layout
8438
8439 \end_inset
8440
8441  files rather than in modules.
8442  A module can contain any layout tag.)
8443 \end_layout
8444
8445 \begin_layout Description
8446 \begin_inset Flex Code
8447 status collapsed
8448
8449 \begin_layout Plain Layout
8450 AddToHTMLPreamble
8451 \end_layout
8452
8453 \end_inset
8454
8455  Adds information that will be output in the
8456 \begin_inset Flex Code
8457 status collapsed
8458
8459 \begin_layout Plain Layout
8460 <head>
8461 \end_layout
8462
8463 \end_inset
8464
8465  block when the document is output to XHTML.
8466  Typically, this would be used to output CSS style information, but it can
8467  be used for anything that can appear in
8468 \begin_inset Flex Code
8469 status collapsed
8470
8471 \begin_layout Plain Layout
8472 <head>
8473 \end_layout
8474
8475 \end_inset
8476
8477 .
8478  Must end with
8479 \begin_inset Quotes eld
8480 \end_inset
8481
8482
8483 \begin_inset Flex Code
8484 status collapsed
8485
8486 \begin_layout Plain Layout
8487 EndPreamble
8488 \end_layout
8489
8490 \end_inset
8491
8492
8493 \begin_inset Quotes erd
8494 \end_inset
8495
8496 .
8497 \end_layout
8498
8499 \begin_layout Description
8500 \begin_inset Flex Code
8501 status collapsed
8502
8503 \begin_layout Plain Layout
8504 AddToPreamble
8505 \end_layout
8506
8507 \end_inset
8508
8509  Adds information to the document preamble.
8510  Must end with
8511 \begin_inset Newline newline
8512 \end_inset
8513
8514
8515 \begin_inset Quotes eld
8516 \end_inset
8517
8518
8519 \begin_inset Flex Code
8520 status collapsed
8521
8522 \begin_layout Plain Layout
8523 EndPreamble
8524 \end_layout
8525
8526 \end_inset
8527
8528
8529 \begin_inset Quotes erd
8530 \end_inset
8531
8532 .
8533 \end_layout
8534
8535 \begin_layout Description
8536 \begin_inset Flex Code
8537 status collapsed
8538
8539 \begin_layout Plain Layout
8540 CiteFormat
8541 \end_layout
8542
8543 \end_inset
8544
8545  Defines formats for use in the display of bibliographic information.
8546  See
8547 \begin_inset CommandInset ref
8548 LatexCommand ref
8549 reference "subsec:Citation-format-description"
8550
8551 \end_inset
8552
8553  for details.
8554  Must end with
8555 \begin_inset Quotes eld
8556 \end_inset
8557
8558
8559 \begin_inset Flex Code
8560 status collapsed
8561
8562 \begin_layout Plain Layout
8563 End
8564 \end_layout
8565
8566 \end_inset
8567
8568
8569 \begin_inset Quotes erd
8570 \end_inset
8571
8572 .
8573 \end_layout
8574
8575 \begin_layout Description
8576 \begin_inset Flex Code
8577 status collapsed
8578
8579 \begin_layout Plain Layout
8580 ClassOptions
8581 \end_layout
8582
8583 \end_inset
8584
8585  Describes various global options supported by the document class.
8586  See
8587 \begin_inset CommandInset ref
8588 LatexCommand ref
8589 reference "subsec:ClassOptions"
8590
8591 \end_inset
8592
8593  for a description.
8594  Must end with
8595 \begin_inset Quotes eld
8596 \end_inset
8597
8598
8599 \begin_inset Flex Code
8600 status collapsed
8601
8602 \begin_layout Plain Layout
8603 End
8604 \end_layout
8605
8606 \end_inset
8607
8608
8609 \begin_inset Quotes erd
8610 \end_inset
8611
8612 .
8613 \end_layout
8614
8615 \begin_layout Description
8616 \begin_inset Flex Code
8617 status collapsed
8618
8619 \begin_layout Plain Layout
8620 Columns
8621 \end_layout
8622
8623 \end_inset
8624
8625  [
8626 \begin_inset Flex Code
8627 status collapsed
8628
8629 \begin_layout Plain Layout
8630
8631 \emph on
8632 1
8633 \end_layout
8634
8635 \end_inset
8636
8637 ,
8638 \begin_inset space \thinspace{}
8639 \end_inset
8640
8641
8642 \begin_inset Flex Code
8643 status collapsed
8644
8645 \begin_layout Plain Layout
8646 2
8647 \end_layout
8648
8649 \end_inset
8650
8651 ] Whether the class should
8652 \emph on
8653 default
8654 \emph default
8655  to having one or two columns.
8656  Can be changed in the
8657 \begin_inset Flex MenuItem
8658 status collapsed
8659
8660 \begin_layout Plain Layout
8661 Document\SpecialChar menuseparator
8662 Settings
8663 \end_layout
8664
8665 \end_inset
8666
8667  dialog.
8668 \end_layout
8669
8670 \begin_layout Description
8671 \begin_inset Flex Code
8672 status collapsed
8673
8674 \begin_layout Plain Layout
8675 Counter
8676 \end_layout
8677
8678 \end_inset
8679
8680  [
8681 \begin_inset Flex Code
8682 status collapsed
8683
8684 \begin_layout Plain Layout
8685 string
8686 \end_layout
8687
8688 \end_inset
8689
8690 ] This sequence defines the properties for a counter.
8691  If the counter does not yet exist, it is created; if it does exist, it
8692  is modified.
8693  Must end with
8694 \begin_inset Quotes eld
8695 \end_inset
8696
8697
8698 \begin_inset Flex Code
8699 status collapsed
8700
8701 \begin_layout Plain Layout
8702 End
8703 \end_layout
8704
8705 \end_inset
8706
8707
8708 \begin_inset Quotes erd
8709 \end_inset
8710
8711 .
8712 \begin_inset Newline newline
8713 \end_inset
8714
8715 See
8716 \begin_inset CommandInset ref
8717 LatexCommand ref
8718 reference "subsec:Counters"
8719
8720 \end_inset
8721
8722  for details on counters.
8723 \end_layout
8724
8725 \begin_layout Description
8726 \begin_inset Flex Code
8727 status collapsed
8728
8729 \begin_layout Plain Layout
8730 DefaultFont
8731 \end_layout
8732
8733 \end_inset
8734
8735  Sets the default font used to display the document.
8736  See
8737 \begin_inset CommandInset ref
8738 LatexCommand ref
8739 reference "subsec:Font-description"
8740
8741 \end_inset
8742
8743  for how to declare fonts.
8744  Must end with
8745 \begin_inset Quotes eld
8746 \end_inset
8747
8748
8749 \begin_inset Flex Code
8750 status collapsed
8751
8752 \begin_layout Plain Layout
8753 EndFont
8754 \end_layout
8755
8756 \end_inset
8757
8758
8759 \begin_inset Quotes erd
8760 \end_inset
8761
8762 .
8763 \end_layout
8764
8765 \begin_layout Description
8766 \begin_inset Flex Code
8767 status collapsed
8768
8769 \begin_layout Plain Layout
8770 DefaultModule
8771 \end_layout
8772
8773 \end_inset
8774
8775  [
8776 \begin_inset Flex Code
8777 status collapsed
8778
8779 \begin_layout Plain Layout
8780 <module>
8781 \end_layout
8782
8783 \end_inset
8784
8785 ] Specifies a module to be included by default with this document class.
8786  The module is specified as filename without the
8787 \begin_inset Flex Code
8788 status collapsed
8789
8790 \begin_layout Plain Layout
8791 .module
8792 \end_layout
8793
8794 \end_inset
8795
8796  extension.
8797  The user can still remove the module, but it will be active at the outset.
8798  (This applies only when new files are created, or when this class is chosen
8799  for an existing document.)
8800 \end_layout
8801
8802 \begin_layout Description
8803 \begin_inset Flex Code
8804 status collapsed
8805
8806 \begin_layout Plain Layout
8807 DefaultStyle
8808 \end_layout
8809
8810 \end_inset
8811
8812  [
8813 \begin_inset Flex Code
8814 status collapsed
8815
8816 \begin_layout Plain Layout
8817 <style>
8818 \end_layout
8819
8820 \end_inset
8821
8822 ] This is the style that will be assigned to new paragraphs, usually
8823 \begin_inset Flex MenuItem
8824 status collapsed
8825
8826 \begin_layout Plain Layout
8827 Standard
8828 \end_layout
8829
8830 \end_inset
8831
8832 .
8833  This will default to the first defined style if not given, but you are
8834  encouraged to use this directive.
8835 \end_layout
8836
8837 \begin_layout Description
8838 \begin_inset Flex Code
8839 status collapsed
8840
8841 \begin_layout Plain Layout
8842 ExcludesModule
8843 \end_layout
8844
8845 \end_inset
8846
8847  [
8848 \begin_inset Flex Code
8849 status collapsed
8850
8851 \begin_layout Plain Layout
8852 <module>
8853 \end_layout
8854
8855 \end_inset
8856
8857 ] This tag indicates that the module (which is specified by filename without
8858  the
8859 \begin_inset Flex Code
8860 status collapsed
8861
8862 \begin_layout Plain Layout
8863 .module
8864 \end_layout
8865
8866 \end_inset
8867
8868  extension) cannot be used with this document class.
8869  This might be used in a journal-specific layout file to prevent, say, the
8870  use of the
8871 \begin_inset Flex Code
8872 status collapsed
8873
8874 \begin_layout Plain Layout
8875 theorems-sec
8876 \end_layout
8877
8878 \end_inset
8879
8880  module that numbers theorems by section.
8881  This tag may
8882 \emph on
8883 not
8884 \emph default
8885  be used in a module.
8886  Modules have their own way of excluding other modules (see
8887 \begin_inset CommandInset ref
8888 LatexCommand ref
8889 reference "subsec:Layout-modules"
8890
8891 \end_inset
8892
8893 ).
8894 \end_layout
8895
8896 \begin_layout Description
8897 \begin_inset Flex Code
8898 status collapsed
8899
8900 \begin_layout Plain Layout
8901 Float
8902 \end_layout
8903
8904 \end_inset
8905
8906  Defines a new float.
8907  See
8908 \begin_inset CommandInset ref
8909 LatexCommand ref
8910 reference "subsec:Floats"
8911
8912 \end_inset
8913
8914  for details.
8915  Must end with
8916 \begin_inset Quotes eld
8917 \end_inset
8918
8919
8920 \begin_inset Flex Code
8921 status collapsed
8922
8923 \begin_layout Plain Layout
8924 End
8925 \end_layout
8926
8927 \end_inset
8928
8929
8930 \begin_inset Quotes erd
8931 \end_inset
8932
8933 .
8934 \end_layout
8935
8936 \begin_layout Description
8937 \begin_inset Flex Code
8938 status collapsed
8939
8940 \begin_layout Plain Layout
8941 HTMLPreamble
8942 \end_layout
8943
8944 \end_inset
8945
8946  Sets the information that will be output in the
8947 \begin_inset Flex Code
8948 status collapsed
8949
8950 \begin_layout Plain Layout
8951 <head>
8952 \end_layout
8953
8954 \end_inset
8955
8956  block when this document class is output to XHTML.
8957  Note that this will completely override any prior
8958 \begin_inset Flex Code
8959 status collapsed
8960
8961 \begin_layout Plain Layout
8962 HTMLPreamble
8963 \end_layout
8964
8965 \end_inset
8966
8967  or
8968 \begin_inset Flex Code
8969 status collapsed
8970
8971 \begin_layout Plain Layout
8972 AddToHTMLPreamble
8973 \end_layout
8974
8975 \end_inset
8976
8977  declarations.
8978  (Use
8979 \begin_inset Newline newline
8980 \end_inset
8981
8982
8983 \begin_inset Flex Code
8984 status collapsed
8985
8986 \begin_layout Plain Layout
8987 AddToHTMLPreamble
8988 \end_layout
8989
8990 \end_inset
8991
8992  if you just want to add material to the preamble.) Must end with
8993 \begin_inset Quotes eld
8994 \end_inset
8995
8996
8997 \begin_inset Flex Code
8998 status collapsed
8999
9000 \begin_layout Plain Layout
9001 EndPreamble
9002 \end_layout
9003
9004 \end_inset
9005
9006
9007 \begin_inset Quotes erd
9008 \end_inset
9009
9010 .
9011 \end_layout
9012
9013 \begin_layout Description
9014 \begin_inset Flex Code
9015 status collapsed
9016
9017 \begin_layout Plain Layout
9018 HTMLTOCSection
9019 \end_layout
9020
9021 \end_inset
9022
9023  [
9024 \begin_inset Flex Code
9025 status collapsed
9026
9027 \begin_layout Plain Layout
9028 <style>
9029 \end_layout
9030
9031 \end_inset
9032
9033 ] The style to use for the table of contents, bibliography, and so forth,
9034  when the document is output to HTML.
9035  For articles, this should normally be
9036 \begin_inset Flex Code
9037 status collapsed
9038
9039 \begin_layout Plain Layout
9040 Section
9041 \end_layout
9042
9043 \end_inset
9044
9045 ; for books
9046 \begin_inset Flex Code
9047 status collapsed
9048
9049 \begin_layout Plain Layout
9050 Chapter
9051 \end_layout
9052
9053 \end_inset
9054
9055 .
9056  If it is not given, then \SpecialChar LyX
9057  will attempt to figure out which layout to use.
9058 \end_layout
9059
9060 \begin_layout Description
9061 \begin_inset Flex Code
9062 status collapsed
9063
9064 \begin_layout Plain Layout
9065 IfCounter
9066 \end_layout
9067
9068 \end_inset
9069
9070  [
9071 \begin_inset Flex Code
9072 status collapsed
9073
9074 \begin_layout Plain Layout
9075 <counter>
9076 \end_layout
9077
9078 \end_inset
9079
9080 ] Modifies the properties of the given counter.
9081  If the counter does not exist, the statement is ignored.
9082  Must end with
9083 \begin_inset Quotes eld
9084 \end_inset
9085
9086
9087 \begin_inset Flex Code
9088 status collapsed
9089
9090 \begin_layout Plain Layout
9091 End
9092 \end_layout
9093
9094 \end_inset
9095
9096
9097 \begin_inset Quotes erd
9098 \end_inset
9099
9100 .
9101 \begin_inset Newline newline
9102 \end_inset
9103
9104 See
9105 \begin_inset CommandInset ref
9106 LatexCommand ref
9107 reference "subsec:Counters"
9108
9109 \end_inset
9110
9111  for details on counters.
9112 \end_layout
9113
9114 \begin_layout Description
9115 \begin_inset Flex Code
9116 status collapsed
9117
9118 \begin_layout Plain Layout
9119 IfStyle
9120 \end_layout
9121
9122 \end_inset
9123
9124  [
9125 \begin_inset Flex Code
9126 status collapsed
9127
9128 \begin_layout Plain Layout
9129 <style>
9130 \end_layout
9131
9132 \end_inset
9133
9134 ] Modifies the properties of the given paragraph style.
9135  If the style does not exist, the statement is ignored.
9136  Must end with
9137 \begin_inset Quotes eld
9138 \end_inset
9139
9140
9141 \begin_inset Flex Code
9142 status collapsed
9143
9144 \begin_layout Plain Layout
9145 End
9146 \end_layout
9147
9148 \end_inset
9149
9150
9151 \begin_inset Quotes erd
9152 \end_inset
9153
9154 .
9155 \end_layout
9156
9157 \begin_layout Description
9158 \begin_inset Flex Code
9159 status collapsed
9160
9161 \begin_layout Plain Layout
9162 Input
9163 \end_layout
9164
9165 \end_inset
9166
9167  [
9168 \begin_inset Flex Code
9169 status collapsed
9170
9171 \begin_layout Plain Layout
9172 <filename>
9173 \end_layout
9174
9175 \end_inset
9176
9177 ] This allows you to include another layout definition file within yours
9178  to avoid duplicating commands.
9179  Common examples are the standard layout files, for example,
9180 \begin_inset Flex Code
9181 status collapsed
9182
9183 \begin_layout Plain Layout
9184 stdclass.inc
9185 \end_layout
9186
9187 \end_inset
9188
9189 , which contains most of the basic layouts.
9190 \end_layout
9191
9192 \begin_layout Description
9193 \begin_inset Flex Code
9194 status collapsed
9195
9196 \begin_layout Plain Layout
9197 InsetLayout
9198 \end_layout
9199
9200 \end_inset
9201
9202  [
9203 \begin_inset Flex Code
9204 status collapsed
9205
9206 \begin_layout Plain Layout
9207 <type>
9208 \end_layout
9209
9210 \end_inset
9211
9212 ] This section (re-)defines the layout of an inset.
9213  It can be applied to an existing inset or to a new, user-defined inset,
9214  e.g., a new character style.
9215  Must end with
9216 \begin_inset Quotes eld
9217 \end_inset
9218
9219
9220 \begin_inset Flex Code
9221 status collapsed
9222
9223 \begin_layout Plain Layout
9224 End
9225 \end_layout
9226
9227 \end_inset
9228
9229
9230 \begin_inset Quotes erd
9231 \end_inset
9232
9233 .
9234 \begin_inset Newline newline
9235 \end_inset
9236
9237 See
9238 \begin_inset CommandInset ref
9239 LatexCommand ref
9240 reference "subsec:Flex-insets-and"
9241
9242 \end_inset
9243
9244  for more information.
9245
9246 \end_layout
9247
9248 \begin_layout Description
9249 \begin_inset Flex Code
9250 status collapsed
9251
9252 \begin_layout Plain Layout
9253 LeftMargin
9254 \end_layout
9255
9256 \end_inset
9257
9258  [
9259 \begin_inset Flex Code
9260 status collapsed
9261
9262 \begin_layout Plain Layout
9263 string
9264 \end_layout
9265
9266 \end_inset
9267
9268 ] A string that indicates the width of the left margin on the screen, for
9269  example,
9270 \begin_inset Quotes eld
9271 \end_inset
9272
9273
9274 \begin_inset Flex Code
9275 status collapsed
9276
9277 \begin_layout Plain Layout
9278 MMMMM
9279 \end_layout
9280
9281 \end_inset
9282
9283
9284 \begin_inset Quotes erd
9285 \end_inset
9286
9287 .
9288  (Note that this is not a `length', like
9289 \begin_inset Quotes eld
9290 \end_inset
9291
9292 2ex
9293 \begin_inset Quotes erd
9294 \end_inset
9295
9296 .)
9297 \end_layout
9298
9299 \begin_layout Description
9300 \begin_inset Flex Code
9301 status collapsed
9302
9303 \begin_layout Plain Layout
9304 NoCounter
9305 \end_layout
9306
9307 \end_inset
9308
9309  [
9310 \begin_inset Flex Code
9311 status collapsed
9312
9313 \begin_layout Plain Layout
9314 <counter>
9315 \end_layout
9316
9317 \end_inset
9318
9319 ] Deletes an existing counter, usually one defined in an included file.
9320 \end_layout
9321
9322 \begin_layout Description
9323 \begin_inset Flex Code
9324 status collapsed
9325
9326 \begin_layout Plain Layout
9327 NoFloat
9328 \end_layout
9329
9330 \end_inset
9331
9332  [
9333 \begin_inset Flex Code
9334 status collapsed
9335
9336 \begin_layout Plain Layout
9337 <float>
9338 \end_layout
9339
9340 \end_inset
9341
9342 ] Deletes an existing float.
9343  This is particularly useful when you want to suppress a float that has
9344  been defined in an input file.
9345 \end_layout
9346
9347 \begin_layout Description
9348 \begin_inset Flex Code
9349 status collapsed
9350
9351 \begin_layout Plain Layout
9352 NoStyle
9353 \end_layout
9354
9355 \end_inset
9356
9357  [
9358 \begin_inset Flex Code
9359 status collapsed
9360
9361 \begin_layout Plain Layout
9362 <style>
9363 \end_layout
9364
9365 \end_inset
9366
9367 ] Deletes an existing style.
9368 \end_layout
9369
9370 \begin_layout Description
9371 \begin_inset Flex Code
9372 status collapsed
9373
9374 \begin_layout Plain Layout
9375 OutputFormat
9376 \end_layout
9377
9378 \end_inset
9379
9380  [
9381 \begin_inset Flex Code
9382 status collapsed
9383
9384 \begin_layout Plain Layout
9385 <format>
9386 \end_layout
9387
9388 \end_inset
9389
9390 ] The file format (as defined in the \SpecialChar LyX
9391  preferences) produced by this document
9392  class.
9393  It is mainly useful when
9394 \begin_inset Flex Code
9395 status collapsed
9396
9397 \begin_layout Plain Layout
9398 OutputType
9399 \end_layout
9400
9401 \end_inset
9402
9403  is
9404 \begin_inset Flex Code
9405 status collapsed
9406
9407 \begin_layout Plain Layout
9408 literate
9409 \end_layout
9410
9411 \end_inset
9412
9413  and one wants to define a new type of literate document.
9414  The format is reset to
9415 \begin_inset Quotes eld
9416 \end_inset
9417
9418
9419 \begin_inset Flex Code
9420 status collapsed
9421
9422 \begin_layout Plain Layout
9423 docbook
9424 \end_layout
9425
9426 \end_inset
9427
9428
9429 \begin_inset Quotes erd
9430 \end_inset
9431
9432  or
9433 \begin_inset Quotes eld
9434 \end_inset
9435
9436
9437 \begin_inset Flex Code
9438 status collapsed
9439
9440 \begin_layout Plain Layout
9441 latex
9442 \end_layout
9443
9444 \end_inset
9445
9446
9447 \begin_inset Quotes erd
9448 \end_inset
9449
9450  when the corresponding
9451 \begin_inset Flex Code
9452 status collapsed
9453
9454 \begin_layout Plain Layout
9455 OutputType
9456 \end_layout
9457
9458 \end_inset
9459
9460  parameter is encountered.
9461 \end_layout
9462
9463 \begin_layout Description
9464 \begin_inset Flex Code
9465 status collapsed
9466
9467 \begin_layout Plain Layout
9468 OutputType
9469 \end_layout
9470
9471 \end_inset
9472
9473  [
9474 \begin_inset Flex Code
9475 status collapsed
9476
9477 \begin_layout Plain Layout
9478
9479 \emph on
9480 lat
9481 \emph default
9482 ex
9483 \end_layout
9484
9485 \end_inset
9486
9487 ,
9488 \begin_inset Flex Code
9489 status collapsed
9490
9491 \begin_layout Plain Layout
9492 docbook
9493 \end_layout
9494
9495 \end_inset
9496
9497 ,
9498 \begin_inset Flex Code
9499 status collapsed
9500
9501 \begin_layout Plain Layout
9502 literate
9503 \end_layout
9504
9505 \end_inset
9506
9507 ] Specifies what sort of output documents using this class will produce.
9508 \end_layout
9509
9510 \begin_layout Description
9511 \begin_inset Flex Code
9512 status collapsed
9513
9514 \begin_layout Plain Layout
9515 PackageOptions
9516 \end_layout
9517
9518 \end_inset
9519
9520  [
9521 \begin_inset Flex Code
9522 status collapsed
9523
9524 \begin_layout Plain Layout
9525 string
9526 \end_layout
9527
9528 \end_inset
9529
9530
9531 \begin_inset Flex Code
9532 status collapsed
9533
9534 \begin_layout Plain Layout
9535 string
9536 \end_layout
9537
9538 \end_inset
9539
9540 ] Specifies options, given in the second string, for the package named by
9541  the first string.
9542  For example,
9543 \begin_inset Quotes eld
9544 \end_inset
9545
9546
9547 \begin_inset Flex Code
9548 status collapsed
9549
9550 \begin_layout Plain Layout
9551 PackageOptions natbib square
9552 \end_layout
9553
9554 \end_inset
9555
9556
9557 \begin_inset Quotes erd
9558 \end_inset
9559
9560  will cause
9561 \begin_inset Flex Code
9562 status collapsed
9563
9564 \begin_layout Plain Layout
9565 natbib
9566 \end_layout
9567
9568 \end_inset
9569
9570  to be loaded with the
9571 \begin_inset Flex Code
9572 status collapsed
9573
9574 \begin_layout Plain Layout
9575 square
9576 \end_layout
9577
9578 \end_inset
9579
9580  option.
9581  (For \SpecialChar TeX
9582 perts, this causes \SpecialChar LyX
9583  to output:
9584 \begin_inset Flex Code
9585 status collapsed
9586
9587 \begin_layout Plain Layout
9588
9589 \backslash
9590 PassOptionsToPackage{natbib}{square}
9591 \end_layout
9592
9593 \end_inset
9594
9595  prior to loading
9596 \begin_inset Flex Code
9597 status collapsed
9598
9599 \begin_layout Plain Layout
9600 natbib
9601 \end_layout
9602
9603 \end_inset
9604
9605 .)
9606 \end_layout
9607
9608 \begin_layout Description
9609 \begin_inset Flex Code
9610 status collapsed
9611
9612 \begin_layout Plain Layout
9613 PageStyle
9614 \end_layout
9615
9616 \end_inset
9617
9618  [
9619 \begin_inset Flex Code
9620 status collapsed
9621
9622 \begin_layout Plain Layout
9623
9624 \emph on
9625 plain
9626 \end_layout
9627
9628 \end_inset
9629
9630 ,
9631 \begin_inset Flex Code
9632 status collapsed
9633
9634 \begin_layout Plain Layout
9635 empty
9636 \end_layout
9637
9638 \end_inset
9639
9640 ,
9641 \begin_inset Flex Code
9642 status collapsed
9643
9644 \begin_layout Plain Layout
9645 headings
9646 \end_layout
9647
9648 \end_inset
9649
9650 ] The default pagestyle.
9651  Can be changed in the
9652 \begin_inset Flex MenuItem
9653 status collapsed
9654
9655 \begin_layout Plain Layout
9656 Document\SpecialChar menuseparator
9657 Settings
9658 \end_layout
9659
9660 \end_inset
9661
9662  dialog.
9663 \end_layout
9664
9665 \begin_layout Description
9666 \begin_inset Flex Code
9667 status collapsed
9668
9669 \begin_layout Plain Layout
9670 Preamble
9671 \end_layout
9672
9673 \end_inset
9674
9675  Sets the preamble for the \SpecialChar LaTeX
9676  document.
9677  Note that this will completely override any prior
9678 \begin_inset Flex Code
9679 status collapsed
9680
9681 \begin_layout Plain Layout
9682 Preamble
9683 \end_layout
9684
9685 \end_inset
9686
9687  or
9688 \begin_inset Flex Code
9689 status collapsed
9690
9691 \begin_layout Plain Layout
9692 AddToPreamble
9693 \end_layout
9694
9695 \end_inset
9696
9697  declarations.
9698  (Use
9699 \begin_inset Flex Code
9700 status collapsed
9701
9702 \begin_layout Plain Layout
9703 AddToPreamble
9704 \end_layout
9705
9706 \end_inset
9707
9708  if you just want to add material to the preamble.) Must end with
9709 \begin_inset Quotes eld
9710 \end_inset
9711
9712
9713 \begin_inset Flex Code
9714 status collapsed
9715
9716 \begin_layout Plain Layout
9717 EndPreamble
9718 \end_layout
9719
9720 \end_inset
9721
9722
9723 \begin_inset Quotes erd
9724 \end_inset
9725
9726 .
9727 \end_layout
9728
9729 \begin_layout Description
9730 \begin_inset Flex Code
9731 status collapsed
9732
9733 \begin_layout Plain Layout
9734 Provides
9735 \end_layout
9736
9737 \end_inset
9738
9739  [
9740 \begin_inset Flex Code
9741 status collapsed
9742
9743 \begin_layout Plain Layout
9744 string
9745 \end_layout
9746
9747 \end_inset
9748
9749 ] [
9750 \begin_inset Flex Code
9751 status collapsed
9752
9753 \begin_layout Plain Layout
9754
9755 \emph on
9756 0
9757 \end_layout
9758
9759 \end_inset
9760
9761 ,
9762 \begin_inset space \thinspace{}
9763 \end_inset
9764
9765
9766 \begin_inset Flex Code
9767 status collapsed
9768
9769 \begin_layout Plain Layout
9770 1
9771 \end_layout
9772
9773 \end_inset
9774
9775 ] Whether the class already provides the feature
9776 \begin_inset Flex Code
9777 status collapsed
9778
9779 \begin_layout Plain Layout
9780 string
9781 \end_layout
9782
9783 \end_inset
9784
9785 .
9786  A feature is in general the name of a package (e.
9787 \begin_inset space \thinspace{}
9788 \end_inset
9789
9790 g.
9791 \begin_inset space \space{}
9792 \end_inset
9793
9794
9795 \begin_inset Flex Code
9796 status collapsed
9797
9798 \begin_layout Plain Layout
9799 amsmath
9800 \end_layout
9801
9802 \end_inset
9803
9804  or
9805 \begin_inset Flex Code
9806 status collapsed
9807
9808 \begin_layout Plain Layout
9809 makeidx
9810 \end_layout
9811
9812 \end_inset
9813
9814 ) or a macro (e.
9815 \begin_inset space \thinspace{}
9816 \end_inset
9817
9818 g.
9819 \begin_inset space \space{}
9820 \end_inset
9821
9822
9823 \begin_inset Flex Code
9824 status collapsed
9825
9826 \begin_layout Plain Layout
9827 url
9828 \end_layout
9829
9830 \end_inset
9831
9832  or
9833 \begin_inset Flex Code
9834 status collapsed
9835
9836 \begin_layout Plain Layout
9837 boldsymbol
9838 \end_layout
9839
9840 \end_inset
9841
9842 ).
9843  See
9844 \begin_inset CommandInset ref
9845 LatexCommand ref
9846 reference "chap:List-of-functions"
9847
9848 \end_inset
9849
9850  for the list of features.
9851 \end_layout
9852
9853 \begin_layout Description
9854 \begin_inset Flex Code
9855 status collapsed
9856
9857 \begin_layout Plain Layout
9858 ProvidesModule
9859 \end_layout
9860
9861 \end_inset
9862
9863  [
9864 \begin_inset Flex Code
9865 status collapsed
9866
9867 \begin_layout Plain Layout
9868 string
9869 \end_layout
9870
9871 \end_inset
9872
9873 ] Indicates that this layout provides the functionality of the module mentioned,
9874  which should be specified by the filename without the
9875 \begin_inset Flex Code
9876 status collapsed
9877
9878 \begin_layout Plain Layout
9879 .module
9880 \end_layout
9881
9882 \end_inset
9883
9884  extension.
9885  This will typically be used if the layout includes the module directly,
9886  rather than using the
9887 \begin_inset Flex Code
9888 status collapsed
9889
9890 \begin_layout Plain Layout
9891 DefaultModule
9892 \end_layout
9893
9894 \end_inset
9895
9896  tag to indicate that it ought to be used.
9897  It could also be used in a module that provided an alternate implementation
9898  of the same functionality.
9899 \end_layout
9900
9901 \begin_layout Description
9902 \begin_inset Flex Code
9903 status collapsed
9904
9905 \begin_layout Plain Layout
9906 Requires
9907 \end_layout
9908
9909 \end_inset
9910
9911  [
9912 \begin_inset Flex Code
9913 status collapsed
9914
9915 \begin_layout Plain Layout
9916 string
9917 \end_layout
9918
9919 \end_inset
9920
9921 ] Whether the class requires the feature
9922 \begin_inset Flex Code
9923 status collapsed
9924
9925 \begin_layout Plain Layout
9926 string
9927 \end_layout
9928
9929 \end_inset
9930
9931 .
9932  Multiple features must be separated by commas.
9933  Note that you can only request supported features.
9934  (See
9935 \begin_inset CommandInset ref
9936 LatexCommand ref
9937 reference "chap:List-of-functions"
9938
9939 \end_inset
9940
9941  for the list of features.)
9942 \change_inserted -712698321 1438601536
9943 .
9944  If you require a package with specific options, you can additionally use
9945
9946 \begin_inset Flex Code
9947 status collapsed
9948
9949 \begin_layout Plain Layout
9950
9951 \change_inserted -712698321 1438601526
9952 PackageOptions
9953 \end_layout
9954
9955 \end_inset
9956
9957 .
9958 \change_unchanged
9959
9960 \end_layout
9961
9962 \begin_layout Description
9963 \begin_inset Flex Code
9964 status collapsed
9965
9966 \begin_layout Plain Layout
9967 RightMargin
9968 \end_layout
9969
9970 \end_inset
9971
9972  [
9973 \begin_inset Flex Code
9974 status collapsed
9975
9976 \begin_layout Plain Layout
9977 string
9978 \end_layout
9979
9980 \end_inset
9981
9982 ] A string that indicates the width of the right margin on the screen, for
9983  example,
9984 \begin_inset Quotes eld
9985 \end_inset
9986
9987
9988 \begin_inset Flex Code
9989 status collapsed
9990
9991 \begin_layout Plain Layout
9992 MMMMM
9993 \end_layout
9994
9995 \end_inset
9996
9997
9998 \begin_inset Quotes erd
9999 \end_inset
10000
10001 .
10002 \end_layout
10003
10004 \begin_layout Description
10005 \begin_inset Flex Code
10006 status collapsed
10007
10008 \begin_layout Plain Layout
10009 SecNumDepth
10010 \end_layout
10011
10012 \end_inset
10013
10014  [
10015 \begin_inset Flex Code
10016 status collapsed
10017
10018 \begin_layout Plain Layout
10019 int=3
10020 \end_layout
10021
10022 \end_inset
10023
10024 ] Sets which divisions get numbered.
10025  Corresponds to the
10026 \begin_inset Newline newline
10027 \end_inset
10028
10029
10030 \begin_inset Flex Code
10031 status collapsed
10032
10033 \begin_layout Plain Layout
10034 secnumdepth
10035 \end_layout
10036
10037 \end_inset
10038
10039  counter in \SpecialChar LaTeX
10040 .
10041 \end_layout
10042
10043 \begin_layout Description
10044 \begin_inset Flex Code
10045 status collapsed
10046
10047 \begin_layout Plain Layout
10048 Sides
10049 \end_layout
10050
10051 \end_inset
10052
10053  [
10054 \begin_inset Flex Code
10055 status collapsed
10056
10057 \begin_layout Plain Layout
10058
10059 \emph on
10060 1
10061 \end_layout
10062
10063 \end_inset
10064
10065 ,
10066 \begin_inset space \thinspace{}
10067 \end_inset
10068
10069
10070 \begin_inset Flex Code
10071 status collapsed
10072
10073 \begin_layout Plain Layout
10074 2
10075 \end_layout
10076
10077 \end_inset
10078
10079 ] Whether the class-default should be printing on one or both sides of the
10080  paper.
10081  Can be changed in the
10082 \begin_inset Flex MenuItem
10083 status collapsed
10084
10085 \begin_layout Plain Layout
10086 Document\SpecialChar menuseparator
10087 Settings
10088 \end_layout
10089
10090 \end_inset
10091
10092  dialog.
10093 \end_layout
10094
10095 \begin_layout Description
10096 \begin_inset Flex Code
10097 status collapsed
10098
10099 \begin_layout Plain Layout
10100 Style
10101 \end_layout
10102
10103 \end_inset
10104
10105  [
10106 \begin_inset Flex Code
10107 status collapsed
10108
10109 \begin_layout Plain Layout
10110 <name>
10111 \end_layout
10112
10113 \end_inset
10114
10115 ] This sequence defines a paragraph style.
10116  If the style does not yet exist, it is created; if it does exist, its parameter
10117 s are modified.
10118  Must end with
10119 \begin_inset Quotes eld
10120 \end_inset
10121
10122
10123 \begin_inset Flex Code
10124 status collapsed
10125
10126 \begin_layout Plain Layout
10127 End
10128 \end_layout
10129
10130 \end_inset
10131
10132
10133 \begin_inset Quotes erd
10134 \end_inset
10135
10136 .
10137 \begin_inset Newline newline
10138 \end_inset
10139
10140 See
10141 \begin_inset CommandInset ref
10142 LatexCommand ref
10143 reference "subsec:Paragraph-Styles"
10144
10145 \end_inset
10146
10147  for details on paragraph styles.
10148 \end_layout
10149
10150 \begin_layout Description
10151 \begin_inset Flex Code
10152 status collapsed
10153
10154 \begin_layout Plain Layout
10155 TitleLatexName
10156 \end_layout
10157
10158 \end_inset
10159
10160  [
10161 \begin_inset Flex Code
10162 status collapsed
10163
10164 \begin_layout Plain Layout
10165 string="maketitle"
10166 \end_layout
10167
10168 \end_inset
10169
10170 ] The name of the command or environment to be used with
10171 \begin_inset Flex Code
10172 status collapsed
10173
10174 \begin_layout Plain Layout
10175 TitleLatexType
10176 \end_layout
10177
10178 \end_inset
10179
10180 .
10181 \end_layout
10182
10183 \begin_layout Description
10184 \begin_inset Flex Code
10185 status collapsed
10186
10187 \begin_layout Plain Layout
10188 TitleLatexType
10189 \end_layout
10190
10191 \end_inset
10192
10193  [
10194 \begin_inset Flex Code
10195 status collapsed
10196
10197 \begin_layout Plain Layout
10198
10199 \emph on
10200 CommandAfter
10201 \end_layout
10202
10203 \end_inset
10204
10205 ,
10206 \begin_inset Flex Code
10207 status collapsed
10208
10209 \begin_layout Plain Layout
10210 Environment
10211 \end_layout
10212
10213 \end_inset
10214
10215 ] Indicates what kind of markup is used to define the title of a document.
10216
10217 \begin_inset Flex Code
10218 status collapsed
10219
10220 \begin_layout Plain Layout
10221 CommandAfter
10222 \end_layout
10223
10224 \end_inset
10225
10226  means that the macro with name
10227 \begin_inset Flex Code
10228 status collapsed
10229
10230 \begin_layout Plain Layout
10231 TitleLatexName
10232 \end_layout
10233
10234 \end_inset
10235
10236  will be inserted after the last layout which has
10237 \begin_inset Quotes eld
10238 \end_inset
10239
10240
10241 \begin_inset Flex Code
10242 status collapsed
10243
10244 \begin_layout Plain Layout
10245 InTitle
10246 \begin_inset space ~
10247 \end_inset
10248
10249 1
10250 \end_layout
10251
10252 \end_inset
10253
10254
10255 \begin_inset Quotes erd
10256 \end_inset
10257
10258 .
10259
10260 \begin_inset Flex Code
10261 status collapsed
10262
10263 \begin_layout Plain Layout
10264 Environment
10265 \end_layout
10266
10267 \end_inset
10268
10269  corresponds to the case where all layouts which have
10270 \begin_inset Quotes eld
10271 \end_inset
10272
10273
10274 \begin_inset Flex Code
10275 status collapsed
10276
10277 \begin_layout Plain Layout
10278 InTitle
10279 \begin_inset space ~
10280 \end_inset
10281
10282 1
10283 \end_layout
10284
10285 \end_inset
10286
10287
10288 \begin_inset Quotes erd
10289 \end_inset
10290
10291  should be enclosed into the
10292 \begin_inset Flex Code
10293 status collapsed
10294
10295 \begin_layout Plain Layout
10296 TitleLatexName
10297 \end_layout
10298
10299 \end_inset
10300
10301  environment.
10302 \end_layout
10303
10304 \begin_layout Description
10305 \begin_inset Flex Code
10306 status collapsed
10307
10308 \begin_layout Plain Layout
10309 TocDepth
10310 \end_layout
10311
10312 \end_inset
10313
10314  [
10315 \begin_inset Flex Code
10316 status collapsed
10317
10318 \begin_layout Plain Layout
10319 int=3
10320 \end_layout
10321
10322 \end_inset
10323
10324 ] Sets which divisions are included in the table of contents.
10325  Corresponds to the
10326 \begin_inset Flex Code
10327 status collapsed
10328
10329 \begin_layout Plain Layout
10330 tocdepth
10331 \end_layout
10332
10333 \end_inset
10334
10335  counter in \SpecialChar LaTeX
10336 .
10337 \end_layout
10338
10339 \begin_layout Subsection
10340 \begin_inset Flex Code
10341 status collapsed
10342
10343 \begin_layout Plain Layout
10344 ClassOptions
10345 \end_layout
10346
10347 \end_inset
10348
10349  section
10350 \begin_inset CommandInset label
10351 LatexCommand label
10352 name "subsec:ClassOptions"
10353
10354 \end_inset
10355
10356
10357 \end_layout
10358
10359 \begin_layout Standard
10360 The
10361 \begin_inset Flex Code
10362 status collapsed
10363
10364 \begin_layout Plain Layout
10365 ClassOptions
10366 \end_layout
10367
10368 \end_inset
10369
10370  section can contain the following entries:
10371 \end_layout
10372
10373 \begin_layout Description
10374 \begin_inset Flex Code
10375 status collapsed
10376
10377 \begin_layout Plain Layout
10378 FontSize
10379 \end_layout
10380
10381 \end_inset
10382
10383  [
10384 \begin_inset Flex Code
10385 status collapsed
10386
10387 \begin_layout Plain Layout
10388 string="10|11|12"
10389 \end_layout
10390
10391 \end_inset
10392
10393 ] The list of available font sizes for the document's main font, separated
10394  by
10395 \begin_inset Quotes eld
10396 \end_inset
10397
10398
10399 \begin_inset Flex Code
10400 status collapsed
10401
10402 \begin_layout Plain Layout
10403 |
10404 \end_layout
10405
10406 \end_inset
10407
10408
10409 \begin_inset Quotes erd
10410 \end_inset
10411
10412 .
10413 \end_layout
10414
10415 \begin_layout Description
10416 \begin_inset Flex Code
10417 status collapsed
10418
10419 \begin_layout Plain Layout
10420 Header
10421 \end_layout
10422
10423 \end_inset
10424
10425  Used to set the DTD line with XML-based output classes.
10426  E.
10427 \begin_inset space \thinspace{}
10428 \end_inset
10429
10430 g.: PUBLIC
10431 \begin_inset Quotes eld
10432 \end_inset
10433
10434 -//OASIS//DTD DocBook V4.2//EN
10435 \begin_inset Quotes erd
10436 \end_inset
10437
10438 .
10439 \end_layout
10440
10441 \begin_layout Description
10442 \begin_inset Flex Code
10443 status collapsed
10444
10445 \begin_layout Plain Layout
10446 PageStyle
10447 \end_layout
10448
10449 \end_inset
10450
10451  [
10452 \begin_inset Flex Code
10453 status collapsed
10454
10455 \begin_layout Plain Layout
10456 string="empty|plain|headings|fancy"
10457 \end_layout
10458
10459 \end_inset
10460
10461 ] The list of available page sty\SpecialChar softhyphen
10462 les, separated by
10463 \begin_inset Quotes eld
10464 \end_inset
10465
10466
10467 \begin_inset Flex Code
10468 status collapsed
10469
10470 \begin_layout Plain Layout
10471 |
10472 \end_layout
10473
10474 \end_inset
10475
10476
10477 \begin_inset Quotes erd
10478 \end_inset
10479
10480 .
10481 \end_layout
10482
10483 \begin_layout Description
10484 \begin_inset Flex Code
10485 status collapsed
10486
10487 \begin_layout Plain Layout
10488 Other
10489 \end_layout
10490
10491 \end_inset
10492
10493  [
10494 \begin_inset Flex Code
10495 status collapsed
10496
10497 \begin_layout Plain Layout
10498 string=""
10499 \end_layout
10500
10501 \end_inset
10502
10503 ] Some document class options, separated by a comma, that will be added
10504  to the optional part of the
10505 \begin_inset Flex Code
10506 status collapsed
10507
10508 \begin_layout Plain Layout
10509
10510 \backslash
10511 documentclass
10512 \end_layout
10513
10514 \end_inset
10515
10516  command.
10517 \end_layout
10518
10519 \begin_layout Standard
10520 The
10521 \begin_inset Flex Code
10522 status collapsed
10523
10524 \begin_layout Plain Layout
10525 ClassOptions
10526 \end_layout
10527
10528 \end_inset
10529
10530  section must end with
10531 \begin_inset Quotes eld
10532 \end_inset
10533
10534
10535 \begin_inset Flex Code
10536 status collapsed
10537
10538 \begin_layout Plain Layout
10539 End
10540 \end_layout
10541
10542 \end_inset
10543
10544
10545 \begin_inset Quotes erd
10546 \end_inset
10547
10548 .
10549 \end_layout
10550
10551 \begin_layout Subsection
10552 Paragraph styles
10553 \begin_inset CommandInset label
10554 LatexCommand label
10555 name "subsec:Paragraph-Styles"
10556
10557 \end_inset
10558
10559
10560 \end_layout
10561
10562 \begin_layout Standard
10563 A paragraph style description looks like this:
10564 \begin_inset Foot
10565 status collapsed
10566
10567 \begin_layout Plain Layout
10568 Note that this will either define a new style or modify an existing one.
10569 \end_layout
10570
10571 \end_inset
10572
10573
10574 \end_layout
10575
10576 \begin_layout LyX-Code
10577 Style
10578 \family roman
10579 \emph on
10580 name
10581 \end_layout
10582
10583 \begin_layout LyX-Code
10584  ...
10585 \end_layout
10586
10587 \begin_layout LyX-Code
10588 End
10589 \end_layout
10590
10591 \begin_layout Standard
10592 where the following commands are allowed:
10593 \end_layout
10594
10595 \begin_layout Description
10596 \begin_inset Flex Code
10597 status collapsed
10598
10599 \begin_layout Plain Layout
10600 Align
10601 \end_layout
10602
10603 \end_inset
10604
10605  [
10606 \begin_inset Flex Code
10607 status collapsed
10608
10609 \begin_layout Plain Layout
10610
10611 \emph on
10612 block
10613 \emph default
10614 , left, right, center
10615 \end_layout
10616
10617 \end_inset
10618
10619 ] Paragraph alignment.
10620 \end_layout
10621
10622 \begin_layout Description
10623 \begin_inset Flex Code
10624 status collapsed
10625
10626 \begin_layout Plain Layout
10627 AlignPossible
10628 \end_layout
10629
10630 \end_inset
10631
10632  [
10633 \begin_inset Flex Code
10634 status collapsed
10635
10636 \begin_layout Plain Layout
10637
10638 \emph on
10639 block
10640 \emph default
10641 , left, right, center
10642 \end_layout
10643
10644 \end_inset
10645
10646 ] A comma separated list of permitted alignments.
10647  (Some \SpecialChar LaTeX
10648  styles prohibit certain alignments, since those wouldn't make sense.
10649  For example a right-aligned or centered enumeration isn't possible.)
10650 \end_layout
10651
10652 \begin_layout Description
10653 \begin_inset Flex Code
10654 status collapsed
10655
10656 \begin_layout Plain Layout
10657 Argument
10658 \end_layout
10659
10660 \end_inset
10661
10662  [
10663 \begin_inset Flex Code
10664 status collapsed
10665
10666 \begin_layout Plain Layout
10667 int
10668 \end_layout
10669
10670 \end_inset
10671
10672 ] Defines argument number <int> of a command\SpecialChar breakableslash
10673 environment associated with
10674  the current style.
10675  This is useful for things like section headings, and only makes sense with
10676  \SpecialChar LaTeX
10677 .
10678  Every (optional or required) argument of a command or environment – except
10679  for the required argument that is associated with the content of the paragraph
10680  itself – has a separate definition, where the number specifies the order
10681  of the arguments.
10682  The definition must end with
10683 \begin_inset Flex Code
10684 status collapsed
10685
10686 \begin_layout Plain Layout
10687 EndArgument
10688 \end_layout
10689
10690 \end_inset
10691
10692 .
10693  So a command with two optional arguments has:
10694 \begin_inset Separator parbreak
10695 \end_inset
10696
10697
10698 \end_layout
10699
10700 \begin_deeper
10701 \begin_layout Quote
10702
10703 \family typewriter
10704 Argument 1
10705 \end_layout
10706
10707 \begin_layout Quote
10708
10709 \family typewriter
10710 ...
10711 \end_layout
10712
10713 \begin_layout Quote
10714
10715 \family typewriter
10716 EndArgument
10717 \end_layout
10718
10719 \begin_layout Quote
10720
10721 \family typewriter
10722 Argument 2
10723 \end_layout
10724
10725 \begin_layout Quote
10726
10727 \family typewriter
10728 ...
10729 \end_layout
10730
10731 \begin_layout Quote
10732
10733 \family typewriter
10734 EndArgument
10735 \end_layout
10736
10737 \begin_layout Standard
10738 Inside the
10739 \begin_inset Flex Code
10740 status collapsed
10741
10742 \begin_layout Plain Layout
10743 Argument
10744 \end_layout
10745
10746 \end_inset
10747
10748  definition, the following specifications are possible:
10749 \end_layout
10750
10751 \begin_layout Itemize
10752 \begin_inset Flex Code
10753 status collapsed
10754
10755 \begin_layout Plain Layout
10756 LabelString
10757 \end_layout
10758
10759 \end_inset
10760
10761
10762 \begin_inset Flex Code
10763 status collapsed
10764
10765 \begin_layout Plain Layout
10766 [string]
10767 \end_layout
10768
10769 \end_inset
10770
10771  The string that will appear both in the menu (to insert this argument)
10772  and on the argument inset button (unless you also specify a separate
10773 \begin_inset Flex Code
10774 status collapsed
10775
10776 \begin_layout Plain Layout
10777 MenuString
10778 \end_layout
10779
10780 \end_inset
10781
10782 ).
10783  For the menu, you can define an accelerator by appending the respective
10784  character to the string, divided by
10785 \begin_inset Quotes eld
10786 \end_inset
10787
10788 |
10789 \begin_inset Quotes erd
10790 \end_inset
10791
10792  (e.
10793 \begin_inset space \thinspace{}
10794 \end_inset
10795
10796 g.
10797 \begin_inset space \space{}
10798 \end_inset
10799
10800
10801 \begin_inset Quotes eld
10802 \end_inset
10803
10804
10805 \begin_inset Flex Code
10806 status collapsed
10807
10808 \begin_layout Plain Layout
10809 Short Title|S
10810 \end_layout
10811
10812 \end_inset
10813
10814
10815 \begin_inset Quotes erd
10816 \end_inset
10817
10818 ).
10819 \end_layout
10820
10821 \begin_layout Itemize
10822 \begin_inset Flex Code
10823 status collapsed
10824
10825 \begin_layout Plain Layout
10826 MenuString
10827 \end_layout
10828
10829 \end_inset
10830
10831
10832 \begin_inset Flex Code
10833 status collapsed
10834
10835 \begin_layout Plain Layout
10836 [string]
10837 \end_layout
10838
10839 \end_inset
10840
10841  A separate string for the menu.
10842  You can define an accelerator by appending the respective character to
10843  the string, divided by
10844 \begin_inset Quotes eld
10845 \end_inset
10846
10847 |
10848 \begin_inset Quotes erd
10849 \end_inset
10850
10851  (e.
10852 \begin_inset space \thinspace{}
10853 \end_inset
10854
10855 g.
10856 \begin_inset space \space{}
10857 \end_inset
10858
10859
10860 \begin_inset Quotes eld
10861 \end_inset
10862
10863
10864 \begin_inset Flex Code
10865 status collapsed
10866
10867 \begin_layout Plain Layout
10868 Short Title|S
10869 \end_layout
10870
10871 \end_inset
10872
10873
10874 \begin_inset Quotes erd
10875 \end_inset
10876
10877 ).
10878  This specification is optional.
10879  If it is not given the
10880 \begin_inset Flex Code
10881 status collapsed
10882
10883 \begin_layout Plain Layout
10884 LabelString
10885 \end_layout
10886
10887 \end_inset
10888
10889  will be used instead for the menu.
10890 \end_layout
10891
10892 \begin_layout Itemize
10893 \begin_inset Flex Code
10894 status collapsed
10895
10896 \begin_layout Plain Layout
10897 Tooltip
10898 \end_layout
10899
10900 \end_inset
10901
10902
10903 \begin_inset Flex Code
10904 status collapsed
10905
10906 \begin_layout Plain Layout
10907 [string]
10908 \end_layout
10909
10910 \end_inset
10911
10912  A longer explanatory text that appears in the tooltip when hovering over
10913  the argument inset.
10914 \end_layout
10915
10916 \begin_layout Itemize
10917 \begin_inset Flex Code
10918 status collapsed
10919
10920 \begin_layout Plain Layout
10921 Mandatory
10922 \end_layout
10923
10924 \end_inset
10925
10926  [
10927 \begin_inset Flex Code
10928 status collapsed
10929
10930 \begin_layout Plain Layout
10931
10932 \emph on
10933 0
10934 \end_layout
10935
10936 \end_inset
10937
10938 ,
10939 \begin_inset space \thinspace{}
10940 \end_inset
10941
10942
10943 \begin_inset Flex Code
10944 status collapsed
10945
10946 \begin_layout Plain Layout
10947 1
10948 \end_layout
10949
10950 \end_inset
10951
10952 ] Declare if this is a mandatory (1) or an optional (0) argument.
10953  Mandatory arguments will be output empty if not given, while optional arguments
10954  will not be output at all.
10955  By default, mandatory arguments are delimited by
10956 \begin_inset Flex Code
10957 status collapsed
10958
10959 \begin_layout Plain Layout
10960 {...}
10961 \end_layout
10962
10963 \end_inset
10964
10965 , while optional arguments are delimited by
10966 \begin_inset Flex Code
10967 status collapsed
10968
10969 \begin_layout Plain Layout
10970 [...]
10971 \end_layout
10972
10973 \end_inset
10974
10975
10976 \end_layout
10977
10978 \begin_layout Itemize
10979 \begin_inset Flex Code
10980 status collapsed
10981
10982 \begin_layout Plain Layout
10983 Requires
10984 \end_layout
10985
10986 \end_inset
10987
10988
10989 \begin_inset Flex Code
10990 status collapsed
10991
10992 \begin_layout Plain Layout
10993 [int=0]
10994 \end_layout
10995
10996 \end_inset
10997
10998  defines another argument (by its number) which this argument requires to
10999  be output if it is itself output.
11000  E.
11001 \begin_inset space \thinspace{}
11002 \end_inset
11003
11004 g., in \SpecialChar LaTeX
11005  commands, optional arguments often require previous optional arguments
11006  to be output (at least empty), as in
11007 \begin_inset Flex Code
11008 status collapsed
11009
11010 \begin_layout Plain Layout
11011
11012 \backslash
11013 command[][argument]{text}
11014 \end_layout
11015
11016 \end_inset
11017
11018 .
11019  This can be achieved by the statement
11020 \begin_inset Flex Code
11021 status collapsed
11022
11023 \begin_layout Plain Layout
11024 Requires 1
11025 \end_layout
11026
11027 \end_inset
11028
11029  within
11030 \begin_inset Flex Code
11031 status collapsed
11032
11033 \begin_layout Plain Layout
11034 Argument 2
11035 \end_layout
11036
11037 \end_inset
11038
11039 .
11040 \end_layout
11041
11042 \begin_layout Itemize
11043 \begin_inset Flex Code
11044 status collapsed
11045
11046 \begin_layout Plain Layout
11047 LeftDelim
11048 \end_layout
11049
11050 \end_inset
11051
11052
11053 \begin_inset Flex Code
11054 status collapsed
11055
11056 \begin_layout Plain Layout
11057 [string]
11058 \end_layout
11059
11060 \end_inset
11061
11062  defines a custom left delimiter (instead of
11063 \begin_inset Flex Code
11064 status collapsed
11065
11066 \begin_layout Plain Layout
11067 {
11068 \end_layout
11069
11070 \end_inset
11071
11072  or
11073 \begin_inset Flex Code
11074 status collapsed
11075
11076 \begin_layout Plain Layout
11077 [
11078 \end_layout
11079
11080 \end_inset
11081
11082 ).
11083  A line break in the output can be indicated by
11084 \begin_inset Flex Code
11085 status collapsed
11086
11087 \begin_layout Plain Layout
11088 <br/>
11089 \end_layout
11090
11091 \end_inset
11092
11093 .
11094 \end_layout
11095
11096 \begin_layout Itemize
11097 \begin_inset Flex Code
11098 status collapsed
11099
11100 \begin_layout Plain Layout
11101 RightDelim
11102 \end_layout
11103
11104 \end_inset
11105
11106
11107 \begin_inset Flex Code
11108 status collapsed
11109
11110 \begin_layout Plain Layout
11111 [string]
11112 \end_layout
11113
11114 \end_inset
11115
11116  defines a custom right delimiter (instead of
11117 \begin_inset Flex Code
11118 status collapsed
11119
11120 \begin_layout Plain Layout
11121 }
11122 \end_layout
11123
11124 \end_inset
11125
11126  or
11127 \begin_inset Flex Code
11128 status collapsed
11129
11130 \begin_layout Plain Layout
11131 ]
11132 \end_layout
11133
11134 \end_inset
11135
11136 ).
11137  A line break in the output can be indicated by
11138 \begin_inset Flex Code
11139 status collapsed
11140
11141 \begin_layout Plain Layout
11142 <br/>
11143 \end_layout
11144
11145 \end_inset
11146
11147 .
11148 \end_layout
11149
11150 \begin_layout Itemize
11151 \begin_inset Flex Code
11152 status collapsed
11153
11154 \begin_layout Plain Layout
11155 DefaultArg
11156 \end_layout
11157
11158 \end_inset
11159
11160
11161 \begin_inset Flex Code
11162 status collapsed
11163
11164 \begin_layout Plain Layout
11165 [string]
11166 \end_layout
11167
11168 \end_inset
11169
11170  defines an argument that is inserted if and only if no user-specified arguments
11171  were given, i.
11172 \begin_inset space \thinspace{}
11173 \end_inset
11174
11175 e.
11176 \begin_inset space \space{}
11177 \end_inset
11178
11179 if no argument inset has been inserted (note that also an empty argument
11180  inset omits the DefaultArg).
11181  Multiple arguments need to be separated by comma.
11182 \end_layout
11183
11184 \begin_layout Itemize
11185 \begin_inset Flex Code
11186 status collapsed
11187
11188 \begin_layout Plain Layout
11189 PresetArg
11190 \end_layout
11191
11192 \end_inset
11193
11194
11195 \begin_inset Flex Code
11196 status collapsed
11197
11198 \begin_layout Plain Layout
11199 [string]
11200 \end_layout
11201
11202 \end_inset
11203
11204  defines an argument that is inserted in any case (alone or in addition
11205  to user-specified arguments).
11206  Multiple arguments need to be separated by comma.
11207 \end_layout
11208
11209 \begin_layout Itemize
11210 \begin_inset Flex Code
11211 status collapsed
11212
11213 \begin_layout Plain Layout
11214 Font
11215 \end_layout
11216
11217 \end_inset
11218
11219  The font used for the argument content, see
11220 \begin_inset CommandInset ref
11221 LatexCommand ref
11222 reference "subsec:Font-description"
11223
11224 \end_inset
11225
11226 .
11227 \end_layout
11228
11229 \begin_layout Itemize
11230 \begin_inset Flex Code
11231 status collapsed
11232
11233 \begin_layout Plain Layout
11234 LabelFont
11235 \end_layout
11236
11237 \end_inset
11238
11239  The font used for the label; see
11240 \begin_inset CommandInset ref
11241 LatexCommand ref
11242 reference "subsec:Font-description"
11243
11244 \end_inset
11245
11246 .
11247 \end_layout
11248
11249 \begin_layout Itemize
11250 \begin_inset Flex Code
11251 status collapsed
11252
11253 \begin_layout Plain Layout
11254 Decoration
11255 \end_layout
11256
11257 \end_inset
11258
11259  [
11260 \begin_inset Flex Code
11261 status collapsed
11262
11263 \begin_layout Plain Layout
11264
11265 \emph on
11266 Classic
11267 \emph default
11268 , Minimalistic, Conglomerate
11269 \end_layout
11270
11271 \end_inset
11272
11273 ] describes the rendering style used for the inset's frame and buttons.
11274 \end_layout
11275
11276 \begin_layout Itemize
11277 \begin_inset Flex Code
11278 status collapsed
11279
11280 \begin_layout Plain Layout
11281 AutoInsert
11282 \end_layout
11283
11284 \end_inset
11285
11286
11287 \begin_inset Flex Code
11288 status collapsed
11289
11290 \begin_layout Plain Layout
11291 [int=0]
11292 \end_layout
11293
11294 \end_inset
11295
11296  If this is set to
11297 \begin_inset Flex Code
11298 status collapsed
11299
11300 \begin_layout Plain Layout
11301 1
11302 \end_layout
11303
11304 \end_inset
11305
11306 , this argument is automatically inserted when the respective style is selected.
11307  Currently, only one argument per style\SpecialChar breakableslash
11308 layout can be automatically inserted.
11309 \change_inserted -712698321 1431166542
11310
11311 \end_layout
11312
11313 \begin_layout Itemize
11314
11315 \change_inserted -712698321 1431166604
11316 \begin_inset Flex Code
11317 status collapsed
11318
11319 \begin_layout Plain Layout
11320
11321 \change_inserted -712698321 1431166548
11322 InsertCotext
11323 \end_layout
11324
11325 \end_inset
11326
11327
11328 \begin_inset Flex Code
11329 status collapsed
11330
11331 \begin_layout Plain Layout
11332
11333 \change_inserted -712698321 1431166543
11334 [int=0]
11335 \end_layout
11336
11337 \end_inset
11338
11339  If this is set to
11340 \begin_inset Flex Code
11341 status collapsed
11342
11343 \begin_layout Plain Layout
11344
11345 \change_inserted -712698321 1431166543
11346 1
11347 \end_layout
11348
11349 \end_inset
11350
11351 , this argument will be inserted with a copy of the co-text (either selected
11352  text or the whole paragraph) as content.
11353 \end_layout
11354
11355 \begin_layout Itemize
11356
11357 \change_inserted -712698321 1431070588
11358 \begin_inset Flex Code
11359 status collapsed
11360
11361 \begin_layout Plain Layout
11362
11363 \change_inserted -712698321 1431070522
11364 PassThruChars
11365 \end_layout
11366
11367 \end_inset
11368
11369  [
11370 \begin_inset Flex Code
11371 status collapsed
11372
11373 \begin_layout Plain Layout
11374
11375 \change_inserted -712698321 1431070522
11376 string of characters
11377 \end_layout
11378
11379 \end_inset
11380
11381 ]
11382 \family typewriter
11383
11384 \family default
11385 Defines individual characters that should be output in raw form, meaning
11386  without special translations that \SpecialChar LaTeX
11387  would require.
11388  Note that, contrary to PassThru, this needs to be explicitly defined for
11389  arguments.
11390  That is, arguments do not inherit PassThruChars from their parent inset
11391  or layout.
11392 \change_unchanged
11393
11394 \end_layout
11395
11396 \begin_layout Standard
11397 By default, the text entered in the \SpecialChar LyX
11398  workarea in the respective layout is
11399  the last (mandatory) argument of a command if the
11400 \begin_inset Flex Code
11401 status collapsed
11402
11403 \begin_layout Plain Layout
11404 LatexType
11405 \end_layout
11406
11407 \end_inset
11408
11409  is
11410 \begin_inset Flex Code
11411 status collapsed
11412
11413 \begin_layout Plain Layout
11414 Command
11415 \end_layout
11416
11417 \end_inset
11418
11419 .
11420  However, arguments with the prefix
11421 \begin_inset Flex Code
11422 status collapsed
11423
11424 \begin_layout Plain Layout
11425 post:
11426 \end_layout
11427
11428 \end_inset
11429
11430  are output after this workarea argument.
11431  Note that post-argument numbering restarts at 1, so the first argument
11432  following the workarea argument is
11433 \begin_inset Flex Code
11434 status collapsed
11435
11436 \begin_layout Plain Layout
11437 post:1
11438 \end_layout
11439
11440 \end_inset
11441
11442 .
11443  Post-arguments are ignored in any other
11444 \begin_inset Flex Code
11445 status collapsed
11446
11447 \begin_layout Plain Layout
11448 LatexType
11449 \end_layout
11450
11451 \end_inset
11452
11453  than
11454 \begin_inset Flex Code
11455 status collapsed
11456
11457 \begin_layout Plain Layout
11458 Command
11459 \end_layout
11460
11461 \end_inset
11462
11463 .
11464 \end_layout
11465
11466 \begin_layout Standard
11467 Arguments for list
11468 \begin_inset Flex Code
11469 status collapsed
11470
11471 \begin_layout Plain Layout
11472
11473 \backslash
11474 item
11475 \end_layout
11476
11477 \end_inset
11478
11479 s (as in
11480 \begin_inset Flex Code
11481 status collapsed
11482
11483 \begin_layout Plain Layout
11484
11485 \backslash
11486 item[foo]
11487 \end_layout
11488
11489 \end_inset
11490
11491 ) have the prefix
11492 \begin_inset Flex Code
11493 status collapsed
11494
11495 \begin_layout Plain Layout
11496 item:
11497 \end_layout
11498
11499 \end_inset
11500
11501  followed by the number (e.
11502 \begin_inset space \thinspace{}
11503 \end_inset
11504
11505 g.
11506 \begin_inset space \space{}
11507 \end_inset
11508
11509
11510 \begin_inset Flex Code
11511 status collapsed
11512
11513 \begin_layout Plain Layout
11514 Argument item:1
11515 \end_layout
11516
11517 \end_inset
11518
11519 )
11520 \end_layout
11521
11522 \end_deeper
11523 \begin_layout Description
11524 \begin_inset Flex Code
11525 status collapsed
11526
11527 \begin_layout Plain Layout
11528 BabelPreamble
11529 \end_layout
11530
11531 \end_inset
11532
11533  Note that this will completely override any prior
11534 \begin_inset Flex Code
11535 status collapsed
11536
11537 \begin_layout Plain Layout
11538 BabelPreamble
11539 \end_layout
11540
11541 \end_inset
11542
11543  declaration for this style.
11544  Must end with
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 EndBabelPreamble
11554 \end_layout
11555
11556 \end_inset
11557
11558
11559 \begin_inset Quotes erd
11560 \end_inset
11561
11562 .
11563  See
11564 \begin_inset CommandInset ref
11565 LatexCommand ref
11566 reference "subsec:I18n"
11567
11568 \end_inset
11569
11570  for details on its use.
11571 \end_layout
11572
11573 \begin_layout Description
11574 \begin_inset Flex Code
11575 status collapsed
11576
11577 \begin_layout Plain Layout
11578 BottomSep
11579 \end_layout
11580
11581 \end_inset
11582
11583  [
11584 \begin_inset Flex Code
11585 status collapsed
11586
11587 \begin_layout Plain Layout
11588 float=0
11589 \end_layout
11590
11591 \end_inset
11592
11593 ]
11594 \begin_inset Foot
11595 status collapsed
11596
11597 \begin_layout Plain Layout
11598 Note that a `float' here is a real number, such as: 1.5.
11599 \end_layout
11600
11601 \end_inset
11602
11603  The vertical space with which the last of a chain of paragraphs with this
11604  style is separated from the following paragraph.
11605  If the next paragraph has another style, the separations are not simply
11606  added, but the maximum is taken.
11607 \end_layout
11608
11609 \begin_layout Description
11610 \begin_inset Flex Code
11611 status collapsed
11612
11613 \begin_layout Plain Layout
11614 Category
11615 \end_layout
11616
11617 \end_inset
11618
11619  [
11620 \begin_inset Flex Code
11621 status collapsed
11622
11623 \begin_layout Plain Layout
11624 string
11625 \end_layout
11626
11627 \end_inset
11628
11629 ] The category for this style.
11630  This is used to group related styles in the style combobox on the toolbar.
11631  Any string can be used, but you may want to use existing categories with
11632  your own styles.
11633
11634 \end_layout
11635
11636 \begin_layout Description
11637 \begin_inset Flex Code
11638 status collapsed
11639
11640 \begin_layout Plain Layout
11641 CommandDepth
11642 \end_layout
11643
11644 \end_inset
11645
11646  Depth of XML command.
11647  Used only with XML-type formats.
11648 \end_layout
11649
11650 \begin_layout Description
11651 \begin_inset Flex Code
11652 status collapsed
11653
11654 \begin_layout Plain Layout
11655 CopyStyle
11656 \end_layout
11657
11658 \end_inset
11659
11660  [
11661 \begin_inset Flex Code
11662 status collapsed
11663
11664 \begin_layout Plain Layout
11665 string
11666 \end_layout
11667
11668 \end_inset
11669
11670 ] Copies all the features of an existing style into the current one.
11671
11672 \end_layout
11673
11674 \begin_layout Description
11675 \begin_inset Flex Code
11676 status collapsed
11677
11678 \begin_layout Plain Layout
11679 DependsOn
11680 \end_layout
11681
11682 \end_inset
11683
11684  [
11685 \begin_inset Flex Code
11686 status collapsed
11687
11688 \begin_layout Plain Layout
11689 <name>
11690 \end_layout
11691
11692 \end_inset
11693
11694 ] The name of a style whose preamble should be output
11695 \emph on
11696 before
11697 \emph default
11698  this one.
11699  This allows to ensure some ordering of the preamble snippets when macros
11700  definitions depend on one another.
11701 \begin_inset Foot
11702 status collapsed
11703
11704 \begin_layout Plain Layout
11705 Note that, besides that functionality, there is no way to ensure any ordering
11706  of preambles.
11707  The ordering that you see in a given version of \SpecialChar LyX
11708  may change without warning
11709  in later versions.
11710 \end_layout
11711
11712 \end_inset
11713
11714
11715 \end_layout
11716
11717 \begin_layout Description
11718 \begin_inset Flex Code
11719 status collapsed
11720
11721 \begin_layout Plain Layout
11722 EndLabeltype
11723 \end_layout
11724
11725 \end_inset
11726
11727  [
11728 \begin_inset Flex Code
11729 status collapsed
11730
11731 \begin_layout Plain Layout
11732
11733 \emph on
11734 No_Label
11735 \emph default
11736 , Box, Filled_Box, Static
11737 \end_layout
11738
11739 \end_inset
11740
11741 ] The type of label that stands at the end of the paragraph (or sequence
11742  of paragraphs if
11743 \begin_inset Flex Code
11744 status collapsed
11745
11746 \begin_layout Plain Layout
11747 LatexType
11748 \end_layout
11749
11750 \end_inset
11751
11752  is
11753 \begin_inset Newline newline
11754 \end_inset
11755
11756
11757 \begin_inset Flex Code
11758 status collapsed
11759
11760 \begin_layout Plain Layout
11761 Environment
11762 \end_layout
11763
11764 \end_inset
11765
11766 ,
11767 \begin_inset Flex Code
11768 status collapsed
11769
11770 \begin_layout Plain Layout
11771 Item_Environment
11772 \end_layout
11773
11774 \end_inset
11775
11776  or
11777 \begin_inset Flex Code
11778 status collapsed
11779
11780 \begin_layout Plain Layout
11781 List_Environment
11782 \end_layout
11783
11784 \end_inset
11785
11786 ).
11787
11788 \begin_inset Flex Code
11789 status collapsed
11790
11791 \begin_layout Plain Layout
11792 No_Label
11793 \end_layout
11794
11795 \end_inset
11796
11797  means
11798 \begin_inset Quotes eld
11799 \end_inset
11800
11801 nothing
11802 \begin_inset Quotes erd
11803 \end_inset
11804
11805 ,
11806 \begin_inset Flex Code
11807 status collapsed
11808
11809 \begin_layout Plain Layout
11810 Box
11811 \end_layout
11812
11813 \end_inset
11814
11815  (resp.
11816 \begin_inset space \space{}
11817 \end_inset
11818
11819
11820 \begin_inset Flex Code
11821 status collapsed
11822
11823 \begin_layout Plain Layout
11824 Filled_Box
11825 \end_layout
11826
11827 \end_inset
11828
11829 ) is a white (resp.
11830 \begin_inset space ~
11831 \end_inset
11832
11833 black) square suitable for end of proof markers,
11834 \begin_inset Flex Code
11835 status collapsed
11836
11837 \begin_layout Plain Layout
11838 Static
11839 \end_layout
11840
11841 \end_inset
11842
11843  is an explicit text string.
11844 \end_layout
11845
11846 \begin_layout Description
11847 \begin_inset Flex Code
11848 status collapsed
11849
11850 \begin_layout Plain Layout
11851 EndLabelString
11852 \end_layout
11853
11854 \end_inset
11855
11856  [
11857 \begin_inset Flex Code
11858 status collapsed
11859
11860 \begin_layout Plain Layout
11861 string=""
11862 \end_layout
11863
11864 \end_inset
11865
11866 ] The string used for a label with a
11867 \begin_inset Flex Code
11868 status collapsed
11869
11870 \begin_layout Plain Layout
11871 Static
11872 \end_layout
11873
11874 \end_inset
11875
11876
11877 \begin_inset Newline newline
11878 \end_inset
11879
11880
11881 \begin_inset Flex Code
11882 status collapsed
11883
11884 \begin_layout Plain Layout
11885 EndLabelType
11886 \end_layout
11887
11888 \end_inset
11889
11890 .
11891
11892 \end_layout
11893
11894 \begin_layout Description
11895 \begin_inset Flex Code
11896 status collapsed
11897
11898 \begin_layout Plain Layout
11899 Font
11900 \end_layout
11901
11902 \end_inset
11903
11904  The font used for both the text body
11905 \emph on
11906 and
11907 \emph default
11908  the label.
11909  See
11910 \begin_inset CommandInset ref
11911 LatexCommand ref
11912 reference "subsec:Font-description"
11913
11914 \end_inset
11915
11916 .
11917  Note that defining this font automatically defines the
11918 \begin_inset Flex Code
11919 status collapsed
11920
11921 \begin_layout Plain Layout
11922 LabelFont
11923 \end_layout
11924
11925 \end_inset
11926
11927  to the same value.
11928  So you should define this one first if you also want to define
11929 \begin_inset Flex Code
11930 status collapsed
11931
11932 \begin_layout Plain Layout
11933 LabelFont
11934 \end_layout
11935
11936 \end_inset
11937
11938 .
11939 \end_layout
11940
11941 \begin_layout Description
11942 \begin_inset Flex Code
11943 status collapsed
11944
11945 \begin_layout Plain Layout
11946 ForceLocal
11947 \end_layout
11948
11949 \end_inset
11950
11951  [
11952 \begin_inset Flex Code
11953 status collapsed
11954
11955 \begin_layout Plain Layout
11956 int=0
11957 \end_layout
11958
11959 \end_inset
11960
11961 ] Used for backporting new styles to stable \SpecialChar LyX
11962  versions.
11963  The first stable version that supports this tag is \SpecialChar LyX
11964  2.1.0.
11965  The argument is a number which may either be 0, -1 or any value greater
11966  than zero.
11967  If the
11968 \begin_inset Flex Code
11969 status collapsed
11970
11971 \begin_layout Plain Layout
11972 ForceLocal
11973 \end_layout
11974
11975 \end_inset
11976
11977  flag of a style is greater than zero, it will always be written to the
11978  document header.
11979  If a .lyx file is read, the style definitions from the document header are
11980  added to the document class.
11981  Therefore even older \SpecialChar LyX
11982  versions can handle the style.
11983  The argument of
11984 \begin_inset Flex Code
11985 status collapsed
11986
11987 \begin_layout Plain Layout
11988 ForceLocal
11989 \end_layout
11990
11991 \end_inset
11992
11993  is a version number: If the style is read, and the version number is less
11994  than the version number of the already existing style in the document class,
11995  the new style is ignored.
11996  If the version number is greater, the new style replaces the existing style.
11997  A value of -1 means an infinite version number, i.
11998 \begin_inset space \thinspace{}
11999 \end_inset
12000
12001 e.
12002 \begin_inset space \space{}
12003 \end_inset
12004
12005 the style is always used.
12006 \end_layout
12007
12008 \begin_layout Description
12009 \begin_inset Flex Code
12010 status collapsed
12011
12012 \begin_layout Plain Layout
12013 FreeSpacing
12014 \end_layout
12015
12016 \end_inset
12017
12018  [
12019 \begin_inset Flex Code
12020 status collapsed
12021
12022 \begin_layout Plain Layout
12023
12024 \emph on
12025 0
12026 \end_layout
12027
12028 \end_inset
12029
12030 ,
12031 \begin_inset space \thinspace{}
12032 \end_inset
12033
12034
12035 \begin_inset Flex Code
12036 status collapsed
12037
12038 \begin_layout Plain Layout
12039 1
12040 \end_layout
12041
12042 \end_inset
12043
12044 ] Usually \SpecialChar LyX
12045  does not allow you to insert more than one space between words,
12046  since a space is considered as the separation between two words, not a
12047  character or symbol of its own.
12048  This is a very fine thing but sometimes annoying, for example, when typing
12049  program code or plain \SpecialChar LaTeX
12050  code.
12051  For this reason,
12052 \begin_inset Flex Code
12053 status collapsed
12054
12055 \begin_layout Plain Layout
12056 FreeSpacing
12057 \end_layout
12058
12059 \end_inset
12060
12061  can be enabled.
12062  Note that \SpecialChar LyX
12063  will create protected blanks for the additional blanks when
12064  in another mode than \SpecialChar LaTeX
12065 -mode.
12066 \end_layout
12067
12068 \begin_layout Description
12069 \begin_inset Flex Code
12070 status collapsed
12071
12072 \begin_layout Plain Layout
12073 HTML*
12074 \end_layout
12075
12076 \end_inset
12077
12078  These tags are used with XHTML output.
12079  See
12080 \begin_inset CommandInset ref
12081 LatexCommand ref
12082 reference "subsec:Paragraph-Style-XHTML"
12083
12084 \end_inset
12085
12086 .
12087 \end_layout
12088
12089 \begin_layout Description
12090 \begin_inset Flex Code
12091 status collapsed
12092
12093 \begin_layout Plain Layout
12094 InnerTag
12095 \end_layout
12096
12097 \end_inset
12098
12099  [FIXME] (Used only with XML-type formats.)
12100 \end_layout
12101
12102 \begin_layout Description
12103 \begin_inset Flex Code
12104 status collapsed
12105
12106 \begin_layout Plain Layout
12107 InPreamble
12108 \end_layout
12109
12110 \end_inset
12111
12112  [
12113 \begin_inset Flex Code
12114 status collapsed
12115
12116 \begin_layout Plain Layout
12117
12118 \emph on
12119 0
12120 \end_layout
12121
12122 \end_inset
12123
12124 ,
12125 \begin_inset space \thinspace{}
12126 \end_inset
12127
12128
12129 \begin_inset Flex Code
12130 status collapsed
12131
12132 \begin_layout Plain Layout
12133 1
12134 \end_layout
12135
12136 \end_inset
12137
12138 ] If
12139 \begin_inset Flex Code
12140 status collapsed
12141
12142 \begin_layout Plain Layout
12143 1
12144 \end_layout
12145
12146 \end_inset
12147
12148 , marks the style as to be included in the document preamble and not in
12149  the document body.
12150  This is useful for document classes that want such information as the title
12151  and author to appear in the preamble.
12152  Note that this works only for styles for which the
12153 \begin_inset Flex Code
12154 status collapsed
12155
12156 \begin_layout Plain Layout
12157 LatexType
12158 \end_layout
12159
12160 \end_inset
12161
12162  is
12163 \begin_inset Flex Code
12164 status collapsed
12165
12166 \begin_layout Plain Layout
12167 Command
12168 \end_layout
12169
12170 \end_inset
12171
12172  or
12173 \begin_inset Flex Code
12174 status collapsed
12175
12176 \begin_layout Plain Layout
12177 Paragraph
12178 \end_layout
12179
12180 \end_inset
12181
12182 .
12183 \end_layout
12184
12185 \begin_layout Description
12186 \begin_inset Flex Code
12187 status collapsed
12188
12189 \begin_layout Plain Layout
12190 InTitle
12191 \end_layout
12192
12193 \end_inset
12194
12195  [
12196 \begin_inset Flex Code
12197 status collapsed
12198
12199 \begin_layout Plain Layout
12200
12201 \emph on
12202 0
12203 \end_layout
12204
12205 \end_inset
12206
12207 ,
12208 \begin_inset space \thinspace{}
12209 \end_inset
12210
12211
12212 \begin_inset Flex Code
12213 status collapsed
12214
12215 \begin_layout Plain Layout
12216 1
12217 \end_layout
12218
12219 \end_inset
12220
12221 ] If
12222 \begin_inset Flex Code
12223 status collapsed
12224
12225 \begin_layout Plain Layout
12226 1
12227 \end_layout
12228
12229 \end_inset
12230
12231 , marks the style as being part of a title block (see also the
12232 \begin_inset Flex Code
12233 status collapsed
12234
12235 \begin_layout Plain Layout
12236 TitleLatexType
12237 \end_layout
12238
12239 \end_inset
12240
12241  and
12242 \begin_inset Flex Code
12243 status collapsed
12244
12245 \begin_layout Plain Layout
12246 TitleLatexName
12247 \end_layout
12248
12249 \end_inset
12250
12251  global entries).
12252 \end_layout
12253
12254 \begin_layout Description
12255 \begin_inset Flex Code
12256 status collapsed
12257
12258 \begin_layout Plain Layout
12259 ItemCommand
12260 \end_layout
12261
12262 \end_inset
12263
12264  [
12265 \begin_inset Flex Code
12266 status collapsed
12267
12268 \begin_layout Plain Layout
12269 string="item"
12270 \end_layout
12271
12272 \end_inset
12273
12274 ] The \SpecialChar LaTeX
12275  command sequence declaring an item in a list.
12276  The command is to be defined without the preceding backslash (the default
12277  is
12278 \begin_inset Quotes eld
12279 \end_inset
12280
12281 item
12282 \begin_inset Quotes erd
12283 \end_inset
12284
12285 , resulting in
12286 \begin_inset Flex Code
12287 status collapsed
12288
12289 \begin_layout Plain Layout
12290
12291 \backslash
12292 item
12293 \end_layout
12294
12295 \end_inset
12296
12297  in the \SpecialChar LaTeX
12298  output).
12299 \end_layout
12300
12301 \begin_layout Description
12302 \begin_inset Flex Code
12303 status collapsed
12304
12305 \begin_layout Plain Layout
12306 ItemSep
12307 \end_layout
12308
12309 \end_inset
12310
12311  [
12312 \begin_inset Flex Code
12313 status collapsed
12314
12315 \begin_layout Plain Layout
12316 float=0
12317 \end_layout
12318
12319 \end_inset
12320
12321 ] This provides extra space between paragraphs that have the same style.
12322  If you put other styles into an environment, each is separated with the
12323  environment's
12324 \begin_inset Flex Code
12325 status collapsed
12326
12327 \begin_layout Plain Layout
12328 ParSep
12329 \end_layout
12330
12331 \end_inset
12332
12333 .
12334  But the whole items of the environment are additionally separated with
12335  this
12336 \begin_inset Flex Code
12337 status collapsed
12338
12339 \begin_layout Plain Layout
12340 ItemSep
12341 \end_layout
12342
12343 \end_inset
12344
12345 .
12346  Note that this is a
12347 \emph on
12348  multiplier.
12349 \end_layout
12350
12351 \begin_layout Description
12352 \begin_inset Flex Code
12353 status collapsed
12354
12355 \begin_layout Plain Layout
12356 ItemTag
12357 \end_layout
12358
12359 \end_inset
12360
12361  [FIXME] (Used only with XML-type formats.)
12362 \end_layout
12363
12364 \begin_layout Description
12365 \begin_inset Flex Code
12366 status collapsed
12367
12368 \begin_layout Plain Layout
12369 KeepEmpty
12370 \end_layout
12371
12372 \end_inset
12373
12374  [
12375 \begin_inset Flex Code
12376 status collapsed
12377
12378 \begin_layout Plain Layout
12379
12380 \emph on
12381 0
12382 \end_layout
12383
12384 \end_inset
12385
12386 ,
12387 \begin_inset space \thinspace{}
12388 \end_inset
12389
12390
12391 \begin_inset Flex Code
12392 status collapsed
12393
12394 \begin_layout Plain Layout
12395 1
12396 \end_layout
12397
12398 \end_inset
12399
12400 ] Usually \SpecialChar LyX
12401  does not allow you to leave a paragraph empty, since it would
12402  lead to empty \SpecialChar LaTeX
12403  output.
12404  There are some cases where this could be desirable however: in a letter
12405  template, the required fields can be provided as empty fields, so that
12406  people do not forget them; in some special classes, a style can be used
12407  as some kind of break, which does not contain actual text.
12408 \end_layout
12409
12410 \begin_layout Description
12411 \begin_inset Flex Code
12412 status collapsed
12413
12414 \begin_layout Plain Layout
12415 LabelBottomsep
12416 \end_layout
12417
12418 \end_inset
12419
12420  [
12421 \begin_inset Flex Code
12422 status collapsed
12423
12424 \begin_layout Plain Layout
12425 float=0
12426 \end_layout
12427
12428 \end_inset
12429
12430 ] The vertical space between the label and the text body.
12431  Only used for labels that are above the text body (
12432 \begin_inset Flex Code
12433 status collapsed
12434
12435 \begin_layout Plain Layout
12436 Top_Environment
12437 \end_layout
12438
12439 \end_inset
12440
12441  and
12442 \begin_inset Newline newline
12443 \end_inset
12444
12445
12446 \begin_inset Flex Code
12447 status collapsed
12448
12449 \begin_layout Plain Layout
12450 Centered_Top_Environment
12451 \end_layout
12452
12453 \end_inset
12454
12455 ).
12456 \end_layout
12457
12458 \begin_layout Description
12459 \begin_inset Flex Code
12460 status collapsed
12461
12462 \begin_layout Plain Layout
12463 LabelCounter
12464 \end_layout
12465
12466 \end_inset
12467
12468  [
12469 \begin_inset Flex Code
12470 status collapsed
12471
12472 \begin_layout Plain Layout
12473 string=""
12474 \end_layout
12475
12476 \end_inset
12477
12478 ] The name of the counter for automatic numbering.
12479  In order to have the counter appear with your label, you will need to reference
12480  it in the
12481 \begin_inset Flex Code
12482 status collapsed
12483
12484 \begin_layout Plain Layout
12485
12486 \family typewriter
12487 LabelString
12488 \end_layout
12489
12490 \end_inset
12491
12492 .
12493  This will work with
12494 \begin_inset Flex Code
12495 status collapsed
12496
12497 \begin_layout Plain Layout
12498 LabelType
12499 \end_layout
12500
12501 \end_inset
12502
12503 s,
12504 \begin_inset Flex Code
12505 status collapsed
12506
12507 \begin_layout Plain Layout
12508 Static
12509 \end_layout
12510
12511 \end_inset
12512
12513 ,
12514 \begin_inset Flex Code
12515 status collapsed
12516
12517 \begin_layout Plain Layout
12518 Above
12519 \end_layout
12520
12521 \end_inset
12522
12523  and
12524 \begin_inset Flex Code
12525 status collapsed
12526
12527 \begin_layout Plain Layout
12528 Centered
12529 \end_layout
12530
12531 \end_inset
12532
12533 , at least.
12534 \begin_inset Newline newline
12535 \end_inset
12536
12537 This
12538 \emph on
12539 may
12540 \emph default
12541  also be given if
12542 \begin_inset Flex Code
12543 status collapsed
12544
12545 \begin_layout Plain Layout
12546 LabelType
12547 \end_layout
12548
12549 \end_inset
12550
12551  is
12552 \begin_inset Flex Code
12553 status collapsed
12554
12555 \begin_layout Plain Layout
12556 Enumerate
12557 \end_layout
12558
12559 \end_inset
12560
12561 , though this case is a bit complicated.
12562  Suppose you declare
12563 \begin_inset Quotes eld
12564 \end_inset
12565
12566
12567 \begin_inset Flex Code
12568 status collapsed
12569
12570 \begin_layout Plain Layout
12571 LabelCounter myenum
12572 \end_layout
12573
12574 \end_inset
12575
12576
12577 \begin_inset Quotes erd
12578 \end_inset
12579
12580 .
12581  Then the actual counters used are
12582 \begin_inset Flex Code
12583 status collapsed
12584
12585 \begin_layout Plain Layout
12586 myenumi
12587 \end_layout
12588
12589 \end_inset
12590
12591 ,
12592 \begin_inset Flex Code
12593 status collapsed
12594
12595 \begin_layout Plain Layout
12596 myenumii
12597 \end_layout
12598
12599 \end_inset
12600
12601 ,
12602 \begin_inset Flex Code
12603 status collapsed
12604
12605 \begin_layout Plain Layout
12606 myenumiii
12607 \end_layout
12608
12609 \end_inset
12610
12611  and
12612 \begin_inset Flex Code
12613 status collapsed
12614
12615 \begin_layout Plain Layout
12616 myenumiv
12617 \end_layout
12618
12619 \end_inset
12620
12621 , much as in \SpecialChar LaTeX
12622 .
12623  These counters must all be declared separately.
12624 \begin_inset Newline newline
12625 \end_inset
12626
12627 See
12628 \begin_inset CommandInset ref
12629 LatexCommand ref
12630 reference "subsec:Counters"
12631
12632 \end_inset
12633
12634  for details on counters.
12635 \end_layout
12636
12637 \begin_layout Description
12638 \begin_inset Flex Code
12639 status collapsed
12640
12641 \begin_layout Plain Layout
12642 LabelFont
12643 \end_layout
12644
12645 \end_inset
12646
12647  The font used for the label.
12648  See
12649 \begin_inset CommandInset ref
12650 LatexCommand ref
12651 reference "subsec:Font-description"
12652
12653 \end_inset
12654
12655 .
12656 \end_layout
12657
12658 \begin_layout Description
12659 \begin_inset Flex Code
12660 status collapsed
12661
12662 \begin_layout Plain Layout
12663 LabelIndent
12664 \end_layout
12665
12666 \end_inset
12667
12668  [
12669 \begin_inset Flex Code
12670 status collapsed
12671
12672 \begin_layout Plain Layout
12673 string=""
12674 \end_layout
12675
12676 \end_inset
12677
12678 ] Text that indicates how far a label should be indented.
12679 \end_layout
12680
12681 \begin_layout Description
12682 \begin_inset Flex Code
12683 status collapsed
12684
12685 \begin_layout Plain Layout
12686 LabelSep
12687 \end_layout
12688
12689 \end_inset
12690
12691  [
12692 \begin_inset Flex Code
12693 status collapsed
12694
12695 \begin_layout Plain Layout
12696 string=""
12697 \end_layout
12698
12699 \end_inset
12700
12701 ] Text that indicates the amount of horizontal space between the label and
12702  the text body.
12703  Only used for labels that are not above the text body.
12704 \end_layout
12705
12706 \begin_layout Description
12707 \begin_inset Flex Code
12708 status collapsed
12709
12710 \begin_layout Plain Layout
12711 LabelString
12712 \end_layout
12713
12714 \end_inset
12715
12716  [
12717 \begin_inset Flex Code
12718 status collapsed
12719
12720 \begin_layout Plain Layout
12721 string=""
12722 \end_layout
12723
12724 \end_inset
12725
12726 ] The string used for the label.
12727  When
12728 \begin_inset Flex Code
12729 status collapsed
12730
12731 \begin_layout Plain Layout
12732 LabelCounter
12733 \end_layout
12734
12735 \end_inset
12736
12737  is set, this string can be contain the special formatting commands described
12738  in
12739 \begin_inset CommandInset ref
12740 LatexCommand ref
12741 reference "subsec:Counters"
12742
12743 \end_inset
12744
12745 .
12746 \end_layout
12747
12748 \begin_layout Description
12749 \begin_inset Flex Code
12750 status collapsed
12751
12752 \begin_layout Plain Layout
12753 LabelStringAppendix
12754 \end_layout
12755
12756 \end_inset
12757
12758  [
12759 \begin_inset Flex Code
12760 status collapsed
12761
12762 \begin_layout Plain Layout
12763 string=""
12764 \end_layout
12765
12766 \end_inset
12767
12768 ] This is used inside the appendix instead of
12769 \begin_inset Newline newline
12770 \end_inset
12771
12772
12773 \begin_inset Flex Code
12774 status collapsed
12775
12776 \begin_layout Plain Layout
12777 LabelString
12778 \end_layout
12779
12780 \end_inset
12781
12782 .
12783  Note that every
12784 \begin_inset Flex Code
12785 status collapsed
12786
12787 \begin_layout Plain Layout
12788 LabelString
12789 \end_layout
12790
12791 \end_inset
12792
12793  statement resets
12794 \begin_inset Newline newline
12795 \end_inset
12796
12797
12798 \begin_inset Flex Code
12799 status collapsed
12800
12801 \begin_layout Plain Layout
12802 LabelStringAppendix
12803 \end_layout
12804
12805 \end_inset
12806
12807  too.
12808 \end_layout
12809
12810 \begin_layout Description
12811 \begin_inset Flex Code
12812 status collapsed
12813
12814 \begin_layout Plain Layout
12815 LabelTag
12816 \end_layout
12817
12818 \end_inset
12819
12820  [FIXME] (Used only with XML-type formats.)
12821 \end_layout
12822
12823 \begin_layout Description
12824 \begin_inset Flex Code
12825 status collapsed
12826
12827 \begin_layout Plain Layout
12828 LabelType
12829 \end_layout
12830
12831 \end_inset
12832
12833  [
12834 \begin_inset Flex Code
12835 status collapsed
12836
12837 \begin_layout Plain Layout
12838
12839 \emph on
12840 No_Label
12841 \emph default
12842 , Manual, Static, Above,
12843 \begin_inset Newline newline
12844 \end_inset
12845
12846 Centered, Sensitive, Enumerate,
12847 \begin_inset Newline newline
12848 \end_inset
12849
12850 Itemize, Bibliography
12851 \end_layout
12852
12853 \end_inset
12854
12855 ]
12856 \begin_inset Separator parbreak
12857 \end_inset
12858
12859
12860 \end_layout
12861
12862 \begin_deeper
12863 \begin_layout Description
12864 \begin_inset Flex Code
12865 status collapsed
12866
12867 \begin_layout Plain Layout
12868 Manual
12869 \end_layout
12870
12871 \end_inset
12872
12873  means the label is the very first word (up to the first real blank).
12874  Use protected spaces if you want more than one word as the label.
12875
12876 \end_layout
12877
12878 \begin_layout Description
12879 \begin_inset Flex Code
12880 status collapsed
12881
12882 \begin_layout Plain Layout
12883 Static
12884 \end_layout
12885
12886 \end_inset
12887
12888  means the label is simply what is declared as
12889 \begin_inset Flex Code
12890 status collapsed
12891
12892 \begin_layout Plain Layout
12893 LabelString
12894 \end_layout
12895
12896 \end_inset
12897
12898 .
12899  This will be displayed
12900 \begin_inset Quotes eld
12901 \end_inset
12902
12903 inline
12904 \begin_inset Quotes erd
12905 \end_inset
12906
12907 , at the beginning of the paragraph.
12908  If the
12909 \begin_inset Flex Code
12910 status collapsed
12911
12912 \begin_layout Plain Layout
12913 LatexType
12914 \end_layout
12915
12916 \end_inset
12917
12918  is
12919 \begin_inset Flex Code
12920 status collapsed
12921
12922 \begin_layout Plain Layout
12923 Environment
12924 \end_layout
12925
12926 \end_inset
12927
12928 , then it will be displayed only in the first paragraph of any sequence
12929  of paragraphs with the same
12930 \begin_inset Flex Code
12931 status collapsed
12932
12933 \begin_layout Plain Layout
12934 Style
12935 \end_layout
12936
12937 \end_inset
12938
12939 .
12940 \end_layout
12941
12942 \begin_layout Description
12943 \begin_inset Flex Code
12944 status collapsed
12945
12946 \begin_layout Plain Layout
12947 Above
12948 \end_layout
12949
12950 \end_inset
12951
12952
12953 \begin_inset space ~
12954 \end_inset
12955
12956 and
12957 \begin_inset space ~
12958 \end_inset
12959
12960
12961 \begin_inset Flex Code
12962 status collapsed
12963
12964 \begin_layout Plain Layout
12965 Centered
12966 \end_layout
12967
12968 \end_inset
12969
12970  are special cases of
12971 \begin_inset Flex Code
12972 status collapsed
12973
12974 \begin_layout Plain Layout
12975 Static
12976 \end_layout
12977
12978 \end_inset
12979
12980 .
12981  The label will be printed above the paragraph either at the beginning of
12982  the line or centered.
12983 \end_layout
12984
12985 \begin_layout Description
12986 \begin_inset Flex Code
12987 status collapsed
12988
12989 \begin_layout Plain Layout
12990 Sensitive
12991 \end_layout
12992
12993 \end_inset
12994
12995  is a special case for the caption-labels
12996 \begin_inset Quotes eld
12997 \end_inset
12998
12999 Figure
13000 \begin_inset Quotes erd
13001 \end_inset
13002
13003  and
13004 \begin_inset Quotes eld
13005 \end_inset
13006
13007 Table
13008 \begin_inset Quotes erd
13009 \end_inset
13010
13011 .
13012 \begin_inset Newline newline
13013 \end_inset
13014
13015
13016 \begin_inset Flex Code
13017 status collapsed
13018
13019 \begin_layout Plain Layout
13020 Sensitive
13021 \end_layout
13022
13023 \end_inset
13024
13025  means the (hardcoded) label string depends on the kind of float: It is
13026  hardcoded to be `FloatType N', where N is the value of the counter associated
13027  with the float.
13028  For the case that a caption is inserted outside of a float the
13029 \begin_inset Flex Code
13030 status collapsed
13031
13032 \begin_layout Plain Layout
13033 LabelString
13034 \end_layout
13035
13036 \end_inset
13037
13038  will appear as
13039 \begin_inset Quotes eld
13040 \end_inset
13041
13042 Senseless!
13043 \begin_inset Quotes erd
13044 \end_inset
13045
13046 .
13047 \end_layout
13048
13049 \begin_layout Description
13050 \begin_inset Flex Code
13051 status collapsed
13052
13053 \begin_layout Plain Layout
13054 Enumerate
13055 \end_layout
13056
13057 \end_inset
13058
13059  produces the usual sort of enumeration labels.
13060  At present, it is hardcoded to use Arabic numerals, lowercase letters,
13061  small Roman numerals, and uppercase letters for the four possible depths.
13062 \end_layout
13063
13064 \begin_layout Description
13065 \begin_inset Flex Code
13066 status collapsed
13067
13068 \begin_layout Plain Layout
13069 Itemize
13070 \end_layout
13071
13072 \end_inset
13073
13074  produces various bullets at the different levels.
13075  It is also hardcoded.
13076 \end_layout
13077
13078 \begin_layout Description
13079 \begin_inset Flex Code
13080 status collapsed
13081
13082 \begin_layout Plain Layout
13083 Bibliography
13084 \end_layout
13085
13086 \end_inset
13087
13088  should be used only with
13089 \begin_inset Flex Code
13090 status collapsed
13091
13092 \begin_layout Plain Layout
13093 LatexType BibEnvironment
13094 \end_layout
13095
13096 \end_inset
13097
13098 .
13099 \end_layout
13100
13101 \end_deeper
13102 \begin_layout Description
13103 \begin_inset Flex Code
13104 status collapsed
13105
13106 \begin_layout Plain Layout
13107 LangPreamble
13108 \end_layout
13109
13110 \end_inset
13111
13112  Note that this will completely override any prior
13113 \begin_inset Flex Code
13114 status collapsed
13115
13116 \begin_layout Plain Layout
13117 LangPreamble
13118 \end_layout
13119
13120 \end_inset
13121
13122  declaration for this style.
13123  Must end with
13124 \begin_inset Quotes eld
13125 \end_inset
13126
13127
13128 \begin_inset Flex Code
13129 status collapsed
13130
13131 \begin_layout Plain Layout
13132 EndLangPreamble
13133 \end_layout
13134
13135 \end_inset
13136
13137
13138 \begin_inset Quotes erd
13139 \end_inset
13140
13141 .
13142  See
13143 \begin_inset CommandInset ref
13144 LatexCommand ref
13145 reference "subsec:I18n"
13146
13147 \end_inset
13148
13149  for details on its use.
13150 \end_layout
13151
13152 \begin_layout Description
13153 \begin_inset Flex Code
13154 status collapsed
13155
13156 \begin_layout Plain Layout
13157 LatexName
13158 \end_layout
13159
13160 \end_inset
13161
13162  [
13163 \begin_inset Flex Code
13164 status collapsed
13165
13166 \begin_layout Plain Layout
13167 <name>
13168 \end_layout
13169
13170 \end_inset
13171
13172 ] The name of the corresponding \SpecialChar LaTeX
13173  stuff.
13174  Either the environment or command name.
13175 \end_layout
13176
13177 \begin_layout Description
13178 \begin_inset Flex Code
13179 status collapsed
13180
13181 \begin_layout Plain Layout
13182 LatexParam
13183 \end_layout
13184
13185 \end_inset
13186
13187  [
13188 \begin_inset Flex Code
13189 status collapsed
13190
13191 \begin_layout Plain Layout
13192 <parameter>
13193 \end_layout
13194
13195 \end_inset
13196
13197 ] An optional parameter for the corresponding
13198 \begin_inset Flex Code
13199 status collapsed
13200
13201 \begin_layout Plain Layout
13202 LatexName
13203 \end_layout
13204
13205 \end_inset
13206
13207  stuff.
13208  This parameter cannot be changed from within \SpecialChar LyX
13209  (use
13210 \begin_inset Flex Code
13211 status collapsed
13212
13213 \begin_layout Plain Layout
13214 Argument
13215 \end_layout
13216
13217 \end_inset
13218
13219  for customizable parameters).
13220  This will be output as is after all \SpecialChar LaTeX
13221
13222 \begin_inset Flex Code
13223 status collapsed
13224
13225 \begin_layout Plain Layout
13226 Argument
13227 \end_layout
13228
13229 \end_inset
13230
13231 s.
13232 \end_layout
13233
13234 \begin_layout Description
13235 \begin_inset Flex Code
13236 status collapsed
13237
13238 \begin_layout Plain Layout
13239 LatexType
13240 \end_layout
13241
13242 \end_inset
13243
13244  [
13245 \begin_inset Flex Code
13246 status collapsed
13247
13248 \begin_layout Plain Layout
13249
13250 \emph on
13251 Paragraph
13252 \emph default
13253 , Command, Environment, Item_Environment,
13254 \begin_inset Newline newline
13255 \end_inset
13256
13257 List_Environment, Bib_Environment
13258 \end_layout
13259
13260 \end_inset
13261
13262 ] How the style should be translated into \SpecialChar LaTeX
13263 .
13264 \begin_inset Foot
13265 status collapsed
13266
13267 \begin_layout Plain Layout
13268 \begin_inset Flex Code
13269 status collapsed
13270
13271 \begin_layout Plain Layout
13272 LatexType
13273 \end_layout
13274
13275 \end_inset
13276
13277  is perhaps a bit misleading, since these rules apply to SGML classes, too.
13278  Visit the SGML class files for specific examples.
13279 \end_layout
13280
13281 \end_inset
13282
13283
13284 \begin_inset Separator parbreak
13285 \end_inset
13286
13287
13288 \end_layout
13289
13290 \begin_deeper
13291 \begin_layout Description
13292 \begin_inset Flex Code
13293 status collapsed
13294
13295 \begin_layout Plain Layout
13296 Paragraph
13297 \end_layout
13298
13299 \end_inset
13300
13301  means nothing special.
13302 \end_layout
13303
13304 \begin_layout Description
13305 \begin_inset Flex Code
13306 status collapsed
13307
13308 \begin_layout Plain Layout
13309 Command
13310 \end_layout
13311
13312 \end_inset
13313
13314  means
13315 \begin_inset Flex Code
13316 status collapsed
13317
13318 \begin_layout Plain Layout
13319
13320 \backslash
13321
13322 \emph on
13323 LatexName
13324 \emph default
13325 {\SpecialChar ldots
13326 }
13327 \end_layout
13328
13329 \end_inset
13330
13331 .
13332 \end_layout
13333
13334 \begin_layout Description
13335 \begin_inset Flex Code
13336 status collapsed
13337
13338 \begin_layout Plain Layout
13339 Environment
13340 \end_layout
13341
13342 \end_inset
13343
13344  means
13345 \begin_inset Flex Code
13346 status collapsed
13347
13348 \begin_layout Plain Layout
13349
13350 \backslash
13351 begin{
13352 \emph on
13353 LatexName
13354 \emph default
13355 }\SpecialChar ldots
13356
13357 \backslash
13358 end{
13359 \emph on
13360 LatexName
13361 \emph default
13362 }
13363 \end_layout
13364
13365 \end_inset
13366
13367 .
13368
13369 \end_layout
13370
13371 \begin_layout Description
13372 \begin_inset Flex Code
13373 status collapsed
13374
13375 \begin_layout Plain Layout
13376 Item_Environment
13377 \end_layout
13378
13379 \end_inset
13380
13381  is the same as
13382 \begin_inset Flex Code
13383 status collapsed
13384
13385 \begin_layout Plain Layout
13386 Environment
13387 \end_layout
13388
13389 \end_inset
13390
13391 , except that an
13392 \begin_inset Flex Code
13393 status collapsed
13394
13395 \begin_layout Plain Layout
13396
13397 \backslash
13398 item
13399 \end_layout
13400
13401 \end_inset
13402
13403  is generated for each paragraph of this environment.
13404
13405 \end_layout
13406
13407 \begin_layout Description
13408 \begin_inset Flex Code
13409 status collapsed
13410
13411 \begin_layout Plain Layout
13412 List_Environment
13413 \end_layout
13414
13415 \end_inset
13416
13417  is the same as
13418 \begin_inset Flex Code
13419 status collapsed
13420
13421 \begin_layout Plain Layout
13422 Item_Environment
13423 \end_layout
13424
13425 \end_inset
13426
13427 , except that
13428 \begin_inset Newline newline
13429 \end_inset
13430
13431
13432 \begin_inset Flex Code
13433 status collapsed
13434
13435 \begin_layout Plain Layout
13436 LabelWidthString
13437 \end_layout
13438
13439 \end_inset
13440
13441  is passed as an argument to the environment.
13442 \begin_inset Newline newline
13443 \end_inset
13444
13445
13446 \begin_inset Flex Code
13447 status collapsed
13448
13449 \begin_layout Plain Layout
13450 LabelWidthString
13451 \end_layout
13452
13453 \end_inset
13454
13455  can be defined in the
13456 \begin_inset Flex MenuItem
13457 status collapsed
13458
13459 \begin_layout Plain Layout
13460 Edit\SpecialChar menuseparator
13461 Paragraph
13462 \begin_inset space ~
13463 \end_inset
13464
13465 settings
13466 \end_layout
13467
13468 \end_inset
13469
13470  dialog.
13471 \end_layout
13472
13473 \begin_layout Description
13474 \begin_inset Flex Code
13475 status collapsed
13476
13477 \begin_layout Plain Layout
13478 Bib_Environment
13479 \end_layout
13480
13481 \end_inset
13482
13483  is like
13484 \begin_inset Flex Code
13485 status collapsed
13486
13487 \begin_layout Plain Layout
13488 Environment
13489 \end_layout
13490
13491 \end_inset
13492
13493  but adds additionally the necessary mandatory argument (the longest label)
13494  to the begin statement of the bibliography environment:
13495 \begin_inset Newline newline
13496 \end_inset
13497
13498
13499 \begin_inset Flex Code
13500 status collapsed
13501
13502 \begin_layout Plain Layout
13503
13504 \backslash
13505 begin{thebibliography}{99}
13506 \end_layout
13507
13508 \end_inset
13509
13510  It is therefore only useful for bibliography environments.
13511  The default longest label
13512 \begin_inset Quotes eld
13513 \end_inset
13514
13515 99
13516 \begin_inset Quotes erd
13517 \end_inset
13518
13519  can be changed by the user in the paragraph settings of a bibliography
13520  item.
13521 \end_layout
13522
13523 \begin_layout Standard
13524 Putting the last few things together, the \SpecialChar LaTeX
13525  output will be either:
13526 \end_layout
13527
13528 \begin_layout LyX-Code
13529
13530 \backslash
13531 LatexName[LatexParam]{\SpecialChar ldots
13532 }
13533 \end_layout
13534
13535 \begin_layout Standard
13536 or:
13537 \end_layout
13538
13539 \begin_layout LyX-Code
13540
13541 \backslash
13542 begin{LatexName}[LatexParam] \SpecialChar ldots
13543
13544 \backslash
13545 end{LatexName}.
13546 \end_layout
13547
13548 \begin_layout Standard
13549 depending upon the \SpecialChar LaTeX
13550  type.
13551 \end_layout
13552
13553 \end_deeper
13554 \begin_layout Description
13555 \begin_inset Flex Code
13556 status collapsed
13557
13558 \begin_layout Plain Layout
13559 LeftDelim
13560 \end_layout
13561
13562 \end_inset
13563
13564  [
13565 \begin_inset Flex Code
13566 status collapsed
13567
13568 \begin_layout Plain Layout
13569 string
13570 \end_layout
13571
13572 \end_inset
13573
13574 ] A string that is put at the beginning of the style content.
13575  A line break in the output can be indicated by
13576 \begin_inset Flex Code
13577 status collapsed
13578
13579 \begin_layout Plain Layout
13580 <br/>
13581 \end_layout
13582
13583 \end_inset
13584
13585 .
13586 \end_layout
13587
13588 \begin_layout Description
13589 \begin_inset Flex Code
13590 status collapsed
13591
13592 \begin_layout Plain Layout
13593 LeftMargin
13594 \end_layout
13595
13596 \end_inset
13597
13598  [
13599 \begin_inset Flex Code
13600 status collapsed
13601
13602 \begin_layout Plain Layout
13603 string=""
13604 \end_layout
13605
13606 \end_inset
13607
13608 ] If you put styles into environments, the different
13609 \begin_inset Flex Code
13610 status collapsed
13611
13612 \begin_layout Plain Layout
13613 LeftMargin
13614 \end_layout
13615
13616 \end_inset
13617
13618  are not simply added, but added with a factor
13619 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
13620 \end_inset
13621
13622 .
13623  Note that this parameter is also used when
13624 \begin_inset Flex Code
13625 status collapsed
13626
13627 \begin_layout Plain Layout
13628 Margin
13629 \end_layout
13630
13631 \end_inset
13632
13633  is defined as
13634 \begin_inset Flex Code
13635 status collapsed
13636
13637 \begin_layout Plain Layout
13638 Manual
13639 \end_layout
13640
13641 \end_inset
13642
13643  or
13644 \begin_inset Flex Code
13645 status collapsed
13646
13647 \begin_layout Plain Layout
13648 Dynamic
13649 \end_layout
13650
13651 \end_inset
13652
13653 .
13654  Then it is added to the manual or dynamic margin.
13655 \begin_inset Newline newline
13656 \end_inset
13657
13658 For example
13659 \begin_inset Quotes eld
13660 \end_inset
13661
13662
13663 \begin_inset Flex Code
13664 status collapsed
13665
13666 \begin_layout Plain Layout
13667 MM
13668 \end_layout
13669
13670 \end_inset
13671
13672
13673 \begin_inset Quotes erd
13674 \end_inset
13675
13676  means that the paragraph is indented with the width of
13677 \begin_inset Quotes eld
13678 \end_inset
13679
13680
13681 \begin_inset Flex Code
13682 status collapsed
13683
13684 \begin_layout Plain Layout
13685 MM
13686 \end_layout
13687
13688 \end_inset
13689
13690
13691 \begin_inset Quotes erd
13692 \end_inset
13693
13694  in the normal font.
13695  You can get a negative width by prefixing the string with
13696 \begin_inset Quotes eld
13697 \end_inset
13698
13699
13700 \begin_inset Flex Code
13701 status collapsed
13702
13703 \begin_layout Plain Layout
13704 -
13705 \end_layout
13706
13707 \end_inset
13708
13709
13710 \begin_inset Quotes erd
13711 \end_inset
13712
13713 .
13714  This way was chosen so that the look is the same with each used screen
13715  font.
13716 \end_layout
13717
13718 \begin_layout Description
13719 \begin_inset Flex Code
13720 status collapsed
13721
13722 \begin_layout Plain Layout
13723 Margin
13724 \end_layout
13725
13726 \end_inset
13727
13728  [
13729 \begin_inset Flex Code
13730 status collapsed
13731
13732 \begin_layout Plain Layout
13733
13734 \emph on
13735 Static
13736 \emph default
13737 , Manual, Dynamic, First_Dynamic, Right_Address_Box
13738 \end_layout
13739
13740 \end_inset
13741
13742 ]
13743 \begin_inset Newline newline
13744 \end_inset
13745
13746 The kind of margin that the style has on the left side.
13747 \begin_inset Separator parbreak
13748 \end_inset
13749
13750
13751 \end_layout
13752
13753 \begin_deeper
13754 \begin_layout Description
13755 \begin_inset Flex Code
13756 status collapsed
13757
13758 \begin_layout Plain Layout
13759 Static
13760 \end_layout
13761
13762 \end_inset
13763
13764  just means a fixed margin.
13765 \end_layout
13766
13767 \begin_layout Description
13768 \begin_inset Flex Code
13769 status collapsed
13770
13771 \begin_layout Plain Layout
13772 Manual
13773 \end_layout
13774
13775 \end_inset
13776
13777  means that the left margin depends on the string entered in the
13778 \begin_inset Flex MenuItem
13779 status collapsed
13780
13781 \begin_layout Plain Layout
13782 Edit\SpecialChar menuseparator
13783 Paragraph
13784 \begin_inset space ~
13785 \end_inset
13786
13787 Settings
13788 \end_layout
13789
13790 \end_inset
13791
13792  dialog.
13793  This is used to typeset nice lists without tabulators.
13794 \end_layout
13795
13796 \begin_layout Description
13797 \begin_inset Flex Code
13798 status collapsed
13799
13800 \begin_layout Plain Layout
13801 Dynamic
13802 \end_layout
13803
13804 \end_inset
13805
13806  means that the margin depends on the size of the label.
13807  This is used for automatic enumerated headlines.
13808  It is obvious that the headline
13809 \begin_inset Quotes eld
13810 \end_inset
13811
13812 5.4.3.2.1 Very long headline
13813 \begin_inset Quotes erd
13814 \end_inset
13815
13816  must have a wider left margin (as wide as
13817 \begin_inset Quotes eld
13818 \end_inset
13819
13820 5.4.3.2.1
13821 \begin_inset Quotes erd
13822 \end_inset
13823
13824  plus the space) than
13825 \begin_inset Quotes eld
13826 \end_inset
13827
13828 3.2 Very long headline
13829 \begin_inset Quotes erd
13830 \end_inset
13831
13832 , even if standard
13833 \begin_inset Quotes eld
13834 \end_inset
13835
13836 word processors
13837 \begin_inset Quotes erd
13838 \end_inset
13839
13840  are not able to do this.
13841 \end_layout
13842
13843 \begin_layout Description
13844 \begin_inset Flex Code
13845 status collapsed
13846
13847 \begin_layout Plain Layout
13848 First_Dynamic
13849 \end_layout
13850
13851 \end_inset
13852
13853  is similar, but only the very first row of the paragraph is dynamic, while
13854  the others are static; this is used, for example, for descriptions.
13855 \end_layout
13856
13857 \begin_layout Description
13858 \begin_inset Flex Code
13859 status collapsed
13860
13861 \begin_layout Plain Layout
13862 Right_Address_Box
13863 \end_layout
13864
13865 \end_inset
13866
13867  means the margin is chosen in a way that the longest row of this paragraph
13868  fits to the right margin.
13869  This is used to typeset an address on the right edge of the page.
13870 \end_layout
13871
13872 \end_deeper
13873 \begin_layout Description
13874 \begin_inset Flex Code
13875 status collapsed
13876
13877 \begin_layout Plain Layout
13878 NeedProtect
13879 \end_layout
13880
13881 \end_inset
13882
13883  [
13884 \begin_inset Flex Code
13885 status collapsed
13886
13887 \begin_layout Plain Layout
13888
13889 \emph on
13890 0
13891 \end_layout
13892
13893 \end_inset
13894
13895 ,
13896 \begin_inset space \thinspace{}
13897 \end_inset
13898
13899
13900 \begin_inset Flex Code
13901 status collapsed
13902
13903 \begin_layout Plain Layout
13904 1
13905 \end_layout
13906
13907 \end_inset
13908
13909 ] Whether fragile commands in this style should be
13910 \begin_inset Flex Code
13911 status collapsed
13912
13913 \begin_layout Plain Layout
13914
13915 \backslash
13916 protect
13917 \end_layout
13918
13919 \end_inset
13920
13921 'ed.
13922  (Note: This is
13923 \emph on
13924 not
13925 \emph default
13926  whether this command should itself be protected.)
13927 \end_layout
13928
13929 \begin_layout Description
13930 \begin_inset Flex Code
13931 status collapsed
13932
13933 \begin_layout Plain Layout
13934 Newline
13935 \end_layout
13936
13937 \end_inset
13938
13939  [
13940 \begin_inset Flex Code
13941 status collapsed
13942
13943 \begin_layout Plain Layout
13944 0
13945 \end_layout
13946
13947 \end_inset
13948
13949 ,
13950 \begin_inset space \thinspace{}
13951 \end_inset
13952
13953
13954 \begin_inset Flex Code
13955 status collapsed
13956
13957 \begin_layout Plain Layout
13958
13959 \emph on
13960 1
13961 \end_layout
13962
13963 \end_inset
13964
13965 ] Whether newlines are translated into \SpecialChar LaTeX
13966  newlines (
13967 \begin_inset Flex Code
13968 status collapsed
13969
13970 \begin_layout Plain Layout
13971
13972 \backslash
13973
13974 \backslash
13975
13976 \end_layout
13977
13978 \end_inset
13979
13980 ) or not.
13981  The translation can be switched off to allow more comfortable \SpecialChar LaTeX
13982  editing
13983  inside \SpecialChar LyX
13984 .
13985 \end_layout
13986
13987 \begin_layout Description
13988 \begin_inset Flex Code
13989 status collapsed
13990
13991 \begin_layout Plain Layout
13992 NextNoIndent
13993 \end_layout
13994
13995 \end_inset
13996
13997  [
13998 \begin_inset Flex Code
13999 status collapsed
14000
14001 \begin_layout Plain Layout
14002
14003 \emph on
14004 0
14005 \end_layout
14006
14007 \end_inset
14008
14009 ,
14010 \begin_inset space \thinspace{}
14011 \end_inset
14012
14013
14014 \begin_inset Flex Code
14015 status collapsed
14016
14017 \begin_layout Plain Layout
14018 1
14019 \end_layout
14020
14021 \end_inset
14022
14023 ] If set to true, and if
14024 \begin_inset Flex Code
14025 status collapsed
14026
14027 \begin_layout Plain Layout
14028 DefaultStyle
14029 \end_layout
14030
14031 \end_inset
14032
14033  (usually
14034 \begin_inset Flex Code
14035 status collapsed
14036
14037 \begin_layout Plain Layout
14038 Standard
14039 \end_layout
14040
14041 \end_inset
14042
14043 ) paragraphs are being indented, then the indentation of such a paragraph
14044  following one of this type will be suppressed.
14045  (So this will not affect the display of non-default paragraphs.)
14046 \end_layout
14047
14048 \begin_layout Description
14049 \begin_inset Flex Code
14050 status collapsed
14051
14052 \begin_layout Plain Layout
14053 ObsoletedBy
14054 \end_layout
14055
14056 \end_inset
14057
14058  [
14059 \begin_inset Flex Code
14060 status collapsed
14061
14062 \begin_layout Plain Layout
14063 <name>
14064 \end_layout
14065
14066 \end_inset
14067
14068 ] Name of a style that has replaced this style.
14069  This is used to rename a style, while keeping backward compatibility.
14070 \change_inserted -712698321 1432986397
14071
14072 \end_layout
14073
14074 \begin_layout Description
14075
14076 \change_inserted -712698321 1432986583
14077 \begin_inset Flex Code
14078 status collapsed
14079
14080 \begin_layout Plain Layout
14081
14082 \change_inserted -712698321 1432986403
14083 ParagraphGroup
14084 \end_layout
14085
14086 \end_inset
14087
14088  [
14089 \begin_inset Flex Code
14090 status collapsed
14091
14092 \begin_layout Plain Layout
14093
14094 \change_inserted -712698321 1432986397
14095 0
14096 \end_layout
14097
14098 \end_inset
14099
14100 ,
14101 \begin_inset space \thinspace{}
14102 \end_inset
14103
14104
14105 \begin_inset Flex Code
14106 status collapsed
14107
14108 \begin_layout Plain Layout
14109
14110 \change_inserted -712698321 1432986397
14111 1
14112 \end_layout
14113
14114 \end_inset
14115
14116 ] Determines whether consecutive pragraphs of the same type are treated
14117  as belonging together.
14118  This has the effect that the
14119 \begin_inset Flex Code
14120 status collapsed
14121
14122 \begin_layout Plain Layout
14123
14124 \change_inserted -712698321 1432986460
14125 GuiLabel
14126 \end_layout
14127
14128 \end_inset
14129
14130  is only printed once before such a group.
14131  By default, this is true for
14132 \begin_inset Flex Code
14133 status collapsed
14134
14135 \begin_layout Plain Layout
14136
14137 \change_inserted -712698321 1432986491
14138 LaTeXType
14139 \end_layout
14140
14141 \end_inset
14142
14143
14144 \begin_inset Flex Code
14145 status collapsed
14146
14147 \begin_layout Plain Layout
14148
14149 \change_inserted -712698321 1432986583
14150 Environment
14151 \change_unchanged
14152
14153 \end_layout
14154
14155 \end_inset
14156
14157  and
14158 \begin_inset Flex Code
14159 status collapsed
14160
14161 \begin_layout Plain Layout
14162
14163 \change_inserted -712698321 1432986572
14164 Bib_Environment
14165 \change_unchanged
14166
14167 \end_layout
14168
14169 \end_inset
14170
14171  and false for all other types.
14172 \change_unchanged
14173
14174 \end_layout
14175
14176 \begin_layout Description
14177 \begin_inset Flex Code
14178 status collapsed
14179
14180 \begin_layout Plain Layout
14181 ParbreakIsNewline
14182 \end_layout
14183
14184 \end_inset
14185
14186  [
14187 \begin_inset Flex Code
14188 status collapsed
14189
14190 \begin_layout Plain Layout
14191
14192 \emph on
14193 0
14194 \end_layout
14195
14196 \end_inset
14197
14198 ,
14199 \begin_inset space \thinspace{}
14200 \end_inset
14201
14202
14203 \begin_inset Flex Code
14204 status collapsed
14205
14206 \begin_layout Plain Layout
14207 1
14208 \end_layout
14209
14210 \end_inset
14211
14212 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
14213  output,
14214  but only by a line break; together with
14215 \begin_inset Flex Code
14216 status collapsed
14217
14218 \begin_layout Plain Layout
14219 PassThru 1
14220 \end_layout
14221
14222 \end_inset
14223
14224 , this allows to emulate a plain text editor (like the ERT inset).
14225 \end_layout
14226
14227 \begin_layout Description
14228 \begin_inset Flex Code
14229 status collapsed
14230
14231 \begin_layout Plain Layout
14232 ParIndent
14233 \end_layout
14234
14235 \end_inset
14236
14237  [
14238 \begin_inset Flex Code
14239 status collapsed
14240
14241 \begin_layout Plain Layout
14242 string=""
14243 \end_layout
14244
14245 \end_inset
14246
14247 ] The indent of the very first line of a paragraph.
14248  The
14249 \begin_inset Newline newline
14250 \end_inset
14251
14252
14253 \begin_inset Flex Code
14254 status collapsed
14255
14256 \begin_layout Plain Layout
14257 Parindent
14258 \end_layout
14259
14260 \end_inset
14261
14262  will be fixed for a certain style.
14263  The exception is the default style, since the indentation for these paragraphs
14264  can be prohibited with
14265 \begin_inset Flex Code
14266 status collapsed
14267
14268 \begin_layout Plain Layout
14269 NextNoIndent
14270 \end_layout
14271
14272 \end_inset
14273
14274 .
14275  Also,
14276 \begin_inset Flex Code
14277 status collapsed
14278
14279 \begin_layout Plain Layout
14280 Standard
14281 \end_layout
14282
14283 \end_inset
14284
14285  style paragraphs inside environments use the
14286 \begin_inset Flex Code
14287 status collapsed
14288
14289 \begin_layout Plain Layout
14290 Parindent
14291 \end_layout
14292
14293 \end_inset
14294
14295  of the environment, not their native one.
14296  For example,
14297 \begin_inset Flex Code
14298 status collapsed
14299
14300 \begin_layout Plain Layout
14301 Standard
14302 \end_layout
14303
14304 \end_inset
14305
14306  paragraphs inside an enumeration are not indented.
14307 \end_layout
14308
14309 \begin_layout Description
14310 \begin_inset Flex Code
14311 status collapsed
14312
14313 \begin_layout Plain Layout
14314 ParSep
14315 \end_layout
14316
14317 \end_inset
14318
14319  [
14320 \begin_inset Flex Code
14321 status collapsed
14322
14323 \begin_layout Plain Layout
14324 float=0
14325 \end_layout
14326
14327 \end_inset
14328
14329 ] The vertical space between two paragraphs of this style.
14330 \end_layout
14331
14332 \begin_layout Description
14333 \begin_inset Flex Code
14334 status collapsed
14335
14336 \begin_layout Plain Layout
14337 Parskip
14338 \end_layout
14339
14340 \end_inset
14341
14342  [
14343 \begin_inset Flex Code
14344 status collapsed
14345
14346 \begin_layout Plain Layout
14347 float=0
14348 \end_layout
14349
14350 \end_inset
14351
14352 ] \SpecialChar LyX
14353  allows the user to choose either
14354 \begin_inset Quotes eld
14355 \end_inset
14356
14357 indent
14358 \begin_inset Quotes erd
14359 \end_inset
14360
14361  or
14362 \begin_inset Quotes eld
14363 \end_inset
14364
14365 skip
14366 \begin_inset Quotes erd
14367 \end_inset
14368
14369  to separate paragraphs.
14370  When
14371 \begin_inset Quotes eld
14372 \end_inset
14373
14374 indent
14375 \begin_inset Quotes erd
14376 \end_inset
14377
14378  is chosen,
14379 \begin_inset Flex Code
14380 status collapsed
14381
14382 \begin_layout Plain Layout
14383 Parskip
14384 \end_layout
14385
14386 \end_inset
14387
14388  is ignored.
14389  When
14390 \begin_inset Quotes eld
14391 \end_inset
14392
14393 skip
14394 \begin_inset Quotes erd
14395 \end_inset
14396
14397  is chosen,
14398 \begin_inset Flex Code
14399 status collapsed
14400
14401 \begin_layout Plain Layout
14402 ParIndent
14403 \end_layout
14404
14405 \end_inset
14406
14407  is ignored and all paragraphs are separated by the
14408 \begin_inset Flex Code
14409 status collapsed
14410
14411 \begin_layout Plain Layout
14412 Parskip
14413 \end_layout
14414
14415 \end_inset
14416
14417  argument.
14418  The vertical space is calculated with
14419 \begin_inset Flex Code
14420 status collapsed
14421
14422 \begin_layout Plain Layout
14423 Parskip
14424 \begin_inset space ~
14425 \end_inset
14426
14427 * DefaultHeight
14428 \end_layout
14429
14430 \end_inset
14431
14432  where
14433 \begin_inset Flex Code
14434 status collapsed
14435
14436 \begin_layout Plain Layout
14437 DefaultHeight
14438 \end_layout
14439
14440 \end_inset
14441
14442  is the height of a row with the normal font.
14443  This way, the look stays the same with different screen fonts.
14444 \end_layout
14445
14446 \begin_layout Description
14447 \begin_inset Flex Code
14448 status collapsed
14449
14450 \begin_layout Plain Layout
14451 PassThru
14452 \end_layout
14453
14454 \end_inset
14455
14456  [
14457 \begin_inset Flex Code
14458 status collapsed
14459
14460 \begin_layout Plain Layout
14461
14462 \emph on
14463 0
14464 \end_layout
14465
14466 \end_inset
14467
14468 ,
14469 \begin_inset space \thinspace{}
14470 \end_inset
14471
14472
14473 \begin_inset Flex Code
14474 status collapsed
14475
14476 \begin_layout Plain Layout
14477 1
14478 \end_layout
14479
14480 \end_inset
14481
14482 ] Whether the contents of this paragraph should be output in raw form, meaning
14483  without special translations that \SpecialChar LaTeX
14484  would require.
14485 \change_inserted -712698321 1429534178
14486
14487 \end_layout
14488
14489 \begin_layout Description
14490
14491 \change_inserted -712698321 1429534242
14492
14493 \lang ngerman
14494 \begin_inset Flex Code
14495 status collapsed
14496
14497 \begin_layout Plain Layout
14498
14499 \change_inserted -712698321 1429534178
14500 PassThruChars
14501 \end_layout
14502
14503 \end_inset
14504
14505
14506 \lang english
14507  [
14508 \begin_inset Flex Code
14509 status collapsed
14510
14511 \begin_layout Plain Layout
14512
14513 \change_inserted -712698321 1429534178
14514 string of characters
14515 \end_layout
14516
14517 \end_inset
14518
14519 ]
14520 \family typewriter
14521
14522 \family default
14523 Defines individual characters that should be output in raw form, meaning
14524  without special translations that \SpecialChar LaTeX
14525  would require.
14526 \change_unchanged
14527
14528 \end_layout
14529
14530 \begin_layout Description
14531 \begin_inset Flex Code
14532 status collapsed
14533
14534 \begin_layout Plain Layout
14535 Preamble
14536 \end_layout
14537
14538 \end_inset
14539
14540  Information to be included in the \SpecialChar LaTeX
14541  preamble when this style is used.
14542  Used to define macros, load packages, etc., required by this particular
14543  style.
14544  Must end with
14545 \begin_inset Quotes eld
14546 \end_inset
14547
14548
14549 \begin_inset Flex Code
14550 status collapsed
14551
14552 \begin_layout Plain Layout
14553 EndPreamble
14554 \end_layout
14555
14556 \end_inset
14557
14558
14559 \begin_inset Quotes erd
14560 \end_inset
14561
14562 .
14563 \end_layout
14564
14565 \begin_layout Description
14566 \begin_inset Flex Code
14567 status collapsed
14568
14569 \begin_layout Plain Layout
14570 RefPrefix
14571 \end_layout
14572
14573 \end_inset
14574
14575  [
14576 \begin_inset Flex Code
14577 status collapsed
14578
14579 \begin_layout Plain Layout
14580 string
14581 \end_layout
14582
14583 \end_inset
14584
14585 ] The prefix to use when creating labels referring to paragraphs of this
14586  type.
14587  This allows the use of formatted references.
14588 \end_layout
14589
14590 \begin_layout Description
14591 \begin_inset Flex Code
14592 status collapsed
14593
14594 \begin_layout Plain Layout
14595 Requires
14596 \end_layout
14597
14598 \end_inset
14599
14600  [
14601 \begin_inset Flex Code
14602 status collapsed
14603
14604 \begin_layout Plain Layout
14605 string
14606 \end_layout
14607
14608 \end_inset
14609
14610 ] Whether the style requires the feature
14611 \begin_inset Flex Code
14612 status collapsed
14613
14614 \begin_layout Plain Layout
14615 string
14616 \end_layout
14617
14618 \end_inset
14619
14620
14621 \change_deleted -712698321 1438601713
14622 .
14623
14624 \change_unchanged
14625
14626 \change_deleted -712698321 1438601638
14627 See the description of
14628 \begin_inset Flex Code
14629 status collapsed
14630
14631 \begin_layout Plain Layout
14632 Provides
14633 \end_layout
14634
14635 \end_inset
14636
14637  above (
14638 \begin_inset CommandInset ref
14639 LatexCommand ref
14640 reference "subsec:General-text-class"
14641
14642 \end_inset
14643
14644 ) for information on `features'.
14645 \change_inserted -712698321 1438601711
14646 (see
14647 \begin_inset CommandInset ref
14648 LatexCommand ref
14649 reference "chap:List-of-functions"
14650
14651 \end_inset
14652
14653  for the list of features).
14654  If you require a package with specific options, you can additionally use
14655
14656 \begin_inset Flex Code
14657 status collapsed
14658
14659 \begin_layout Plain Layout
14660
14661 \change_inserted -712698321 1438601638
14662 PackageOptions
14663 \end_layout
14664
14665 \end_inset
14666
14667  as a general text class parameter (see sec.
14668 \begin_inset space ~
14669 \end_inset
14670
14671
14672 \begin_inset CommandInset ref
14673 LatexCommand ref
14674 reference "subsec:General-text-class"
14675
14676 \end_inset
14677
14678 ).
14679 \change_unchanged
14680
14681 \end_layout
14682
14683 \begin_layout Description
14684 \begin_inset Flex Code
14685 status collapsed
14686
14687 \begin_layout Plain Layout
14688 ResetArgs
14689 \end_layout
14690
14691 \end_inset
14692
14693  [
14694 \begin_inset Flex Code
14695 status collapsed
14696
14697 \begin_layout Plain Layout
14698
14699 \emph on
14700 0
14701 \end_layout
14702
14703 \end_inset
14704
14705 ,
14706 \begin_inset Flex Code
14707 status collapsed
14708
14709 \begin_layout Plain Layout
14710 1
14711 \end_layout
14712
14713 \end_inset
14714
14715 ] Resets the \SpecialChar LaTeX
14716  arguments of this style (as defined via the
14717 \begin_inset Flex Code
14718 status collapsed
14719
14720 \begin_layout Plain Layout
14721 Argument
14722 \end_layout
14723
14724 \end_inset
14725
14726  tag).
14727  This is useful if you have copied a style via
14728 \begin_inset Flex Code
14729 status collapsed
14730
14731 \begin_layout Plain Layout
14732 CopyStyle
14733 \end_layout
14734
14735 \end_inset
14736
14737 , but you do not want to inherit its (required and optional) arguments.
14738 \end_layout
14739
14740 \begin_layout Description
14741 \begin_inset Flex Code
14742 status collapsed
14743
14744 \begin_layout Plain Layout
14745 RightDelim
14746 \end_layout
14747
14748 \end_inset
14749
14750  [
14751 \begin_inset Flex Code
14752 status collapsed
14753
14754 \begin_layout Plain Layout
14755 string
14756 \end_layout
14757
14758 \end_inset
14759
14760 ] A string that is put at the end of the layout content.
14761  A line break in the output can be indicated by
14762 \begin_inset Flex Code
14763 status collapsed
14764
14765 \begin_layout Plain Layout
14766 <br/>
14767 \end_layout
14768
14769 \end_inset
14770
14771 .
14772 \end_layout
14773
14774 \begin_layout Description
14775 \begin_inset Flex Code
14776 status collapsed
14777
14778 \begin_layout Plain Layout
14779 RightMargin
14780 \end_layout
14781
14782 \end_inset
14783
14784  [
14785 \begin_inset Flex Code
14786 status collapsed
14787
14788 \begin_layout Plain Layout
14789 string=""
14790 \end_layout
14791
14792 \end_inset
14793
14794 ] Similar to
14795 \begin_inset Flex Code
14796 status collapsed
14797
14798 \begin_layout Plain Layout
14799 LeftMargin
14800 \end_layout
14801
14802 \end_inset
14803
14804 .
14805 \end_layout
14806
14807 \begin_layout Description
14808 \begin_inset Flex Code
14809 status collapsed
14810
14811 \begin_layout Plain Layout
14812 Spacing
14813 \end_layout
14814
14815 \end_inset
14816
14817  [
14818 \begin_inset Flex Code
14819 status collapsed
14820
14821 \begin_layout Plain Layout
14822
14823 \emph on
14824 single
14825 \end_layout
14826
14827 \end_inset
14828
14829 ,
14830 \begin_inset Flex Code
14831 status collapsed
14832
14833 \begin_layout Plain Layout
14834 onehalf
14835 \end_layout
14836
14837 \end_inset
14838
14839 ,
14840 \begin_inset Flex Code
14841 status collapsed
14842
14843 \begin_layout Plain Layout
14844 double
14845 \end_layout
14846
14847 \end_inset
14848
14849 ,
14850 \begin_inset Flex Code
14851 status collapsed
14852
14853 \begin_layout Plain Layout
14854 other
14855 \begin_inset space ~
14856 \end_inset
14857
14858 <value>
14859 \end_layout
14860
14861 \end_inset
14862
14863 ] This defines what the default spacing should be in the style.
14864  The arguments
14865 \begin_inset Flex Code
14866 status collapsed
14867
14868 \begin_layout Plain Layout
14869 single
14870 \end_layout
14871
14872 \end_inset
14873
14874 ,
14875 \begin_inset Flex Code
14876 status collapsed
14877
14878 \begin_layout Plain Layout
14879 onehalf
14880 \end_layout
14881
14882 \end_inset
14883
14884  and
14885 \begin_inset Flex Code
14886 status collapsed
14887
14888 \begin_layout Plain Layout
14889 double
14890 \end_layout
14891
14892 \end_inset
14893
14894  correspond respectively to a multiplier value of 1, 1.25 and 1.667.
14895  If you specify the argument
14896 \begin_inset Flex Code
14897 status collapsed
14898
14899 \begin_layout Plain Layout
14900 other
14901 \end_layout
14902
14903 \end_inset
14904
14905 , then you must also provide a value argument which will be the actual multiplie
14906 r value.
14907  Note that, contrary to other parameters,
14908 \begin_inset Flex Code
14909 status collapsed
14910
14911 \begin_layout Plain Layout
14912 Spacing
14913 \end_layout
14914
14915 \end_inset
14916
14917  implies the generation of specific \SpecialChar LaTeX
14918  code, using the \SpecialChar LaTeX
14919  package
14920 \family roman
14921
14922 \begin_inset Flex Code
14923 status collapsed
14924
14925 \begin_layout Plain Layout
14926 setspace
14927 \end_layout
14928
14929 \end_inset
14930
14931 .
14932 \end_layout
14933
14934 \begin_layout Description
14935 \begin_inset Flex Code
14936 status collapsed
14937
14938 \begin_layout Plain Layout
14939 Spellcheck
14940 \end_layout
14941
14942 \end_inset
14943
14944  [
14945 \begin_inset Flex Code
14946 status collapsed
14947
14948 \begin_layout Plain Layout
14949 0
14950 \end_layout
14951
14952 \end_inset
14953
14954 ,
14955 \begin_inset space \thinspace{}
14956 \end_inset
14957
14958
14959 \begin_inset Flex Code
14960 status collapsed
14961
14962 \begin_layout Plain Layout
14963
14964 \emph on
14965 1
14966 \end_layout
14967
14968 \end_inset
14969
14970 ] Allow spell-checking paragraphs of this style.
14971  Default is true.
14972 \end_layout
14973
14974 \begin_layout Description
14975 \begin_inset Flex Code
14976 status collapsed
14977
14978 \begin_layout Plain Layout
14979 TextFont
14980 \end_layout
14981
14982 \end_inset
14983
14984  The font used for the text body .
14985  See
14986 \begin_inset CommandInset ref
14987 LatexCommand ref
14988 reference "subsec:Font-description"
14989
14990 \end_inset
14991
14992 .
14993 \end_layout
14994
14995 \begin_layout Description
14996 \begin_inset Flex Code
14997 status collapsed
14998
14999 \begin_layout Plain Layout
15000 TocLevel
15001 \end_layout
15002
15003 \end_inset
15004
15005
15006 \series medium
15007  [
15008 \begin_inset Flex Code
15009 status collapsed
15010
15011 \begin_layout Plain Layout
15012
15013 \series medium
15014 int=3
15015 \end_layout
15016
15017 \end_inset
15018
15019 ]
15020 \series default
15021  The level of the style in the table of contents.
15022  This is used for automatic numbering of section headings.
15023 \change_inserted -712698321 1401363541
15024
15025 \end_layout
15026
15027 \begin_layout Description
15028
15029 \change_inserted -712698321 1401363906
15030 \begin_inset Flex Code
15031 status collapsed
15032
15033 \begin_layout Plain Layout
15034
15035 \change_inserted -712698321 1401363547
15036 ToggleIndent
15037 \end_layout
15038
15039 \end_inset
15040
15041  [
15042 \emph on
15043
15044 \begin_inset Flex Code
15045 status collapsed
15046
15047 \begin_layout Plain Layout
15048
15049 \change_inserted -712698321 1401363664
15050
15051 \emph on
15052 default
15053 \change_unchanged
15054
15055 \end_layout
15056
15057 \end_inset
15058
15059
15060 \emph default
15061 ,
15062 \begin_inset Flex Code
15063 status collapsed
15064
15065 \begin_layout Plain Layout
15066
15067 \change_inserted -712698321 1401363669
15068 always
15069 \change_unchanged
15070
15071 \end_layout
15072
15073 \end_inset
15074
15075 ,
15076 \begin_inset Flex Code
15077 status collapsed
15078
15079 \begin_layout Plain Layout
15080
15081 \change_inserted -712698321 1401363675
15082 never
15083 \change_unchanged
15084
15085 \end_layout
15086
15087 \end_inset
15088
15089 ] This tag determines whether the first line indentation of this paragraph
15090  can be toggled via the Paragraph settings dialog.
15091  If
15092 \emph on
15093
15094 \begin_inset Flex Code
15095 status collapsed
15096
15097 \begin_layout Plain Layout
15098
15099 \change_inserted -712698321 1401363761
15100
15101 \emph off
15102 default
15103 \end_layout
15104
15105 \end_inset
15106
15107
15108 \emph default
15109  is set, indentation can be toggled if the document settings use
15110 \begin_inset Quotes eld
15111 \end_inset
15112
15113 indent
15114 \begin_inset Quotes erd
15115 \end_inset
15116
15117  paragraph style, with
15118 \begin_inset Flex Code
15119 status collapsed
15120
15121 \begin_layout Plain Layout
15122
15123 \change_inserted -712698321 1401363844
15124 always
15125 \end_layout
15126
15127 \end_inset
15128
15129 , indentation can always be toggled, notwithstanding the document settings,
15130  with
15131 \begin_inset Flex Code
15132 status collapsed
15133
15134 \begin_layout Plain Layout
15135
15136 \change_inserted -712698321 1401363901
15137 never
15138 \end_layout
15139
15140 \end_inset
15141
15142 , indentation can never be toggled.
15143 \change_unchanged
15144
15145 \end_layout
15146
15147 \begin_layout Description
15148 \begin_inset Flex Code
15149 status collapsed
15150
15151 \begin_layout Plain Layout
15152 TopSep
15153 \end_layout
15154
15155 \end_inset
15156
15157  [
15158 \begin_inset Flex Code
15159 status collapsed
15160
15161 \begin_layout Plain Layout
15162 float=0
15163 \end_layout
15164
15165 \end_inset
15166
15167 ] The vertical space with which the very first of a chain of paragraphs
15168  with this style is separated from the previous paragraph.
15169  If the previous paragraph has another style, the separations are not simply
15170  added, but the maximum is taken.
15171 \end_layout
15172
15173 \begin_layout Subsection
15174 \begin_inset CommandInset label
15175 LatexCommand label
15176 name "subsec:I18n"
15177
15178 \end_inset
15179
15180 Internationalization of Paragraph Styles
15181 \end_layout
15182
15183 \begin_layout Standard
15184 \SpecialChar LyX
15185  has long supported internationalization of layout information, but, until
15186  version 2.0, this applied only to the user interface and not to, say, PDF
15187  output.
15188  Thus, French authors were forced to resort to ugly hacks if they wanted
15189  `
15190 \lang french
15191 Théorème
15192 \lang english
15193  1' instead of `Theorem 1'.
15194  Thanks to Georg Baum, that is no longer the case.
15195 \end_layout
15196
15197 \begin_layout Standard
15198 If a
15199 \begin_inset Flex Code
15200 status collapsed
15201
15202 \begin_layout Plain Layout
15203 Style
15204 \end_layout
15205
15206 \end_inset
15207
15208  defines text that is to appear in the typeset document, it may use
15209 \begin_inset Flex Code
15210 status collapsed
15211
15212 \begin_layout Plain Layout
15213 LangPreamble
15214 \end_layout
15215
15216 \end_inset
15217
15218  and
15219 \begin_inset Flex Code
15220 status collapsed
15221
15222 \begin_layout Plain Layout
15223 BabelPreamble
15224 \end_layout
15225
15226 \end_inset
15227
15228  to support non-English and even multi-language documents correctly.
15229  The following excerpt (from the
15230 \begin_inset Flex Code
15231 status collapsed
15232
15233 \begin_layout Plain Layout
15234 theorems-ams.inc
15235 \end_layout
15236
15237 \end_inset
15238
15239  file) shows how this works:
15240 \end_layout
15241
15242 \begin_layout LyX-Code
15243 Preamble
15244 \begin_inset Separator parbreak
15245 \end_inset
15246
15247
15248 \end_layout
15249
15250 \begin_deeper
15251 \begin_layout LyX-Code
15252
15253 \backslash
15254 theoremstyle{remark}
15255 \end_layout
15256
15257 \begin_layout LyX-Code
15258
15259 \backslash
15260 newtheorem{claim}[thm]{
15261 \backslash
15262 protect
15263 \backslash
15264 claimname}
15265 \end_layout
15266
15267 \begin_layout LyX-Code
15268 EndPreamble
15269 \end_layout
15270
15271 \begin_layout LyX-Code
15272 LangPreamble
15273 \end_layout
15274
15275 \begin_layout LyX-Code
15276
15277 \backslash
15278 providecommand{
15279 \backslash
15280 claimname}{_(Claim)}
15281 \end_layout
15282
15283 \begin_layout LyX-Code
15284 EndLangPreamble
15285 \end_layout
15286
15287 \begin_layout LyX-Code
15288 BabelPreamble
15289 \end_layout
15290
15291 \begin_layout LyX-Code
15292
15293 \backslash
15294 addto
15295 \backslash
15296 captions$$lang{
15297 \backslash
15298 renewcommand{
15299 \backslash
15300 claimname}{_(Claim)}}
15301 \end_layout
15302
15303 \begin_layout LyX-Code
15304 EndBabelPreamble
15305 \end_layout
15306
15307 \end_deeper
15308 \begin_layout Standard
15309 In principle, any legal \SpecialChar LaTeX
15310  may appear in the
15311 \begin_inset Flex Code
15312 status collapsed
15313
15314 \begin_layout Plain Layout
15315 LangPreamble
15316 \end_layout
15317
15318 \end_inset
15319
15320  and
15321 \begin_inset Flex Code
15322 status collapsed
15323
15324 \begin_layout Plain Layout
15325 BabelPreamble
15326 \end_layout
15327
15328 \end_inset
15329
15330  tags, but in practice they will typically look as they do here.
15331  The key to correct translation of the typeset text is the definition of
15332  the \SpecialChar LaTeX
15333  command
15334 \begin_inset Flex Code
15335 status collapsed
15336
15337 \begin_layout Plain Layout
15338
15339 \backslash
15340 claimname
15341 \end_layout
15342
15343 \end_inset
15344
15345  and its use in
15346 \begin_inset Flex Code
15347 status collapsed
15348
15349 \begin_layout Plain Layout
15350
15351 \backslash
15352 newtheorem
15353 \end_layout
15354
15355 \end_inset
15356
15357 .
15358
15359 \end_layout
15360
15361 \begin_layout Standard
15362 The
15363 \begin_inset Flex Code
15364 status collapsed
15365
15366 \begin_layout Plain Layout
15367 LangPreamble
15368 \end_layout
15369
15370 \end_inset
15371
15372  tag provides for internationalization based upon the overall language of
15373  the document.
15374  The contents of the tag will be included in the preamble, just as with
15375  the
15376 \begin_inset Flex Code
15377 status collapsed
15378
15379 \begin_layout Plain Layout
15380 Preamble
15381 \end_layout
15382
15383 \end_inset
15384
15385  tag.
15386  What makes it special is the use of the
15387 \begin_inset Quotes eld
15388 \end_inset
15389
15390 function
15391 \begin_inset Quotes erd
15392 \end_inset
15393
15394
15395 \begin_inset Flex Code
15396 status collapsed
15397
15398 \begin_layout Plain Layout
15399 _()
15400 \end_layout
15401
15402 \end_inset
15403
15404 , which will be replaced, when \SpecialChar LyX
15405  produces \SpecialChar LaTeX
15406  output, with the translation of
15407  its argument into the document language.
15408 \end_layout
15409
15410 \begin_layout Standard
15411 The
15412 \begin_inset Flex Code
15413 status collapsed
15414
15415 \begin_layout Plain Layout
15416 BabelPreamble
15417 \end_layout
15418
15419 \end_inset
15420
15421  tag is more complex, since it is meant to provide support for multi-language
15422  documents and so offers an interface to the
15423 \begin_inset Flex Code
15424 status collapsed
15425
15426 \begin_layout Plain Layout
15427 babel
15428 \end_layout
15429
15430 \end_inset
15431
15432  package.
15433  Its contents will be added to the preamble once for each language that
15434  appears in the document.
15435  In this case, the argument to
15436 \begin_inset Flex Code
15437 status collapsed
15438
15439 \begin_layout Plain Layout
15440 _()
15441 \end_layout
15442
15443 \end_inset
15444
15445  will be replaced with its translation into the language in question; the
15446  expression
15447 \begin_inset Flex Code
15448 status collapsed
15449
15450 \begin_layout Plain Layout
15451 $$lang
15452 \end_layout
15453
15454 \end_inset
15455
15456  is replaced by the language name (as used by the babel package).
15457 \end_layout
15458
15459 \begin_layout Standard
15460 A German document that also included a French section would thus have the
15461  following in the preamble:
15462 \end_layout
15463
15464 \begin_layout LyX-Code
15465
15466 \backslash
15467 addto
15468 \backslash
15469 captionsfrench{
15470 \backslash
15471 renewcommand{
15472 \backslash
15473 claimname}{Affirmation}}
15474 \begin_inset Newline newline
15475 \end_inset
15476
15477
15478 \backslash
15479 addto
15480 \backslash
15481 captionsngerman{
15482 \backslash
15483 renewcommand{
15484 \backslash
15485 claimname}{Behauptung}}
15486 \begin_inset Newline newline
15487 \end_inset
15488
15489
15490 \backslash
15491 providecommand{
15492 \backslash
15493 claimname}{Behauptung}
15494 \end_layout
15495
15496 \begin_layout Standard
15497 \SpecialChar LaTeX
15498  and
15499 \begin_inset Flex Code
15500 status collapsed
15501
15502 \begin_layout Plain Layout
15503 babel
15504 \end_layout
15505
15506 \end_inset
15507
15508  will then conspire to produce the correct text in the output.
15509 \end_layout
15510
15511 \begin_layout Standard
15512 One important point to note here is that the translations are provided by
15513  \SpecialChar LyX
15514  itself, through the file
15515 \begin_inset Flex Code
15516 status collapsed
15517
15518 \begin_layout Plain Layout
15519 layouttranslations
15520 \end_layout
15521
15522 \end_inset
15523
15524 .
15525  This means, in effect, that
15526 \begin_inset Flex Code
15527 status collapsed
15528
15529 \begin_layout Plain Layout
15530 LangPreamble
15531 \end_layout
15532
15533 \end_inset
15534
15535  and
15536 \begin_inset Flex Code
15537 status collapsed
15538
15539 \begin_layout Plain Layout
15540 BabelPreamble
15541 \end_layout
15542
15543 \end_inset
15544
15545  are really only of use in layout files that are provided with \SpecialChar LyX
15546 , since text
15547  entered in user-created layout files will not be seen by \SpecialChar LyX
15548 's internationalizatio
15549 n routines unless the
15550 \begin_inset Flex Code
15551 status collapsed
15552
15553 \begin_layout Plain Layout
15554 layouttranslations
15555 \end_layout
15556
15557 \end_inset
15558
15559  file is modified accordingly.
15560  That said, however, any layout created with the intention that it will
15561  be included with \SpecialChar LyX
15562  should use these tags where appropriate.
15563  Please note that the paragraph style translations provided by \SpecialChar LyX
15564  will never
15565  change with a minor update (e.
15566 \begin_inset space \thinspace{}
15567 \end_inset
15568
15569 g.
15570 \begin_inset space \space{}
15571 \end_inset
15572
15573 from version 2.1.x to 2.1.y).
15574  It is however quite likely that a major update (e.
15575 \begin_inset space \thinspace{}
15576 \end_inset
15577
15578 g.
15579 \begin_inset space \space{}
15580 \end_inset
15581
15582 from 2.0.x to 2.1.y) will introduce new translations or corrections.
15583 \end_layout
15584
15585 \begin_layout Subsection
15586 Floats
15587 \begin_inset CommandInset label
15588 LatexCommand label
15589 name "subsec:Floats"
15590
15591 \end_inset
15592
15593
15594 \end_layout
15595
15596 \begin_layout Standard
15597 It is necessary to define the floats (
15598 \begin_inset Flex MenuItem
15599 status collapsed
15600
15601 \begin_layout Plain Layout
15602 figure
15603 \end_layout
15604
15605 \end_inset
15606
15607 ,
15608 \begin_inset Flex MenuItem
15609 status collapsed
15610
15611 \begin_layout Plain Layout
15612 table
15613 \end_layout
15614
15615 \end_inset
15616
15617 , \SpecialChar ldots
15618 ) in the text class itself.
15619  Standard floats are included in the file
15620 \begin_inset Flex Code
15621 status collapsed
15622
15623 \begin_layout Plain Layout
15624 stdfloats.inc
15625 \end_layout
15626
15627 \end_inset
15628
15629 , so you may have to do no more than add
15630 \end_layout
15631
15632 \begin_layout LyX-Code
15633 Input stdfloats.inc
15634 \end_layout
15635
15636 \begin_layout Standard
15637 to your layout file.
15638  If you want to implement a text class that proposes some other float types
15639  (like the AGU class bundled with \SpecialChar LyX
15640 ), the information below will hopefully
15641  help you:
15642 \change_inserted -712698321 1432283506
15643
15644 \end_layout
15645
15646 \begin_layout Description
15647
15648 \change_inserted -712698321 1432313622
15649 \begin_inset Flex Code
15650 status collapsed
15651
15652 \begin_layout Plain Layout
15653
15654 \change_inserted -712698321 1432283514
15655 AllowedPlacement
15656 \end_layout
15657
15658 \end_inset
15659
15660  [
15661 \begin_inset Flex Code
15662 status collapsed
15663
15664 \begin_layout Plain Layout
15665
15666 \change_inserted -712698321 1432283507
15667 string
15668 \end_layout
15669
15670 \end_inset
15671
15672 =!htbpH] Allowed placement options for this float type.
15673  The value is a string of placement characters.
15674  Possible characters include:
15675 \emph on
15676 h
15677 \emph default
15678  (
15679 \begin_inset Quotes eld
15680 \end_inset
15681
15682 here if possible
15683 \begin_inset Quotes erd
15684 \end_inset
15685
15686 ),
15687 \emph on
15688 t
15689 \emph default
15690  (
15691 \begin_inset Quotes eld
15692 \end_inset
15693
15694 top of page
15695 \begin_inset Quotes erd
15696 \end_inset
15697
15698 ),
15699 \emph on
15700 b
15701 \emph default
15702  (
15703 \begin_inset Quotes eld
15704 \end_inset
15705
15706 bottom of page
15707 \begin_inset Quotes erd
15708 \end_inset
15709
15710 ),
15711 \emph on
15712 p
15713 \emph default
15714  (
15715 \begin_inset Quotes eld
15716 \end_inset
15717
15718 page of floats
15719 \begin_inset Quotes erd
15720 \end_inset
15721
15722 ),
15723 \emph on
15724 H
15725 \emph default
15726  (
15727 \begin_inset Quotes eld
15728 \end_inset
15729
15730 here definitely
15731 \begin_inset Quotes erd
15732 \end_inset
15733
15734 ) and
15735 \emph on
15736 !
15737 \emph default
15738  (
15739 \begin_inset Quotes eld
15740 \end_inset
15741
15742 ignore LaTeX rules
15743 \begin_inset Quotes erd
15744 \end_inset
15745
15746 ).
15747  The order of the characters in the string does not matter.
15748  If no placement options are allowed, use the string
15749 \emph on
15750 none
15751 \emph default
15752 .
15753 \end_layout
15754
15755 \begin_layout Description
15756
15757 \change_inserted -712698321 1432313755
15758 \begin_inset Flex Code
15759 status collapsed
15760
15761 \begin_layout Plain Layout
15762
15763 \change_inserted -712698321 1432313630
15764 AllowsSideways
15765 \end_layout
15766
15767 \end_inset
15768
15769  [
15770 \begin_inset Flex Code
15771 status collapsed
15772
15773 \begin_layout Plain Layout
15774
15775 \change_inserted -712698321 1432313646
15776
15777 \emph off
15778 0
15779 \end_layout
15780
15781 \end_inset
15782
15783 ,
15784 \begin_inset space \thinspace{}
15785 \end_inset
15786
15787
15788 \emph on
15789
15790 \begin_inset Flex Code
15791 status collapsed
15792
15793 \begin_layout Plain Layout
15794
15795 \change_inserted -712698321 1432313646
15796
15797 \emph on
15798 1
15799 \end_layout
15800
15801 \end_inset
15802
15803
15804 \emph default
15805 ] Defines whether the float allows to be rotated via the rotfloat package
15806  (sidewaysfloat).
15807  Set to
15808 \begin_inset Flex Code
15809 status collapsed
15810
15811 \begin_layout Plain Layout
15812
15813 \change_inserted -712698321 1432313721
15814 0
15815 \end_layout
15816
15817 \end_inset
15818
15819  if the float does not support this feature.
15820 \end_layout
15821
15822 \begin_layout Description
15823
15824 \change_inserted -712698321 1432313802
15825 \begin_inset Flex Code
15826 status collapsed
15827
15828 \begin_layout Plain Layout
15829
15830 \change_inserted -712698321 1432313759
15831 AllowsWide
15832 \end_layout
15833
15834 \end_inset
15835
15836  [
15837 \begin_inset Flex Code
15838 status collapsed
15839
15840 \begin_layout Plain Layout
15841
15842 \change_inserted -712698321 1432313755
15843
15844 \emph off
15845 0
15846 \end_layout
15847
15848 \end_inset
15849
15850 ,
15851 \begin_inset space \thinspace{}
15852 \end_inset
15853
15854
15855 \emph on
15856
15857 \begin_inset Flex Code
15858 status collapsed
15859
15860 \begin_layout Plain Layout
15861
15862 \change_inserted -712698321 1432313755
15863
15864 \emph on
15865 1
15866 \end_layout
15867
15868 \end_inset
15869
15870
15871 \emph default
15872 ] Defines whether the float has a starred variant that spans columns in
15873  a two column paragraph.
15874  Set to
15875 \begin_inset Flex Code
15876 status collapsed
15877
15878 \begin_layout Plain Layout
15879
15880 \change_inserted -712698321 1432313755
15881 0
15882 \end_layout
15883
15884 \end_inset
15885
15886  if the float does not support this feature.
15887 \change_unchanged
15888
15889 \end_layout
15890
15891 \begin_layout Description
15892 \begin_inset Flex Code
15893 status collapsed
15894
15895 \begin_layout Plain Layout
15896 Extension
15897 \end_layout
15898
15899 \end_inset
15900
15901  [
15902 \begin_inset Flex Code
15903 status collapsed
15904
15905 \begin_layout Plain Layout
15906 string
15907 \end_layout
15908
15909 \end_inset
15910
15911 =
15912 \begin_inset Quotes erd
15913 \end_inset
15914
15915
15916 \begin_inset Quotes erd
15917 \end_inset
15918
15919 ] The file name extension of an auxiliary file for the list of figures (or
15920  whatever).
15921  \SpecialChar LaTeX
15922  writes the captions to this file.
15923 \end_layout
15924
15925 \begin_layout Description
15926 \begin_inset Flex Code
15927 status collapsed
15928
15929 \begin_layout Plain Layout
15930 GuiName
15931 \end_layout
15932
15933 \end_inset
15934
15935  [
15936 \begin_inset Flex Code
15937 status collapsed
15938
15939 \begin_layout Plain Layout
15940 string
15941 \end_layout
15942
15943 \end_inset
15944
15945 =
15946 \begin_inset Quotes erd
15947 \end_inset
15948
15949
15950 \begin_inset Quotes erd
15951 \end_inset
15952
15953 ] The string that will be used in the menus and also for the caption.
15954  This is translated to the current language if babel is used.
15955 \end_layout
15956
15957 \begin_layout Description
15958 \begin_inset Flex Code
15959 status collapsed
15960
15961 \begin_layout Plain Layout
15962 HTML*
15963 \end_layout
15964
15965 \end_inset
15966
15967  These tags control the XHTML output.
15968  See
15969 \begin_inset CommandInset ref
15970 LatexCommand ref
15971 reference "sec:Tags-for-XHTML"
15972
15973 \end_inset
15974
15975 .
15976 \end_layout
15977
15978 \begin_layout Description
15979 \begin_inset Flex Code
15980 status collapsed
15981
15982 \begin_layout Plain Layout
15983 IsPredefined
15984 \end_layout
15985
15986 \end_inset
15987
15988  [
15989 \emph on
15990
15991 \begin_inset Flex Code
15992 status collapsed
15993
15994 \begin_layout Plain Layout
15995 0
15996 \end_layout
15997
15998 \end_inset
15999
16000
16001 \emph default
16002 ,
16003 \begin_inset space \thinspace{}
16004 \end_inset
16005
16006
16007 \begin_inset Flex Code
16008 status collapsed
16009
16010 \begin_layout Plain Layout
16011 1
16012 \end_layout
16013
16014 \end_inset
16015
16016 ] Indicates whether the float is already defined in the document class or
16017  if instead the \SpecialChar LaTeX
16018  package
16019 \begin_inset Flex Code
16020 status collapsed
16021
16022 \begin_layout Plain Layout
16023 float
16024 \end_layout
16025
16026 \end_inset
16027
16028  needs to be loaded to define it on-the-fly.
16029  The default is
16030 \begin_inset Flex Code
16031 status collapsed
16032
16033 \begin_layout Plain Layout
16034 0
16035 \end_layout
16036
16037 \end_inset
16038
16039 , which means:
16040 \begin_inset Flex Code
16041 status collapsed
16042
16043 \begin_layout Plain Layout
16044 float
16045 \end_layout
16046
16047 \end_inset
16048
16049  is used.
16050  It should be set to
16051 \begin_inset Flex Code
16052 status collapsed
16053
16054 \begin_layout Plain Layout
16055 1
16056 \end_layout
16057
16058 \end_inset
16059
16060  if the float is already defined by the \SpecialChar LaTeX
16061  document class.
16062 \end_layout
16063
16064 \begin_layout Description
16065 \begin_inset Flex Code
16066 status collapsed
16067
16068 \begin_layout Plain Layout
16069 ListCommand
16070 \end_layout
16071
16072 \end_inset
16073
16074  [
16075 \begin_inset Flex Code
16076 status collapsed
16077
16078 \begin_layout Plain Layout
16079 string
16080 \end_layout
16081
16082 \end_inset
16083
16084 =
16085 \begin_inset Quotes erd
16086 \end_inset
16087
16088
16089 \begin_inset Quotes erd
16090 \end_inset
16091
16092 ] The command used to generate a list of floats of this type; the leading
16093  `
16094 \backslash
16095 ' must be omitted.
16096  This
16097 \emph on
16098 must
16099 \emph default
16100  be given if
16101 \begin_inset Flex Code
16102 status collapsed
16103
16104 \begin_layout Plain Layout
16105 UsesFloatPkg
16106 \end_layout
16107
16108 \end_inset
16109
16110  is false, since there is no standard way to generate this command.
16111  It is ignored if
16112 \begin_inset Flex Code
16113 status collapsed
16114
16115 \begin_layout Plain Layout
16116 UsesFloatPkg
16117 \end_layout
16118
16119 \end_inset
16120
16121  is true, since in that case there is a standard way to define the command.
16122 \end_layout
16123
16124 \begin_layout Description
16125 \begin_inset Flex Code
16126 status collapsed
16127
16128 \begin_layout Plain Layout
16129 ListName
16130 \end_layout
16131
16132 \end_inset
16133
16134  [
16135 \begin_inset Flex Code
16136 status collapsed
16137
16138 \begin_layout Plain Layout
16139 string
16140 \end_layout
16141
16142 \end_inset
16143
16144 =
16145 \begin_inset Quotes erd
16146 \end_inset
16147
16148
16149 \begin_inset Quotes erd
16150 \end_inset
16151
16152 ] A title for a list of floats of this kind (list of figures, tables, or
16153  whatever).
16154  It is used for the screen label within \SpecialChar LyX
16155 , it is used by \SpecialChar LaTeX
16156  for the title and
16157  it is used as the title in the XHTML output.
16158  It will be translated to the document language.
16159 \end_layout
16160
16161 \begin_layout Description
16162 \begin_inset Flex Code
16163 status collapsed
16164
16165 \begin_layout Plain Layout
16166 NumberWithin
16167 \end_layout
16168
16169 \end_inset
16170
16171  [
16172 \begin_inset Flex Code
16173 status collapsed
16174
16175 \begin_layout Plain Layout
16176 string
16177 \end_layout
16178
16179 \end_inset
16180
16181 =
16182 \begin_inset Quotes erd
16183 \end_inset
16184
16185
16186 \begin_inset Quotes erd
16187 \end_inset
16188
16189 ] This (optional) argument determines whether floats of this class will
16190  be numbered within some sectional unit of the document.
16191  For example, if
16192 \begin_inset Flex Code
16193 status collapsed
16194
16195 \begin_layout Plain Layout
16196 NumberWithin
16197 \end_layout
16198
16199 \end_inset
16200
16201  is set to
16202 \begin_inset Quotes eld
16203 \end_inset
16204
16205
16206 \begin_inset Flex Code
16207 status collapsed
16208
16209 \begin_layout Plain Layout
16210 chapter
16211 \end_layout
16212
16213 \end_inset
16214
16215
16216 \begin_inset Quotes erd
16217 \end_inset
16218
16219 , the floats will be numbered within chapters.
16220
16221 \end_layout
16222
16223 \begin_layout Description
16224 \begin_inset Flex Code
16225 status collapsed
16226
16227 \begin_layout Plain Layout
16228 Placement
16229 \end_layout
16230
16231 \end_inset
16232
16233  [
16234 \begin_inset Flex Code
16235 status collapsed
16236
16237 \begin_layout Plain Layout
16238 string
16239 \end_layout
16240
16241 \end_inset
16242
16243 =
16244 \begin_inset Quotes erd
16245 \end_inset
16246
16247
16248 \begin_inset Quotes erd
16249 \end_inset
16250
16251 ] The default placement for the given class of floats.
16252  The string should be as in standard \SpecialChar LaTeX
16253 :
16254 \begin_inset Flex Code
16255 status collapsed
16256
16257 \begin_layout Plain Layout
16258 t
16259 \end_layout
16260
16261 \end_inset
16262
16263 ,
16264 \begin_inset Flex Code
16265 status collapsed
16266
16267 \begin_layout Plain Layout
16268 b
16269 \end_layout
16270
16271 \end_inset
16272
16273 ,
16274 \begin_inset Flex Code
16275 status collapsed
16276
16277 \begin_layout Plain Layout
16278 p
16279 \end_layout
16280
16281 \end_inset
16282
16283  and
16284 \begin_inset Flex Code
16285 status collapsed
16286
16287 \begin_layout Plain Layout
16288 h
16289 \end_layout
16290
16291 \end_inset
16292
16293  for top, bottom, page, and here, respectively.
16294 \begin_inset Foot
16295 status collapsed
16296
16297 \begin_layout Plain Layout
16298 Note that the order of these letters in the string is irrelevant, like in
16299  \SpecialChar LaTeX
16300 .
16301 \end_layout
16302
16303 \end_inset
16304
16305  On top of that there is a new type,
16306 \begin_inset Flex Code
16307 status collapsed
16308
16309 \begin_layout Plain Layout
16310 H
16311 \end_layout
16312
16313 \end_inset
16314
16315 , which does not really correspond to a float, since it means: put it
16316 \begin_inset Quotes eld
16317 \end_inset
16318
16319 here
16320 \begin_inset Quotes erd
16321 \end_inset
16322
16323  and nowhere else.
16324  Note however that the
16325 \begin_inset Flex Code
16326 status collapsed
16327
16328 \begin_layout Plain Layout
16329 H
16330 \end_layout
16331
16332 \end_inset
16333
16334  specifier is special and, because of implementation details, cannot be
16335  used in non-built in float types.
16336  If you do not understand what this means, just use
16337 \begin_inset Quotes eld
16338 \end_inset
16339
16340
16341 \begin_inset Flex Code
16342 status collapsed
16343
16344 \begin_layout Plain Layout
16345 tbp
16346 \end_layout
16347
16348 \end_inset
16349
16350
16351 \begin_inset Quotes erd
16352 \end_inset
16353
16354 .
16355 \end_layout
16356
16357 \begin_layout Description
16358 \begin_inset Flex Code
16359 status collapsed
16360
16361 \begin_layout Plain Layout
16362 RefPrefix
16363 \end_layout
16364
16365 \end_inset
16366
16367  [
16368 \begin_inset Flex Code
16369 status collapsed
16370
16371 \begin_layout Plain Layout
16372 string
16373 \end_layout
16374
16375 \end_inset
16376
16377 ] The prefix to use when creating labels referring to floats of this type.
16378  This allows the use of formatted references.
16379  Note that you can remove any
16380 \begin_inset Flex Code
16381 status collapsed
16382
16383 \begin_layout Plain Layout
16384 RefPrefix
16385 \end_layout
16386
16387 \end_inset
16388
16389  set by a copied style by using the special value
16390 \begin_inset Quotes eld
16391 \end_inset
16392
16393 OFF
16394 \begin_inset Quotes erd
16395 \end_inset
16396
16397 , which must be all caps.
16398 \end_layout
16399
16400 \begin_layout Description
16401 \begin_inset Flex Code
16402 status collapsed
16403
16404 \begin_layout Plain Layout
16405 Style
16406 \end_layout
16407
16408 \end_inset
16409
16410  [
16411 \begin_inset Flex Code
16412 status collapsed
16413
16414 \begin_layout Plain Layout
16415 string
16416 \end_layout
16417
16418 \end_inset
16419
16420 =
16421 \begin_inset Quotes erd
16422 \end_inset
16423
16424
16425 \begin_inset Quotes erd
16426 \end_inset
16427
16428 ] The style used when defining the float using
16429 \begin_inset Flex Code
16430 status collapsed
16431
16432 \begin_layout Plain Layout
16433
16434 \backslash
16435 newfloat
16436 \end_layout
16437
16438 \end_inset
16439
16440 .
16441 \end_layout
16442
16443 \begin_layout Description
16444 \begin_inset Flex Code
16445 status collapsed
16446
16447 \begin_layout Plain Layout
16448 Type
16449 \end_layout
16450
16451 \end_inset
16452
16453  [
16454 \begin_inset Flex Code
16455 status collapsed
16456
16457 \begin_layout Plain Layout
16458 string
16459 \end_layout
16460
16461 \end_inset
16462
16463 =
16464 \begin_inset Quotes erd
16465 \end_inset
16466
16467
16468 \begin_inset Quotes erd
16469 \end_inset
16470
16471 ] The
16472 \begin_inset Quotes eld
16473 \end_inset
16474
16475 type
16476 \begin_inset Quotes erd
16477 \end_inset
16478
16479  of the new class of floats, like program or algorithm.
16480  After the appropriate
16481 \begin_inset Flex Code
16482 status collapsed
16483
16484 \begin_layout Plain Layout
16485
16486 \backslash
16487 newfloat
16488 \end_layout
16489
16490 \end_inset
16491
16492 , commands such as
16493 \begin_inset Flex Code
16494 status collapsed
16495
16496 \begin_layout Plain Layout
16497
16498 \backslash
16499 begin{program}
16500 \end_layout
16501
16502 \end_inset
16503
16504  or
16505 \begin_inset Flex Code
16506 status collapsed
16507
16508 \begin_layout Plain Layout
16509
16510 \backslash
16511 end{algorithm*}
16512 \end_layout
16513
16514 \end_inset
16515
16516  will be available.
16517 \end_layout
16518
16519 \begin_layout Description
16520 \begin_inset Flex Code
16521 status collapsed
16522
16523 \begin_layout Plain Layout
16524 UsesFloatPkg
16525 \end_layout
16526
16527 \end_inset
16528
16529  [
16530 \begin_inset Flex Code
16531 status collapsed
16532
16533 \begin_layout Plain Layout
16534 0
16535 \end_layout
16536
16537 \end_inset
16538
16539 ,
16540 \begin_inset space \thinspace{}
16541 \end_inset
16542
16543
16544 \begin_inset Flex Code
16545 status collapsed
16546
16547 \begin_layout Plain Layout
16548
16549 \emph on
16550 1
16551 \end_layout
16552
16553 \end_inset
16554
16555 ] Specifies whether this float is defined using the \SpecialChar LaTeX
16556  package
16557 \begin_inset Flex Code
16558 status collapsed
16559
16560 \begin_layout Plain Layout
16561 float
16562 \end_layout
16563
16564 \end_inset
16565
16566 , either by the class file, another package or on-the-fly by \SpecialChar LyX
16567  itself.
16568 \end_layout
16569
16570 \begin_layout Standard
16571 Note that defining a float with type
16572 \begin_inset Flex Code
16573 status collapsed
16574
16575 \begin_layout Plain Layout
16576
16577 \emph on
16578 type
16579 \end_layout
16580
16581 \end_inset
16582
16583  automatically defines the corresponding counter with name
16584 \begin_inset Flex Code
16585 status collapsed
16586
16587 \begin_layout Plain Layout
16588
16589 \emph on
16590 type
16591 \end_layout
16592
16593 \end_inset
16594
16595 .
16596 \end_layout
16597
16598 \begin_layout Subsection
16599 Flex insets and InsetLayout
16600 \begin_inset CommandInset label
16601 LatexCommand label
16602 name "subsec:Flex-insets-and"
16603
16604 \end_inset
16605
16606
16607 \end_layout
16608
16609 \begin_layout Standard
16610 Flex insets come in three different kinds:
16611 \end_layout
16612
16613 \begin_layout Itemize
16614 character style (
16615 \begin_inset Flex Code
16616 status collapsed
16617
16618 \begin_layout Plain Layout
16619 CharStyle
16620 \end_layout
16621
16622 \end_inset
16623
16624 ): These define semantic markup corresponding to such \SpecialChar LaTeX
16625  commands as
16626 \begin_inset Flex Code
16627 status collapsed
16628
16629 \begin_layout Plain Layout
16630
16631 \backslash
16632 noun
16633 \end_layout
16634
16635 \end_inset
16636
16637  and
16638 \begin_inset Flex Code
16639 status collapsed
16640
16641 \begin_layout Plain Layout
16642
16643 \backslash
16644 code
16645 \end_layout
16646
16647 \end_inset
16648
16649 .
16650 \end_layout
16651
16652 \begin_layout Itemize
16653 user custom (
16654 \begin_inset Flex Code
16655 status collapsed
16656
16657 \begin_layout Plain Layout
16658 Custom
16659 \end_layout
16660
16661 \end_inset
16662
16663 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
16664  code,
16665  footnote, and the like.
16666  An obvious example is an endnote inset, which is defined in the
16667 \begin_inset Flex Code
16668 status collapsed
16669
16670 \begin_layout Plain Layout
16671 endnote
16672 \end_layout
16673
16674 \end_inset
16675
16676  module.
16677 \end_layout
16678
16679 \begin_layout Itemize
16680 XML elements (
16681 \begin_inset Flex Code
16682 status collapsed
16683
16684 \begin_layout Plain Layout
16685 Element
16686 \end_layout
16687
16688 \end_inset
16689
16690 ): For use with DocBook classes.
16691 \end_layout
16692
16693 \begin_layout Standard
16694 Flex insets are defined using the
16695 \begin_inset Flex Code
16696 status collapsed
16697
16698 \begin_layout Plain Layout
16699 InsetLayout
16700 \end_layout
16701
16702 \end_inset
16703
16704  tag, which shall be explained in a moment.
16705 \end_layout
16706
16707 \begin_layout Standard
16708 The
16709 \begin_inset Flex Code
16710 status collapsed
16711
16712 \begin_layout Plain Layout
16713 InsetLayout
16714 \end_layout
16715
16716 \end_inset
16717
16718  tag also serves another function: It can be used to customize the general
16719  layout of many different types of insets.
16720  Currently,
16721 \begin_inset Flex Code
16722 status collapsed
16723
16724 \begin_layout Plain Layout
16725 InsetLayout
16726 \end_layout
16727
16728 \end_inset
16729
16730  can be used to customize the layout parameters for footnotes, marginal
16731  notes, note insets, \SpecialChar TeX
16732  code (ERT) insets, branches, listings, indexes, boxes,
16733  tables, algorithms, URLs, and captions, as well as to define Flex insets.
16734 \end_layout
16735
16736 \begin_layout Standard
16737 The
16738 \begin_inset Flex Code
16739 status collapsed
16740
16741 \begin_layout Plain Layout
16742 InsetLayout
16743 \end_layout
16744
16745 \end_inset
16746
16747  definition must begin with a line of the form:
16748 \end_layout
16749
16750 \begin_layout LyX-Code
16751 InsetLayout <type>
16752 \end_layout
16753
16754 \begin_layout Standard
16755 Here
16756 \begin_inset Flex Code
16757 status collapsed
16758
16759 \begin_layout Plain Layout
16760 <Type>
16761 \end_layout
16762
16763 \end_inset
16764
16765  indicates the inset whose layout is being defined, and here there are four
16766  cases.
16767 \end_layout
16768
16769 \begin_layout Enumerate
16770 The layout for a pre-existing inset is being modified.
16771  In this case, can be
16772 \begin_inset Flex Code
16773 status collapsed
16774
16775 \begin_layout Plain Layout
16776 <Type>
16777 \end_layout
16778
16779 \end_inset
16780
16781  any one of the following:
16782 \begin_inset Flex Code
16783 status collapsed
16784
16785 \begin_layout Plain Layout
16786 Algorithm
16787 \end_layout
16788
16789 \end_inset
16790
16791 ,
16792 \begin_inset Flex Code
16793 status collapsed
16794
16795 \begin_layout Plain Layout
16796 Branch
16797 \end_layout
16798
16799 \end_inset
16800
16801 ,
16802 \begin_inset Flex Code
16803 status collapsed
16804
16805 \begin_layout Plain Layout
16806 Box
16807 \end_layout
16808
16809 \end_inset
16810
16811 ,
16812 \begin_inset Flex Code
16813 status collapsed
16814
16815 \begin_layout Plain Layout
16816 Box:shaded
16817 \end_layout
16818
16819 \end_inset
16820
16821 ,
16822 \begin_inset Flex Code
16823 status collapsed
16824
16825 \begin_layout Plain Layout
16826 Caption:Standard
16827 \end_layout
16828
16829 \end_inset
16830
16831 ,
16832 \begin_inset Flex Code
16833 status collapsed
16834
16835 \begin_layout Plain Layout
16836 ERT
16837 \end_layout
16838
16839 \end_inset
16840
16841 ,
16842 \begin_inset Flex Code
16843 status collapsed
16844
16845 \begin_layout Plain Layout
16846 Figure
16847 \end_layout
16848
16849 \end_inset
16850
16851 ,
16852 \begin_inset Flex Code
16853 status collapsed
16854
16855 \begin_layout Plain Layout
16856 Foot
16857 \end_layout
16858
16859 \end_inset
16860
16861 ,
16862 \begin_inset Flex Code
16863 status collapsed
16864
16865 \begin_layout Plain Layout
16866 Index
16867 \end_layout
16868
16869 \end_inset
16870
16871 ,
16872 \begin_inset Flex Code
16873 status collapsed
16874
16875 \begin_layout Plain Layout
16876 Info
16877 \end_layout
16878
16879 \end_inset
16880
16881 ,
16882 \begin_inset Flex Code
16883 status collapsed
16884
16885 \begin_layout Plain Layout
16886 Info:menu
16887 \end_layout
16888
16889 \end_inset
16890
16891 ,
16892 \begin_inset Flex Code
16893 status collapsed
16894
16895 \begin_layout Plain Layout
16896 Info:shortcut
16897 \end_layout
16898
16899 \end_inset
16900
16901 ,
16902 \begin_inset Flex Code
16903 status collapsed
16904
16905 \begin_layout Plain Layout
16906 Info:shortcuts
16907 \end_layout
16908
16909 \end_inset
16910
16911 ,
16912 \begin_inset Flex Code
16913 status collapsed
16914
16915 \begin_layout Plain Layout
16916 Listings
16917 \end_layout
16918
16919 \end_inset
16920
16921 ,
16922 \begin_inset Flex Code
16923 status collapsed
16924
16925 \begin_layout Plain Layout
16926 Marginal
16927 \end_layout
16928
16929 \end_inset
16930
16931 ,
16932 \begin_inset Flex Code
16933 status collapsed
16934
16935 \begin_layout Plain Layout
16936 Note:Comment
16937 \end_layout
16938
16939 \end_inset
16940
16941 ,
16942 \begin_inset Flex Code
16943 status collapsed
16944
16945 \begin_layout Plain Layout
16946 Note:Note
16947 \end_layout
16948
16949 \end_inset
16950
16951 ,
16952 \begin_inset Flex Code
16953 status collapsed
16954
16955 \begin_layout Plain Layout
16956 Note:Greyedout
16957 \end_layout
16958
16959 \end_inset
16960
16961 ,
16962 \begin_inset Flex Code
16963 status collapsed
16964
16965 \begin_layout Plain Layout
16966 Table
16967 \end_layout
16968
16969 \end_inset
16970
16971 , or
16972 \begin_inset Flex Code
16973 status collapsed
16974
16975 \begin_layout Plain Layout
16976 URL
16977 \end_layout
16978
16979 \end_inset
16980
16981 .
16982 \end_layout
16983
16984 \begin_layout Enumerate
16985 The layout for a Flex inset is being defined.
16986  In this case,
16987 \begin_inset Flex Code
16988 status collapsed
16989
16990 \begin_layout Plain Layout
16991 <Type>
16992 \end_layout
16993
16994 \end_inset
16995
16996  must be of the form
16997 \begin_inset Quotes eld
16998 \end_inset
16999
17000
17001 \begin_inset Flex Code
17002 status collapsed
17003
17004 \begin_layout Plain Layout
17005 Flex:<name>
17006 \end_layout
17007
17008 \end_inset
17009
17010
17011 \begin_inset Quotes erd
17012 \end_inset
17013
17014 , where
17015 \begin_inset Flex Code
17016 status collapsed
17017
17018 \begin_layout Plain Layout
17019 name
17020 \end_layout
17021
17022 \end_inset
17023
17024  may be be any valid identifier not used by a pre-existing Flex inset.
17025  The identifier may include spaces, but in that case the whole thing must
17026  be wrapped in quotes.
17027  Note that the definition of a flex inset
17028 \emph on
17029 must
17030 \emph default
17031 also include a
17032 \begin_inset Flex Code
17033 status collapsed
17034
17035 \begin_layout Plain Layout
17036 LyXType
17037 \end_layout
17038
17039 \end_inset
17040
17041  entry, declaring which type of inset it defines.
17042 \end_layout
17043
17044 \begin_layout Enumerate
17045 The layout for user specific branch is being defined.
17046  In this case,
17047 \begin_inset Flex Code
17048 status collapsed
17049
17050 \begin_layout Plain Layout
17051 <Type>
17052 \end_layout
17053
17054 \end_inset
17055
17056  must be of the form
17057 \begin_inset Quotes eld
17058 \end_inset
17059
17060
17061 \begin_inset Flex Code
17062 status collapsed
17063
17064 \begin_layout Plain Layout
17065 Branch:<name>
17066 \end_layout
17067
17068 \end_inset
17069
17070
17071 \begin_inset Quotes erd
17072 \end_inset
17073
17074 , where
17075 \begin_inset Flex Code
17076 status collapsed
17077
17078 \begin_layout Plain Layout
17079 name
17080 \end_layout
17081
17082 \end_inset
17083
17084  may be be any valid identifier of branch defined in user's document.
17085  The identifier may include spaces, but in that case the whole thing must
17086  be wrapped in quotes.
17087  The main purpose of this feature is to allow \SpecialChar LaTeX
17088  wrapping around specific
17089  branches as user needs.
17090 \end_layout
17091
17092 \begin_layout Enumerate
17093 The layout of a user (or class) specific caption is being defined.
17094  In this case,
17095 \begin_inset Flex Code
17096 status collapsed
17097
17098 \begin_layout Plain Layout
17099 <Type>
17100 \end_layout
17101
17102 \end_inset
17103
17104  must be of the form
17105 \begin_inset Quotes eld
17106 \end_inset
17107
17108
17109 \begin_inset Flex Code
17110 status collapsed
17111
17112 \begin_layout Plain Layout
17113 Caption:<name>
17114 \end_layout
17115
17116 \end_inset
17117
17118
17119 \begin_inset Quotes erd
17120 \end_inset
17121
17122 , where
17123 \begin_inset Flex Code
17124 status collapsed
17125
17126 \begin_layout Plain Layout
17127 name
17128 \end_layout
17129
17130 \end_inset
17131
17132  specifies the name of the caption as it appears in the menu.
17133  Have a look at the standard caption (
17134 \begin_inset Flex Code
17135 status collapsed
17136
17137 \begin_layout Plain Layout
17138 Caption:Standard
17139 \end_layout
17140
17141 \end_inset
17142
17143 ), the specific captions of the KOMA-Script classes (
17144 \begin_inset Flex Code
17145 status collapsed
17146
17147 \begin_layout Plain Layout
17148 Caption:Above
17149 \end_layout
17150
17151 \end_inset
17152
17153 ,
17154 \begin_inset Flex Code
17155 status collapsed
17156
17157 \begin_layout Plain Layout
17158 Caption:Below
17159 \end_layout
17160
17161 \end_inset
17162
17163 ) or the module
17164 \family sans
17165 Multilingual
17166 \begin_inset space ~
17167 \end_inset
17168
17169 Captions
17170 \family default
17171 (
17172 \begin_inset Flex Code
17173 status collapsed
17174
17175 \begin_layout Plain Layout
17176 Caption:Bicaption
17177 \end_layout
17178
17179 \end_inset
17180
17181 ) for applications.
17182 \end_layout
17183
17184 \begin_layout Standard
17185 The
17186 \begin_inset Flex Code
17187 status collapsed
17188
17189 \begin_layout Plain Layout
17190 InsetLayout
17191 \end_layout
17192
17193 \end_inset
17194
17195  definition can contain the following entries:
17196 \end_layout
17197
17198 \begin_layout Description
17199 \begin_inset Flex Code
17200 status collapsed
17201
17202 \begin_layout Plain Layout
17203 Argument
17204 \end_layout
17205
17206 \end_inset
17207
17208  [
17209 \begin_inset Flex Code
17210 status collapsed
17211
17212 \begin_layout Plain Layout
17213 int
17214 \end_layout
17215
17216 \end_inset
17217
17218 ] Defines argument number of a command\SpecialChar breakableslash
17219 environment associated with the current
17220  layout.
17221  The definition must end with
17222 \begin_inset Flex Code
17223 status collapsed
17224
17225 \begin_layout Plain Layout
17226 EndArgument
17227 \end_layout
17228
17229 \end_inset
17230
17231 .
17232  See
17233 \begin_inset CommandInset ref
17234 LatexCommand ref
17235 reference "subsec:Paragraph-Styles"
17236
17237 \end_inset
17238
17239  for details.
17240 \end_layout
17241
17242 \begin_layout Description
17243 \begin_inset Flex Code
17244 status collapsed
17245
17246 \begin_layout Plain Layout
17247 BabelPreamble
17248 \end_layout
17249
17250 \end_inset
17251
17252  Preamble for changing language commands; see
17253 \begin_inset CommandInset ref
17254 LatexCommand ref
17255 reference "subsec:I18n"
17256
17257 \end_inset
17258
17259 .
17260 \end_layout
17261
17262 \begin_layout Description
17263 \begin_inset Flex Code
17264 status collapsed
17265
17266 \begin_layout Plain Layout
17267 BgColor
17268 \end_layout
17269
17270 \end_inset
17271
17272  [
17273 \begin_inset Flex Code
17274 status collapsed
17275
17276 \begin_layout Plain Layout
17277 <name>
17278 \end_layout
17279
17280 \end_inset
17281
17282 ] The color for the inset's background.
17283  See
17284 \begin_inset CommandInset ref
17285 LatexCommand ref
17286 reference "chap:Names-of-colors"
17287
17288 \end_inset
17289
17290  for a list of the available color names.
17291 \end_layout
17292
17293 \begin_layout Description
17294 \begin_inset Flex Code
17295 status collapsed
17296
17297 \begin_layout Plain Layout
17298 ContentAsLabel
17299 \end_layout
17300
17301 \end_inset
17302
17303  [
17304 \begin_inset Flex Code
17305 status collapsed
17306
17307 \begin_layout Plain Layout
17308
17309 \emph on
17310 0
17311 \end_layout
17312
17313 \end_inset
17314
17315 ,
17316 \begin_inset space \thinspace{}
17317 \end_inset
17318
17319
17320 \begin_inset Flex Code
17321 status collapsed
17322
17323 \begin_layout Plain Layout
17324 1
17325 \end_layout
17326
17327 \end_inset
17328
17329 ] Whether to use the content of the inset as the label, when the inset is
17330  closed.
17331  Default is false.
17332 \end_layout
17333
17334 \begin_layout Description
17335 \begin_inset Flex Code
17336 status collapsed
17337
17338 \begin_layout Plain Layout
17339 CopyStyle
17340 \end_layout
17341
17342 \end_inset
17343
17344  [
17345 \begin_inset Flex Code
17346 status collapsed
17347
17348 \begin_layout Plain Layout
17349 <type>
17350 \end_layout
17351
17352 \end_inset
17353
17354 ] As with paragraph styles, see
17355 \begin_inset CommandInset ref
17356 LatexCommand ref
17357 reference "subsec:Paragraph-Styles"
17358
17359 \end_inset
17360
17361 .
17362  Note that you need to specify the complete type, e.
17363 \begin_inset space \thinspace{}
17364 \end_inset
17365
17366 g.
17367 \begin_inset space ~
17368 \end_inset
17369
17370
17371 \begin_inset Flex Code
17372 status collapsed
17373
17374 \begin_layout Plain Layout
17375 CopyStyle Flex:<name>
17376 \end_layout
17377
17378 \end_inset
17379
17380 .
17381 \end_layout
17382
17383 \begin_layout Description
17384 \begin_inset Flex Code
17385 status collapsed
17386
17387 \begin_layout Plain Layout
17388 CustomPars
17389 \end_layout
17390
17391 \end_inset
17392
17393  [
17394 \begin_inset Flex Code
17395 status collapsed
17396
17397 \begin_layout Plain Layout
17398
17399 \emph on
17400 0
17401 \end_layout
17402
17403 \end_inset
17404
17405 ,
17406 \begin_inset space \thinspace{}
17407 \end_inset
17408
17409
17410 \begin_inset Flex Code
17411 status collapsed
17412
17413 \begin_layout Plain Layout
17414 1
17415 \end_layout
17416
17417 \end_inset
17418
17419 ] Indicates whether the user may employ the Paragraph Settings dialog to
17420  customize the paragraph.
17421 \end_layout
17422
17423 \begin_layout Description
17424 \begin_inset Flex Code
17425 status collapsed
17426
17427 \begin_layout Plain Layout
17428 Decoration
17429 \end_layout
17430
17431 \end_inset
17432
17433  can be
17434 \begin_inset Flex Code
17435 status collapsed
17436
17437 \begin_layout Plain Layout
17438 Classic
17439 \end_layout
17440
17441 \end_inset
17442
17443 ,
17444 \begin_inset Flex Code
17445 status collapsed
17446
17447 \begin_layout Plain Layout
17448 Minimalistic
17449 \end_layout
17450
17451 \end_inset
17452
17453 , or
17454 \begin_inset Flex Code
17455 status collapsed
17456
17457 \begin_layout Plain Layout
17458 Conglomerate
17459 \end_layout
17460
17461 \end_inset
17462
17463 , describing the rendering style used for the inset's frame and buttons.
17464  Footnotes generally use
17465 \begin_inset Flex Code
17466 status collapsed
17467
17468 \begin_layout Plain Layout
17469 Classic
17470 \end_layout
17471
17472 \end_inset
17473
17474 , ERT insets generally
17475 \begin_inset Flex Code
17476 status collapsed
17477
17478 \begin_layout Plain Layout
17479 Minimalistic
17480 \end_layout
17481
17482 \end_inset
17483
17484 , and character styles
17485 \begin_inset Flex Code
17486 status collapsed
17487
17488 \begin_layout Plain Layout
17489 Conglomerate
17490 \end_layout
17491
17492 \end_inset
17493
17494 .
17495 \end_layout
17496
17497 \begin_layout Description
17498 \begin_inset Flex Code
17499 status collapsed
17500
17501 \begin_layout Plain Layout
17502 Display
17503 \end_layout
17504
17505 \end_inset
17506
17507  [
17508 \begin_inset Flex Code
17509 status collapsed
17510
17511 \begin_layout Plain Layout
17512 0
17513 \end_layout
17514
17515 \end_inset
17516
17517 ,
17518 \emph on
17519
17520 \begin_inset space \thinspace{}
17521 \end_inset
17522
17523
17524 \emph default
17525
17526 \begin_inset Flex Code
17527 status collapsed
17528
17529 \begin_layout Plain Layout
17530
17531 \emph on
17532 1
17533 \end_layout
17534
17535 \end_inset
17536
17537 ] Only useful if
17538 \begin_inset Flex Code
17539 status collapsed
17540
17541 \begin_layout Plain Layout
17542 LatexType
17543 \end_layout
17544
17545 \end_inset
17546
17547  is
17548 \begin_inset Flex Code
17549 status collapsed
17550
17551 \begin_layout Plain Layout
17552 Environment
17553 \end_layout
17554
17555 \end_inset
17556
17557 .
17558  Indicates whether the environment will stand on its own in the output or
17559  will appear inline with the surrounding text.
17560  If set to false, it is supposed that the \SpecialChar LaTeX
17561  environment ignores white space
17562  (including one newline character) after the
17563 \begin_inset Flex Code
17564 status collapsed
17565
17566 \begin_layout Plain Layout
17567
17568 \backslash
17569 begin{
17570 \emph on
17571 LatexName
17572 \emph default
17573 }
17574 \end_layout
17575
17576 \end_inset
17577
17578  and
17579 \begin_inset Flex Code
17580 status collapsed
17581
17582 \begin_layout Plain Layout
17583
17584 \backslash
17585 end{
17586 \emph on
17587 LatexName
17588 \emph default
17589 }
17590 \end_layout
17591
17592 \end_inset
17593
17594  tags.
17595  Default is true.
17596 \end_layout
17597
17598 \begin_layout Description
17599 \begin_inset Flex Code
17600 status collapsed
17601
17602 \begin_layout Plain Layout
17603 End
17604 \end_layout
17605
17606 \end_inset
17607
17608  Required at the end of the
17609 \begin_inset Flex Code
17610 status collapsed
17611
17612 \begin_layout Plain Layout
17613 InsetLayout
17614 \end_layout
17615
17616 \end_inset
17617
17618  declarations.
17619 \end_layout
17620
17621 \begin_layout Description
17622 \begin_inset Flex Code
17623 status collapsed
17624
17625 \begin_layout Plain Layout
17626 Font
17627 \end_layout
17628
17629 \end_inset
17630
17631  The font used for both the text body
17632 \emph on
17633 and
17634 \emph default
17635  the label.
17636  See
17637 \begin_inset CommandInset ref
17638 LatexCommand ref
17639 reference "subsec:Font-description"
17640
17641 \end_inset
17642
17643 .
17644  Note that defining this font automatically defines the
17645 \begin_inset Flex Code
17646 status collapsed
17647
17648 \begin_layout Plain Layout
17649 LabelFont
17650 \end_layout
17651
17652 \end_inset
17653
17654  to the same value, so define this first and define
17655 \begin_inset Flex Code
17656 status collapsed
17657
17658 \begin_layout Plain Layout
17659 LabelFont
17660 \end_layout
17661
17662 \end_inset
17663
17664  later if you want them to be different.
17665 \change_inserted -195340706 1421002157
17666
17667 \end_layout
17668
17669 \begin_layout Description
17670
17671 \change_inserted -195340706 1421002157
17672 \begin_inset Flex Code
17673 status collapsed
17674
17675 \begin_layout Plain Layout
17676
17677 \change_inserted -195340706 1421002157
17678 FixedWidthPreambleEncoding
17679 \end_layout
17680
17681 \end_inset
17682
17683  [
17684 \begin_inset Flex Code
17685 status collapsed
17686
17687 \begin_layout Plain Layout
17688
17689 \change_inserted -195340706 1421002157
17690
17691 \emph on
17692 0
17693 \end_layout
17694
17695 \end_inset
17696
17697 ,
17698 \begin_inset space \thinspace{}
17699 \end_inset
17700
17701
17702 \begin_inset Flex Code
17703 status collapsed
17704
17705 \begin_layout Plain Layout
17706
17707 \change_inserted -195340706 1421002157
17708 1
17709 \end_layout
17710
17711 \end_inset
17712
17713 ] Force a fixed width encoding for the translated contents of
17714 \begin_inset Flex Code
17715 status collapsed
17716
17717 \begin_layout Plain Layout
17718
17719 \change_inserted -195340706 1421002157
17720 BabelPreamble
17721 \end_layout
17722
17723 \end_inset
17724
17725  and
17726 \begin_inset Flex Code
17727 status collapsed
17728
17729 \begin_layout Plain Layout
17730
17731 \change_inserted -195340706 1421002157
17732 LangPreamble
17733 \end_layout
17734
17735 \end_inset
17736
17737  code generated by this layout.
17738  This is needed for special packages like the listings package that do not
17739  work with variable width encodings such as utf8.
17740  Default is false.
17741  This setting is ignored if fully unicode aware \SpecialChar LaTeX
17742  backends such as Xe\SpecialChar LaTeX
17743  are
17744  used.
17745 \change_unchanged
17746
17747 \end_layout
17748
17749 \begin_layout Description
17750 \begin_inset Flex Code
17751 status collapsed
17752
17753 \begin_layout Plain Layout
17754 ForceLocalFontSwitch
17755 \end_layout
17756
17757 \end_inset
17758
17759  [
17760 \begin_inset Flex Code
17761 status collapsed
17762
17763 \begin_layout Plain Layout
17764
17765 \emph on
17766 0
17767 \end_layout
17768
17769 \end_inset
17770
17771 ,
17772 \begin_inset space \thinspace{}
17773 \end_inset
17774
17775
17776 \begin_inset Flex Code
17777 status collapsed
17778
17779 \begin_layout Plain Layout
17780 1
17781 \end_layout
17782
17783 \end_inset
17784
17785 ] When using babel, always use a local font switch (
17786 \begin_inset Flex Code
17787 status collapsed
17788
17789 \begin_layout Plain Layout
17790
17791 \backslash
17792 foreignlanguage
17793 \end_layout
17794
17795 \end_inset
17796
17797 ), never a global one (such as
17798 \begin_inset Flex Code
17799 status collapsed
17800
17801 \begin_layout Plain Layout
17802
17803 \backslash
17804 selectlanguage
17805 \end_layout
17806
17807 \end_inset
17808
17809 ).
17810 \end_layout
17811
17812 \begin_layout Description
17813 \begin_inset Flex Code
17814 status collapsed
17815
17816 \begin_layout Plain Layout
17817 ForceLTR
17818 \end_layout
17819
17820 \end_inset
17821
17822  [
17823 \begin_inset Flex Code
17824 status collapsed
17825
17826 \begin_layout Plain Layout
17827
17828 \emph on
17829 0
17830 \end_layout
17831
17832 \end_inset
17833
17834 ,
17835 \begin_inset space \thinspace{}
17836 \end_inset
17837
17838
17839 \begin_inset Flex Code
17840 status collapsed
17841
17842 \begin_layout Plain Layout
17843 1
17844 \end_layout
17845
17846 \end_inset
17847
17848 ] Force the
17849 \begin_inset Quotes eld
17850 \end_inset
17851
17852 latex
17853 \begin_inset Quotes erd
17854 \end_inset
17855
17856  language, leading to Left-to-Right (Latin) output, e.
17857 \begin_inset space \thinspace{}
17858 \end_inset
17859
17860 g.
17861 \begin_inset space \space{}
17862 \end_inset
17863
17864 in \SpecialChar TeX
17865  code or URL.
17866  A kludge.
17867 \change_inserted -712698321 1417441977
17868
17869 \end_layout
17870
17871 \begin_layout Description
17872
17873 \change_inserted -712698321 1417442090
17874 \begin_inset Flex Code
17875 status collapsed
17876
17877 \begin_layout Plain Layout
17878
17879 \change_inserted -712698321 1417441983
17880 ForceOwnlines
17881 \end_layout
17882
17883 \end_inset
17884
17885  [
17886 \begin_inset Flex Code
17887 status collapsed
17888
17889 \begin_layout Plain Layout
17890
17891 \change_inserted -712698321 1417441978
17892
17893 \emph on
17894 0
17895 \end_layout
17896
17897 \end_inset
17898
17899 ,
17900 \begin_inset space \thinspace{}
17901 \end_inset
17902
17903
17904 \begin_inset Flex Code
17905 status collapsed
17906
17907 \begin_layout Plain Layout
17908
17909 \change_inserted -712698321 1417441978
17910 1
17911 \end_layout
17912
17913 \end_inset
17914
17915 ] Force a a line break in the \SpecialChar LaTeX
17916  output before the inset starts and after
17917  the inset ends.
17918  This assures the inset itself is output on its own lines, for parsing purposes.
17919
17920 \change_inserted 274215730 1419105878
17921  Default is false.
17922 \change_unchanged
17923
17924 \end_layout
17925
17926 \begin_layout Description
17927 \begin_inset Flex Code
17928 status collapsed
17929
17930 \begin_layout Plain Layout
17931 ForcePlain
17932 \end_layout
17933
17934 \end_inset
17935
17936  [
17937 \begin_inset Flex Code
17938 status collapsed
17939
17940 \begin_layout Plain Layout
17941
17942 \emph on
17943 0
17944 \end_layout
17945
17946 \end_inset
17947
17948 ,
17949 \begin_inset space \thinspace{}
17950 \end_inset
17951
17952
17953 \begin_inset Flex Code
17954 status collapsed
17955
17956 \begin_layout Plain Layout
17957 1
17958 \end_layout
17959
17960 \end_inset
17961
17962 ] Indicates whether the
17963 \begin_inset Flex Code
17964 status collapsed
17965
17966 \begin_layout Plain Layout
17967 PlainLayout
17968 \end_layout
17969
17970 \end_inset
17971
17972  should be used or, instead, the user can change the paragraph style used
17973  in the inset.
17974  Default is false.
17975 \end_layout
17976
17977 \begin_layout Description
17978 \begin_inset Flex Code
17979 status collapsed
17980
17981 \begin_layout Plain Layout
17982 FreeSpacing
17983 \end_layout
17984
17985 \end_inset
17986
17987  [
17988 \begin_inset Flex Code
17989 status collapsed
17990
17991 \begin_layout Plain Layout
17992
17993 \emph on
17994 0
17995 \end_layout
17996
17997 \end_inset
17998
17999 ,
18000 \begin_inset space \thinspace{}
18001 \end_inset
18002
18003
18004 \begin_inset Flex Code
18005 status collapsed
18006
18007 \begin_layout Plain Layout
18008 1
18009 \end_layout
18010
18011 \end_inset
18012
18013 ] As with paragraph styles, see
18014 \begin_inset CommandInset ref
18015 LatexCommand ref
18016 reference "subsec:Paragraph-Styles"
18017
18018 \end_inset
18019
18020 .
18021 \end_layout
18022
18023 \begin_layout Description
18024 \begin_inset Flex Code
18025 status collapsed
18026
18027 \begin_layout Plain Layout
18028 HTML*
18029 \end_layout
18030
18031 \end_inset
18032
18033  These tags control the XHTML output.
18034  See
18035 \begin_inset CommandInset ref
18036 LatexCommand ref
18037 reference "sec:Tags-for-XHTML"
18038
18039 \end_inset
18040
18041 .
18042 \end_layout
18043
18044 \begin_layout Description
18045 \begin_inset Flex Code
18046 status collapsed
18047
18048 \begin_layout Plain Layout
18049 InToc
18050 \end_layout
18051
18052 \end_inset
18053
18054  [
18055 \begin_inset Flex Code
18056 status collapsed
18057
18058 \begin_layout Plain Layout
18059
18060 \emph on
18061 0
18062 \end_layout
18063
18064 \end_inset
18065
18066 ,
18067 \begin_inset space \thinspace{}
18068 \end_inset
18069
18070
18071 \begin_inset Flex Code
18072 status collapsed
18073
18074 \begin_layout Plain Layout
18075 1
18076 \end_layout
18077
18078 \end_inset
18079
18080 ] Whether to include the contents of this inset in the strings generated
18081  for the `Outline' pane.
18082  One would not, for example, want the content of a footnote in a section
18083  header to be included in the TOC displayed in the outline, but one would
18084  normally want the content of a character style displayed.
18085  Default is false: not to include.
18086 \end_layout
18087
18088 \begin_layout Description
18089 \begin_inset Flex Code
18090 status collapsed
18091
18092 \begin_layout Plain Layout
18093 KeepEmpty
18094 \end_layout
18095
18096 \end_inset
18097
18098  [
18099 \emph on
18100
18101 \begin_inset Flex Code
18102 status collapsed
18103
18104 \begin_layout Plain Layout
18105 0
18106 \end_layout
18107
18108 \end_inset
18109
18110
18111 \emph default
18112 ,
18113 \begin_inset space \thinspace{}
18114 \end_inset
18115
18116
18117 \begin_inset Flex Code
18118 status collapsed
18119
18120 \begin_layout Plain Layout
18121 1
18122 \end_layout
18123
18124 \end_inset
18125
18126 ] As with paragraph styles, see
18127 \begin_inset CommandInset ref
18128 LatexCommand ref
18129 reference "subsec:Paragraph-Styles"
18130
18131 \end_inset
18132
18133 .
18134 \end_layout
18135
18136 \begin_layout Description
18137 \begin_inset Flex Code
18138 status collapsed
18139
18140 \begin_layout Plain Layout
18141 LabelFont
18142 \end_layout
18143
18144 \end_inset
18145
18146  The font used for the label.
18147  See
18148 \begin_inset CommandInset ref
18149 LatexCommand ref
18150 reference "subsec:Font-description"
18151
18152 \end_inset
18153
18154 .
18155  Note that this definition can never appear before
18156 \begin_inset Flex Code
18157 status collapsed
18158
18159 \begin_layout Plain Layout
18160 Font
18161 \end_layout
18162
18163 \end_inset
18164
18165 , lest it be ineffective.
18166 \end_layout
18167
18168 \begin_layout Description
18169 \begin_inset Flex Code
18170 status collapsed
18171
18172 \begin_layout Plain Layout
18173 LabelString
18174 \end_layout
18175
18176 \end_inset
18177
18178  [
18179 \begin_inset Flex Code
18180 status collapsed
18181
18182 \begin_layout Plain Layout
18183 string
18184 \end_layout
18185
18186 \end_inset
18187
18188 =
18189 \begin_inset Quotes erd
18190 \end_inset
18191
18192
18193 \begin_inset Quotes erd
18194 \end_inset
18195
18196 ] What will be displayed on the button or elsewhere as the inset label.
18197  Some inset types (
18198 \begin_inset Flex Code
18199 status collapsed
18200
18201 \begin_layout Plain Layout
18202 \SpecialChar TeX
18203  code
18204 \end_layout
18205
18206 \end_inset
18207
18208  and
18209 \begin_inset Flex Code
18210 status collapsed
18211
18212 \begin_layout Plain Layout
18213 Branch
18214 \end_layout
18215
18216 \end_inset
18217
18218 ) modify this label on the fly.
18219 \end_layout
18220
18221 \begin_layout Description
18222 \begin_inset Flex Code
18223 status collapsed
18224
18225 \begin_layout Plain Layout
18226 LangPreamble
18227 \end_layout
18228
18229 \end_inset
18230
18231  Language dependent preamble; see
18232 \begin_inset CommandInset ref
18233 LatexCommand ref
18234 reference "subsec:I18n"
18235
18236 \end_inset
18237
18238 .
18239 \end_layout
18240
18241 \begin_layout Description
18242 \begin_inset Flex Code
18243 status collapsed
18244
18245 \begin_layout Plain Layout
18246 LatexName
18247 \end_layout
18248
18249 \end_inset
18250
18251  [
18252 \begin_inset Flex Code
18253 status collapsed
18254
18255 \begin_layout Plain Layout
18256 <name>
18257 \end_layout
18258
18259 \end_inset
18260
18261 ] The name of the corresponding \SpecialChar LaTeX
18262  stuff.
18263  Either the environment or command name.
18264 \end_layout
18265
18266 \begin_layout Description
18267 \begin_inset Flex Code
18268 status collapsed
18269
18270 \begin_layout Plain Layout
18271 LatexParam
18272 \end_layout
18273
18274 \end_inset
18275
18276  [
18277 \begin_inset Flex Code
18278 status collapsed
18279
18280 \begin_layout Plain Layout
18281 <parameter>
18282 \end_layout
18283
18284 \end_inset
18285
18286 ] The optional parameter for the corresponding
18287 \begin_inset Flex Code
18288 status collapsed
18289
18290 \begin_layout Plain Layout
18291 LatexName
18292 \end_layout
18293
18294 \end_inset
18295
18296  stuff, including possible bracket pairs like
18297 \begin_inset Flex Code
18298 status collapsed
18299
18300 \begin_layout Plain Layout
18301 []
18302 \end_layout
18303
18304 \end_inset
18305
18306 .
18307  This parameter cannot be changed from within \SpecialChar LyX
18308  (use
18309 \begin_inset Flex Code
18310 status collapsed
18311
18312 \begin_layout Plain Layout
18313 Argument
18314 \end_layout
18315
18316 \end_inset
18317
18318  for customizable parameters).
18319  It will be output as is after all \SpecialChar LaTeX
18320
18321 \begin_inset Flex Code
18322 status collapsed
18323
18324 \begin_layout Plain Layout
18325 Argument
18326 \end_layout
18327
18328 \end_inset
18329
18330 s.
18331 \end_layout
18332
18333 \begin_layout Description
18334 \begin_inset Flex Code
18335 status collapsed
18336
18337 \begin_layout Plain Layout
18338 LatexType
18339 \end_layout
18340
18341 \end_inset
18342
18343  [
18344 \begin_inset Flex Code
18345 status collapsed
18346
18347 \begin_layout Plain Layout
18348 Command, Environment, None
18349 \end_layout
18350
18351 \end_inset
18352
18353 ] How the style should be translated into \SpecialChar LaTeX
18354 .
18355 \begin_inset Foot
18356 status collapsed
18357
18358 \begin_layout Plain Layout
18359 \begin_inset Flex Code
18360 status collapsed
18361
18362 \begin_layout Plain Layout
18363 LatexType
18364 \end_layout
18365
18366 \end_inset
18367
18368  is perhaps a bit misleading, since these rules apply to SGML classes too.
18369  Visit the SGML class files for specific examples.
18370 \end_layout
18371
18372 \end_inset
18373
18374
18375 \begin_inset Separator parbreak
18376 \end_inset
18377
18378
18379 \end_layout
18380
18381 \begin_deeper
18382 \begin_layout Description
18383 \begin_inset Flex Code
18384 status collapsed
18385
18386 \begin_layout Plain Layout
18387 None
18388 \end_layout
18389
18390 \end_inset
18391
18392  means nothing special
18393 \end_layout
18394
18395 \begin_layout Description
18396 \begin_inset Flex Code
18397 status collapsed
18398
18399 \begin_layout Plain Layout
18400 Command
18401 \end_layout
18402
18403 \end_inset
18404
18405  means
18406 \begin_inset Flex Code
18407 status collapsed
18408
18409 \begin_layout Plain Layout
18410
18411 \backslash
18412
18413 \emph on
18414 LatexName
18415 \emph default
18416 {\SpecialChar ldots
18417 }
18418 \end_layout
18419
18420 \end_inset
18421
18422
18423 \end_layout
18424
18425 \begin_layout Description
18426 \begin_inset Flex Code
18427 status collapsed
18428
18429 \begin_layout Plain Layout
18430 Environment
18431 \end_layout
18432
18433 \end_inset
18434
18435  means
18436 \begin_inset Flex Code
18437 status collapsed
18438
18439 \begin_layout Plain Layout
18440
18441 \backslash
18442 begin{
18443 \emph on
18444 LatexName
18445 \emph default
18446 }\SpecialChar ldots
18447
18448 \backslash
18449 end{
18450 \emph on
18451 LatexName
18452 \emph default
18453 }
18454 \end_layout
18455
18456 \end_inset
18457
18458
18459 \end_layout
18460
18461 \begin_layout Standard
18462 Putting the last few things together, the \SpecialChar LaTeX
18463  output will be either:
18464 \end_layout
18465
18466 \begin_layout LyX-Code
18467
18468 \backslash
18469 LatexName[LatexParam]{\SpecialChar ldots
18470 }
18471 \end_layout
18472
18473 \begin_layout Standard
18474 or:
18475 \end_layout
18476
18477 \begin_layout LyX-Code
18478
18479 \backslash
18480 begin{LatexName}[LatexParam] \SpecialChar ldots
18481
18482 \backslash
18483 end{LatexName}
18484 \end_layout
18485
18486 \begin_layout Standard
18487 depending upon the \SpecialChar LaTeX
18488  type.
18489 \end_layout
18490
18491 \end_deeper
18492 \begin_layout Description
18493 \begin_inset Flex Code
18494 status collapsed
18495
18496 \begin_layout Plain Layout
18497 LeftDelim
18498 \end_layout
18499
18500 \end_inset
18501
18502  [
18503 \begin_inset Flex Code
18504 status collapsed
18505
18506 \begin_layout Plain Layout
18507 string
18508 \end_layout
18509
18510 \end_inset
18511
18512 ] A string that is put at the beginning of the layout content.
18513  A line break in the output can be indicated by
18514 \begin_inset Flex Code
18515 status collapsed
18516
18517 \begin_layout Plain Layout
18518 <br/>
18519 \end_layout
18520
18521 \end_inset
18522
18523 .
18524 \end_layout
18525
18526 \begin_layout Description
18527 \begin_inset Flex Code
18528 status collapsed
18529
18530 \begin_layout Plain Layout
18531 LyxType
18532 \end_layout
18533
18534 \end_inset
18535
18536  Can be
18537 \begin_inset Flex Code
18538 status collapsed
18539
18540 \begin_layout Plain Layout
18541 charstyle
18542 \end_layout
18543
18544 \end_inset
18545
18546 ,
18547 \begin_inset Flex Code
18548 status collapsed
18549
18550 \begin_layout Plain Layout
18551 custom
18552 \end_layout
18553
18554 \end_inset
18555
18556 ,
18557 \begin_inset Flex Code
18558 status collapsed
18559
18560 \begin_layout Plain Layout
18561 element
18562 \end_layout
18563
18564 \end_inset
18565
18566  or
18567 \begin_inset Flex Code
18568 status collapsed
18569
18570 \begin_layout Plain Layout
18571 end
18572 \end_layout
18573
18574 \end_inset
18575
18576  (indicating a dummy definition ending definitions of charstyles, etc).
18577  This entry is required in and is only meaningful for Flex insets.
18578  Among other things, it determines on which menu this inset will appear.
18579  Setting
18580 \begin_inset Flex Code
18581 status collapsed
18582
18583 \begin_layout Plain Layout
18584 LyXType
18585 \end_layout
18586
18587 \end_inset
18588
18589  to
18590 \begin_inset Flex Code
18591 status collapsed
18592
18593 \begin_layout Plain Layout
18594 charstyle
18595 \end_layout
18596
18597 \end_inset
18598
18599  will automatically set
18600 \begin_inset Flex Code
18601 status collapsed
18602
18603 \begin_layout Plain Layout
18604 MultiPar
18605 \end_layout
18606
18607 \end_inset
18608
18609  to false.
18610
18611 \begin_inset Flex Code
18612 status collapsed
18613
18614 \begin_layout Plain Layout
18615 MultiPar
18616 \end_layout
18617
18618 \end_inset
18619
18620  can be set to true for
18621 \begin_inset Flex Code
18622 status collapsed
18623
18624 \begin_layout Plain Layout
18625 charstyle
18626 \end_layout
18627
18628 \end_inset
18629
18630  insets by setting it
18631 \emph on
18632 after
18633 \emph default
18634  you set the
18635 \begin_inset Flex Code
18636 status collapsed
18637
18638 \begin_layout Plain Layout
18639 LyXType
18640 \end_layout
18641
18642 \end_inset
18643
18644 .
18645 \end_layout
18646
18647 \begin_layout Description
18648 \begin_inset Flex Code
18649 status collapsed
18650
18651 \begin_layout Plain Layout
18652 MultiPar
18653 \end_layout
18654
18655 \end_inset
18656
18657  [
18658 \begin_inset Flex Code
18659 status collapsed
18660
18661 \begin_layout Plain Layout
18662
18663 \emph on
18664 0
18665 \end_layout
18666
18667 \end_inset
18668
18669 ,
18670 \begin_inset space \thinspace{}
18671 \end_inset
18672
18673
18674 \begin_inset Flex Code
18675 status collapsed
18676
18677 \begin_layout Plain Layout
18678 1
18679 \end_layout
18680
18681 \end_inset
18682
18683 ] Whether multiple paragraphs are permitted in this inset.
18684  This will also set
18685 \begin_inset Flex Code
18686 status collapsed
18687
18688 \begin_layout Plain Layout
18689 CustomPars
18690 \end_layout
18691
18692 \end_inset
18693
18694  to the same value and
18695 \begin_inset Flex Code
18696 status collapsed
18697
18698 \begin_layout Plain Layout
18699 ForcePlain
18700 \end_layout
18701
18702 \end_inset
18703
18704  to the opposite value.
18705  These can be reset to other values, if they are used
18706 \emph on
18707 after
18708 \emph default
18709
18710 \begin_inset Flex Code
18711 status collapsed
18712
18713 \begin_layout Plain Layout
18714 MultiPar
18715 \end_layout
18716
18717 \end_inset
18718
18719 .
18720  Default is true.
18721 \end_layout
18722
18723 \begin_layout Description
18724 \begin_inset Flex Code
18725 status collapsed
18726
18727 \begin_layout Plain Layout
18728 NeedProtect
18729 \end_layout
18730
18731 \end_inset
18732
18733  [
18734 \begin_inset Flex Code
18735 status collapsed
18736
18737 \begin_layout Plain Layout
18738
18739 \emph on
18740 0
18741 \end_layout
18742
18743 \end_inset
18744
18745 ,
18746 \begin_inset space \thinspace{}
18747 \end_inset
18748
18749
18750 \begin_inset Flex Code
18751 status collapsed
18752
18753 \begin_layout Plain Layout
18754 1
18755 \end_layout
18756
18757 \end_inset
18758
18759 ] Whether fragile commands in this inset should be
18760 \begin_inset Flex Code
18761 status collapsed
18762
18763 \begin_layout Plain Layout
18764
18765 \backslash
18766 protect
18767 \end_layout
18768
18769 \end_inset
18770
18771 'ed.
18772  (Note: This is
18773 \emph on
18774 not
18775 \emph default
18776  whether the command should itself be protected.) Default is false.
18777 \end_layout
18778
18779 \begin_layout Description
18780 \begin_inset Flex Code
18781 status collapsed
18782
18783 \begin_layout Plain Layout
18784 NoInsetLayout
18785 \end_layout
18786
18787 \end_inset
18788
18789  [
18790 \begin_inset Flex Code
18791 status collapsed
18792
18793 \begin_layout Plain Layout
18794 <layout>
18795 \end_layout
18796
18797 \end_inset
18798
18799 ] Deletes an existing
18800 \begin_inset Flex Code
18801 status collapsed
18802
18803 \begin_layout Plain Layout
18804 InsetLayout
18805 \end_layout
18806
18807 \end_inset
18808
18809 .
18810 \change_inserted -712698321 1417953494
18811
18812 \end_layout
18813
18814 \begin_layout Description
18815
18816 \change_inserted -712698321 1417953559
18817 \begin_inset Flex Code
18818 status collapsed
18819
18820 \begin_layout Plain Layout
18821
18822 \change_inserted -712698321 1417953494
18823 ObsoletedBy
18824 \end_layout
18825
18826 \end_inset
18827
18828  [
18829 \begin_inset Flex Code
18830 status collapsed
18831
18832 \begin_layout Plain Layout
18833
18834 \change_inserted -712698321 1417953574
18835 <layout>
18836 \end_layout
18837
18838 \end_inset
18839
18840 ] Name of an
18841 \begin_inset Flex Code
18842 status collapsed
18843
18844 \begin_layout Plain Layout
18845
18846 \change_inserted -712698321 1417953533
18847 InsetLayout
18848 \end_layout
18849
18850 \end_inset
18851
18852  that has replaced this
18853 \begin_inset Flex Code
18854 status collapsed
18855
18856 \begin_layout Plain Layout
18857
18858 \change_inserted -712698321 1417953551
18859 InsetLayout
18860 \end_layout
18861
18862 \end_inset
18863
18864 .
18865  This is used to rename an
18866 \begin_inset Flex Code
18867 status collapsed
18868
18869 \begin_layout Plain Layout
18870
18871 \change_inserted -712698321 1417953559
18872 InsetLayout
18873 \end_layout
18874
18875 \end_inset
18876
18877 , while keeping backward compatibility.
18878 \change_unchanged
18879
18880 \end_layout
18881
18882 \begin_layout Description
18883 \begin_inset Flex Code
18884 status collapsed
18885
18886 \begin_layout Plain Layout
18887 ParbreakIsNewline
18888 \end_layout
18889
18890 \end_inset
18891
18892  [
18893 \begin_inset Flex Code
18894 status collapsed
18895
18896 \begin_layout Plain Layout
18897
18898 \emph on
18899 0
18900 \end_layout
18901
18902 \end_inset
18903
18904 ,
18905 \begin_inset space \thinspace{}
18906 \end_inset
18907
18908
18909 \begin_inset Flex Code
18910 status collapsed
18911
18912 \begin_layout Plain Layout
18913 1
18914 \end_layout
18915
18916 \end_inset
18917
18918 ] As with paragraph styles, see
18919 \begin_inset CommandInset ref
18920 LatexCommand ref
18921 reference "subsec:Paragraph-Styles"
18922
18923 \end_inset
18924
18925 .
18926  Default is false.
18927 \end_layout
18928
18929 \begin_layout Description
18930 \begin_inset Flex Code
18931 status collapsed
18932
18933 \begin_layout Plain Layout
18934 PassThru
18935 \end_layout
18936
18937 \end_inset
18938
18939  [
18940 \begin_inset Flex Code
18941 status collapsed
18942
18943 \begin_layout Plain Layout
18944
18945 \emph on
18946 0
18947 \end_layout
18948
18949 \end_inset
18950
18951 ,
18952 \begin_inset space \thinspace{}
18953 \end_inset
18954
18955
18956 \begin_inset Flex Code
18957 status collapsed
18958
18959 \begin_layout Plain Layout
18960 1
18961 \end_layout
18962
18963 \end_inset
18964
18965 ] As with paragraph styles, see
18966 \begin_inset CommandInset ref
18967 LatexCommand ref
18968 reference "subsec:Paragraph-Styles"
18969
18970 \end_inset
18971
18972 .
18973  Default is false.
18974 \end_layout
18975
18976 \begin_layout Description
18977 \begin_inset Flex Code
18978 status collapsed
18979
18980 \begin_layout Plain Layout
18981 Preamble
18982 \end_layout
18983
18984 \end_inset
18985
18986  As with paragraph styles, see
18987 \begin_inset CommandInset ref
18988 LatexCommand ref
18989 reference "subsec:Paragraph-Styles"
18990
18991 \end_inset
18992
18993 .
18994 \end_layout
18995
18996 \begin_layout Description
18997 \begin_inset Flex Code
18998 status collapsed
18999
19000 \begin_layout Plain Layout
19001 RefPrefix
19002 \end_layout
19003
19004 \end_inset
19005
19006  [
19007 \begin_inset Flex Code
19008 status collapsed
19009
19010 \begin_layout Plain Layout
19011 string
19012 \end_layout
19013
19014 \end_inset
19015
19016 ] The prefix to use when creating labels referring to insets of this type.
19017  This allows the use of formatted references.
19018 \end_layout
19019
19020 \begin_layout Description
19021 \begin_inset Flex Code
19022 status collapsed
19023
19024 \begin_layout Plain Layout
19025 Requires
19026 \end_layout
19027
19028 \end_inset
19029
19030  [
19031 \begin_inset Flex Code
19032 status collapsed
19033
19034 \begin_layout Plain Layout
19035 string
19036 \end_layout
19037
19038 \end_inset
19039
19040 ] As with paragraph styles, see
19041 \begin_inset CommandInset ref
19042 LatexCommand ref
19043 reference "subsec:Paragraph-Styles"
19044
19045 \end_inset
19046
19047 .
19048 \end_layout
19049
19050 \begin_layout Description
19051 \begin_inset Flex Code
19052 status collapsed
19053
19054 \begin_layout Plain Layout
19055 ResetArgs
19056 \end_layout
19057
19058 \end_inset
19059
19060  [
19061 \begin_inset Flex Code
19062 status collapsed
19063
19064 \begin_layout Plain Layout
19065
19066 \emph on
19067 0
19068 \end_layout
19069
19070 \end_inset
19071
19072 ,
19073 \begin_inset space \thinspace{}
19074 \end_inset
19075
19076
19077 \begin_inset Flex Code
19078 status collapsed
19079
19080 \begin_layout Plain Layout
19081 1
19082 \end_layout
19083
19084 \end_inset
19085
19086 ] Resets the \SpecialChar LaTeX
19087  arguments of this layout (as defined via the
19088 \begin_inset Flex Code
19089 status collapsed
19090
19091 \begin_layout Plain Layout
19092 Argument
19093 \end_layout
19094
19095 \end_inset
19096
19097  tag).
19098  This is useful if you have copied a style via
19099 \begin_inset Flex Code
19100 status collapsed
19101
19102 \begin_layout Plain Layout
19103 CopyStyle
19104 \end_layout
19105
19106 \end_inset
19107
19108 , but you do not want to inherit its (required and optional) arguments.
19109 \end_layout
19110
19111 \begin_layout Description
19112 \begin_inset Flex Code
19113 status collapsed
19114
19115 \begin_layout Plain Layout
19116 ResetsFont
19117 \end_layout
19118
19119 \end_inset
19120
19121  [
19122 \begin_inset Flex Code
19123 status collapsed
19124
19125 \begin_layout Plain Layout
19126 0
19127 \end_layout
19128
19129 \end_inset
19130
19131 ,
19132 \begin_inset space \thinspace{}
19133 \end_inset
19134
19135
19136 \begin_inset Flex Code
19137 status collapsed
19138
19139 \begin_layout Plain Layout
19140
19141 \emph on
19142 1
19143 \end_layout
19144
19145 \end_inset
19146
19147 ] Whether this inset should use the font of its surrounding environment
19148  or uses its own.
19149  Default is false: use the font of the surrounding environment.
19150 \end_layout
19151
19152 \begin_layout Description
19153 \begin_inset Flex Code
19154 status collapsed
19155
19156 \begin_layout Plain Layout
19157 RightDelim
19158 \end_layout
19159
19160 \end_inset
19161
19162  [
19163 \begin_inset Flex Code
19164 status collapsed
19165
19166 \begin_layout Plain Layout
19167 string
19168 \end_layout
19169
19170 \end_inset
19171
19172 ] A string that is put at the end of the layout content.
19173  A line break in the output can be indicated by
19174 \begin_inset Flex Code
19175 status collapsed
19176
19177 \begin_layout Plain Layout
19178 <br/>
19179 \end_layout
19180
19181 \end_inset
19182
19183 .
19184 \end_layout
19185
19186 \begin_layout Description
19187 \begin_inset Flex Code
19188 status collapsed
19189
19190 \begin_layout Plain Layout
19191 Spellcheck
19192 \end_layout
19193
19194 \end_inset
19195
19196  [
19197 \begin_inset Flex Code
19198 status collapsed
19199
19200 \begin_layout Plain Layout
19201 0
19202 \end_layout
19203
19204 \end_inset
19205
19206 ,
19207 \begin_inset space \thinspace{}
19208 \end_inset
19209
19210
19211 \begin_inset Flex Code
19212 status collapsed
19213
19214 \begin_layout Plain Layout
19215
19216 \emph on
19217 1
19218 \end_layout
19219
19220 \end_inset
19221
19222 ] Allow spell-checking the contents of this inset.
19223  Default is true.
19224 \end_layout
19225
19226 \begin_layout Subsection
19227 Counters
19228 \begin_inset CommandInset label
19229 LatexCommand label
19230 name "subsec:Counters"
19231
19232 \end_inset
19233
19234
19235 \end_layout
19236
19237 \begin_layout Standard
19238 It is necessary to define the counters (
19239 \begin_inset Flex MenuItem
19240 status collapsed
19241
19242 \begin_layout Plain Layout
19243 chapter
19244 \end_layout
19245
19246 \end_inset
19247
19248 ,
19249 \begin_inset Flex MenuItem
19250 status collapsed
19251
19252 \begin_layout Plain Layout
19253 figure
19254 \end_layout
19255
19256 \end_inset
19257
19258 , \SpecialChar ldots
19259 ) in the text class itself.
19260  The standard counters are defined in the file
19261 \begin_inset Flex Code
19262 status collapsed
19263
19264 \begin_layout Plain Layout
19265 stdcounters.inc
19266 \end_layout
19267
19268 \end_inset
19269
19270 , so you may have to do no more than add
19271 \end_layout
19272
19273 \begin_layout LyX-Code
19274 Input stdcounters.inc
19275 \end_layout
19276
19277 \begin_layout Standard
19278 to your layout file to get them to work.
19279  But if you want to define custom counters, then you can do so.
19280  The counter declaration must begin with:
19281 \end_layout
19282
19283 \begin_layout LyX-Code
19284 Counter CounterName
19285 \end_layout
19286
19287 \begin_layout Standard
19288 where of course `
19289 \begin_inset Flex Code
19290 status collapsed
19291
19292 \begin_layout Plain Layout
19293 CounterName
19294 \end_layout
19295
19296 \end_inset
19297
19298 ' is replaced by the name of the counter.
19299  And it must end with
19300 \begin_inset Quotes eld
19301 \end_inset
19302
19303
19304 \begin_inset Flex Code
19305 status collapsed
19306
19307 \begin_layout Plain Layout
19308 End
19309 \end_layout
19310
19311 \end_inset
19312
19313
19314 \begin_inset Quotes erd
19315 \end_inset
19316
19317 .
19318  The following parameters can also be used:
19319 \end_layout
19320
19321 \begin_layout Description
19322 \begin_inset Flex Code
19323 status collapsed
19324
19325 \begin_layout Plain Layout
19326 InitialValue
19327 \end_layout
19328
19329 \end_inset
19330
19331  [
19332 \begin_inset Flex Code
19333 status collapsed
19334
19335 \begin_layout Plain Layout
19336 int=1
19337 \end_layout
19338
19339 \end_inset
19340
19341 ] Sets the initial value for the counter, to which it will be reset whenever
19342  that happens.
19343  Normally, one will want the default, 1.
19344 \end_layout
19345
19346 \begin_layout Description
19347 \begin_inset Flex Code
19348 status collapsed
19349
19350 \begin_layout Plain Layout
19351 LabelString
19352 \end_layout
19353
19354 \end_inset
19355
19356  [
19357 \begin_inset Flex Code
19358 status collapsed
19359
19360 \begin_layout Plain Layout
19361 string
19362 \end_layout
19363
19364 \end_inset
19365
19366 =
19367 \begin_inset Quotes erd
19368 \end_inset
19369
19370
19371 \begin_inset Quotes erd
19372 \end_inset
19373
19374 ] When defined, this string defines how the counter is displayed.
19375  Setting this value sets
19376 \begin_inset Flex Code
19377 status collapsed
19378
19379 \begin_layout Plain Layout
19380 LabelStringAppendix
19381 \end_layout
19382
19383 \end_inset
19384
19385  to the same value.
19386  The following special constructs can be used in the string:
19387 \begin_inset Separator parbreak
19388 \end_inset
19389
19390
19391 \end_layout
19392
19393 \begin_deeper
19394 \begin_layout Itemize
19395 \begin_inset Flex Code
19396 status collapsed
19397
19398 \begin_layout Plain Layout
19399
19400 \backslash
19401 thecounter
19402 \end_layout
19403
19404 \end_inset
19405
19406  will be replaced by the expansion of the
19407 \begin_inset Flex Code
19408 status collapsed
19409
19410 \begin_layout Plain Layout
19411 LabelString
19412 \end_layout
19413
19414 \end_inset
19415
19416  (or
19417 \begin_inset Flex Code
19418 status collapsed
19419
19420 \begin_layout Plain Layout
19421 LabelStringAppendix
19422 \end_layout
19423
19424 \end_inset
19425
19426 ) of the counter
19427 \begin_inset Flex Code
19428 status collapsed
19429
19430 \begin_layout Plain Layout
19431 counter
19432 \end_layout
19433
19434 \end_inset
19435
19436 .
19437
19438 \end_layout
19439
19440 \begin_layout Itemize
19441 counter values can be expressed using \SpecialChar LaTeX
19442 -like macros
19443 \begin_inset Newline newline
19444 \end_inset
19445
19446
19447 \begin_inset Flex Code
19448 status collapsed
19449
19450 \begin_layout Plain Layout
19451
19452 \backslash
19453
19454 \emph on
19455 numbertype
19456 \emph default
19457 {
19458 \emph on
19459 counter
19460 \emph default
19461 }
19462 \end_layout
19463
19464 \end_inset
19465
19466 , where
19467 \begin_inset Flex Code
19468 status collapsed
19469
19470 \begin_layout Plain Layout
19471
19472 \emph on
19473 numbertype
19474 \end_layout
19475
19476 \end_inset
19477
19478  can be:
19479 \begin_inset Foot
19480 status collapsed
19481
19482 \begin_layout Plain Layout
19483
19484 \family roman
19485 \series medium
19486 \shape up
19487 \size normal
19488 \emph off
19489 \bar no
19490 \noun off
19491 \color none
19492 Actually, the situation is a bit more complicated: any
19493 \family default
19494 \series default
19495 \shape default
19496 \emph default
19497 \bar default
19498
19499 \size default
19500 \emph on
19501 \noun default
19502 \color inherit
19503 numbertype
19504 \family roman
19505 \series medium
19506 \shape up
19507 \size normal
19508 \emph off
19509 \bar no
19510 \noun off
19511  other than those described below will produce arabic numerals.
19512  It would not be surprising to see this change in the future.
19513 \end_layout
19514
19515 \end_inset
19516
19517
19518 \begin_inset Flex Code
19519 status collapsed
19520
19521 \begin_layout Plain Layout
19522 arabic
19523 \end_layout
19524
19525 \end_inset
19526
19527 : 1, 2, 3,\SpecialChar ldots
19528 ;
19529 \begin_inset Flex Code
19530 status collapsed
19531
19532 \begin_layout Plain Layout
19533 alph
19534 \end_layout
19535
19536 \end_inset
19537
19538  for lower-case letters: a, b, c, \SpecialChar ldots
19539 ;
19540 \begin_inset Flex Code
19541 status collapsed
19542
19543 \begin_layout Plain Layout
19544 Alph
19545 \end_layout
19546
19547 \end_inset
19548
19549  for upper-case letters: A, B, C, \SpecialChar ldots
19550 ;
19551 \begin_inset Flex Code
19552 status collapsed
19553
19554 \begin_layout Plain Layout
19555 roman
19556 \end_layout
19557
19558 \end_inset
19559
19560  for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
19561 ;
19562 \begin_inset Flex Code
19563 status collapsed
19564
19565 \begin_layout Plain Layout
19566 Roman
19567 \end_layout
19568
19569 \end_inset
19570
19571  for upper-case roman numerals: I, II, III\SpecialChar ldots
19572 ;
19573 \begin_inset Flex Code
19574 status collapsed
19575
19576 \begin_layout Plain Layout
19577 hebrew
19578 \end_layout
19579
19580 \end_inset
19581
19582  for hebrew numerals.
19583 \end_layout
19584
19585 \end_deeper
19586 \begin_layout Standard
19587 If LabelString is not defined, a default value is constructed as follows:
19588  if the counter has a master counter
19589 \begin_inset Flex Code
19590 status collapsed
19591
19592 \begin_layout Plain Layout
19593 master
19594 \end_layout
19595
19596 \end_inset
19597
19598  (defined via
19599 \begin_inset Flex Code
19600 status collapsed
19601
19602 \begin_layout Plain Layout
19603 Within
19604 \end_layout
19605
19606 \end_inset
19607
19608 ), the string
19609 \begin_inset Newline newline
19610 \end_inset
19611
19612
19613 \begin_inset Flex Code
19614 status collapsed
19615
19616 \begin_layout Plain Layout
19617
19618 \backslash
19619 themaster.
19620 \backslash
19621 arabic{counter}
19622 \end_layout
19623
19624 \end_inset
19625
19626  is used; otherwise the string
19627 \begin_inset Flex Code
19628 status collapsed
19629
19630 \begin_layout Plain Layout
19631
19632 \backslash
19633 arabic{counter}
19634 \end_layout
19635
19636 \end_inset
19637
19638  is used.
19639 \end_layout
19640
19641 \begin_layout Description
19642 \begin_inset Flex Code
19643 status collapsed
19644
19645 \begin_layout Plain Layout
19646 LabelStringAppendix
19647 \end_layout
19648
19649 \end_inset
19650
19651  [
19652 \begin_inset Flex Code
19653 status collapsed
19654
19655 \begin_layout Plain Layout
19656 string
19657 \end_layout
19658
19659 \end_inset
19660
19661 =
19662 \begin_inset Quotes erd
19663 \end_inset
19664
19665
19666 \begin_inset Quotes erd
19667 \end_inset
19668
19669 ] Same as
19670 \begin_inset Flex Code
19671 status collapsed
19672
19673 \begin_layout Plain Layout
19674 LabelString
19675 \end_layout
19676
19677 \end_inset
19678
19679 , but for use in the Appendix.
19680 \end_layout
19681
19682 \begin_layout Description
19683 \begin_inset Flex Code
19684 status collapsed
19685
19686 \begin_layout Plain Layout
19687 PrettyFormat
19688 \end_layout
19689
19690 \end_inset
19691
19692  [
19693 \begin_inset Flex Code
19694 status collapsed
19695
19696 \begin_layout Plain Layout
19697 string
19698 \end_layout
19699
19700 \end_inset
19701
19702 =
19703 \begin_inset Quotes erd
19704 \end_inset
19705
19706
19707 \begin_inset Quotes erd
19708 \end_inset
19709
19710 ] A format for use with formatted references to this counter.
19711  For example, one might want to have references to section numbers appear
19712  as
19713 \begin_inset Quotes eld
19714 \end_inset
19715
19716 Section 2.4
19717 \begin_inset Quotes erd
19718 \end_inset
19719
19720 .
19721  The string should contain
19722 \begin_inset Quotes eld
19723 \end_inset
19724
19725 ##
19726 \begin_inset Quotes erd
19727 \end_inset
19728
19729 .
19730  This will be replaced by the counter number itself.
19731  So, for sections, it would be: Section ##.
19732 \end_layout
19733
19734 \begin_layout Description
19735 \begin_inset Flex Code
19736 status collapsed
19737
19738 \begin_layout Plain Layout
19739 Within
19740 \end_layout
19741
19742 \end_inset
19743
19744  [
19745 \begin_inset Flex Code
19746 status collapsed
19747
19748 \begin_layout Plain Layout
19749 string
19750 \end_layout
19751
19752 \end_inset
19753
19754 =
19755 \begin_inset Quotes erd
19756 \end_inset
19757
19758
19759 \begin_inset Quotes erd
19760 \end_inset
19761
19762 ] If this is set to the name of another counter, the present counter will
19763  be reset every time the other one is increased.
19764  For example,
19765 \begin_inset Flex Code
19766 status collapsed
19767
19768 \begin_layout Plain Layout
19769 subsection
19770 \end_layout
19771
19772 \end_inset
19773
19774  is numbered inside
19775 \begin_inset Flex Code
19776 status collapsed
19777
19778 \begin_layout Plain Layout
19779 section
19780 \end_layout
19781
19782 \end_inset
19783
19784 .
19785 \end_layout
19786
19787 \begin_layout Subsection
19788 Font description
19789 \begin_inset CommandInset label
19790 LatexCommand label
19791 name "subsec:Font-description"
19792
19793 \end_inset
19794
19795
19796 \end_layout
19797
19798 \begin_layout Standard
19799 A font description looks like this:
19800 \end_layout
19801
19802 \begin_layout LyX-Code
19803 Font
19804 \family roman
19805 \emph on
19806 or
19807 \family default
19808 \emph default
19809  LabelFont
19810 \emph on
19811  or
19812 \emph default
19813  DefaultFont
19814 \end_layout
19815
19816 \begin_layout LyX-Code
19817  ...
19818 \end_layout
19819
19820 \begin_layout LyX-Code
19821 EndFont
19822 \end_layout
19823
19824 \begin_layout Standard
19825 The following commands are available:
19826 \end_layout
19827
19828 \begin_layout Description
19829 \begin_inset Flex Code
19830 status collapsed
19831
19832 \begin_layout Plain Layout
19833 Color
19834 \end_layout
19835
19836 \end_inset
19837
19838  [
19839 \begin_inset Flex Code
19840 status collapsed
19841
19842 \begin_layout Plain Layout
19843
19844 \emph on
19845 none
19846 \end_layout
19847
19848 \end_inset
19849
19850 ,
19851 \begin_inset Flex Code
19852 status collapsed
19853
19854 \begin_layout Plain Layout
19855 black
19856 \end_layout
19857
19858 \end_inset
19859
19860 ,
19861 \begin_inset Flex Code
19862 status collapsed
19863
19864 \begin_layout Plain Layout
19865 white
19866 \end_layout
19867
19868 \end_inset
19869
19870 ,
19871 \begin_inset Flex Code
19872 status collapsed
19873
19874 \begin_layout Plain Layout
19875 red
19876 \end_layout
19877
19878 \end_inset
19879
19880 ,
19881 \begin_inset Flex Code
19882 status collapsed
19883
19884 \begin_layout Plain Layout
19885 green
19886 \end_layout
19887
19888 \end_inset
19889
19890 ,
19891 \begin_inset Flex Code
19892 status collapsed
19893
19894 \begin_layout Plain Layout
19895 blue
19896 \end_layout
19897
19898 \end_inset
19899
19900 ,
19901 \begin_inset Flex Code
19902 status collapsed
19903
19904 \begin_layout Plain Layout
19905 cyan
19906 \end_layout
19907
19908 \end_inset
19909
19910 ,
19911 \begin_inset Flex Code
19912 status collapsed
19913
19914 \begin_layout Plain Layout
19915 magenta
19916 \end_layout
19917
19918 \end_inset
19919
19920 ,
19921 \begin_inset Flex Code
19922 status collapsed
19923
19924 \begin_layout Plain Layout
19925 yellow
19926 \end_layout
19927
19928 \end_inset
19929
19930 ]
19931 \end_layout
19932
19933 \begin_layout Description
19934 \begin_inset Flex Code
19935 status collapsed
19936
19937 \begin_layout Plain Layout
19938 Family
19939 \end_layout
19940
19941 \end_inset
19942
19943  [
19944 \begin_inset Flex Code
19945 status collapsed
19946
19947 \begin_layout Plain Layout
19948
19949 \emph on
19950 Roman
19951 \end_layout
19952
19953 \end_inset
19954
19955 ,
19956 \begin_inset Flex Code
19957 status collapsed
19958
19959 \begin_layout Plain Layout
19960 Sans
19961 \end_layout
19962
19963 \end_inset
19964
19965 ,
19966 \begin_inset Flex Code
19967 status collapsed
19968
19969 \begin_layout Plain Layout
19970 Typewriter
19971 \end_layout
19972
19973 \end_inset
19974
19975 ]
19976 \end_layout
19977
19978 \begin_layout Description
19979 \begin_inset Flex Code
19980 status collapsed
19981
19982 \begin_layout Plain Layout
19983 Misc
19984 \end_layout
19985
19986 \end_inset
19987
19988  [
19989 \begin_inset Flex Code
19990 status collapsed
19991
19992 \begin_layout Plain Layout
19993 string
19994 \end_layout
19995
19996 \end_inset
19997
19998 ] Valid arguments are:
19999 \begin_inset Flex Code
20000 status collapsed
20001
20002 \begin_layout Plain Layout
20003 emph
20004 \end_layout
20005
20006 \end_inset
20007
20008 ,
20009 \begin_inset Flex Code
20010 status collapsed
20011
20012 \begin_layout Plain Layout
20013 noun
20014 \end_layout
20015
20016 \end_inset
20017
20018 ,
20019 \begin_inset Flex Code
20020 status collapsed
20021
20022 \begin_layout Plain Layout
20023 strikeout
20024 \end_layout
20025
20026 \end_inset
20027
20028 ,
20029 \begin_inset Flex Code
20030 status collapsed
20031
20032 \begin_layout Plain Layout
20033 underbar
20034 \end_layout
20035
20036 \end_inset
20037
20038 ,
20039 \begin_inset Flex Code
20040 status collapsed
20041
20042 \begin_layout Plain Layout
20043 uuline
20044 \end_layout
20045
20046 \end_inset
20047
20048 ,
20049 \begin_inset Flex Code
20050 status collapsed
20051
20052 \begin_layout Plain Layout
20053 uwave
20054 \end_layout
20055
20056 \end_inset
20057
20058 ,
20059 \begin_inset Flex Code
20060 status collapsed
20061
20062 \begin_layout Plain Layout
20063 no_emph
20064 \end_layout
20065
20066 \end_inset
20067
20068 ,
20069 \begin_inset Flex Code
20070 status collapsed
20071
20072 \begin_layout Plain Layout
20073 no_noun
20074 \end_layout
20075
20076 \end_inset
20077
20078 ,
20079 \begin_inset Flex Code
20080 status collapsed
20081
20082 \begin_layout Plain Layout
20083 no_strikeout
20084 \end_layout
20085
20086 \end_inset
20087
20088 ,
20089 \begin_inset Flex Code
20090 status collapsed
20091
20092 \begin_layout Plain Layout
20093 no_bar
20094 \end_layout
20095
20096 \end_inset
20097
20098 ,
20099 \begin_inset Flex Code
20100 status collapsed
20101
20102 \begin_layout Plain Layout
20103 no_uuline
20104 \end_layout
20105
20106 \end_inset
20107
20108  and
20109 \begin_inset Flex Code
20110 status collapsed
20111
20112 \begin_layout Plain Layout
20113 no_uwave
20114 \end_layout
20115
20116 \end_inset
20117
20118 .
20119  Each of these turns on or off the corresponding attribute.
20120  For example,
20121 \begin_inset Flex Code
20122 status collapsed
20123
20124 \begin_layout Plain Layout
20125 emph
20126 \end_layout
20127
20128 \end_inset
20129
20130  turns on emphasis, and
20131 \begin_inset Flex Code
20132 status collapsed
20133
20134 \begin_layout Plain Layout
20135 no_emph
20136 \end_layout
20137
20138 \end_inset
20139
20140  turns it off.
20141
20142 \begin_inset Newline newline
20143 \end_inset
20144
20145 If the latter seems puzzling, remember that the font settings for the present
20146  context are generally inherited from the surrounding context.
20147  So
20148 \begin_inset Flex Code
20149 status collapsed
20150
20151 \begin_layout Plain Layout
20152 no_emph
20153 \end_layout
20154
20155 \end_inset
20156
20157  would turn off the emphasis that was anyway in effect, say, in a theorem
20158  environment.
20159 \end_layout
20160
20161 \begin_layout Description
20162 \begin_inset Flex Code
20163 status collapsed
20164
20165 \begin_layout Plain Layout
20166 Series
20167 \end_layout
20168
20169 \end_inset
20170
20171  [
20172 \begin_inset Flex Code
20173 status collapsed
20174
20175 \begin_layout Plain Layout
20176
20177 \emph on
20178 Medium
20179 \end_layout
20180
20181 \end_inset
20182
20183 ,
20184 \begin_inset Flex Code
20185 status collapsed
20186
20187 \begin_layout Plain Layout
20188 Bold
20189 \end_layout
20190
20191 \end_inset
20192
20193 ]
20194 \end_layout
20195
20196 \begin_layout Description
20197 \begin_inset Flex Code
20198 status collapsed
20199
20200 \begin_layout Plain Layout
20201 Shape
20202 \end_layout
20203
20204 \end_inset
20205
20206  [
20207 \begin_inset Flex Code
20208 status collapsed
20209
20210 \begin_layout Plain Layout
20211
20212 \emph on
20213 Up
20214 \end_layout
20215
20216 \end_inset
20217
20218 ,
20219 \begin_inset Flex Code
20220 status collapsed
20221
20222 \begin_layout Plain Layout
20223 Italic
20224 \end_layout
20225
20226 \end_inset
20227
20228 ,
20229 \begin_inset Flex Code
20230 status collapsed
20231
20232 \begin_layout Plain Layout
20233 SmallCaps
20234 \end_layout
20235
20236 \end_inset
20237
20238 ,
20239 \begin_inset Flex Code
20240 status collapsed
20241
20242 \begin_layout Plain Layout
20243 Slanted
20244 \end_layout
20245
20246 \end_inset
20247
20248 ]
20249 \end_layout
20250
20251 \begin_layout Description
20252 \begin_inset Flex Code
20253 status collapsed
20254
20255 \begin_layout Plain Layout
20256 Size
20257 \end_layout
20258
20259 \end_inset
20260
20261  [
20262 \begin_inset Flex Code
20263 status collapsed
20264
20265 \begin_layout Plain Layout
20266 tiny
20267 \end_layout
20268
20269 \end_inset
20270
20271 ,
20272 \begin_inset Flex Code
20273 status collapsed
20274
20275 \begin_layout Plain Layout
20276 small
20277 \end_layout
20278
20279 \end_inset
20280
20281 ,
20282 \begin_inset Flex Code
20283 status collapsed
20284
20285 \begin_layout Plain Layout
20286
20287 \emph on
20288 normal
20289 \end_layout
20290
20291 \end_inset
20292
20293 ,
20294 \begin_inset Flex Code
20295 status collapsed
20296
20297 \begin_layout Plain Layout
20298 large
20299 \end_layout
20300
20301 \end_inset
20302
20303 ,
20304 \begin_inset Flex Code
20305 status collapsed
20306
20307 \begin_layout Plain Layout
20308 larger
20309 \end_layout
20310
20311 \end_inset
20312
20313 ,
20314 \begin_inset Flex Code
20315 status collapsed
20316
20317 \begin_layout Plain Layout
20318 largest
20319 \end_layout
20320
20321 \end_inset
20322
20323 ,
20324 \begin_inset Flex Code
20325 status collapsed
20326
20327 \begin_layout Plain Layout
20328 huge
20329 \end_layout
20330
20331 \end_inset
20332
20333 ,
20334 \begin_inset Flex Code
20335 status collapsed
20336
20337 \begin_layout Plain Layout
20338 giant
20339 \end_layout
20340
20341 \end_inset
20342
20343 ]
20344 \end_layout
20345
20346 \begin_layout Subsection
20347 \begin_inset CommandInset label
20348 LatexCommand label
20349 name "subsec:Citation-format-description"
20350
20351 \end_inset
20352
20353 Citation format description
20354 \end_layout
20355
20356 \begin_layout Standard
20357 The
20358 \begin_inset Flex Code
20359 status collapsed
20360
20361 \begin_layout Plain Layout
20362 CiteFormat
20363 \end_layout
20364
20365 \end_inset
20366
20367  blocks are used to describe how bibliographic information should be displayed,
20368  both within \SpecialChar LyX
20369  itself (in the citation dialog and in tooltips, for example)
20370  and in XHTML output.
20371  Such a block might look like this:
20372 \end_layout
20373
20374 \begin_layout LyX-Code
20375 CiteFormat
20376 \end_layout
20377
20378 \begin_layout LyX-Code
20379  article ...
20380 \end_layout
20381
20382 \begin_layout LyX-Code
20383  book ...
20384 \end_layout
20385
20386 \begin_layout LyX-Code
20387 End
20388 \end_layout
20389
20390 \begin_layout Standard
20391 The individual lines define how the bibliographic information associated
20392  with an article or book, respectively, is to be displayed, and such a definitio
20393 n can be given for any `entry type' that might be present in a Bib\SpecialChar TeX
20394  file.
20395  \SpecialChar LyX
20396  defines a default format in the source code that will be used if no specific
20397  definition has been given.
20398  \SpecialChar LyX
20399  predefines several formats in the file
20400 \begin_inset Flex Code
20401 status collapsed
20402
20403 \begin_layout Plain Layout
20404 stdciteformats.inc
20405 \end_layout
20406
20407 \end_inset
20408
20409 , which is included in most of \SpecialChar LyX
20410 's document classes.
20411 \end_layout
20412
20413 \begin_layout Standard
20414 The definitions use a simple language that allows Bib\SpecialChar TeX
20415  keys to be replaced
20416  with their values.
20417  Keys should be enclosed in
20418 \begin_inset Flex Code
20419 status collapsed
20420
20421 \begin_layout Plain Layout
20422 %
20423 \end_layout
20424
20425 \end_inset
20426
20427  signs, e.g.:
20428 \begin_inset Flex Code
20429 status collapsed
20430
20431 \begin_layout Plain Layout
20432 %author%
20433 \end_layout
20434
20435 \end_inset
20436
20437 .
20438  So a simple definition might look like this:
20439 \end_layout
20440
20441 \begin_layout LyX-Code
20442 misc %author%,
20443 \begin_inset Quotes eld
20444 \end_inset
20445
20446 %title
20447 \begin_inset Quotes erd
20448 \end_inset
20449
20450 .
20451 \end_layout
20452
20453 \begin_layout Standard
20454 This would print the author, followed by a comma, followed by the title,
20455  in quotes, followed by a period.
20456 \end_layout
20457
20458 \begin_layout Standard
20459 Of course, sometimes you may want to print a key only if it exists.
20460  This can be done by using a conditional construction, such as:
20461 \begin_inset Flex Code
20462 status collapsed
20463
20464 \begin_layout Plain Layout
20465 {%volume%[[vol.
20466 \begin_inset space ~
20467 \end_inset
20468
20469 %volume%]]}
20470 \end_layout
20471
20472 \end_inset
20473
20474 .
20475  This says: If the
20476 \begin_inset Flex Code
20477 status collapsed
20478
20479 \begin_layout Plain Layout
20480 volume
20481 \end_layout
20482
20483 \end_inset
20484
20485  key exists, then print
20486 \begin_inset Quotes eld
20487 \end_inset
20488
20489 vol.
20490 \begin_inset space ~
20491 \end_inset
20492
20493
20494 \begin_inset Quotes erd
20495 \end_inset
20496
20497  followed by the volume key.
20498  It is also possible to have an else clause in the conditional, such as:
20499 \begin_inset Newline newline
20500 \end_inset
20501
20502
20503 \begin_inset Flex Code
20504 status collapsed
20505
20506 \begin_layout Plain Layout
20507 {%author%[[%author%]][[%editor%, ed.]]}
20508 \end_layout
20509
20510 \end_inset
20511
20512 .
20513 \begin_inset Newline newline
20514 \end_inset
20515
20516 Here, the
20517 \begin_inset Flex Code
20518 status collapsed
20519
20520 \begin_layout Plain Layout
20521 author
20522 \end_layout
20523
20524 \end_inset
20525
20526  key is printed if it exists; otherwise, the editor key is printed, followed
20527  by
20528 \begin_inset Quotes eld
20529 \end_inset
20530
20531 ,
20532 \begin_inset space ~
20533 \end_inset
20534
20535 ed.
20536 \begin_inset Quotes erd
20537 \end_inset
20538
20539  Note that the key is again enclosed in
20540 \begin_inset Flex Code
20541 status collapsed
20542
20543 \begin_layout Plain Layout
20544 %
20545 \end_layout
20546
20547 \end_inset
20548
20549  signs; the entire conditional is enclosed in braces; and the if and else
20550  clauses are enclosed in double brackets,
20551 \begin_inset Quotes eld
20552 \end_inset
20553
20554
20555 \begin_inset Flex Code
20556 status collapsed
20557
20558 \begin_layout Plain Layout
20559 [[
20560 \end_layout
20561
20562 \end_inset
20563
20564
20565 \begin_inset Quotes eld
20566 \end_inset
20567
20568  and
20569 \begin_inset Quotes eld
20570 \end_inset
20571
20572
20573 \begin_inset Flex Code
20574 status collapsed
20575
20576 \begin_layout Plain Layout
20577 ]]
20578 \end_layout
20579
20580 \end_inset
20581
20582
20583 \begin_inset Quotes erd
20584 \end_inset
20585
20586 .
20587  There must be no space between any of these.
20588 \end_layout
20589
20590 \begin_layout Standard
20591 There is one other piece of syntax available in definitions, which looks
20592  like this:
20593 \begin_inset Flex Code
20594 status collapsed
20595
20596 \begin_layout Plain Layout
20597 {!<i>!}
20598 \end_layout
20599
20600 \end_inset
20601
20602 .
20603  This defines a piece of formatting information that is to be used when
20604  creating
20605 \begin_inset Quotes eld
20606 \end_inset
20607
20608 rich text
20609 \begin_inset Quotes erd
20610 \end_inset
20611
20612 .
20613  Obviously, we do not want to output HTML tags when writing plain text,
20614  so they should be wrapped in
20615 \begin_inset Quotes eld
20616 \end_inset
20617
20618 {!
20619 \begin_inset Quotes erd
20620 \end_inset
20621
20622  and
20623 \begin_inset Quotes eld
20624 \end_inset
20625
20626 !}
20627 \begin_inset Quotes erd
20628 \end_inset
20629
20630 .
20631 \end_layout
20632
20633 \begin_layout Standard
20634 Two special sorts of definitions are also possible in a
20635 \begin_inset Flex Code
20636 status collapsed
20637
20638 \begin_layout Plain Layout
20639 CiteFormat
20640 \end_layout
20641
20642 \end_inset
20643
20644  block.
20645  An example of the first would be:
20646 \end_layout
20647
20648 \begin_layout LyX-Code
20649 !quotetitle
20650 \begin_inset Quotes eld
20651 \end_inset
20652
20653 %title%
20654 \begin_inset Quotes erd
20655 \end_inset
20656
20657
20658 \end_layout
20659
20660 \begin_layout Standard
20661 This is an abbreviation, or macro, and it can be used by treating it as
20662  if it were a key:
20663 \begin_inset Flex Code
20664 status collapsed
20665
20666 \begin_layout Plain Layout
20667 %!quotetitle%
20668 \end_layout
20669
20670 \end_inset
20671
20672 .
20673  \SpecialChar LyX
20674  will treat
20675 \begin_inset Flex Code
20676 status collapsed
20677
20678 \begin_layout Plain Layout
20679 %!quotetitle%
20680 \end_layout
20681
20682 \end_inset
20683
20684  exactly as it would treat its definition.
20685  So, let us issue the obvious
20686 \emph on
20687 warning
20688 \emph default
20689 .
20690  Do not do this:
20691 \end_layout
20692
20693 \begin_layout LyX-Code
20694 !funfun %funfun%
20695 \end_layout
20696
20697 \begin_layout Standard
20698 or anything like it.
20699  \SpecialChar LyX
20700  shouldn't go into an infinite loop, but it may go into a long one before
20701  it gives up.
20702 \end_layout
20703
20704 \begin_layout Standard
20705 The second sort of special definition might look like this:
20706 \end_layout
20707
20708 \begin_layout LyX-Code
20709 _pptext pp.
20710 \end_layout
20711
20712 \begin_layout Standard
20713 This defines a translatable piece of text, which allows relevant parts of
20714  the bibliography to be translated.
20715  It can be included in a definition by treating it as a key:
20716 \begin_inset Flex Code
20717 status collapsed
20718
20719 \begin_layout Plain Layout
20720 %_pptext%
20721 \end_layout
20722
20723 \end_inset
20724
20725 .
20726  Several of these are predefined in
20727 \begin_inset Flex Code
20728 status collapsed
20729
20730 \begin_layout Plain Layout
20731 stdciteformats.inc
20732 \end_layout
20733
20734 \end_inset
20735
20736 .
20737  Note that these are not macros, in the sense just defined.
20738  They will not be expanded.
20739 \end_layout
20740
20741 \begin_layout Standard
20742 So here then is an example that use all these features:
20743 \begin_inset VSpace defskip
20744 \end_inset
20745
20746
20747 \end_layout
20748
20749 \begin_layout Standard
20750 \noindent
20751
20752 \family typewriter
20753 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
20754 \end_layout
20755
20756 \begin_layout Standard
20757 \begin_inset VSpace defskip
20758 \end_inset
20759
20760 This defines a macro that prints the author, followed by a comma, if the
20761
20762 \begin_inset Flex Code
20763 status collapsed
20764
20765 \begin_layout Plain Layout
20766 author
20767 \end_layout
20768
20769 \end_inset
20770
20771  key is defined, or else prints the name of the editor, followed by the
20772
20773 \begin_inset Flex Code
20774 status collapsed
20775
20776 \begin_layout Plain Layout
20777 _edtext
20778 \end_layout
20779
20780 \end_inset
20781
20782  or its translation (it is by default
20783 \begin_inset Quotes eld
20784 \end_inset
20785
20786 ed.
20787 \begin_inset Quotes erd
20788 \end_inset
20789
20790 ), if the
20791 \begin_inset Flex Code
20792 status collapsed
20793
20794 \begin_layout Plain Layout
20795 editor
20796 \end_layout
20797
20798 \end_inset
20799
20800  key is defined.
20801  Note that this is in fact defined in
20802 \begin_inset Flex Code
20803 status collapsed
20804
20805 \begin_layout Plain Layout
20806 stdciteformats.inc
20807 \end_layout
20808
20809 \end_inset
20810
20811 , so you can use it in your own definitions, or re-definitions, if you load
20812  that file first.
20813 \end_layout
20814
20815 \begin_layout Section
20816 \begin_inset CommandInset label
20817 LatexCommand label
20818 name "sec:Tags-for-XHTML"
20819
20820 \end_inset
20821
20822 Tags for XHTML output
20823 \end_layout
20824
20825 \begin_layout Standard
20826 As with \SpecialChar LaTeX
20827  or DocBook, the format of \SpecialChar LyX
20828 's XHTML output is also controlled by
20829  layout information.
20830  In general, \SpecialChar LyX
20831  provides sensible defaults and, as mentioned earlier, it will
20832  even construct default CSS style rules from the other layout tags.
20833  For example, \SpecialChar LyX
20834  will attempt to use the information provided in the
20835 \begin_inset Flex Code
20836 status collapsed
20837
20838 \begin_layout Plain Layout
20839 Font
20840 \end_layout
20841
20842 \end_inset
20843
20844  declaration for the Chapter style to write CSS that will appropriately
20845  format chapter headings.
20846 \end_layout
20847
20848 \begin_layout Standard
20849 In many cases, then, you may not have to do anything at all to get acceptable
20850  XHTML output for your own environments, custom insets, and so forth.
20851  But in some cases you will, and so \SpecialChar LyX
20852  provides a number of layout tags that
20853  can be used to customize the XHTML and CSS that are generated.
20854 \end_layout
20855
20856 \begin_layout Standard
20857 Note that there are two tags,
20858 \begin_inset Flex Code
20859 status collapsed
20860
20861 \begin_layout Plain Layout
20862 HTMLPreamble
20863 \end_layout
20864
20865 \end_inset
20866
20867  and
20868 \begin_inset Flex Code
20869 status collapsed
20870
20871 \begin_layout Plain Layout
20872 AddToHTMLPreamble
20873 \end_layout
20874
20875 \end_inset
20876
20877  that may appear outside style and inset declarations.
20878  See
20879 \begin_inset CommandInset ref
20880 LatexCommand ref
20881 reference "subsec:General-text-class"
20882
20883 \end_inset
20884
20885  for details on these.
20886 \end_layout
20887
20888 \begin_layout Subsection
20889 \begin_inset CommandInset label
20890 LatexCommand label
20891 name "subsec:Paragraph-Style-XHTML"
20892
20893 \end_inset
20894
20895 Paragraph styles
20896 \end_layout
20897
20898 \begin_layout Standard
20899 The sort of XHTML \SpecialChar LyX
20900  outputs for a paragraph depends upon whether we are dealing
20901  with a normal paragraph, a command, or an environment, where this is itself
20902  determined by the contents of the corresponding
20903 \begin_inset Flex Code
20904 status collapsed
20905
20906 \begin_layout Plain Layout
20907 \SpecialChar LaTeX
20908 Type
20909 \end_layout
20910
20911 \end_inset
20912
20913  tag.
20914
20915 \end_layout
20916
20917 \begin_layout Standard
20918 For a command or normal paragraph, the output XHTML has the following form:
20919 \end_layout
20920
20921 \begin_layout LyX-Code
20922 <tag attr=
20923 \begin_inset Quotes erd
20924 \end_inset
20925
20926 value
20927 \begin_inset Quotes erd
20928 \end_inset
20929
20930 >
20931 \end_layout
20932
20933 \begin_layout LyX-Code
20934 <labeltag attr=
20935 \begin_inset Quotes erd
20936 \end_inset
20937
20938 value
20939 \begin_inset Quotes erd
20940 \end_inset
20941
20942 >Label</labeltag>
20943 \end_layout
20944
20945 \begin_layout LyX-Code
20946 Contents of the paragraph.
20947 \end_layout
20948
20949 \begin_layout LyX-Code
20950 </tag>
20951 \end_layout
20952
20953 \begin_layout Standard
20954 The label tags are of course omitted if the paragraph does not have a label.
20955 \end_layout
20956
20957 \begin_layout Standard
20958 For an environment that is not some sort of list, the XHTML takes this form:
20959 \end_layout
20960
20961 \begin_layout LyX-Code
20962 <tag attr=
20963 \begin_inset Quotes erd
20964 \end_inset
20965
20966 value
20967 \begin_inset Quotes erd
20968 \end_inset
20969
20970 >
20971 \end_layout
20972
20973 \begin_layout LyX-Code
20974 <itemtag attr=
20975 \begin_inset Quotes erd
20976 \end_inset
20977
20978 value
20979 \begin_inset Quotes erd
20980 \end_inset
20981
20982 ><labeltag attr=
20983 \begin_inset Quotes erd
20984 \end_inset
20985
20986 value
20987 \begin_inset Quotes erd
20988 \end_inset
20989
20990 >Environment Label</labeltag>First paragraph.</itemtag>
20991 \end_layout
20992
20993 \begin_layout LyX-Code
20994 <itemtag>Second paragraph.</itemtag>
20995 \end_layout
20996
20997 \begin_layout LyX-Code
20998 </tag>
20999 \end_layout
21000
21001 \begin_layout Standard
21002 Note that the label is output only for the first paragraph, as it should
21003  be for a theorem, for example.
21004
21005 \end_layout
21006
21007 \begin_layout Standard
21008 For a list, we have one of these forms:
21009 \end_layout
21010
21011 \begin_layout LyX-Code
21012 <tag attr=
21013 \begin_inset Quotes erd
21014 \end_inset
21015
21016 value
21017 \begin_inset Quotes erd
21018 \end_inset
21019
21020 >
21021 \end_layout
21022
21023 \begin_layout LyX-Code
21024 <itemtag attr=
21025 \begin_inset Quotes erd
21026 \end_inset
21027
21028 value
21029 \begin_inset Quotes erd
21030 \end_inset
21031
21032 ><labeltag attr=
21033 \begin_inset Quotes erd
21034 \end_inset
21035
21036 value
21037 \begin_inset Quotes erd
21038 \end_inset
21039
21040 >List Label</labeltag>First item.</itemtag>
21041 \end_layout
21042
21043 \begin_layout LyX-Code
21044 <itemtag attr=
21045 \begin_inset Quotes erd
21046 \end_inset
21047
21048 value
21049 \begin_inset Quotes erd
21050 \end_inset
21051
21052 ><labeltag attr=
21053 \begin_inset Quotes erd
21054 \end_inset
21055
21056 value
21057 \begin_inset Quotes erd
21058 \end_inset
21059
21060 >List Label</labeltag>Second item.</itemtag>
21061 \end_layout
21062
21063 \begin_layout LyX-Code
21064 </tag>
21065 \end_layout
21066
21067 \begin_layout LyX-Code
21068
21069 \end_layout
21070
21071 \begin_layout LyX-Code
21072 <tag attr=
21073 \begin_inset Quotes erd
21074 \end_inset
21075
21076 value
21077 \begin_inset Quotes erd
21078 \end_inset
21079
21080 >
21081 \end_layout
21082
21083 \begin_layout LyX-Code
21084 <labeltag attr=
21085 \begin_inset Quotes erd
21086 \end_inset
21087
21088 value
21089 \begin_inset Quotes erd
21090 \end_inset
21091
21092 >List Label</labeltag><itemtag attr=
21093 \begin_inset Quotes erd
21094 \end_inset
21095
21096 value
21097 \begin_inset Quotes erd
21098 \end_inset
21099
21100 >First item.</itemtag>
21101 \end_layout
21102
21103 \begin_layout LyX-Code
21104 <labeltag attr=
21105 \begin_inset Quotes erd
21106 \end_inset
21107
21108 value
21109 \begin_inset Quotes erd
21110 \end_inset
21111
21112 >List Label</labeltag><itemtag attr=
21113 \begin_inset Quotes erd
21114 \end_inset
21115
21116 value
21117 \begin_inset Quotes erd
21118 \end_inset
21119
21120 >Second item.</itemtag>
21121 \end_layout
21122
21123 \begin_layout LyX-Code
21124 </tag>
21125 \end_layout
21126
21127 \begin_layout Standard
21128 Note the different orders of
21129 \begin_inset Flex Code
21130 status collapsed
21131
21132 \begin_layout Plain Layout
21133 labeltag
21134 \end_layout
21135
21136 \end_inset
21137
21138  and
21139 \begin_inset Flex Code
21140 status collapsed
21141
21142 \begin_layout Plain Layout
21143 itemtag
21144 \end_layout
21145
21146 \end_inset
21147
21148 .
21149  Which order we get depends upon the setting of
21150 \begin_inset Flex Code
21151 status collapsed
21152
21153 \begin_layout Plain Layout
21154 HTMLLabelFirst
21155 \end_layout
21156
21157 \end_inset
21158
21159 : If
21160 \begin_inset Flex Code
21161 status collapsed
21162
21163 \begin_layout Plain Layout
21164 HTMLLabelFirst
21165 \end_layout
21166
21167 \end_inset
21168
21169  is false (the default), you get the first of these, with the label within
21170  the item; if true, you get the second, with the label outside the item.
21171 \end_layout
21172
21173 \begin_layout Standard
21174 The specific tags and attributes output for each paragraph type can be controlle
21175 d by means of the layout tags we are about to describe.
21176  As mentioned earlier, however, \SpecialChar LyX
21177  uses sensible defaults for many of these,
21178  so you often may not need to do very much to get good XHTML output.
21179  Think of the available tags as there so you can tweak things to your liking.
21180 \end_layout
21181
21182 \begin_layout Description
21183 \begin_inset Flex Code
21184 status collapsed
21185
21186 \begin_layout Plain Layout
21187 HTMLAttr
21188 \end_layout
21189
21190 \end_inset
21191
21192  [
21193 \begin_inset Flex Code
21194 status collapsed
21195
21196 \begin_layout Plain Layout
21197 string
21198 \end_layout
21199
21200 \end_inset
21201
21202 ] Specifies attribute information to be output with the main tag.
21203  For example,
21204 \begin_inset Quotes eld
21205 \end_inset
21206
21207
21208 \begin_inset Flex Code
21209 status collapsed
21210
21211 \begin_layout Plain Layout
21212 class=`mydiv'
21213 \end_layout
21214
21215 \end_inset
21216
21217
21218 \begin_inset Quotes erd
21219 \end_inset
21220
21221 .
21222  By default, \SpecialChar LyX
21223  will output
21224 \begin_inset Quotes eld
21225 \end_inset
21226
21227
21228 \begin_inset Flex Code
21229 status collapsed
21230
21231 \begin_layout Plain Layout
21232 class=`layoutname'
21233 \end_layout
21234
21235 \end_inset
21236
21237
21238 \begin_inset Quotes erd
21239 \end_inset
21240
21241 , where
21242 \begin_inset Flex Code
21243 status collapsed
21244
21245 \begin_layout Plain Layout
21246 layoutname
21247 \end_layout
21248
21249 \end_inset
21250
21251  is the \SpecialChar LyX
21252  name of the layout, made lowercase, for example: chapter.
21253  This should
21254 \emph on
21255 not
21256 \emph default
21257  contain any style information.
21258  Use
21259 \begin_inset Flex Code
21260 status collapsed
21261
21262 \begin_layout Plain Layout
21263 HTMLStyle
21264 \end_layout
21265
21266 \end_inset
21267
21268  for that purpose.
21269 \end_layout
21270
21271 \begin_layout Description
21272 \begin_inset Flex Code
21273 status collapsed
21274
21275 \begin_layout Plain Layout
21276 HTMLForceCSS
21277 \end_layout
21278
21279 \end_inset
21280
21281  [
21282 \begin_inset Flex Code
21283 status collapsed
21284
21285 \begin_layout Plain Layout
21286
21287 \emph on
21288 0
21289 \emph default
21290 ,1
21291 \end_layout
21292
21293 \end_inset
21294
21295 ] Whether to output the default CSS information \SpecialChar LyX
21296  generates for this layout,
21297  even if additional information is explicitly provided via
21298 \begin_inset Flex Code
21299 status collapsed
21300
21301 \begin_layout Plain Layout
21302 HTMLStyle
21303 \end_layout
21304
21305 \end_inset
21306
21307 .
21308  Setting this to
21309 \begin_inset Flex Code
21310 status collapsed
21311
21312 \begin_layout Plain Layout
21313 1
21314 \end_layout
21315
21316 \end_inset
21317
21318  allows you to alter or augment the generated CSS, rather than to override
21319  it completely.
21320  Default is
21321 \begin_inset Flex Code
21322 status collapsed
21323
21324 \begin_layout Plain Layout
21325 0
21326 \end_layout
21327
21328 \end_inset
21329
21330 .
21331 \end_layout
21332
21333 \begin_layout Description
21334 \begin_inset Flex Code
21335 status collapsed
21336
21337 \begin_layout Plain Layout
21338 HTMLItem
21339 \end_layout
21340
21341 \end_inset
21342
21343  [
21344 \begin_inset Flex Code
21345 status collapsed
21346
21347 \begin_layout Plain Layout
21348 string
21349 \end_layout
21350
21351 \end_inset
21352
21353 ] The tag to be used for individual paragraphs of environments, replacing
21354
21355 \begin_inset Flex Code
21356 status collapsed
21357
21358 \begin_layout Plain Layout
21359 itemtag
21360 \end_layout
21361
21362 \end_inset
21363
21364  in the examples above.
21365  Defaults to
21366 \begin_inset Flex Code
21367 status collapsed
21368
21369 \begin_layout Plain Layout
21370 div
21371 \end_layout
21372
21373 \end_inset
21374
21375 .
21376 \end_layout
21377
21378 \begin_layout Description
21379 \begin_inset Flex Code
21380 status collapsed
21381
21382 \begin_layout Plain Layout
21383 HTMLItemAttr
21384 \end_layout
21385
21386 \end_inset
21387
21388  [
21389 \begin_inset Flex Code
21390 status collapsed
21391
21392 \begin_layout Plain Layout
21393 string
21394 \end_layout
21395
21396 \end_inset
21397
21398 ] Attributes for the item tag.
21399  Defaults to
21400 \begin_inset Quotes eld
21401 \end_inset
21402
21403
21404 \begin_inset Flex Code
21405 status collapsed
21406
21407 \begin_layout Plain Layout
21408 class=`layoutname_item'
21409 \end_layout
21410
21411 \end_inset
21412
21413
21414 \begin_inset Quotes erd
21415 \end_inset
21416
21417 .
21418  This should
21419 \emph on
21420 not
21421 \emph default
21422  contain any style information.
21423  Use
21424 \begin_inset Flex Code
21425 status collapsed
21426
21427 \begin_layout Plain Layout
21428 HTMLStyle
21429 \end_layout
21430
21431 \end_inset
21432
21433  for that purpose.
21434 \end_layout
21435
21436 \begin_layout Description
21437 \begin_inset Flex Code
21438 status collapsed
21439
21440 \begin_layout Plain Layout
21441 HTMLLabel
21442 \end_layout
21443
21444 \end_inset
21445
21446  [
21447 \begin_inset Flex Code
21448 status collapsed
21449
21450 \begin_layout Plain Layout
21451 string
21452 \end_layout
21453
21454 \end_inset
21455
21456 ] The tag to be used for paragraph and item labels, replacing
21457 \begin_inset Flex Code
21458 status collapsed
21459
21460 \begin_layout Plain Layout
21461 labeltag
21462 \end_layout
21463
21464 \end_inset
21465
21466  in the examples above.
21467  Defaults to
21468 \begin_inset Flex Code
21469 status collapsed
21470
21471 \begin_layout Plain Layout
21472 span
21473 \end_layout
21474
21475 \end_inset
21476
21477 , unless
21478 \begin_inset Flex Code
21479 status collapsed
21480
21481 \begin_layout Plain Layout
21482 LabelType
21483 \end_layout
21484
21485 \end_inset
21486
21487  is either
21488 \begin_inset Flex Code
21489 status collapsed
21490
21491 \begin_layout Plain Layout
21492 Top_Environment
21493 \end_layout
21494
21495 \end_inset
21496
21497  or
21498 \begin_inset Flex Code
21499 status collapsed
21500
21501 \begin_layout Plain Layout
21502 Centered_Top_Environment
21503 \end_layout
21504
21505 \end_inset
21506
21507 , in which case it defaults to
21508 \begin_inset Flex Code
21509 status collapsed
21510
21511 \begin_layout Plain Layout
21512 div
21513 \end_layout
21514
21515 \end_inset
21516
21517 .
21518 \end_layout
21519
21520 \begin_layout Description
21521 \begin_inset Flex Code
21522 status collapsed
21523
21524 \begin_layout Plain Layout
21525 HTMLLabelAttr
21526 \end_layout
21527
21528 \end_inset
21529
21530  [
21531 \begin_inset Flex Code
21532 status collapsed
21533
21534 \begin_layout Plain Layout
21535 string
21536 \end_layout
21537
21538 \end_inset
21539
21540 ] Attributes for the label tag.
21541  Defaults to
21542 \begin_inset Quotes eld
21543 \end_inset
21544
21545
21546 \begin_inset Flex Code
21547 status collapsed
21548
21549 \begin_layout Plain Layout
21550 class=`layoutname_label'
21551 \end_layout
21552
21553 \end_inset
21554
21555
21556 \begin_inset Quotes erd
21557 \end_inset
21558
21559 .
21560  This should
21561 \emph on
21562 not
21563 \emph default
21564  contain any style information.
21565  Use
21566 \begin_inset Flex Code
21567 status collapsed
21568
21569 \begin_layout Plain Layout
21570 HTMLStyle
21571 \end_layout
21572
21573 \end_inset
21574
21575  for that purpose.
21576 \end_layout
21577
21578 \begin_layout Description
21579 \begin_inset Flex Code
21580 status collapsed
21581
21582 \begin_layout Plain Layout
21583 HTMLLabelFirst
21584 \end_layout
21585
21586 \end_inset
21587
21588  [
21589 \begin_inset Flex Code
21590 status collapsed
21591
21592 \begin_layout Plain Layout
21593
21594 \emph on
21595 0
21596 \emph default
21597 ,1
21598 \end_layout
21599
21600 \end_inset
21601
21602 ] Meaningful only for list-like environments, this tag controls whether
21603  the label tag is output before or inside the item tag.
21604  This is used, for example, in the description environment, where we want
21605  `
21606 \begin_inset Flex Code
21607 status collapsed
21608
21609 \begin_layout Plain Layout
21610 <dt>\SpecialChar ldots
21611 </dt><dd>\SpecialChar ldots
21612 </dd>
21613 \end_layout
21614
21615 \end_inset
21616
21617 .
21618  Default is
21619 \begin_inset Flex Code
21620 status collapsed
21621
21622 \begin_layout Plain Layout
21623 0
21624 \end_layout
21625
21626 \end_inset
21627
21628 : The label tag is output inside the item tag.
21629 \end_layout
21630
21631 \begin_layout Description
21632 \begin_inset Flex Code
21633 status collapsed
21634
21635 \begin_layout Plain Layout
21636 HTMLPreamble
21637 \end_layout
21638
21639 \end_inset
21640
21641  Information to be output in the
21642 \begin_inset Flex Code
21643 status collapsed
21644
21645 \begin_layout Plain Layout
21646 <head>
21647 \end_layout
21648
21649 \end_inset
21650
21651  section when this style is used.
21652  This might, for example, be used to include a
21653 \begin_inset Flex Code
21654 status collapsed
21655
21656 \begin_layout Plain Layout
21657 <script>
21658 \end_layout
21659
21660 \end_inset
21661
21662  block defining an
21663 \begin_inset Flex Code
21664 status collapsed
21665
21666 \begin_layout Plain Layout
21667 onclick
21668 \end_layout
21669
21670 \end_inset
21671
21672  handler.
21673 \end_layout
21674
21675 \begin_layout Description
21676 \begin_inset Flex Code
21677 status collapsed
21678
21679 \begin_layout Plain Layout
21680 HTMLStyle
21681 \end_layout
21682
21683 \end_inset
21684
21685  CSS style information to be included when this style is used.
21686  Note that this will automatically be wrapped in a layout-generated
21687 \begin_inset Flex Code
21688 status collapsed
21689
21690 \begin_layout Plain Layout
21691 <style>
21692 \end_layout
21693
21694 \end_inset
21695
21696  block, so only the CSS itself need be included.
21697  Must end with
21698 \begin_inset Flex Code
21699 status collapsed
21700
21701 \begin_layout Plain Layout
21702 EndHTMLStyle
21703 \end_layout
21704
21705 \end_inset
21706
21707 .
21708 \end_layout
21709
21710 \begin_layout Description
21711 \begin_inset Flex Code
21712 status collapsed
21713
21714 \begin_layout Plain Layout
21715 HTMLTag
21716 \end_layout
21717
21718 \end_inset
21719
21720  [
21721 \begin_inset Flex Code
21722 status collapsed
21723
21724 \begin_layout Plain Layout
21725 string
21726 \end_layout
21727
21728 \end_inset
21729
21730 ] The tag to be used for the main label, replacing
21731 \begin_inset Flex Code
21732 status collapsed
21733
21734 \begin_layout Plain Layout
21735 tag
21736 \end_layout
21737
21738 \end_inset
21739
21740  in the examples above.
21741  Defaults to
21742 \begin_inset Flex Code
21743 status collapsed
21744
21745 \begin_layout Plain Layout
21746 div
21747 \end_layout
21748
21749 \end_inset
21750
21751 .
21752 \end_layout
21753
21754 \begin_layout Description
21755 \begin_inset Flex Code
21756 status collapsed
21757
21758 \begin_layout Plain Layout
21759 HTMLTitle
21760 \end_layout
21761
21762 \end_inset
21763
21764  [
21765 \begin_inset Flex Code
21766 status collapsed
21767
21768 \begin_layout Plain Layout
21769
21770 \emph on
21771 0
21772 \emph default
21773 ,1
21774 \end_layout
21775
21776 \end_inset
21777
21778 ] Marks this style as the one to be used to generate the
21779 \begin_inset Flex Code
21780 status collapsed
21781
21782 \begin_layout Plain Layout
21783 <title>
21784 \end_layout
21785
21786 \end_inset
21787
21788  tag for the XHTML file.
21789  By default, it is false.
21790  The
21791 \begin_inset Flex Code
21792 status collapsed
21793
21794 \begin_layout Plain Layout
21795 stdtitle.inc
21796 \end_layout
21797
21798 \end_inset
21799
21800  file sets it to true for the
21801 \begin_inset Flex Code
21802 status collapsed
21803
21804 \begin_layout Plain Layout
21805 title
21806 \end_layout
21807
21808 \end_inset
21809
21810  environment.
21811
21812 \end_layout
21813
21814 \begin_layout Subsection
21815 InsetLayout XHTML
21816 \end_layout
21817
21818 \begin_layout Standard
21819 The XHTML output of insets can also be controlled by information in layout
21820  files.
21821 \begin_inset Foot
21822 status collapsed
21823
21824 \begin_layout Plain Layout
21825 At present, this is true only for
21826 \begin_inset Quotes eld
21827 \end_inset
21828
21829 text
21830 \begin_inset Quotes erd
21831 \end_inset
21832
21833  insets (insets you can type into) and is not true for
21834 \begin_inset Quotes eld
21835 \end_inset
21836
21837 command
21838 \begin_inset Quotes erd
21839 \end_inset
21840
21841  insets (insets that are associated with dialog boxes).
21842 \end_layout
21843
21844 \end_inset
21845
21846  Here, too, \SpecialChar LyX
21847  tries to provide sensible defaults, and it constructs default
21848  CSS style rules.
21849  But everything can be customized.
21850 \end_layout
21851
21852 \begin_layout Standard
21853 The XHTML \SpecialChar LyX
21854  outputs for an inset has the following form:
21855 \end_layout
21856
21857 \begin_layout LyX-Code
21858 <tag attr=
21859 \begin_inset Quotes erd
21860 \end_inset
21861
21862 value
21863 \begin_inset Quotes erd
21864 \end_inset
21865
21866 >
21867 \end_layout
21868
21869 \begin_layout LyX-Code
21870 <labeltag>Label</labeltag>
21871 \end_layout
21872
21873 \begin_layout LyX-Code
21874 <innertag attr=
21875 \begin_inset Quotes erd
21876 \end_inset
21877
21878 value
21879 \begin_inset Quotes erd
21880 \end_inset
21881
21882 >Contents of the inset.</innertag>
21883 \end_layout
21884
21885 \begin_layout LyX-Code
21886 </tag>
21887 \end_layout
21888
21889 \begin_layout Standard
21890 If the inset permits multiple paragraphs—that is, if
21891 \begin_inset Flex Code
21892 status collapsed
21893
21894 \begin_layout Plain Layout
21895 MultiPar
21896 \end_layout
21897
21898 \end_inset
21899
21900  is true—then the contents of the inset will itself be output as paragraphs
21901  formatted according to the styles used for those paragraphs (standard,
21902  quote, and the like).
21903  The label tag is of course omitted if the paragraph does not have a label
21904  and, at present, is always
21905 \begin_inset Flex Code
21906 status collapsed
21907
21908 \begin_layout Plain Layout
21909 span
21910 \end_layout
21911
21912 \end_inset
21913
21914 .
21915  The inner tag is optional and, by default, does not appear.
21916 \end_layout
21917
21918 \begin_layout Standard
21919 The specific tags and attributes output for each inset can be controlled
21920  by means of the following layout tags.
21921 \end_layout
21922
21923 \begin_layout Description
21924 \begin_inset Flex Code
21925 status collapsed
21926
21927 \begin_layout Plain Layout
21928 HTMLAttr
21929 \end_layout
21930
21931 \end_inset
21932
21933  [
21934 \begin_inset Flex Code
21935 status collapsed
21936
21937 \begin_layout Plain Layout
21938 string
21939 \end_layout
21940
21941 \end_inset
21942
21943 ] Specifies attribute information to be output with the main tag.
21944  For example,
21945 \begin_inset Quotes eld
21946 \end_inset
21947
21948
21949 \begin_inset Flex Code
21950 status collapsed
21951
21952 \begin_layout Plain Layout
21953 class=`myinset' onclick=`\SpecialChar ldots
21954 '
21955 \end_layout
21956
21957 \end_inset
21958
21959
21960 \begin_inset Quotes erd
21961 \end_inset
21962
21963 .
21964  By default, \SpecialChar LyX
21965  will output
21966 \begin_inset Quotes eld
21967 \end_inset
21968
21969
21970 \begin_inset Flex Code
21971 status collapsed
21972
21973 \begin_layout Plain Layout
21974 class=`insetname'
21975 \end_layout
21976
21977 \end_inset
21978
21979
21980 \begin_inset Quotes erd
21981 \end_inset
21982
21983 , where
21984 \begin_inset Flex Code
21985 status collapsed
21986
21987 \begin_layout Plain Layout
21988 insetname
21989 \end_layout
21990
21991 \end_inset
21992
21993  is the \SpecialChar LyX
21994  name of the inset, made lowercase and with non-alphanumeric characters
21995  converted to underscores, for example: footnote.
21996 \end_layout
21997
21998 \begin_layout Description
21999 \begin_inset Flex Code
22000 status collapsed
22001
22002 \begin_layout Plain Layout
22003 HTMLForceCSS
22004 \end_layout
22005
22006 \end_inset
22007
22008  [
22009 \begin_inset Flex Code
22010 status collapsed
22011
22012 \begin_layout Plain Layout
22013
22014 \emph on
22015 0
22016 \emph default
22017 ,1
22018 \end_layout
22019
22020 \end_inset
22021
22022 ] Whether to output the default CSS information \SpecialChar LyX
22023  generates for this layout,
22024  even if additional information is explicitly provided via
22025 \begin_inset Flex Code
22026 status collapsed
22027
22028 \begin_layout Plain Layout
22029 HTMLStyle
22030 \end_layout
22031
22032 \end_inset
22033
22034 .
22035  Setting this to
22036 \begin_inset Flex Code
22037 status collapsed
22038
22039 \begin_layout Plain Layout
22040 1
22041 \end_layout
22042
22043 \end_inset
22044
22045  allows you to alter or augment the generated CSS, rather than to override
22046  it completely.
22047  Default is 0.
22048 \end_layout
22049
22050 \begin_layout Description
22051 \begin_inset Flex Code
22052 status collapsed
22053
22054 \begin_layout Plain Layout
22055 HTMLInnerAttr
22056 \end_layout
22057
22058 \end_inset
22059
22060  [
22061 \begin_inset Flex Code
22062 status collapsed
22063
22064 \begin_layout Plain Layout
22065 string
22066 \end_layout
22067
22068 \end_inset
22069
22070 ] Attributes for the inner tag.
22071  Defaults to
22072 \begin_inset Quotes eld
22073 \end_inset
22074
22075
22076 \begin_inset Flex Code
22077 status collapsed
22078
22079 \begin_layout Plain Layout
22080 class=`insetname_inner'
22081 \end_layout
22082
22083 \end_inset
22084
22085
22086 \begin_inset Quotes erd
22087 \end_inset
22088
22089 .
22090 \end_layout
22091
22092 \begin_layout Description
22093 \begin_inset Flex Code
22094 status collapsed
22095
22096 \begin_layout Plain Layout
22097 HTMLInnerTag
22098 \end_layout
22099
22100 \end_inset
22101
22102  [
22103 \begin_inset Flex Code
22104 status collapsed
22105
22106 \begin_layout Plain Layout
22107 string
22108 \end_layout
22109
22110 \end_inset
22111
22112 ] The inner tag, replacing
22113 \begin_inset Flex Code
22114 status collapsed
22115
22116 \begin_layout Plain Layout
22117 innertag
22118 \end_layout
22119
22120 \end_inset
22121
22122  in the examples above.
22123  By default, there is none.
22124 \end_layout
22125
22126 \begin_layout Description
22127 \begin_inset Flex Code
22128 status collapsed
22129
22130 \begin_layout Plain Layout
22131 HTMLIsBlock
22132 \end_layout
22133
22134 \end_inset
22135
22136  [
22137 \begin_inset Flex Code
22138 status collapsed
22139
22140 \begin_layout Plain Layout
22141 0,
22142 \emph on
22143 1
22144 \end_layout
22145
22146 \end_inset
22147
22148 ] Whether this inset represents a standalone block of text (such as a footnote)
22149  or instead represents material that is included in the surrounding text
22150  (such as a branch).
22151  Defaults to 1.
22152 \end_layout
22153
22154 \begin_layout Description
22155 \begin_inset Flex Code
22156 status collapsed
22157
22158 \begin_layout Plain Layout
22159 HTMLLabel
22160 \end_layout
22161
22162 \end_inset
22163
22164  [
22165 \begin_inset Flex Code
22166 status collapsed
22167
22168 \begin_layout Plain Layout
22169 string
22170 \end_layout
22171
22172 \end_inset
22173
22174 ] A label for this inset, possibly including a reference to a counter.
22175  For example, for footnote, it might be:
22176 \begin_inset Flex Code
22177 status collapsed
22178
22179 \begin_layout Plain Layout
22180
22181 \backslash
22182 arabic{footnote}
22183 \end_layout
22184
22185 \end_inset
22186
22187 .
22188  This is optional, and there is no default.
22189 \end_layout
22190
22191 \begin_layout Description
22192 \begin_inset Flex Code
22193 status collapsed
22194
22195 \begin_layout Plain Layout
22196 HTMLPreamble
22197 \end_layout
22198
22199 \end_inset
22200
22201  Information to be output in the
22202 \begin_inset Flex Code
22203 status collapsed
22204
22205 \begin_layout Plain Layout
22206 <head>
22207 \end_layout
22208
22209 \end_inset
22210
22211  section when this style is used.
22212  This might, for example, be used to include a
22213 \begin_inset Flex Code
22214 status collapsed
22215
22216 \begin_layout Plain Layout
22217 <script>
22218 \end_layout
22219
22220 \end_inset
22221
22222  block defining an
22223 \begin_inset Flex Code
22224 status collapsed
22225
22226 \begin_layout Plain Layout
22227 onclick
22228 \end_layout
22229
22230 \end_inset
22231
22232  handler.
22233 \end_layout
22234
22235 \begin_layout Description
22236 \begin_inset Flex Code
22237 status collapsed
22238
22239 \begin_layout Plain Layout
22240 HTMLStyle
22241 \end_layout
22242
22243 \end_inset
22244
22245  CSS style information to be included when this style is used.
22246  Note that this will automatically be wrapped in a layout-generated
22247 \begin_inset Flex Code
22248 status collapsed
22249
22250 \begin_layout Plain Layout
22251 <style>
22252 \end_layout
22253
22254 \end_inset
22255
22256  block, so only the CSS itself need be included.
22257 \end_layout
22258
22259 \begin_layout Description
22260 \begin_inset Flex Code
22261 status collapsed
22262
22263 \begin_layout Plain Layout
22264 HTMLTag
22265 \end_layout
22266
22267 \end_inset
22268
22269  [
22270 \begin_inset Flex Code
22271 status collapsed
22272
22273 \begin_layout Plain Layout
22274 string
22275 \end_layout
22276
22277 \end_inset
22278
22279 ] The tag to be used for the main label, replacing
22280 \begin_inset Flex Code
22281 status collapsed
22282
22283 \begin_layout Plain Layout
22284 tag
22285 \end_layout
22286
22287 \end_inset
22288
22289  in the examples above.
22290  The default depends upon the setting of
22291 \begin_inset Flex Code
22292 status collapsed
22293
22294 \begin_layout Plain Layout
22295 MultiPar
22296 \end_layout
22297
22298 \end_inset
22299
22300 : If
22301 \begin_inset Flex Code
22302 status collapsed
22303
22304 \begin_layout Plain Layout
22305 MultiPar
22306 \end_layout
22307
22308 \end_inset
22309
22310  is true, the default is
22311 \begin_inset Flex Code
22312 status collapsed
22313
22314 \begin_layout Plain Layout
22315 div
22316 \end_layout
22317
22318 \end_inset
22319
22320 ; if it is false, the default is
22321 \begin_inset Flex Code
22322 status collapsed
22323
22324 \begin_layout Plain Layout
22325 span
22326 \end_layout
22327
22328 \end_inset
22329
22330 .
22331 \end_layout
22332
22333 \begin_layout Subsection
22334 Float XHTML
22335 \end_layout
22336
22337 \begin_layout Standard
22338 The XHTML output for floats too can be controlled by layout information.
22339  The output has the following form:
22340 \end_layout
22341
22342 \begin_layout LyX-Code
22343 <tag attr=
22344 \begin_inset Quotes erd
22345 \end_inset
22346
22347 value
22348 \begin_inset Quotes erd
22349 \end_inset
22350
22351 >
22352 \end_layout
22353
22354 \begin_layout LyX-Code
22355 Contents of the float.
22356 \end_layout
22357
22358 \begin_layout LyX-Code
22359 </tag>
22360 \end_layout
22361
22362 \begin_layout Standard
22363 The caption, if there is one, is a separate inset and will be output as
22364  such.
22365  Its appearance can be controlled via the InsetLayout for caption insets.
22366
22367 \end_layout
22368
22369 \begin_layout Description
22370 \begin_inset Flex Code
22371 status collapsed
22372
22373 \begin_layout Plain Layout
22374 HTMLAttr
22375 \end_layout
22376
22377 \end_inset
22378
22379  [
22380 \begin_inset Flex Code
22381 status collapsed
22382
22383 \begin_layout Plain Layout
22384 string
22385 \end_layout
22386
22387 \end_inset
22388
22389 ] Specifies attribute information to be output with the main tag.
22390  For example,
22391 \begin_inset Quotes eld
22392 \end_inset
22393
22394
22395 \begin_inset Flex Code
22396 status collapsed
22397
22398 \begin_layout Plain Layout
22399 class=`myfloat' onclick=`\SpecialChar ldots
22400 '
22401 \end_layout
22402
22403 \end_inset
22404
22405
22406 \begin_inset Quotes erd
22407 \end_inset
22408
22409 .
22410  By default, \SpecialChar LyX
22411  will output
22412 \begin_inset Quotes eld
22413 \end_inset
22414
22415
22416 \begin_inset Flex Code
22417 status collapsed
22418
22419 \begin_layout Plain Layout
22420 class=`float float-floattype'
22421 \end_layout
22422
22423 \end_inset
22424
22425
22426 \begin_inset Quotes erd
22427 \end_inset
22428
22429 , where
22430 \begin_inset Flex Code
22431 status collapsed
22432
22433 \begin_layout Plain Layout
22434 floattype
22435 \end_layout
22436
22437 \end_inset
22438
22439  is \SpecialChar LyX
22440 's name for this type of float, as determined by the float declaration
22441  (see
22442 \begin_inset CommandInset ref
22443 LatexCommand ref
22444 reference "subsec:Floats"
22445
22446 \end_inset
22447
22448 ), though made lowercase and with non-alphanumeric characters converted
22449  to underscores, for example: float-table.
22450 \end_layout
22451
22452 \begin_layout Description
22453 \begin_inset Flex Code
22454 status collapsed
22455
22456 \begin_layout Plain Layout
22457 HTMLStyle
22458 \end_layout
22459
22460 \end_inset
22461
22462  CSS style information to be included when this float is used.
22463  Note that this will automatically be wrapped in a layout-generated
22464 \begin_inset Flex Code
22465 status collapsed
22466
22467 \begin_layout Plain Layout
22468 <style>
22469 \end_layout
22470
22471 \end_inset
22472
22473  block, so only the CSS itself need be included.
22474 \end_layout
22475
22476 \begin_layout Description
22477 \begin_inset Flex Code
22478 status collapsed
22479
22480 \begin_layout Plain Layout
22481 HTMLTag
22482 \end_layout
22483
22484 \end_inset
22485
22486  [
22487 \begin_inset Flex Code
22488 status collapsed
22489
22490 \begin_layout Plain Layout
22491 string
22492 \end_layout
22493
22494 \end_inset
22495
22496 ] The tag to be used for this float, replacing
22497 \begin_inset Quotes eld
22498 \end_inset
22499
22500
22501 \begin_inset Flex Code
22502 status collapsed
22503
22504 \begin_layout Plain Layout
22505 tag
22506 \end_layout
22507
22508 \end_inset
22509
22510
22511 \begin_inset Quotes erd
22512 \end_inset
22513
22514  in the example above.
22515  The default is
22516 \begin_inset Flex Code
22517 status collapsed
22518
22519 \begin_layout Plain Layout
22520 div
22521 \end_layout
22522
22523 \end_inset
22524
22525  and will rarely need changing.
22526 \end_layout
22527
22528 \begin_layout Subsection
22529 Bibliography formatting
22530 \end_layout
22531
22532 \begin_layout Standard
22533 The bibliography can be formatted using
22534 \begin_inset Flex Code
22535 status collapsed
22536
22537 \begin_layout Plain Layout
22538 CiteFormat
22539 \end_layout
22540
22541 \end_inset
22542
22543  blocks.
22544  See
22545 \begin_inset CommandInset ref
22546 LatexCommand ref
22547 reference "subsec:Citation-format-description"
22548
22549 \end_inset
22550
22551  for the details.
22552 \end_layout
22553
22554 \begin_layout Subsection
22555 \SpecialChar LyX
22556 -generated CSS
22557 \end_layout
22558
22559 \begin_layout Standard
22560 We have several times mentioned that \SpecialChar LyX
22561  will generate default CSS style rules
22562  for both insets and paragraph styles, based upon the other layout information
22563  that is provided.
22564  In this section, we shall say a word about which layout information \SpecialChar LyX
22565  uses
22566  and how.
22567 \end_layout
22568
22569 \begin_layout Standard
22570 At present, \SpecialChar LyX
22571  auto-generates CSS only for font information, making use of
22572  the
22573 \begin_inset Flex Code
22574 status collapsed
22575
22576 \begin_layout Plain Layout
22577 Family
22578 \end_layout
22579
22580 \end_inset
22581
22582 ,
22583 \begin_inset Flex Code
22584 status collapsed
22585
22586 \begin_layout Plain Layout
22587 Series
22588 \end_layout
22589
22590 \end_inset
22591
22592 ,
22593 \begin_inset Flex Code
22594 status collapsed
22595
22596 \begin_layout Plain Layout
22597 Shape
22598 \end_layout
22599
22600 \end_inset
22601
22602 , and
22603 \begin_inset Flex Code
22604 status collapsed
22605
22606 \begin_layout Plain Layout
22607 Size
22608 \end_layout
22609
22610 \end_inset
22611
22612  specified in the
22613 \begin_inset Flex Code
22614 status collapsed
22615
22616 \begin_layout Plain Layout
22617 Font
22618 \end_layout
22619
22620 \end_inset
22621
22622  declaration (see
22623 \begin_inset CommandInset ref
22624 LatexCommand ref
22625 reference "subsec:Font-description"
22626
22627 \end_inset
22628
22629 ).
22630  The translation is mostly straightforward and obvious.
22631  For example,
22632 \begin_inset Quotes eld
22633 \end_inset
22634
22635
22636 \begin_inset Flex Code
22637 status collapsed
22638
22639 \begin_layout Plain Layout
22640 Family Sans
22641 \end_layout
22642
22643 \end_inset
22644
22645
22646 \begin_inset Quotes erd
22647 \end_inset
22648
22649  becomes
22650 \begin_inset Quotes eld
22651 \end_inset
22652
22653
22654 \begin_inset Flex Code
22655 status collapsed
22656
22657 \begin_layout Plain Layout
22658 font-family: sans-serif;
22659 \end_layout
22660
22661 \end_inset
22662
22663
22664 \begin_inset Quotes erd
22665 \end_inset
22666
22667 .
22668  The correspondence of \SpecialChar LyX
22669  sizes and CSS sizes is a little less obvious but
22670  nonetheless intuitive.
22671  See the
22672 \begin_inset Flex Code
22673 status collapsed
22674
22675 \begin_layout Plain Layout
22676 getSizeCSS()
22677 \end_layout
22678
22679 \end_inset
22680
22681  function in
22682 \begin_inset Flex URL
22683 status collapsed
22684
22685 \begin_layout Plain Layout
22686
22687 src/FontInfo.cpp
22688 \end_layout
22689
22690 \end_inset
22691
22692  for the details.
22693 \end_layout
22694
22695 \begin_layout Chapter
22696 Including External Material
22697 \begin_inset CommandInset label
22698 LatexCommand label
22699 name "chap:Including-External-Material"
22700
22701 \end_inset
22702
22703
22704 \end_layout
22705
22706 \begin_layout Standard
22707 \begin_inset Box Shadowbox
22708 position "t"
22709 hor_pos "c"
22710 has_inner_box 1
22711 inner_pos "t"
22712 use_parbox 0
22713 use_makebox 0
22714 width "100col%"
22715 special "none"
22716 height "1in"
22717 height_special "totalheight"
22718 thickness "0.4pt"
22719 separation "3pt"
22720 shadowsize "4pt"
22721 framecolor "black"
22722 backgroundcolor "none"
22723 status open
22724
22725 \begin_layout Plain Layout
22726 WARNING: This portion of the documentation has not been updated for some
22727  time.
22728  We certainly hope that it is still accurate, but there are no guarantees.
22729 \end_layout
22730
22731 \end_inset
22732
22733
22734 \end_layout
22735
22736 \begin_layout Standard
22737 The use of material from sources external to \SpecialChar LyX
22738  is covered in detail in the
22739
22740 \emph on
22741 Embedded Objects
22742 \emph default
22743  manual.
22744  This part of the manual covers what needs to happen behind the scenes for
22745  new sorts of material to be included.
22746 \end_layout
22747
22748 \begin_layout Section
22749 How does it work?
22750 \end_layout
22751
22752 \begin_layout Standard
22753 The external material feature is based on the concept of a
22754 \emph on
22755 template
22756 \emph default
22757 .
22758  A template is a specification of how \SpecialChar LyX
22759  should interface with a certain kind
22760  of material.
22761  As bundled, \SpecialChar LyX
22762  comes with predefined templates for Xfig figures, various
22763  raster format images, chess diagrams, and LilyPond music notation.
22764  You can check the actual list by using the menu
22765 \begin_inset Flex MenuItem
22766 status collapsed
22767
22768 \begin_layout Plain Layout
22769 Insert\SpecialChar menuseparator
22770 File\SpecialChar menuseparator
22771 External Material
22772 \end_layout
22773
22774 \end_inset
22775
22776 .
22777  Furthermore, it is possible to roll your own template to support a specific
22778  kind of material.
22779  Later we'll describe in more detail what is involved, and hopefully you
22780  will submit all the templates you create so we can include them in a later
22781  \SpecialChar LyX
22782  version.
22783 \end_layout
22784
22785 \begin_layout Standard
22786 Another basic idea of the external material feature is to distinguish between
22787  the original file that serves as a base for final material and the produced
22788  file that is included in your exported or printed document.
22789  For example, consider the case of a figure produced with
22790 \begin_inset Flex Code
22791 status collapsed
22792
22793 \begin_layout Plain Layout
22794 Xfig
22795 \end_layout
22796
22797 \end_inset
22798
22799 .
22800  The Xfig application itself works on an original file with the
22801 \begin_inset Flex Code
22802 status collapsed
22803
22804 \begin_layout Plain Layout
22805 .fig
22806 \end_layout
22807
22808 \end_inset
22809
22810  extension.
22811  Within Xfig, you create and change your figure, and when you are done,
22812  you save the
22813 \begin_inset Flex Code
22814 status collapsed
22815
22816 \begin_layout Plain Layout
22817 fig
22818 \end_layout
22819
22820 \end_inset
22821
22822 -file.
22823  When you want to include the figure in your document, you invoke
22824 \begin_inset Flex Code
22825 status collapsed
22826
22827 \begin_layout Plain Layout
22828 transfig
22829 \end_layout
22830
22831 \end_inset
22832
22833  in order to create a PostScript file that can readily be included in your
22834  \SpecialChar LaTeX
22835  file.
22836  In this case, the
22837 \begin_inset Flex Code
22838 status collapsed
22839
22840 \begin_layout Plain Layout
22841 .fig
22842 \end_layout
22843
22844 \end_inset
22845
22846  file is the original file, and the PostScript file is the produced file.
22847 \end_layout
22848
22849 \begin_layout Standard
22850 This distinction is important in order to allow updating of the material
22851  while you are in the process of writing the document.
22852  Furthermore, it provides us with the flexibility that is needed to support
22853  multiple export formats.
22854  For instance, in the case of a plain text file, it is not exactly an award-winn
22855 ing idea to include the figure as raw PostScript.
22856  Instead, you would either prefer to just include a reference to the figure
22857  or try to invoke some graphics to ASCII converter to make the final result
22858  look similar to the real graphics.
22859  The external material management allows you to do this, because it is parametri
22860 zed on the different export formats that \SpecialChar LyX
22861  supports.
22862 \end_layout
22863
22864 \begin_layout Standard
22865 Besides supporting the production of different products according to the
22866  exported format, it supports tight integration with editing and viewing
22867  applications.
22868  In the case of an Xfig figure, you are able to invoke Xfig on the original
22869  file with a single click from within the external material dialog in \SpecialChar LyX
22870 ,
22871  and also preview the produced PostScript file with Ghostview with another
22872  click.
22873  No more fiddling around with the command line and/or file browsers to locate
22874  and manipulate the original or produced files.
22875  In this way, you are finally able to take full advantage of the many different
22876  applications that are relevant to use when you write your documents, and
22877  ultimately be more productive.
22878 \end_layout
22879
22880 \begin_layout Section
22881 The external template configuration file
22882 \end_layout
22883
22884 \begin_layout Standard
22885 It is relatively easy to add custom external template definitions to \SpecialChar LyX
22886 .
22887  However, be aware that doing this in an careless manner most probably
22888 \emph on
22889 will
22890 \emph default
22891  introduce an easily exploitable security hole.
22892  So before you do this, please read the discussion about security in
22893 \begin_inset CommandInset ref
22894 LatexCommand ref
22895 reference "sec:Security-discussion"
22896
22897 \end_inset
22898
22899 .
22900 \end_layout
22901
22902 \begin_layout Standard
22903 Having said that, we encourage you to submit any interesting templates that
22904  you create.
22905
22906 \end_layout
22907
22908 \begin_layout Standard
22909 The external templates are defined in the
22910 \begin_inset Flex Code
22911 status collapsed
22912
22913 \begin_layout Plain Layout
22914 LyXDir/lib/external_templates
22915 \end_layout
22916
22917 \end_inset
22918
22919  file.
22920  You can place your own version in
22921 \begin_inset Flex Code
22922 status collapsed
22923
22924 \begin_layout Plain Layout
22925 UserDir/external_templates
22926 \end_layout
22927
22928 \end_inset
22929
22930 .
22931 \end_layout
22932
22933 \begin_layout Standard
22934 A typical template looks like this:
22935 \end_layout
22936
22937 \begin_layout LyX-Code
22938 Template XFig
22939 \end_layout
22940
22941 \begin_layout LyX-Code
22942 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
22943 \end_layout
22944
22945 \begin_layout LyX-Code
22946 HelpText
22947 \end_layout
22948
22949 \begin_layout LyX-Code
22950 An XFig figure.
22951 \end_layout
22952
22953 \begin_layout LyX-Code
22954 HelpTextEnd
22955 \end_layout
22956
22957 \begin_layout LyX-Code
22958 InputFormat fig
22959 \end_layout
22960
22961 \begin_layout LyX-Code
22962 FileFilter "*.fig"
22963 \end_layout
22964
22965 \begin_layout LyX-Code
22966 AutomaticProduction true
22967 \end_layout
22968
22969 \begin_layout LyX-Code
22970 Transform Rotate
22971 \end_layout
22972
22973 \begin_layout LyX-Code
22974 Transform Resize
22975 \end_layout
22976
22977 \begin_layout LyX-Code
22978 Format \SpecialChar LaTeX
22979
22980 \end_layout
22981
22982 \begin_layout LyX-Code
22983 TransformCommand Rotate RotationLatexCommand
22984 \end_layout
22985
22986 \begin_layout LyX-Code
22987 TransformCommand Resize ResizeLatexCommand
22988 \end_layout
22989
22990 \begin_layout LyX-Code
22991 Product "$$RotateFront$$ResizeFront
22992 \end_layout
22993
22994 \begin_layout LyX-Code
22995
22996 \backslash
22997
22998 \backslash
22999 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
23000 \end_layout
23001
23002 \begin_layout LyX-Code
23003          $$ResizeBack$$RotateBack"
23004 \end_layout
23005
23006 \begin_layout LyX-Code
23007 UpdateFormat pstex
23008 \end_layout
23009
23010 \begin_layout LyX-Code
23011 UpdateResult "$$AbsPath$$Basename.pstex_t"
23012 \end_layout
23013
23014 \begin_layout LyX-Code
23015 Requirement "graphicx"
23016 \end_layout
23017
23018 \begin_layout LyX-Code
23019 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
23020 \end_layout
23021
23022 \begin_layout LyX-Code
23023 ReferencedFile latex "$$AbsPath$$Basename.eps"
23024 \end_layout
23025
23026 \begin_layout LyX-Code
23027 ReferencedFile dvi "$$AbsPath$$Basename.eps"
23028 \end_layout
23029
23030 \begin_layout LyX-Code
23031 FormatEnd
23032 \end_layout
23033
23034 \begin_layout LyX-Code
23035 Format PDF\SpecialChar LaTeX
23036
23037 \end_layout
23038
23039 \begin_layout LyX-Code
23040 TransformCommand Rotate RotationLatexCommand
23041 \end_layout
23042
23043 \begin_layout LyX-Code
23044 TransformCommand Resize ResizeLatexCommand
23045 \end_layout
23046
23047 \begin_layout LyX-Code
23048 Product "$$RotateFront$$ResizeFront
23049 \end_layout
23050
23051 \begin_layout LyX-Code
23052
23053 \backslash
23054
23055 \backslash
23056 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
23057 \end_layout
23058
23059 \begin_layout LyX-Code
23060          $$ResizeBack$$RotateBack"
23061 \end_layout
23062
23063 \begin_layout LyX-Code
23064 UpdateFormat pdftex
23065 \end_layout
23066
23067 \begin_layout LyX-Code
23068 UpdateResult "$$AbsPath$$Basename.pdftex_t"
23069 \end_layout
23070
23071 \begin_layout LyX-Code
23072 Requirement "graphicx"
23073 \end_layout
23074
23075 \begin_layout LyX-Code
23076 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
23077 \end_layout
23078
23079 \begin_layout LyX-Code
23080 ReferencedFile latex "$$AbsPath$$Basename.pdf"
23081 \end_layout
23082
23083 \begin_layout LyX-Code
23084 FormatEnd
23085 \end_layout
23086
23087 \begin_layout LyX-Code
23088 Format Ascii
23089 \end_layout
23090
23091 \begin_layout LyX-Code
23092 Product "$$Contents(
23093 \backslash
23094 "$$AbsPath$$Basename.asc
23095 \backslash
23096 ")"
23097 \end_layout
23098
23099 \begin_layout LyX-Code
23100 UpdateFormat asciixfig
23101 \end_layout
23102
23103 \begin_layout LyX-Code
23104 UpdateResult "$$AbsPath$$Basename.asc"
23105 \end_layout
23106
23107 \begin_layout LyX-Code
23108 FormatEnd
23109 \end_layout
23110
23111 \begin_layout LyX-Code
23112 Format DocBook
23113 \end_layout
23114
23115 \begin_layout LyX-Code
23116 Product "<graphic fileref=
23117 \backslash
23118 "$$AbsOrRelPathMaster$$Basename.eps
23119 \backslash
23120 ">
23121 \end_layout
23122
23123 \begin_layout LyX-Code
23124          </graphic>"
23125 \end_layout
23126
23127 \begin_layout LyX-Code
23128 UpdateFormat eps
23129 \end_layout
23130
23131 \begin_layout LyX-Code
23132 UpdateResult "$$AbsPath$$Basename.eps"
23133 \end_layout
23134
23135 \begin_layout LyX-Code
23136 ReferencedFile docbook "$$AbsPath$$Basename.eps"
23137 \end_layout
23138
23139 \begin_layout LyX-Code
23140 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
23141 \end_layout
23142
23143 \begin_layout LyX-Code
23144 FormatEnd
23145 \end_layout
23146
23147 \begin_layout LyX-Code
23148 Product "[XFig: $$FName]"
23149 \end_layout
23150
23151 \begin_layout LyX-Code
23152 FormatEnd
23153 \end_layout
23154
23155 \begin_layout LyX-Code
23156 TemplateEnd
23157 \end_layout
23158
23159 \begin_layout Standard
23160 As you can see, the template is enclosed in
23161 \begin_inset Flex Code
23162 status collapsed
23163
23164 \begin_layout Plain Layout
23165 Template
23166 \end_layout
23167
23168 \end_inset
23169
23170  \SpecialChar ldots
23171
23172 \begin_inset Flex Code
23173 status collapsed
23174
23175 \begin_layout Plain Layout
23176 TemplateEnd
23177 \end_layout
23178
23179 \end_inset
23180
23181 .
23182  It contains a header specifying some general settings and, for each supported
23183  primary document file format, a section
23184 \begin_inset Flex Code
23185 status collapsed
23186
23187 \begin_layout Plain Layout
23188 Format
23189 \end_layout
23190
23191 \end_inset
23192
23193  \SpecialChar ldots
23194
23195 \begin_inset Flex Code
23196 status collapsed
23197
23198 \begin_layout Plain Layout
23199 FormatEnd
23200 \end_layout
23201
23202 \end_inset
23203
23204 .
23205 \end_layout
23206
23207 \begin_layout Subsection
23208 The template header
23209 \end_layout
23210
23211 \begin_layout Description
23212 \begin_inset Flex Code
23213 status collapsed
23214
23215 \begin_layout Plain Layout
23216 AutomaticProduction
23217 \begin_inset space ~
23218 \end_inset
23219
23220 true|false
23221 \end_layout
23222
23223 \end_inset
23224
23225  Whether the file represented by the template must be generated by \SpecialChar LyX
23226 .
23227  This command must occur exactly once.
23228 \end_layout
23229
23230 \begin_layout Description
23231 \begin_inset Flex Code
23232 status collapsed
23233
23234 \begin_layout Plain Layout
23235 FileFilter
23236 \begin_inset space ~
23237 \end_inset
23238
23239 <pattern>
23240 \end_layout
23241
23242 \end_inset
23243
23244  A glob pattern that is used in the file dialog to filter out the desired
23245  files.
23246  If there is more than one possible file extension (e.
23247 \begin_inset space \thinspace{}
23248 \end_inset
23249
23250 g.
23251 \begin_inset space \space{}
23252 \end_inset
23253
23254 tgif has
23255 \begin_inset Flex Code
23256 status collapsed
23257
23258 \begin_layout Plain Layout
23259 .obj
23260 \end_layout
23261
23262 \end_inset
23263
23264  and
23265 \begin_inset Flex Code
23266 status collapsed
23267
23268 \begin_layout Plain Layout
23269 .tgo
23270 \end_layout
23271
23272 \end_inset
23273
23274 ), use something like
23275 \begin_inset Flex Code
23276 status collapsed
23277
23278 \begin_layout Plain Layout
23279 "*.{obj,tgo}"
23280 \end_layout
23281
23282 \end_inset
23283
23284 .
23285  This command must occur exactly once.
23286 \end_layout
23287
23288 \begin_layout Description
23289 \begin_inset Flex Code
23290 status collapsed
23291
23292 \begin_layout Plain Layout
23293 GuiName
23294 \begin_inset space ~
23295 \end_inset
23296
23297 <guiname>
23298 \end_layout
23299
23300 \end_inset
23301
23302  The text that is displayed on the button.
23303  This command must occur exactly once.
23304 \end_layout
23305
23306 \begin_layout Description
23307 \begin_inset Flex Code
23308 status collapsed
23309
23310 \begin_layout Plain Layout
23311 HelpText
23312 \begin_inset space ~
23313 \end_inset
23314
23315 <text>
23316 \begin_inset space ~
23317 \end_inset
23318
23319 HelpTextEnd
23320 \end_layout
23321
23322 \end_inset
23323
23324  The help text that is used in the External dialog.
23325  Provide enough information to explain to the user just what the template
23326  can provide him with.
23327  This command must occur exactly once.
23328 \end_layout
23329
23330 \begin_layout Description
23331 \begin_inset Flex Code
23332 status collapsed
23333
23334 \begin_layout Plain Layout
23335 InputFormat
23336 \begin_inset space ~
23337 \end_inset
23338
23339 <format>
23340 \end_layout
23341
23342 \end_inset
23343
23344  The file format of the original file.
23345  This must be the name of a format that is known to \SpecialChar LyX
23346  (see
23347 \begin_inset CommandInset ref
23348 LatexCommand ref
23349 reference "sec:Formats"
23350
23351 \end_inset
23352
23353 ).
23354  Use
23355 \begin_inset Quotes eld
23356 \end_inset
23357
23358
23359 \begin_inset Flex Code
23360 status collapsed
23361
23362 \begin_layout Plain Layout
23363 *
23364 \end_layout
23365
23366 \end_inset
23367
23368
23369 \begin_inset Quotes erd
23370 \end_inset
23371
23372  if the template can handle original files of more than one format.
23373  \SpecialChar LyX
23374  will attempt to interrogate the file itself in order to deduce its format
23375  in this case.
23376  This command must occur exactly once.
23377 \end_layout
23378
23379 \begin_layout Description
23380 \begin_inset Flex Code
23381 status collapsed
23382
23383 \begin_layout Plain Layout
23384 Template
23385 \begin_inset space ~
23386 \end_inset
23387
23388 <id>
23389 \end_layout
23390
23391 \end_inset
23392
23393  A unique name for the template.
23394  It must not contain substitution macros (see below).
23395 \end_layout
23396
23397 \begin_layout Description
23398 \begin_inset Flex Code
23399 status collapsed
23400
23401 \begin_layout Plain Layout
23402 Transform
23403 \begin_inset space ~
23404 \end_inset
23405
23406 Rotate|Resize|Clip|Extra
23407 \end_layout
23408
23409 \end_inset
23410
23411  This command specifies which transformations are supported by this template.
23412  It may occur zero or more times.
23413  This command enables the corresponding tabs in the external dialog.
23414  Each
23415 \begin_inset Flex Code
23416 status collapsed
23417
23418 \begin_layout Plain Layout
23419 Transform
23420 \end_layout
23421
23422 \end_inset
23423
23424  command must have either a corresponding
23425 \begin_inset Flex Code
23426 status collapsed
23427
23428 \begin_layout Plain Layout
23429 TransformCommand
23430 \end_layout
23431
23432 \end_inset
23433
23434  or a
23435 \begin_inset Flex Code
23436 status collapsed
23437
23438 \begin_layout Plain Layout
23439 TransformOption
23440 \end_layout
23441
23442 \end_inset
23443
23444  command in the
23445 \begin_inset Flex Code
23446 status collapsed
23447
23448 \begin_layout Plain Layout
23449 Format
23450 \end_layout
23451
23452 \end_inset
23453
23454  section.
23455  Otherwise the transformation will not be supported by that format.
23456 \end_layout
23457
23458 \begin_layout Subsection
23459 The Format section
23460 \end_layout
23461
23462 \begin_layout Description
23463 \begin_inset Flex Code
23464 status collapsed
23465
23466 \begin_layout Plain Layout
23467 Format
23468 \begin_inset space ~
23469 \end_inset
23470
23471 LaTeX|PDFLaTeX|PlainText|DocBook
23472 \end_layout
23473
23474 \end_inset
23475
23476  The primary document file format that this format definition is for.
23477  Not every template has a sensible representation in all document file formats.
23478  Please define nevertheless a
23479 \begin_inset Flex Code
23480 status collapsed
23481
23482 \begin_layout Plain Layout
23483 Format
23484 \end_layout
23485
23486 \end_inset
23487
23488  section for all templates.
23489  Use a dummy text when no representation is available.
23490  Then you can at least see a reference to the external material in the exported
23491  document.
23492 \end_layout
23493
23494 \begin_layout Description
23495 \begin_inset Flex Code
23496 status collapsed
23497
23498 \begin_layout Plain Layout
23499 Option
23500 \begin_inset space ~
23501 \end_inset
23502
23503 <name>
23504 \begin_inset space ~
23505 \end_inset
23506
23507 <value>
23508 \end_layout
23509
23510 \end_inset
23511
23512  This command defines an additional macro
23513 \begin_inset Flex Code
23514 status collapsed
23515
23516 \begin_layout Plain Layout
23517 $$<name>
23518 \end_layout
23519
23520 \end_inset
23521
23522  for substitution in
23523 \begin_inset Flex Code
23524 status collapsed
23525
23526 \begin_layout Plain Layout
23527 Product
23528 \end_layout
23529
23530 \end_inset
23531
23532 .
23533
23534 \begin_inset Flex Code
23535 status collapsed
23536
23537 \begin_layout Plain Layout
23538 <value>
23539 \end_layout
23540
23541 \end_inset
23542
23543  itself may contain substitution macros.
23544  The advantage over using
23545 \begin_inset Flex Code
23546 status collapsed
23547
23548 \begin_layout Plain Layout
23549 <value>
23550 \end_layout
23551
23552 \end_inset
23553
23554  directly in
23555 \begin_inset Flex Code
23556 status collapsed
23557
23558 \begin_layout Plain Layout
23559 Product
23560 \end_layout
23561
23562 \end_inset
23563
23564  is that the substituted value of
23565 \begin_inset Flex Code
23566 status collapsed
23567
23568 \begin_layout Plain Layout
23569 $$<name>
23570 \end_layout
23571
23572 \end_inset
23573
23574  is sanitized so that it is a valid optional argument in the document format.
23575  This command may occur zero or more times.
23576 \end_layout
23577
23578 \begin_layout Description
23579 \begin_inset Flex Code
23580 status collapsed
23581
23582 \begin_layout Plain Layout
23583 Product
23584 \begin_inset space ~
23585 \end_inset
23586
23587 <text>
23588 \end_layout
23589
23590 \end_inset
23591
23592  The text that is inserted in the exported document.
23593  This is actually the most important command and can be quite complex.
23594  This command must occur exactly once.
23595 \end_layout
23596
23597 \begin_layout Description
23598 \begin_inset Flex Code
23599 status collapsed
23600
23601 \begin_layout Plain Layout
23602 Preamble
23603 \begin_inset space ~
23604 \end_inset
23605
23606 <name>
23607 \end_layout
23608
23609 \end_inset
23610
23611  This command specifies a preamble snippet that will be included in the
23612  \SpecialChar LaTeX
23613  preamble.
23614  It has to be defined using
23615 \begin_inset Flex Code
23616 status collapsed
23617
23618 \begin_layout Plain Layout
23619 PreambleDef
23620 \end_layout
23621
23622 \end_inset
23623
23624  \SpecialChar ldots
23625
23626 \begin_inset Flex Code
23627 status collapsed
23628
23629 \begin_layout Plain Layout
23630 PreambleDefEnd
23631 \end_layout
23632
23633 \end_inset
23634
23635 .
23636  This command may occur zero or more times.
23637 \end_layout
23638
23639 \begin_layout Description
23640 \begin_inset Flex Code
23641 status collapsed
23642
23643 \begin_layout Plain Layout
23644 ReferencedFile
23645 \begin_inset space ~
23646 \end_inset
23647
23648 <format>
23649 \begin_inset space ~
23650 \end_inset
23651
23652 <filename>
23653 \end_layout
23654
23655 \end_inset
23656
23657  This command denotes files that are created by the conversion process and
23658  are needed for a particular export format.
23659  If the filename is relative, it is interpreted relative to the master document.
23660  This command may be given zero or more times.
23661 \end_layout
23662
23663 \begin_layout Description
23664 \begin_inset Flex Code
23665 status collapsed
23666
23667 \begin_layout Plain Layout
23668 Requirement
23669 \begin_inset space ~
23670 \end_inset
23671
23672 <package>
23673 \end_layout
23674
23675 \end_inset
23676
23677  The name of a required \SpecialChar LaTeX
23678  package.
23679  The package is included via
23680 \begin_inset Flex Code
23681 status collapsed
23682
23683 \begin_layout Plain Layout
23684
23685 \backslash
23686 usepackage{}
23687 \end_layout
23688
23689 \end_inset
23690
23691  in the \SpecialChar LaTeX
23692  preamble.
23693  This command may occur zero or more times.
23694 \end_layout
23695
23696 \begin_layout Description
23697 \begin_inset Flex Code
23698 status collapsed
23699
23700 \begin_layout Plain Layout
23701 TransformCommand
23702 \begin_inset space ~
23703 \end_inset
23704
23705 Rotate
23706 \begin_inset space ~
23707 \end_inset
23708
23709 RotationLatexCommand
23710 \end_layout
23711
23712 \end_inset
23713
23714  This command specifies that the built in \SpecialChar LaTeX
23715  command should be used for rotation.
23716  This command may occur once or not at all.
23717 \end_layout
23718
23719 \begin_layout Description
23720 \begin_inset Flex Code
23721 status collapsed
23722
23723 \begin_layout Plain Layout
23724 TransformCommand
23725 \begin_inset space ~
23726 \end_inset
23727
23728 Resize
23729 \begin_inset space ~
23730 \end_inset
23731
23732 ResizeLatexCommand
23733 \end_layout
23734
23735 \end_inset
23736
23737  This command specifies that the built in \SpecialChar LaTeX
23738  command should be used for resizing.
23739  This command may occur once or not at all.
23740 \end_layout
23741
23742 \begin_layout Description
23743 \begin_inset Flex Code
23744 status collapsed
23745
23746 \begin_layout Plain Layout
23747 TransformOption
23748 \begin_inset space ~
23749 \end_inset
23750
23751 Rotate
23752 \begin_inset space ~
23753 \end_inset
23754
23755 RotationLatexOption
23756 \end_layout
23757
23758 \end_inset
23759
23760  This command specifies that rotation is done via an optional argument.
23761  This command may occur once or not at all.
23762 \end_layout
23763
23764 \begin_layout Description
23765 \begin_inset Flex Code
23766 status collapsed
23767
23768 \begin_layout Plain Layout
23769 TransformOption
23770 \begin_inset space ~
23771 \end_inset
23772
23773 Resize
23774 \begin_inset space ~
23775 \end_inset
23776
23777 ResizeLatexOption
23778 \end_layout
23779
23780 \end_inset
23781
23782  This command specifies that resizing is done via an optional argument.
23783  This command may occur once or not at all.
23784 \end_layout
23785
23786 \begin_layout Description
23787 \begin_inset Flex Code
23788 status collapsed
23789
23790 \begin_layout Plain Layout
23791 TransformOption
23792 \begin_inset space ~
23793 \end_inset
23794
23795 Clip
23796 \begin_inset space ~
23797 \end_inset
23798
23799 ClipLatexOption
23800 \end_layout
23801
23802 \end_inset
23803
23804  This command specifies that clipping is done via an optional argument.
23805  This command may occur once or not at all.
23806 \end_layout
23807
23808 \begin_layout Description
23809 \begin_inset Flex Code
23810 status collapsed
23811
23812 \begin_layout Plain Layout
23813 TransformOption
23814 \begin_inset space ~
23815 \end_inset
23816
23817 Extra
23818 \begin_inset space ~
23819 \end_inset
23820
23821 ExtraLatexOption
23822 \end_layout
23823
23824 \end_inset
23825
23826  This command specifies that an extra optional argument is used.
23827  This command may occur once or not at all.
23828 \end_layout
23829
23830 \begin_layout Description
23831 \begin_inset Flex Code
23832 status collapsed
23833
23834 \begin_layout Plain Layout
23835 UpdateFormat
23836 \begin_inset space ~
23837 \end_inset
23838
23839 <format>
23840 \end_layout
23841
23842 \end_inset
23843
23844  The file format of the converted file.
23845  This must be the name of a format that is known to \SpecialChar LyX
23846  (see the
23847 \begin_inset Flex MenuItem
23848 status collapsed
23849
23850 \begin_layout Plain Layout
23851 Tools\SpecialChar menuseparator
23852 Preferences\SpecialChar menuseparator
23853 File Handling\SpecialChar menuseparator
23854 File Format
23855 \end_layout
23856
23857 \end_inset
23858
23859  dialog).
23860  This command must occur exactly once.
23861  If the resulting file format is PDF, you need to specify the format
23862 \begin_inset Flex Code
23863 status collapsed
23864
23865 \begin_layout Plain Layout
23866 pdf6
23867 \end_layout
23868
23869 \end_inset
23870
23871 .
23872  This is the PDF format used for including graphics.
23873  The other defined PDF formats are for document export.
23874 \end_layout
23875
23876 \begin_layout Description
23877 \begin_inset Flex Code
23878 status collapsed
23879
23880 \begin_layout Plain Layout
23881 UpdateResult
23882 \begin_inset space ~
23883 \end_inset
23884
23885 <filename>
23886 \end_layout
23887
23888 \end_inset
23889
23890  The file name of the converted file.
23891  The file name must be absolute.
23892  This command must occur exactly once.
23893 \end_layout
23894
23895 \begin_layout Subsection
23896 Preamble definitions
23897 \end_layout
23898
23899 \begin_layout Standard
23900 The external template configuration file may contain additional preamble
23901  definitions enclosed by
23902 \begin_inset Flex Code
23903 status collapsed
23904
23905 \begin_layout Plain Layout
23906 PreambleDef
23907 \end_layout
23908
23909 \end_inset
23910
23911  \SpecialChar ldots
23912
23913 \begin_inset Flex Code
23914 status collapsed
23915
23916 \begin_layout Plain Layout
23917 PreambleDefEnd
23918 \end_layout
23919
23920 \end_inset
23921
23922 .
23923  They can be used by the templates in the
23924 \begin_inset Flex Code
23925 status collapsed
23926
23927 \begin_layout Plain Layout
23928 Format
23929 \end_layout
23930
23931 \end_inset
23932
23933  section.
23934 \end_layout
23935
23936 \begin_layout Section
23937 The substitution mechanism
23938 \end_layout
23939
23940 \begin_layout Standard
23941 When the external material facility invokes an external program, it is done
23942  on the basis of a command defined in the template configuration file.
23943  These commands can contain various macros that are expanded before execution.
23944  Execution always take place in the directory of the containing document.
23945 \end_layout
23946
23947 \begin_layout Standard
23948 Also, whenever external material is to be displayed, the name will be produced
23949  by the substitution mechanism, and most other commands in the template
23950  definition support substitution as well.
23951 \end_layout
23952
23953 \begin_layout Standard
23954 The available macros are the following:
23955 \end_layout
23956
23957 \begin_layout Description
23958 \begin_inset Flex Code
23959 status collapsed
23960
23961 \begin_layout Plain Layout
23962 $$AbsOrRelPathMaster
23963 \end_layout
23964
23965 \end_inset
23966
23967  The file path, absolute or relative to the master \SpecialChar LyX
23968  document.
23969 \end_layout
23970
23971 \begin_layout Description
23972 \begin_inset Flex Code
23973 status collapsed
23974
23975 \begin_layout Plain Layout
23976 $$AbsOrRelPathParent
23977 \end_layout
23978
23979 \end_inset
23980
23981  The file path, absolute or relative to the \SpecialChar LyX
23982  document.
23983 \end_layout
23984
23985 \begin_layout Description
23986 \begin_inset Flex Code
23987 status collapsed
23988
23989 \begin_layout Plain Layout
23990 $$AbsPath
23991 \end_layout
23992
23993 \end_inset
23994
23995  The absolute file path.
23996 \end_layout
23997
23998 \begin_layout Description
23999 \begin_inset Flex Code
24000 status collapsed
24001
24002 \begin_layout Plain Layout
24003 $$Basename
24004 \end_layout
24005
24006 \end_inset
24007
24008  The filename without path and without the extension.
24009 \end_layout
24010
24011 \begin_layout Description
24012 \begin_inset Flex Code
24013 status collapsed
24014
24015 \begin_layout Plain Layout
24016 $$Contents(
24017 \begin_inset Quotes eld
24018 \end_inset
24019
24020 filename.ext
24021 \begin_inset Quotes erd
24022 \end_inset
24023
24024 )
24025 \end_layout
24026
24027 \end_inset
24028
24029  This macro will expand to the contents of the file with the name
24030 \begin_inset Flex Code
24031 status collapsed
24032
24033 \begin_layout Plain Layout
24034 filename.ext
24035 \end_layout
24036
24037 \end_inset
24038
24039 .
24040 \end_layout
24041
24042 \begin_layout Description
24043 \begin_inset Flex Code
24044 status collapsed
24045
24046 \begin_layout Plain Layout
24047 $$Extension
24048 \end_layout
24049
24050 \end_inset
24051
24052  The file extension (including the dot).
24053 \change_inserted -195340706 1437418878
24054
24055 \end_layout
24056
24057 \begin_layout Description
24058
24059 \change_inserted -195340706 1437418878
24060 \begin_inset Flex Code
24061 status collapsed
24062
24063 \begin_layout Plain Layout
24064
24065 \change_inserted -195340706 1437418878
24066 $$pngOrjpg
24067 \end_layout
24068
24069 \end_inset
24070
24071  This will be the string
24072 \begin_inset Quotes eld
24073 \end_inset
24074
24075 jpg
24076 \begin_inset Quotes erd
24077 \end_inset
24078
24079  if the file is in JPEG format, otherwise it will be the string
24080 \begin_inset Quotes eld
24081 \end_inset
24082
24083 png
24084 \begin_inset Quotes erd
24085 \end_inset
24086
24087 .
24088  This is useful to avoid uneeded conversions for output formats that support
24089  both PNG and JPEG fomats.
24090  The predefined RasterImage template uses this macro for the PDFL
24091 \change_deleted -712698321 1437634446
24092 A
24093 \change_inserted -712698321 1437634446
24094 a
24095 \change_inserted -195340706 1437418878
24096 TeX output format.
24097 \change_unchanged
24098
24099 \end_layout
24100
24101 \begin_layout Description
24102 \begin_inset Flex Code
24103 status collapsed
24104
24105 \begin_layout Plain Layout
24106 $$FName
24107 \end_layout
24108
24109 \end_inset
24110
24111  The filename of the file specified in the external material dialog.
24112  This is either an absolute name, or it is relative to the \SpecialChar LyX
24113  document.
24114 \end_layout
24115
24116 \begin_layout Description
24117 \begin_inset Flex Code
24118 status collapsed
24119
24120 \begin_layout Plain Layout
24121 $$FPath
24122 \end_layout
24123
24124 \end_inset
24125
24126  The path part of
24127 \begin_inset Flex Code
24128 status collapsed
24129
24130 \begin_layout Plain Layout
24131 $$FName
24132 \end_layout
24133
24134 \end_inset
24135
24136  (absolute name or relative to the \SpecialChar LyX
24137  document).
24138 \end_layout
24139
24140 \begin_layout Description
24141 \begin_inset Flex Code
24142 status collapsed
24143
24144 \begin_layout Plain Layout
24145 $$RelPathMaster
24146 \end_layout
24147
24148 \end_inset
24149
24150  The file path, relative to the master \SpecialChar LyX
24151  document.
24152 \end_layout
24153
24154 \begin_layout Description
24155 \begin_inset Flex Code
24156 status collapsed
24157
24158 \begin_layout Plain Layout
24159 $$RelPathParent
24160 \end_layout
24161
24162 \end_inset
24163
24164  The file path, relative to the \SpecialChar LyX
24165  document.
24166 \end_layout
24167
24168 \begin_layout Description
24169 \begin_inset Flex Code
24170 status collapsed
24171
24172 \begin_layout Plain Layout
24173 $$Sysdir
24174 \end_layout
24175
24176 \end_inset
24177
24178  This macro will expand to the absolute path of the system directory.
24179  This is typically used to point to the various helper scripts that are
24180  bundled with \SpecialChar LyX
24181 .
24182 \end_layout
24183
24184 \begin_layout Description
24185 \begin_inset Flex Code
24186 status collapsed
24187
24188 \begin_layout Plain Layout
24189 $$Tempname
24190 \end_layout
24191
24192 \end_inset
24193
24194  A name and full path to a temporary file which will be automatically deleted
24195  whenever the containing document is closed, or the external material insertion
24196  deleted.
24197 \end_layout
24198
24199 \begin_layout Standard
24200 All path macros contain a trailing directory separator, so you can construct
24201  e.
24202 \begin_inset space \thinspace{}
24203 \end_inset
24204
24205 g.
24206 \begin_inset space \space{}
24207 \end_inset
24208
24209 the absolute filename with
24210 \begin_inset Flex Code
24211 status collapsed
24212
24213 \begin_layout Plain Layout
24214 $$AbsPath$$Basename$$Extension
24215 \end_layout
24216
24217 \end_inset
24218
24219 .
24220 \end_layout
24221
24222 \begin_layout Standard
24223 The macros above are substituted in all commands unless otherwise noted.
24224  The command
24225 \begin_inset Flex Code
24226 status collapsed
24227
24228 \begin_layout Plain Layout
24229 Product
24230 \end_layout
24231
24232 \end_inset
24233
24234  supports additionally the following substitutions if they are enabled by
24235  the
24236 \begin_inset Flex Code
24237 status collapsed
24238
24239 \begin_layout Plain Layout
24240 Transform
24241 \end_layout
24242
24243 \end_inset
24244
24245  and
24246 \begin_inset Flex Code
24247 status collapsed
24248
24249 \begin_layout Plain Layout
24250 TransformCommand
24251 \end_layout
24252
24253 \end_inset
24254
24255  commands:
24256 \end_layout
24257
24258 \begin_layout Description
24259 \begin_inset Flex Code
24260 status collapsed
24261
24262 \begin_layout Plain Layout
24263 $$ResizeFront
24264 \end_layout
24265
24266 \end_inset
24267
24268  The front part of the resize command.
24269 \end_layout
24270
24271 \begin_layout Description
24272 \begin_inset Flex Code
24273 status collapsed
24274
24275 \begin_layout Plain Layout
24276 $$ResizeBack
24277 \end_layout
24278
24279 \end_inset
24280
24281  The back part of the resize command.
24282 \end_layout
24283
24284 \begin_layout Description
24285 \begin_inset Flex Code
24286 status collapsed
24287
24288 \begin_layout Plain Layout
24289 $$RotateFront
24290 \end_layout
24291
24292 \end_inset
24293
24294  The front part of the rotation command.
24295 \end_layout
24296
24297 \begin_layout Description
24298 \begin_inset Flex Code
24299 status collapsed
24300
24301 \begin_layout Plain Layout
24302 $$RotateBack
24303 \end_layout
24304
24305 \end_inset
24306
24307  The back part of the rotation command.
24308 \end_layout
24309
24310 \begin_layout Standard
24311 The value string of the
24312 \begin_inset Flex Code
24313 status collapsed
24314
24315 \begin_layout Plain Layout
24316 Option
24317 \end_layout
24318
24319 \end_inset
24320
24321  command supports additionally the following substitutions if they are enabled
24322  by the
24323 \begin_inset Flex Code
24324 status collapsed
24325
24326 \begin_layout Plain Layout
24327 Transform
24328 \end_layout
24329
24330 \end_inset
24331
24332  and
24333 \begin_inset Flex Code
24334 status collapsed
24335
24336 \begin_layout Plain Layout
24337 TransformOption
24338 \end_layout
24339
24340 \end_inset
24341
24342  commands:
24343 \end_layout
24344
24345 \begin_layout Description
24346 \begin_inset Flex Code
24347 status collapsed
24348
24349 \begin_layout Plain Layout
24350 $$Clip
24351 \end_layout
24352
24353 \end_inset
24354
24355  The clip option.
24356 \end_layout
24357
24358 \begin_layout Description
24359 \begin_inset Flex Code
24360 status collapsed
24361
24362 \begin_layout Plain Layout
24363 $$Extra
24364 \end_layout
24365
24366 \end_inset
24367
24368  The extra option.
24369 \end_layout
24370
24371 \begin_layout Description
24372 \begin_inset Flex Code
24373 status collapsed
24374
24375 \begin_layout Plain Layout
24376 $$Resize
24377 \end_layout
24378
24379 \end_inset
24380
24381  The resize option.
24382 \end_layout
24383
24384 \begin_layout Description
24385 \begin_inset Flex Code
24386 status collapsed
24387
24388 \begin_layout Plain Layout
24389 $$Rotate
24390 \end_layout
24391
24392 \end_inset
24393
24394  The rotation option.
24395 \end_layout
24396
24397 \begin_layout Standard
24398 You may ask why there are so many path macros.
24399  There are mainly two reasons:
24400 \end_layout
24401
24402 \begin_layout Enumerate
24403 Relative and absolute file names should remain relative or absolute, respectivel
24404 y.
24405  Users may have reasons to prefer either form.
24406  Relative names are useful for portable documents that should work on different
24407  machines, for example.
24408  Absolute names may be required by some programs.
24409 \end_layout
24410
24411 \begin_layout Enumerate
24412 \SpecialChar LaTeX
24413  treats relative file names differently than \SpecialChar LyX
24414  and other programs in nested
24415  included files.
24416  For \SpecialChar LyX
24417 , a relative file name is always relative to the document that contains
24418  the file name.
24419  For \SpecialChar LaTeX
24420 , it is always relative to the master document.
24421  These two definitions are identical if you have only one document, but
24422  differ if you have a master document that includes part documents.
24423  That means that relative filenames must be transformed when presented to
24424  \SpecialChar LaTeX
24425 .
24426  Fortunately \SpecialChar LyX
24427  does this automatically for you if you choose the right macros.
24428 \end_layout
24429
24430 \begin_layout Standard
24431 So which path macro should be used in new template definitions? The rule
24432  is not difficult:
24433 \end_layout
24434
24435 \begin_layout Itemize
24436 Use
24437 \begin_inset Flex Code
24438 status collapsed
24439
24440 \begin_layout Plain Layout
24441 $$AbsPath
24442 \end_layout
24443
24444 \end_inset
24445
24446  if an absolute path is required.
24447 \end_layout
24448
24449 \begin_layout Itemize
24450 Use
24451 \begin_inset Flex Code
24452 status collapsed
24453
24454 \begin_layout Plain Layout
24455 $$AbsOrRelPathMaster
24456 \end_layout
24457
24458 \end_inset
24459
24460  if the substituted string is some kind of \SpecialChar LaTeX
24461  input.
24462 \end_layout
24463
24464 \begin_layout Itemize
24465 Else use
24466 \begin_inset Flex Code
24467 status collapsed
24468
24469 \begin_layout Plain Layout
24470 $$AbsOrRelPathParent
24471 \end_layout
24472
24473 \end_inset
24474
24475  in order to preserve the user's choice.
24476 \end_layout
24477
24478 \begin_layout Standard
24479 There are special cases where this rule does not work and e.
24480 \begin_inset space \thinspace{}
24481 \end_inset
24482
24483 g.
24484 \begin_inset space \space{}
24485 \end_inset
24486
24487 relative names are needed, but normally it will work just fine.
24488  One example for such a case is the command
24489 \begin_inset Flex Code
24490 status collapsed
24491
24492 \begin_layout Plain Layout
24493 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
24494 \end_layout
24495
24496 \end_inset
24497
24498  in the XFig template above: We can't use the absolute name because the
24499  copier for
24500 \begin_inset Flex Code
24501 status collapsed
24502
24503 \begin_layout Plain Layout
24504 .pstex_t
24505 \end_layout
24506
24507 \end_inset
24508
24509  files needs the relative name in order to rewrite the file content.
24510 \end_layout
24511
24512 \begin_layout Section
24513 Security discussion
24514 \begin_inset CommandInset label
24515 LatexCommand label
24516 name "sec:Security-discussion"
24517
24518 \end_inset
24519
24520
24521 \end_layout
24522
24523 \begin_layout Standard
24524 The external material feature interfaces with a lot of external programs
24525  and does so automatically, so we have to consider the security implications
24526  of this.
24527  In particular, since you have the option of including your own filenames
24528  and/or parameter strings and those are expanded into a command, it seems
24529  that it would be possible to create a malicious document which executes
24530  arbitrary commands when a user views or prints the document.
24531  This is something we definitely want to avoid.
24532 \end_layout
24533
24534 \begin_layout Standard
24535 However, since the external program commands are specified in the template
24536  configuration file only, there are no security issues if \SpecialChar LyX
24537  is properly configure
24538 d with safe templates only.
24539  This is so because the external programs are invoked with the
24540 \begin_inset Flex Code
24541 status collapsed
24542
24543 \begin_layout Plain Layout
24544 execvp
24545 \end_layout
24546
24547 \end_inset
24548
24549 -system call rather than the
24550 \begin_inset Flex Code
24551 status collapsed
24552
24553 \begin_layout Plain Layout
24554 system
24555 \end_layout
24556
24557 \end_inset
24558
24559  system-call, so it's not possible to execute arbitrary commands from the
24560  filename or parameter section via the shell.
24561 \end_layout
24562
24563 \begin_layout Standard
24564 This also implies that you are restricted in what command strings you can
24565  use in the external material templates.
24566  In particular, pipes and redirection are not readily available.
24567  This has to be so if \SpecialChar LyX
24568  should remain safe.
24569  If you want to use some of the shell features, you should write a safe
24570  script to do this in a controlled manner, and then invoke the script from
24571  the command string.
24572
24573 \end_layout
24574
24575 \begin_layout Standard
24576 It is possible to design a template that interacts directly with the shell,
24577  but since this would allow a malicious user to execute arbitrary commands
24578  by writing clever filenames and/or parameters, we generally recommend that
24579  you only use safe scripts that work with the
24580 \begin_inset Flex Code
24581 status collapsed
24582
24583 \begin_layout Plain Layout
24584 execvp
24585 \end_layout
24586
24587 \end_inset
24588
24589  system call in a controlled manner.
24590  Of course, for use in a controlled environment, it can be tempting to just
24591  fall back to use ordinary shell scripts.
24592  If you do so, be aware that you
24593 \emph on
24594 will
24595 \emph default
24596  provide an easily exploitable security hole in your system.
24597  Of course it stands to reason that such unsafe templates will never be
24598  included in the standard \SpecialChar LyX
24599  distribution, although we do encourage people
24600  to submit new templates in the open source tradition.
24601  But \SpecialChar LyX
24602  as shipped from the official distribution channels will never have
24603  unsafe templates.
24604 \end_layout
24605
24606 \begin_layout Standard
24607 Including external material provides a lot of power, and you have to be
24608  careful not to introduce security hazards with this power.
24609  A subtle error in a single line in an innocent looking script can open
24610  the door to huge security problems.
24611  So if you do not fully understand the issues, we recommend that you consult
24612  a knowledgeable security professional or the \SpecialChar LyX
24613  development team if you have
24614  any questions about whether a given template is safe or not.
24615  And do this before you use it in an uncontrolled environment.
24616 \end_layout
24617
24618 \begin_layout Chapter
24619 \start_of_appendix
24620 List of supported \SpecialChar LyX
24621  functions to be used in layouts
24622 \begin_inset CommandInset label
24623 LatexCommand label
24624 name "chap:List-of-functions"
24625
24626 \end_inset
24627
24628
24629 \end_layout
24630
24631 \begin_layout Standard
24632 \align center
24633 \begin_inset Tabular
24634 <lyxtabular version="3" rows="11" columns="8">
24635 <features tabularvalignment="middle">
24636 <column alignment="left" valignment="top">
24637 <column alignment="left" valignment="top">
24638 <column alignment="left" valignment="top">
24639 <column alignment="left" valignment="top">
24640 <column alignment="left" valignment="top">
24641 <column alignment="left" valignment="top">
24642 <column alignment="left" valignment="top">
24643 <column alignment="left" valignment="top">
24644 <row>
24645 <cell alignment="left" valignment="top" usebox="none">
24646 \begin_inset Text
24647
24648 \begin_layout Plain Layout
24649 accents
24650 \end_layout
24651
24652 \end_inset
24653 </cell>
24654 <cell alignment="left" valignment="top" usebox="none">
24655 \begin_inset Text
24656
24657 \begin_layout Plain Layout
24658 booktabs
24659 \end_layout
24660
24661 \end_inset
24662 </cell>
24663 <cell alignment="left" valignment="top" usebox="none">
24664 \begin_inset Text
24665
24666 \begin_layout Plain Layout
24667 feyn
24668 \end_layout
24669
24670 \end_inset
24671 </cell>
24672 <cell alignment="left" valignment="top" usebox="none">
24673 \begin_inset Text
24674
24675 \begin_layout Plain Layout
24676 listings
24677 \end_layout
24678
24679 \end_inset
24680 </cell>
24681 <cell alignment="center" valignment="top" usebox="none">
24682 \begin_inset Text
24683
24684 \begin_layout Plain Layout
24685 natbib
24686 \end_layout
24687
24688 \end_inset
24689 </cell>
24690 <cell alignment="center" valignment="top" usebox="none">
24691 \begin_inset Text
24692
24693 \begin_layout Plain Layout
24694 rotfloat
24695 \end_layout
24696
24697 \end_inset
24698 </cell>
24699 <cell alignment="center" valignment="top" usebox="none">
24700 \begin_inset Text
24701
24702 \begin_layout Plain Layout
24703 tfrupee
24704 \end_layout
24705
24706 \end_inset
24707 </cell>
24708 <cell alignment="center" valignment="top" usebox="none">
24709 \begin_inset Text
24710
24711 \begin_layout Plain Layout
24712 wasysym
24713 \end_layout
24714
24715 \end_inset
24716 </cell>
24717 </row>
24718 <row>
24719 <cell alignment="left" valignment="top" usebox="none">
24720 \begin_inset Text
24721
24722 \begin_layout Plain Layout
24723 amsbsy
24724 \end_layout
24725
24726 \end_inset
24727 </cell>
24728 <cell alignment="left" valignment="top" usebox="none">
24729 \begin_inset Text
24730
24731 \begin_layout Plain Layout
24732 calc
24733 \end_layout
24734
24735 \end_inset
24736 </cell>
24737 <cell alignment="left" valignment="top" usebox="none">
24738 \begin_inset Text
24739
24740 \begin_layout Plain Layout
24741 fixltx2e
24742 \end_layout
24743
24744 \end_inset
24745 </cell>
24746 <cell alignment="left" valignment="top" usebox="none">
24747 \begin_inset Text
24748
24749 \begin_layout Plain Layout
24750 longtable
24751 \end_layout
24752
24753 \end_inset
24754 </cell>
24755 <cell alignment="center" valignment="top" usebox="none">
24756 \begin_inset Text
24757
24758 \begin_layout Plain Layout
24759 nomencl
24760 \end_layout
24761
24762 \end_inset
24763 </cell>
24764 <cell alignment="center" valignment="top" usebox="none">
24765 \begin_inset Text
24766
24767 \begin_layout Plain Layout
24768 rsphrase
24769 \end_layout
24770
24771 \end_inset
24772 </cell>
24773 <cell alignment="center" valignment="top" usebox="none">
24774 \begin_inset Text
24775
24776 \begin_layout Plain Layout
24777 tipa
24778 \end_layout
24779
24780 \end_inset
24781 </cell>
24782 <cell alignment="center" valignment="top" usebox="none">
24783 \begin_inset Text
24784
24785 \begin_layout Plain Layout
24786 wrapfig
24787 \end_layout
24788
24789 \end_inset
24790 </cell>
24791 </row>
24792 <row>
24793 <cell alignment="left" valignment="top" usebox="none">
24794 \begin_inset Text
24795
24796 \begin_layout Plain Layout
24797 amscd
24798 \end_layout
24799
24800 \end_inset
24801 </cell>
24802 <cell alignment="left" valignment="top" usebox="none">
24803 \begin_inset Text
24804
24805 \begin_layout Plain Layout
24806 CJK
24807 \end_layout
24808
24809 \end_inset
24810 </cell>
24811 <cell alignment="left" valignment="top" usebox="none">
24812 \begin_inset Text
24813
24814 \begin_layout Plain Layout
24815 float
24816 \end_layout
24817
24818 \end_inset
24819 </cell>
24820 <cell alignment="left" valignment="top" usebox="none">
24821 \begin_inset Text
24822
24823 \begin_layout Plain Layout
24824 lyxskak
24825 \end_layout
24826
24827 \end_inset
24828 </cell>
24829 <cell alignment="center" valignment="top" usebox="none">
24830 \begin_inset Text
24831
24832 \begin_layout Plain Layout
24833 pdfcolmk
24834 \end_layout
24835
24836 \end_inset
24837 </cell>
24838 <cell alignment="center" valignment="top" usebox="none">
24839 \begin_inset Text
24840
24841 \begin_layout Plain Layout
24842 setspace
24843 \end_layout
24844
24845 \end_inset
24846 </cell>
24847 <cell alignment="center" valignment="top" usebox="none">
24848 \begin_inset Text
24849
24850 \begin_layout Plain Layout
24851 tipx
24852 \end_layout
24853
24854 \end_inset
24855 </cell>
24856 <cell alignment="center" valignment="top" usebox="none">
24857 \begin_inset Text
24858
24859 \begin_layout Plain Layout
24860 xargs
24861 \end_layout
24862
24863 \end_inset
24864 </cell>
24865 </row>
24866 <row>
24867 <cell alignment="left" valignment="top" usebox="none">
24868 \begin_inset Text
24869
24870 \begin_layout Plain Layout
24871 amsmath
24872 \end_layout
24873
24874 \end_inset
24875 </cell>
24876 <cell alignment="left" valignment="top" usebox="none">
24877 \begin_inset Text
24878
24879 \begin_layout Plain Layout
24880 color
24881 \end_layout
24882
24883 \end_inset
24884 </cell>
24885 <cell alignment="left" valignment="top" usebox="none">
24886 \begin_inset Text
24887
24888 \begin_layout Plain Layout
24889 framed
24890 \end_layout
24891
24892 \end_inset
24893 </cell>
24894 <cell alignment="left" valignment="top" usebox="none">
24895 \begin_inset Text
24896
24897 \begin_layout Plain Layout
24898 makeidx
24899 \end_layout
24900
24901 \end_inset
24902 </cell>
24903 <cell alignment="center" valignment="top" usebox="none">
24904 \begin_inset Text
24905
24906 \begin_layout Plain Layout
24907 pdfpages
24908 \end_layout
24909
24910 \end_inset
24911 </cell>
24912 <cell alignment="center" valignment="top" usebox="none">
24913 \begin_inset Text
24914
24915 \begin_layout Plain Layout
24916 shapepar
24917 \end_layout
24918
24919 \end_inset
24920 </cell>
24921 <cell alignment="center" valignment="top" usebox="none">
24922 \begin_inset Text
24923
24924 \begin_layout Plain Layout
24925 tone
24926 \end_layout
24927
24928 \end_inset
24929 </cell>
24930 <cell alignment="center" valignment="top" usebox="none">
24931 \begin_inset Text
24932
24933 \begin_layout Plain Layout
24934 xcolor
24935 \end_layout
24936
24937 \end_inset
24938 </cell>
24939 </row>
24940 <row>
24941 <cell alignment="left" valignment="top" usebox="none">
24942 \begin_inset Text
24943
24944 \begin_layout Plain Layout
24945 amssymb
24946 \end_layout
24947
24948 \end_inset
24949 </cell>
24950 <cell alignment="left" valignment="top" usebox="none">
24951 \begin_inset Text
24952
24953 \begin_layout Plain Layout
24954 covington
24955 \end_layout
24956
24957 \end_inset
24958 </cell>
24959 <cell alignment="left" valignment="top" usebox="none">
24960 \begin_inset Text
24961
24962 \begin_layout Plain Layout
24963 graphicx
24964 \end_layout
24965
24966 \end_inset
24967 </cell>
24968 <cell alignment="left" valignment="top" usebox="none">
24969 \begin_inset Text
24970
24971 \begin_layout Plain Layout
24972 marvosym
24973 \end_layout
24974
24975 \end_inset
24976 </cell>
24977 <cell alignment="center" valignment="top" usebox="none">
24978 \begin_inset Text
24979
24980 \begin_layout Plain Layout
24981 pifont
24982 \end_layout
24983
24984 \end_inset
24985 </cell>
24986 <cell alignment="center" valignment="top" usebox="none">
24987 \begin_inset Text
24988
24989 \begin_layout Plain Layout
24990 slashed
24991 \end_layout
24992
24993 \end_inset
24994 </cell>
24995 <cell alignment="center" valignment="top" usebox="none">
24996 \begin_inset Text
24997
24998 \begin_layout Plain Layout
24999 txfonts
25000 \end_layout
25001
25002 \end_inset
25003 </cell>
25004 <cell alignment="center" valignment="top" usebox="none">
25005 \begin_inset Text
25006
25007 \begin_layout Plain Layout
25008 xy
25009 \end_layout
25010
25011 \end_inset
25012 </cell>
25013 </row>
25014 <row>
25015 <cell alignment="left" valignment="top" usebox="none">
25016 \begin_inset Text
25017
25018 \begin_layout Plain Layout
25019 amstext
25020 \end_layout
25021
25022 \end_inset
25023 </cell>
25024 <cell alignment="left" valignment="top" usebox="none">
25025 \begin_inset Text
25026
25027 \begin_layout Plain Layout
25028 csquotes
25029 \end_layout
25030
25031 \end_inset
25032 </cell>
25033 <cell alignment="left" valignment="top" usebox="none">
25034 \begin_inset Text
25035
25036 \begin_layout Plain Layout
25037 hhline
25038 \end_layout
25039
25040 \end_inset
25041 </cell>
25042 <cell alignment="left" valignment="top" usebox="none">
25043 \begin_inset Text
25044
25045 \begin_layout Plain Layout
25046 mathdesign
25047 \end_layout
25048
25049 \end_inset
25050 </cell>
25051 <cell alignment="center" valignment="top" usebox="none">
25052 \begin_inset Text
25053
25054 \begin_layout Plain Layout
25055 pmboxdraw
25056 \end_layout
25057
25058 \end_inset
25059 </cell>
25060 <cell alignment="center" valignment="top" usebox="none">
25061 \begin_inset Text
25062
25063 \begin_layout Plain Layout
25064 soul
25065 \end_layout
25066
25067 \end_inset
25068 </cell>
25069 <cell alignment="center" valignment="top" usebox="none">
25070 \begin_inset Text
25071
25072 \begin_layout Plain Layout
25073 ulem
25074 \end_layout
25075
25076 \end_inset
25077 </cell>
25078 <cell alignment="center" valignment="top" usebox="none">
25079 \begin_inset Text
25080
25081 \begin_layout Plain Layout
25082 yhmath
25083 \end_layout
25084
25085 \end_inset
25086 </cell>
25087 </row>
25088 <row>
25089 <cell alignment="left" valignment="top" usebox="none">
25090 \begin_inset Text
25091
25092 \begin_layout Plain Layout
25093 amsthm
25094 \end_layout
25095
25096 \end_inset
25097 </cell>
25098 <cell alignment="left" valignment="top" usebox="none">
25099 \begin_inset Text
25100
25101 \begin_layout Plain Layout
25102 dvipost
25103 \end_layout
25104
25105 \end_inset
25106 </cell>
25107 <cell alignment="left" valignment="top" usebox="none">
25108 \begin_inset Text
25109
25110 \begin_layout Plain Layout
25111 hyperref
25112 \end_layout
25113
25114 \end_inset
25115 </cell>
25116 <cell alignment="left" valignment="top" usebox="none">
25117 \begin_inset Text
25118
25119 \begin_layout Plain Layout
25120 mathdots
25121 \end_layout
25122
25123 \end_inset
25124 </cell>
25125 <cell alignment="center" valignment="top" usebox="none">
25126 \begin_inset Text
25127
25128 \begin_layout Plain Layout
25129 polyglossia
25130 \end_layout
25131
25132 \end_inset
25133 </cell>
25134 <cell alignment="center" valignment="top" usebox="none">
25135 \begin_inset Text
25136
25137 \begin_layout Plain Layout
25138 splitidx
25139 \end_layout
25140
25141 \end_inset
25142 </cell>
25143 <cell alignment="center" valignment="top" usebox="none">
25144 \begin_inset Text
25145
25146 \begin_layout Plain Layout
25147 undertilde
25148 \end_layout
25149
25150 \end_inset
25151 </cell>
25152 <cell alignment="center" valignment="top" usebox="none">
25153 \begin_inset Text
25154
25155 \begin_layout Plain Layout
25156
25157 \end_layout
25158
25159 \end_inset
25160 </cell>
25161 </row>
25162 <row>
25163 <cell alignment="left" valignment="top" usebox="none">
25164 \begin_inset Text
25165
25166 \begin_layout Plain Layout
25167 array
25168 \end_layout
25169
25170 \end_inset
25171 </cell>
25172 <cell alignment="left" valignment="top" usebox="none">
25173 \begin_inset Text
25174
25175 \begin_layout Plain Layout
25176 endnotes
25177 \end_layout
25178
25179 \end_inset
25180 </cell>
25181 <cell alignment="left" valignment="top" usebox="none">
25182 \begin_inset Text
25183
25184 \begin_layout Plain Layout
25185 ifsym
25186 \end_layout
25187
25188 \end_inset
25189 </cell>
25190 <cell alignment="left" valignment="top" usebox="none">
25191 \begin_inset Text
25192
25193 \begin_layout Plain Layout
25194 mathrsfs
25195 \end_layout
25196
25197 \end_inset
25198 </cell>
25199 <cell alignment="center" valignment="top" usebox="none">
25200 \begin_inset Text
25201
25202 \begin_layout Plain Layout
25203 prettyref
25204 \end_layout
25205
25206 \end_inset
25207 </cell>
25208 <cell alignment="center" valignment="top" usebox="none">
25209 \begin_inset Text
25210
25211 \begin_layout Plain Layout
25212 subfig
25213 \end_layout
25214
25215 \end_inset
25216 </cell>
25217 <cell alignment="center" valignment="top" usebox="none">
25218 \begin_inset Text
25219
25220 \begin_layout Plain Layout
25221 units
25222 \end_layout
25223
25224 \end_inset
25225 </cell>
25226 <cell alignment="center" valignment="top" usebox="none">
25227 \begin_inset Text
25228
25229 \begin_layout Plain Layout
25230
25231 \end_layout
25232
25233 \end_inset
25234 </cell>
25235 </row>
25236 <row>
25237 <cell alignment="left" valignment="top" usebox="none">
25238 \begin_inset Text
25239
25240 \begin_layout Plain Layout
25241 ascii
25242 \end_layout
25243
25244 \end_inset
25245 </cell>
25246 <cell alignment="left" valignment="top" usebox="none">
25247 \begin_inset Text
25248
25249 \begin_layout Plain Layout
25250 enumitem
25251 \end_layout
25252
25253 \end_inset
25254 </cell>
25255 <cell alignment="left" valignment="top" usebox="none">
25256 \begin_inset Text
25257
25258 \begin_layout Plain Layout
25259 ifthen
25260 \end_layout
25261
25262 \end_inset
25263 </cell>
25264 <cell alignment="left" valignment="top" usebox="none">
25265 \begin_inset Text
25266
25267 \begin_layout Plain Layout
25268 mhchem
25269 \end_layout
25270
25271 \end_inset
25272 </cell>
25273 <cell alignment="center" valignment="top" usebox="none">
25274 \begin_inset Text
25275
25276 \begin_layout Plain Layout
25277 pxfonts
25278 \end_layout
25279
25280 \end_inset
25281 </cell>
25282 <cell alignment="center" valignment="top" usebox="none">
25283 \begin_inset Text
25284
25285 \begin_layout Plain Layout
25286 subscript
25287 \end_layout
25288
25289 \end_inset
25290 </cell>
25291 <cell alignment="center" valignment="top" usebox="none">
25292 \begin_inset Text
25293
25294 \begin_layout Plain Layout
25295 url
25296 \end_layout
25297
25298 \end_inset
25299 </cell>
25300 <cell alignment="center" valignment="top" usebox="none">
25301 \begin_inset Text
25302
25303 \begin_layout Plain Layout
25304
25305 \end_layout
25306
25307 \end_inset
25308 </cell>
25309 </row>
25310 <row>
25311 <cell alignment="left" valignment="top" usebox="none">
25312 \begin_inset Text
25313
25314 \begin_layout Plain Layout
25315 bbding
25316 \end_layout
25317
25318 \end_inset
25319 </cell>
25320 <cell alignment="left" valignment="top" usebox="none">
25321 \begin_inset Text
25322
25323 \begin_layout Plain Layout
25324 esint
25325 \end_layout
25326
25327 \end_inset
25328 </cell>
25329 <cell alignment="left" valignment="top" usebox="none">
25330 \begin_inset Text
25331
25332 \begin_layout Plain Layout
25333 jurabib
25334 \end_layout
25335
25336 \end_inset
25337 </cell>
25338 <cell alignment="left" valignment="top" usebox="none">
25339 \begin_inset Text
25340
25341 \begin_layout Plain Layout
25342 multicol
25343 \end_layout
25344
25345 \end_inset
25346 </cell>
25347 <cell alignment="center" valignment="top" usebox="none">
25348 \begin_inset Text
25349
25350 \begin_layout Plain Layout
25351 refstyle
25352 \end_layout
25353
25354 \end_inset
25355 </cell>
25356 <cell alignment="center" valignment="top" usebox="none">
25357 \begin_inset Text
25358
25359 \begin_layout Plain Layout
25360 textcomp
25361 \end_layout
25362
25363 \end_inset
25364 </cell>
25365 <cell alignment="center" valignment="top" usebox="none">
25366 \begin_inset Text
25367
25368 \begin_layout Plain Layout
25369 varioref
25370 \end_layout
25371
25372 \end_inset
25373 </cell>
25374 <cell alignment="center" valignment="top" usebox="none">
25375 \begin_inset Text
25376
25377 \begin_layout Plain Layout
25378
25379 \end_layout
25380
25381 \end_inset
25382 </cell>
25383 </row>
25384 <row>
25385 <cell alignment="center" valignment="top" usebox="none">
25386 \begin_inset Text
25387
25388 \begin_layout Plain Layout
25389 bm
25390 \end_layout
25391
25392 \end_inset
25393 </cell>
25394 <cell alignment="center" valignment="top" usebox="none">
25395 \begin_inset Text
25396
25397 \begin_layout Plain Layout
25398 fancybox
25399 \end_layout
25400
25401 \end_inset
25402 </cell>
25403 <cell alignment="center" valignment="top" usebox="none">
25404 \begin_inset Text
25405
25406 \begin_layout Plain Layout
25407 latexsym
25408 \end_layout
25409
25410 \end_inset
25411 </cell>
25412 <cell alignment="center" valignment="top" usebox="none">
25413 \begin_inset Text
25414
25415 \begin_layout Plain Layout
25416 multirow
25417 \end_layout
25418
25419 \end_inset
25420 </cell>
25421 <cell alignment="center" valignment="top" usebox="none">
25422 \begin_inset Text
25423
25424 \begin_layout Plain Layout
25425 rotating
25426 \end_layout
25427
25428 \end_inset
25429 </cell>
25430 <cell alignment="center" valignment="top" usebox="none">
25431 \begin_inset Text
25432
25433 \begin_layout Plain Layout
25434 textgreek
25435 \end_layout
25436
25437 \end_inset
25438 </cell>
25439 <cell alignment="center" valignment="top" usebox="none">
25440 \begin_inset Text
25441
25442 \begin_layout Plain Layout
25443 verbatim
25444 \end_layout
25445
25446 \end_inset
25447 </cell>
25448 <cell alignment="center" valignment="top" usebox="none">
25449 \begin_inset Text
25450
25451 \begin_layout Plain Layout
25452
25453 \end_layout
25454
25455 \end_inset
25456 </cell>
25457 </row>
25458 </lyxtabular>
25459
25460 \end_inset
25461
25462
25463 \end_layout
25464
25465 \begin_layout Chapter
25466 Names of available colors to be used in layouts
25467 \begin_inset CommandInset label
25468 LatexCommand label
25469 name "chap:Names-of-colors"
25470
25471 \end_inset
25472
25473
25474 \end_layout
25475
25476 \begin_layout Standard
25477 The colors listed here are the standard colors and the those that you can
25478  adjust in the \SpecialChar LyX
25479  preferences.
25480 \end_layout
25481
25482 \begin_layout Description
25483 none
25484 \family roman
25485 \series medium
25486 \shape up
25487 \size normal
25488 \emph off
25489 \bar no
25490 \strikeout off
25491 \uuline off
25492 \uwave off
25493 \noun off
25494 \color none
25495  No particular color – clear or default
25496 \end_layout
25497
25498 \begin_layout Description
25499 black
25500 \end_layout
25501
25502 \begin_layout Description
25503 white
25504 \end_layout
25505
25506 \begin_layout Description
25507 red
25508 \end_layout
25509
25510 \begin_layout Description
25511 green
25512 \end_layout
25513
25514 \begin_layout Description
25515 blue
25516 \end_layout
25517
25518 \begin_layout Description
25519 cyan
25520 \end_layout
25521
25522 \begin_layout Description
25523 magenta
25524 \end_layout
25525
25526 \begin_layout Description
25527 yellow
25528 \end_layout
25529
25530 \begin_layout Description
25531 added_space Added space marker color
25532 \end_layout
25533
25534 \begin_layout Description
25535 addedtext Added text color
25536 \end_layout
25537
25538 \begin_layout Description
25539 appendix Appendix marker color
25540 \end_layout
25541
25542 \begin_layout Description
25543 background Background color
25544 \end_layout
25545
25546 \begin_layout Description
25547 bottomarea Bottom area color
25548 \end_layout
25549
25550 \begin_layout Description
25551 branchlabel Label color for branches
25552 \end_layout
25553
25554 \begin_layout Description
25555 buttonbg Color used for bottom background
25556 \end_layout
25557
25558 \begin_layout Description
25559 buttonhoverbg Color used for button background under focus
25560 \end_layout
25561
25562 \begin_layout Description
25563 buttonframe Color for inset button frames
25564 \end_layout
25565
25566 \begin_layout Description
25567 changebar Changebar color
25568 \end_layout
25569
25570 \begin_layout Description
25571 changedtextauthor1 Changed text color author 1
25572 \end_layout
25573
25574 \begin_layout Description
25575 changedtextauthor2 Changed text color author 2
25576 \end_layout
25577
25578 \begin_layout Description
25579 changedtextauthor3 Changed text color author 3
25580 \end_layout
25581
25582 \begin_layout Description
25583 changedtextauthor4 Changed text color author 4
25584 \end_layout
25585
25586 \begin_layout Description
25587 changedtextauthor5 Changed text color author 5
25588 \end_layout
25589
25590 \begin_layout Description
25591 collapsable_inset_frame Collapsable insets framecolor
25592 \end_layout
25593
25594 \begin_layout Description
25595 collapsable_inset_text Collapsable insets text color
25596 \end_layout
25597
25598 \begin_layout Description
25599 command Text color for command insets
25600 \end_layout
25601
25602 \begin_layout Description
25603 commandbg Background color for command insets
25604 \end_layout
25605
25606 \begin_layout Description
25607 commandframe Frame color for command insets
25608 \end_layout
25609
25610 \begin_layout Description
25611 comment color for comments
25612 \end_layout
25613
25614 \begin_layout Description
25615 commentbg Background color of comments
25616 \end_layout
25617
25618 \begin_layout Description
25619 cursor Cursor color
25620 \end_layout
25621
25622 \begin_layout Description
25623 deletedtext Deleted text color
25624 \end_layout
25625
25626 \begin_layout Description
25627 deletedtextmodifier Deleted text modifying color
25628 \end_layout
25629
25630 \begin_layout Description
25631 depthbar Color for the depth bars in the margin
25632 \end_layout
25633
25634 \begin_layout Description
25635 eolmarker End of line marker color
25636 \end_layout
25637
25638 \begin_layout Description
25639 error Color of the \SpecialChar LaTeX
25640  error box
25641 \end_layout
25642
25643 \begin_layout Description
25644 footlabel Label color for footnotes
25645 \end_layout
25646
25647 \begin_layout Description
25648 graphicsbg Graphics inset background color
25649 \end_layout
25650
25651 \begin_layout Description
25652 greyedout Label color for greyedout insets
25653 \end_layout
25654
25655 \begin_layout Description
25656 greyedoutbg Background color of greyedout inset
25657 \end_layout
25658
25659 \begin_layout Description
25660 greyedouttext Color for greyedout inset text
25661 \end_layout
25662
25663 \begin_layout Description
25664 indexlabel Label color for index insets
25665 \end_layout
25666
25667 \begin_layout Description
25668 ignore The color is ignored
25669 \end_layout
25670
25671 \begin_layout Description
25672 inherit The color is inherited
25673 \end_layout
25674
25675 \begin_layout Description
25676 inlinecompletion Inline completion color
25677 \end_layout
25678
25679 \begin_layout Description
25680 insetbg Inset marker background color
25681 \end_layout
25682
25683 \begin_layout Description
25684 insetframe Inset marker frame color
25685 \end_layout
25686
25687 \begin_layout Description
25688 language Color for marking foreign language words
25689 \end_layout
25690
25691 \begin_layout Description
25692 latex Text color in \SpecialChar LaTeX
25693  mode
25694 \end_layout
25695
25696 \begin_layout Description
25697 listingsbg Background color of listings inset
25698 \end_layout
25699
25700 \begin_layout Description
25701 marginlabel Label color for margin notes
25702 \end_layout
25703
25704 \begin_layout Description
25705 math Math inset text color
25706 \end_layout
25707
25708 \begin_layout Description
25709 mathbg Math inset background color
25710 \end_layout
25711
25712 \begin_layout Description
25713 mathcorners Math inset frame color not under focus
25714 \end_layout
25715
25716 \begin_layout Description
25717 mathframe Math inset frame color under focus
25718 \end_layout
25719
25720 \begin_layout Description
25721 mathline Math line color
25722 \end_layout
25723
25724 \begin_layout Description
25725 mathmacrobg Macro math inset background color
25726 \end_layout
25727
25728 \begin_layout Description
25729 mathmacroblend Macro math blended color
25730 \end_layout
25731
25732 \begin_layout Description
25733 mathmacroframe Macro math frame color
25734 \end_layout
25735
25736 \begin_layout Description
25737 mathmacrohoverbg Macro math inset background color hovered
25738 \end_layout
25739
25740 \begin_layout Description
25741 mathmacrolabel Macro math label color
25742 \end_layout
25743
25744 \begin_layout Description
25745 mathmacronewarg Macro template color for new parameters
25746 \end_layout
25747
25748 \begin_layout Description
25749 mathmacrooldarg Macro template color for old parameters
25750 \end_layout
25751
25752 \begin_layout Description
25753 newpage New page color
25754 \end_layout
25755
25756 \begin_layout Description
25757 nonunique_inlinecompletion Inline completion color for the non-unique part
25758 \end_layout
25759
25760 \begin_layout Description
25761 notebg Background color of notes
25762 \end_layout
25763
25764 \begin_layout Description
25765 notelabel Label color for notes
25766 \end_layout
25767
25768 \begin_layout Description
25769 pagebreak Page break/line break color
25770 \end_layout
25771
25772 \begin_layout Description
25773 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
25774 \end_layout
25775
25776 \begin_layout Description
25777 phantomtext Text color for phantom insets
25778 \end_layout
25779
25780 \begin_layout Description
25781 preview The color used for previews
25782 \end_layout
25783
25784 \begin_layout Description
25785 previewframe Preview frame color
25786 \end_layout
25787
25788 \begin_layout Description
25789 regexpframe Color for regexp frame
25790 \end_layout
25791
25792 \begin_layout Description
25793 selection Background color of selected text
25794 \end_layout
25795
25796 \begin_layout Description
25797 selectiontext Foreground color of selected text
25798 \end_layout
25799
25800 \begin_layout Description
25801 shadedbg Background color of shaded box
25802 \end_layout
25803
25804 \begin_layout Description
25805 special Special chars text color
25806 \end_layout
25807
25808 \begin_layout Description
25809 tabularline Table line color
25810 \end_layout
25811
25812 \begin_layout Description
25813 tabularonoffline Table line color
25814 \end_layout
25815
25816 \begin_layout Description
25817 urllabel Label color for URL insets
25818 \end_layout
25819
25820 \begin_layout Description
25821 urltext Color for URL inset text
25822 \end_layout
25823
25824 \end_body
25825 \end_document