lib/doc/Customization.lyx

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