lib/doc/Customization.lyx

   1 #LyX 2.2 created this file. For more info see http://www.lyx.org/
   2 \lyxformat 508
   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 \graphics default
  60 \default_output_format pdf2
  61 \output_sync 0
  62 \bibtex_command default
  63 \index_command default
  64 \paperfontsize 12
  65 \spacing single
  66 \use_hyperref true
  67 \pdf_title "LyX Configuration Manual"
  68 \pdf_author "LyX Team"
  69 \pdf_subject "LyX-documentation Customization"
  70 \pdf_keywords "LyX, documentation, customization"
  71 \pdf_bookmarks true
  72 \pdf_bookmarksnumbered true
  73 \pdf_bookmarksopen true
  74 \pdf_bookmarksopenlevel 1
  75 \pdf_breaklinks false
  76 \pdf_pdfborder false
  77 \pdf_colorlinks true
  78 \pdf_backref false
  79 \pdf_pdfusetitle false
  80 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
  81 \papersize default
  82 \use_geometry false
  83 \use_package amsmath 0
  84 \use_package amssymb 0
  85 \use_package cancel 0
  86 \use_package esint 0
  87 \use_package mathdots 1
  88 \use_package mathtools 0
  89 \use_package mhchem 0
  90 \use_package stackrel 0
  91 \use_package stmaryrd 0
  92 \use_package undertilde 0
  93 \cite_engine basic
  94 \cite_engine_type default
  95 \biblio_style plain
  96 \use_bibtopic false
  97 \use_indices false
  98 \paperorientation portrait
  99 \suppress_date false
 100 \justification true
 101 \use_refstyle 0
 102 \notefontcolor #0000ff
 103 \branch OutDated
 104 \selected 0
 105 \filename_suffix 0
 106 \color #f5fae7
 107 \end_branch
 108 \index Index
 109 \shortcut idx
 110 \color #008000
 111 \end_index
 112 \secnumdepth 3
 113 \tocdepth 3
 114 \paragraph_separation indent
 115 \paragraph_indentation default
 116 \quotes_language english
 117 \papercolumns 1
 118 \papersides 2
 119 \paperpagestyle headings
 120 \tracking_changes true
 121 \output_changes false
 122 \html_math_output 0
 123 \html_css_as_file 0
 124 \html_be_strict true
 125 \author -712698321 "Jürgen Spitzmüller"
 126 \author 2089657418 "Usti"
 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 \end_layout
6031
6032 \begin_deeper
6033 \begin_layout Enumerate
6034 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6035  for all users on your system, then install it in your `local' \SpecialChar TeX
6036  tree, otherwise
6037  install it in your own `user' \SpecialChar TeX
6038  tree.
6039  Where these trees should be created, if they do not already exist, depends
6040  on your system.
6041  To find this out, look in the file
6042 \begin_inset Flex Code
6043 status collapsed
6044
6045 \begin_layout Plain Layout
6046 texmf.cnf
6047 \end_layout
6048
6049 \end_inset
6050
6051 .
6052 \begin_inset Foot
6053 status collapsed
6054
6055 \begin_layout Plain Layout
6056 This is usually in the directory
6057 \begin_inset Flex Code
6058 status collapsed
6059
6060 \begin_layout Plain Layout
6061 $TEXMF/web2c
6062 \end_layout
6063
6064 \end_inset
6065
6066 , though you can execute the command
6067 \begin_inset Flex Code
6068 status collapsed
6069
6070 \begin_layout Plain Layout
6071 kpsewhich texmf.cnf
6072 \end_layout
6073
6074 \end_inset
6075
6076  to locate it.
6077 \end_layout
6078
6079 \end_inset
6080
6081  The location of the `local' \SpecialChar TeX
6082  tree is defined by the
6083 \begin_inset Flex Code
6084 status collapsed
6085
6086 \begin_layout Plain Layout
6087 TEXMFLOCAL
6088 \end_layout
6089
6090 \end_inset
6091
6092  variable; this is usually somewhere like
6093 \begin_inset Flex Code
6094 status collapsed
6095
6096 \begin_layout Plain Layout
6097 /usr/local/share/texmf
6098 \end_layout
6099
6100 \end_inset
6101
6102  or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6103 Live
6104  distribution.
6105  The location of the `user' \SpecialChar TeX
6106  tree is defined by
6107 \begin_inset Flex Code
6108 status collapsed
6109
6110 \begin_layout Plain Layout
6111 TEXMFHOME
6112 \end_layout
6113
6114 \end_inset
6115
6116  and is commonly
6117 \begin_inset Flex Code
6118 status collapsed
6119
6120 \begin_layout Plain Layout
6121 $HOME/texmf
6122 \end_layout
6123
6124 \end_inset
6125
6126  or
6127 \begin_inset Flex Code
6128 status collapsed
6129
6130 \begin_layout Plain Layout
6131
6132 \family sans
6133 \lang french
6134 $HOME/.texliveXXXX
6135 \end_layout
6136
6137 \end_inset
6138
6139 .
6140  (If these variables are not predefined, you have to define them.) You'll
6141  probably need root permissions to create or modify the `local' tree, but
6142  not for your `user' tree.
6143 \begin_inset Newline newline
6144 \end_inset
6145
6146 In general, it is recommended to install in the user tree because your user
6147  will not be modified or even overwritten when you upgrade your system.
6148  It will typically also be backed up together with everything else when
6149  you backup your home directory (which, of course, you do on a regular basis).
6150 \end_layout
6151
6152 \begin_layout Enumerate
6153 On Windows, if you want the new package to be available for all users on
6154  your system, change to the folder where \SpecialChar LaTeX
6155  is installed and then change to
6156  the subfolder
6157 \begin_inset Flex Code
6158 status collapsed
6159
6160 \begin_layout Plain Layout
6161 ~
6162 \backslash
6163 tex
6164 \backslash
6165 latex
6166 \end_layout
6167
6168 \end_inset
6169
6170 .
6171  (For MiK\SpecialChar TeX
6172 , this would be by default the folder
6173 \begin_inset Flex Code
6174 status collapsed
6175
6176 \begin_layout Plain Layout
6177 ~:
6178 \backslash
6179 Programs
6180 \backslash
6181 MiKTeX
6182 \backslash
6183 tex
6184 \backslash
6185 latex
6186 \end_layout
6187
6188 \end_inset
6189
6190 .)
6191 \begin_inset Foot
6192 status collapsed
6193
6194 \begin_layout Plain Layout
6195 Note that this will be the correct path only on English installations.
6196  On a German one, it would be
6197 \begin_inset Flex Code
6198 status collapsed
6199
6200 \begin_layout Plain Layout
6201 ~:
6202 \backslash
6203 Programme
6204 \backslash
6205 MiKTeX
6206 \backslash
6207 tex
6208 \backslash
6209 latex
6210 \end_layout
6211
6212 \end_inset
6213
6214 , and similarly for other languages.
6215 \end_layout
6216
6217 \end_inset
6218
6219  Create there a new folder
6220 \begin_inset Flex Code
6221 status collapsed
6222
6223 \begin_layout Plain Layout
6224 foiltex
6225 \end_layout
6226
6227 \end_inset
6228
6229  and copy all files of the package into it.
6230
6231 \begin_inset Newline newline
6232 \end_inset
6233
6234 If the package should only available for you or you don't have admin permissions
6235 , do the same, but in the local \SpecialChar LaTeX
6236  folder.
6237  E.
6238 \begin_inset space \thinspace{}
6239 \end_inset
6240
6241 g., for MiK\SpecialChar TeX
6242
6243 \begin_inset space ~
6244 \end_inset
6245
6246 2.8 under Windows XP, this would be the folder:
6247 \begin_inset Newline newline
6248 \end_inset
6249
6250
6251 \family sans
6252
6253 \begin_inset Flex Code
6254 status collapsed
6255
6256 \begin_layout Plain Layout
6257 ~:
6258 \backslash
6259 Documents and Settings
6260 \backslash
6261 <username>
6262 \backslash
6263 Application Data
6264 \backslash
6265
6266 \end_layout
6267
6268 \end_inset
6269
6270
6271 \begin_inset Newline newline
6272 \end_inset
6273
6274
6275 \family default
6276
6277 \begin_inset Phantom HPhantom
6278 status open
6279
6280 \begin_layout Plain Layout
6281
6282 \family sans
6283 ~:
6284 \backslash
6285
6286 \end_layout
6287
6288 \end_inset
6289
6290
6291 \begin_inset Flex Code
6292 status collapsed
6293
6294 \begin_layout Plain Layout
6295 MiKTeX
6296 \backslash
6297 2.8
6298 \backslash
6299 tex
6300 \backslash
6301 latex
6302 \end_layout
6303
6304 \end_inset
6305
6306
6307 \begin_inset Newline newline
6308 \end_inset
6309
6310 On Vista, it would be:
6311 \begin_inset Newline newline
6312 \end_inset
6313
6314
6315 \begin_inset Flex Code
6316 status collapsed
6317
6318 \begin_layout Plain Layout
6319 ~:
6320 \backslash
6321 Users
6322 \backslash
6323 <username>
6324 \backslash
6325 AppData
6326 \backslash
6327 Roaming
6328 \backslash
6329 2.8
6330 \backslash
6331 MiKTeX
6332 \backslash
6333 tex
6334 \backslash
6335 latex
6336 \end_layout
6337
6338 \end_inset
6339
6340
6341 \end_layout
6342
6343 \end_deeper
6344 \begin_layout Enumerate
6345 Now one only need to tell \SpecialChar LaTeX
6346  that there are new files.
6347  This depends on the used \SpecialChar LaTeX
6348 -Distribution:
6349 \end_layout
6350
6351 \begin_deeper
6352 \begin_layout Enumerate
6353 For \SpecialChar TeX
6354 Live execute the command
6355 \begin_inset Flex Code
6356 status collapsed
6357
6358 \begin_layout Plain Layout
6359 texhash
6360 \end_layout
6361
6362 \end_inset
6363
6364  from a console.
6365  If you installed the package for all users, then you will probably need
6366  to have root permissions for that.
6367 \end_layout
6368
6369 \begin_layout Enumerate
6370 For MiK\SpecialChar TeX
6371 , if you have installed the package for all users, start the program
6372
6373 \begin_inset Quotes eld
6374 \end_inset
6375
6376 Settings
6377 \begin_inset space ~
6378 \end_inset
6379
6380 (Admin)
6381 \begin_inset Quotes erd
6382 \end_inset
6383
6384  and press the button marked
6385 \begin_inset Quotes eld
6386 \end_inset
6387
6388 Refresh FNDB
6389 \begin_inset Quotes erd
6390 \end_inset
6391
6392 .
6393  Otherwise start the program
6394 \begin_inset Quotes eld
6395 \end_inset
6396
6397 Settings
6398 \begin_inset Quotes erd
6399 \end_inset
6400
6401  and do the same.
6402 \end_layout
6403
6404 \end_deeper
6405 \begin_layout Enumerate
6406 Finally, you need to tell \SpecialChar LyX
6407  that there are new packages available.
6408  So, in \SpecialChar LyX
6409 , use the menu
6410 \begin_inset Flex Noun
6411 status collapsed
6412
6413 \begin_layout Plain Layout
6414 Tools
6415 \family sans
6416 \SpecialChar menuseparator
6417 Reconfigure
6418 \end_layout
6419
6420 \end_inset
6421
6422  and then restart \SpecialChar LyX
6423 .
6424 \end_layout
6425
6426 \begin_layout Standard
6427 Now the package is installed.
6428  In our example, the document class
6429 \begin_inset Flex Code
6430 status collapsed
6431
6432 \begin_layout Plain Layout
6433 Slides
6434 \begin_inset space ~
6435 \end_inset
6436
6437 (FoilTex)
6438 \end_layout
6439
6440 \end_inset
6441
6442  will now be available under
6443 \begin_inset Flex Noun
6444 status collapsed
6445
6446 \begin_layout Plain Layout
6447 Document\SpecialChar menuseparator
6448 Settings\SpecialChar menuseparator
6449 Document Class
6450 \end_layout
6451
6452 \end_inset
6453
6454 .
6455
6456 \end_layout
6457
6458 \begin_layout Standard
6459 If you would like to use a \SpecialChar LaTeX
6460  document class that is not even listed in the
6461  menu
6462 \begin_inset Flex Noun
6463 status collapsed
6464
6465 \begin_layout Plain Layout
6466 Document\SpecialChar menuseparator
6467 Settings\SpecialChar menuseparator
6468 Document Class
6469 \end_layout
6470
6471 \end_inset
6472
6473 , then you need to create a `layout' file for it.
6474  That is the topic of the next section.
6475 \end_layout
6476
6477 \begin_layout Section
6478 Types of layout files
6479 \end_layout
6480
6481 \begin_layout Standard
6482 This section describes the various sorts of \SpecialChar LyX
6483  files that contain layout informati
6484 on.
6485  These files describe various paragraph and character styles, determining
6486  how \SpecialChar LyX
6487  should display them and how they should be translated into \SpecialChar LaTeX
6488 , DocBook,
6489  XHTML, or whatever output format is being used.
6490
6491 \end_layout
6492
6493 \begin_layout Standard
6494 We shall try to provide a thorough description of the process of writing
6495  layout files here.
6496  However, there are so many different types of documents supported even
6497  by just \SpecialChar LaTeX
6498  that we can't hope to cover every different possibility or problem
6499  you might encounter.
6500  The \SpecialChar LyX
6501  users' list is frequented by people with lots of experience with layout
6502  design who are willing to share what they've learned, so please feel free
6503  to ask questions there.
6504 \end_layout
6505
6506 \begin_layout Standard
6507 As you prepare to write a new layout, it is extremely helpful to look at
6508  the layouts distributed with \SpecialChar LyX
6509 .
6510  If you write a \SpecialChar LyX
6511  layout for a \SpecialChar LaTeX
6512  document class that might also be used by
6513  others, or write a module that might be useful to others, then you should
6514  consider posting your layout to the
6515 \begin_inset CommandInset href
6516 LatexCommand href
6517 name "layout section on the LyX wiki"
6518 target "http://wiki.lyx.org/Layouts/Layouts"
6519
6520 \end_inset
6521
6522  or even to the \SpecialChar LyX
6523  developers' list, so that it might be included in \SpecialChar LyX
6524  itself.
6525 \begin_inset Foot
6526 status collapsed
6527
6528 \begin_layout Plain Layout
6529 Note that \SpecialChar LyX
6530  is licensed under the General Public License, so any material
6531  that is contributed to \SpecialChar LyX
6532  must be similarly licensed.
6533 \end_layout
6534
6535 \end_inset
6536
6537
6538 \end_layout
6539
6540 \begin_layout Subsection
6541 Layout modules
6542 \begin_inset CommandInset label
6543 LatexCommand label
6544 name "subsec:Layout-modules"
6545
6546 \end_inset
6547
6548
6549 \end_layout
6550
6551 \begin_layout Standard
6552 We have spoken to this point about `layout files'.
6553  But there are different sorts of files that contain layout information.
6554  Layout files, strictly so called, have the
6555 \begin_inset Flex Code
6556 status collapsed
6557
6558 \begin_layout Plain Layout
6559 .layout
6560 \end_layout
6561
6562 \end_inset
6563
6564  extension and provide \SpecialChar LyX
6565  with information about document classes.
6566  Since \SpecialChar LyX
6567  1.6 layout information can also be contained in layout
6568 \emph on
6569 modules
6570 \emph default
6571 , which have the
6572 \begin_inset Flex Code
6573 status collapsed
6574
6575 \begin_layout Plain Layout
6576 .module
6577 \end_layout
6578
6579 \end_inset
6580
6581  extension.
6582  Modules are to \SpecialChar LaTeX
6583  packages much as layouts are to \SpecialChar LaTeX
6584  classes, and some modules—such
6585  as the
6586 \begin_inset Flex Code
6587 status collapsed
6588
6589 \begin_layout Plain Layout
6590 endnotes
6591 \end_layout
6592
6593 \end_inset
6594
6595  module—specifically provide support for one package.
6596  In a sense, layout modules are similar to included
6597 \begin_inset Foot
6598 status collapsed
6599
6600 \begin_layout Plain Layout
6601 These can have any extension, but by convention have the
6602 \begin_inset Flex Code
6603 status collapsed
6604
6605 \begin_layout Plain Layout
6606 .inc
6607 \end_layout
6608
6609 \end_inset
6610
6611  extension.
6612 \end_layout
6613
6614 \end_inset
6615
6616  files—files like
6617 \begin_inset Flex Code
6618 status collapsed
6619
6620 \begin_layout Plain Layout
6621 stdsections.inc
6622 \end_layout
6623
6624 \end_inset
6625
6626 —in that modules are not specific to a given document class but may be used
6627  with many different classes.
6628  The difference is that using an included file with
6629 \begin_inset Flex Code
6630 status collapsed
6631
6632 \begin_layout Plain Layout
6633 article.cls
6634 \end_layout
6635
6636 \end_inset
6637
6638  requires editing that file.
6639  Modules, by contrast, are selected in the
6640 \begin_inset Flex Noun
6641 status collapsed
6642
6643 \begin_layout Plain Layout
6644 Document\SpecialChar menuseparator
6645 Settings
6646 \end_layout
6647
6648 \end_inset
6649
6650  dialog.
6651 \end_layout
6652
6653 \begin_layout Standard
6654 Building modules is the easiest way to get started with layout editing,
6655  since it can be as simple as adding a single new paragraph style or flex
6656  inset.
6657  But modules may, in principle, contain anything a layout file can contain.
6658 \end_layout
6659
6660 \begin_layout Standard
6661 After creating a new module and copying it to the
6662 \begin_inset Flex Code
6663 status collapsed
6664
6665 \begin_layout Plain Layout
6666 layouts/
6667 \end_layout
6668
6669 \end_inset
6670
6671  folder, you will need to reconfigure and then restart \SpecialChar LyX
6672  for the module to
6673  appear in the menu.
6674  However, changes you make to the module will be seen immediately, if you
6675  open
6676 \begin_inset Flex Noun
6677 status collapsed
6678
6679 \begin_layout Plain Layout
6680 Document\SpecialChar menuseparator
6681 Settings
6682 \end_layout
6683
6684 \end_inset
6685
6686 , highlight something, and then hit
6687 \begin_inset Quotes eld
6688 \end_inset
6689
6690 OK
6691 \begin_inset Quotes erd
6692 \end_inset
6693
6694 .
6695
6696 \emph on
6697 It is strongly recommended that you save your work before doing this
6698 \emph default
6699 .
6700  In fact,
6701 \emph on
6702 it is strongly recommended that you not attempt to edit modules while simultaneo
6703 usly working on actual documents
6704 \emph default
6705 .
6706  Though of course the developers strive to keep \SpecialChar LyX
6707  stable in such situations,
6708  syntax errors and the like in your module file could cause strange behavior.
6709 \end_layout
6710
6711 \begin_layout Subsubsection
6712 Local Layout
6713 \end_layout
6714
6715 \begin_layout Standard
6716 Modules are to \SpecialChar LyX
6717  as packages are to \SpecialChar LaTeX
6718 .
6719  Sometimes, however, you find yourself wanting a specific inset or character
6720  style just for one document and writing a module that will also be available
6721  to other documents makes little sense.
6722  What you need is \SpecialChar LyX
6723 's
6724 \begin_inset Quotes eld
6725 \end_inset
6726
6727 Local Layout
6728 \begin_inset Quotes erd
6729 \end_inset
6730
6731 .
6732 \end_layout
6733
6734 \begin_layout Standard
6735 You will find it under
6736 \family sans
6737 Document\SpecialChar menuseparator
6738 Settings\SpecialChar menuseparator
6739 Local Layout
6740 \family default
6741 .
6742  The large text box allows you to enter anything that you might enter in
6743  a layout file or module.
6744  You can think of a document's local layout, in fact, as a module that belongs
6745  just to it.
6746  So, in particular, you must enter a
6747 \begin_inset Flex Code
6748 status collapsed
6749
6750 \begin_layout Plain Layout
6751 Format
6752 \end_layout
6753
6754 \end_inset
6755
6756  tag.
6757  Any format is acceptable, but one would normally use the format current
6758  at the time.
6759  (In \SpecialChar LyX
6760  2.2, the current layout format is 60.)
6761 \end_layout
6762
6763 \begin_layout Standard
6764 When you have entered something in the
6765 \begin_inset Flex Code
6766 status collapsed
6767
6768 \begin_layout Plain Layout
6769 Local Layout
6770 \end_layout
6771
6772 \end_inset
6773
6774  pane, \SpecialChar LyX
6775  will enable the
6776 \begin_inset Quotes eld
6777 \end_inset
6778
6779 Validate
6780 \begin_inset Quotes erd
6781 \end_inset
6782
6783  button at the bottom.
6784  Clicking this button will cause \SpecialChar LyX
6785  to determine whether what you have entered
6786  is valid layout information for the chosen format.
6787  \SpecialChar LyX
6788  will report the result but, unfortunately, will not tell you what errors
6789  there might have been.
6790  These will be written to the terminal, however, if \SpecialChar LyX
6791  is started from a terminal.
6792  You will not be permitted to save your local layout until you have entered
6793  something valid.
6794 \end_layout
6795
6796 \begin_layout Standard
6797 The warnings at the end of the previous section apply here, too.
6798  Do not play with local layout while you are actually working, especially
6799  if you have not saved your document.
6800  That said, using local layout with a test document can be a very convenient
6801  way to try out layout ideas, or even to start developing a module.
6802 \end_layout
6803
6804 \begin_layout Subsection
6805 Layout for
6806 \begin_inset Flex Noun
6807 status collapsed
6808
6809 \begin_layout Plain Layout
6810 .sty
6811 \end_layout
6812
6813 \end_inset
6814
6815  files
6816 \end_layout
6817
6818 \begin_layout Standard
6819 There are two situations you are likely to encounter when wanting to support
6820  a new \SpecialChar LaTeX
6821  document class, involving style (
6822 \begin_inset Flex Code
6823 status collapsed
6824
6825 \begin_layout Plain Layout
6826 .sty
6827 \end_layout
6828
6829 \end_inset
6830
6831 ) files and \SpecialChar LaTeX2e
6832  class (
6833 \begin_inset Flex Code
6834 status collapsed
6835
6836 \begin_layout Plain Layout
6837 .cls
6838 \end_layout
6839
6840 \end_inset
6841
6842 ) .
6843  Supporting a style file is usually fairly easy.
6844  Supporting a new class file is a bit harder.
6845  We'll discuss the former in this section and the latter in the next.
6846  Similar remarks apply, of course, if you want to support a new DocBook
6847  DTD.
6848 \end_layout
6849
6850 \begin_layout Standard
6851 The easier case is the one in which your new document class is provided
6852  as a style file that is to be used in conjunction with an already supported
6853  document class.
6854  For the sake of the example, we'll assume that the style file is called
6855
6856 \begin_inset Flex Noun
6857 status collapsed
6858
6859 \begin_layout Plain Layout
6860 myclass.sty
6861 \end_layout
6862
6863 \end_inset
6864
6865  and that it is meant to be used with
6866 \begin_inset Flex Noun
6867 status collapsed
6868
6869 \begin_layout Plain Layout
6870 report.cls
6871 \end_layout
6872
6873 \end_inset
6874
6875 , which is a standard class.
6876
6877 \end_layout
6878
6879 \begin_layout Standard
6880 Start by copying the existing class's layout file into your local directory:
6881 \begin_inset Foot
6882 status collapsed
6883
6884 \begin_layout Plain Layout
6885 Of course, which directory is your local directory will vary by platform,
6886  and \SpecialChar LyX
6887  allows you to specify your local directory on startup, too, using
6888  the
6889 \begin_inset Flex Code
6890 status collapsed
6891
6892 \begin_layout Plain Layout
6893 -userdir
6894 \end_layout
6895
6896 \end_inset
6897
6898  option.
6899 \end_layout
6900
6901 \end_inset
6902
6903
6904 \end_layout
6905
6906 \begin_layout LyX-Code
6907 cp report.layout ~/.lyx/layouts/myclass.layout
6908 \end_layout
6909
6910 \begin_layout Standard
6911 Then edit
6912 \begin_inset Flex Code
6913 status collapsed
6914
6915 \begin_layout Plain Layout
6916 myclass.layout
6917 \end_layout
6918
6919 \end_inset
6920
6921  and change the line:
6922 \end_layout
6923
6924 \begin_layout LyX-Code
6925
6926 \backslash
6927 DeclareLaTeXClass{report}
6928 \end_layout
6929
6930 \begin_layout Standard
6931 to read
6932 \end_layout
6933
6934 \begin_layout LyX-Code
6935
6936 \backslash
6937 DeclareLaTeXClass[report, myclass.sty]{report (myclass)}
6938 \end_layout
6939
6940 \begin_layout Standard
6941 Then add:
6942 \end_layout
6943
6944 \begin_layout LyX-Code
6945 Preamble
6946 \begin_inset Newline newline
6947 \end_inset
6948
6949
6950 \backslash
6951 usepackage{myclass}
6952 \begin_inset Newline newline
6953 \end_inset
6954
6955 EndPreamble
6956 \end_layout
6957
6958 \begin_layout Standard
6959 near the top of the file.
6960 \end_layout
6961
6962 \begin_layout Standard
6963 Start \SpecialChar LyX
6964  and select
6965 \begin_inset Flex Noun
6966 status collapsed
6967
6968 \begin_layout Plain Layout
6969 Tools\SpecialChar menuseparator
6970 Reconfigure
6971 \end_layout
6972
6973 \end_inset
6974
6975 .
6976  Then restart \SpecialChar LyX
6977  and try creating a new document.
6978  You should see "
6979 \begin_inset Flex Noun
6980 status collapsed
6981
6982 \begin_layout Plain Layout
6983 report (myclass)
6984 \end_layout
6985
6986 \end_inset
6987
6988 " as a document class option in the
6989 \begin_inset Flex Noun
6990 status collapsed
6991
6992 \begin_layout Plain Layout
6993 Document\SpecialChar menuseparator
6994 Settings
6995 \end_layout
6996
6997 \end_inset
6998
6999  dialog.
7000  It is likely that some of the sectioning commands and such in your new
7001  class will work differently from how they worked in the base class—
7002 \begin_inset Flex Code
7003 status collapsed
7004
7005 \begin_layout Plain Layout
7006 report
7007 \end_layout
7008
7009 \end_inset
7010
7011  in this example—so you can fiddle around with the settings for the different
7012  sections if you wish.
7013  The layout information for sections is contained in
7014 \begin_inset Flex Code
7015 status collapsed
7016
7017 \begin_layout Plain Layout
7018 stdsections.inc
7019 \end_layout
7020
7021 \end_inset
7022
7023 , but you do not need to copy and change this file.
7024  Instead, you can simply add your changes to your layout file, after the
7025  line
7026 \begin_inset Flex Code
7027 status collapsed
7028
7029 \begin_layout Plain Layout
7030 Input stdclass.inc
7031 \end_layout
7032
7033 \end_inset
7034
7035 , which itself includes
7036 \begin_inset Flex Code
7037 status collapsed
7038
7039 \begin_layout Plain Layout
7040 stdsections.inc
7041 \end_layout
7042
7043 \end_inset
7044
7045 .
7046  For example, you might add these lines:
7047 \end_layout
7048
7049 \begin_layout LyX-Code
7050 Style Chapter
7051 \end_layout
7052
7053 \begin_layout LyX-Code
7054     Font
7055 \end_layout
7056
7057 \begin_layout LyX-Code
7058         Family Sans
7059 \end_layout
7060
7061 \begin_layout LyX-Code
7062     EndFont
7063 \end_layout
7064
7065 \begin_layout LyX-Code
7066 End
7067 \end_layout
7068
7069 \begin_layout Standard
7070 to change the font for chapter headings to sans-serif.
7071  This will override (or, in this case, add to) the existing declaration
7072  for the Chapter style.
7073
7074 \end_layout
7075
7076 \begin_layout Standard
7077 Your new package may also provide commands or environments not present in
7078  the base class.
7079  In this case, you will want to add these to the layout file.
7080  See
7081 \begin_inset CommandInset ref
7082 LatexCommand ref
7083 reference "sec:TextClass"
7084
7085 \end_inset
7086
7087  for information on how to do so.
7088 \end_layout
7089
7090 \begin_layout Standard
7091 If
7092 \begin_inset Flex Noun
7093 status collapsed
7094
7095 \begin_layout Plain Layout
7096 myclass.sty
7097 \end_layout
7098
7099 \end_inset
7100
7101  can be used with several different document classes, and even if it cannot,
7102  you might find it easiest just to write a module that you can load with
7103  the base class.
7104  The simplest possible such module would be:
7105 \end_layout
7106
7107 \begin_layout LyX-Code
7108 #
7109 \backslash
7110 DeclareLyXModule{My Package}
7111 \end_layout
7112
7113 \begin_layout LyX-Code
7114 #DescriptionBegin
7115 \end_layout
7116
7117 \begin_layout LyX-Code
7118 #Support for mypkg.sty.
7119 \end_layout
7120
7121 \begin_layout LyX-Code
7122 #DescriptionEnd
7123 \begin_inset Newline newline
7124 \end_inset
7125
7126
7127 \end_layout
7128
7129 \begin_layout LyX-Code
7130 Format 60
7131 \begin_inset Newline newline
7132 \end_inset
7133
7134
7135 \end_layout
7136
7137 \begin_layout LyX-Code
7138 Preamble
7139 \begin_inset Newline newline
7140 \end_inset
7141
7142
7143 \backslash
7144 usepackage{mypkg}
7145 \begin_inset Newline newline
7146 \end_inset
7147
7148 EndPreamble
7149 \end_layout
7150
7151 \begin_layout Standard
7152 A more complex module might modify the behavior of some existing constructs
7153  or define some new ones.
7154  Again, see
7155 \begin_inset CommandInset ref
7156 LatexCommand ref
7157 reference "sec:TextClass"
7158
7159 \end_inset
7160
7161  for discussion.
7162 \end_layout
7163
7164 \begin_layout Subsection
7165 Layout for
7166 \begin_inset Flex Noun
7167 status collapsed
7168
7169 \begin_layout Plain Layout
7170 .cls
7171 \end_layout
7172
7173 \end_inset
7174
7175  files
7176 \end_layout
7177
7178 \begin_layout Standard
7179 There are two possibilities here.
7180  One is that the class file is itself based upon an existing document class.
7181  For example, many thesis classes are based upon
7182 \begin_inset Flex Noun
7183 status collapsed
7184
7185 \begin_layout Plain Layout
7186 book.cls
7187 \end_layout
7188
7189 \end_inset
7190
7191 .
7192  To see whether yours is, look for a line like
7193 \end_layout
7194
7195 \begin_layout LyX-Code
7196
7197 \backslash
7198 LoadClass{book}
7199 \end_layout
7200
7201 \begin_layout Standard
7202 in the file.
7203  If so, then you may proceed largely as in the previous section, though
7204  the
7205 \begin_inset Flex Code
7206 status collapsed
7207
7208 \begin_layout Plain Layout
7209 Declare\SpecialChar LaTeX
7210 Class
7211 \end_layout
7212
7213 \end_inset
7214
7215  line will be different.
7216  If your new class is
7217 \begin_inset Flex Code
7218 status collapsed
7219
7220 \begin_layout Plain Layout
7221 thesis
7222 \end_layout
7223
7224 \end_inset
7225
7226  and it is based upon
7227 \begin_inset Flex Code
7228 status collapsed
7229
7230 \begin_layout Plain Layout
7231 book
7232 \end_layout
7233
7234 \end_inset
7235
7236 , then the line should read:
7237 \begin_inset Foot
7238 status collapsed
7239
7240 \begin_layout Plain Layout
7241 And it will be easiest if you save the file to
7242 \begin_inset Flex Code
7243 status collapsed
7244
7245 \begin_layout Plain Layout
7246 thesis.layout
7247 \end_layout
7248
7249 \end_inset
7250
7251 : \SpecialChar LyX
7252  assumes that the document class has the same name as the layout file.
7253
7254 \end_layout
7255
7256 \end_inset
7257
7258
7259 \end_layout
7260
7261 \begin_layout LyX-Code
7262
7263 \backslash
7264 DeclareLaTeXClass[thesis,book]{thesis}
7265 \end_layout
7266
7267 \begin_layout Standard
7268 If, on the other hand, the new class is not based upon an existing class,
7269  you will probably have to
7270 \begin_inset Quotes eld
7271 \end_inset
7272
7273 roll your own
7274 \begin_inset Quotes erd
7275 \end_inset
7276
7277  layout.
7278  We strongly suggest copying an existing layout file which uses a similar
7279  \SpecialChar LaTeX
7280  class and then modifying it, if you can do so.
7281  At least use an existing file as a starting point so you can find out what
7282  items you need to worry about.
7283  Again, the specifics are covered below.
7284 \end_layout
7285
7286 \begin_layout Subsection
7287 Creating templates
7288 \begin_inset CommandInset label
7289 LatexCommand label
7290 name "subsec:Creating-Templates"
7291
7292 \end_inset
7293
7294
7295 \end_layout
7296
7297 \begin_layout Standard
7298 Once you have written a layout file for a new document class, you might
7299  want to consider writing a
7300 \emph on
7301 template
7302 \emph default
7303  for it, too.
7304  A template acts as a kind of tutorial for your layout, showing how it might
7305  be used, though containing dummy content.
7306  You can of course look at the various templates included with \SpecialChar LyX
7307  for ideas.
7308 \end_layout
7309
7310 \begin_layout Standard
7311 Templates are created just like usual documents: using \SpecialChar LyX
7312 .
7313  The only difference is that usual documents contain all possible settings,
7314  including the font scheme and the paper size.
7315  Usually a user doesn't want a template to overwrite his preferred settings
7316  for such parameters.
7317  For that reason, the designer of a template should remove the corresponding
7318  commands like
7319 \begin_inset Flex Code
7320 status collapsed
7321
7322 \begin_layout Plain Layout
7323
7324 \backslash
7325 font_roman
7326 \end_layout
7327
7328 \end_inset
7329
7330  or
7331 \begin_inset Flex Code
7332 status collapsed
7333
7334 \begin_layout Plain Layout
7335
7336 \backslash
7337 papersize
7338 \end_layout
7339
7340 \end_inset
7341
7342  from the template \SpecialChar LyX
7343  file.
7344  This can be done with any simple text-editor, for example
7345 \begin_inset Flex Code
7346 status collapsed
7347
7348 \begin_layout Plain Layout
7349 vi
7350 \end_layout
7351
7352 \end_inset
7353
7354  or
7355 \begin_inset Flex Code
7356 status collapsed
7357
7358 \begin_layout Plain Layout
7359 notepad
7360 \end_layout
7361
7362 \end_inset
7363
7364 .
7365 \end_layout
7366
7367 \begin_layout Standard
7368 Put the edited template files you create in
7369 \begin_inset Flex Code
7370 status collapsed
7371
7372 \begin_layout Plain Layout
7373 UserDir/templates/
7374 \end_layout
7375
7376 \end_inset
7377
7378 , copy the ones you use from the global template directory in
7379 \begin_inset Flex Code
7380 status collapsed
7381
7382 \begin_layout Plain Layout
7383 LyXDir/templates/
7384 \end_layout
7385
7386 \end_inset
7387
7388  to the same place, and redefine the template path in the
7389 \begin_inset Flex Noun
7390 status collapsed
7391
7392 \begin_layout Plain Layout
7393 Tools\SpecialChar menuseparator
7394 Preferences\SpecialChar menuseparator
7395 Paths
7396 \end_layout
7397
7398 \end_inset
7399
7400  dialog.
7401 \end_layout
7402
7403 \begin_layout Standard
7404 Note, by the way, that there is a template which has a particular meaning:
7405
7406 \begin_inset Flex Code
7407 status collapsed
7408
7409 \begin_layout Plain Layout
7410 defaults.lyx
7411 \end_layout
7412
7413 \end_inset
7414
7415 .
7416  This template is loaded every time you create a new document with
7417 \begin_inset Flex Noun
7418 status collapsed
7419
7420 \begin_layout Plain Layout
7421 File\SpecialChar menuseparator
7422 New
7423 \end_layout
7424
7425 \end_inset
7426
7427  in order to provide useful defaults.
7428  To create this template from inside \SpecialChar LyX
7429 , all you have to do is to open a document
7430  with the correct settings, and use the
7431 \begin_inset Flex Noun
7432 status collapsed
7433
7434 \begin_layout Plain Layout
7435 Save as Document Defaults
7436 \end_layout
7437
7438 \end_inset
7439
7440  button.
7441 \end_layout
7442
7443 \begin_layout Subsection
7444 Upgrading old layout files
7445 \end_layout
7446
7447 \begin_layout Standard
7448 The format of layout files changes with each \SpecialChar LyX
7449  release, so old layout files
7450  need to be converted to the new format.
7451  If \SpecialChar LyX
7452  reads a layout file in an older format, it automatically calls the
7453  script
7454 \begin_inset Flex Code
7455 status collapsed
7456
7457 \begin_layout Plain Layout
7458 layout2layout.py
7459 \end_layout
7460
7461 \end_inset
7462
7463  to convert it to a temporary file in current format.
7464  The original file is left untouched.
7465  If you use the layout file often, then, you may want to convert it permanently,
7466  so that \SpecialChar LyX
7467  does not have to do so itself every time.
7468  To do this, you can call the converter manually:
7469 \end_layout
7470
7471 \begin_layout Enumerate
7472 rename the file
7473 \begin_inset Flex Code
7474 status collapsed
7475
7476 \begin_layout Plain Layout
7477 myclass.layout
7478 \end_layout
7479
7480 \end_inset
7481
7482  to
7483 \begin_inset Flex Code
7484 status collapsed
7485
7486 \begin_layout Plain Layout
7487 myclass.old
7488 \end_layout
7489
7490 \end_inset
7491
7492
7493 \end_layout
7494
7495 \begin_layout Enumerate
7496 Call the command
7497 \begin_inset Newline newline
7498 \end_inset
7499
7500
7501 \begin_inset Flex Code
7502 status collapsed
7503
7504 \begin_layout Plain Layout
7505 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7506 \end_layout
7507
7508 \end_inset
7509
7510
7511 \begin_inset Newline newline
7512 \end_inset
7513
7514 where
7515 \begin_inset Flex Code
7516 status collapsed
7517
7518 \begin_layout Plain Layout
7519 LyXDir
7520 \end_layout
7521
7522 \end_inset
7523
7524  is the name of your \SpecialChar LyX
7525  system directory.
7526 \end_layout
7527
7528 \begin_layout Standard
7529 Note that manual conversion does not affect included files, so these will
7530  have to be converted separately.
7531 \end_layout
7532
7533 \begin_layout Section
7534 \begin_inset CommandInset label
7535 LatexCommand label
7536 name "sec:TextClass"
7537
7538 \end_inset
7539
7540 The layout file format
7541 \end_layout
7542
7543 \begin_layout Standard
7544 The following sections describe how layout files are structured and written.
7545  Our advice is to go slowly, save and test often.
7546  It is really not that hard, except that the multitude of options can become
7547  overwhelming, especially if you try to check out too many at once.
7548  It becomes easier if you use existing layouts of \SpecialChar LyX
7549  as examples/reference
7550  or if you modify an existing layout to your needs.
7551 \end_layout
7552
7553 \begin_layout Standard
7554 Note that all the tags used in layout files are case-insensitive.
7555  This means that
7556 \begin_inset Flex Code
7557 status collapsed
7558
7559 \begin_layout Plain Layout
7560 Style
7561 \end_layout
7562
7563 \end_inset
7564
7565 ,
7566 \begin_inset Flex Code
7567 status collapsed
7568
7569 \begin_layout Plain Layout
7570 style
7571 \end_layout
7572
7573 \end_inset
7574
7575  and
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  are really the same tag.
7586  The possible arguments are printed in brackets after the tag's name.
7587  The default argument is typeset
7588 \begin_inset Flex Code
7589 status collapsed
7590
7591 \begin_layout Plain Layout
7592
7593 \emph on
7594 emphasized
7595 \end_layout
7596
7597 \end_inset
7598
7599 .
7600  If the argument has a data type like
7601 \begin_inset Quotes eld
7602 \end_inset
7603
7604 string
7605 \begin_inset Quotes erd
7606 \end_inset
7607
7608  or
7609 \begin_inset Quotes eld
7610 \end_inset
7611
7612 float
7613 \begin_inset Quotes erd
7614 \end_inset
7615
7616 , the default is shown like this:
7617 \begin_inset Flex Code
7618 status collapsed
7619
7620 \begin_layout Plain Layout
7621 float=
7622 \emph on
7623 default
7624 \end_layout
7625
7626 \end_inset
7627
7628 .
7629 \end_layout
7630
7631 \begin_layout Subsection
7632 The document class declaration and classification
7633 \end_layout
7634
7635 \begin_layout Standard
7636 Lines in a layout file which begin with
7637 \begin_inset Flex Code
7638 status collapsed
7639
7640 \begin_layout Plain Layout
7641 #
7642 \end_layout
7643
7644 \end_inset
7645
7646  are comments.
7647  There is one exception to this rule.
7648  All
7649 \begin_inset Flex Code
7650 status collapsed
7651
7652 \begin_layout Plain Layout
7653 *.layout
7654 \end_layout
7655
7656 \end_inset
7657
7658  files should begin with lines like:
7659 \end_layout
7660
7661 \begin_layout LyX-Code
7662
7663 \size small
7664 #% Do not delete the line below; configure depends on this
7665 \end_layout
7666
7667 \begin_layout LyX-Code
7668
7669 \size small
7670 #
7671 \backslash
7672 DeclareLaTeXClass{Article (Standard Class)}
7673 \end_layout
7674
7675 \begin_layout LyX-Code
7676
7677 \size small
7678 #
7679 \backslash
7680 DeclareCategory{Articles}
7681 \end_layout
7682
7683 \begin_layout Standard
7684 The second and third lines are used when you (re)configure \SpecialChar LyX
7685 .
7686  The layout file is read by the \SpecialChar LaTeX
7687  script
7688 \begin_inset Flex Code
7689 status collapsed
7690
7691 \begin_layout Plain Layout
7692 chkconfig.ltx
7693 \end_layout
7694
7695 \end_inset
7696
7697 , in a special mode where
7698 \begin_inset Flex Code
7699 status collapsed
7700
7701 \begin_layout Plain Layout
7702 #
7703 \end_layout
7704
7705 \end_inset
7706
7707  is ignored.
7708  The first line is just a \SpecialChar LaTeX
7709  comment, the second one contains the mandatory
7710  declaration of the text class and the third line contains the optional
7711  classification of the class.
7712  If these lines appear in a file named
7713 \begin_inset Flex Code
7714 status collapsed
7715
7716 \begin_layout Plain Layout
7717 article.layout
7718 \end_layout
7719
7720 \end_inset
7721
7722 , then they define a text class of name
7723 \begin_inset Flex Code
7724 status collapsed
7725
7726 \begin_layout Plain Layout
7727 article
7728 \end_layout
7729
7730 \end_inset
7731
7732  (the name of the layout file) which uses the \SpecialChar LaTeX
7733  document class
7734 \begin_inset Flex Code
7735 status collapsed
7736
7737 \begin_layout Plain Layout
7738 article.cls
7739 \end_layout
7740
7741 \end_inset
7742
7743  (the default is to use the same name as the layout).
7744  The string
7745 \begin_inset Quotes eld
7746 \end_inset
7747
7748 Article (Standard Class)
7749 \begin_inset Quotes erd
7750 \end_inset
7751
7752  that appears above is used as a description of the text class in the
7753 \begin_inset Flex Noun
7754 status collapsed
7755
7756 \begin_layout Plain Layout
7757 Document\SpecialChar menuseparator
7758 Settings
7759 \end_layout
7760
7761 \end_inset
7762
7763  dialog.
7764  The category (
7765 \begin_inset Quotes eld
7766 \end_inset
7767
7768 Articles
7769 \begin_inset Quotes erd
7770 \end_inset
7771
7772  in the example) is also used 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: the text classes are grouped by these categories (which are usually
7784  genres, so typical categories are
7785 \begin_inset Quotes eld
7786 \end_inset
7787
7788 Articles
7789 \begin_inset Quotes erd
7790 \end_inset
7791
7792 ,
7793 \begin_inset Quotes eld
7794 \end_inset
7795
7796 Books
7797 \begin_inset Quotes erd
7798 \end_inset
7799
7800 ,
7801 \begin_inset Quotes eld
7802 \end_inset
7803
7804 Reports
7805 \begin_inset Quotes erd
7806 \end_inset
7807
7808 ,
7809 \begin_inset Quotes eld
7810 \end_inset
7811
7812 Letters
7813 \begin_inset Quotes erd
7814 \end_inset
7815
7816 ,
7817 \begin_inset Quotes eld
7818 \end_inset
7819
7820 Presentations
7821 \begin_inset Quotes erd
7822 \end_inset
7823
7824 ,
7825 \begin_inset Quotes eld
7826 \end_inset
7827
7828 Curricula Vitae
7829 \begin_inset Quotes erd
7830 \end_inset
7831
7832  etc.).
7833  If no category has been declared, the class will be put in the
7834 \begin_inset Quotes eld
7835 \end_inset
7836
7837 Uncategorized
7838 \begin_inset Quotes erd
7839 \end_inset
7840
7841  group.
7842 \end_layout
7843
7844 \begin_layout Standard
7845 Let's assume that you wrote your own text class that uses the
7846 \begin_inset Flex Code
7847 status collapsed
7848
7849 \begin_layout Plain Layout
7850 article.cls
7851 \end_layout
7852
7853 \end_inset
7854
7855  document class, but where you changed the appearance of the section headings.
7856  If you put it in a file
7857 \begin_inset Flex Code
7858 status collapsed
7859
7860 \begin_layout Plain Layout
7861 myarticle.layout
7862 \end_layout
7863
7864 \end_inset
7865
7866 , the header of this file should be:
7867 \end_layout
7868
7869 \begin_layout LyX-Code
7870
7871 \size small
7872 #% Do not delete the line below; configure depends on this
7873 \end_layout
7874
7875 \begin_layout LyX-Code
7876
7877 \size small
7878 #
7879 \backslash
7880 DeclareLaTeXClass[article]{Article (with My Own Headings)}
7881 \end_layout
7882
7883 \begin_layout LyX-Code
7884
7885 \size small
7886 #
7887 \backslash
7888 DeclareCategory{Articles}
7889 \end_layout
7890
7891 \begin_layout Standard
7892 This declares a text class
7893 \begin_inset Flex Code
7894 status collapsed
7895
7896 \begin_layout Plain Layout
7897 myarticle
7898 \end_layout
7899
7900 \end_inset
7901
7902 , associated with the \SpecialChar LaTeX
7903  document class
7904 \begin_inset Flex Code
7905 status collapsed
7906
7907 \begin_layout Plain Layout
7908 article.cls
7909 \end_layout
7910
7911 \end_inset
7912
7913  and described as
7914 \begin_inset Quotes eld
7915 \end_inset
7916
7917 Article (with My Own Headings)
7918 \begin_inset Quotes erd
7919 \end_inset
7920
7921 .
7922  If your text class depends on several packages, you can declare it as:
7923 \end_layout
7924
7925 \begin_layout LyX-Code
7926
7927 \size small
7928 #% Do not delete the line below; configure depends on this
7929 \end_layout
7930
7931 \begin_layout LyX-Code
7932
7933 \size small
7934 #
7935 \backslash
7936 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
7937 \end_layout
7938
7939 \begin_layout LyX-Code
7940
7941 \size small
7942 #
7943 \backslash
7944 DeclareCategory{Articles}
7945 \end_layout
7946
7947 \begin_layout Standard
7948 This indicates that your text class uses the
7949 \begin_inset Flex Code
7950 status collapsed
7951
7952 \begin_layout Plain Layout
7953 foo.sty
7954 \end_layout
7955
7956 \end_inset
7957
7958  package.
7959  Finally, it is also possible to declare classes for DocBook code.
7960  Typical declarations will look like:
7961 \end_layout
7962
7963 \begin_layout LyX-Code
7964
7965 \size small
7966 #% Do not delete the line below; configure depends on this
7967 \end_layout
7968
7969 \begin_layout LyX-Code
7970
7971 \size small
7972 #
7973 \backslash
7974 DeclareDocBookClass[article]{SGML (DocBook Article)}
7975 \end_layout
7976
7977 \begin_layout LyX-Code
7978
7979 \size small
7980 #
7981 \backslash
7982 DeclareCategory{Articles (DocBook)}
7983 \end_layout
7984
7985 \begin_layout Standard
7986 Note that these declarations can also be given an optional parameter declaring
7987  the name of the document class (but not a list).
7988 \end_layout
7989
7990 \begin_layout Standard
7991 So, to be as explicit as possible, the form of the layout declaration is:
7992 \end_layout
7993
7994 \begin_layout LyX-Code
7995
7996 \size small
7997 #
7998 \backslash
7999 DeclareLaTeXClass[class,package.sty]{layout description}
8000 \end_layout
8001
8002 \begin_layout LyX-Code
8003
8004 \size small
8005 #
8006 \backslash
8007 DeclareCategory{category}
8008 \end_layout
8009
8010 \begin_layout Standard
8011 The class need only be specified if the name of the \SpecialChar LaTeX
8012  class file and the
8013  name of the layout file are different or if there are packages to load.
8014  If the name of the class file is not specified, then \SpecialChar LyX
8015  will simply assume
8016  that it is the same as the name of the layout file.
8017 \end_layout
8018
8019 \begin_layout Standard
8020 When the text class has been modified to your taste, all you have to do
8021  is to copy it either to
8022 \begin_inset Flex Code
8023 status collapsed
8024
8025 \begin_layout Plain Layout
8026 LyXDir/layouts/
8027 \end_layout
8028
8029 \end_inset
8030
8031  or to
8032 \begin_inset Flex Code
8033 status collapsed
8034
8035 \begin_layout Plain Layout
8036 UserDir/layouts
8037 \end_layout
8038
8039 \end_inset
8040
8041 , run
8042 \begin_inset Flex Noun
8043 status collapsed
8044
8045 \begin_layout Plain Layout
8046 Tools\SpecialChar menuseparator
8047 Reconfigure
8048 \end_layout
8049
8050 \end_inset
8051
8052 , exit \SpecialChar LyX
8053  and restart.
8054  Then your new text class should be available along with the others.
8055 \end_layout
8056
8057 \begin_layout Standard
8058 Once the layout file is installed, you can edit it and see your changes
8059  without having to reconfigure or to restart \SpecialChar LyX
8060 .
8061
8062 \begin_inset Foot
8063 status collapsed
8064
8065 \begin_layout Plain Layout
8066 In versions of \SpecialChar LyX
8067  prior to 1.6, this was not true.
8068  As a result, editing layout files was very time consuming, since you had
8069  constantly to restart \SpecialChar LyX
8070  to see changes.
8071 \end_layout
8072
8073 \end_inset
8074
8075  You can force a reload of the current layout by using the \SpecialChar LyX
8076  function
8077 \begin_inset Flex Noun
8078 status collapsed
8079
8080 \begin_layout Plain Layout
8081 layout-reload
8082 \end_layout
8083
8084 \end_inset
8085
8086 .
8087  There is no default binding for this function—though, of course, you can
8088  bind it to a key yourself.
8089  But you will normally use this function simply by entering it in the mini-buffe
8090 r.
8091
8092 \end_layout
8093
8094 \begin_layout Standard
8095
8096 \emph on
8097 Warning
8098 \emph default
8099 :
8100 \begin_inset Flex Noun
8101 status collapsed
8102
8103 \begin_layout Plain Layout
8104 layout-reload
8105 \end_layout
8106
8107 \end_inset
8108
8109  is very much an `advanced feature'.
8110  It is
8111 \emph on
8112 strongly
8113 \emph default
8114  recommended that you save your work before using this function.
8115  In fact, it is
8116 \emph on
8117 strongly
8118 \emph default
8119  recommended that you not attempt to edit layout information while simultaneousl
8120 y working on a document that you care about.
8121  Use a test document.
8122  Syntax errors and the like in your layout file could cause peculiar behavior.
8123  In particular, such errors could cause \SpecialChar LyX
8124  to regard the current layout as
8125  invalid and to attempt to switch to some other layout.
8126 \begin_inset Foot
8127 status collapsed
8128
8129 \begin_layout Plain Layout
8130 Really bad syntax errors may even caused \SpecialChar LyX
8131  to exit.
8132  This is because certain sorts of errors may make \SpecialChar LyX
8133  unable to read
8134 \emph on
8135 any
8136 \emph default
8137  layout information.
8138  Please be careful.
8139 \end_layout
8140
8141 \end_inset
8142
8143  The \SpecialChar LyX
8144  team strives to keep \SpecialChar LyX
8145  stable in such situations, but safe is better
8146  than sorry.
8147 \begin_inset Foot
8148 status collapsed
8149
8150 \begin_layout Plain Layout
8151 While we're giving advice: make regular backups.
8152  And be nice to your mother.
8153 \end_layout
8154
8155 \end_inset
8156
8157
8158 \end_layout
8159
8160 \begin_layout Subsection
8161 The Module declaration
8162 \end_layout
8163
8164 \begin_layout Standard
8165 A module must begin with a line like the following:
8166 \end_layout
8167
8168 \begin_layout LyX-Code
8169 #
8170 \backslash
8171 DeclareLyXModule[endnotes.sty]{Endnotes}
8172 \end_layout
8173
8174 \begin_layout Standard
8175 The mandatory argument, in curly brackets, is the name of the module, as
8176  it should appear in
8177 \begin_inset Flex Noun
8178 status collapsed
8179
8180 \begin_layout Plain Layout
8181 Document\SpecialChar menuseparator
8182 Settings\SpecialChar menuseparator
8183 Modules
8184 \end_layout
8185
8186 \end_inset
8187
8188 .
8189  The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8190  packages
8191  on which the module depends.
8192  It is also possible to use the form
8193 \begin_inset Flex Noun
8194 status collapsed
8195
8196 \begin_layout Plain Layout
8197 from->to
8198 \end_layout
8199
8200 \end_inset
8201
8202  as an optional argument, which declares that the module can only be used
8203  when there exists a conversion chain between the formats `
8204 \begin_inset Flex Code
8205 status collapsed
8206
8207 \begin_layout Plain Layout
8208 from
8209 \end_layout
8210
8211 \end_inset
8212
8213 ' and `
8214 \begin_inset Flex Code
8215 status collapsed
8216
8217 \begin_layout Plain Layout
8218 to
8219 \end_layout
8220
8221 \end_inset
8222
8223 '.
8224 \end_layout
8225
8226 \begin_layout Standard
8227 The module declaration should then be followed by lines like the following
8228 \begin_inset Foot
8229 status collapsed
8230
8231 \begin_layout Plain Layout
8232 Preferably in English if the module should be published with \SpecialChar LyX
8233 .
8234  This description will appear in the list of messages to be translated and
8235  will be thus translated with the next interface update.
8236 \end_layout
8237
8238 \end_inset
8239
8240 :
8241 \end_layout
8242
8243 \begin_layout LyX-Code
8244 #DescriptionBegin
8245 \end_layout
8246
8247 \begin_layout LyX-Code
8248 #Adds an endnote command, in addition to footnotes.
8249
8250 \end_layout
8251
8252 \begin_layout LyX-Code
8253 #You will need to add
8254 \backslash
8255 theendnotes in TeX code where you
8256 \end_layout
8257
8258 \begin_layout LyX-Code
8259 #want the endnotes to appear.
8260
8261 \end_layout
8262
8263 \begin_layout LyX-Code
8264 #DescriptionEnd
8265 \end_layout
8266
8267 \begin_layout LyX-Code
8268 #Requires: somemodule | othermodule
8269 \end_layout
8270
8271 \begin_layout LyX-Code
8272 #Excludes: badmodule
8273 \end_layout
8274
8275 \begin_layout Standard
8276 The description is used in
8277 \begin_inset Flex Noun
8278 status collapsed
8279
8280 \begin_layout Plain Layout
8281 Document\SpecialChar menuseparator
8282 Settings\SpecialChar menuseparator
8283 Modules
8284 \end_layout
8285
8286 \end_inset
8287
8288  to provide the user with information about what the module does.
8289  The
8290 \begin_inset Flex Code
8291 status collapsed
8292
8293 \begin_layout Plain Layout
8294 Requires
8295 \end_layout
8296
8297 \end_inset
8298
8299  line is used to identify other modules with which this one must be used;
8300  the
8301 \begin_inset Flex Code
8302 status collapsed
8303
8304 \begin_layout Plain Layout
8305 Excludes
8306 \end_layout
8307
8308 \end_inset
8309
8310  line is used to identify modules with which this one may not be used.
8311  Both are optional, and, as shown, multiple modules should be separated
8312  with the pipe symbol: |.
8313  Note that the required modules are treated disjunctively:
8314 \emph on
8315 at least one
8316 \emph default
8317  of the required modules must be used.
8318  Similarly,
8319 \emph on
8320 no
8321 \emph default
8322  excluded module may be used.
8323  Note that modules are identified here by their filenames without the
8324 \begin_inset Flex Code
8325 status collapsed
8326
8327 \begin_layout Plain Layout
8328 .module
8329 \end_layout
8330
8331 \end_inset
8332
8333  extension.
8334  So
8335 \begin_inset Flex Code
8336 status collapsed
8337
8338 \begin_layout Plain Layout
8339 somemodule
8340 \end_layout
8341
8342 \end_inset
8343
8344  is really
8345 \begin_inset Flex Code
8346 status collapsed
8347
8348 \begin_layout Plain Layout
8349 somemodule.module
8350 \end_layout
8351
8352 \end_inset
8353
8354 .
8355 \end_layout
8356
8357 \begin_layout Subsection
8358 Format number
8359 \end_layout
8360
8361 \begin_layout Standard
8362 The first non-comment line of any layout file, included file, or module
8363
8364 \emph on
8365 must
8366 \emph default
8367  contain the file format number:
8368 \end_layout
8369
8370 \begin_layout Description
8371 \begin_inset Flex Code
8372 status collapsed
8373
8374 \begin_layout Plain Layout
8375 Format
8376 \end_layout
8377
8378 \end_inset
8379
8380  [
8381 \begin_inset Flex Code
8382 status collapsed
8383
8384 \begin_layout Plain Layout
8385 int
8386 \end_layout
8387
8388 \end_inset
8389
8390 ] The format number of the layout file.
8391 \end_layout
8392
8393 \begin_layout Standard
8394 This tag was introduced with \SpecialChar LyX
8395
8396 \begin_inset space ~
8397 \end_inset
8398
8399 1.4.0.
8400  Layout files from older \SpecialChar LyX
8401  versions do not have an explicit file format and
8402  are considered to have
8403 \begin_inset Flex Code
8404 status collapsed
8405
8406 \begin_layout Plain Layout
8407 Format
8408 \begin_inset space ~
8409 \end_inset
8410
8411 1
8412 \end_layout
8413
8414 \end_inset
8415
8416 .
8417  The format for the present version of \SpecialChar LyX
8418  is format 60.
8419  But each version of \SpecialChar LyX
8420  is capable of reading earlier versions' layout files,
8421  just as they are capable of reading files produced by earlier versions
8422  of \SpecialChar LyX
8423 .
8424  There is, however, no provision for converting to earlier formats.
8425 \end_layout
8426
8427 \begin_layout Subsection
8428 \begin_inset CommandInset label
8429 LatexCommand label
8430 name "subsec:General-text-class"
8431
8432 \end_inset
8433
8434 General text class parameters
8435 \end_layout
8436
8437 \begin_layout Standard
8438 These are general parameters that govern the behavior of an entire document
8439  class.
8440  (This does
8441 \emph on
8442 not
8443 \emph default
8444  mean that they must appear in
8445 \begin_inset Flex Code
8446 status collapsed
8447
8448 \begin_layout Plain Layout
8449 .layout
8450 \end_layout
8451
8452 \end_inset
8453
8454  files rather than in modules.
8455  A module can contain any layout tag.)
8456 \end_layout
8457
8458 \begin_layout Description
8459 \begin_inset Flex Code
8460 status collapsed
8461
8462 \begin_layout Plain Layout
8463 AddToHTMLPreamble
8464 \end_layout
8465
8466 \end_inset
8467
8468  Adds information that will be output in the
8469 \begin_inset Flex Code
8470 status collapsed
8471
8472 \begin_layout Plain Layout
8473 <head>
8474 \end_layout
8475
8476 \end_inset
8477
8478  block when the document is output to XHTML.
8479  Typically, this would be used to output CSS style information, but it can
8480  be used for anything that can appear in
8481 \begin_inset Flex Code
8482 status collapsed
8483
8484 \begin_layout Plain Layout
8485 <head>
8486 \end_layout
8487
8488 \end_inset
8489
8490 .
8491  Must end with
8492 \begin_inset Quotes eld
8493 \end_inset
8494
8495
8496 \begin_inset Flex Code
8497 status collapsed
8498
8499 \begin_layout Plain Layout
8500 EndPreamble
8501 \end_layout
8502
8503 \end_inset
8504
8505
8506 \begin_inset Quotes erd
8507 \end_inset
8508
8509 .
8510 \end_layout
8511
8512 \begin_layout Description
8513 \begin_inset Flex Code
8514 status collapsed
8515
8516 \begin_layout Plain Layout
8517 AddToPreamble
8518 \end_layout
8519
8520 \end_inset
8521
8522  Adds information to the document preamble.
8523  Must end with
8524 \begin_inset Newline newline
8525 \end_inset
8526
8527
8528 \begin_inset Quotes eld
8529 \end_inset
8530
8531
8532 \begin_inset Flex Code
8533 status collapsed
8534
8535 \begin_layout Plain Layout
8536 EndPreamble
8537 \end_layout
8538
8539 \end_inset
8540
8541
8542 \begin_inset Quotes erd
8543 \end_inset
8544
8545 .
8546 \end_layout
8547
8548 \begin_layout Description
8549 \begin_inset Flex Code
8550 status collapsed
8551
8552 \begin_layout Plain Layout
8553 CiteFormat
8554 \end_layout
8555
8556 \end_inset
8557
8558  Defines formats for use in the display of bibliographic information.
8559  See
8560 \begin_inset CommandInset ref
8561 LatexCommand ref
8562 reference "subsec:Citation-format-description"
8563
8564 \end_inset
8565
8566  for details.
8567  Must end with
8568 \begin_inset Quotes eld
8569 \end_inset
8570
8571
8572 \begin_inset Flex Code
8573 status collapsed
8574
8575 \begin_layout Plain Layout
8576 End
8577 \end_layout
8578
8579 \end_inset
8580
8581
8582 \begin_inset Quotes erd
8583 \end_inset
8584
8585 .
8586 \end_layout
8587
8588 \begin_layout Description
8589 \begin_inset Flex Code
8590 status collapsed
8591
8592 \begin_layout Plain Layout
8593 ClassOptions
8594 \end_layout
8595
8596 \end_inset
8597
8598  Describes various global options supported by the document class.
8599  See
8600 \begin_inset CommandInset ref
8601 LatexCommand ref
8602 reference "subsec:ClassOptions"
8603
8604 \end_inset
8605
8606  for a description.
8607  Must end with
8608 \begin_inset Quotes eld
8609 \end_inset
8610
8611
8612 \begin_inset Flex Code
8613 status collapsed
8614
8615 \begin_layout Plain Layout
8616 End
8617 \end_layout
8618
8619 \end_inset
8620
8621
8622 \begin_inset Quotes erd
8623 \end_inset
8624
8625 .
8626 \end_layout
8627
8628 \begin_layout Description
8629 \begin_inset Flex Code
8630 status collapsed
8631
8632 \begin_layout Plain Layout
8633 Columns
8634 \end_layout
8635
8636 \end_inset
8637
8638  [
8639 \begin_inset Flex Code
8640 status collapsed
8641
8642 \begin_layout Plain Layout
8643
8644 \emph on
8645 1
8646 \end_layout
8647
8648 \end_inset
8649
8650 ,
8651 \begin_inset space \thinspace{}
8652 \end_inset
8653
8654
8655 \begin_inset Flex Code
8656 status collapsed
8657
8658 \begin_layout Plain Layout
8659 2
8660 \end_layout
8661
8662 \end_inset
8663
8664 ] Whether the class should
8665 \emph on
8666 default
8667 \emph default
8668  to having one or two columns.
8669  Can be changed in the
8670 \begin_inset Flex Noun
8671 status collapsed
8672
8673 \begin_layout Plain Layout
8674 Document\SpecialChar menuseparator
8675 Settings
8676 \end_layout
8677
8678 \end_inset
8679
8680  dialog.
8681 \end_layout
8682
8683 \begin_layout Description
8684 \begin_inset Flex Code
8685 status collapsed
8686
8687 \begin_layout Plain Layout
8688 Counter
8689 \end_layout
8690
8691 \end_inset
8692
8693  [
8694 \begin_inset Flex Code
8695 status collapsed
8696
8697 \begin_layout Plain Layout
8698 string
8699 \end_layout
8700
8701 \end_inset
8702
8703 ] This sequence defines the properties for a counter.
8704  If the counter does not yet exist, it is created; if it does exist, it
8705  is modified.
8706  Must end with
8707 \begin_inset Quotes eld
8708 \end_inset
8709
8710
8711 \begin_inset Flex Code
8712 status collapsed
8713
8714 \begin_layout Plain Layout
8715 End
8716 \end_layout
8717
8718 \end_inset
8719
8720
8721 \begin_inset Quotes erd
8722 \end_inset
8723
8724 .
8725 \begin_inset Newline newline
8726 \end_inset
8727
8728 See
8729 \begin_inset CommandInset ref
8730 LatexCommand ref
8731 reference "subsec:Counters"
8732
8733 \end_inset
8734
8735  for details on counters.
8736 \end_layout
8737
8738 \begin_layout Description
8739 \begin_inset Flex Code
8740 status collapsed
8741
8742 \begin_layout Plain Layout
8743 DefaultFont
8744 \end_layout
8745
8746 \end_inset
8747
8748  Sets the default font used to display the document.
8749  See
8750 \begin_inset CommandInset ref
8751 LatexCommand ref
8752 reference "subsec:Font-description"
8753
8754 \end_inset
8755
8756  for how to declare fonts.
8757  Must end with
8758 \begin_inset Quotes eld
8759 \end_inset
8760
8761
8762 \begin_inset Flex Code
8763 status collapsed
8764
8765 \begin_layout Plain Layout
8766 EndFont
8767 \end_layout
8768
8769 \end_inset
8770
8771
8772 \begin_inset Quotes erd
8773 \end_inset
8774
8775 .
8776 \end_layout
8777
8778 \begin_layout Description
8779 \begin_inset Flex Code
8780 status collapsed
8781
8782 \begin_layout Plain Layout
8783 DefaultModule
8784 \end_layout
8785
8786 \end_inset
8787
8788  [
8789 \begin_inset Flex Code
8790 status collapsed
8791
8792 \begin_layout Plain Layout
8793 <module>
8794 \end_layout
8795
8796 \end_inset
8797
8798 ] Specifies a module to be included by default with this document class.
8799  The module is specified as filename without the
8800 \begin_inset Flex Code
8801 status collapsed
8802
8803 \begin_layout Plain Layout
8804 .module
8805 \end_layout
8806
8807 \end_inset
8808
8809  extension.
8810  The user can still remove the module, but it will be active at the outset.
8811  (This applies only when new files are created, or when this class is chosen
8812  for an existing document.)
8813 \end_layout
8814
8815 \begin_layout Description
8816 \begin_inset Flex Code
8817 status collapsed
8818
8819 \begin_layout Plain Layout
8820 DefaultStyle
8821 \end_layout
8822
8823 \end_inset
8824
8825  [
8826 \begin_inset Flex Code
8827 status collapsed
8828
8829 \begin_layout Plain Layout
8830 <style>
8831 \end_layout
8832
8833 \end_inset
8834
8835 ] This is the style that will be assigned to new paragraphs, usually
8836 \begin_inset Flex Noun
8837 status collapsed
8838
8839 \begin_layout Plain Layout
8840 Standard
8841 \end_layout
8842
8843 \end_inset
8844
8845 .
8846  This will default to the first defined style if not given, but you are
8847  encouraged to use this directive.
8848 \end_layout
8849
8850 \begin_layout Description
8851 \begin_inset Flex Code
8852 status collapsed
8853
8854 \begin_layout Plain Layout
8855 ExcludesModule
8856 \end_layout
8857
8858 \end_inset
8859
8860  [
8861 \begin_inset Flex Code
8862 status collapsed
8863
8864 \begin_layout Plain Layout
8865 <module>
8866 \end_layout
8867
8868 \end_inset
8869
8870 ] This tag indicates that the module (which is specified by filename without
8871  the
8872 \begin_inset Flex Code
8873 status collapsed
8874
8875 \begin_layout Plain Layout
8876 .module
8877 \end_layout
8878
8879 \end_inset
8880
8881  extension) cannot be used with this document class.
8882  This might be used in a journal-specific layout file to prevent, say, the
8883  use of the
8884 \begin_inset Flex Code
8885 status collapsed
8886
8887 \begin_layout Plain Layout
8888 theorems-sec
8889 \end_layout
8890
8891 \end_inset
8892
8893  module that numbers theorems by section.
8894  This tag may
8895 \emph on
8896 not
8897 \emph default
8898  be used in a module.
8899  Modules have their own way of excluding other modules (see
8900 \begin_inset CommandInset ref
8901 LatexCommand ref
8902 reference "subsec:Layout-modules"
8903
8904 \end_inset
8905
8906 ).
8907 \end_layout
8908
8909 \begin_layout Description
8910 \begin_inset Flex Code
8911 status collapsed
8912
8913 \begin_layout Plain Layout
8914 Float
8915 \end_layout
8916
8917 \end_inset
8918
8919  Defines a new float.
8920  See
8921 \begin_inset CommandInset ref
8922 LatexCommand ref
8923 reference "subsec:Floats"
8924
8925 \end_inset
8926
8927  for details.
8928  Must end with
8929 \begin_inset Quotes eld
8930 \end_inset
8931
8932
8933 \begin_inset Flex Code
8934 status collapsed
8935
8936 \begin_layout Plain Layout
8937 End
8938 \end_layout
8939
8940 \end_inset
8941
8942
8943 \begin_inset Quotes erd
8944 \end_inset
8945
8946 .
8947 \end_layout
8948
8949 \begin_layout Description
8950 \begin_inset Flex Code
8951 status collapsed
8952
8953 \begin_layout Plain Layout
8954 HTMLPreamble
8955 \end_layout
8956
8957 \end_inset
8958
8959  Sets the information that will be output in the
8960 \begin_inset Flex Code
8961 status collapsed
8962
8963 \begin_layout Plain Layout
8964 <head>
8965 \end_layout
8966
8967 \end_inset
8968
8969  block when this document class is output to XHTML.
8970  Note that this will completely override any prior
8971 \begin_inset Flex Code
8972 status collapsed
8973
8974 \begin_layout Plain Layout
8975 HTMLPreamble
8976 \end_layout
8977
8978 \end_inset
8979
8980  or
8981 \begin_inset Flex Code
8982 status collapsed
8983
8984 \begin_layout Plain Layout
8985 AddToHTMLPreamble
8986 \end_layout
8987
8988 \end_inset
8989
8990  declarations.
8991  (Use
8992 \begin_inset Newline newline
8993 \end_inset
8994
8995
8996 \begin_inset Flex Code
8997 status collapsed
8998
8999 \begin_layout Plain Layout
9000 AddToHTMLPreamble
9001 \end_layout
9002
9003 \end_inset
9004
9005  if you just want to add material to the preamble.) Must end with
9006 \begin_inset Quotes eld
9007 \end_inset
9008
9009
9010 \begin_inset Flex Code
9011 status collapsed
9012
9013 \begin_layout Plain Layout
9014 EndPreamble
9015 \end_layout
9016
9017 \end_inset
9018
9019
9020 \begin_inset Quotes erd
9021 \end_inset
9022
9023 .
9024 \end_layout
9025
9026 \begin_layout Description
9027 \begin_inset Flex Code
9028 status collapsed
9029
9030 \begin_layout Plain Layout
9031 HTMLTOCSection
9032 \end_layout
9033
9034 \end_inset
9035
9036  [
9037 \begin_inset Flex Code
9038 status collapsed
9039
9040 \begin_layout Plain Layout
9041 <style>
9042 \end_layout
9043
9044 \end_inset
9045
9046 ] The style to use for the table of contents, bibliography, and so forth,
9047  when the document is output to HTML.
9048  For articles, this should normally be
9049 \begin_inset Flex Code
9050 status collapsed
9051
9052 \begin_layout Plain Layout
9053 Section
9054 \end_layout
9055
9056 \end_inset
9057
9058 ; for books
9059 \begin_inset Flex Code
9060 status collapsed
9061
9062 \begin_layout Plain Layout
9063 Chapter
9064 \end_layout
9065
9066 \end_inset
9067
9068 .
9069  If it is not given, then \SpecialChar LyX
9070  will attempt to figure out which layout to use.
9071 \end_layout
9072
9073 \begin_layout Description
9074 \begin_inset Flex Code
9075 status collapsed
9076
9077 \begin_layout Plain Layout
9078 IfCounter
9079 \end_layout
9080
9081 \end_inset
9082
9083  [
9084 \begin_inset Flex Code
9085 status collapsed
9086
9087 \begin_layout Plain Layout
9088 <counter>
9089 \end_layout
9090
9091 \end_inset
9092
9093 ] Modifies the properties of the given counter.
9094  If the counter does not exist, the statement is ignored.
9095  Must end with
9096 \begin_inset Quotes eld
9097 \end_inset
9098
9099
9100 \begin_inset Flex Code
9101 status collapsed
9102
9103 \begin_layout Plain Layout
9104 End
9105 \end_layout
9106
9107 \end_inset
9108
9109
9110 \begin_inset Quotes erd
9111 \end_inset
9112
9113 .
9114 \begin_inset Newline newline
9115 \end_inset
9116
9117 See
9118 \begin_inset CommandInset ref
9119 LatexCommand ref
9120 reference "subsec:Counters"
9121
9122 \end_inset
9123
9124  for details on counters.
9125 \end_layout
9126
9127 \begin_layout Description
9128 \begin_inset Flex Code
9129 status collapsed
9130
9131 \begin_layout Plain Layout
9132 Input
9133 \end_layout
9134
9135 \end_inset
9136
9137  [
9138 \begin_inset Flex Code
9139 status collapsed
9140
9141 \begin_layout Plain Layout
9142 <filename>
9143 \end_layout
9144
9145 \end_inset
9146
9147 ] This allows you to include another layout definition file within yours
9148  to avoid duplicating commands.
9149  Common examples are the standard layout files, for example,
9150 \begin_inset Flex Code
9151 status collapsed
9152
9153 \begin_layout Plain Layout
9154 stdclass.inc
9155 \end_layout
9156
9157 \end_inset
9158
9159 , which contains most of the basic layouts.
9160 \end_layout
9161
9162 \begin_layout Description
9163 \begin_inset Flex Code
9164 status collapsed
9165
9166 \begin_layout Plain Layout
9167 InsetLayout
9168 \end_layout
9169
9170 \end_inset
9171
9172  [
9173 \begin_inset Flex Code
9174 status collapsed
9175
9176 \begin_layout Plain Layout
9177 <type>
9178 \end_layout
9179
9180 \end_inset
9181
9182 ] This section (re-)defines the layout of an inset.
9183  It can be applied to an existing inset or to a new, user-defined inset,
9184  e.g., a new character style.
9185  Must end with
9186 \begin_inset Quotes eld
9187 \end_inset
9188
9189
9190 \begin_inset Flex Code
9191 status collapsed
9192
9193 \begin_layout Plain Layout
9194 End
9195 \end_layout
9196
9197 \end_inset
9198
9199
9200 \begin_inset Quotes erd
9201 \end_inset
9202
9203 .
9204 \begin_inset Newline newline
9205 \end_inset
9206
9207 See
9208 \begin_inset CommandInset ref
9209 LatexCommand ref
9210 reference "subsec:Flex-insets-and"
9211
9212 \end_inset
9213
9214  for more information.
9215
9216 \end_layout
9217
9218 \begin_layout Description
9219 \begin_inset Flex Code
9220 status collapsed
9221
9222 \begin_layout Plain Layout
9223 LeftMargin
9224 \end_layout
9225
9226 \end_inset
9227
9228  [
9229 \begin_inset Flex Code
9230 status collapsed
9231
9232 \begin_layout Plain Layout
9233 string
9234 \end_layout
9235
9236 \end_inset
9237
9238 ] A string that indicates the width of the left margin on the screen, for
9239  example,
9240 \begin_inset Quotes eld
9241 \end_inset
9242
9243
9244 \begin_inset Flex Code
9245 status collapsed
9246
9247 \begin_layout Plain Layout
9248 MMMMM
9249 \end_layout
9250
9251 \end_inset
9252
9253
9254 \begin_inset Quotes erd
9255 \end_inset
9256
9257 .
9258  (Note that this is not a `length', like
9259 \begin_inset Quotes eld
9260 \end_inset
9261
9262 2ex
9263 \begin_inset Quotes erd
9264 \end_inset
9265
9266 .)
9267 \end_layout
9268
9269 \begin_layout Description
9270 \begin_inset Flex Code
9271 status collapsed
9272
9273 \begin_layout Plain Layout
9274 ModifyStyle
9275 \end_layout
9276
9277 \end_inset
9278
9279  [
9280 \begin_inset Flex Code
9281 status collapsed
9282
9283 \begin_layout Plain Layout
9284 <style>
9285 \end_layout
9286
9287 \end_inset
9288
9289 ] Modifies the properties of the given paragraph style.
9290  If the style does not exist, this section is ignored.
9291  Must end with
9292 \begin_inset Quotes eld
9293 \end_inset
9294
9295
9296 \begin_inset Flex Code
9297 status collapsed
9298
9299 \begin_layout Plain Layout
9300 End
9301 \end_layout
9302
9303 \end_inset
9304
9305
9306 \begin_inset Quotes erd
9307 \end_inset
9308
9309 .
9310 \end_layout
9311
9312 \begin_layout Description
9313 \begin_inset Flex Code
9314 status collapsed
9315
9316 \begin_layout Plain Layout
9317 NoCounter
9318 \end_layout
9319
9320 \end_inset
9321
9322  [
9323 \begin_inset Flex Code
9324 status collapsed
9325
9326 \begin_layout Plain Layout
9327 <counter>
9328 \end_layout
9329
9330 \end_inset
9331
9332 ] Deletes an existing counter, usually one defined in an included file.
9333 \end_layout
9334
9335 \begin_layout Description
9336 \begin_inset Flex Code
9337 status collapsed
9338
9339 \begin_layout Plain Layout
9340 NoFloat
9341 \end_layout
9342
9343 \end_inset
9344
9345  [
9346 \begin_inset Flex Code
9347 status collapsed
9348
9349 \begin_layout Plain Layout
9350 <float>
9351 \end_layout
9352
9353 \end_inset
9354
9355 ] Deletes an existing float.
9356  This is particularly useful when you want to suppress a float that has
9357  been defined in an input file.
9358 \end_layout
9359
9360 \begin_layout Description
9361 \begin_inset Flex Code
9362 status collapsed
9363
9364 \begin_layout Plain Layout
9365 NoStyle
9366 \end_layout
9367
9368 \end_inset
9369
9370  [
9371 \begin_inset Flex Code
9372 status collapsed
9373
9374 \begin_layout Plain Layout
9375 <style>
9376 \end_layout
9377
9378 \end_inset
9379
9380 ] Deletes an existing style.
9381 \end_layout
9382
9383 \begin_layout Description
9384 \begin_inset Flex Code
9385 status collapsed
9386
9387 \begin_layout Plain Layout
9388 OutputFormat
9389 \end_layout
9390
9391 \end_inset
9392
9393  [
9394 \begin_inset Flex Code
9395 status collapsed
9396
9397 \begin_layout Plain Layout
9398 <format>
9399 \end_layout
9400
9401 \end_inset
9402
9403 ] The file format (as defined in the \SpecialChar LyX
9404  preferences) produced by this document
9405  class.
9406  It is mainly useful when
9407 \begin_inset Flex Code
9408 status collapsed
9409
9410 \begin_layout Plain Layout
9411 OutputType
9412 \end_layout
9413
9414 \end_inset
9415
9416  is
9417 \begin_inset Flex Code
9418 status collapsed
9419
9420 \begin_layout Plain Layout
9421 literate
9422 \end_layout
9423
9424 \end_inset
9425
9426  and one wants to define a new type of literate document.
9427  The format is reset to
9428 \begin_inset Quotes eld
9429 \end_inset
9430
9431
9432 \begin_inset Flex Code
9433 status collapsed
9434
9435 \begin_layout Plain Layout
9436 docbook
9437 \end_layout
9438
9439 \end_inset
9440
9441
9442 \begin_inset Quotes erd
9443 \end_inset
9444
9445  or
9446 \begin_inset Quotes eld
9447 \end_inset
9448
9449
9450 \begin_inset Flex Code
9451 status collapsed
9452
9453 \begin_layout Plain Layout
9454 latex
9455 \end_layout
9456
9457 \end_inset
9458
9459
9460 \begin_inset Quotes erd
9461 \end_inset
9462
9463  when the corresponding
9464 \begin_inset Flex Code
9465 status collapsed
9466
9467 \begin_layout Plain Layout
9468 OutputType
9469 \end_layout
9470
9471 \end_inset
9472
9473  parameter is encountered.
9474 \end_layout
9475
9476 \begin_layout Description
9477 \begin_inset Flex Code
9478 status collapsed
9479
9480 \begin_layout Plain Layout
9481 OutputType
9482 \end_layout
9483
9484 \end_inset
9485
9486  [
9487 \begin_inset Flex Code
9488 status collapsed
9489
9490 \begin_layout Plain Layout
9491
9492 \emph on
9493 lat
9494 \emph default
9495 ex
9496 \end_layout
9497
9498 \end_inset
9499
9500 ,
9501 \begin_inset Flex Code
9502 status collapsed
9503
9504 \begin_layout Plain Layout
9505 docbook
9506 \end_layout
9507
9508 \end_inset
9509
9510 ,
9511 \begin_inset Flex Code
9512 status collapsed
9513
9514 \begin_layout Plain Layout
9515 literate
9516 \end_layout
9517
9518 \end_inset
9519
9520 ] Specifies what sort of output documents using this class will produce.
9521 \end_layout
9522
9523 \begin_layout Description
9524 \begin_inset Flex Code
9525 status collapsed
9526
9527 \begin_layout Plain Layout
9528 PackageOptions
9529 \end_layout
9530
9531 \end_inset
9532
9533  [
9534 \begin_inset Flex Code
9535 status collapsed
9536
9537 \begin_layout Plain Layout
9538 string
9539 \end_layout
9540
9541 \end_inset
9542
9543
9544 \begin_inset Flex Code
9545 status collapsed
9546
9547 \begin_layout Plain Layout
9548 string
9549 \end_layout
9550
9551 \end_inset
9552
9553 ] Specifies options, given in the second string, for the package named by
9554  the first string.
9555  For example,
9556 \begin_inset Quotes eld
9557 \end_inset
9558
9559
9560 \begin_inset Flex Code
9561 status collapsed
9562
9563 \begin_layout Plain Layout
9564 PackageOptions natbib square
9565 \end_layout
9566
9567 \end_inset
9568
9569
9570 \begin_inset Quotes erd
9571 \end_inset
9572
9573  will cause
9574 \begin_inset Flex Code
9575 status collapsed
9576
9577 \begin_layout Plain Layout
9578 natbib
9579 \end_layout
9580
9581 \end_inset
9582
9583  to be loaded with the
9584 \begin_inset Flex Code
9585 status collapsed
9586
9587 \begin_layout Plain Layout
9588 square
9589 \end_layout
9590
9591 \end_inset
9592
9593  option.
9594  (For \SpecialChar TeX
9595 perts, this causes \SpecialChar LyX
9596  to output:
9597 \begin_inset Flex Code
9598 status collapsed
9599
9600 \begin_layout Plain Layout
9601
9602 \backslash
9603 PassOptionsToPackage{natbib}{square}
9604 \end_layout
9605
9606 \end_inset
9607
9608  prior to loading
9609 \begin_inset Flex Code
9610 status collapsed
9611
9612 \begin_layout Plain Layout
9613 natbib
9614 \end_layout
9615
9616 \end_inset
9617
9618 .)
9619 \end_layout
9620
9621 \begin_layout Description
9622 \begin_inset Flex Code
9623 status collapsed
9624
9625 \begin_layout Plain Layout
9626 PageStyle
9627 \end_layout
9628
9629 \end_inset
9630
9631  [
9632 \begin_inset Flex Code
9633 status collapsed
9634
9635 \begin_layout Plain Layout
9636
9637 \emph on
9638 plain
9639 \end_layout
9640
9641 \end_inset
9642
9643 ,
9644 \begin_inset Flex Code
9645 status collapsed
9646
9647 \begin_layout Plain Layout
9648 empty
9649 \end_layout
9650
9651 \end_inset
9652
9653 ,
9654 \begin_inset Flex Code
9655 status collapsed
9656
9657 \begin_layout Plain Layout
9658 headings
9659 \end_layout
9660
9661 \end_inset
9662
9663 ] The default pagestyle.
9664  Can be changed in the
9665 \begin_inset Flex Noun
9666 status collapsed
9667
9668 \begin_layout Plain Layout
9669 Document\SpecialChar menuseparator
9670 Settings
9671 \end_layout
9672
9673 \end_inset
9674
9675  dialog.
9676 \end_layout
9677
9678 \begin_layout Description
9679 \begin_inset Flex Code
9680 status collapsed
9681
9682 \begin_layout Plain Layout
9683 Preamble
9684 \end_layout
9685
9686 \end_inset
9687
9688  Sets the preamble for the \SpecialChar LaTeX
9689  document.
9690  Note that this will completely override any prior
9691 \begin_inset Flex Code
9692 status collapsed
9693
9694 \begin_layout Plain Layout
9695 Preamble
9696 \end_layout
9697
9698 \end_inset
9699
9700  or
9701 \begin_inset Flex Code
9702 status collapsed
9703
9704 \begin_layout Plain Layout
9705 AddToPreamble
9706 \end_layout
9707
9708 \end_inset
9709
9710  declarations.
9711  (Use
9712 \begin_inset Flex Code
9713 status collapsed
9714
9715 \begin_layout Plain Layout
9716 AddToPreamble
9717 \end_layout
9718
9719 \end_inset
9720
9721  if you just want to add material to the preamble.) Must end with
9722 \begin_inset Quotes eld
9723 \end_inset
9724
9725
9726 \begin_inset Flex Code
9727 status collapsed
9728
9729 \begin_layout Plain Layout
9730 EndPreamble
9731 \end_layout
9732
9733 \end_inset
9734
9735
9736 \begin_inset Quotes erd
9737 \end_inset
9738
9739 .
9740 \end_layout
9741
9742 \begin_layout Description
9743 \begin_inset Flex Code
9744 status collapsed
9745
9746 \begin_layout Plain Layout
9747 Provides
9748 \end_layout
9749
9750 \end_inset
9751
9752  [
9753 \begin_inset Flex Code
9754 status collapsed
9755
9756 \begin_layout Plain Layout
9757 string
9758 \end_layout
9759
9760 \end_inset
9761
9762 ] [
9763 \begin_inset Flex Code
9764 status collapsed
9765
9766 \begin_layout Plain Layout
9767
9768 \emph on
9769 0
9770 \end_layout
9771
9772 \end_inset
9773
9774 ,
9775 \begin_inset space \thinspace{}
9776 \end_inset
9777
9778
9779 \begin_inset Flex Code
9780 status collapsed
9781
9782 \begin_layout Plain Layout
9783 1
9784 \end_layout
9785
9786 \end_inset
9787
9788 ] Whether the class already provides the feature
9789 \begin_inset Flex Code
9790 status collapsed
9791
9792 \begin_layout Plain Layout
9793 string
9794 \end_layout
9795
9796 \end_inset
9797
9798 .
9799  A feature is in general the name of a package (e.
9800 \begin_inset space \thinspace{}
9801 \end_inset
9802
9803 g.
9804 \begin_inset space \space{}
9805 \end_inset
9806
9807
9808 \begin_inset Flex Code
9809 status collapsed
9810
9811 \begin_layout Plain Layout
9812 amsmath
9813 \end_layout
9814
9815 \end_inset
9816
9817  or
9818 \begin_inset Flex Code
9819 status collapsed
9820
9821 \begin_layout Plain Layout
9822 makeidx
9823 \end_layout
9824
9825 \end_inset
9826
9827 ) or a macro (e.
9828 \begin_inset space \thinspace{}
9829 \end_inset
9830
9831 g.
9832 \begin_inset space \space{}
9833 \end_inset
9834
9835
9836 \begin_inset Flex Code
9837 status collapsed
9838
9839 \begin_layout Plain Layout
9840 url
9841 \end_layout
9842
9843 \end_inset
9844
9845  or
9846 \begin_inset Flex Code
9847 status collapsed
9848
9849 \begin_layout Plain Layout
9850 boldsymbol
9851 \end_layout
9852
9853 \end_inset
9854
9855 ).
9856  See
9857 \begin_inset CommandInset ref
9858 LatexCommand ref
9859 reference "chap:List-of-functions"
9860
9861 \end_inset
9862
9863  for the list of features.
9864 \end_layout
9865
9866 \begin_layout Description
9867 \begin_inset Flex Code
9868 status collapsed
9869
9870 \begin_layout Plain Layout
9871 ProvidesModule
9872 \end_layout
9873
9874 \end_inset
9875
9876  [
9877 \begin_inset Flex Code
9878 status collapsed
9879
9880 \begin_layout Plain Layout
9881 string
9882 \end_layout
9883
9884 \end_inset
9885
9886 ] Indicates that this layout provides the functionality of the module mentioned,
9887  which should be specified by the filename without the
9888 \begin_inset Flex Code
9889 status collapsed
9890
9891 \begin_layout Plain Layout
9892 .module
9893 \end_layout
9894
9895 \end_inset
9896
9897  extension.
9898  This will typically be used if the layout includes the module directly,
9899  rather than using the
9900 \begin_inset Flex Code
9901 status collapsed
9902
9903 \begin_layout Plain Layout
9904 DefaultModule
9905 \end_layout
9906
9907 \end_inset
9908
9909  tag to indicate that it ought to be used.
9910  It could also be used in a module that provided an alternate implementation
9911  of the same functionality.
9912 \end_layout
9913
9914 \begin_layout Description
9915 \begin_inset Flex Code
9916 status collapsed
9917
9918 \begin_layout Plain Layout
9919 ProvideStyle
9920 \end_layout
9921
9922 \end_inset
9923
9924  [
9925 \begin_inset Flex Code
9926 status collapsed
9927
9928 \begin_layout Plain Layout
9929 <style>
9930 \end_layout
9931
9932 \end_inset
9933
9934 ] Creates a new paragraph style if it does not already exist.
9935  If the style does exist, this section is ignored.
9936  Must end with
9937 \begin_inset Quotes eld
9938 \end_inset
9939
9940
9941 \begin_inset Flex Code
9942 status collapsed
9943
9944 \begin_layout Plain Layout
9945 End
9946 \end_layout
9947
9948 \end_inset
9949
9950
9951 \begin_inset Quotes erd
9952 \end_inset
9953
9954 .
9955 \end_layout
9956
9957 \begin_layout Description
9958 \begin_inset Flex Code
9959 status collapsed
9960
9961 \begin_layout Plain Layout
9962 Requires
9963 \end_layout
9964
9965 \end_inset
9966
9967  [
9968 \begin_inset Flex Code
9969 status collapsed
9970
9971 \begin_layout Plain Layout
9972 string
9973 \end_layout
9974
9975 \end_inset
9976
9977 ] Whether the class requires the feature
9978 \begin_inset Flex Code
9979 status collapsed
9980
9981 \begin_layout Plain Layout
9982 string
9983 \end_layout
9984
9985 \end_inset
9986
9987 .
9988  Multiple features must be separated by commas.
9989  Note that you can only request supported features.
9990  (See
9991 \begin_inset CommandInset ref
9992 LatexCommand ref
9993 reference "chap:List-of-functions"
9994
9995 \end_inset
9996
9997  for the list of features.).
9998  If you require a package with specific options, you can additionally use
9999
10000 \begin_inset Flex Code
10001 status collapsed
10002
10003 \begin_layout Plain Layout
10004 PackageOptions
10005 \end_layout
10006
10007 \end_inset
10008
10009 .
10010 \end_layout
10011
10012 \begin_layout Description
10013 \begin_inset Flex Code
10014 status collapsed
10015
10016 \begin_layout Plain Layout
10017 RightMargin
10018 \end_layout
10019
10020 \end_inset
10021
10022  [
10023 \begin_inset Flex Code
10024 status collapsed
10025
10026 \begin_layout Plain Layout
10027 string
10028 \end_layout
10029
10030 \end_inset
10031
10032 ] A string that indicates the width of the right margin on the screen, for
10033  example,
10034 \begin_inset Quotes eld
10035 \end_inset
10036
10037
10038 \begin_inset Flex Code
10039 status collapsed
10040
10041 \begin_layout Plain Layout
10042 MMMMM
10043 \end_layout
10044
10045 \end_inset
10046
10047
10048 \begin_inset Quotes erd
10049 \end_inset
10050
10051 .
10052 \end_layout
10053
10054 \begin_layout Description
10055 \begin_inset Flex Code
10056 status collapsed
10057
10058 \begin_layout Plain Layout
10059 SecNumDepth
10060 \end_layout
10061
10062 \end_inset
10063
10064  [
10065 \begin_inset Flex Code
10066 status collapsed
10067
10068 \begin_layout Plain Layout
10069 int=3
10070 \end_layout
10071
10072 \end_inset
10073
10074 ] Sets which divisions get numbered.
10075  Corresponds to the
10076 \begin_inset Newline newline
10077 \end_inset
10078
10079
10080 \begin_inset Flex Code
10081 status collapsed
10082
10083 \begin_layout Plain Layout
10084 secnumdepth
10085 \end_layout
10086
10087 \end_inset
10088
10089  counter in \SpecialChar LaTeX
10090 .
10091 \end_layout
10092
10093 \begin_layout Description
10094 \begin_inset Flex Code
10095 status collapsed
10096
10097 \begin_layout Plain Layout
10098 Sides
10099 \end_layout
10100
10101 \end_inset
10102
10103  [
10104 \begin_inset Flex Code
10105 status collapsed
10106
10107 \begin_layout Plain Layout
10108
10109 \emph on
10110 1
10111 \end_layout
10112
10113 \end_inset
10114
10115 ,
10116 \begin_inset space \thinspace{}
10117 \end_inset
10118
10119
10120 \begin_inset Flex Code
10121 status collapsed
10122
10123 \begin_layout Plain Layout
10124 2
10125 \end_layout
10126
10127 \end_inset
10128
10129 ] Whether the class-default should be printing on one or both sides of the
10130  paper.
10131  Can be changed in the
10132 \begin_inset Flex Noun
10133 status collapsed
10134
10135 \begin_layout Plain Layout
10136 Document\SpecialChar menuseparator
10137 Settings
10138 \end_layout
10139
10140 \end_inset
10141
10142  dialog.
10143 \end_layout
10144
10145 \begin_layout Description
10146 \begin_inset Flex Code
10147 status collapsed
10148
10149 \begin_layout Plain Layout
10150 Style
10151 \end_layout
10152
10153 \end_inset
10154
10155  [
10156 \begin_inset Flex Code
10157 status collapsed
10158
10159 \begin_layout Plain Layout
10160 <name>
10161 \end_layout
10162
10163 \end_inset
10164
10165 ] This sequence defines a paragraph style.
10166  If the style does not yet exist, it is created; if it does exist, its parameter
10167 s are modified.
10168  Must end with
10169 \begin_inset Quotes eld
10170 \end_inset
10171
10172
10173 \begin_inset Flex Code
10174 status collapsed
10175
10176 \begin_layout Plain Layout
10177 End
10178 \end_layout
10179
10180 \end_inset
10181
10182
10183 \begin_inset Quotes erd
10184 \end_inset
10185
10186 .
10187 \begin_inset Newline newline
10188 \end_inset
10189
10190 See
10191 \begin_inset CommandInset ref
10192 LatexCommand ref
10193 reference "subsec:Paragraph-Styles"
10194
10195 \end_inset
10196
10197  for details on paragraph styles.
10198 \end_layout
10199
10200 \begin_layout Description
10201 \begin_inset Flex Code
10202 status collapsed
10203
10204 \begin_layout Plain Layout
10205 TitleLatexName
10206 \end_layout
10207
10208 \end_inset
10209
10210  [
10211 \begin_inset Flex Code
10212 status collapsed
10213
10214 \begin_layout Plain Layout
10215 string="maketitle"
10216 \end_layout
10217
10218 \end_inset
10219
10220 ] The name of the command or environment to be used with
10221 \begin_inset Flex Code
10222 status collapsed
10223
10224 \begin_layout Plain Layout
10225 TitleLatexType
10226 \end_layout
10227
10228 \end_inset
10229
10230 .
10231 \end_layout
10232
10233 \begin_layout Description
10234 \begin_inset Flex Code
10235 status collapsed
10236
10237 \begin_layout Plain Layout
10238 TitleLatexType
10239 \end_layout
10240
10241 \end_inset
10242
10243  [
10244 \begin_inset Flex Code
10245 status collapsed
10246
10247 \begin_layout Plain Layout
10248
10249 \emph on
10250 CommandAfter
10251 \end_layout
10252
10253 \end_inset
10254
10255 ,
10256 \begin_inset Flex Code
10257 status collapsed
10258
10259 \begin_layout Plain Layout
10260 Environment
10261 \end_layout
10262
10263 \end_inset
10264
10265 ] Indicates what kind of markup is used to define the title of a document.
10266
10267 \begin_inset Flex Code
10268 status collapsed
10269
10270 \begin_layout Plain Layout
10271 CommandAfter
10272 \end_layout
10273
10274 \end_inset
10275
10276  means that the macro with name
10277 \begin_inset Flex Code
10278 status collapsed
10279
10280 \begin_layout Plain Layout
10281 TitleLatexName
10282 \end_layout
10283
10284 \end_inset
10285
10286  will be inserted after the last layout which has
10287 \begin_inset Quotes eld
10288 \end_inset
10289
10290
10291 \begin_inset Flex Code
10292 status collapsed
10293
10294 \begin_layout Plain Layout
10295 InTitle
10296 \begin_inset space ~
10297 \end_inset
10298
10299 1
10300 \end_layout
10301
10302 \end_inset
10303
10304
10305 \begin_inset Quotes erd
10306 \end_inset
10307
10308 .
10309
10310 \begin_inset Flex Code
10311 status collapsed
10312
10313 \begin_layout Plain Layout
10314 Environment
10315 \end_layout
10316
10317 \end_inset
10318
10319  corresponds to the case where all layouts which have
10320 \begin_inset Quotes eld
10321 \end_inset
10322
10323
10324 \begin_inset Flex Code
10325 status collapsed
10326
10327 \begin_layout Plain Layout
10328 InTitle
10329 \begin_inset space ~
10330 \end_inset
10331
10332 1
10333 \end_layout
10334
10335 \end_inset
10336
10337
10338 \begin_inset Quotes erd
10339 \end_inset
10340
10341  should be enclosed into the
10342 \begin_inset Flex Code
10343 status collapsed
10344
10345 \begin_layout Plain Layout
10346 TitleLatexName
10347 \end_layout
10348
10349 \end_inset
10350
10351  environment.
10352 \end_layout
10353
10354 \begin_layout Description
10355 \begin_inset Flex Code
10356 status collapsed
10357
10358 \begin_layout Plain Layout
10359 TocDepth
10360 \end_layout
10361
10362 \end_inset
10363
10364  [
10365 \begin_inset Flex Code
10366 status collapsed
10367
10368 \begin_layout Plain Layout
10369 int=3
10370 \end_layout
10371
10372 \end_inset
10373
10374 ] Sets which divisions are included in the table of contents.
10375  Corresponds to the
10376 \begin_inset Flex Code
10377 status collapsed
10378
10379 \begin_layout Plain Layout
10380 tocdepth
10381 \end_layout
10382
10383 \end_inset
10384
10385  counter in \SpecialChar LaTeX
10386 .
10387 \end_layout
10388
10389 \begin_layout Subsection
10390 \begin_inset Flex Code
10391 status collapsed
10392
10393 \begin_layout Plain Layout
10394 ClassOptions
10395 \end_layout
10396
10397 \end_inset
10398
10399  section
10400 \begin_inset CommandInset label
10401 LatexCommand label
10402 name "subsec:ClassOptions"
10403
10404 \end_inset
10405
10406
10407 \end_layout
10408
10409 \begin_layout Standard
10410 The
10411 \begin_inset Flex Code
10412 status collapsed
10413
10414 \begin_layout Plain Layout
10415 ClassOptions
10416 \end_layout
10417
10418 \end_inset
10419
10420  section can contain the following entries:
10421 \end_layout
10422
10423 \begin_layout Description
10424 \begin_inset Flex Code
10425 status collapsed
10426
10427 \begin_layout Plain Layout
10428 FontSize
10429 \end_layout
10430
10431 \end_inset
10432
10433  [
10434 \begin_inset Flex Code
10435 status collapsed
10436
10437 \begin_layout Plain Layout
10438 string="10|11|12"
10439 \end_layout
10440
10441 \end_inset
10442
10443 ] The list of available font sizes for the document's main font, separated
10444  by
10445 \begin_inset Quotes eld
10446 \end_inset
10447
10448
10449 \begin_inset Flex Code
10450 status collapsed
10451
10452 \begin_layout Plain Layout
10453 |
10454 \end_layout
10455
10456 \end_inset
10457
10458
10459 \begin_inset Quotes erd
10460 \end_inset
10461
10462 .
10463 \end_layout
10464
10465 \begin_layout Description
10466 \begin_inset Flex Code
10467 status collapsed
10468
10469 \begin_layout Plain Layout
10470 Header
10471 \end_layout
10472
10473 \end_inset
10474
10475  Used to set the DTD line with XML-based output classes.
10476  E.
10477 \begin_inset space \thinspace{}
10478 \end_inset
10479
10480 g.: PUBLIC
10481 \begin_inset Quotes eld
10482 \end_inset
10483
10484 -//OASIS//DTD DocBook V4.2//EN
10485 \begin_inset Quotes erd
10486 \end_inset
10487
10488 .
10489 \end_layout
10490
10491 \begin_layout Description
10492 \begin_inset Flex Code
10493 status collapsed
10494
10495 \begin_layout Plain Layout
10496 PageStyle
10497 \end_layout
10498
10499 \end_inset
10500
10501  [
10502 \begin_inset Flex Code
10503 status collapsed
10504
10505 \begin_layout Plain Layout
10506 string="empty|plain|headings|fancy"
10507 \end_layout
10508
10509 \end_inset
10510
10511 ] The list of available page sty\SpecialChar softhyphen
10512 les, separated by
10513 \begin_inset Quotes eld
10514 \end_inset
10515
10516
10517 \begin_inset Flex Code
10518 status collapsed
10519
10520 \begin_layout Plain Layout
10521 |
10522 \end_layout
10523
10524 \end_inset
10525
10526
10527 \begin_inset Quotes erd
10528 \end_inset
10529
10530 .
10531 \end_layout
10532
10533 \begin_layout Description
10534 \begin_inset Flex Code
10535 status collapsed
10536
10537 \begin_layout Plain Layout
10538 Other
10539 \end_layout
10540
10541 \end_inset
10542
10543  [
10544 \begin_inset Flex Code
10545 status collapsed
10546
10547 \begin_layout Plain Layout
10548 string=""
10549 \end_layout
10550
10551 \end_inset
10552
10553 ] Some document class options, separated by a comma, that will be added
10554  to the optional part of the
10555 \begin_inset Flex Code
10556 status collapsed
10557
10558 \begin_layout Plain Layout
10559
10560 \backslash
10561 documentclass
10562 \end_layout
10563
10564 \end_inset
10565
10566  command.
10567 \end_layout
10568
10569 \begin_layout Standard
10570 The
10571 \begin_inset Flex Code
10572 status collapsed
10573
10574 \begin_layout Plain Layout
10575 ClassOptions
10576 \end_layout
10577
10578 \end_inset
10579
10580  section must end with
10581 \begin_inset Quotes eld
10582 \end_inset
10583
10584
10585 \begin_inset Flex Code
10586 status collapsed
10587
10588 \begin_layout Plain Layout
10589 End
10590 \end_layout
10591
10592 \end_inset
10593
10594
10595 \begin_inset Quotes erd
10596 \end_inset
10597
10598 .
10599 \end_layout
10600
10601 \begin_layout Subsection
10602 Paragraph styles
10603 \begin_inset CommandInset label
10604 LatexCommand label
10605 name "subsec:Paragraph-Styles"
10606
10607 \end_inset
10608
10609
10610 \end_layout
10611
10612 \begin_layout Standard
10613 A paragraph style description looks like this:
10614 \begin_inset Foot
10615 status collapsed
10616
10617 \begin_layout Plain Layout
10618 Note that this will either define a new style or modify an existing one.
10619 \end_layout
10620
10621 \end_inset
10622
10623
10624 \end_layout
10625
10626 \begin_layout LyX-Code
10627 Style
10628 \family roman
10629 \emph on
10630 name
10631 \end_layout
10632
10633 \begin_layout LyX-Code
10634  ...
10635 \end_layout
10636
10637 \begin_layout LyX-Code
10638 End
10639 \end_layout
10640
10641 \begin_layout Standard
10642 where the following commands are allowed:
10643 \end_layout
10644
10645 \begin_layout Description
10646 \begin_inset Flex Code
10647 status collapsed
10648
10649 \begin_layout Plain Layout
10650 Align
10651 \end_layout
10652
10653 \end_inset
10654
10655  [
10656 \begin_inset Flex Code
10657 status collapsed
10658
10659 \begin_layout Plain Layout
10660
10661 \emph on
10662 block
10663 \emph default
10664 , left, right, center
10665 \end_layout
10666
10667 \end_inset
10668
10669 ] Paragraph alignment.
10670 \end_layout
10671
10672 \begin_layout Description
10673 \begin_inset Flex Code
10674 status collapsed
10675
10676 \begin_layout Plain Layout
10677 AlignPossible
10678 \end_layout
10679
10680 \end_inset
10681
10682  [
10683 \begin_inset Flex Code
10684 status collapsed
10685
10686 \begin_layout Plain Layout
10687
10688 \emph on
10689 block
10690 \emph default
10691 , left, right, center
10692 \end_layout
10693
10694 \end_inset
10695
10696 ] A comma separated list of permitted alignments.
10697  (Some \SpecialChar LaTeX
10698  styles prohibit certain alignments, since those wouldn't make sense.
10699  For example a right-aligned or centered enumeration isn't possible.)
10700 \end_layout
10701
10702 \begin_layout Description
10703 \begin_inset Flex Code
10704 status collapsed
10705
10706 \begin_layout Plain Layout
10707 Argument
10708 \end_layout
10709
10710 \end_inset
10711
10712  [
10713 \begin_inset Flex Code
10714 status collapsed
10715
10716 \begin_layout Plain Layout
10717 int
10718 \end_layout
10719
10720 \end_inset
10721
10722 ] Defines argument number <int> of a command\SpecialChar breakableslash
10723 environment associated with
10724  the current style.
10725  This is useful for things like section headings, and only makes sense with
10726  \SpecialChar LaTeX
10727 .
10728  Every (optional or required) argument of a command or environment – except
10729  for the required argument that is associated with the content of the paragraph
10730  itself – has a separate definition, where the number specifies the order
10731  of the arguments.
10732  The definition must end with
10733 \begin_inset Flex Code
10734 status collapsed
10735
10736 \begin_layout Plain Layout
10737 EndArgument
10738 \end_layout
10739
10740 \end_inset
10741
10742 .
10743  So a command with two optional arguments has:
10744 \end_layout
10745
10746 \begin_deeper
10747 \begin_layout Quote
10748
10749 \family typewriter
10750 Argument 1
10751 \end_layout
10752
10753 \begin_layout Quote
10754
10755 \family typewriter
10756 ...
10757 \end_layout
10758
10759 \begin_layout Quote
10760
10761 \family typewriter
10762 EndArgument
10763 \end_layout
10764
10765 \begin_layout Quote
10766
10767 \family typewriter
10768 Argument 2
10769 \end_layout
10770
10771 \begin_layout Quote
10772
10773 \family typewriter
10774 ...
10775 \end_layout
10776
10777 \begin_layout Quote
10778
10779 \family typewriter
10780 EndArgument
10781 \end_layout
10782
10783 \begin_layout Standard
10784 Inside the
10785 \begin_inset Flex Code
10786 status collapsed
10787
10788 \begin_layout Plain Layout
10789 Argument
10790 \end_layout
10791
10792 \end_inset
10793
10794  definition, the following specifications are possible:
10795 \end_layout
10796
10797 \begin_layout Itemize
10798 \begin_inset Flex Code
10799 status collapsed
10800
10801 \begin_layout Plain Layout
10802 LabelString
10803 \end_layout
10804
10805 \end_inset
10806
10807
10808 \begin_inset Flex Code
10809 status collapsed
10810
10811 \begin_layout Plain Layout
10812 [string]
10813 \end_layout
10814
10815 \end_inset
10816
10817  The string that will appear both in the menu (to insert this argument)
10818  and on the argument inset button (unless you also specify a separate
10819 \begin_inset Flex Code
10820 status collapsed
10821
10822 \begin_layout Plain Layout
10823 MenuString
10824 \end_layout
10825
10826 \end_inset
10827
10828 ).
10829  For the menu, you can define an accelerator by appending the respective
10830  character to the string, divided by
10831 \begin_inset Quotes eld
10832 \end_inset
10833
10834 |
10835 \begin_inset Quotes erd
10836 \end_inset
10837
10838  (e.
10839 \begin_inset space \thinspace{}
10840 \end_inset
10841
10842 g.
10843 \begin_inset space \space{}
10844 \end_inset
10845
10846
10847 \begin_inset Quotes eld
10848 \end_inset
10849
10850
10851 \begin_inset Flex Code
10852 status collapsed
10853
10854 \begin_layout Plain Layout
10855 Short Title|S
10856 \end_layout
10857
10858 \end_inset
10859
10860
10861 \begin_inset Quotes erd
10862 \end_inset
10863
10864 ).
10865 \end_layout
10866
10867 \begin_layout Itemize
10868 \begin_inset Flex Code
10869 status collapsed
10870
10871 \begin_layout Plain Layout
10872 MenuString
10873 \end_layout
10874
10875 \end_inset
10876
10877
10878 \begin_inset Flex Code
10879 status collapsed
10880
10881 \begin_layout Plain Layout
10882 [string]
10883 \end_layout
10884
10885 \end_inset
10886
10887  A separate string for the menu.
10888  You can define an accelerator by appending the respective character to
10889  the string, divided by
10890 \begin_inset Quotes eld
10891 \end_inset
10892
10893 |
10894 \begin_inset Quotes erd
10895 \end_inset
10896
10897  (e.
10898 \begin_inset space \thinspace{}
10899 \end_inset
10900
10901 g.
10902 \begin_inset space \space{}
10903 \end_inset
10904
10905
10906 \begin_inset Quotes eld
10907 \end_inset
10908
10909
10910 \begin_inset Flex Code
10911 status collapsed
10912
10913 \begin_layout Plain Layout
10914 Short Title|S
10915 \end_layout
10916
10917 \end_inset
10918
10919
10920 \begin_inset Quotes erd
10921 \end_inset
10922
10923 ).
10924  This specification is optional.
10925  If it is not given the
10926 \begin_inset Flex Code
10927 status collapsed
10928
10929 \begin_layout Plain Layout
10930 LabelString
10931 \end_layout
10932
10933 \end_inset
10934
10935  will be used instead for the menu.
10936 \end_layout
10937
10938 \begin_layout Itemize
10939 \begin_inset Flex Code
10940 status collapsed
10941
10942 \begin_layout Plain Layout
10943 Tooltip
10944 \end_layout
10945
10946 \end_inset
10947
10948
10949 \begin_inset Flex Code
10950 status collapsed
10951
10952 \begin_layout Plain Layout
10953 [string]
10954 \end_layout
10955
10956 \end_inset
10957
10958  A longer explanatory text that appears in the tooltip when hovering over
10959  the argument inset.
10960 \end_layout
10961
10962 \begin_layout Itemize
10963 \begin_inset Flex Code
10964 status collapsed
10965
10966 \begin_layout Plain Layout
10967 Mandatory
10968 \end_layout
10969
10970 \end_inset
10971
10972  [
10973 \begin_inset Flex Code
10974 status collapsed
10975
10976 \begin_layout Plain Layout
10977
10978 \emph on
10979 0
10980 \end_layout
10981
10982 \end_inset
10983
10984 ,
10985 \begin_inset space \thinspace{}
10986 \end_inset
10987
10988
10989 \begin_inset Flex Code
10990 status collapsed
10991
10992 \begin_layout Plain Layout
10993 1
10994 \end_layout
10995
10996 \end_inset
10997
10998 ] Declare if this is a mandatory (1) or an optional (0) argument.
10999  Mandatory arguments will be output empty if not given, while optional arguments
11000  will not be output at all.
11001  By default, mandatory arguments are delimited by
11002 \begin_inset Flex Code
11003 status collapsed
11004
11005 \begin_layout Plain Layout
11006 {...}
11007 \end_layout
11008
11009 \end_inset
11010
11011 , while optional arguments are delimited by
11012 \begin_inset Flex Code
11013 status collapsed
11014
11015 \begin_layout Plain Layout
11016 [...]
11017 \end_layout
11018
11019 \end_inset
11020
11021
11022 \end_layout
11023
11024 \begin_layout Itemize
11025 \begin_inset Flex Code
11026 status collapsed
11027
11028 \begin_layout Plain Layout
11029 Requires
11030 \end_layout
11031
11032 \end_inset
11033
11034
11035 \begin_inset Flex Code
11036 status collapsed
11037
11038 \begin_layout Plain Layout
11039 [int=0]
11040 \end_layout
11041
11042 \end_inset
11043
11044  defines another argument (by its number) which this argument requires to
11045  be output if it is itself output.
11046  E.
11047 \begin_inset space \thinspace{}
11048 \end_inset
11049
11050 g., in \SpecialChar LaTeX
11051  commands, optional arguments often require previous optional arguments
11052  to be output (at least empty), as in
11053 \begin_inset Flex Code
11054 status collapsed
11055
11056 \begin_layout Plain Layout
11057
11058 \backslash
11059 command[][argument]{text}
11060 \end_layout
11061
11062 \end_inset
11063
11064 .
11065  This can be achieved by the statement
11066 \begin_inset Flex Code
11067 status collapsed
11068
11069 \begin_layout Plain Layout
11070 Requires 1
11071 \end_layout
11072
11073 \end_inset
11074
11075  within
11076 \begin_inset Flex Code
11077 status collapsed
11078
11079 \begin_layout Plain Layout
11080 Argument 2
11081 \end_layout
11082
11083 \end_inset
11084
11085 .
11086 \end_layout
11087
11088 \begin_layout Itemize
11089 \begin_inset Flex Code
11090 status collapsed
11091
11092 \begin_layout Plain Layout
11093 LeftDelim
11094 \end_layout
11095
11096 \end_inset
11097
11098
11099 \begin_inset Flex Code
11100 status collapsed
11101
11102 \begin_layout Plain Layout
11103 [string]
11104 \end_layout
11105
11106 \end_inset
11107
11108  defines a custom left delimiter (instead of
11109 \begin_inset Flex Code
11110 status collapsed
11111
11112 \begin_layout Plain Layout
11113 {
11114 \end_layout
11115
11116 \end_inset
11117
11118  or
11119 \begin_inset Flex Code
11120 status collapsed
11121
11122 \begin_layout Plain Layout
11123 [
11124 \end_layout
11125
11126 \end_inset
11127
11128 ).
11129  A line break in the output can be indicated by
11130 \begin_inset Flex Code
11131 status collapsed
11132
11133 \begin_layout Plain Layout
11134 <br/>
11135 \end_layout
11136
11137 \end_inset
11138
11139 .
11140 \end_layout
11141
11142 \begin_layout Itemize
11143 \begin_inset Flex Code
11144 status collapsed
11145
11146 \begin_layout Plain Layout
11147 RightDelim
11148 \end_layout
11149
11150 \end_inset
11151
11152
11153 \begin_inset Flex Code
11154 status collapsed
11155
11156 \begin_layout Plain Layout
11157 [string]
11158 \end_layout
11159
11160 \end_inset
11161
11162  defines a custom right delimiter (instead of
11163 \begin_inset Flex Code
11164 status collapsed
11165
11166 \begin_layout Plain Layout
11167 }
11168 \end_layout
11169
11170 \end_inset
11171
11172  or
11173 \begin_inset Flex Code
11174 status collapsed
11175
11176 \begin_layout Plain Layout
11177 ]
11178 \end_layout
11179
11180 \end_inset
11181
11182 ).
11183  A line break in the output can be indicated by
11184 \begin_inset Flex Code
11185 status collapsed
11186
11187 \begin_layout Plain Layout
11188 <br/>
11189 \end_layout
11190
11191 \end_inset
11192
11193 .
11194 \end_layout
11195
11196 \begin_layout Itemize
11197 \begin_inset Flex Code
11198 status collapsed
11199
11200 \begin_layout Plain Layout
11201 DefaultArg
11202 \end_layout
11203
11204 \end_inset
11205
11206
11207 \begin_inset Flex Code
11208 status collapsed
11209
11210 \begin_layout Plain Layout
11211 [string]
11212 \end_layout
11213
11214 \end_inset
11215
11216  defines an argument that is inserted if and only if no user-specified arguments
11217  were given, i.
11218 \begin_inset space \thinspace{}
11219 \end_inset
11220
11221 e.
11222 \begin_inset space \space{}
11223 \end_inset
11224
11225 if no argument inset has been inserted (note that also an empty argument
11226  inset omits the DefaultArg).
11227  Multiple arguments need to be separated by comma.
11228 \end_layout
11229
11230 \begin_layout Itemize
11231 \begin_inset Flex Code
11232 status collapsed
11233
11234 \begin_layout Plain Layout
11235 PresetArg
11236 \end_layout
11237
11238 \end_inset
11239
11240
11241 \begin_inset Flex Code
11242 status collapsed
11243
11244 \begin_layout Plain Layout
11245 [string]
11246 \end_layout
11247
11248 \end_inset
11249
11250  defines an argument that is inserted in any case (alone or in addition
11251  to user-specified arguments).
11252  Multiple arguments need to be separated by comma.
11253 \end_layout
11254
11255 \begin_layout Itemize
11256 \begin_inset Flex Code
11257 status collapsed
11258
11259 \begin_layout Plain Layout
11260 Font
11261 \end_layout
11262
11263 \end_inset
11264
11265  The font used for the argument content, see
11266 \begin_inset CommandInset ref
11267 LatexCommand ref
11268 reference "subsec:Font-description"
11269
11270 \end_inset
11271
11272 .
11273 \end_layout
11274
11275 \begin_layout Itemize
11276 \begin_inset Flex Code
11277 status collapsed
11278
11279 \begin_layout Plain Layout
11280 LabelFont
11281 \end_layout
11282
11283 \end_inset
11284
11285  The font used for the label; see
11286 \begin_inset CommandInset ref
11287 LatexCommand ref
11288 reference "subsec:Font-description"
11289
11290 \end_inset
11291
11292 .
11293 \end_layout
11294
11295 \begin_layout Itemize
11296 \begin_inset Flex Code
11297 status collapsed
11298
11299 \begin_layout Plain Layout
11300 Decoration
11301 \end_layout
11302
11303 \end_inset
11304
11305  [
11306 \begin_inset Flex Code
11307 status collapsed
11308
11309 \begin_layout Plain Layout
11310
11311 \emph on
11312 Classic
11313 \emph default
11314 , Minimalistic, Conglomerate
11315 \end_layout
11316
11317 \end_inset
11318
11319 ] describes the rendering style used for the inset's frame and buttons.
11320 \end_layout
11321
11322 \begin_layout Itemize
11323 \begin_inset Flex Code
11324 status collapsed
11325
11326 \begin_layout Plain Layout
11327 AutoInsert
11328 \end_layout
11329
11330 \end_inset
11331
11332
11333 \begin_inset Flex Code
11334 status collapsed
11335
11336 \begin_layout Plain Layout
11337 [int=0]
11338 \end_layout
11339
11340 \end_inset
11341
11342  If this is set to
11343 \begin_inset Flex Code
11344 status collapsed
11345
11346 \begin_layout Plain Layout
11347 1
11348 \end_layout
11349
11350 \end_inset
11351
11352 , this argument is automatically inserted when the respective style is selected.
11353  Currently, only one argument per style\SpecialChar breakableslash
11354 layout can be automatically inserted.
11355 \end_layout
11356
11357 \begin_layout Itemize
11358 \begin_inset Flex Code
11359 status collapsed
11360
11361 \begin_layout Plain Layout
11362 InsertCotext
11363 \end_layout
11364
11365 \end_inset
11366
11367
11368 \begin_inset Flex Code
11369 status collapsed
11370
11371 \begin_layout Plain Layout
11372 [int=0]
11373 \end_layout
11374
11375 \end_inset
11376
11377  If this is set to
11378 \begin_inset Flex Code
11379 status collapsed
11380
11381 \begin_layout Plain Layout
11382 1
11383 \end_layout
11384
11385 \end_inset
11386
11387 , this argument will be inserted with a copy of the co-text (either selected
11388  text or the whole paragraph) as content.
11389 \change_inserted -712698321 1477038290
11390
11391 \end_layout
11392
11393 \begin_layout Itemize
11394
11395 \change_inserted -712698321 1477038425
11396 \begin_inset Flex Code
11397 status collapsed
11398
11399 \begin_layout Plain Layout
11400
11401 \change_inserted -712698321 1477038295
11402 PassThru
11403 \end_layout
11404
11405 \end_inset
11406
11407  [
11408 \begin_inset Flex Code
11409 status collapsed
11410
11411 \begin_layout Plain Layout
11412
11413 \change_inserted -712698321 1477038311
11414
11415 \emph on
11416 inherited
11417 \emph default
11418 , true, false
11419 \end_layout
11420
11421 \end_inset
11422
11423 ] Whether the contents of this argument should be output in raw form, meaning
11424  without special translations that \SpecialChar LaTeX
11425  would require.
11426  By default, the
11427 \begin_inset Flex Code
11428 status collapsed
11429
11430 \begin_layout Plain Layout
11431
11432 \change_inserted -712698321 1477038356
11433 PassThru
11434 \end_layout
11435
11436 \end_inset
11437
11438  status is inherited by the inset or paragraph layout the argument belongs
11439  to, true and false change the status for the given argument only.
11440 \change_unchanged
11441
11442 \end_layout
11443
11444 \begin_layout Itemize
11445 \begin_inset Flex Code
11446 status collapsed
11447
11448 \begin_layout Plain Layout
11449 PassThruChars
11450 \end_layout
11451
11452 \end_inset
11453
11454  [
11455 \begin_inset Flex Code
11456 status collapsed
11457
11458 \begin_layout Plain Layout
11459 string of characters
11460 \end_layout
11461
11462 \end_inset
11463
11464 ]
11465 \family typewriter
11466
11467 \family default
11468 Defines individual characters that should be output in raw form, meaning
11469  without special translations that \SpecialChar LaTeX
11470  would require.
11471  Note that, contrary to PassThru, this needs to be explicitly defined for
11472  arguments.
11473  That is, arguments do not inherit PassThruChars from their parent inset
11474  or layout.
11475 \end_layout
11476
11477 \begin_layout Standard
11478 By default, the text entered in the \SpecialChar LyX
11479  workarea in the respective layout is
11480  the last (mandatory) argument of a command if the
11481 \begin_inset Flex Code
11482 status collapsed
11483
11484 \begin_layout Plain Layout
11485 LatexType
11486 \end_layout
11487
11488 \end_inset
11489
11490  is
11491 \begin_inset Flex Code
11492 status collapsed
11493
11494 \begin_layout Plain Layout
11495 Command
11496 \end_layout
11497
11498 \end_inset
11499
11500 .
11501  However, arguments with the prefix
11502 \begin_inset Flex Code
11503 status collapsed
11504
11505 \begin_layout Plain Layout
11506 post:
11507 \end_layout
11508
11509 \end_inset
11510
11511  are output after this workarea argument.
11512  Note that post-argument numbering restarts at 1, so the first argument
11513  following the workarea argument is
11514 \begin_inset Flex Code
11515 status collapsed
11516
11517 \begin_layout Plain Layout
11518 post:1
11519 \end_layout
11520
11521 \end_inset
11522
11523 .
11524  Post-arguments are ignored in any other
11525 \begin_inset Flex Code
11526 status collapsed
11527
11528 \begin_layout Plain Layout
11529 LatexType
11530 \end_layout
11531
11532 \end_inset
11533
11534  than
11535 \begin_inset Flex Code
11536 status collapsed
11537
11538 \begin_layout Plain Layout
11539 Command
11540 \end_layout
11541
11542 \end_inset
11543
11544 .
11545 \end_layout
11546
11547 \begin_layout Standard
11548 Arguments for list
11549 \begin_inset Flex Code
11550 status collapsed
11551
11552 \begin_layout Plain Layout
11553
11554 \backslash
11555 item
11556 \end_layout
11557
11558 \end_inset
11559
11560 s (as in
11561 \begin_inset Flex Code
11562 status collapsed
11563
11564 \begin_layout Plain Layout
11565
11566 \backslash
11567 item[foo]
11568 \end_layout
11569
11570 \end_inset
11571
11572 ) have the prefix
11573 \begin_inset Flex Code
11574 status collapsed
11575
11576 \begin_layout Plain Layout
11577 item:
11578 \end_layout
11579
11580 \end_inset
11581
11582  followed by the number (e.
11583 \begin_inset space \thinspace{}
11584 \end_inset
11585
11586 g.
11587 \begin_inset space \space{}
11588 \end_inset
11589
11590
11591 \begin_inset Flex Code
11592 status collapsed
11593
11594 \begin_layout Plain Layout
11595 Argument item:1
11596 \end_layout
11597
11598 \end_inset
11599
11600 ).
11601 \end_layout
11602
11603 \end_deeper
11604 \begin_layout Description
11605 \begin_inset Flex Code
11606 status collapsed
11607
11608 \begin_layout Plain Layout
11609 BabelPreamble
11610 \end_layout
11611
11612 \end_inset
11613
11614  Note that this will completely override any prior
11615 \begin_inset Flex Code
11616 status collapsed
11617
11618 \begin_layout Plain Layout
11619 BabelPreamble
11620 \end_layout
11621
11622 \end_inset
11623
11624  declaration for this style.
11625  Must end with
11626 \begin_inset Quotes eld
11627 \end_inset
11628
11629
11630 \begin_inset Flex Code
11631 status collapsed
11632
11633 \begin_layout Plain Layout
11634 EndBabelPreamble
11635 \end_layout
11636
11637 \end_inset
11638
11639
11640 \begin_inset Quotes erd
11641 \end_inset
11642
11643 .
11644  See
11645 \begin_inset CommandInset ref
11646 LatexCommand ref
11647 reference "subsec:I18n"
11648
11649 \end_inset
11650
11651  for details on its use.
11652 \end_layout
11653
11654 \begin_layout Description
11655 \begin_inset Flex Code
11656 status collapsed
11657
11658 \begin_layout Plain Layout
11659 BottomSep
11660 \end_layout
11661
11662 \end_inset
11663
11664  [
11665 \begin_inset Flex Code
11666 status collapsed
11667
11668 \begin_layout Plain Layout
11669 float=0
11670 \end_layout
11671
11672 \end_inset
11673
11674 ]
11675 \begin_inset Foot
11676 status collapsed
11677
11678 \begin_layout Plain Layout
11679 Note that a `float' here is a real number, such as: 1.5.
11680 \end_layout
11681
11682 \end_inset
11683
11684  The vertical space with which the last of a chain of paragraphs with this
11685  style is separated from the following paragraph.
11686  If the next paragraph has another style, the separations are not simply
11687  added, but the maximum is taken.
11688 \end_layout
11689
11690 \begin_layout Description
11691 \begin_inset Flex Code
11692 status collapsed
11693
11694 \begin_layout Plain Layout
11695 Category
11696 \end_layout
11697
11698 \end_inset
11699
11700  [
11701 \begin_inset Flex Code
11702 status collapsed
11703
11704 \begin_layout Plain Layout
11705 string
11706 \end_layout
11707
11708 \end_inset
11709
11710 ] The category for this style.
11711  This is used to group related styles in the style combobox on the toolbar.
11712  Any string can be used, but you may want to use existing categories with
11713  your own styles.
11714
11715 \end_layout
11716
11717 \begin_layout Description
11718 \begin_inset Flex Code
11719 status collapsed
11720
11721 \begin_layout Plain Layout
11722 CommandDepth
11723 \end_layout
11724
11725 \end_inset
11726
11727  Depth of XML command.
11728  Used only with XML-type formats.
11729 \end_layout
11730
11731 \begin_layout Description
11732 \begin_inset Flex Code
11733 status collapsed
11734
11735 \begin_layout Plain Layout
11736 CopyStyle
11737 \end_layout
11738
11739 \end_inset
11740
11741  [
11742 \begin_inset Flex Code
11743 status collapsed
11744
11745 \begin_layout Plain Layout
11746 string
11747 \end_layout
11748
11749 \end_inset
11750
11751 ] Copies all the features of an existing style into the current one.
11752
11753 \end_layout
11754
11755 \begin_layout Description
11756 \begin_inset Flex Code
11757 status collapsed
11758
11759 \begin_layout Plain Layout
11760 DependsOn
11761 \end_layout
11762
11763 \end_inset
11764
11765  [
11766 \begin_inset Flex Code
11767 status collapsed
11768
11769 \begin_layout Plain Layout
11770 <name>
11771 \end_layout
11772
11773 \end_inset
11774
11775 ] The name of a style whose preamble should be output
11776 \emph on
11777 before
11778 \emph default
11779  this one.
11780  This allows to ensure some ordering of the preamble snippets when macros
11781  definitions depend on one another.
11782 \begin_inset Foot
11783 status collapsed
11784
11785 \begin_layout Plain Layout
11786 Note that, besides that functionality, there is no way to ensure any ordering
11787  of preambles.
11788  The ordering that you see in a given version of \SpecialChar LyX
11789  may change without warning
11790  in later versions.
11791 \end_layout
11792
11793 \end_inset
11794
11795
11796 \end_layout
11797
11798 \begin_layout Description
11799 \begin_inset Flex Code
11800 status collapsed
11801
11802 \begin_layout Plain Layout
11803 EndLabeltype
11804 \end_layout
11805
11806 \end_inset
11807
11808  [
11809 \begin_inset Flex Code
11810 status collapsed
11811
11812 \begin_layout Plain Layout
11813
11814 \emph on
11815 No_Label
11816 \emph default
11817 , Box, Filled_Box, Static
11818 \end_layout
11819
11820 \end_inset
11821
11822 ] The type of label that stands at the end of the paragraph (or sequence
11823  of paragraphs if
11824 \begin_inset Flex Code
11825 status collapsed
11826
11827 \begin_layout Plain Layout
11828 LatexType
11829 \end_layout
11830
11831 \end_inset
11832
11833  is
11834 \begin_inset Newline newline
11835 \end_inset
11836
11837
11838 \begin_inset Flex Code
11839 status collapsed
11840
11841 \begin_layout Plain Layout
11842 Environment
11843 \end_layout
11844
11845 \end_inset
11846
11847 ,
11848 \begin_inset Flex Code
11849 status collapsed
11850
11851 \begin_layout Plain Layout
11852 Item_Environment
11853 \end_layout
11854
11855 \end_inset
11856
11857  or
11858 \begin_inset Flex Code
11859 status collapsed
11860
11861 \begin_layout Plain Layout
11862 List_Environment
11863 \end_layout
11864
11865 \end_inset
11866
11867 ).
11868
11869 \begin_inset Flex Code
11870 status collapsed
11871
11872 \begin_layout Plain Layout
11873 No_Label
11874 \end_layout
11875
11876 \end_inset
11877
11878  means
11879 \begin_inset Quotes eld
11880 \end_inset
11881
11882 nothing
11883 \begin_inset Quotes erd
11884 \end_inset
11885
11886 ,
11887 \begin_inset Flex Code
11888 status collapsed
11889
11890 \begin_layout Plain Layout
11891 Box
11892 \end_layout
11893
11894 \end_inset
11895
11896  (resp.
11897 \begin_inset space \space{}
11898 \end_inset
11899
11900
11901 \begin_inset Flex Code
11902 status collapsed
11903
11904 \begin_layout Plain Layout
11905 Filled_Box
11906 \end_layout
11907
11908 \end_inset
11909
11910 ) is a white (resp.
11911 \begin_inset space ~
11912 \end_inset
11913
11914 black) square suitable for end of proof markers,
11915 \begin_inset Flex Code
11916 status collapsed
11917
11918 \begin_layout Plain Layout
11919 Static
11920 \end_layout
11921
11922 \end_inset
11923
11924  is an explicit text string.
11925 \end_layout
11926
11927 \begin_layout Description
11928 \begin_inset Flex Code
11929 status collapsed
11930
11931 \begin_layout Plain Layout
11932 EndLabelString
11933 \end_layout
11934
11935 \end_inset
11936
11937  [
11938 \begin_inset Flex Code
11939 status collapsed
11940
11941 \begin_layout Plain Layout
11942 string=""
11943 \end_layout
11944
11945 \end_inset
11946
11947 ] The string used for a label with a
11948 \begin_inset Flex Code
11949 status collapsed
11950
11951 \begin_layout Plain Layout
11952 Static
11953 \end_layout
11954
11955 \end_inset
11956
11957
11958 \begin_inset Newline newline
11959 \end_inset
11960
11961
11962 \begin_inset Flex Code
11963 status collapsed
11964
11965 \begin_layout Plain Layout
11966 EndLabelType
11967 \end_layout
11968
11969 \end_inset
11970
11971 .
11972
11973 \end_layout
11974
11975 \begin_layout Description
11976 \begin_inset Flex Code
11977 status collapsed
11978
11979 \begin_layout Plain Layout
11980 Font
11981 \end_layout
11982
11983 \end_inset
11984
11985  The font used for both the text body
11986 \emph on
11987 and
11988 \emph default
11989  the label.
11990  See
11991 \begin_inset CommandInset ref
11992 LatexCommand ref
11993 reference "subsec:Font-description"
11994
11995 \end_inset
11996
11997 .
11998  Note that defining this font automatically defines the
11999 \begin_inset Flex Code
12000 status collapsed
12001
12002 \begin_layout Plain Layout
12003 LabelFont
12004 \end_layout
12005
12006 \end_inset
12007
12008  to the same value.
12009  So you should define this one first if you also want to define
12010 \begin_inset Flex Code
12011 status collapsed
12012
12013 \begin_layout Plain Layout
12014 LabelFont
12015 \end_layout
12016
12017 \end_inset
12018
12019 .
12020 \end_layout
12021
12022 \begin_layout Description
12023 \begin_inset Flex Code
12024 status collapsed
12025
12026 \begin_layout Plain Layout
12027 ForceLocal
12028 \end_layout
12029
12030 \end_inset
12031
12032  [
12033 \begin_inset Flex Code
12034 status collapsed
12035
12036 \begin_layout Plain Layout
12037 int=0
12038 \end_layout
12039
12040 \end_inset
12041
12042 ] Used for backporting new styles to stable \SpecialChar LyX
12043  versions.
12044  The first stable version that supports this tag is \SpecialChar LyX
12045  2.1.0.
12046  The argument is a number which may either be 0, -1 or any value greater
12047  than zero.
12048  If the
12049 \begin_inset Flex Code
12050 status collapsed
12051
12052 \begin_layout Plain Layout
12053 ForceLocal
12054 \end_layout
12055
12056 \end_inset
12057
12058  flag of a style is greater than zero, it will always be written to the
12059  document header.
12060  If a .lyx file is read, the style definitions from the document header are
12061  added to the document class.
12062  Therefore even older \SpecialChar LyX
12063  versions can handle the style.
12064  The argument of
12065 \begin_inset Flex Code
12066 status collapsed
12067
12068 \begin_layout Plain Layout
12069 ForceLocal
12070 \end_layout
12071
12072 \end_inset
12073
12074  is a version number: if the style is read, and the version number is less
12075  than the version number of the already existing style in the document class,
12076  the new style is ignored.
12077  If the version number is greater, the new style replaces the existing style.
12078  A value of -1 means an infinite version number, i.
12079 \begin_inset space \thinspace{}
12080 \end_inset
12081
12082 e.
12083 \begin_inset space \space{}
12084 \end_inset
12085
12086 the style is always used.
12087 \end_layout
12088
12089 \begin_layout Description
12090 \begin_inset Flex Code
12091 status collapsed
12092
12093 \begin_layout Plain Layout
12094 FreeSpacing
12095 \end_layout
12096
12097 \end_inset
12098
12099  [
12100 \begin_inset Flex Code
12101 status collapsed
12102
12103 \begin_layout Plain Layout
12104
12105 \emph on
12106 0
12107 \end_layout
12108
12109 \end_inset
12110
12111 ,
12112 \begin_inset space \thinspace{}
12113 \end_inset
12114
12115
12116 \begin_inset Flex Code
12117 status collapsed
12118
12119 \begin_layout Plain Layout
12120 1
12121 \end_layout
12122
12123 \end_inset
12124
12125 ] Usually \SpecialChar LyX
12126  does not allow you to insert more than one space between words,
12127  since a space is considered as the separation between two words, not a
12128  character or symbol of its own.
12129  This is a very fine thing but sometimes annoying, for example, when typing
12130  program code or plain \SpecialChar LaTeX
12131  code.
12132  For this reason,
12133 \begin_inset Flex Code
12134 status collapsed
12135
12136 \begin_layout Plain Layout
12137 FreeSpacing
12138 \end_layout
12139
12140 \end_inset
12141
12142  can be enabled.
12143  Note that \SpecialChar LyX
12144  will create protected blanks for the additional blanks when
12145  in another mode than \SpecialChar LaTeX
12146 -mode.
12147 \end_layout
12148
12149 \begin_layout Description
12150 \begin_inset Flex Code
12151 status collapsed
12152
12153 \begin_layout Plain Layout
12154 HTML*
12155 \end_layout
12156
12157 \end_inset
12158
12159  These tags are used with XHTML output.
12160  See
12161 \begin_inset CommandInset ref
12162 LatexCommand ref
12163 reference "subsec:Paragraph-Style-XHTML"
12164
12165 \end_inset
12166
12167 .
12168 \end_layout
12169
12170 \begin_layout Description
12171 \begin_inset Flex Code
12172 status collapsed
12173
12174 \begin_layout Plain Layout
12175 InnerTag
12176 \end_layout
12177
12178 \end_inset
12179
12180  [FIXME] (Used only with XML-type formats.)
12181 \end_layout
12182
12183 \begin_layout Description
12184 \begin_inset Flex Code
12185 status collapsed
12186
12187 \begin_layout Plain Layout
12188 InPreamble
12189 \end_layout
12190
12191 \end_inset
12192
12193  [
12194 \begin_inset Flex Code
12195 status collapsed
12196
12197 \begin_layout Plain Layout
12198
12199 \emph on
12200 0
12201 \end_layout
12202
12203 \end_inset
12204
12205 ,
12206 \begin_inset space \thinspace{}
12207 \end_inset
12208
12209
12210 \begin_inset Flex Code
12211 status collapsed
12212
12213 \begin_layout Plain Layout
12214 1
12215 \end_layout
12216
12217 \end_inset
12218
12219 ] If
12220 \begin_inset Flex Code
12221 status collapsed
12222
12223 \begin_layout Plain Layout
12224 1
12225 \end_layout
12226
12227 \end_inset
12228
12229 , marks the style as to be included in the document preamble and not in
12230  the document body.
12231  This is useful for document classes that want such information as the title
12232  and author to appear in the preamble.
12233  Note that this works only for styles for which the
12234 \begin_inset Flex Code
12235 status collapsed
12236
12237 \begin_layout Plain Layout
12238 LatexType
12239 \end_layout
12240
12241 \end_inset
12242
12243  is
12244 \begin_inset Flex Code
12245 status collapsed
12246
12247 \begin_layout Plain Layout
12248 Command
12249 \end_layout
12250
12251 \end_inset
12252
12253  or
12254 \begin_inset Flex Code
12255 status collapsed
12256
12257 \begin_layout Plain Layout
12258 Paragraph
12259 \end_layout
12260
12261 \end_inset
12262
12263 .
12264 \end_layout
12265
12266 \begin_layout Description
12267 \begin_inset Flex Code
12268 status collapsed
12269
12270 \begin_layout Plain Layout
12271 InTitle
12272 \end_layout
12273
12274 \end_inset
12275
12276  [
12277 \begin_inset Flex Code
12278 status collapsed
12279
12280 \begin_layout Plain Layout
12281
12282 \emph on
12283 0
12284 \end_layout
12285
12286 \end_inset
12287
12288 ,
12289 \begin_inset space \thinspace{}
12290 \end_inset
12291
12292
12293 \begin_inset Flex Code
12294 status collapsed
12295
12296 \begin_layout Plain Layout
12297 1
12298 \end_layout
12299
12300 \end_inset
12301
12302 ] If
12303 \begin_inset Flex Code
12304 status collapsed
12305
12306 \begin_layout Plain Layout
12307 1
12308 \end_layout
12309
12310 \end_inset
12311
12312 , marks the style as being part of a title block (see also the
12313 \begin_inset Flex Code
12314 status collapsed
12315
12316 \begin_layout Plain Layout
12317 TitleLatexType
12318 \end_layout
12319
12320 \end_inset
12321
12322  and
12323 \begin_inset Flex Code
12324 status collapsed
12325
12326 \begin_layout Plain Layout
12327 TitleLatexName
12328 \end_layout
12329
12330 \end_inset
12331
12332  global entries).
12333 \end_layout
12334
12335 \begin_layout Description
12336 \begin_inset Flex Code
12337 status collapsed
12338
12339 \begin_layout Plain Layout
12340 ItemCommand
12341 \end_layout
12342
12343 \end_inset
12344
12345  [
12346 \begin_inset Flex Code
12347 status collapsed
12348
12349 \begin_layout Plain Layout
12350 string="item"
12351 \end_layout
12352
12353 \end_inset
12354
12355 ] The \SpecialChar LaTeX
12356  command sequence declaring an item in a list.
12357  The command is to be defined without the preceding backslash (the default
12358  is
12359 \begin_inset Quotes eld
12360 \end_inset
12361
12362 item
12363 \begin_inset Quotes erd
12364 \end_inset
12365
12366 , resulting in
12367 \begin_inset Flex Code
12368 status collapsed
12369
12370 \begin_layout Plain Layout
12371
12372 \backslash
12373 item
12374 \end_layout
12375
12376 \end_inset
12377
12378  in the \SpecialChar LaTeX
12379  output).
12380 \end_layout
12381
12382 \begin_layout Description
12383 \begin_inset Flex Code
12384 status collapsed
12385
12386 \begin_layout Plain Layout
12387 ItemSep
12388 \end_layout
12389
12390 \end_inset
12391
12392  [
12393 \begin_inset Flex Code
12394 status collapsed
12395
12396 \begin_layout Plain Layout
12397 float=0
12398 \end_layout
12399
12400 \end_inset
12401
12402 ] This provides extra space between paragraphs that have the same style.
12403  If you put other styles into an environment, each is separated with the
12404  environment's
12405 \begin_inset Flex Code
12406 status collapsed
12407
12408 \begin_layout Plain Layout
12409 ParSep
12410 \end_layout
12411
12412 \end_inset
12413
12414 .
12415  But the whole items of the environment are additionally separated with
12416  this
12417 \begin_inset Flex Code
12418 status collapsed
12419
12420 \begin_layout Plain Layout
12421 ItemSep
12422 \end_layout
12423
12424 \end_inset
12425
12426 .
12427  Note that this is a
12428 \emph on
12429  multiplier.
12430 \end_layout
12431
12432 \begin_layout Description
12433 \begin_inset Flex Code
12434 status collapsed
12435
12436 \begin_layout Plain Layout
12437 ItemTag
12438 \end_layout
12439
12440 \end_inset
12441
12442  [FIXME] (Used only with XML-type formats.)
12443 \end_layout
12444
12445 \begin_layout Description
12446 \begin_inset Flex Code
12447 status collapsed
12448
12449 \begin_layout Plain Layout
12450 KeepEmpty
12451 \end_layout
12452
12453 \end_inset
12454
12455  [
12456 \begin_inset Flex Code
12457 status collapsed
12458
12459 \begin_layout Plain Layout
12460
12461 \emph on
12462 0
12463 \end_layout
12464
12465 \end_inset
12466
12467 ,
12468 \begin_inset space \thinspace{}
12469 \end_inset
12470
12471
12472 \begin_inset Flex Code
12473 status collapsed
12474
12475 \begin_layout Plain Layout
12476 1
12477 \end_layout
12478
12479 \end_inset
12480
12481 ] Usually \SpecialChar LyX
12482  does not allow you to leave a paragraph empty, since it would
12483  lead to empty \SpecialChar LaTeX
12484  output.
12485  There are some cases where this could be desirable however: in a letter
12486  template, the required fields can be provided as empty fields, so that
12487  people do not forget them; in some special classes, a style can be used
12488  as some kind of break, which does not contain actual text.
12489 \end_layout
12490
12491 \begin_layout Description
12492 \begin_inset Flex Code
12493 status collapsed
12494
12495 \begin_layout Plain Layout
12496 LabelBottomsep
12497 \end_layout
12498
12499 \end_inset
12500
12501  [
12502 \begin_inset Flex Code
12503 status collapsed
12504
12505 \begin_layout Plain Layout
12506 float=0
12507 \end_layout
12508
12509 \end_inset
12510
12511 ] The vertical space between the label and the text body.
12512  Only used for labels that are above the text body (
12513 \begin_inset Flex Code
12514 status collapsed
12515
12516 \begin_layout Plain Layout
12517 Top_Environment
12518 \end_layout
12519
12520 \end_inset
12521
12522  and
12523 \begin_inset Newline newline
12524 \end_inset
12525
12526
12527 \begin_inset Flex Code
12528 status collapsed
12529
12530 \begin_layout Plain Layout
12531 Centered_Top_Environment
12532 \end_layout
12533
12534 \end_inset
12535
12536 ).
12537 \end_layout
12538
12539 \begin_layout Description
12540 \begin_inset Flex Code
12541 status collapsed
12542
12543 \begin_layout Plain Layout
12544 LabelCounter
12545 \end_layout
12546
12547 \end_inset
12548
12549  [
12550 \begin_inset Flex Code
12551 status collapsed
12552
12553 \begin_layout Plain Layout
12554 string=""
12555 \end_layout
12556
12557 \end_inset
12558
12559 ] The name of the counter for automatic numbering.
12560  In order to have the counter appear with your label, you will need to reference
12561  it in the
12562 \begin_inset Flex Code
12563 status collapsed
12564
12565 \begin_layout Plain Layout
12566
12567 \family typewriter
12568 LabelString
12569 \end_layout
12570
12571 \end_inset
12572
12573 .
12574  This will work with
12575 \begin_inset Flex Code
12576 status collapsed
12577
12578 \begin_layout Plain Layout
12579 LabelType
12580 \end_layout
12581
12582 \end_inset
12583
12584 s,
12585 \begin_inset Flex Code
12586 status collapsed
12587
12588 \begin_layout Plain Layout
12589 Static
12590 \end_layout
12591
12592 \end_inset
12593
12594 ,
12595 \begin_inset Flex Code
12596 status collapsed
12597
12598 \begin_layout Plain Layout
12599 Above
12600 \end_layout
12601
12602 \end_inset
12603
12604  and
12605 \begin_inset Flex Code
12606 status collapsed
12607
12608 \begin_layout Plain Layout
12609 Centered
12610 \end_layout
12611
12612 \end_inset
12613
12614 , at least.
12615 \begin_inset Newline newline
12616 \end_inset
12617
12618 This
12619 \emph on
12620 may
12621 \emph default
12622  also be given if
12623 \begin_inset Flex Code
12624 status collapsed
12625
12626 \begin_layout Plain Layout
12627 LabelType
12628 \end_layout
12629
12630 \end_inset
12631
12632  is
12633 \begin_inset Flex Code
12634 status collapsed
12635
12636 \begin_layout Plain Layout
12637 Enumerate
12638 \end_layout
12639
12640 \end_inset
12641
12642 , though this case is a bit complicated.
12643  Suppose you declare
12644 \begin_inset Quotes eld
12645 \end_inset
12646
12647
12648 \begin_inset Flex Code
12649 status collapsed
12650
12651 \begin_layout Plain Layout
12652 LabelCounter myenum
12653 \end_layout
12654
12655 \end_inset
12656
12657
12658 \begin_inset Quotes erd
12659 \end_inset
12660
12661 .
12662  Then the actual counters used are
12663 \begin_inset Flex Code
12664 status collapsed
12665
12666 \begin_layout Plain Layout
12667 myenumi
12668 \end_layout
12669
12670 \end_inset
12671
12672 ,
12673 \begin_inset Flex Code
12674 status collapsed
12675
12676 \begin_layout Plain Layout
12677 myenumii
12678 \end_layout
12679
12680 \end_inset
12681
12682 ,
12683 \begin_inset Flex Code
12684 status collapsed
12685
12686 \begin_layout Plain Layout
12687 myenumiii
12688 \end_layout
12689
12690 \end_inset
12691
12692  and
12693 \begin_inset Flex Code
12694 status collapsed
12695
12696 \begin_layout Plain Layout
12697 myenumiv
12698 \end_layout
12699
12700 \end_inset
12701
12702 , much as in \SpecialChar LaTeX
12703 .
12704  These counters must all be declared separately.
12705 \begin_inset Newline newline
12706 \end_inset
12707
12708 See
12709 \begin_inset CommandInset ref
12710 LatexCommand ref
12711 reference "subsec:Counters"
12712
12713 \end_inset
12714
12715  for details on counters.
12716 \end_layout
12717
12718 \begin_layout Description
12719 \begin_inset Flex Code
12720 status collapsed
12721
12722 \begin_layout Plain Layout
12723 LabelFont
12724 \end_layout
12725
12726 \end_inset
12727
12728  The font used for the label.
12729  See
12730 \begin_inset CommandInset ref
12731 LatexCommand ref
12732 reference "subsec:Font-description"
12733
12734 \end_inset
12735
12736 .
12737 \end_layout
12738
12739 \begin_layout Description
12740 \begin_inset Flex Code
12741 status collapsed
12742
12743 \begin_layout Plain Layout
12744 LabelIndent
12745 \end_layout
12746
12747 \end_inset
12748
12749  [
12750 \begin_inset Flex Code
12751 status collapsed
12752
12753 \begin_layout Plain Layout
12754 string=""
12755 \end_layout
12756
12757 \end_inset
12758
12759 ] Text that indicates how far a label should be indented.
12760 \end_layout
12761
12762 \begin_layout Description
12763 \begin_inset Flex Code
12764 status collapsed
12765
12766 \begin_layout Plain Layout
12767 LabelSep
12768 \end_layout
12769
12770 \end_inset
12771
12772  [
12773 \begin_inset Flex Code
12774 status collapsed
12775
12776 \begin_layout Plain Layout
12777 string=""
12778 \end_layout
12779
12780 \end_inset
12781
12782 ] Text that indicates the amount of horizontal space between the label and
12783  the text body.
12784  Only used for labels that are not above the text body.
12785 \end_layout
12786
12787 \begin_layout Description
12788 \begin_inset Flex Code
12789 status collapsed
12790
12791 \begin_layout Plain Layout
12792 LabelString
12793 \end_layout
12794
12795 \end_inset
12796
12797  [
12798 \begin_inset Flex Code
12799 status collapsed
12800
12801 \begin_layout Plain Layout
12802 string=""
12803 \end_layout
12804
12805 \end_inset
12806
12807 ] The string used for the label.
12808  When
12809 \begin_inset Flex Code
12810 status collapsed
12811
12812 \begin_layout Plain Layout
12813 LabelCounter
12814 \end_layout
12815
12816 \end_inset
12817
12818  is set, this string can be contain the special formatting commands described
12819  in
12820 \begin_inset CommandInset ref
12821 LatexCommand ref
12822 reference "subsec:Counters"
12823
12824 \end_inset
12825
12826 .
12827 \end_layout
12828
12829 \begin_layout Description
12830 \begin_inset Flex Code
12831 status collapsed
12832
12833 \begin_layout Plain Layout
12834 LabelStringAppendix
12835 \end_layout
12836
12837 \end_inset
12838
12839  [
12840 \begin_inset Flex Code
12841 status collapsed
12842
12843 \begin_layout Plain Layout
12844 string=""
12845 \end_layout
12846
12847 \end_inset
12848
12849 ] This is used inside the appendix instead of
12850 \begin_inset Newline newline
12851 \end_inset
12852
12853
12854 \begin_inset Flex Code
12855 status collapsed
12856
12857 \begin_layout Plain Layout
12858 LabelString
12859 \end_layout
12860
12861 \end_inset
12862
12863 .
12864  Note that every
12865 \begin_inset Flex Code
12866 status collapsed
12867
12868 \begin_layout Plain Layout
12869 LabelString
12870 \end_layout
12871
12872 \end_inset
12873
12874  statement resets
12875 \begin_inset Newline newline
12876 \end_inset
12877
12878
12879 \begin_inset Flex Code
12880 status collapsed
12881
12882 \begin_layout Plain Layout
12883 LabelStringAppendix
12884 \end_layout
12885
12886 \end_inset
12887
12888  too.
12889 \end_layout
12890
12891 \begin_layout Description
12892 \begin_inset Flex Code
12893 status collapsed
12894
12895 \begin_layout Plain Layout
12896 LabelTag
12897 \end_layout
12898
12899 \end_inset
12900
12901  [FIXME] (Used only with XML-type formats.)
12902 \end_layout
12903
12904 \begin_layout Description
12905 \begin_inset Flex Code
12906 status collapsed
12907
12908 \begin_layout Plain Layout
12909 LabelType
12910 \end_layout
12911
12912 \end_inset
12913
12914  [
12915 \begin_inset Flex Code
12916 status collapsed
12917
12918 \begin_layout Plain Layout
12919
12920 \emph on
12921 No_Label
12922 \emph default
12923 , Manual, Static, Above,
12924 \begin_inset Newline newline
12925 \end_inset
12926
12927 Centered, Sensitive, Enumerate,
12928 \begin_inset Newline newline
12929 \end_inset
12930
12931 Itemize, Bibliography
12932 \end_layout
12933
12934 \end_inset
12935
12936 ]
12937 \end_layout
12938
12939 \begin_deeper
12940 \begin_layout Description
12941 \begin_inset Flex Code
12942 status collapsed
12943
12944 \begin_layout Plain Layout
12945 Manual
12946 \end_layout
12947
12948 \end_inset
12949
12950  means the label is the very first word (up to the first real blank).
12951  Use protected spaces if you want more than one word as the label.
12952
12953 \end_layout
12954
12955 \begin_layout Description
12956 \begin_inset Flex Code
12957 status collapsed
12958
12959 \begin_layout Plain Layout
12960 Static
12961 \end_layout
12962
12963 \end_inset
12964
12965  means the label is simply what is declared as
12966 \begin_inset Flex Code
12967 status collapsed
12968
12969 \begin_layout Plain Layout
12970 LabelString
12971 \end_layout
12972
12973 \end_inset
12974
12975 .
12976  This will be displayed
12977 \begin_inset Quotes eld
12978 \end_inset
12979
12980 inline
12981 \begin_inset Quotes erd
12982 \end_inset
12983
12984 , at the beginning of the paragraph.
12985  If the
12986 \begin_inset Flex Code
12987 status collapsed
12988
12989 \begin_layout Plain Layout
12990 LatexType
12991 \end_layout
12992
12993 \end_inset
12994
12995  is
12996 \begin_inset Flex Code
12997 status collapsed
12998
12999 \begin_layout Plain Layout
13000 Environment
13001 \end_layout
13002
13003 \end_inset
13004
13005 , then it will be displayed only in the first paragraph of any sequence
13006  of paragraphs with the same
13007 \begin_inset Flex Code
13008 status collapsed
13009
13010 \begin_layout Plain Layout
13011 Style
13012 \end_layout
13013
13014 \end_inset
13015
13016 .
13017 \end_layout
13018
13019 \begin_layout Description
13020 \begin_inset Flex Code
13021 status collapsed
13022
13023 \begin_layout Plain Layout
13024 Above
13025 \end_layout
13026
13027 \end_inset
13028
13029
13030 \begin_inset space ~
13031 \end_inset
13032
13033 and
13034 \begin_inset space ~
13035 \end_inset
13036
13037
13038 \begin_inset Flex Code
13039 status collapsed
13040
13041 \begin_layout Plain Layout
13042 Centered
13043 \end_layout
13044
13045 \end_inset
13046
13047  are special cases of
13048 \begin_inset Flex Code
13049 status collapsed
13050
13051 \begin_layout Plain Layout
13052 Static
13053 \end_layout
13054
13055 \end_inset
13056
13057 .
13058  The label will be printed above the paragraph either at the beginning of
13059  the line or centered.
13060 \end_layout
13061
13062 \begin_layout Description
13063 \begin_inset Flex Code
13064 status collapsed
13065
13066 \begin_layout Plain Layout
13067 Sensitive
13068 \end_layout
13069
13070 \end_inset
13071
13072  is a special case for the caption-labels
13073 \begin_inset Quotes eld
13074 \end_inset
13075
13076 Figure
13077 \begin_inset Quotes erd
13078 \end_inset
13079
13080  and
13081 \begin_inset Quotes eld
13082 \end_inset
13083
13084 Table
13085 \begin_inset Quotes erd
13086 \end_inset
13087
13088 .
13089 \begin_inset Newline newline
13090 \end_inset
13091
13092
13093 \begin_inset Flex Code
13094 status collapsed
13095
13096 \begin_layout Plain Layout
13097 Sensitive
13098 \end_layout
13099
13100 \end_inset
13101
13102  means the (hardcoded) label string depends on the kind of float: It is
13103  hardcoded to be `FloatType N', where N is the value of the counter associated
13104  with the float.
13105  For the case that a caption is inserted outside of a float the
13106 \begin_inset Flex Code
13107 status collapsed
13108
13109 \begin_layout Plain Layout
13110 LabelString
13111 \end_layout
13112
13113 \end_inset
13114
13115  will appear as
13116 \begin_inset Quotes eld
13117 \end_inset
13118
13119 Senseless!
13120 \begin_inset Quotes erd
13121 \end_inset
13122
13123 .
13124 \end_layout
13125
13126 \begin_layout Description
13127 \begin_inset Flex Code
13128 status collapsed
13129
13130 \begin_layout Plain Layout
13131 Enumerate
13132 \end_layout
13133
13134 \end_inset
13135
13136  produces the usual sort of enumeration labels.
13137  At present, it is hardcoded to use Arabic numerals, lowercase letters,
13138  small Roman numerals, and uppercase letters for the four possible depths.
13139 \end_layout
13140
13141 \begin_layout Description
13142 \begin_inset Flex Code
13143 status collapsed
13144
13145 \begin_layout Plain Layout
13146 Itemize
13147 \end_layout
13148
13149 \end_inset
13150
13151  produces various bullets at the different levels.
13152  It is also hardcoded.
13153 \end_layout
13154
13155 \begin_layout Description
13156 \begin_inset Flex Code
13157 status collapsed
13158
13159 \begin_layout Plain Layout
13160 Bibliography
13161 \end_layout
13162
13163 \end_inset
13164
13165  should be used only with
13166 \begin_inset Flex Code
13167 status collapsed
13168
13169 \begin_layout Plain Layout
13170 LatexType BibEnvironment
13171 \end_layout
13172
13173 \end_inset
13174
13175 .
13176 \end_layout
13177
13178 \end_deeper
13179 \begin_layout Description
13180 \begin_inset Flex Code
13181 status collapsed
13182
13183 \begin_layout Plain Layout
13184 LangPreamble
13185 \end_layout
13186
13187 \end_inset
13188
13189  Note that this will completely override any prior
13190 \begin_inset Flex Code
13191 status collapsed
13192
13193 \begin_layout Plain Layout
13194 LangPreamble
13195 \end_layout
13196
13197 \end_inset
13198
13199  declaration for this style.
13200  Must end with
13201 \begin_inset Quotes eld
13202 \end_inset
13203
13204
13205 \begin_inset Flex Code
13206 status collapsed
13207
13208 \begin_layout Plain Layout
13209 EndLangPreamble
13210 \end_layout
13211
13212 \end_inset
13213
13214
13215 \begin_inset Quotes erd
13216 \end_inset
13217
13218 .
13219  See
13220 \begin_inset CommandInset ref
13221 LatexCommand ref
13222 reference "subsec:I18n"
13223
13224 \end_inset
13225
13226  for details on its use.
13227 \end_layout
13228
13229 \begin_layout Description
13230 \begin_inset Flex Code
13231 status collapsed
13232
13233 \begin_layout Plain Layout
13234 LatexName
13235 \end_layout
13236
13237 \end_inset
13238
13239  [
13240 \begin_inset Flex Code
13241 status collapsed
13242
13243 \begin_layout Plain Layout
13244 <name>
13245 \end_layout
13246
13247 \end_inset
13248
13249 ] The name of the corresponding \SpecialChar LaTeX
13250  stuff.
13251  Either the environment or command name.
13252 \end_layout
13253
13254 \begin_layout Description
13255 \begin_inset Flex Code
13256 status collapsed
13257
13258 \begin_layout Plain Layout
13259 LatexParam
13260 \end_layout
13261
13262 \end_inset
13263
13264  [
13265 \begin_inset Flex Code
13266 status collapsed
13267
13268 \begin_layout Plain Layout
13269 <parameter>
13270 \end_layout
13271
13272 \end_inset
13273
13274 ] An optional parameter for the corresponding
13275 \begin_inset Flex Code
13276 status collapsed
13277
13278 \begin_layout Plain Layout
13279 LatexName
13280 \end_layout
13281
13282 \end_inset
13283
13284  stuff.
13285  This parameter cannot be changed from within \SpecialChar LyX
13286  (use
13287 \begin_inset Flex Code
13288 status collapsed
13289
13290 \begin_layout Plain Layout
13291 Argument
13292 \end_layout
13293
13294 \end_inset
13295
13296  for customizable parameters).
13297  This will be output as is after all \SpecialChar LaTeX
13298
13299 \begin_inset Flex Code
13300 status collapsed
13301
13302 \begin_layout Plain Layout
13303 Argument
13304 \end_layout
13305
13306 \end_inset
13307
13308 s.
13309 \end_layout
13310
13311 \begin_layout Description
13312 \begin_inset Flex Code
13313 status collapsed
13314
13315 \begin_layout Plain Layout
13316 LatexType
13317 \end_layout
13318
13319 \end_inset
13320
13321  [
13322 \begin_inset Flex Code
13323 status collapsed
13324
13325 \begin_layout Plain Layout
13326
13327 \emph on
13328 Paragraph
13329 \emph default
13330 , Command, Environment, Item_Environment,
13331 \begin_inset Newline newline
13332 \end_inset
13333
13334 List_Environment, Bib_Environment
13335 \end_layout
13336
13337 \end_inset
13338
13339 ] How the style should be translated into \SpecialChar LaTeX
13340 .
13341 \begin_inset Foot
13342 status collapsed
13343
13344 \begin_layout Plain Layout
13345 \begin_inset Flex Code
13346 status collapsed
13347
13348 \begin_layout Plain Layout
13349 LatexType
13350 \end_layout
13351
13352 \end_inset
13353
13354  is perhaps a bit misleading, since these rules apply to SGML classes, too.
13355  Visit the SGML class files for specific examples.
13356 \end_layout
13357
13358 \end_inset
13359
13360
13361 \end_layout
13362
13363 \begin_deeper
13364 \begin_layout Description
13365 \begin_inset Flex Code
13366 status collapsed
13367
13368 \begin_layout Plain Layout
13369 Paragraph
13370 \end_layout
13371
13372 \end_inset
13373
13374  means nothing special.
13375 \end_layout
13376
13377 \begin_layout Description
13378 \begin_inset Flex Code
13379 status collapsed
13380
13381 \begin_layout Plain Layout
13382 Command
13383 \end_layout
13384
13385 \end_inset
13386
13387  means
13388 \begin_inset Flex Code
13389 status collapsed
13390
13391 \begin_layout Plain Layout
13392
13393 \backslash
13394
13395 \emph on
13396 LatexName
13397 \emph default
13398 {\SpecialChar ldots
13399 }
13400 \end_layout
13401
13402 \end_inset
13403
13404 .
13405 \end_layout
13406
13407 \begin_layout Description
13408 \begin_inset Flex Code
13409 status collapsed
13410
13411 \begin_layout Plain Layout
13412 Environment
13413 \end_layout
13414
13415 \end_inset
13416
13417  means
13418 \begin_inset Flex Code
13419 status collapsed
13420
13421 \begin_layout Plain Layout
13422
13423 \backslash
13424 begin{
13425 \emph on
13426 LatexName
13427 \emph default
13428 }\SpecialChar ldots
13429
13430 \backslash
13431 end{
13432 \emph on
13433 LatexName
13434 \emph default
13435 }
13436 \end_layout
13437
13438 \end_inset
13439
13440 .
13441
13442 \end_layout
13443
13444 \begin_layout Description
13445 \begin_inset Flex Code
13446 status collapsed
13447
13448 \begin_layout Plain Layout
13449 Item_Environment
13450 \end_layout
13451
13452 \end_inset
13453
13454  is the same as
13455 \begin_inset Flex Code
13456 status collapsed
13457
13458 \begin_layout Plain Layout
13459 Environment
13460 \end_layout
13461
13462 \end_inset
13463
13464 , except that an
13465 \begin_inset Flex Code
13466 status collapsed
13467
13468 \begin_layout Plain Layout
13469
13470 \backslash
13471 item
13472 \end_layout
13473
13474 \end_inset
13475
13476  is generated for each paragraph of this environment.
13477
13478 \end_layout
13479
13480 \begin_layout Description
13481 \begin_inset Flex Code
13482 status collapsed
13483
13484 \begin_layout Plain Layout
13485 List_Environment
13486 \end_layout
13487
13488 \end_inset
13489
13490  is the same as
13491 \begin_inset Flex Code
13492 status collapsed
13493
13494 \begin_layout Plain Layout
13495 Item_Environment
13496 \end_layout
13497
13498 \end_inset
13499
13500 , except that
13501 \begin_inset Newline newline
13502 \end_inset
13503
13504
13505 \begin_inset Flex Code
13506 status collapsed
13507
13508 \begin_layout Plain Layout
13509 LabelWidthString
13510 \end_layout
13511
13512 \end_inset
13513
13514  is passed as an argument to the environment.
13515 \begin_inset Newline newline
13516 \end_inset
13517
13518
13519 \begin_inset Flex Code
13520 status collapsed
13521
13522 \begin_layout Plain Layout
13523 LabelWidthString
13524 \end_layout
13525
13526 \end_inset
13527
13528  can be defined in the
13529 \begin_inset Flex Noun
13530 status collapsed
13531
13532 \begin_layout Plain Layout
13533 Edit\SpecialChar menuseparator
13534 Paragraph
13535 \begin_inset space ~
13536 \end_inset
13537
13538 settings
13539 \end_layout
13540
13541 \end_inset
13542
13543  dialog.
13544 \end_layout
13545
13546 \begin_layout Description
13547 \begin_inset Flex Code
13548 status collapsed
13549
13550 \begin_layout Plain Layout
13551 Bib_Environment
13552 \end_layout
13553
13554 \end_inset
13555
13556  is like
13557 \begin_inset Flex Code
13558 status collapsed
13559
13560 \begin_layout Plain Layout
13561 Environment
13562 \end_layout
13563
13564 \end_inset
13565
13566  but adds the necessary mandatory argument (the longest label) to the begin
13567  statement of the bibliography environment:
13568 \begin_inset Newline newline
13569 \end_inset
13570
13571
13572 \begin_inset Flex Code
13573 status collapsed
13574
13575 \begin_layout Plain Layout
13576
13577 \backslash
13578 begin{thebibliography}{99}
13579 \end_layout
13580
13581 \end_inset
13582
13583 .
13584  It is therefore only useful for bibliography environments.
13585  The default longest label
13586 \begin_inset Quotes eld
13587 \end_inset
13588
13589 99
13590 \begin_inset Quotes erd
13591 \end_inset
13592
13593  can be changed by the user in the paragraph settings of a bibliography
13594  item.
13595 \end_layout
13596
13597 \begin_layout Standard
13598 Putting the last few things together, the \SpecialChar LaTeX
13599  output will be either:
13600 \end_layout
13601
13602 \begin_layout LyX-Code
13603
13604 \backslash
13605 LatexName[LatexParam]{\SpecialChar ldots
13606 }
13607 \end_layout
13608
13609 \begin_layout Standard
13610 or:
13611 \end_layout
13612
13613 \begin_layout LyX-Code
13614
13615 \backslash
13616 begin{LatexName}[LatexParam] \SpecialChar ldots
13617
13618 \backslash
13619 end{LatexName}.
13620 \end_layout
13621
13622 \begin_layout Standard
13623 depending upon the \SpecialChar LaTeX
13624  type.
13625 \end_layout
13626
13627 \end_deeper
13628 \begin_layout Description
13629 \begin_inset Flex Code
13630 status collapsed
13631
13632 \begin_layout Plain Layout
13633 LeftDelim
13634 \end_layout
13635
13636 \end_inset
13637
13638  [
13639 \begin_inset Flex Code
13640 status collapsed
13641
13642 \begin_layout Plain Layout
13643 string
13644 \end_layout
13645
13646 \end_inset
13647
13648 ] A string that is put at the beginning of the style content.
13649  A line break in the output can be indicated by
13650 \begin_inset Flex Code
13651 status collapsed
13652
13653 \begin_layout Plain Layout
13654 <br/>
13655 \end_layout
13656
13657 \end_inset
13658
13659 .
13660 \end_layout
13661
13662 \begin_layout Description
13663 \begin_inset Flex Code
13664 status collapsed
13665
13666 \begin_layout Plain Layout
13667 LeftMargin
13668 \end_layout
13669
13670 \end_inset
13671
13672  [
13673 \begin_inset Flex Code
13674 status collapsed
13675
13676 \begin_layout Plain Layout
13677 string=""
13678 \end_layout
13679
13680 \end_inset
13681
13682 ] If you put styles into environments, the different
13683 \begin_inset Flex Code
13684 status collapsed
13685
13686 \begin_layout Plain Layout
13687 LeftMargin
13688 \end_layout
13689
13690 \end_inset
13691
13692  are not simply added, but added with a factor
13693 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
13694 \end_inset
13695
13696 .
13697  Note that this parameter is also used when
13698 \begin_inset Flex Code
13699 status collapsed
13700
13701 \begin_layout Plain Layout
13702 Margin
13703 \end_layout
13704
13705 \end_inset
13706
13707  is defined as
13708 \begin_inset Flex Code
13709 status collapsed
13710
13711 \begin_layout Plain Layout
13712 Manual
13713 \end_layout
13714
13715 \end_inset
13716
13717  or
13718 \begin_inset Flex Code
13719 status collapsed
13720
13721 \begin_layout Plain Layout
13722 Dynamic
13723 \end_layout
13724
13725 \end_inset
13726
13727 .
13728  Then it is added to the manual or dynamic margin.
13729 \begin_inset Newline newline
13730 \end_inset
13731
13732 For example
13733 \begin_inset Quotes eld
13734 \end_inset
13735
13736
13737 \begin_inset Flex Code
13738 status collapsed
13739
13740 \begin_layout Plain Layout
13741 MM
13742 \end_layout
13743
13744 \end_inset
13745
13746
13747 \begin_inset Quotes erd
13748 \end_inset
13749
13750  means that the paragraph is indented with the width of
13751 \begin_inset Quotes eld
13752 \end_inset
13753
13754
13755 \begin_inset Flex Code
13756 status collapsed
13757
13758 \begin_layout Plain Layout
13759 MM
13760 \end_layout
13761
13762 \end_inset
13763
13764
13765 \begin_inset Quotes erd
13766 \end_inset
13767
13768  in the normal font.
13769  You can get a negative width by prefixing the string with
13770 \begin_inset Quotes eld
13771 \end_inset
13772
13773
13774 \begin_inset Flex Code
13775 status collapsed
13776
13777 \begin_layout Plain Layout
13778 -
13779 \end_layout
13780
13781 \end_inset
13782
13783
13784 \begin_inset Quotes erd
13785 \end_inset
13786
13787 .
13788  This way was chosen so that the look is the same with each used screen
13789  font.
13790 \end_layout
13791
13792 \begin_layout Description
13793 \begin_inset Flex Code
13794 status collapsed
13795
13796 \begin_layout Plain Layout
13797 Margin
13798 \end_layout
13799
13800 \end_inset
13801
13802  [
13803 \begin_inset Flex Code
13804 status collapsed
13805
13806 \begin_layout Plain Layout
13807
13808 \emph on
13809 Static
13810 \emph default
13811 , Manual, Dynamic, First_Dynamic, Right_Address_Box
13812 \end_layout
13813
13814 \end_inset
13815
13816 ]
13817 \begin_inset Newline newline
13818 \end_inset
13819
13820 The kind of margin that the style has on the left side.
13821 \end_layout
13822
13823 \begin_deeper
13824 \begin_layout Description
13825 \begin_inset Flex Code
13826 status collapsed
13827
13828 \begin_layout Plain Layout
13829 Static
13830 \end_layout
13831
13832 \end_inset
13833
13834  just means a fixed margin.
13835 \end_layout
13836
13837 \begin_layout Description
13838 \begin_inset Flex Code
13839 status collapsed
13840
13841 \begin_layout Plain Layout
13842 Manual
13843 \end_layout
13844
13845 \end_inset
13846
13847  means that the left margin depends on the string entered in the
13848 \begin_inset Flex Noun
13849 status collapsed
13850
13851 \begin_layout Plain Layout
13852 Edit\SpecialChar menuseparator
13853 Paragraph
13854 \begin_inset space ~
13855 \end_inset
13856
13857 Settings
13858 \end_layout
13859
13860 \end_inset
13861
13862  dialog.
13863  This is used to typeset nice lists without tabulators.
13864 \end_layout
13865
13866 \begin_layout Description
13867 \begin_inset Flex Code
13868 status collapsed
13869
13870 \begin_layout Plain Layout
13871 Dynamic
13872 \end_layout
13873
13874 \end_inset
13875
13876  means that the margin depends on the size of the label.
13877  This is used for automatic enumerated headlines.
13878  It is obvious that the headline
13879 \begin_inset Quotes eld
13880 \end_inset
13881
13882 5.4.3.2.1 Very long headline
13883 \begin_inset Quotes erd
13884 \end_inset
13885
13886  must have a wider left margin (as wide as
13887 \begin_inset Quotes eld
13888 \end_inset
13889
13890 5.4.3.2.1
13891 \begin_inset Quotes erd
13892 \end_inset
13893
13894  plus the space) than
13895 \begin_inset Quotes eld
13896 \end_inset
13897
13898 3.2 Very long headline
13899 \begin_inset Quotes erd
13900 \end_inset
13901
13902 , even if standard
13903 \begin_inset Quotes eld
13904 \end_inset
13905
13906 word processors
13907 \begin_inset Quotes erd
13908 \end_inset
13909
13910  are not able to do this.
13911 \end_layout
13912
13913 \begin_layout Description
13914 \begin_inset Flex Code
13915 status collapsed
13916
13917 \begin_layout Plain Layout
13918 First_Dynamic
13919 \end_layout
13920
13921 \end_inset
13922
13923  is similar, but only the very first row of the paragraph is dynamic, while
13924  the others are static; this is used, for example, for descriptions.
13925 \end_layout
13926
13927 \begin_layout Description
13928 \begin_inset Flex Code
13929 status collapsed
13930
13931 \begin_layout Plain Layout
13932 Right_Address_Box
13933 \end_layout
13934
13935 \end_inset
13936
13937  means the margin is chosen in a way that the longest row of this paragraph
13938  fits to the right margin.
13939  This is used to typeset an address on the right edge of the page.
13940 \end_layout
13941
13942 \end_deeper
13943 \begin_layout Description
13944 \begin_inset Flex Code
13945 status collapsed
13946
13947 \begin_layout Plain Layout
13948 NeedProtect
13949 \end_layout
13950
13951 \end_inset
13952
13953  [
13954 \begin_inset Flex Code
13955 status collapsed
13956
13957 \begin_layout Plain Layout
13958
13959 \emph on
13960 0
13961 \end_layout
13962
13963 \end_inset
13964
13965 ,
13966 \begin_inset space \thinspace{}
13967 \end_inset
13968
13969
13970 \begin_inset Flex Code
13971 status collapsed
13972
13973 \begin_layout Plain Layout
13974 1
13975 \end_layout
13976
13977 \end_inset
13978
13979 ] Whether fragile commands in this style should be
13980 \begin_inset Flex Code
13981 status collapsed
13982
13983 \begin_layout Plain Layout
13984
13985 \backslash
13986 protect
13987 \end_layout
13988
13989 \end_inset
13990
13991 'ed.
13992  (Note: This is
13993 \emph on
13994 not
13995 \emph default
13996  whether this command should itself be protected.)
13997 \end_layout
13998
13999 \begin_layout Description
14000 \begin_inset Flex Code
14001 status collapsed
14002
14003 \begin_layout Plain Layout
14004 Newline
14005 \end_layout
14006
14007 \end_inset
14008
14009  [
14010 \begin_inset Flex Code
14011 status collapsed
14012
14013 \begin_layout Plain Layout
14014 0
14015 \end_layout
14016
14017 \end_inset
14018
14019 ,
14020 \begin_inset space \thinspace{}
14021 \end_inset
14022
14023
14024 \begin_inset Flex Code
14025 status collapsed
14026
14027 \begin_layout Plain Layout
14028
14029 \emph on
14030 1
14031 \end_layout
14032
14033 \end_inset
14034
14035 ] Whether newlines are translated into \SpecialChar LaTeX
14036  newlines (
14037 \begin_inset Flex Code
14038 status collapsed
14039
14040 \begin_layout Plain Layout
14041
14042 \backslash
14043
14044 \backslash
14045
14046 \end_layout
14047
14048 \end_inset
14049
14050 ) or not.
14051  The translation can be switched off to allow more comfortable \SpecialChar LaTeX
14052  editing
14053  inside \SpecialChar LyX
14054 .
14055 \end_layout
14056
14057 \begin_layout Description
14058 \begin_inset Flex Code
14059 status collapsed
14060
14061 \begin_layout Plain Layout
14062 NextNoIndent
14063 \end_layout
14064
14065 \end_inset
14066
14067  [
14068 \begin_inset Flex Code
14069 status collapsed
14070
14071 \begin_layout Plain Layout
14072
14073 \emph on
14074 0
14075 \end_layout
14076
14077 \end_inset
14078
14079 ,
14080 \begin_inset space \thinspace{}
14081 \end_inset
14082
14083
14084 \begin_inset Flex Code
14085 status collapsed
14086
14087 \begin_layout Plain Layout
14088 1
14089 \end_layout
14090
14091 \end_inset
14092
14093 ] If set to true, and if
14094 \begin_inset Flex Code
14095 status collapsed
14096
14097 \begin_layout Plain Layout
14098 DefaultStyle
14099 \end_layout
14100
14101 \end_inset
14102
14103  (usually
14104 \begin_inset Flex Code
14105 status collapsed
14106
14107 \begin_layout Plain Layout
14108 Standard
14109 \end_layout
14110
14111 \end_inset
14112
14113 ) paragraphs are being indented, then the indentation of such a paragraph
14114  following one of this type will be suppressed.
14115  (So this will not affect the display of non-default paragraphs.)
14116 \end_layout
14117
14118 \begin_layout Description
14119 \begin_inset Flex Code
14120 status collapsed
14121
14122 \begin_layout Plain Layout
14123 ObsoletedBy
14124 \end_layout
14125
14126 \end_inset
14127
14128  [
14129 \begin_inset Flex Code
14130 status collapsed
14131
14132 \begin_layout Plain Layout
14133 <name>
14134 \end_layout
14135
14136 \end_inset
14137
14138 ] Name of a style that has replaced this style.
14139  This is used to rename a style, while keeping backward compatibility.
14140 \end_layout
14141
14142 \begin_layout Description
14143 \begin_inset Flex Code
14144 status collapsed
14145
14146 \begin_layout Plain Layout
14147 ParagraphGroup
14148 \end_layout
14149
14150 \end_inset
14151
14152  [
14153 \begin_inset Flex Code
14154 status collapsed
14155
14156 \begin_layout Plain Layout
14157 0
14158 \end_layout
14159
14160 \end_inset
14161
14162 ,
14163 \begin_inset space \thinspace{}
14164 \end_inset
14165
14166
14167 \begin_inset Flex Code
14168 status collapsed
14169
14170 \begin_layout Plain Layout
14171 1
14172 \end_layout
14173
14174 \end_inset
14175
14176 ] Determines whether consecutive pragraphs of the same type are treated
14177  as belonging together.
14178  This has the effect that the
14179 \begin_inset Flex Code
14180 status collapsed
14181
14182 \begin_layout Plain Layout
14183 GuiLabel
14184 \end_layout
14185
14186 \end_inset
14187
14188  is only printed once before such a group.
14189  By default, this is true for
14190 \begin_inset Flex Code
14191 status collapsed
14192
14193 \begin_layout Plain Layout
14194 LaTeXType
14195 \end_layout
14196
14197 \end_inset
14198
14199
14200 \begin_inset Flex Code
14201 status collapsed
14202
14203 \begin_layout Plain Layout
14204 Environment
14205 \end_layout
14206
14207 \end_inset
14208
14209  and
14210 \begin_inset Flex Code
14211 status collapsed
14212
14213 \begin_layout Plain Layout
14214 Bib_Environment
14215 \end_layout
14216
14217 \end_inset
14218
14219  and false for all other types.
14220 \end_layout
14221
14222 \begin_layout Description
14223 \begin_inset Flex Code
14224 status collapsed
14225
14226 \begin_layout Plain Layout
14227 ParbreakIsNewline
14228 \end_layout
14229
14230 \end_inset
14231
14232  [
14233 \begin_inset Flex Code
14234 status collapsed
14235
14236 \begin_layout Plain Layout
14237
14238 \emph on
14239 0
14240 \end_layout
14241
14242 \end_inset
14243
14244 ,
14245 \begin_inset space \thinspace{}
14246 \end_inset
14247
14248
14249 \begin_inset Flex Code
14250 status collapsed
14251
14252 \begin_layout Plain Layout
14253 1
14254 \end_layout
14255
14256 \end_inset
14257
14258 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
14259  output,
14260  but only by a line break; together with
14261 \begin_inset Flex Code
14262 status collapsed
14263
14264 \begin_layout Plain Layout
14265 PassThru 1
14266 \end_layout
14267
14268 \end_inset
14269
14270 , this allows to emulate a plain text editor (like the ERT inset).
14271 \end_layout
14272
14273 \begin_layout Description
14274 \begin_inset Flex Code
14275 status collapsed
14276
14277 \begin_layout Plain Layout
14278 ParIndent
14279 \end_layout
14280
14281 \end_inset
14282
14283  [
14284 \begin_inset Flex Code
14285 status collapsed
14286
14287 \begin_layout Plain Layout
14288 string=""
14289 \end_layout
14290
14291 \end_inset
14292
14293 ] The indent of the very first line of a paragraph.
14294  The
14295 \begin_inset Newline newline
14296 \end_inset
14297
14298
14299 \begin_inset Flex Code
14300 status collapsed
14301
14302 \begin_layout Plain Layout
14303 Parindent
14304 \end_layout
14305
14306 \end_inset
14307
14308  will be fixed for a certain style.
14309  The exception is the default style, since the indentation for these paragraphs
14310  can be prohibited with
14311 \begin_inset Flex Code
14312 status collapsed
14313
14314 \begin_layout Plain Layout
14315 NextNoIndent
14316 \end_layout
14317
14318 \end_inset
14319
14320 .
14321  Also,
14322 \begin_inset Flex Code
14323 status collapsed
14324
14325 \begin_layout Plain Layout
14326 Standard
14327 \end_layout
14328
14329 \end_inset
14330
14331  style paragraphs inside environments use the
14332 \begin_inset Flex Code
14333 status collapsed
14334
14335 \begin_layout Plain Layout
14336 Parindent
14337 \end_layout
14338
14339 \end_inset
14340
14341  of the environment, not their native one.
14342  For example,
14343 \begin_inset Flex Code
14344 status collapsed
14345
14346 \begin_layout Plain Layout
14347 Standard
14348 \end_layout
14349
14350 \end_inset
14351
14352  paragraphs inside an enumeration are not indented.
14353 \end_layout
14354
14355 \begin_layout Description
14356 \begin_inset Flex Code
14357 status collapsed
14358
14359 \begin_layout Plain Layout
14360 ParSep
14361 \end_layout
14362
14363 \end_inset
14364
14365  [
14366 \begin_inset Flex Code
14367 status collapsed
14368
14369 \begin_layout Plain Layout
14370 float=0
14371 \end_layout
14372
14373 \end_inset
14374
14375 ] The vertical space between two paragraphs of this style.
14376 \end_layout
14377
14378 \begin_layout Description
14379 \begin_inset Flex Code
14380 status collapsed
14381
14382 \begin_layout Plain Layout
14383 Parskip
14384 \end_layout
14385
14386 \end_inset
14387
14388  [
14389 \begin_inset Flex Code
14390 status collapsed
14391
14392 \begin_layout Plain Layout
14393 float=0
14394 \end_layout
14395
14396 \end_inset
14397
14398 ] \SpecialChar LyX
14399  allows the user to choose either
14400 \begin_inset Quotes eld
14401 \end_inset
14402
14403 indent
14404 \begin_inset Quotes erd
14405 \end_inset
14406
14407  or
14408 \begin_inset Quotes eld
14409 \end_inset
14410
14411 skip
14412 \begin_inset Quotes erd
14413 \end_inset
14414
14415  to separate paragraphs.
14416  When
14417 \begin_inset Quotes eld
14418 \end_inset
14419
14420 indent
14421 \begin_inset Quotes erd
14422 \end_inset
14423
14424  is chosen,
14425 \begin_inset Flex Code
14426 status collapsed
14427
14428 \begin_layout Plain Layout
14429 Parskip
14430 \end_layout
14431
14432 \end_inset
14433
14434  is ignored.
14435  When
14436 \begin_inset Quotes eld
14437 \end_inset
14438
14439 skip
14440 \begin_inset Quotes erd
14441 \end_inset
14442
14443  is chosen,
14444 \begin_inset Flex Code
14445 status collapsed
14446
14447 \begin_layout Plain Layout
14448 ParIndent
14449 \end_layout
14450
14451 \end_inset
14452
14453  is ignored and all paragraphs are separated by the
14454 \begin_inset Flex Code
14455 status collapsed
14456
14457 \begin_layout Plain Layout
14458 Parskip
14459 \end_layout
14460
14461 \end_inset
14462
14463  argument.
14464  The vertical space is calculated with
14465 \begin_inset Flex Code
14466 status collapsed
14467
14468 \begin_layout Plain Layout
14469 Parskip
14470 \begin_inset space ~
14471 \end_inset
14472
14473 * DefaultHeight
14474 \end_layout
14475
14476 \end_inset
14477
14478  where
14479 \begin_inset Flex Code
14480 status collapsed
14481
14482 \begin_layout Plain Layout
14483 DefaultHeight
14484 \end_layout
14485
14486 \end_inset
14487
14488  is the height of a row with the normal font.
14489  This way, the look stays the same with different screen fonts.
14490 \end_layout
14491
14492 \begin_layout Description
14493 \begin_inset Flex Code
14494 status collapsed
14495
14496 \begin_layout Plain Layout
14497 PassThru
14498 \end_layout
14499
14500 \end_inset
14501
14502  [
14503 \begin_inset Flex Code
14504 status collapsed
14505
14506 \begin_layout Plain Layout
14507
14508 \emph on
14509 0
14510 \end_layout
14511
14512 \end_inset
14513
14514 ,
14515 \begin_inset space \thinspace{}
14516 \end_inset
14517
14518
14519 \begin_inset Flex Code
14520 status collapsed
14521
14522 \begin_layout Plain Layout
14523 1
14524 \end_layout
14525
14526 \end_inset
14527
14528 ] Whether the contents of this paragraph should be output in raw form, meaning
14529  without special translations that \SpecialChar LaTeX
14530  would require.
14531 \end_layout
14532
14533 \begin_layout Description
14534 \begin_inset Flex Code
14535 status collapsed
14536
14537 \begin_layout Plain Layout
14538 PassThruChars
14539 \end_layout
14540
14541 \end_inset
14542
14543  [
14544 \begin_inset Flex Code
14545 status collapsed
14546
14547 \begin_layout Plain Layout
14548 string
14549 \end_layout
14550
14551 \end_inset
14552
14553 ]
14554 \family typewriter
14555
14556 \family default
14557 Defines individual characters that should be output in raw form, meaning
14558  without special translations that \SpecialChar LaTeX
14559  would require.
14560 \end_layout
14561
14562 \begin_layout Description
14563 \begin_inset Flex Code
14564 status collapsed
14565
14566 \begin_layout Plain Layout
14567 Preamble
14568 \end_layout
14569
14570 \end_inset
14571
14572  Information to be included in the \SpecialChar LaTeX
14573  preamble when this style is used.
14574  Used to define macros, load packages, etc., required by this particular
14575  style.
14576  Must end with
14577 \begin_inset Quotes eld
14578 \end_inset
14579
14580
14581 \begin_inset Flex Code
14582 status collapsed
14583
14584 \begin_layout Plain Layout
14585 EndPreamble
14586 \end_layout
14587
14588 \end_inset
14589
14590
14591 \begin_inset Quotes erd
14592 \end_inset
14593
14594 .
14595 \end_layout
14596
14597 \begin_layout Description
14598 \begin_inset Flex Code
14599 status collapsed
14600
14601 \begin_layout Plain Layout
14602 RefPrefix
14603 \end_layout
14604
14605 \end_inset
14606
14607  [
14608 \begin_inset Flex Code
14609 status collapsed
14610
14611 \begin_layout Plain Layout
14612 string
14613 \end_layout
14614
14615 \end_inset
14616
14617 ] The prefix to use when creating labels referring to paragraphs of this
14618  type.
14619  This allows the use of formatted references.
14620 \end_layout
14621
14622 \begin_layout Description
14623 \begin_inset Flex Code
14624 status collapsed
14625
14626 \begin_layout Plain Layout
14627 Requires
14628 \end_layout
14629
14630 \end_inset
14631
14632  [
14633 \begin_inset Flex Code
14634 status collapsed
14635
14636 \begin_layout Plain Layout
14637 string
14638 \end_layout
14639
14640 \end_inset
14641
14642 ] Whether the style requires the feature
14643 \begin_inset Flex Code
14644 status collapsed
14645
14646 \begin_layout Plain Layout
14647 string
14648 \end_layout
14649
14650 \end_inset
14651
14652  (see
14653 \begin_inset CommandInset ref
14654 LatexCommand ref
14655 reference "chap:List-of-functions"
14656
14657 \end_inset
14658
14659  for the list of features).
14660  If you require a package with specific options, you can additionally use
14661
14662 \begin_inset Flex Code
14663 status collapsed
14664
14665 \begin_layout Plain Layout
14666 PackageOptions
14667 \end_layout
14668
14669 \end_inset
14670
14671  as a general text class parameter (see
14672 \begin_inset CommandInset ref
14673 LatexCommand ref
14674 reference "subsec:General-text-class"
14675
14676 \end_inset
14677
14678 ).
14679 \end_layout
14680
14681 \begin_layout Description
14682 \begin_inset Flex Code
14683 status collapsed
14684
14685 \begin_layout Plain Layout
14686 ResetArgs
14687 \end_layout
14688
14689 \end_inset
14690
14691  [
14692 \begin_inset Flex Code
14693 status collapsed
14694
14695 \begin_layout Plain Layout
14696
14697 \emph on
14698 0
14699 \end_layout
14700
14701 \end_inset
14702
14703 ,
14704 \begin_inset Flex Code
14705 status collapsed
14706
14707 \begin_layout Plain Layout
14708 1
14709 \end_layout
14710
14711 \end_inset
14712
14713 ] Resets the \SpecialChar LaTeX
14714  arguments of this style (as defined via the
14715 \begin_inset Flex Code
14716 status collapsed
14717
14718 \begin_layout Plain Layout
14719 Argument
14720 \end_layout
14721
14722 \end_inset
14723
14724  tag).
14725  This is useful if you have copied a style via
14726 \begin_inset Flex Code
14727 status collapsed
14728
14729 \begin_layout Plain Layout
14730 CopyStyle
14731 \end_layout
14732
14733 \end_inset
14734
14735 , but you do not want to inherit its (required and optional) arguments.
14736 \change_inserted 2089657418 1476488475
14737
14738 \end_layout
14739
14740 \begin_layout Description
14741
14742 \change_inserted 2089657418 1476488475
14743 \begin_inset Flex Code
14744 status collapsed
14745
14746 \begin_layout Plain Layout
14747
14748 \change_inserted 2089657418 1476488475
14749 ResumeCounter
14750 \end_layout
14751
14752 \end_inset
14753
14754  [
14755 \begin_inset Flex Code
14756 status collapsed
14757
14758 \begin_layout Plain Layout
14759
14760 \change_inserted 2089657418 1476488475
14761
14762 \emph on
14763 0
14764 \end_layout
14765
14766 \end_inset
14767
14768 ,
14769 \begin_inset Flex Code
14770 status collapsed
14771
14772 \begin_layout Plain Layout
14773
14774 \change_inserted 2089657418 1476488475
14775 1
14776 \end_layout
14777
14778 \end_inset
14779
14780 ] Resumes a counter that is usually reset at each new sequence of layouts.
14781  This is currently only useful when
14782 \begin_inset Flex Code
14783 status collapsed
14784
14785 \begin_layout Plain Layout
14786
14787 \change_inserted 2089657418 1476488475
14788 LabelType
14789 \end_layout
14790
14791 \end_inset
14792
14793  is
14794 \begin_inset Flex Code
14795 status collapsed
14796
14797 \begin_layout Plain Layout
14798
14799 \change_inserted 2089657418 1476488475
14800 Enumerate
14801 \end_layout
14802
14803 \end_inset
14804
14805 .
14806 \change_unchanged
14807
14808 \end_layout
14809
14810 \begin_layout Description
14811 \begin_inset Flex Code
14812 status collapsed
14813
14814 \begin_layout Plain Layout
14815 RightDelim
14816 \end_layout
14817
14818 \end_inset
14819
14820  [
14821 \begin_inset Flex Code
14822 status collapsed
14823
14824 \begin_layout Plain Layout
14825 string
14826 \end_layout
14827
14828 \end_inset
14829
14830 ] A string that is put at the end of the layout content.
14831  A line break in the output can be indicated by
14832 \begin_inset Flex Code
14833 status collapsed
14834
14835 \begin_layout Plain Layout
14836 <br/>
14837 \end_layout
14838
14839 \end_inset
14840
14841 .
14842 \end_layout
14843
14844 \begin_layout Description
14845 \begin_inset Flex Code
14846 status collapsed
14847
14848 \begin_layout Plain Layout
14849 RightMargin
14850 \end_layout
14851
14852 \end_inset
14853
14854  [
14855 \begin_inset Flex Code
14856 status collapsed
14857
14858 \begin_layout Plain Layout
14859 string=""
14860 \end_layout
14861
14862 \end_inset
14863
14864 ] Similar to
14865 \begin_inset Flex Code
14866 status collapsed
14867
14868 \begin_layout Plain Layout
14869 LeftMargin
14870 \end_layout
14871
14872 \end_inset
14873
14874 .
14875 \end_layout
14876
14877 \begin_layout Description
14878 \begin_inset Flex Code
14879 status collapsed
14880
14881 \begin_layout Plain Layout
14882 Spacing
14883 \end_layout
14884
14885 \end_inset
14886
14887  [
14888 \begin_inset Flex Code
14889 status collapsed
14890
14891 \begin_layout Plain Layout
14892
14893 \emph on
14894 single
14895 \end_layout
14896
14897 \end_inset
14898
14899 ,
14900 \begin_inset Flex Code
14901 status collapsed
14902
14903 \begin_layout Plain Layout
14904 onehalf
14905 \end_layout
14906
14907 \end_inset
14908
14909 ,
14910 \begin_inset Flex Code
14911 status collapsed
14912
14913 \begin_layout Plain Layout
14914 double
14915 \end_layout
14916
14917 \end_inset
14918
14919 ,
14920 \begin_inset Flex Code
14921 status collapsed
14922
14923 \begin_layout Plain Layout
14924 other
14925 \begin_inset space ~
14926 \end_inset
14927
14928 <value>
14929 \end_layout
14930
14931 \end_inset
14932
14933 ] This defines what the default spacing should be in the style.
14934  The arguments
14935 \begin_inset Flex Code
14936 status collapsed
14937
14938 \begin_layout Plain Layout
14939 single
14940 \end_layout
14941
14942 \end_inset
14943
14944 ,
14945 \begin_inset Flex Code
14946 status collapsed
14947
14948 \begin_layout Plain Layout
14949 onehalf
14950 \end_layout
14951
14952 \end_inset
14953
14954  and
14955 \begin_inset Flex Code
14956 status collapsed
14957
14958 \begin_layout Plain Layout
14959 double
14960 \end_layout
14961
14962 \end_inset
14963
14964  correspond respectively to a multiplier value of 1, 1.25 and 1.667.
14965  If you specify the argument
14966 \begin_inset Flex Code
14967 status collapsed
14968
14969 \begin_layout Plain Layout
14970 other
14971 \end_layout
14972
14973 \end_inset
14974
14975 , then you must also provide a value argument which will be the actual multiplie
14976 r value.
14977  Note that, contrary to other parameters,
14978 \begin_inset Flex Code
14979 status collapsed
14980
14981 \begin_layout Plain Layout
14982 Spacing
14983 \end_layout
14984
14985 \end_inset
14986
14987  implies the generation of specific \SpecialChar LaTeX
14988  code, using the \SpecialChar LaTeX
14989  package
14990 \family roman
14991
14992 \begin_inset Flex Code
14993 status collapsed
14994
14995 \begin_layout Plain Layout
14996 setspace
14997 \end_layout
14998
14999 \end_inset
15000
15001 .
15002 \end_layout
15003
15004 \begin_layout Description
15005 \begin_inset Flex Code
15006 status collapsed
15007
15008 \begin_layout Plain Layout
15009 Spellcheck
15010 \end_layout
15011
15012 \end_inset
15013
15014  [
15015 \begin_inset Flex Code
15016 status collapsed
15017
15018 \begin_layout Plain Layout
15019 0
15020 \end_layout
15021
15022 \end_inset
15023
15024 ,
15025 \begin_inset space \thinspace{}
15026 \end_inset
15027
15028
15029 \begin_inset Flex Code
15030 status collapsed
15031
15032 \begin_layout Plain Layout
15033
15034 \emph on
15035 1
15036 \end_layout
15037
15038 \end_inset
15039
15040 ] Allow spell-checking paragraphs of this style.
15041  Default is true.
15042 \change_inserted 2089657418 1476488264
15043
15044 \end_layout
15045
15046 \begin_layout Description
15047
15048 \change_inserted 2089657418 1476488264
15049 \begin_inset Flex Code
15050 status collapsed
15051
15052 \begin_layout Plain Layout
15053
15054 \change_inserted 2089657418 1476488264
15055 StepMasterCounter
15056 \end_layout
15057
15058 \end_inset
15059
15060  [
15061 \begin_inset Flex Code
15062 status collapsed
15063
15064 \begin_layout Plain Layout
15065
15066 \change_inserted 2089657418 1476488264
15067
15068 \emph on
15069 0
15070 \end_layout
15071
15072 \end_inset
15073
15074 ,
15075 \begin_inset Flex Code
15076 status collapsed
15077
15078 \begin_layout Plain Layout
15079
15080 \change_inserted 2089657418 1476488264
15081 1
15082 \end_layout
15083
15084 \end_inset
15085
15086 ] Steps the master counter of a given counter at the beginning of a new
15087  sequence of layouts.
15088  This is currently only useful when
15089 \begin_inset Flex Code
15090 status collapsed
15091
15092 \begin_layout Plain Layout
15093
15094 \change_inserted 2089657418 1476488264
15095 LabelType
15096 \end_layout
15097
15098 \end_inset
15099
15100  is
15101 \begin_inset Flex Code
15102 status collapsed
15103
15104 \begin_layout Plain Layout
15105
15106 \change_inserted 2089657418 1476488264
15107 Enumerate
15108 \end_layout
15109
15110 \end_inset
15111
15112 .
15113 \change_unchanged
15114
15115 \end_layout
15116
15117 \begin_layout Description
15118 \begin_inset Flex Code
15119 status collapsed
15120
15121 \begin_layout Plain Layout
15122 TextFont
15123 \end_layout
15124
15125 \end_inset
15126
15127  The font used for the text body .
15128  See
15129 \begin_inset CommandInset ref
15130 LatexCommand ref
15131 reference "subsec:Font-description"
15132
15133 \end_inset
15134
15135 .
15136 \end_layout
15137
15138 \begin_layout Description
15139 \begin_inset Flex Code
15140 status collapsed
15141
15142 \begin_layout Plain Layout
15143 TocLevel
15144 \end_layout
15145
15146 \end_inset
15147
15148
15149 \series medium
15150  [
15151 \begin_inset Flex Code
15152 status collapsed
15153
15154 \begin_layout Plain Layout
15155
15156 \series medium
15157 int=3
15158 \end_layout
15159
15160 \end_inset
15161
15162 ]
15163 \series default
15164  The level of the style in the table of contents.
15165  This is used for automatic numbering of section headings.
15166 \end_layout
15167
15168 \begin_layout Description
15169 \begin_inset Flex Code
15170 status collapsed
15171
15172 \begin_layout Plain Layout
15173 ToggleIndent
15174 \end_layout
15175
15176 \end_inset
15177
15178  [
15179 \emph on
15180
15181 \begin_inset Flex Code
15182 status collapsed
15183
15184 \begin_layout Plain Layout
15185
15186 \emph on
15187 default
15188 \end_layout
15189
15190 \end_inset
15191
15192
15193 \emph default
15194 ,
15195 \begin_inset Flex Code
15196 status collapsed
15197
15198 \begin_layout Plain Layout
15199 always
15200 \end_layout
15201
15202 \end_inset
15203
15204 ,
15205 \begin_inset Flex Code
15206 status collapsed
15207
15208 \begin_layout Plain Layout
15209 never
15210 \end_layout
15211
15212 \end_inset
15213
15214 ] This tag determines whether the first line indentation of this paragraph
15215  can be toggled via the Paragraph settings dialog.
15216  If
15217 \emph on
15218
15219 \begin_inset Flex Code
15220 status collapsed
15221
15222 \begin_layout Plain Layout
15223
15224 \emph off
15225 default
15226 \end_layout
15227
15228 \end_inset
15229
15230
15231 \emph default
15232  is set, indentation can be toggled if the document settings use
15233 \begin_inset Quotes eld
15234 \end_inset
15235
15236 indent
15237 \begin_inset Quotes erd
15238 \end_inset
15239
15240  paragraph style, with
15241 \begin_inset Flex Code
15242 status collapsed
15243
15244 \begin_layout Plain Layout
15245 always
15246 \end_layout
15247
15248 \end_inset
15249
15250 , indentation can always be toggled, notwithstanding the document settings,
15251  with
15252 \begin_inset Flex Code
15253 status collapsed
15254
15255 \begin_layout Plain Layout
15256 never
15257 \end_layout
15258
15259 \end_inset
15260
15261 , indentation can never be toggled.
15262 \end_layout
15263
15264 \begin_layout Description
15265 \begin_inset Flex Code
15266 status collapsed
15267
15268 \begin_layout Plain Layout
15269 TopSep
15270 \end_layout
15271
15272 \end_inset
15273
15274  [
15275 \begin_inset Flex Code
15276 status collapsed
15277
15278 \begin_layout Plain Layout
15279 float=0
15280 \end_layout
15281
15282 \end_inset
15283
15284 ] The vertical space with which the very first of a chain of paragraphs
15285  with this style is separated from the previous paragraph.
15286  If the previous paragraph has another style, the separations are not simply
15287  added, but the maximum is taken.
15288 \end_layout
15289
15290 \begin_layout Subsection
15291 \begin_inset CommandInset label
15292 LatexCommand label
15293 name "subsec:I18n"
15294
15295 \end_inset
15296
15297 Internationalization of Paragraph Styles
15298 \end_layout
15299
15300 \begin_layout Standard
15301 \SpecialChar LyX
15302  has long supported internationalization of layout information, but, until
15303  version 2.0, this applied only to the user interface and not to, say, PDF
15304  output.
15305  Thus, French authors were forced to resort to ugly hacks if they wanted
15306  `
15307 \lang french
15308 Théorème
15309 \lang english
15310  1' instead of `Theorem 1'.
15311  Thanks to Georg Baum, that is no longer the case.
15312 \end_layout
15313
15314 \begin_layout Standard
15315 If a
15316 \begin_inset Flex Code
15317 status collapsed
15318
15319 \begin_layout Plain Layout
15320 Style
15321 \end_layout
15322
15323 \end_inset
15324
15325  defines text that is to appear in the typeset document, it may use
15326 \begin_inset Flex Code
15327 status collapsed
15328
15329 \begin_layout Plain Layout
15330 LangPreamble
15331 \end_layout
15332
15333 \end_inset
15334
15335  and
15336 \begin_inset Flex Code
15337 status collapsed
15338
15339 \begin_layout Plain Layout
15340 BabelPreamble
15341 \end_layout
15342
15343 \end_inset
15344
15345  to support non-English and even multi-language documents correctly.
15346  The following excerpt (from the
15347 \begin_inset Flex Code
15348 status collapsed
15349
15350 \begin_layout Plain Layout
15351 theorems-ams.inc
15352 \end_layout
15353
15354 \end_inset
15355
15356  file) shows how this works:
15357 \end_layout
15358
15359 \begin_layout LyX-Code
15360 Preamble
15361 \end_layout
15362
15363 \begin_deeper
15364 \begin_layout LyX-Code
15365
15366 \backslash
15367 theoremstyle{remark}
15368 \end_layout
15369
15370 \begin_layout LyX-Code
15371
15372 \backslash
15373 newtheorem{claim}[thm]{
15374 \backslash
15375 protect
15376 \backslash
15377 claimname}
15378 \end_layout
15379
15380 \begin_layout LyX-Code
15381 EndPreamble
15382 \end_layout
15383
15384 \begin_layout LyX-Code
15385 LangPreamble
15386 \end_layout
15387
15388 \begin_layout LyX-Code
15389
15390 \backslash
15391 providecommand{
15392 \backslash
15393 claimname}{_(Claim)}
15394 \end_layout
15395
15396 \begin_layout LyX-Code
15397 EndLangPreamble
15398 \end_layout
15399
15400 \begin_layout LyX-Code
15401 BabelPreamble
15402 \end_layout
15403
15404 \begin_layout LyX-Code
15405
15406 \backslash
15407 addto
15408 \backslash
15409 captions$$lang{
15410 \backslash
15411 renewcommand{
15412 \backslash
15413 claimname}{_(Claim)}}
15414 \end_layout
15415
15416 \begin_layout LyX-Code
15417 EndBabelPreamble
15418 \end_layout
15419
15420 \end_deeper
15421 \begin_layout Standard
15422 In principle, any legal \SpecialChar LaTeX
15423  may appear in the
15424 \begin_inset Flex Code
15425 status collapsed
15426
15427 \begin_layout Plain Layout
15428 LangPreamble
15429 \end_layout
15430
15431 \end_inset
15432
15433  and
15434 \begin_inset Flex Code
15435 status collapsed
15436
15437 \begin_layout Plain Layout
15438 BabelPreamble
15439 \end_layout
15440
15441 \end_inset
15442
15443  tags, but in practice they will typically look as they do here.
15444  The key to correct translation of the typeset text is the definition of
15445  the \SpecialChar LaTeX
15446  command
15447 \begin_inset Flex Code
15448 status collapsed
15449
15450 \begin_layout Plain Layout
15451
15452 \backslash
15453 claimname
15454 \end_layout
15455
15456 \end_inset
15457
15458  and its use in
15459 \begin_inset Flex Code
15460 status collapsed
15461
15462 \begin_layout Plain Layout
15463
15464 \backslash
15465 newtheorem
15466 \end_layout
15467
15468 \end_inset
15469
15470 .
15471
15472 \end_layout
15473
15474 \begin_layout Standard
15475 The
15476 \begin_inset Flex Code
15477 status collapsed
15478
15479 \begin_layout Plain Layout
15480 LangPreamble
15481 \end_layout
15482
15483 \end_inset
15484
15485  tag provides for internationalization based upon the overall language of
15486  the document.
15487  The contents of the tag will be included in the preamble, just as with
15488  the
15489 \begin_inset Flex Code
15490 status collapsed
15491
15492 \begin_layout Plain Layout
15493 Preamble
15494 \end_layout
15495
15496 \end_inset
15497
15498  tag.
15499  What makes it special is the use of the
15500 \begin_inset Quotes eld
15501 \end_inset
15502
15503 function
15504 \begin_inset Quotes erd
15505 \end_inset
15506
15507
15508 \begin_inset Flex Code
15509 status collapsed
15510
15511 \begin_layout Plain Layout
15512 _()
15513 \end_layout
15514
15515 \end_inset
15516
15517 , which will be replaced, when \SpecialChar LyX
15518  produces \SpecialChar LaTeX
15519  output, with the translation of
15520  its argument into the document language.
15521 \end_layout
15522
15523 \begin_layout Standard
15524 The
15525 \begin_inset Flex Code
15526 status collapsed
15527
15528 \begin_layout Plain Layout
15529 BabelPreamble
15530 \end_layout
15531
15532 \end_inset
15533
15534  tag is more complex, since it is meant to provide support for multi-language
15535  documents and so offers an interface to the
15536 \begin_inset Flex Code
15537 status collapsed
15538
15539 \begin_layout Plain Layout
15540 babel
15541 \end_layout
15542
15543 \end_inset
15544
15545  package.
15546  Its contents will be added to the preamble once for each language that
15547  appears in the document.
15548  In this case, the argument to
15549 \begin_inset Flex Code
15550 status collapsed
15551
15552 \begin_layout Plain Layout
15553 _()
15554 \end_layout
15555
15556 \end_inset
15557
15558  will be replaced with its translation into the language in question; the
15559  expression
15560 \begin_inset Flex Code
15561 status collapsed
15562
15563 \begin_layout Plain Layout
15564 $$lang
15565 \end_layout
15566
15567 \end_inset
15568
15569  is replaced by the language name (as used by the babel package).
15570 \end_layout
15571
15572 \begin_layout Standard
15573 A German document that also included a French section would thus have the
15574  following in the preamble:
15575 \end_layout
15576
15577 \begin_layout LyX-Code
15578
15579 \backslash
15580 addto
15581 \backslash
15582 captionsfrench{
15583 \backslash
15584 renewcommand{
15585 \backslash
15586 claimname}{Affirmation}}
15587 \begin_inset Newline newline
15588 \end_inset
15589
15590
15591 \backslash
15592 addto
15593 \backslash
15594 captionsngerman{
15595 \backslash
15596 renewcommand{
15597 \backslash
15598 claimname}{Behauptung}}
15599 \begin_inset Newline newline
15600 \end_inset
15601
15602
15603 \backslash
15604 providecommand{
15605 \backslash
15606 claimname}{Behauptung}
15607 \end_layout
15608
15609 \begin_layout Standard
15610 \SpecialChar LaTeX
15611  and
15612 \begin_inset Flex Code
15613 status collapsed
15614
15615 \begin_layout Plain Layout
15616 babel
15617 \end_layout
15618
15619 \end_inset
15620
15621  will then conspire to produce the correct text in the output.
15622 \end_layout
15623
15624 \begin_layout Standard
15625 One important point to note here is that the translations are provided by
15626  \SpecialChar LyX
15627  itself, through the file
15628 \begin_inset Flex Code
15629 status collapsed
15630
15631 \begin_layout Plain Layout
15632 layouttranslations
15633 \end_layout
15634
15635 \end_inset
15636
15637 .
15638  This means, in effect, that
15639 \begin_inset Flex Code
15640 status collapsed
15641
15642 \begin_layout Plain Layout
15643 LangPreamble
15644 \end_layout
15645
15646 \end_inset
15647
15648  and
15649 \begin_inset Flex Code
15650 status collapsed
15651
15652 \begin_layout Plain Layout
15653 BabelPreamble
15654 \end_layout
15655
15656 \end_inset
15657
15658  are really only of use in layout files that are provided with \SpecialChar LyX
15659 , since text
15660  entered in user-created layout files will not be seen by \SpecialChar LyX
15661 's internationalizatio
15662 n routines unless the
15663 \begin_inset Flex Code
15664 status collapsed
15665
15666 \begin_layout Plain Layout
15667 layouttranslations
15668 \end_layout
15669
15670 \end_inset
15671
15672  file is modified accordingly.
15673  That said, however, any layout created with the intention that it will
15674  be included with \SpecialChar LyX
15675  should use these tags where appropriate.
15676  Please note that the paragraph style translations provided by \SpecialChar LyX
15677  will never
15678  change with a minor update (e.
15679 \begin_inset space \thinspace{}
15680 \end_inset
15681
15682 g.
15683 \begin_inset space \space{}
15684 \end_inset
15685
15686 from version 2.1.x to 2.1.y).
15687  It is however quite likely that a major update (e.
15688 \begin_inset space \thinspace{}
15689 \end_inset
15690
15691 g.
15692 \begin_inset space \space{}
15693 \end_inset
15694
15695 from 2.0.x to 2.1.y) will introduce new translations or corrections.
15696 \end_layout
15697
15698 \begin_layout Subsection
15699 Floats
15700 \begin_inset CommandInset label
15701 LatexCommand label
15702 name "subsec:Floats"
15703
15704 \end_inset
15705
15706
15707 \end_layout
15708
15709 \begin_layout Standard
15710 It is necessary to define the floats (
15711 \begin_inset Flex Noun
15712 status collapsed
15713
15714 \begin_layout Plain Layout
15715 figure
15716 \end_layout
15717
15718 \end_inset
15719
15720 ,
15721 \begin_inset Flex Noun
15722 status collapsed
15723
15724 \begin_layout Plain Layout
15725 table
15726 \end_layout
15727
15728 \end_inset
15729
15730 , \SpecialChar ldots
15731 ) in the text class itself.
15732  Standard floats are included in the file
15733 \begin_inset Flex Code
15734 status collapsed
15735
15736 \begin_layout Plain Layout
15737 stdfloats.inc
15738 \end_layout
15739
15740 \end_inset
15741
15742 , so you may have to do no more than add
15743 \end_layout
15744
15745 \begin_layout LyX-Code
15746 Input stdfloats.inc
15747 \end_layout
15748
15749 \begin_layout Standard
15750 to your layout file.
15751  If you want to implement a text class that proposes some other float types
15752  (like the AGU class bundled with \SpecialChar LyX
15753 ), the information below will hopefully
15754  help you:
15755 \end_layout
15756
15757 \begin_layout Description
15758 \begin_inset Flex Code
15759 status collapsed
15760
15761 \begin_layout Plain Layout
15762 AllowedPlacement
15763 \end_layout
15764
15765 \end_inset
15766
15767  [
15768 \begin_inset Flex Code
15769 status collapsed
15770
15771 \begin_layout Plain Layout
15772 string
15773 \end_layout
15774
15775 \end_inset
15776
15777 =!htbpH] Allowed placement options for this float type.
15778  The value is a string of placement characters.
15779  Possible characters include:
15780 \emph on
15781 h
15782 \emph default
15783  (
15784 \begin_inset Quotes eld
15785 \end_inset
15786
15787 here if possible
15788 \begin_inset Quotes erd
15789 \end_inset
15790
15791 ),
15792 \emph on
15793 t
15794 \emph default
15795  (
15796 \begin_inset Quotes eld
15797 \end_inset
15798
15799 top of page
15800 \begin_inset Quotes erd
15801 \end_inset
15802
15803 ),
15804 \emph on
15805 b
15806 \emph default
15807  (
15808 \begin_inset Quotes eld
15809 \end_inset
15810
15811 bottom of page
15812 \begin_inset Quotes erd
15813 \end_inset
15814
15815 ),
15816 \emph on
15817 p
15818 \emph default
15819  (
15820 \begin_inset Quotes eld
15821 \end_inset
15822
15823 page of floats
15824 \begin_inset Quotes erd
15825 \end_inset
15826
15827 ),
15828 \emph on
15829 H
15830 \emph default
15831  (
15832 \begin_inset Quotes eld
15833 \end_inset
15834
15835 here definitely
15836 \begin_inset Quotes erd
15837 \end_inset
15838
15839 ) and
15840 \emph on
15841 !
15842 \emph default
15843  (
15844 \begin_inset Quotes eld
15845 \end_inset
15846
15847 ignore LaTeX rules
15848 \begin_inset Quotes erd
15849 \end_inset
15850
15851 ).
15852  The order of the characters in the string does not matter.
15853  If no placement options are allowed, use the string
15854 \emph on
15855 none
15856 \emph default
15857 .
15858 \end_layout
15859
15860 \begin_layout Description
15861 \begin_inset Flex Code
15862 status collapsed
15863
15864 \begin_layout Plain Layout
15865 AllowsSideways
15866 \end_layout
15867
15868 \end_inset
15869
15870  [
15871 \begin_inset Flex Code
15872 status collapsed
15873
15874 \begin_layout Plain Layout
15875
15876 \emph off
15877 0
15878 \end_layout
15879
15880 \end_inset
15881
15882 ,
15883 \begin_inset space \thinspace{}
15884 \end_inset
15885
15886
15887 \emph on
15888
15889 \begin_inset Flex Code
15890 status collapsed
15891
15892 \begin_layout Plain Layout
15893
15894 \emph on
15895 1
15896 \end_layout
15897
15898 \end_inset
15899
15900
15901 \emph default
15902 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
15903 -package
15904 \family typewriter
15905 rotfloat
15906 \family default
15907  (sidewaysfloat).
15908  Set to
15909 \begin_inset Flex Code
15910 status collapsed
15911
15912 \begin_layout Plain Layout
15913 0
15914 \end_layout
15915
15916 \end_inset
15917
15918  if the float does not support this feature.
15919 \end_layout
15920
15921 \begin_layout Description
15922 \begin_inset Flex Code
15923 status collapsed
15924
15925 \begin_layout Plain Layout
15926 AllowsWide
15927 \end_layout
15928
15929 \end_inset
15930
15931  [
15932 \begin_inset Flex Code
15933 status collapsed
15934
15935 \begin_layout Plain Layout
15936
15937 \emph off
15938 0
15939 \end_layout
15940
15941 \end_inset
15942
15943 ,
15944 \begin_inset space \thinspace{}
15945 \end_inset
15946
15947
15948 \emph on
15949
15950 \begin_inset Flex Code
15951 status collapsed
15952
15953 \begin_layout Plain Layout
15954
15955 \emph on
15956 1
15957 \end_layout
15958
15959 \end_inset
15960
15961
15962 \emph default
15963 ] Defines whether the float has a starred variant that spans columns in
15964  a two column paragraph.
15965  Set to
15966 \begin_inset Flex Code
15967 status collapsed
15968
15969 \begin_layout Plain Layout
15970 0
15971 \end_layout
15972
15973 \end_inset
15974
15975  if the float does not support this feature.
15976 \end_layout
15977
15978 \begin_layout Description
15979 \begin_inset Flex Code
15980 status collapsed
15981
15982 \begin_layout Plain Layout
15983 Extension
15984 \end_layout
15985
15986 \end_inset
15987
15988  [
15989 \begin_inset Flex Code
15990 status collapsed
15991
15992 \begin_layout Plain Layout
15993 string
15994 \end_layout
15995
15996 \end_inset
15997
15998 =
15999 \begin_inset Quotes erd
16000 \end_inset
16001
16002
16003 \begin_inset Quotes erd
16004 \end_inset
16005
16006 ] The file name extension of an auxiliary file for the list of figures (or
16007  whatever).
16008  \SpecialChar LaTeX
16009  writes the captions to this file.
16010 \end_layout
16011
16012 \begin_layout Description
16013 \begin_inset Flex Code
16014 status collapsed
16015
16016 \begin_layout Plain Layout
16017 GuiName
16018 \end_layout
16019
16020 \end_inset
16021
16022  [
16023 \begin_inset Flex Code
16024 status collapsed
16025
16026 \begin_layout Plain Layout
16027 string
16028 \end_layout
16029
16030 \end_inset
16031
16032 =
16033 \begin_inset Quotes erd
16034 \end_inset
16035
16036
16037 \begin_inset Quotes erd
16038 \end_inset
16039
16040 ] The string that will be used in the menus and also for the caption.
16041  This is translated to the current language if babel is used.
16042 \end_layout
16043
16044 \begin_layout Description
16045 \begin_inset Flex Code
16046 status collapsed
16047
16048 \begin_layout Plain Layout
16049 HTML*
16050 \end_layout
16051
16052 \end_inset
16053
16054  These tags control the XHTML output.
16055  See
16056 \begin_inset CommandInset ref
16057 LatexCommand ref
16058 reference "sec:Tags-for-XHTML"
16059
16060 \end_inset
16061
16062 .
16063 \end_layout
16064
16065 \begin_layout Description
16066 \begin_inset Flex Code
16067 status collapsed
16068
16069 \begin_layout Plain Layout
16070 IsPredefined
16071 \end_layout
16072
16073 \end_inset
16074
16075  [
16076 \emph on
16077
16078 \begin_inset Flex Code
16079 status collapsed
16080
16081 \begin_layout Plain Layout
16082 0
16083 \end_layout
16084
16085 \end_inset
16086
16087
16088 \emph default
16089 ,
16090 \begin_inset space \thinspace{}
16091 \end_inset
16092
16093
16094 \begin_inset Flex Code
16095 status collapsed
16096
16097 \begin_layout Plain Layout
16098 1
16099 \end_layout
16100
16101 \end_inset
16102
16103 ] Indicates whether the float is already defined in the document class or
16104  if instead the \SpecialChar LaTeX
16105  package
16106 \begin_inset Flex Code
16107 status collapsed
16108
16109 \begin_layout Plain Layout
16110 float
16111 \end_layout
16112
16113 \end_inset
16114
16115  needs to be loaded to define it on-the-fly.
16116  The default is
16117 \begin_inset Flex Code
16118 status collapsed
16119
16120 \begin_layout Plain Layout
16121 0
16122 \end_layout
16123
16124 \end_inset
16125
16126 , which means:
16127 \begin_inset Flex Code
16128 status collapsed
16129
16130 \begin_layout Plain Layout
16131 float
16132 \end_layout
16133
16134 \end_inset
16135
16136  is used.
16137  It should be set to
16138 \begin_inset Flex Code
16139 status collapsed
16140
16141 \begin_layout Plain Layout
16142 1
16143 \end_layout
16144
16145 \end_inset
16146
16147  if the float is already defined by the \SpecialChar LaTeX
16148  document class.
16149 \end_layout
16150
16151 \begin_layout Description
16152 \begin_inset Flex Code
16153 status collapsed
16154
16155 \begin_layout Plain Layout
16156 ListCommand
16157 \end_layout
16158
16159 \end_inset
16160
16161  [
16162 \begin_inset Flex Code
16163 status collapsed
16164
16165 \begin_layout Plain Layout
16166 string
16167 \end_layout
16168
16169 \end_inset
16170
16171 =
16172 \begin_inset Quotes erd
16173 \end_inset
16174
16175
16176 \begin_inset Quotes erd
16177 \end_inset
16178
16179 ] The command used to generate a list of floats of this type; the leading
16180  `
16181 \backslash
16182 ' must be omitted.
16183  This
16184 \emph on
16185 must
16186 \emph default
16187  be given if
16188 \begin_inset Flex Code
16189 status collapsed
16190
16191 \begin_layout Plain Layout
16192 UsesFloatPkg
16193 \end_layout
16194
16195 \end_inset
16196
16197  is false, since there is no standard way to generate this command.
16198  It is ignored if
16199 \begin_inset Flex Code
16200 status collapsed
16201
16202 \begin_layout Plain Layout
16203 UsesFloatPkg
16204 \end_layout
16205
16206 \end_inset
16207
16208  is true, since in that case there is a standard way to define the command.
16209 \end_layout
16210
16211 \begin_layout Description
16212 \begin_inset Flex Code
16213 status collapsed
16214
16215 \begin_layout Plain Layout
16216 ListName
16217 \end_layout
16218
16219 \end_inset
16220
16221  [
16222 \begin_inset Flex Code
16223 status collapsed
16224
16225 \begin_layout Plain Layout
16226 string
16227 \end_layout
16228
16229 \end_inset
16230
16231 =
16232 \begin_inset Quotes erd
16233 \end_inset
16234
16235
16236 \begin_inset Quotes erd
16237 \end_inset
16238
16239 ] A title for a list of floats of this kind (list of figures, tables, or
16240  whatever).
16241  It is used for the screen label within \SpecialChar LyX
16242 , it is used by \SpecialChar LaTeX
16243  for the title and
16244  it is used as the title in the XHTML output.
16245  It will be translated to the document language.
16246 \end_layout
16247
16248 \begin_layout Description
16249 \begin_inset Flex Code
16250 status collapsed
16251
16252 \begin_layout Plain Layout
16253 NumberWithin
16254 \end_layout
16255
16256 \end_inset
16257
16258  [
16259 \begin_inset Flex Code
16260 status collapsed
16261
16262 \begin_layout Plain Layout
16263 string
16264 \end_layout
16265
16266 \end_inset
16267
16268 =
16269 \begin_inset Quotes erd
16270 \end_inset
16271
16272
16273 \begin_inset Quotes erd
16274 \end_inset
16275
16276 ] This (optional) argument determines whether floats of this class will
16277  be numbered within some sectional unit of the document.
16278  For example, if
16279 \begin_inset Flex Code
16280 status collapsed
16281
16282 \begin_layout Plain Layout
16283 NumberWithin
16284 \end_layout
16285
16286 \end_inset
16287
16288  is set to
16289 \begin_inset Quotes eld
16290 \end_inset
16291
16292
16293 \begin_inset Flex Code
16294 status collapsed
16295
16296 \begin_layout Plain Layout
16297 chapter
16298 \end_layout
16299
16300 \end_inset
16301
16302
16303 \begin_inset Quotes erd
16304 \end_inset
16305
16306 , the floats will be numbered within chapters.
16307
16308 \end_layout
16309
16310 \begin_layout Description
16311 \begin_inset Flex Code
16312 status collapsed
16313
16314 \begin_layout Plain Layout
16315 Placement
16316 \end_layout
16317
16318 \end_inset
16319
16320  [
16321 \begin_inset Flex Code
16322 status collapsed
16323
16324 \begin_layout Plain Layout
16325 string
16326 \end_layout
16327
16328 \end_inset
16329
16330 =
16331 \begin_inset Quotes erd
16332 \end_inset
16333
16334
16335 \begin_inset Quotes erd
16336 \end_inset
16337
16338 ] The default placement for the given class of floats.
16339  The string should be as in standard \SpecialChar LaTeX
16340 :
16341 \begin_inset Flex Code
16342 status collapsed
16343
16344 \begin_layout Plain Layout
16345 t
16346 \end_layout
16347
16348 \end_inset
16349
16350 ,
16351 \begin_inset Flex Code
16352 status collapsed
16353
16354 \begin_layout Plain Layout
16355 b
16356 \end_layout
16357
16358 \end_inset
16359
16360 ,
16361 \begin_inset Flex Code
16362 status collapsed
16363
16364 \begin_layout Plain Layout
16365 p
16366 \end_layout
16367
16368 \end_inset
16369
16370  and
16371 \begin_inset Flex Code
16372 status collapsed
16373
16374 \begin_layout Plain Layout
16375 h
16376 \end_layout
16377
16378 \end_inset
16379
16380  for top, bottom, page, and here, respectively.
16381 \begin_inset Foot
16382 status collapsed
16383
16384 \begin_layout Plain Layout
16385 Note that the order of these letters in the string is irrelevant, like in
16386  \SpecialChar LaTeX
16387 .
16388 \end_layout
16389
16390 \end_inset
16391
16392  On top of that there is a new type,
16393 \begin_inset Flex Code
16394 status collapsed
16395
16396 \begin_layout Plain Layout
16397 H
16398 \end_layout
16399
16400 \end_inset
16401
16402 , which does not really correspond to a float, since it means: put it
16403 \begin_inset Quotes eld
16404 \end_inset
16405
16406 here
16407 \begin_inset Quotes erd
16408 \end_inset
16409
16410  and nowhere else.
16411  Note however that the
16412 \begin_inset Flex Code
16413 status collapsed
16414
16415 \begin_layout Plain Layout
16416 H
16417 \end_layout
16418
16419 \end_inset
16420
16421  specifier is special and, because of implementation details, cannot be
16422  used in non-built in float types.
16423  If you do not understand what this means, just use
16424 \begin_inset Quotes eld
16425 \end_inset
16426
16427
16428 \begin_inset Flex Code
16429 status collapsed
16430
16431 \begin_layout Plain Layout
16432 tbp
16433 \end_layout
16434
16435 \end_inset
16436
16437
16438 \begin_inset Quotes erd
16439 \end_inset
16440
16441 .
16442 \end_layout
16443
16444 \begin_layout Description
16445 \begin_inset Flex Code
16446 status collapsed
16447
16448 \begin_layout Plain Layout
16449 RefPrefix
16450 \end_layout
16451
16452 \end_inset
16453
16454  [
16455 \begin_inset Flex Code
16456 status collapsed
16457
16458 \begin_layout Plain Layout
16459 string
16460 \end_layout
16461
16462 \end_inset
16463
16464 ] The prefix to use when creating labels referring to floats of this type.
16465  This allows the use of formatted references.
16466  Note that you can remove any
16467 \begin_inset Flex Code
16468 status collapsed
16469
16470 \begin_layout Plain Layout
16471 RefPrefix
16472 \end_layout
16473
16474 \end_inset
16475
16476  set by a copied style by using the special value
16477 \begin_inset Quotes eld
16478 \end_inset
16479
16480 OFF
16481 \begin_inset Quotes erd
16482 \end_inset
16483
16484 , which must be all caps.
16485 \end_layout
16486
16487 \begin_layout Description
16488 \begin_inset Flex Code
16489 status collapsed
16490
16491 \begin_layout Plain Layout
16492 Style
16493 \end_layout
16494
16495 \end_inset
16496
16497  [
16498 \begin_inset Flex Code
16499 status collapsed
16500
16501 \begin_layout Plain Layout
16502 string
16503 \end_layout
16504
16505 \end_inset
16506
16507 =
16508 \begin_inset Quotes erd
16509 \end_inset
16510
16511
16512 \begin_inset Quotes erd
16513 \end_inset
16514
16515 ] The style used when defining the float using
16516 \begin_inset Flex Code
16517 status collapsed
16518
16519 \begin_layout Plain Layout
16520
16521 \backslash
16522 newfloat
16523 \end_layout
16524
16525 \end_inset
16526
16527 .
16528 \end_layout
16529
16530 \begin_layout Description
16531 \begin_inset Flex Code
16532 status collapsed
16533
16534 \begin_layout Plain Layout
16535 Type
16536 \end_layout
16537
16538 \end_inset
16539
16540  [
16541 \begin_inset Flex Code
16542 status collapsed
16543
16544 \begin_layout Plain Layout
16545 string
16546 \end_layout
16547
16548 \end_inset
16549
16550 =
16551 \begin_inset Quotes erd
16552 \end_inset
16553
16554
16555 \begin_inset Quotes erd
16556 \end_inset
16557
16558 ] The
16559 \begin_inset Quotes eld
16560 \end_inset
16561
16562 type
16563 \begin_inset Quotes erd
16564 \end_inset
16565
16566  of the new class of floats, like program or algorithm.
16567  After the appropriate
16568 \begin_inset Flex Code
16569 status collapsed
16570
16571 \begin_layout Plain Layout
16572
16573 \backslash
16574 newfloat
16575 \end_layout
16576
16577 \end_inset
16578
16579 , commands such as
16580 \begin_inset Flex Code
16581 status collapsed
16582
16583 \begin_layout Plain Layout
16584
16585 \backslash
16586 begin{program}
16587 \end_layout
16588
16589 \end_inset
16590
16591  or
16592 \begin_inset Flex Code
16593 status collapsed
16594
16595 \begin_layout Plain Layout
16596
16597 \backslash
16598 end{algorithm*}
16599 \end_layout
16600
16601 \end_inset
16602
16603  will be available.
16604 \end_layout
16605
16606 \begin_layout Description
16607 \begin_inset Flex Code
16608 status collapsed
16609
16610 \begin_layout Plain Layout
16611 UsesFloatPkg
16612 \end_layout
16613
16614 \end_inset
16615
16616  [
16617 \begin_inset Flex Code
16618 status collapsed
16619
16620 \begin_layout Plain Layout
16621 0
16622 \end_layout
16623
16624 \end_inset
16625
16626 ,
16627 \begin_inset space \thinspace{}
16628 \end_inset
16629
16630
16631 \begin_inset Flex Code
16632 status collapsed
16633
16634 \begin_layout Plain Layout
16635
16636 \emph on
16637 1
16638 \end_layout
16639
16640 \end_inset
16641
16642 ] Specifies whether this float is defined using the \SpecialChar LaTeX
16643  package
16644 \begin_inset Flex Code
16645 status collapsed
16646
16647 \begin_layout Plain Layout
16648 float
16649 \end_layout
16650
16651 \end_inset
16652
16653 , either by the class file, another package or on-the-fly by \SpecialChar LyX
16654  itself.
16655 \end_layout
16656
16657 \begin_layout Standard
16658 Note that defining a float with type
16659 \begin_inset Flex Code
16660 status collapsed
16661
16662 \begin_layout Plain Layout
16663
16664 \emph on
16665 type
16666 \end_layout
16667
16668 \end_inset
16669
16670  automatically defines the corresponding counter with name
16671 \begin_inset Flex Code
16672 status collapsed
16673
16674 \begin_layout Plain Layout
16675
16676 \emph on
16677 type
16678 \end_layout
16679
16680 \end_inset
16681
16682 .
16683 \end_layout
16684
16685 \begin_layout Subsection
16686 Flex insets and InsetLayout
16687 \begin_inset CommandInset label
16688 LatexCommand label
16689 name "subsec:Flex-insets-and"
16690
16691 \end_inset
16692
16693
16694 \end_layout
16695
16696 \begin_layout Standard
16697 Flex insets come in three different kinds:
16698 \end_layout
16699
16700 \begin_layout Itemize
16701 character style (
16702 \begin_inset Flex Code
16703 status collapsed
16704
16705 \begin_layout Plain Layout
16706 CharStyle
16707 \end_layout
16708
16709 \end_inset
16710
16711 ): These define semantic markup corresponding to such \SpecialChar LaTeX
16712  commands as
16713 \begin_inset Flex Code
16714 status collapsed
16715
16716 \begin_layout Plain Layout
16717
16718 \backslash
16719 noun
16720 \end_layout
16721
16722 \end_inset
16723
16724  and
16725 \begin_inset Flex Code
16726 status collapsed
16727
16728 \begin_layout Plain Layout
16729
16730 \backslash
16731 code
16732 \end_layout
16733
16734 \end_inset
16735
16736 .
16737 \end_layout
16738
16739 \begin_layout Itemize
16740 user custom (
16741 \begin_inset Flex Code
16742 status collapsed
16743
16744 \begin_layout Plain Layout
16745 Custom
16746 \end_layout
16747
16748 \end_inset
16749
16750 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
16751  code,
16752  footnote, and the like.
16753  An obvious example is an endnote inset, which is defined in the
16754 \begin_inset Flex Code
16755 status collapsed
16756
16757 \begin_layout Plain Layout
16758 endnote
16759 \end_layout
16760
16761 \end_inset
16762
16763  module.
16764 \end_layout
16765
16766 \begin_layout Itemize
16767 XML elements (
16768 \begin_inset Flex Code
16769 status collapsed
16770
16771 \begin_layout Plain Layout
16772 Element
16773 \end_layout
16774
16775 \end_inset
16776
16777 ): For use with DocBook classes.
16778 \end_layout
16779
16780 \begin_layout Standard
16781 Flex insets are defined using the
16782 \begin_inset Flex Code
16783 status collapsed
16784
16785 \begin_layout Plain Layout
16786 InsetLayout
16787 \end_layout
16788
16789 \end_inset
16790
16791  tag, which shall be explained in a moment.
16792 \end_layout
16793
16794 \begin_layout Standard
16795 The
16796 \begin_inset Flex Code
16797 status collapsed
16798
16799 \begin_layout Plain Layout
16800 InsetLayout
16801 \end_layout
16802
16803 \end_inset
16804
16805  tag also serves another function: It can be used to customize the general
16806  layout of many different types of insets.
16807  Currently,
16808 \begin_inset Flex Code
16809 status collapsed
16810
16811 \begin_layout Plain Layout
16812 InsetLayout
16813 \end_layout
16814
16815 \end_inset
16816
16817  can be used to customize the layout parameters for footnotes, marginal
16818  notes, note insets, \SpecialChar TeX
16819  code (ERT) insets, branches, listings, indexes, boxes,
16820  tables, algorithms, URLs, and captions, as well as to define Flex insets.
16821 \end_layout
16822
16823 \begin_layout Standard
16824 The
16825 \begin_inset Flex Code
16826 status collapsed
16827
16828 \begin_layout Plain Layout
16829 InsetLayout
16830 \end_layout
16831
16832 \end_inset
16833
16834  definition must begin with a line of the form:
16835 \end_layout
16836
16837 \begin_layout LyX-Code
16838 InsetLayout <type>
16839 \end_layout
16840
16841 \begin_layout Standard
16842 Here
16843 \begin_inset Flex Code
16844 status collapsed
16845
16846 \begin_layout Plain Layout
16847 <Type>
16848 \end_layout
16849
16850 \end_inset
16851
16852  indicates the inset whose layout is being defined, and here there are four
16853  cases.
16854 \end_layout
16855
16856 \begin_layout Enumerate
16857 The layout for a pre-existing inset is being modified.
16858  In this case, can be
16859 \begin_inset Flex Code
16860 status collapsed
16861
16862 \begin_layout Plain Layout
16863 <Type>
16864 \end_layout
16865
16866 \end_inset
16867
16868  any one of the following:
16869 \begin_inset Flex Code
16870 status collapsed
16871
16872 \begin_layout Plain Layout
16873 Algorithm
16874 \end_layout
16875
16876 \end_inset
16877
16878 ,
16879 \begin_inset Flex Code
16880 status collapsed
16881
16882 \begin_layout Plain Layout
16883 Branch
16884 \end_layout
16885
16886 \end_inset
16887
16888 ,
16889 \begin_inset Flex Code
16890 status collapsed
16891
16892 \begin_layout Plain Layout
16893 Box
16894 \end_layout
16895
16896 \end_inset
16897
16898 ,
16899 \begin_inset Flex Code
16900 status collapsed
16901
16902 \begin_layout Plain Layout
16903 Box:shaded
16904 \end_layout
16905
16906 \end_inset
16907
16908 ,
16909 \begin_inset Flex Code
16910 status collapsed
16911
16912 \begin_layout Plain Layout
16913 Caption:Standard
16914 \end_layout
16915
16916 \end_inset
16917
16918 ,
16919 \begin_inset Flex Code
16920 status collapsed
16921
16922 \begin_layout Plain Layout
16923 ERT
16924 \end_layout
16925
16926 \end_inset
16927
16928 ,
16929 \begin_inset Flex Code
16930 status collapsed
16931
16932 \begin_layout Plain Layout
16933 Figure
16934 \end_layout
16935
16936 \end_inset
16937
16938 ,
16939 \begin_inset Flex Code
16940 status collapsed
16941
16942 \begin_layout Plain Layout
16943 Foot
16944 \end_layout
16945
16946 \end_inset
16947
16948 ,
16949 \begin_inset Flex Code
16950 status collapsed
16951
16952 \begin_layout Plain Layout
16953 Index
16954 \end_layout
16955
16956 \end_inset
16957
16958 ,
16959 \begin_inset Flex Code
16960 status collapsed
16961
16962 \begin_layout Plain Layout
16963 Info
16964 \end_layout
16965
16966 \end_inset
16967
16968 ,
16969 \begin_inset Flex Code
16970 status collapsed
16971
16972 \begin_layout Plain Layout
16973 Info:menu
16974 \end_layout
16975
16976 \end_inset
16977
16978 ,
16979 \begin_inset Flex Code
16980 status collapsed
16981
16982 \begin_layout Plain Layout
16983 Info:shortcut
16984 \end_layout
16985
16986 \end_inset
16987
16988 ,
16989 \begin_inset Flex Code
16990 status collapsed
16991
16992 \begin_layout Plain Layout
16993 Info:shortcuts
16994 \end_layout
16995
16996 \end_inset
16997
16998 ,
16999 \begin_inset Flex Code
17000 status collapsed
17001
17002 \begin_layout Plain Layout
17003 Listings
17004 \end_layout
17005
17006 \end_inset
17007
17008 ,
17009 \begin_inset Flex Code
17010 status collapsed
17011
17012 \begin_layout Plain Layout
17013 Marginal
17014 \end_layout
17015
17016 \end_inset
17017
17018 ,
17019 \begin_inset Flex Code
17020 status collapsed
17021
17022 \begin_layout Plain Layout
17023 Note:Comment
17024 \end_layout
17025
17026 \end_inset
17027
17028 ,
17029 \begin_inset Flex Code
17030 status collapsed
17031
17032 \begin_layout Plain Layout
17033 Note:Note
17034 \end_layout
17035
17036 \end_inset
17037
17038 ,
17039 \begin_inset Flex Code
17040 status collapsed
17041
17042 \begin_layout Plain Layout
17043 Note:Greyedout
17044 \end_layout
17045
17046 \end_inset
17047
17048 ,
17049 \begin_inset Flex Code
17050 status collapsed
17051
17052 \begin_layout Plain Layout
17053 Table
17054 \end_layout
17055
17056 \end_inset
17057
17058 , or
17059 \begin_inset Flex Code
17060 status collapsed
17061
17062 \begin_layout Plain Layout
17063 URL
17064 \end_layout
17065
17066 \end_inset
17067
17068 .
17069 \end_layout
17070
17071 \begin_layout Enumerate
17072 The layout for a Flex inset is being defined.
17073  In this case,
17074 \begin_inset Flex Code
17075 status collapsed
17076
17077 \begin_layout Plain Layout
17078 <Type>
17079 \end_layout
17080
17081 \end_inset
17082
17083  must be of the form
17084 \begin_inset Quotes eld
17085 \end_inset
17086
17087
17088 \begin_inset Flex Code
17089 status collapsed
17090
17091 \begin_layout Plain Layout
17092 Flex:<name>
17093 \end_layout
17094
17095 \end_inset
17096
17097
17098 \begin_inset Quotes erd
17099 \end_inset
17100
17101 , where
17102 \begin_inset Flex Code
17103 status collapsed
17104
17105 \begin_layout Plain Layout
17106 name
17107 \end_layout
17108
17109 \end_inset
17110
17111  may be be any valid identifier not used by a pre-existing Flex inset.
17112  The identifier may include spaces, but in that case the whole thing must
17113  be wrapped in quotes.
17114  Note that the definition of a flex inset
17115 \emph on
17116 must
17117 \emph default
17118 also include a
17119 \begin_inset Flex Code
17120 status collapsed
17121
17122 \begin_layout Plain Layout
17123 LyXType
17124 \end_layout
17125
17126 \end_inset
17127
17128  entry, declaring which type of inset it defines.
17129 \end_layout
17130
17131 \begin_layout Enumerate
17132 The layout for user specific branch is being defined.
17133  In this case,
17134 \begin_inset Flex Code
17135 status collapsed
17136
17137 \begin_layout Plain Layout
17138 <Type>
17139 \end_layout
17140
17141 \end_inset
17142
17143  must be of the form
17144 \begin_inset Quotes eld
17145 \end_inset
17146
17147
17148 \begin_inset Flex Code
17149 status collapsed
17150
17151 \begin_layout Plain Layout
17152 Branch:<name>
17153 \end_layout
17154
17155 \end_inset
17156
17157
17158 \begin_inset Quotes erd
17159 \end_inset
17160
17161 , where
17162 \begin_inset Flex Code
17163 status collapsed
17164
17165 \begin_layout Plain Layout
17166 name
17167 \end_layout
17168
17169 \end_inset
17170
17171  may be be any valid identifier of branch defined in user's document.
17172  The identifier may include spaces, but in that case the whole thing must
17173  be wrapped in quotes.
17174  The main purpose of this feature is to allow \SpecialChar LaTeX
17175  wrapping around specific
17176  branches as user needs.
17177 \end_layout
17178
17179 \begin_layout Enumerate
17180 The layout of a user (or class) specific caption is being defined.
17181  In this case,
17182 \begin_inset Flex Code
17183 status collapsed
17184
17185 \begin_layout Plain Layout
17186 <Type>
17187 \end_layout
17188
17189 \end_inset
17190
17191  must be of the form
17192 \begin_inset Quotes eld
17193 \end_inset
17194
17195
17196 \begin_inset Flex Code
17197 status collapsed
17198
17199 \begin_layout Plain Layout
17200 Caption:<name>
17201 \end_layout
17202
17203 \end_inset
17204
17205
17206 \begin_inset Quotes erd
17207 \end_inset
17208
17209 , where
17210 \begin_inset Flex Code
17211 status collapsed
17212
17213 \begin_layout Plain Layout
17214 name
17215 \end_layout
17216
17217 \end_inset
17218
17219  specifies the name of the caption as it appears in the menu.
17220  Have a look at the standard caption (
17221 \begin_inset Flex Code
17222 status collapsed
17223
17224 \begin_layout Plain Layout
17225 Caption:Standard
17226 \end_layout
17227
17228 \end_inset
17229
17230 ), the specific captions of the KOMA-Script classes (
17231 \begin_inset Flex Code
17232 status collapsed
17233
17234 \begin_layout Plain Layout
17235 Caption:Above
17236 \end_layout
17237
17238 \end_inset
17239
17240 ,
17241 \begin_inset Flex Code
17242 status collapsed
17243
17244 \begin_layout Plain Layout
17245 Caption:Below
17246 \end_layout
17247
17248 \end_inset
17249
17250 ) or the module
17251 \family sans
17252 Multilingual
17253 \begin_inset space ~
17254 \end_inset
17255
17256 Captions
17257 \family default
17258 (
17259 \begin_inset Flex Code
17260 status collapsed
17261
17262 \begin_layout Plain Layout
17263 Caption:Bicaption
17264 \end_layout
17265
17266 \end_inset
17267
17268 ) for applications.
17269 \end_layout
17270
17271 \begin_layout Standard
17272 The
17273 \begin_inset Flex Code
17274 status collapsed
17275
17276 \begin_layout Plain Layout
17277 InsetLayout
17278 \end_layout
17279
17280 \end_inset
17281
17282  definition can contain the following entries:
17283 \end_layout
17284
17285 \begin_layout Description
17286 \begin_inset Flex Code
17287 status collapsed
17288
17289 \begin_layout Plain Layout
17290 Argument
17291 \end_layout
17292
17293 \end_inset
17294
17295  [
17296 \begin_inset Flex Code
17297 status collapsed
17298
17299 \begin_layout Plain Layout
17300 int
17301 \end_layout
17302
17303 \end_inset
17304
17305 ] Defines argument number of a command\SpecialChar breakableslash
17306 environment associated with the current
17307  layout.
17308  The definition must end with
17309 \begin_inset Flex Code
17310 status collapsed
17311
17312 \begin_layout Plain Layout
17313 EndArgument
17314 \end_layout
17315
17316 \end_inset
17317
17318 .
17319  See
17320 \begin_inset CommandInset ref
17321 LatexCommand ref
17322 reference "subsec:Paragraph-Styles"
17323
17324 \end_inset
17325
17326  for details.
17327 \end_layout
17328
17329 \begin_layout Description
17330 \begin_inset Flex Code
17331 status collapsed
17332
17333 \begin_layout Plain Layout
17334 BabelPreamble
17335 \end_layout
17336
17337 \end_inset
17338
17339  Preamble for changing language commands; see
17340 \begin_inset CommandInset ref
17341 LatexCommand ref
17342 reference "subsec:I18n"
17343
17344 \end_inset
17345
17346 .
17347 \end_layout
17348
17349 \begin_layout Description
17350 \begin_inset Flex Code
17351 status collapsed
17352
17353 \begin_layout Plain Layout
17354 BgColor
17355 \end_layout
17356
17357 \end_inset
17358
17359  [
17360 \begin_inset Flex Code
17361 status collapsed
17362
17363 \begin_layout Plain Layout
17364 <name>
17365 \end_layout
17366
17367 \end_inset
17368
17369 ] The color for the inset's background.
17370  See
17371 \begin_inset CommandInset ref
17372 LatexCommand ref
17373 reference "chap:Names-of-colors"
17374
17375 \end_inset
17376
17377  for a list of the available color names.
17378 \end_layout
17379
17380 \begin_layout Description
17381 \begin_inset Flex Code
17382 status collapsed
17383
17384 \begin_layout Plain Layout
17385 ContentAsLabel
17386 \end_layout
17387
17388 \end_inset
17389
17390  [
17391 \begin_inset Flex Code
17392 status collapsed
17393
17394 \begin_layout Plain Layout
17395
17396 \emph on
17397 0
17398 \end_layout
17399
17400 \end_inset
17401
17402 ,
17403 \begin_inset space \thinspace{}
17404 \end_inset
17405
17406
17407 \begin_inset Flex Code
17408 status collapsed
17409
17410 \begin_layout Plain Layout
17411 1
17412 \end_layout
17413
17414 \end_inset
17415
17416 ] Whether to use the content of the inset as the label, when the inset is
17417  closed.
17418  Default is false.
17419 \end_layout
17420
17421 \begin_layout Description
17422 \begin_inset Flex Code
17423 status collapsed
17424
17425 \begin_layout Plain Layout
17426 CopyStyle
17427 \end_layout
17428
17429 \end_inset
17430
17431  [
17432 \begin_inset Flex Code
17433 status collapsed
17434
17435 \begin_layout Plain Layout
17436 <type>
17437 \end_layout
17438
17439 \end_inset
17440
17441 ] As with paragraph styles, see
17442 \begin_inset CommandInset ref
17443 LatexCommand ref
17444 reference "subsec:Paragraph-Styles"
17445
17446 \end_inset
17447
17448 .
17449  Note that you need to specify the complete type, e.
17450 \begin_inset space \thinspace{}
17451 \end_inset
17452
17453 g.
17454 \begin_inset space ~
17455 \end_inset
17456
17457
17458 \begin_inset Flex Code
17459 status collapsed
17460
17461 \begin_layout Plain Layout
17462 CopyStyle Flex:<name>
17463 \end_layout
17464
17465 \end_inset
17466
17467 .
17468 \end_layout
17469
17470 \begin_layout Description
17471 \begin_inset Flex Code
17472 status collapsed
17473
17474 \begin_layout Plain Layout
17475 CustomPars
17476 \end_layout
17477
17478 \end_inset
17479
17480  [
17481 \begin_inset Flex Code
17482 status collapsed
17483
17484 \begin_layout Plain Layout
17485
17486 \emph on
17487 0
17488 \end_layout
17489
17490 \end_inset
17491
17492 ,
17493 \begin_inset space \thinspace{}
17494 \end_inset
17495
17496
17497 \begin_inset Flex Code
17498 status collapsed
17499
17500 \begin_layout Plain Layout
17501 1
17502 \end_layout
17503
17504 \end_inset
17505
17506 ] Indicates whether the user may employ the Paragraph Settings dialog to
17507  customize the paragraph.
17508 \end_layout
17509
17510 \begin_layout Description
17511 \begin_inset Flex Code
17512 status collapsed
17513
17514 \begin_layout Plain Layout
17515 Decoration
17516 \end_layout
17517
17518 \end_inset
17519
17520  can be
17521 \begin_inset Flex Code
17522 status collapsed
17523
17524 \begin_layout Plain Layout
17525 Classic
17526 \end_layout
17527
17528 \end_inset
17529
17530 ,
17531 \begin_inset Flex Code
17532 status collapsed
17533
17534 \begin_layout Plain Layout
17535 Minimalistic
17536 \end_layout
17537
17538 \end_inset
17539
17540 , or
17541 \begin_inset Flex Code
17542 status collapsed
17543
17544 \begin_layout Plain Layout
17545 Conglomerate
17546 \end_layout
17547
17548 \end_inset
17549
17550 , describing the rendering style used for the inset's frame and buttons.
17551  Footnotes generally use
17552 \begin_inset Flex Code
17553 status collapsed
17554
17555 \begin_layout Plain Layout
17556 Classic
17557 \end_layout
17558
17559 \end_inset
17560
17561 , ERT insets generally
17562 \begin_inset Flex Code
17563 status collapsed
17564
17565 \begin_layout Plain Layout
17566 Minimalistic
17567 \end_layout
17568
17569 \end_inset
17570
17571 , and character styles
17572 \begin_inset Flex Code
17573 status collapsed
17574
17575 \begin_layout Plain Layout
17576 Conglomerate
17577 \end_layout
17578
17579 \end_inset
17580
17581 .
17582 \end_layout
17583
17584 \begin_layout Description
17585 \begin_inset Flex Code
17586 status collapsed
17587
17588 \begin_layout Plain Layout
17589 Display
17590 \end_layout
17591
17592 \end_inset
17593
17594  [
17595 \begin_inset Flex Code
17596 status collapsed
17597
17598 \begin_layout Plain Layout
17599 0
17600 \end_layout
17601
17602 \end_inset
17603
17604 ,
17605 \emph on
17606
17607 \begin_inset space \thinspace{}
17608 \end_inset
17609
17610
17611 \emph default
17612
17613 \begin_inset Flex Code
17614 status collapsed
17615
17616 \begin_layout Plain Layout
17617
17618 \emph on
17619 1
17620 \end_layout
17621
17622 \end_inset
17623
17624 ] Only useful if
17625 \begin_inset Flex Code
17626 status collapsed
17627
17628 \begin_layout Plain Layout
17629 LatexType
17630 \end_layout
17631
17632 \end_inset
17633
17634  is
17635 \begin_inset Flex Code
17636 status collapsed
17637
17638 \begin_layout Plain Layout
17639 Environment
17640 \end_layout
17641
17642 \end_inset
17643
17644 .
17645  Indicates whether the environment will stand on its own in the output or
17646  will appear inline with the surrounding text.
17647  If set to false, it is supposed that the \SpecialChar LaTeX
17648  environment ignores white space
17649  (including one newline character) after the
17650 \begin_inset Flex Code
17651 status collapsed
17652
17653 \begin_layout Plain Layout
17654
17655 \backslash
17656 begin{
17657 \emph on
17658 LatexName
17659 \emph default
17660 }
17661 \end_layout
17662
17663 \end_inset
17664
17665  and
17666 \begin_inset Flex Code
17667 status collapsed
17668
17669 \begin_layout Plain Layout
17670
17671 \backslash
17672 end{
17673 \emph on
17674 LatexName
17675 \emph default
17676 }
17677 \end_layout
17678
17679 \end_inset
17680
17681  tags.
17682  Default is true.
17683 \end_layout
17684
17685 \begin_layout Description
17686 \begin_inset Flex Code
17687 status collapsed
17688
17689 \begin_layout Plain Layout
17690 End
17691 \end_layout
17692
17693 \end_inset
17694
17695  Required at the end of the
17696 \begin_inset Flex Code
17697 status collapsed
17698
17699 \begin_layout Plain Layout
17700 InsetLayout
17701 \end_layout
17702
17703 \end_inset
17704
17705  declarations.
17706 \end_layout
17707
17708 \begin_layout Description
17709 \begin_inset Flex Code
17710 status collapsed
17711
17712 \begin_layout Plain Layout
17713 Font
17714 \end_layout
17715
17716 \end_inset
17717
17718  The font used for both the text body
17719 \emph on
17720 and
17721 \emph default
17722  the label.
17723  See
17724 \begin_inset CommandInset ref
17725 LatexCommand ref
17726 reference "subsec:Font-description"
17727
17728 \end_inset
17729
17730 .
17731  Note that defining this font automatically defines the
17732 \begin_inset Flex Code
17733 status collapsed
17734
17735 \begin_layout Plain Layout
17736 LabelFont
17737 \end_layout
17738
17739 \end_inset
17740
17741  to the same value, so define this first and define
17742 \begin_inset Flex Code
17743 status collapsed
17744
17745 \begin_layout Plain Layout
17746 LabelFont
17747 \end_layout
17748
17749 \end_inset
17750
17751  later if you want them to be different.
17752 \end_layout
17753
17754 \begin_layout Description
17755 \begin_inset Flex Code
17756 status collapsed
17757
17758 \begin_layout Plain Layout
17759 FixedWidthPreambleEncoding
17760 \end_layout
17761
17762 \end_inset
17763
17764  [
17765 \begin_inset Flex Code
17766 status collapsed
17767
17768 \begin_layout Plain Layout
17769
17770 \emph on
17771 0
17772 \end_layout
17773
17774 \end_inset
17775
17776 ,
17777 \begin_inset space \thinspace{}
17778 \end_inset
17779
17780
17781 \begin_inset Flex Code
17782 status collapsed
17783
17784 \begin_layout Plain Layout
17785 1
17786 \end_layout
17787
17788 \end_inset
17789
17790 ] Force a fixed width encoding for the translated contents of
17791 \begin_inset Flex Code
17792 status collapsed
17793
17794 \begin_layout Plain Layout
17795 BabelPreamble
17796 \end_layout
17797
17798 \end_inset
17799
17800  and
17801 \begin_inset Flex Code
17802 status collapsed
17803
17804 \begin_layout Plain Layout
17805 LangPreamble
17806 \end_layout
17807
17808 \end_inset
17809
17810  code generated by this layout.
17811  This is needed for special \SpecialChar LaTeX
17812 -packages like
17813 \family typewriter
17814 listings
17815 \family default
17816  that do not work with variable width encodings such as
17817 \family sans
17818 utf8
17819 \family default
17820 .
17821  This setting is ignored if fully Unicode aware \SpecialChar LaTeX
17822  backends such as Xe\SpecialChar TeX
17823  or
17824  Lua\SpecialChar TeX
17825  are used.
17826 \end_layout
17827
17828 \begin_layout Description
17829 \begin_inset Flex Code
17830 status collapsed
17831
17832 \begin_layout Plain Layout
17833 ForceLocalFontSwitch
17834 \end_layout
17835
17836 \end_inset
17837
17838  [
17839 \begin_inset Flex Code
17840 status collapsed
17841
17842 \begin_layout Plain Layout
17843
17844 \emph on
17845 0
17846 \end_layout
17847
17848 \end_inset
17849
17850 ,
17851 \begin_inset space \thinspace{}
17852 \end_inset
17853
17854
17855 \begin_inset Flex Code
17856 status collapsed
17857
17858 \begin_layout Plain Layout
17859 1
17860 \end_layout
17861
17862 \end_inset
17863
17864 ] When using babel, always use a local font switch (
17865 \begin_inset Flex Code
17866 status collapsed
17867
17868 \begin_layout Plain Layout
17869
17870 \backslash
17871 foreignlanguage
17872 \end_layout
17873
17874 \end_inset
17875
17876 ), never a global one (such as
17877 \begin_inset Flex Code
17878 status collapsed
17879
17880 \begin_layout Plain Layout
17881
17882 \backslash
17883 selectlanguage
17884 \end_layout
17885
17886 \end_inset
17887
17888 ).
17889 \end_layout
17890
17891 \begin_layout Description
17892 \begin_inset Flex Code
17893 status collapsed
17894
17895 \begin_layout Plain Layout
17896 ForceLTR
17897 \end_layout
17898
17899 \end_inset
17900
17901  [
17902 \begin_inset Flex Code
17903 status collapsed
17904
17905 \begin_layout Plain Layout
17906
17907 \emph on
17908 0
17909 \end_layout
17910
17911 \end_inset
17912
17913 ,
17914 \begin_inset space \thinspace{}
17915 \end_inset
17916
17917
17918 \begin_inset Flex Code
17919 status collapsed
17920
17921 \begin_layout Plain Layout
17922 1
17923 \end_layout
17924
17925 \end_inset
17926
17927 ] Force the
17928 \begin_inset Quotes eld
17929 \end_inset
17930
17931 latex
17932 \begin_inset Quotes erd
17933 \end_inset
17934
17935  language, leading to Left-to-Right (Latin) output, e.
17936 \begin_inset space \thinspace{}
17937 \end_inset
17938
17939 g.
17940 \begin_inset space \space{}
17941 \end_inset
17942
17943 in \SpecialChar TeX
17944  code or URL.
17945  A kludge.
17946 \end_layout
17947
17948 \begin_layout Description
17949 \begin_inset Flex Code
17950 status collapsed
17951
17952 \begin_layout Plain Layout
17953 ForceOwnlines
17954 \end_layout
17955
17956 \end_inset
17957
17958  [
17959 \begin_inset Flex Code
17960 status collapsed
17961
17962 \begin_layout Plain Layout
17963
17964 \emph on
17965 0
17966 \end_layout
17967
17968 \end_inset
17969
17970 ,
17971 \begin_inset space \thinspace{}
17972 \end_inset
17973
17974
17975 \begin_inset Flex Code
17976 status collapsed
17977
17978 \begin_layout Plain Layout
17979 1
17980 \end_layout
17981
17982 \end_inset
17983
17984 ] Force a a line break in the \SpecialChar LaTeX
17985  output before the inset starts and after
17986  the inset ends.
17987  This assures the inset itself is output on its own lines, for parsing purposes.
17988 \end_layout
17989
17990 \begin_layout Description
17991 \begin_inset Flex Code
17992 status collapsed
17993
17994 \begin_layout Plain Layout
17995 ForcePlain
17996 \end_layout
17997
17998 \end_inset
17999
18000  [
18001 \begin_inset Flex Code
18002 status collapsed
18003
18004 \begin_layout Plain Layout
18005
18006 \emph on
18007 0
18008 \end_layout
18009
18010 \end_inset
18011
18012 ,
18013 \begin_inset space \thinspace{}
18014 \end_inset
18015
18016
18017 \begin_inset Flex Code
18018 status collapsed
18019
18020 \begin_layout Plain Layout
18021 1
18022 \end_layout
18023
18024 \end_inset
18025
18026 ] Indicates whether the
18027 \begin_inset Flex Code
18028 status collapsed
18029
18030 \begin_layout Plain Layout
18031 PlainLayout
18032 \end_layout
18033
18034 \end_inset
18035
18036  should be used or, instead, the user can change the paragraph style used
18037  in the inset.
18038  Default is false.
18039 \end_layout
18040
18041 \begin_layout Description
18042 \begin_inset Flex Code
18043 status collapsed
18044
18045 \begin_layout Plain Layout
18046 FreeSpacing
18047 \end_layout
18048
18049 \end_inset
18050
18051  [
18052 \begin_inset Flex Code
18053 status collapsed
18054
18055 \begin_layout Plain Layout
18056
18057 \emph on
18058 0
18059 \end_layout
18060
18061 \end_inset
18062
18063 ,
18064 \begin_inset space \thinspace{}
18065 \end_inset
18066
18067
18068 \begin_inset Flex Code
18069 status collapsed
18070
18071 \begin_layout Plain Layout
18072 1
18073 \end_layout
18074
18075 \end_inset
18076
18077 ] As with paragraph styles, see
18078 \begin_inset CommandInset ref
18079 LatexCommand ref
18080 reference "subsec:Paragraph-Styles"
18081
18082 \end_inset
18083
18084 .
18085 \end_layout
18086
18087 \begin_layout Description
18088 \begin_inset Flex Code
18089 status collapsed
18090
18091 \begin_layout Plain Layout
18092 HTML*
18093 \end_layout
18094
18095 \end_inset
18096
18097  These tags control the XHTML output.
18098  See
18099 \begin_inset CommandInset ref
18100 LatexCommand ref
18101 reference "sec:Tags-for-XHTML"
18102
18103 \end_inset
18104
18105 .
18106 \end_layout
18107
18108 \begin_layout Description
18109 \begin_inset Flex Code
18110 status collapsed
18111
18112 \begin_layout Plain Layout
18113 InToc
18114 \end_layout
18115
18116 \end_inset
18117
18118  [
18119 \begin_inset Flex Code
18120 status collapsed
18121
18122 \begin_layout Plain Layout
18123
18124 \emph on
18125 0
18126 \end_layout
18127
18128 \end_inset
18129
18130 ,
18131 \begin_inset space \thinspace{}
18132 \end_inset
18133
18134
18135 \begin_inset Flex Code
18136 status collapsed
18137
18138 \begin_layout Plain Layout
18139 1
18140 \end_layout
18141
18142 \end_inset
18143
18144 ] Whether to include the contents of this inset in the strings generated
18145  for the `Outline' pane.
18146  One would not, for example, want the content of a footnote in a section
18147  header to be included in the TOC displayed in the outline, but one would
18148  normally want the content of a character style displayed.
18149  Default is false: not to include.
18150 \end_layout
18151
18152 \begin_layout Description
18153 \begin_inset Flex Code
18154 status collapsed
18155
18156 \begin_layout Plain Layout
18157 KeepEmpty
18158 \end_layout
18159
18160 \end_inset
18161
18162  [
18163 \emph on
18164
18165 \begin_inset Flex Code
18166 status collapsed
18167
18168 \begin_layout Plain Layout
18169 0
18170 \end_layout
18171
18172 \end_inset
18173
18174
18175 \emph default
18176 ,
18177 \begin_inset space \thinspace{}
18178 \end_inset
18179
18180
18181 \begin_inset Flex Code
18182 status collapsed
18183
18184 \begin_layout Plain Layout
18185 1
18186 \end_layout
18187
18188 \end_inset
18189
18190 ] As with paragraph styles, see
18191 \begin_inset CommandInset ref
18192 LatexCommand ref
18193 reference "subsec:Paragraph-Styles"
18194
18195 \end_inset
18196
18197 .
18198 \end_layout
18199
18200 \begin_layout Description
18201 \begin_inset Flex Code
18202 status collapsed
18203
18204 \begin_layout Plain Layout
18205 LabelFont
18206 \end_layout
18207
18208 \end_inset
18209
18210  The font used for the label.
18211  See
18212 \begin_inset CommandInset ref
18213 LatexCommand ref
18214 reference "subsec:Font-description"
18215
18216 \end_inset
18217
18218 .
18219  Note that this definition can never appear before
18220 \begin_inset Flex Code
18221 status collapsed
18222
18223 \begin_layout Plain Layout
18224 Font
18225 \end_layout
18226
18227 \end_inset
18228
18229 , lest it be ineffective.
18230 \end_layout
18231
18232 \begin_layout Description
18233 \begin_inset Flex Code
18234 status collapsed
18235
18236 \begin_layout Plain Layout
18237 LabelString
18238 \end_layout
18239
18240 \end_inset
18241
18242  [
18243 \begin_inset Flex Code
18244 status collapsed
18245
18246 \begin_layout Plain Layout
18247 string
18248 \end_layout
18249
18250 \end_inset
18251
18252 =
18253 \begin_inset Quotes erd
18254 \end_inset
18255
18256
18257 \begin_inset Quotes erd
18258 \end_inset
18259
18260 ] What will be displayed on the button or elsewhere as the inset label.
18261  Some inset types (
18262 \begin_inset Flex Code
18263 status collapsed
18264
18265 \begin_layout Plain Layout
18266 \SpecialChar TeX
18267  code
18268 \end_layout
18269
18270 \end_inset
18271
18272  and
18273 \begin_inset Flex Code
18274 status collapsed
18275
18276 \begin_layout Plain Layout
18277 Branch
18278 \end_layout
18279
18280 \end_inset
18281
18282 ) modify this label on the fly.
18283 \end_layout
18284
18285 \begin_layout Description
18286 \begin_inset Flex Code
18287 status collapsed
18288
18289 \begin_layout Plain Layout
18290 LangPreamble
18291 \end_layout
18292
18293 \end_inset
18294
18295  Language dependent preamble; see
18296 \begin_inset CommandInset ref
18297 LatexCommand ref
18298 reference "subsec:I18n"
18299
18300 \end_inset
18301
18302 .
18303 \end_layout
18304
18305 \begin_layout Description
18306 \begin_inset Flex Code
18307 status collapsed
18308
18309 \begin_layout Plain Layout
18310 LatexName
18311 \end_layout
18312
18313 \end_inset
18314
18315  [
18316 \begin_inset Flex Code
18317 status collapsed
18318
18319 \begin_layout Plain Layout
18320 <name>
18321 \end_layout
18322
18323 \end_inset
18324
18325 ] The name of the corresponding \SpecialChar LaTeX
18326  stuff.
18327  Either the environment or command name.
18328 \end_layout
18329
18330 \begin_layout Description
18331 \begin_inset Flex Code
18332 status collapsed
18333
18334 \begin_layout Plain Layout
18335 LatexParam
18336 \end_layout
18337
18338 \end_inset
18339
18340  [
18341 \begin_inset Flex Code
18342 status collapsed
18343
18344 \begin_layout Plain Layout
18345 <parameter>
18346 \end_layout
18347
18348 \end_inset
18349
18350 ] The optional parameter for the corresponding
18351 \begin_inset Flex Code
18352 status collapsed
18353
18354 \begin_layout Plain Layout
18355 LatexName
18356 \end_layout
18357
18358 \end_inset
18359
18360  stuff, including possible bracket pairs like
18361 \begin_inset Flex Code
18362 status collapsed
18363
18364 \begin_layout Plain Layout
18365 []
18366 \end_layout
18367
18368 \end_inset
18369
18370 .
18371  This parameter cannot be changed from within \SpecialChar LyX
18372  (use
18373 \begin_inset Flex Code
18374 status collapsed
18375
18376 \begin_layout Plain Layout
18377 Argument
18378 \end_layout
18379
18380 \end_inset
18381
18382  for customizable parameters).
18383  It will be output as is after all \SpecialChar LaTeX
18384
18385 \begin_inset Flex Code
18386 status collapsed
18387
18388 \begin_layout Plain Layout
18389 Argument
18390 \end_layout
18391
18392 \end_inset
18393
18394 s.
18395 \end_layout
18396
18397 \begin_layout Description
18398 \begin_inset Flex Code
18399 status collapsed
18400
18401 \begin_layout Plain Layout
18402 LatexType
18403 \end_layout
18404
18405 \end_inset
18406
18407  [
18408 \begin_inset Flex Code
18409 status collapsed
18410
18411 \begin_layout Plain Layout
18412 Command, Environment, None
18413 \end_layout
18414
18415 \end_inset
18416
18417 ] How the style should be translated into \SpecialChar LaTeX
18418 .
18419 \begin_inset Foot
18420 status collapsed
18421
18422 \begin_layout Plain Layout
18423 \begin_inset Flex Code
18424 status collapsed
18425
18426 \begin_layout Plain Layout
18427 LatexType
18428 \end_layout
18429
18430 \end_inset
18431
18432  is perhaps a bit misleading, since these rules apply to SGML classes too.
18433  Visit the SGML class files for specific examples.
18434 \end_layout
18435
18436 \end_inset
18437
18438
18439 \end_layout
18440
18441 \begin_deeper
18442 \begin_layout Description
18443 \begin_inset Flex Code
18444 status collapsed
18445
18446 \begin_layout Plain Layout
18447 None
18448 \end_layout
18449
18450 \end_inset
18451
18452  means nothing special
18453 \end_layout
18454
18455 \begin_layout Description
18456 \begin_inset Flex Code
18457 status collapsed
18458
18459 \begin_layout Plain Layout
18460 Command
18461 \end_layout
18462
18463 \end_inset
18464
18465  means
18466 \begin_inset Flex Code
18467 status collapsed
18468
18469 \begin_layout Plain Layout
18470
18471 \backslash
18472
18473 \emph on
18474 LatexName
18475 \emph default
18476 {\SpecialChar ldots
18477 }
18478 \end_layout
18479
18480 \end_inset
18481
18482
18483 \end_layout
18484
18485 \begin_layout Description
18486 \begin_inset Flex Code
18487 status collapsed
18488
18489 \begin_layout Plain Layout
18490 Environment
18491 \end_layout
18492
18493 \end_inset
18494
18495  means
18496 \begin_inset Flex Code
18497 status collapsed
18498
18499 \begin_layout Plain Layout
18500
18501 \backslash
18502 begin{
18503 \emph on
18504 LatexName
18505 \emph default
18506 }\SpecialChar ldots
18507
18508 \backslash
18509 end{
18510 \emph on
18511 LatexName
18512 \emph default
18513 }
18514 \end_layout
18515
18516 \end_inset
18517
18518
18519 \end_layout
18520
18521 \begin_layout Standard
18522 Putting the last few things together, the \SpecialChar LaTeX
18523  output will be either:
18524 \end_layout
18525
18526 \begin_layout LyX-Code
18527
18528 \backslash
18529 LatexName[LatexParam]{\SpecialChar ldots
18530 }
18531 \end_layout
18532
18533 \begin_layout Standard
18534 or:
18535 \end_layout
18536
18537 \begin_layout LyX-Code
18538
18539 \backslash
18540 begin{LatexName}[LatexParam] \SpecialChar ldots
18541
18542 \backslash
18543 end{LatexName}
18544 \end_layout
18545
18546 \begin_layout Standard
18547 depending upon the \SpecialChar LaTeX
18548  type.
18549 \end_layout
18550
18551 \end_deeper
18552 \begin_layout Description
18553 \begin_inset Flex Code
18554 status collapsed
18555
18556 \begin_layout Plain Layout
18557 LeftDelim
18558 \end_layout
18559
18560 \end_inset
18561
18562  [
18563 \begin_inset Flex Code
18564 status collapsed
18565
18566 \begin_layout Plain Layout
18567 string
18568 \end_layout
18569
18570 \end_inset
18571
18572 ] A string that is put at the beginning of the layout content.
18573  A line break in the output can be indicated by
18574 \begin_inset Flex Code
18575 status collapsed
18576
18577 \begin_layout Plain Layout
18578 <br/>
18579 \end_layout
18580
18581 \end_inset
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 LyxType
18592 \end_layout
18593
18594 \end_inset
18595
18596  Can be
18597 \begin_inset Flex Code
18598 status collapsed
18599
18600 \begin_layout Plain Layout
18601 charstyle
18602 \end_layout
18603
18604 \end_inset
18605
18606 ,
18607 \begin_inset Flex Code
18608 status collapsed
18609
18610 \begin_layout Plain Layout
18611 custom
18612 \end_layout
18613
18614 \end_inset
18615
18616 ,
18617 \begin_inset Flex Code
18618 status collapsed
18619
18620 \begin_layout Plain Layout
18621 element
18622 \end_layout
18623
18624 \end_inset
18625
18626  or
18627 \begin_inset Flex Code
18628 status collapsed
18629
18630 \begin_layout Plain Layout
18631 end
18632 \end_layout
18633
18634 \end_inset
18635
18636  (indicating a dummy definition ending definitions of charstyles, etc).
18637  This entry is required in and is only meaningful for Flex insets.
18638  Among other things, it determines on which menu this inset will appear.
18639  Setting
18640 \begin_inset Flex Code
18641 status collapsed
18642
18643 \begin_layout Plain Layout
18644 LyxType
18645 \end_layout
18646
18647 \end_inset
18648
18649  to
18650 \begin_inset Flex Code
18651 status collapsed
18652
18653 \begin_layout Plain Layout
18654 charstyle
18655 \end_layout
18656
18657 \end_inset
18658
18659  will automatically set
18660 \begin_inset Flex Code
18661 status collapsed
18662
18663 \begin_layout Plain Layout
18664 MultiPar
18665 \end_layout
18666
18667 \end_inset
18668
18669  to false and
18670 \begin_inset Flex Code
18671 status collapsed
18672
18673 \begin_layout Plain Layout
18674 ForcePlain
18675 \end_layout
18676
18677 \end_inset
18678
18679  to true.
18680
18681 \begin_inset Flex Code
18682 status collapsed
18683
18684 \begin_layout Plain Layout
18685 MultiPar
18686 \end_layout
18687
18688 \end_inset
18689
18690  can be set to true, or
18691 \begin_inset Flex Code
18692 status collapsed
18693
18694 \begin_layout Plain Layout
18695 ForcePlain
18696 \end_layout
18697
18698 \end_inset
18699
18700  to false, for
18701 \begin_inset Flex Code
18702 status collapsed
18703
18704 \begin_layout Plain Layout
18705 charstyle
18706 \end_layout
18707
18708 \end_inset
18709
18710  insets by setting it
18711 \emph on
18712 after
18713 \emph default
18714  you set the
18715 \begin_inset Flex Code
18716 status collapsed
18717
18718 \begin_layout Plain Layout
18719 LyxType
18720 \end_layout
18721
18722 \end_inset
18723
18724 .
18725 \end_layout
18726
18727 \begin_layout Description
18728 \begin_inset Flex Code
18729 status collapsed
18730
18731 \begin_layout Plain Layout
18732 MultiPar
18733 \end_layout
18734
18735 \end_inset
18736
18737  [
18738 \begin_inset Flex Code
18739 status collapsed
18740
18741 \begin_layout Plain Layout
18742
18743 \emph on
18744 0
18745 \end_layout
18746
18747 \end_inset
18748
18749 ,
18750 \begin_inset space \thinspace{}
18751 \end_inset
18752
18753
18754 \begin_inset Flex Code
18755 status collapsed
18756
18757 \begin_layout Plain Layout
18758 1
18759 \end_layout
18760
18761 \end_inset
18762
18763 ] Whether multiple paragraphs are permitted in this inset.
18764  This will also set
18765 \begin_inset Flex Code
18766 status collapsed
18767
18768 \begin_layout Plain Layout
18769 CustomPars
18770 \end_layout
18771
18772 \end_inset
18773
18774  to the same value and
18775 \begin_inset Flex Code
18776 status collapsed
18777
18778 \begin_layout Plain Layout
18779 ForcePlain
18780 \end_layout
18781
18782 \end_inset
18783
18784  to the opposite value.
18785  These can be reset to other values, if they are used
18786 \emph on
18787 after
18788 \emph default
18789
18790 \begin_inset Flex Code
18791 status collapsed
18792
18793 \begin_layout Plain Layout
18794 MultiPar
18795 \end_layout
18796
18797 \end_inset
18798
18799 .
18800  Default is true.
18801 \end_layout
18802
18803 \begin_layout Description
18804 \begin_inset Flex Code
18805 status collapsed
18806
18807 \begin_layout Plain Layout
18808 NeedProtect
18809 \end_layout
18810
18811 \end_inset
18812
18813  [
18814 \begin_inset Flex Code
18815 status collapsed
18816
18817 \begin_layout Plain Layout
18818
18819 \emph on
18820 0
18821 \end_layout
18822
18823 \end_inset
18824
18825 ,
18826 \begin_inset space \thinspace{}
18827 \end_inset
18828
18829
18830 \begin_inset Flex Code
18831 status collapsed
18832
18833 \begin_layout Plain Layout
18834 1
18835 \end_layout
18836
18837 \end_inset
18838
18839 ] Whether fragile commands in this inset should be
18840 \begin_inset Flex Code
18841 status collapsed
18842
18843 \begin_layout Plain Layout
18844
18845 \backslash
18846 protect
18847 \end_layout
18848
18849 \end_inset
18850
18851 'ed.
18852  (Note: This is
18853 \emph on
18854 not
18855 \emph default
18856  whether the command should itself be protected.) Default is false.
18857 \end_layout
18858
18859 \begin_layout Description
18860 \begin_inset Flex Code
18861 status collapsed
18862
18863 \begin_layout Plain Layout
18864 NoInsetLayout
18865 \end_layout
18866
18867 \end_inset
18868
18869  [
18870 \begin_inset Flex Code
18871 status collapsed
18872
18873 \begin_layout Plain Layout
18874 <layout>
18875 \end_layout
18876
18877 \end_inset
18878
18879 ] Deletes an existing
18880 \begin_inset Flex Code
18881 status collapsed
18882
18883 \begin_layout Plain Layout
18884 InsetLayout
18885 \end_layout
18886
18887 \end_inset
18888
18889 .
18890 \end_layout
18891
18892 \begin_layout Description
18893 \begin_inset Flex Code
18894 status collapsed
18895
18896 \begin_layout Plain Layout
18897 ObsoletedBy
18898 \end_layout
18899
18900 \end_inset
18901
18902  [
18903 \begin_inset Flex Code
18904 status collapsed
18905
18906 \begin_layout Plain Layout
18907 <layout>
18908 \end_layout
18909
18910 \end_inset
18911
18912 ] Name of an
18913 \begin_inset Flex Code
18914 status collapsed
18915
18916 \begin_layout Plain Layout
18917 InsetLayout
18918 \end_layout
18919
18920 \end_inset
18921
18922  that has replaced this
18923 \begin_inset Flex Code
18924 status collapsed
18925
18926 \begin_layout Plain Layout
18927 InsetLayout
18928 \end_layout
18929
18930 \end_inset
18931
18932 .
18933  This is used to rename an
18934 \begin_inset Flex Code
18935 status collapsed
18936
18937 \begin_layout Plain Layout
18938 InsetLayout
18939 \end_layout
18940
18941 \end_inset
18942
18943 , while keeping backward compatibility.
18944 \end_layout
18945
18946 \begin_layout Description
18947 \begin_inset Flex Code
18948 status collapsed
18949
18950 \begin_layout Plain Layout
18951 ParbreakIsNewline
18952 \end_layout
18953
18954 \end_inset
18955
18956  [
18957 \begin_inset Flex Code
18958 status collapsed
18959
18960 \begin_layout Plain Layout
18961
18962 \emph on
18963 0
18964 \end_layout
18965
18966 \end_inset
18967
18968 ,
18969 \begin_inset space \thinspace{}
18970 \end_inset
18971
18972
18973 \begin_inset Flex Code
18974 status collapsed
18975
18976 \begin_layout Plain Layout
18977 1
18978 \end_layout
18979
18980 \end_inset
18981
18982 ] As with paragraph styles, see
18983 \begin_inset CommandInset ref
18984 LatexCommand ref
18985 reference "subsec:Paragraph-Styles"
18986
18987 \end_inset
18988
18989 .
18990  Default is false.
18991 \end_layout
18992
18993 \begin_layout Description
18994 \begin_inset Flex Code
18995 status collapsed
18996
18997 \begin_layout Plain Layout
18998 PassThru
18999 \end_layout
19000
19001 \end_inset
19002
19003  [
19004 \begin_inset Flex Code
19005 status collapsed
19006
19007 \begin_layout Plain Layout
19008
19009 \emph on
19010 0
19011 \end_layout
19012
19013 \end_inset
19014
19015 ,
19016 \begin_inset space \thinspace{}
19017 \end_inset
19018
19019
19020 \begin_inset Flex Code
19021 status collapsed
19022
19023 \begin_layout Plain Layout
19024 1
19025 \end_layout
19026
19027 \end_inset
19028
19029 ] As with paragraph styles, see
19030 \begin_inset CommandInset ref
19031 LatexCommand ref
19032 reference "subsec:Paragraph-Styles"
19033
19034 \end_inset
19035
19036 .
19037  Default is false.
19038 \end_layout
19039
19040 \begin_layout Description
19041 \begin_inset Flex Code
19042 status collapsed
19043
19044 \begin_layout Plain Layout
19045 Preamble
19046 \end_layout
19047
19048 \end_inset
19049
19050  As with paragraph styles, see
19051 \begin_inset CommandInset ref
19052 LatexCommand ref
19053 reference "subsec:Paragraph-Styles"
19054
19055 \end_inset
19056
19057 .
19058 \end_layout
19059
19060 \begin_layout Description
19061 \begin_inset Flex Code
19062 status collapsed
19063
19064 \begin_layout Plain Layout
19065 RefPrefix
19066 \end_layout
19067
19068 \end_inset
19069
19070  [
19071 \begin_inset Flex Code
19072 status collapsed
19073
19074 \begin_layout Plain Layout
19075 string
19076 \end_layout
19077
19078 \end_inset
19079
19080 ] The prefix to use when creating labels referring to insets of this type.
19081  This allows the use of formatted references.
19082 \end_layout
19083
19084 \begin_layout Description
19085 \begin_inset Flex Code
19086 status collapsed
19087
19088 \begin_layout Plain Layout
19089 Requires
19090 \end_layout
19091
19092 \end_inset
19093
19094  [
19095 \begin_inset Flex Code
19096 status collapsed
19097
19098 \begin_layout Plain Layout
19099 string
19100 \end_layout
19101
19102 \end_inset
19103
19104 ] As with paragraph styles, see
19105 \begin_inset CommandInset ref
19106 LatexCommand ref
19107 reference "subsec:Paragraph-Styles"
19108
19109 \end_inset
19110
19111 .
19112 \end_layout
19113
19114 \begin_layout Description
19115 \begin_inset Flex Code
19116 status collapsed
19117
19118 \begin_layout Plain Layout
19119 ResetArgs
19120 \end_layout
19121
19122 \end_inset
19123
19124  [
19125 \begin_inset Flex Code
19126 status collapsed
19127
19128 \begin_layout Plain Layout
19129
19130 \emph on
19131 0
19132 \end_layout
19133
19134 \end_inset
19135
19136 ,
19137 \begin_inset space \thinspace{}
19138 \end_inset
19139
19140
19141 \begin_inset Flex Code
19142 status collapsed
19143
19144 \begin_layout Plain Layout
19145 1
19146 \end_layout
19147
19148 \end_inset
19149
19150 ] Resets the \SpecialChar LaTeX
19151  arguments of this layout (as defined via the
19152 \begin_inset Flex Code
19153 status collapsed
19154
19155 \begin_layout Plain Layout
19156 Argument
19157 \end_layout
19158
19159 \end_inset
19160
19161  tag).
19162  This is useful if you have copied a style via
19163 \begin_inset Flex Code
19164 status collapsed
19165
19166 \begin_layout Plain Layout
19167 CopyStyle
19168 \end_layout
19169
19170 \end_inset
19171
19172 , but you do not want to inherit its (required and optional) arguments.
19173 \end_layout
19174
19175 \begin_layout Description
19176 \begin_inset Flex Code
19177 status collapsed
19178
19179 \begin_layout Plain Layout
19180 ResetsFont
19181 \end_layout
19182
19183 \end_inset
19184
19185  [
19186 \begin_inset Flex Code
19187 status collapsed
19188
19189 \begin_layout Plain Layout
19190 0
19191 \end_layout
19192
19193 \end_inset
19194
19195 ,
19196 \begin_inset space \thinspace{}
19197 \end_inset
19198
19199
19200 \begin_inset Flex Code
19201 status collapsed
19202
19203 \begin_layout Plain Layout
19204
19205 \emph on
19206 1
19207 \end_layout
19208
19209 \end_inset
19210
19211 ] Whether this inset should use the font of its surrounding environment
19212  or uses its own.
19213  Default is false: use the font of the surrounding environment.
19214 \end_layout
19215
19216 \begin_layout Description
19217 \begin_inset Flex Code
19218 status collapsed
19219
19220 \begin_layout Plain Layout
19221 RightDelim
19222 \end_layout
19223
19224 \end_inset
19225
19226  [
19227 \begin_inset Flex Code
19228 status collapsed
19229
19230 \begin_layout Plain Layout
19231 string
19232 \end_layout
19233
19234 \end_inset
19235
19236 ] A string that is put at the end of the layout content.
19237  A line break in the output can be indicated by
19238 \begin_inset Flex Code
19239 status collapsed
19240
19241 \begin_layout Plain Layout
19242 <br/>
19243 \end_layout
19244
19245 \end_inset
19246
19247 .
19248 \end_layout
19249
19250 \begin_layout Description
19251 \begin_inset Flex Code
19252 status collapsed
19253
19254 \begin_layout Plain Layout
19255 Spellcheck
19256 \end_layout
19257
19258 \end_inset
19259
19260  [
19261 \begin_inset Flex Code
19262 status collapsed
19263
19264 \begin_layout Plain Layout
19265 0
19266 \end_layout
19267
19268 \end_inset
19269
19270 ,
19271 \begin_inset space \thinspace{}
19272 \end_inset
19273
19274
19275 \begin_inset Flex Code
19276 status collapsed
19277
19278 \begin_layout Plain Layout
19279
19280 \emph on
19281 1
19282 \end_layout
19283
19284 \end_inset
19285
19286 ] Allow spell-checking the contents of this inset.
19287  Default is true.
19288 \end_layout
19289
19290 \begin_layout Subsection
19291 Counters
19292 \begin_inset CommandInset label
19293 LatexCommand label
19294 name "subsec:Counters"
19295
19296 \end_inset
19297
19298
19299 \end_layout
19300
19301 \begin_layout Standard
19302 It is necessary to define the counters (
19303 \begin_inset Flex Noun
19304 status collapsed
19305
19306 \begin_layout Plain Layout
19307 chapter
19308 \end_layout
19309
19310 \end_inset
19311
19312 ,
19313 \begin_inset Flex Noun
19314 status collapsed
19315
19316 \begin_layout Plain Layout
19317 figure
19318 \end_layout
19319
19320 \end_inset
19321
19322 , \SpecialChar ldots
19323 ) in the text class itself.
19324  The standard counters are defined in the file
19325 \begin_inset Flex Code
19326 status collapsed
19327
19328 \begin_layout Plain Layout
19329 stdcounters.inc
19330 \end_layout
19331
19332 \end_inset
19333
19334 , so you may have to do no more than add
19335 \end_layout
19336
19337 \begin_layout LyX-Code
19338 Input stdcounters.inc
19339 \end_layout
19340
19341 \begin_layout Standard
19342 to your layout file to get them to work.
19343  But if you want to define custom counters, then you can do so.
19344  The counter declaration must begin with:
19345 \end_layout
19346
19347 \begin_layout LyX-Code
19348 Counter CounterName
19349 \end_layout
19350
19351 \begin_layout Standard
19352 where of course `
19353 \begin_inset Flex Code
19354 status collapsed
19355
19356 \begin_layout Plain Layout
19357 CounterName
19358 \end_layout
19359
19360 \end_inset
19361
19362 ' is replaced by the name of the counter.
19363  And it must end with
19364 \begin_inset Quotes eld
19365 \end_inset
19366
19367
19368 \begin_inset Flex Code
19369 status collapsed
19370
19371 \begin_layout Plain Layout
19372 End
19373 \end_layout
19374
19375 \end_inset
19376
19377
19378 \begin_inset Quotes erd
19379 \end_inset
19380
19381 .
19382  The following parameters can also be used:
19383 \end_layout
19384
19385 \begin_layout Description
19386 \begin_inset Flex Code
19387 status collapsed
19388
19389 \begin_layout Plain Layout
19390 InitialValue
19391 \end_layout
19392
19393 \end_inset
19394
19395  [
19396 \begin_inset Flex Code
19397 status collapsed
19398
19399 \begin_layout Plain Layout
19400 int=1
19401 \end_layout
19402
19403 \end_inset
19404
19405 ] Sets the initial value for the counter, to which it will be reset whenever
19406  that happens.
19407  Normally, one will want the default, 1.
19408 \end_layout
19409
19410 \begin_layout Description
19411 \begin_inset Flex Code
19412 status collapsed
19413
19414 \begin_layout Plain Layout
19415 LabelString
19416 \end_layout
19417
19418 \end_inset
19419
19420  [
19421 \begin_inset Flex Code
19422 status collapsed
19423
19424 \begin_layout Plain Layout
19425 string
19426 \end_layout
19427
19428 \end_inset
19429
19430 =
19431 \begin_inset Quotes erd
19432 \end_inset
19433
19434
19435 \begin_inset Quotes erd
19436 \end_inset
19437
19438 ] When defined, this string defines how the counter is displayed.
19439  Setting this value sets
19440 \begin_inset Flex Code
19441 status collapsed
19442
19443 \begin_layout Plain Layout
19444 LabelStringAppendix
19445 \end_layout
19446
19447 \end_inset
19448
19449  to the same value.
19450  The following special constructs can be used in the string:
19451 \end_layout
19452
19453 \begin_deeper
19454 \begin_layout Itemize
19455 \begin_inset Flex Code
19456 status collapsed
19457
19458 \begin_layout Plain Layout
19459
19460 \backslash
19461 thecounter
19462 \end_layout
19463
19464 \end_inset
19465
19466  will be replaced by the expansion of the
19467 \begin_inset Flex Code
19468 status collapsed
19469
19470 \begin_layout Plain Layout
19471 LabelString
19472 \end_layout
19473
19474 \end_inset
19475
19476  (or
19477 \begin_inset Flex Code
19478 status collapsed
19479
19480 \begin_layout Plain Layout
19481 LabelStringAppendix
19482 \end_layout
19483
19484 \end_inset
19485
19486 ) of the counter
19487 \begin_inset Flex Code
19488 status collapsed
19489
19490 \begin_layout Plain Layout
19491 counter
19492 \end_layout
19493
19494 \end_inset
19495
19496 .
19497
19498 \end_layout
19499
19500 \begin_layout Itemize
19501 counter values can be expressed using \SpecialChar LaTeX
19502 -like macros
19503 \begin_inset Newline newline
19504 \end_inset
19505
19506
19507 \begin_inset Flex Code
19508 status collapsed
19509
19510 \begin_layout Plain Layout
19511
19512 \backslash
19513
19514 \emph on
19515 numbertype
19516 \emph default
19517 {
19518 \emph on
19519 counter
19520 \emph default
19521 }
19522 \end_layout
19523
19524 \end_inset
19525
19526 , where
19527 \begin_inset Flex Code
19528 status collapsed
19529
19530 \begin_layout Plain Layout
19531
19532 \emph on
19533 numbertype
19534 \end_layout
19535
19536 \end_inset
19537
19538  can be:
19539 \begin_inset Foot
19540 status collapsed
19541
19542 \begin_layout Plain Layout
19543
19544 \family roman
19545 \series medium
19546 \shape up
19547 \size normal
19548 \emph off
19549 \bar no
19550 \noun off
19551 \color none
19552 Actually, the situation is a bit more complicated: any
19553 \family default
19554 \series default
19555 \shape default
19556 \emph default
19557 \bar default
19558
19559 \size default
19560 \emph on
19561 \noun default
19562 \color inherit
19563 numbertype
19564 \family roman
19565 \series medium
19566 \shape up
19567 \size normal
19568 \emph off
19569 \bar no
19570 \noun off
19571  other than those described below will produce arabic numerals.
19572  It would not be surprising to see this change in the future.
19573 \end_layout
19574
19575 \end_inset
19576
19577
19578 \begin_inset Flex Code
19579 status collapsed
19580
19581 \begin_layout Plain Layout
19582 arabic
19583 \end_layout
19584
19585 \end_inset
19586
19587 : 1, 2, 3,\SpecialChar ldots
19588 ;
19589 \begin_inset Flex Code
19590 status collapsed
19591
19592 \begin_layout Plain Layout
19593 alph
19594 \end_layout
19595
19596 \end_inset
19597
19598  for lower-case letters: a, b, c, \SpecialChar ldots
19599 ;
19600 \begin_inset Flex Code
19601 status collapsed
19602
19603 \begin_layout Plain Layout
19604 Alph
19605 \end_layout
19606
19607 \end_inset
19608
19609  for upper-case letters: A, B, C, \SpecialChar ldots
19610 ;
19611 \begin_inset Flex Code
19612 status collapsed
19613
19614 \begin_layout Plain Layout
19615 roman
19616 \end_layout
19617
19618 \end_inset
19619
19620  for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
19621 ;
19622 \begin_inset Flex Code
19623 status collapsed
19624
19625 \begin_layout Plain Layout
19626 Roman
19627 \end_layout
19628
19629 \end_inset
19630
19631  for upper-case roman numerals: I, II, III\SpecialChar ldots
19632 ;
19633 \begin_inset Flex Code
19634 status collapsed
19635
19636 \begin_layout Plain Layout
19637 hebrew
19638 \end_layout
19639
19640 \end_inset
19641
19642  for hebrew numerals.
19643 \end_layout
19644
19645 \end_deeper
19646 \begin_layout Standard
19647 If LabelString is not defined, a default value is constructed as follows:
19648  if the counter has a master counter
19649 \begin_inset Flex Code
19650 status collapsed
19651
19652 \begin_layout Plain Layout
19653 master
19654 \end_layout
19655
19656 \end_inset
19657
19658  (defined via
19659 \begin_inset Flex Code
19660 status collapsed
19661
19662 \begin_layout Plain Layout
19663 Within
19664 \end_layout
19665
19666 \end_inset
19667
19668 ), the string
19669 \begin_inset Newline newline
19670 \end_inset
19671
19672
19673 \begin_inset Flex Code
19674 status collapsed
19675
19676 \begin_layout Plain Layout
19677
19678 \backslash
19679 themaster.
19680 \backslash
19681 arabic{counter}
19682 \end_layout
19683
19684 \end_inset
19685
19686  is used; otherwise the string
19687 \begin_inset Flex Code
19688 status collapsed
19689
19690 \begin_layout Plain Layout
19691
19692 \backslash
19693 arabic{counter}
19694 \end_layout
19695
19696 \end_inset
19697
19698  is used.
19699 \end_layout
19700
19701 \begin_layout Description
19702 \begin_inset Flex Code
19703 status collapsed
19704
19705 \begin_layout Plain Layout
19706 LabelStringAppendix
19707 \end_layout
19708
19709 \end_inset
19710
19711  [
19712 \begin_inset Flex Code
19713 status collapsed
19714
19715 \begin_layout Plain Layout
19716 string
19717 \end_layout
19718
19719 \end_inset
19720
19721 =
19722 \begin_inset Quotes erd
19723 \end_inset
19724
19725
19726 \begin_inset Quotes erd
19727 \end_inset
19728
19729 ] Same as
19730 \begin_inset Flex Code
19731 status collapsed
19732
19733 \begin_layout Plain Layout
19734 LabelString
19735 \end_layout
19736
19737 \end_inset
19738
19739 , but for use in the Appendix.
19740 \end_layout
19741
19742 \begin_layout Description
19743 \begin_inset Flex Code
19744 status collapsed
19745
19746 \begin_layout Plain Layout
19747 PrettyFormat
19748 \end_layout
19749
19750 \end_inset
19751
19752  [
19753 \begin_inset Flex Code
19754 status collapsed
19755
19756 \begin_layout Plain Layout
19757 string
19758 \end_layout
19759
19760 \end_inset
19761
19762 =
19763 \begin_inset Quotes erd
19764 \end_inset
19765
19766
19767 \begin_inset Quotes erd
19768 \end_inset
19769
19770 ] A format for use with formatted references to this counter.
19771  For example, one might want to have references to section numbers appear
19772  as
19773 \begin_inset Quotes eld
19774 \end_inset
19775
19776 Section 2.4
19777 \begin_inset Quotes erd
19778 \end_inset
19779
19780 .
19781  The string should contain
19782 \begin_inset Quotes eld
19783 \end_inset
19784
19785 ##
19786 \begin_inset Quotes erd
19787 \end_inset
19788
19789 .
19790  This will be replaced by the counter number itself.
19791  So, for sections, it would be: Section ##.
19792 \end_layout
19793
19794 \begin_layout Description
19795 \begin_inset Flex Code
19796 status collapsed
19797
19798 \begin_layout Plain Layout
19799 Within
19800 \end_layout
19801
19802 \end_inset
19803
19804  [
19805 \begin_inset Flex Code
19806 status collapsed
19807
19808 \begin_layout Plain Layout
19809 string
19810 \end_layout
19811
19812 \end_inset
19813
19814 =
19815 \begin_inset Quotes erd
19816 \end_inset
19817
19818
19819 \begin_inset Quotes erd
19820 \end_inset
19821
19822 ] If this is set to the name of another counter, the present counter will
19823  be reset every time the other one is increased.
19824  For example,
19825 \begin_inset Flex Code
19826 status collapsed
19827
19828 \begin_layout Plain Layout
19829 subsection
19830 \end_layout
19831
19832 \end_inset
19833
19834  is numbered inside
19835 \begin_inset Flex Code
19836 status collapsed
19837
19838 \begin_layout Plain Layout
19839 section
19840 \end_layout
19841
19842 \end_inset
19843
19844 .
19845 \end_layout
19846
19847 \begin_layout Subsection
19848 Font description
19849 \begin_inset CommandInset label
19850 LatexCommand label
19851 name "subsec:Font-description"
19852
19853 \end_inset
19854
19855
19856 \end_layout
19857
19858 \begin_layout Standard
19859 A font description looks like this:
19860 \end_layout
19861
19862 \begin_layout LyX-Code
19863 Font
19864 \family roman
19865 \emph on
19866 or
19867 \family default
19868 \emph default
19869  LabelFont
19870 \emph on
19871  or
19872 \emph default
19873  DefaultFont
19874 \end_layout
19875
19876 \begin_layout LyX-Code
19877  ...
19878 \end_layout
19879
19880 \begin_layout LyX-Code
19881 EndFont
19882 \end_layout
19883
19884 \begin_layout Standard
19885 The following commands are available:
19886 \end_layout
19887
19888 \begin_layout Description
19889 \begin_inset Flex Code
19890 status collapsed
19891
19892 \begin_layout Plain Layout
19893 Color
19894 \end_layout
19895
19896 \end_inset
19897
19898  [
19899 \begin_inset Flex Code
19900 status collapsed
19901
19902 \begin_layout Plain Layout
19903
19904 \emph on
19905 none
19906 \end_layout
19907
19908 \end_inset
19909
19910 ,
19911 \begin_inset Flex Code
19912 status collapsed
19913
19914 \begin_layout Plain Layout
19915 black
19916 \end_layout
19917
19918 \end_inset
19919
19920 ,
19921 \begin_inset Flex Code
19922 status collapsed
19923
19924 \begin_layout Plain Layout
19925 white
19926 \end_layout
19927
19928 \end_inset
19929
19930 ,
19931 \begin_inset Flex Code
19932 status collapsed
19933
19934 \begin_layout Plain Layout
19935 red
19936 \end_layout
19937
19938 \end_inset
19939
19940 ,
19941 \begin_inset Flex Code
19942 status collapsed
19943
19944 \begin_layout Plain Layout
19945 green
19946 \end_layout
19947
19948 \end_inset
19949
19950 ,
19951 \begin_inset Flex Code
19952 status collapsed
19953
19954 \begin_layout Plain Layout
19955 blue
19956 \end_layout
19957
19958 \end_inset
19959
19960 ,
19961 \begin_inset Flex Code
19962 status collapsed
19963
19964 \begin_layout Plain Layout
19965 cyan
19966 \end_layout
19967
19968 \end_inset
19969
19970 ,
19971 \begin_inset Flex Code
19972 status collapsed
19973
19974 \begin_layout Plain Layout
19975 magenta
19976 \end_layout
19977
19978 \end_inset
19979
19980 ,
19981 \begin_inset Flex Code
19982 status collapsed
19983
19984 \begin_layout Plain Layout
19985 yellow
19986 \end_layout
19987
19988 \end_inset
19989
19990 ,
19991 \begin_inset Flex Code
19992 status collapsed
19993
19994 \begin_layout Plain Layout
19995 brown
19996 \end_layout
19997
19998 \end_inset
19999
20000 ,
20001 \begin_inset Flex Code
20002 status collapsed
20003
20004 \begin_layout Plain Layout
20005 darkgray
20006 \end_layout
20007
20008 \end_inset
20009
20010 ,
20011 \begin_inset Flex Code
20012 status collapsed
20013
20014 \begin_layout Plain Layout
20015 gray
20016 \end_layout
20017
20018 \end_inset
20019
20020 ,
20021 \begin_inset Flex Code
20022 status collapsed
20023
20024 \begin_layout Plain Layout
20025 lightgray
20026 \end_layout
20027
20028 \end_inset
20029
20030 ,
20031 \begin_inset Flex Code
20032 status collapsed
20033
20034 \begin_layout Plain Layout
20035 lime
20036 \end_layout
20037
20038 \end_inset
20039
20040 ,
20041 \begin_inset Flex Code
20042 status collapsed
20043
20044 \begin_layout Plain Layout
20045 orange
20046 \end_layout
20047
20048 \end_inset
20049
20050 ,
20051 \begin_inset Flex Code
20052 status collapsed
20053
20054 \begin_layout Plain Layout
20055 olive
20056 \end_layout
20057
20058 \end_inset
20059
20060 ,
20061 \begin_inset Flex Code
20062 status collapsed
20063
20064 \begin_layout Plain Layout
20065 pink
20066 \end_layout
20067
20068 \end_inset
20069
20070 ,
20071 \begin_inset Flex Code
20072 status collapsed
20073
20074 \begin_layout Plain Layout
20075 purple
20076 \end_layout
20077
20078 \end_inset
20079
20080 ,
20081 \begin_inset Flex Code
20082 status collapsed
20083
20084 \begin_layout Plain Layout
20085 teal
20086 \end_layout
20087
20088 \end_inset
20089
20090 ,
20091 \begin_inset Flex Code
20092 status collapsed
20093
20094 \begin_layout Plain Layout
20095 violet
20096 \end_layout
20097
20098 \end_inset
20099
20100 ]
20101 \end_layout
20102
20103 \begin_layout Description
20104 \begin_inset Flex Code
20105 status collapsed
20106
20107 \begin_layout Plain Layout
20108 Family
20109 \end_layout
20110
20111 \end_inset
20112
20113  [
20114 \begin_inset Flex Code
20115 status collapsed
20116
20117 \begin_layout Plain Layout
20118
20119 \emph on
20120 Roman
20121 \end_layout
20122
20123 \end_inset
20124
20125 ,
20126 \begin_inset Flex Code
20127 status collapsed
20128
20129 \begin_layout Plain Layout
20130 Sans
20131 \end_layout
20132
20133 \end_inset
20134
20135 ,
20136 \begin_inset Flex Code
20137 status collapsed
20138
20139 \begin_layout Plain Layout
20140 Typewriter
20141 \end_layout
20142
20143 \end_inset
20144
20145 ]
20146 \end_layout
20147
20148 \begin_layout Description
20149 \begin_inset Flex Code
20150 status collapsed
20151
20152 \begin_layout Plain Layout
20153 Misc
20154 \end_layout
20155
20156 \end_inset
20157
20158  [
20159 \begin_inset Flex Code
20160 status collapsed
20161
20162 \begin_layout Plain Layout
20163 string
20164 \end_layout
20165
20166 \end_inset
20167
20168 ] Valid arguments are:
20169 \begin_inset Flex Code
20170 status collapsed
20171
20172 \begin_layout Plain Layout
20173 emph
20174 \end_layout
20175
20176 \end_inset
20177
20178 ,
20179 \begin_inset Flex Code
20180 status collapsed
20181
20182 \begin_layout Plain Layout
20183 noun
20184 \end_layout
20185
20186 \end_inset
20187
20188 ,
20189 \begin_inset Flex Code
20190 status collapsed
20191
20192 \begin_layout Plain Layout
20193 strikeout
20194 \end_layout
20195
20196 \end_inset
20197
20198 ,
20199 \begin_inset Flex Code
20200 status collapsed
20201
20202 \begin_layout Plain Layout
20203 underbar
20204 \end_layout
20205
20206 \end_inset
20207
20208 ,
20209 \begin_inset Flex Code
20210 status collapsed
20211
20212 \begin_layout Plain Layout
20213 uuline
20214 \end_layout
20215
20216 \end_inset
20217
20218 ,
20219 \begin_inset Flex Code
20220 status collapsed
20221
20222 \begin_layout Plain Layout
20223 uwave
20224 \end_layout
20225
20226 \end_inset
20227
20228 ,
20229 \begin_inset Flex Code
20230 status collapsed
20231
20232 \begin_layout Plain Layout
20233 no_emph
20234 \end_layout
20235
20236 \end_inset
20237
20238 ,
20239 \begin_inset Flex Code
20240 status collapsed
20241
20242 \begin_layout Plain Layout
20243 no_noun
20244 \end_layout
20245
20246 \end_inset
20247
20248 ,
20249 \begin_inset Flex Code
20250 status collapsed
20251
20252 \begin_layout Plain Layout
20253 no_strikeout
20254 \end_layout
20255
20256 \end_inset
20257
20258 ,
20259 \begin_inset Flex Code
20260 status collapsed
20261
20262 \begin_layout Plain Layout
20263 no_bar
20264 \end_layout
20265
20266 \end_inset
20267
20268 ,
20269 \begin_inset Flex Code
20270 status collapsed
20271
20272 \begin_layout Plain Layout
20273 no_uuline
20274 \end_layout
20275
20276 \end_inset
20277
20278  and
20279 \begin_inset Flex Code
20280 status collapsed
20281
20282 \begin_layout Plain Layout
20283 no_uwave
20284 \end_layout
20285
20286 \end_inset
20287
20288 .
20289  Each of these turns on or off the corresponding attribute.
20290  For example,
20291 \begin_inset Flex Code
20292 status collapsed
20293
20294 \begin_layout Plain Layout
20295 emph
20296 \end_layout
20297
20298 \end_inset
20299
20300  turns on emphasis, and
20301 \begin_inset Flex Code
20302 status collapsed
20303
20304 \begin_layout Plain Layout
20305 no_emph
20306 \end_layout
20307
20308 \end_inset
20309
20310  turns it off.
20311
20312 \begin_inset Newline newline
20313 \end_inset
20314
20315 If the latter seems puzzling, remember that the font settings for the present
20316  context are generally inherited from the surrounding context.
20317  So
20318 \begin_inset Flex Code
20319 status collapsed
20320
20321 \begin_layout Plain Layout
20322 no_emph
20323 \end_layout
20324
20325 \end_inset
20326
20327  would turn off the emphasis that was anyway in effect, say, in a theorem
20328  environment.
20329 \end_layout
20330
20331 \begin_layout Description
20332 \begin_inset Flex Code
20333 status collapsed
20334
20335 \begin_layout Plain Layout
20336 Series
20337 \end_layout
20338
20339 \end_inset
20340
20341  [
20342 \begin_inset Flex Code
20343 status collapsed
20344
20345 \begin_layout Plain Layout
20346
20347 \emph on
20348 Medium
20349 \end_layout
20350
20351 \end_inset
20352
20353 ,
20354 \begin_inset Flex Code
20355 status collapsed
20356
20357 \begin_layout Plain Layout
20358 Bold
20359 \end_layout
20360
20361 \end_inset
20362
20363 ]
20364 \end_layout
20365
20366 \begin_layout Description
20367 \begin_inset Flex Code
20368 status collapsed
20369
20370 \begin_layout Plain Layout
20371 Shape
20372 \end_layout
20373
20374 \end_inset
20375
20376  [
20377 \begin_inset Flex Code
20378 status collapsed
20379
20380 \begin_layout Plain Layout
20381
20382 \emph on
20383 Up
20384 \end_layout
20385
20386 \end_inset
20387
20388 ,
20389 \begin_inset Flex Code
20390 status collapsed
20391
20392 \begin_layout Plain Layout
20393 Italic
20394 \end_layout
20395
20396 \end_inset
20397
20398 ,
20399 \begin_inset Flex Code
20400 status collapsed
20401
20402 \begin_layout Plain Layout
20403 SmallCaps
20404 \end_layout
20405
20406 \end_inset
20407
20408 ,
20409 \begin_inset Flex Code
20410 status collapsed
20411
20412 \begin_layout Plain Layout
20413 Slanted
20414 \end_layout
20415
20416 \end_inset
20417
20418 ]
20419 \end_layout
20420
20421 \begin_layout Description
20422 \begin_inset Flex Code
20423 status collapsed
20424
20425 \begin_layout Plain Layout
20426 Size
20427 \end_layout
20428
20429 \end_inset
20430
20431  [
20432 \begin_inset Flex Code
20433 status collapsed
20434
20435 \begin_layout Plain Layout
20436 tiny
20437 \end_layout
20438
20439 \end_inset
20440
20441 ,
20442 \begin_inset Flex Code
20443 status collapsed
20444
20445 \begin_layout Plain Layout
20446 small
20447 \end_layout
20448
20449 \end_inset
20450
20451 ,
20452 \begin_inset Flex Code
20453 status collapsed
20454
20455 \begin_layout Plain Layout
20456
20457 \emph on
20458 normal
20459 \end_layout
20460
20461 \end_inset
20462
20463 ,
20464 \begin_inset Flex Code
20465 status collapsed
20466
20467 \begin_layout Plain Layout
20468 large
20469 \end_layout
20470
20471 \end_inset
20472
20473 ,
20474 \begin_inset Flex Code
20475 status collapsed
20476
20477 \begin_layout Plain Layout
20478 larger
20479 \end_layout
20480
20481 \end_inset
20482
20483 ,
20484 \begin_inset Flex Code
20485 status collapsed
20486
20487 \begin_layout Plain Layout
20488 largest
20489 \end_layout
20490
20491 \end_inset
20492
20493 ,
20494 \begin_inset Flex Code
20495 status collapsed
20496
20497 \begin_layout Plain Layout
20498 huge
20499 \end_layout
20500
20501 \end_inset
20502
20503 ,
20504 \begin_inset Flex Code
20505 status collapsed
20506
20507 \begin_layout Plain Layout
20508 giant
20509 \end_layout
20510
20511 \end_inset
20512
20513 ]
20514 \end_layout
20515
20516 \begin_layout Subsection
20517 \begin_inset CommandInset label
20518 LatexCommand label
20519 name "subsec:Citation-format-description"
20520
20521 \end_inset
20522
20523 Citation format description
20524 \end_layout
20525
20526 \begin_layout Standard
20527 The
20528 \begin_inset Flex Code
20529 status collapsed
20530
20531 \begin_layout Plain Layout
20532 CiteFormat
20533 \end_layout
20534
20535 \end_inset
20536
20537  blocks are used to describe how bibliographic information should be displayed,
20538  both within \SpecialChar LyX
20539  itself (in the citation dialog and in tooltips, for example)
20540  and in XHTML output.
20541  Such a block might look like this:
20542 \end_layout
20543
20544 \begin_layout LyX-Code
20545 CiteFormat
20546 \end_layout
20547
20548 \begin_layout LyX-Code
20549  article ...
20550 \end_layout
20551
20552 \begin_layout LyX-Code
20553  book ...
20554 \end_layout
20555
20556 \begin_layout LyX-Code
20557 End
20558 \end_layout
20559
20560 \begin_layout Standard
20561 The individual lines define how the bibliographic information associated
20562  with an article or book, respectively, is to be displayed, and such a definitio
20563 n can be given for any `entry type' that might be present in a Bib\SpecialChar TeX
20564  file.
20565  \SpecialChar LyX
20566  defines a default format in the source code that will be used if no specific
20567  definition has been given.
20568  \SpecialChar LyX
20569  predefines several formats in the file
20570 \begin_inset Flex Code
20571 status collapsed
20572
20573 \begin_layout Plain Layout
20574 stdciteformats.inc
20575 \end_layout
20576
20577 \end_inset
20578
20579 , which is included in most of \SpecialChar LyX
20580 's document classes.
20581 \end_layout
20582
20583 \begin_layout Standard
20584 The definitions use a simple language that allows Bib\SpecialChar TeX
20585  keys to be replaced
20586  with their values.
20587  Keys should be enclosed in
20588 \begin_inset Flex Code
20589 status collapsed
20590
20591 \begin_layout Plain Layout
20592 %
20593 \end_layout
20594
20595 \end_inset
20596
20597  signs, e.g.:
20598 \begin_inset Flex Code
20599 status collapsed
20600
20601 \begin_layout Plain Layout
20602 %author%
20603 \end_layout
20604
20605 \end_inset
20606
20607 .
20608  So a simple definition might look like this:
20609 \end_layout
20610
20611 \begin_layout LyX-Code
20612 misc %author%,
20613 \begin_inset Quotes eld
20614 \end_inset
20615
20616 %title%
20617 \begin_inset Quotes erd
20618 \end_inset
20619
20620 .
20621 \end_layout
20622
20623 \begin_layout Standard
20624 This would print the author, followed by a comma, followed by the title,
20625  in quotes, followed by a period.
20626 \end_layout
20627
20628 \begin_layout Standard
20629 Of course, sometimes you may want to print a key only if it exists.
20630  This can be done by using a conditional construction, such as:
20631 \begin_inset Flex Code
20632 status collapsed
20633
20634 \begin_layout Plain Layout
20635 {%volume%[[vol.
20636 \begin_inset space ~
20637 \end_inset
20638
20639 %volume%]]}
20640 \end_layout
20641
20642 \end_inset
20643
20644 .
20645  This says: If the
20646 \begin_inset Flex Code
20647 status collapsed
20648
20649 \begin_layout Plain Layout
20650 volume
20651 \end_layout
20652
20653 \end_inset
20654
20655  key exists, then print
20656 \begin_inset Quotes eld
20657 \end_inset
20658
20659 vol.
20660 \begin_inset space ~
20661 \end_inset
20662
20663
20664 \begin_inset Quotes erd
20665 \end_inset
20666
20667  followed by the volume key.
20668  It is also possible to have an else clause in the conditional, such as:
20669 \begin_inset Newline newline
20670 \end_inset
20671
20672
20673 \begin_inset Flex Code
20674 status collapsed
20675
20676 \begin_layout Plain Layout
20677 {%author%[[%author%]][[%editor%, ed.]]}
20678 \end_layout
20679
20680 \end_inset
20681
20682 .
20683 \begin_inset Newline newline
20684 \end_inset
20685
20686 Here, the
20687 \begin_inset Flex Code
20688 status collapsed
20689
20690 \begin_layout Plain Layout
20691 author
20692 \end_layout
20693
20694 \end_inset
20695
20696  key is printed if it exists; otherwise, the editor key is printed, followed
20697  by
20698 \begin_inset Quotes eld
20699 \end_inset
20700
20701 ,
20702 \begin_inset space ~
20703 \end_inset
20704
20705 ed.
20706 \begin_inset Quotes erd
20707 \end_inset
20708
20709  Note that the key is again enclosed in
20710 \begin_inset Flex Code
20711 status collapsed
20712
20713 \begin_layout Plain Layout
20714 %
20715 \end_layout
20716
20717 \end_inset
20718
20719  signs; the entire conditional is enclosed in braces; and the if and else
20720  clauses are enclosed in double brackets,
20721 \begin_inset Quotes eld
20722 \end_inset
20723
20724
20725 \begin_inset Flex Code
20726 status collapsed
20727
20728 \begin_layout Plain Layout
20729 [[
20730 \end_layout
20731
20732 \end_inset
20733
20734
20735 \begin_inset Quotes eld
20736 \end_inset
20737
20738  and
20739 \begin_inset Quotes eld
20740 \end_inset
20741
20742
20743 \begin_inset Flex Code
20744 status collapsed
20745
20746 \begin_layout Plain Layout
20747 ]]
20748 \end_layout
20749
20750 \end_inset
20751
20752
20753 \begin_inset Quotes erd
20754 \end_inset
20755
20756 .
20757  There must be no space between any of these.
20758 \end_layout
20759
20760 \begin_layout Standard
20761 There is one other piece of syntax available in definitions, which looks
20762  like this:
20763 \begin_inset Flex Code
20764 status collapsed
20765
20766 \begin_layout Plain Layout
20767 {!<i>!}
20768 \end_layout
20769
20770 \end_inset
20771
20772 .
20773  This defines a piece of formatting information that is to be used when
20774  creating
20775 \begin_inset Quotes eld
20776 \end_inset
20777
20778 rich text
20779 \begin_inset Quotes erd
20780 \end_inset
20781
20782 .
20783  Obviously, we do not want to output HTML tags when writing plain text,
20784  so they should be wrapped in
20785 \begin_inset Quotes eld
20786 \end_inset
20787
20788 {!
20789 \begin_inset Quotes erd
20790 \end_inset
20791
20792  and
20793 \begin_inset Quotes eld
20794 \end_inset
20795
20796 !}
20797 \begin_inset Quotes erd
20798 \end_inset
20799
20800 .
20801 \end_layout
20802
20803 \begin_layout Standard
20804 Two special sorts of definitions are also possible in a
20805 \begin_inset Flex Code
20806 status collapsed
20807
20808 \begin_layout Plain Layout
20809 CiteFormat
20810 \end_layout
20811
20812 \end_inset
20813
20814  block.
20815  An example of the first would be:
20816 \end_layout
20817
20818 \begin_layout LyX-Code
20819 !quotetitle
20820 \begin_inset Quotes eld
20821 \end_inset
20822
20823 %title%
20824 \begin_inset Quotes erd
20825 \end_inset
20826
20827
20828 \end_layout
20829
20830 \begin_layout Standard
20831 This is an abbreviation, or macro, and it can be used by treating it as
20832  if it were a key:
20833 \begin_inset Flex Code
20834 status collapsed
20835
20836 \begin_layout Plain Layout
20837 %!quotetitle%
20838 \end_layout
20839
20840 \end_inset
20841
20842 .
20843  \SpecialChar LyX
20844  will treat
20845 \begin_inset Flex Code
20846 status collapsed
20847
20848 \begin_layout Plain Layout
20849 %!quotetitle%
20850 \end_layout
20851
20852 \end_inset
20853
20854  exactly as it would treat its definition.
20855  So, let us issue the obvious
20856 \emph on
20857 warning
20858 \emph default
20859 .
20860  Do not do this:
20861 \end_layout
20862
20863 \begin_layout LyX-Code
20864 !funfun %funfun%
20865 \end_layout
20866
20867 \begin_layout Standard
20868 or anything like it.
20869  \SpecialChar LyX
20870  shouldn't go into an infinite loop, but it may go into a long one before
20871  it gives up.
20872 \end_layout
20873
20874 \begin_layout Standard
20875 The second sort of special definition might look like this:
20876 \end_layout
20877
20878 \begin_layout LyX-Code
20879 _pptext pp.
20880 \end_layout
20881
20882 \begin_layout Standard
20883 This defines a translatable piece of text, which allows relevant parts of
20884  the bibliography to be translated.
20885  It can be included in a definition by treating it as a key:
20886 \begin_inset Flex Code
20887 status collapsed
20888
20889 \begin_layout Plain Layout
20890 %_pptext%
20891 \end_layout
20892
20893 \end_inset
20894
20895 .
20896  Several of these are predefined in
20897 \begin_inset Flex Code
20898 status collapsed
20899
20900 \begin_layout Plain Layout
20901 stdciteformats.inc
20902 \end_layout
20903
20904 \end_inset
20905
20906 .
20907  Note that these are not macros, in the sense just defined.
20908  They will not be expanded.
20909 \end_layout
20910
20911 \begin_layout Standard
20912 So here then is an example that use all these features:
20913 \begin_inset VSpace defskip
20914 \end_inset
20915
20916
20917 \end_layout
20918
20919 \begin_layout Standard
20920 \noindent
20921
20922 \family typewriter
20923 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
20924 \end_layout
20925
20926 \begin_layout Standard
20927 \begin_inset VSpace defskip
20928 \end_inset
20929
20930 This defines a macro that prints the author, followed by a comma, if the
20931
20932 \begin_inset Flex Code
20933 status collapsed
20934
20935 \begin_layout Plain Layout
20936 author
20937 \end_layout
20938
20939 \end_inset
20940
20941  key is defined, or else prints the name of the editor, followed by the
20942
20943 \begin_inset Flex Code
20944 status collapsed
20945
20946 \begin_layout Plain Layout
20947 _edtext
20948 \end_layout
20949
20950 \end_inset
20951
20952  or its translation (it is by default
20953 \begin_inset Quotes eld
20954 \end_inset
20955
20956 ed.
20957 \begin_inset Quotes erd
20958 \end_inset
20959
20960 ), if the
20961 \begin_inset Flex Code
20962 status collapsed
20963
20964 \begin_layout Plain Layout
20965 editor
20966 \end_layout
20967
20968 \end_inset
20969
20970  key is defined.
20971  Note that this is in fact defined in
20972 \begin_inset Flex Code
20973 status collapsed
20974
20975 \begin_layout Plain Layout
20976 stdciteformats.inc
20977 \end_layout
20978
20979 \end_inset
20980
20981 , so you can use it in your own definitions, or re-definitions, if you load
20982  that file first.
20983 \end_layout
20984
20985 \begin_layout Section
20986 \begin_inset CommandInset label
20987 LatexCommand label
20988 name "sec:Tags-for-XHTML"
20989
20990 \end_inset
20991
20992 Tags for XHTML output
20993 \end_layout
20994
20995 \begin_layout Standard
20996 As with \SpecialChar LaTeX
20997  or DocBook, the format of \SpecialChar LyX
20998 's XHTML output is also controlled by
20999  layout information.
21000  In general, \SpecialChar LyX
21001  provides sensible defaults and, as mentioned earlier, it will
21002  even construct default CSS style rules from the other layout tags.
21003  For example, \SpecialChar LyX
21004  will attempt to use the information provided in the
21005 \begin_inset Flex Code
21006 status collapsed
21007
21008 \begin_layout Plain Layout
21009 Font
21010 \end_layout
21011
21012 \end_inset
21013
21014  declaration for the Chapter style to write CSS that will appropriately
21015  format chapter headings.
21016 \end_layout
21017
21018 \begin_layout Standard
21019 In many cases, then, you may not have to do anything at all to get acceptable
21020  XHTML output for your own environments, custom insets, and so forth.
21021  But in some cases you will, and so \SpecialChar LyX
21022  provides a number of layout tags that
21023  can be used to customize the XHTML and CSS that are generated.
21024 \end_layout
21025
21026 \begin_layout Standard
21027 Note that there are two tags,
21028 \begin_inset Flex Code
21029 status collapsed
21030
21031 \begin_layout Plain Layout
21032 HTMLPreamble
21033 \end_layout
21034
21035 \end_inset
21036
21037  and
21038 \begin_inset Flex Code
21039 status collapsed
21040
21041 \begin_layout Plain Layout
21042 AddToHTMLPreamble
21043 \end_layout
21044
21045 \end_inset
21046
21047  that may appear outside style and inset declarations.
21048  See
21049 \begin_inset CommandInset ref
21050 LatexCommand ref
21051 reference "subsec:General-text-class"
21052
21053 \end_inset
21054
21055  for details on these.
21056 \end_layout
21057
21058 \begin_layout Subsection
21059 \begin_inset CommandInset label
21060 LatexCommand label
21061 name "subsec:Paragraph-Style-XHTML"
21062
21063 \end_inset
21064
21065 Paragraph styles
21066 \end_layout
21067
21068 \begin_layout Standard
21069 The sort of XHTML \SpecialChar LyX
21070  outputs for a paragraph depends upon whether we are dealing
21071  with a normal paragraph, a command, or an environment, where this is itself
21072  determined by the contents of the corresponding
21073 \begin_inset Flex Code
21074 status collapsed
21075
21076 \begin_layout Plain Layout
21077 \SpecialChar LaTeX
21078 Type
21079 \end_layout
21080
21081 \end_inset
21082
21083  tag.
21084
21085 \end_layout
21086
21087 \begin_layout Standard
21088 For a command or normal paragraph, the output XHTML has the following form:
21089 \end_layout
21090
21091 \begin_layout LyX-Code
21092 <tag attr=
21093 \begin_inset Quotes erd
21094 \end_inset
21095
21096 value
21097 \begin_inset Quotes erd
21098 \end_inset
21099
21100 >
21101 \end_layout
21102
21103 \begin_layout LyX-Code
21104 <labeltag attr=
21105 \begin_inset Quotes erd
21106 \end_inset
21107
21108 value
21109 \begin_inset Quotes erd
21110 \end_inset
21111
21112 >Label</labeltag>
21113 \end_layout
21114
21115 \begin_layout LyX-Code
21116 Contents of the paragraph.
21117 \end_layout
21118
21119 \begin_layout LyX-Code
21120 </tag>
21121 \end_layout
21122
21123 \begin_layout Standard
21124 The label tags are of course omitted if the paragraph does not have a label.
21125 \end_layout
21126
21127 \begin_layout Standard
21128 For an environment that is not some sort of list, the XHTML takes this form:
21129 \end_layout
21130
21131 \begin_layout LyX-Code
21132 <tag attr=
21133 \begin_inset Quotes erd
21134 \end_inset
21135
21136 value
21137 \begin_inset Quotes erd
21138 \end_inset
21139
21140 >
21141 \end_layout
21142
21143 \begin_layout LyX-Code
21144 <itemtag attr=
21145 \begin_inset Quotes erd
21146 \end_inset
21147
21148 value
21149 \begin_inset Quotes erd
21150 \end_inset
21151
21152 ><labeltag attr=
21153 \begin_inset Quotes erd
21154 \end_inset
21155
21156 value
21157 \begin_inset Quotes erd
21158 \end_inset
21159
21160 >Environment Label</labeltag>First paragraph.</itemtag>
21161 \end_layout
21162
21163 \begin_layout LyX-Code
21164 <itemtag>Second paragraph.</itemtag>
21165 \end_layout
21166
21167 \begin_layout LyX-Code
21168 </tag>
21169 \end_layout
21170
21171 \begin_layout Standard
21172 Note that the label is output only for the first paragraph, as it should
21173  be for a theorem, for example.
21174
21175 \end_layout
21176
21177 \begin_layout Standard
21178 For a list, we have one of these forms:
21179 \end_layout
21180
21181 \begin_layout LyX-Code
21182 <tag attr=
21183 \begin_inset Quotes erd
21184 \end_inset
21185
21186 value
21187 \begin_inset Quotes erd
21188 \end_inset
21189
21190 >
21191 \end_layout
21192
21193 \begin_layout LyX-Code
21194 <itemtag attr=
21195 \begin_inset Quotes erd
21196 \end_inset
21197
21198 value
21199 \begin_inset Quotes erd
21200 \end_inset
21201
21202 ><labeltag attr=
21203 \begin_inset Quotes erd
21204 \end_inset
21205
21206 value
21207 \begin_inset Quotes erd
21208 \end_inset
21209
21210 >List Label</labeltag>First item.</itemtag>
21211 \end_layout
21212
21213 \begin_layout LyX-Code
21214 <itemtag attr=
21215 \begin_inset Quotes erd
21216 \end_inset
21217
21218 value
21219 \begin_inset Quotes erd
21220 \end_inset
21221
21222 ><labeltag attr=
21223 \begin_inset Quotes erd
21224 \end_inset
21225
21226 value
21227 \begin_inset Quotes erd
21228 \end_inset
21229
21230 >List Label</labeltag>Second item.</itemtag>
21231 \end_layout
21232
21233 \begin_layout LyX-Code
21234 </tag>
21235 \end_layout
21236
21237 \begin_layout LyX-Code
21238
21239 \end_layout
21240
21241 \begin_layout LyX-Code
21242 <tag attr=
21243 \begin_inset Quotes erd
21244 \end_inset
21245
21246 value
21247 \begin_inset Quotes erd
21248 \end_inset
21249
21250 >
21251 \end_layout
21252
21253 \begin_layout LyX-Code
21254 <labeltag attr=
21255 \begin_inset Quotes erd
21256 \end_inset
21257
21258 value
21259 \begin_inset Quotes erd
21260 \end_inset
21261
21262 >List Label</labeltag><itemtag attr=
21263 \begin_inset Quotes erd
21264 \end_inset
21265
21266 value
21267 \begin_inset Quotes erd
21268 \end_inset
21269
21270 >First item.</itemtag>
21271 \end_layout
21272
21273 \begin_layout LyX-Code
21274 <labeltag attr=
21275 \begin_inset Quotes erd
21276 \end_inset
21277
21278 value
21279 \begin_inset Quotes erd
21280 \end_inset
21281
21282 >List Label</labeltag><itemtag attr=
21283 \begin_inset Quotes erd
21284 \end_inset
21285
21286 value
21287 \begin_inset Quotes erd
21288 \end_inset
21289
21290 >Second item.</itemtag>
21291 \end_layout
21292
21293 \begin_layout LyX-Code
21294 </tag>
21295 \end_layout
21296
21297 \begin_layout Standard
21298 Note the different orders of
21299 \begin_inset Flex Code
21300 status collapsed
21301
21302 \begin_layout Plain Layout
21303 labeltag
21304 \end_layout
21305
21306 \end_inset
21307
21308  and
21309 \begin_inset Flex Code
21310 status collapsed
21311
21312 \begin_layout Plain Layout
21313 itemtag
21314 \end_layout
21315
21316 \end_inset
21317
21318 .
21319  Which order we get depends upon the setting of
21320 \begin_inset Flex Code
21321 status collapsed
21322
21323 \begin_layout Plain Layout
21324 HTMLLabelFirst
21325 \end_layout
21326
21327 \end_inset
21328
21329 : If
21330 \begin_inset Flex Code
21331 status collapsed
21332
21333 \begin_layout Plain Layout
21334 HTMLLabelFirst
21335 \end_layout
21336
21337 \end_inset
21338
21339  is false (the default), you get the first of these, with the label within
21340  the item; if true, you get the second, with the label outside the item.
21341 \end_layout
21342
21343 \begin_layout Standard
21344 The specific tags and attributes output for each paragraph type can be controlle
21345 d by means of the layout tags we are about to describe.
21346  As mentioned earlier, however, \SpecialChar LyX
21347  uses sensible defaults for many of these,
21348  so you often may not need to do very much to get good XHTML output.
21349  Think of the available tags as there so you can tweak things to your liking.
21350 \end_layout
21351
21352 \begin_layout Description
21353 \begin_inset Flex Code
21354 status collapsed
21355
21356 \begin_layout Plain Layout
21357 HTMLAttr
21358 \end_layout
21359
21360 \end_inset
21361
21362  [
21363 \begin_inset Flex Code
21364 status collapsed
21365
21366 \begin_layout Plain Layout
21367 string
21368 \end_layout
21369
21370 \end_inset
21371
21372 ] Specifies attribute information to be output with the main tag.
21373  For example,
21374 \begin_inset Quotes eld
21375 \end_inset
21376
21377
21378 \begin_inset Flex Code
21379 status collapsed
21380
21381 \begin_layout Plain Layout
21382 class=`mydiv'
21383 \end_layout
21384
21385 \end_inset
21386
21387
21388 \begin_inset Quotes erd
21389 \end_inset
21390
21391 .
21392  By default, \SpecialChar LyX
21393  will output
21394 \begin_inset Quotes eld
21395 \end_inset
21396
21397
21398 \begin_inset Flex Code
21399 status collapsed
21400
21401 \begin_layout Plain Layout
21402 class=`layoutname'
21403 \end_layout
21404
21405 \end_inset
21406
21407
21408 \begin_inset Quotes erd
21409 \end_inset
21410
21411 , where
21412 \begin_inset Flex Code
21413 status collapsed
21414
21415 \begin_layout Plain Layout
21416 layoutname
21417 \end_layout
21418
21419 \end_inset
21420
21421  is the \SpecialChar LyX
21422  name of the layout, made lowercase, for example: chapter.
21423  This should
21424 \emph on
21425 not
21426 \emph default
21427  contain any style information.
21428  Use
21429 \begin_inset Flex Code
21430 status collapsed
21431
21432 \begin_layout Plain Layout
21433 HTMLStyle
21434 \end_layout
21435
21436 \end_inset
21437
21438  for that purpose.
21439 \end_layout
21440
21441 \begin_layout Description
21442 \begin_inset Flex Code
21443 status collapsed
21444
21445 \begin_layout Plain Layout
21446 HTMLForceCSS
21447 \end_layout
21448
21449 \end_inset
21450
21451  [
21452 \begin_inset Flex Code
21453 status collapsed
21454
21455 \begin_layout Plain Layout
21456
21457 \emph on
21458 0
21459 \emph default
21460 ,1
21461 \end_layout
21462
21463 \end_inset
21464
21465 ] Whether to output the default CSS information \SpecialChar LyX
21466  generates for this layout,
21467  even if additional information is explicitly provided via
21468 \begin_inset Flex Code
21469 status collapsed
21470
21471 \begin_layout Plain Layout
21472 HTMLStyle
21473 \end_layout
21474
21475 \end_inset
21476
21477 .
21478  Setting this to
21479 \begin_inset Flex Code
21480 status collapsed
21481
21482 \begin_layout Plain Layout
21483 1
21484 \end_layout
21485
21486 \end_inset
21487
21488  allows you to alter or augment the generated CSS, rather than to override
21489  it completely.
21490  Default is
21491 \begin_inset Flex Code
21492 status collapsed
21493
21494 \begin_layout Plain Layout
21495 0
21496 \end_layout
21497
21498 \end_inset
21499
21500 .
21501 \end_layout
21502
21503 \begin_layout Description
21504 \begin_inset Flex Code
21505 status collapsed
21506
21507 \begin_layout Plain Layout
21508 HTMLItem
21509 \end_layout
21510
21511 \end_inset
21512
21513  [
21514 \begin_inset Flex Code
21515 status collapsed
21516
21517 \begin_layout Plain Layout
21518 string
21519 \end_layout
21520
21521 \end_inset
21522
21523 ] The tag to be used for individual paragraphs of environments, replacing
21524
21525 \begin_inset Flex Code
21526 status collapsed
21527
21528 \begin_layout Plain Layout
21529 itemtag
21530 \end_layout
21531
21532 \end_inset
21533
21534  in the examples above.
21535  Defaults to
21536 \begin_inset Flex Code
21537 status collapsed
21538
21539 \begin_layout Plain Layout
21540 div
21541 \end_layout
21542
21543 \end_inset
21544
21545 .
21546 \end_layout
21547
21548 \begin_layout Description
21549 \begin_inset Flex Code
21550 status collapsed
21551
21552 \begin_layout Plain Layout
21553 HTMLItemAttr
21554 \end_layout
21555
21556 \end_inset
21557
21558  [
21559 \begin_inset Flex Code
21560 status collapsed
21561
21562 \begin_layout Plain Layout
21563 string
21564 \end_layout
21565
21566 \end_inset
21567
21568 ] Attributes for the item tag.
21569  Defaults to
21570 \begin_inset Quotes eld
21571 \end_inset
21572
21573
21574 \begin_inset Flex Code
21575 status collapsed
21576
21577 \begin_layout Plain Layout
21578 class=`layoutname_item'
21579 \end_layout
21580
21581 \end_inset
21582
21583
21584 \begin_inset Quotes erd
21585 \end_inset
21586
21587 .
21588  This should
21589 \emph on
21590 not
21591 \emph default
21592  contain any style information.
21593  Use
21594 \begin_inset Flex Code
21595 status collapsed
21596
21597 \begin_layout Plain Layout
21598 HTMLStyle
21599 \end_layout
21600
21601 \end_inset
21602
21603  for that purpose.
21604 \end_layout
21605
21606 \begin_layout Description
21607 \begin_inset Flex Code
21608 status collapsed
21609
21610 \begin_layout Plain Layout
21611 HTMLLabel
21612 \end_layout
21613
21614 \end_inset
21615
21616  [
21617 \begin_inset Flex Code
21618 status collapsed
21619
21620 \begin_layout Plain Layout
21621 string
21622 \end_layout
21623
21624 \end_inset
21625
21626 ] The tag to be used for paragraph and item labels, replacing
21627 \begin_inset Flex Code
21628 status collapsed
21629
21630 \begin_layout Plain Layout
21631 labeltag
21632 \end_layout
21633
21634 \end_inset
21635
21636  in the examples above.
21637  Defaults to
21638 \begin_inset Flex Code
21639 status collapsed
21640
21641 \begin_layout Plain Layout
21642 span
21643 \end_layout
21644
21645 \end_inset
21646
21647 , unless
21648 \begin_inset Flex Code
21649 status collapsed
21650
21651 \begin_layout Plain Layout
21652 LabelType
21653 \end_layout
21654
21655 \end_inset
21656
21657  is either
21658 \begin_inset Flex Code
21659 status collapsed
21660
21661 \begin_layout Plain Layout
21662 Top_Environment
21663 \end_layout
21664
21665 \end_inset
21666
21667  or
21668 \begin_inset Flex Code
21669 status collapsed
21670
21671 \begin_layout Plain Layout
21672 Centered_Top_Environment
21673 \end_layout
21674
21675 \end_inset
21676
21677 , in which case it defaults to
21678 \begin_inset Flex Code
21679 status collapsed
21680
21681 \begin_layout Plain Layout
21682 div
21683 \end_layout
21684
21685 \end_inset
21686
21687 .
21688 \end_layout
21689
21690 \begin_layout Description
21691 \begin_inset Flex Code
21692 status collapsed
21693
21694 \begin_layout Plain Layout
21695 HTMLLabelAttr
21696 \end_layout
21697
21698 \end_inset
21699
21700  [
21701 \begin_inset Flex Code
21702 status collapsed
21703
21704 \begin_layout Plain Layout
21705 string
21706 \end_layout
21707
21708 \end_inset
21709
21710 ] Attributes for the label tag.
21711  Defaults to
21712 \begin_inset Quotes eld
21713 \end_inset
21714
21715
21716 \begin_inset Flex Code
21717 status collapsed
21718
21719 \begin_layout Plain Layout
21720 class=`layoutname_label'
21721 \end_layout
21722
21723 \end_inset
21724
21725
21726 \begin_inset Quotes erd
21727 \end_inset
21728
21729 .
21730  This should
21731 \emph on
21732 not
21733 \emph default
21734  contain any style information.
21735  Use
21736 \begin_inset Flex Code
21737 status collapsed
21738
21739 \begin_layout Plain Layout
21740 HTMLStyle
21741 \end_layout
21742
21743 \end_inset
21744
21745  for that purpose.
21746 \end_layout
21747
21748 \begin_layout Description
21749 \begin_inset Flex Code
21750 status collapsed
21751
21752 \begin_layout Plain Layout
21753 HTMLLabelFirst
21754 \end_layout
21755
21756 \end_inset
21757
21758  [
21759 \begin_inset Flex Code
21760 status collapsed
21761
21762 \begin_layout Plain Layout
21763
21764 \emph on
21765 0
21766 \emph default
21767 ,1
21768 \end_layout
21769
21770 \end_inset
21771
21772 ] Meaningful only for list-like environments, this tag controls whether
21773  the label tag is output before or inside the item tag.
21774  This is used, for example, in the description environment, where we want
21775  `
21776 \begin_inset Flex Code
21777 status collapsed
21778
21779 \begin_layout Plain Layout
21780 <dt>\SpecialChar ldots
21781 </dt><dd>\SpecialChar ldots
21782 </dd>
21783 \end_layout
21784
21785 \end_inset
21786
21787 .
21788  Default is
21789 \begin_inset Flex Code
21790 status collapsed
21791
21792 \begin_layout Plain Layout
21793 0
21794 \end_layout
21795
21796 \end_inset
21797
21798 : The label tag is output inside the item tag.
21799 \end_layout
21800
21801 \begin_layout Description
21802 \begin_inset Flex Code
21803 status collapsed
21804
21805 \begin_layout Plain Layout
21806 HTMLPreamble
21807 \end_layout
21808
21809 \end_inset
21810
21811  Information to be output in the
21812 \begin_inset Flex Code
21813 status collapsed
21814
21815 \begin_layout Plain Layout
21816 <head>
21817 \end_layout
21818
21819 \end_inset
21820
21821  section when this style is used.
21822  This might, for example, be used to include a
21823 \begin_inset Flex Code
21824 status collapsed
21825
21826 \begin_layout Plain Layout
21827 <script>
21828 \end_layout
21829
21830 \end_inset
21831
21832  block defining an
21833 \begin_inset Flex Code
21834 status collapsed
21835
21836 \begin_layout Plain Layout
21837 onclick
21838 \end_layout
21839
21840 \end_inset
21841
21842  handler.
21843 \end_layout
21844
21845 \begin_layout Description
21846 \begin_inset Flex Code
21847 status collapsed
21848
21849 \begin_layout Plain Layout
21850 HTMLStyle
21851 \end_layout
21852
21853 \end_inset
21854
21855  CSS style information to be included when this style is used.
21856  Note that this will automatically be wrapped in a layout-generated
21857 \begin_inset Flex Code
21858 status collapsed
21859
21860 \begin_layout Plain Layout
21861 <style>
21862 \end_layout
21863
21864 \end_inset
21865
21866  block, so only the CSS itself need be included.
21867  Must end with
21868 \begin_inset Flex Code
21869 status collapsed
21870
21871 \begin_layout Plain Layout
21872 EndHTMLStyle
21873 \end_layout
21874
21875 \end_inset
21876
21877 .
21878 \end_layout
21879
21880 \begin_layout Description
21881 \begin_inset Flex Code
21882 status collapsed
21883
21884 \begin_layout Plain Layout
21885 HTMLTag
21886 \end_layout
21887
21888 \end_inset
21889
21890  [
21891 \begin_inset Flex Code
21892 status collapsed
21893
21894 \begin_layout Plain Layout
21895 string
21896 \end_layout
21897
21898 \end_inset
21899
21900 ] The tag to be used for the main label, replacing
21901 \begin_inset Flex Code
21902 status collapsed
21903
21904 \begin_layout Plain Layout
21905 tag
21906 \end_layout
21907
21908 \end_inset
21909
21910  in the examples above.
21911  Defaults to
21912 \begin_inset Flex Code
21913 status collapsed
21914
21915 \begin_layout Plain Layout
21916 div
21917 \end_layout
21918
21919 \end_inset
21920
21921 .
21922 \end_layout
21923
21924 \begin_layout Description
21925 \begin_inset Flex Code
21926 status collapsed
21927
21928 \begin_layout Plain Layout
21929 HTMLTitle
21930 \end_layout
21931
21932 \end_inset
21933
21934  [
21935 \begin_inset Flex Code
21936 status collapsed
21937
21938 \begin_layout Plain Layout
21939
21940 \emph on
21941 0
21942 \emph default
21943 ,1
21944 \end_layout
21945
21946 \end_inset
21947
21948 ] Marks this style as the one to be used to generate the
21949 \begin_inset Flex Code
21950 status collapsed
21951
21952 \begin_layout Plain Layout
21953 <title>
21954 \end_layout
21955
21956 \end_inset
21957
21958  tag for the XHTML file.
21959  By default, it is false.
21960  The
21961 \begin_inset Flex Code
21962 status collapsed
21963
21964 \begin_layout Plain Layout
21965 stdtitle.inc
21966 \end_layout
21967
21968 \end_inset
21969
21970  file sets it to true for the
21971 \begin_inset Flex Code
21972 status collapsed
21973
21974 \begin_layout Plain Layout
21975 title
21976 \end_layout
21977
21978 \end_inset
21979
21980  environment.
21981
21982 \end_layout
21983
21984 \begin_layout Subsection
21985 InsetLayout XHTML
21986 \end_layout
21987
21988 \begin_layout Standard
21989 The XHTML output of insets can also be controlled by information in layout
21990  files.
21991 \begin_inset Foot
21992 status collapsed
21993
21994 \begin_layout Plain Layout
21995 At present, this is true only for
21996 \begin_inset Quotes eld
21997 \end_inset
21998
21999 text
22000 \begin_inset Quotes erd
22001 \end_inset
22002
22003  insets (insets you can type into) and is not true for
22004 \begin_inset Quotes eld
22005 \end_inset
22006
22007 command
22008 \begin_inset Quotes erd
22009 \end_inset
22010
22011  insets (insets that are associated with dialog boxes).
22012 \end_layout
22013
22014 \end_inset
22015
22016  Here, too, \SpecialChar LyX
22017  tries to provide sensible defaults, and it constructs default
22018  CSS style rules.
22019  But everything can be customized.
22020 \end_layout
22021
22022 \begin_layout Standard
22023 The XHTML \SpecialChar LyX
22024  outputs for an inset has the following form:
22025 \end_layout
22026
22027 \begin_layout LyX-Code
22028 <tag attr=
22029 \begin_inset Quotes erd
22030 \end_inset
22031
22032 value
22033 \begin_inset Quotes erd
22034 \end_inset
22035
22036 >
22037 \end_layout
22038
22039 \begin_layout LyX-Code
22040 <labeltag>Label</labeltag>
22041 \end_layout
22042
22043 \begin_layout LyX-Code
22044 <innertag attr=
22045 \begin_inset Quotes erd
22046 \end_inset
22047
22048 value
22049 \begin_inset Quotes erd
22050 \end_inset
22051
22052 >Contents of the inset.</innertag>
22053 \end_layout
22054
22055 \begin_layout LyX-Code
22056 </tag>
22057 \end_layout
22058
22059 \begin_layout Standard
22060 If the inset permits multiple paragraphs—that is, if
22061 \begin_inset Flex Code
22062 status collapsed
22063
22064 \begin_layout Plain Layout
22065 MultiPar
22066 \end_layout
22067
22068 \end_inset
22069
22070  is true—then the contents of the inset will itself be output as paragraphs
22071  formatted according to the styles used for those paragraphs (standard,
22072  quote, and the like).
22073  The label tag is of course omitted if the paragraph does not have a label
22074  and, at present, is always
22075 \begin_inset Flex Code
22076 status collapsed
22077
22078 \begin_layout Plain Layout
22079 span
22080 \end_layout
22081
22082 \end_inset
22083
22084 .
22085  The inner tag is optional and, by default, does not appear.
22086 \end_layout
22087
22088 \begin_layout Standard
22089 The specific tags and attributes output for each inset can be controlled
22090  by means of the following layout tags.
22091 \end_layout
22092
22093 \begin_layout Description
22094 \begin_inset Flex Code
22095 status collapsed
22096
22097 \begin_layout Plain Layout
22098 HTMLAttr
22099 \end_layout
22100
22101 \end_inset
22102
22103  [
22104 \begin_inset Flex Code
22105 status collapsed
22106
22107 \begin_layout Plain Layout
22108 string
22109 \end_layout
22110
22111 \end_inset
22112
22113 ] Specifies attribute information to be output with the main tag.
22114  For example,
22115 \begin_inset Quotes eld
22116 \end_inset
22117
22118
22119 \begin_inset Flex Code
22120 status collapsed
22121
22122 \begin_layout Plain Layout
22123 class=`myinset' onclick=`\SpecialChar ldots
22124 '
22125 \end_layout
22126
22127 \end_inset
22128
22129
22130 \begin_inset Quotes erd
22131 \end_inset
22132
22133 .
22134  By default, \SpecialChar LyX
22135  will output
22136 \begin_inset Quotes eld
22137 \end_inset
22138
22139
22140 \begin_inset Flex Code
22141 status collapsed
22142
22143 \begin_layout Plain Layout
22144 class=`insetname'
22145 \end_layout
22146
22147 \end_inset
22148
22149
22150 \begin_inset Quotes erd
22151 \end_inset
22152
22153 , where
22154 \begin_inset Flex Code
22155 status collapsed
22156
22157 \begin_layout Plain Layout
22158 insetname
22159 \end_layout
22160
22161 \end_inset
22162
22163  is the \SpecialChar LyX
22164  name of the inset, made lowercase and with non-alphanumeric characters
22165  converted to underscores, for example: footnote.
22166 \end_layout
22167
22168 \begin_layout Description
22169 \begin_inset Flex Code
22170 status collapsed
22171
22172 \begin_layout Plain Layout
22173 HTMLForceCSS
22174 \end_layout
22175
22176 \end_inset
22177
22178  [
22179 \begin_inset Flex Code
22180 status collapsed
22181
22182 \begin_layout Plain Layout
22183
22184 \emph on
22185 0
22186 \emph default
22187 ,1
22188 \end_layout
22189
22190 \end_inset
22191
22192 ] Whether to output the default CSS information \SpecialChar LyX
22193  generates for this layout,
22194  even if additional information is explicitly provided via
22195 \begin_inset Flex Code
22196 status collapsed
22197
22198 \begin_layout Plain Layout
22199 HTMLStyle
22200 \end_layout
22201
22202 \end_inset
22203
22204 .
22205  Setting this to
22206 \begin_inset Flex Code
22207 status collapsed
22208
22209 \begin_layout Plain Layout
22210 1
22211 \end_layout
22212
22213 \end_inset
22214
22215  allows you to alter or augment the generated CSS, rather than to override
22216  it completely.
22217  Default is 0.
22218 \end_layout
22219
22220 \begin_layout Description
22221 \begin_inset Flex Code
22222 status collapsed
22223
22224 \begin_layout Plain Layout
22225 HTMLInnerAttr
22226 \end_layout
22227
22228 \end_inset
22229
22230  [
22231 \begin_inset Flex Code
22232 status collapsed
22233
22234 \begin_layout Plain Layout
22235 string
22236 \end_layout
22237
22238 \end_inset
22239
22240 ] Attributes for the inner tag.
22241  Defaults to
22242 \begin_inset Quotes eld
22243 \end_inset
22244
22245
22246 \begin_inset Flex Code
22247 status collapsed
22248
22249 \begin_layout Plain Layout
22250 class=`insetname_inner'
22251 \end_layout
22252
22253 \end_inset
22254
22255
22256 \begin_inset Quotes erd
22257 \end_inset
22258
22259 .
22260 \end_layout
22261
22262 \begin_layout Description
22263 \begin_inset Flex Code
22264 status collapsed
22265
22266 \begin_layout Plain Layout
22267 HTMLInnerTag
22268 \end_layout
22269
22270 \end_inset
22271
22272  [
22273 \begin_inset Flex Code
22274 status collapsed
22275
22276 \begin_layout Plain Layout
22277 string
22278 \end_layout
22279
22280 \end_inset
22281
22282 ] The inner tag, replacing
22283 \begin_inset Flex Code
22284 status collapsed
22285
22286 \begin_layout Plain Layout
22287 innertag
22288 \end_layout
22289
22290 \end_inset
22291
22292  in the examples above.
22293  By default, there is none.
22294 \end_layout
22295
22296 \begin_layout Description
22297 \begin_inset Flex Code
22298 status collapsed
22299
22300 \begin_layout Plain Layout
22301 HTMLIsBlock
22302 \end_layout
22303
22304 \end_inset
22305
22306  [
22307 \begin_inset Flex Code
22308 status collapsed
22309
22310 \begin_layout Plain Layout
22311 0,
22312 \emph on
22313 1
22314 \end_layout
22315
22316 \end_inset
22317
22318 ] Whether this inset represents a standalone block of text (such as a footnote)
22319  or instead represents material that is included in the surrounding text
22320  (such as a branch).
22321  Defaults to 1.
22322 \end_layout
22323
22324 \begin_layout Description
22325 \begin_inset Flex Code
22326 status collapsed
22327
22328 \begin_layout Plain Layout
22329 HTMLLabel
22330 \end_layout
22331
22332 \end_inset
22333
22334  [
22335 \begin_inset Flex Code
22336 status collapsed
22337
22338 \begin_layout Plain Layout
22339 string
22340 \end_layout
22341
22342 \end_inset
22343
22344 ] A label for this inset, possibly including a reference to a counter.
22345  For example, for footnote, it might be:
22346 \begin_inset Flex Code
22347 status collapsed
22348
22349 \begin_layout Plain Layout
22350
22351 \backslash
22352 arabic{footnote}
22353 \end_layout
22354
22355 \end_inset
22356
22357 .
22358  This is optional, and there is no default.
22359 \end_layout
22360
22361 \begin_layout Description
22362 \begin_inset Flex Code
22363 status collapsed
22364
22365 \begin_layout Plain Layout
22366 HTMLPreamble
22367 \end_layout
22368
22369 \end_inset
22370
22371  Information to be output in the
22372 \begin_inset Flex Code
22373 status collapsed
22374
22375 \begin_layout Plain Layout
22376 <head>
22377 \end_layout
22378
22379 \end_inset
22380
22381  section when this style is used.
22382  This might, for example, be used to include a
22383 \begin_inset Flex Code
22384 status collapsed
22385
22386 \begin_layout Plain Layout
22387 <script>
22388 \end_layout
22389
22390 \end_inset
22391
22392  block defining an
22393 \begin_inset Flex Code
22394 status collapsed
22395
22396 \begin_layout Plain Layout
22397 onclick
22398 \end_layout
22399
22400 \end_inset
22401
22402  handler.
22403 \end_layout
22404
22405 \begin_layout Description
22406 \begin_inset Flex Code
22407 status collapsed
22408
22409 \begin_layout Plain Layout
22410 HTMLStyle
22411 \end_layout
22412
22413 \end_inset
22414
22415  CSS style information to be included when this style is used.
22416  Note that this will automatically be wrapped in a layout-generated
22417 \begin_inset Flex Code
22418 status collapsed
22419
22420 \begin_layout Plain Layout
22421 <style>
22422 \end_layout
22423
22424 \end_inset
22425
22426  block, so only the CSS itself need be included.
22427 \end_layout
22428
22429 \begin_layout Description
22430 \begin_inset Flex Code
22431 status collapsed
22432
22433 \begin_layout Plain Layout
22434 HTMLTag
22435 \end_layout
22436
22437 \end_inset
22438
22439  [
22440 \begin_inset Flex Code
22441 status collapsed
22442
22443 \begin_layout Plain Layout
22444 string
22445 \end_layout
22446
22447 \end_inset
22448
22449 ] The tag to be used for the main label, replacing
22450 \begin_inset Flex Code
22451 status collapsed
22452
22453 \begin_layout Plain Layout
22454 tag
22455 \end_layout
22456
22457 \end_inset
22458
22459  in the examples above.
22460  The default depends upon the setting of
22461 \begin_inset Flex Code
22462 status collapsed
22463
22464 \begin_layout Plain Layout
22465 MultiPar
22466 \end_layout
22467
22468 \end_inset
22469
22470 : If
22471 \begin_inset Flex Code
22472 status collapsed
22473
22474 \begin_layout Plain Layout
22475 MultiPar
22476 \end_layout
22477
22478 \end_inset
22479
22480  is true, the default is
22481 \begin_inset Flex Code
22482 status collapsed
22483
22484 \begin_layout Plain Layout
22485 div
22486 \end_layout
22487
22488 \end_inset
22489
22490 ; if it is false, the default is
22491 \begin_inset Flex Code
22492 status collapsed
22493
22494 \begin_layout Plain Layout
22495 span
22496 \end_layout
22497
22498 \end_inset
22499
22500 .
22501 \end_layout
22502
22503 \begin_layout Subsection
22504 Float XHTML
22505 \end_layout
22506
22507 \begin_layout Standard
22508 The XHTML output for floats too can be controlled by layout information.
22509  The output has the following form:
22510 \end_layout
22511
22512 \begin_layout LyX-Code
22513 <tag attr=
22514 \begin_inset Quotes erd
22515 \end_inset
22516
22517 value
22518 \begin_inset Quotes erd
22519 \end_inset
22520
22521 >
22522 \end_layout
22523
22524 \begin_layout LyX-Code
22525 Contents of the float.
22526 \end_layout
22527
22528 \begin_layout LyX-Code
22529 </tag>
22530 \end_layout
22531
22532 \begin_layout Standard
22533 The caption, if there is one, is a separate inset and will be output as
22534  such.
22535  Its appearance can be controlled via the InsetLayout for caption insets.
22536
22537 \end_layout
22538
22539 \begin_layout Description
22540 \begin_inset Flex Code
22541 status collapsed
22542
22543 \begin_layout Plain Layout
22544 HTMLAttr
22545 \end_layout
22546
22547 \end_inset
22548
22549  [
22550 \begin_inset Flex Code
22551 status collapsed
22552
22553 \begin_layout Plain Layout
22554 string
22555 \end_layout
22556
22557 \end_inset
22558
22559 ] Specifies attribute information to be output with the main tag.
22560  For example,
22561 \begin_inset Quotes eld
22562 \end_inset
22563
22564
22565 \begin_inset Flex Code
22566 status collapsed
22567
22568 \begin_layout Plain Layout
22569 class=`myfloat' onclick=`\SpecialChar ldots
22570 '
22571 \end_layout
22572
22573 \end_inset
22574
22575
22576 \begin_inset Quotes erd
22577 \end_inset
22578
22579 .
22580  By default, \SpecialChar LyX
22581  will output
22582 \begin_inset Quotes eld
22583 \end_inset
22584
22585
22586 \begin_inset Flex Code
22587 status collapsed
22588
22589 \begin_layout Plain Layout
22590 class=`float float-floattype'
22591 \end_layout
22592
22593 \end_inset
22594
22595
22596 \begin_inset Quotes erd
22597 \end_inset
22598
22599 , where
22600 \begin_inset Flex Code
22601 status collapsed
22602
22603 \begin_layout Plain Layout
22604 floattype
22605 \end_layout
22606
22607 \end_inset
22608
22609  is \SpecialChar LyX
22610 's name for this type of float, as determined by the float declaration
22611  (see
22612 \begin_inset CommandInset ref
22613 LatexCommand ref
22614 reference "subsec:Floats"
22615
22616 \end_inset
22617
22618 ), though made lowercase and with non-alphanumeric characters converted
22619  to underscores, for example: float-table.
22620 \end_layout
22621
22622 \begin_layout Description
22623 \begin_inset Flex Code
22624 status collapsed
22625
22626 \begin_layout Plain Layout
22627 HTMLStyle
22628 \end_layout
22629
22630 \end_inset
22631
22632  CSS style information to be included when this float is used.
22633  Note that this will automatically be wrapped in a layout-generated
22634 \begin_inset Flex Code
22635 status collapsed
22636
22637 \begin_layout Plain Layout
22638 <style>
22639 \end_layout
22640
22641 \end_inset
22642
22643  block, so only the CSS itself need be included.
22644 \end_layout
22645
22646 \begin_layout Description
22647 \begin_inset Flex Code
22648 status collapsed
22649
22650 \begin_layout Plain Layout
22651 HTMLTag
22652 \end_layout
22653
22654 \end_inset
22655
22656  [
22657 \begin_inset Flex Code
22658 status collapsed
22659
22660 \begin_layout Plain Layout
22661 string
22662 \end_layout
22663
22664 \end_inset
22665
22666 ] The tag to be used for this float, replacing
22667 \begin_inset Quotes eld
22668 \end_inset
22669
22670
22671 \begin_inset Flex Code
22672 status collapsed
22673
22674 \begin_layout Plain Layout
22675 tag
22676 \end_layout
22677
22678 \end_inset
22679
22680
22681 \begin_inset Quotes erd
22682 \end_inset
22683
22684  in the example above.
22685  The default is
22686 \begin_inset Flex Code
22687 status collapsed
22688
22689 \begin_layout Plain Layout
22690 div
22691 \end_layout
22692
22693 \end_inset
22694
22695  and will rarely need changing.
22696 \end_layout
22697
22698 \begin_layout Subsection
22699 Bibliography formatting
22700 \end_layout
22701
22702 \begin_layout Standard
22703 The bibliography can be formatted using
22704 \begin_inset Flex Code
22705 status collapsed
22706
22707 \begin_layout Plain Layout
22708 CiteFormat
22709 \end_layout
22710
22711 \end_inset
22712
22713  blocks.
22714  See
22715 \begin_inset CommandInset ref
22716 LatexCommand ref
22717 reference "subsec:Citation-format-description"
22718
22719 \end_inset
22720
22721  for the details.
22722 \end_layout
22723
22724 \begin_layout Subsection
22725 \SpecialChar LyX
22726 -generated CSS
22727 \end_layout
22728
22729 \begin_layout Standard
22730 We have several times mentioned that \SpecialChar LyX
22731  will generate default CSS style rules
22732  for both insets and paragraph styles, based upon the other layout information
22733  that is provided.
22734  In this section, we shall say a word about which layout information \SpecialChar LyX
22735  uses
22736  and how.
22737 \end_layout
22738
22739 \begin_layout Standard
22740 At present, \SpecialChar LyX
22741  auto-generates CSS only for font information, making use of
22742  the
22743 \begin_inset Flex Code
22744 status collapsed
22745
22746 \begin_layout Plain Layout
22747 Family
22748 \end_layout
22749
22750 \end_inset
22751
22752 ,
22753 \begin_inset Flex Code
22754 status collapsed
22755
22756 \begin_layout Plain Layout
22757 Series
22758 \end_layout
22759
22760 \end_inset
22761
22762 ,
22763 \begin_inset Flex Code
22764 status collapsed
22765
22766 \begin_layout Plain Layout
22767 Shape
22768 \end_layout
22769
22770 \end_inset
22771
22772 , and
22773 \begin_inset Flex Code
22774 status collapsed
22775
22776 \begin_layout Plain Layout
22777 Size
22778 \end_layout
22779
22780 \end_inset
22781
22782  specified in the
22783 \begin_inset Flex Code
22784 status collapsed
22785
22786 \begin_layout Plain Layout
22787 Font
22788 \end_layout
22789
22790 \end_inset
22791
22792  declaration (see
22793 \begin_inset CommandInset ref
22794 LatexCommand ref
22795 reference "subsec:Font-description"
22796
22797 \end_inset
22798
22799 ).
22800  The translation is mostly straightforward and obvious.
22801  For example,
22802 \begin_inset Quotes eld
22803 \end_inset
22804
22805
22806 \begin_inset Flex Code
22807 status collapsed
22808
22809 \begin_layout Plain Layout
22810 Family Sans
22811 \end_layout
22812
22813 \end_inset
22814
22815
22816 \begin_inset Quotes erd
22817 \end_inset
22818
22819  becomes
22820 \begin_inset Quotes eld
22821 \end_inset
22822
22823
22824 \begin_inset Flex Code
22825 status collapsed
22826
22827 \begin_layout Plain Layout
22828 font-family: sans-serif;
22829 \end_layout
22830
22831 \end_inset
22832
22833
22834 \begin_inset Quotes erd
22835 \end_inset
22836
22837 .
22838  The correspondence of \SpecialChar LyX
22839  sizes and CSS sizes is a little less obvious but
22840  nonetheless intuitive.
22841  See the
22842 \begin_inset Flex Code
22843 status collapsed
22844
22845 \begin_layout Plain Layout
22846 getSizeCSS()
22847 \end_layout
22848
22849 \end_inset
22850
22851  function in
22852 \begin_inset Flex URL
22853 status collapsed
22854
22855 \begin_layout Plain Layout
22856
22857 src/FontInfo.cpp
22858 \end_layout
22859
22860 \end_inset
22861
22862  for the details.
22863 \end_layout
22864
22865 \begin_layout Chapter
22866 Including External Material
22867 \begin_inset CommandInset label
22868 LatexCommand label
22869 name "chap:Including-External-Material"
22870
22871 \end_inset
22872
22873
22874 \end_layout
22875
22876 \begin_layout Standard
22877 \begin_inset Box Shadowbox
22878 position "t"
22879 hor_pos "c"
22880 has_inner_box 1
22881 inner_pos "t"
22882 use_parbox 0
22883 use_makebox 0
22884 width "100col%"
22885 special "none"
22886 height "1in"
22887 height_special "totalheight"
22888 thickness "0.4pt"
22889 separation "3pt"
22890 shadowsize "4pt"
22891 framecolor "black"
22892 backgroundcolor "none"
22893 status open
22894
22895 \begin_layout Plain Layout
22896 WARNING: This portion of the documentation has not been updated for some
22897  time.
22898  We certainly hope that it is still accurate, but there are no guarantees.
22899 \end_layout
22900
22901 \end_inset
22902
22903
22904 \end_layout
22905
22906 \begin_layout Standard
22907 The use of material from sources external to \SpecialChar LyX
22908  is covered in detail in the
22909
22910 \emph on
22911 Embedded Objects
22912 \emph default
22913  manual.
22914  This part of the manual covers what needs to happen behind the scenes for
22915  new sorts of material to be included.
22916 \end_layout
22917
22918 \begin_layout Section
22919 How does it work?
22920 \end_layout
22921
22922 \begin_layout Standard
22923 The external material feature is based on the concept of a
22924 \emph on
22925 template
22926 \emph default
22927 .
22928  A template is a specification of how \SpecialChar LyX
22929  should interface with a certain kind
22930  of material.
22931  As bundled, \SpecialChar LyX
22932  comes with predefined templates for Xfig figures, various
22933  raster format images, chess diagrams, and LilyPond music notation.
22934  You can check the actual list by using the menu
22935 \begin_inset Flex Noun
22936 status collapsed
22937
22938 \begin_layout Plain Layout
22939 Insert\SpecialChar menuseparator
22940 File\SpecialChar menuseparator
22941 External Material
22942 \end_layout
22943
22944 \end_inset
22945
22946 .
22947  Furthermore, it is possible to roll your own template to support a specific
22948  kind of material.
22949  Later we'll describe in more detail what is involved, and hopefully you
22950  will submit all the templates you create so we can include them in a later
22951  \SpecialChar LyX
22952  version.
22953 \end_layout
22954
22955 \begin_layout Standard
22956 Another basic idea of the external material feature is to distinguish between
22957  the original file that serves as a base for final material and the produced
22958  file that is included in your exported or printed document.
22959  For example, consider the case of a figure produced with
22960 \begin_inset Flex Code
22961 status collapsed
22962
22963 \begin_layout Plain Layout
22964 Xfig
22965 \end_layout
22966
22967 \end_inset
22968
22969 .
22970  The Xfig application itself works on an original file with the
22971 \begin_inset Flex Code
22972 status collapsed
22973
22974 \begin_layout Plain Layout
22975 .fig
22976 \end_layout
22977
22978 \end_inset
22979
22980  extension.
22981  Within Xfig, you create and change your figure, and when you are done,
22982  you save the
22983 \begin_inset Flex Code
22984 status collapsed
22985
22986 \begin_layout Plain Layout
22987 fig
22988 \end_layout
22989
22990 \end_inset
22991
22992 -file.
22993  When you want to include the figure in your document, you invoke
22994 \begin_inset Flex Code
22995 status collapsed
22996
22997 \begin_layout Plain Layout
22998 transfig
22999 \end_layout
23000
23001 \end_inset
23002
23003  in order to create a PostScript file that can readily be included in your
23004  \SpecialChar LaTeX
23005  file.
23006  In this case, the
23007 \begin_inset Flex Code
23008 status collapsed
23009
23010 \begin_layout Plain Layout
23011 .fig
23012 \end_layout
23013
23014 \end_inset
23015
23016  file is the original file, and the PostScript file is the produced file.
23017 \end_layout
23018
23019 \begin_layout Standard
23020 This distinction is important in order to allow updating of the material
23021  while you are in the process of writing the document.
23022  Furthermore, it provides us with the flexibility that is needed to support
23023  multiple export formats.
23024  For instance, in the case of a plain text file, it is not exactly an award-winn
23025 ing idea to include the figure as raw PostScript.
23026  Instead, you would either prefer to just include a reference to the figure
23027  or try to invoke some graphics to ASCII converter to make the final result
23028  look similar to the real graphics.
23029  The external material management allows you to do this, because it is parametri
23030 zed on the different export formats that \SpecialChar LyX
23031  supports.
23032 \end_layout
23033
23034 \begin_layout Standard
23035 Besides supporting the production of different products according to the
23036  exported format, it supports tight integration with editing and viewing
23037  applications.
23038  In the case of an Xfig figure, you are able to invoke Xfig on the original
23039  file with a single click from within the external material dialog in \SpecialChar LyX
23040 ,
23041  and also preview the produced PostScript file with Ghostview with another
23042  click.
23043  No more fiddling around with the command line and/or file browsers to locate
23044  and manipulate the original or produced files.
23045  In this way, you are finally able to take full advantage of the many different
23046  applications that are relevant to use when you write your documents, and
23047  ultimately be more productive.
23048 \end_layout
23049
23050 \begin_layout Section
23051 The external template configuration file
23052 \end_layout
23053
23054 \begin_layout Standard
23055 It is relatively easy to add custom external template definitions to \SpecialChar LyX
23056 .
23057  However, be aware that doing this in an careless manner most probably
23058 \emph on
23059 will
23060 \emph default
23061  introduce an easily exploitable security hole.
23062  So before you do this, please read the discussion about security in
23063 \begin_inset CommandInset ref
23064 LatexCommand ref
23065 reference "sec:Security-discussion"
23066
23067 \end_inset
23068
23069 .
23070 \end_layout
23071
23072 \begin_layout Standard
23073 Having said that, we encourage you to submit any interesting templates that
23074  you create.
23075
23076 \end_layout
23077
23078 \begin_layout Standard
23079 The external templates are defined in the
23080 \begin_inset Flex Code
23081 status collapsed
23082
23083 \begin_layout Plain Layout
23084 LyXDir/lib/external_templates
23085 \end_layout
23086
23087 \end_inset
23088
23089  file.
23090  You can place your own version in
23091 \begin_inset Flex Code
23092 status collapsed
23093
23094 \begin_layout Plain Layout
23095 UserDir/external_templates
23096 \end_layout
23097
23098 \end_inset
23099
23100 .
23101 \end_layout
23102
23103 \begin_layout Standard
23104 A typical template looks like this:
23105 \end_layout
23106
23107 \begin_layout LyX-Code
23108 Template XFig
23109 \end_layout
23110
23111 \begin_layout LyX-Code
23112 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
23113 \end_layout
23114
23115 \begin_layout LyX-Code
23116 HelpText
23117 \end_layout
23118
23119 \begin_layout LyX-Code
23120 An XFig figure.
23121 \end_layout
23122
23123 \begin_layout LyX-Code
23124 HelpTextEnd
23125 \end_layout
23126
23127 \begin_layout LyX-Code
23128 InputFormat fig
23129 \end_layout
23130
23131 \begin_layout LyX-Code
23132 FileFilter "*.fig"
23133 \end_layout
23134
23135 \begin_layout LyX-Code
23136 AutomaticProduction true
23137 \end_layout
23138
23139 \begin_layout LyX-Code
23140 Transform Rotate
23141 \end_layout
23142
23143 \begin_layout LyX-Code
23144 Transform Resize
23145 \end_layout
23146
23147 \begin_layout LyX-Code
23148 Format LaTeX
23149 \end_layout
23150
23151 \begin_layout LyX-Code
23152 TransformCommand Rotate RotationLatexCommand
23153 \end_layout
23154
23155 \begin_layout LyX-Code
23156 TransformCommand Resize ResizeLatexCommand
23157 \end_layout
23158
23159 \begin_layout LyX-Code
23160 Product "$$RotateFront$$ResizeFront
23161 \end_layout
23162
23163 \begin_layout LyX-Code
23164
23165 \backslash
23166
23167 \backslash
23168 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
23169 \end_layout
23170
23171 \begin_layout LyX-Code
23172          $$ResizeBack$$RotateBack"
23173 \end_layout
23174
23175 \begin_layout LyX-Code
23176 UpdateFormat pstex
23177 \end_layout
23178
23179 \begin_layout LyX-Code
23180 UpdateResult "$$AbsPath$$Basename.pstex_t"
23181 \end_layout
23182
23183 \begin_layout LyX-Code
23184 Requirement "graphicx"
23185 \end_layout
23186
23187 \begin_layout LyX-Code
23188 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
23189 \end_layout
23190
23191 \begin_layout LyX-Code
23192 ReferencedFile latex "$$AbsPath$$Basename.eps"
23193 \end_layout
23194
23195 \begin_layout LyX-Code
23196 ReferencedFile dvi "$$AbsPath$$Basename.eps"
23197 \end_layout
23198
23199 \begin_layout LyX-Code
23200 FormatEnd
23201 \end_layout
23202
23203 \begin_layout LyX-Code
23204 Format PDFLaTeX
23205 \end_layout
23206
23207 \begin_layout LyX-Code
23208 TransformCommand Rotate RotationLatexCommand
23209 \end_layout
23210
23211 \begin_layout LyX-Code
23212 TransformCommand Resize ResizeLatexCommand
23213 \end_layout
23214
23215 \begin_layout LyX-Code
23216 Product "$$RotateFront$$ResizeFront
23217 \end_layout
23218
23219 \begin_layout LyX-Code
23220
23221 \backslash
23222
23223 \backslash
23224 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
23225 \end_layout
23226
23227 \begin_layout LyX-Code
23228          $$ResizeBack$$RotateBack"
23229 \end_layout
23230
23231 \begin_layout LyX-Code
23232 UpdateFormat pdftex
23233 \end_layout
23234
23235 \begin_layout LyX-Code
23236 UpdateResult "$$AbsPath$$Basename.pdftex_t"
23237 \end_layout
23238
23239 \begin_layout LyX-Code
23240 Requirement "graphicx"
23241 \end_layout
23242
23243 \begin_layout LyX-Code
23244 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
23245 \end_layout
23246
23247 \begin_layout LyX-Code
23248 ReferencedFile latex "$$AbsPath$$Basename.pdf"
23249 \end_layout
23250
23251 \begin_layout LyX-Code
23252 FormatEnd
23253 \end_layout
23254
23255 \begin_layout LyX-Code
23256 Format Ascii
23257 \end_layout
23258
23259 \begin_layout LyX-Code
23260 Product "[XFig: $$FName]"
23261 \end_layout
23262
23263 \begin_layout LyX-Code
23264 FormatEnd
23265 \end_layout
23266
23267 \begin_layout LyX-Code
23268 Format DocBook
23269 \end_layout
23270
23271 \begin_layout LyX-Code
23272 Product "<graphic fileref=
23273 \backslash
23274 "$$AbsOrRelPathMaster$$Basename.eps
23275 \backslash
23276 ">
23277 \end_layout
23278
23279 \begin_layout LyX-Code
23280          </graphic>"
23281 \end_layout
23282
23283 \begin_layout LyX-Code
23284 UpdateFormat eps
23285 \end_layout
23286
23287 \begin_layout LyX-Code
23288 UpdateResult "$$AbsPath$$Basename.eps"
23289 \end_layout
23290
23291 \begin_layout LyX-Code
23292 ReferencedFile docbook "$$AbsPath$$Basename.eps"
23293 \end_layout
23294
23295 \begin_layout LyX-Code
23296 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
23297 \end_layout
23298
23299 \begin_layout LyX-Code
23300 FormatEnd
23301 \end_layout
23302
23303 \begin_layout LyX-Code
23304 TemplateEnd
23305 \end_layout
23306
23307 \begin_layout Standard
23308 As you can see, the template is enclosed in
23309 \begin_inset Flex Code
23310 status collapsed
23311
23312 \begin_layout Plain Layout
23313 Template
23314 \end_layout
23315
23316 \end_inset
23317
23318  \SpecialChar ldots
23319
23320 \begin_inset Flex Code
23321 status collapsed
23322
23323 \begin_layout Plain Layout
23324 TemplateEnd
23325 \end_layout
23326
23327 \end_inset
23328
23329 .
23330  It contains a header specifying some general settings and, for each supported
23331  primary document file format, a section
23332 \begin_inset Flex Code
23333 status collapsed
23334
23335 \begin_layout Plain Layout
23336 Format
23337 \end_layout
23338
23339 \end_inset
23340
23341  \SpecialChar ldots
23342
23343 \begin_inset Flex Code
23344 status collapsed
23345
23346 \begin_layout Plain Layout
23347 FormatEnd
23348 \end_layout
23349
23350 \end_inset
23351
23352 .
23353 \end_layout
23354
23355 \begin_layout Subsection
23356 The template header
23357 \end_layout
23358
23359 \begin_layout Description
23360 \begin_inset Flex Code
23361 status collapsed
23362
23363 \begin_layout Plain Layout
23364 AutomaticProduction
23365 \begin_inset space ~
23366 \end_inset
23367
23368 true|false
23369 \end_layout
23370
23371 \end_inset
23372
23373  Whether the file represented by the template must be generated by \SpecialChar LyX
23374 .
23375  This command must occur exactly once.
23376 \end_layout
23377
23378 \begin_layout Description
23379 \begin_inset Flex Code
23380 status collapsed
23381
23382 \begin_layout Plain Layout
23383 FileFilter
23384 \begin_inset space ~
23385 \end_inset
23386
23387 <pattern>
23388 \end_layout
23389
23390 \end_inset
23391
23392  A glob pattern that is used in the file dialog to filter out the desired
23393  files.
23394  If there is more than one possible file extension (e.
23395 \begin_inset space \thinspace{}
23396 \end_inset
23397
23398 g.
23399 \begin_inset space \space{}
23400 \end_inset
23401
23402 tgif has
23403 \begin_inset Flex Code
23404 status collapsed
23405
23406 \begin_layout Plain Layout
23407 .obj
23408 \end_layout
23409
23410 \end_inset
23411
23412  and
23413 \begin_inset Flex Code
23414 status collapsed
23415
23416 \begin_layout Plain Layout
23417 .tgo
23418 \end_layout
23419
23420 \end_inset
23421
23422 ), use something like
23423 \begin_inset Flex Code
23424 status collapsed
23425
23426 \begin_layout Plain Layout
23427 "*.{obj,tgo}"
23428 \end_layout
23429
23430 \end_inset
23431
23432 .
23433  This command must occur exactly once.
23434 \end_layout
23435
23436 \begin_layout Description
23437 \begin_inset Flex Code
23438 status collapsed
23439
23440 \begin_layout Plain Layout
23441 GuiName
23442 \begin_inset space ~
23443 \end_inset
23444
23445 <guiname>
23446 \end_layout
23447
23448 \end_inset
23449
23450  The text that is displayed on the button.
23451  This command must occur exactly once.
23452 \end_layout
23453
23454 \begin_layout Description
23455 \begin_inset Flex Code
23456 status collapsed
23457
23458 \begin_layout Plain Layout
23459 HelpText
23460 \begin_inset space ~
23461 \end_inset
23462
23463 <text>
23464 \begin_inset space ~
23465 \end_inset
23466
23467 HelpTextEnd
23468 \end_layout
23469
23470 \end_inset
23471
23472  The help text that is used in the External dialog.
23473  Provide enough information to explain to the user just what the template
23474  can provide him with.
23475  This command must occur exactly once.
23476 \end_layout
23477
23478 \begin_layout Description
23479 \begin_inset Flex Code
23480 status collapsed
23481
23482 \begin_layout Plain Layout
23483 InputFormat
23484 \begin_inset space ~
23485 \end_inset
23486
23487 <format>
23488 \end_layout
23489
23490 \end_inset
23491
23492  The file format of the original file.
23493  This must be the name of a format that is known to \SpecialChar LyX
23494  (see
23495 \begin_inset CommandInset ref
23496 LatexCommand ref
23497 reference "sec:Formats"
23498
23499 \end_inset
23500
23501 ).
23502  Use
23503 \begin_inset Quotes eld
23504 \end_inset
23505
23506
23507 \begin_inset Flex Code
23508 status collapsed
23509
23510 \begin_layout Plain Layout
23511 *
23512 \end_layout
23513
23514 \end_inset
23515
23516
23517 \begin_inset Quotes erd
23518 \end_inset
23519
23520  if the template can handle original files of more than one format.
23521  \SpecialChar LyX
23522  will attempt to interrogate the file itself in order to deduce its format
23523  in this case.
23524  This command must occur exactly once.
23525 \end_layout
23526
23527 \begin_layout Description
23528 \begin_inset Flex Code
23529 status collapsed
23530
23531 \begin_layout Plain Layout
23532 Template
23533 \begin_inset space ~
23534 \end_inset
23535
23536 <id>
23537 \end_layout
23538
23539 \end_inset
23540
23541  A unique name for the template.
23542  It must not contain substitution macros (see below).
23543 \end_layout
23544
23545 \begin_layout Description
23546 \begin_inset Flex Code
23547 status collapsed
23548
23549 \begin_layout Plain Layout
23550 Transform
23551 \begin_inset space ~
23552 \end_inset
23553
23554 Rotate|Resize|Clip|Extra
23555 \end_layout
23556
23557 \end_inset
23558
23559  This command specifies which transformations are supported by this template.
23560  It may occur zero or more times.
23561  This command enables the corresponding tabs in the external dialog.
23562  Each
23563 \begin_inset Flex Code
23564 status collapsed
23565
23566 \begin_layout Plain Layout
23567 Transform
23568 \end_layout
23569
23570 \end_inset
23571
23572  command must have either a corresponding
23573 \begin_inset Flex Code
23574 status collapsed
23575
23576 \begin_layout Plain Layout
23577 TransformCommand
23578 \end_layout
23579
23580 \end_inset
23581
23582  or a
23583 \begin_inset Flex Code
23584 status collapsed
23585
23586 \begin_layout Plain Layout
23587 TransformOption
23588 \end_layout
23589
23590 \end_inset
23591
23592  command in the
23593 \begin_inset Flex Code
23594 status collapsed
23595
23596 \begin_layout Plain Layout
23597 Format
23598 \end_layout
23599
23600 \end_inset
23601
23602  section.
23603  Otherwise the transformation will not be supported by that format.
23604 \end_layout
23605
23606 \begin_layout Subsection
23607 The Format section
23608 \end_layout
23609
23610 \begin_layout Description
23611 \begin_inset Flex Code
23612 status collapsed
23613
23614 \begin_layout Plain Layout
23615 Format
23616 \begin_inset space ~
23617 \end_inset
23618
23619 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
23620 \end_layout
23621
23622 \end_inset
23623
23624  The primary document file format that this format definition is for.
23625  Not every template has a sensible representation in all document file formats.
23626  Please define nevertheless a
23627 \begin_inset Flex Code
23628 status collapsed
23629
23630 \begin_layout Plain Layout
23631 Format
23632 \end_layout
23633
23634 \end_inset
23635
23636  section for all templates.
23637  Use a dummy text when no representation is available.
23638  Then you can at least see a reference to the external material in the exported
23639  document.
23640 \end_layout
23641
23642 \begin_layout Description
23643 \begin_inset Flex Code
23644 status collapsed
23645
23646 \begin_layout Plain Layout
23647 Option
23648 \begin_inset space ~
23649 \end_inset
23650
23651 <name>
23652 \begin_inset space ~
23653 \end_inset
23654
23655 <value>
23656 \end_layout
23657
23658 \end_inset
23659
23660  This command defines an additional macro
23661 \begin_inset Flex Code
23662 status collapsed
23663
23664 \begin_layout Plain Layout
23665 $$<name>
23666 \end_layout
23667
23668 \end_inset
23669
23670  for substitution in
23671 \begin_inset Flex Code
23672 status collapsed
23673
23674 \begin_layout Plain Layout
23675 Product
23676 \end_layout
23677
23678 \end_inset
23679
23680 .
23681
23682 \begin_inset Flex Code
23683 status collapsed
23684
23685 \begin_layout Plain Layout
23686 <value>
23687 \end_layout
23688
23689 \end_inset
23690
23691  itself may contain substitution macros.
23692  The advantage over using
23693 \begin_inset Flex Code
23694 status collapsed
23695
23696 \begin_layout Plain Layout
23697 <value>
23698 \end_layout
23699
23700 \end_inset
23701
23702  directly in
23703 \begin_inset Flex Code
23704 status collapsed
23705
23706 \begin_layout Plain Layout
23707 Product
23708 \end_layout
23709
23710 \end_inset
23711
23712  is that the substituted value of
23713 \begin_inset Flex Code
23714 status collapsed
23715
23716 \begin_layout Plain Layout
23717 $$<name>
23718 \end_layout
23719
23720 \end_inset
23721
23722  is sanitized so that it is a valid optional argument in the document format.
23723  This command may occur zero or more times.
23724 \end_layout
23725
23726 \begin_layout Description
23727 \begin_inset Flex Code
23728 status collapsed
23729
23730 \begin_layout Plain Layout
23731 Product
23732 \begin_inset space ~
23733 \end_inset
23734
23735 <text>
23736 \end_layout
23737
23738 \end_inset
23739
23740  The text that is inserted in the exported document.
23741  This is actually the most important command and can be quite complex.
23742  This command must occur exactly once.
23743 \end_layout
23744
23745 \begin_layout Description
23746 \begin_inset Flex Code
23747 status collapsed
23748
23749 \begin_layout Plain Layout
23750 Preamble
23751 \begin_inset space ~
23752 \end_inset
23753
23754 <name>
23755 \end_layout
23756
23757 \end_inset
23758
23759  This command specifies a preamble snippet that will be included in the
23760  \SpecialChar LaTeX
23761  preamble.
23762  It has to be defined using
23763 \begin_inset Flex Code
23764 status collapsed
23765
23766 \begin_layout Plain Layout
23767 PreambleDef
23768 \end_layout
23769
23770 \end_inset
23771
23772  \SpecialChar ldots
23773
23774 \begin_inset Flex Code
23775 status collapsed
23776
23777 \begin_layout Plain Layout
23778 PreambleDefEnd
23779 \end_layout
23780
23781 \end_inset
23782
23783 .
23784  This command may occur zero or more times.
23785 \end_layout
23786
23787 \begin_layout Description
23788 \begin_inset Flex Code
23789 status collapsed
23790
23791 \begin_layout Plain Layout
23792 ReferencedFile
23793 \begin_inset space ~
23794 \end_inset
23795
23796 <format>
23797 \begin_inset space ~
23798 \end_inset
23799
23800 <filename>
23801 \end_layout
23802
23803 \end_inset
23804
23805  This command denotes files that are created by the conversion process and
23806  are needed for a particular export format.
23807  If the filename is relative, it is interpreted relative to the master document.
23808  This command may be given zero or more times.
23809 \end_layout
23810
23811 \begin_layout Description
23812 \begin_inset Flex Code
23813 status collapsed
23814
23815 \begin_layout Plain Layout
23816 Requirement
23817 \begin_inset space ~
23818 \end_inset
23819
23820 <package>
23821 \end_layout
23822
23823 \end_inset
23824
23825  The name of a required \SpecialChar LaTeX
23826  package.
23827  The package is included via
23828 \begin_inset Flex Code
23829 status collapsed
23830
23831 \begin_layout Plain Layout
23832
23833 \backslash
23834 usepackage{}
23835 \end_layout
23836
23837 \end_inset
23838
23839  in the \SpecialChar LaTeX
23840  preamble.
23841  This command may occur zero or more times.
23842 \end_layout
23843
23844 \begin_layout Description
23845 \begin_inset Flex Code
23846 status collapsed
23847
23848 \begin_layout Plain Layout
23849 TransformCommand
23850 \begin_inset space ~
23851 \end_inset
23852
23853 Rotate
23854 \begin_inset space ~
23855 \end_inset
23856
23857 RotationLatexCommand
23858 \end_layout
23859
23860 \end_inset
23861
23862  This command specifies that the built in \SpecialChar LaTeX
23863  command should be used for rotation.
23864  This command may occur once or not at all.
23865 \end_layout
23866
23867 \begin_layout Description
23868 \begin_inset Flex Code
23869 status collapsed
23870
23871 \begin_layout Plain Layout
23872 TransformCommand
23873 \begin_inset space ~
23874 \end_inset
23875
23876 Resize
23877 \begin_inset space ~
23878 \end_inset
23879
23880 ResizeLatexCommand
23881 \end_layout
23882
23883 \end_inset
23884
23885  This command specifies that the built in \SpecialChar LaTeX
23886  command should be used for resizing.
23887  This command may occur once or not at all.
23888 \end_layout
23889
23890 \begin_layout Description
23891 \begin_inset Flex Code
23892 status collapsed
23893
23894 \begin_layout Plain Layout
23895 TransformOption
23896 \begin_inset space ~
23897 \end_inset
23898
23899 Rotate
23900 \begin_inset space ~
23901 \end_inset
23902
23903 RotationLatexOption
23904 \end_layout
23905
23906 \end_inset
23907
23908  This command specifies that rotation is done via an optional argument.
23909  This command may occur once or not at all.
23910 \end_layout
23911
23912 \begin_layout Description
23913 \begin_inset Flex Code
23914 status collapsed
23915
23916 \begin_layout Plain Layout
23917 TransformOption
23918 \begin_inset space ~
23919 \end_inset
23920
23921 Resize
23922 \begin_inset space ~
23923 \end_inset
23924
23925 ResizeLatexOption
23926 \end_layout
23927
23928 \end_inset
23929
23930  This command specifies that resizing is done via an optional argument.
23931  This command may occur once or not at all.
23932 \end_layout
23933
23934 \begin_layout Description
23935 \begin_inset Flex Code
23936 status collapsed
23937
23938 \begin_layout Plain Layout
23939 TransformOption
23940 \begin_inset space ~
23941 \end_inset
23942
23943 Clip
23944 \begin_inset space ~
23945 \end_inset
23946
23947 ClipLatexOption
23948 \end_layout
23949
23950 \end_inset
23951
23952  This command specifies that clipping is done via an optional argument.
23953  This command may occur once or not at all.
23954 \end_layout
23955
23956 \begin_layout Description
23957 \begin_inset Flex Code
23958 status collapsed
23959
23960 \begin_layout Plain Layout
23961 TransformOption
23962 \begin_inset space ~
23963 \end_inset
23964
23965 Extra
23966 \begin_inset space ~
23967 \end_inset
23968
23969 ExtraLatexOption
23970 \end_layout
23971
23972 \end_inset
23973
23974  This command specifies that an extra optional argument is used.
23975  This command may occur once or not at all.
23976 \end_layout
23977
23978 \begin_layout Description
23979 \begin_inset Flex Code
23980 status collapsed
23981
23982 \begin_layout Plain Layout
23983 UpdateFormat
23984 \begin_inset space ~
23985 \end_inset
23986
23987 <format>
23988 \end_layout
23989
23990 \end_inset
23991
23992  The file format of the converted file.
23993  This must be the name of a format that is known to \SpecialChar LyX
23994  (see the
23995 \begin_inset Flex Noun
23996 status collapsed
23997
23998 \begin_layout Plain Layout
23999 Tools\SpecialChar menuseparator
24000 Preferences\SpecialChar menuseparator
24001 File Handling\SpecialChar menuseparator
24002 File Format
24003 \end_layout
24004
24005 \end_inset
24006
24007  dialog).
24008  This command must occur exactly once.
24009  If the resulting file format is PDF, you need to specify the format
24010 \begin_inset Flex Code
24011 status collapsed
24012
24013 \begin_layout Plain Layout
24014 pdf6
24015 \end_layout
24016
24017 \end_inset
24018
24019 .
24020  This is the PDF format used for including graphics.
24021  The other defined PDF formats are for document export.
24022 \end_layout
24023
24024 \begin_layout Description
24025 \begin_inset Flex Code
24026 status collapsed
24027
24028 \begin_layout Plain Layout
24029 UpdateResult
24030 \begin_inset space ~
24031 \end_inset
24032
24033 <filename>
24034 \end_layout
24035
24036 \end_inset
24037
24038  The file name of the converted file.
24039  The file name must be absolute.
24040  This command must occur exactly once.
24041 \end_layout
24042
24043 \begin_layout Subsection
24044 Preamble definitions
24045 \end_layout
24046
24047 \begin_layout Standard
24048 The external template configuration file may contain additional preamble
24049  definitions enclosed by
24050 \begin_inset Flex Code
24051 status collapsed
24052
24053 \begin_layout Plain Layout
24054 PreambleDef
24055 \end_layout
24056
24057 \end_inset
24058
24059  \SpecialChar ldots
24060
24061 \begin_inset Flex Code
24062 status collapsed
24063
24064 \begin_layout Plain Layout
24065 PreambleDefEnd
24066 \end_layout
24067
24068 \end_inset
24069
24070 .
24071  They can be used by the templates in the
24072 \begin_inset Flex Code
24073 status collapsed
24074
24075 \begin_layout Plain Layout
24076 Format
24077 \end_layout
24078
24079 \end_inset
24080
24081  section.
24082 \end_layout
24083
24084 \begin_layout Section
24085 The substitution mechanism
24086 \end_layout
24087
24088 \begin_layout Standard
24089 When the external material facility invokes an external program, it is done
24090  on the basis of a command defined in the template configuration file.
24091  These commands can contain various macros that are expanded before execution.
24092  Execution always take place in the directory of the containing document.
24093 \end_layout
24094
24095 \begin_layout Standard
24096 Also, whenever external material is to be displayed, the name will be produced
24097  by the substitution mechanism, and most other commands in the template
24098  definition support substitution as well.
24099 \end_layout
24100
24101 \begin_layout Standard
24102 The available macros are the following:
24103 \end_layout
24104
24105 \begin_layout Description
24106 \begin_inset Flex Code
24107 status collapsed
24108
24109 \begin_layout Plain Layout
24110 $$AbsOrRelPathMaster
24111 \end_layout
24112
24113 \end_inset
24114
24115  The file path, absolute or relative to the master \SpecialChar LyX
24116  document.
24117 \end_layout
24118
24119 \begin_layout Description
24120 \begin_inset Flex Code
24121 status collapsed
24122
24123 \begin_layout Plain Layout
24124 $$AbsOrRelPathParent
24125 \end_layout
24126
24127 \end_inset
24128
24129  The file path, absolute or relative to the \SpecialChar LyX
24130  document.
24131 \end_layout
24132
24133 \begin_layout Description
24134 \begin_inset Flex Code
24135 status collapsed
24136
24137 \begin_layout Plain Layout
24138 $$AbsPath
24139 \end_layout
24140
24141 \end_inset
24142
24143  The absolute file path.
24144 \end_layout
24145
24146 \begin_layout Description
24147 \begin_inset Flex Code
24148 status collapsed
24149
24150 \begin_layout Plain Layout
24151 $$Basename
24152 \end_layout
24153
24154 \end_inset
24155
24156  The filename without path and without the extension.
24157 \end_layout
24158
24159 \begin_layout Description
24160 \begin_inset Flex Code
24161 status collapsed
24162
24163 \begin_layout Plain Layout
24164 $$Contents(
24165 \begin_inset Quotes eld
24166 \end_inset
24167
24168 filename.ext
24169 \begin_inset Quotes erd
24170 \end_inset
24171
24172 )
24173 \end_layout
24174
24175 \end_inset
24176
24177  This macro will expand to the contents of the file with the name
24178 \begin_inset Flex Code
24179 status collapsed
24180
24181 \begin_layout Plain Layout
24182 filename.ext
24183 \end_layout
24184
24185 \end_inset
24186
24187 .
24188 \end_layout
24189
24190 \begin_layout Description
24191 \begin_inset Flex Code
24192 status collapsed
24193
24194 \begin_layout Plain Layout
24195 $$Extension
24196 \end_layout
24197
24198 \end_inset
24199
24200  The file extension (including the dot).
24201 \end_layout
24202
24203 \begin_layout Description
24204 \begin_inset Flex Code
24205 status collapsed
24206
24207 \begin_layout Plain Layout
24208 $$pngOrjpg
24209 \end_layout
24210
24211 \end_inset
24212
24213  This will be the string
24214 \begin_inset Quotes eld
24215 \end_inset
24216
24217 jpg
24218 \begin_inset Quotes erd
24219 \end_inset
24220
24221  if the file is in JPEG format, otherwise it will be the string
24222 \begin_inset Quotes eld
24223 \end_inset
24224
24225 png
24226 \begin_inset Quotes erd
24227 \end_inset
24228
24229 .
24230  This is useful to avoid uneeded conversions for output formats that support
24231  both PNG and JPEG fomats.
24232  The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
24233  output
24234  format.
24235 \end_layout
24236
24237 \begin_layout Description
24238 \begin_inset Flex Code
24239 status collapsed
24240
24241 \begin_layout Plain Layout
24242 $$FName
24243 \end_layout
24244
24245 \end_inset
24246
24247  The filename of the file specified in the external material dialog.
24248  This is either an absolute name, or it is relative to the \SpecialChar LyX
24249  document.
24250 \end_layout
24251
24252 \begin_layout Description
24253 \begin_inset Flex Code
24254 status collapsed
24255
24256 \begin_layout Plain Layout
24257 $$FPath
24258 \end_layout
24259
24260 \end_inset
24261
24262  The path part of
24263 \begin_inset Flex Code
24264 status collapsed
24265
24266 \begin_layout Plain Layout
24267 $$FName
24268 \end_layout
24269
24270 \end_inset
24271
24272  (absolute name or relative to the \SpecialChar LyX
24273  document).
24274 \end_layout
24275
24276 \begin_layout Description
24277 \begin_inset Flex Code
24278 status collapsed
24279
24280 \begin_layout Plain Layout
24281 $$RelPathMaster
24282 \end_layout
24283
24284 \end_inset
24285
24286  The file path, relative to the master \SpecialChar LyX
24287  document.
24288 \end_layout
24289
24290 \begin_layout Description
24291 \begin_inset Flex Code
24292 status collapsed
24293
24294 \begin_layout Plain Layout
24295 $$RelPathParent
24296 \end_layout
24297
24298 \end_inset
24299
24300  The file path, relative to the \SpecialChar LyX
24301  document.
24302 \end_layout
24303
24304 \begin_layout Description
24305 \begin_inset Flex Code
24306 status collapsed
24307
24308 \begin_layout Plain Layout
24309 $$Sysdir
24310 \end_layout
24311
24312 \end_inset
24313
24314  This macro will expand to the absolute path of the system directory.
24315  This is typically used to point to the various helper scripts that are
24316  bundled with \SpecialChar LyX
24317 .
24318 \end_layout
24319
24320 \begin_layout Description
24321 \begin_inset Flex Code
24322 status collapsed
24323
24324 \begin_layout Plain Layout
24325 $$Tempname
24326 \end_layout
24327
24328 \end_inset
24329
24330  A name and full path to a temporary file which will be automatically deleted
24331  whenever the containing document is closed, or the external material insertion
24332  deleted.
24333 \end_layout
24334
24335 \begin_layout Standard
24336 All path macros contain a trailing directory separator, so you can construct
24337  e.
24338 \begin_inset space \thinspace{}
24339 \end_inset
24340
24341 g.
24342 \begin_inset space \space{}
24343 \end_inset
24344
24345 the absolute filename with
24346 \begin_inset Flex Code
24347 status collapsed
24348
24349 \begin_layout Plain Layout
24350 $$AbsPath$$Basename$$Extension
24351 \end_layout
24352
24353 \end_inset
24354
24355 .
24356 \end_layout
24357
24358 \begin_layout Standard
24359 The macros above are substituted in all commands unless otherwise noted.
24360  The command
24361 \begin_inset Flex Code
24362 status collapsed
24363
24364 \begin_layout Plain Layout
24365 Product
24366 \end_layout
24367
24368 \end_inset
24369
24370  supports additionally the following substitutions if they are enabled by
24371  the
24372 \begin_inset Flex Code
24373 status collapsed
24374
24375 \begin_layout Plain Layout
24376 Transform
24377 \end_layout
24378
24379 \end_inset
24380
24381  and
24382 \begin_inset Flex Code
24383 status collapsed
24384
24385 \begin_layout Plain Layout
24386 TransformCommand
24387 \end_layout
24388
24389 \end_inset
24390
24391  commands:
24392 \end_layout
24393
24394 \begin_layout Description
24395 \begin_inset Flex Code
24396 status collapsed
24397
24398 \begin_layout Plain Layout
24399 $$ResizeFront
24400 \end_layout
24401
24402 \end_inset
24403
24404  The front part of the resize command.
24405 \end_layout
24406
24407 \begin_layout Description
24408 \begin_inset Flex Code
24409 status collapsed
24410
24411 \begin_layout Plain Layout
24412 $$ResizeBack
24413 \end_layout
24414
24415 \end_inset
24416
24417  The back part of the resize command.
24418 \end_layout
24419
24420 \begin_layout Description
24421 \begin_inset Flex Code
24422 status collapsed
24423
24424 \begin_layout Plain Layout
24425 $$RotateFront
24426 \end_layout
24427
24428 \end_inset
24429
24430  The front part of the rotation command.
24431 \end_layout
24432
24433 \begin_layout Description
24434 \begin_inset Flex Code
24435 status collapsed
24436
24437 \begin_layout Plain Layout
24438 $$RotateBack
24439 \end_layout
24440
24441 \end_inset
24442
24443  The back part of the rotation command.
24444 \end_layout
24445
24446 \begin_layout Standard
24447 The value string of the
24448 \begin_inset Flex Code
24449 status collapsed
24450
24451 \begin_layout Plain Layout
24452 Option
24453 \end_layout
24454
24455 \end_inset
24456
24457  command supports additionally the following substitutions if they are enabled
24458  by the
24459 \begin_inset Flex Code
24460 status collapsed
24461
24462 \begin_layout Plain Layout
24463 Transform
24464 \end_layout
24465
24466 \end_inset
24467
24468  and
24469 \begin_inset Flex Code
24470 status collapsed
24471
24472 \begin_layout Plain Layout
24473 TransformOption
24474 \end_layout
24475
24476 \end_inset
24477
24478  commands:
24479 \end_layout
24480
24481 \begin_layout Description
24482 \begin_inset Flex Code
24483 status collapsed
24484
24485 \begin_layout Plain Layout
24486 $$Clip
24487 \end_layout
24488
24489 \end_inset
24490
24491  The clip option.
24492 \end_layout
24493
24494 \begin_layout Description
24495 \begin_inset Flex Code
24496 status collapsed
24497
24498 \begin_layout Plain Layout
24499 $$Extra
24500 \end_layout
24501
24502 \end_inset
24503
24504  The extra option.
24505 \end_layout
24506
24507 \begin_layout Description
24508 \begin_inset Flex Code
24509 status collapsed
24510
24511 \begin_layout Plain Layout
24512 $$Resize
24513 \end_layout
24514
24515 \end_inset
24516
24517  The resize option.
24518 \end_layout
24519
24520 \begin_layout Description
24521 \begin_inset Flex Code
24522 status collapsed
24523
24524 \begin_layout Plain Layout
24525 $$Rotate
24526 \end_layout
24527
24528 \end_inset
24529
24530  The rotation option.
24531 \end_layout
24532
24533 \begin_layout Standard
24534 You may ask why there are so many path macros.
24535  There are mainly two reasons:
24536 \end_layout
24537
24538 \begin_layout Enumerate
24539 Relative and absolute file names should remain relative or absolute, respectivel
24540 y.
24541  Users may have reasons to prefer either form.
24542  Relative names are useful for portable documents that should work on different
24543  machines, for example.
24544  Absolute names may be required by some programs.
24545 \end_layout
24546
24547 \begin_layout Enumerate
24548 \SpecialChar LaTeX
24549  treats relative file names differently than \SpecialChar LyX
24550  and other programs in nested
24551  included files.
24552  For \SpecialChar LyX
24553 , a relative file name is always relative to the document that contains
24554  the file name.
24555  For \SpecialChar LaTeX
24556 , it is always relative to the master document.
24557  These two definitions are identical if you have only one document, but
24558  differ if you have a master document that includes part documents.
24559  That means that relative filenames must be transformed when presented to
24560  \SpecialChar LaTeX
24561 .
24562  Fortunately \SpecialChar LyX
24563  does this automatically for you if you choose the right macros.
24564 \end_layout
24565
24566 \begin_layout Standard
24567 So which path macro should be used in new template definitions? The rule
24568  is not difficult:
24569 \end_layout
24570
24571 \begin_layout Itemize
24572 Use
24573 \begin_inset Flex Code
24574 status collapsed
24575
24576 \begin_layout Plain Layout
24577 $$AbsPath
24578 \end_layout
24579
24580 \end_inset
24581
24582  if an absolute path is required.
24583 \end_layout
24584
24585 \begin_layout Itemize
24586 Use
24587 \begin_inset Flex Code
24588 status collapsed
24589
24590 \begin_layout Plain Layout
24591 $$AbsOrRelPathMaster
24592 \end_layout
24593
24594 \end_inset
24595
24596  if the substituted string is some kind of \SpecialChar LaTeX
24597  input.
24598 \end_layout
24599
24600 \begin_layout Itemize
24601 Else use
24602 \begin_inset Flex Code
24603 status collapsed
24604
24605 \begin_layout Plain Layout
24606 $$AbsOrRelPathParent
24607 \end_layout
24608
24609 \end_inset
24610
24611  in order to preserve the user's choice.
24612 \end_layout
24613
24614 \begin_layout Standard
24615 There are special cases where this rule does not work and e.
24616 \begin_inset space \thinspace{}
24617 \end_inset
24618
24619 g.
24620 \begin_inset space \space{}
24621 \end_inset
24622
24623 relative names are needed, but normally it will work just fine.
24624  One example for such a case is the command
24625 \begin_inset Flex Code
24626 status collapsed
24627
24628 \begin_layout Plain Layout
24629 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
24630 \end_layout
24631
24632 \end_inset
24633
24634  in the XFig template above: We can't use the absolute name because the
24635  copier for
24636 \begin_inset Flex Code
24637 status collapsed
24638
24639 \begin_layout Plain Layout
24640 .pstex_t
24641 \end_layout
24642
24643 \end_inset
24644
24645  files needs the relative name in order to rewrite the file content.
24646 \end_layout
24647
24648 \begin_layout Section
24649 Security discussion
24650 \begin_inset CommandInset label
24651 LatexCommand label
24652 name "sec:Security-discussion"
24653
24654 \end_inset
24655
24656
24657 \end_layout
24658
24659 \begin_layout Standard
24660 The external material feature interfaces with a lot of external programs
24661  and does so automatically, so we have to consider the security implications
24662  of this.
24663  In particular, since you have the option of including your own filenames
24664  and/or parameter strings and those are expanded into a command, it seems
24665  that it would be possible to create a malicious document which executes
24666  arbitrary commands when a user views or prints the document.
24667  This is something we definitely want to avoid.
24668 \end_layout
24669
24670 \begin_layout Standard
24671 However, since the external program commands are specified in the template
24672  configuration file only, there are no security issues if \SpecialChar LyX
24673  is properly configure
24674 d with safe templates only.
24675  This is so because the external programs are invoked with the
24676 \begin_inset Flex Code
24677 status collapsed
24678
24679 \begin_layout Plain Layout
24680 execvp
24681 \end_layout
24682
24683 \end_inset
24684
24685 -system call rather than the
24686 \begin_inset Flex Code
24687 status collapsed
24688
24689 \begin_layout Plain Layout
24690 system
24691 \end_layout
24692
24693 \end_inset
24694
24695  system-call, so it's not possible to execute arbitrary commands from the
24696  filename or parameter section via the shell.
24697 \end_layout
24698
24699 \begin_layout Standard
24700 This also implies that you are restricted in what command strings you can
24701  use in the external material templates.
24702  In particular, pipes and redirection are not readily available.
24703  This has to be so if \SpecialChar LyX
24704  should remain safe.
24705  If you want to use some of the shell features, you should write a safe
24706  script to do this in a controlled manner, and then invoke the script from
24707  the command string.
24708
24709 \end_layout
24710
24711 \begin_layout Standard
24712 It is possible to design a template that interacts directly with the shell,
24713  but since this would allow a malicious user to execute arbitrary commands
24714  by writing clever filenames and/or parameters, we generally recommend that
24715  you only use safe scripts that work with the
24716 \begin_inset Flex Code
24717 status collapsed
24718
24719 \begin_layout Plain Layout
24720 execvp
24721 \end_layout
24722
24723 \end_inset
24724
24725  system call in a controlled manner.
24726  Of course, for use in a controlled environment, it can be tempting to just
24727  fall back to use ordinary shell scripts.
24728  If you do so, be aware that you
24729 \emph on
24730 will
24731 \emph default
24732  provide an easily exploitable security hole in your system.
24733  Of course it stands to reason that such unsafe templates will never be
24734  included in the standard \SpecialChar LyX
24735  distribution, although we do encourage people
24736  to submit new templates in the open source tradition.
24737  But \SpecialChar LyX
24738  as shipped from the official distribution channels will never have
24739  unsafe templates.
24740 \end_layout
24741
24742 \begin_layout Standard
24743 Including external material provides a lot of power, and you have to be
24744  careful not to introduce security hazards with this power.
24745  A subtle error in a single line in an innocent looking script can open
24746  the door to huge security problems.
24747  So if you do not fully understand the issues, we recommend that you consult
24748  a knowledgeable security professional or the \SpecialChar LyX
24749  development team if you have
24750  any questions about whether a given template is safe or not.
24751  And do this before you use it in an uncontrolled environment.
24752 \end_layout
24753
24754 \begin_layout Chapter
24755 \start_of_appendix
24756 List of supported \SpecialChar LyX
24757  functions to be used in layouts
24758 \begin_inset CommandInset label
24759 LatexCommand label
24760 name "chap:List-of-functions"
24761
24762 \end_inset
24763
24764
24765 \end_layout
24766
24767 \begin_layout Standard
24768 \align center
24769 \begin_inset Tabular
24770 <lyxtabular version="3" rows="11" columns="8">
24771 <features tabularvalignment="middle">
24772 <column alignment="left" valignment="top">
24773 <column alignment="left" valignment="top">
24774 <column alignment="left" valignment="top">
24775 <column alignment="left" valignment="top">
24776 <column alignment="left" valignment="top">
24777 <column alignment="left" valignment="top">
24778 <column alignment="left" valignment="top">
24779 <column alignment="left" valignment="top">
24780 <row>
24781 <cell alignment="left" valignment="top" usebox="none">
24782 \begin_inset Text
24783
24784 \begin_layout Plain Layout
24785 accents
24786 \end_layout
24787
24788 \end_inset
24789 </cell>
24790 <cell alignment="left" valignment="top" usebox="none">
24791 \begin_inset Text
24792
24793 \begin_layout Plain Layout
24794 booktabs
24795 \end_layout
24796
24797 \end_inset
24798 </cell>
24799 <cell alignment="left" valignment="top" usebox="none">
24800 \begin_inset Text
24801
24802 \begin_layout Plain Layout
24803 feyn
24804 \end_layout
24805
24806 \end_inset
24807 </cell>
24808 <cell alignment="left" valignment="top" usebox="none">
24809 \begin_inset Text
24810
24811 \begin_layout Plain Layout
24812 listings
24813 \end_layout
24814
24815 \end_inset
24816 </cell>
24817 <cell alignment="center" valignment="top" usebox="none">
24818 \begin_inset Text
24819
24820 \begin_layout Plain Layout
24821 natbib
24822 \end_layout
24823
24824 \end_inset
24825 </cell>
24826 <cell alignment="center" valignment="top" usebox="none">
24827 \begin_inset Text
24828
24829 \begin_layout Plain Layout
24830 rotfloat
24831 \end_layout
24832
24833 \end_inset
24834 </cell>
24835 <cell alignment="center" valignment="top" usebox="none">
24836 \begin_inset Text
24837
24838 \begin_layout Plain Layout
24839 tfrupee
24840 \end_layout
24841
24842 \end_inset
24843 </cell>
24844 <cell alignment="center" valignment="top" usebox="none">
24845 \begin_inset Text
24846
24847 \begin_layout Plain Layout
24848 wasysym
24849 \end_layout
24850
24851 \end_inset
24852 </cell>
24853 </row>
24854 <row>
24855 <cell alignment="left" valignment="top" usebox="none">
24856 \begin_inset Text
24857
24858 \begin_layout Plain Layout
24859 amsbsy
24860 \end_layout
24861
24862 \end_inset
24863 </cell>
24864 <cell alignment="left" valignment="top" usebox="none">
24865 \begin_inset Text
24866
24867 \begin_layout Plain Layout
24868 calc
24869 \end_layout
24870
24871 \end_inset
24872 </cell>
24873 <cell alignment="left" valignment="top" usebox="none">
24874 \begin_inset Text
24875
24876 \begin_layout Plain Layout
24877 fixltx2e
24878 \end_layout
24879
24880 \end_inset
24881 </cell>
24882 <cell alignment="left" valignment="top" usebox="none">
24883 \begin_inset Text
24884
24885 \begin_layout Plain Layout
24886 longtable
24887 \end_layout
24888
24889 \end_inset
24890 </cell>
24891 <cell alignment="center" valignment="top" usebox="none">
24892 \begin_inset Text
24893
24894 \begin_layout Plain Layout
24895 nomencl
24896 \end_layout
24897
24898 \end_inset
24899 </cell>
24900 <cell alignment="center" valignment="top" usebox="none">
24901 \begin_inset Text
24902
24903 \begin_layout Plain Layout
24904 rsphrase
24905 \end_layout
24906
24907 \end_inset
24908 </cell>
24909 <cell alignment="center" valignment="top" usebox="none">
24910 \begin_inset Text
24911
24912 \begin_layout Plain Layout
24913 tipa
24914 \end_layout
24915
24916 \end_inset
24917 </cell>
24918 <cell alignment="center" valignment="top" usebox="none">
24919 \begin_inset Text
24920
24921 \begin_layout Plain Layout
24922 wrapfig
24923 \end_layout
24924
24925 \end_inset
24926 </cell>
24927 </row>
24928 <row>
24929 <cell alignment="left" valignment="top" usebox="none">
24930 \begin_inset Text
24931
24932 \begin_layout Plain Layout
24933 amscd
24934 \end_layout
24935
24936 \end_inset
24937 </cell>
24938 <cell alignment="left" valignment="top" usebox="none">
24939 \begin_inset Text
24940
24941 \begin_layout Plain Layout
24942 CJK
24943 \end_layout
24944
24945 \end_inset
24946 </cell>
24947 <cell alignment="left" valignment="top" usebox="none">
24948 \begin_inset Text
24949
24950 \begin_layout Plain Layout
24951 float
24952 \end_layout
24953
24954 \end_inset
24955 </cell>
24956 <cell alignment="left" valignment="top" usebox="none">
24957 \begin_inset Text
24958
24959 \begin_layout Plain Layout
24960 lyxskak
24961 \end_layout
24962
24963 \end_inset
24964 </cell>
24965 <cell alignment="center" valignment="top" usebox="none">
24966 \begin_inset Text
24967
24968 \begin_layout Plain Layout
24969 pdfcolmk
24970 \end_layout
24971
24972 \end_inset
24973 </cell>
24974 <cell alignment="center" valignment="top" usebox="none">
24975 \begin_inset Text
24976
24977 \begin_layout Plain Layout
24978 setspace
24979 \end_layout
24980
24981 \end_inset
24982 </cell>
24983 <cell alignment="center" valignment="top" usebox="none">
24984 \begin_inset Text
24985
24986 \begin_layout Plain Layout
24987 tipx
24988 \end_layout
24989
24990 \end_inset
24991 </cell>
24992 <cell alignment="center" valignment="top" usebox="none">
24993 \begin_inset Text
24994
24995 \begin_layout Plain Layout
24996 xargs
24997 \end_layout
24998
24999 \end_inset
25000 </cell>
25001 </row>
25002 <row>
25003 <cell alignment="left" valignment="top" usebox="none">
25004 \begin_inset Text
25005
25006 \begin_layout Plain Layout
25007 amsmath
25008 \end_layout
25009
25010 \end_inset
25011 </cell>
25012 <cell alignment="left" valignment="top" usebox="none">
25013 \begin_inset Text
25014
25015 \begin_layout Plain Layout
25016 color
25017 \end_layout
25018
25019 \end_inset
25020 </cell>
25021 <cell alignment="left" valignment="top" usebox="none">
25022 \begin_inset Text
25023
25024 \begin_layout Plain Layout
25025 framed
25026 \end_layout
25027
25028 \end_inset
25029 </cell>
25030 <cell alignment="left" valignment="top" usebox="none">
25031 \begin_inset Text
25032
25033 \begin_layout Plain Layout
25034 makeidx
25035 \end_layout
25036
25037 \end_inset
25038 </cell>
25039 <cell alignment="center" valignment="top" usebox="none">
25040 \begin_inset Text
25041
25042 \begin_layout Plain Layout
25043 pdfpages
25044 \end_layout
25045
25046 \end_inset
25047 </cell>
25048 <cell alignment="center" valignment="top" usebox="none">
25049 \begin_inset Text
25050
25051 \begin_layout Plain Layout
25052 shapepar
25053 \end_layout
25054
25055 \end_inset
25056 </cell>
25057 <cell alignment="center" valignment="top" usebox="none">
25058 \begin_inset Text
25059
25060 \begin_layout Plain Layout
25061 tone
25062 \end_layout
25063
25064 \end_inset
25065 </cell>
25066 <cell alignment="center" valignment="top" usebox="none">
25067 \begin_inset Text
25068
25069 \begin_layout Plain Layout
25070 xcolor
25071 \end_layout
25072
25073 \end_inset
25074 </cell>
25075 </row>
25076 <row>
25077 <cell alignment="left" valignment="top" usebox="none">
25078 \begin_inset Text
25079
25080 \begin_layout Plain Layout
25081 amssymb
25082 \end_layout
25083
25084 \end_inset
25085 </cell>
25086 <cell alignment="left" valignment="top" usebox="none">
25087 \begin_inset Text
25088
25089 \begin_layout Plain Layout
25090 covington
25091 \end_layout
25092
25093 \end_inset
25094 </cell>
25095 <cell alignment="left" valignment="top" usebox="none">
25096 \begin_inset Text
25097
25098 \begin_layout Plain Layout
25099 graphicx
25100 \end_layout
25101
25102 \end_inset
25103 </cell>
25104 <cell alignment="left" valignment="top" usebox="none">
25105 \begin_inset Text
25106
25107 \begin_layout Plain Layout
25108 marvosym
25109 \end_layout
25110
25111 \end_inset
25112 </cell>
25113 <cell alignment="center" valignment="top" usebox="none">
25114 \begin_inset Text
25115
25116 \begin_layout Plain Layout
25117 pifont
25118 \end_layout
25119
25120 \end_inset
25121 </cell>
25122 <cell alignment="center" valignment="top" usebox="none">
25123 \begin_inset Text
25124
25125 \begin_layout Plain Layout
25126 slashed
25127 \end_layout
25128
25129 \end_inset
25130 </cell>
25131 <cell alignment="center" valignment="top" usebox="none">
25132 \begin_inset Text
25133
25134 \begin_layout Plain Layout
25135 txfonts
25136 \end_layout
25137
25138 \end_inset
25139 </cell>
25140 <cell alignment="center" valignment="top" usebox="none">
25141 \begin_inset Text
25142
25143 \begin_layout Plain Layout
25144 xy
25145 \end_layout
25146
25147 \end_inset
25148 </cell>
25149 </row>
25150 <row>
25151 <cell alignment="left" valignment="top" usebox="none">
25152 \begin_inset Text
25153
25154 \begin_layout Plain Layout
25155 amstext
25156 \end_layout
25157
25158 \end_inset
25159 </cell>
25160 <cell alignment="left" valignment="top" usebox="none">
25161 \begin_inset Text
25162
25163 \begin_layout Plain Layout
25164 csquotes
25165 \end_layout
25166
25167 \end_inset
25168 </cell>
25169 <cell alignment="left" valignment="top" usebox="none">
25170 \begin_inset Text
25171
25172 \begin_layout Plain Layout
25173 hhline
25174 \end_layout
25175
25176 \end_inset
25177 </cell>
25178 <cell alignment="left" valignment="top" usebox="none">
25179 \begin_inset Text
25180
25181 \begin_layout Plain Layout
25182 mathdesign
25183 \end_layout
25184
25185 \end_inset
25186 </cell>
25187 <cell alignment="center" valignment="top" usebox="none">
25188 \begin_inset Text
25189
25190 \begin_layout Plain Layout
25191 pmboxdraw
25192 \end_layout
25193
25194 \end_inset
25195 </cell>
25196 <cell alignment="center" valignment="top" usebox="none">
25197 \begin_inset Text
25198
25199 \begin_layout Plain Layout
25200 soul
25201 \end_layout
25202
25203 \end_inset
25204 </cell>
25205 <cell alignment="center" valignment="top" usebox="none">
25206 \begin_inset Text
25207
25208 \begin_layout Plain Layout
25209 ulem
25210 \end_layout
25211
25212 \end_inset
25213 </cell>
25214 <cell alignment="center" valignment="top" usebox="none">
25215 \begin_inset Text
25216
25217 \begin_layout Plain Layout
25218 yhmath
25219 \end_layout
25220
25221 \end_inset
25222 </cell>
25223 </row>
25224 <row>
25225 <cell alignment="left" valignment="top" usebox="none">
25226 \begin_inset Text
25227
25228 \begin_layout Plain Layout
25229 amsthm
25230 \end_layout
25231
25232 \end_inset
25233 </cell>
25234 <cell alignment="left" valignment="top" usebox="none">
25235 \begin_inset Text
25236
25237 \begin_layout Plain Layout
25238 dvipost
25239 \end_layout
25240
25241 \end_inset
25242 </cell>
25243 <cell alignment="left" valignment="top" usebox="none">
25244 \begin_inset Text
25245
25246 \begin_layout Plain Layout
25247 hyperref
25248 \end_layout
25249
25250 \end_inset
25251 </cell>
25252 <cell alignment="left" valignment="top" usebox="none">
25253 \begin_inset Text
25254
25255 \begin_layout Plain Layout
25256 mathdots
25257 \end_layout
25258
25259 \end_inset
25260 </cell>
25261 <cell alignment="center" valignment="top" usebox="none">
25262 \begin_inset Text
25263
25264 \begin_layout Plain Layout
25265 polyglossia
25266 \end_layout
25267
25268 \end_inset
25269 </cell>
25270 <cell alignment="center" valignment="top" usebox="none">
25271 \begin_inset Text
25272
25273 \begin_layout Plain Layout
25274 splitidx
25275 \end_layout
25276
25277 \end_inset
25278 </cell>
25279 <cell alignment="center" valignment="top" usebox="none">
25280 \begin_inset Text
25281
25282 \begin_layout Plain Layout
25283 undertilde
25284 \end_layout
25285
25286 \end_inset
25287 </cell>
25288 <cell alignment="center" valignment="top" usebox="none">
25289 \begin_inset Text
25290
25291 \begin_layout Plain Layout
25292
25293 \end_layout
25294
25295 \end_inset
25296 </cell>
25297 </row>
25298 <row>
25299 <cell alignment="left" valignment="top" usebox="none">
25300 \begin_inset Text
25301
25302 \begin_layout Plain Layout
25303 array
25304 \end_layout
25305
25306 \end_inset
25307 </cell>
25308 <cell alignment="left" valignment="top" usebox="none">
25309 \begin_inset Text
25310
25311 \begin_layout Plain Layout
25312 endnotes
25313 \end_layout
25314
25315 \end_inset
25316 </cell>
25317 <cell alignment="left" valignment="top" usebox="none">
25318 \begin_inset Text
25319
25320 \begin_layout Plain Layout
25321 ifsym
25322 \end_layout
25323
25324 \end_inset
25325 </cell>
25326 <cell alignment="left" valignment="top" usebox="none">
25327 \begin_inset Text
25328
25329 \begin_layout Plain Layout
25330 mathrsfs
25331 \end_layout
25332
25333 \end_inset
25334 </cell>
25335 <cell alignment="center" valignment="top" usebox="none">
25336 \begin_inset Text
25337
25338 \begin_layout Plain Layout
25339 prettyref
25340 \end_layout
25341
25342 \end_inset
25343 </cell>
25344 <cell alignment="center" valignment="top" usebox="none">
25345 \begin_inset Text
25346
25347 \begin_layout Plain Layout
25348 subfig
25349 \end_layout
25350
25351 \end_inset
25352 </cell>
25353 <cell alignment="center" valignment="top" usebox="none">
25354 \begin_inset Text
25355
25356 \begin_layout Plain Layout
25357 units
25358 \end_layout
25359
25360 \end_inset
25361 </cell>
25362 <cell alignment="center" valignment="top" usebox="none">
25363 \begin_inset Text
25364
25365 \begin_layout Plain Layout
25366
25367 \end_layout
25368
25369 \end_inset
25370 </cell>
25371 </row>
25372 <row>
25373 <cell alignment="left" valignment="top" usebox="none">
25374 \begin_inset Text
25375
25376 \begin_layout Plain Layout
25377 ascii
25378 \end_layout
25379
25380 \end_inset
25381 </cell>
25382 <cell alignment="left" valignment="top" usebox="none">
25383 \begin_inset Text
25384
25385 \begin_layout Plain Layout
25386 enumitem
25387 \end_layout
25388
25389 \end_inset
25390 </cell>
25391 <cell alignment="left" valignment="top" usebox="none">
25392 \begin_inset Text
25393
25394 \begin_layout Plain Layout
25395 ifthen
25396 \end_layout
25397
25398 \end_inset
25399 </cell>
25400 <cell alignment="left" valignment="top" usebox="none">
25401 \begin_inset Text
25402
25403 \begin_layout Plain Layout
25404 mhchem
25405 \end_layout
25406
25407 \end_inset
25408 </cell>
25409 <cell alignment="center" valignment="top" usebox="none">
25410 \begin_inset Text
25411
25412 \begin_layout Plain Layout
25413 pxfonts
25414 \end_layout
25415
25416 \end_inset
25417 </cell>
25418 <cell alignment="center" valignment="top" usebox="none">
25419 \begin_inset Text
25420
25421 \begin_layout Plain Layout
25422 subscript
25423 \end_layout
25424
25425 \end_inset
25426 </cell>
25427 <cell alignment="center" valignment="top" usebox="none">
25428 \begin_inset Text
25429
25430 \begin_layout Plain Layout
25431 url
25432 \end_layout
25433
25434 \end_inset
25435 </cell>
25436 <cell alignment="center" valignment="top" usebox="none">
25437 \begin_inset Text
25438
25439 \begin_layout Plain Layout
25440
25441 \end_layout
25442
25443 \end_inset
25444 </cell>
25445 </row>
25446 <row>
25447 <cell alignment="left" valignment="top" usebox="none">
25448 \begin_inset Text
25449
25450 \begin_layout Plain Layout
25451 bbding
25452 \end_layout
25453
25454 \end_inset
25455 </cell>
25456 <cell alignment="left" valignment="top" usebox="none">
25457 \begin_inset Text
25458
25459 \begin_layout Plain Layout
25460 esint
25461 \end_layout
25462
25463 \end_inset
25464 </cell>
25465 <cell alignment="left" valignment="top" usebox="none">
25466 \begin_inset Text
25467
25468 \begin_layout Plain Layout
25469 jurabib
25470 \end_layout
25471
25472 \end_inset
25473 </cell>
25474 <cell alignment="left" valignment="top" usebox="none">
25475 \begin_inset Text
25476
25477 \begin_layout Plain Layout
25478 multicol
25479 \end_layout
25480
25481 \end_inset
25482 </cell>
25483 <cell alignment="center" valignment="top" usebox="none">
25484 \begin_inset Text
25485
25486 \begin_layout Plain Layout
25487 refstyle
25488 \end_layout
25489
25490 \end_inset
25491 </cell>
25492 <cell alignment="center" valignment="top" usebox="none">
25493 \begin_inset Text
25494
25495 \begin_layout Plain Layout
25496 textcomp
25497 \end_layout
25498
25499 \end_inset
25500 </cell>
25501 <cell alignment="center" valignment="top" usebox="none">
25502 \begin_inset Text
25503
25504 \begin_layout Plain Layout
25505 varioref
25506 \end_layout
25507
25508 \end_inset
25509 </cell>
25510 <cell alignment="center" valignment="top" usebox="none">
25511 \begin_inset Text
25512
25513 \begin_layout Plain Layout
25514
25515 \end_layout
25516
25517 \end_inset
25518 </cell>
25519 </row>
25520 <row>
25521 <cell alignment="center" valignment="top" usebox="none">
25522 \begin_inset Text
25523
25524 \begin_layout Plain Layout
25525 bm
25526 \end_layout
25527
25528 \end_inset
25529 </cell>
25530 <cell alignment="center" valignment="top" usebox="none">
25531 \begin_inset Text
25532
25533 \begin_layout Plain Layout
25534 fancybox
25535 \end_layout
25536
25537 \end_inset
25538 </cell>
25539 <cell alignment="center" valignment="top" usebox="none">
25540 \begin_inset Text
25541
25542 \begin_layout Plain Layout
25543 latexsym
25544 \end_layout
25545
25546 \end_inset
25547 </cell>
25548 <cell alignment="center" valignment="top" usebox="none">
25549 \begin_inset Text
25550
25551 \begin_layout Plain Layout
25552 multirow
25553 \end_layout
25554
25555 \end_inset
25556 </cell>
25557 <cell alignment="center" valignment="top" usebox="none">
25558 \begin_inset Text
25559
25560 \begin_layout Plain Layout
25561 rotating
25562 \end_layout
25563
25564 \end_inset
25565 </cell>
25566 <cell alignment="center" valignment="top" usebox="none">
25567 \begin_inset Text
25568
25569 \begin_layout Plain Layout
25570 textgreek
25571 \end_layout
25572
25573 \end_inset
25574 </cell>
25575 <cell alignment="center" valignment="top" usebox="none">
25576 \begin_inset Text
25577
25578 \begin_layout Plain Layout
25579 verbatim
25580 \end_layout
25581
25582 \end_inset
25583 </cell>
25584 <cell alignment="center" valignment="top" usebox="none">
25585 \begin_inset Text
25586
25587 \begin_layout Plain Layout
25588
25589 \end_layout
25590
25591 \end_inset
25592 </cell>
25593 </row>
25594 </lyxtabular>
25595
25596 \end_inset
25597
25598
25599 \end_layout
25600
25601 \begin_layout Chapter
25602 Names of available colors to be used in layouts
25603 \begin_inset CommandInset label
25604 LatexCommand label
25605 name "chap:Names-of-colors"
25606
25607 \end_inset
25608
25609
25610 \end_layout
25611
25612 \begin_layout Standard
25613 The colors listed here are the standard colors and the those that you can
25614  adjust in the \SpecialChar LyX
25615  preferences.
25616 \end_layout
25617
25618 \begin_layout Description
25619 none
25620 \family roman
25621 \series medium
25622 \shape up
25623 \size normal
25624 \emph off
25625 \bar no
25626 \strikeout off
25627 \uuline off
25628 \uwave off
25629 \noun off
25630 \color none
25631  No particular color – clear or default
25632 \end_layout
25633
25634 \begin_layout Description
25635 black
25636 \end_layout
25637
25638 \begin_layout Description
25639 white
25640 \end_layout
25641
25642 \begin_layout Description
25643 red
25644 \end_layout
25645
25646 \begin_layout Description
25647 green
25648 \end_layout
25649
25650 \begin_layout Description
25651 blue
25652 \end_layout
25653
25654 \begin_layout Description
25655 cyan
25656 \end_layout
25657
25658 \begin_layout Description
25659 magenta
25660 \end_layout
25661
25662 \begin_layout Description
25663 yellow
25664 \end_layout
25665
25666 \begin_layout Description
25667 added_space Added space marker color
25668 \end_layout
25669
25670 \begin_layout Description
25671 addedtext Added text color
25672 \end_layout
25673
25674 \begin_layout Description
25675 appendix Appendix marker color
25676 \end_layout
25677
25678 \begin_layout Description
25679 background Background color
25680 \end_layout
25681
25682 \begin_layout Description
25683 bottomarea Bottom area color
25684 \end_layout
25685
25686 \begin_layout Description
25687 branchlabel Label color for branches
25688 \end_layout
25689
25690 \begin_layout Description
25691 buttonbg Color used for button background
25692 \end_layout
25693
25694 \begin_layout Description
25695 buttonhoverbg Color used for button background under focus
25696 \end_layout
25697
25698 \begin_layout Description
25699 buttonframe Color for inset button frames
25700 \end_layout
25701
25702 \begin_layout Description
25703 changebar Changebar color
25704 \end_layout
25705
25706 \begin_layout Description
25707 changedtextauthor1 Changed text color author 1
25708 \end_layout
25709
25710 \begin_layout Description
25711 changedtextauthor2 Changed text color author 2
25712 \end_layout
25713
25714 \begin_layout Description
25715 changedtextauthor3 Changed text color author 3
25716 \end_layout
25717
25718 \begin_layout Description
25719 changedtextauthor4 Changed text color author 4
25720 \end_layout
25721
25722 \begin_layout Description
25723 changedtextauthor5 Changed text color author 5
25724 \end_layout
25725
25726 \begin_layout Description
25727 collapsable_inset_frame Collapsable insets framecolor
25728 \end_layout
25729
25730 \begin_layout Description
25731 collapsable_inset_text Collapsable insets text color
25732 \end_layout
25733
25734 \begin_layout Description
25735 command Text color for command insets
25736 \end_layout
25737
25738 \begin_layout Description
25739 commandbg Background color for command insets
25740 \end_layout
25741
25742 \begin_layout Description
25743 commandframe Frame color for command insets
25744 \end_layout
25745
25746 \begin_layout Description
25747 comment color for comments
25748 \end_layout
25749
25750 \begin_layout Description
25751 commentbg Background color of comments
25752 \end_layout
25753
25754 \begin_layout Description
25755 cursor Cursor color
25756 \end_layout
25757
25758 \begin_layout Description
25759 deletedtext Deleted text color
25760 \end_layout
25761
25762 \begin_layout Description
25763 deletedtextmodifier Deleted text modifying color
25764 \end_layout
25765
25766 \begin_layout Description
25767 depthbar Color for the depth bars in the margin
25768 \end_layout
25769
25770 \begin_layout Description
25771 eolmarker End of line marker color
25772 \end_layout
25773
25774 \begin_layout Description
25775 error Color of the \SpecialChar LaTeX
25776  error box
25777 \end_layout
25778
25779 \begin_layout Description
25780 footlabel Label color for footnotes
25781 \end_layout
25782
25783 \begin_layout Description
25784 graphicsbg Graphics inset background color
25785 \end_layout
25786
25787 \begin_layout Description
25788 greyedout Label color for greyedout insets
25789 \end_layout
25790
25791 \begin_layout Description
25792 greyedoutbg Background color of greyedout inset
25793 \end_layout
25794
25795 \begin_layout Description
25796 greyedouttext Color for greyedout inset text
25797 \end_layout
25798
25799 \begin_layout Description
25800 indexlabel Label color for index insets
25801 \end_layout
25802
25803 \begin_layout Description
25804 ignore The color is ignored
25805 \end_layout
25806
25807 \begin_layout Description
25808 inherit The color is inherited
25809 \end_layout
25810
25811 \begin_layout Description
25812 inlinecompletion Inline completion color
25813 \end_layout
25814
25815 \begin_layout Description
25816 insetbg Inset marker background color
25817 \end_layout
25818
25819 \begin_layout Description
25820 insetframe Inset marker frame color
25821 \end_layout
25822
25823 \begin_layout Description
25824 language Color for marking foreign language words
25825 \end_layout
25826
25827 \begin_layout Description
25828 latex Text color in \SpecialChar LaTeX
25829  mode
25830 \end_layout
25831
25832 \begin_layout Description
25833 listingsbg Background color of listings inset
25834 \end_layout
25835
25836 \begin_layout Description
25837 marginlabel Label color for margin notes
25838 \end_layout
25839
25840 \begin_layout Description
25841 math Math inset text color
25842 \end_layout
25843
25844 \begin_layout Description
25845 mathbg Math inset background color
25846 \end_layout
25847
25848 \begin_layout Description
25849 mathcorners Math inset frame color not under focus
25850 \end_layout
25851
25852 \begin_layout Description
25853 mathframe Math inset frame color under focus
25854 \end_layout
25855
25856 \begin_layout Description
25857 mathline Math line color
25858 \end_layout
25859
25860 \begin_layout Description
25861 mathmacrobg Macro math inset background color
25862 \end_layout
25863
25864 \begin_layout Description
25865 mathmacroblend Macro math blended color
25866 \end_layout
25867
25868 \begin_layout Description
25869 mathmacroframe Macro math frame color
25870 \end_layout
25871
25872 \begin_layout Description
25873 mathmacrohoverbg Macro math inset background color hovered
25874 \end_layout
25875
25876 \begin_layout Description
25877 mathmacrolabel Macro math label color
25878 \end_layout
25879
25880 \begin_layout Description
25881 mathmacronewarg Macro template color for new parameters
25882 \end_layout
25883
25884 \begin_layout Description
25885 mathmacrooldarg Macro template color for old parameters
25886 \end_layout
25887
25888 \begin_layout Description
25889 newpage New page color
25890 \end_layout
25891
25892 \begin_layout Description
25893 nonunique_inlinecompletion Inline completion color for the non-unique part
25894 \end_layout
25895
25896 \begin_layout Description
25897 notebg Background color of notes
25898 \end_layout
25899
25900 \begin_layout Description
25901 notelabel Label color for notes
25902 \end_layout
25903
25904 \begin_layout Description
25905 pagebreak Page break/line break color
25906 \end_layout
25907
25908 \begin_layout Description
25909 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
25910 \end_layout
25911
25912 \begin_layout Description
25913 phantomtext Text color for phantom insets
25914 \end_layout
25915
25916 \begin_layout Description
25917 preview The color used for previews
25918 \end_layout
25919
25920 \begin_layout Description
25921 previewframe Preview frame color
25922 \end_layout
25923
25924 \begin_layout Description
25925 regexpframe Color for regexp frame
25926 \end_layout
25927
25928 \begin_layout Description
25929 selection Background color of selected text
25930 \end_layout
25931
25932 \begin_layout Description
25933 selectiontext Foreground color of selected text
25934 \end_layout
25935
25936 \begin_layout Description
25937 shadedbg Background color of shaded box
25938 \end_layout
25939
25940 \begin_layout Description
25941 special Special chars text color
25942 \end_layout
25943
25944 \begin_layout Description
25945 tabularline Table line color
25946 \end_layout
25947
25948 \begin_layout Description
25949 tabularonoffline Table line color
25950 \end_layout
25951
25952 \begin_layout Description
25953 urllabel Label color for URL insets
25954 \end_layout
25955
25956 \begin_layout Description
25957 urltext Color for URL inset text
25958 \end_layout
25959
25960 \end_body
25961 \end_document