lib/doc/Customization.lyx

   1 #LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
   2 \lyxformat 376
   3 \begin_document
   4 \begin_header
   5 \textclass scrbook
   6 \begin_preamble
   7 % DO NOT ALTER THIS PREAMBLE!!!
   8 %
   9 % This preamble is designed to ensure that this document prints
  10 % out as advertised. If you mess with this preamble,
  11 % parts of this document may not print out as expected.  If you
  12 % have problems LaTeXing this file, please contact
  13 % the documentation team
  14 % email: lyx-docs@lists.lyx.org
  15
  16 \usepackage{ifpdf} % part of the hyperref bundle
  17 \ifpdf % if pdflatex is used
  18
  19  % set fonts for nicer pdf view
  20  \IfFileExists{lmodern.sty}
  21   {\usepackage{lmodern}}{}
  22
  23 \fi % end if pdflatex is used
  24
  25 % the pages of the TOC is numbered roman
  26 % and a pdf-bookmark for the TOC is added
  27 \let\myTOC\tableofcontents
  28 \renewcommand\tableofcontents{%
  29   \frontmatter
  30   \pdfbookmark[1]{\contentsname}{}
  31   \myTOC
  32   \mainmatter }
  33
  34 % redefine the \LyX macro for PDF bookmarks
  35 \def\LyX{\texorpdfstring{%
  36   L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
  37   {LyX}}
  38
  39 % used for multi-column text
  40 \usepackage{multicol}
  41 \usepackage{inputenc}
  42 \end_preamble
  43 \options fleqn,liststotoc,bibtotoc,idxtotoc,BCOR7.5mm,titlepage,tablecaptionabove
  44 \use_default_options false
  45 \begin_modules
  46 logicalmkup
  47 \end_modules
  48 \maintain_unincluded_children false
  49 \begin_local_layout
  50 Format 7
  51 InsetLayout CharStyle:MenuItem
  52 LyxType               charstyle
  53 LabelString           menu
  54 LatexType             command
  55 LatexName             menuitem
  56 Font
  57 Family              Sans
  58 EndFont
  59 Preamble
  60 \newcommand*{\menuitem}[1]{{\sffamily #1}}
  61 EndPreamble
  62 End
  63 \end_local_layout
  64 \language english
  65 \inputencoding auto
  66 \fontencoding global
  67 \font_roman default
  68 \font_sans default
  69 \font_typewriter default
  70 \font_default_family default
  71 \use_xetex false
  72 \font_sc false
  73 \font_osf false
  74 \font_sf_scale 100
  75 \font_tt_scale 100
  76
  77 \graphics default
  78 \default_output_format default
  79 \bibtex_command default
  80 \index_command default
  81 \paperfontsize 12
  82 \spacing single
  83 \use_hyperref true
  84 \pdf_title "LyX Configuration Manual"
  85 \pdf_author "LyX Team"
  86 \pdf_subject "LyX-documentation Customization"
  87 \pdf_keywords "LyX, documentation, customization"
  88 \pdf_bookmarks true
  89 \pdf_bookmarksnumbered true
  90 \pdf_bookmarksopen true
  91 \pdf_bookmarksopenlevel 1
  92 \pdf_breaklinks false
  93 \pdf_pdfborder false
  94 \pdf_colorlinks true
  95 \pdf_backref false
  96 \pdf_pdfusetitle false
  97 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true,pdfstartview=XYZ, plainpages=false, pdfpagelabels"
  98 \papersize default
  99 \use_geometry false
 100 \use_amsmath 0
 101 \use_esint 0
 102 \use_mhchem 1
 103 \cite_engine basic
 104 \use_bibtopic false
 105 \use_indices false
 106 \paperorientation portrait
 107 \suppress_date false
 108 \branch OutDated
 109 \selected 0
 110 \filename_suffix 0
 111 \color #f5fae7
 112 \end_branch
 113 \index Index
 114 \shortcut idx
 115 \color #008000
 116 \end_index
 117 \secnumdepth 3
 118 \tocdepth 3
 119 \paragraph_separation indent
 120 \paragraph_indentation default
 121 \quotes_language english
 122 \papercolumns 1
 123 \papersides 2
 124 \paperpagestyle headings
 125 \tracking_changes false
 126 \output_changes false
 127 \html_use_mathml true
 128 \html_be_strict true
 129 \end_header
 130
 131 \begin_body
 132
 133 \begin_layout Title
 134 Customizing LyX: Features for the Advanced User
 135 \end_layout
 136
 137 \begin_layout Author
 138 by the LyX 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 LyX Documenta
 145 tion mailing list,
 146 \begin_inset CommandInset href
 147 LatexCommand href
 148 target "lyx-docs@lists.lyx.org"
 149 type "mailto:"
 150
 151 \end_inset
 152
 153 .
 154  Include
 155 \begin_inset Quotes eld
 156 \end_inset
 157
 158 [Customization]
 159 \begin_inset Quotes erd
 160 \end_inset
 161
 162  in the subject header, and please cc the current maintainer of this file,
 163  Richard Heck <rgheck@comcast.net>.
 164 \end_layout
 165
 166 \end_inset
 167
 168
 169 \begin_inset Newline newline
 170 \end_inset
 171
 172
 173 \begin_inset Newline newline
 174 \end_inset
 175
 176 Version 2.0.x
 177 \end_layout
 178
 179 \begin_layout Standard
 180 \begin_inset CommandInset toc
 181 LatexCommand tableofcontents
 182
 183 \end_inset
 184
 185
 186 \end_layout
 187
 188 \begin_layout Standard
 189 \begin_inset Note Note
 190 status open
 191
 192 \begin_layout Plain Layout
 193 Please use change tracking when modifying this document.
 194  This makes it easier for our translators to recognize things that have
 195  been changed, and it helps the maintainer keep up-to-date with what's been
 196  done.
 197 \end_layout
 198
 199 \end_inset
 200
 201
 202 \end_layout
 203
 204 \begin_layout Chapter
 205 Introduction
 206 \end_layout
 207
 208 \begin_layout Standard
 209 This manual covers the customization features present in LyX.
 210  In it, we discuss issues like keyboard shortcuts, screen previewing options,
 211  printer options, sending commands to LyX via the LyX Server, internationalizati
 212 on, installing new LaTeX classes and LyX layouts, etc.
 213  We can't possibly hope to touch on everything you can change—our developers
 214  add new features faster than we can document them—but we will explain the
 215  most common customizations and hopefully point you in the right direction
 216  for some of the more obscure ones.
 217 \end_layout
 218
 219 \begin_layout Standard
 220 \begin_inset Branch OutDated
 221 status open
 222
 223 \begin_layout Standard
 224 Information from previous versions of this document that now seems to be
 225  outdated is contained in the OutDated branch of this document.
 226  By default, this information will not appear in the LaTeX output.
 227 \end_layout
 228
 229 \end_inset
 230
 231
 232 \end_layout
 233
 234 \begin_layout Chapter
 235 LyX configuration files
 236 \end_layout
 237
 238 \begin_layout Standard
 239 This chapter aims to help you to find your way through the LyX configuration
 240  files.
 241  Before continuing to read this chapter, you should find out where your
 242  LyX library and user directories are by using
 243 \begin_inset Flex CharStyle:MenuItem
 244 status collapsed
 245
 246 \begin_layout Plain Layout
 247 Help\SpecialChar \menuseparator
 248 About
 249 \begin_inset space ~
 250 \end_inset
 251
 252 LyX
 253 \end_layout
 254
 255 \end_inset
 256
 257 .
 258  The library directory is the place where LyX places its system-wide configurati
 259 on files; the user directory is where you can place your modified versions.
 260  We will call the former
 261 \begin_inset Flex CharStyle:Code
 262 status collapsed
 263
 264 \begin_layout Plain Layout
 265 LyXDir
 266 \end_layout
 267
 268 \end_inset
 269
 270  and the latter
 271 \begin_inset Flex CharStyle:MenuItem
 272 status collapsed
 273
 274 \begin_layout Plain Layout
 275 UserDir
 276 \end_layout
 277
 278 \end_inset
 279
 280  in the remainder of this document.
 281
 282 \end_layout
 283
 284 \begin_layout Section
 285 What's in
 286 \begin_inset Flex CharStyle:Code
 287 status collapsed
 288
 289 \begin_layout Plain Layout
 290 LyXDir
 291 \end_layout
 292
 293 \end_inset
 294
 295 ?
 296 \end_layout
 297
 298 \begin_layout Standard
 299 \begin_inset Flex CharStyle:Code
 300 status collapsed
 301
 302 \begin_layout Plain Layout
 303 LyXDir
 304 \end_layout
 305
 306 \end_inset
 307
 308  and its sub-directories contain a number of files and that can be used
 309  to customize LyX's behavior.
 310  You can change many of these files from within LyX itself through the
 311 \begin_inset Flex CharStyle:MenuItem
 312 status collapsed
 313
 314 \begin_layout Plain Layout
 315 Tools\SpecialChar \menuseparator
 316 Preferences
 317 \end_layout
 318
 319 \end_inset
 320
 321  dialog.
 322  Most customization that you will want to do in LyX is possible through
 323  this dialog.
 324  However, many other inner aspects of LyX can be customized by modifying
 325  the files in
 326 \begin_inset Flex CharStyle:Code
 327 status collapsed
 328
 329 \begin_layout Plain Layout
 330 LyXDir
 331 \end_layout
 332
 333 \end_inset
 334
 335 .
 336  These files fall in different categories, described in the following subsection
 337 s.
 338 \end_layout
 339
 340 \begin_layout Subsection
 341 Automatically generated files
 342 \end_layout
 343
 344 \begin_layout Standard
 345 The files, which are to be found in
 346 \begin_inset Flex CharStyle:MenuItem
 347 status collapsed
 348
 349 \begin_layout Plain Layout
 350 UserDir
 351 \end_layout
 352
 353 \end_inset
 354
 355 , are generated when you configure LyX.
 356  They contain various default values that are guessed by inspection.
 357  In general, it is not a good idea to modify them, since they might be overwritt
 358 en at any time.
 359 \end_layout
 360
 361 \begin_layout Labeling
 362 \labelwidthstring 00.00.0000
 363 \begin_inset Flex CharStyle:Code
 364 status collapsed
 365
 366 \begin_layout Plain Layout
 367 lyxrc.defaults
 368 \end_layout
 369
 370 \end_inset
 371
 372  contains defaults for various commands.
 373 \end_layout
 374
 375 \begin_layout Labeling
 376 \labelwidthstring 00.00.0000
 377 \begin_inset Flex CharStyle:Code
 378 status collapsed
 379
 380 \begin_layout Plain Layout
 381 packages.lst
 382 \end_layout
 383
 384 \end_inset
 385
 386  contains the list of packages that have been recognized by LyX.
 387  It is currently unused by the LyX program itself, but the information extracted
 388 , and more, is made available with
 389 \begin_inset Flex CharStyle:MenuItem
 390 status collapsed
 391
 392 \begin_layout Plain Layout
 393 Help\SpecialChar \menuseparator
 394 LaTeX
 395 \begin_inset space ~
 396 \end_inset
 397
 398 Configuration
 399 \end_layout
 400
 401 \end_inset
 402
 403 .
 404 \end_layout
 405
 406 \begin_layout Labeling
 407 \labelwidthstring 00.00.0000
 408 \begin_inset Flex CharStyle:Code
 409 status collapsed
 410
 411 \begin_layout Plain Layout
 412 textclass.lst
 413 \end_layout
 414
 415 \end_inset
 416
 417  the list of text classes that have been found in your
 418 \begin_inset Flex CharStyle:Code
 419 status collapsed
 420
 421 \begin_layout Plain Layout
 422 layout/
 423 \end_layout
 424
 425 \end_inset
 426
 427  directories, along with the associated LaTeX document class and their descripti
 428 on.
 429 \end_layout
 430
 431 \begin_layout Labeling
 432 \labelwidthstring 00.00.0000
 433 \begin_inset Flex CharStyle:Code
 434 status collapsed
 435
 436 \begin_layout Plain Layout
 437 lyxmodules.lst
 438 \end_layout
 439
 440 \end_inset
 441
 442  the list of layout modules found in your
 443 \begin_inset Flex CharStyle:Code
 444 status collapsed
 445
 446 \begin_layout Plain Layout
 447 layout/
 448 \end_layout
 449
 450 \end_inset
 451
 452  directories
 453 \end_layout
 454
 455 \begin_layout Labeling
 456 \labelwidthstring 00.00.0000
 457 \begin_inset Flex CharStyle:Code
 458 status collapsed
 459
 460 \begin_layout Plain Layout
 461 *files.lst
 462 \end_layout
 463
 464 \end_inset
 465
 466  lists of various sorts of LaTeX-related files found on your system
 467 \end_layout
 468
 469 \begin_layout Labeling
 470 \labelwidthstring 00.00.0000
 471 \begin_inset Flex CharStyle:Code
 472 status collapsed
 473
 474 \begin_layout Plain Layout
 475 doc/LaTeXConfig.lyx
 476 \end_layout
 477
 478 \end_inset
 479
 480  is automatically generated during configuration from the file
 481 \begin_inset Flex CharStyle:Code
 482 status collapsed
 483
 484 \begin_layout Plain Layout
 485 LaTeXConfig.lyx.in
 486 \end_layout
 487
 488 \end_inset
 489
 490 .
 491  It contains information on your LaTeX configuration.
 492 \end_layout
 493
 494 \begin_layout Subsection
 495 Directories
 496 \end_layout
 497
 498 \begin_layout Standard
 499 These directories are duplicated between
 500 \begin_inset Flex CharStyle:Code
 501 status collapsed
 502
 503 \begin_layout Plain Layout
 504 LyXDir
 505 \end_layout
 506
 507 \end_inset
 508
 509  and
 510 \begin_inset Flex CharStyle:Code
 511 status collapsed
 512
 513 \begin_layout Plain Layout
 514 UserDir
 515 \end_layout
 516
 517 \end_inset
 518
 519 .
 520  If a particular files exists in both places, the one in
 521 \begin_inset Flex CharStyle:Code
 522 status collapsed
 523
 524 \begin_layout Plain Layout
 525 UserDir
 526 \end_layout
 527
 528 \end_inset
 529
 530  will be used.
 531 \end_layout
 532
 533 \begin_layout Labeling
 534 \labelwidthstring 00.00.0000
 535 \begin_inset Flex CharStyle:Code
 536 status collapsed
 537
 538 \begin_layout Plain Layout
 539 bind/
 540 \end_layout
 541
 542 \end_inset
 543
 544  this directory contains files with the extension
 545 \begin_inset Flex CharStyle:Code
 546 status collapsed
 547
 548 \begin_layout Plain Layout
 549 .bind
 550 \end_layout
 551
 552 \end_inset
 553
 554  that define the keybindings used in LyX.
 555  If there exists an internationalized version of the bind file named
 556 \begin_inset Flex CharStyle:Code
 557 status collapsed
 558
 559 \begin_layout Plain Layout
 560 $LANG_xxx.bind
 561 \end_layout
 562
 563 \end_inset
 564
 565 , that will be used first.
 566 \end_layout
 567
 568 \begin_layout Labeling
 569 \labelwidthstring 00.00.0000
 570 \begin_inset Flex CharStyle:Code
 571 status collapsed
 572
 573 \begin_layout Plain Layout
 574 clipart/
 575 \end_layout
 576
 577 \end_inset
 578
 579  contains graphics files that can be included in documents.
 580
 581 \end_layout
 582
 583 \begin_layout Labeling
 584 \labelwidthstring 00.00.0000
 585 \begin_inset Flex CharStyle:Code
 586 status collapsed
 587
 588 \begin_layout Plain Layout
 589 doc/
 590 \end_layout
 591
 592 \end_inset
 593
 594  contains LyX documentation files (including the one you are currently reading).
 595  The file
 596 \begin_inset Flex CharStyle:Code
 597 status collapsed
 598
 599 \begin_layout Plain Layout
 600 LaTeXConfig.lyx
 601 \end_layout
 602
 603 \end_inset
 604
 605  deserves special attention, as noted above.
 606  The internationalized help docs are in subdirectories
 607 \begin_inset Flex CharStyle:Code
 608 status collapsed
 609
 610 \begin_layout Plain Layout
 611 doc/xx
 612 \end_layout
 613
 614 \end_inset
 615
 616  where
 617 \begin_inset Quotes eld
 618 \end_inset
 619
 620 xx
 621 \begin_inset Quotes erd
 622 \end_inset
 623
 624  is the ISO language code.
 625  See chapter
 626 \begin_inset space ~
 627 \end_inset
 628
 629
 630 \begin_inset CommandInset ref
 631 LatexCommand ref
 632 reference "cha:Internationalizing-LyX"
 633
 634 \end_inset
 635
 636  for details.
 637 \end_layout
 638
 639 \begin_layout Labeling
 640 \labelwidthstring 00.00.0000
 641 \begin_inset Flex CharStyle:Code
 642 status collapsed
 643
 644 \begin_layout Plain Layout
 645 examples/
 646 \end_layout
 647
 648 \end_inset
 649
 650  contains example files that explain how to use some features.
 651  In the file browser, press the
 652 \begin_inset Flex CharStyle:MenuItem
 653 status collapsed
 654
 655 \begin_layout Plain Layout
 656 Examples
 657 \end_layout
 658
 659 \end_inset
 660
 661  button to get there.
 662 \end_layout
 663
 664 \begin_layout Labeling
 665 \labelwidthstring 00.00.0000
 666 \begin_inset Flex CharStyle:Code
 667 status collapsed
 668
 669 \begin_layout Plain Layout
 670 images/
 671 \end_layout
 672
 673 \end_inset
 674
 675  contains image files that are used by the
 676 \begin_inset Flex CharStyle:MenuItem
 677 status collapsed
 678
 679 \begin_layout Plain Layout
 680 Document
 681 \end_layout
 682
 683 \end_inset
 684
 685  dialog.
 686  In addition, it also contains the individual icons used in the toolbar
 687  and the banners that can be shown when LyX is launched.
 688 \end_layout
 689
 690 \begin_layout Labeling
 691 \labelwidthstring 00.00.0000
 692 \begin_inset Flex CharStyle:Code
 693 status collapsed
 694
 695 \begin_layout Plain Layout
 696 kbd/
 697 \end_layout
 698
 699 \end_inset
 700
 701  contains keyboard keymapping files.
 702  See Chapter
 703 \begin_inset space ~
 704 \end_inset
 705
 706
 707 \begin_inset CommandInset ref
 708 LatexCommand ref
 709 reference "sec:International-Keymap-Stuff"
 710
 711 \end_inset
 712
 713  for details.
 714 \end_layout
 715
 716 \begin_layout Labeling
 717 \labelwidthstring 00.00.0000
 718 \begin_inset Flex CharStyle:Code
 719 status collapsed
 720
 721 \begin_layout Plain Layout
 722 layouts/
 723 \end_layout
 724
 725 \end_inset
 726
 727  contains the text class and module files described in Chapter
 728 \begin_inset space ~
 729 \end_inset
 730
 731
 732 \begin_inset CommandInset ref
 733 LatexCommand ref
 734 reference "cha:Installing-New-Document"
 735
 736 \end_inset
 737
 738 .
 739 \end_layout
 740
 741 \begin_layout Labeling
 742 \labelwidthstring 00.00.0000
 743 \begin_inset Flex CharStyle:Code
 744 status collapsed
 745
 746 \begin_layout Plain Layout
 747 lyx2lyx
 748 \end_layout
 749
 750 \end_inset
 751
 752  contains the
 753 \begin_inset Flex CharStyle:Code
 754 status collapsed
 755
 756 \begin_layout Plain Layout
 757 lyx2lyx
 758 \end_layout
 759
 760 \end_inset
 761
 762  Python scripts used to convert between LyX versions.
 763  These can be run from the command line if, say, you want to batch-convert
 764  files.
 765 \end_layout
 766
 767 \begin_layout Labeling
 768 \labelwidthstring 00.00.0000
 769 \begin_inset Flex CharStyle:Code
 770 status collapsed
 771
 772 \begin_layout Plain Layout
 773 scripts/
 774 \end_layout
 775
 776 \end_inset
 777
 778  contains some files that demonstrate the capabilities of the
 779 \begin_inset Flex CharStyle:MenuItem
 780 status collapsed
 781
 782 \begin_layout Plain Layout
 783 External
 784 \begin_inset space ~
 785 \end_inset
 786
 787 Template
 788 \end_layout
 789
 790 \end_inset
 791
 792  feature.
 793  Also contains some scripts used by LyX itself.
 794 \end_layout
 795
 796 \begin_layout Labeling
 797 \labelwidthstring 00.00.0000
 798 \begin_inset Flex CharStyle:Code
 799 status collapsed
 800
 801 \begin_layout Plain Layout
 802 templates/
 803 \end_layout
 804
 805 \end_inset
 806
 807  contains the standard LyX template files described in Chapter
 808 \begin_inset space ~
 809 \end_inset
 810
 811
 812 \begin_inset CommandInset ref
 813 LatexCommand ref
 814 reference "sub:Creating-Templates"
 815
 816 \end_inset
 817
 818 .
 819 \end_layout
 820
 821 \begin_layout Labeling
 822 \labelwidthstring 00.00.0000
 823 \begin_inset Flex CharStyle:Code
 824 status collapsed
 825
 826 \begin_layout Plain Layout
 827 ui/
 828 \end_layout
 829
 830 \end_inset
 831
 832  contains files with the extension
 833 \begin_inset Flex CharStyle:Code
 834 status collapsed
 835
 836 \begin_layout Plain Layout
 837 .ui
 838 \end_layout
 839
 840 \end_inset
 841
 842  that define the user interface to LyX.
 843  That is, the files define which items appear in which menus and the items
 844  appearing on the toolbar.
 845 \end_layout
 846
 847 \begin_layout Subsection
 848 Files you don't want to modify
 849 \end_layout
 850
 851 \begin_layout Standard
 852 These files are used internally by LyX and you generally do not need to
 853  modify them unless you are a developer.
 854 \end_layout
 855
 856 \begin_layout Labeling
 857 \labelwidthstring 00.00.0000
 858 \begin_inset Flex CharStyle:Code
 859 status collapsed
 860
 861 \begin_layout Plain Layout
 862 CREDITS
 863 \end_layout
 864
 865 \end_inset
 866
 867  this file contains the list of LyX developers.
 868  The contents are displayed with the menu entry
 869 \begin_inset Flex CharStyle:MenuItem
 870 status collapsed
 871
 872 \begin_layout Plain Layout
 873 Help\SpecialChar \menuseparator
 874 About
 875 \begin_inset space ~
 876 \end_inset
 877
 878 LyX
 879 \end_layout
 880
 881 \end_inset
 882
 883 .
 884 \end_layout
 885
 886 \begin_layout Labeling
 887 \labelwidthstring 00.00.0000
 888 \begin_inset Flex CharStyle:Code
 889 status collapsed
 890
 891 \begin_layout Plain Layout
 892 chkconfig.ltx
 893 \end_layout
 894
 895 \end_inset
 896
 897  this is a LaTeX script used during the configuration process.
 898  Do not run directly.
 899 \end_layout
 900
 901 \begin_layout Labeling
 902 \labelwidthstring 00.00.0000
 903 \begin_inset Flex CharStyle:Code
 904 status collapsed
 905
 906 \begin_layout Plain Layout
 907 configure.py
 908 \end_layout
 909
 910 \end_inset
 911
 912  this is the script that is used to re-configure LyX.
 913  It creates configuration files in the directory it was run from.
 914 \end_layout
 915
 916 \begin_layout Subsection
 917 Other files needing a line or two...
 918 \end_layout
 919
 920 \begin_layout Labeling
 921 \labelwidthstring 00.00.0000
 922 \begin_inset Flex CharStyle:Code
 923 status collapsed
 924
 925 \begin_layout Plain Layout
 926 encodings
 927 \end_layout
 928
 929 \end_inset
 930
 931  this contains tables describing how different character encodings can be
 932  mapped to Unicode
 933 \end_layout
 934
 935 \begin_layout Labeling
 936 \labelwidthstring 00.00.0000
 937 \begin_inset Flex CharStyle:Code
 938 status collapsed
 939
 940 \begin_layout Plain Layout
 941 external_templates
 942 \end_layout
 943
 944 \end_inset
 945
 946  this file contains the templates available to the new
 947 \begin_inset Flex CharStyle:MenuItem
 948 status collapsed
 949
 950 \begin_layout Plain Layout
 951 External
 952 \begin_inset space ~
 953 \end_inset
 954
 955 Template
 956 \end_layout
 957
 958 \end_inset
 959
 960  feature.
 961 \end_layout
 962
 963 \begin_layout Labeling
 964 \labelwidthstring 00.00.0000
 965 \begin_inset Flex CharStyle:Code
 966 status collapsed
 967
 968 \begin_layout Plain Layout
 969 languages
 970 \end_layout
 971
 972 \end_inset
 973
 974  this file contains a list of all the languages currently supported by LyX.
 975 \end_layout
 976
 977 \begin_layout Section
 978 Your local configuration directory
 979 \end_layout
 980
 981 \begin_layout Standard
 982 Even if you are using LyX as an unprivileged user, you might want to change
 983  LyX configuration for your own use.
 984  The
 985 \begin_inset Flex CharStyle:Code
 986 status collapsed
 987
 988 \begin_layout Plain Layout
 989 UserDir
 990 \end_layout
 991
 992 \end_inset
 993
 994  directory contains all your personal configuration files.
 995  This is the directory described as
 996 \begin_inset Quotes eld
 997 \end_inset
 998
 999 user directory
1000 \begin_inset Quotes erd
1001 \end_inset
1002
1003  in
1004 \begin_inset Flex CharStyle:MenuItem
1005 status collapsed
1006
1007 \begin_layout Plain Layout
1008 Help\SpecialChar \menuseparator
1009 About
1010 \begin_inset space ~
1011 \end_inset
1012
1013 LyX
1014 \end_layout
1015
1016 \end_inset
1017
1018 .
1019  This directory is used as a mirror of
1020 \begin_inset Flex CharStyle:Code
1021 status collapsed
1022
1023 \begin_layout Plain Layout
1024 LyXDir
1025 \end_layout
1026
1027 \end_inset
1028
1029 , which means that every file in
1030 \begin_inset Flex CharStyle:Code
1031 status collapsed
1032
1033 \begin_layout Plain Layout
1034 UserDir
1035 \end_layout
1036
1037 \end_inset
1038
1039  is a replacement for the corresponding file in
1040 \begin_inset Flex CharStyle:Code
1041 status collapsed
1042
1043 \begin_layout Plain Layout
1044 LyXDir
1045 \end_layout
1046
1047 \end_inset
1048
1049 .
1050  Any configuration file described in the above sections can be placed either
1051  in the system-wide directory, in which case it will affect all users, or
1052  in your local directory for your own use.
1053 \end_layout
1054
1055 \begin_layout Standard
1056 To make things clearer, let's provide a few examples:
1057 \end_layout
1058
1059 \begin_layout Itemize
1060 The preferences set in the
1061 \begin_inset Flex CharStyle:MenuItem
1062 status collapsed
1063
1064 \begin_layout Plain Layout
1065 Tools\SpecialChar \menuseparator
1066 Preferences
1067 \end_layout
1068
1069 \end_inset
1070
1071  dialog are saved to a file
1072 \begin_inset Flex CharStyle:Code
1073 status collapsed
1074
1075 \begin_layout Plain Layout
1076 preferences
1077 \end_layout
1078
1079 \end_inset
1080
1081  in
1082 \begin_inset Flex CharStyle:Code
1083 status collapsed
1084
1085 \begin_layout Plain Layout
1086 UserDir
1087 \end_layout
1088
1089 \end_inset
1090
1091 .
1092 \end_layout
1093
1094 \begin_layout Itemize
1095 When you reconfigure using
1096 \begin_inset Flex CharStyle:MenuItem
1097 status collapsed
1098
1099 \begin_layout Plain Layout
1100 Tools\SpecialChar \menuseparator
1101 Reconfigure
1102 \end_layout
1103
1104 \end_inset
1105
1106 , LyX runs the
1107 \begin_inset Flex CharStyle:Code
1108 status collapsed
1109
1110 \begin_layout Plain Layout
1111 configure.py
1112 \end_layout
1113
1114 \end_inset
1115
1116  script, and the resulting files are written in your local configuration
1117  directory.
1118  This means that any additional text class file that you might have added
1119  in
1120 \begin_inset Flex CharStyle:Code
1121 status collapsed
1122
1123 \begin_layout Plain Layout
1124 UserDir/layouts
1125 \end_layout
1126
1127 \end_inset
1128
1129  will be added to the list of classes in the
1130 \begin_inset Flex CharStyle:MenuItem
1131 status collapsed
1132
1133 \begin_layout Plain Layout
1134 Document\SpecialChar \menuseparator
1135 Settings
1136 \end_layout
1137
1138 \end_inset
1139
1140  dialog.
1141 \end_layout
1142
1143 \begin_layout Itemize
1144 If you get some updated documentation from LyX ftp site and cannot install
1145  it because you do not have sysadmin rights on your system, you can just
1146  copy the files in
1147 \begin_inset Flex CharStyle:Code
1148 status collapsed
1149
1150 \begin_layout Plain Layout
1151 UserDir/doc/
1152 \end_layout
1153
1154 \end_inset
1155
1156  and the items in the
1157 \begin_inset Flex CharStyle:MenuItem
1158 status collapsed
1159
1160 \begin_layout Plain Layout
1161 Help
1162 \end_layout
1163
1164 \end_inset
1165
1166  menu will open them!
1167 \end_layout
1168
1169 \begin_layout Section
1170 Running LyX with multiple configurations
1171 \end_layout
1172
1173 \begin_layout Standard
1174 The configuration freedom of the local configuration directory may not suffice
1175  if you want to have more than one configuration at your disposal.
1176  For example, you may want to be use different key bindings or printer settings
1177  at different times.
1178  You can achieve this by having several such directories.
1179  You then specify which directory to use at run-time.
1180 \end_layout
1181
1182 \begin_layout Standard
1183 Invoking LyX with the command line switch
1184 \begin_inset Flex CharStyle:Code
1185 status collapsed
1186
1187 \begin_layout Plain Layout
1188 -userdir
1189 \end_layout
1190
1191 \end_inset
1192
1193
1194 \emph on
1195 <some directory>
1196 \emph default
1197  instructs the program to read the configuration from that directory, and
1198  not from the default directory.
1199  (You can determine the default directory by running LyX without the
1200 \begin_inset Flex CharStyle:Code
1201 status collapsed
1202
1203 \begin_layout Plain Layout
1204 -userdir
1205 \end_layout
1206
1207 \end_inset
1208
1209  switch.) If the specified directory does not exist, LyX offers to create
1210  it for you, just like it does for the default directory on the first time
1211  you run the program.
1212  You can modify the configuration options in this additional user directory
1213  exactly as you would for the default directory.
1214  These directories are completely independent (but read on).
1215  Note that setting the environment variable
1216 \begin_inset Flex CharStyle:Code
1217 status collapsed
1218
1219 \begin_layout Plain Layout
1220 LYX_USERDIR_VER
1221 \end_layout
1222
1223 \end_inset
1224
1225  to some value has exactly the same effect.
1226 \end_layout
1227
1228 \begin_layout Standard
1229 Having several configurations also requires more maintenance: if you want
1230  to add a new layout to
1231 \begin_inset Flex CharStyle:Code
1232 status collapsed
1233
1234 \begin_layout Plain Layout
1235 NewUserDir/layouts
1236 \end_layout
1237
1238 \end_inset
1239
1240  which you want available from all your configurations, you must add it
1241  to each directory separately.
1242  You can avoid this with the following trick: after LyX creates the additional
1243  directory, most of the subdirectories (see above) are empty.
1244  If you want the new configuration to mirror an existing one, replace the
1245  empty subdirectory with a symbolic link to the matching subdirectory in
1246  the existing configuration.
1247  Take care with the
1248 \begin_inset Flex CharStyle:Code
1249 status collapsed
1250
1251 \begin_layout Plain Layout
1252 doc/
1253 \end_layout
1254
1255 \end_inset
1256
1257  subdirectory, however, since it contains a file written by the configuration
1258  script (also accessible through
1259 \begin_inset Flex CharStyle:MenuItem
1260 status collapsed
1261
1262 \begin_layout Plain Layout
1263 Tools\SpecialChar \menuseparator
1264 Reconfigure
1265 \end_layout
1266
1267 \end_inset
1268
1269 ) which is configuration-specific.
1270 \end_layout
1271
1272 \begin_layout Chapter
1273 The Preferences dialog
1274 \end_layout
1275
1276 \begin_layout Standard
1277 All options of the preferences dialog are described in the Appendix
1278 \emph on
1279 The Preferences Dialog
1280 \emph default
1281  in the
1282 \emph on
1283 User's Guide
1284 \emph default
1285 .
1286  For some options you might find here more details.
1287 \end_layout
1288
1289 \begin_layout Section
1290 Formats
1291 \begin_inset CommandInset label
1292 LatexCommand label
1293 name "sec:Formats"
1294
1295 \end_inset
1296
1297
1298 \end_layout
1299
1300 \begin_layout Standard
1301 The first step is to define your file formats if they are not already defined.
1302  To do so, open the
1303 \begin_inset Flex CharStyle:MenuItem
1304 status collapsed
1305
1306 \begin_layout Plain Layout
1307 Tools\SpecialChar \menuseparator
1308 Preferences
1309 \end_layout
1310
1311 \end_inset
1312
1313  dialog.
1314  Under
1315 \begin_inset Flex CharStyle:MenuItem
1316 status collapsed
1317
1318 \begin_layout Plain Layout
1319 File Handling\SpecialChar \menuseparator
1320 File formats
1321 \end_layout
1322
1323 \end_inset
1324
1325  press the
1326 \begin_inset Flex CharStyle:MenuItem
1327 status collapsed
1328
1329 \begin_layout Plain Layout
1330 New\SpecialChar \ldots{}
1331
1332 \end_layout
1333
1334 \end_inset
1335
1336  button to define your new format.
1337  The
1338 \begin_inset Flex CharStyle:MenuItem
1339 status collapsed
1340
1341 \begin_layout Plain Layout
1342 Format
1343 \end_layout
1344
1345 \end_inset
1346
1347  field contains the name used to identify the format in the GUI.
1348  The
1349 \begin_inset Flex CharStyle:MenuItem
1350 status collapsed
1351
1352 \begin_layout Plain Layout
1353 Short Name
1354 \end_layout
1355
1356 \end_inset
1357
1358  is used to identify the format internally.
1359  You will also need to enter a file extension.
1360  These are all required.
1361  The optional
1362 \begin_inset Flex CharStyle:MenuItem
1363 status collapsed
1364
1365 \begin_layout Plain Layout
1366 Shortcut
1367 \end_layout
1368
1369 \end_inset
1370
1371  field is used to provide a keyboard shortcut on the menus.
1372  (For example, pressing
1373 \begin_inset Flex CharStyle:MenuItem
1374 status collapsed
1375
1376 \begin_layout Plain Layout
1377 Alt-V D
1378 \end_layout
1379
1380 \end_inset
1381
1382  will
1383 \begin_inset Flex CharStyle:MenuItem
1384 status collapsed
1385
1386 \begin_layout Plain Layout
1387 View\SpecialChar \menuseparator
1388 DVI
1389 \end_layout
1390
1391 \end_inset
1392
1393 .)
1394 \end_layout
1395
1396 \begin_layout Standard
1397 A Format can have a
1398 \begin_inset Flex CharStyle:MenuItem
1399 status collapsed
1400
1401 \begin_layout Plain Layout
1402 Viewer
1403 \end_layout
1404
1405 \end_inset
1406
1407  and an
1408 \begin_inset Flex CharStyle:MenuItem
1409 status collapsed
1410
1411 \begin_layout Plain Layout
1412 Editor
1413 \end_layout
1414
1415 \end_inset
1416
1417  associated with it.
1418  For example, you might want to use
1419 \begin_inset Flex CharStyle:MenuItem
1420 status collapsed
1421
1422 \begin_layout Plain Layout
1423 Ghostview
1424 \end_layout
1425
1426 \end_inset
1427
1428  to view PostScript files.
1429  You can enter the command needed to start the program in the corresponding
1430  fields.
1431  In defining this command, you can use the four variables listed in the
1432  next section.
1433  The viewer is launched when you view an image in LyX or use the
1434 \begin_inset Flex CharStyle:MenuItem
1435 status collapsed
1436
1437 \begin_layout Plain Layout
1438 View
1439 \end_layout
1440
1441 \end_inset
1442
1443  menu.
1444  The editor is for example launched when you right-click on an image and
1445  choose
1446 \begin_inset Flex CharStyle:MenuItem
1447 status collapsed
1448
1449 \begin_layout Plain Layout
1450 Edit externally
1451 \end_layout
1452
1453 \end_inset
1454
1455  in the appearing context menu.
1456 \end_layout
1457
1458 \begin_layout Standard
1459 The
1460 \begin_inset Flex CharStyle:MenuItem
1461 status collapsed
1462
1463 \begin_layout Plain Layout
1464 Document format
1465 \end_layout
1466
1467 \end_inset
1468
1469  option tells LyX that a format is suitable for document export.
1470  If this is set and if a suitable conversion route exists (see sec.
1471 \begin_inset space \thinspace{}
1472 \end_inset
1473
1474
1475 \begin_inset CommandInset ref
1476 LatexCommand ref
1477 reference "sec:Converters"
1478
1479 \end_inset
1480
1481 ), the format will appear in the
1482 \begin_inset Flex CharStyle:MenuItem
1483 status collapsed
1484
1485 \begin_layout Plain Layout
1486 File\SpecialChar \menuseparator
1487 Export
1488 \end_layout
1489
1490 \end_inset
1491
1492  menu.
1493  The format will also appear in the
1494 \begin_inset Flex CharStyle:MenuItem
1495 status collapsed
1496
1497 \begin_layout Plain Layout
1498 View
1499 \end_layout
1500
1501 \end_inset
1502
1503  menu if a viewer is specified for the format.
1504  Pure image formats, such as
1505 \begin_inset Flex CharStyle:Code
1506 status collapsed
1507
1508 \begin_layout Plain Layout
1509 png
1510 \end_layout
1511
1512 \end_inset
1513
1514 , should not use this option.
1515  Formats that can both represent vector graphics and documents like
1516 \begin_inset Flex CharStyle:Code
1517 status collapsed
1518
1519 \begin_layout Plain Layout
1520 pdf
1521 \end_layout
1522
1523 \end_inset
1524
1525  should use it.
1526 \end_layout
1527
1528 \begin_layout Standard
1529 The option
1530 \begin_inset Flex CharStyle:MenuItem
1531 status collapsed
1532
1533 \begin_layout Plain Layout
1534 Vector graphics format
1535 \end_layout
1536
1537 \end_inset
1538
1539  tells LyX that a format can contain vector graphics.
1540  This information is used to determine the target format of included graphics
1541  for
1542 \begin_inset Flex CharStyle:MenuItem
1543 status collapsed
1544
1545 \begin_layout Plain Layout
1546 pdflatex
1547 \end_layout
1548
1549 \end_inset
1550
1551  export.
1552  Included graphics may need to be converted to either
1553 \begin_inset Flex CharStyle:MenuItem
1554 status collapsed
1555
1556 \begin_layout Plain Layout
1557 pdf
1558 \end_layout
1559
1560 \end_inset
1561
1562 ,
1563 \begin_inset Flex CharStyle:MenuItem
1564 status collapsed
1565
1566 \begin_layout Plain Layout
1567 png
1568 \end_layout
1569
1570 \end_inset
1571
1572 , or
1573 \begin_inset Flex CharStyle:MenuItem
1574 status collapsed
1575
1576 \begin_layout Plain Layout
1577 jpg
1578 \end_layout
1579
1580 \end_inset
1581
1582 , since
1583 \begin_inset Flex CharStyle:MenuItem
1584 status collapsed
1585
1586 \begin_layout Plain Layout
1587 pdflatex
1588 \end_layout
1589
1590 \end_inset
1591
1592  cannot handle other image formats.
1593  If an included graphic is not already in
1594 \begin_inset Flex CharStyle:MenuItem
1595 status collapsed
1596
1597 \begin_layout Plain Layout
1598 pdf
1599 \end_layout
1600
1601 \end_inset
1602
1603 ,
1604 \begin_inset Flex CharStyle:MenuItem
1605 status collapsed
1606
1607 \begin_layout Plain Layout
1608 png
1609 \end_layout
1610
1611 \end_inset
1612
1613 , or
1614 \begin_inset Flex CharStyle:MenuItem
1615 status collapsed
1616
1617 \begin_layout Plain Layout
1618 jpg
1619 \end_layout
1620
1621 \end_inset
1622
1623  format, it is converted to
1624 \begin_inset Flex CharStyle:MenuItem
1625 status collapsed
1626
1627 \begin_layout Plain Layout
1628 pdf
1629 \end_layout
1630
1631 \end_inset
1632
1633  if the vector format option is set, and otherwise to
1634 \begin_inset Flex CharStyle:MenuItem
1635 status collapsed
1636
1637 \begin_layout Plain Layout
1638 png
1639 \end_layout
1640
1641 \end_inset
1642
1643 .
1644 \end_layout
1645
1646 \begin_layout Section
1647 Copiers
1648 \end_layout
1649
1650 \begin_layout Standard
1651 Since all conversions from one format to another take place in LyX's temporary
1652  directory, it is sometimes necessary to modify a file before copying it
1653  to the temporary directory in order that the conversion may be performed.
1654 \begin_inset Foot
1655 status collapsed
1656
1657 \begin_layout Plain Layout
1658 For example, the file may refer to other files—images, for example—using
1659  relative file names, and these may become invalid when the file is copied
1660  to the temporary directory.
1661 \end_layout
1662
1663 \end_inset
1664
1665  This is done by a Copier: It copies a file to (or from) the temporary directory
1666  and may modify it in the process.
1667 \end_layout
1668
1669 \begin_layout Standard
1670 The definitions of the copiers may use four variables:
1671 \end_layout
1672
1673 \begin_layout Labeling
1674 \labelwidthstring 00.00.0000
1675 \begin_inset Flex CharStyle:Code
1676 status collapsed
1677
1678 \begin_layout Plain Layout
1679 $$s
1680 \end_layout
1681
1682 \end_inset
1683
1684  The LyX system directory (e.
1685 \begin_inset space \thinspace{}
1686 \end_inset
1687
1688 g.
1689 \begin_inset space \space{}
1690 \end_inset
1691
1692
1693 \begin_inset Flex CharStyle:MenuItem
1694 status collapsed
1695
1696 \begin_layout Plain Layout
1697 /usr/share/lyx
1698 \end_layout
1699
1700 \end_inset
1701
1702 ).
1703 \end_layout
1704
1705 \begin_layout Labeling
1706 \labelwidthstring 00.00.0000
1707 \begin_inset Flex CharStyle:Code
1708 status collapsed
1709
1710 \begin_layout Plain Layout
1711 $$i
1712 \end_layout
1713
1714 \end_inset
1715
1716  The input file
1717 \end_layout
1718
1719 \begin_layout Labeling
1720 \labelwidthstring 00.00.0000
1721 \begin_inset Flex CharStyle:Code
1722 status collapsed
1723
1724 \begin_layout Plain Layout
1725 $$o
1726 \end_layout
1727
1728 \end_inset
1729
1730  The output file
1731 \end_layout
1732
1733 \begin_layout Labeling
1734 \labelwidthstring 00.00.0000
1735 \begin_inset Flex CharStyle:Code
1736 status collapsed
1737
1738 \begin_layout Plain Layout
1739 $$l
1740 \end_layout
1741
1742 \end_inset
1743
1744  The `LaTeX name'
1745 \end_layout
1746
1747 \begin_layout Standard
1748 The latter should be the filename as it would be used in a LaTeX's
1749 \series bold
1750
1751 \backslash
1752 include
1753 \series default
1754  command.
1755  It is relevant only when exporting files suitable for such inclusion.
1756 \end_layout
1757
1758 \begin_layout Standard
1759 Copiers can be used to do almost anything with output files.
1760  For example, suppose you want generated pdf files to be copied to a special
1761  directory,
1762 \begin_inset Flex CharStyle:Code
1763 status collapsed
1764
1765 \begin_layout Plain Layout
1766 /home/you/pdf/
1767 \end_layout
1768
1769 \end_inset
1770
1771 .
1772  Then you could write a shell script such as this one:
1773 \end_layout
1774
1775 \begin_layout Standard
1776 \begin_inset listings
1777 inline false
1778 status open
1779
1780 \begin_layout Plain Layout
1781
1782 #!/bin/bash
1783 \end_layout
1784
1785 \begin_layout Plain Layout
1786
1787 FROMFILE=$1
1788 \end_layout
1789
1790 \begin_layout Plain Layout
1791
1792 TOFILE=`basename $2`
1793 \end_layout
1794
1795 \begin_layout Plain Layout
1796
1797 cp $FROMFILE /home/you/pdf/$TOFILE
1798 \end_layout
1799
1800 \end_inset
1801
1802 Save it in your local LyX directory—say,
1803 \begin_inset Flex CharStyle:Code
1804 status collapsed
1805
1806 \begin_layout Plain Layout
1807 /home/you/.lyx/scripts/pdfcopier.sh
1808 \end_layout
1809
1810 \end_inset
1811
1812 —and make it executable, if you need to do so on your platform.
1813  Then, in the
1814 \begin_inset Flex CharStyle:MenuItem
1815 status collapsed
1816
1817 \begin_layout Plain Layout
1818 Tools\SpecialChar \menuseparator
1819 Preferences
1820 \end_layout
1821
1822 \end_inset
1823
1824  dialog, select under
1825 \begin_inset Flex CharStyle:MenuItem
1826 status collapsed
1827
1828 \begin_layout Plain Layout
1829 File Handling\SpecialChar \menuseparator
1830 File formats
1831 \end_layout
1832
1833 \end_inset
1834
1835  the
1836 \begin_inset Flex CharStyle:MenuItem
1837 status collapsed
1838
1839 \begin_layout Plain Layout
1840 PDF(pdflatex)
1841 \end_layout
1842
1843 \end_inset
1844
1845  format—or one of the other pdf formats—and enter
1846 \begin_inset Flex CharStyle:Code
1847 status collapsed
1848
1849 \begin_layout Plain Layout
1850 pdfcopier.sh $$i $$o
1851 \end_layout
1852
1853 \end_inset
1854
1855  into the
1856 \begin_inset Flex CharStyle:MenuItem
1857 status collapsed
1858
1859 \begin_layout Plain Layout
1860 Copier
1861 \end_layout
1862
1863 \end_inset
1864
1865  field.
1866
1867 \end_layout
1868
1869 \begin_layout Standard
1870 Copiers are used by LyX in various of its own conversions.
1871  For example, if appropriate programs are found, LyX will automatically
1872  install copiers for the
1873 \begin_inset Flex CharStyle:MenuItem
1874 status collapsed
1875
1876 \begin_layout Plain Layout
1877 HTML
1878 \end_layout
1879
1880 \end_inset
1881
1882  and
1883 \begin_inset Flex CharStyle:MenuItem
1884 status collapsed
1885
1886 \begin_layout Plain Layout
1887 HTML
1888 \begin_inset space ~
1889 \end_inset
1890
1891 (MS Word)
1892 \end_layout
1893
1894 \end_inset
1895
1896  formats.
1897  When these formats are exported, the copier sees that not just the main
1898  HTML file but various associated files (style files, images, etc.) are also
1899  copied.
1900  All these files are written to a subdirectory of the directory in which
1901  the original LyX file was found.
1902 \begin_inset Foot
1903 status collapsed
1904
1905 \begin_layout Plain Layout
1906 This copier can be customized.
1907  The optional
1908 \begin_inset Quotes eld
1909 \end_inset
1910
1911 -e
1912 \begin_inset Quotes erd
1913 \end_inset
1914
1915  argument takes a comma-separated list of extensions to be copied; if it
1916  is omitted, all files will be copied.
1917  The
1918 \begin_inset Quotes eld
1919 \end_inset
1920
1921 -t
1922 \begin_inset Quotes erd
1923 \end_inset
1924
1925  argument determines the extension added to the generated directory.
1926  By default, it is
1927 \begin_inset Quotes eld
1928 \end_inset
1929
1930
1931 \begin_inset Flex CharStyle:MenuItem
1932 status collapsed
1933
1934 \begin_layout Plain Layout
1935 LyXconv
1936 \end_layout
1937
1938 \end_inset
1939
1940
1941 \begin_inset Quotes erd
1942 \end_inset
1943
1944 , so HTML generated from
1945 \begin_inset Flex CharStyle:MenuItem
1946 status collapsed
1947
1948 \begin_layout Plain Layout
1949 /path/to/filename.lyx
1950 \end_layout
1951
1952 \end_inset
1953
1954  will end up in
1955 \begin_inset Flex CharStyle:MenuItem
1956 status collapsed
1957
1958 \begin_layout Plain Layout
1959 /path/to/filename.html.LyXconv
1960 \end_layout
1961
1962 \end_inset
1963
1964 .
1965
1966 \end_layout
1967
1968 \end_inset
1969
1970
1971 \end_layout
1972
1973 \begin_layout Section
1974 Converters
1975 \begin_inset CommandInset label
1976 LatexCommand label
1977 name "sec:Converters"
1978
1979 \end_inset
1980
1981
1982 \end_layout
1983
1984 \begin_layout Standard
1985 You can define your own Converters to convert files between different formats.
1986  This is done in the
1987 \begin_inset Flex CharStyle:MenuItem
1988 status collapsed
1989
1990 \begin_layout Plain Layout
1991 Tools\SpecialChar \menuseparator
1992 Preferences\SpecialChar \menuseparator
1993 File Handling\SpecialChar \menuseparator
1994 Converters
1995 \end_layout
1996
1997 \end_inset
1998
1999  dialog.
2000 \end_layout
2001
2002 \begin_layout Standard
2003 To define a new converter, select the
2004 \begin_inset Flex CharStyle:MenuItem
2005 status collapsed
2006
2007 \begin_layout Plain Layout
2008 From
2009 \begin_inset space ~
2010 \end_inset
2011
2012 format
2013 \end_layout
2014
2015 \end_inset
2016
2017  and
2018 \begin_inset Flex CharStyle:MenuItem
2019 status collapsed
2020
2021 \begin_layout Plain Layout
2022 To
2023 \begin_inset space ~
2024 \end_inset
2025
2026 format
2027 \end_layout
2028
2029 \end_inset
2030
2031  from the drop-down lists, enter the command needed for the conversion,
2032  and then press the
2033 \begin_inset Flex CharStyle:MenuItem
2034 status collapsed
2035
2036 \begin_layout Plain Layout
2037 Add
2038 \end_layout
2039
2040 \end_inset
2041
2042  button.
2043  Several variables can be used in the definition of converters:
2044 \end_layout
2045
2046 \begin_layout Labeling
2047 \labelwidthstring 00.00.0000
2048 \begin_inset Flex CharStyle:Code
2049 status collapsed
2050
2051 \begin_layout Plain Layout
2052 $$s
2053 \end_layout
2054
2055 \end_inset
2056
2057  The LyX system directory
2058 \end_layout
2059
2060 \begin_layout Labeling
2061 \labelwidthstring 00.00.0000
2062 \begin_inset Flex CharStyle:Code
2063 status collapsed
2064
2065 \begin_layout Plain Layout
2066 $$i
2067 \end_layout
2068
2069 \end_inset
2070
2071  The input file
2072 \end_layout
2073
2074 \begin_layout Labeling
2075 \labelwidthstring 00.00.0000
2076 \begin_inset Flex CharStyle:Code
2077 status collapsed
2078
2079 \begin_layout Plain Layout
2080 $$o
2081 \end_layout
2082
2083 \end_inset
2084
2085  The output file
2086 \end_layout
2087
2088 \begin_layout Labeling
2089 \labelwidthstring 00.00.0000
2090 \begin_inset Flex CharStyle:Code
2091 status collapsed
2092
2093 \begin_layout Plain Layout
2094 $$b
2095 \end_layout
2096
2097 \end_inset
2098
2099  The base filename of the input file (i.
2100 \begin_inset space \thinspace{}
2101 \end_inset
2102
2103 g., without the extension)
2104 \end_layout
2105
2106 \begin_layout Labeling
2107 \labelwidthstring 00.00.0000
2108 \begin_inset Flex CharStyle:Code
2109 status collapsed
2110
2111 \begin_layout Plain Layout
2112 $$p
2113 \end_layout
2114
2115 \end_inset
2116
2117  The path to the input file
2118 \end_layout
2119
2120 \begin_layout Labeling
2121 \labelwidthstring 00.00.0000
2122 \begin_inset Flex CharStyle:Code
2123 status collapsed
2124
2125 \begin_layout Plain Layout
2126 $$r
2127 \end_layout
2128
2129 \end_inset
2130
2131  The path to the original input file (this is different from $$p when a
2132  chain of converters is called).
2133 \end_layout
2134
2135 \begin_layout Standard
2136 In the
2137 \begin_inset Flex CharStyle:MenuItem
2138 status collapsed
2139
2140 \begin_layout Plain Layout
2141 Extra
2142 \begin_inset space ~
2143 \end_inset
2144
2145 Flag
2146 \end_layout
2147
2148 \end_inset
2149
2150  field you can enter the following flags, separated by commas:
2151 \end_layout
2152
2153 \begin_layout Labeling
2154 \labelwidthstring 00.00.0000
2155 \begin_inset Flex CharStyle:Code
2156 status collapsed
2157
2158 \begin_layout Plain Layout
2159 latex
2160 \end_layout
2161
2162 \end_inset
2163
2164  This converter runs some form of LaTeX.
2165  This will make LyX's LaTeX error logs available.
2166 \end_layout
2167
2168 \begin_layout Labeling
2169 \labelwidthstring 00.00.0000
2170 \begin_inset Flex CharStyle:Code
2171 status collapsed
2172
2173 \begin_layout Plain Layout
2174 needaux
2175 \end_layout
2176
2177 \end_inset
2178
2179  Needs the LaTeX
2180 \begin_inset Flex CharStyle:MenuItem
2181 status collapsed
2182
2183 \begin_layout Plain Layout
2184 .aux
2185 \end_layout
2186
2187 \end_inset
2188
2189  file for the conversion.
2190 \end_layout
2191
2192 \begin_layout Labeling
2193 \labelwidthstring 00.00.0000
2194 \begin_inset Flex CharStyle:Code
2195 status collapsed
2196
2197 \begin_layout Plain Layout
2198 xml
2199 \end_layout
2200
2201 \end_inset
2202
2203  Output is XML.
2204 \end_layout
2205
2206 \begin_layout Standard
2207 The following three flags are not really flags at all because they take
2208  an argument in the
2209 \begin_inset Flex CharStyle:MenuItem
2210 status collapsed
2211
2212 \begin_layout Plain Layout
2213 key
2214 \begin_inset space ~
2215 \end_inset
2216
2217 =
2218 \begin_inset space ~
2219 \end_inset
2220
2221 value
2222 \end_layout
2223
2224 \end_inset
2225
2226  format:
2227 \end_layout
2228
2229 \begin_layout Labeling
2230 \labelwidthstring 00.00.0000
2231 \begin_inset Flex CharStyle:Code
2232 status collapsed
2233
2234 \begin_layout Plain Layout
2235 parselog
2236 \end_layout
2237
2238 \end_inset
2239
2240  If set, the converter's standard error will be redirected to a file
2241 \begin_inset Flex CharStyle:Code
2242 status collapsed
2243
2244 \begin_layout Plain Layout
2245 infile.out
2246 \end_layout
2247
2248 \end_inset
2249
2250 , and the script given as argument will be run as:
2251 \begin_inset Flex CharStyle:Code
2252 status collapsed
2253
2254 \begin_layout Plain Layout
2255 script < infile.out > infile.log
2256 \end_layout
2257
2258 \end_inset
2259
2260 .
2261  The argument may contain
2262 \begin_inset Flex CharStyle:Code
2263 status collapsed
2264
2265 \begin_layout Plain Layout
2266 $$s
2267 \end_layout
2268
2269 \end_inset
2270
2271 .
2272 \end_layout
2273
2274 \begin_layout Labeling
2275 \labelwidthstring 00.00.0000
2276 \begin_inset Flex CharStyle:Code
2277 status collapsed
2278
2279 \begin_layout Plain Layout
2280 resultdir
2281 \end_layout
2282
2283 \end_inset
2284
2285  The name of the directory in which the converter will dump the generated
2286  files.
2287  LyX will not create this directory, and it does not copy anything into
2288  it, though it will copy this directory to the destination.
2289  The argument may contain
2290 \begin_inset Flex CharStyle:Code
2291 status collapsed
2292
2293 \begin_layout Plain Layout
2294 $$b
2295 \end_layout
2296
2297 \end_inset
2298
2299 , which will be replaced by the base name of the input and output files,
2300  respectively, when the directory is copied.
2301 \begin_inset Newline newline
2302 \end_inset
2303
2304 Note that resultdir and usetempdir make no sense together.
2305  The latter will be ignored if the former is given.
2306 \end_layout
2307
2308 \begin_layout Labeling
2309 \labelwidthstring 00.00.0000
2310 \begin_inset Flex CharStyle:Code
2311 status collapsed
2312
2313 \begin_layout Plain Layout
2314 resultfile
2315 \end_layout
2316
2317 \end_inset
2318
2319  Determines the output file name and may, contain
2320 \begin_inset Flex CharStyle:Code
2321 status collapsed
2322
2323 \begin_layout Plain Layout
2324 $$b
2325 \end_layout
2326
2327 \end_inset
2328
2329 .
2330  Sensible only with resultdir and optional even then; if not given, it defaults
2331  to `index'.
2332 \end_layout
2333
2334 \begin_layout Standard
2335 None of these last three are presently used in any of the converters that
2336  are installed with LyX.
2337
2338 \end_layout
2339
2340 \begin_layout Standard
2341 You do not have to define converters for all formats between which you want
2342  to convert.
2343  For example, you will note that there is no `LyX to PostScript' converter,
2344  but LyX will export PostScript.
2345  It does so by first creating a LaTeX file (no converter needs to be defined
2346  for this) which is then converted to DVI using the `LaTeX to DVI' converter,
2347  and finally converting the resulting DVI file to PostScript.
2348  LyX finds such `chains' of converters automatically, and it will always
2349  choose the shortest possible chain.
2350  You can, though, still define multiple conversion methods between file
2351  formats.
2352  For example, the standard LyX configuration provides three ways to convert
2353  LaTeX to PDF: Directly, using
2354 \begin_inset Flex CharStyle:MenuItem
2355 status collapsed
2356
2357 \begin_layout Plain Layout
2358 pdflatex
2359 \end_layout
2360
2361 \end_inset
2362
2363 ; via (DVI and) PostScript, using
2364 \begin_inset Flex CharStyle:MenuItem
2365 status collapsed
2366
2367 \begin_layout Plain Layout
2368 ps2pdf
2369 \end_layout
2370
2371 \end_inset
2372
2373 ; or via DVI, using
2374 \begin_inset Flex CharStyle:MenuItem
2375 status collapsed
2376
2377 \begin_layout Plain Layout
2378 dvipdfm
2379 \end_layout
2380
2381 \end_inset
2382
2383 .
2384  To define such alternate chains, you must define multiple target `file
2385  formats', as described in section
2386 \begin_inset CommandInset ref
2387 LatexCommand ref
2388 reference "sec:Formats"
2389
2390 \end_inset
2391
2392 .
2393  For example, in the standard configuration, the formats named
2394 \begin_inset Flex CharStyle:MenuItem
2395 status collapsed
2396
2397 \begin_layout Plain Layout
2398 pdf
2399 \end_layout
2400
2401 \end_inset
2402
2403 ,
2404 \begin_inset Flex CharStyle:MenuItem
2405 status collapsed
2406
2407 \begin_layout Plain Layout
2408 pdf2
2409 \end_layout
2410
2411 \end_inset
2412
2413 , and
2414 \begin_inset Flex CharStyle:MenuItem
2415 status collapsed
2416
2417 \begin_layout Plain Layout
2418 pdf3
2419 \end_layout
2420
2421 \end_inset
2422
2423  are defined, all of which share the extension
2424 \begin_inset Flex CharStyle:MenuItem
2425 status collapsed
2426
2427 \begin_layout Plain Layout
2428 .pdf
2429 \end_layout
2430
2431 \end_inset
2432
2433 , and which correspond to the conversion methods just mentioned.
2434 \end_layout
2435
2436 \begin_layout Chapter
2437 Internationalizing LyX
2438 \begin_inset CommandInset label
2439 LatexCommand label
2440 name "cha:Internationalizing-LyX"
2441
2442 \end_inset
2443
2444
2445 \end_layout
2446
2447 \begin_layout Standard
2448 LyX supports using a translated interface.
2449  Last time we checked, LyX provided text in thirty languages.
2450  The language of choice is called your
2451 \emph on
2452 locale
2453 \emph default
2454 .
2455  (For further reading on locale settings, see also the documentation for
2456  locale that comes with your operating system.
2457  For Linux, the manual page for
2458 \begin_inset Flex CharStyle:Code
2459 status collapsed
2460
2461 \begin_layout Plain Layout
2462 locale(5)
2463 \end_layout
2464
2465 \end_inset
2466
2467  could be a good place to start).
2468 \end_layout
2469
2470 \begin_layout Standard
2471 Notice that these translations will work, but do contain a few flaws.
2472  In particular, all dialogs have been designed with the English text in
2473  mind, which means that some of the translated text will be too large to
2474  fit within the space allocated.
2475  This is only a display problem and will not cause any harm.
2476  Also, you will find that some of the translations do not define shortcut
2477  keys for everything.
2478  Sometimes, there are simply not enough free letters to do it.
2479  Other times, the translator just hasn't got around to doing it yet.
2480  Our localization team, which you may wish to join,
2481 \begin_inset Foot
2482 status collapsed
2483
2484 \begin_layout Plain Layout
2485 If you are a fluent speaker of a language other than English, joining these
2486  teams is a great way to give back to the LyX community!
2487 \end_layout
2488
2489 \end_inset
2490
2491  will of course try to fix these shortcomings in future versions of LyX.
2492 \end_layout
2493
2494 \begin_layout Section
2495 Translating LyX
2496 \end_layout
2497
2498 \begin_layout Subsection
2499 Translating the graphical user interface (text messages).
2500 \end_layout
2501
2502 \begin_layout Standard
2503 LyX uses the GNU
2504 \begin_inset Flex CharStyle:Code
2505 status collapsed
2506
2507 \begin_layout Plain Layout
2508 gettext
2509 \end_layout
2510
2511 \end_inset
2512
2513  library to handle the internationalization of the interface.
2514  To have LyX speak your favorite language in all menus and dialogs, you
2515  need a
2516 \begin_inset Flex CharStyle:Code
2517 status collapsed
2518
2519 \begin_layout Plain Layout
2520 po
2521 \end_layout
2522
2523 \end_inset
2524
2525 -file for that language.
2526  When this is available, you'll have to generate a
2527 \begin_inset Flex CharStyle:Code
2528 status collapsed
2529
2530 \begin_layout Plain Layout
2531 mo
2532 \end_layout
2533
2534 \end_inset
2535
2536 -file from it and install the
2537 \begin_inset Flex CharStyle:Code
2538 status collapsed
2539
2540 \begin_layout Plain Layout
2541 mo
2542 \end_layout
2543
2544 \end_inset
2545
2546 -file.
2547  The process of doing all of this is explained in the documentation for
2548  GNU
2549 \begin_inset Flex CharStyle:Code
2550 status collapsed
2551
2552 \begin_layout Plain Layout
2553 gettext
2554 \end_layout
2555
2556 \end_inset
2557
2558 .
2559  It is possible to do this just for yourself, but if you're going to do
2560  it, you might as well share the results of your labors with the rest of
2561  the LyX community.
2562  Send a message to the LyX developers' list for more information about how
2563  to proceed.
2564 \end_layout
2565
2566 \begin_layout Standard
2567 In short, this is what you should do (xx denotes the language code):
2568 \end_layout
2569
2570 \begin_layout Itemize
2571 Check out the LyX source code.
2572  (See the
2573 \begin_inset CommandInset href
2574 LatexCommand href
2575 name "information on the web"
2576 target "http://www.lyx.org/devel/cvs.php"
2577
2578 \end_inset
2579
2580 .)
2581 \end_layout
2582
2583 \begin_layout Itemize
2584 Copy the file
2585 \begin_inset Flex CharStyle:Code
2586 status collapsed
2587
2588 \begin_layout Plain Layout
2589 lyx.pot
2590 \end_layout
2591
2592 \end_inset
2593
2594  to the folder of the
2595 \begin_inset Flex CharStyle:Code
2596 status collapsed
2597
2598 \begin_layout Plain Layout
2599 **.po
2600 \end_layout
2601
2602 \end_inset
2603
2604  files.
2605  Then rename it to
2606 \begin_inset Flex CharStyle:Code
2607 status collapsed
2608
2609 \begin_layout Plain Layout
2610 xx.po
2611 \end_layout
2612
2613 \end_inset
2614
2615 .
2616  (If
2617 \begin_inset Flex CharStyle:Code
2618 status collapsed
2619
2620 \begin_layout Plain Layout
2621 lyx.pot
2622 \end_layout
2623
2624 \end_inset
2625
2626  doesn't exist anywhere, it can be remade with the console command
2627 \begin_inset Flex CharStyle:Code
2628 status collapsed
2629
2630 \begin_layout Plain Layout
2631 make lyx.pot
2632 \end_layout
2633
2634 \end_inset
2635
2636  in that directory, or you can use an existing po-file for some other language
2637  as a template).
2638 \end_layout
2639
2640 \begin_layout Itemize
2641 Edit
2642 \begin_inset Flex CharStyle:Code
2643 status collapsed
2644
2645 \begin_layout Plain Layout
2646 xx.po
2647 \end_layout
2648
2649 \end_inset
2650
2651 .
2652 \begin_inset Foot
2653 status collapsed
2654
2655 \begin_layout Plain Layout
2656 This is just a text file, so it can be edited in any text editor.
2657  But there are also specialized programs that support such editing, such
2658  as
2659 \family typewriter
2660 Poedit
2661 \family default
2662  (for all platforms) or
2663 \family typewriter
2664 KBabel
2665 \family default
2666  (for KDE).
2667
2668 \family typewriter
2669 Emacs
2670 \family default
2671  contains a `mode' for editing
2672 \begin_inset Flex CharStyle:Code
2673 status collapsed
2674
2675 \begin_layout Plain Layout
2676 po
2677 \end_layout
2678
2679 \end_inset
2680
2681  files, as well.
2682 \end_layout
2683
2684 \end_inset
2685
2686  For some menu- and widget-labels, there are also shortcut keys that should
2687  be translated.
2688  Those keys are marked after a `|', and should be translated according to
2689  the words and phrases of the language.
2690  You should also fill also out the information at the beginning of the new
2691
2692 \begin_inset Flex CharStyle:Code
2693 status collapsed
2694
2695 \begin_layout Plain Layout
2696 po
2697 \end_layout
2698
2699 \end_inset
2700
2701 -file with your email-address, etc., so people know where to reach you with
2702  suggestions and entertaining flames.
2703 \end_layout
2704
2705 \begin_layout Standard
2706 If you are just doing this on your own, then:
2707 \end_layout
2708
2709 \begin_layout Itemize
2710 Generate
2711 \begin_inset Flex CharStyle:Code
2712 status collapsed
2713
2714 \begin_layout Plain Layout
2715 xx.mo
2716 \end_layout
2717
2718 \end_inset
2719
2720 .
2721  This can be done with
2722 \begin_inset Flex CharStyle:Code
2723 status collapsed
2724
2725 \begin_layout Plain Layout
2726 msgfmt -o xx.mo < xx.po
2727 \end_layout
2728
2729 \end_inset
2730
2731 .
2732 \end_layout
2733
2734 \begin_layout Itemize
2735 Copy the
2736 \begin_inset Flex CharStyle:Code
2737 status collapsed
2738
2739 \begin_layout Plain Layout
2740 mo
2741 \end_layout
2742
2743 \end_inset
2744
2745 -file to your locale-tree, at the correct directory for application messages
2746  for the language
2747 \series bold
2748
2749 \series default
2750 xx, and under the name
2751 \begin_inset Flex CharStyle:Code
2752 status collapsed
2753
2754 \begin_layout Plain Layout
2755 lyx.mo
2756 \end_layout
2757
2758 \end_inset
2759
2760  (e.
2761 \begin_inset space \thinspace{}
2762 \end_inset
2763
2764 g.
2765 \begin_inset space \space{}
2766 \end_inset
2767
2768
2769 \begin_inset Flex CharStyle:Code
2770 status collapsed
2771
2772 \begin_layout Plain Layout
2773 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
2774 \end_layout
2775
2776 \end_inset
2777
2778
2779 \series bold
2780 .
2781 \end_layout
2782
2783 \begin_layout Standard
2784 As said, however, it would be best if the new
2785 \begin_inset Flex CharStyle:Code
2786 status collapsed
2787
2788 \begin_layout Plain Layout
2789 po
2790 \end_layout
2791
2792 \end_inset
2793
2794 -file could be added to the LyX distribution, so others can use it.
2795  Adding it involves making additional changes to LyX.
2796  So send an email to the developers' mailing list if you're interested in
2797  doing that.
2798 \end_layout
2799
2800 \begin_layout Subsubsection
2801 Ambiguous messages
2802 \end_layout
2803
2804 \begin_layout Standard
2805 Sometimes it turns out that one English message needs to be translated into
2806  different messages in the target language.
2807  One example is the message
2808 \begin_inset Flex CharStyle:Code
2809 status collapsed
2810
2811 \begin_layout Plain Layout
2812 To
2813 \end_layout
2814
2815 \end_inset
2816
2817  which has the German translation
2818 \lang german
2819 Nach
2820 \lang english
2821  or
2822 \lang german
2823 Bis
2824 \lang english
2825 , depending upon exactly what the English
2826 \begin_inset Quotes eld
2827 \end_inset
2828
2829 to
2830 \begin_inset Quotes erd
2831 \end_inset
2832
2833  means.
2834  GNU
2835 \begin_inset Flex CharStyle:Code
2836 status collapsed
2837
2838 \begin_layout Plain Layout
2839 gettext
2840 \end_layout
2841
2842 \end_inset
2843
2844  does not handle such ambiguous translations.
2845  Therefore you have to add some context information to the message: Instead
2846  of
2847 \begin_inset Flex CharStyle:Code
2848 status collapsed
2849
2850 \begin_layout Plain Layout
2851 To
2852 \end_layout
2853
2854 \end_inset
2855
2856  it becomes
2857 \begin_inset Flex CharStyle:Code
2858 status collapsed
2859
2860 \begin_layout Plain Layout
2861 To[[as in 'From format x to format y']]
2862 \end_layout
2863
2864 \end_inset
2865
2866  and
2867 \begin_inset Flex CharStyle:Code
2868 status collapsed
2869
2870 \begin_layout Plain Layout
2871 To[[as in 'From page x to page y']].
2872 \end_layout
2873
2874 \end_inset
2875
2876  Now the two occurrences of
2877 \begin_inset Flex CharStyle:Code
2878 status collapsed
2879
2880 \begin_layout Plain Layout
2881 To
2882 \end_layout
2883
2884 \end_inset
2885
2886  are different for
2887 \begin_inset Flex CharStyle:Code
2888 status collapsed
2889
2890 \begin_layout Plain Layout
2891 gettext
2892 \end_layout
2893
2894 \end_inset
2895
2896  and can be translated correctly to
2897 \lang german
2898 Nach
2899 \lang english
2900  and
2901 \lang german
2902 Bis
2903 \lang english
2904 , respectively.
2905 \end_layout
2906
2907 \begin_layout Standard
2908 Of course the context information needs to be stripped off the original
2909  message when no translation is used.
2910  Therefore you have to put it in double square brackets at the end of the
2911  message (see the example above).
2912  The translation mechanism of LyX ensures that everything in double square
2913  brackets at the end of messages is removed before displaying the message.
2914 \end_layout
2915
2916 \begin_layout Subsection
2917 Translating the documentation.
2918 \end_layout
2919
2920 \begin_layout Standard
2921 The online documentation (in the
2922 \begin_inset Flex CharStyle:MenuItem
2923 status collapsed
2924
2925 \begin_layout Plain Layout
2926 Help
2927 \end_layout
2928
2929 \end_inset
2930
2931 -menu) can (and should!) be translated.
2932  If there are translated versions of the documentation available
2933 \begin_inset Foot
2934 status collapsed
2935
2936 \begin_layout Plain Layout
2937 As of March 2008, at least some of the documents have been translated into
2938  fourteen languages, with the Tutorial available in a few more.
2939 \end_layout
2940
2941 \end_inset
2942
2943  and the locale is set accordingly, these will be used automagically by
2944  LyX.
2945  LyX looks for translated versions as
2946 \begin_inset Flex CharStyle:Code
2947 status collapsed
2948
2949 \begin_layout Plain Layout
2950 LyXDir/doc/xx/DocName.lyx
2951 \end_layout
2952
2953 \end_inset
2954
2955 , where
2956 \begin_inset Flex CharStyle:Code
2957 status collapsed
2958
2959 \begin_layout Plain Layout
2960 xx
2961 \end_layout
2962
2963 \end_inset
2964
2965  is the code for the language currently in use.
2966  If there are no translated documents, the default English versions will
2967  be displayed.
2968  Note that the translated versions must have the same filenames (
2969 \begin_inset Flex CharStyle:Code
2970 status collapsed
2971
2972 \begin_layout Plain Layout
2973 DocName
2974 \end_layout
2975
2976 \end_inset
2977
2978  above) as the original.
2979  If you feel up to translating the documentation (an excellent way to proof-read
2980  the original documentation by the way!), there are a few things you should
2981  do right away:
2982 \end_layout
2983
2984 \begin_layout Itemize
2985 Check out the documentation translation web page at
2986 \begin_inset CommandInset href
2987 LatexCommand href
2988 name "http://www.lyx.org/Translation"
2989 target "http://www.lyx.org/Translation"
2990
2991 \end_inset
2992
2993 .
2994  That way, you can find out which (if any) documents have already been translate
2995 d into your language.
2996  You can also find out who (if anyone) is organizing the effort to translate
2997  the documentation into your language.
2998  If no one is organizing the effort, please let us know that you're interested.
2999 \end_layout
3000
3001 \begin_layout Standard
3002 Once you get to actually translating, here's a few hints for you that may
3003  save you trouble:
3004 \end_layout
3005
3006 \begin_layout Itemize
3007 Join the documentation team! There is information on how to do that in
3008 \begin_inset Flex CharStyle:Code
3009 status collapsed
3010
3011 \begin_layout Plain Layout
3012 Intro.lyx
3013 \end_layout
3014
3015 \end_inset
3016
3017  (
3018 \begin_inset Flex CharStyle:MenuItem
3019 status collapsed
3020
3021 \begin_layout Plain Layout
3022 Help\SpecialChar \menuseparator
3023 Introduction
3024 \end_layout
3025
3026 \end_inset
3027
3028 ), which by the way is the first document you should translate.
3029 \end_layout
3030
3031 \begin_layout Itemize
3032 Learn the typographic conventions for the language you are translating to.
3033  Typography is an ancient art and over the centuries, a great variety of
3034  conventions have developed throughout different parts of the world.
3035  Also study the professional terminology amongst typographers in your country.
3036  Inventing your own terminology will only confuse the users.
3037
3038 \emph on
3039 (Warning! Typography is addictive!)
3040 \end_layout
3041
3042 \begin_layout Itemize
3043 Make a copy of the document.
3044  This will be your working copy.
3045  You can use this as your personal translated help-file by placing it in
3046  your
3047 \begin_inset Flex CharStyle:Code
3048 status collapsed
3049
3050 \begin_layout Plain Layout
3051 UserDir/doc/xx/
3052 \end_layout
3053
3054 \end_inset
3055
3056  directory.
3057 \end_layout
3058
3059 \begin_layout Itemize
3060 Sometimes the original document (from the LyX-team) will be updated.
3061  Use the source viewer at
3062 \begin_inset CommandInset href
3063 LatexCommand href
3064 name "http://www.lyx.org/trac/timeline"
3065 target "http://www.lyx.org/trac/timeline"
3066
3067 \end_inset
3068
3069  to see what has been changed.
3070  That way you can easily see which parts of the translated document need
3071  to be updated.
3072 \end_layout
3073
3074 \begin_layout Standard
3075 If you ever find an error in the original document, fix it and notify the
3076  rest of the documentation team of the changes! (You didn't forget to join
3077  the documentation team, did you?)
3078 \end_layout
3079
3080 \begin_layout Standard
3081 \begin_inset Branch OutDated
3082 status collapsed
3083
3084 \begin_layout Section
3085 International Keyboard Support
3086 \end_layout
3087
3088 \begin_layout Standard
3089
3090 \emph on
3091 [Editor's Note: The following section is by
3092 \emph default
3093
3094 \shape smallcaps
3095 \emph on
3096 Ivan Schreter
3097 \shape default
3098 .
3099  It needs to be fixed to conform to the new Documentation Style sheet and
3100  to make use of the new v1.0 features.
3101  The whole thing also needs to be merged with the section following it.-jw
3102  It may also be badly out of date.-rh (2008)]
3103 \end_layout
3104
3105 \begin_layout Subsection
3106 Defining Own Keymaps: Keymap File Format
3107 \end_layout
3108
3109 \begin_layout Standard
3110 Let's look at a keyboard definition file a little closer.
3111  It is a plain text file defining
3112 \end_layout
3113
3114 \begin_layout Itemize
3115 key-to-key or key-to-string translations
3116 \end_layout
3117
3118 \begin_layout Itemize
3119 dead keys
3120 \end_layout
3121
3122 \begin_layout Itemize
3123 dead keys exceptions
3124 \end_layout
3125
3126 \begin_layout Standard
3127 To define key-to-key or key-to-string translation, use this command:
3128 \end_layout
3129
3130 \begin_layout Quotation
3131 \begin_inset Flex CharStyle:Code
3132 status collapsed
3133
3134 \begin_layout Plain Layout
3135
3136 \backslash
3137 kmap
3138 \end_layout
3139
3140 \end_inset
3141
3142
3143 \begin_inset Flex CharStyle:Code
3144 status collapsed
3145
3146 \begin_layout Plain Layout
3147 key
3148 \end_layout
3149
3150 \end_inset
3151
3152  outstring
3153 \end_layout
3154
3155 \begin_layout Standard
3156 where
3157 \begin_inset Flex CharStyle:Code
3158 status collapsed
3159
3160 \begin_layout Plain Layout
3161 key
3162 \end_layout
3163
3164 \end_inset
3165
3166  is the key to be translated and
3167 \begin_inset Flex CharStyle:Code
3168 status collapsed
3169
3170 \begin_layout Plain Layout
3171 outstring
3172 \end_layout
3173
3174 \end_inset
3175
3176  is the string to be inserted into the document.
3177  To define dead keys, use:
3178 \end_layout
3179
3180 \begin_layout Quotation
3181 \begin_inset Flex CharStyle:Code
3182 status collapsed
3183
3184 \begin_layout Plain Layout
3185
3186 \backslash
3187 kmod
3188 \end_layout
3189
3190 \end_inset
3191
3192
3193 \begin_inset Flex CharStyle:Code
3194 status collapsed
3195
3196 \begin_layout Plain Layout
3197 key
3198 \end_layout
3199
3200 \end_inset
3201
3202  deadkey
3203 \end_layout
3204
3205 \begin_layout Standard
3206 where
3207 \begin_inset Flex CharStyle:Code
3208 status collapsed
3209
3210 \begin_layout Plain Layout
3211 key
3212 \end_layout
3213
3214 \end_inset
3215
3216  is a keyboard key and
3217 \begin_inset Flex CharStyle:Code
3218 status collapsed
3219
3220 \begin_layout Plain Layout
3221 deadkey
3222 \end_layout
3223
3224 \end_inset
3225
3226  is dead key name.
3227  The following dead keys are supported (shortcut name is in parentheses):
3228 \end_layout
3229
3230 \begin_layout Quotation
3231
3232 \emph on
3233 Name
3234 \begin_inset space \hfill{}
3235 \end_inset
3236
3237 Example
3238 \end_layout
3239
3240 \begin_layout Quotation
3241 acute (acu)
3242 \begin_inset space \hfill{}
3243 \end_inset
3244
3245 áéíóú
3246 \end_layout
3247
3248 \begin_layout Quotation
3249 grave (gra)
3250 \begin_inset space \hfill{}
3251 \end_inset
3252
3253 àèìòù
3254 \end_layout
3255
3256 \begin_layout Quotation
3257 macron (mac)
3258 \begin_inset space \hfill{}
3259 \end_inset
3260
3261  ō
3262 \end_layout
3263
3264 \begin_layout Quotation
3265 tilde (til)
3266 \begin_inset space \hfill{}
3267 \end_inset
3268
3269 ñÑ
3270 \end_layout
3271
3272 \begin_layout Quotation
3273 underbar (underb)
3274 \begin_inset space \hfill{}
3275 \end_inset
3276
3277
3278 \begin_inset ERT
3279 status open
3280
3281 \begin_layout Plain Layout
3282
3283
3284 \backslash
3285 b o
3286 \end_layout
3287
3288 \end_inset
3289
3290
3291 \end_layout
3292
3293 \begin_layout Quotation
3294 cedilla (ced)
3295 \begin_inset space \hfill{}
3296 \end_inset
3297
3298 çÇ
3299 \end_layout
3300
3301 \begin_layout Quotation
3302 underdot (underd)
3303 \begin_inset space \hfill{}
3304 \end_inset
3305
3306
3307 \begin_inset ERT
3308 status open
3309
3310 \begin_layout Plain Layout
3311
3312
3313 \backslash
3314 d o
3315 \end_layout
3316
3317 \end_inset
3318
3319
3320 \end_layout
3321
3322 \begin_layout Quotation
3323 circumflex (circu)
3324 \begin_inset space \hfill{}
3325 \end_inset
3326
3327 âêîôû
3328 \end_layout
3329
3330 \begin_layout Quotation
3331 circle (circl)
3332 \begin_inset space \hfill{}
3333 \end_inset
3334
3335 ÅůŮ
3336 \end_layout
3337
3338 \begin_layout Quotation
3339 tie (tie)
3340 \begin_inset space \hfill{}
3341 \end_inset
3342
3343
3344 \begin_inset ERT
3345 status open
3346
3347 \begin_layout Plain Layout
3348
3349
3350 \backslash
3351 t o
3352 \end_layout
3353
3354 \end_inset
3355
3356
3357 \end_layout
3358
3359 \begin_layout Quotation
3360 breve (bre)
3361 \begin_inset space \hfill{}
3362 \end_inset
3363
3364 ă
3365 \begin_inset ERT
3366 status open
3367
3368 \begin_layout Plain Layout
3369
3370
3371 \backslash
3372 u o
3373 \end_layout
3374
3375 \end_inset
3376
3377
3378 \end_layout
3379
3380 \begin_layout Quotation
3381 caron (car)
3382 \begin_inset space \hfill{}
3383 \end_inset
3384
3385 čšž
3386 \end_layout
3387
3388 \begin_layout Quotation
3389 hungarian umlaut (hug)
3390 \begin_inset space \hfill{}
3391 \end_inset
3392
3393 őű
3394 \end_layout
3395
3396 \begin_layout Quotation
3397 umlaut (uml)
3398 \begin_inset space \hfill{}
3399 \end_inset
3400
3401 äöü
3402 \end_layout
3403
3404 \begin_layout Quotation
3405 dot (dot)
3406 \begin_inset space \hfill{}
3407 \end_inset
3408
3409 ż
3410 \begin_inset ERT
3411 status open
3412
3413 \begin_layout Plain Layout
3414
3415
3416 \backslash
3417 .s
3418 \end_layout
3419
3420 \end_inset
3421
3422
3423 \end_layout
3424
3425 \begin_layout Standard
3426 Since in many international keyboards there are exceptions to what some
3427  dead keys should do, you can define them using
3428 \end_layout
3429
3430 \begin_layout Quotation
3431 \begin_inset Flex CharStyle:Code
3432 status collapsed
3433
3434 \begin_layout Plain Layout
3435
3436 \backslash
3437 kxmod
3438 \end_layout
3439
3440 \end_inset
3441
3442  deadkey key outstring
3443 \end_layout
3444
3445 \begin_layout Standard
3446 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
3447 , so you put in
3448 \end_layout
3449
3450 \begin_layout Quotation
3451 \begin_inset Flex CharStyle:Code
3452 status collapsed
3453
3454 \begin_layout Plain Layout
3455
3456 \backslash
3457 kxmod
3458 \end_layout
3459
3460 \end_inset
3461
3462  caron o "
3463 \backslash
3464 ^o"
3465 \end_layout
3466
3467 \begin_layout Standard
3468 to make it work correctly.
3469  Also, you have to define as exceptions dead keys over i and j, to remove
3470  the dot from them before inserting an accent mark.
3471  I will change this when the time comes, but so far I haven't had time.
3472 \end_layout
3473
3474 \begin_layout Standard
3475 Oh, and about characters: backslash is escaped, so to enter it, you'll need
3476  double backslash.
3477  Also, quotes and
3478 \begin_inset Flex CharStyle:Code
3479 status collapsed
3480
3481 \begin_layout Plain Layout
3482 #
3483 \end_layout
3484
3485 \end_inset
3486
3487  have different meaning.
3488
3489 \begin_inset Flex CharStyle:Code
3490 status collapsed
3491
3492 \begin_layout Plain Layout
3493 #
3494 \end_layout
3495
3496 \end_inset
3497
3498  marks comments, quotes start and end LaTeX-style commands.
3499  To enter quote, you'll need to use
3500 \begin_inset Flex CharStyle:Code
3501 status collapsed
3502
3503 \begin_layout Plain Layout
3504
3505 \backslash
3506 "
3507 \end_layout
3508
3509 \end_inset
3510
3511 , to enter
3512 \begin_inset Flex CharStyle:Code
3513 status collapsed
3514
3515 \begin_layout Plain Layout
3516 #
3517 \end_layout
3518
3519 \end_inset
3520
3521 , use
3522 \begin_inset Flex CharStyle:Code
3523 status collapsed
3524
3525 \begin_layout Plain Layout
3526
3527 \backslash
3528 #
3529 \end_layout
3530
3531 \end_inset
3532
3533 .
3534 \end_layout
3535
3536 \begin_layout Standard
3537 If you make a keyboard description file that works for your language, please
3538  mail it to me, so I can include it in the next keymap distribution.
3539 \end_layout
3540
3541 \begin_layout Standard
3542 More keywords will be supported in keymap configuration file in future,
3543  like
3544 \end_layout
3545
3546 \begin_layout Itemize
3547 \begin_inset Flex CharStyle:Code
3548 status collapsed
3549
3550 \begin_layout Plain Layout
3551
3552 \backslash
3553 kinclude filename
3554 \end_layout
3555
3556 \end_inset
3557
3558
3559 \emph on
3560
3561 \begin_inset space \hfill{}
3562 \end_inset
3563
3564
3565 \begin_inset Flex CharStyle:Code
3566 status collapsed
3567
3568 \begin_layout Plain Layout
3569 include
3570 \end_layout
3571
3572 \end_inset
3573
3574  another file
3575 \end_layout
3576
3577 \begin_layout Itemize
3578 \begin_inset Flex CharStyle:Code
3579 status collapsed
3580
3581 \begin_layout Plain Layout
3582
3583 \backslash
3584 kprog program
3585 \end_layout
3586
3587 \end_inset
3588
3589
3590 \emph on
3591
3592 \begin_inset space \hfill{}
3593 \end_inset
3594
3595
3596 \begin_inset Flex CharStyle:Code
3597 status collapsed
3598
3599 \begin_layout Plain Layout
3600 define
3601 \end_layout
3602
3603 \end_inset
3604
3605  an external keymap translation program
3606 \end_layout
3607
3608 \begin_layout Standard
3609 Also, it should look into
3610 \begin_inset Flex CharStyle:Code
3611 status collapsed
3612
3613 \begin_layout Plain Layout
3614 lyxrc
3615 \end_layout
3616
3617 \end_inset
3618
3619  file for defaults, too (for example, a
3620 \begin_inset Flex CharStyle:Code
3621 status collapsed
3622
3623 \begin_layout Plain Layout
3624
3625 \backslash
3626 kinclude
3627 \end_layout
3628
3629 \end_inset
3630
3631  option to include default keyboard).
3632 \end_layout
3633
3634 \end_inset
3635
3636
3637 \end_layout
3638
3639 \begin_layout Section
3640 International Keymap Stuff
3641 \begin_inset CommandInset label
3642 LatexCommand label
3643 name "sec:International-Keymap-Stuff"
3644
3645 \end_inset
3646
3647
3648 \end_layout
3649
3650 \begin_layout Standard
3651 \begin_inset Note Note
3652 status open
3653
3654 \begin_layout Plain Layout
3655 In doing the revisions on this document in March 2008, I did not look over
3656  this stuff, as I do not understand it.
3657  It would be good if someone else could do so.
3658  (RH)
3659 \end_layout
3660
3661 \end_inset
3662
3663
3664 \end_layout
3665
3666 \begin_layout Standard
3667 The next two sections describe the
3668 \begin_inset Flex CharStyle:Code
3669 status collapsed
3670
3671 \begin_layout Plain Layout
3672
3673 \shape up
3674 .kmap
3675 \end_layout
3676
3677 \end_inset
3678
3679  and
3680 \begin_inset Flex CharStyle:Code
3681 status collapsed
3682
3683 \begin_layout Plain Layout
3684
3685 \shape up
3686 .cdef
3687 \end_layout
3688
3689 \end_inset
3690
3691  file syntax in detail.
3692  These sections should help you design your own key map if the ones provided
3693  do not meet your needs.
3694 \end_layout
3695
3696 \begin_layout Subsection
3697 The .kmap File
3698 \end_layout
3699
3700 \begin_layout Standard
3701 A
3702 \shape up
3703 .
3704 \begin_inset Flex CharStyle:Code
3705 status collapsed
3706
3707 \begin_layout Plain Layout
3708 kmap
3709 \end_layout
3710
3711 \end_inset
3712
3713  file maps keystrokes to characters or strings.
3714  As the name suggests, it sets a keyboard mapping.
3715  The
3716 \begin_inset Flex CharStyle:Code
3717 status collapsed
3718
3719 \begin_layout Plain Layout
3720 .kmap
3721 \end_layout
3722
3723 \end_inset
3724
3725
3726 \shape default
3727  file keywords
3728 \shape up
3729
3730 \begin_inset Flex CharStyle:Code
3731 status collapsed
3732
3733 \begin_layout Plain Layout
3734
3735 \shape up
3736 kmap
3737 \end_layout
3738
3739 \end_inset
3740
3741
3742 \shape default
3743 ,
3744 \shape up
3745
3746 \shape default
3747
3748 \begin_inset Flex CharStyle:Code
3749 status collapsed
3750
3751 \begin_layout Plain Layout
3752
3753 \shape up
3754 kmod
3755 \end_layout
3756
3757 \end_inset
3758
3759 ,
3760 \shape up
3761
3762 \shape default
3763
3764 \begin_inset Flex CharStyle:Code
3765 status collapsed
3766
3767 \begin_layout Plain Layout
3768
3769 \shape up
3770 ksmod
3771 \end_layout
3772
3773 \end_inset
3774
3775 , and
3776 \begin_inset Flex CharStyle:Code
3777 status collapsed
3778
3779 \begin_layout Plain Layout
3780
3781 \shape up
3782 kcomb
3783 \end_layout
3784
3785 \end_inset
3786
3787  are described in this section.
3788 \end_layout
3789
3790 \begin_layout Labeling
3791 \labelwidthstring 00.00.0000
3792 \begin_inset Flex CharStyle:Code
3793 status collapsed
3794
3795 \begin_layout Plain Layout
3796
3797 \shape up
3798 kmap
3799 \end_layout
3800
3801 \end_inset
3802
3803  Map a character to a string
3804 \end_layout
3805
3806 \begin_layout LyX-Code
3807
3808 \backslash
3809 kmap
3810 \family roman
3811 \emph on
3812 char
3813 \family default
3814 \emph default
3815
3816 \family roman
3817 \emph on
3818 string
3819 \end_layout
3820
3821 \begin_layout Standard
3822 This will ma
3823 \family roman
3824 p
3825 \family default
3826
3827 \family roman
3828 \emph on
3829 char
3830 \family default
3831 \emph default
3832
3833 \family roman
3834 to
3835 \family default
3836
3837 \family roman
3838 \emph on
3839 string
3840 \emph default
3841 .
3842  Note that in
3843 \family default
3844
3845 \family roman
3846 \emph on
3847 string
3848 \emph default
3849 ,
3850 \family default
3851
3852 \family roman
3853 \shape up
3854 the double-quote (")
3855 \family default
3856 \shape default
3857
3858 \family roman
3859 and
3860 \family default
3861
3862 \family roman
3863 \shape up
3864 the backslash (
3865 \backslash
3866 )
3867 \family default
3868 \shape default
3869
3870 \family roman
3871 must be escaped with a preceding backslash (
3872 \shape up
3873
3874 \backslash
3875
3876 \shape default
3877 )
3878 \family default
3879 .
3880 \end_layout
3881
3882 \begin_layout Standard
3883 An example of a
3884 \begin_inset Flex CharStyle:MenuItem
3885 status collapsed
3886
3887 \begin_layout Plain Layout
3888
3889 \shape up
3890 kmap
3891 \end_layout
3892
3893 \end_inset
3894
3895  statement to cause the symbol
3896 \begin_inset Flex CharStyle:MenuItem
3897 status collapsed
3898
3899 \begin_layout Plain Layout
3900
3901 \shape up
3902 /
3903 \end_layout
3904
3905 \end_inset
3906
3907  to be output for the keystroke
3908 \begin_inset Flex CharStyle:MenuItem
3909 status collapsed
3910
3911 \begin_layout Plain Layout
3912
3913 \shape up
3914 &
3915 \end_layout
3916
3917 \end_inset
3918
3919  is:
3920 \end_layout
3921
3922 \begin_layout LyX-Code
3923
3924 \backslash
3925 kmap & /
3926 \end_layout
3927
3928 \begin_layout Labeling
3929 \labelwidthstring 00.00.0000
3930 \begin_inset Flex CharStyle:Code
3931 status collapsed
3932
3933 \begin_layout Plain Layout
3934
3935 \shape up
3936 kmod
3937 \end_layout
3938
3939 \end_inset
3940
3941  Specify an accent character
3942 \end_layout
3943
3944 \begin_layout LyX-Code
3945
3946 \backslash
3947 kmod
3948 \family roman
3949 \emph on
3950 char accent allowed
3951 \end_layout
3952
3953 \begin_layout Standard
3954 This will make the cha
3955 \family roman
3956 racter
3957 \family default
3958
3959 \family roman
3960 \emph on
3961 char
3962 \family default
3963 \emph default
3964
3965 \family roman
3966 \shape up
3967 \emph on
3968 be an accent
3969 \family default
3970 \shape default
3971 \emph default
3972
3973 \family roman
3974 \shape up
3975 on the
3976 \family default
3977 \shape default
3978
3979 \family roman
3980 \shape up
3981 \emph on
3982 allowed
3983 \family default
3984 \shape default
3985 \emph default
3986
3987 \family roman
3988 \shape up
3989 cha
3990 \family default
3991 racter(s).
3992  This is the dead key
3993 \begin_inset Foot
3994 status collapsed
3995
3996 \begin_layout Plain Layout
3997 The term
3998 \family roman
3999 \emph on
4000 dead key
4001 \family default
4002 \emph default
4003  refers to a key that does not produce a character by itself, but when followed
4004  with another key, produces the desired accent character.
4005  For example, a German characte
4006 \family roman
4007 r with an umlaut like
4008 \family default
4009
4010 \family roman
4011 \emph on
4012 ä
4013 \family default
4014 \emph default
4015
4016 \family roman
4017 can be produced in this manner.
4018 \end_layout
4019
4020 \end_inset
4021
4022  mechanism.
4023
4024 \end_layout
4025
4026 \begin_layout Standard
4027 If you
4028 \family roman
4029 hit
4030 \family default
4031
4032 \family roman
4033 \emph on
4034 char
4035 \family default
4036 \emph default
4037
4038 \family roman
4039 and then another key not in
4040 \family default
4041
4042 \family roman
4043 \emph on
4044 allowed
4045 \emph default
4046 , you will get a
4047 \family default
4048
4049 \family roman
4050 \emph on
4051 char
4052 \family default
4053 \emph default
4054
4055 \family roman
4056 followed by the other, not allowed key, as output.
4057
4058 \family default
4059  Note that a
4060 \begin_inset Flex CharStyle:MenuItem
4061 status collapsed
4062
4063 \begin_layout Plain Layout
4064
4065 \shape up
4066 Backspace
4067 \end_layout
4068
4069 \end_inset
4070
4071  cancels a dead key, so if
4072 \family roman
4073 you hit
4074 \family default
4075
4076 \family roman
4077 \emph on
4078 char
4079 \family default
4080 \emph default
4081
4082 \begin_inset Flex CharStyle:MenuItem
4083 status collapsed
4084
4085 \begin_layout Plain Layout
4086
4087 \shape up
4088 \emph on
4089 Backspace
4090 \end_layout
4091
4092 \end_inset
4093
4094 , the cursor will not go one position backwards but will instead cancel
4095  the effect t
4096 \family roman
4097 hat
4098 \family default
4099
4100 \family roman
4101 \shape up
4102 \emph on
4103 char
4104 \family default
4105 \shape default
4106 \emph default
4107
4108 \family roman
4109 \shape up
4110 might have had on the next keystroke.
4111
4112 \end_layout
4113
4114 \begin_layout Standard
4115 The following example specifies that the character ' is to be an acute accent,
4116  allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4117 \end_layout
4118
4119 \begin_layout LyX-Code
4120
4121 \backslash
4122 kmod ' acute aeiouAEIOU
4123 \end_layout
4124
4125 \begin_layout Labeling
4126 \labelwidthstring 00.00.0000
4127 \begin_inset Flex CharStyle:Code
4128 status collapsed
4129
4130 \begin_layout Plain Layout
4131 ksmod
4132 \end_layout
4133
4134 \end_inset
4135
4136  Specify an exception to the accent character
4137 \end_layout
4138
4139 \begin_layout LyX-Code
4140
4141 \backslash
4142 kxmod
4143 \family roman
4144 \emph on
4145 accent char result
4146 \end_layout
4147
4148 \begin_layout Standard
4149 This defines an exce
4150 \family roman
4151 ption for
4152 \family default
4153
4154 \family roman
4155 \emph on
4156 accent
4157 \family default
4158 \emph default
4159
4160 \family roman
4161 on
4162 \family default
4163
4164 \family roman
4165 \emph on
4166 char
4167 \emph default
4168 .
4169  T
4170 \shape up
4171 he
4172 \family default
4173 \shape default
4174
4175 \family roman
4176 \shape up
4177 \emph on
4178 accent
4179 \family default
4180 \shape default
4181 \emph default
4182
4183 \family roman
4184 \shape up
4185 must
4186 \family default
4187 \shape default
4188
4189 \shape up
4190 have been assigned a keystroke with a previous
4191 \shape default
4192
4193 \begin_inset Flex CharStyle:Code
4194 status collapsed
4195
4196 \begin_layout Plain Layout
4197
4198 \shape up
4199
4200 \backslash
4201 kmo
4202 \shape default
4203 d
4204 \end_layout
4205
4206 \end_inset
4207
4208  declar
4209 \family roman
4210 ation and
4211 \family default
4212
4213 \family roman
4214 \emph on
4215 char
4216 \family default
4217 \emph default
4218
4219 \family roman
4220 must not belong in the
4221 \family default
4222
4223 \family roman
4224 \emph on
4225 allowed
4226 \family default
4227 \emph default
4228
4229 \family roman
4230 set of
4231 \family default
4232
4233 \family roman
4234 \emph on
4235 accent
4236 \emph default
4237 .
4238  When
4239 \family default
4240
4241 \family roman
4242 \shape up
4243 you enter the
4244 \family default
4245 \shape default
4246
4247 \family roman
4248 \shape up
4249 \emph on
4250 accent char
4251 \family default
4252 \shape default
4253 \emph default
4254
4255 \family roman
4256 \shape up
4257 sequence,
4258 \family default
4259 \shape default
4260
4261 \family roman
4262 \shape up
4263 \emph on
4264 result
4265 \emph default
4266  is produced.
4267  If such a declaration does not exist in
4268 \family default
4269 \shape default
4270
4271 \shape up
4272 the
4273 \shape default
4274
4275 \begin_inset Flex CharStyle:Code
4276 status collapsed
4277
4278 \begin_layout Plain Layout
4279
4280 \shape up
4281 .kmap
4282 \end_layout
4283
4284 \end_inset
4285
4286  file and yo
4287 \family roman
4288 u enter
4289 \family default
4290
4291 \family roman
4292 \emph on
4293 accent char
4294 \emph default
4295 , you get
4296 \family default
4297
4298 \family roman
4299 \emph on
4300 accent_key char
4301 \emph default
4302  where
4303 \family default
4304
4305 \family roman
4306 \emph on
4307 accent_key
4308 \emph default
4309  is the first arg
4310 \family default
4311 ument of the
4312 \begin_inset Flex CharStyle:Code
4313 status collapsed
4314
4315 \begin_layout Plain Layout
4316
4317 \shape up
4318
4319 \backslash
4320 kmod
4321 \end_layout
4322
4323 \end_inset
4324
4325  declaration.
4326
4327 \end_layout
4328
4329 \begin_layout Standard
4330 The following command produces causes äi to be produced when you enter acute-i
4331  ('i):
4332 \end_layout
4333
4334 \begin_layout LyX-Code
4335
4336 \backslash
4337 kxmod acute i "
4338 \backslash
4339
4340 \backslash
4341 '{
4342 \backslash
4343
4344 \backslash
4345 i}"
4346 \end_layout
4347
4348 \begin_layout Labeling
4349 \labelwidthstring 00.00.0000
4350 \begin_inset Flex CharStyle:Code
4351 status collapsed
4352
4353 \begin_layout Plain Layout
4354 kcomb
4355 \end_layout
4356
4357 \end_inset
4358
4359  Combine two accent characters
4360 \end_layout
4361
4362 \begin_layout LyX-Code
4363
4364 \backslash
4365 kcomb
4366 \family roman
4367 \emph on
4368 accent1 accent2 allowed
4369 \end_layout
4370
4371 \begin_layout Standard
4372 This one is getting pretty esoteric.
4373  It allows you to combine the effect
4374 \family roman
4375 of
4376 \family default
4377
4378 \family roman
4379 \emph on
4380 accent1
4381 \family default
4382 \emph default
4383
4384 \family roman
4385 and
4386 \family default
4387
4388 \family roman
4389 \emph on
4390 accent2
4391 \family default
4392 \emph default
4393
4394 \family roman
4395 (in that order!) on
4396 \family default
4397
4398 \family roman
4399 \emph on
4400 allowed
4401 \family default
4402 \emph default
4403
4404 \family roman
4405 chars.
4406  The keystrokes for
4407 \family default
4408
4409 \family roman
4410 \emph on
4411 accent1
4412 \family default
4413 \emph default
4414
4415 \family roman
4416 and
4417 \family default
4418
4419 \family roman
4420 \emph on
4421 accent2
4422 \family default
4423 \emph default
4424
4425 \family roman
4426 must have be
4427 \family default
4428 en set with a
4429 \begin_inset Flex CharStyle:Code
4430 status collapsed
4431
4432 \begin_layout Plain Layout
4433
4434 \shape up
4435
4436 \backslash
4437 kmod
4438 \end_layout
4439
4440 \end_inset
4441
4442  command at
4443 \family roman
4444 a
4445 \family default
4446
4447 \family roman
4448 \emph on
4449 previous
4450 \family default
4451 \emph default
4452
4453 \family roman
4454 point in the
4455 \family default
4456  file.
4457
4458 \end_layout
4459
4460 \begin_layout Standard
4461 Consider this example from the
4462 \begin_inset Flex CharStyle:Code
4463 status collapsed
4464
4465 \begin_layout Plain Layout
4466
4467 \shape up
4468 greek.kmap
4469 \end_layout
4470
4471 \end_inset
4472
4473  file:
4474 \end_layout
4475
4476 \begin_layout LyX-Code
4477
4478 \backslash
4479 kmod ; acute aeioyvhAEIOYVH
4480 \backslash
4481 kmod : umlaut iyIY
4482 \backslash
4483 kcomb acute umlaut iyIY
4484 \end_layout
4485
4486 \begin_layout Standard
4487 This allows you to press
4488 \begin_inset Flex CharStyle:MenuItem
4489 status collapsed
4490
4491 \begin_layout Plain Layout
4492
4493 \shape up
4494 ;:i
4495 \end_layout
4496
4497 \end_inset
4498
4499  and get the effect of
4500 \begin_inset Flex CharStyle:Code
4501 status collapsed
4502
4503 \begin_layout Plain Layout
4504
4505 \shape up
4506
4507 \backslash
4508 '{
4509 \backslash
4510 "{i}}
4511 \end_layout
4512
4513 \end_inset
4514
4515 .
4516
4517 \family roman
4518 \shape up
4519 A backspace
4520 \family default
4521 \shape default
4522  in this case cancels the last dead key, so if you press
4523 \begin_inset Flex CharStyle:MenuItem
4524 status collapsed
4525
4526 \begin_layout Plain Layout
4527
4528 \shape up
4529 ;: Backspace i
4530 \end_layout
4531
4532 \end_inset
4533
4534  you get
4535 \begin_inset Flex CharStyle:Code
4536 status collapsed
4537
4538 \begin_layout Plain Layout
4539
4540 \shape up
4541
4542 \backslash
4543 '{i}
4544 \end_layout
4545
4546 \end_inset
4547
4548 .
4549 \end_layout
4550
4551 \begin_layout Subsection
4552 The .cdef File
4553 \end_layout
4554
4555 \begin_layout Standard
4556 After the
4557 \begin_inset Flex CharStyle:Code
4558 status collapsed
4559
4560 \begin_layout Plain Layout
4561
4562 \shape up
4563 .kmap
4564 \end_layout
4565
4566 \end_inset
4567
4568  mapping is performed, a
4569 \begin_inset Flex CharStyle:Code
4570 status collapsed
4571
4572 \begin_layout Plain Layout
4573
4574 \shape up
4575 .cde
4576 \shape default
4577 f
4578 \end_layout
4579
4580 \end_inset
4581
4582  file maps the strings that the symbols generate to characters in the current
4583  font.
4584  The LyX distribution currently includes at least the
4585 \begin_inset Flex CharStyle:Code
4586 status collapsed
4587
4588 \begin_layout Plain Layout
4589
4590 \shape up
4591 iso8859-1.cdef
4592 \end_layout
4593
4594 \end_inset
4595
4596  and
4597 \begin_inset Flex CharStyle:Code
4598 status collapsed
4599
4600 \begin_layout Plain Layout
4601
4602 \shape up
4603 iso8859-2.cdef
4604 \end_layout
4605
4606 \end_inset
4607
4608  files.
4609 \end_layout
4610
4611 \begin_layout Standard
4612 In general the
4613 \begin_inset Flex CharStyle:Code
4614 status collapsed
4615
4616 \begin_layout Plain Layout
4617
4618 \shape up
4619 .cdef
4620 \end_layout
4621
4622 \end_inset
4623
4624  file is a sequence of declarations of the form
4625 \end_layout
4626
4627 \begin_layout LyX-Code
4628
4629 \family roman
4630 \emph on
4631 char_index_in_set
4632 \family default
4633 \emph default
4634
4635 \family roman
4636 \emph on
4637  string
4638 \end_layout
4639
4640 \begin_layout Standard
4641 For example, in order to map
4642 \begin_inset Flex CharStyle:MenuItem
4643 status collapsed
4644
4645 \begin_layout Plain Layout
4646
4647 \shape up
4648
4649 \backslash
4650 '{e}
4651 \end_layout
4652
4653 \end_inset
4654
4655  to the corresponding character in the iso-8859-1 set (233), the following
4656  declaration is used
4657 \end_layout
4658
4659 \begin_layout LyX-Code
4660 233 "
4661 \backslash
4662
4663 \backslash
4664 '{e}"
4665 \end_layout
4666
4667 \begin_layout Standard
4668 with
4669 \begin_inset Flex CharStyle:Code
4670 status collapsed
4671
4672 \begin_layout Plain Layout
4673
4674 \backslash
4675
4676 \end_layout
4677
4678 \end_inset
4679
4680  and
4681 \begin_inset Flex CharStyle:Code
4682 status collapsed
4683
4684 \begin_layout Plain Layout
4685 "
4686 \end_layout
4687
4688 \end_inset
4689
4690  being escap
4691 \family roman
4692 ed in
4693 \family default
4694
4695 \family roman
4696 \emph on
4697 string
4698 \emph default
4699 .
4700  Note that
4701 \family default
4702  the same character can apply to more than one string.
4703  In the
4704 \begin_inset Flex CharStyle:Code
4705 status collapsed
4706
4707 \begin_layout Plain Layout
4708 i
4709 \shape up
4710 so-8859-7.cdef
4711 \end_layout
4712
4713 \end_inset
4714
4715  file you have
4716 \end_layout
4717
4718 \begin_layout LyX-Code
4719 192 "
4720 \backslash
4721
4722 \backslash
4723 '{
4724 \backslash
4725
4726 \backslash
4727
4728 \backslash
4729 "{i}}"
4730 \begin_inset Newline newline
4731 \end_inset
4732
4733 192 "
4734 \backslash
4735
4736 \backslash
4737
4738 \backslash
4739 "{
4740 \backslash
4741
4742 \backslash
4743 '{i}}"
4744 \end_layout
4745
4746 \begin_layout Standard
4747 If LyX cannot find a mapping for the string produced by the keystroke or
4748  a deadkey sequence, it will check if it looks like an accented char and
4749  try to draw an accent over the character on screen.
4750 \end_layout
4751
4752 \begin_layout Subsection
4753 Dead Keys
4754 \end_layout
4755
4756 \begin_layout Standard
4757 There is a second way to add support for international characters through
4758  so-called dead-keys.
4759  A dead-key works in combination with a letter to produce an accented character.
4760  Here, we'll explain how to create a really simple dead-key to illustrate
4761  how they work.
4762 \end_layout
4763
4764 \begin_layout Standard
4765 Suppose you happen to need the circumflex character,
4766 \begin_inset Quotes eld
4767 \end_inset
4768
4769  ̂
4770 \begin_inset Quotes erd
4771 \end_inset
4772
4773 .
4774  You could bind the
4775 \begin_inset Flex CharStyle:MenuItem
4776 status collapsed
4777
4778 \begin_layout Plain Layout
4779 ^
4780 \end_layout
4781
4782 \end_inset
4783
4784 -key [a.k.a.
4785 \begin_inset space ~
4786 \end_inset
4787
4788
4789 \begin_inset Flex CharStyle:MenuItem
4790 status collapsed
4791
4792 \begin_layout Plain Layout
4793 Shift-6
4794 \end_layout
4795
4796 \end_inset
4797
4798 ] to the LyX command
4799 \begin_inset Flex CharStyle:Code
4800 status collapsed
4801
4802 \begin_layout Plain Layout
4803 accent-circumflex
4804 \end_layout
4805
4806 \end_inset
4807
4808  in your
4809 \begin_inset Flex CharStyle:Code
4810 status collapsed
4811
4812 \begin_layout Plain Layout
4813 lyxrc
4814 \end_layout
4815
4816 \end_inset
4817
4818  file.
4819  Now, whenever you type the
4820 \begin_inset Flex CharStyle:MenuItem
4821 status collapsed
4822
4823 \begin_layout Plain Layout
4824 ^
4825 \end_layout
4826
4827 \end_inset
4828
4829 -key followed by a letter, that letter will have a circumflex accent on
4830  it.
4831  For example, the sequence
4832 \begin_inset Quotes eld
4833 \end_inset
4834
4835
4836 \begin_inset Flex CharStyle:MenuItem
4837 status collapsed
4838
4839 \begin_layout Plain Layout
4840 ^e
4841 \end_layout
4842
4843 \end_inset
4844
4845
4846 \begin_inset Quotes erd
4847 \end_inset
4848
4849  produces the letter:
4850 \begin_inset Quotes eld
4851 \end_inset
4852
4853 ê
4854 \begin_inset Quotes erd
4855 \end_inset
4856
4857 .
4858  If you tried to type
4859 \begin_inset Quotes eld
4860 \end_inset
4861
4862
4863 \begin_inset Flex CharStyle:MenuItem
4864 status collapsed
4865
4866 \begin_layout Plain Layout
4867 ^t
4868 \end_layout
4869
4870 \end_inset
4871
4872
4873 \begin_inset Quotes erd
4874 \end_inset
4875
4876 , however, LyX will complain with a beep, since a
4877 \begin_inset Quotes eld
4878 \end_inset
4879
4880
4881 \begin_inset Flex CharStyle:MenuItem
4882 status collapsed
4883
4884 \begin_layout Plain Layout
4885 t
4886 \end_layout
4887
4888 \end_inset
4889
4890
4891 \begin_inset Quotes erd
4892 \end_inset
4893
4894  never takes a circumflex accent.
4895  Hitting
4896 \begin_inset Flex CharStyle:MenuItem
4897 status collapsed
4898
4899 \begin_layout Plain Layout
4900 Space
4901 \end_layout
4902
4903 \end_inset
4904
4905  after a dead-key produces the bare-accent.
4906  Please note this last point! If you bind a key to a dead-key, you'll need
4907  to rebind the character on that key to yet another key.
4908  Binding the
4909 \begin_inset Flex CharStyle:MenuItem
4910 status collapsed
4911
4912 \begin_layout Plain Layout
4913 ,-key
4914 \end_layout
4915
4916 \end_inset
4917
4918  to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
4919 \end_layout
4920
4921 \begin_layout Standard
4922 One common way to bind dead-keys is to use
4923 \begin_inset Flex CharStyle:MenuItem
4924 status collapsed
4925
4926 \begin_layout Plain Layout
4927 Meta-
4928 \end_layout
4929
4930 \end_inset
4931
4932 ,
4933 \begin_inset Flex CharStyle:MenuItem
4934 status collapsed
4935
4936 \begin_layout Plain Layout
4937 Ctrl-
4938 \end_layout
4939
4940 \end_inset
4941
4942 , and
4943 \begin_inset Flex CharStyle:MenuItem
4944 status collapsed
4945
4946 \begin_layout Plain Layout
4947 Shift-
4948 \end_layout
4949
4950 \end_inset
4951
4952  in combination with an accent, like
4953 \begin_inset Quotes eld
4954 \end_inset
4955
4956
4957 \begin_inset Flex CharStyle:MenuItem
4958 status collapsed
4959
4960 \begin_layout Plain Layout
4961 ~
4962 \end_layout
4963
4964 \end_inset
4965
4966
4967 \begin_inset Quotes erd
4968 \end_inset
4969
4970  or
4971 \begin_inset Quotes eld
4972 \end_inset
4973
4974
4975 \begin_inset Flex CharStyle:MenuItem
4976 status collapsed
4977
4978 \begin_layout Plain Layout
4979 ,
4980 \end_layout
4981
4982 \end_inset
4983
4984
4985 \begin_inset Quotes erd
4986 \end_inset
4987
4988  or
4989 \begin_inset Quotes eld
4990 \end_inset
4991
4992
4993 \begin_inset Flex CharStyle:MenuItem
4994 status collapsed
4995
4996 \begin_layout Plain Layout
4997 ^
4998 \end_layout
4999
5000 \end_inset
5001
5002
5003 \begin_inset Quotes erd
5004 \end_inset
5005
5006 .
5007  Another way involves using
5008 \begin_inset Flex CharStyle:Code
5009 status collapsed
5010
5011 \begin_layout Plain Layout
5012 xmodmap
5013 \end_layout
5014
5015 \end_inset
5016
5017  and
5018 \begin_inset Flex CharStyle:Code
5019 status collapsed
5020
5021 \begin_layout Plain Layout
5022 xkeycaps
5023 \end_layout
5024
5025 \end_inset
5026
5027  to set up the special
5028 \begin_inset Flex CharStyle:Code
5029 status collapsed
5030
5031 \begin_layout Plain Layout
5032 Mode_Switch
5033 \end_layout
5034
5035 \end_inset
5036
5037  key.
5038  The
5039 \begin_inset Flex CharStyle:Code
5040 status collapsed
5041
5042 \begin_layout Plain Layout
5043 Mode_Switch
5044 \end_layout
5045
5046 \end_inset
5047
5048  acts in some ways just like
5049 \begin_inset Flex CharStyle:MenuItem
5050 status collapsed
5051
5052 \begin_layout Plain Layout
5053 Shift
5054 \end_layout
5055
5056 \end_inset
5057
5058  and permits you to bind keys to accented characters.
5059  You can also turn keys into dead-keys by binding them to something like
5060
5061 \begin_inset Flex CharStyle:Code
5062 status collapsed
5063
5064 \begin_layout Plain Layout
5065 usldead_cedilla
5066 \end_layout
5067
5068 \end_inset
5069
5070  and then binding this symbolic key to the corresponding LyX command.
5071 \begin_inset Foot
5072 status collapsed
5073
5074 \begin_layout Plain Layout
5075 Note from
5076 \noun on
5077 John Weiss
5078 \noun default
5079 : This is exactly what I do in my
5080 \begin_inset Flex CharStyle:Code
5081 status collapsed
5082
5083 \begin_layout Plain Layout
5084 ~/.lyx/lyxrc
5085 \end_layout
5086
5087 \end_inset
5088
5089  and my
5090 \begin_inset Flex CharStyle:Code
5091 status collapsed
5092
5093 \begin_layout Plain Layout
5094 ~/.xmodmap
5095 \end_layout
5096
5097 \end_inset
5098
5099  files.
5100  I have my
5101 \begin_inset Flex CharStyle:MenuItem
5102 status collapsed
5103
5104 \begin_layout Plain Layout
5105 Scroll
5106 \begin_inset space ~
5107 \end_inset
5108
5109 Lock
5110 \end_layout
5111
5112 \end_inset
5113
5114  key set up as
5115 \begin_inset Flex CharStyle:Code
5116 status collapsed
5117
5118 \begin_layout Plain Layout
5119 Mode_Shift
5120 \end_layout
5121
5122 \end_inset
5123
5124  and a bunch of these
5125 \begin_inset Quotes eld
5126 \end_inset
5127
5128
5129 \begin_inset Flex CharStyle:Code
5130 status collapsed
5131
5132 \begin_layout Plain Layout
5133 usldead_*
5134 \end_layout
5135
5136 \end_inset
5137
5138
5139 \begin_inset Quotes erd
5140 \end_inset
5141
5142  symbolic keys bound such things as
5143 \begin_inset Flex CharStyle:MenuItem
5144 status collapsed
5145
5146 \begin_layout Plain Layout
5147 Scroll
5148 \begin_inset space ~
5149 \end_inset
5150
5151 Lock-^
5152 \end_layout
5153
5154 \end_inset
5155
5156  and
5157 \begin_inset Flex CharStyle:MenuItem
5158 status collapsed
5159
5160 \begin_layout Plain Layout
5161 Scroll
5162 \begin_inset space ~
5163 \end_inset
5164
5165 Lock-~
5166 \end_layout
5167
5168 \end_inset
5169
5170 .
5171  This is how I produce my accented characters.
5172 \end_layout
5173
5174 \end_inset
5175
5176  You can make just about anything into the
5177 \begin_inset Flex CharStyle:Code
5178 status collapsed
5179
5180 \begin_layout Plain Layout
5181 Mode_Switch
5182 \end_layout
5183
5184 \end_inset
5185
5186  key: One of the
5187 \begin_inset Flex CharStyle:MenuItem
5188 status collapsed
5189
5190 \begin_layout Plain Layout
5191 Ctrl-
5192 \end_layout
5193
5194 \end_inset
5195
5196  keys, a spare function key, etc.
5197  As for the LyX commands that produce accents, check the entry for
5198 \begin_inset Flex CharStyle:Code
5199 status collapsed
5200
5201 \begin_layout Plain Layout
5202 accent-acute
5203 \end_layout
5204
5205 \end_inset
5206
5207  in the
5208 \emph on
5209 Reference Manual
5210 \emph default
5211 .
5212  You'll find the complete list there.
5213 \end_layout
5214
5215 \begin_layout Subsection
5216 Saving your Language Configuration
5217 \end_layout
5218
5219 \begin_layout Standard
5220 You can edit your preferences so that your desired language environment
5221  is automatically configured when LyX starts up, via the
5222 \begin_inset Flex CharStyle:MenuItem
5223 status collapsed
5224
5225 \begin_layout Plain Layout
5226 Edit\SpecialChar \menuseparator
5227 Preferences
5228 \end_layout
5229
5230 \end_inset
5231
5232  dialog.
5233 \end_layout
5234
5235 \begin_layout Chapter
5236 Installing New Document Classes, Layouts, and Templates
5237 \begin_inset CommandInset label
5238 LatexCommand label
5239 name "cha:Installing-New-Document"
5240
5241 \end_inset
5242
5243
5244 \begin_inset OptArg
5245 status collapsed
5246
5247 \begin_layout Plain Layout
5248 Installing New Document Classes
5249 \end_layout
5250
5251 \end_inset
5252
5253
5254 \end_layout
5255
5256 \begin_layout Standard
5257 In this chapter, we describe the procedures for creating and installing
5258  new LyX layout and template files, as well as offer a refresher on correctly
5259  installing new LaTeX document classes.
5260
5261 \end_layout
5262
5263 \begin_layout Standard
5264 First, let us a say a few words about how one ought to think about the relation
5265  between LyX and LaTeX.
5266  The thing to understand is that, in a certain sense, LyX doesn't know anything
5267  about LaTeX.
5268  Indeed, from LyX's point of view, LaTeX is just one of several
5269 \begin_inset Quotes eld
5270 \end_inset
5271
5272 backend formats
5273 \begin_inset Quotes erd
5274 \end_inset
5275
5276  in which it is capable of producing output.
5277  Other such formats are DocBook, plaintext, and XHTML.
5278  LaTeX is, of course, a particularly important format, but very little of
5279  the information LyX has about LaTeX is actually contained in the program
5280  itself.
5281 \begin_inset Foot
5282 status collapsed
5283
5284 \begin_layout Plain Layout
5285 Some commands are sufficiently complex that they are
5286 \begin_inset Quotes eld
5287 \end_inset
5288
5289 hardcoded
5290 \begin_inset Quotes erd
5291 \end_inset
5292
5293  into LyX.
5294  But the developers generally regard this as a Bad Thing.
5295 \end_layout
5296
5297 \end_inset
5298
5299  Rather, that information, even for the standard classes like
5300 \begin_inset Flex CharStyle:Code
5301 status collapsed
5302
5303 \begin_layout Plain Layout
5304 article.cls
5305 \end_layout
5306
5307 \end_inset
5308
5309 , is contained in `layout files'.
5310  Similarly, LyX itself does not know much about DocBook or XHTML.
5311  What it knows is contained in layout files.
5312 \end_layout
5313
5314 \begin_layout Standard
5315 You can think of the layout file for a given document class as a translation
5316  manual between LyX constructs---paragraphs with their corresponding styles,
5317  certain sorts of insets, etc---and the corresponding LaTeX, DocBook, or
5318  XHTML constructs.
5319  Almost everything LyX knows about
5320 \begin_inset Flex CharStyle:Code
5321 status collapsed
5322
5323 \begin_layout Plain Layout
5324 article.cls
5325 \end_layout
5326
5327 \end_inset
5328
5329 , for example, is contained in the file
5330 \begin_inset Flex CharStyle:Code
5331 status collapsed
5332
5333 \begin_layout Plain Layout
5334 article.layout
5335 \end_layout
5336
5337 \end_inset
5338
5339  and in various other files it includes.
5340  For this reason, anyone intending to write layout files should plan to
5341  study the existing files.
5342  A good place to start is with
5343 \begin_inset Flex CharStyle:Code
5344 status collapsed
5345
5346 \begin_layout Plain Layout
5347 stdsections.inc
5348 \end_layout
5349
5350 \end_inset
5351
5352 , which is included in
5353 \begin_inset Flex CharStyle:Code
5354 status collapsed
5355
5356 \begin_layout Plain Layout
5357 article.layout
5358 \end_layout
5359
5360 \end_inset
5361
5362 ,
5363 \begin_inset Flex CharStyle:Code
5364 status collapsed
5365
5366 \begin_layout Plain Layout
5367 book.layout
5368 \end_layout
5369
5370 \end_inset
5371
5372 , and many of the other layout files for document classes.
5373  This file is where sections and the like are defined:
5374 \begin_inset Flex CharStyle:Code
5375 status collapsed
5376
5377 \begin_layout Plain Layout
5378 stdsections.inc
5379 \end_layout
5380
5381 \end_inset
5382
5383  tells LyX how paragraphs that are marked with the Section, Subsection,
5384  etc, styles can be translated into corresponding LaTeX, DocBook, and XHTML
5385  commands and tags.
5386  The
5387 \begin_inset Flex CharStyle:Code
5388 status collapsed
5389
5390 \begin_layout Plain Layout
5391 article.layout
5392 \end_layout
5393
5394 \end_inset
5395
5396  file basically just includes several of these
5397 \begin_inset Flex CharStyle:Code
5398 status collapsed
5399
5400 \begin_layout Plain Layout
5401 std*.inc
5402 \end_layout
5403
5404 \end_inset
5405
5406  files.
5407 \end_layout
5408
5409 \begin_layout Standard
5410 Defining the LyX--LaTeX correspondence is not the only thing layout files
5411  do, though.
5412  Their other job is to define how the LyX constructs themselves will appear
5413  on-screen.
5414  The fact that layout files have these two jobs is often a source of confusion,
5415  because they are completely separate.
5416  Telling LyX how to translate a certain paragraph style into LaTeX does
5417  not tell LyX how to display it; conversely, telling LyX how to display
5418  a certain paragraph style does not tell LyX how to translate it into LaTeX
5419  (let alone tell LaTeX how to display it).
5420  So, in general, when you define a new LyX construct, you must always do
5421  two quite separate things: (i)
5422 \begin_inset space ~
5423 \end_inset
5424
5425 tell LyX how to translate it into LaTeX and (ii)
5426 \begin_inset space ~
5427 \end_inset
5428
5429 tell LyX how to display it.
5430 \end_layout
5431
5432 \begin_layout Standard
5433 Much the same is true, of course, as regards LyX's other backend formats,
5434  though XHTML is in some ways different, because in that case LyX
5435 \emph on
5436 is
5437 \emph default
5438  able, to some extent, to use information about how it should display a
5439  paragraph on the screen to output information (in the form of CSS) about
5440  how the paragraph should be displayed in a browser.
5441  Even in this case, however, the distinction between what LyX does internally
5442  and how things are rendered externally remains in force, and the two can
5443  be controlled separately.
5444  See
5445 \begin_inset CommandInset ref
5446 LatexCommand prettyref
5447 reference "sec:Tags-for-XHTML"
5448
5449 \end_inset
5450
5451  for the details.
5452 \end_layout
5453
5454 \begin_layout Section
5455 Installing new LaTeX files
5456 \end_layout
5457
5458 \begin_layout Standard
5459 Some installations may not include a LaTeX package or class file that you
5460  would like to use within LyX.
5461  For example, you might need FoilTeX, a package for preparing slides for
5462  overhead projectors.
5463  Modern LaTeX distributions like TeXLive (2008 or newer) or MiKTeX provide
5464  a user interface for installing such packages.
5465  For example, with MiKTeX, you start the program
5466 \begin_inset Quotes eld
5467 \end_inset
5468
5469 Browse Packages
5470 \begin_inset Quotes erd
5471 \end_inset
5472
5473  to get a list of available packages.
5474  To install one, right click on it or use the toolbar button to install
5475  it.
5476
5477 \end_layout
5478
5479 \begin_layout Standard
5480 If your LaTeX distribution doesn't provide such a `package manager', or
5481  if the file is not available from your distribution, then you can follow
5482  these steps to install it manually.
5483 \end_layout
5484
5485 \begin_layout Enumerate
5486 Get the package from
5487 \begin_inset CommandInset href
5488 LatexCommand href
5489 name "CTAN"
5490 target "http://www.ctan.org/"
5491
5492 \end_inset
5493
5494  or wherever.
5495 \end_layout
5496
5497 \begin_layout Enumerate
5498 You can install the package in several different places.
5499  If you want it to be available for all users on your system, then you should
5500  install it in your `local' TeX tree; if you want (or need) it to be available
5501  just for you, then you can install it in your own `user' TeX tree.
5502  Where these trees should be created, if they do not already exist, depends
5503  upon the details of your system.
5504  To find out where they are, look in the file
5505 \begin_inset Flex CharStyle:Code
5506 status collapsed
5507
5508 \begin_layout Plain Layout
5509 texmf.cnf
5510 \end_layout
5511
5512 \end_inset
5513
5514 .
5515 \begin_inset Foot
5516 status collapsed
5517
5518 \begin_layout Plain Layout
5519 This usually lives in the directory
5520 \begin_inset Flex CharStyle:Code
5521 status collapsed
5522
5523 \begin_layout Plain Layout
5524 $TEXMF/web2c
5525 \end_layout
5526
5527 \end_inset
5528
5529 , though you can run
5530 \begin_inset Flex CharStyle:Code
5531 status collapsed
5532
5533 \begin_layout Plain Layout
5534 kpsewhich texmf.cnf
5535 \end_layout
5536
5537 \end_inset
5538
5539  to locate it.
5540 \end_layout
5541
5542 \end_inset
5543
5544  The location of the `local' TeX tree is defined by the
5545 \begin_inset Flex CharStyle:Code
5546 status collapsed
5547
5548 \begin_layout Plain Layout
5549 TEXMFLOCAL
5550 \end_layout
5551
5552 \end_inset
5553
5554  variable; this is usually somewhere like
5555 \begin_inset Flex URL
5556 status collapsed
5557
5558 \begin_layout Plain Layout
5559
5560 /usr/local/share/texmf/
5561 \end_layout
5562
5563 \end_inset
5564
5565 .
5566  The location of the `user' TeX tree is defined by
5567 \begin_inset Flex CharStyle:Code
5568 status collapsed
5569
5570 \begin_layout Plain Layout
5571 TEXMFHOME
5572 \end_layout
5573
5574 \end_inset
5575
5576  and is commonly
5577 \begin_inset Flex CharStyle:Code
5578 status collapsed
5579
5580 \begin_layout Plain Layout
5581 $HOME/texmf/
5582 \end_layout
5583
5584 \end_inset
5585
5586 .
5587  (If these variables are not predefined, you can define them.) You'll probably
5588  need root permissions to create or modify the `local' tree, but your `user'
5589  tree shouldn't have such limitations.
5590 \end_layout
5591
5592 \begin_layout Enumerate
5593 Make sure
5594 \begin_inset Flex CharStyle:Code
5595 status collapsed
5596
5597 \begin_layout Plain Layout
5598 TEXMF
5599 \end_layout
5600
5601 \end_inset
5602
5603  includes the
5604 \begin_inset Flex CharStyle:Code
5605 status collapsed
5606
5607 \begin_layout Plain Layout
5608 TEXMFLOCAL
5609 \end_layout
5610
5611 \end_inset
5612
5613  and
5614 \begin_inset Flex CharStyle:Code
5615 status collapsed
5616
5617 \begin_layout Plain Layout
5618 TEXMFHOME
5619 \end_layout
5620
5621 \end_inset
5622
5623  variables; e.
5624 \begin_inset space \thinspace{}
5625 \end_inset
5626
5627 g.
5628 \begin_inset Newline newline
5629 \end_inset
5630
5631
5632 \begin_inset Flex CharStyle:Code
5633 status collapsed
5634
5635 \begin_layout Plain Layout
5636 TEXMF = {$TEXMFHOME,!!$TEXMFLOCAL,!!$TEXMFMAIN}
5637 \end_layout
5638
5639 \end_inset
5640
5641
5642 \begin_inset Newline newline
5643 \end_inset
5644
5645 It probably does.
5646 \end_layout
5647
5648 \begin_layout Enumerate
5649 Your local and user trees
5650 \emph on
5651 must
5652 \emph default
5653  have the same sort of directory structure as your main existing
5654 \begin_inset Flex CharStyle:Code
5655 status collapsed
5656
5657 \begin_layout Plain Layout
5658 texmf
5659 \end_layout
5660
5661 \end_inset
5662
5663  directory, which will be found at
5664 \begin_inset Flex CharStyle:Code
5665 status collapsed
5666
5667 \begin_layout Plain Layout
5668 TEXMFMAIN
5669 \end_layout
5670
5671 \end_inset
5672
5673  (commonly,
5674 \begin_inset Flex CharStyle:Code
5675 status collapsed
5676
5677 \begin_layout Plain Layout
5678 /usr/share/texmf/
5679 \end_layout
5680
5681 \end_inset
5682
5683 .) For example, latex packages should go under
5684 \begin_inset Flex CharStyle:Code
5685 status collapsed
5686
5687 \begin_layout Plain Layout
5688 $TEXMFLOCAL/tex/latex/
5689 \end_layout
5690
5691 \end_inset
5692
5693  or
5694 \begin_inset Flex CharStyle:Code
5695 status collapsed
5696
5697 \begin_layout Plain Layout
5698 $TEXMFHOME/tex/latex/
5699 \end_layout
5700
5701 \end_inset
5702
5703 .
5704  If you do not put them here, they probably will not work.
5705 \end_layout
5706
5707 \begin_layout Enumerate
5708 Once your tree is properly set up, you can install the package into an appropria
5709 te location.
5710  If you are lucky, your package will have been provided as a so-called `TDS'
5711  (TeX Directory Structure) zip file.
5712  To install it, you want to unzip it from the top of your tree.
5713  So, for example, you can copy the file
5714 \begin_inset Flex CharStyle:Code
5715 status collapsed
5716
5717 \begin_layout Plain Layout
5718 newpkg.zip
5719 \end_layout
5720
5721 \end_inset
5722
5723  to
5724 \begin_inset Flex CharStyle:Code
5725 status collapsed
5726
5727 \begin_layout Plain Layout
5728 /home/yourname/texmf/
5729 \end_layout
5730
5731 \end_inset
5732
5733  and then, from inside that directory, just run:
5734 \begin_inset Flex CharStyle:Code
5735 status collapsed
5736
5737 \begin_layout Plain Layout
5738 unzip newpkg.zip
5739 \end_layout
5740
5741 \end_inset
5742
5743 .
5744  This will extract the needed files and copy them where they need to be.
5745 \begin_inset Newline newline
5746 \end_inset
5747
5748 If you do not have a TDS file, then you have to do this manually.
5749  For example, you might install the FoilTeX files into
5750 \begin_inset Flex URL
5751 status collapsed
5752
5753 \begin_layout Plain Layout
5754
5755 $TEXMFLOCAL/tex/latex/contrib/foiltex
5756 \end_layout
5757
5758 \end_inset
5759
5760 .
5761  Why there? The CTAN download directories are themselves organized much
5762  like a TeX tree, and it isn't a bad idea to follow its structure when you
5763  install your own files.
5764  FoilTeX, as it happens, is found at
5765 \begin_inset Flex URL
5766 status collapsed
5767
5768 \begin_layout Plain Layout
5769
5770 http://ctan.org/texarchive/macros/latex/contrib/foiltex/
5771 \end_layout
5772
5773 \end_inset
5774
5775 .
5776
5777 \end_layout
5778
5779 \begin_layout Enumerate
5780 Finally, you must update the database TeX uses to find files.
5781  On MiKTeX, this is done by pressing the button
5782 \family sans
5783 Refresh
5784 \begin_inset space ~
5785 \end_inset
5786
5787 FNDB
5788 \family default
5789  that you find in MiKTeX's
5790 \begin_inset Quotes eld
5791 \end_inset
5792
5793 Settings
5794 \begin_inset Quotes erd
5795 \end_inset
5796
5797  program.
5798
5799 \begin_inset Flex CharStyle:Code
5800 status collapsed
5801
5802 \begin_layout Plain Layout
5803 $TEXMFLOCAL/tex/latex/
5804 \end_layout
5805
5806 \end_inset
5807
5808 .
5809  Under TeXLive and the like, you should run
5810 \begin_inset Flex CharStyle:Code
5811 status collapsed
5812
5813 \begin_layout Plain Layout
5814 texhash
5815 \end_layout
5816
5817 \end_inset
5818
5819  from a terminal, with root permissions if necessary.
5820
5821 \end_layout
5822
5823 \begin_layout Standard
5824 Your package is now installed and available to LaTeX.
5825  You can verify this from a terminal by typing `
5826 \begin_inset Flex CharStyle:Code
5827 status collapsed
5828
5829 \begin_layout Plain Layout
5830 kpsewhich yourfile.ext
5831 \end_layout
5832
5833 \end_inset
5834
5835 '.
5836  To make LyX aware of it, however, you will need to reconfigure (
5837 \begin_inset Flex CharStyle:MenuItem
5838 status collapsed
5839
5840 \begin_layout Plain Layout
5841 Tools\SpecialChar \menuseparator
5842 Reconfigure
5843 \end_layout
5844
5845 \end_inset
5846
5847 ) and then restart LyX.
5848  If the new package was a document class, such as FoilTeX again, you will
5849  now see it available under
5850 \begin_inset Flex CharStyle:MenuItem
5851 status collapsed
5852
5853 \begin_layout Plain Layout
5854 Document\SpecialChar \menuseparator
5855 Settings\SpecialChar \menuseparator
5856 Document Class
5857 \end_layout
5858
5859 \end_inset
5860
5861 , in this case as
5862 \begin_inset Flex CharStyle:MenuItem
5863 status collapsed
5864
5865 \begin_layout Plain Layout
5866 slides (FoilTeX)
5867 \end_layout
5868
5869 \end_inset
5870
5871 .
5872 \end_layout
5873
5874 \begin_layout Standard
5875 What if there isn't a layout file is available for your new document class?
5876  Then, unfortunately, LyX will know nothing about it until you create a
5877  layout file yourself (or get someone else to do it).
5878  That is the topic of the next section.
5879 \end_layout
5880
5881 \begin_layout Section
5882 Types of layout files
5883 \end_layout
5884
5885 \begin_layout Standard
5886 This section describes the various sorts of LyX files that contain layout
5887  information.
5888  These files describe various paragraph and character styles, determining
5889  how LyX should display them and how they should be translated into LaTeX,
5890  DocBook, XHTML, or whatever output format is being used.
5891
5892 \end_layout
5893
5894 \begin_layout Standard
5895 We shall try to provide a thorough description of the process of writing
5896  layout files here.
5897  However, there are so many different types of documents supported even
5898  by just LaTeX that we can't hope to cover every different possibility or
5899  problem you might encounter.
5900  The LyX users' list is frequented by people with lots of experience with
5901  layout design who are willing to share what they've learned, so please
5902  feel free to ask questions there.
5903 \end_layout
5904
5905 \begin_layout Standard
5906 As you prepare to write a new layout, it is extremely helpful to look at
5907  the layouts distributed with LyX.
5908  If you write a LyX layout for a LaTeX document class that might also be
5909  used by others, or write a module that might be useful to others, then
5910  you should consider posting your layout to the
5911 \begin_inset CommandInset href
5912 LatexCommand href
5913 name "layout section on the LyX wiki"
5914 target "http://wiki.lyx.org/Layouts/Layouts"
5915
5916 \end_inset
5917
5918  or even to the LyX developers' list, so that it might be included in LyX
5919  itself.
5920 \begin_inset Foot
5921 status collapsed
5922
5923 \begin_layout Plain Layout
5924 Note that LyX is licensed under the General Public License, so any material
5925  that is contribued to LyX must be similarly licensed.
5926 \end_layout
5927
5928 \end_inset
5929
5930
5931 \end_layout
5932
5933 \begin_layout Subsection
5934 Layout modules
5935 \begin_inset CommandInset label
5936 LatexCommand label
5937 name "sub:Layout-modules"
5938
5939 \end_inset
5940
5941
5942 \end_layout
5943
5944 \begin_layout Standard
5945 We have spoken to this point about `layout files'.
5946  But there are different sorts of files that contain layout information.
5947  Layout files, strictly so called, have the
5948 \begin_inset Flex CharStyle:Code
5949 status collapsed
5950
5951 \begin_layout Plain Layout
5952 .layout
5953 \end_layout
5954
5955 \end_inset
5956
5957  extension and provide LyX with information about document classes.
5958  As of LyX 1.6, however, layout information can also be contained in layout
5959
5960 \emph on
5961 modules
5962 \emph default
5963 , which have the
5964 \begin_inset Flex CharStyle:Code
5965 status collapsed
5966
5967 \begin_layout Plain Layout
5968 .module
5969 \end_layout
5970
5971 \end_inset
5972
5973  extension.
5974  Modules are to LaTeX packages much as layouts are to LaTeX classes, and
5975  some modules—such as the
5976 \begin_inset Flex CharStyle:Code
5977 status collapsed
5978
5979 \begin_layout Plain Layout
5980 endnotes
5981 \end_layout
5982
5983 \end_inset
5984
5985  module—specifcally provide support for one package.
5986  In a sense, layout modules are similar to included
5987 \begin_inset Foot
5988 status collapsed
5989
5990 \begin_layout Plain Layout
5991 These can have any extension, but by convention have the
5992 \begin_inset Flex CharStyle:Code
5993 status collapsed
5994
5995 \begin_layout Plain Layout
5996 .inc
5997 \end_layout
5998
5999 \end_inset
6000
6001  extension.
6002 \end_layout
6003
6004 \end_inset
6005
6006  files—files like
6007 \begin_inset Flex CharStyle:Code
6008 status collapsed
6009
6010 \begin_layout Plain Layout
6011 stdsections.inc
6012 \end_layout
6013
6014 \end_inset
6015
6016 —in that modules are not specific to a given document class but may be used
6017  with many different classes.
6018  The difference is that using an included file with
6019 \begin_inset Flex CharStyle:Code
6020 status collapsed
6021
6022 \begin_layout Plain Layout
6023 article.cls
6024 \end_layout
6025
6026 \end_inset
6027
6028  requires editing that file.
6029  Modules, by contrast, are selected in the
6030 \begin_inset Flex CharStyle:MenuItem
6031 status collapsed
6032
6033 \begin_layout Plain Layout
6034 Document\SpecialChar \menuseparator
6035 Settings
6036 \end_layout
6037
6038 \end_inset
6039
6040  dialog.
6041 \end_layout
6042
6043 \begin_layout Standard
6044 Building modules is the easiest way to get started with layout editing,
6045  since it can be as simple as adding a single new paragraph style or flex
6046  inset.
6047  But modules may, in principle, contain anything a layout file can contain.
6048 \end_layout
6049
6050 \begin_layout Standard
6051 After creating a new module and copying it to the
6052 \begin_inset Flex CharStyle:Code
6053 status collapsed
6054
6055 \begin_layout Plain Layout
6056 layout/
6057 \end_layout
6058
6059 \end_inset
6060
6061  folder, you will need to reconfigure and then restart LyX for the module
6062  to appear in the menu.
6063  However, changes you make to the module will be seen immediately, if you
6064  open
6065 \begin_inset Flex CharStyle:MenuItem
6066 status collapsed
6067
6068 \begin_layout Plain Layout
6069 Document\SpecialChar \menuseparator
6070 Settings
6071 \end_layout
6072
6073 \end_inset
6074
6075 , highlight something, and then hit
6076 \begin_inset Quotes eld
6077 \end_inset
6078
6079 OK
6080 \begin_inset Quotes erd
6081 \end_inset
6082
6083 .
6084
6085 \emph on
6086 It is strongly recommended that you save your work before doing this
6087 \emph default
6088 .
6089  In fact,
6090 \emph on
6091 it is strongly recommended that you not attempt to edit modules while simultaneo
6092 usly working on actual documents
6093 \emph default
6094 .
6095  Though of course the developers strive to keep LyX stable in such situations,
6096  syntax errors and the like in your module file could cause strange behavior.
6097 \end_layout
6098
6099 \begin_layout Subsection
6100 Layout for
6101 \begin_inset Flex CharStyle:MenuItem
6102 status collapsed
6103
6104 \begin_layout Plain Layout
6105 .sty
6106 \end_layout
6107
6108 \end_inset
6109
6110  files
6111 \end_layout
6112
6113 \begin_layout Standard
6114 There are two situations you are likely to encounter when wanting to support
6115  a new LaTeX document class, involving LaTeX2e class (
6116 \begin_inset Flex CharStyle:Code
6117 status collapsed
6118
6119 \begin_layout Plain Layout
6120 .cls
6121 \end_layout
6122
6123 \end_inset
6124
6125 ) and style (
6126 \begin_inset Flex CharStyle:Code
6127 status collapsed
6128
6129 \begin_layout Plain Layout
6130 .sty
6131 \end_layout
6132
6133 \end_inset
6134
6135 ) files.
6136  Supporting a style file is usually fairly easy.
6137  Supporting a new class file is a bit harder.
6138  We'll discuss the former in this section and the latter in the next.
6139  Similar remarks apply, of course, if you want to support a new DocBook
6140  DTD.
6141 \end_layout
6142
6143 \begin_layout Standard
6144 The easier case is the one in which your new document class is provided
6145  as a style file that is to be used in conjunction with an already supported
6146  document class.
6147  For the sake of the example, we'll assume that the style file is called
6148
6149 \begin_inset Flex CharStyle:MenuItem
6150 status collapsed
6151
6152 \begin_layout Plain Layout
6153 myclass.sty
6154 \end_layout
6155
6156 \end_inset
6157
6158  and that it is meant to be used with
6159 \begin_inset Flex CharStyle:MenuItem
6160 status collapsed
6161
6162 \begin_layout Plain Layout
6163 report.cls
6164 \end_layout
6165
6166 \end_inset
6167
6168 , which is a standard class.
6169
6170 \end_layout
6171
6172 \begin_layout Standard
6173 Start by copying the existing class's layout file into your local directory:
6174 \begin_inset Foot
6175 status collapsed
6176
6177 \begin_layout Plain Layout
6178 Of course, which directory is your local directory will vary by platform,
6179  and LyX allows you to specify your local directory on startup, too, using
6180  the
6181 \begin_inset Flex CharStyle:Code
6182 status collapsed
6183
6184 \begin_layout Plain Layout
6185 -userdir
6186 \end_layout
6187
6188 \end_inset
6189
6190  option.
6191 \end_layout
6192
6193 \end_inset
6194
6195
6196 \end_layout
6197
6198 \begin_layout LyX-Code
6199 cp report.layout ~/.lyx/layouts/myclass.layout
6200 \end_layout
6201
6202 \begin_layout Standard
6203 Then edit
6204 \begin_inset Flex CharStyle:Code
6205 status collapsed
6206
6207 \begin_layout Plain Layout
6208 myclass.layout
6209 \end_layout
6210
6211 \end_inset
6212
6213  and change the line:
6214 \end_layout
6215
6216 \begin_layout LyX-Code
6217
6218 \backslash
6219 DeclareLaTeXClass{report}
6220 \end_layout
6221
6222 \begin_layout Standard
6223 to read
6224 \end_layout
6225
6226 \begin_layout LyX-Code
6227
6228 \backslash
6229 DeclareLaTeXClass[report, myclass.sty]{report (myclass)}
6230 \end_layout
6231
6232 \begin_layout Standard
6233 Then add:
6234 \end_layout
6235
6236 \begin_layout LyX-Code
6237 Preamble
6238 \begin_inset Newline newline
6239 \end_inset
6240
6241
6242 \backslash
6243 usepackage{myclass}
6244 \begin_inset Newline newline
6245 \end_inset
6246
6247 EndPreamble
6248 \end_layout
6249
6250 \begin_layout Standard
6251 near the top of the file.
6252 \end_layout
6253
6254 \begin_layout Standard
6255 Start LyX and select
6256 \begin_inset Flex CharStyle:MenuItem
6257 status collapsed
6258
6259 \begin_layout Plain Layout
6260 Tools\SpecialChar \menuseparator
6261 Reconfigure
6262 \end_layout
6263
6264 \end_inset
6265
6266 .
6267  Then restart LyX and try creating a new document.
6268  You should see "
6269 \begin_inset Flex CharStyle:MenuItem
6270 status collapsed
6271
6272 \begin_layout Plain Layout
6273 report (myclass)
6274 \end_layout
6275
6276 \end_inset
6277
6278 " as a document class option in the
6279 \begin_inset Flex CharStyle:MenuItem
6280 status collapsed
6281
6282 \begin_layout Plain Layout
6283 Document\SpecialChar \menuseparator
6284 Settings
6285 \end_layout
6286
6287 \end_inset
6288
6289  dialog.
6290  It is likely that some of the sectioning commands and such in your new
6291  class will work differently from how they worked in the base class—
6292 \begin_inset Flex CharStyle:Code
6293 status collapsed
6294
6295 \begin_layout Plain Layout
6296 report
6297 \end_layout
6298
6299 \end_inset
6300
6301  in this example—so you can fiddle around with the settings for the different
6302  sections if you wish.
6303  The layout information for sections is contained in
6304 \begin_inset Flex CharStyle:Code
6305 status collapsed
6306
6307 \begin_layout Plain Layout
6308 stdsections.inc
6309 \end_layout
6310
6311 \end_inset
6312
6313 , but you do not need to copy and change this file.
6314  Instead, you can simply add your changes to your layout file, after the
6315  line
6316 \begin_inset Flex CharStyle:Code
6317 status collapsed
6318
6319 \begin_layout Plain Layout
6320 Input stdclass.inc
6321 \end_layout
6322
6323 \end_inset
6324
6325 , which itself includes
6326 \begin_inset Flex CharStyle:Code
6327 status collapsed
6328
6329 \begin_layout Plain Layout
6330 stdsections.inc
6331 \end_layout
6332
6333 \end_inset
6334
6335 .
6336  For example, you might add these lines:
6337 \end_layout
6338
6339 \begin_layout LyX-Code
6340 Style Chapter
6341 \end_layout
6342
6343 \begin_layout LyX-Code
6344     Font
6345 \end_layout
6346
6347 \begin_layout LyX-Code
6348         Family Sans
6349 \end_layout
6350
6351 \begin_layout LyX-Code
6352     EndFont
6353 \end_layout
6354
6355 \begin_layout LyX-Code
6356 End
6357 \end_layout
6358
6359 \begin_layout Standard
6360 to change the font for chapter headings to sans-serif.
6361  This will override (or, in this case, add to) the existing declaration
6362  for the Chapter style.
6363
6364 \end_layout
6365
6366 \begin_layout Standard
6367 Your new package may also provide commands or environments not present in
6368  the base class.
6369  In this case, you will want to add these to the layout file.
6370  See
6371 \begin_inset CommandInset ref
6372 LatexCommand ref
6373 reference "sec:TextClass"
6374
6375 \end_inset
6376
6377  for information on how to do so.
6378 \end_layout
6379
6380 \begin_layout Standard
6381 If
6382 \begin_inset Flex CharStyle:MenuItem
6383 status collapsed
6384
6385 \begin_layout Plain Layout
6386 myclass.sty
6387 \end_layout
6388
6389 \end_inset
6390
6391  can be used with several different document classes, and even if it cannot,
6392  you might find it easiest just to write a module that you can load with
6393  the base class.
6394  The simplest possible such module would be:
6395 \end_layout
6396
6397 \begin_layout LyX-Code
6398 #
6399 \backslash
6400 DeclareLyXModule{My Package}
6401 \end_layout
6402
6403 \begin_layout LyX-Code
6404 #DescriptionBegin
6405 \end_layout
6406
6407 \begin_layout LyX-Code
6408 #Support for mypkg.sty.
6409 \end_layout
6410
6411 \begin_layout LyX-Code
6412 #DescriptionEnd
6413 \begin_inset Newline newline
6414 \end_inset
6415
6416
6417 \end_layout
6418
6419 \begin_layout LyX-Code
6420 Format 21
6421 \begin_inset Newline newline
6422 \end_inset
6423
6424
6425 \end_layout
6426
6427 \begin_layout LyX-Code
6428 Preamble
6429 \begin_inset Newline newline
6430 \end_inset
6431
6432
6433 \backslash
6434 usepackage{mypkg}
6435 \begin_inset Newline newline
6436 \end_inset
6437
6438 EndPreamble
6439 \end_layout
6440
6441 \begin_layout Standard
6442 A more complex module might modify the behavior of some existing constructs
6443  or define some new ones.
6444  Again, see
6445 \begin_inset CommandInset ref
6446 LatexCommand ref
6447 reference "sec:TextClass"
6448
6449 \end_inset
6450
6451  for discussion.
6452 \end_layout
6453
6454 \begin_layout Subsection
6455 Layout for
6456 \begin_inset Flex CharStyle:MenuItem
6457 status collapsed
6458
6459 \begin_layout Plain Layout
6460 .cls
6461 \end_layout
6462
6463 \end_inset
6464
6465  files
6466 \end_layout
6467
6468 \begin_layout Standard
6469 There are two possibilities here.
6470  One is that the class file is itself based upon an existing document class.
6471  For example, many thesis classes are based upon
6472 \begin_inset Flex CharStyle:MenuItem
6473 status collapsed
6474
6475 \begin_layout Plain Layout
6476 book.cls
6477 \end_layout
6478
6479 \end_inset
6480
6481 .
6482  To see whether yours is, look for a line like
6483 \end_layout
6484
6485 \begin_layout LyX-Code
6486
6487 \backslash
6488 LoadClass{book}
6489 \end_layout
6490
6491 \begin_layout Standard
6492 in the file.
6493  If so, then you may proceed largely as in the previous section, though
6494  the
6495 \begin_inset Flex CharStyle:Code
6496 status collapsed
6497
6498 \begin_layout Plain Layout
6499 DeclareLaTeXClass
6500 \end_layout
6501
6502 \end_inset
6503
6504  line will be different.
6505  If your new class is
6506 \begin_inset Flex CharStyle:Code
6507 status collapsed
6508
6509 \begin_layout Plain Layout
6510 thesis
6511 \end_layout
6512
6513 \end_inset
6514
6515  and it is based upon
6516 \begin_inset Flex CharStyle:Code
6517 status collapsed
6518
6519 \begin_layout Plain Layout
6520 book
6521 \end_layout
6522
6523 \end_inset
6524
6525 , then the line should read:
6526 \begin_inset Foot
6527 status collapsed
6528
6529 \begin_layout Plain Layout
6530 And it will be easiest if you save the file to
6531 \begin_inset Flex CharStyle:Code
6532 status collapsed
6533
6534 \begin_layout Plain Layout
6535 thesis.layout
6536 \end_layout
6537
6538 \end_inset
6539
6540 : LyX assumes that the document class has the same name as the layout file.
6541
6542 \end_layout
6543
6544 \end_inset
6545
6546
6547 \end_layout
6548
6549 \begin_layout LyX-Code
6550
6551 \backslash
6552 DeclareLaTeXClass[thesis,book]{thesis}
6553 \end_layout
6554
6555 \begin_layout Standard
6556 If, on the other hand, the new class is not based upon an existing class,
6557  you will probably have to
6558 \begin_inset Quotes eld
6559 \end_inset
6560
6561 roll your own
6562 \begin_inset Quotes erd
6563 \end_inset
6564
6565  layout.
6566  We strongly suggest copying an existing layout file which uses a similar
6567  LaTeX class and then modifying it, if you can do so.
6568  At least use an existing file as a starting point so you can find out what
6569  items you need to worry about.
6570  Again, the specifics are covered below.
6571 \end_layout
6572
6573 \begin_layout Subsection
6574 Creating templates
6575 \begin_inset CommandInset label
6576 LatexCommand label
6577 name "sub:Creating-Templates"
6578
6579 \end_inset
6580
6581
6582 \end_layout
6583
6584 \begin_layout Standard
6585 Once you have written a layout file for a new document class, you might
6586  want to consider writing a
6587 \emph on
6588 template
6589 \emph default
6590  for it, too.
6591  A template acts as a kind of tutorial for your layout, showing how it might
6592  be used, though containing dummy content.
6593  You can of course look at the various templates included with LyX for ideas.
6594 \end_layout
6595
6596 \begin_layout Standard
6597 Templates are created just like usual documents: using LyX.
6598  The only difference is that usual documents contain all possible settings,
6599  including the font scheme and the paper size.
6600  Usually a user doesn't want a template to overwrite his preferred settings
6601  for such parameters.
6602  For that reason, the designer of a template should remove the corresponding
6603  commands like
6604 \begin_inset Flex CharStyle:Code
6605 status collapsed
6606
6607 \begin_layout Plain Layout
6608
6609 \backslash
6610 font_roman
6611 \end_layout
6612
6613 \end_inset
6614
6615  or
6616 \begin_inset Flex CharStyle:Code
6617 status collapsed
6618
6619 \begin_layout Plain Layout
6620
6621 \backslash
6622 papersize
6623 \end_layout
6624
6625 \end_inset
6626
6627  from the template LyX file.
6628  This can be done with any simple text-editor, for example
6629 \begin_inset Flex CharStyle:Code
6630 status collapsed
6631
6632 \begin_layout Plain Layout
6633 vi
6634 \end_layout
6635
6636 \end_inset
6637
6638  or
6639 \begin_inset Flex CharStyle:Code
6640 status collapsed
6641
6642 \begin_layout Plain Layout
6643 notepad
6644 \end_layout
6645
6646 \end_inset
6647
6648 .
6649
6650 \end_layout
6651
6652 \begin_layout Standard
6653 Put the edited template files you create in
6654 \begin_inset Flex CharStyle:Code
6655 status collapsed
6656
6657 \begin_layout Plain Layout
6658 UserDir/templates/
6659 \end_layout
6660
6661 \end_inset
6662
6663 , copy the ones you use from the global template directory in
6664 \begin_inset Flex CharStyle:Code
6665 status collapsed
6666
6667 \begin_layout Plain Layout
6668 LyXDir/templates/
6669 \end_layout
6670
6671 \end_inset
6672
6673  to the same place, and redefine the template path in the
6674 \begin_inset Flex CharStyle:MenuItem
6675 status collapsed
6676
6677 \begin_layout Plain Layout
6678 Tools\SpecialChar \menuseparator
6679 Preferences\SpecialChar \menuseparator
6680 Paths
6681 \end_layout
6682
6683 \end_inset
6684
6685  dialog.
6686 \end_layout
6687
6688 \begin_layout Standard
6689 Note, by the way, that there is a template which has a particular meaning:
6690
6691 \begin_inset Flex CharStyle:Code
6692 status collapsed
6693
6694 \begin_layout Plain Layout
6695 defaults.lyx
6696 \end_layout
6697
6698 \end_inset
6699
6700 .
6701  This template is loaded every time you create a new document with
6702 \begin_inset Flex CharStyle:MenuItem
6703 status collapsed
6704
6705 \begin_layout Plain Layout
6706 File\SpecialChar \menuseparator
6707 New
6708 \end_layout
6709
6710 \end_inset
6711
6712  in order to provide useful defaults.
6713  To create this template from inside LyX, all you have to do is to open
6714  a document with the correct settings, and use the
6715 \begin_inset Flex CharStyle:MenuItem
6716 status collapsed
6717
6718 \begin_layout Plain Layout
6719 Save as Document Defaults
6720 \end_layout
6721
6722 \end_inset
6723
6724  button.
6725 \end_layout
6726
6727 \begin_layout Subsection
6728 Upgrading old layout files
6729 \end_layout
6730
6731 \begin_layout Standard
6732 The format of layout files changes with each LyX release, so old layout
6733  files need to be converted to the new format.
6734  This process has been automated since LyX 1.4: If LyX reads a layout file
6735  in an older format, it automatically calls the script
6736 \begin_inset Flex CharStyle:Code
6737 status collapsed
6738
6739 \begin_layout Plain Layout
6740 layout2layout.py
6741 \end_layout
6742
6743 \end_inset
6744
6745  to convert it to a temporary file in current format.
6746  The original file is left untouched.
6747  If you use the layout file often, then, you may want to convert it permanently,
6748  so that LyX does not have to do so itself every time.
6749  To do this, you can call the converter manually:
6750 \end_layout
6751
6752 \begin_layout LyX-Code
6753 mv myclass.layout myclass.old
6754 \end_layout
6755
6756 \begin_layout LyX-Code
6757 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
6758 \end_layout
6759
6760 \begin_layout Standard
6761 You need to replace
6762 \begin_inset Flex CharStyle:Code
6763 status collapsed
6764
6765 \begin_layout Plain Layout
6766 LyXDir
6767 \end_layout
6768
6769 \end_inset
6770
6771  with the name of your LyX system directory, of course.
6772 \end_layout
6773
6774 \begin_layout Standard
6775 Note that manual conversion does not affect included files, so these will
6776  have to be converted separately.
6777 \end_layout
6778
6779 \begin_layout Section
6780 \begin_inset CommandInset label
6781 LatexCommand label
6782 name "sec:TextClass"
6783
6784 \end_inset
6785
6786 The layout file format
6787 \end_layout
6788
6789 \begin_layout Standard
6790 When it's finally time to get your hands dirty and create or edit your own
6791  layout file, the following sections describe what you're up against.
6792  Our advice is to go slowly, save and test often, listen to soothing music,
6793  and enjoy one or two of your favorite adult beverages; more if you are
6794  getting particularly stuck.
6795  It's really not that hard, except that the multitude of options can become
6796  overwhelming if you try to do too much in one sitting.
6797  Go have another adult beverage, just for good measure.
6798 \end_layout
6799
6800 \begin_layout Standard
6801 Note that all the tags used in layout files are case-insensitive.
6802  This means that
6803 \begin_inset Flex CharStyle:Code
6804 status collapsed
6805
6806 \begin_layout Plain Layout
6807 Style
6808 \end_layout
6809
6810 \end_inset
6811
6812 ,
6813 \begin_inset Flex CharStyle:Code
6814 status collapsed
6815
6816 \begin_layout Plain Layout
6817 style
6818 \end_layout
6819
6820 \end_inset
6821
6822  and
6823 \begin_inset Flex CharStyle:Code
6824 status collapsed
6825
6826 \begin_layout Plain Layout
6827 StYlE
6828 \end_layout
6829
6830 \end_inset
6831
6832  are really the same tag.
6833  The possible values are printed in brackets after the feature's name.
6834  The default value if a feature isn't specified inside a text class-description
6835  is typeset
6836 \begin_inset Flex CharStyle:Code
6837 status collapsed
6838
6839 \begin_layout Plain Layout
6840
6841 \emph on
6842 emphasized
6843 \end_layout
6844
6845 \end_inset
6846
6847 .
6848  If the argument has a data type like
6849 \begin_inset Quotes eld
6850 \end_inset
6851
6852 string
6853 \begin_inset Quotes erd
6854 \end_inset
6855
6856  or
6857 \begin_inset Quotes eld
6858 \end_inset
6859
6860 float
6861 \begin_inset Quotes erd
6862 \end_inset
6863
6864 , the default is shown like this:
6865 \begin_inset Flex CharStyle:Code
6866 status collapsed
6867
6868 \begin_layout Plain Layout
6869 float=
6870 \emph on
6871 default
6872 \end_layout
6873
6874 \end_inset
6875
6876 .
6877 \end_layout
6878
6879 \begin_layout Subsection
6880 The Document Class Declaration
6881 \end_layout
6882
6883 \begin_layout Standard
6884 Lines in a layout file which begin with
6885 \begin_inset Flex CharStyle:Code
6886 status collapsed
6887
6888 \begin_layout Plain Layout
6889 #
6890 \end_layout
6891
6892 \end_inset
6893
6894  are comments.
6895  There is one exception to this rule.
6896  All
6897 \begin_inset Flex CharStyle:Code
6898 status collapsed
6899
6900 \begin_layout Plain Layout
6901 *.layout
6902 \end_layout
6903
6904 \end_inset
6905
6906  files should begin with a line like:
6907 \end_layout
6908
6909 \begin_layout LyX-Code
6910
6911 \size small
6912 #% Do not delete the line below; configure depends on this
6913 \end_layout
6914
6915 \begin_layout LyX-Code
6916
6917 \size small
6918 #
6919 \backslash
6920 DeclareLaTeXClass{article}
6921 \end_layout
6922
6923 \begin_layout Standard
6924 The second line is used when you (re)configure LyX.
6925  The layout file is read by the LaTeX script
6926 \begin_inset Flex CharStyle:Code
6927 status collapsed
6928
6929 \begin_layout Plain Layout
6930 chkconfig.ltx
6931 \end_layout
6932
6933 \end_inset
6934
6935 , in a special mode where
6936 \begin_inset Flex CharStyle:Code
6937 status collapsed
6938
6939 \begin_layout Plain Layout
6940 #
6941 \end_layout
6942
6943 \end_inset
6944
6945  is ignored.
6946  The first line is just a LaTeX comment, and the second one contains the
6947  declaration of the text class.
6948  If these lines appear in a file named
6949 \begin_inset Flex CharStyle:Code
6950 status collapsed
6951
6952 \begin_layout Plain Layout
6953 article.layout
6954 \end_layout
6955
6956 \end_inset
6957
6958 , then they define a text class of name
6959 \begin_inset Flex CharStyle:Code
6960 status collapsed
6961
6962 \begin_layout Plain Layout
6963 article
6964 \end_layout
6965
6966 \end_inset
6967
6968  (the name of the layout file) which uses the LaTeX document class
6969 \begin_inset Flex CharStyle:Code
6970 status collapsed
6971
6972 \begin_layout Plain Layout
6973 article.cls
6974 \end_layout
6975
6976 \end_inset
6977
6978  (the default is to use the same name as the layout).
6979  The string
6980 \begin_inset Quotes eld
6981 \end_inset
6982
6983 article
6984 \begin_inset Quotes erd
6985 \end_inset
6986
6987  that appears above is used as a description of the text class in the
6988 \begin_inset Flex CharStyle:MenuItem
6989 status collapsed
6990
6991 \begin_layout Plain Layout
6992 Document\SpecialChar \menuseparator
6993 Settings
6994 \end_layout
6995
6996 \end_inset
6997
6998  dialog.
6999 \end_layout
7000
7001 \begin_layout Standard
7002 Let's assume that you wrote your own text class that uses the
7003 \begin_inset Flex CharStyle:Code
7004 status collapsed
7005
7006 \begin_layout Plain Layout
7007 article.cls
7008 \end_layout
7009
7010 \end_inset
7011
7012  document class, but where you changed the appearance of the section headings.
7013  If you put it in a file
7014 \begin_inset Flex CharStyle:Code
7015 status collapsed
7016
7017 \begin_layout Plain Layout
7018 myarticle.layout
7019 \end_layout
7020
7021 \end_inset
7022
7023 , the header of this file should be:
7024 \end_layout
7025
7026 \begin_layout LyX-Code
7027
7028 \size small
7029 #% Do not delete the line below; configure depends on this
7030 \end_layout
7031
7032 \begin_layout LyX-Code
7033
7034 \size small
7035 #
7036 \backslash
7037 DeclareLaTeXClass[article]{article (with my own headings)}
7038 \end_layout
7039
7040 \begin_layout Standard
7041 This declares a text class
7042 \begin_inset Flex CharStyle:Code
7043 status collapsed
7044
7045 \begin_layout Plain Layout
7046 myarticle
7047 \end_layout
7048
7049 \end_inset
7050
7051 , associated with the LaTeX document class
7052 \begin_inset Flex CharStyle:Code
7053 status collapsed
7054
7055 \begin_layout Plain Layout
7056 article.cls
7057 \end_layout
7058
7059 \end_inset
7060
7061  and described as
7062 \begin_inset Quotes eld
7063 \end_inset
7064
7065 article (with my own headings)
7066 \begin_inset Quotes erd
7067 \end_inset
7068
7069 .
7070  If your text class depends on several packages, you can declare it as:
7071 \end_layout
7072
7073 \begin_layout LyX-Code
7074
7075 \size small
7076 #% Do not delete the line below; configure depends on this
7077 \end_layout
7078
7079 \begin_layout LyX-Code
7080
7081 \size small
7082 #
7083 \backslash
7084 DeclareLaTeXClass[article,foo.sty]{article (with my own headings)}
7085 \end_layout
7086
7087 \begin_layout Standard
7088 This indicates that your text class uses the
7089 \begin_inset Flex CharStyle:Code
7090 status collapsed
7091
7092 \begin_layout Plain Layout
7093 foo.sty
7094 \end_layout
7095
7096 \end_inset
7097
7098  package.
7099  Finally, it is also possible to declare classes for DocBook code.
7100  Typical declarations will look like:
7101 \end_layout
7102
7103 \begin_layout LyX-Code
7104
7105 \size small
7106 #% Do not delete the line below; configure depends on this
7107 \end_layout
7108
7109 \begin_layout LyX-Code
7110
7111 \size small
7112 #
7113 \backslash
7114 DeclareDocBookClass[article]{SGML (DocBook article)}
7115 \end_layout
7116
7117 \begin_layout Standard
7118 Note that these declarations can also be given an optional parameter declaring
7119  the name of the document class (but not a list).
7120 \end_layout
7121
7122 \begin_layout Standard
7123 So, to be as explicit as possible, the form of the layout declaration is:
7124 \end_layout
7125
7126 \begin_layout LyX-Code
7127
7128 \size small
7129 #
7130 \backslash
7131 DeclareLaTeXClass[class,package.sty]{layout description}
7132 \end_layout
7133
7134 \begin_layout Standard
7135 The class need only be specified if the name of the LaTeX class file and
7136  the name of the layout file are different; if the name of the class file
7137  is not specified, then LyX will simply assume that it is the same as the
7138  name of the layout file.
7139 \end_layout
7140
7141 \begin_layout Standard
7142 When the text class has been modified to your taste, all you have to do
7143  is to copy it either to
7144 \begin_inset Flex CharStyle:Code
7145 status collapsed
7146
7147 \begin_layout Plain Layout
7148 LyXDir/layouts/
7149 \end_layout
7150
7151 \end_inset
7152
7153  or to
7154 \begin_inset Flex CharStyle:Code
7155 status collapsed
7156
7157 \begin_layout Plain Layout
7158 UserDir/layouts
7159 \end_layout
7160
7161 \end_inset
7162
7163 , run
7164 \begin_inset Flex CharStyle:MenuItem
7165 status collapsed
7166
7167 \begin_layout Plain Layout
7168 Tools\SpecialChar \menuseparator
7169 Reconfigure
7170 \end_layout
7171
7172 \end_inset
7173
7174 , exit LyX and restart.
7175  Then your new text class should be available along with the others.
7176 \end_layout
7177
7178 \begin_layout Standard
7179 Once the layout file is installed, you can edit it and see your changes
7180  without having to reconfigure or to restart LyX.
7181
7182 \begin_inset Foot
7183 status collapsed
7184
7185 \begin_layout Plain Layout
7186 In versions of LyX prior to 1.6, this was not true.
7187  As a result, editing layout files was very time consuming, since you had
7188  constantly to restart LyX to see changes.
7189 \end_layout
7190
7191 \end_inset
7192
7193  You can force a reload of the current layout by using the LyX function
7194
7195 \begin_inset Flex CharStyle:MenuItem
7196 status collapsed
7197
7198 \begin_layout Plain Layout
7199 layout-reload
7200 \end_layout
7201
7202 \end_inset
7203
7204 .
7205  There is no default binding for this function—though, of course, you can
7206  bind it to a key yourself.
7207  But you will normally use this function simply by entering it in the mini-buffe
7208 r.
7209
7210 \end_layout
7211
7212 \begin_layout Standard
7213
7214 \emph on
7215 Warning
7216 \emph default
7217 :
7218 \begin_inset Flex CharStyle:MenuItem
7219 status collapsed
7220
7221 \begin_layout Plain Layout
7222 layout-reload
7223 \end_layout
7224
7225 \end_inset
7226
7227  is very much an `advanced feature'.
7228  It is
7229 \emph on
7230 strongly
7231 \emph default
7232  recommended that you save your work before using this function.
7233  In fact, it is
7234 \emph on
7235 strongly
7236 \emph default
7237  recommended that you not attempt to edit layout information while simultaneousl
7238 y working on a document that you care about.
7239  Use a test document.
7240  Syntax errors and the like in your layout file could cause peculiar behavior.
7241  In particular, such errors could cause LyX to regard the current layout
7242  as invalid and to attempt to switch to some other layout.
7243 \begin_inset Foot
7244 status collapsed
7245
7246 \begin_layout Plain Layout
7247 Really bad syntax errors may even caused LyX to exit.
7248  This is because certain sorts of errors may make LyX unable to read
7249 \emph on
7250 any
7251 \emph default
7252  layout information.
7253  Please be careful.
7254 \end_layout
7255
7256 \end_inset
7257
7258  The LyX team strives to keep LyX stable in such situations, but safe is
7259  better than sorry.
7260 \begin_inset Foot
7261 status collapsed
7262
7263 \begin_layout Plain Layout
7264 While we're giving advice: make regular backups.
7265  And be nice to your mother.
7266 \end_layout
7267
7268 \end_inset
7269
7270
7271 \end_layout
7272
7273 \begin_layout Subsection
7274 The Module Declaration
7275 \end_layout
7276
7277 \begin_layout Standard
7278 A module must begin with a line like the following:
7279 \end_layout
7280
7281 \begin_layout LyX-Code
7282 #
7283 \backslash
7284 DeclareLyXModule[endnotes.sty]{Endnotes}
7285 \end_layout
7286
7287 \begin_layout Standard
7288 The mandatory argument, in curly brackets, is the name of the module, as
7289  it should appear in
7290 \begin_inset Flex CharStyle:MenuItem
7291 status collapsed
7292
7293 \begin_layout Plain Layout
7294 Document\SpecialChar \menuseparator
7295 Settings
7296 \end_layout
7297
7298 \end_inset
7299
7300 .
7301  The argument in square brackets is optional: It declares any LaTeX packages
7302  on which the module depends.
7303  Please note that only packages about which LyX knows should be listed in
7304  the square brackets.
7305 \begin_inset Foot
7306 status collapsed
7307
7308 \begin_layout Plain Layout
7309 The list of such packages is documented only in the source code.
7310 \end_layout
7311
7312 \end_inset
7313
7314  LyX will not check for arbitrary packages.
7315  It is also possible to use the form
7316 \begin_inset Flex CharStyle:MenuItem
7317 status collapsed
7318
7319 \begin_layout Plain Layout
7320 from->to
7321 \end_layout
7322
7323 \end_inset
7324
7325  as an optional argument, which declares that the module can only be used
7326  when there exists a conversion chain between the formats `
7327 \begin_inset Flex CharStyle:Code
7328 status collapsed
7329
7330 \begin_layout Plain Layout
7331 from
7332 \end_layout
7333
7334 \end_inset
7335
7336 ' and `
7337 \begin_inset Flex CharStyle:Code
7338 status collapsed
7339
7340 \begin_layout Plain Layout
7341 to
7342 \end_layout
7343
7344 \end_inset
7345
7346 '.
7347 \end_layout
7348
7349 \begin_layout Standard
7350 The module declaration should then be followed by lines like the following:
7351 \end_layout
7352
7353 \begin_layout LyX-Code
7354 #DescriptionBegin
7355 \end_layout
7356
7357 \begin_layout LyX-Code
7358 #Adds an endnote command, in addition to footnotes.
7359
7360 \end_layout
7361
7362 \begin_layout LyX-Code
7363 #You will need to add
7364 \backslash
7365 theendnotes in TeX code where you
7366 \end_layout
7367
7368 \begin_layout LyX-Code
7369 #want the endnotes to appear.
7370
7371 \end_layout
7372
7373 \begin_layout LyX-Code
7374 #DescriptionEnd
7375 \end_layout
7376
7377 \begin_layout LyX-Code
7378 #Requires: somemodule | othermodule
7379 \end_layout
7380
7381 \begin_layout LyX-Code
7382 #Excludes: badmodule
7383 \end_layout
7384
7385 \begin_layout Standard
7386 The description is used in
7387 \begin_inset Flex CharStyle:MenuItem
7388 status collapsed
7389
7390 \begin_layout Plain Layout
7391 Document\SpecialChar \menuseparator
7392 Settings
7393 \end_layout
7394
7395 \end_inset
7396
7397  to provide the user with information about what the module does.
7398  The
7399 \begin_inset Flex CharStyle:Code
7400 status collapsed
7401
7402 \begin_layout Plain Layout
7403 Requires
7404 \end_layout
7405
7406 \end_inset
7407
7408  line is used to identify other modules with which this one must be used;
7409  the
7410 \begin_inset Flex CharStyle:Code
7411 status collapsed
7412
7413 \begin_layout Plain Layout
7414 Excludes
7415 \end_layout
7416
7417 \end_inset
7418
7419  line is used to identify modules with which this one may not be used.
7420  Both are optional, and, as shown, multiple modules should be separated
7421  with the pipe symbol: |.
7422  Note that the required modules are treated disjunctively:
7423 \emph on
7424 at least one
7425 \emph default
7426  of the required modules must be used.
7427  Similarly,
7428 \emph on
7429 no
7430 \emph default
7431  excluded module may be used.
7432  Note that modules are identified here by their
7433 \emph on
7434 filenames
7435 \emph default
7436  without the
7437 \begin_inset Flex CharStyle:Code
7438 status collapsed
7439
7440 \begin_layout Plain Layout
7441 .module
7442 \end_layout
7443
7444 \end_inset
7445
7446  extension.
7447  So
7448 \begin_inset Flex CharStyle:Code
7449 status collapsed
7450
7451 \begin_layout Plain Layout
7452 somemodule
7453 \end_layout
7454
7455 \end_inset
7456
7457  is really
7458 \begin_inset Flex CharStyle:Code
7459 status collapsed
7460
7461 \begin_layout Plain Layout
7462 somemodule.module
7463 \end_layout
7464
7465 \end_inset
7466
7467 .
7468 \end_layout
7469
7470 \begin_layout Subsection
7471 File format
7472 \end_layout
7473
7474 \begin_layout Standard
7475 The first non-comment line of any layout file, included file, or module
7476
7477 \emph on
7478 must
7479 \emph default
7480  contain the file format number:
7481 \end_layout
7482
7483 \begin_layout Description
7484 \begin_inset Flex CharStyle:Code
7485 status collapsed
7486
7487 \begin_layout Plain Layout
7488 Format
7489 \end_layout
7490
7491 \end_inset
7492
7493  [
7494 \begin_inset Flex CharStyle:Code
7495 status collapsed
7496
7497 \begin_layout Plain Layout
7498 int
7499 \end_layout
7500
7501 \end_inset
7502
7503 ] The format of the layout file.
7504 \end_layout
7505
7506 \begin_layout Standard
7507 This tag was introduced with LyX 1.4.0.
7508  Layout files from LyX 1.3.x and earlier don't have an explicit file format
7509  and are considered to be of format 1.
7510  The format for the present version of LyX is format 21.
7511  But each version of LyX is capable of reading earlier versions' layout
7512  files, just as they are capable of reading files produced by earlier versions
7513  of LyX.
7514  There is, however, no provision for converting to earlier formats.
7515  So LyX 1.6.x will not read layout files in format 21 but only files in format
7516  11 or earlier.
7517 \end_layout
7518
7519 \begin_layout Subsection
7520 \begin_inset CommandInset label
7521 LatexCommand label
7522 name "sub:General-text-class"
7523
7524 \end_inset
7525
7526 General text class parameters
7527 \end_layout
7528
7529 \begin_layout Standard
7530 These are general parameters that govern the behavior of an entire document
7531  class.
7532  (This does
7533 \emph on
7534 not
7535 \emph default
7536  mean that they must appear in
7537 \begin_inset Flex CharStyle:Code
7538 status collapsed
7539
7540 \begin_layout Plain Layout
7541 .layout
7542 \end_layout
7543
7544 \end_inset
7545
7546  files rather than in modules.
7547  A module can contain any layout tag.)
7548 \end_layout
7549
7550 \begin_layout Description
7551 \begin_inset Flex CharStyle:Code
7552 status collapsed
7553
7554 \begin_layout Plain Layout
7555 AddToHTMLPreamble
7556 \end_layout
7557
7558 \end_inset
7559
7560  Adds information that will be output in the
7561 \begin_inset Flex CharStyle:Code
7562 status collapsed
7563
7564 \begin_layout Plain Layout
7565 <head>
7566 \end_layout
7567
7568 \end_inset
7569
7570  block when this document class is output to XHTML.
7571  Typically, this would be used to output CSS style information, but it can
7572  be used for anything that can appear in
7573 \begin_inset Flex CharStyle:Code
7574 status collapsed
7575
7576 \begin_layout Plain Layout
7577 <head>
7578 \end_layout
7579
7580 \end_inset
7581
7582 .
7583  Must end with
7584 \begin_inset Quotes eld
7585 \end_inset
7586
7587
7588 \begin_inset Flex CharStyle:Code
7589 status collapsed
7590
7591 \begin_layout Plain Layout
7592 EndPreamble
7593 \end_layout
7594
7595 \end_inset
7596
7597
7598 \begin_inset Quotes erd
7599 \end_inset
7600
7601 .
7602 \end_layout
7603
7604 \begin_layout Description
7605 \begin_inset Flex CharStyle:Code
7606 status collapsed
7607
7608 \begin_layout Plain Layout
7609 AddToPreamble
7610 \end_layout
7611
7612 \end_inset
7613
7614  Adds information to the document preamble.
7615  Must end with
7616 \begin_inset Quotes eld
7617 \end_inset
7618
7619
7620 \begin_inset Flex CharStyle:Code
7621 status collapsed
7622
7623 \begin_layout Plain Layout
7624 EndPreamble
7625 \end_layout
7626
7627 \end_inset
7628
7629
7630 \begin_inset Quotes erd
7631 \end_inset
7632
7633 .
7634 \end_layout
7635
7636 \begin_layout Description
7637 \begin_inset Flex CharStyle:Code
7638 status collapsed
7639
7640 \begin_layout Plain Layout
7641 ClassOptions
7642 \end_layout
7643
7644 \end_inset
7645
7646  Describes various global options supported by the document class.
7647  See Section
7648 \begin_inset space ~
7649 \end_inset
7650
7651
7652 \begin_inset CommandInset ref
7653 LatexCommand ref
7654 reference "sub:ClassOptions"
7655
7656 \end_inset
7657
7658  for a description.
7659  Must end with
7660 \begin_inset Quotes eld
7661 \end_inset
7662
7663
7664 \begin_inset Flex CharStyle:Code
7665 status collapsed
7666
7667 \begin_layout Plain Layout
7668 End
7669 \end_layout
7670
7671 \end_inset
7672
7673
7674 \begin_inset Quotes erd
7675 \end_inset
7676
7677 .
7678 \end_layout
7679
7680 \begin_layout Description
7681 \begin_inset Flex CharStyle:Code
7682 status collapsed
7683
7684 \begin_layout Plain Layout
7685 Columns
7686 \end_layout
7687
7688 \end_inset
7689
7690  [
7691 \begin_inset Flex CharStyle:Code
7692 status collapsed
7693
7694 \begin_layout Plain Layout
7695
7696 \emph on
7697 1
7698 \end_layout
7699
7700 \end_inset
7701
7702 ,
7703 \begin_inset Flex CharStyle:Code
7704 status collapsed
7705
7706 \begin_layout Plain Layout
7707 2
7708 \end_layout
7709
7710 \end_inset
7711
7712 ] Whether the class should
7713 \emph on
7714 default
7715 \emph default
7716  to having one or two columns.
7717  Can be changed in the
7718 \begin_inset Flex CharStyle:MenuItem
7719 status collapsed
7720
7721 \begin_layout Plain Layout
7722 Document\SpecialChar \menuseparator
7723 Settings
7724 \end_layout
7725
7726 \end_inset
7727
7728  dialog.
7729 \end_layout
7730
7731 \begin_layout Description
7732 \begin_inset Flex CharStyle:Code
7733 status collapsed
7734
7735 \begin_layout Plain Layout
7736 Counter
7737 \end_layout
7738
7739 \end_inset
7740
7741  [
7742 \begin_inset Flex CharStyle:Code
7743 status collapsed
7744
7745 \begin_layout Plain Layout
7746 string
7747 \end_layout
7748
7749 \end_inset
7750
7751 ] This sequence defines the properties for a counter.
7752  If the counter does not yet exist, it is created; if it does exist, it
7753  is modified.
7754  Must end with
7755 \begin_inset Quotes eld
7756 \end_inset
7757
7758
7759 \begin_inset Flex CharStyle:Code
7760 status collapsed
7761
7762 \begin_layout Plain Layout
7763 End
7764 \end_layout
7765
7766 \end_inset
7767
7768
7769 \begin_inset Quotes erd
7770 \end_inset
7771
7772 .
7773 \begin_inset Newline newline
7774 \end_inset
7775
7776 See Section
7777 \begin_inset space ~
7778 \end_inset
7779
7780
7781 \begin_inset CommandInset ref
7782 LatexCommand ref
7783 reference "sub:Counters"
7784
7785 \end_inset
7786
7787  for details on counters.
7788 \end_layout
7789
7790 \begin_layout Description
7791 \begin_inset Flex CharStyle:Code
7792 status collapsed
7793
7794 \begin_layout Plain Layout
7795 DefaultFont
7796 \end_layout
7797
7798 \end_inset
7799
7800  Sets the default font used to display the document.
7801  See Section
7802 \begin_inset space ~
7803 \end_inset
7804
7805
7806 \begin_inset CommandInset ref
7807 LatexCommand ref
7808 reference "sub:Font-description"
7809
7810 \end_inset
7811
7812  for how to declare fonts.
7813  Must end with
7814 \begin_inset Quotes eld
7815 \end_inset
7816
7817
7818 \begin_inset Flex CharStyle:Code
7819 status collapsed
7820
7821 \begin_layout Plain Layout
7822 EndFont
7823 \end_layout
7824
7825 \end_inset
7826
7827
7828 \begin_inset Quotes erd
7829 \end_inset
7830
7831 .
7832 \end_layout
7833
7834 \begin_layout Description
7835 \begin_inset Flex CharStyle:Code
7836 status collapsed
7837
7838 \begin_layout Plain Layout
7839 DefaultModule
7840 \end_layout
7841
7842 \end_inset
7843
7844  [
7845 \begin_inset Flex CharStyle:Code
7846 status collapsed
7847
7848 \begin_layout Plain Layout
7849 string]
7850 \end_layout
7851
7852 \end_inset
7853
7854  Specifies a module to be included by default with this document class.
7855  The module should be specified by filename without the
7856 \begin_inset Flex CharStyle:Code
7857 status collapsed
7858
7859 \begin_layout Plain Layout
7860 .module
7861 \end_layout
7862
7863 \end_inset
7864
7865  extension.
7866  The user can still remove the module, but it will be active at the outset.
7867  (This applies only when new files are created, or when this class is chosen
7868  for an existing document.)
7869 \end_layout
7870
7871 \begin_layout Description
7872 \begin_inset Flex CharStyle:Code
7873 status collapsed
7874
7875 \begin_layout Plain Layout
7876 DefaultStyle
7877 \end_layout
7878
7879 \end_inset
7880
7881  [
7882 \begin_inset Flex CharStyle:Code
7883 status collapsed
7884
7885 \begin_layout Plain Layout
7886 string
7887 \end_layout
7888
7889 \end_inset
7890
7891 ] This is the style that will be assigned to new paragraphs, usually
7892 \begin_inset Flex CharStyle:MenuItem
7893 status collapsed
7894
7895 \begin_layout Plain Layout
7896 Standard
7897 \end_layout
7898
7899 \end_inset
7900
7901 .
7902  This will default to the first defined style if not given, but you are
7903  encouraged to use this directive.
7904 \end_layout
7905
7906 \begin_layout Description
7907 \begin_inset Flex CharStyle:Code
7908 status collapsed
7909
7910 \begin_layout Plain Layout
7911 ExcludesModule
7912 \end_layout
7913
7914 \end_inset
7915
7916  [
7917 \begin_inset Flex CharStyle:Code
7918 status collapsed
7919
7920 \begin_layout Plain Layout
7921 string
7922 \end_layout
7923
7924 \end_inset
7925
7926 ] This tag indicates that the module in question—which should be specified
7927  by filename without the
7928 \begin_inset Flex CharStyle:Code
7929 status collapsed
7930
7931 \begin_layout Plain Layout
7932 .module
7933 \end_layout
7934
7935 \end_inset
7936
7937  extension—cannot be used with this document class.
7938  This might be used in a journal-specific layout file to prevent, say, the
7939  use of the
7940 \begin_inset Flex CharStyle:Code
7941 status collapsed
7942
7943 \begin_layout Plain Layout
7944 theorems-sec
7945 \end_layout
7946
7947 \end_inset
7948
7949  module that numbers theorems by section.
7950  This tag may
7951 \emph on
7952 not
7953 \emph default
7954  be used in a module.
7955  Modules have their own way of excluding other modules (see
7956 \begin_inset CommandInset ref
7957 LatexCommand ref
7958 reference "sub:Layout-modules"
7959
7960 \end_inset
7961
7962 ).
7963 \end_layout
7964
7965 \begin_layout Description
7966 \begin_inset Flex CharStyle:Code
7967 status collapsed
7968
7969 \begin_layout Plain Layout
7970 Float
7971 \end_layout
7972
7973 \end_inset
7974
7975  Defines a new float.
7976  See Section
7977 \begin_inset space ~
7978 \end_inset
7979
7980
7981 \begin_inset CommandInset ref
7982 LatexCommand ref
7983 reference "sub:Floats"
7984
7985 \end_inset
7986
7987  for details.
7988  Must end with
7989 \begin_inset Quotes eld
7990 \end_inset
7991
7992
7993 \begin_inset Flex CharStyle:Code
7994 status collapsed
7995
7996 \begin_layout Plain Layout
7997 End
7998 \end_layout
7999
8000 \end_inset
8001
8002
8003 \begin_inset Quotes erd
8004 \end_inset
8005
8006 .
8007 \end_layout
8008
8009 \begin_layout Description
8010 \begin_inset Flex CharStyle:Code
8011 status collapsed
8012
8013 \begin_layout Plain Layout
8014 HTMLPreamble
8015 \end_layout
8016
8017 \end_inset
8018
8019  Sets the information that will be output in the
8020 \begin_inset Flex CharStyle:Code
8021 status collapsed
8022
8023 \begin_layout Plain Layout
8024 <head>
8025 \end_layout
8026
8027 \end_inset
8028
8029  block when this document class is output to XHTML.
8030  Note that this will completely override any prior
8031 \begin_inset Flex CharStyle:Code
8032 status collapsed
8033
8034 \begin_layout Plain Layout
8035 HTMLPreamble
8036 \end_layout
8037
8038 \end_inset
8039
8040  or
8041 \begin_inset Flex CharStyle:Code
8042 status collapsed
8043
8044 \begin_layout Plain Layout
8045 AddToHTMLPreamble
8046 \end_layout
8047
8048 \end_inset
8049
8050  declarations.
8051  (Use
8052 \begin_inset Flex CharStyle:Code
8053 status collapsed
8054
8055 \begin_layout Plain Layout
8056 AddToHTMLPreamble
8057 \end_layout
8058
8059 \end_inset
8060
8061  if you just want to add material to the preamble.) Must end with
8062 \begin_inset Quotes eld
8063 \end_inset
8064
8065
8066 \begin_inset Flex CharStyle:Code
8067 status collapsed
8068
8069 \begin_layout Plain Layout
8070 EndPreamble
8071 \end_layout
8072
8073 \end_inset
8074
8075
8076 \begin_inset Quotes erd
8077 \end_inset
8078
8079 .
8080 \end_layout
8081
8082 \begin_layout Description
8083 \begin_inset Flex CharStyle:Code
8084 status collapsed
8085
8086 \begin_layout Plain Layout
8087 HTMLTOCSection
8088 \end_layout
8089
8090 \end_inset
8091
8092  [
8093 \begin_inset Flex CharStyle:Code
8094 status collapsed
8095
8096 \begin_layout Plain Layout
8097 string
8098 \end_layout
8099
8100 \end_inset
8101
8102 ] The layout to use for the table of contents, bibliography, and so forth,
8103  when the document is output to HTML.
8104  For articles, this should normally be Section; for books, Chapter.
8105  If it is not given, then LyX will attempt to figure out which layout to
8106  use.
8107 \end_layout
8108
8109 \begin_layout Description
8110 \begin_inset Flex CharStyle:Code
8111 status collapsed
8112
8113 \begin_layout Plain Layout
8114 IfCounter
8115 \end_layout
8116
8117 \end_inset
8118
8119  [
8120 \begin_inset Flex CharStyle:Code
8121 status collapsed
8122
8123 \begin_layout Plain Layout
8124 string
8125 \end_layout
8126
8127 \end_inset
8128
8129 ] Modifies the properties of the given counter.
8130  If the counter does not exist, the section is ignored.
8131  Must end with
8132 \begin_inset Quotes eld
8133 \end_inset
8134
8135
8136 \begin_inset Flex CharStyle:Code
8137 status collapsed
8138
8139 \begin_layout Plain Layout
8140 End
8141 \end_layout
8142
8143 \end_inset
8144
8145
8146 \begin_inset Quotes erd
8147 \end_inset
8148
8149 .
8150 \begin_inset Newline newline
8151 \end_inset
8152
8153 See Section
8154 \begin_inset space ~
8155 \end_inset
8156
8157
8158 \begin_inset CommandInset ref
8159 LatexCommand ref
8160 reference "sub:Counters"
8161
8162 \end_inset
8163
8164  for details on counters.
8165 \end_layout
8166
8167 \begin_layout Description
8168 \begin_inset Flex CharStyle:Code
8169 status collapsed
8170
8171 \begin_layout Plain Layout
8172 IfStyle
8173 \end_layout
8174
8175 \end_inset
8176
8177  [
8178 \begin_inset Flex CharStyle:Code
8179 status collapsed
8180
8181 \begin_layout Plain Layout
8182 string
8183 \end_layout
8184
8185 \end_inset
8186
8187 ] Modifies the properties of the given paragraph style.
8188  If the style does not exist, the section is ignored.
8189  Must end with
8190 \begin_inset Quotes eld
8191 \end_inset
8192
8193
8194 \begin_inset Flex CharStyle:Code
8195 status collapsed
8196
8197 \begin_layout Plain Layout
8198 End
8199 \end_layout
8200
8201 \end_inset
8202
8203
8204 \begin_inset Quotes erd
8205 \end_inset
8206
8207 .
8208 \end_layout
8209
8210 \begin_layout Description
8211 \begin_inset Flex CharStyle:Code
8212 status collapsed
8213
8214 \begin_layout Plain Layout
8215 Input
8216 \end_layout
8217
8218 \end_inset
8219
8220  As its name implies, this command allows you to include another layout
8221  definition file within yours to avoid duplicating commands.
8222  Common examples are the standard layout files, for example,
8223 \begin_inset Flex CharStyle:Code
8224 status collapsed
8225
8226 \begin_layout Plain Layout
8227 stdclass.inc
8228 \end_layout
8229
8230 \end_inset
8231
8232 , which contains most of the basic layouts.
8233 \end_layout
8234
8235 \begin_layout Description
8236 \begin_inset Flex CharStyle:Code
8237 status collapsed
8238
8239 \begin_layout Plain Layout
8240 InsetLayout
8241 \end_layout
8242
8243 \end_inset
8244
8245  This section (re-)defines the layout of an inset.
8246  It can be applied to an existing inset or to a new, user-defined inset,
8247  e.g., a new character style.
8248  Must end with
8249 \begin_inset Quotes eld
8250 \end_inset
8251
8252
8253 \begin_inset Flex CharStyle:Code
8254 status collapsed
8255
8256 \begin_layout Plain Layout
8257 End
8258 \end_layout
8259
8260 \end_inset
8261
8262
8263 \begin_inset Quotes erd
8264 \end_inset
8265
8266 .
8267 \begin_inset Newline newline
8268 \end_inset
8269
8270 See Section
8271 \begin_inset space ~
8272 \end_inset
8273
8274
8275 \begin_inset CommandInset ref
8276 LatexCommand ref
8277 reference "sub:Flex-insets-and"
8278
8279 \end_inset
8280
8281  for more information.
8282
8283 \end_layout
8284
8285 \begin_layout Description
8286 \begin_inset Flex CharStyle:Code
8287 status collapsed
8288
8289 \begin_layout Plain Layout
8290 LeftMargin
8291 \end_layout
8292
8293 \end_inset
8294
8295  [
8296 \begin_inset Flex CharStyle:Code
8297 status collapsed
8298
8299 \begin_layout Plain Layout
8300 string
8301 \end_layout
8302
8303 \end_inset
8304
8305 ] A string that indicates the width of the left margin on the screen, for
8306  example,
8307 \begin_inset Quotes eld
8308 \end_inset
8309
8310 MMMMM
8311 \begin_inset Quotes erd
8312 \end_inset
8313
8314 .
8315  (Note that this is not a `length', like
8316 \begin_inset Quotes eld
8317 \end_inset
8318
8319 2ex
8320 \begin_inset Quotes erd
8321 \end_inset
8322
8323 .)
8324 \end_layout
8325
8326 \begin_layout Description
8327 \begin_inset Flex CharStyle:Code
8328 status collapsed
8329
8330 \begin_layout Plain Layout
8331 NoFloat
8332 \end_layout
8333
8334 \end_inset
8335
8336  This command deletes an existing float.
8337  This is particularly useful when you want to suppress a float that has
8338  been defined in an input file.
8339 \end_layout
8340
8341 \begin_layout Description
8342 \begin_inset Flex CharStyle:Code
8343 status collapsed
8344
8345 \begin_layout Plain Layout
8346 NoStyle
8347 \end_layout
8348
8349 \end_inset
8350
8351  This command deletes an existing style.
8352  This is particularly useful when you want to suppress a style that has
8353  be defined in an input file.
8354 \end_layout
8355
8356 \begin_layout Description
8357 \begin_inset Flex CharStyle:Code
8358 status collapsed
8359
8360 \begin_layout Plain Layout
8361 OutputFormat
8362 \end_layout
8363
8364 \end_inset
8365
8366  A string indicating the file format (as defined in the Preferences dialog)
8367  produced by this class.
8368  It is mainly useful when
8369 \begin_inset Flex CharStyle:Code
8370 status collapsed
8371
8372 \begin_layout Plain Layout
8373 OutputType
8374 \end_layout
8375
8376 \end_inset
8377
8378  is `literate' and one wants to define a new type of literate document.
8379  This string is reset to `docbook', `latex', or `literate' when the correspondin
8380 g
8381 \begin_inset Flex CharStyle:Code
8382 status collapsed
8383
8384 \begin_layout Plain Layout
8385 OutputType
8386 \end_layout
8387
8388 \end_inset
8389
8390  parameter is encountered.
8391 \end_layout
8392
8393 \begin_layout Description
8394 \begin_inset Flex CharStyle:Code
8395 status collapsed
8396
8397 \begin_layout Plain Layout
8398 OutputType
8399 \end_layout
8400
8401 \end_inset
8402
8403  A string indicating what sort of output documents using this class will
8404  produce.
8405  At present, the options are: `docbook', `latex', and `literate'.
8406 \end_layout
8407
8408 \begin_layout Description
8409 \begin_inset Flex CharStyle:Code
8410 status collapsed
8411
8412 \begin_layout Plain Layout
8413 PageStyle
8414 \end_layout
8415
8416 \end_inset
8417
8418  [
8419 \emph on
8420
8421 \begin_inset Flex CharStyle:Code
8422 status collapsed
8423
8424 \begin_layout Plain Layout
8425
8426 \emph on
8427 plain
8428 \end_layout
8429
8430 \end_inset
8431
8432
8433 \emph default
8434 ,
8435 \begin_inset Flex CharStyle:Code
8436 status collapsed
8437
8438 \begin_layout Plain Layout
8439 empty
8440 \end_layout
8441
8442 \end_inset
8443
8444 ,
8445 \begin_inset Flex CharStyle:Code
8446 status collapsed
8447
8448 \begin_layout Plain Layout
8449 headings
8450 \end_layout
8451
8452 \end_inset
8453
8454 ] The default pagestyle.
8455  Can be changed in the
8456 \begin_inset Flex CharStyle:MenuItem
8457 status collapsed
8458
8459 \begin_layout Plain Layout
8460 Document\SpecialChar \menuseparator
8461 Settings
8462 \end_layout
8463
8464 \end_inset
8465
8466  dialog.
8467 \end_layout
8468
8469 \begin_layout Description
8470 \begin_inset Flex CharStyle:Code
8471 status collapsed
8472
8473 \begin_layout Plain Layout
8474 Preamble
8475 \end_layout
8476
8477 \end_inset
8478
8479  Sets the preamble for the LaTeX document.
8480  Note that this will completely override any prior
8481 \begin_inset Flex CharStyle:Code
8482 status collapsed
8483
8484 \begin_layout Plain Layout
8485 Preamble
8486 \end_layout
8487
8488 \end_inset
8489
8490  or
8491 \begin_inset Flex CharStyle:Code
8492 status collapsed
8493
8494 \begin_layout Plain Layout
8495 AddToPreamble
8496 \end_layout
8497
8498 \end_inset
8499
8500  declarations.
8501  (Use
8502 \begin_inset Flex CharStyle:Code
8503 status collapsed
8504
8505 \begin_layout Plain Layout
8506 AddToPreamble
8507 \end_layout
8508
8509 \end_inset
8510
8511  if you just want to add material to the preamble.) Must end with
8512 \begin_inset Quotes eld
8513 \end_inset
8514
8515
8516 \begin_inset Flex CharStyle:Code
8517 status collapsed
8518
8519 \begin_layout Plain Layout
8520 EndPreamble
8521 \end_layout
8522
8523 \end_inset
8524
8525
8526 \begin_inset Quotes erd
8527 \end_inset
8528
8529 .
8530 \end_layout
8531
8532 \begin_layout Description
8533 \begin_inset Flex CharStyle:Code
8534 status collapsed
8535
8536 \begin_layout Plain Layout
8537 Provides
8538 \end_layout
8539
8540 \end_inset
8541
8542  [
8543 \begin_inset Flex CharStyle:Code
8544 status collapsed
8545
8546 \begin_layout Plain Layout
8547 string
8548 \end_layout
8549
8550 \end_inset
8551
8552 ] [
8553 \begin_inset Flex CharStyle:Code
8554 status collapsed
8555
8556 \begin_layout Plain Layout
8557
8558 \emph on
8559 0
8560 \end_layout
8561
8562 \end_inset
8563
8564 ,
8565 \begin_inset Flex CharStyle:Code
8566 status collapsed
8567
8568 \begin_layout Plain Layout
8569 1
8570 \end_layout
8571
8572 \end_inset
8573
8574 ] Whether the class already provides the feature
8575 \begin_inset Flex CharStyle:Code
8576 status collapsed
8577
8578 \begin_layout Plain Layout
8579 string
8580 \end_layout
8581
8582 \end_inset
8583
8584 .
8585  A feature is in general the name of a package (
8586 \begin_inset Flex CharStyle:Code
8587 status collapsed
8588
8589 \begin_layout Plain Layout
8590 amsmath
8591 \end_layout
8592
8593 \end_inset
8594
8595 ,
8596 \begin_inset Flex CharStyle:Code
8597 status collapsed
8598
8599 \begin_layout Plain Layout
8600 makeidx
8601 \end_layout
8602
8603 \end_inset
8604
8605 , \SpecialChar \ldots{}
8606 ) or a macro (
8607 \begin_inset Flex CharStyle:Code
8608 status collapsed
8609
8610 \begin_layout Plain Layout
8611 url
8612 \end_layout
8613
8614 \end_inset
8615
8616 ,
8617 \begin_inset Flex CharStyle:Code
8618 status collapsed
8619
8620 \begin_layout Plain Layout
8621 boldsymbol
8622 \end_layout
8623
8624 \end_inset
8625
8626 ,\SpecialChar \ldots{}
8627 ); the complete list of supported features is unfortunately not documented
8628  outside the LyX source code—but see
8629 \begin_inset Flex CharStyle:Code
8630 status collapsed
8631
8632 \begin_layout Plain Layout
8633 LaTeXFeatures.cpp
8634 \end_layout
8635
8636 \end_inset
8637
8638  if you're interested.
8639
8640 \begin_inset Flex CharStyle:MenuItem
8641 status collapsed
8642
8643 \begin_layout Plain Layout
8644 Help\SpecialChar \menuseparator
8645 LaTeX Configuration
8646 \end_layout
8647
8648 \end_inset
8649
8650  also gives an overview of the supported packages.
8651 \end_layout
8652
8653 \begin_layout Description
8654 \begin_inset Flex CharStyle:Code
8655 status collapsed
8656
8657 \begin_layout Plain Layout
8658 ProvidesModule
8659 \end_layout
8660
8661 \end_inset
8662
8663  [
8664 \begin_inset Flex CharStyle:Code
8665 status collapsed
8666
8667 \begin_layout Plain Layout
8668 string
8669 \end_layout
8670
8671 \end_inset
8672
8673 ] Indicates that this layout provides the functionality of the module mentioned,
8674  which should be specified by the filename without the
8675 \begin_inset Flex CharStyle:Code
8676 status collapsed
8677
8678 \begin_layout Plain Layout
8679 .module
8680 \end_layout
8681
8682 \end_inset
8683
8684  extension.
8685  This will typically be used if the layout includes the module directly,
8686  rather than using the
8687 \begin_inset Flex CharStyle:Code
8688 status collapsed
8689
8690 \begin_layout Plain Layout
8691 DefaultModule
8692 \end_layout
8693
8694 \end_inset
8695
8696  tag to indicate that it ought to be used.
8697  It could also be used in a module that provided an alternate implementation
8698  of the same functionality.
8699 \end_layout
8700
8701 \begin_layout Description
8702 \begin_inset Flex CharStyle:Code
8703 status collapsed
8704
8705 \begin_layout Plain Layout
8706 Requires
8707 \end_layout
8708
8709 \end_inset
8710
8711  [
8712 \begin_inset Flex CharStyle:Code
8713 status collapsed
8714
8715 \begin_layout Plain Layout
8716 string
8717 \end_layout
8718
8719 \end_inset
8720
8721 ] Whether the class requires the feature
8722 \begin_inset Flex CharStyle:Code
8723 status collapsed
8724
8725 \begin_layout Plain Layout
8726 string
8727 \end_layout
8728
8729 \end_inset
8730
8731 .
8732  Multiple features must be separated by commas.
8733  Note that you can only request supported features.
8734  (Again, see
8735 \begin_inset Flex CharStyle:Code
8736 status collapsed
8737
8738 \begin_layout Plain Layout
8739 LaTeXFeatures.cpp
8740 \end_layout
8741
8742 \end_inset
8743
8744  for a list of these.)
8745 \end_layout
8746
8747 \begin_layout Description
8748 \begin_inset Flex CharStyle:Code
8749 status collapsed
8750
8751 \begin_layout Plain Layout
8752 RightMargin
8753 \end_layout
8754
8755 \end_inset
8756
8757  A string that indicates the width of the right margin on the screen, for
8758  example,
8759 \begin_inset Quotes eld
8760 \end_inset
8761
8762 MMMMM
8763 \begin_inset Quotes erd
8764 \end_inset
8765
8766 .
8767 \end_layout
8768
8769 \begin_layout Description
8770 \begin_inset Flex CharStyle:Code
8771 status collapsed
8772
8773 \begin_layout Plain Layout
8774 SecNumDepth
8775 \end_layout
8776
8777 \end_inset
8778
8779  Sets which divisions get numbered.
8780  Corresponds to the
8781 \begin_inset Flex CharStyle:Code
8782 status collapsed
8783
8784 \begin_layout Plain Layout
8785 secnumdepth
8786 \end_layout
8787
8788 \end_inset
8789
8790  counter in LaTeX.
8791 \end_layout
8792
8793 \begin_layout Description
8794 \begin_inset Flex CharStyle:Code
8795 status collapsed
8796
8797 \begin_layout Plain Layout
8798 Sides
8799 \end_layout
8800
8801 \end_inset
8802
8803  [
8804 \emph on
8805
8806 \begin_inset Flex CharStyle:Code
8807 status collapsed
8808
8809 \begin_layout Plain Layout
8810
8811 \emph on
8812 1
8813 \end_layout
8814
8815 \end_inset
8816
8817
8818 \emph default
8819 ,
8820 \begin_inset Flex CharStyle:Code
8821 status collapsed
8822
8823 \begin_layout Plain Layout
8824 2
8825 \end_layout
8826
8827 \end_inset
8828
8829 ] Whether the class-default should be printing on one or both sides of the
8830  paper.
8831  Can be changed in the
8832 \begin_inset Flex CharStyle:MenuItem
8833 status collapsed
8834
8835 \begin_layout Plain Layout
8836 Document\SpecialChar \menuseparator
8837 Settings
8838 \end_layout
8839
8840 \end_inset
8841
8842  dialog.
8843 \end_layout
8844
8845 \begin_layout Description
8846 \begin_inset Flex CharStyle:Code
8847 status collapsed
8848
8849 \begin_layout Plain Layout
8850 Style
8851 \end_layout
8852
8853 \end_inset
8854
8855  This sequence defines a paragraph style.
8856  If the style does not yet exist, it is created; if it does exist, its parameter
8857 s are modified.
8858  Must end with
8859 \begin_inset Quotes eld
8860 \end_inset
8861
8862
8863 \begin_inset Flex CharStyle:Code
8864 status collapsed
8865
8866 \begin_layout Plain Layout
8867 End
8868 \end_layout
8869
8870 \end_inset
8871
8872
8873 \begin_inset Quotes erd
8874 \end_inset
8875
8876 .
8877 \begin_inset Newline newline
8878 \end_inset
8879
8880 See Section
8881 \begin_inset space ~
8882 \end_inset
8883
8884
8885 \begin_inset CommandInset ref
8886 LatexCommand ref
8887 reference "sub:Paragraph-Styles"
8888
8889 \end_inset
8890
8891  for details on paragraph styles.
8892 \end_layout
8893
8894 \begin_layout Description
8895 \begin_inset Flex CharStyle:Code
8896 status collapsed
8897
8898 \begin_layout Plain Layout
8899 TitleLatexName
8900 \end_layout
8901
8902 \end_inset
8903
8904  [
8905 \begin_inset Flex CharStyle:Code
8906 status collapsed
8907
8908 \begin_layout Plain Layout
8909 string="maketitle"
8910 \end_layout
8911
8912 \end_inset
8913
8914 ] The name of the command or environment to be used with
8915 \begin_inset Flex CharStyle:Code
8916 status collapsed
8917
8918 \begin_layout Plain Layout
8919 TitleLatexType
8920 \end_layout
8921
8922 \end_inset
8923
8924 .
8925 \end_layout
8926
8927 \begin_layout Description
8928 \begin_inset Flex CharStyle:Code
8929 status collapsed
8930
8931 \begin_layout Plain Layout
8932 TitleLatexType
8933 \end_layout
8934
8935 \end_inset
8936
8937  [
8938 \begin_inset Flex CharStyle:Code
8939 status collapsed
8940
8941 \begin_layout Plain Layout
8942
8943 \emph on
8944 CommandAfter
8945 \end_layout
8946
8947 \end_inset
8948
8949 ,
8950 \begin_inset Flex CharStyle:Code
8951 status collapsed
8952
8953 \begin_layout Plain Layout
8954 Environment
8955 \end_layout
8956
8957 \end_inset
8958
8959 ] Indicates what kind of markup is used to define the title of a document.
8960
8961 \begin_inset Flex CharStyle:Code
8962 status collapsed
8963
8964 \begin_layout Plain Layout
8965 CommandAfter
8966 \end_layout
8967
8968 \end_inset
8969
8970  means that the macro with name
8971 \begin_inset Flex CharStyle:Code
8972 status collapsed
8973
8974 \begin_layout Plain Layout
8975 TitleLatexName
8976 \end_layout
8977
8978 \end_inset
8979
8980  will be inserted after the last layout which has
8981 \begin_inset Quotes eld
8982 \end_inset
8983
8984
8985 \begin_inset Flex CharStyle:Code
8986 status collapsed
8987
8988 \begin_layout Plain Layout
8989 InTitle 1
8990 \end_layout
8991
8992 \end_inset
8993
8994
8995 \begin_inset Quotes erd
8996 \end_inset
8997
8998 .
8999
9000 \begin_inset Flex CharStyle:Code
9001 status collapsed
9002
9003 \begin_layout Plain Layout
9004 Environment
9005 \end_layout
9006
9007 \end_inset
9008
9009  corresponds to the case where the block of paragraphs which have
9010 \begin_inset Quotes eld
9011 \end_inset
9012
9013
9014 \begin_inset Flex CharStyle:Code
9015 status collapsed
9016
9017 \begin_layout Plain Layout
9018 InTitle 1
9019 \end_layout
9020
9021 \end_inset
9022
9023
9024 \begin_inset Quotes erd
9025 \end_inset
9026
9027  should be enclosed into the
9028 \begin_inset Flex CharStyle:Code
9029 status collapsed
9030
9031 \begin_layout Plain Layout
9032 TitleLatexName
9033 \end_layout
9034
9035 \end_inset
9036
9037  environment.
9038 \end_layout
9039
9040 \begin_layout Description
9041 \begin_inset Flex CharStyle:Code
9042 status collapsed
9043
9044 \begin_layout Plain Layout
9045 TocDepth
9046 \end_layout
9047
9048 \end_inset
9049
9050  Sets which divisions are included in the table of contents.
9051  Corresponds to the
9052 \begin_inset Flex CharStyle:Code
9053 status collapsed
9054
9055 \begin_layout Plain Layout
9056 tocdepth
9057 \end_layout
9058
9059 \end_inset
9060
9061  counter in LaTeX.
9062 \end_layout
9063
9064 \begin_layout Subsection
9065 \begin_inset Flex CharStyle:Code
9066 status collapsed
9067
9068 \begin_layout Plain Layout
9069 ClassOptions
9070 \end_layout
9071
9072 \end_inset
9073
9074  section
9075 \begin_inset CommandInset label
9076 LatexCommand label
9077 name "sub:ClassOptions"
9078
9079 \end_inset
9080
9081
9082 \end_layout
9083
9084 \begin_layout Standard
9085 The
9086 \begin_inset Flex CharStyle:Code
9087 status collapsed
9088
9089 \begin_layout Plain Layout
9090 ClassOptions
9091 \end_layout
9092
9093 \end_inset
9094
9095  section can contain the following entries:
9096 \end_layout
9097
9098 \begin_layout Description
9099 \begin_inset Flex CharStyle:Code
9100 status collapsed
9101
9102 \begin_layout Plain Layout
9103 FontSize
9104 \end_layout
9105
9106 \end_inset
9107
9108  [
9109 \begin_inset Flex CharStyle:Code
9110 status collapsed
9111
9112 \begin_layout Plain Layout
9113 string="10|11|12"
9114 \end_layout
9115
9116 \end_inset
9117
9118 ] The list of available font sizes for the document's main font, separated
9119  by
9120 \begin_inset Quotes eld
9121 \end_inset
9122
9123
9124 \begin_inset Flex CharStyle:Code
9125 status collapsed
9126
9127 \begin_layout Plain Layout
9128 |
9129 \end_layout
9130
9131 \end_inset
9132
9133
9134 \begin_inset Quotes erd
9135 \end_inset
9136
9137 .
9138 \end_layout
9139
9140 \begin_layout Description
9141 \begin_inset Flex CharStyle:Code
9142 status collapsed
9143
9144 \begin_layout Plain Layout
9145 Header
9146 \end_layout
9147
9148 \end_inset
9149
9150  Used to set the DTD line with XML-based output classes.
9151  E.
9152 \begin_inset space \thinspace{}
9153 \end_inset
9154
9155 g.: PUBLIC
9156 \begin_inset Quotes eld
9157 \end_inset
9158
9159 -//OASIS//DTD DocBook V4.2//EN
9160 \begin_inset Quotes erd
9161 \end_inset
9162
9163 .
9164 \end_layout
9165
9166 \begin_layout Description
9167 \begin_inset Flex CharStyle:Code
9168 status collapsed
9169
9170 \begin_layout Plain Layout
9171 PageStyle
9172 \end_layout
9173
9174 \end_inset
9175
9176  [
9177 \begin_inset Flex CharStyle:Code
9178 status collapsed
9179
9180 \begin_layout Plain Layout
9181 string="empty|plain|headings|fancy"
9182 \end_layout
9183
9184 \end_inset
9185
9186 ] The list of available page styles, separated by
9187 \begin_inset Quotes eld
9188 \end_inset
9189
9190
9191 \begin_inset Flex CharStyle:Code
9192 status collapsed
9193
9194 \begin_layout Plain Layout
9195 |
9196 \end_layout
9197
9198 \end_inset
9199
9200
9201 \begin_inset Quotes erd
9202 \end_inset
9203
9204 .
9205 \end_layout
9206
9207 \begin_layout Description
9208 \begin_inset Flex CharStyle:Code
9209 status collapsed
9210
9211 \begin_layout Plain Layout
9212 Other
9213 \end_layout
9214
9215 \end_inset
9216
9217  [
9218 \begin_inset Flex CharStyle:Code
9219 status collapsed
9220
9221 \begin_layout Plain Layout
9222 string=""
9223 \end_layout
9224
9225 \end_inset
9226
9227 ] Some document class options, separated by a comma, that will be added
9228  to the optional part of the
9229 \begin_inset Flex CharStyle:Code
9230 status collapsed
9231
9232 \begin_layout Plain Layout
9233
9234 \backslash
9235 documentclass
9236 \end_layout
9237
9238 \end_inset
9239
9240  command.
9241 \end_layout
9242
9243 \begin_layout Standard
9244 The
9245 \begin_inset Flex CharStyle:Code
9246 status collapsed
9247
9248 \begin_layout Plain Layout
9249 ClassOptions
9250 \end_layout
9251
9252 \end_inset
9253
9254  section must end with
9255 \begin_inset Quotes eld
9256 \end_inset
9257
9258
9259 \begin_inset Flex CharStyle:Code
9260 status collapsed
9261
9262 \begin_layout Plain Layout
9263 End
9264 \end_layout
9265
9266 \end_inset
9267
9268
9269 \begin_inset Quotes erd
9270 \end_inset
9271
9272 .
9273 \end_layout
9274
9275 \begin_layout Subsection
9276 Paragraph Styles
9277 \begin_inset CommandInset label
9278 LatexCommand label
9279 name "sub:Paragraph-Styles"
9280
9281 \end_inset
9282
9283
9284 \end_layout
9285
9286 \begin_layout Standard
9287 A paragraph style description looks like this:
9288 \begin_inset Foot
9289 status collapsed
9290
9291 \begin_layout Plain Layout
9292 Note that this will either define a new layout or modify an existing one.
9293 \end_layout
9294
9295 \end_inset
9296
9297
9298 \end_layout
9299
9300 \begin_layout LyX-Code
9301 Style
9302 \family roman
9303 \emph on
9304 name
9305 \end_layout
9306
9307 \begin_layout LyX-Code
9308  ...
9309 \end_layout
9310
9311 \begin_layout LyX-Code
9312 End
9313 \end_layout
9314
9315 \begin_layout Standard
9316 where the following commands are allowed:
9317 \end_layout
9318
9319 \begin_layout Description
9320 \begin_inset Flex CharStyle:Code
9321 status collapsed
9322
9323 \begin_layout Plain Layout
9324 Align
9325 \end_layout
9326
9327 \end_inset
9328
9329  [
9330 \begin_inset Flex CharStyle:Code
9331 status collapsed
9332
9333 \begin_layout Plain Layout
9334
9335 \emph on
9336 block
9337 \emph default
9338 , left, right, center
9339 \end_layout
9340
9341 \end_inset
9342
9343 ] Paragraph alignment.
9344 \end_layout
9345
9346 \begin_layout Description
9347 \begin_inset Flex CharStyle:Code
9348 status collapsed
9349
9350 \begin_layout Plain Layout
9351 AlignPossible
9352 \end_layout
9353
9354 \end_inset
9355
9356  [
9357 \begin_inset Flex CharStyle:Code
9358 status collapsed
9359
9360 \begin_layout Plain Layout
9361
9362 \emph on
9363 block
9364 \emph default
9365 , left, right, center
9366 \end_layout
9367
9368 \end_inset
9369
9370 ] A comma separated list of permitted alignments.
9371  (Some LaTeX styles prohibit certain alignments, since those wouldn't make
9372  sense.
9373  For example a right-aligned or centered enumeration isn't possible.)
9374 \end_layout
9375
9376 \begin_layout Description
9377 \begin_inset Flex CharStyle:Code
9378 status collapsed
9379
9380 \begin_layout Plain Layout
9381 BabelPreamble
9382 \end_layout
9383
9384 \end_inset
9385
9386  Language dependent information to be included in the LaTeX preamble when
9387  this style is used.
9388  Note that this will completely override any prior
9389 \begin_inset Flex CharStyle:Code
9390 status collapsed
9391
9392 \begin_layout Plain Layout
9393 BabelPreamble
9394 \end_layout
9395
9396 \end_inset
9397
9398  declarations.
9399  Must end with
9400 \begin_inset Quotes eld
9401 \end_inset
9402
9403
9404 \begin_inset Flex CharStyle:Code
9405 status collapsed
9406
9407 \begin_layout Plain Layout
9408 EndBabelPreamble
9409 \end_layout
9410
9411 \end_inset
9412
9413
9414 \begin_inset Quotes erd
9415 \end_inset
9416
9417 .
9418  The contents of this tag will occur once in the LaTeX preamble for each
9419  language used by the document.
9420  Each time, the following substitutions are made:
9421 \end_layout
9422
9423 \begin_deeper
9424 \begin_layout Itemize
9425 \begin_inset Flex CharStyle:Code
9426 status collapsed
9427
9428 \begin_layout Plain Layout
9429 $$lang
9430 \end_layout
9431
9432 \end_inset
9433
9434  is replaced by the language name (as used by the babel package).
9435 \end_layout
9436
9437 \begin_layout Itemize
9438 The
9439 \begin_inset Quotes eld
9440 \end_inset
9441
9442 Function
9443 \begin_inset Quotes erd
9444 \end_inset
9445
9446
9447 \begin_inset Flex CharStyle:Code
9448 status collapsed
9449
9450 \begin_layout Plain Layout
9451 _()
9452 \end_layout
9453
9454 \end_inset
9455
9456  replaces its argument by the translation of the argument to the current
9457  language.
9458 \end_layout
9459
9460 \begin_layout Standard
9461 This preamble snippet will only be used if the document contains more than
9462  one language and the babel package is used.
9463 \end_layout
9464
9465 \end_deeper
9466 \begin_layout Description
9467 \begin_inset Flex CharStyle:Code
9468 status collapsed
9469
9470 \begin_layout Plain Layout
9471 BottomSep
9472 \end_layout
9473
9474 \end_inset
9475
9476  [
9477 \begin_inset Flex CharStyle:Code
9478 status collapsed
9479
9480 \begin_layout Plain Layout
9481 float=0
9482 \end_layout
9483
9484 \end_inset
9485
9486 ]
9487 \begin_inset Foot
9488 status collapsed
9489
9490 \begin_layout Plain Layout
9491 Note that a `float' here is a real number, such as: 1.5.
9492 \end_layout
9493
9494 \end_inset
9495
9496  The vertical space with which the last of a chain of paragraphs with this
9497  layout is separated from the following paragraph.
9498  If the next paragraph has another layout, the separations are not simply
9499  added, but the maximum is taken.
9500 \end_layout
9501
9502 \begin_layout Description
9503 \begin_inset Flex CharStyle:Code
9504 status collapsed
9505
9506 \begin_layout Plain Layout
9507 Category
9508 \end_layout
9509
9510 \end_inset
9511
9512
9513 \begin_inset Flex CharStyle:Code
9514 status collapsed
9515
9516 \begin_layout Plain Layout
9517 [string]
9518 \end_layout
9519
9520 \end_inset
9521
9522  The category for this style.
9523  This is used to group related styles in the Layout combobox on the toolbar.
9524  Any string can be used, but you may want to use existing categories with
9525  your own styles.
9526
9527 \end_layout
9528
9529 \begin_layout Description
9530 \begin_inset Flex CharStyle:Code
9531 status collapsed
9532
9533 \begin_layout Plain Layout
9534 CommandDepth
9535 \end_layout
9536
9537 \end_inset
9538
9539  Depth of XML command.
9540  Used only with XML-type formats.
9541 \end_layout
9542
9543 \begin_layout Description
9544 \begin_inset Flex CharStyle:Code
9545 status collapsed
9546
9547 \begin_layout Plain Layout
9548 CopyStyle
9549 \end_layout
9550
9551 \end_inset
9552
9553
9554 \begin_inset CommandInset label
9555 LatexCommand label
9556 name "des:CopyStyle"
9557
9558 \end_inset
9559
9560
9561 \begin_inset Flex CharStyle:Code
9562 status collapsed
9563
9564 \begin_layout Plain Layout
9565 [string]
9566 \end_layout
9567
9568 \end_inset
9569
9570  Copies all the features of an existing style into the current one.
9571
9572 \end_layout
9573
9574 \begin_layout Description
9575 \begin_inset Flex CharStyle:Code
9576 status collapsed
9577
9578 \begin_layout Plain Layout
9579 DependsOn
9580 \end_layout
9581
9582 \end_inset
9583
9584  The name of a style whose preamble should be output
9585 \emph on
9586 before
9587 \emph default
9588  this one.
9589  This allows to ensure some ordering of the preamble snippets when macros
9590  definitions depend on one another.
9591 \begin_inset Foot
9592 status collapsed
9593
9594 \begin_layout Plain Layout
9595 Note that, besides that functionality, there is no way to ensure any ordering
9596  of preambles.
9597  The ordering that you see in a given version of LyX may change without
9598  warning in later versions.
9599 \end_layout
9600
9601 \end_inset
9602
9603
9604 \end_layout
9605
9606 \begin_layout Description
9607 \begin_inset Flex CharStyle:Code
9608 status collapsed
9609
9610 \begin_layout Plain Layout
9611 EndLabeltype
9612 \end_layout
9613
9614 \end_inset
9615
9616  [
9617 \begin_inset Flex CharStyle:Code
9618 status collapsed
9619
9620 \begin_layout Plain Layout
9621
9622 \emph on
9623 No_Label
9624 \emph default
9625 , Box, Filled_Box, Static
9626 \end_layout
9627
9628 \end_inset
9629
9630 ] The type of label that stands at the end of the paragraph (or sequence
9631  of paragraphs if
9632 \begin_inset Flex CharStyle:Code
9633 status collapsed
9634
9635 \begin_layout Plain Layout
9636 LatexType
9637 \end_layout
9638
9639 \end_inset
9640
9641  is
9642 \begin_inset Flex CharStyle:Code
9643 status collapsed
9644
9645 \begin_layout Plain Layout
9646 Environment
9647 \end_layout
9648
9649 \end_inset
9650
9651 ,
9652 \begin_inset Flex CharStyle:Code
9653 status collapsed
9654
9655 \begin_layout Plain Layout
9656 Item_Environment
9657 \end_layout
9658
9659 \end_inset
9660
9661  or
9662 \begin_inset Flex CharStyle:Code
9663 status collapsed
9664
9665 \begin_layout Plain Layout
9666 List_Environment
9667 \end_layout
9668
9669 \end_inset
9670
9671 ).
9672
9673 \begin_inset Flex CharStyle:Code
9674 status collapsed
9675
9676 \begin_layout Plain Layout
9677 No_Label
9678 \end_layout
9679
9680 \end_inset
9681
9682  means
9683 \begin_inset Quotes eld
9684 \end_inset
9685
9686 nothing
9687 \begin_inset Quotes erd
9688 \end_inset
9689
9690 ,
9691 \begin_inset Flex CharStyle:Code
9692 status collapsed
9693
9694 \begin_layout Plain Layout
9695 Box
9696 \end_layout
9697
9698 \end_inset
9699
9700  (resp.
9701 \begin_inset Flex CharStyle:Code
9702 status collapsed
9703
9704 \begin_layout Plain Layout
9705 \begin_inset space ~
9706 \end_inset
9707
9708 Filled_Box
9709 \end_layout
9710
9711 \end_inset
9712
9713 ) is a white (resp.
9714 \begin_inset space ~
9715 \end_inset
9716
9717 black) square suitable for end of proof markers,
9718 \begin_inset Flex CharStyle:Code
9719 status collapsed
9720
9721 \begin_layout Plain Layout
9722 Static
9723 \end_layout
9724
9725 \end_inset
9726
9727  is an explicit text string.
9728 \end_layout
9729
9730 \begin_layout Description
9731 \begin_inset Flex CharStyle:Code
9732 status collapsed
9733
9734 \begin_layout Plain Layout
9735 EndLabelString
9736 \end_layout
9737
9738 \end_inset
9739
9740  [
9741 \begin_inset Flex CharStyle:Code
9742 status collapsed
9743
9744 \begin_layout Plain Layout
9745 string=""
9746 \end_layout
9747
9748 \end_inset
9749
9750 ] The string used for a label with a
9751 \begin_inset Flex CharStyle:Code
9752 status collapsed
9753
9754 \begin_layout Plain Layout
9755 Static
9756 \end_layout
9757
9758 \end_inset
9759
9760
9761 \begin_inset Flex CharStyle:Code
9762 status collapsed
9763
9764 \begin_layout Plain Layout
9765 EndLabelType
9766 \end_layout
9767
9768 \end_inset
9769
9770 .
9771
9772 \end_layout
9773
9774 \begin_layout Description
9775 \begin_inset Flex CharStyle:Code
9776 status collapsed
9777
9778 \begin_layout Plain Layout
9779 Fill_Bottom
9780 \end_layout
9781
9782 \end_inset
9783
9784  [
9785 \begin_inset Flex CharStyle:Code
9786 status collapsed
9787
9788 \begin_layout Plain Layout
9789
9790 \emph on
9791 0
9792 \emph default
9793 ,1
9794 \end_layout
9795
9796 \end_inset
9797
9798 ] Similar to
9799 \begin_inset Flex CharStyle:Code
9800 status collapsed
9801
9802 \begin_layout Plain Layout
9803 Fill_Top
9804 \end_layout
9805
9806 \end_inset
9807
9808 .
9809 \end_layout
9810
9811 \begin_layout Description
9812 \begin_inset Flex CharStyle:Code
9813 status collapsed
9814
9815 \begin_layout Plain Layout
9816 Fill_Top
9817 \end_layout
9818
9819 \end_inset
9820
9821  [
9822 \begin_inset Flex CharStyle:Code
9823 status collapsed
9824
9825 \begin_layout Plain Layout
9826
9827 \emph on
9828 0
9829 \emph default
9830 ,1
9831 \end_layout
9832
9833 \end_inset
9834
9835 ] With this parameter the
9836 \begin_inset Flex CharStyle:MenuItem
9837 status collapsed
9838
9839 \begin_layout Plain Layout
9840 Fill
9841 \end_layout
9842
9843 \end_inset
9844
9845  value of the
9846 \begin_inset Quotes eld
9847 \end_inset
9848
9849 Vertical space above
9850 \begin_inset Quotes erd
9851 \end_inset
9852
9853  list of the
9854 \begin_inset Flex CharStyle:MenuItem
9855 status collapsed
9856
9857 \begin_layout Plain Layout
9858 Edit\SpecialChar \menuseparator
9859 Paragraph
9860 \begin_inset space ~
9861 \end_inset
9862
9863 Settings
9864 \end_layout
9865
9866 \end_inset
9867
9868  dialog can be set when initializing a paragraph with this style.
9869 \begin_inset Foot
9870 status collapsed
9871
9872 \begin_layout Plain Layout
9873
9874 \emph on
9875 Note from Jean-Marc:
9876 \emph default
9877  I'm not sure that this setting has much use, and it should probably be
9878  removed in later versions.
9879 \end_layout
9880
9881 \end_inset
9882
9883
9884 \end_layout
9885
9886 \begin_layout Description
9887 \begin_inset Flex CharStyle:Code
9888 status collapsed
9889
9890 \begin_layout Plain Layout
9891 Font
9892 \end_layout
9893
9894 \end_inset
9895
9896  The font used for both the text body
9897 \emph on
9898 and
9899 \emph default
9900  the label.
9901  See section
9902 \begin_inset space ~
9903 \end_inset
9904
9905
9906 \begin_inset CommandInset ref
9907 LatexCommand ref
9908 reference "sub:Font-description"
9909
9910 \end_inset
9911
9912 .
9913  Note that defining this font automatically defines the
9914 \begin_inset Flex CharStyle:Code
9915 status collapsed
9916
9917 \begin_layout Plain Layout
9918 LabelFont
9919 \end_layout
9920
9921 \end_inset
9922
9923  to the same value.
9924  So you should define this one first if you also want to define
9925 \begin_inset Flex CharStyle:Code
9926 status collapsed
9927
9928 \begin_layout Plain Layout
9929 LabelFont
9930 \end_layout
9931
9932 \end_inset
9933
9934 .
9935 \end_layout
9936
9937 \begin_layout Description
9938 \begin_inset Flex CharStyle:Code
9939 status collapsed
9940
9941 \begin_layout Plain Layout
9942 FreeSpacing
9943 \end_layout
9944
9945 \end_inset
9946
9947
9948 \begin_inset CommandInset label
9949 LatexCommand label
9950 name "des:FreeSpacing"
9951
9952 \end_inset
9953
9954 [
9955 \emph on
9956
9957 \begin_inset Flex CharStyle:Code
9958 status collapsed
9959
9960 \begin_layout Plain Layout
9961
9962 \emph on
9963 0
9964 \end_layout
9965
9966 \end_inset
9967
9968
9969 \emph default
9970 ,
9971 \begin_inset Flex CharStyle:Code
9972 status collapsed
9973
9974 \begin_layout Plain Layout
9975 1
9976 \end_layout
9977
9978 \end_inset
9979
9980 ] Usually LyX doesn't allow you to insert more than one space between words,
9981  since a space is considered as the separation between two words, not a
9982  character or symbol of its own.
9983  This is a very fine thing but sometimes annoying, for example, when typing
9984  program code or plain LaTeX code.
9985  For this reason,
9986 \begin_inset Flex CharStyle:Code
9987 status collapsed
9988
9989 \begin_layout Plain Layout
9990 FreeSpacing
9991 \end_layout
9992
9993 \end_inset
9994
9995  can be enabled.
9996  Note that LyX will create protected blanks for the additional blanks when
9997  in another mode than LaTeX-mode.
9998 \end_layout
9999
10000 \begin_layout Description
10001 \begin_inset Flex CharStyle:Code
10002 status collapsed
10003
10004 \begin_layout Plain Layout
10005 HTML*
10006 \end_layout
10007
10008 \end_inset
10009
10010  These tags are used with XHTML output.
10011  See
10012 \begin_inset CommandInset ref
10013 LatexCommand prettyref
10014 reference "sub:Paragraph-Style-XHTML"
10015
10016 \end_inset
10017
10018 .
10019 \end_layout
10020
10021 \begin_layout Description
10022 \begin_inset Flex CharStyle:Code
10023 status collapsed
10024
10025 \begin_layout Plain Layout
10026 InnerTag
10027 \end_layout
10028
10029 \end_inset
10030
10031  [[FIXME]] (Used only with XML-type formats.)
10032 \end_layout
10033
10034 \begin_layout Description
10035 \begin_inset Flex CharStyle:Code
10036 status collapsed
10037
10038 \begin_layout Plain Layout
10039 InPreamble
10040 \end_layout
10041
10042 \end_inset
10043
10044
10045 \begin_inset Flex CharStyle:Code
10046 status collapsed
10047
10048 \begin_layout Plain Layout
10049 [1, 0]
10050 \end_layout
10051
10052 \end_inset
10053
10054  If 1, marks the layout as to be included in the document preamble rather
10055  than in the document body.
10056  This is useful for document classes that want such information as the title
10057  and author to appear in the preamble.
10058 \end_layout
10059
10060 \begin_layout Description
10061 \begin_inset Flex CharStyle:Code
10062 status collapsed
10063
10064 \begin_layout Plain Layout
10065 InTitle
10066 \end_layout
10067
10068 \end_inset
10069
10070
10071 \begin_inset Flex CharStyle:Code
10072 status collapsed
10073
10074 \begin_layout Plain Layout
10075 [1, 0]
10076 \end_layout
10077
10078 \end_inset
10079
10080  If 1, marks the layout as being part of a title block (see also the
10081 \begin_inset Flex CharStyle:Code
10082 status collapsed
10083
10084 \begin_layout Plain Layout
10085 TitleLatexType
10086 \end_layout
10087
10088 \end_inset
10089
10090  and
10091 \begin_inset Flex CharStyle:Code
10092 status collapsed
10093
10094 \begin_layout Plain Layout
10095 TitleLatexName
10096 \end_layout
10097
10098 \end_inset
10099
10100  global entries).
10101 \end_layout
10102
10103 \begin_layout Description
10104 \begin_inset Flex CharStyle:Code
10105 status collapsed
10106
10107 \begin_layout Plain Layout
10108 ItemSep
10109 \end_layout
10110
10111 \end_inset
10112
10113  [
10114 \begin_inset Flex CharStyle:Code
10115 status collapsed
10116
10117 \begin_layout Plain Layout
10118 float=0
10119 \end_layout
10120
10121 \end_inset
10122
10123 ] This provides extra space between paragraphs that have the same layout.
10124  If you put other layouts into an environment, each is separated with the
10125  environment's
10126 \begin_inset Flex CharStyle:Code
10127 status collapsed
10128
10129 \begin_layout Plain Layout
10130 Parsep
10131 \end_layout
10132
10133 \end_inset
10134
10135 .
10136  But the whole items of the environment are additionally separated with
10137  this
10138 \begin_inset Flex CharStyle:Code
10139 status collapsed
10140
10141 \begin_layout Plain Layout
10142 Itemsep
10143 \end_layout
10144
10145 \end_inset
10146
10147 .
10148  Note that this is a
10149 \emph on
10150  multiplier.
10151 \end_layout
10152
10153 \begin_layout Description
10154 \begin_inset Flex CharStyle:Code
10155 status collapsed
10156
10157 \begin_layout Plain Layout
10158 ItemTag
10159 \end_layout
10160
10161 \end_inset
10162
10163  [[FIXME]] (Used only with XML-type formats.)
10164 \end_layout
10165
10166 \begin_layout Description
10167 \begin_inset Flex CharStyle:Code
10168 status collapsed
10169
10170 \begin_layout Plain Layout
10171 KeepEmpty
10172 \end_layout
10173
10174 \end_inset
10175
10176
10177 \begin_inset CommandInset label
10178 LatexCommand label
10179 name "des:KeepEmpty"
10180
10181 \end_inset
10182
10183 [
10184 \emph on
10185
10186 \begin_inset Flex CharStyle:Code
10187 status collapsed
10188
10189 \begin_layout Plain Layout
10190
10191 \emph on
10192 0
10193 \end_layout
10194
10195 \end_inset
10196
10197
10198 \emph default
10199 ,
10200 \begin_inset Flex CharStyle:Code
10201 status collapsed
10202
10203 \begin_layout Plain Layout
10204 1
10205 \end_layout
10206
10207 \end_inset
10208
10209 ] Usually LyX does not allow you to leave a paragraph empty, since it would
10210  lead to empty LaTeX output.
10211  There are some cases where this could be desirable however: in a letter
10212  template, the required fields can be provided as empty fields, so that
10213  people do not forget them; in some special classes, a layout can be used
10214  as some kind of break, which does not contain actual text.
10215 \end_layout
10216
10217 \begin_layout Description
10218 \begin_inset Flex CharStyle:Code
10219 status collapsed
10220
10221 \begin_layout Plain Layout
10222 LabelBottomsep
10223 \end_layout
10224
10225 \end_inset
10226
10227  [float=0] The vertical space between the label and the text body.
10228  Only used for labels that are above the text body (
10229 \begin_inset Flex CharStyle:Code
10230 status collapsed
10231
10232 \begin_layout Plain Layout
10233 Top_Environment
10234 \end_layout
10235
10236 \end_inset
10237
10238 ,
10239 \begin_inset Flex CharStyle:Code
10240 status collapsed
10241
10242 \begin_layout Plain Layout
10243 Centered_Top_Environment
10244 \end_layout
10245
10246 \end_inset
10247
10248 ).
10249 \end_layout
10250
10251 \begin_layout Description
10252 \begin_inset Flex CharStyle:Code
10253 status collapsed
10254
10255 \begin_layout Plain Layout
10256 LabelCounter
10257 \end_layout
10258
10259 \end_inset
10260
10261  [
10262 \begin_inset Flex CharStyle:Code
10263 status collapsed
10264
10265 \begin_layout Plain Layout
10266 string=""
10267 \end_layout
10268
10269 \end_inset
10270
10271 ]
10272 \begin_inset Newline newline
10273 \end_inset
10274
10275 The name of the counter for automatic numbering.
10276
10277 \begin_inset Newline newline
10278 \end_inset
10279
10280 This
10281 \emph on
10282 must
10283 \emph default
10284  be given if
10285 \begin_inset Flex CharStyle:Code
10286 status collapsed
10287
10288 \begin_layout Plain Layout
10289 LabelType
10290 \end_layout
10291
10292 \end_inset
10293
10294  is
10295 \begin_inset Flex CharStyle:Code
10296 status collapsed
10297
10298 \begin_layout Plain Layout
10299 Counter
10300 \end_layout
10301
10302 \end_inset
10303
10304 .
10305  In that case, the counter will be stepped each time the layout appears.
10306
10307 \begin_inset Newline newline
10308 \end_inset
10309
10310 This
10311 \emph on
10312 may
10313 \emph default
10314  also be given if
10315 \begin_inset Flex CharStyle:Code
10316 status collapsed
10317
10318 \begin_layout Plain Layout
10319 LabelType
10320 \end_layout
10321
10322 \end_inset
10323
10324  is
10325 \begin_inset Flex CharStyle:Code
10326 status collapsed
10327
10328 \begin_layout Plain Layout
10329 Enumerate
10330 \end_layout
10331
10332 \end_inset
10333
10334 , though this case is a bit complicated.
10335  Suppose you declare
10336 \begin_inset Quotes eld
10337 \end_inset
10338
10339
10340 \begin_inset Flex CharStyle:Code
10341 status collapsed
10342
10343 \begin_layout Plain Layout
10344 LabelCounter myenum
10345 \end_layout
10346
10347 \end_inset
10348
10349
10350 \begin_inset Quotes erd
10351 \end_inset
10352
10353 .
10354  Then the actual counters used are
10355 \begin_inset Flex CharStyle:Code
10356 status collapsed
10357
10358 \begin_layout Plain Layout
10359 myenumi
10360 \end_layout
10361
10362 \end_inset
10363
10364 ,
10365 \begin_inset Flex CharStyle:Code
10366 status collapsed
10367
10368 \begin_layout Plain Layout
10369 myenumii
10370 \end_layout
10371
10372 \end_inset
10373
10374 ,
10375 \begin_inset Flex CharStyle:Code
10376 status collapsed
10377
10378 \begin_layout Plain Layout
10379 myenumiii
10380 \end_layout
10381
10382 \end_inset
10383
10384 , and
10385 \begin_inset Flex CharStyle:Code
10386 status collapsed
10387
10388 \begin_layout Plain Layout
10389 myenumiv
10390 \end_layout
10391
10392 \end_inset
10393
10394 , much as in LaTeX.
10395  These counters must all be declared separately.
10396 \begin_inset Newline newline
10397 \end_inset
10398
10399 See Section
10400 \begin_inset CommandInset ref
10401 LatexCommand ref
10402 reference "sub:Counters"
10403
10404 \end_inset
10405
10406  for details on counters.
10407 \end_layout
10408
10409 \begin_layout Description
10410 \begin_inset Flex CharStyle:Code
10411 status collapsed
10412
10413 \begin_layout Plain Layout
10414 LabelFont
10415 \end_layout
10416
10417 \end_inset
10418
10419  The font used for the label.
10420  See section
10421 \begin_inset space ~
10422 \end_inset
10423
10424
10425 \begin_inset CommandInset ref
10426 LatexCommand ref
10427 reference "sub:Font-description"
10428
10429 \end_inset
10430
10431 .
10432 \end_layout
10433
10434 \begin_layout Description
10435 \begin_inset Flex CharStyle:Code
10436 status collapsed
10437
10438 \begin_layout Plain Layout
10439 LabelIndent
10440 \end_layout
10441
10442 \end_inset
10443
10444  Text that indicates how far a label should be indented.
10445 \end_layout
10446
10447 \begin_layout Description
10448 \begin_inset Flex CharStyle:Code
10449 status collapsed
10450
10451 \begin_layout Plain Layout
10452 Labelsep
10453 \end_layout
10454
10455 \end_inset
10456
10457  [
10458 \begin_inset Flex CharStyle:Code
10459 status collapsed
10460
10461 \begin_layout Plain Layout
10462 string=""
10463 \end_layout
10464
10465 \end_inset
10466
10467 ] The horizontal space between the label and the text body.
10468  Only used for labels that are not above the text body.
10469 \end_layout
10470
10471 \begin_layout Description
10472 \begin_inset Flex CharStyle:Code
10473 status collapsed
10474
10475 \begin_layout Plain Layout
10476 LabelString
10477 \end_layout
10478
10479 \end_inset
10480
10481  [
10482 \begin_inset Flex CharStyle:Code
10483 status collapsed
10484
10485 \begin_layout Plain Layout
10486 string=""
10487 \end_layout
10488
10489 \end_inset
10490
10491 ] The string used for a label with a
10492 \begin_inset Flex CharStyle:Code
10493 status collapsed
10494
10495 \begin_layout Plain Layout
10496 Static
10497 \end_layout
10498
10499 \end_inset
10500
10501  labeltype.
10502  When
10503 \begin_inset Flex CharStyle:Code
10504 status collapsed
10505
10506 \begin_layout Plain Layout
10507 LabelCounter
10508 \end_layout
10509
10510 \end_inset
10511
10512  is set, this string can be contain the special formatting commands described
10513  in Section
10514 \begin_inset CommandInset ref
10515 LatexCommand ref
10516 reference "sub:Counters"
10517
10518 \end_inset
10519
10520 .
10521 \begin_inset Foot
10522 status collapsed
10523
10524 \begin_layout Plain Layout
10525 For the sake of backwards compatibility, the string
10526 \begin_inset Flex CharStyle:Code
10527 status collapsed
10528
10529 \begin_layout Plain Layout
10530 @
10531 \emph on
10532 style-name
10533 \emph default
10534 @
10535 \end_layout
10536
10537 \end_inset
10538
10539  will be replaced by the expanded
10540 \begin_inset Flex CharStyle:Code
10541 status collapsed
10542
10543 \begin_layout Plain Layout
10544 LabelString
10545 \end_layout
10546
10547 \end_inset
10548
10549  of style
10550 \begin_inset Flex CharStyle:Code
10551 status collapsed
10552
10553 \begin_layout Plain Layout
10554
10555 \emph on
10556 style-name
10557 \end_layout
10558
10559 \end_inset
10560
10561 .
10562  This feature is now obsolete and should be replaced by the mechanisms of
10563  Section
10564 \begin_inset CommandInset ref
10565 LatexCommand ref
10566 reference "sub:Counters"
10567
10568 \end_inset
10569
10570 .
10571 \end_layout
10572
10573 \end_inset
10574
10575
10576 \end_layout
10577
10578 \begin_layout Description
10579 \begin_inset Flex CharStyle:Code
10580 status collapsed
10581
10582 \begin_layout Plain Layout
10583 LabelStringAppendix
10584 \end_layout
10585
10586 \end_inset
10587
10588  [
10589 \begin_inset Flex CharStyle:Code
10590 status collapsed
10591
10592 \begin_layout Plain Layout
10593 string=""
10594 \end_layout
10595
10596 \end_inset
10597
10598 ] This is used inside the appendix instead of
10599 \begin_inset Flex CharStyle:Code
10600 status collapsed
10601
10602 \begin_layout Plain Layout
10603 LabelString
10604 \end_layout
10605
10606 \end_inset
10607
10608 .
10609  Note that every
10610 \begin_inset Flex CharStyle:Code
10611 status collapsed
10612
10613 \begin_layout Plain Layout
10614 LabelString
10615 \end_layout
10616
10617 \end_inset
10618
10619  statement resets
10620 \begin_inset Flex CharStyle:Code
10621 status collapsed
10622
10623 \begin_layout Plain Layout
10624 LabelStringAppendix
10625 \end_layout
10626
10627 \end_inset
10628
10629  too.
10630 \end_layout
10631
10632 \begin_layout Description
10633 \begin_inset Flex CharStyle:Code
10634 status collapsed
10635
10636 \begin_layout Plain Layout
10637 LabelTag
10638 \end_layout
10639
10640 \end_inset
10641
10642  [FIXME] (Used only with XML-type formats.)
10643 \end_layout
10644
10645 \begin_layout Description
10646 \begin_inset Flex CharStyle:Code
10647 status collapsed
10648
10649 \begin_layout Plain Layout
10650 LabelType
10651 \end_layout
10652
10653 \end_inset
10654
10655  [
10656 \begin_inset Flex CharStyle:Code
10657 status collapsed
10658
10659 \begin_layout Plain Layout
10660
10661 \emph on
10662 No_Label
10663 \emph default
10664 , Manual, Static, Top_Environment, Centered_Top_Environment, Counter, Sensitive,
10665  Enumerate, Itemize, Bibliography
10666 \end_layout
10667
10668 \end_inset
10669
10670 ]
10671 \end_layout
10672
10673 \begin_deeper
10674 \begin_layout Itemize
10675 \begin_inset Flex CharStyle:Code
10676 status collapsed
10677
10678 \begin_layout Plain Layout
10679 Manual
10680 \end_layout
10681
10682 \end_inset
10683
10684  means the label is the very first word (up to the first real blank).
10685  Use protected spaces (like
10686 \begin_inset space ~
10687 \end_inset
10688
10689 that one) if you want more than one word as the label.
10690
10691 \end_layout
10692
10693 \begin_layout Itemize
10694 \begin_inset Flex CharStyle:Code
10695 status collapsed
10696
10697 \begin_layout Plain Layout
10698 Static
10699 \end_layout
10700
10701 \end_inset
10702
10703  means the label is simply whatever
10704 \begin_inset Flex CharStyle:Code
10705 status collapsed
10706
10707 \begin_layout Plain Layout
10708 LabelString
10709 \end_layout
10710
10711 \end_inset
10712
10713  declares it to be.
10714  Note that this really is `static'.
10715 \end_layout
10716
10717 \begin_layout Itemize
10718 \begin_inset Flex CharStyle:Code
10719 status collapsed
10720
10721 \begin_layout Plain Layout
10722 Top_Environment
10723 \end_layout
10724
10725 \end_inset
10726
10727  and
10728 \begin_inset Flex CharStyle:Code
10729 status collapsed
10730
10731 \begin_layout Plain Layout
10732 Centered_Top_Environment
10733 \end_layout
10734
10735 \end_inset
10736
10737  are special cases of
10738 \begin_inset Flex CharStyle:Code
10739 status collapsed
10740
10741 \begin_layout Plain Layout
10742 Static
10743 \end_layout
10744
10745 \end_inset
10746
10747 .
10748  The label will be printed above the paragraph, but only at the top of an
10749  environment or the top of a chain of paragraphs with this layout.
10750  This might be used with the
10751 \begin_inset Flex CharStyle:MenuItem
10752 status collapsed
10753
10754 \begin_layout Plain Layout
10755 Abstract
10756 \end_layout
10757
10758 \end_inset
10759
10760  layout, for example.
10761 \end_layout
10762
10763 \begin_layout Itemize
10764 \begin_inset Flex CharStyle:Code
10765 status collapsed
10766
10767 \begin_layout Plain Layout
10768 Sensitive
10769 \end_layout
10770
10771 \end_inset
10772
10773  is a special case for the caption-labels
10774 \begin_inset Quotes eld
10775 \end_inset
10776
10777 Figure
10778 \begin_inset Quotes erd
10779 \end_inset
10780
10781  and
10782 \begin_inset Quotes eld
10783 \end_inset
10784
10785 Table
10786 \begin_inset Quotes erd
10787 \end_inset
10788
10789 .
10790
10791 \begin_inset Flex CharStyle:Code
10792 status collapsed
10793
10794 \begin_layout Plain Layout
10795 Sensitive
10796 \end_layout
10797
10798 \end_inset
10799
10800  means the (hardcoded) label string depends on the kind of float: It is
10801  hardcoded to be `FloatType N', where N is the value of the counter associated
10802  with the float.
10803 \end_layout
10804
10805 \begin_layout Itemize
10806 The
10807 \begin_inset Flex CharStyle:Code
10808 status collapsed
10809
10810 \begin_layout Plain Layout
10811 Counter
10812 \end_layout
10813
10814 \end_inset
10815
10816  label type defines automatically numbered labels.
10817  The
10818 \begin_inset Flex CharStyle:Code
10819 status collapsed
10820
10821 \begin_layout Plain Layout
10822 LabelString
10823 \end_layout
10824
10825 \end_inset
10826
10827  will be expanded to resolve any counter references it contains: For example,
10828  it might be
10829 \begin_inset Quotes eld
10830 \end_inset
10831
10832
10833 \begin_inset Flex CharStyle:Code
10834 status collapsed
10835
10836 \begin_layout Plain Layout
10837 Section
10838 \backslash
10839 thechapter.
10840 \backslash
10841 thesection
10842 \end_layout
10843
10844 \end_inset
10845
10846
10847 \begin_inset Quotes erd
10848 \end_inset
10849
10850 .
10851  See Section
10852 \begin_inset CommandInset ref
10853 LatexCommand ref
10854 reference "sub:Counters"
10855
10856 \end_inset
10857
10858  for more information on counters.
10859 \end_layout
10860
10861 \begin_layout Itemize
10862 \begin_inset Flex CharStyle:Code
10863 status collapsed
10864
10865 \begin_layout Plain Layout
10866 Enumerate
10867 \end_layout
10868
10869 \end_inset
10870
10871  produces the usual sort of enumeration labels.
10872  At present, it is hardcoded to use Arabic numerals, lowercase letters,
10873  small Roman numerals, and uppercase letters for the four possible depths.
10874 \end_layout
10875
10876 \begin_layout Itemize
10877 \begin_inset Flex CharStyle:Code
10878 status collapsed
10879
10880 \begin_layout Plain Layout
10881 Itemize
10882 \end_layout
10883
10884 \end_inset
10885
10886  produces various bullets at the different levels.
10887  It is also hardcoded.
10888 \end_layout
10889
10890 \begin_layout Itemize
10891 \begin_inset Flex CharStyle:Code
10892 status collapsed
10893
10894 \begin_layout Plain Layout
10895 Bibliography
10896 \end_layout
10897
10898 \end_inset
10899
10900  is used internally by LyX and should be used only with
10901 \begin_inset Flex CharStyle:Code
10902 status collapsed
10903
10904 \begin_layout Plain Layout
10905 LatexType BibEnvironment
10906 \end_layout
10907
10908 \end_inset
10909
10910 .
10911 \end_layout
10912
10913 \end_deeper
10914 \begin_layout Description
10915 \begin_inset Flex CharStyle:Code
10916 status collapsed
10917
10918 \begin_layout Plain Layout
10919 LangPreamble
10920 \end_layout
10921
10922 \end_inset
10923
10924  Like
10925 \begin_inset Flex CharStyle:Code
10926 status collapsed
10927
10928 \begin_layout Plain Layout
10929 BabelPreamble
10930 \end_layout
10931
10932 \end_inset
10933
10934 , but this preamble snippet occurs independently from the babel package,
10935  and only for the document language.
10936  Must end with
10937 \begin_inset Quotes eld
10938 \end_inset
10939
10940
10941 \begin_inset Flex CharStyle:Code
10942 status collapsed
10943
10944 \begin_layout Plain Layout
10945 EndLangPreamble
10946 \end_layout
10947
10948 \end_inset
10949
10950
10951 \begin_inset Quotes erd
10952 \end_inset
10953
10954 .
10955 \end_layout
10956
10957 \begin_deeper
10958 \begin_layout Standard
10959 If the style defines text that appears in the typeset document, it may use
10960
10961 \begin_inset Flex CharStyle:Code
10962 status collapsed
10963
10964 \begin_layout Plain Layout
10965 LangPreamble
10966 \end_layout
10967
10968 \end_inset
10969
10970  and
10971 \begin_inset Flex CharStyle:Code
10972 status collapsed
10973
10974 \begin_layout Plain Layout
10975 BabelPreamble
10976 \end_layout
10977
10978 \end_inset
10979
10980  to support non-english and even multilanguage documents correctly.
10981  The following excerpt (from the
10982 \begin_inset Flex CharStyle:Code
10983 status collapsed
10984
10985 \begin_layout Plain Layout
10986 theorems-ams.inc
10987 \end_layout
10988
10989 \end_inset
10990
10991  file) shows how this works:
10992 \end_layout
10993
10994 \begin_layout LyX-Code
10995 Preamble
10996 \end_layout
10997
10998 \begin_layout LyX-Code
10999
11000 \backslash
11001 theoremstyle{remark}
11002 \end_layout
11003
11004 \begin_layout LyX-Code
11005
11006 \backslash
11007 newtheorem{claim}[thm]{
11008 \backslash
11009 protect
11010 \backslash
11011 claimname}
11012 \end_layout
11013
11014 \begin_layout LyX-Code
11015 EndPreamble
11016 \end_layout
11017
11018 \begin_layout LyX-Code
11019 LangPreamble
11020 \end_layout
11021
11022 \begin_layout LyX-Code
11023
11024 \backslash
11025 providecommand{
11026 \backslash
11027 claimname}{_(Claim)}
11028 \end_layout
11029
11030 \begin_layout LyX-Code
11031
11032 \end_layout
11033
11034 \begin_layout LyX-Code
11035 EndLangPreamble
11036 \end_layout
11037
11038 \begin_layout LyX-Code
11039 BabelPreamble
11040 \end_layout
11041
11042 \begin_layout LyX-Code
11043
11044 \backslash
11045 addto
11046 \backslash
11047 captions$$lang{
11048 \backslash
11049 renewcommand{
11050 \backslash
11051 claimname}{_(Claim)}}
11052 \end_layout
11053
11054 \begin_layout LyX-Code
11055 EndBabelPreamble
11056 \end_layout
11057
11058 \begin_layout Standard
11059 The key to correct translation of the user visible text is the definition
11060  of the command
11061 \begin_inset Flex CharStyle:Code
11062 status collapsed
11063
11064 \begin_layout Plain Layout
11065
11066 \backslash
11067 claimname
11068 \end_layout
11069
11070 \end_inset
11071
11072  in the language preamble.
11073  This command holds the name of the theorem that will appear in the output.
11074  The
11075 \begin_inset Flex CharStyle:Code
11076 status collapsed
11077
11078 \begin_layout Plain Layout
11079 BabelPreamble
11080 \end_layout
11081
11082 \end_inset
11083
11084  then uses the commands offered by the babel package to redefine
11085 \begin_inset Flex CharStyle:Code
11086 status collapsed
11087
11088 \begin_layout Plain Layout
11089
11090 \backslash
11091 claimname
11092 \end_layout
11093
11094 \end_inset
11095
11096  for each used language in multilanguage documents.
11097 \end_layout
11098
11099 \end_deeper
11100 \begin_layout Description
11101 \begin_inset Flex CharStyle:Code
11102 status collapsed
11103
11104 \begin_layout Plain Layout
11105 LatexName
11106 \end_layout
11107
11108 \end_inset
11109
11110  The name of the corresponding LaTeX stuff.
11111  Either the environment or command name.
11112 \end_layout
11113
11114 \begin_layout Description
11115 \begin_inset Flex CharStyle:Code
11116 status collapsed
11117
11118 \begin_layout Plain Layout
11119 LatexParam
11120 \end_layout
11121
11122 \end_inset
11123
11124  An optional parameter for the corresponding
11125 \begin_inset Flex CharStyle:Code
11126 status collapsed
11127
11128 \begin_layout Plain Layout
11129 LatexName
11130 \end_layout
11131
11132 \end_inset
11133
11134  stuff.
11135  This parameter cannot be changed from within LyX.
11136 \end_layout
11137
11138 \begin_layout Description
11139 \begin_inset Flex CharStyle:Code
11140 status collapsed
11141
11142 \begin_layout Plain Layout
11143 LatexType
11144 \end_layout
11145
11146 \end_inset
11147
11148
11149 \begin_inset CommandInset label
11150 LatexCommand label
11151 name "des:LatexType"
11152
11153 \end_inset
11154
11155 [
11156 \begin_inset Flex CharStyle:Code
11157 status collapsed
11158
11159 \begin_layout Plain Layout
11160
11161 \emph on
11162 Paragraph
11163 \emph default
11164 , Command, Environment, Item_Environment,
11165 \end_layout
11166
11167 \end_inset
11168
11169
11170 \begin_inset Flex CharStyle:Code
11171 status collapsed
11172
11173 \begin_layout Plain Layout
11174 List_Environment, Bib_Environment
11175 \end_layout
11176
11177 \end_inset
11178
11179 ] How the layout should be translated into LaTeX.
11180 \begin_inset Foot
11181 status collapsed
11182
11183 \begin_layout Plain Layout
11184 \begin_inset Flex CharStyle:Code
11185 status collapsed
11186
11187 \begin_layout Plain Layout
11188 LatexType
11189 \end_layout
11190
11191 \end_inset
11192
11193  is perhaps a bit misleading, since these rules apply to SGML classes, too.
11194  Visit the SGML class files for specific examples.
11195 \end_layout
11196
11197 \end_inset
11198
11199
11200 \end_layout
11201
11202 \begin_deeper
11203 \begin_layout Itemize
11204 \begin_inset Flex CharStyle:Code
11205 status collapsed
11206
11207 \begin_layout Plain Layout
11208 Paragraph
11209 \end_layout
11210
11211 \end_inset
11212
11213  means nothing special.
11214
11215 \end_layout
11216
11217 \begin_layout Itemize
11218 \begin_inset Flex CharStyle:Code
11219 status collapsed
11220
11221 \begin_layout Plain Layout
11222 Command
11223 \end_layout
11224
11225 \end_inset
11226
11227  means
11228 \begin_inset Flex CharStyle:Code
11229 status collapsed
11230
11231 \begin_layout Plain Layout
11232
11233 \backslash
11234
11235 \emph on
11236 LatexName
11237 \emph default
11238 {\SpecialChar \ldots{}
11239 }
11240 \end_layout
11241
11242 \end_inset
11243
11244 .
11245 \end_layout
11246
11247 \begin_layout Itemize
11248 \begin_inset Flex CharStyle:Code
11249 status collapsed
11250
11251 \begin_layout Plain Layout
11252 Environment
11253 \end_layout
11254
11255 \end_inset
11256
11257  means
11258 \begin_inset Flex CharStyle:Code
11259 status collapsed
11260
11261 \begin_layout Plain Layout
11262
11263 \backslash
11264 begin{
11265 \emph on
11266 LatexName
11267 \emph default
11268 }\SpecialChar \ldots{}
11269
11270 \backslash
11271 end{
11272 \emph on
11273 LatexName
11274 \emph default
11275 }
11276 \end_layout
11277
11278 \end_inset
11279
11280 .
11281
11282 \end_layout
11283
11284 \begin_layout Itemize
11285 \begin_inset Flex CharStyle:Code
11286 status collapsed
11287
11288 \begin_layout Plain Layout
11289 Item_Environment
11290 \end_layout
11291
11292 \end_inset
11293
11294  is the same as
11295 \begin_inset Flex CharStyle:Code
11296 status collapsed
11297
11298 \begin_layout Plain Layout
11299 Environment
11300 \end_layout
11301
11302 \end_inset
11303
11304 , except that an
11305 \begin_inset Flex CharStyle:Code
11306 status collapsed
11307
11308 \begin_layout Plain Layout
11309
11310 \backslash
11311 item
11312 \end_layout
11313
11314 \end_inset
11315
11316  is generated for each paragraph of this environment.
11317
11318 \end_layout
11319
11320 \begin_layout Itemize
11321 \begin_inset Flex CharStyle:Code
11322 status collapsed
11323
11324 \begin_layout Plain Layout
11325 List_Environment
11326 \end_layout
11327
11328 \end_inset
11329
11330  is the same as
11331 \begin_inset Flex CharStyle:Code
11332 status collapsed
11333
11334 \begin_layout Plain Layout
11335 Item_Environment
11336 \end_layout
11337
11338 \end_inset
11339
11340 , except that
11341 \begin_inset Flex CharStyle:Code
11342 status collapsed
11343
11344 \begin_layout Plain Layout
11345 LabelWidthString
11346 \end_layout
11347
11348 \end_inset
11349
11350  is passed as an argument to the environment.
11351
11352 \begin_inset Flex CharStyle:Code
11353 status collapsed
11354
11355 \begin_layout Plain Layout
11356 LabelWidthString
11357 \end_layout
11358
11359 \end_inset
11360
11361  can be defined in the
11362 \begin_inset Flex CharStyle:MenuItem
11363 status collapsed
11364
11365 \begin_layout Plain Layout
11366
11367 \bar under
11368 L
11369 \bar default
11370 ayout\SpecialChar \menuseparator
11371
11372 \bar under
11373 P
11374 \bar default
11375 aragraph
11376 \end_layout
11377
11378 \end_inset
11379
11380  dialog.
11381
11382 \end_layout
11383
11384 \begin_layout Standard
11385 Putting the last few things together, the LaTeX output will be either:
11386 \end_layout
11387
11388 \begin_layout LyX-Code
11389
11390 \backslash
11391 latexname[latexparam]{\SpecialChar \ldots{}
11392 }
11393 \end_layout
11394
11395 \begin_layout Standard
11396 or:
11397 \end_layout
11398
11399 \begin_layout LyX-Code
11400
11401 \backslash
11402 begin{latexname}[latexparam] \SpecialChar \ldots{}
11403
11404 \backslash
11405 end{latexname}.
11406 \end_layout
11407
11408 \begin_layout Standard
11409 depending upon the LaTeX type.
11410 \end_layout
11411
11412 \end_deeper
11413 \begin_layout Description
11414 \begin_inset Flex CharStyle:Code
11415 status collapsed
11416
11417 \begin_layout Plain Layout
11418 LeftMargin
11419 \end_layout
11420
11421 \end_inset
11422
11423  [
11424 \begin_inset Flex CharStyle:Code
11425 status collapsed
11426
11427 \begin_layout Plain Layout
11428 string=""
11429 \end_layout
11430
11431 \end_inset
11432
11433 ] If you put layouts into environments, the leftmargins are not simply added,
11434  but added with a factor
11435 \begin_inset Formula $\frac{4}{depth+4}$
11436 \end_inset
11437
11438 .
11439  Note that this parameter is also used when the margin is defined as
11440 \begin_inset Flex CharStyle:Code
11441 status collapsed
11442
11443 \begin_layout Plain Layout
11444 Manual
11445 \end_layout
11446
11447 \end_inset
11448
11449  or
11450 \begin_inset Flex CharStyle:Code
11451 status collapsed
11452
11453 \begin_layout Plain Layout
11454 Dynamic
11455 \end_layout
11456
11457 \end_inset
11458
11459 .
11460  Then it is added to the manual or dynamic margin.
11461
11462 \begin_inset Newline newline
11463 \end_inset
11464
11465 The argument is passed as a string.
11466  For example
11467 \begin_inset Quotes eld
11468 \end_inset
11469
11470
11471 \begin_inset Flex CharStyle:Code
11472 status collapsed
11473
11474 \begin_layout Plain Layout
11475 MM
11476 \end_layout
11477
11478 \end_inset
11479
11480
11481 \begin_inset Quotes erd
11482 \end_inset
11483
11484  means that the paragraph is indented with the width of
11485 \begin_inset Quotes eld
11486 \end_inset
11487
11488
11489 \begin_inset Flex CharStyle:Code
11490 status collapsed
11491
11492 \begin_layout Plain Layout
11493 MM
11494 \end_layout
11495
11496 \end_inset
11497
11498
11499 \begin_inset Quotes erd
11500 \end_inset
11501
11502  in the normal font.
11503  You can get a negative width by prefixing the string with
11504 \begin_inset Quotes eld
11505 \end_inset
11506
11507
11508 \begin_inset Flex CharStyle:Code
11509 status collapsed
11510
11511 \begin_layout Plain Layout
11512 -
11513 \end_layout
11514
11515 \end_inset
11516
11517
11518 \begin_inset Quotes erd
11519 \end_inset
11520
11521 .
11522  This way was chosen so that the look is the same with each used screen
11523  font.
11524
11525 \end_layout
11526
11527 \begin_layout Description
11528 \begin_inset Flex CharStyle:Code
11529 status collapsed
11530
11531 \begin_layout Plain Layout
11532 Margin
11533 \end_layout
11534
11535 \end_inset
11536
11537  [
11538 \begin_inset Flex CharStyle:Code
11539 status collapsed
11540
11541 \begin_layout Plain Layout
11542
11543 \emph on
11544 Static
11545 \emph default
11546 , Manual, Dynamic, First_Dynamic, Right_Address_Box
11547 \end_layout
11548
11549 \end_inset
11550
11551 ]
11552 \begin_inset Newline newline
11553 \end_inset
11554
11555 The kind of margin that the layout has on the left side.
11556
11557 \begin_inset Flex CharStyle:Code
11558 status collapsed
11559
11560 \begin_layout Plain Layout
11561 Static
11562 \end_layout
11563
11564 \end_inset
11565
11566  just means a fixed margin.
11567
11568 \begin_inset Flex CharStyle:Code
11569 status collapsed
11570
11571 \begin_layout Plain Layout
11572 Manual
11573 \end_layout
11574
11575 \end_inset
11576
11577  means that the left margin depends on the string entered in the
11578 \begin_inset Flex CharStyle:MenuItem
11579 status collapsed
11580
11581 \begin_layout Plain Layout
11582 Edit\SpecialChar \menuseparator
11583 Paragraph
11584 \begin_inset space ~
11585 \end_inset
11586
11587 Settings
11588 \end_layout
11589
11590 \end_inset
11591
11592  dialog.
11593  This is used to typeset nice lists without tabulators.
11594
11595 \begin_inset Flex CharStyle:Code
11596 status collapsed
11597
11598 \begin_layout Plain Layout
11599 Dynamic
11600 \end_layout
11601
11602 \end_inset
11603
11604  means that the margin depends on the size of the label.
11605  This is used for automatic enumerated headlines.
11606  It is obvious that the headline
11607 \begin_inset Quotes eld
11608 \end_inset
11609
11610 5.4.3.2.1 Very long headline
11611 \begin_inset Quotes erd
11612 \end_inset
11613
11614  must have a wider left margin (as wide as
11615 \begin_inset Quotes eld
11616 \end_inset
11617
11618 5.4.3.2.1
11619 \begin_inset Quotes erd
11620 \end_inset
11621
11622  plus the space) than
11623 \begin_inset Quotes eld
11624 \end_inset
11625
11626 3.2 Very long headline
11627 \begin_inset Quotes erd
11628 \end_inset
11629
11630 , even if standard
11631 \begin_inset Quotes eld
11632 \end_inset
11633
11634 word processors
11635 \begin_inset Quotes erd
11636 \end_inset
11637
11638  are not able to do this.
11639
11640 \begin_inset Flex CharStyle:Code
11641 status collapsed
11642
11643 \begin_layout Plain Layout
11644 First_Dynamic
11645 \end_layout
11646
11647 \end_inset
11648
11649  is similar, but only the very first row of the paragraph is dynamic, while
11650  the others are static; this is used, for example, for descriptions.
11651
11652 \begin_inset Flex CharStyle:Code
11653 status collapsed
11654
11655 \begin_layout Plain Layout
11656 Right_Address_Box
11657 \end_layout
11658
11659 \end_inset
11660
11661  means the margin is chosen in a way that the longest row of this paragraph
11662  fits to the right margin.
11663  This is used to typeset an address on the right edge of the page.
11664 \end_layout
11665
11666 \begin_layout Description
11667 \begin_inset Flex CharStyle:Code
11668 status collapsed
11669
11670 \begin_layout Plain Layout
11671 NeedProtect
11672 \end_layout
11673
11674 \end_inset
11675
11676  [
11677 \begin_inset Flex CharStyle:Code
11678 status collapsed
11679
11680 \begin_layout Plain Layout
11681
11682 \emph on
11683 0
11684 \end_layout
11685
11686 \end_inset
11687
11688 ,
11689 \begin_inset Flex CharStyle:Code
11690 status collapsed
11691
11692 \begin_layout Plain Layout
11693 1
11694 \end_layout
11695
11696 \end_inset
11697
11698 ] Whether fragile commands in this layout should be
11699 \begin_inset Flex CharStyle:Code
11700 status collapsed
11701
11702 \begin_layout Plain Layout
11703
11704 \backslash
11705 protect
11706 \end_layout
11707
11708 \end_inset
11709
11710 'ed.
11711  (Note: This is
11712 \emph on
11713 not
11714 \emph default
11715  whether this command should itself be protected.)
11716 \end_layout
11717
11718 \begin_layout Description
11719 \begin_inset Flex CharStyle:Code
11720 status collapsed
11721
11722 \begin_layout Plain Layout
11723 Newline
11724 \end_layout
11725
11726 \end_inset
11727
11728  [
11729 \begin_inset Flex CharStyle:Code
11730 status collapsed
11731
11732 \begin_layout Plain Layout
11733 0
11734 \end_layout
11735
11736 \end_inset
11737
11738 ,
11739 \begin_inset Flex CharStyle:Code
11740 status collapsed
11741
11742 \begin_layout Plain Layout
11743
11744 \emph on
11745 1
11746 \end_layout
11747
11748 \end_inset
11749
11750 ] Whether newlines are translated into LaTeX newlines (
11751 \begin_inset Flex CharStyle:Code
11752 status collapsed
11753
11754 \begin_layout Plain Layout
11755
11756 \backslash
11757
11758 \backslash
11759
11760 \end_layout
11761
11762 \end_inset
11763
11764 ) or not.
11765  The translation can be switched off to allow more comfortable LaTeX editing
11766  inside LyX.
11767 \end_layout
11768
11769 \begin_layout Description
11770 \begin_inset Flex CharStyle:Code
11771 status collapsed
11772
11773 \begin_layout Plain Layout
11774 NextNoIndent
11775 \end_layout
11776
11777 \end_inset
11778
11779  [
11780 \begin_inset Flex CharStyle:Code
11781 status collapsed
11782
11783 \begin_layout Plain Layout
11784 1
11785 \end_layout
11786
11787 \end_inset
11788
11789 ,
11790 \begin_inset Flex CharStyle:Code
11791 status collapsed
11792
11793 \begin_layout Plain Layout
11794
11795 \emph on
11796 0
11797 \end_layout
11798
11799 \end_inset
11800
11801 ] Whether the following Paragraph is allowed to indent its very first row.
11802
11803 \begin_inset Flex CharStyle:Code
11804 status collapsed
11805
11806 \begin_layout Plain Layout
11807 1
11808 \end_layout
11809
11810 \end_inset
11811
11812  means that it is not allowed to do so;
11813 \begin_inset Flex CharStyle:Code
11814 status collapsed
11815
11816 \begin_layout Plain Layout
11817 0
11818 \end_layout
11819
11820 \end_inset
11821
11822  means it could do so if it wants to.
11823 \end_layout
11824
11825 \begin_layout Description
11826 \begin_inset Flex CharStyle:Code
11827 status collapsed
11828
11829 \begin_layout Plain Layout
11830 ObsoletedBy
11831 \end_layout
11832
11833 \end_inset
11834
11835  Name of a layout that has replaced this layout.
11836  This is used to rename a layout, while keeping backward compatibility.
11837 \end_layout
11838
11839 \begin_layout Description
11840 \begin_inset Flex CharStyle:Code
11841 status collapsed
11842
11843 \begin_layout Plain Layout
11844 OptionalArgs
11845 \end_layout
11846
11847 \end_inset
11848
11849  [
11850 \begin_inset Flex CharStyle:Code
11851 status collapsed
11852
11853 \begin_layout Plain Layout
11854 int=0
11855 \end_layout
11856
11857 \end_inset
11858
11859 ] The number of optional arguments that can be used with this layout.
11860  This is useful for things like section headings, and only makes sense with
11861  LaTeX.
11862 \end_layout
11863
11864 \begin_layout Description
11865 \begin_inset Flex CharStyle:Code
11866 status collapsed
11867
11868 \begin_layout Plain Layout
11869 ParIndent
11870 \end_layout
11871
11872 \end_inset
11873
11874  [
11875 \begin_inset Flex CharStyle:Code
11876 status collapsed
11877
11878 \begin_layout Plain Layout
11879 string=""
11880 \end_layout
11881
11882 \end_inset
11883
11884 ] The indent of the very first line of a paragraph.
11885  The
11886 \begin_inset Flex CharStyle:Code
11887 status collapsed
11888
11889 \begin_layout Plain Layout
11890 Parindent
11891 \end_layout
11892
11893 \end_inset
11894
11895  will be fixed for a certain layout.
11896  The exception is Standard layout, since the indentation of a Standard layout
11897  paragraph can be prohibited with
11898 \begin_inset Flex CharStyle:Code
11899 status collapsed
11900
11901 \begin_layout Plain Layout
11902 NextNoIndent
11903 \end_layout
11904
11905 \end_inset
11906
11907 .
11908  Also, Standard layout paragraphs inside environments use the
11909 \begin_inset Flex CharStyle:Code
11910 status collapsed
11911
11912 \begin_layout Plain Layout
11913 Parindent
11914 \end_layout
11915
11916 \end_inset
11917
11918  of the environment, not their native one.
11919  For example, Standard paragraphs inside an enumeration are not indented.
11920 \end_layout
11921
11922 \begin_layout Description
11923 \begin_inset Flex CharStyle:Code
11924 status collapsed
11925
11926 \begin_layout Plain Layout
11927 Parsep
11928 \end_layout
11929
11930 \end_inset
11931
11932  [
11933 \begin_inset Flex CharStyle:Code
11934 status collapsed
11935
11936 \begin_layout Plain Layout
11937 float=0
11938 \end_layout
11939
11940 \end_inset
11941
11942 ] The vertical space between two paragraphs of this layout.
11943 \end_layout
11944
11945 \begin_layout Description
11946 \begin_inset Flex CharStyle:Code
11947 status collapsed
11948
11949 \begin_layout Plain Layout
11950 Parskip
11951 \end_layout
11952
11953 \end_inset
11954
11955  [
11956 \begin_inset Flex CharStyle:Code
11957 status collapsed
11958
11959 \begin_layout Plain Layout
11960 float=0
11961 \end_layout
11962
11963 \end_inset
11964
11965 ] LyX allows the user to choose either
11966 \begin_inset Quotes eld
11967 \end_inset
11968
11969 indent
11970 \begin_inset Quotes erd
11971 \end_inset
11972
11973  or
11974 \begin_inset Quotes eld
11975 \end_inset
11976
11977 skip
11978 \begin_inset Quotes erd
11979 \end_inset
11980
11981  to typeset a document.
11982  When
11983 \begin_inset Quotes eld
11984 \end_inset
11985
11986 indent
11987 \begin_inset Quotes erd
11988 \end_inset
11989
11990  is chosen, this value is completely ignored.
11991  When
11992 \begin_inset Quotes eld
11993 \end_inset
11994
11995 skip
11996 \begin_inset Quotes erd
11997 \end_inset
11998
11999  is chosen, the parindent of a LaTeXtype
12000 \begin_inset Quotes eld
12001 \end_inset
12002
12003 Paragraph
12004 \begin_inset Quotes erd
12005 \end_inset
12006
12007  layout is ignored and all paragraphs are separated by this parskip argument.
12008  The vertical space is calculated with
12009 \begin_inset Flex CharStyle:Code
12010 status collapsed
12011
12012 \begin_layout Plain Layout
12013 value
12014 \begin_inset space ~
12015 \end_inset
12016
12017 * DefaultHeight
12018 \end_layout
12019
12020 \end_inset
12021
12022  where
12023 \begin_inset Flex CharStyle:Code
12024 status collapsed
12025
12026 \begin_layout Plain Layout
12027 DefaultHeight
12028 \end_layout
12029
12030 \end_inset
12031
12032  is the height of a row with the normal font.
12033  This way, the look stays the same with different screen fonts.
12034 \end_layout
12035
12036 \begin_layout Description
12037 \begin_inset Flex CharStyle:Code
12038 status collapsed
12039
12040 \begin_layout Plain Layout
12041 PassThru
12042 \end_layout
12043
12044 \end_inset
12045
12046
12047 \begin_inset CommandInset label
12048 LatexCommand label
12049 name "des:PathThru"
12050
12051 \end_inset
12052
12053 [
12054 \emph on
12055
12056 \begin_inset Flex CharStyle:Code
12057 status collapsed
12058
12059 \begin_layout Plain Layout
12060
12061 \emph on
12062 0
12063 \end_layout
12064
12065 \end_inset
12066
12067
12068 \emph default
12069 ,
12070 \begin_inset Flex CharStyle:Code
12071 status collapsed
12072
12073 \begin_layout Plain Layout
12074 1
12075 \end_layout
12076
12077 \end_inset
12078
12079 ] Whether the contents of this paragraph should be output in raw form, meaning
12080  without special translations that LaTeX would require.
12081 \end_layout
12082
12083 \begin_layout Description
12084 \begin_inset Flex CharStyle:Code
12085 status collapsed
12086
12087 \begin_layout Plain Layout
12088 Preamble
12089 \end_layout
12090
12091 \end_inset
12092
12093
12094 \begin_inset CommandInset label
12095 LatexCommand label
12096 name "des:Preamble"
12097
12098 \end_inset
12099
12100 Information to be included in the LaTeX preamble when this style is used.
12101  Used to define macros, load packages, etc., required by this particular
12102  style.
12103  Must end with
12104 \begin_inset Quotes eld
12105 \end_inset
12106
12107
12108 \begin_inset Flex CharStyle:Code
12109 status collapsed
12110
12111 \begin_layout Plain Layout
12112 EndPreamble
12113 \end_layout
12114
12115 \end_inset
12116
12117
12118 \begin_inset Quotes erd
12119 \end_inset
12120
12121 .
12122 \end_layout
12123
12124 \begin_layout Description
12125 \begin_inset Flex CharStyle:Code
12126 status collapsed
12127
12128 \begin_layout Plain Layout
12129 Requires
12130 \end_layout
12131
12132 \end_inset
12133
12134 [
12135 \begin_inset Flex CharStyle:Code
12136 status collapsed
12137
12138 \begin_layout Plain Layout
12139 string
12140 \end_layout
12141
12142 \end_inset
12143
12144 ]
12145 \begin_inset CommandInset label
12146 LatexCommand label
12147 name "des:Requires"
12148
12149 \end_inset
12150
12151 Whether the layout requires the feature
12152 \begin_inset Flex CharStyle:Code
12153 status collapsed
12154
12155 \begin_layout Plain Layout
12156 string
12157 \end_layout
12158
12159 \end_inset
12160
12161 .
12162  See the description of
12163 \begin_inset Flex CharStyle:Code
12164 status collapsed
12165
12166 \begin_layout Plain Layout
12167 Provides
12168 \end_layout
12169
12170 \end_inset
12171
12172  above (page
12173 \begin_inset CommandInset ref
12174 LatexCommand pageref
12175 reference "des:FreeSpacing"
12176
12177 \end_inset
12178
12179 ) for information on `features'.
12180
12181 \end_layout
12182
12183 \begin_layout Description
12184 \begin_inset Flex CharStyle:Code
12185 status collapsed
12186
12187 \begin_layout Plain Layout
12188 RightMargin
12189 \end_layout
12190
12191 \end_inset
12192
12193  [
12194 \begin_inset Flex CharStyle:Code
12195 status collapsed
12196
12197 \begin_layout Plain Layout
12198 string=""
12199 \end_layout
12200
12201 \end_inset
12202
12203 ] Similar to
12204 \begin_inset Flex CharStyle:Code
12205 status collapsed
12206
12207 \begin_layout Plain Layout
12208 LeftMargin
12209 \end_layout
12210
12211 \end_inset
12212
12213 .
12214 \end_layout
12215
12216 \begin_layout Description
12217 \begin_inset Flex CharStyle:Code
12218 status collapsed
12219
12220 \begin_layout Plain Layout
12221 Spacing
12222 \end_layout
12223
12224 \end_inset
12225
12226  [
12227 \begin_inset Flex CharStyle:Code
12228 status collapsed
12229
12230 \begin_layout Plain Layout
12231
12232 \emph on
12233 single
12234 \emph default
12235 , onehalf, double, other
12236 \end_layout
12237
12238 \end_inset
12239
12240
12241 \emph on
12242 value
12243 \emph default
12244 ] This defines what the default spacing should be in the layout.
12245  The arguments
12246 \begin_inset Flex CharStyle:Code
12247 status collapsed
12248
12249 \begin_layout Plain Layout
12250 single
12251 \end_layout
12252
12253 \end_inset
12254
12255 ,
12256 \begin_inset Flex CharStyle:Code
12257 status collapsed
12258
12259 \begin_layout Plain Layout
12260 onehalf
12261 \end_layout
12262
12263 \end_inset
12264
12265  and
12266 \begin_inset Flex CharStyle:Code
12267 status collapsed
12268
12269 \begin_layout Plain Layout
12270 double
12271 \end_layout
12272
12273 \end_inset
12274
12275  correspond respectively to a multiplier value of 1, 1.25 and 1.667.
12276  If you specify the argument
12277 \begin_inset Flex CharStyle:Code
12278 status collapsed
12279
12280 \begin_layout Plain Layout
12281 other
12282 \end_layout
12283
12284 \end_inset
12285
12286 , then you should also provide a numerical argument which will be the actual
12287  multiplier value.
12288  Note that, contrary to other parameters,
12289 \begin_inset Flex CharStyle:Code
12290 status collapsed
12291
12292 \begin_layout Plain Layout
12293 Spacing
12294 \end_layout
12295
12296 \end_inset
12297
12298  implies the generation of specific LaTeX code, using the package
12299 \family roman
12300
12301 \begin_inset Flex CharStyle:Code
12302 status collapsed
12303
12304 \begin_layout Plain Layout
12305 setspace.sty
12306 \end_layout
12307
12308 \end_inset
12309
12310 .
12311 \end_layout
12312
12313 \begin_layout Description
12314 \begin_inset Flex CharStyle:Code
12315 status collapsed
12316
12317 \begin_layout Plain Layout
12318 TextFont
12319 \end_layout
12320
12321 \end_inset
12322
12323  The font used for the text body .
12324  See section
12325 \begin_inset CommandInset ref
12326 LatexCommand ref
12327 reference "sub:Font-description"
12328
12329 \end_inset
12330
12331 .
12332 \end_layout
12333
12334 \begin_layout Description
12335 \begin_inset Flex CharStyle:Code
12336 status collapsed
12337
12338 \begin_layout Plain Layout
12339 TocLevel
12340 \end_layout
12341
12342 \end_inset
12343
12344
12345 \series medium
12346
12347 \begin_inset Flex CharStyle:Code
12348 status collapsed
12349
12350 \begin_layout Plain Layout
12351
12352 \series medium
12353 [int]
12354 \end_layout
12355
12356 \end_inset
12357
12358
12359 \series default
12360  The level of the style in the table of contents.
12361  This is used for automatic numbering of section headings.
12362 \end_layout
12363
12364 \begin_layout Description
12365 \begin_inset Flex CharStyle:Code
12366 status collapsed
12367
12368 \begin_layout Plain Layout
12369 TopSep
12370 \end_layout
12371
12372 \end_inset
12373
12374  [
12375 \begin_inset Flex CharStyle:Code
12376 status collapsed
12377
12378 \begin_layout Plain Layout
12379 float=0
12380 \end_layout
12381
12382 \end_inset
12383
12384 ] The vertical space with which the very first of a chain of paragraphs
12385  with this layout is separated from the previous paragraph.
12386  If the previous paragraph has another layout, the separations are not simply
12387  added, but the maximum is taken.
12388 \end_layout
12389
12390 \begin_layout Subsection
12391 Floats
12392 \begin_inset CommandInset label
12393 LatexCommand label
12394 name "sub:Floats"
12395
12396 \end_inset
12397
12398
12399 \end_layout
12400
12401 \begin_layout Standard
12402 Since version 1.3.0 of LyX, it is has been both possible and necessary to
12403  define the floats (
12404 \begin_inset Flex CharStyle:MenuItem
12405 status collapsed
12406
12407 \begin_layout Plain Layout
12408 figure
12409 \end_layout
12410
12411 \end_inset
12412
12413 ,
12414 \begin_inset Flex CharStyle:MenuItem
12415 status collapsed
12416
12417 \begin_layout Plain Layout
12418 table
12419 \end_layout
12420
12421 \end_inset
12422
12423 , \SpecialChar \ldots{}
12424 ) in the text class itself.
12425  Standard floats are included in the file
12426 \begin_inset Flex CharStyle:Code
12427 status collapsed
12428
12429 \begin_layout Plain Layout
12430 stdfloats.inc
12431 \end_layout
12432
12433 \end_inset
12434
12435 , so you may have to do no more than add
12436 \end_layout
12437
12438 \begin_layout LyX-Code
12439 Input stdfloats.inc
12440 \end_layout
12441
12442 \begin_layout Standard
12443 to your layout file.
12444  If you want to implement a text class that proposes some other float types
12445  (like the AGU class bundled with LyX), the information below will hopefully
12446  help you:
12447 \end_layout
12448
12449 \begin_layout Description
12450 \begin_inset Flex CharStyle:Code
12451 status collapsed
12452
12453 \begin_layout Plain Layout
12454 Extension
12455 \end_layout
12456
12457 \end_inset
12458
12459  [
12460 \begin_inset Flex CharStyle:Code
12461 status collapsed
12462
12463 \begin_layout Plain Layout
12464 string
12465 \end_layout
12466
12467 \end_inset
12468
12469 =
12470 \begin_inset Quotes erd
12471 \end_inset
12472
12473
12474 \begin_inset Quotes erd
12475 \end_inset
12476
12477 ] The file name extension of an auxiliary file for the list of figures (or
12478  whatever).
12479  LaTeX writes the captions to this file.
12480 \end_layout
12481
12482 \begin_layout Description
12483 \begin_inset Flex CharStyle:Code
12484 status collapsed
12485
12486 \begin_layout Plain Layout
12487 GuiName
12488 \end_layout
12489
12490 \end_inset
12491
12492  [
12493 \begin_inset Flex CharStyle:Code
12494 status collapsed
12495
12496 \begin_layout Plain Layout
12497 string
12498 \end_layout
12499
12500 \end_inset
12501
12502 =
12503 \begin_inset Quotes erd
12504 \end_inset
12505
12506
12507 \begin_inset Quotes erd
12508 \end_inset
12509
12510 ] The string that will be used in the menus and also for the caption.
12511  This is translated to the current language if babel is used.
12512 \end_layout
12513
12514 \begin_layout Description
12515 \begin_inset Flex CharStyle:Code
12516 status collapsed
12517
12518 \begin_layout Plain Layout
12519 HTML*
12520 \end_layout
12521
12522 \end_inset
12523
12524  These are used for XHTML output.
12525  See
12526 \end_layout
12527
12528 \begin_layout Description
12529 \begin_inset Flex CharStyle:Code
12530 status collapsed
12531
12532 \begin_layout Plain Layout
12533 LaTeXBuiltin
12534 \end_layout
12535
12536 \end_inset
12537
12538  [
12539 \begin_inset Flex CharStyle:Code
12540 status collapsed
12541
12542 \begin_layout Plain Layout
12543
12544 \emph on
12545 0
12546 \end_layout
12547
12548 \end_inset
12549
12550 ,
12551 \begin_inset Flex CharStyle:Code
12552 status collapsed
12553
12554 \begin_layout Plain Layout
12555 1
12556 \end_layout
12557
12558 \end_inset
12559
12560 ] Set to
12561 \begin_inset Flex CharStyle:Code
12562 status collapsed
12563
12564 \begin_layout Plain Layout
12565 1
12566 \end_layout
12567
12568 \end_inset
12569
12570  if the float is already defined by the LaTeX document class.
12571  If this is set to
12572 \begin_inset Flex CharStyle:Code
12573 status collapsed
12574
12575 \begin_layout Plain Layout
12576 0
12577 \end_layout
12578
12579 \end_inset
12580
12581 , the float will be defined using the LaTeX package
12582 \begin_inset Flex CharStyle:Code
12583 status collapsed
12584
12585 \begin_layout Plain Layout
12586 float
12587 \end_layout
12588
12589 \end_inset
12590
12591 .
12592 \end_layout
12593
12594 \begin_layout Description
12595 \begin_inset Flex CharStyle:Code
12596 status collapsed
12597
12598 \begin_layout Plain Layout
12599 ListName
12600 \end_layout
12601
12602 \end_inset
12603
12604  [
12605 \begin_inset Flex CharStyle:Code
12606 status collapsed
12607
12608 \begin_layout Plain Layout
12609 string
12610 \end_layout
12611
12612 \end_inset
12613
12614 =
12615 \begin_inset Quotes erd
12616 \end_inset
12617
12618
12619 \begin_inset Quotes erd
12620 \end_inset
12621
12622 ] The heading used for the list of floats.
12623  This is translated to the document language.
12624 \end_layout
12625
12626 \begin_layout Description
12627 \begin_inset Flex CharStyle:Code
12628 status collapsed
12629
12630 \begin_layout Plain Layout
12631 NumberWithin
12632 \end_layout
12633
12634 \end_inset
12635
12636  [
12637 \begin_inset Flex CharStyle:Code
12638 status collapsed
12639
12640 \begin_layout Plain Layout
12641 string
12642 \end_layout
12643
12644 \end_inset
12645
12646 =
12647 \begin_inset Quotes erd
12648 \end_inset
12649
12650
12651 \begin_inset Quotes erd
12652 \end_inset
12653
12654 ] This (optional) argument determines whether floats of this class will
12655  be numbered within some sectional unit of the document.
12656  For example, if within is equal to
12657 \begin_inset Flex CharStyle:Code
12658 status collapsed
12659
12660 \begin_layout Plain Layout
12661 chapter
12662 \end_layout
12663
12664 \end_inset
12665
12666 , the floats will be numbered within chapters.
12667
12668 \end_layout
12669
12670 \begin_layout Description
12671 \begin_inset Flex CharStyle:Code
12672 status collapsed
12673
12674 \begin_layout Plain Layout
12675 Placement
12676 \end_layout
12677
12678 \end_inset
12679
12680  [
12681 \begin_inset Flex CharStyle:Code
12682 status collapsed
12683
12684 \begin_layout Plain Layout
12685 string
12686 \end_layout
12687
12688 \end_inset
12689
12690 =
12691 \begin_inset Quotes erd
12692 \end_inset
12693
12694
12695 \begin_inset Quotes erd
12696 \end_inset
12697
12698 ] The default placement for the given class of floats.
12699  The string should be as in standard LaTeX:
12700 \begin_inset Flex CharStyle:Code
12701 status collapsed
12702
12703 \begin_layout Plain Layout
12704 t
12705 \end_layout
12706
12707 \end_inset
12708
12709 ,
12710 \begin_inset Flex CharStyle:Code
12711 status collapsed
12712
12713 \begin_layout Plain Layout
12714 b
12715 \end_layout
12716
12717 \end_inset
12718
12719 ,
12720 \begin_inset Flex CharStyle:Code
12721 status collapsed
12722
12723 \begin_layout Plain Layout
12724 p
12725 \end_layout
12726
12727 \end_inset
12728
12729  and
12730 \begin_inset Flex CharStyle:Code
12731 status collapsed
12732
12733 \begin_layout Plain Layout
12734 h
12735 \end_layout
12736
12737 \end_inset
12738
12739  for top, bottom, page, and here, respectively.
12740 \begin_inset Foot
12741 status collapsed
12742
12743 \begin_layout Plain Layout
12744 Note that the order of these letters in the string is irrelevant, like in
12745  LaTeX.
12746 \end_layout
12747
12748 \end_inset
12749
12750  On top of that there is a new type,
12751 \begin_inset Flex CharStyle:Code
12752 status collapsed
12753
12754 \begin_layout Plain Layout
12755 H
12756 \end_layout
12757
12758 \end_inset
12759
12760 , which does not really correspond to a float, since it means: put it
12761 \begin_inset Quotes eld
12762 \end_inset
12763
12764 here
12765 \begin_inset Quotes erd
12766 \end_inset
12767
12768  and nowhere else.
12769  Note however that the
12770 \begin_inset Flex CharStyle:Code
12771 status collapsed
12772
12773 \begin_layout Plain Layout
12774 H
12775 \end_layout
12776
12777 \end_inset
12778
12779  specifier is special and, because of implementation details, cannot be
12780  used in non-built in float types.
12781  If you do not understand what this means, just use
12782 \begin_inset Quotes eld
12783 \end_inset
12784
12785
12786 \begin_inset Flex CharStyle:Code
12787 status collapsed
12788
12789 \begin_layout Plain Layout
12790 tbp
12791 \end_layout
12792
12793 \end_inset
12794
12795
12796 \begin_inset Quotes erd
12797 \end_inset
12798
12799 .
12800 \end_layout
12801
12802 \begin_layout Description
12803 \begin_inset Flex CharStyle:Code
12804 status collapsed
12805
12806 \begin_layout Plain Layout
12807 Style
12808 \end_layout
12809
12810 \end_inset
12811
12812  [
12813 \begin_inset Flex CharStyle:Code
12814 status collapsed
12815
12816 \begin_layout Plain Layout
12817 string
12818 \end_layout
12819
12820 \end_inset
12821
12822 =
12823 \begin_inset Quotes erd
12824 \end_inset
12825
12826
12827 \begin_inset Quotes erd
12828 \end_inset
12829
12830 ] The style used when defining the float using
12831 \begin_inset Flex CharStyle:Code
12832 status collapsed
12833
12834 \begin_layout Plain Layout
12835
12836 \backslash
12837 newfloat
12838 \end_layout
12839
12840 \end_inset
12841
12842 .
12843 \end_layout
12844
12845 \begin_layout Description
12846 \begin_inset Flex CharStyle:Code
12847 status collapsed
12848
12849 \begin_layout Plain Layout
12850 Type
12851 \end_layout
12852
12853 \end_inset
12854
12855  [
12856 \begin_inset Flex CharStyle:Code
12857 status collapsed
12858
12859 \begin_layout Plain Layout
12860 string
12861 \end_layout
12862
12863 \end_inset
12864
12865 =
12866 \begin_inset Quotes erd
12867 \end_inset
12868
12869
12870 \begin_inset Quotes erd
12871 \end_inset
12872
12873 ] The
12874 \begin_inset Quotes eld
12875 \end_inset
12876
12877 type
12878 \begin_inset Quotes erd
12879 \end_inset
12880
12881  of the new class of floats, like program or algorithm.
12882  After the appropriate
12883 \begin_inset Flex CharStyle:Code
12884 status collapsed
12885
12886 \begin_layout Plain Layout
12887
12888 \backslash
12889 newfloat
12890 \end_layout
12891
12892 \end_inset
12893
12894 , commands such as
12895 \begin_inset Flex CharStyle:Code
12896 status collapsed
12897
12898 \begin_layout Plain Layout
12899
12900 \backslash
12901 begin{program}
12902 \end_layout
12903
12904 \end_inset
12905
12906  or
12907 \begin_inset Flex CharStyle:Code
12908 status collapsed
12909
12910 \begin_layout Plain Layout
12911
12912 \backslash
12913 end{algorithm*}
12914 \end_layout
12915
12916 \end_inset
12917
12918  will be available.
12919 \end_layout
12920
12921 \begin_layout Standard
12922 Note that defining a float with type
12923 \begin_inset Flex CharStyle:Code
12924 status collapsed
12925
12926 \begin_layout Plain Layout
12927
12928 \emph on
12929 type
12930 \end_layout
12931
12932 \end_inset
12933
12934  automatically defines the corresponding counter with name
12935 \begin_inset Flex CharStyle:Code
12936 status collapsed
12937
12938 \begin_layout Plain Layout
12939
12940 \emph on
12941 type
12942 \end_layout
12943
12944 \end_inset
12945
12946 .
12947 \end_layout
12948
12949 \begin_layout Subsection
12950 Flex insets and InsetLayout
12951 \begin_inset CommandInset label
12952 LatexCommand label
12953 name "sub:Flex-insets-and"
12954
12955 \end_inset
12956
12957
12958 \end_layout
12959
12960 \begin_layout Standard
12961 LyX has supported character styles since version 1.4.0; as of version 1.6.0,
12962  these are called Flex insets.
12963
12964 \end_layout
12965
12966 \begin_layout Standard
12967 Flex insets come in three different kinds:
12968 \end_layout
12969
12970 \begin_layout Itemize
12971 character style (
12972 \begin_inset Flex CharStyle:Code
12973 status collapsed
12974
12975 \begin_layout Plain Layout
12976 CharStyle
12977 \end_layout
12978
12979 \end_inset
12980
12981 ): These define semantic markup corresponding to such LaTeX commands as
12982
12983 \begin_inset Flex CharStyle:Code
12984 status collapsed
12985
12986 \begin_layout Plain Layout
12987
12988 \backslash
12989 noun
12990 \end_layout
12991
12992 \end_inset
12993
12994  and
12995 \begin_inset Flex CharStyle:Code
12996 status collapsed
12997
12998 \begin_layout Plain Layout
12999
13000 \backslash
13001 code
13002 \end_layout
13003
13004 \end_inset
13005
13006 .
13007 \end_layout
13008
13009 \begin_layout Itemize
13010 user custom (
13011 \begin_inset Flex CharStyle:Code
13012 status collapsed
13013
13014 \begin_layout Plain Layout
13015 Custom
13016 \end_layout
13017
13018 \end_inset
13019
13020 ): These can be used to define custom collapsible insets, similar to TeX
13021  code, footnote, and the like.
13022  An obvious example is an endnote inset, which is defined in the
13023 \begin_inset Flex CharStyle:Code
13024 status collapsed
13025
13026 \begin_layout Plain Layout
13027 endnote
13028 \end_layout
13029
13030 \end_inset
13031
13032  module.
13033 \end_layout
13034
13035 \begin_layout Itemize
13036 XML elements (
13037 \begin_inset Flex CharStyle:Code
13038 status collapsed
13039
13040 \begin_layout Plain Layout
13041 Element
13042 \end_layout
13043
13044 \end_inset
13045
13046 ): For use with DocBook classes.
13047 \end_layout
13048
13049 \begin_layout Standard
13050 Flex insets are defined using the
13051 \begin_inset Flex CharStyle:Code
13052 status collapsed
13053
13054 \begin_layout Plain Layout
13055 InsetLayout
13056 \end_layout
13057
13058 \end_inset
13059
13060  tag, which shall be explained in a moment.
13061 \end_layout
13062
13063 \begin_layout Standard
13064 The
13065 \begin_inset Flex CharStyle:Code
13066 status collapsed
13067
13068 \begin_layout Plain Layout
13069 InsetLayout
13070 \end_layout
13071
13072 \end_inset
13073
13074  tag also serves another function: It can be used to customize the general
13075  layout of many different types of insets.
13076  Currently,
13077 \begin_inset Flex CharStyle:Code
13078 status collapsed
13079
13080 \begin_layout Plain Layout
13081 InsetLayout
13082 \end_layout
13083
13084 \end_inset
13085
13086  can be used to customize the layout parameters for footnotes, marginal
13087  notes, note insets, TeX code (ERT) insets, branches, listings, indexes,
13088  boxes, tables, algorithms, URLs, and optional arguments, as well as to
13089  define Flex insets.
13090 \end_layout
13091
13092 \begin_layout Standard
13093 The
13094 \begin_inset Flex CharStyle:Code
13095 status collapsed
13096
13097 \begin_layout Plain Layout
13098 InsetLayout
13099 \end_layout
13100
13101 \end_inset
13102
13103  definition must begin with a line of the form:
13104 \end_layout
13105
13106 \begin_layout LyX-Code
13107 InsetLayout <Type>
13108 \end_layout
13109
13110 \begin_layout Standard
13111 Here
13112 \begin_inset Flex CharStyle:Code
13113 status collapsed
13114
13115 \begin_layout Plain Layout
13116 <Type>
13117 \end_layout
13118
13119 \end_inset
13120
13121  indicates the inset whose layout is being defined, and here there are two
13122  cases.
13123 \end_layout
13124
13125 \begin_layout Enumerate
13126 The layout for a pre-existing inset is being modified.
13127  In this case, can be
13128 \begin_inset Flex CharStyle:Code
13129 status collapsed
13130
13131 \begin_layout Plain Layout
13132 <Type>
13133 \end_layout
13134
13135 \end_inset
13136
13137  any one of the following:
13138 \begin_inset Flex CharStyle:Code
13139 status collapsed
13140
13141 \begin_layout Plain Layout
13142 Algorithm
13143 \end_layout
13144
13145 \end_inset
13146
13147 ,
13148 \begin_inset Flex CharStyle:Code
13149 status collapsed
13150
13151 \begin_layout Plain Layout
13152 Branch
13153 \end_layout
13154
13155 \end_inset
13156
13157 ,
13158 \begin_inset Flex CharStyle:Code
13159 status collapsed
13160
13161 \begin_layout Plain Layout
13162 Box
13163 \end_layout
13164
13165 \end_inset
13166
13167 ,
13168 \begin_inset Flex CharStyle:Code
13169 status collapsed
13170
13171 \begin_layout Plain Layout
13172 Box:shaded
13173 \end_layout
13174
13175 \end_inset
13176
13177 ,
13178 \begin_inset Flex CharStyle:Code
13179 status collapsed
13180
13181 \begin_layout Plain Layout
13182 ERT
13183 \end_layout
13184
13185 \end_inset
13186
13187 ,
13188 \begin_inset Flex CharStyle:Code
13189 status collapsed
13190
13191 \begin_layout Plain Layout
13192 Figure
13193 \end_layout
13194
13195 \end_inset
13196
13197 ,
13198 \begin_inset Flex CharStyle:Code
13199 status collapsed
13200
13201 \begin_layout Plain Layout
13202 Foot
13203 \end_layout
13204
13205 \end_inset
13206
13207 ,
13208 \begin_inset Flex CharStyle:Code
13209 status collapsed
13210
13211 \begin_layout Plain Layout
13212 Index
13213 \end_layout
13214
13215 \end_inset
13216
13217 ,
13218 \begin_inset Flex CharStyle:Code
13219 status collapsed
13220
13221 \begin_layout Plain Layout
13222 Info
13223 \end_layout
13224
13225 \end_inset
13226
13227 ,
13228 \begin_inset Flex CharStyle:Code
13229 status collapsed
13230
13231 \begin_layout Plain Layout
13232 Info:menu
13233 \end_layout
13234
13235 \end_inset
13236
13237 ,
13238 \begin_inset Flex CharStyle:Code
13239 status collapsed
13240
13241 \begin_layout Plain Layout
13242 Info:shortcut
13243 \end_layout
13244
13245 \end_inset
13246
13247 ,
13248 \begin_inset Flex CharStyle:Code
13249 status collapsed
13250
13251 \begin_layout Plain Layout
13252 Info:shortcuts
13253 \end_layout
13254
13255 \end_inset
13256
13257 ,
13258 \begin_inset Flex CharStyle:Code
13259 status collapsed
13260
13261 \begin_layout Plain Layout
13262 Listings
13263 \end_layout
13264
13265 \end_inset
13266
13267 ,
13268 \begin_inset Flex CharStyle:Code
13269 status collapsed
13270
13271 \begin_layout Plain Layout
13272 Marginal
13273 \end_layout
13274
13275 \end_inset
13276
13277 ,
13278 \begin_inset Flex CharStyle:Code
13279 status collapsed
13280
13281 \begin_layout Plain Layout
13282 Note:Comment
13283 \end_layout
13284
13285 \end_inset
13286
13287 ,
13288 \begin_inset Flex CharStyle:Code
13289 status collapsed
13290
13291 \begin_layout Plain Layout
13292 Note:Note
13293 \end_layout
13294
13295 \end_inset
13296
13297 ,
13298 \begin_inset Flex CharStyle:Code
13299 status collapsed
13300
13301 \begin_layout Plain Layout
13302 Note:GreyedOut
13303 \end_layout
13304
13305 \end_inset
13306
13307 ,
13308 \begin_inset Flex CharStyle:Code
13309 status collapsed
13310
13311 \begin_layout Plain Layout
13312 OptArg
13313 \end_layout
13314
13315 \end_inset
13316
13317 ,
13318 \begin_inset Flex CharStyle:Code
13319 status collapsed
13320
13321 \begin_layout Plain Layout
13322 Table
13323 \end_layout
13324
13325 \end_inset
13326
13327 , or
13328 \begin_inset Flex CharStyle:Code
13329 status collapsed
13330
13331 \begin_layout Plain Layout
13332 URL
13333 \end_layout
13334
13335 \end_inset
13336
13337 .
13338 \end_layout
13339
13340 \begin_layout Enumerate
13341 The layout for a Flex inset is being defined.
13342  In this case,
13343 \begin_inset Flex CharStyle:Code
13344 status collapsed
13345
13346 \begin_layout Plain Layout
13347 <Type>
13348 \end_layout
13349
13350 \end_inset
13351
13352  can be any valid identifier not used by a pre-existing inset.
13353  Note that the definition of a flex inset
13354 \emph on
13355 must
13356 \emph default
13357 also include a
13358 \begin_inset Flex CharStyle:Code
13359 status collapsed
13360
13361 \begin_layout Plain Layout
13362 LyXType
13363 \end_layout
13364
13365 \end_inset
13366
13367  entry, declaring which type of inset this is.
13368 \end_layout
13369
13370 \begin_layout Standard
13371 The
13372 \begin_inset Flex CharStyle:Code
13373 status collapsed
13374
13375 \begin_layout Plain Layout
13376 InsetLayout
13377 \end_layout
13378
13379 \end_inset
13380
13381  definition can contain the following entries:
13382 \end_layout
13383
13384 \begin_layout Description
13385 \begin_inset Flex CharStyle:Code
13386 status collapsed
13387
13388 \begin_layout Plain Layout
13389 BgColor
13390 \end_layout
13391
13392 \end_inset
13393
13394  The color for the inset's background.
13395  The valid colors are defined in
13396 \begin_inset Flex CharStyle:Code
13397 status collapsed
13398
13399 \begin_layout Plain Layout
13400 src/ColorCode.h
13401 \end_layout
13402
13403 \end_inset
13404
13405 .
13406 \end_layout
13407
13408 \begin_layout Description
13409 \begin_inset Flex CharStyle:Code
13410 status collapsed
13411
13412 \begin_layout Plain Layout
13413 ContentAsLabel
13414 \end_layout
13415
13416 \end_inset
13417
13418  [
13419 \begin_inset Flex CharStyle:Code
13420 status collapsed
13421
13422 \begin_layout Plain Layout
13423
13424 \emph on
13425 0
13426 \end_layout
13427
13428 \end_inset
13429
13430 ,
13431 \begin_inset Flex CharStyle:Code
13432 status collapsed
13433
13434 \begin_layout Plain Layout
13435 1
13436 \end_layout
13437
13438 \end_inset
13439
13440 ] Whether to use the content of the inset as the label, when the inset is
13441  closed.
13442  Default is false.
13443 \end_layout
13444
13445 \begin_layout Description
13446 \begin_inset Flex CharStyle:Code
13447 status collapsed
13448
13449 \begin_layout Plain Layout
13450 CopyStyle
13451 \end_layout
13452
13453 \end_inset
13454
13455  As with paragraph styles (see page
13456 \begin_inset CommandInset ref
13457 LatexCommand ref
13458 reference "des:CopyStyle"
13459
13460 \end_inset
13461
13462 ).
13463 \end_layout
13464
13465 \begin_layout Description
13466 \begin_inset Flex CharStyle:Code
13467 status collapsed
13468
13469 \begin_layout Plain Layout
13470 CustomPars
13471 \end_layout
13472
13473 \end_inset
13474
13475  [
13476 \begin_inset Flex CharStyle:Code
13477 status collapsed
13478
13479 \begin_layout Plain Layout
13480
13481 \emph on
13482 0
13483 \end_layout
13484
13485 \end_inset
13486
13487 ,
13488 \begin_inset Flex CharStyle:Code
13489 status collapsed
13490
13491 \begin_layout Plain Layout
13492 1
13493 \end_layout
13494
13495 \end_inset
13496
13497 ] Indicates whether the user may employ the Paragraph Settings dialog to
13498  customize the paragraph.
13499 \end_layout
13500
13501 \begin_layout Description
13502 \begin_inset Flex CharStyle:Code
13503 status collapsed
13504
13505 \begin_layout Plain Layout
13506 Decoration
13507 \end_layout
13508
13509 \end_inset
13510
13511  can be
13512 \begin_inset Flex CharStyle:Code
13513 status collapsed
13514
13515 \begin_layout Plain Layout
13516 Classic
13517 \end_layout
13518
13519 \end_inset
13520
13521 ,
13522 \begin_inset Flex CharStyle:Code
13523 status collapsed
13524
13525 \begin_layout Plain Layout
13526 Minimalistic
13527 \end_layout
13528
13529 \end_inset
13530
13531 , or
13532 \begin_inset Flex CharStyle:Code
13533 status collapsed
13534
13535 \begin_layout Plain Layout
13536 Conglomerate
13537 \end_layout
13538
13539 \end_inset
13540
13541 , describing the rendering style used for the inset's frame and buttons.
13542  Footnotes generally use
13543 \begin_inset Flex CharStyle:Code
13544 status collapsed
13545
13546 \begin_layout Plain Layout
13547 Classic
13548 \end_layout
13549
13550 \end_inset
13551
13552 , ERT insets generally
13553 \begin_inset Flex CharStyle:Code
13554 status collapsed
13555
13556 \begin_layout Plain Layout
13557 Minimalistic
13558 \end_layout
13559
13560 \end_inset
13561
13562 , and character styles
13563 \begin_inset Flex CharStyle:Code
13564 status collapsed
13565
13566 \begin_layout Plain Layout
13567 Conglomerate
13568 \end_layout
13569
13570 \end_inset
13571
13572 .
13573 \end_layout
13574
13575 \begin_layout Description
13576 \begin_inset Flex CharStyle:Code
13577 status collapsed
13578
13579 \begin_layout Plain Layout
13580 End
13581 \end_layout
13582
13583 \end_inset
13584
13585  Required at the end of the InsetLayout declarations.
13586 \end_layout
13587
13588 \begin_layout Description
13589 \begin_inset Flex CharStyle:Code
13590 status collapsed
13591
13592 \begin_layout Plain Layout
13593 Font
13594 \end_layout
13595
13596 \end_inset
13597
13598  The font used for both the text body
13599 \emph on
13600 and
13601 \emph default
13602  the label.
13603  See section
13604 \begin_inset space ~
13605 \end_inset
13606
13607
13608 \begin_inset CommandInset ref
13609 LatexCommand ref
13610 reference "sub:Font-description"
13611
13612 \end_inset
13613
13614 .
13615  Note that defining this font automatically defines the
13616 \begin_inset Flex CharStyle:Code
13617 status collapsed
13618
13619 \begin_layout Plain Layout
13620 LabelFont
13621 \end_layout
13622
13623 \end_inset
13624
13625  to the same value, so define this first and define
13626 \begin_inset Flex CharStyle:Code
13627 status collapsed
13628
13629 \begin_layout Plain Layout
13630 LabelFont
13631 \end_layout
13632
13633 \end_inset
13634
13635  later if you want them to be different.
13636 \end_layout
13637
13638 \begin_layout Description
13639 \begin_inset Flex CharStyle:Code
13640 status collapsed
13641
13642 \begin_layout Plain Layout
13643 ForceLTR
13644 \end_layout
13645
13646 \end_inset
13647
13648  Force the
13649 \begin_inset Quotes eld
13650 \end_inset
13651
13652 latex
13653 \begin_inset Quotes erd
13654 \end_inset
13655
13656  language, leading to Left-to-Right (latin) output, e.
13657 \begin_inset space \thinspace{}
13658 \end_inset
13659
13660 g.
13661 \begin_inset space \space{}
13662 \end_inset
13663
13664 in TeX code or URL.
13665  A kludge.
13666 \end_layout
13667
13668 \begin_layout Description
13669 \begin_inset Flex CharStyle:Code
13670 status collapsed
13671
13672 \begin_layout Plain Layout
13673 ForcePlain
13674 \end_layout
13675
13676 \end_inset
13677
13678  [
13679 \begin_inset Flex CharStyle:Code
13680 status collapsed
13681
13682 \begin_layout Plain Layout
13683
13684 \emph on
13685 0
13686 \end_layout
13687
13688 \end_inset
13689
13690 ,
13691 \begin_inset Flex CharStyle:Code
13692 status collapsed
13693
13694 \begin_layout Plain Layout
13695 1
13696 \end_layout
13697
13698 \end_inset
13699
13700 ] Indicates whether the PlainLayout should be used or, instead, the user
13701  can change the paragraph style used in the inset.
13702  Default is false.
13703 \end_layout
13704
13705 \begin_layout Description
13706 \begin_inset Flex CharStyle:Code
13707 status collapsed
13708
13709 \begin_layout Plain Layout
13710 FreeSpacing
13711 \end_layout
13712
13713 \end_inset
13714
13715  As with paragraph styles (see page
13716 \begin_inset CommandInset ref
13717 LatexCommand pageref
13718 reference "des:FreeSpacing"
13719
13720 \end_inset
13721
13722 ).
13723  Default is false.
13724 \end_layout
13725
13726 \begin_layout Description
13727 \begin_inset Flex CharStyle:Code
13728 status collapsed
13729
13730 \begin_layout Plain Layout
13731 HTML*
13732 \end_layout
13733
13734 \end_inset
13735
13736  These tags control XHTML output.
13737  See
13738 \end_layout
13739
13740 \begin_layout Description
13741 \begin_inset Flex CharStyle:Code
13742 status collapsed
13743
13744 \begin_layout Plain Layout
13745 InToc
13746 \end_layout
13747
13748 \end_inset
13749
13750  [
13751 \begin_inset Flex CharStyle:Code
13752 status collapsed
13753
13754 \begin_layout Plain Layout
13755
13756 \emph on
13757 0
13758 \end_layout
13759
13760 \end_inset
13761
13762 ,
13763 \begin_inset Flex CharStyle:Code
13764 status collapsed
13765
13766 \begin_layout Plain Layout
13767 1
13768 \end_layout
13769
13770 \end_inset
13771
13772 ] Whether to include the contents of this inset in the strings generated
13773  for the `Outline' pane.
13774  One would not, for example, want the content of a footnote in a section
13775  header to be included in the TOC displayed in the outline, but one would
13776  normally want the content of a character style displayed.
13777  Default is false: not to include.
13778 \end_layout
13779
13780 \begin_layout Description
13781 \begin_inset Flex CharStyle:Code
13782 status collapsed
13783
13784 \begin_layout Plain Layout
13785 KeepEmpty
13786 \end_layout
13787
13788 \end_inset
13789
13790  As with paragraph styles (see page
13791 \begin_inset CommandInset ref
13792 LatexCommand pageref
13793 reference "des:KeepEmpty"
13794
13795 \end_inset
13796
13797 ).
13798  Default is false.
13799 \end_layout
13800
13801 \begin_layout Description
13802 \begin_inset Flex CharStyle:Code
13803 status collapsed
13804
13805 \begin_layout Plain Layout
13806 LabelFont
13807 \end_layout
13808
13809 \end_inset
13810
13811  The font used for the label.
13812  See section
13813 \begin_inset space ~
13814 \end_inset
13815
13816
13817 \begin_inset CommandInset ref
13818 LatexCommand ref
13819 reference "sub:Font-description"
13820
13821 \end_inset
13822
13823 .
13824  Note that this definition can never appear before
13825 \begin_inset Flex CharStyle:Code
13826 status collapsed
13827
13828 \begin_layout Plain Layout
13829 Font
13830 \end_layout
13831
13832 \end_inset
13833
13834 , lest it be ineffective.
13835 \end_layout
13836
13837 \begin_layout Description
13838 \begin_inset Flex CharStyle:Code
13839 status collapsed
13840
13841 \begin_layout Plain Layout
13842 LabelString
13843 \end_layout
13844
13845 \end_inset
13846
13847  What will be displayed on the button or elsewhere as the inset label.
13848  Some inset types (TeX code and Branch) modify this label on the fly.
13849 \end_layout
13850
13851 \begin_layout Description
13852 \begin_inset Flex CharStyle:Code
13853 status collapsed
13854
13855 \begin_layout Plain Layout
13856 LatexName
13857 \end_layout
13858
13859 \end_inset
13860
13861  The name of the corresponding LaTeX stuff.
13862  Either the environment or command name.
13863 \end_layout
13864
13865 \begin_layout Description
13866 \begin_inset Flex CharStyle:Code
13867 status collapsed
13868
13869 \begin_layout Plain Layout
13870 LatexParam
13871 \end_layout
13872
13873 \end_inset
13874
13875  The optional parameter for the corresponding
13876 \begin_inset Flex CharStyle:Code
13877 status collapsed
13878
13879 \begin_layout Plain Layout
13880 LatexName
13881 \end_layout
13882
13883 \end_inset
13884
13885  stuff, including possible bracket pairs like
13886 \begin_inset Flex CharStyle:Code
13887 status collapsed
13888
13889 \begin_layout Plain Layout
13890 []
13891 \end_layout
13892
13893 \end_inset
13894
13895 .
13896  This parameter cannot be changed from within LyX.
13897 \end_layout
13898
13899 \begin_layout Description
13900 \begin_inset Flex CharStyle:Code
13901 status collapsed
13902
13903 \begin_layout Plain Layout
13904 LatexType
13905 \end_layout
13906
13907 \end_inset
13908
13909  As with paragraph styles (see page
13910 \begin_inset CommandInset ref
13911 LatexCommand pageref
13912 reference "des:LatexType"
13913
13914 \end_inset
13915
13916 ).
13917 \end_layout
13918
13919 \begin_layout Description
13920 \begin_inset Flex CharStyle:Code
13921 status collapsed
13922
13923 \begin_layout Plain Layout
13924 LyxType
13925 \end_layout
13926
13927 \end_inset
13928
13929  Can be
13930 \begin_inset Flex CharStyle:Code
13931 status collapsed
13932
13933 \begin_layout Plain Layout
13934 charstyle
13935 \end_layout
13936
13937 \end_inset
13938
13939 ,
13940 \begin_inset Flex CharStyle:Code
13941 status collapsed
13942
13943 \begin_layout Plain Layout
13944 custom
13945 \end_layout
13946
13947 \end_inset
13948
13949 ,
13950 \begin_inset Flex CharStyle:Code
13951 status collapsed
13952
13953 \begin_layout Plain Layout
13954 element
13955 \end_layout
13956
13957 \end_inset
13958
13959 , or
13960 \begin_inset Flex CharStyle:Code
13961 status collapsed
13962
13963 \begin_layout Plain Layout
13964 end
13965 \end_layout
13966
13967 \end_inset
13968
13969  (indicating a dummy definition ending definitions of charstyles, etc).
13970  This entry is required in and is only meaningful for Flex insets.
13971  Among other things, it determines on which menu this inset will appear.
13972 \end_layout
13973
13974 \begin_layout Description
13975 \begin_inset Flex CharStyle:Code
13976 status collapsed
13977
13978 \begin_layout Plain Layout
13979 MultiPar
13980 \end_layout
13981
13982 \end_inset
13983
13984  [
13985 \begin_inset Flex CharStyle:Code
13986 status collapsed
13987
13988 \begin_layout Plain Layout
13989
13990 \emph on
13991 0
13992 \end_layout
13993
13994 \end_inset
13995
13996 ,
13997 \begin_inset Flex CharStyle:Code
13998 status collapsed
13999
14000 \begin_layout Plain Layout
14001 1
14002 \end_layout
14003
14004 \end_inset
14005
14006 ] Whether multiple paragraphs are permitted in this inset.
14007  This will also set
14008 \begin_inset Flex CharStyle:Code
14009 status collapsed
14010
14011 \begin_layout Plain Layout
14012 CustomPars
14013 \end_layout
14014
14015 \end_inset
14016
14017  to the same value and
14018 \begin_inset Flex CharStyle:Code
14019 status collapsed
14020
14021 \begin_layout Plain Layout
14022 ForcePlain
14023 \end_layout
14024
14025 \end_inset
14026
14027  to the opposite value.
14028  These can be reset to other values, if they are used
14029 \emph on
14030 after
14031 \emph default
14032
14033 \begin_inset Flex CharStyle:Code
14034 status collapsed
14035
14036 \begin_layout Plain Layout
14037 MultiPar
14038 \end_layout
14039
14040 \end_inset
14041
14042 .
14043  Default is true.
14044 \end_layout
14045
14046 \begin_layout Description
14047 \begin_inset Flex CharStyle:Code
14048 status collapsed
14049
14050 \begin_layout Plain Layout
14051 NeedProtect
14052 \end_layout
14053
14054 \end_inset
14055
14056  [
14057 \begin_inset Flex CharStyle:Code
14058 status collapsed
14059
14060 \begin_layout Plain Layout
14061
14062 \emph on
14063 0
14064 \end_layout
14065
14066 \end_inset
14067
14068 ,
14069 \begin_inset Flex CharStyle:Code
14070 status collapsed
14071
14072 \begin_layout Plain Layout
14073 1
14074 \end_layout
14075
14076 \end_inset
14077
14078 ] Whether fragile commands in this layout should be
14079 \begin_inset Flex CharStyle:Code
14080 status collapsed
14081
14082 \begin_layout Plain Layout
14083
14084 \backslash
14085 protect
14086 \end_layout
14087
14088 \end_inset
14089
14090 'ed.
14091  (Note: This is
14092 \emph on
14093 not
14094 \emph default
14095  whether the command should itself be protected.) Default is false.
14096 \end_layout
14097
14098 \begin_layout Description
14099 \begin_inset Flex CharStyle:Code
14100 status collapsed
14101
14102 \begin_layout Plain Layout
14103 PassThru
14104 \end_layout
14105
14106 \end_inset
14107
14108  [
14109 \begin_inset Flex CharStyle:Code
14110 status collapsed
14111
14112 \begin_layout Plain Layout
14113
14114 \emph on
14115 0
14116 \end_layout
14117
14118 \end_inset
14119
14120 ,
14121 \begin_inset Flex CharStyle:Code
14122 status collapsed
14123
14124 \begin_layout Plain Layout
14125 1
14126 \end_layout
14127
14128 \end_inset
14129
14130 ] As with paragraph styles (see page
14131 \begin_inset CommandInset ref
14132 LatexCommand pageref
14133 reference "des:PathThru"
14134
14135 \end_inset
14136
14137 ).
14138  Default is false.
14139 \end_layout
14140
14141 \begin_layout Description
14142 \begin_inset Flex CharStyle:Code
14143 status collapsed
14144
14145 \begin_layout Plain Layout
14146 Preamble
14147 \end_layout
14148
14149 \end_inset
14150
14151  As with paragraph styles (see page
14152 \begin_inset CommandInset ref
14153 LatexCommand pageref
14154 reference "des:Preamble"
14155
14156 \end_inset
14157
14158 ).
14159 \end_layout
14160
14161 \begin_layout Description
14162 \begin_inset Flex CharStyle:Code
14163 status collapsed
14164
14165 \begin_layout Plain Layout
14166 Requires
14167 \end_layout
14168
14169 \end_inset
14170
14171  [
14172 \begin_inset Flex CharStyle:Code
14173 status collapsed
14174
14175 \begin_layout Plain Layout
14176 string
14177 \end_layout
14178
14179 \end_inset
14180
14181 ] As with paragraph styles (see page
14182 \begin_inset CommandInset ref
14183 LatexCommand pageref
14184 reference "des:Requires"
14185
14186 \end_inset
14187
14188 ).
14189 \end_layout
14190
14191 \begin_layout Subsection
14192 Counters
14193 \begin_inset CommandInset label
14194 LatexCommand label
14195 name "sub:Counters"
14196
14197 \end_inset
14198
14199
14200 \end_layout
14201
14202 \begin_layout Standard
14203 Since version 1.3.0 of LyX, it is both possible and necessary to define the
14204  counters (
14205 \begin_inset Flex CharStyle:MenuItem
14206 status collapsed
14207
14208 \begin_layout Plain Layout
14209 chapter
14210 \end_layout
14211
14212 \end_inset
14213
14214 ,
14215 \begin_inset Flex CharStyle:MenuItem
14216 status collapsed
14217
14218 \begin_layout Plain Layout
14219 figure
14220 \end_layout
14221
14222 \end_inset
14223
14224 , \SpecialChar \ldots{}
14225 ) in the text class itself.
14226  The standard counters are defined in the file
14227 \begin_inset Flex CharStyle:Code
14228 status collapsed
14229
14230 \begin_layout Plain Layout
14231 stdcounters.inc
14232 \end_layout
14233
14234 \end_inset
14235
14236 , so you may have to do no more than add
14237 \end_layout
14238
14239 \begin_layout LyX-Code
14240 Input stdcounters.inc
14241 \end_layout
14242
14243 \begin_layout Standard
14244 to your layout file to get them to work.
14245  But if you want to define custom counters, then you can do so.
14246  The counter declaration must begin with:
14247 \end_layout
14248
14249 \begin_layout LyX-Code
14250 Counter CounterName
14251 \end_layout
14252
14253 \begin_layout Standard
14254 where of course `
14255 \begin_inset Flex CharStyle:Code
14256 status collapsed
14257
14258 \begin_layout Plain Layout
14259 CounterName
14260 \end_layout
14261
14262 \end_inset
14263
14264 ' is replaced by the name of the counter.
14265  And it must end with
14266 \begin_inset Quotes eld
14267 \end_inset
14268
14269
14270 \begin_inset Flex CharStyle:Code
14271 status collapsed
14272
14273 \begin_layout Plain Layout
14274 End
14275 \end_layout
14276
14277 \end_inset
14278
14279
14280 \begin_inset Quotes erd
14281 \end_inset
14282
14283 .
14284  The following parameters can also be used:
14285 \end_layout
14286
14287 \begin_layout Description
14288 \begin_inset Flex CharStyle:Code
14289 status collapsed
14290
14291 \begin_layout Plain Layout
14292 LabelString [string=""]
14293 \end_layout
14294
14295 \end_inset
14296
14297  when this is defined, this string defines how the counter is displayed.
14298  Setting this value sets
14299 \begin_inset Flex CharStyle:Code
14300 status collapsed
14301
14302 \begin_layout Plain Layout
14303 LabelStringAppendix
14304 \end_layout
14305
14306 \end_inset
14307
14308  to the same value.
14309  The following special constructs can be used in the string:
14310 \end_layout
14311
14312 \begin_deeper
14313 \begin_layout Itemize
14314 \begin_inset Flex CharStyle:Code
14315 status collapsed
14316
14317 \begin_layout Plain Layout
14318
14319 \backslash
14320 thecounter
14321 \end_layout
14322
14323 \end_inset
14324
14325  will be replaced by the expansion of the
14326 \begin_inset Flex CharStyle:Code
14327 status collapsed
14328
14329 \begin_layout Plain Layout
14330 LabelString
14331 \end_layout
14332
14333 \end_inset
14334
14335  (or
14336 \begin_inset Flex CharStyle:Code
14337 status collapsed
14338
14339 \begin_layout Plain Layout
14340 LabelStringAppendix
14341 \end_layout
14342
14343 \end_inset
14344
14345 ) of the counter
14346 \begin_inset Flex CharStyle:Code
14347 status collapsed
14348
14349 \begin_layout Plain Layout
14350 counter
14351 \end_layout
14352
14353 \end_inset
14354
14355 .
14356
14357 \end_layout
14358
14359 \begin_layout Itemize
14360 counter values can be expressed using LaTeX-like macros
14361 \begin_inset Flex CharStyle:Code
14362 status collapsed
14363
14364 \begin_layout Plain Layout
14365
14366 \backslash
14367
14368 \emph on
14369 numbertype
14370 \emph default
14371 {
14372 \emph on
14373 counter
14374 \emph default
14375 }
14376 \end_layout
14377
14378 \end_inset
14379
14380 , where
14381 \begin_inset Flex CharStyle:Code
14382 status collapsed
14383
14384 \begin_layout Plain Layout
14385
14386 \emph on
14387 numbertype
14388 \end_layout
14389
14390 \end_inset
14391
14392  can be:
14393 \begin_inset Foot
14394 status collapsed
14395
14396 \begin_layout Plain Layout
14397
14398 \family roman
14399 \series medium
14400 \shape up
14401 \size normal
14402 \emph off
14403 \bar no
14404 \noun off
14405 \color none
14406 Actually, the situation is a bit more complicated: any
14407 \family default
14408 \series default
14409 \shape default
14410 \emph default
14411 \bar default
14412
14413 \size default
14414 \emph on
14415 \noun default
14416 \color inherit
14417 numbertype
14418 \family roman
14419 \series medium
14420 \shape up
14421 \size normal
14422 \emph off
14423 \bar no
14424 \noun off
14425  other than those described below will produce arabic numerals.
14426  It would not be surprising to see this change in the future.
14427 \end_layout
14428
14429 \end_inset
14430
14431
14432 \begin_inset Flex CharStyle:Code
14433 status collapsed
14434
14435 \begin_layout Plain Layout
14436 arabic
14437 \end_layout
14438
14439 \end_inset
14440
14441 : 1, 2, 3,\SpecialChar \ldots{}
14442 ;
14443 \begin_inset Flex CharStyle:Code
14444 status collapsed
14445
14446 \begin_layout Plain Layout
14447 alph
14448 \end_layout
14449
14450 \end_inset
14451
14452  for lower-case letters: a, b, c, \SpecialChar \ldots{}
14453 ;
14454 \begin_inset Flex CharStyle:Code
14455 status collapsed
14456
14457 \begin_layout Plain Layout
14458 Alph
14459 \end_layout
14460
14461 \end_inset
14462
14463  for upper-case letters: A, B, C, \SpecialChar \ldots{}
14464 ;
14465 \begin_inset Flex CharStyle:Code
14466 status collapsed
14467
14468 \begin_layout Plain Layout
14469 roman
14470 \end_layout
14471
14472 \end_inset
14473
14474  for lower-case roman numerals: i, ii, iii, \SpecialChar \ldots{}
14475 ;
14476 \begin_inset Flex CharStyle:Code
14477 status collapsed
14478
14479 \begin_layout Plain Layout
14480 Roman
14481 \end_layout
14482
14483 \end_inset
14484
14485  for upper-case roman numerals: I, II, III\SpecialChar \ldots{}
14486 ;
14487 \begin_inset Flex CharStyle:Code
14488 status collapsed
14489
14490 \begin_layout Plain Layout
14491 hebrew
14492 \end_layout
14493
14494 \end_inset
14495
14496  for hebrew numerals.
14497 \end_layout
14498
14499 \end_deeper
14500 \begin_layout Standard
14501 If LabelString is not defined, a default value is constructed as follows:
14502  if the counter has a master counter
14503 \begin_inset Flex CharStyle:Code
14504 status collapsed
14505
14506 \begin_layout Plain Layout
14507 master
14508 \end_layout
14509
14510 \end_inset
14511
14512  (defined via
14513 \begin_inset Flex CharStyle:Code
14514 status collapsed
14515
14516 \begin_layout Plain Layout
14517 Within
14518 \end_layout
14519
14520 \end_inset
14521
14522 ), the string
14523 \begin_inset Flex CharStyle:Code
14524 status collapsed
14525
14526 \begin_layout Plain Layout
14527
14528 \backslash
14529 themaster.
14530 \backslash
14531 arabic{counter}
14532 \end_layout
14533
14534 \end_inset
14535
14536  is used; otherwise the string
14537 \begin_inset Flex CharStyle:Code
14538 status collapsed
14539
14540 \begin_layout Plain Layout
14541
14542 \backslash
14543 arabic{counter}
14544 \end_layout
14545
14546 \end_inset
14547
14548  is used.
14549 \end_layout
14550
14551 \begin_layout Description
14552 \begin_inset Flex CharStyle:Code
14553 status collapsed
14554
14555 \begin_layout Plain Layout
14556 LabelStringAppendix [string=""]
14557 \end_layout
14558
14559 \end_inset
14560
14561  Same as
14562 \begin_inset Flex CharStyle:Code
14563 status collapsed
14564
14565 \begin_layout Plain Layout
14566 LabelString
14567 \end_layout
14568
14569 \end_inset
14570
14571 , but for use in the Appendix.
14572 \end_layout
14573
14574 \begin_layout Description
14575 \begin_inset Flex CharStyle:Code
14576 status collapsed
14577
14578 \begin_layout Plain Layout
14579 Within
14580 \end_layout
14581
14582 \end_inset
14583
14584  [
14585 \begin_inset Flex CharStyle:Code
14586 status collapsed
14587
14588 \begin_layout Plain Layout
14589 string
14590 \end_layout
14591
14592 \end_inset
14593
14594 =
14595 \begin_inset Quotes erd
14596 \end_inset
14597
14598
14599 \begin_inset Quotes erd
14600 \end_inset
14601
14602 ] If this is set to the name of another counter, the present counter will
14603  be reset every time the other one is increased.
14604  For example,
14605 \begin_inset Flex CharStyle:Code
14606 status collapsed
14607
14608 \begin_layout Plain Layout
14609 subsection
14610 \end_layout
14611
14612 \end_inset
14613
14614  is numbered inside
14615 \begin_inset Flex CharStyle:Code
14616 status collapsed
14617
14618 \begin_layout Plain Layout
14619 section
14620 \end_layout
14621
14622 \end_inset
14623
14624 .
14625 \end_layout
14626
14627 \begin_layout Subsection
14628 Font description
14629 \begin_inset CommandInset label
14630 LatexCommand label
14631 name "sub:Font-description"
14632
14633 \end_inset
14634
14635
14636 \end_layout
14637
14638 \begin_layout Standard
14639 A font description looks like this:
14640 \end_layout
14641
14642 \begin_layout LyX-Code
14643 Font
14644 \family roman
14645 \emph on
14646 or
14647 \family default
14648 \emph default
14649  LabelFont
14650 \end_layout
14651
14652 \begin_layout LyX-Code
14653  ...
14654 \end_layout
14655
14656 \begin_layout LyX-Code
14657 EndFont
14658 \end_layout
14659
14660 \begin_layout Standard
14661 The following commands are available:
14662 \end_layout
14663
14664 \begin_layout Description
14665 \begin_inset Flex CharStyle:Code
14666 status collapsed
14667
14668 \begin_layout Plain Layout
14669 Color
14670 \end_layout
14671
14672 \end_inset
14673
14674  [
14675 \begin_inset Flex CharStyle:Code
14676 status collapsed
14677
14678 \begin_layout Plain Layout
14679
14680 \emph on
14681 none
14682 \end_layout
14683
14684 \end_inset
14685
14686 ,
14687 \begin_inset Flex CharStyle:Code
14688 status collapsed
14689
14690 \begin_layout Plain Layout
14691 black
14692 \end_layout
14693
14694 \end_inset
14695
14696 ,
14697 \begin_inset Flex CharStyle:Code
14698 status collapsed
14699
14700 \begin_layout Plain Layout
14701 white
14702 \end_layout
14703
14704 \end_inset
14705
14706 ,
14707 \begin_inset Flex CharStyle:Code
14708 status collapsed
14709
14710 \begin_layout Plain Layout
14711 red
14712 \end_layout
14713
14714 \end_inset
14715
14716 ,
14717 \begin_inset Flex CharStyle:Code
14718 status collapsed
14719
14720 \begin_layout Plain Layout
14721 green
14722 \end_layout
14723
14724 \end_inset
14725
14726 ,
14727 \begin_inset Flex CharStyle:Code
14728 status collapsed
14729
14730 \begin_layout Plain Layout
14731 blue
14732 \end_layout
14733
14734 \end_inset
14735
14736 ,
14737 \begin_inset Flex CharStyle:Code
14738 status collapsed
14739
14740 \begin_layout Plain Layout
14741 cyan
14742 \end_layout
14743
14744 \end_inset
14745
14746 ,
14747 \begin_inset Flex CharStyle:Code
14748 status collapsed
14749
14750 \begin_layout Plain Layout
14751 magenta
14752 \end_layout
14753
14754 \end_inset
14755
14756 ,
14757 \begin_inset Flex CharStyle:Code
14758 status collapsed
14759
14760 \begin_layout Plain Layout
14761 yellow
14762 \end_layout
14763
14764 \end_inset
14765
14766 ]
14767 \end_layout
14768
14769 \begin_layout Description
14770 \begin_inset Flex CharStyle:Code
14771 status collapsed
14772
14773 \begin_layout Plain Layout
14774 Family
14775 \end_layout
14776
14777 \end_inset
14778
14779  [
14780 \emph on
14781
14782 \begin_inset Flex CharStyle:Code
14783 status collapsed
14784
14785 \begin_layout Plain Layout
14786
14787 \emph on
14788 Roman
14789 \end_layout
14790
14791 \end_inset
14792
14793
14794 \emph default
14795 ,
14796 \begin_inset Flex CharStyle:Code
14797 status collapsed
14798
14799 \begin_layout Plain Layout
14800 Sans
14801 \end_layout
14802
14803 \end_inset
14804
14805 ,
14806 \begin_inset Flex CharStyle:Code
14807 status collapsed
14808
14809 \begin_layout Plain Layout
14810 Typewriter
14811 \end_layout
14812
14813 \end_inset
14814
14815 ]
14816 \end_layout
14817
14818 \begin_layout Description
14819 \begin_inset Flex CharStyle:Code
14820 status collapsed
14821
14822 \begin_layout Plain Layout
14823 Misc
14824 \end_layout
14825
14826 \end_inset
14827
14828  [
14829 \begin_inset Flex CharStyle:Code
14830 status collapsed
14831
14832 \begin_layout Plain Layout
14833 string
14834 \end_layout
14835
14836 \end_inset
14837
14838 ] Valid arguments are:
14839 \begin_inset Flex CharStyle:Code
14840 status collapsed
14841
14842 \begin_layout Plain Layout
14843 emph
14844 \end_layout
14845
14846 \end_inset
14847
14848 ,
14849 \begin_inset Flex CharStyle:Code
14850 status collapsed
14851
14852 \begin_layout Plain Layout
14853 noun
14854 \end_layout
14855
14856 \end_inset
14857
14858 ,
14859 \begin_inset Flex CharStyle:Code
14860 status collapsed
14861
14862 \begin_layout Plain Layout
14863 underbar
14864 \end_layout
14865
14866 \end_inset
14867
14868 ,
14869 \begin_inset Flex CharStyle:Code
14870 status collapsed
14871
14872 \begin_layout Plain Layout
14873 no_emph
14874 \end_layout
14875
14876 \end_inset
14877
14878 ,
14879 \begin_inset Flex CharStyle:Code
14880 status collapsed
14881
14882 \begin_layout Plain Layout
14883 no_noun
14884 \end_layout
14885
14886 \end_inset
14887
14888  and
14889 \begin_inset Flex CharStyle:Code
14890 status collapsed
14891
14892 \begin_layout Plain Layout
14893 no_bar
14894 \end_layout
14895
14896 \end_inset
14897
14898 .
14899  Each of these turns on or off the corresponding attribute.
14900  For example,
14901 \begin_inset Flex CharStyle:Code
14902 status collapsed
14903
14904 \begin_layout Plain Layout
14905 emph
14906 \end_layout
14907
14908 \end_inset
14909
14910  turns on emphasis, and
14911 \begin_inset Flex CharStyle:Code
14912 status collapsed
14913
14914 \begin_layout Plain Layout
14915 no_emph
14916 \end_layout
14917
14918 \end_inset
14919
14920  turns it off.
14921
14922 \begin_inset Newline newline
14923 \end_inset
14924
14925 If the latter seems puzzling, remember that the font settings for the present
14926  context are generally inherited from the surrounding context.
14927  So
14928 \begin_inset Flex CharStyle:Code
14929 status collapsed
14930
14931 \begin_layout Plain Layout
14932 no_emph
14933 \end_layout
14934
14935 \end_inset
14936
14937  would turn off the emphasis that was anyway in effect, say, in a theorem
14938  environment.
14939 \end_layout
14940
14941 \begin_layout Description
14942 \begin_inset Flex CharStyle:Code
14943 status collapsed
14944
14945 \begin_layout Plain Layout
14946 Series
14947 \end_layout
14948
14949 \end_inset
14950
14951  [
14952 \emph on
14953
14954 \begin_inset Flex CharStyle:Code
14955 status collapsed
14956
14957 \begin_layout Plain Layout
14958
14959 \emph on
14960 Medium
14961 \end_layout
14962
14963 \end_inset
14964
14965
14966 \emph default
14967 ,
14968 \begin_inset Flex CharStyle:Code
14969 status collapsed
14970
14971 \begin_layout Plain Layout
14972 Bold
14973 \end_layout
14974
14975 \end_inset
14976
14977 ]
14978 \end_layout
14979
14980 \begin_layout Description
14981 \begin_inset Flex CharStyle:Code
14982 status collapsed
14983
14984 \begin_layout Plain Layout
14985 Shape
14986 \end_layout
14987
14988 \end_inset
14989
14990  [
14991 \emph on
14992
14993 \begin_inset Flex CharStyle:Code
14994 status collapsed
14995
14996 \begin_layout Plain Layout
14997
14998 \emph on
14999 Up
15000 \end_layout
15001
15002 \end_inset
15003
15004
15005 \emph default
15006 ,
15007 \begin_inset Flex CharStyle:Code
15008 status collapsed
15009
15010 \begin_layout Plain Layout
15011 Italic
15012 \end_layout
15013
15014 \end_inset
15015
15016 ,
15017 \begin_inset Flex CharStyle:Code
15018 status collapsed
15019
15020 \begin_layout Plain Layout
15021 SmallCaps
15022 \end_layout
15023
15024 \end_inset
15025
15026 ,
15027 \begin_inset Flex CharStyle:Code
15028 status collapsed
15029
15030 \begin_layout Plain Layout
15031 Slanted
15032 \end_layout
15033
15034 \end_inset
15035
15036 ]
15037 \end_layout
15038
15039 \begin_layout Description
15040 \begin_inset Flex CharStyle:Code
15041 status collapsed
15042
15043 \begin_layout Plain Layout
15044 Size
15045 \end_layout
15046
15047 \end_inset
15048
15049  [
15050 \begin_inset Flex CharStyle:Code
15051 status collapsed
15052
15053 \begin_layout Plain Layout
15054 tiny
15055 \end_layout
15056
15057 \end_inset
15058
15059 ,
15060 \begin_inset Flex CharStyle:Code
15061 status collapsed
15062
15063 \begin_layout Plain Layout
15064 small
15065 \end_layout
15066
15067 \end_inset
15068
15069 ,
15070 \begin_inset Flex CharStyle:Code
15071 status collapsed
15072
15073 \begin_layout Plain Layout
15074
15075 \emph on
15076 normal
15077 \end_layout
15078
15079 \end_inset
15080
15081 ,
15082 \begin_inset Flex CharStyle:Code
15083 status collapsed
15084
15085 \begin_layout Plain Layout
15086 large
15087 \end_layout
15088
15089 \end_inset
15090
15091 ,
15092 \begin_inset Flex CharStyle:Code
15093 status collapsed
15094
15095 \begin_layout Plain Layout
15096 larger
15097 \end_layout
15098
15099 \end_inset
15100
15101 ,
15102 \begin_inset Flex CharStyle:Code
15103 status collapsed
15104
15105 \begin_layout Plain Layout
15106 largest
15107 \end_layout
15108
15109 \end_inset
15110
15111 ,
15112 \begin_inset Flex CharStyle:Code
15113 status collapsed
15114
15115 \begin_layout Plain Layout
15116 huge
15117 \end_layout
15118
15119 \end_inset
15120
15121 ,
15122 \begin_inset Flex CharStyle:Code
15123 status collapsed
15124
15125 \begin_layout Plain Layout
15126 giant
15127 \end_layout
15128
15129 \end_inset
15130
15131 ]
15132 \end_layout
15133
15134 \begin_layout Section
15135 \begin_inset CommandInset label
15136 LatexCommand label
15137 name "sec:Tags-for-XHTML"
15138
15139 \end_inset
15140
15141 Tags for XHTML output
15142 \end_layout
15143
15144 \begin_layout Standard
15145 As with LaTeX or DocBook, the format of LyX's XHTML output is also controlled
15146  by layout information.
15147  In general, LyX provides sensible defaults and, as mentioned earlier, it
15148  will even construct default CSS style rules from the other layout tags.
15149  For example, LyX will attempt to use the information provided in the
15150 \begin_inset Flex CharStyle:Code
15151 status collapsed
15152
15153 \begin_layout Plain Layout
15154 Font
15155 \end_layout
15156
15157 \end_inset
15158
15159  declaration for the Chapter style to write CSS that will appropriately
15160  format chapter headings.
15161 \end_layout
15162
15163 \begin_layout Standard
15164 In many cases, then, you may not have to do anything at all to get acceptable
15165  XHTML output for your own environments, custom insets, and so forth.
15166  But in some cases you will, and so LyX provides a number of layout tags
15167  that can be used to customize the XHTML and CSS that are generated.
15168 \end_layout
15169
15170 \begin_layout Standard
15171 Note that there are two tags,
15172 \begin_inset Flex CharStyle:Code
15173 status collapsed
15174
15175 \begin_layout Plain Layout
15176 HTMLPreamble
15177 \end_layout
15178
15179 \end_inset
15180
15181  and
15182 \begin_inset Flex CharStyle:Code
15183 status collapsed
15184
15185 \begin_layout Plain Layout
15186 AddToHTMLPreamble
15187 \end_layout
15188
15189 \end_inset
15190
15191  that may appear outside style and inset declarations.
15192  See
15193 \begin_inset CommandInset ref
15194 LatexCommand prettyref
15195 reference "sub:General-text-class"
15196
15197 \end_inset
15198
15199  for details on these.
15200 \end_layout
15201
15202 \begin_layout Subsection
15203 \begin_inset CommandInset label
15204 LatexCommand label
15205 name "sub:Paragraph-Style-XHTML"
15206
15207 \end_inset
15208
15209 Paragraph styles
15210 \end_layout
15211
15212 \begin_layout Standard
15213 The sort of XHTML LyX outputs for a paragraph depends upon whether we are
15214  dealing with a normal paragraph, a command, or an environment, where this
15215  is itself determined by the contents of the corresponding
15216 \begin_inset Flex CharStyle:Code
15217 status collapsed
15218
15219 \begin_layout Plain Layout
15220 LaTeXType
15221 \end_layout
15222
15223 \end_inset
15224
15225  tag.
15226
15227 \end_layout
15228
15229 \begin_layout Standard
15230 For a command or normal paragraph, the output XHTML has the following form:
15231 \end_layout
15232
15233 \begin_layout LyX-Code
15234 <tag attr=
15235 \begin_inset Quotes erd
15236 \end_inset
15237
15238 value
15239 \begin_inset Quotes erd
15240 \end_inset
15241
15242 >
15243 \end_layout
15244
15245 \begin_layout LyX-Code
15246 <labeltag attr=
15247 \begin_inset Quotes erd
15248 \end_inset
15249
15250 value
15251 \begin_inset Quotes erd
15252 \end_inset
15253
15254 >Label</labeltag>
15255 \end_layout
15256
15257 \begin_layout LyX-Code
15258 Contents of the paragraph.
15259 \end_layout
15260
15261 \begin_layout LyX-Code
15262 </tag>
15263 \end_layout
15264
15265 \begin_layout Standard
15266 The label tags are of course omitted if the paragraph does not have a label.
15267 \end_layout
15268
15269 \begin_layout Standard
15270 For an environment that is not some sort of list, the XHTML takes this form:
15271 \end_layout
15272
15273 \begin_layout LyX-Code
15274 <tag attr=
15275 \begin_inset Quotes erd
15276 \end_inset
15277
15278 value
15279 \begin_inset Quotes erd
15280 \end_inset
15281
15282 >
15283 \end_layout
15284
15285 \begin_layout LyX-Code
15286 <itemtag attr=
15287 \begin_inset Quotes erd
15288 \end_inset
15289
15290 value
15291 \begin_inset Quotes erd
15292 \end_inset
15293
15294 ><labeltag attr=
15295 \begin_inset Quotes erd
15296 \end_inset
15297
15298 value
15299 \begin_inset Quotes erd
15300 \end_inset
15301
15302 >Environment Label</labeltag>First paragraph.</itemtag>
15303 \end_layout
15304
15305 \begin_layout LyX-Code
15306 <itemtag>Second paragraph.</itemtag>
15307 \end_layout
15308
15309 \begin_layout LyX-Code
15310 </tag>
15311 \end_layout
15312
15313 \begin_layout Standard
15314 Note that the label is output only for the first paragraph, as it should
15315  be for a theorem, for example.
15316
15317 \end_layout
15318
15319 \begin_layout Standard
15320 For a list, we have one of these forms:
15321 \end_layout
15322
15323 \begin_layout LyX-Code
15324 <tag attr=
15325 \begin_inset Quotes erd
15326 \end_inset
15327
15328 value
15329 \begin_inset Quotes erd
15330 \end_inset
15331
15332 >
15333 \end_layout
15334
15335 \begin_layout LyX-Code
15336 <itemtag attr=
15337 \begin_inset Quotes erd
15338 \end_inset
15339
15340 value
15341 \begin_inset Quotes erd
15342 \end_inset
15343
15344 ><labeltag attr=
15345 \begin_inset Quotes erd
15346 \end_inset
15347
15348 value
15349 \begin_inset Quotes erd
15350 \end_inset
15351
15352 >List Label</labeltag>First item.</itemtag>
15353 \end_layout
15354
15355 \begin_layout LyX-Code
15356 <itemtag attr=
15357 \begin_inset Quotes erd
15358 \end_inset
15359
15360 value
15361 \begin_inset Quotes erd
15362 \end_inset
15363
15364 ><labeltag attr=
15365 \begin_inset Quotes erd
15366 \end_inset
15367
15368 value
15369 \begin_inset Quotes erd
15370 \end_inset
15371
15372 >List Label</labeltag>Second item.</itemtag>
15373 \end_layout
15374
15375 \begin_layout LyX-Code
15376 </tag>
15377 \end_layout
15378
15379 \begin_layout LyX-Code
15380
15381 \end_layout
15382
15383 \begin_layout LyX-Code
15384 <tag attr=
15385 \begin_inset Quotes erd
15386 \end_inset
15387
15388 value
15389 \begin_inset Quotes erd
15390 \end_inset
15391
15392 >
15393 \end_layout
15394
15395 \begin_layout LyX-Code
15396 <labeltag attr=
15397 \begin_inset Quotes erd
15398 \end_inset
15399
15400 value
15401 \begin_inset Quotes erd
15402 \end_inset
15403
15404 >List Label</labeltag><itemtag attr=
15405 \begin_inset Quotes erd
15406 \end_inset
15407
15408 value
15409 \begin_inset Quotes erd
15410 \end_inset
15411
15412 >First item.</itemtag>
15413 \end_layout
15414
15415 \begin_layout LyX-Code
15416 <labeltag attr=
15417 \begin_inset Quotes erd
15418 \end_inset
15419
15420 value
15421 \begin_inset Quotes erd
15422 \end_inset
15423
15424 >List Label</labeltag><itemtag attr=
15425 \begin_inset Quotes erd
15426 \end_inset
15427
15428 value
15429 \begin_inset Quotes erd
15430 \end_inset
15431
15432 >Second item.</itemtag>
15433 \end_layout
15434
15435 \begin_layout LyX-Code
15436 </tag>
15437 \end_layout
15438
15439 \begin_layout Standard
15440 Note the different orders of
15441 \begin_inset Flex CharStyle:Code
15442 status collapsed
15443
15444 \begin_layout Plain Layout
15445 labeltag
15446 \end_layout
15447
15448 \end_inset
15449
15450  and
15451 \begin_inset Flex CharStyle:Code
15452 status collapsed
15453
15454 \begin_layout Plain Layout
15455 itemtag
15456 \end_layout
15457
15458 \end_inset
15459
15460 .
15461  Which order we get depends upon the setting of
15462 \begin_inset Flex CharStyle:Code
15463 status collapsed
15464
15465 \begin_layout Plain Layout
15466 HTMLLabelFirst
15467 \end_layout
15468
15469 \end_inset
15470
15471 : If
15472 \begin_inset Flex CharStyle:Code
15473 status collapsed
15474
15475 \begin_layout Plain Layout
15476 HTMLLabelFirst
15477 \end_layout
15478
15479 \end_inset
15480
15481  is false (the default), you get the first of these, with the label within
15482  the item; if true, you get the second, with the label outside the item.
15483 \end_layout
15484
15485 \begin_layout Standard
15486 The specific tags and attributes output for each paragraph type can be controlle
15487 d by means of the layout tags we are about to describe.
15488  As mentioned earlier, however, LyX uses sensible defaults for many of these,
15489  so you often may not need to do very much to get good XHTML output.
15490  Think of the available tags as there so you can tweak things to your liking.
15491 \end_layout
15492
15493 \begin_layout Description
15494 \begin_inset Flex CharStyle:Code
15495 status collapsed
15496
15497 \begin_layout Plain Layout
15498 HTMLAttr
15499 \end_layout
15500
15501 \end_inset
15502
15503  [
15504 \begin_inset Flex CharStyle:Code
15505 status collapsed
15506
15507 \begin_layout Plain Layout
15508 string
15509 \end_layout
15510
15511 \end_inset
15512
15513 ] Specifies attribute information to be output with the main tag.
15514  For example,
15515 \begin_inset Quotes eld
15516 \end_inset
15517
15518
15519 \begin_inset Flex CharStyle:Code
15520 status collapsed
15521
15522 \begin_layout Plain Layout
15523 class=`mydiv'
15524 \end_layout
15525
15526 \end_inset
15527
15528
15529 \begin_inset Quotes erd
15530 \end_inset
15531
15532 .
15533  By default, LyX will output
15534 \begin_inset Quotes eld
15535 \end_inset
15536
15537
15538 \begin_inset Flex CharStyle:Code
15539 status collapsed
15540
15541 \begin_layout Plain Layout
15542 class=`layoutname'
15543 \end_layout
15544
15545 \end_inset
15546
15547
15548 \begin_inset Quotes erd
15549 \end_inset
15550
15551 , where
15552 \begin_inset Flex CharStyle:Code
15553 status collapsed
15554
15555 \begin_layout Plain Layout
15556 layoutname
15557 \end_layout
15558
15559 \end_inset
15560
15561  is the LyX name of the layout, made lowercase, for example: chapter.
15562 \end_layout
15563
15564 \begin_layout Description
15565 \begin_inset Flex CharStyle:Code
15566 status collapsed
15567
15568 \begin_layout Plain Layout
15569 HTMLForceCSS
15570 \end_layout
15571
15572 \end_inset
15573
15574  [
15575 \begin_inset Flex CharStyle:Code
15576 status collapsed
15577
15578 \begin_layout Plain Layout
15579 0,1
15580 \end_layout
15581
15582 \end_inset
15583
15584 ] Whether to output the default CSS information LyX generates for this layout,
15585  even if additional information is explicitly provided via
15586 \begin_inset Flex CharStyle:Code
15587 status collapsed
15588
15589 \begin_layout Plain Layout
15590 HTMLStyle
15591 \end_layout
15592
15593 \end_inset
15594
15595 .
15596  Setting this to
15597 \begin_inset Flex CharStyle:Code
15598 status collapsed
15599
15600 \begin_layout Plain Layout
15601 1
15602 \end_layout
15603
15604 \end_inset
15605
15606  allows you to alter or augment the generated CSS, rather than to override
15607  it completely.
15608  Default is
15609 \begin_inset Flex CharStyle:Code
15610 status collapsed
15611
15612 \begin_layout Plain Layout
15613 0
15614 \end_layout
15615
15616 \end_inset
15617
15618 .
15619 \end_layout
15620
15621 \begin_layout Description
15622 \begin_inset Flex CharStyle:Code
15623 status collapsed
15624
15625 \begin_layout Plain Layout
15626 HTMLItem
15627 \end_layout
15628
15629 \end_inset
15630
15631  [
15632 \begin_inset Flex CharStyle:Code
15633 status collapsed
15634
15635 \begin_layout Plain Layout
15636 string
15637 \end_layout
15638
15639 \end_inset
15640
15641 ] The tag to be used for individual paragraphs of environments, replacing
15642
15643 \begin_inset Flex CharStyle:Code
15644 status collapsed
15645
15646 \begin_layout Plain Layout
15647 itemtag
15648 \end_layout
15649
15650 \end_inset
15651
15652  in the examples above.
15653  Defaults to
15654 \begin_inset Flex CharStyle:Code
15655 status collapsed
15656
15657 \begin_layout Plain Layout
15658 div
15659 \end_layout
15660
15661 \end_inset
15662
15663 .
15664 \end_layout
15665
15666 \begin_layout Description
15667 \begin_inset Flex CharStyle:Code
15668 status collapsed
15669
15670 \begin_layout Plain Layout
15671 HTMLItemAttr
15672 \end_layout
15673
15674 \end_inset
15675
15676  [
15677 \begin_inset Flex CharStyle:Code
15678 status collapsed
15679
15680 \begin_layout Plain Layout
15681 string
15682 \end_layout
15683
15684 \end_inset
15685
15686 ] Attributes for the item tag.
15687  Defaults to
15688 \begin_inset Quotes eld
15689 \end_inset
15690
15691
15692 \begin_inset Flex CharStyle:Code
15693 status collapsed
15694
15695 \begin_layout Plain Layout
15696 class=`layoutname_item'
15697 \end_layout
15698
15699 \end_inset
15700
15701
15702 \begin_inset Quotes erd
15703 \end_inset
15704
15705 .
15706 \end_layout
15707
15708 \begin_layout Description
15709 \begin_inset Flex CharStyle:Code
15710 status collapsed
15711
15712 \begin_layout Plain Layout
15713 HTMLLabel
15714 \end_layout
15715
15716 \end_inset
15717
15718  [
15719 \begin_inset Flex CharStyle:Code
15720 status collapsed
15721
15722 \begin_layout Plain Layout
15723 string
15724 \end_layout
15725
15726 \end_inset
15727
15728 ] The tag to be used for paragraph and item labels, replacing
15729 \begin_inset Flex CharStyle:Code
15730 status collapsed
15731
15732 \begin_layout Plain Layout
15733 labeltag
15734 \end_layout
15735
15736 \end_inset
15737
15738  in the examples above.
15739  Defaults to
15740 \begin_inset Flex CharStyle:Code
15741 status collapsed
15742
15743 \begin_layout Plain Layout
15744 span
15745 \end_layout
15746
15747 \end_inset
15748
15749 .
15750 \end_layout
15751
15752 \begin_layout Description
15753 \begin_inset Flex CharStyle:Code
15754 status collapsed
15755
15756 \begin_layout Plain Layout
15757 HTMLLabelAttr
15758 \end_layout
15759
15760 \end_inset
15761
15762  [
15763 \begin_inset Flex CharStyle:Code
15764 status collapsed
15765
15766 \begin_layout Plain Layout
15767 string
15768 \end_layout
15769
15770 \end_inset
15771
15772 ] Attributes for the label tag.
15773  Defaults to
15774 \begin_inset Quotes eld
15775 \end_inset
15776
15777
15778 \begin_inset Flex CharStyle:Code
15779 status collapsed
15780
15781 \begin_layout Plain Layout
15782 class=`layoutname_label'
15783 \end_layout
15784
15785 \end_inset
15786
15787
15788 \begin_inset Quotes erd
15789 \end_inset
15790
15791 .
15792 \end_layout
15793
15794 \begin_layout Description
15795 \begin_inset Flex CharStyle:Code
15796 status collapsed
15797
15798 \begin_layout Plain Layout
15799 HTMLLabelFirst
15800 \end_layout
15801
15802 \end_inset
15803
15804  [
15805 \begin_inset Flex CharStyle:Code
15806 status collapsed
15807
15808 \begin_layout Plain Layout
15809 0,1
15810 \end_layout
15811
15812 \end_inset
15813
15814 ] Meaningful only for list-like environments, this tag controls whether
15815  the label tag is output before or inside the item tag.
15816  This is used, for example, in the description environment, where we want
15817  `
15818 \begin_inset Flex CharStyle:Code
15819 status collapsed
15820
15821 \begin_layout Plain Layout
15822 <dt>\SpecialChar \ldots{}
15823 </dt><dd>\SpecialChar \ldots{}
15824 </dd>
15825 \end_layout
15826
15827 \end_inset
15828
15829 .
15830  Default is
15831 \begin_inset Flex CharStyle:Code
15832 status collapsed
15833
15834 \begin_layout Plain Layout
15835 0
15836 \end_layout
15837
15838 \end_inset
15839
15840 : The label tag is output inside the item tag.
15841 \end_layout
15842
15843 \begin_layout Description
15844 \begin_inset Flex CharStyle:Code
15845 status collapsed
15846
15847 \begin_layout Plain Layout
15848 HTMLPreamble
15849 \end_layout
15850
15851 \end_inset
15852
15853  Information to be output in the
15854 \begin_inset Flex CharStyle:Code
15855 status collapsed
15856
15857 \begin_layout Plain Layout
15858 <head>
15859 \end_layout
15860
15861 \end_inset
15862
15863  section when this style is used.
15864  This might, for example, be used to include a
15865 \begin_inset Flex CharStyle:Code
15866 status collapsed
15867
15868 \begin_layout Plain Layout
15869 <script>
15870 \end_layout
15871
15872 \end_inset
15873
15874  block defining an
15875 \begin_inset Flex CharStyle:Code
15876 status collapsed
15877
15878 \begin_layout Plain Layout
15879 onclick
15880 \end_layout
15881
15882 \end_inset
15883
15884  handler.
15885 \end_layout
15886
15887 \begin_layout Description
15888 \begin_inset Flex CharStyle:Code
15889 status collapsed
15890
15891 \begin_layout Plain Layout
15892 HTMLStyle
15893 \end_layout
15894
15895 \end_inset
15896
15897  CSS style information to be included when this style is used.
15898  Note that this will automatically be wrapped in a layout-generated
15899 \begin_inset Flex CharStyle:Code
15900 status collapsed
15901
15902 \begin_layout Plain Layout
15903 <style>
15904 \end_layout
15905
15906 \end_inset
15907
15908  block, so only the CSS itself need be included.
15909 \end_layout
15910
15911 \begin_layout Description
15912 \begin_inset Flex CharStyle:Code
15913 status collapsed
15914
15915 \begin_layout Plain Layout
15916 HTMLTag
15917 \end_layout
15918
15919 \end_inset
15920
15921  [
15922 \begin_inset Flex CharStyle:Code
15923 status collapsed
15924
15925 \begin_layout Plain Layout
15926 string
15927 \end_layout
15928
15929 \end_inset
15930
15931 ] The tag to be used for the main label, replacing
15932 \begin_inset Flex CharStyle:Code
15933 status collapsed
15934
15935 \begin_layout Plain Layout
15936 tag
15937 \end_layout
15938
15939 \end_inset
15940
15941  in the examples above.
15942  Defaults to
15943 \begin_inset Flex CharStyle:Code
15944 status collapsed
15945
15946 \begin_layout Plain Layout
15947 div
15948 \end_layout
15949
15950 \end_inset
15951
15952 .
15953 \end_layout
15954
15955 \begin_layout Subsection
15956 InsetLayout XHTML
15957 \end_layout
15958
15959 \begin_layout Standard
15960 The XHTML output of insets can also be controlled by information in layout
15961  files.
15962 \begin_inset Foot
15963 status collapsed
15964
15965 \begin_layout Plain Layout
15966 At present, this is true only for
15967 \begin_inset Quotes eld
15968 \end_inset
15969
15970 text
15971 \begin_inset Quotes erd
15972 \end_inset
15973
15974  insets (insets you can type into) and is not true for
15975 \begin_inset Quotes eld
15976 \end_inset
15977
15978 command
15979 \begin_inset Quotes erd
15980 \end_inset
15981
15982  insets (insets that are associated with dialog boxes).
15983 \end_layout
15984
15985 \end_inset
15986
15987  Here, too, LyX tries to provide sensible defaults, and it constructs default
15988  CSS style rules.
15989  But everything can be customized.
15990 \end_layout
15991
15992 \begin_layout Standard
15993 The XHTML LyX outputs for an inset has the following form:
15994 \end_layout
15995
15996 \begin_layout LyX-Code
15997 <tag attr=
15998 \begin_inset Quotes erd
15999 \end_inset
16000
16001 value
16002 \begin_inset Quotes erd
16003 \end_inset
16004
16005 >
16006 \end_layout
16007
16008 \begin_layout LyX-Code
16009 <labeltag>Label</labeltag>
16010 \end_layout
16011
16012 \begin_layout LyX-Code
16013 <innertag attr=
16014 \begin_inset Quotes erd
16015 \end_inset
16016
16017 value
16018 \begin_inset Quotes erd
16019 \end_inset
16020
16021 >Contents of the inset.</innertag>
16022 \end_layout
16023
16024 \begin_layout LyX-Code
16025 </tag>
16026 \end_layout
16027
16028 \begin_layout Standard
16029 If the inset permits multiple paragraphs---that is, if
16030 \begin_inset Flex CharStyle:Code
16031 status collapsed
16032
16033 \begin_layout Plain Layout
16034 MultiPar
16035 \end_layout
16036
16037 \end_inset
16038
16039  is true---then the contents of the inset will itself be output as paragraphs
16040  formatted according to the styles used for those paragraphs (standard,
16041  quote, and the like).
16042  The label tag is of course omitted if the paragraph does not have a label
16043  and, at present, is always
16044 \begin_inset Flex CharStyle:Code
16045 status collapsed
16046
16047 \begin_layout Plain Layout
16048 span
16049 \end_layout
16050
16051 \end_inset
16052
16053 .
16054  The inner tag is optional and, by default, does not appear.
16055 \end_layout
16056
16057 \begin_layout Standard
16058 The specific tags and attributes output for each inset can be controlled
16059  by means of the following layout tags.
16060 \end_layout
16061
16062 \begin_layout Description
16063 \begin_inset Flex CharStyle:Code
16064 status collapsed
16065
16066 \begin_layout Plain Layout
16067 HTMLAttr
16068 \end_layout
16069
16070 \end_inset
16071
16072  [
16073 \begin_inset Flex CharStyle:Code
16074 status collapsed
16075
16076 \begin_layout Plain Layout
16077 string
16078 \end_layout
16079
16080 \end_inset
16081
16082 ] Specifies attribute information to be output with the main tag.
16083  For example,
16084 \begin_inset Quotes eld
16085 \end_inset
16086
16087
16088 \begin_inset Flex CharStyle:Code
16089 status collapsed
16090
16091 \begin_layout Plain Layout
16092 class=`myinset' onclick=`\SpecialChar \ldots{}
16093 '
16094 \end_layout
16095
16096 \end_inset
16097
16098
16099 \begin_inset Quotes erd
16100 \end_inset
16101
16102 .
16103  By default, LyX will output
16104 \begin_inset Quotes eld
16105 \end_inset
16106
16107
16108 \begin_inset Flex CharStyle:Code
16109 status collapsed
16110
16111 \begin_layout Plain Layout
16112 class=`insetname'
16113 \end_layout
16114
16115 \end_inset
16116
16117
16118 \begin_inset Quotes erd
16119 \end_inset
16120
16121 , where
16122 \begin_inset Flex CharStyle:Code
16123 status collapsed
16124
16125 \begin_layout Plain Layout
16126 insetname
16127 \end_layout
16128
16129 \end_inset
16130
16131  is the LyX name of the inset, made lowercase and with non-alphanumeric
16132  characters converted to underscores, for example: footnote.
16133 \end_layout
16134
16135 \begin_layout Description
16136 \begin_inset Flex CharStyle:Code
16137 status collapsed
16138
16139 \begin_layout Plain Layout
16140 HTMLForceCSS
16141 \end_layout
16142
16143 \end_inset
16144
16145  [
16146 \begin_inset Flex CharStyle:Code
16147 status collapsed
16148
16149 \begin_layout Plain Layout
16150
16151 \emph on
16152 0
16153 \emph default
16154 ,1
16155 \end_layout
16156
16157 \end_inset
16158
16159 ] Whether to output the default CSS information LyX generates for this layout,
16160  even if additional information is explicitly provided via
16161 \begin_inset Flex CharStyle:Code
16162 status collapsed
16163
16164 \begin_layout Plain Layout
16165 HTMLStyle
16166 \end_layout
16167
16168 \end_inset
16169
16170 .
16171  Setting this to
16172 \begin_inset Flex CharStyle:Code
16173 status collapsed
16174
16175 \begin_layout Plain Layout
16176 1
16177 \end_layout
16178
16179 \end_inset
16180
16181  allows you to alter or augment the generated CSS, rather than to override
16182  it completely.
16183  Default is 0.
16184 \end_layout
16185
16186 \begin_layout Description
16187 \begin_inset Flex CharStyle:Code
16188 status collapsed
16189
16190 \begin_layout Plain Layout
16191 HTMLInnerAttr
16192 \end_layout
16193
16194 \end_inset
16195
16196  [
16197 \begin_inset Flex CharStyle:Code
16198 status collapsed
16199
16200 \begin_layout Plain Layout
16201 string
16202 \end_layout
16203
16204 \end_inset
16205
16206 ] Attributes for the inner tag.
16207  Defaults to
16208 \begin_inset Quotes eld
16209 \end_inset
16210
16211
16212 \begin_inset Flex CharStyle:Code
16213 status collapsed
16214
16215 \begin_layout Plain Layout
16216 class=`insetname_inner'
16217 \end_layout
16218
16219 \end_inset
16220
16221
16222 \begin_inset Quotes erd
16223 \end_inset
16224
16225 .
16226 \end_layout
16227
16228 \begin_layout Description
16229 \begin_inset Flex CharStyle:Code
16230 status collapsed
16231
16232 \begin_layout Plain Layout
16233 HTMLInnerTag
16234 \end_layout
16235
16236 \end_inset
16237
16238  [
16239 \begin_inset Flex CharStyle:Code
16240 status collapsed
16241
16242 \begin_layout Plain Layout
16243 string
16244 \end_layout
16245
16246 \end_inset
16247
16248 ] The inner tag, replacing
16249 \begin_inset Flex CharStyle:Code
16250 status collapsed
16251
16252 \begin_layout Plain Layout
16253 innertag
16254 \end_layout
16255
16256 \end_inset
16257
16258  in the examples above.
16259  By default, there is none.
16260 \end_layout
16261
16262 \begin_layout Description
16263 \begin_inset Flex CharStyle:Code
16264 status collapsed
16265
16266 \begin_layout Plain Layout
16267 HTMLIsBlock
16268 \end_layout
16269
16270 \end_inset
16271
16272  [
16273 \begin_inset Flex CharStyle:Code
16274 status collapsed
16275
16276 \begin_layout Plain Layout
16277 0,
16278 \emph on
16279 1
16280 \end_layout
16281
16282 \end_inset
16283
16284 ] Whether this inset represents a standalone block of text (such as a footnote)
16285  or instead represents material that is included in the surrounding text
16286  (such as a branch).
16287  Defaults to 1.
16288 \end_layout
16289
16290 \begin_layout Description
16291 \begin_inset Flex CharStyle:Code
16292 status collapsed
16293
16294 \begin_layout Plain Layout
16295 HTMLLabel
16296 \end_layout
16297
16298 \end_inset
16299
16300  [
16301 \begin_inset Flex CharStyle:Code
16302 status collapsed
16303
16304 \begin_layout Plain Layout
16305 string
16306 \end_layout
16307
16308 \end_inset
16309
16310 ] A label for this inset, possibly including a reference to a counter.
16311  For example, for footnote, it might be:
16312 \begin_inset Flex CharStyle:Code
16313 status collapsed
16314
16315 \begin_layout Plain Layout
16316
16317 \backslash
16318 arabic{footnote}
16319 \end_layout
16320
16321 \end_inset
16322
16323 .
16324  This is optional, and there is no default.
16325 \end_layout
16326
16327 \begin_layout Description
16328 \begin_inset Flex CharStyle:Code
16329 status collapsed
16330
16331 \begin_layout Plain Layout
16332 HTMLPreamble
16333 \end_layout
16334
16335 \end_inset
16336
16337  Information to be output in the
16338 \begin_inset Flex CharStyle:Code
16339 status collapsed
16340
16341 \begin_layout Plain Layout
16342 <head>
16343 \end_layout
16344
16345 \end_inset
16346
16347  section when this style is used.
16348  This might, for example, be used to include a
16349 \begin_inset Flex CharStyle:Code
16350 status collapsed
16351
16352 \begin_layout Plain Layout
16353 <script>
16354 \end_layout
16355
16356 \end_inset
16357
16358  block defining an
16359 \begin_inset Flex CharStyle:Code
16360 status collapsed
16361
16362 \begin_layout Plain Layout
16363 onclick
16364 \end_layout
16365
16366 \end_inset
16367
16368  handler.
16369 \end_layout
16370
16371 \begin_layout Description
16372 \begin_inset Flex CharStyle:Code
16373 status collapsed
16374
16375 \begin_layout Plain Layout
16376 HTMLStyle
16377 \end_layout
16378
16379 \end_inset
16380
16381  CSS style information to be included when this style is used.
16382  Note that this will automatically be wrapped in a layout-generated
16383 \begin_inset Flex CharStyle:Code
16384 status collapsed
16385
16386 \begin_layout Plain Layout
16387 <style>
16388 \end_layout
16389
16390 \end_inset
16391
16392  block, so only the CSS itself need be included.
16393 \end_layout
16394
16395 \begin_layout Description
16396 \begin_inset Flex CharStyle:Code
16397 status collapsed
16398
16399 \begin_layout Plain Layout
16400 HTMLTag
16401 \end_layout
16402
16403 \end_inset
16404
16405  [
16406 \begin_inset Flex CharStyle:Code
16407 status collapsed
16408
16409 \begin_layout Plain Layout
16410 string
16411 \end_layout
16412
16413 \end_inset
16414
16415 ] The tag to be used for the main label, replacing
16416 \begin_inset Flex CharStyle:Code
16417 status collapsed
16418
16419 \begin_layout Plain Layout
16420 tag
16421 \end_layout
16422
16423 \end_inset
16424
16425  in the examples above.
16426  The default depends upon the setting of
16427 \begin_inset Flex CharStyle:Code
16428 status collapsed
16429
16430 \begin_layout Plain Layout
16431 MultiPar
16432 \end_layout
16433
16434 \end_inset
16435
16436 : If
16437 \begin_inset Flex CharStyle:Code
16438 status collapsed
16439
16440 \begin_layout Plain Layout
16441 MultiPar
16442 \end_layout
16443
16444 \end_inset
16445
16446  is true, the default is
16447 \begin_inset Flex CharStyle:Code
16448 status collapsed
16449
16450 \begin_layout Plain Layout
16451 div
16452 \end_layout
16453
16454 \end_inset
16455
16456 ; if it is false, the default is
16457 \begin_inset Flex CharStyle:Code
16458 status collapsed
16459
16460 \begin_layout Plain Layout
16461 span
16462 \end_layout
16463
16464 \end_inset
16465
16466 .
16467 \end_layout
16468
16469 \begin_layout Subsection
16470 Float XHTML
16471 \end_layout
16472
16473 \begin_layout Standard
16474 The XHTML output for floats too can be controlled by layout information.
16475  The output has the following form:
16476 \end_layout
16477
16478 \begin_layout LyX-Code
16479 <tag attr=
16480 \begin_inset Quotes erd
16481 \end_inset
16482
16483 value
16484 \begin_inset Quotes erd
16485 \end_inset
16486
16487 >
16488 \end_layout
16489
16490 \begin_layout LyX-Code
16491 Contents of the float.
16492 \end_layout
16493
16494 \begin_layout LyX-Code
16495 </tag>
16496 \end_layout
16497
16498 \begin_layout Standard
16499 The caption, if there is one, is a separate inset and will be output as
16500  such.
16501  Its appearance can be controlled via the InsetLayout for caption insets.
16502
16503 \end_layout
16504
16505 \begin_layout Description
16506 \begin_inset Flex CharStyle:Code
16507 status collapsed
16508
16509 \begin_layout Plain Layout
16510 HTMLAttr
16511 \end_layout
16512
16513 \end_inset
16514
16515  [
16516 \begin_inset Flex CharStyle:Code
16517 status collapsed
16518
16519 \begin_layout Plain Layout
16520 string
16521 \end_layout
16522
16523 \end_inset
16524
16525 ] Specifies attribute information to be output with the main tag.
16526  For example,
16527 \begin_inset Quotes eld
16528 \end_inset
16529
16530
16531 \begin_inset Flex CharStyle:Code
16532 status collapsed
16533
16534 \begin_layout Plain Layout
16535 class=`myfloat' onclick=`\SpecialChar \ldots{}
16536 '
16537 \end_layout
16538
16539 \end_inset
16540
16541
16542 \begin_inset Quotes erd
16543 \end_inset
16544
16545 .
16546  By default, LyX will output
16547 \begin_inset Quotes eld
16548 \end_inset
16549
16550
16551 \begin_inset Flex CharStyle:Code
16552 status collapsed
16553
16554 \begin_layout Plain Layout
16555 class=`float float-floattype'
16556 \end_layout
16557
16558 \end_inset
16559
16560
16561 \begin_inset Quotes erd
16562 \end_inset
16563
16564 , where
16565 \begin_inset Flex CharStyle:Code
16566 status collapsed
16567
16568 \begin_layout Plain Layout
16569 floattype
16570 \end_layout
16571
16572 \end_inset
16573
16574  is LyX's name for this type of float, as determined by the float delcaration
16575  (see
16576 \begin_inset CommandInset ref
16577 LatexCommand ref
16578 reference "sub:Floats"
16579
16580 \end_inset
16581
16582 ), though made lowercase and with non-alphanumeric characters converted
16583  to underscores, for example: float-table.
16584 \end_layout
16585
16586 \begin_layout Description
16587 \begin_inset Flex CharStyle:Code
16588 status collapsed
16589
16590 \begin_layout Plain Layout
16591 HTMLStyle
16592 \end_layout
16593
16594 \end_inset
16595
16596  CSS style information to be included when this float is used.
16597  Note that this will automatically be wrapped in a layout-generated
16598 \begin_inset Flex CharStyle:Code
16599 status collapsed
16600
16601 \begin_layout Plain Layout
16602 <style>
16603 \end_layout
16604
16605 \end_inset
16606
16607  block, so only the CSS itself need be included.
16608 \end_layout
16609
16610 \begin_layout Description
16611 \begin_inset Flex CharStyle:Code
16612 status collapsed
16613
16614 \begin_layout Plain Layout
16615 HTMLTag
16616 \end_layout
16617
16618 \end_inset
16619
16620  [
16621 \begin_inset Flex CharStyle:Code
16622 status collapsed
16623
16624 \begin_layout Plain Layout
16625 string
16626 \end_layout
16627
16628 \end_inset
16629
16630 ] The tag to be used for this float, replacing
16631 \begin_inset Quotes eld
16632 \end_inset
16633
16634
16635 \begin_inset Flex CharStyle:Code
16636 status collapsed
16637
16638 \begin_layout Plain Layout
16639 tag
16640 \end_layout
16641
16642 \end_inset
16643
16644
16645 \begin_inset Quotes erd
16646 \end_inset
16647
16648  in the example above.
16649  The default is
16650 \begin_inset Flex CharStyle:Code
16651 status collapsed
16652
16653 \begin_layout Plain Layout
16654 div
16655 \end_layout
16656
16657 \end_inset
16658
16659  and will rarely need changing.
16660 \end_layout
16661
16662 \begin_layout Subsection
16663 LyX-generated CSS
16664 \end_layout
16665
16666 \begin_layout Standard
16667 We have several times mentioned that LyX will generate default CSS style
16668  rules for both insets and paragraph styles, based upon the other layout
16669  information that is provided.
16670  In this section, we shall say a word about which layout information LyX
16671  uses and how.
16672 \end_layout
16673
16674 \begin_layout Standard
16675 At present, LyX auto-generates CSS only for font information, making use
16676  of the
16677 \begin_inset Flex CharStyle:Code
16678 status collapsed
16679
16680 \begin_layout Plain Layout
16681 Family
16682 \end_layout
16683
16684 \end_inset
16685
16686 ,
16687 \begin_inset Flex CharStyle:Code
16688 status collapsed
16689
16690 \begin_layout Plain Layout
16691 Series
16692 \end_layout
16693
16694 \end_inset
16695
16696 ,
16697 \begin_inset Flex CharStyle:Code
16698 status collapsed
16699
16700 \begin_layout Plain Layout
16701 Shape
16702 \end_layout
16703
16704 \end_inset
16705
16706 , and
16707 \begin_inset Flex CharStyle:Code
16708 status collapsed
16709
16710 \begin_layout Plain Layout
16711 Size
16712 \end_layout
16713
16714 \end_inset
16715
16716  specified in the
16717 \begin_inset Flex CharStyle:Code
16718 status collapsed
16719
16720 \begin_layout Plain Layout
16721 Font
16722 \end_layout
16723
16724 \end_inset
16725
16726  declaration.
16727  (See
16728 \begin_inset CommandInset ref
16729 LatexCommand ref
16730 reference "sub:Font-description"
16731
16732 \end_inset
16733
16734 .) The translation is mostly straightforward and obvious.
16735  For example,
16736 \begin_inset Quotes eld
16737 \end_inset
16738
16739
16740 \begin_inset Flex CharStyle:Code
16741 status collapsed
16742
16743 \begin_layout Plain Layout
16744 Family Sans
16745 \end_layout
16746
16747 \end_inset
16748
16749
16750 \begin_inset Quotes erd
16751 \end_inset
16752
16753  becomes
16754 \begin_inset Quotes eld
16755 \end_inset
16756
16757
16758 \begin_inset Flex CharStyle:Code
16759 status collapsed
16760
16761 \begin_layout Plain Layout
16762 font-family: sans-serif;
16763 \end_layout
16764
16765 \end_inset
16766
16767
16768 \begin_inset Quotes erd
16769 \end_inset
16770
16771 .
16772  The correspondence of LyX sizes and CSS sizes is a little less obvious
16773  but nonetheless intuitive.
16774  See the
16775 \begin_inset Flex CharStyle:Code
16776 status collapsed
16777
16778 \begin_layout Plain Layout
16779 getSizeCSS()
16780 \end_layout
16781
16782 \end_inset
16783
16784  function in
16785 \begin_inset Flex URL
16786 status collapsed
16787
16788 \begin_layout Plain Layout
16789
16790 src/FontInfo.cpp
16791 \end_layout
16792
16793 \end_inset
16794
16795  for the details.
16796
16797 \end_layout
16798
16799 \begin_layout Chapter
16800 Including External Material
16801 \end_layout
16802
16803 \begin_layout Standard
16804 \begin_inset Box Shadowbox
16805 position "t"
16806 hor_pos "c"
16807 has_inner_box 1
16808 inner_pos "t"
16809 use_parbox 0
16810 width "100col%"
16811 special "none"
16812 height "1in"
16813 height_special "totalheight"
16814 status open
16815
16816 \begin_layout Plain Layout
16817 WARNING: This portion of the documentation has not been updated for some
16818  time.
16819  We certainly hope that it is still accurate, but there are no guarantees.
16820 \end_layout
16821
16822 \end_inset
16823
16824
16825 \end_layout
16826
16827 \begin_layout Standard
16828 The use of material from sources external to LyX is covered in detail in
16829  the
16830 \emph on
16831 Embedded Objects
16832 \emph default
16833  manual.
16834  This part of the manual covers what needs to happen behind the scenes for
16835  new sorts of material to be included.
16836 \end_layout
16837
16838 \begin_layout Section
16839 How does it work?
16840 \end_layout
16841
16842 \begin_layout Standard
16843 The external material feature is based on the concept of a
16844 \emph on
16845 template
16846 \emph default
16847 .
16848  A template is a specification of how LyX should interface with a certain
16849  kind of material.
16850  As bundled, LyX comes with predefined templates for Xfig figures, various
16851  raster format images, chess diagrams, and LilyPond music notation.
16852  You can check the actual list by using the menu
16853 \begin_inset Flex CharStyle:MenuItem
16854 status collapsed
16855
16856 \begin_layout Plain Layout
16857 Insert\SpecialChar \menuseparator
16858 File\SpecialChar \menuseparator
16859 External Material
16860 \end_layout
16861
16862 \end_inset
16863
16864 .
16865  Furthermore, it is possible to roll your own template to support a specific
16866  kind of material.
16867  Later we'll describe in more detail what is involved, and hopefully you
16868  will submit all the templates you create so we can include them in a later
16869  LyX version.
16870 \end_layout
16871
16872 \begin_layout Standard
16873 Another basic idea of the external material feature is to distinguish between
16874  the original file that serves as a base for final material and the produced
16875  file that is included in your exported or printed document.
16876  For example, consider the case of a figure produced with
16877 \begin_inset Flex CharStyle:Code
16878 status collapsed
16879
16880 \begin_layout Plain Layout
16881 Xfig
16882 \end_layout
16883
16884 \end_inset
16885
16886 .
16887  The Xfig application itself works on an original file with the
16888 \begin_inset Flex CharStyle:Code
16889 status collapsed
16890
16891 \begin_layout Plain Layout
16892 .fig
16893 \end_layout
16894
16895 \end_inset
16896
16897  extension.
16898  Within Xfig, you create and change your figure, and when you are done,
16899  you save the
16900 \begin_inset Flex CharStyle:Code
16901 status collapsed
16902
16903 \begin_layout Plain Layout
16904 fig
16905 \end_layout
16906
16907 \end_inset
16908
16909 -file.
16910  When you want to include the figure in your document, you invoke
16911 \begin_inset Flex CharStyle:Code
16912 status collapsed
16913
16914 \begin_layout Plain Layout
16915 transfig
16916 \end_layout
16917
16918 \end_inset
16919
16920  in order to create a PostScript file that can readily be included in your
16921  LaTeX file.
16922  In this case, the
16923 \begin_inset Flex CharStyle:Code
16924 status collapsed
16925
16926 \begin_layout Plain Layout
16927 .fig
16928 \end_layout
16929
16930 \end_inset
16931
16932  file is the original file, and the PostScript file is the produced file.
16933 \end_layout
16934
16935 \begin_layout Standard
16936 This distinction is important in order to allow updating of the material
16937  while you are in the process of writing the document.
16938  Furthermore, it provides us with the flexibility that is needed to support
16939  multiple export formats.
16940  For instance, in the case of a plain text file, it is not exactly an award-winn
16941 ing idea to include the figure as raw PostScript.
16942  Instead, you'd either prefer to just include a reference to the figure
16943  or try to invoke some graphics to ASCII converter to make the final result
16944  look similar to the real graphics.
16945  The external material management allows you to do this, because it is parametri
16946 zed on the different export formats that LyX supports.
16947 \end_layout
16948
16949 \begin_layout Standard
16950 Besides supporting the production of different products according to the
16951  exported format, it supports tight integration with editing and viewing
16952  applications.
16953  In the case of an Xfig figure, you are able to invoke Xfig on the original
16954  file with a single click from within the external material dialog in LyX,
16955  and also preview the produced PostScript file with Ghostview with another
16956  click.
16957  No more fiddling around with the command line and/or file browsers to locate
16958  and manipulate the original or produced files.
16959  In this way, you are finally able to take full advantage of the many different
16960  applications that are relevant to use when you write your documents, and
16961  ultimately be more productive.
16962 \end_layout
16963
16964 \begin_layout Section
16965 The external template configuration file
16966 \end_layout
16967
16968 \begin_layout Standard
16969 It is relatively easy to add custom external template definitions to LyX.
16970  However, be aware that doing this in an careless manner most probably
16971 \emph on
16972 will
16973 \emph default
16974  introduce an easily exploitable security hole.
16975  So before you do this, please read the discussion about security in section
16976
16977 \begin_inset CommandInset ref
16978 LatexCommand ref
16979 reference "sec:Security-discussion"
16980
16981 \end_inset
16982
16983 .
16984 \end_layout
16985
16986 \begin_layout Standard
16987 Having said that, we encourage you to submit any interesting templates that
16988  you create.
16989
16990 \end_layout
16991
16992 \begin_layout Standard
16993 The external templates are defined in the
16994 \begin_inset Flex CharStyle:Code
16995 status collapsed
16996
16997 \begin_layout Plain Layout
16998 LyXDir/lib/external_templates
16999 \end_layout
17000
17001 \end_inset
17002
17003  file.
17004  You can place your own version in
17005 \begin_inset Flex CharStyle:Code
17006 status collapsed
17007
17008 \begin_layout Plain Layout
17009 UserDir/external_templates
17010 \end_layout
17011
17012 \end_inset
17013
17014 .
17015 \end_layout
17016
17017 \begin_layout Standard
17018 A typical template looks like this:
17019 \end_layout
17020
17021 \begin_layout LyX-Code
17022 Template XFig
17023 \end_layout
17024
17025 \begin_layout LyX-Code
17026 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
17027 \end_layout
17028
17029 \begin_layout LyX-Code
17030 HelpText
17031 \end_layout
17032
17033 \begin_layout LyX-Code
17034 An XFig figure.
17035 \end_layout
17036
17037 \begin_layout LyX-Code
17038 HelpTextEnd
17039 \end_layout
17040
17041 \begin_layout LyX-Code
17042 InputFormat fig
17043 \end_layout
17044
17045 \begin_layout LyX-Code
17046 FileFilter "*.fig"
17047 \end_layout
17048
17049 \begin_layout LyX-Code
17050 AutomaticProduction true
17051 \end_layout
17052
17053 \begin_layout LyX-Code
17054 Transform Rotate
17055 \end_layout
17056
17057 \begin_layout LyX-Code
17058 Transform Resize
17059 \end_layout
17060
17061 \begin_layout LyX-Code
17062 Format LaTeX
17063 \end_layout
17064
17065 \begin_layout LyX-Code
17066 TransformCommand Rotate RotationLatexCommand
17067 \end_layout
17068
17069 \begin_layout LyX-Code
17070 TransformCommand Resize ResizeLatexCommand
17071 \end_layout
17072
17073 \begin_layout LyX-Code
17074 Product "$$RotateFront$$ResizeFront
17075 \end_layout
17076
17077 \begin_layout LyX-Code
17078
17079 \backslash
17080
17081 \backslash
17082 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
17083 \end_layout
17084
17085 \begin_layout LyX-Code
17086          $$ResizeBack$$RotateBack"
17087 \end_layout
17088
17089 \begin_layout LyX-Code
17090 UpdateFormat pstex
17091 \end_layout
17092
17093 \begin_layout LyX-Code
17094 UpdateResult "$$AbsPath$$Basename.pstex_t"
17095 \end_layout
17096
17097 \begin_layout LyX-Code
17098 Requirement "graphicx"
17099 \end_layout
17100
17101 \begin_layout LyX-Code
17102 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
17103 \end_layout
17104
17105 \begin_layout LyX-Code
17106 ReferencedFile latex "$$AbsPath$$Basename.eps"
17107 \end_layout
17108
17109 \begin_layout LyX-Code
17110 ReferencedFile dvi "$$AbsPath$$Basename.eps"
17111 \end_layout
17112
17113 \begin_layout LyX-Code
17114 FormatEnd
17115 \end_layout
17116
17117 \begin_layout LyX-Code
17118 Format PDFLaTeX
17119 \end_layout
17120
17121 \begin_layout LyX-Code
17122 TransformCommand Rotate RotationLatexCommand
17123 \end_layout
17124
17125 \begin_layout LyX-Code
17126 TransformCommand Resize ResizeLatexCommand
17127 \end_layout
17128
17129 \begin_layout LyX-Code
17130 Product "$$RotateFront$$ResizeFront
17131 \end_layout
17132
17133 \begin_layout LyX-Code
17134
17135 \backslash
17136
17137 \backslash
17138 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
17139 \end_layout
17140
17141 \begin_layout LyX-Code
17142          $$ResizeBack$$RotateBack"
17143 \end_layout
17144
17145 \begin_layout LyX-Code
17146 UpdateFormat pdftex
17147 \end_layout
17148
17149 \begin_layout LyX-Code
17150 UpdateResult "$$AbsPath$$Basename.pdftex_t"
17151 \end_layout
17152
17153 \begin_layout LyX-Code
17154 Requirement "graphicx"
17155 \end_layout
17156
17157 \begin_layout LyX-Code
17158 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
17159 \end_layout
17160
17161 \begin_layout LyX-Code
17162 ReferencedFile latex "$$AbsPath$$Basename.pdf"
17163 \end_layout
17164
17165 \begin_layout LyX-Code
17166 FormatEnd
17167 \end_layout
17168
17169 \begin_layout LyX-Code
17170 Format Ascii
17171 \end_layout
17172
17173 \begin_layout LyX-Code
17174 Product "$$Contents(
17175 \backslash
17176 "$$AbsPath$$Basename.asc
17177 \backslash
17178 ")"
17179 \end_layout
17180
17181 \begin_layout LyX-Code
17182 UpdateFormat asciixfig
17183 \end_layout
17184
17185 \begin_layout LyX-Code
17186 UpdateResult "$$AbsPath$$Basename.asc"
17187 \end_layout
17188
17189 \begin_layout LyX-Code
17190 FormatEnd
17191 \end_layout
17192
17193 \begin_layout LyX-Code
17194 Format DocBook
17195 \end_layout
17196
17197 \begin_layout LyX-Code
17198 Product "<graphic fileref=
17199 \backslash
17200 "$$AbsOrRelPathMaster$$Basename.eps
17201 \backslash
17202 ">
17203 \end_layout
17204
17205 \begin_layout LyX-Code
17206          </graphic>"
17207 \end_layout
17208
17209 \begin_layout LyX-Code
17210 UpdateFormat eps
17211 \end_layout
17212
17213 \begin_layout LyX-Code
17214 UpdateResult "$$AbsPath$$Basename.eps"
17215 \end_layout
17216
17217 \begin_layout LyX-Code
17218 ReferencedFile docbook "$$AbsPath$$Basename.eps"
17219 \end_layout
17220
17221 \begin_layout LyX-Code
17222 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
17223 \end_layout
17224
17225 \begin_layout LyX-Code
17226 FormatEnd
17227 \end_layout
17228
17229 \begin_layout LyX-Code
17230 Product "[XFig: $$FName]"
17231 \end_layout
17232
17233 \begin_layout LyX-Code
17234 FormatEnd
17235 \end_layout
17236
17237 \begin_layout LyX-Code
17238 TemplateEnd
17239 \end_layout
17240
17241 \begin_layout Standard
17242 As you can see, the template is enclosed in
17243 \begin_inset Flex CharStyle:Code
17244 status collapsed
17245
17246 \begin_layout Plain Layout
17247 Template
17248 \end_layout
17249
17250 \end_inset
17251
17252  \SpecialChar \ldots{}
17253
17254 \begin_inset Flex CharStyle:Code
17255 status collapsed
17256
17257 \begin_layout Plain Layout
17258 TemplateEnd
17259 \end_layout
17260
17261 \end_inset
17262
17263 .
17264  It contains a header specifying some general settings and, for each supported
17265  primary document file format, a section
17266 \begin_inset Flex CharStyle:Code
17267 status collapsed
17268
17269 \begin_layout Plain Layout
17270 Format
17271 \end_layout
17272
17273 \end_inset
17274
17275  \SpecialChar \ldots{}
17276
17277 \begin_inset Flex CharStyle:Code
17278 status collapsed
17279
17280 \begin_layout Plain Layout
17281 FormatEnd
17282 \end_layout
17283
17284 \end_inset
17285
17286 .
17287 \end_layout
17288
17289 \begin_layout Subsection
17290 The template header
17291 \end_layout
17292
17293 \begin_layout Description
17294 \begin_inset Flex CharStyle:Code
17295 status collapsed
17296
17297 \begin_layout Plain Layout
17298 AutomaticProduction
17299 \begin_inset space ~
17300 \end_inset
17301
17302 true|false
17303 \end_layout
17304
17305 \end_inset
17306
17307  Whether the file represented by the template must be generated by LyX.
17308  This command must occur exactly once.
17309 \end_layout
17310
17311 \begin_layout Description
17312 \begin_inset Flex CharStyle:Code
17313 status collapsed
17314
17315 \begin_layout Plain Layout
17316 FileFilter
17317 \begin_inset space ~
17318 \end_inset
17319
17320 <pattern>
17321 \end_layout
17322
17323 \end_inset
17324
17325  A glob pattern that is used in the file dialog to filter out the desired
17326  files.
17327  If there is more than one possible file extension (e.
17328 \begin_inset space \thinspace{}
17329 \end_inset
17330
17331 g.
17332 \begin_inset space \space{}
17333 \end_inset
17334
17335 tgif has
17336 \begin_inset Flex CharStyle:Code
17337 status collapsed
17338
17339 \begin_layout Plain Layout
17340 .obj
17341 \end_layout
17342
17343 \end_inset
17344
17345  and
17346 \begin_inset Flex CharStyle:Code
17347 status collapsed
17348
17349 \begin_layout Plain Layout
17350 .tgo
17351 \end_layout
17352
17353 \end_inset
17354
17355 ), use something like
17356 \begin_inset Flex CharStyle:Code
17357 status collapsed
17358
17359 \begin_layout Plain Layout
17360 "*.{obj,tgo}"
17361 \end_layout
17362
17363 \end_inset
17364
17365 .
17366  This command must occur exactly once.
17367 \end_layout
17368
17369 \begin_layout Description
17370 \begin_inset Flex CharStyle:Code
17371 status collapsed
17372
17373 \begin_layout Plain Layout
17374 GuiName
17375 \begin_inset space ~
17376 \end_inset
17377
17378 <guiname>
17379 \end_layout
17380
17381 \end_inset
17382
17383  The text that is displayed on the button.
17384  This command must occur exactly once.
17385 \end_layout
17386
17387 \begin_layout Description
17388 \begin_inset Flex CharStyle:Code
17389 status collapsed
17390
17391 \begin_layout Plain Layout
17392 HelpText
17393 \begin_inset space ~
17394 \end_inset
17395
17396 <text>
17397 \begin_inset space ~
17398 \end_inset
17399
17400 HelpTextEnd
17401 \end_layout
17402
17403 \end_inset
17404
17405  The help text that is used in the External dialog.
17406  Provide enough information to explain to the user just what the template
17407  can provide him with.
17408  This command must occur exactly once.
17409 \end_layout
17410
17411 \begin_layout Description
17412 \begin_inset Flex CharStyle:Code
17413 status collapsed
17414
17415 \begin_layout Plain Layout
17416 InputFormat
17417 \begin_inset space ~
17418 \end_inset
17419
17420 <format>
17421 \end_layout
17422
17423 \end_inset
17424
17425  The file format of the original file.
17426  This must be the name of a format that is known to LyX (see section
17427 \begin_inset CommandInset ref
17428 LatexCommand ref
17429 reference "sec:Formats"
17430
17431 \end_inset
17432
17433 ).
17434  Use
17435 \begin_inset Quotes eld
17436 \end_inset
17437
17438
17439 \begin_inset Flex CharStyle:Code
17440 status collapsed
17441
17442 \begin_layout Plain Layout
17443 *
17444 \end_layout
17445
17446 \end_inset
17447
17448
17449 \begin_inset Quotes erd
17450 \end_inset
17451
17452  if the template can handle original files of more than one format.
17453  LyX will attempt to interrogate the file itself in order to deduce its
17454  format in this case.
17455  This command must occur exactly once.
17456 \end_layout
17457
17458 \begin_layout Description
17459 \begin_inset Flex CharStyle:Code
17460 status collapsed
17461
17462 \begin_layout Plain Layout
17463 Template
17464 \begin_inset space ~
17465 \end_inset
17466
17467 <id>
17468 \end_layout
17469
17470 \end_inset
17471
17472  A unique name for the template.
17473  It must not contain substitution macros (see below).
17474 \end_layout
17475
17476 \begin_layout Description
17477 \begin_inset Flex CharStyle:Code
17478 status collapsed
17479
17480 \begin_layout Plain Layout
17481 Transform
17482 \begin_inset space ~
17483 \end_inset
17484
17485 Rotate|Resize|Clip|Extra
17486 \end_layout
17487
17488 \end_inset
17489
17490  This command specifies which transformations are supported by this template.
17491  It may occur zero or more times.
17492  This command enables the corresponding tabs in the external dialog.
17493  Each
17494 \begin_inset Flex CharStyle:Code
17495 status collapsed
17496
17497 \begin_layout Plain Layout
17498 Transform
17499 \end_layout
17500
17501 \end_inset
17502
17503  command must have either a corresponding
17504 \begin_inset Flex CharStyle:Code
17505 status collapsed
17506
17507 \begin_layout Plain Layout
17508 TransformCommand
17509 \end_layout
17510
17511 \end_inset
17512
17513  or a
17514 \begin_inset Flex CharStyle:Code
17515 status collapsed
17516
17517 \begin_layout Plain Layout
17518 TransformOption
17519 \end_layout
17520
17521 \end_inset
17522
17523  command in the
17524 \begin_inset Flex CharStyle:Code
17525 status collapsed
17526
17527 \begin_layout Plain Layout
17528 Format
17529 \end_layout
17530
17531 \end_inset
17532
17533  section.
17534  Otherwise the transformation will not be supported by that format.
17535 \end_layout
17536
17537 \begin_layout Subsection
17538 The Format section
17539 \end_layout
17540
17541 \begin_layout Description
17542 \begin_inset Flex CharStyle:Code
17543 status collapsed
17544
17545 \begin_layout Plain Layout
17546 Format
17547 \begin_inset space ~
17548 \end_inset
17549
17550 LaTeX|PDFLaTeX|PlainText|DocBook
17551 \end_layout
17552
17553 \end_inset
17554
17555  The primary document file format that this format definition is for.
17556  Not every template has a sensible representation in all document file formats.
17557  Please define nevertheless a
17558 \begin_inset Flex CharStyle:Code
17559 status collapsed
17560
17561 \begin_layout Plain Layout
17562 Format
17563 \end_layout
17564
17565 \end_inset
17566
17567  section for all formats.
17568  Use a dummy text when no representation is available.
17569  Then you can at least see a reference to the external material in the exported
17570  document.
17571 \end_layout
17572
17573 \begin_layout Description
17574 \begin_inset Flex CharStyle:Code
17575 status collapsed
17576
17577 \begin_layout Plain Layout
17578 Option
17579 \begin_inset space ~
17580 \end_inset
17581
17582 <name>
17583 \begin_inset space ~
17584 \end_inset
17585
17586 <value>
17587 \end_layout
17588
17589 \end_inset
17590
17591  This command defines an additional macro
17592 \begin_inset Flex CharStyle:Code
17593 status collapsed
17594
17595 \begin_layout Plain Layout
17596 $$<name>
17597 \end_layout
17598
17599 \end_inset
17600
17601  for substitution in
17602 \begin_inset Flex CharStyle:Code
17603 status collapsed
17604
17605 \begin_layout Plain Layout
17606 Product
17607 \end_layout
17608
17609 \end_inset
17610
17611 .
17612
17613 \begin_inset Flex CharStyle:Code
17614 status collapsed
17615
17616 \begin_layout Plain Layout
17617 <value>
17618 \end_layout
17619
17620 \end_inset
17621
17622  itself may contain substitution macros.
17623  The advantage over using
17624 \begin_inset Flex CharStyle:Code
17625 status collapsed
17626
17627 \begin_layout Plain Layout
17628 <value>
17629 \end_layout
17630
17631 \end_inset
17632
17633  directly in
17634 \begin_inset Flex CharStyle:Code
17635 status collapsed
17636
17637 \begin_layout Plain Layout
17638 Product
17639 \end_layout
17640
17641 \end_inset
17642
17643  is that the substituted value of
17644 \begin_inset Flex CharStyle:Code
17645 status collapsed
17646
17647 \begin_layout Plain Layout
17648 $$<name>
17649 \end_layout
17650
17651 \end_inset
17652
17653  is sanitized so that it is a valid optional argument in the document format.
17654  This command may occur zero or more times.
17655 \end_layout
17656
17657 \begin_layout Description
17658 \begin_inset Flex CharStyle:Code
17659 status collapsed
17660
17661 \begin_layout Plain Layout
17662 Product
17663 \begin_inset space ~
17664 \end_inset
17665
17666 <text>
17667 \end_layout
17668
17669 \end_inset
17670
17671  The text that is inserted in the exported document.
17672  This is actually the most important command and can be quite complex.
17673  This command must occur exactly once.
17674 \end_layout
17675
17676 \begin_layout Description
17677 \begin_inset Flex CharStyle:Code
17678 status collapsed
17679
17680 \begin_layout Plain Layout
17681 Preamble
17682 \begin_inset space ~
17683 \end_inset
17684
17685 <name>
17686 \end_layout
17687
17688 \end_inset
17689
17690  This command specifies a preamble snippet that will be included in the
17691  LaTeX preamble.
17692  It has to be defined using
17693 \begin_inset Flex CharStyle:Code
17694 status collapsed
17695
17696 \begin_layout Plain Layout
17697 PreambleDef
17698 \end_layout
17699
17700 \end_inset
17701
17702  \SpecialChar \ldots{}
17703
17704 \begin_inset Flex CharStyle:Code
17705 status collapsed
17706
17707 \begin_layout Plain Layout
17708 PreambleDefEnd
17709 \end_layout
17710
17711 \end_inset
17712
17713 .
17714  This command may occur zero or more times.
17715 \end_layout
17716
17717 \begin_layout Description
17718 \begin_inset Flex CharStyle:Code
17719 status collapsed
17720
17721 \begin_layout Plain Layout
17722 ReferencedFile
17723 \begin_inset space ~
17724 \end_inset
17725
17726 <format>
17727 \begin_inset space ~
17728 \end_inset
17729
17730 <filename>
17731 \end_layout
17732
17733 \end_inset
17734
17735  This command denotes files that are created by the conversion process and
17736  are needed for a particular export format.
17737  If the filename is relative, it is interpreted relative to the master document.
17738  This command may be given zero or more times.
17739 \end_layout
17740
17741 \begin_layout Description
17742 \begin_inset Flex CharStyle:Code
17743 status collapsed
17744
17745 \begin_layout Plain Layout
17746 Requirement
17747 \begin_inset space ~
17748 \end_inset
17749
17750 <package>
17751 \end_layout
17752
17753 \end_inset
17754
17755  The name of a required LaTeX package.
17756  The package is included via
17757 \begin_inset Flex CharStyle:Code
17758 status collapsed
17759
17760 \begin_layout Plain Layout
17761
17762 \backslash
17763 usepackage{}
17764 \end_layout
17765
17766 \end_inset
17767
17768  in the LaTeX preamble.
17769  This command may occur zero or more times.
17770 \end_layout
17771
17772 \begin_layout Description
17773 \begin_inset Flex CharStyle:Code
17774 status collapsed
17775
17776 \begin_layout Plain Layout
17777 TransformCommand
17778 \begin_inset space ~
17779 \end_inset
17780
17781 Rotate
17782 \begin_inset space ~
17783 \end_inset
17784
17785 RotationLatexCommand
17786 \end_layout
17787
17788 \end_inset
17789
17790  This command specifies that the built in LaTeX command should be used for
17791  rotation.
17792  This command may occur once or not at all.
17793 \end_layout
17794
17795 \begin_layout Description
17796 \begin_inset Flex CharStyle:Code
17797 status collapsed
17798
17799 \begin_layout Plain Layout
17800 TransformCommand
17801 \begin_inset space ~
17802 \end_inset
17803
17804 Resize
17805 \begin_inset space ~
17806 \end_inset
17807
17808 ResizeLatexCommand
17809 \end_layout
17810
17811 \end_inset
17812
17813  This command specifies that the built in LaTeX command should be used for
17814  resizing.
17815  This command may occur once or not at all.
17816 \end_layout
17817
17818 \begin_layout Description
17819 \begin_inset Flex CharStyle:Code
17820 status collapsed
17821
17822 \begin_layout Plain Layout
17823 TransformOption
17824 \begin_inset space ~
17825 \end_inset
17826
17827 Rotate
17828 \begin_inset space ~
17829 \end_inset
17830
17831 RotationLatexOption
17832 \end_layout
17833
17834 \end_inset
17835
17836  This command specifies that rotation is done via an optional argument.
17837  This command may occur once or not at all.
17838 \end_layout
17839
17840 \begin_layout Description
17841 \begin_inset Flex CharStyle:Code
17842 status collapsed
17843
17844 \begin_layout Plain Layout
17845 TransformOption
17846 \begin_inset space ~
17847 \end_inset
17848
17849 Resize
17850 \begin_inset space ~
17851 \end_inset
17852
17853 ResizeLatexOption
17854 \end_layout
17855
17856 \end_inset
17857
17858  This command specifies that resizing is done via an optional argument.
17859  This command may occur once or not at all.
17860 \end_layout
17861
17862 \begin_layout Description
17863 \begin_inset Flex CharStyle:Code
17864 status collapsed
17865
17866 \begin_layout Plain Layout
17867 TransformOption
17868 \begin_inset space ~
17869 \end_inset
17870
17871 Clip
17872 \begin_inset space ~
17873 \end_inset
17874
17875 ClipLatexOption
17876 \end_layout
17877
17878 \end_inset
17879
17880  This command specifies that clipping is done via an optional argument.
17881  This command may occur once or not at all.
17882 \end_layout
17883
17884 \begin_layout Description
17885 \begin_inset Flex CharStyle:Code
17886 status collapsed
17887
17888 \begin_layout Plain Layout
17889 TransformOption
17890 \begin_inset space ~
17891 \end_inset
17892
17893 Extra
17894 \begin_inset space ~
17895 \end_inset
17896
17897 ExtraLatexOption
17898 \end_layout
17899
17900 \end_inset
17901
17902  This command specifies that an extra optional argument is used.
17903  This command may occur once or not at all.
17904 \end_layout
17905
17906 \begin_layout Description
17907 \begin_inset Flex CharStyle:Code
17908 status collapsed
17909
17910 \begin_layout Plain Layout
17911 UpdateFormat
17912 \begin_inset space ~
17913 \end_inset
17914
17915 <format>
17916 \end_layout
17917
17918 \end_inset
17919
17920  The file format of the converted file.
17921  This must be the name of a format that is known to LyX (see the
17922 \begin_inset Flex CharStyle:MenuItem
17923 status collapsed
17924
17925 \begin_layout Plain Layout
17926
17927 \bar under
17928 T
17929 \bar default
17930 ools\SpecialChar \menuseparator
17931
17932 \bar under
17933 P
17934 \bar default
17935 references:Conversion
17936 \end_layout
17937
17938 \end_inset
17939
17940  dialog).
17941  This command must occur exactly once.
17942 \end_layout
17943
17944 \begin_layout Description
17945 \begin_inset Flex CharStyle:Code
17946 status collapsed
17947
17948 \begin_layout Plain Layout
17949 UpdateResult
17950 \begin_inset space ~
17951 \end_inset
17952
17953 <filename>
17954 \end_layout
17955
17956 \end_inset
17957
17958  The file name of the converted file.
17959  The file name must be absolute.
17960  This command must occur exactly once.
17961 \end_layout
17962
17963 \begin_layout Subsection
17964 Preamble definitions
17965 \end_layout
17966
17967 \begin_layout Standard
17968 The external template configuration file may contain additional preamble
17969  definitions enclosed by
17970 \begin_inset Flex CharStyle:Code
17971 status collapsed
17972
17973 \begin_layout Plain Layout
17974 PreambleDef
17975 \end_layout
17976
17977 \end_inset
17978
17979  \SpecialChar \ldots{}
17980
17981 \begin_inset Flex CharStyle:Code
17982 status collapsed
17983
17984 \begin_layout Plain Layout
17985 PreambleDefEnd
17986 \end_layout
17987
17988 \end_inset
17989
17990 .
17991  They can be used by the templates in the
17992 \begin_inset Flex CharStyle:Code
17993 status collapsed
17994
17995 \begin_layout Plain Layout
17996 Format
17997 \end_layout
17998
17999 \end_inset
18000
18001  section.
18002 \end_layout
18003
18004 \begin_layout Section
18005 The substitution mechanism
18006 \end_layout
18007
18008 \begin_layout Standard
18009 When the external material facility invokes an external program, it is done
18010  on the basis of a command defined in the template configuration file.
18011  These commands can contain various macros that are expanded before execution.
18012  Execution always take place in the directory of the containing document.
18013 \end_layout
18014
18015 \begin_layout Standard
18016 Also, whenever external material is to be displayed, the name will be produced
18017  by the substitution mechanism, and most other commands in the template
18018  definition support substitution as well.
18019 \end_layout
18020
18021 \begin_layout Standard
18022 The available macros are the following:
18023 \end_layout
18024
18025 \begin_layout Description
18026 \begin_inset Flex CharStyle:Code
18027 status collapsed
18028
18029 \begin_layout Plain Layout
18030 $$AbsOrRelPathMaster
18031 \end_layout
18032
18033 \end_inset
18034
18035  The file path, absolute or relative to the master LyX document.
18036 \end_layout
18037
18038 \begin_layout Description
18039 \begin_inset Flex CharStyle:Code
18040 status collapsed
18041
18042 \begin_layout Plain Layout
18043 $$AbsOrRelPathParent
18044 \end_layout
18045
18046 \end_inset
18047
18048  The file path, absolute or relative to the LyX document.
18049 \end_layout
18050
18051 \begin_layout Description
18052 \begin_inset Flex CharStyle:Code
18053 status collapsed
18054
18055 \begin_layout Plain Layout
18056 $$AbsPath
18057 \end_layout
18058
18059 \end_inset
18060
18061  The absolute file path.
18062 \end_layout
18063
18064 \begin_layout Description
18065 \begin_inset Flex CharStyle:Code
18066 status collapsed
18067
18068 \begin_layout Plain Layout
18069 $$Basename
18070 \end_layout
18071
18072 \end_inset
18073
18074  The filename without path and without the extension.
18075 \end_layout
18076
18077 \begin_layout Description
18078 \begin_inset Flex CharStyle:Code
18079 status collapsed
18080
18081 \begin_layout Plain Layout
18082 $$Contents(
18083 \begin_inset Quotes eld
18084 \end_inset
18085
18086 filename.ext
18087 \begin_inset Quotes erd
18088 \end_inset
18089
18090 )
18091 \end_layout
18092
18093 \end_inset
18094
18095  This macro will expand to the contents of the file with the name
18096 \begin_inset Flex CharStyle:Code
18097 status collapsed
18098
18099 \begin_layout Plain Layout
18100 filename.ext
18101 \end_layout
18102
18103 \end_inset
18104
18105 .
18106 \end_layout
18107
18108 \begin_layout Description
18109 \begin_inset Flex CharStyle:Code
18110 status collapsed
18111
18112 \begin_layout Plain Layout
18113 $$Extension
18114 \end_layout
18115
18116 \end_inset
18117
18118  The file extension (including the dot).
18119 \end_layout
18120
18121 \begin_layout Description
18122 \begin_inset Flex CharStyle:Code
18123 status collapsed
18124
18125 \begin_layout Plain Layout
18126 $$FName
18127 \end_layout
18128
18129 \end_inset
18130
18131  The filename of the file specified in the external material dialog.
18132  This is either an absolute name, or it is relative to the LyX document.
18133 \end_layout
18134
18135 \begin_layout Description
18136 \begin_inset Flex CharStyle:Code
18137 status collapsed
18138
18139 \begin_layout Plain Layout
18140 $$FPath
18141 \end_layout
18142
18143 \end_inset
18144
18145  The path part of
18146 \begin_inset Flex CharStyle:Code
18147 status collapsed
18148
18149 \begin_layout Plain Layout
18150 $$FName
18151 \end_layout
18152
18153 \end_inset
18154
18155  (absolute name or relative to the LyX document).
18156 \end_layout
18157
18158 \begin_layout Description
18159 \begin_inset Flex CharStyle:Code
18160 status collapsed
18161
18162 \begin_layout Plain Layout
18163 $$RelPathMaster
18164 \end_layout
18165
18166 \end_inset
18167
18168  The file path, relative to the master LyX document.
18169 \end_layout
18170
18171 \begin_layout Description
18172 \begin_inset Flex CharStyle:Code
18173 status collapsed
18174
18175 \begin_layout Plain Layout
18176 $$RelPathParent
18177 \end_layout
18178
18179 \end_inset
18180
18181  The file path, relative to the LyX document.
18182 \end_layout
18183
18184 \begin_layout Description
18185 \begin_inset Flex CharStyle:Code
18186 status collapsed
18187
18188 \begin_layout Plain Layout
18189 $$Sysdir
18190 \end_layout
18191
18192 \end_inset
18193
18194  This macro will expand to the absolute path of the system directory.
18195  This is typically used to point to the various helper scripts that are
18196  bundled with LyX.
18197 \end_layout
18198
18199 \begin_layout Description
18200 \begin_inset Flex CharStyle:Code
18201 status collapsed
18202
18203 \begin_layout Plain Layout
18204 $$Tempname
18205 \end_layout
18206
18207 \end_inset
18208
18209  A name and full path to a temporary file which will be automatically deleted
18210  whenever the containing document is closed, or the external material insertion
18211  deleted.
18212 \end_layout
18213
18214 \begin_layout Standard
18215 All path macros contain a trailing directory separator, so you can construct
18216  e.
18217 \begin_inset space \thinspace{}
18218 \end_inset
18219
18220 g.
18221 \begin_inset space \space{}
18222 \end_inset
18223
18224 the absolute filename with
18225 \begin_inset Flex CharStyle:Code
18226 status collapsed
18227
18228 \begin_layout Plain Layout
18229 $$AbsPath$$Basename$$Extension
18230 \end_layout
18231
18232 \end_inset
18233
18234 .
18235 \end_layout
18236
18237 \begin_layout Standard
18238 The macros above are substituted in all commands unless otherwise noted.
18239  The command
18240 \begin_inset Flex CharStyle:Code
18241 status collapsed
18242
18243 \begin_layout Plain Layout
18244 Product
18245 \end_layout
18246
18247 \end_inset
18248
18249  supports additionally the following substitutions if they are enabled by
18250  the
18251 \begin_inset Flex CharStyle:Code
18252 status collapsed
18253
18254 \begin_layout Plain Layout
18255 Transform
18256 \end_layout
18257
18258 \end_inset
18259
18260  and
18261 \begin_inset Flex CharStyle:Code
18262 status collapsed
18263
18264 \begin_layout Plain Layout
18265 TransformCommand
18266 \end_layout
18267
18268 \end_inset
18269
18270  commands:
18271 \end_layout
18272
18273 \begin_layout Description
18274 \begin_inset Flex CharStyle:Code
18275 status collapsed
18276
18277 \begin_layout Plain Layout
18278 $$ResizeFront
18279 \end_layout
18280
18281 \end_inset
18282
18283  The front part of the resize command.
18284 \end_layout
18285
18286 \begin_layout Description
18287 \begin_inset Flex CharStyle:Code
18288 status collapsed
18289
18290 \begin_layout Plain Layout
18291 $$ResizeBack
18292 \end_layout
18293
18294 \end_inset
18295
18296  The back part of the resize command.
18297 \end_layout
18298
18299 \begin_layout Description
18300 \begin_inset Flex CharStyle:Code
18301 status collapsed
18302
18303 \begin_layout Plain Layout
18304 $$RotateFront
18305 \end_layout
18306
18307 \end_inset
18308
18309  The front part of the rotation command.
18310 \end_layout
18311
18312 \begin_layout Description
18313 \begin_inset Flex CharStyle:Code
18314 status collapsed
18315
18316 \begin_layout Plain Layout
18317 $$RotateBack
18318 \end_layout
18319
18320 \end_inset
18321
18322  The back part of the rotation command.
18323 \end_layout
18324
18325 \begin_layout Standard
18326 The value string of the
18327 \begin_inset Flex CharStyle:Code
18328 status collapsed
18329
18330 \begin_layout Plain Layout
18331 Option
18332 \end_layout
18333
18334 \end_inset
18335
18336  command supports additionally the following substitutions if they are enabled
18337  by the
18338 \begin_inset Flex CharStyle:Code
18339 status collapsed
18340
18341 \begin_layout Plain Layout
18342 Transform
18343 \end_layout
18344
18345 \end_inset
18346
18347  and
18348 \begin_inset Flex CharStyle:Code
18349 status collapsed
18350
18351 \begin_layout Plain Layout
18352 TransformOption
18353 \end_layout
18354
18355 \end_inset
18356
18357  commands:
18358 \end_layout
18359
18360 \begin_layout Description
18361 \begin_inset Flex CharStyle:Code
18362 status collapsed
18363
18364 \begin_layout Plain Layout
18365 $$Clip
18366 \end_layout
18367
18368 \end_inset
18369
18370  The clip option.
18371 \end_layout
18372
18373 \begin_layout Description
18374 \begin_inset Flex CharStyle:Code
18375 status collapsed
18376
18377 \begin_layout Plain Layout
18378 $$Extra
18379 \end_layout
18380
18381 \end_inset
18382
18383  The extra option.
18384 \end_layout
18385
18386 \begin_layout Description
18387 \begin_inset Flex CharStyle:Code
18388 status collapsed
18389
18390 \begin_layout Plain Layout
18391 $$Resize
18392 \end_layout
18393
18394 \end_inset
18395
18396  The resize option.
18397 \end_layout
18398
18399 \begin_layout Description
18400 \begin_inset Flex CharStyle:Code
18401 status collapsed
18402
18403 \begin_layout Plain Layout
18404 $$Rotate
18405 \end_layout
18406
18407 \end_inset
18408
18409  The rotation option.
18410 \end_layout
18411
18412 \begin_layout Standard
18413 You may ask why there are so many path macros.
18414  There are mainly two reasons:
18415 \end_layout
18416
18417 \begin_layout Enumerate
18418 Relative and absolute file names should remain relative or absolute, respectivel
18419 y.
18420  Users may have reasons to prefer either form.
18421  Relative names are useful for portable documents that should work on different
18422  machines, for example.
18423  Absolute names may be required by some programs.
18424 \end_layout
18425
18426 \begin_layout Enumerate
18427 LaTeX treats relative file names differently than LyX and other programs
18428  in nested included files.
18429  For LyX, a relative file name is always relative to the document that contains
18430  the file name.
18431  For LaTeX, it is always relative to the master document.
18432  These two definitions are identical if you have only one document, but
18433  differ if you have a master document that includes part documents.
18434  That means that relative filenames must be transformed when presented to
18435  LaTeX.
18436  Fortunately LyX does this automatically for you if you choose the right
18437  macros.
18438 \end_layout
18439
18440 \begin_layout Standard
18441 So which path macro should be used in new template definitions? The rule
18442  is not difficult:
18443 \end_layout
18444
18445 \begin_layout Itemize
18446 Use
18447 \begin_inset Flex CharStyle:Code
18448 status collapsed
18449
18450 \begin_layout Plain Layout
18451 $$AbsPath
18452 \end_layout
18453
18454 \end_inset
18455
18456  if an absolute path is required.
18457 \end_layout
18458
18459 \begin_layout Itemize
18460 Use
18461 \begin_inset Flex CharStyle:Code
18462 status collapsed
18463
18464 \begin_layout Plain Layout
18465 $$AbsOrRelPathMaster
18466 \end_layout
18467
18468 \end_inset
18469
18470  if the substituted string is some kind of LaTeX input.
18471 \end_layout
18472
18473 \begin_layout Itemize
18474 Else use
18475 \begin_inset Flex CharStyle:Code
18476 status collapsed
18477
18478 \begin_layout Plain Layout
18479 $$AbsOrRelPathParent
18480 \end_layout
18481
18482 \end_inset
18483
18484  in order to preserve the user's choice.
18485 \end_layout
18486
18487 \begin_layout Standard
18488 There are special cases where this rule does not work and e.
18489 \begin_inset space \thinspace{}
18490 \end_inset
18491
18492 g.
18493 \begin_inset space \space{}
18494 \end_inset
18495
18496 relative names are needed, but normally it will work just fine.
18497  One example for such a case is the command
18498 \begin_inset Flex CharStyle:Code
18499 status collapsed
18500
18501 \begin_layout Plain Layout
18502 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
18503 \end_layout
18504
18505 \end_inset
18506
18507  in the XFig template above: We can't use the absolute name because the
18508  copier for
18509 \begin_inset Flex CharStyle:Code
18510 status collapsed
18511
18512 \begin_layout Plain Layout
18513 .pstex_t
18514 \end_layout
18515
18516 \end_inset
18517
18518  files needs the relative name in order to rewrite the file content.
18519 \end_layout
18520
18521 \begin_layout Section
18522 Security discussion
18523 \begin_inset CommandInset label
18524 LatexCommand label
18525 name "sec:Security-discussion"
18526
18527 \end_inset
18528
18529
18530 \end_layout
18531
18532 \begin_layout Standard
18533 The external material feature interfaces with a lot of external programs
18534  and does so automatically, so we have to consider the security implications
18535  of this.
18536  In particular, since you have the option of including your own filenames
18537  and/or parameter strings and those are expanded into a command, it seems
18538  that it would be possible to create a malicious document which executes
18539  arbitrary commands when a user views or prints the document.
18540  This is something we definitely want to avoid.
18541 \end_layout
18542
18543 \begin_layout Standard
18544 However, since the external program commands are specified in the template
18545  configuration file only, there are no security issues if LyX is properly
18546  configured with safe templates only.
18547  This is so because the external programs are invoked with the
18548 \begin_inset Flex CharStyle:Code
18549 status collapsed
18550
18551 \begin_layout Plain Layout
18552 execvp
18553 \end_layout
18554
18555 \end_inset
18556
18557 -system call rather than the
18558 \begin_inset Flex CharStyle:Code
18559 status collapsed
18560
18561 \begin_layout Plain Layout
18562 system
18563 \end_layout
18564
18565 \end_inset
18566
18567  system-call, so it's not possible to execute arbitrary commands from the
18568  filename or parameter section via the shell.
18569 \end_layout
18570
18571 \begin_layout Standard
18572 This also implies that you are restricted in what command strings you can
18573  use in the external material templates.
18574  In particular, pipes and redirection are not readily available.
18575  This has to be so if LyX should remain safe.
18576  If you want to use some of the shell features, you should write a safe
18577  script to do this in a controlled manner, and then invoke the script from
18578  the command string.
18579
18580 \end_layout
18581
18582 \begin_layout Standard
18583 It is possible to design a template that interacts directly with the shell,
18584  but since this would allow a malicious user to execute arbitrary commands
18585  by writing clever filenames and/or parameters, we generally recommend that
18586  you only use safe scripts that work with the
18587 \begin_inset Flex CharStyle:Code
18588 status collapsed
18589
18590 \begin_layout Plain Layout
18591 execvp
18592 \end_layout
18593
18594 \end_inset
18595
18596  system call in a controlled manner.
18597  Of course, for use in a controlled environment, it can be tempting to just
18598  fall back to use ordinary shell scripts.
18599  If you do so, be aware that you
18600 \emph on
18601 will
18602 \emph default
18603  provide an easily exploitable security hole in your system.
18604  Of course it stands to reason that such unsafe templates will never be
18605  included in the standard LyX distribution, although we do encourage people
18606  to submit new templates in the open source tradition.
18607  But LyX as shipped from the official distribution channels will never have
18608  unsafe templates.
18609 \end_layout
18610
18611 \begin_layout Standard
18612 Including external material provides a lot of power, and you have to be
18613  careful not to introduce security hazards with this power.
18614  A subtle error in a single line in an innocent looking script can open
18615  the door to huge security problems.
18616  So if you do not fully understand the issues, we recommend that you consult
18617  a knowledgeable security professional or the LyX development team if you
18618  have any questions about whether a given template is safe or not.
18619  And do this before you use it in an uncontrolled environment.
18620 \end_layout
18621
18622 \end_body
18623 \end_document