1 #LyX 2.2 created this file. For more info see http://www.lyx.org/
5 \origin /systemlyxdir/doc/
8 % DO NOT ALTER THIS PREAMBLE!!!
10 % This preamble is designed to ensure that this document prints
11 % out as advertised. If you mess with this preamble,
12 % parts of this document may not print out as expected. If you
13 % have problems LaTeXing this file, please contact
14 % the documentation team
15 % email: lyx-docs@lists.lyx.org
17 \usepackage{ifpdf} % part of the hyperref bundle
18 \ifpdf % if pdflatex is used
20 % set fonts for nicer pdf view
21 \IfFileExists{lmodern.sty}
22 {\usepackage{lmodern}}{}
24 \fi % end if pdflatex is used
26 % the pages of the TOC is numbered roman
27 % and a pdf-bookmark for the TOC is added
28 \let\myTOC\tableofcontents
29 \renewcommand\tableofcontents{%
31 \pdfbookmark[1]{\contentsname}{}
35 % increase link area for cross-references and autoname them,
36 \AtBeginDocument{\renewcommand{\ref}[1]{\mbox{\autoref{#1}}}}
37 \@ifundefined{extrasenglish}{\usepackage[english]{babel}}{}
38 \@ifpackageloaded{babel}{
39 \addto\extrasenglish{%
40 \renewcommand*{\equationautorefname}[1]{}%
41 \renewcommand{\sectionautorefname}{sec.\negthinspace}%
42 \renewcommand{\subsectionautorefname}{sec.\negthinspace}%
43 \renewcommand{\subsubsectionautorefname}{sec.\negthinspace}%
47 \options fleqn,bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
48 \use_default_options false
52 \maintain_unincluded_children false
55 InsetLayout Flex:MenuItem
64 \newcommand*{\menuitem}[1]{{\sffamily #1}}
67 # In case we need to do with sans...
68 #InsetLayout CharStyle:Code
73 #\renewcommand{\code}[1]{{\sffamily #1}}
78 \language_package default
81 \font_roman "default" "default"
82 \font_sans "default" "default"
83 \font_typewriter "default" "default"
84 \font_math "auto" "auto"
85 \font_default_family default
86 \use_non_tex_fonts false
89 \font_sf_scale 100 100
90 \font_tt_scale 100 100
92 \default_output_format default
94 \bibtex_command default
95 \index_command default
99 \pdf_title "LyX Configuration Manual"
100 \pdf_author "LyX Team"
101 \pdf_subject "LyX-documentation Customization"
102 \pdf_keywords "LyX, documentation, customization"
104 \pdf_bookmarksnumbered true
105 \pdf_bookmarksopen true
106 \pdf_bookmarksopenlevel 1
107 \pdf_breaklinks false
111 \pdf_pdfusetitle false
112 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
115 \use_package amsmath 0
116 \use_package amssymb 0
117 \use_package cancel 0
119 \use_package mathdots 1
120 \use_package mathtools 0
121 \use_package mhchem 0
122 \use_package stackrel 0
123 \use_package stmaryrd 0
124 \use_package undertilde 0
126 \cite_engine_type default
130 \paperorientation portrait
145 \paragraph_separation indent
146 \paragraph_indentation default
147 \quotes_language english
150 \paperpagestyle headings
151 \tracking_changes true
152 \output_changes false
156 \author -712698321 "Jürgen Spitzmüller"
157 \author -195340706 "Georg Baum"
158 \author 274215730 "scott"
164 Customizing \SpecialChar LyX
165 : Features for the Advanced User
169 by the \SpecialChar LyX
174 \begin_layout Plain Layout
176 If you have comments or error corrections, please send them to the \SpecialChar LyX
179 \begin_inset CommandInset href
181 target "lyx-docs@lists.lyx.org"
188 \begin_inset Quotes eld
192 \begin_inset Quotes erd
195 in the subject header, and please cc the current maintainer of this file,
196 Richard Heck <rgheck@comcast.net>.
202 \begin_inset Newline newline
206 \begin_inset Newline newline
212 \begin_layout Standard
213 \begin_inset CommandInset toc
214 LatexCommand tableofcontents
221 \begin_layout Standard
222 \begin_inset Note Note
225 \begin_layout Plain Layout
226 Please use change tracking when modifying this document.
227 This makes it easier for our translators to recognize things that have
228 been changed, and it helps the maintainer keep up-to-date with what's been
237 \begin_layout Chapter
241 \begin_layout Standard
242 This manual covers the customization features present in \SpecialChar LyX
244 In it, we discuss issues like keyboard shortcuts, screen previewing options,
245 printer options, sending commands to \SpecialChar LyX
246 via the \SpecialChar LyX
247 Server, internationalization,
248 installing new \SpecialChar LaTeX
249 classes and \SpecialChar LyX
251 We can't possibly hope to touch on everything you can change—our developers
252 add new features faster than we can document them—but we will explain the
253 most common customizations and hopefully point you in the right direction
254 for some of the more obscure ones.
257 \begin_layout Standard
258 \begin_inset Branch OutDated
261 \begin_layout Standard
262 Information from previous versions of this document that now seems to be
263 outdated is contained in the OutDated branch of this document.
264 By default, this information will not appear in the \SpecialChar LaTeX
273 \begin_layout Chapter
278 \begin_layout Standard
279 This chapter aims to help you to find your way through the \SpecialChar LyX
282 Before continuing to read this chapter, you should find out where your
284 library and user directories are by using
285 \begin_inset Flex MenuItem
288 \begin_layout Plain Layout
289 Help\SpecialChar menuseparator
295 \change_deleted -712698321 1437634470
298 \change_inserted -712698321 1437634471
307 The library directory is the place where \SpecialChar LyX
308 places its system-wide configuration
309 files; the user directory is where you can place your modified versions.
310 We will call the former
311 \begin_inset Flex Code
314 \begin_layout Plain Layout
316 \change_inserted -712698321 1437634480
318 \change_deleted -712698321 1437634481
328 \begin_inset Flex MenuItem
331 \begin_layout Plain Layout
337 in the remainder of this document.
341 \begin_layout Section
343 \begin_inset Flex Code
346 \begin_layout Plain Layout
348 \change_inserted -712698321 1437634488
350 \change_deleted -712698321 1437634487
362 \begin_layout Standard
363 \begin_inset Flex Code
366 \begin_layout Plain Layout
368 \change_deleted -712698321 1437634497
371 \change_inserted -712698321 1437634498
379 and its sub-directories contain a number of files and that can be used
380 to customize \SpecialChar LyX
382 You can change many of these files from within \SpecialChar LyX
384 \begin_inset Flex MenuItem
387 \begin_layout Plain Layout
388 Tools\SpecialChar menuseparator
395 Most customization that you will want to do in \SpecialChar LyX
396 is possible through this
398 However, many other inner aspects of \SpecialChar LyX
399 can be customized by modifying the
401 \begin_inset Flex Code
404 \begin_layout Plain Layout
406 \change_deleted -712698321 1437634507
409 \change_inserted -712698321 1437634507
418 These files fall in different categories, described in the following subsection
422 \begin_layout Subsection
423 Automatically generated files
426 \begin_layout Standard
427 The files, which are to be found in
428 \begin_inset Flex MenuItem
431 \begin_layout Plain Layout
437 , are generated when you configure \SpecialChar LyX
439 They contain various default values that are guessed by inspection.
440 In general, it is not a good idea to modify them, since they might be overwritt
444 \begin_layout Labeling
445 \labelwidthstring 00.00.0000
446 \begin_inset Flex Code
449 \begin_layout Plain Layout
455 contains defaults for various commands.
458 \begin_layout Labeling
459 \labelwidthstring 00.00.0000
460 \begin_inset Flex Code
463 \begin_layout Plain Layout
469 contains the list of packages that have been recognized by \SpecialChar LyX
471 It is currently unused by the \SpecialChar LyX
472 program itself, but the information extracted,
473 and more, is made available with
474 \begin_inset Flex MenuItem
477 \begin_layout Plain Layout
478 Help\SpecialChar menuseparator
492 \begin_layout Labeling
493 \labelwidthstring 00.00.0000
494 \begin_inset Flex Code
497 \begin_layout Plain Layout
503 the list of text classes that have been found in your
504 \begin_inset Flex Code
507 \begin_layout Plain Layout
513 directories, along with the associated \SpecialChar LaTeX
514 document class and their description.
517 \begin_layout Labeling
518 \labelwidthstring 00.00.0000
519 \begin_inset Flex Code
522 \begin_layout Plain Layout
528 the list of layout modules found in your
529 \begin_inset Flex Code
532 \begin_layout Plain Layout
541 \begin_layout Labeling
542 \labelwidthstring 00.00.0000
543 \begin_inset Flex Code
546 \begin_layout Plain Layout
552 lists of various sorts of \SpecialChar LaTeX
553 -related files found on your system
556 \begin_layout Labeling
557 \labelwidthstring 00.00.0000
558 \begin_inset Flex Code
561 \begin_layout Plain Layout
562 doc/\SpecialChar LaTeX
568 is automatically generated during configuration from the file
569 \begin_inset Flex Code
572 \begin_layout Plain Layout
580 It contains information on your \SpecialChar LaTeX
584 \begin_layout Subsection
588 \begin_layout Standard
589 These directories are duplicated between
590 \begin_inset Flex Code
593 \begin_layout Plain Layout
595 \change_deleted -712698321 1437634516
598 \change_inserted -712698321 1437634517
607 \begin_inset Flex Code
610 \begin_layout Plain Layout
617 If a particular files exists in both places, the one in
618 \begin_inset Flex Code
621 \begin_layout Plain Layout
630 \begin_layout Labeling
631 \labelwidthstring 00.00.0000
632 \begin_inset Flex Code
635 \begin_layout Plain Layout
641 this directory contains files with the extension
642 \begin_inset Flex Code
645 \begin_layout Plain Layout
651 that define the keybindings used in \SpecialChar LyX
653 If there exists an internationalized version of the bind file named
654 \begin_inset Flex Code
657 \begin_layout Plain Layout
663 , that will be used first.
666 \begin_layout Labeling
667 \labelwidthstring 00.00.0000
668 \begin_inset Flex Code
671 \begin_layout Plain Layout
677 contains graphics files that can be included in documents.
681 \begin_layout Labeling
682 \labelwidthstring 00.00.0000
683 \begin_inset Flex Code
686 \begin_layout Plain Layout
692 contains \SpecialChar LyX
693 documentation files (including the one you are currently reading).
695 \begin_inset Flex Code
698 \begin_layout Plain Layout
705 deserves special attention, as noted above.
706 The internationalized help docs are in subdirectories
707 \begin_inset Flex Code
710 \begin_layout Plain Layout
717 \begin_inset Quotes eld
721 \begin_inset Quotes erd
724 is the ISO language code.
726 \begin_inset CommandInset ref
728 reference "cha:Internationalizing-LyX"
735 \begin_layout Labeling
736 \labelwidthstring 00.00.0000
737 \begin_inset Flex Code
740 \begin_layout Plain Layout
746 contains example files that explain how to use some features.
747 In the file browser, press the
748 \begin_inset Flex MenuItem
751 \begin_layout Plain Layout
760 \begin_layout Labeling
761 \labelwidthstring 00.00.0000
762 \begin_inset Flex Code
765 \begin_layout Plain Layout
771 contains image files that are used by the
772 \begin_inset Flex MenuItem
775 \begin_layout Plain Layout
782 In addition, it also contains the individual icons used in the toolbar
783 and the banners that can be shown when \SpecialChar LyX
787 \begin_layout Labeling
788 \labelwidthstring 00.00.0000
789 \begin_inset Flex Code
792 \begin_layout Plain Layout
798 contains keyboard keymapping files.
800 \begin_inset CommandInset ref
802 reference "sec:International-Keymap-Stuff"
809 \begin_layout Labeling
810 \labelwidthstring 00.00.0000
811 \begin_inset Flex Code
814 \begin_layout Plain Layout
820 contains the text class and module files described in
821 \begin_inset CommandInset ref
823 reference "cha:Installing-New-Document"
830 \begin_layout Labeling
831 \labelwidthstring 00.00.0000
832 \begin_inset Flex Code
835 \begin_layout Plain Layout
842 \begin_inset Flex Code
845 \begin_layout Plain Layout
851 Python scripts used to convert between \SpecialChar LyX
853 These can be run from the command line if, say, you want to batch-convert
857 \begin_layout Labeling
858 \labelwidthstring 00.00.0000
859 \begin_inset Flex Code
862 \begin_layout Plain Layout
868 contains some files that demonstrate the capabilities of the
869 \begin_inset Flex MenuItem
872 \begin_layout Plain Layout
883 Also contains some scripts used by \SpecialChar LyX
887 \begin_layout Labeling
888 \labelwidthstring 00.00.0000
889 \begin_inset Flex Code
892 \begin_layout Plain Layout
898 contains the standard \SpecialChar LyX
899 template files described in
900 \begin_inset CommandInset ref
902 reference "subsec:Creating-Templates"
909 \begin_layout Labeling
910 \labelwidthstring 00.00.0000
911 \begin_inset Flex Code
914 \begin_layout Plain Layout
920 contains files with the extension
921 \begin_inset Flex Code
924 \begin_layout Plain Layout
930 that define the user interface to \SpecialChar LyX
932 That is, the files define which items appear in which menus and the items
933 appearing on the toolbar.
936 \begin_layout Subsection
937 Files you don't want to modify
940 \begin_layout Standard
941 These files are used internally by \SpecialChar LyX
942 and you generally do not need to modify
943 them unless you are a developer.
946 \begin_layout Labeling
947 \labelwidthstring 00.00.0000
948 \begin_inset Flex Code
951 \begin_layout Plain Layout
957 this file contains the list of \SpecialChar LyX
959 The contents are displayed with the menu entry
960 \begin_inset Flex MenuItem
963 \begin_layout Plain Layout
964 Help\SpecialChar menuseparator
970 \change_deleted -712698321 1437634530
973 \change_inserted -712698321 1437634531
984 \begin_layout Labeling
985 \labelwidthstring 00.00.0000
986 \begin_inset Flex Code
989 \begin_layout Plain Layout
995 this is a \SpecialChar LaTeX
996 script used during the configuration process.
1000 \begin_layout Labeling
1001 \labelwidthstring 00.00.0000
1002 \begin_inset Flex Code
1005 \begin_layout Plain Layout
1011 this is a Python script that is used to re-configure \SpecialChar LyX
1013 It creates configuration files in the directory it was run from.
1016 \begin_layout Subsection
1017 Other files needing a line or two
1020 \begin_layout Labeling
1021 \labelwidthstring 00.00.0000
1022 \begin_inset Flex Code
1025 \begin_layout Plain Layout
1031 this contains tables describing how different character encodings can be
1035 \begin_layout Labeling
1036 \labelwidthstring 00.00.0000
1037 \begin_inset Flex Code
1040 \begin_layout Plain Layout
1046 this file contains the templates available to the new
1047 \begin_inset Flex MenuItem
1050 \begin_layout Plain Layout
1052 \begin_inset space ~
1061 \begin_inset CommandInset ref
1063 reference "chap:Including-External-Material"
1070 \begin_layout Labeling
1071 \labelwidthstring 00.00.0000
1072 \begin_inset Flex Code
1075 \begin_layout Plain Layout
1081 this file contains a list of all the languages currently supported by \SpecialChar LyX
1085 \begin_layout Labeling
1086 \labelwidthstring 00.00.0000
1087 \begin_inset Flex Code
1090 \begin_layout Plain Layout
1096 contains information about the supported fonts.
1099 \begin_layout Labeling
1100 \labelwidthstring 00.00.0000
1101 \begin_inset Flex Code
1104 \begin_layout Plain Layout
1110 this file contains translations for internationalized paragraph styles
1112 \begin_inset CommandInset ref
1114 reference "subsec:I18n"
1121 \begin_layout Labeling
1122 \labelwidthstring 00.00.0000
1123 \begin_inset Flex Code
1126 \begin_layout Plain Layout
1132 this file contains information about unicode-encoded glyphs and the way
1133 they are supported by \SpecialChar LyX
1134 via \SpecialChar LaTeX
1138 \begin_layout Section
1139 Your local configuration directory
1142 \begin_layout Standard
1143 Even if you are using \SpecialChar LyX
1144 as an unprivileged user, you might want to change
1146 configuration for your own use.
1148 \begin_inset Flex Code
1151 \begin_layout Plain Layout
1157 directory contains all your personal configuration files.
1158 This is the directory described as
1159 \begin_inset Quotes eld
1163 \begin_inset Quotes erd
1167 \begin_inset Flex MenuItem
1170 \begin_layout Plain Layout
1171 Help\SpecialChar menuseparator
1173 \begin_inset space ~
1177 \change_inserted -712698321 1437634544
1179 \change_deleted -712698321 1437634543
1189 This directory is used as a mirror of
1190 \begin_inset Flex Code
1193 \begin_layout Plain Layout
1195 \change_deleted -712698321 1437634548
1198 \change_inserted -712698321 1437634549
1206 , which means that every file in
1207 \begin_inset Flex Code
1210 \begin_layout Plain Layout
1216 is a replacement for the corresponding file in
1217 \begin_inset Flex Code
1220 \begin_layout Plain Layout
1222 \change_deleted -712698321 1437634553
1225 \change_inserted -712698321 1437634554
1234 Any configuration file described in the above sections can be placed either
1235 in the system-wide directory, in which case it will affect all users, or
1236 in your local directory for your own use.
1239 \begin_layout Standard
1240 To make things clearer, let's provide a few examples:
1243 \begin_layout Itemize
1244 The preferences set in the
1245 \begin_inset Flex MenuItem
1248 \begin_layout Plain Layout
1249 Tools\SpecialChar menuseparator
1255 dialog are saved to a file
1256 \begin_inset Flex Code
1259 \begin_layout Plain Layout
1266 \begin_inset Flex Code
1269 \begin_layout Plain Layout
1278 \begin_layout Itemize
1279 When you reconfigure using
1280 \begin_inset Flex MenuItem
1283 \begin_layout Plain Layout
1284 Tools\SpecialChar menuseparator
1292 \begin_inset Flex Code
1295 \begin_layout Plain Layout
1301 script, and the resulting files are written in your local configuration
1303 This means that any additional text class file that you might have added
1305 \begin_inset Flex Code
1308 \begin_layout Plain Layout
1314 will be added to the list of classes in the
1315 \begin_inset Flex MenuItem
1318 \begin_layout Plain Layout
1319 Document\SpecialChar menuseparator
1328 \begin_layout Itemize
1329 If you get some updated documentation from \SpecialChar LyX
1330 ftp site and cannot install
1331 it because you do not have sysadmin rights on your system, you can just
1333 \begin_inset Flex Code
1336 \begin_layout Plain Layout
1342 and the items in the
1343 \begin_inset Flex MenuItem
1346 \begin_layout Plain Layout
1352 menu will open them!
1355 \begin_layout Section
1356 Running \SpecialChar LyX
1357 with multiple configurations
1360 \begin_layout Standard
1361 The configuration freedom of the local configuration directory may not suffice
1362 if you want to have more than one configuration at your disposal.
1363 For example, you may want to be use different key bindings or printer settings
1365 You can achieve this by having several such directories.
1366 You then specify which directory to use at run-time.
1369 \begin_layout Standard
1370 Invoking \SpecialChar LyX
1371 with the command line switch
1372 \begin_inset Flex Code
1375 \begin_layout Plain Layout
1385 instructs the program to read the configuration from that directory, and
1386 not from the default directory.
1387 (You can determine the default directory by running \SpecialChar LyX
1389 \begin_inset Flex Code
1392 \begin_layout Plain Layout
1398 switch.) If the specified directory does not exist, \SpecialChar LyX
1400 for you, just like it does for the default directory on the first time
1401 you run the program.
1402 You can modify the configuration options in this additional user directory
1403 exactly as you would for the default directory.
1404 These directories are completely independent (but read on).
1405 Note that setting the environment variable
1406 \begin_inset Flex Code
1409 \begin_layout Plain Layout
1415 to some value has exactly the same effect.
1418 \begin_layout Standard
1419 Having several configurations also requires more maintenance: if you want
1420 to add a new layout to
1421 \begin_inset Flex Code
1424 \begin_layout Plain Layout
1430 which you want available from all your configurations, you must add it
1431 to each directory separately.
1432 You can avoid this with the following trick: after \SpecialChar LyX
1433 creates the additional
1434 directory, most of the subdirectories (see above) are empty.
1435 If you want the new configuration to mirror an existing one, replace the
1436 empty subdirectory with a symbolic link to the matching subdirectory in
1437 the existing configuration.
1439 \begin_inset Flex Code
1442 \begin_layout Plain Layout
1448 subdirectory, however, since it contains a file written by the configuration
1449 script (also accessible through
1450 \begin_inset Flex MenuItem
1453 \begin_layout Plain Layout
1454 Tools\SpecialChar menuseparator
1460 ) which is configuration-specific.
1463 \begin_layout Chapter
1464 The Preferences dialog
1467 \begin_layout Standard
1468 All options of the preferences dialog are described in the Appendix
1470 The Preferences Dialog
1477 For some options you might find here more details.
1480 \begin_layout Section
1482 \begin_inset CommandInset label
1491 \begin_layout Standard
1492 The first step is to define your file formats if they are not already defined.
1494 \begin_inset Flex MenuItem
1497 \begin_layout Plain Layout
1498 Tools\SpecialChar menuseparator
1506 \begin_inset Flex MenuItem
1509 \begin_layout Plain Layout
1510 File Handling\SpecialChar menuseparator
1517 \begin_inset Flex MenuItem
1520 \begin_layout Plain Layout
1526 button to define your new format.
1528 \begin_inset Flex MenuItem
1531 \begin_layout Plain Layout
1537 field contains the name used to identify the format in the GUI.
1539 \begin_inset Flex MenuItem
1542 \begin_layout Plain Layout
1548 is used to identify the format internally.
1549 You will also need to enter a file extension.
1550 These are all required.
1552 \begin_inset Flex MenuItem
1555 \begin_layout Plain Layout
1561 field is used to provide a keyboard shortcut on the menus.
1562 (For example, pressing
1563 \begin_inset Flex MenuItem
1566 \begin_layout Plain Layout
1573 \begin_inset Flex MenuItem
1576 \begin_layout Plain Layout
1577 Document\SpecialChar menuseparator
1578 View (Other Formats)\SpecialChar menuseparator
1587 \begin_layout Standard
1589 \begin_inset Flex MenuItem
1592 \begin_layout Plain Layout
1599 \begin_inset Flex MenuItem
1602 \begin_layout Plain Layout
1609 For example, you might want to use
1610 \begin_inset Flex MenuItem
1613 \begin_layout Plain Layout
1619 to view PostScript files.
1620 You can enter the command needed to start the program in the corresponding
1622 In defining this command, you can use the four variables listed in the
1624 The viewer is launched when you view an image in \SpecialChar LyX
1626 \begin_inset Flex MenuItem
1629 \begin_layout Plain Layout
1630 Document\SpecialChar menuseparator
1637 The editor is for example launched when you right-click on an image and
1639 \begin_inset Flex MenuItem
1642 \begin_layout Plain Layout
1648 in the appearing context menu.
1651 \begin_layout Standard
1653 \begin_inset Flex MenuItem
1656 \begin_layout Plain Layout
1662 type of a format is optional, but if it is specified, it must be unique
1664 It is used to detect files of this format from the file contents.
1665 For some important file formats there is no MIME type officially registered
1667 \begin_inset CommandInset href
1670 target "http://www.iana.org/assignments/media-types/"
1675 Therefore \SpecialChar LyX
1676 uses the extended list of MIME types as specified by
1677 \begin_inset CommandInset href
1679 name "freedesktop.org"
1680 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1687 \begin_layout Standard
1689 \begin_inset Flex MenuItem
1692 \begin_layout Plain Layout
1698 option tells \SpecialChar LyX
1699 that a format is suitable for document export.
1700 If this is set and if a suitable conversion route exists (see
1701 \begin_inset CommandInset ref
1703 reference "sec:Converters"
1707 ), the format will appear in the
1708 \begin_inset Flex MenuItem
1711 \begin_layout Plain Layout
1712 File\SpecialChar menuseparator
1719 The format will also appear in the
1720 \begin_inset Flex MenuItem
1723 \begin_layout Plain Layout
1724 Document\SpecialChar menuseparator
1730 menu if a viewer is specified for the format.
1731 Pure image formats, such as
1732 \begin_inset Flex Code
1735 \begin_layout Plain Layout
1741 , should not use this option.
1742 Formats that can both represent vector graphics and documents like
1743 \begin_inset Flex Code
1746 \begin_layout Plain Layout
1755 \begin_layout Standard
1757 \begin_inset Flex MenuItem
1760 \begin_layout Plain Layout
1761 Vector graphics format
1766 tells \SpecialChar LyX
1767 that a format can contain vector graphics.
1768 This information is used to determine the target format of included graphics
1770 \begin_inset Flex MenuItem
1773 \begin_layout Plain Layout
1780 Included graphics may need to be converted to either
1781 \begin_inset Flex MenuItem
1784 \begin_layout Plain Layout
1791 \begin_inset Flex MenuItem
1794 \begin_layout Plain Layout
1801 \begin_inset Flex MenuItem
1804 \begin_layout Plain Layout
1811 \begin_inset Flex MenuItem
1814 \begin_layout Plain Layout
1820 cannot handle other image formats.
1821 If an included graphic is not already in
1822 \begin_inset Flex MenuItem
1825 \begin_layout Plain Layout
1832 \begin_inset Flex MenuItem
1835 \begin_layout Plain Layout
1842 \begin_inset Flex MenuItem
1845 \begin_layout Plain Layout
1851 format, it is converted to
1852 \begin_inset Flex MenuItem
1855 \begin_layout Plain Layout
1861 if the vector format option is set, and otherwise to
1862 \begin_inset Flex MenuItem
1865 \begin_layout Plain Layout
1874 \begin_layout Section
1878 \begin_layout Standard
1879 Since all conversions from one format to another take place in \SpecialChar LyX
1881 directory, it is sometimes necessary to modify a file before copying it
1882 to the temporary directory in order that the conversion may be performed.
1886 \begin_layout Plain Layout
1887 For example, the file may refer to other files—images, for example—using
1888 relative file names, and these may become invalid when the file is copied
1889 to the temporary directory.
1894 This is done by a Copier: It copies a file to (or from) the temporary directory
1895 and may modify it in the process.
1898 \begin_layout Standard
1899 The definitions of the copiers may use four variables:
1902 \begin_layout Labeling
1903 \labelwidthstring 00.00.0000
1904 \begin_inset Flex Code
1907 \begin_layout Plain Layout
1913 The \SpecialChar LyX
1914 system directory (e.
1915 \begin_inset space \thinspace{}
1919 \begin_inset space \space{}
1923 \begin_inset Flex MenuItem
1926 \begin_layout Plain Layout
1935 \begin_layout Labeling
1936 \labelwidthstring 00.00.0000
1937 \begin_inset Flex Code
1940 \begin_layout Plain Layout
1949 \begin_layout Labeling
1950 \labelwidthstring 00.00.0000
1951 \begin_inset Flex Code
1954 \begin_layout Plain Layout
1963 \begin_layout Labeling
1964 \labelwidthstring 00.00.0000
1965 \begin_inset Flex Code
1968 \begin_layout Plain Layout
1974 The base name (without filename extension) in the \SpecialChar LyX
1978 \begin_layout Labeling
1979 \labelwidthstring 00.00.0000
1980 \begin_inset Flex Code
1983 \begin_layout Plain Layout
1989 The full directory path of the \SpecialChar LyX
1993 \begin_layout Labeling
1994 \labelwidthstring 00.00.0000
1995 \begin_inset Flex Code
1998 \begin_layout Plain Layout
2004 The full pathname to the original \SpecialChar LyX
2005 file being processed
2008 \begin_layout Labeling
2009 \labelwidthstring 00.00.0000
2010 \begin_inset Flex Code
2013 \begin_layout Plain Layout
2019 The filename (without any directory path) of the \SpecialChar LyX
2023 \begin_layout Labeling
2024 \labelwidthstring 00.00.0000
2025 \begin_inset Flex Code
2028 \begin_layout Plain Layout
2034 The `\SpecialChar LaTeX
2038 \begin_layout Standard
2039 The latter should be the filename as it would be used in a \SpecialChar LaTeX
2047 It is relevant only when exporting files suitable for such inclusion.
2050 \begin_layout Standard
2051 Copiers can be used to do almost anything with output files.
2052 For example, suppose you want generated pdf files to be copied to a special
2054 \begin_inset Flex Code
2057 \begin_layout Plain Layout
2064 Then you could write a shell script such as this one:
2067 \begin_layout Standard
2068 \begin_inset listings
2072 \begin_layout Plain Layout
2077 \begin_layout Plain Layout
2082 \begin_layout Plain Layout
2084 TOFILE=`basename $2`
2087 \begin_layout Plain Layout
2089 cp $FROMFILE /home/you/pdf/$TOFILE
2094 Save it in your local \SpecialChar LyX
2096 \begin_inset Flex Code
2099 \begin_layout Plain Layout
2100 /home/you/.lyx/scripts/pdfcopier.sh
2105 —and make it executable, if you need to do so on your platform.
2107 \begin_inset Flex MenuItem
2110 \begin_layout Plain Layout
2111 Tools\SpecialChar menuseparator
2117 dialog, select under
2118 \begin_inset Flex MenuItem
2121 \begin_layout Plain Layout
2122 File Handling\SpecialChar menuseparator
2129 \begin_inset Flex MenuItem
2132 \begin_layout Plain Layout
2138 format—or one of the other pdf formats—and enter
2139 \begin_inset Flex Code
2142 \begin_layout Plain Layout
2143 pdfcopier.sh $$i $$o
2149 \begin_inset Flex MenuItem
2152 \begin_layout Plain Layout
2162 \begin_layout Standard
2163 Copiers are used by \SpecialChar LyX
2164 in various of its own conversions.
2165 For example, if appropriate programs are found, \SpecialChar LyX
2166 will automatically install
2168 \begin_inset Flex MenuItem
2171 \begin_layout Plain Layout
2178 \begin_inset Flex MenuItem
2181 \begin_layout Plain Layout
2183 \begin_inset space ~
2192 When these formats are exported, the copier sees that not just the main
2193 HTML file but various associated files (style files, images, etc.) are also
2195 All these files are written to a subdirectory of the directory in which
2196 the original \SpecialChar LyX
2201 \begin_layout Plain Layout
2202 This copier can be customized.
2204 \begin_inset Quotes eld
2208 \begin_inset Quotes erd
2211 argument takes a comma-separated list of extensions to be copied; if it
2212 is omitted, all files will be copied.
2214 \begin_inset Quotes eld
2218 \begin_inset Quotes erd
2221 argument determines the extension added to the generated directory.
2223 \begin_inset Quotes eld
2227 \begin_inset Flex MenuItem
2230 \begin_layout Plain Layout
2232 \change_inserted -712698321 1437634589
2234 \change_deleted -712698321 1437634588
2244 \begin_inset Quotes erd
2247 , so HTML generated from
2248 \begin_inset Flex MenuItem
2251 \begin_layout Plain Layout
2252 /path/to/filename.lyx
2258 \begin_inset Flex MenuItem
2261 \begin_layout Plain Layout
2262 /path/to/filename.html.
2263 \change_deleted -712698321 1437634593
2266 \change_inserted -712698321 1437634595
2283 \begin_layout Section
2285 \begin_inset CommandInset label
2287 name "sec:Converters"
2294 \begin_layout Standard
2295 You can define your own Converters to convert files between different formats.
2297 \begin_inset Flex MenuItem
2300 \begin_layout Plain Layout
2301 Tools\SpecialChar menuseparator
2302 Preferences\SpecialChar menuseparator
2303 File Handling\SpecialChar menuseparator
2312 \begin_layout Standard
2313 To define a new converter, select the
2314 \begin_inset Flex MenuItem
2317 \begin_layout Plain Layout
2319 \begin_inset space ~
2328 \begin_inset Flex MenuItem
2331 \begin_layout Plain Layout
2333 \begin_inset space ~
2341 from the drop-down lists, enter the command needed for the conversion,
2343 \begin_inset Flex MenuItem
2346 \begin_layout Plain Layout
2353 Several variables can be used in the definition of converters:
2356 \begin_layout Labeling
2357 \labelwidthstring 00.00.0000
2358 \begin_inset Flex Code
2361 \begin_layout Plain Layout
2367 The \SpecialChar LyX
2371 \begin_layout Labeling
2372 \labelwidthstring 00.00.0000
2373 \begin_inset Flex Code
2376 \begin_layout Plain Layout
2385 \begin_layout Labeling
2386 \labelwidthstring 00.00.0000
2387 \begin_inset Flex Code
2390 \begin_layout Plain Layout
2399 \begin_layout Labeling
2400 \labelwidthstring 00.00.0000
2401 \begin_inset Flex Code
2404 \begin_layout Plain Layout
2410 The base filename of the input file (i.
2411 \begin_inset space \thinspace{}
2414 g., without the extension)
2417 \begin_layout Labeling
2418 \labelwidthstring 00.00.0000
2419 \begin_inset Flex Code
2422 \begin_layout Plain Layout
2428 The path to the input file
2431 \begin_layout Labeling
2432 \labelwidthstring 00.00.0000
2433 \begin_inset Flex Code
2436 \begin_layout Plain Layout
2442 The path to the original input file (this is different from $$p when a
2443 chain of converters is called)
2446 \begin_layout Labeling
2447 \labelwidthstring 00.00.0000
2448 \begin_inset Flex Code
2451 \begin_layout Plain Layout
2457 The iconv name for the encoding of the document.
2460 \begin_layout Standard
2462 \begin_inset Flex MenuItem
2465 \begin_layout Plain Layout
2467 \begin_inset space ~
2475 field you can enter the following flags, separated by commas:
2478 \begin_layout Labeling
2479 \labelwidthstring 00.00.0000
2480 \begin_inset Flex Code
2483 \begin_layout Plain Layout
2489 This converter runs some form of \SpecialChar LaTeX
2491 This will make \SpecialChar LyX
2492 's \SpecialChar LaTeX
2493 error logs available.
2496 \begin_layout Labeling
2497 \labelwidthstring 00.00.0000
2498 \begin_inset Flex Code
2501 \begin_layout Plain Layout
2507 Needs the \SpecialChar LaTeX
2509 \begin_inset Flex MenuItem
2512 \begin_layout Plain Layout
2518 file for the conversion.
2521 \begin_layout Labeling
2522 \labelwidthstring 00.00.0000
2523 \begin_inset Flex Code
2526 \begin_layout Plain Layout
2533 \begin_inset Quotes eld
2537 \begin_inset Quotes erd
2540 file from the backend, which in practice means a \SpecialChar LaTeX
2541 file like the one we
2542 would export, without
2543 \begin_inset Flex Code
2546 \begin_layout Plain Layout
2555 \begin_layout Labeling
2556 \labelwidthstring 00.00.0000
2557 \begin_inset Flex Code
2560 \begin_layout Plain Layout
2569 \begin_layout Standard
2570 The following three flags are not really flags at all because they take
2572 \begin_inset Flex MenuItem
2575 \begin_layout Plain Layout
2577 \begin_inset space ~
2581 \begin_inset space ~
2592 \begin_layout Labeling
2593 \labelwidthstring 00.00.0000
2594 \begin_inset Flex Code
2597 \begin_layout Plain Layout
2603 If set, the converter's standard error will be redirected to a file
2604 \begin_inset Flex Code
2607 \begin_layout Plain Layout
2613 , and the script given as argument will be run as:
2614 \begin_inset Flex Code
2617 \begin_layout Plain Layout
2618 script < infile.out > infile.log
2624 The argument may contain
2625 \begin_inset Flex Code
2628 \begin_layout Plain Layout
2637 \begin_layout Labeling
2638 \labelwidthstring 00.00.0000
2639 \begin_inset Flex Code
2642 \begin_layout Plain Layout
2648 The name of the directory in which the converter will dump the generated
2651 will not create this directory, and it does not copy anything into it,
2652 though it will copy this directory to the destination.
2653 The argument may contain
2654 \begin_inset Flex Code
2657 \begin_layout Plain Layout
2663 , which will be replaced by the base name of the input and output files,
2664 respectively, when the directory is copied.
2665 \begin_inset Newline newline
2668 Note that resultdir and usetempdir make no sense together.
2669 The latter will be ignored if the former is given.
2672 \begin_layout Labeling
2673 \labelwidthstring 00.00.0000
2674 \begin_inset Flex Code
2677 \begin_layout Plain Layout
2683 Determines the output file name and may, contain
2684 \begin_inset Flex Code
2687 \begin_layout Plain Layout
2694 Sensible only with resultdir and optional even then; if not given, it defaults
2698 \begin_layout Standard
2699 None of these last three are presently used in any of the converters that
2700 are installed with \SpecialChar LyX
2705 \begin_layout Standard
2706 You do not have to define converters for all formats between which you want
2708 For example, you will note that there is no `\SpecialChar LyX
2709 to PostScript' converter,
2710 but \SpecialChar LyX
2711 will export PostScript.
2712 It does so by first creating a \SpecialChar LaTeX
2713 file (no converter needs to be defined
2714 for this) which is then converted to DVI using the `\SpecialChar LaTeX
2716 and finally converting the resulting DVI file to PostScript.
2718 finds such `chains' of converters automatically, and it will always choose
2719 the shortest possible chain.
2720 You can, though, still define multiple conversion methods between file
2722 For example, the standard \SpecialChar LyX
2723 configuration provides five ways to convert
2728 \begin_layout Enumerate
2730 \begin_inset Flex MenuItem
2733 \begin_layout Plain Layout
2742 \begin_layout Enumerate
2743 via (DVI and) PostScript, using
2744 \begin_inset Flex MenuItem
2747 \begin_layout Plain Layout
2756 \begin_layout Enumerate
2758 \begin_inset Flex MenuItem
2761 \begin_layout Plain Layout
2770 \begin_layout Enumerate
2772 \begin_inset Flex MenuItem
2775 \begin_layout Plain Layout
2785 \begin_layout Enumerate
2787 \begin_inset Flex MenuItem
2790 \begin_layout Plain Layout
2800 \begin_layout Standard
2801 To define such alternate chains, you must define multiple target `file formats',
2803 \begin_inset CommandInset ref
2805 reference "sec:Formats"
2810 For example, in the standard configuration, the formats named
2811 \begin_inset Flex MenuItem
2814 \begin_layout Plain Layout
2821 \begin_inset Flex MenuItem
2824 \begin_layout Plain Layout
2831 \begin_inset Flex MenuItem
2834 \begin_layout Plain Layout
2841 \begin_inset Flex MenuItem
2844 \begin_layout Plain Layout
2851 \begin_inset Flex MenuItem
2854 \begin_layout Plain Layout
2861 \begin_inset Flex MenuItem
2864 \begin_layout Plain Layout
2871 \begin_inset Flex MenuItem
2874 \begin_layout Plain Layout
2881 \begin_inset Flex MenuItem
2884 \begin_layout Plain Layout
2892 \begin_inset Flex MenuItem
2895 \begin_layout Plain Layout
2902 \begin_inset Flex MenuItem
2905 \begin_layout Plain Layout
2912 ) are defined, all of which share the extension
2913 \begin_inset Flex MenuItem
2916 \begin_layout Plain Layout
2922 , and which correspond to the conversion methods just mentioned.
2925 \begin_layout Chapter
2926 Internationalizing \SpecialChar LyX
2928 \begin_inset CommandInset label
2930 name "cha:Internationalizing-LyX"
2937 \begin_layout Standard
2939 supports using a translated interface.
2940 Last time we checked, \SpecialChar LyX
2941 provided text in thirty languages.
2942 The language of choice is called your
2947 (For further reading on locale settings, see also the documentation for
2948 locale that comes with your operating system.
2949 For Linux, the manual page for
2950 \begin_inset Flex Code
2953 \begin_layout Plain Layout
2959 could be a good place to start).
2962 \begin_layout Standard
2963 Notice that these translations will work, but do contain a few flaws.
2964 In particular, all dialogs have been designed with the English text in
2965 mind, which means that some of the translated text will be too large to
2966 fit within the space allocated.
2967 This is only a display problem and will not cause any harm.
2968 Also, you will find that some of the translations do not define shortcut
2969 keys for everything.
2970 Sometimes, there are simply not enough free letters to do it.
2971 Other times, the translator just hasn't got around to doing it yet.
2972 Our localization team, which you may wish to join,
2976 \begin_layout Plain Layout
2977 If you are a fluent speaker of a language other than English, joining these
2978 teams is a great way to give back to the \SpecialChar LyX
2984 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
2988 \begin_layout Section
2989 Translating \SpecialChar LyX
2993 \begin_layout Subsection
2994 Translating the graphical user interface (text messages).
2997 \begin_layout Standard
3000 \begin_inset Flex Code
3003 \begin_layout Plain Layout
3009 library to handle the internationalization of the interface.
3010 To have \SpecialChar LyX
3011 speak your favorite language in all menus and dialogs, you need
3013 \begin_inset Flex Code
3016 \begin_layout Plain Layout
3022 -file for that language.
3023 When this is available, you'll have to generate a
3024 \begin_inset Flex Code
3027 \begin_layout Plain Layout
3033 -file from it and install the
3034 \begin_inset Flex Code
3037 \begin_layout Plain Layout
3044 The process of doing all of this is explained in the documentation for
3046 \begin_inset Flex Code
3049 \begin_layout Plain Layout
3056 It is possible to do this just for yourself, but if you're going to do
3057 it, you might as well share the results of your labors with the rest of
3058 the \SpecialChar LyX
3060 Send a message to the \SpecialChar LyX
3061 developers' list for more information about how
3065 \begin_layout Standard
3066 In short, this is what you should do (xx denotes the language code):
3069 \begin_layout Itemize
3070 Check out the \SpecialChar LyX
3073 \begin_inset CommandInset href
3075 name "information on the web"
3076 target "http://www.lyx.org/HowToUseSVN"
3083 \begin_layout Itemize
3085 \begin_inset Flex Code
3088 \begin_layout Plain Layout
3094 to the folder of the
3095 \begin_inset Flex Code
3098 \begin_layout Plain Layout
3106 \begin_inset Flex Code
3109 \begin_layout Plain Layout
3117 \begin_inset Flex Code
3120 \begin_layout Plain Layout
3126 doesn't exist anywhere, it can be remade with the console command
3127 \begin_inset Flex Code
3130 \begin_layout Plain Layout
3136 in that directory, or you can use an existing po-file for some other language
3140 \begin_layout Itemize
3142 \begin_inset Flex Code
3145 \begin_layout Plain Layout
3155 \begin_layout Plain Layout
3156 This is just a text file, so it can be edited in any text editor.
3157 But there are also specialized programs that support such editing, such
3162 (for all platforms) or
3171 contains a `mode' for editing
3172 \begin_inset Flex Code
3175 \begin_layout Plain Layout
3186 For some menu- and widget-labels, there are also shortcut keys that should
3188 Those keys are marked after a `|', and should be translated according to
3189 the words and phrases of the language.
3190 You should also fill also out the information at the beginning of the new
3192 \begin_inset Flex Code
3195 \begin_layout Plain Layout
3201 -file with your email-address, etc., so people know where to reach you with
3202 suggestions and entertaining flames.
3205 \begin_layout Standard
3206 If you are just doing this on your own, then:
3209 \begin_layout Itemize
3211 \begin_inset Flex Code
3214 \begin_layout Plain Layout
3221 This can be done with
3222 \begin_inset Flex Code
3225 \begin_layout Plain Layout
3226 msgfmt -o xx.mo < xx.po
3234 \begin_layout Itemize
3236 \begin_inset Flex Code
3239 \begin_layout Plain Layout
3245 -file to your locale-tree, at the correct directory for application messages
3250 xx, and under the name
3251 \begin_inset Flex Code
3254 \begin_layout Plain Layout
3261 \begin_inset space \thinspace{}
3265 \begin_inset space \space{}
3269 \begin_inset Flex Code
3272 \begin_layout Plain Layout
3273 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3283 \begin_layout Standard
3284 As said, however, it would be best if the new
3285 \begin_inset Flex Code
3288 \begin_layout Plain Layout
3295 \change_inserted -712698321 1437634626
3297 \change_deleted -712698321 1437634624
3300 file could be added to the \SpecialChar LyX
3301 distribution, so others can use it.
3302 Adding it involves making additional changes to \SpecialChar LyX
3304 So send an email to the developers' mailing list if you're interested in
3308 \begin_layout Subsubsection
3312 \begin_layout Standard
3313 Sometimes it turns out that one English message needs to be translated into
3314 different messages in the target language.
3315 One example is the message
3316 \begin_inset Flex Code
3319 \begin_layout Plain Layout
3325 which has the German translation
3333 , depending upon exactly what the English
3334 \begin_inset Quotes eld
3338 \begin_inset Quotes erd
3343 \begin_inset Flex Code
3346 \begin_layout Plain Layout
3352 does not handle such ambiguous translations.
3353 Therefore you have to add some context information to the message: Instead
3355 \begin_inset Flex Code
3358 \begin_layout Plain Layout
3365 \begin_inset Flex Code
3368 \begin_layout Plain Layout
3369 To[[as in 'From format x to format y']]
3375 \begin_inset Flex Code
3378 \begin_layout Plain Layout
3379 To[[as in 'From page x to page y']].
3384 Now the two occurrences of
3385 \begin_inset Flex Code
3388 \begin_layout Plain Layout
3395 \begin_inset Flex Code
3398 \begin_layout Plain Layout
3404 and can be translated correctly to
3415 \begin_layout Standard
3416 Of course the context information needs to be stripped off the original
3417 message when no translation is used.
3418 Therefore you have to put it in double square brackets at the end of the
3419 message (see the example above).
3420 The translation mechanism of \SpecialChar LyX
3421 ensures that everything in double square
3422 brackets at the end of messages is removed before displaying the message.
3425 \begin_layout Subsection
3426 Translating the documentation.
3429 \begin_layout Standard
3430 The online documentation (in the
3431 \begin_inset Flex MenuItem
3434 \begin_layout Plain Layout
3440 -menu) can (and should!) be translated.
3441 If there are translated versions of the documentation available
3445 \begin_layout Plain Layout
3446 As of March 2008, at least some of the documents have been translated into
3447 fourteen languages, with the Tutorial available in a few more.
3452 and the locale is set accordingly, these will be used automagically by
3456 looks for translated versions as
3457 \begin_inset Flex Code
3460 \begin_layout Plain Layout
3462 \change_deleted -712698321 1437634637
3465 \change_inserted -712698321 1437634639
3468 Dir/doc/xx/DocName.lyx
3474 \begin_inset Flex Code
3477 \begin_layout Plain Layout
3483 is the code for the language currently in use.
3484 If there are no translated documents, the default English versions will
3486 Note that the translated versions must have the same filenames (
3487 \begin_inset Flex Code
3490 \begin_layout Plain Layout
3496 above) as the original.
3497 If you feel up to translating the documentation (an excellent way to proof-read
3498 the original documentation by the way!), there are a few things you should
3502 \begin_layout Itemize
3503 Check out the documentation translation web page at
3504 \begin_inset CommandInset href
3506 name "http://www.lyx.org/Translation"
3507 target "http://www.lyx.org/Translation"
3512 That way, you can find out which (if any) documents have already been translate
3513 d into your language.
3514 You can also find out who (if anyone) is organizing the effort to translate
3515 the documentation into your language.
3516 If no one is organizing the effort, please let us know that you're interested.
3519 \begin_layout Standard
3520 Once you get to actually translating, here's a few hints for you that may
3524 \begin_layout Itemize
3525 Join the documentation team! There is information on how to do that in
3526 \begin_inset Flex Code
3529 \begin_layout Plain Layout
3536 \begin_inset Flex MenuItem
3539 \begin_layout Plain Layout
3540 Help\SpecialChar menuseparator
3546 ), which by the way is the first document you should translate.
3549 \begin_layout Itemize
3550 Learn the typographic conventions for the language you are translating to.
3551 Typography is an ancient art and over the centuries, a great variety of
3552 conventions have developed throughout different parts of the world.
3553 Also study the professional terminology amongst typographers in your country.
3554 Inventing your own terminology will only confuse the users.
3557 (Warning! Typography is addictive!)
3560 \begin_layout Itemize
3561 Make a copy of the document.
3562 This will be your working copy.
3563 You can use this as your personal translated help-file by placing it in
3565 \begin_inset Flex Code
3568 \begin_layout Plain Layout
3577 \begin_layout Itemize
3578 Sometimes the original document (from the \SpecialChar LyX
3580 \change_inserted -712698321 1437634643
3582 \change_deleted -712698321 1437634643
3585 team) will be updated.
3586 Use the source viewer at
3587 \begin_inset CommandInset href
3589 name "http://www.lyx.org/trac/timeline"
3590 target "http://www.lyx.org/trac/timeline"
3594 to see what has been changed.
3595 That way you can easily see which parts of the translated document need
3599 \begin_layout Standard
3600 If you ever find an error in the original document, fix it and notify the
3601 rest of the documentation team of the changes! (You didn't forget to join
3602 the documentation team, did you?)
3605 \begin_layout Standard
3606 \begin_inset Branch OutDated
3609 \begin_layout Section
3610 International Keyboard Support
3613 \begin_layout Standard
3616 [Editor's Note: The following section is by
3624 It needs to be fixed to conform to the new Documentation Style sheet and
3625 to make use of the new v1.0 features.
3626 The whole thing also needs to be merged with the section following it.-jw
3627 It may also be badly out of date.-rh (2008)]
3630 \begin_layout Subsection
3631 Defining Own Keymaps: Keymap File Format
3634 \begin_layout Standard
3635 Let's look at a keyboard definition file a little closer.
3636 It is a plain text file defining
3639 \begin_layout Itemize
3640 key-to-key or key-to-string translations
3643 \begin_layout Itemize
3647 \begin_layout Itemize
3648 dead keys exceptions
3651 \begin_layout Standard
3652 To define key-to-key or key-to-string translation, use this command:
3655 \begin_layout Quotation
3656 \begin_inset Flex Code
3659 \begin_layout Plain Layout
3668 \begin_inset Flex Code
3671 \begin_layout Plain Layout
3680 \begin_layout Standard
3682 \begin_inset Flex Code
3685 \begin_layout Plain Layout
3691 is the key to be translated and
3692 \begin_inset Flex Code
3695 \begin_layout Plain Layout
3701 is the string to be inserted into the document.
3702 To define dead keys, use:
3705 \begin_layout Quotation
3706 \begin_inset Flex Code
3709 \begin_layout Plain Layout
3718 \begin_inset Flex Code
3721 \begin_layout Plain Layout
3730 \begin_layout Standard
3732 \begin_inset Flex Code
3735 \begin_layout Plain Layout
3741 is a keyboard key and
3742 \begin_inset Flex Code
3745 \begin_layout Plain Layout
3752 The following dead keys are supported (shortcut name is in parentheses):
3755 \begin_layout Quotation
3759 \begin_inset space \hfill{}
3765 \begin_layout Quotation
3767 \begin_inset space \hfill{}
3773 \begin_layout Quotation
3775 \begin_inset space \hfill{}
3781 \begin_layout Quotation
3783 \begin_inset space \hfill{}
3789 \begin_layout Quotation
3791 \begin_inset space \hfill{}
3797 \begin_layout Quotation
3799 \begin_inset space \hfill{}
3806 \begin_layout Plain Layout
3818 \begin_layout Quotation
3820 \begin_inset space \hfill{}
3826 \begin_layout Quotation
3828 \begin_inset space \hfill{}
3835 \begin_layout Plain Layout
3847 \begin_layout Quotation
3849 \begin_inset space \hfill{}
3855 \begin_layout Quotation
3857 \begin_inset space \hfill{}
3863 \begin_layout Quotation
3865 \begin_inset space \hfill{}
3872 \begin_layout Plain Layout
3884 \begin_layout Quotation
3886 \begin_inset space \hfill{}
3893 \begin_layout Plain Layout
3905 \begin_layout Quotation
3907 \begin_inset space \hfill{}
3913 \begin_layout Quotation
3914 hungarian umlaut (hug)
3915 \begin_inset space \hfill{}
3921 \begin_layout Quotation
3923 \begin_inset space \hfill{}
3929 \begin_layout Quotation
3931 \begin_inset space \hfill{}
3938 \begin_layout Plain Layout
3950 \begin_layout Standard
3951 Since in many international keyboards there are exceptions to what some
3952 dead keys should do, you can define them using
3955 \begin_layout Quotation
3956 \begin_inset Flex Code
3959 \begin_layout Plain Layout
3967 deadkey key outstring
3970 \begin_layout Standard
3971 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
3975 \begin_layout Quotation
3976 \begin_inset Flex Code
3979 \begin_layout Plain Layout
3992 \begin_layout Standard
3993 to make it work correctly.
3994 Also, you have to define as exceptions dead keys over i and j, to remove
3995 the dot from them before inserting an accent mark.
3996 I will change this when the time comes, but so far I haven't had time.
3999 \begin_layout Standard
4000 Oh, and about characters: backslash is escaped, so to enter it, you'll need
4003 \begin_inset Flex Code
4006 \begin_layout Plain Layout
4012 have different meaning.
4014 \begin_inset Flex Code
4017 \begin_layout Plain Layout
4023 marks comments, quotes start and end \SpecialChar LaTeX
4025 To enter quote, you'll need to use
4026 \begin_inset Flex Code
4029 \begin_layout Plain Layout
4038 \begin_inset Flex Code
4041 \begin_layout Plain Layout
4048 \begin_inset Flex Code
4051 \begin_layout Plain Layout
4062 \begin_layout Standard
4063 If you make a keyboard description file that works for your language, please
4064 mail it to me, so I can include it in the next keymap distribution.
4067 \begin_layout Standard
4068 More keywords will be supported in keymap configuration file in future,
4072 \begin_layout Itemize
4073 \begin_inset Flex Code
4076 \begin_layout Plain Layout
4087 \begin_inset space \hfill{}
4091 \begin_inset Flex Code
4094 \begin_layout Plain Layout
4103 \begin_layout Itemize
4104 \begin_inset Flex Code
4107 \begin_layout Plain Layout
4118 \begin_inset space \hfill{}
4122 \begin_inset Flex Code
4125 \begin_layout Plain Layout
4131 an external keymap translation program
4134 \begin_layout Standard
4135 Also, it should look into
4136 \begin_inset Flex Code
4139 \begin_layout Plain Layout
4145 file for defaults, too (for example, a
4146 \begin_inset Flex Code
4149 \begin_layout Plain Layout
4157 option to include default keyboard).
4165 \begin_layout Section
4166 International Keymap Stuff
4167 \begin_inset CommandInset label
4169 name "sec:International-Keymap-Stuff"
4176 \begin_layout Standard
4177 \begin_inset Note Note
4180 \begin_layout Plain Layout
4181 In doing the revisions on this document in March 2008, I did not look over
4182 this stuff, as I do not understand it.
4183 It would be good if someone else could do so.
4192 \begin_layout Standard
4193 The next two sections describe the
4194 \begin_inset Flex Code
4197 \begin_layout Plain Layout
4206 \begin_inset Flex Code
4209 \begin_layout Plain Layout
4217 file syntax in detail.
4218 These sections should help you design your own key map if the ones provided
4219 do not meet your needs.
4222 \begin_layout Subsection
4226 \begin_layout Standard
4230 \begin_inset Flex Code
4233 \begin_layout Plain Layout
4239 file maps keystrokes to characters or strings.
4240 As the name suggests, it sets a keyboard mapping.
4242 \begin_inset Flex Code
4245 \begin_layout Plain Layout
4256 \begin_inset Flex Code
4259 \begin_layout Plain Layout
4274 \begin_inset Flex Code
4277 \begin_layout Plain Layout
4290 \begin_inset Flex Code
4293 \begin_layout Plain Layout
4302 \begin_inset Flex Code
4305 \begin_layout Plain Layout
4313 are described in this section.
4316 \begin_layout Labeling
4317 \labelwidthstring 00.00.0000
4318 \begin_inset Flex Code
4321 \begin_layout Plain Layout
4329 Map a character to a string
4332 \begin_layout LyX-Code
4347 \begin_layout Standard
4380 the double-quote (")
4397 must be escaped with a preceding backslash (
4408 \begin_layout Standard
4410 \begin_inset Flex MenuItem
4413 \begin_layout Plain Layout
4421 statement to cause the symbol
4422 \begin_inset Flex MenuItem
4425 \begin_layout Plain Layout
4433 to be output for the keystroke
4434 \begin_inset Flex MenuItem
4437 \begin_layout Plain Layout
4448 \begin_layout LyX-Code
4454 \begin_layout Labeling
4455 \labelwidthstring 00.00.0000
4456 \begin_inset Flex Code
4459 \begin_layout Plain Layout
4467 Specify an accent character
4470 \begin_layout LyX-Code
4479 \begin_layout Standard
4480 This will make the cha
4518 This is the dead key
4522 \begin_layout Plain Layout
4529 refers to a key that does not produce a character by itself, but when followed
4530 with another key, produces the desired accent character.
4531 For example, a German characte
4533 r with an umlaut like
4543 can be produced in this manner.
4552 \begin_layout Standard
4565 and then another key not in
4582 followed by the other, not allowed key, as output.
4586 \begin_inset Flex MenuItem
4589 \begin_layout Plain Layout
4597 cancels a dead key, so if
4608 \begin_inset Flex MenuItem
4611 \begin_layout Plain Layout
4620 , the cursor will not go one position backwards but will instead cancel
4636 might have had on the next keystroke.
4640 \begin_layout Standard
4641 The following example specifies that the character ' is to be an acute accent,
4642 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4645 \begin_layout LyX-Code
4648 kmod ' acute aeiouAEIOU
4651 \begin_layout Labeling
4652 \labelwidthstring 00.00.0000
4653 \begin_inset Flex Code
4656 \begin_layout Plain Layout
4662 Specify an exception to the accent character
4665 \begin_layout LyX-Code
4674 \begin_layout Standard
4675 This defines an exce
4716 have been assigned a keystroke with a previous
4719 \begin_inset Flex Code
4722 \begin_layout Plain Layout
4746 must not belong in the
4793 If such a declaration does not exist in
4801 \begin_inset Flex Code
4804 \begin_layout Plain Layout
4838 \begin_inset Flex Code
4841 \begin_layout Plain Layout
4855 \begin_layout Standard
4856 The following command produces causes äi to be produced when you enter acute-i
4860 \begin_layout LyX-Code
4874 \begin_layout Labeling
4875 \labelwidthstring 00.00.0000
4876 \begin_inset Flex Code
4879 \begin_layout Plain Layout
4885 Combine two accent characters
4888 \begin_layout LyX-Code
4894 accent1 accent2 allowed
4897 \begin_layout Standard
4898 This one is getting pretty esoteric.
4899 It allows you to combine the effect
4955 \begin_inset Flex Code
4958 \begin_layout Plain Layout
4986 \begin_layout Standard
4987 Consider this example from the
4988 \begin_inset Flex Code
4991 \begin_layout Plain Layout
5002 \begin_layout LyX-Code
5005 kmod ; acute aeioyvhAEIOYVH
5009 kcomb acute umlaut iyIY
5012 \begin_layout Standard
5013 This allows you to press
5014 \begin_inset Flex MenuItem
5017 \begin_layout Plain Layout
5025 and get the effect of
5026 \begin_inset Flex Code
5029 \begin_layout Plain Layout
5048 in this case cancels the last dead key, so if you press
5049 \begin_inset Flex MenuItem
5052 \begin_layout Plain Layout
5061 \begin_inset Flex Code
5064 \begin_layout Plain Layout
5077 \begin_layout Subsection
5081 \begin_layout Standard
5083 \begin_inset Flex Code
5086 \begin_layout Plain Layout
5094 mapping is performed, a
5095 \begin_inset Flex Code
5098 \begin_layout Plain Layout
5108 file maps the strings that the symbols generate to characters in the current
5110 The \SpecialChar LyX
5111 distribution currently includes at least the
5112 \begin_inset Flex Code
5115 \begin_layout Plain Layout
5124 \begin_inset Flex Code
5127 \begin_layout Plain Layout
5138 \begin_layout Standard
5140 \begin_inset Flex Code
5143 \begin_layout Plain Layout
5151 file is a sequence of declarations of the form
5154 \begin_layout LyX-Code
5167 \begin_layout Standard
5168 For example, in order to map
5169 \begin_inset Flex MenuItem
5172 \begin_layout Plain Layout
5182 to the corresponding character in the iso-8859-1 set (233), the following
5186 \begin_layout LyX-Code
5194 \begin_layout Standard
5196 \begin_inset Flex Code
5199 \begin_layout Plain Layout
5208 \begin_inset Flex Code
5211 \begin_layout Plain Layout
5229 the same character can apply to more than one string.
5231 \begin_inset Flex Code
5234 \begin_layout Plain Layout
5245 \begin_layout LyX-Code
5257 \begin_inset Newline newline
5273 \begin_layout Standard
5275 cannot find a mapping for the string produced by the keystroke or a
5276 deadkey sequence, it will check if it looks like an accented char and try
5277 to draw an accent over the character on screen.
5280 \begin_layout Subsection
5284 \begin_layout Standard
5285 There is a second way to add support for international characters through
5286 so-called dead-keys.
5287 A dead-key works in combination with a letter to produce an accented character.
5288 Here, we'll explain how to create a really simple dead-key to illustrate
5292 \begin_layout Standard
5293 Suppose you happen to need the circumflex character,
5294 \begin_inset Quotes eld
5298 \begin_inset Quotes erd
5303 \begin_inset Flex MenuItem
5306 \begin_layout Plain Layout
5313 \begin_inset space ~
5317 \begin_inset Flex MenuItem
5320 \begin_layout Plain Layout
5326 ] to the \SpecialChar LyX
5328 \begin_inset Flex Code
5331 \begin_layout Plain Layout
5338 \begin_inset Flex Code
5341 \begin_layout Plain Layout
5348 Now, whenever you type the
5349 \begin_inset Flex MenuItem
5352 \begin_layout Plain Layout
5358 -key followed by a letter, that letter will have a circumflex accent on
5360 For example, the sequence
5361 \begin_inset Quotes eld
5365 \begin_inset Flex MenuItem
5368 \begin_layout Plain Layout
5375 \begin_inset Quotes erd
5378 produces the letter:
5379 \begin_inset Quotes eld
5383 \begin_inset Quotes erd
5387 If you tried to type
5388 \begin_inset Quotes eld
5392 \begin_inset Flex MenuItem
5395 \begin_layout Plain Layout
5402 \begin_inset Quotes erd
5405 , however, \SpecialChar LyX
5406 will complain with a beep, since a
5407 \begin_inset Quotes eld
5411 \begin_inset Flex MenuItem
5414 \begin_layout Plain Layout
5421 \begin_inset Quotes erd
5424 never takes a circumflex accent.
5426 \begin_inset Flex MenuItem
5429 \begin_layout Plain Layout
5435 after a dead-key produces the bare-accent.
5436 Please note this last point! If you bind a key to a dead-key, you'll need
5437 to rebind the character on that key to yet another key.
5439 \begin_inset Flex MenuItem
5442 \begin_layout Plain Layout
5448 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5451 \begin_layout Standard
5452 One common way to bind dead-keys is to use
5453 \begin_inset Flex MenuItem
5456 \begin_layout Plain Layout
5463 \begin_inset Flex MenuItem
5466 \begin_layout Plain Layout
5473 \begin_inset Flex MenuItem
5476 \begin_layout Plain Layout
5482 in combination with an accent, like
5483 \begin_inset Quotes eld
5487 \begin_inset Flex MenuItem
5490 \begin_layout Plain Layout
5497 \begin_inset Quotes erd
5501 \begin_inset Quotes eld
5505 \begin_inset Flex MenuItem
5508 \begin_layout Plain Layout
5515 \begin_inset Quotes erd
5519 \begin_inset Quotes eld
5523 \begin_inset Flex MenuItem
5526 \begin_layout Plain Layout
5533 \begin_inset Quotes erd
5537 Another way involves using
5538 \begin_inset Flex Code
5541 \begin_layout Plain Layout
5548 \begin_inset Flex Code
5551 \begin_layout Plain Layout
5557 to set up the special
5558 \begin_inset Flex Code
5561 \begin_layout Plain Layout
5569 \begin_inset Flex Code
5572 \begin_layout Plain Layout
5578 acts in some ways just like
5579 \begin_inset Flex MenuItem
5582 \begin_layout Plain Layout
5588 and permits you to bind keys to accented characters.
5589 You can also turn keys into dead-keys by binding them to something like
5591 \begin_inset Flex Code
5594 \begin_layout Plain Layout
5600 and then binding this symbolic key to the corresponding \SpecialChar LyX
5605 \begin_layout Plain Layout
5610 : This is exactly what I do in my
5611 \begin_inset Flex Code
5614 \begin_layout Plain Layout
5621 \begin_inset Flex Code
5624 \begin_layout Plain Layout
5632 \begin_inset Flex MenuItem
5635 \begin_layout Plain Layout
5637 \begin_inset space ~
5646 \begin_inset Flex Code
5649 \begin_layout Plain Layout
5655 and a bunch of these
5656 \begin_inset Quotes eld
5660 \begin_inset Flex Code
5663 \begin_layout Plain Layout
5670 \begin_inset Quotes erd
5673 symbolic keys bound such things as
5674 \begin_inset Flex MenuItem
5677 \begin_layout Plain Layout
5679 \begin_inset space ~
5688 \begin_inset Flex MenuItem
5691 \begin_layout Plain Layout
5693 \begin_inset space ~
5702 This is how I produce my accented characters.
5707 You can make just about anything into the
5708 \begin_inset Flex Code
5711 \begin_layout Plain Layout
5718 \begin_inset Flex MenuItem
5721 \begin_layout Plain Layout
5727 keys, a spare function key, etc.
5728 As for the \SpecialChar LyX
5729 commands that produce accents, check the entry for
5730 \begin_inset Flex Code
5733 \begin_layout Plain Layout
5744 You'll find the complete list there.
5747 \begin_layout Subsection
5748 Saving your Language Configuration
5751 \begin_layout Standard
5752 You can edit your preferences so that your desired language environment
5753 is automatically configured when \SpecialChar LyX
5755 \begin_inset Flex MenuItem
5758 \begin_layout Plain Layout
5759 Edit\SpecialChar menuseparator
5768 \begin_layout Chapter
5769 Installing New Document Classes, Layouts, and Templates
5770 \begin_inset CommandInset label
5772 name "cha:Installing-New-Document"
5777 \begin_inset Argument 1
5780 \begin_layout Plain Layout
5781 Installing New Document Classes
5789 \begin_layout Standard
5790 In this chapter, we describe the procedures for creating and installing
5791 new \SpecialChar LyX
5792 layout and template files, as well as offer a refresher on correctly
5793 installing new \SpecialChar LaTeX
5798 \begin_layout Standard
5799 First, let us a say a few words about how one ought to think about the relation
5800 between \SpecialChar LyX
5801 and \SpecialChar LaTeX
5803 The thing to understand is that, in a certain sense, \SpecialChar LyX
5804 doesn't know anything
5805 about \SpecialChar LaTeX
5807 Indeed, from \SpecialChar LyX
5808 's point of view, \SpecialChar LaTeX
5809 is just one of several
5810 \begin_inset Quotes eld
5814 \begin_inset Quotes erd
5817 in which it is capable of producing output.
5818 Other such formats are DocBook, plaintext, and XHTML.
5820 is, of course, a particularly important format, but very little of the
5821 information \SpecialChar LyX
5822 has about \SpecialChar LaTeX
5823 is actually contained in the program itself.
5827 \begin_layout Plain Layout
5828 Some commands are sufficiently complex that they are
5829 \begin_inset Quotes eld
5833 \begin_inset Quotes erd
5836 into \SpecialChar LyX
5838 But the developers generally regard this as a Bad Thing.
5843 Rather, that information, even for the standard classes like
5844 \begin_inset Flex Code
5847 \begin_layout Plain Layout
5853 , is contained in `layout files'.
5854 Similarly, \SpecialChar LyX
5855 itself does not know much about DocBook or XHTML.
5856 What it knows is contained in layout files.
5859 \begin_layout Standard
5860 You can think of the layout file for a given document class as a translation
5861 manual between \SpecialChar LyX
5862 constructs—paragraphs with their corresponding styles,
5863 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
5866 Almost everything \SpecialChar LyX
5868 \begin_inset Flex Code
5871 \begin_layout Plain Layout
5877 , for example, is contained in the file
5878 \begin_inset Flex Code
5881 \begin_layout Plain Layout
5887 and in various other files it includes.
5888 For this reason, anyone intending to write layout files should plan to
5889 study the existing files.
5890 A good place to start is with
5891 \begin_inset Flex Code
5894 \begin_layout Plain Layout
5900 , which is included in
5901 \begin_inset Flex Code
5904 \begin_layout Plain Layout
5911 \begin_inset Flex Code
5914 \begin_layout Plain Layout
5920 , and many of the other layout files for document classes.
5921 This file is where sections and the like are defined:
5922 \begin_inset Flex Code
5925 \begin_layout Plain Layout
5931 tells \SpecialChar LyX
5932 how paragraphs that are marked with the Section, Subsection, etc,
5933 styles can be translated into corresponding \SpecialChar LaTeX
5934 , DocBook, and XHTML commands
5937 \begin_inset Flex Code
5940 \begin_layout Plain Layout
5946 file basically just includes several of these
5947 \begin_inset Flex Code
5950 \begin_layout Plain Layout
5959 \begin_layout Standard
5960 Defining the \SpecialChar LyX
5962 correspondence is not the only thing layout files do, though.
5963 Their other job is to define how the \SpecialChar LyX
5964 constructs themselves will appear
5966 The fact that layout files have these two jobs is often a source of confusion,
5967 because they are completely separate.
5968 Telling \SpecialChar LyX
5969 how to translate a certain paragraph style into \SpecialChar LaTeX
5972 how to display it; conversely, telling \SpecialChar LyX
5973 how to display a certain paragraph
5974 style does not tell \SpecialChar LyX
5975 how to translate it into \SpecialChar LaTeX
5976 (let alone tell \SpecialChar LaTeX
5979 So, in general, when you define a new \SpecialChar LyX
5980 construct, you must always do two
5981 quite separate things: (i)
5982 \begin_inset space ~
5985 tell \SpecialChar LyX
5986 how to translate it into \SpecialChar LaTeX
5988 \begin_inset space ~
5991 tell \SpecialChar LyX
5995 \begin_layout Standard
5996 Much the same is true, of course, as regards \SpecialChar LyX
5997 's other backend formats, though
5998 XHTML is in some ways different, because in that case \SpecialChar LyX
6003 able, to some extent, to use information about how it should display a
6004 paragraph on the screen to output information (in the form of CSS) about
6005 how the paragraph should be displayed in a browser.
6006 Even in this case, however, the distinction between what \SpecialChar LyX
6008 and how things are rendered externally remains in force, and the two can
6009 be controlled separately.
6011 \begin_inset CommandInset ref
6013 reference "sec:Tags-for-XHTML"
6020 \begin_layout Section
6021 Installing new \SpecialChar LaTeX
6025 \begin_layout Standard
6026 Some installations may not include a \SpecialChar LaTeX
6027 package or class file that you would
6028 like to use within \SpecialChar LyX
6030 For example, you might need Foil\SpecialChar TeX
6031 , a package for preparing slides for overhead
6033 Modern \SpecialChar LaTeX
6034 distributions like \SpecialChar TeX
6035 Live (2008 or newer) or MiK\SpecialChar TeX
6036 provide a user interface
6037 for installing such packages.
6038 For example, with MiK\SpecialChar TeX
6039 , you start the program
6040 \begin_inset Quotes eld
6044 \begin_inset space ~
6048 \begin_inset Quotes erd
6051 to get a list of available packages.
6052 To install one of them, right click on it or use the corresponding toolbar
6056 \begin_layout Standard
6057 If your \SpecialChar LaTeX
6058 distribution does not provide such a `package manager', or if the
6059 package is not available from your distribution, then follow these steps
6060 to install it manually:
6063 \begin_layout Enumerate
6064 Get the package from
6065 \begin_inset CommandInset href
6068 target "http://www.ctan.org/"
6075 \begin_layout Enumerate
6076 If the package contains a file with the ending
6077 \begin_inset Quotes eld
6081 \begin_inset Flex Code
6084 \begin_layout Plain Layout
6091 \begin_inset Quotes erd
6094 (is the case for Foil\SpecialChar TeX
6095 ) then open a console, change to the folder of this
6096 file and execute the command
6097 \begin_inset Flex Code
6100 \begin_layout Plain Layout
6107 You have now unpacked the package and have all files to install it.
6108 Most \SpecialChar LaTeX
6109 -packages are not packed and you can skip this step.
6112 \begin_layout Enumerate
6113 Now you need to decide if the package should be available for all users
6115 \begin_inset Separator parbreak
6122 \begin_layout Enumerate
6123 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6124 for all users on your system, then install it in your `local' \SpecialChar TeX
6126 install it in your own `user' \SpecialChar TeX
6128 Where these trees should be created, if they do not already exist, depends
6130 To find this out, look in the file
6131 \begin_inset Flex Code
6134 \begin_layout Plain Layout
6144 \begin_layout Plain Layout
6145 This is usually in the directory
6146 \begin_inset Flex Code
6149 \begin_layout Plain Layout
6155 , though you can execute the command
6156 \begin_inset Flex Code
6159 \begin_layout Plain Layout
6170 The location of the `local' \SpecialChar TeX
6171 tree is defined by the
6172 \begin_inset Flex Code
6175 \begin_layout Plain Layout
6181 variable; this is usually somewhere like
6182 \begin_inset Flex Code
6185 \begin_layout Plain Layout
6186 /usr/local/share/texmf
6192 The location of the `user' \SpecialChar TeX
6194 \begin_inset Flex Code
6197 \begin_layout Plain Layout
6204 \begin_inset Flex Code
6207 \begin_layout Plain Layout
6214 (If these variables are not predefined, you have to define them.) You'll
6215 probably need root permissions to create or modify the `local' tree, but
6216 not for your `user' tree.
6217 \begin_inset Newline newline
6220 In general, it is recommended to install in the user tree because your user
6221 will not be modified or even overwritten when you upgrade your system.
6222 It will typically also be backed up together with everything else when
6223 you backup your home directory (which, of course, you do on a regular basis).
6226 \begin_layout Enumerate
6227 On Windows, if you want the new package to be available for all users on
6228 your system, change to the folder where \SpecialChar LaTeX
6229 is installed and then change to
6231 \begin_inset Flex Code
6234 \begin_layout Plain Layout
6245 (For MiK\SpecialChar TeX
6246 , this would be by default the folder
6247 \begin_inset Flex Code
6250 \begin_layout Plain Layout
6256 \change_deleted -712698321 1437634323
6259 \change_inserted -712698321 1437634327
6275 \begin_layout Plain Layout
6276 Note that this will be the correct path only on English installations.
6277 On a German one, it would be
6278 \begin_inset Flex Code
6281 \begin_layout Plain Layout
6287 \change_deleted -712698321 1437634336
6290 \change_inserted -712698321 1437634337
6302 , and similarly for other languages.
6307 Create there a new folder
6308 \begin_inset Flex Code
6311 \begin_layout Plain Layout
6317 and copy all files of the package into it.
6319 \begin_inset Newline newline
6322 If the package should only available for you or you don't have admin permissions
6323 , do the same, but in the local \SpecialChar LaTeX
6326 \begin_inset space \thinspace{}
6329 g., for MiK\SpecialChar TeX
6331 \begin_inset space ~
6334 2.8 under Windows XP, this would be the folder:
6335 \begin_inset Newline newline
6341 \begin_inset Flex Code
6344 \begin_layout Plain Layout
6347 Documents and Settings
6359 \begin_inset Newline newline
6365 \begin_inset Phantom HPhantom
6368 \begin_layout Plain Layout
6379 \begin_inset Flex Code
6382 \begin_layout Plain Layout
6384 \change_deleted -712698321 1437634345
6387 \change_inserted -712698321 1437634347
6402 \begin_inset Newline newline
6405 On Vista, it would be:
6406 \begin_inset Newline newline
6410 \begin_inset Flex Code
6413 \begin_layout Plain Layout
6427 \change_inserted -712698321 1437634351
6429 \change_deleted -712698321 1437634351
6446 \begin_layout Enumerate
6447 Now one only need to tell \SpecialChar LaTeX
6448 that there are new files.
6449 This depends on the used \SpecialChar LaTeX
6451 \begin_inset Separator parbreak
6458 \begin_layout Enumerate
6459 For \SpecialChar TeX
6460 Live execute the command
6461 \begin_inset Flex Code
6464 \begin_layout Plain Layout
6471 If you installed the package for all users, then you will probably need
6472 to have root permissions for that.
6475 \begin_layout Enumerate
6476 For MiK\SpecialChar TeX
6477 , if you have installed the package for all users, start the program
6479 \begin_inset Quotes eld
6483 \begin_inset space ~
6487 \begin_inset Quotes erd
6490 and press the button marked
6491 \begin_inset Quotes eld
6495 \begin_inset Quotes erd
6499 Otherwise start the program
6500 \begin_inset Quotes eld
6504 \begin_inset Quotes erd
6511 \begin_layout Enumerate
6512 Finally, you need to tell \SpecialChar LyX
6513 that there are new packages available.
6514 So, in \SpecialChar LyX
6516 \begin_inset Flex MenuItem
6519 \begin_layout Plain Layout
6522 \SpecialChar menuseparator
6528 and then restart \SpecialChar LyX
6532 \begin_layout Standard
6533 Now the package is installed.
6534 In our example, the document class
6535 \begin_inset Flex Code
6538 \begin_layout Plain Layout
6540 \begin_inset space ~
6544 \change_deleted -712698321 1437634694
6549 \begin_layout Plain Layout
6563 will now be available under
6564 \begin_inset Flex MenuItem
6567 \begin_layout Plain Layout
6568 Document\SpecialChar menuseparator
6569 Settings\SpecialChar menuseparator
6579 \begin_layout Standard
6580 If you would like to use a \SpecialChar LaTeX
6581 document class that is not even listed in the
6583 \begin_inset Flex MenuItem
6586 \begin_layout Plain Layout
6587 Document\SpecialChar menuseparator
6588 Settings\SpecialChar menuseparator
6594 , then you need to create a `layout' file for it.
6595 That is the topic of the next section.
6598 \begin_layout Section
6599 Types of layout files
6602 \begin_layout Standard
6603 This section describes the various sorts of \SpecialChar LyX
6604 files that contain layout informati
6606 These files describe various paragraph and character styles, determining
6607 how \SpecialChar LyX
6608 should display them and how they should be translated into \SpecialChar LaTeX
6610 XHTML, or whatever output format is being used.
6614 \begin_layout Standard
6615 We shall try to provide a thorough description of the process of writing
6617 However, there are so many different types of documents supported even
6618 by just \SpecialChar LaTeX
6619 that we can't hope to cover every different possibility or problem
6620 you might encounter.
6621 The \SpecialChar LyX
6622 users' list is frequented by people with lots of experience with layout
6623 design who are willing to share what they've learned, so please feel free
6624 to ask questions there.
6627 \begin_layout Standard
6628 As you prepare to write a new layout, it is extremely helpful to look at
6629 the layouts distributed with \SpecialChar LyX
6631 If you write a \SpecialChar LyX
6632 layout for a \SpecialChar LaTeX
6633 document class that might also be used by
6634 others, or write a module that might be useful to others, then you should
6635 consider posting your layout to the
6636 \begin_inset CommandInset href
6638 name "layout section on the LyX wiki"
6639 target "http://wiki.lyx.org/Layouts/Layouts"
6643 or even to the \SpecialChar LyX
6644 developers' list, so that it might be included in \SpecialChar LyX
6649 \begin_layout Plain Layout
6650 Note that \SpecialChar LyX
6651 is licensed under the General Public License, so any material
6652 that is contributed to \SpecialChar LyX
6653 must be similarly licensed.
6661 \begin_layout Subsection
6663 \begin_inset CommandInset label
6665 name "subsec:Layout-modules"
6672 \begin_layout Standard
6673 We have spoken to this point about `layout files'.
6674 But there are different sorts of files that contain layout information.
6675 Layout files, strictly so called, have the
6676 \begin_inset Flex Code
6679 \begin_layout Plain Layout
6685 extension and provide \SpecialChar LyX
6686 with information about document classes.
6687 Since \SpecialChar LyX
6688 1.6 layout information can also be contained in layout
6693 \begin_inset Flex Code
6696 \begin_layout Plain Layout
6703 Modules are to \SpecialChar LaTeX
6704 packages much as layouts are to \SpecialChar LaTeX
6705 classes, and some modules—such
6707 \begin_inset Flex Code
6710 \begin_layout Plain Layout
6716 module—specifically provide support for one package.
6717 In a sense, layout modules are similar to included
6721 \begin_layout Plain Layout
6722 These can have any extension, but by convention have the
6723 \begin_inset Flex Code
6726 \begin_layout Plain Layout
6738 \begin_inset Flex Code
6741 \begin_layout Plain Layout
6747 —in that modules are not specific to a given document class but may be used
6748 with many different classes.
6749 The difference is that using an included file with
6750 \begin_inset Flex Code
6753 \begin_layout Plain Layout
6759 requires editing that file.
6760 Modules, by contrast, are selected in the
6761 \begin_inset Flex MenuItem
6764 \begin_layout Plain Layout
6765 Document\SpecialChar menuseparator
6774 \begin_layout Standard
6775 Building modules is the easiest way to get started with layout editing,
6776 since it can be as simple as adding a single new paragraph style or flex
6778 But modules may, in principle, contain anything a layout file can contain.
6781 \begin_layout Standard
6782 After creating a new module and copying it to the
6783 \begin_inset Flex Code
6786 \begin_layout Plain Layout
6792 folder, you will need to reconfigure and then restart \SpecialChar LyX
6795 However, changes you make to the module will be seen immediately, if you
6797 \begin_inset Flex MenuItem
6800 \begin_layout Plain Layout
6801 Document\SpecialChar menuseparator
6807 , highlight something, and then hit
6808 \begin_inset Quotes eld
6812 \begin_inset Quotes erd
6818 It is strongly recommended that you save your work before doing this
6823 it is strongly recommended that you not attempt to edit modules while simultaneo
6824 usly working on actual documents
6827 Though of course the developers strive to keep \SpecialChar LyX
6828 stable in such situations,
6829 syntax errors and the like in your module file could cause strange behavior.
6832 \begin_layout Subsubsection
6836 \begin_layout Standard
6837 Modules are to \SpecialChar LyX
6838 as packages are to \SpecialChar LaTeX
6840 Sometimes, however, you find yourself wanting a specific inset or character
6841 style just for one document and writing a module that will also be available
6842 to other documents makes little sense.
6843 What you need is \SpecialChar LyX
6845 \begin_inset Quotes eld
6849 \begin_inset Quotes erd
6855 \begin_layout Standard
6856 You will find it under
6858 Document\SpecialChar menuseparator
6859 Settings\SpecialChar menuseparator
6863 The large text box allows you to enter anything that you might enter in
6864 a layout file or module.
6865 You can think of a document's local layout, in fact, as a module that belongs
6867 So, in particular, you must enter a
6868 \begin_inset Flex Code
6871 \begin_layout Plain Layout
6878 Any format is acceptable, but one would normally use the format current
6880 (In \SpecialChar LyX
6881 2.1, the current layout format is 48.) You should be aware that local
6882 layout is not supported by versions of \SpecialChar LyX
6883 prior to 1.6, so you should not
6884 use it if you want to be able to export your document to \SpecialChar LyX
6886 (without, that is, losing the local layout information).
6887 If you wish to be able to export to 1.6—local layout is supported in 1.6,
6888 though there is no UI for it—then you should use format 11 and, of course,
6889 use only layout constructs that were available in \SpecialChar LyX
6893 \begin_layout Standard
6894 When you have entered something in the
6895 \begin_inset Flex Code
6898 \begin_layout Plain Layout
6904 pane, \SpecialChar LyX
6906 \begin_inset Quotes eld
6910 \begin_inset Quotes erd
6913 button at the bottom.
6914 Clicking this button will cause \SpecialChar LyX
6915 to determine whether what you have entered
6916 is valid layout information for the chosen format.
6918 will report the result but, unfortunately, will not tell you what errors
6919 there might have been.
6920 These will be written to the terminal, however, if \SpecialChar LyX
6921 is started from a terminal.
6922 You will not be permitted to save your local layout until you have entered
6926 \begin_layout Standard
6927 The warnings at the end of the previous section apply here, too.
6928 Do not play with local layout while you are actually working, especially
6929 if you have not saved your document.
6930 That said, using local layout with a test document can be a very convenient
6931 way to try out layout ideas, or even to start developing a module.
6934 \begin_layout Subsection
6936 \begin_inset Flex MenuItem
6939 \begin_layout Plain Layout
6948 \begin_layout Standard
6949 There are two situations you are likely to encounter when wanting to support
6950 a new \SpecialChar LaTeX
6951 document class, involving style (
6952 \begin_inset Flex Code
6955 \begin_layout Plain Layout
6961 ) files and \SpecialChar LaTeX2e
6963 \begin_inset Flex Code
6966 \begin_layout Plain Layout
6973 Supporting a style file is usually fairly easy.
6974 Supporting a new class file is a bit harder.
6975 We'll discuss the former in this section and the latter in the next.
6976 Similar remarks apply, of course, if you want to support a new DocBook
6980 \begin_layout Standard
6981 The easier case is the one in which your new document class is provided
6982 as a style file that is to be used in conjunction with an already supported
6984 For the sake of the example, we'll assume that the style file is called
6986 \begin_inset Flex MenuItem
6989 \begin_layout Plain Layout
6995 and that it is meant to be used with
6996 \begin_inset Flex MenuItem
6999 \begin_layout Plain Layout
7005 , which is a standard class.
7009 \begin_layout Standard
7010 Start by copying the existing class's layout file into your local directory:
7014 \begin_layout Plain Layout
7015 Of course, which directory is your local directory will vary by platform,
7016 and \SpecialChar LyX
7017 allows you to specify your local directory on startup, too, using
7019 \begin_inset Flex Code
7022 \begin_layout Plain Layout
7036 \begin_layout LyX-Code
7037 cp report.layout ~/.lyx/layouts/myclass.layout
7040 \begin_layout Standard
7042 \begin_inset Flex Code
7045 \begin_layout Plain Layout
7051 and change the line:
7054 \begin_layout LyX-Code
7057 Declare\SpecialChar LaTeX
7061 \begin_layout Standard
7065 \begin_layout LyX-Code
7068 Declare\SpecialChar LaTeX
7069 Class[report, myclass.sty]{report (myclass)}
7072 \begin_layout Standard
7076 \begin_layout LyX-Code
7078 \begin_inset Newline newline
7084 \begin_inset Newline newline
7090 \begin_layout Standard
7091 near the top of the file.
7094 \begin_layout Standard
7095 Start \SpecialChar LyX
7097 \begin_inset Flex MenuItem
7100 \begin_layout Plain Layout
7101 Tools\SpecialChar menuseparator
7108 Then restart \SpecialChar LyX
7109 and try creating a new document.
7111 \begin_inset Flex MenuItem
7114 \begin_layout Plain Layout
7120 " as a document class option in the
7121 \begin_inset Flex MenuItem
7124 \begin_layout Plain Layout
7125 Document\SpecialChar menuseparator
7132 It is likely that some of the sectioning commands and such in your new
7133 class will work differently from how they worked in the base class—
7134 \begin_inset Flex Code
7137 \begin_layout Plain Layout
7143 in this example—so you can fiddle around with the settings for the different
7144 sections if you wish.
7145 The layout information for sections is contained in
7146 \begin_inset Flex Code
7149 \begin_layout Plain Layout
7155 , but you do not need to copy and change this file.
7156 Instead, you can simply add your changes to your layout file, after the
7158 \begin_inset Flex Code
7161 \begin_layout Plain Layout
7167 , which itself includes
7168 \begin_inset Flex Code
7171 \begin_layout Plain Layout
7178 For example, you might add these lines:
7181 \begin_layout LyX-Code
7185 \begin_layout LyX-Code
7189 \begin_layout LyX-Code
7193 \begin_layout LyX-Code
7197 \begin_layout LyX-Code
7201 \begin_layout Standard
7202 to change the font for chapter headings to sans-serif.
7203 This will override (or, in this case, add to) the existing declaration
7204 for the Chapter style.
7208 \begin_layout Standard
7209 Your new package may also provide commands or environments not present in
7211 In this case, you will want to add these to the layout file.
7213 \begin_inset CommandInset ref
7215 reference "sec:TextClass"
7219 for information on how to do so.
7222 \begin_layout Standard
7224 \begin_inset Flex MenuItem
7227 \begin_layout Plain Layout
7233 can be used with several different document classes, and even if it cannot,
7234 you might find it easiest just to write a module that you can load with
7236 The simplest possible such module would be:
7239 \begin_layout LyX-Code
7243 \change_deleted -712698321 1437634736
7246 \change_inserted -712698321 1437634737
7252 \begin_layout LyX-Code
7256 \begin_layout LyX-Code
7257 #Support for mypkg.sty.
7260 \begin_layout LyX-Code
7262 \begin_inset Newline newline
7268 \begin_layout LyX-Code
7270 \begin_inset Newline newline
7276 \begin_layout LyX-Code
7278 \begin_inset Newline newline
7284 \begin_inset Newline newline
7290 \begin_layout Standard
7291 A more complex module might modify the behavior of some existing constructs
7292 or define some new ones.
7294 \begin_inset CommandInset ref
7296 reference "sec:TextClass"
7303 \begin_layout Subsection
7305 \begin_inset Flex MenuItem
7308 \begin_layout Plain Layout
7317 \begin_layout Standard
7318 There are two possibilities here.
7319 One is that the class file is itself based upon an existing document class.
7320 For example, many thesis classes are based upon
7321 \begin_inset Flex MenuItem
7324 \begin_layout Plain Layout
7331 To see whether yours is, look for a line like
7334 \begin_layout LyX-Code
7340 \begin_layout Standard
7342 If so, then you may proceed largely as in the previous section, though
7344 \begin_inset Flex Code
7347 \begin_layout Plain Layout
7348 Declare\SpecialChar LaTeX
7354 line will be different.
7355 If your new class is
7356 \begin_inset Flex Code
7359 \begin_layout Plain Layout
7365 and it is based upon
7366 \begin_inset Flex Code
7369 \begin_layout Plain Layout
7375 , then the line should read:
7379 \begin_layout Plain Layout
7380 And it will be easiest if you save the file to
7381 \begin_inset Flex Code
7384 \begin_layout Plain Layout
7391 assumes that the document class has the same name as the layout file.
7400 \begin_layout LyX-Code
7403 Declare\SpecialChar LaTeX
7404 Class[thesis,book]{thesis}
7407 \begin_layout Standard
7408 If, on the other hand, the new class is not based upon an existing class,
7409 you will probably have to
7410 \begin_inset Quotes eld
7414 \begin_inset Quotes erd
7418 We strongly suggest copying an existing layout file which uses a similar
7420 class and then modifying it, if you can do so.
7421 At least use an existing file as a starting point so you can find out what
7422 items you need to worry about.
7423 Again, the specifics are covered below.
7426 \begin_layout Subsection
7428 \begin_inset CommandInset label
7430 name "subsec:Creating-Templates"
7437 \begin_layout Standard
7438 Once you have written a layout file for a new document class, you might
7439 want to consider writing a
7444 A template acts as a kind of tutorial for your layout, showing how it might
7445 be used, though containing dummy content.
7446 You can of course look at the various templates included with \SpecialChar LyX
7450 \begin_layout Standard
7451 Templates are created just like usual documents: using \SpecialChar LyX
7453 The only difference is that usual documents contain all possible settings,
7454 including the font scheme and the paper size.
7455 Usually a user doesn't want a template to overwrite his preferred settings
7456 for such parameters.
7457 For that reason, the designer of a template should remove the corresponding
7459 \begin_inset Flex Code
7462 \begin_layout Plain Layout
7471 \begin_inset Flex Code
7474 \begin_layout Plain Layout
7482 from the template \SpecialChar LyX
7484 This can be done with any simple text-editor, for example
7485 \begin_inset Flex Code
7488 \begin_layout Plain Layout
7495 \begin_inset Flex Code
7498 \begin_layout Plain Layout
7507 \begin_layout Standard
7508 Put the edited template files you create in
7509 \begin_inset Flex Code
7512 \begin_layout Plain Layout
7518 , copy the ones you use from the global template directory in
7519 \begin_inset Flex Code
7522 \begin_layout Plain Layout
7524 \change_deleted -712698321 1437634751
7527 \change_inserted -712698321 1437634752
7535 to the same place, and redefine the template path in the
7536 \begin_inset Flex MenuItem
7539 \begin_layout Plain Layout
7540 Tools\SpecialChar menuseparator
7541 Preferences\SpecialChar menuseparator
7550 \begin_layout Standard
7551 Note, by the way, that there is a template which has a particular meaning:
7553 \begin_inset Flex Code
7556 \begin_layout Plain Layout
7563 This template is loaded every time you create a new document with
7564 \begin_inset Flex MenuItem
7567 \begin_layout Plain Layout
7568 File\SpecialChar menuseparator
7574 in order to provide useful defaults.
7575 To create this template from inside \SpecialChar LyX
7576 , all you have to do is to open a document
7577 with the correct settings, and use the
7578 \begin_inset Flex MenuItem
7581 \begin_layout Plain Layout
7582 Save as Document Defaults
7590 \begin_layout Subsection
7591 Upgrading old layout files
7594 \begin_layout Standard
7595 The format of layout files changes with each \SpecialChar LyX
7596 release, so old layout files
7597 need to be converted to the new format.
7599 reads a layout file in an older format, it automatically calls the
7601 \begin_inset Flex Code
7604 \begin_layout Plain Layout
7610 to convert it to a temporary file in current format.
7611 The original file is left untouched.
7612 If you use the layout file often, then, you may want to convert it permanently,
7613 so that \SpecialChar LyX
7614 does not have to do so itself every time.
7615 To do this, you can call the converter manually:
7618 \begin_layout Enumerate
7620 \begin_inset Flex Code
7623 \begin_layout Plain Layout
7630 \begin_inset Flex Code
7633 \begin_layout Plain Layout
7642 \begin_layout Enumerate
7644 \begin_inset Newline newline
7648 \begin_inset Flex Code
7651 \begin_layout Plain Layout
7653 \change_deleted -712698321 1437634764
7656 \change_inserted -712698321 1437634766
7659 Dir/scripts/layout2layout.py myclass.old myclass.layout
7665 \begin_inset Newline newline
7669 \begin_inset Flex Code
7672 \begin_layout Plain Layout
7674 \change_deleted -712698321 1437634771
7677 \change_inserted -712698321 1437634772
7685 is the name of your \SpecialChar LyX
7689 \begin_layout Standard
7690 Note that manual conversion does not affect included files, so these will
7691 have to be converted separately.
7694 \begin_layout Section
7695 \begin_inset CommandInset label
7697 name "sec:TextClass"
7701 The layout file format
7704 \begin_layout Standard
7705 The following sections describe how layout files are structured and written.
7706 Our advice is to go slowly, save and test often.
7707 It is really not that hard, except that the multitude of options can become
7708 overwhelming, especially if you try to check out too many at once.
7709 It becomes easier if you use existing layouts of \SpecialChar LyX
7710 as examples/reference
7711 or if you modify an existing layout to your needs.
7714 \begin_layout Standard
7715 Note that all the tags used in layout files are case-insensitive.
7717 \begin_inset Flex Code
7720 \begin_layout Plain Layout
7727 \begin_inset Flex Code
7730 \begin_layout Plain Layout
7737 \begin_inset Flex Code
7740 \begin_layout Plain Layout
7746 are really the same tag.
7747 The possible arguments are printed in brackets after the tag's name.
7748 The default argument is typeset
7749 \begin_inset Flex Code
7752 \begin_layout Plain Layout
7761 If the argument has a data type like
7762 \begin_inset Quotes eld
7766 \begin_inset Quotes erd
7770 \begin_inset Quotes eld
7774 \begin_inset Quotes erd
7777 , the default is shown like this:
7778 \begin_inset Flex Code
7781 \begin_layout Plain Layout
7792 \begin_layout Subsection
7793 The document class declaration and classification
7796 \begin_layout Standard
7797 Lines in a layout file which begin with
7798 \begin_inset Flex Code
7801 \begin_layout Plain Layout
7808 There is one exception to this rule.
7810 \begin_inset Flex Code
7813 \begin_layout Plain Layout
7819 files should begin with lines like:
7822 \begin_layout LyX-Code
7825 #% Do not delete the line below; configure depends on this
7828 \begin_layout LyX-Code
7834 \change_deleted -712698321 1437634362
7841 \begin_layout Plain Layout
7852 eXClass{Article (Standard Class)}
7855 \begin_layout LyX-Code
7860 DeclareCategory{Articles}
7863 \begin_layout Standard
7864 The second and third lines are used when you (re)configure \SpecialChar LyX
7866 The layout file is read by the \SpecialChar LaTeX
7868 \begin_inset Flex Code
7871 \begin_layout Plain Layout
7877 , in a special mode where
7878 \begin_inset Flex Code
7881 \begin_layout Plain Layout
7888 The first line is just a \SpecialChar LaTeX
7889 comment, the second one contains the mandatory
7890 declaration of the text class and the third line contains the optional
7891 classification of the class.
7892 If these lines appear in a file named
7893 \begin_inset Flex Code
7896 \begin_layout Plain Layout
7902 , then they define a text class of name
7903 \begin_inset Flex Code
7906 \begin_layout Plain Layout
7912 (the name of the layout file) which uses the \SpecialChar LaTeX
7914 \begin_inset Flex Code
7917 \begin_layout Plain Layout
7923 (the default is to use the same name as the layout).
7925 \begin_inset Quotes eld
7928 Article (Standard Class)
7929 \begin_inset Quotes erd
7932 that appears above is used as a description of the text class in the
7933 \begin_inset Flex MenuItem
7936 \begin_layout Plain Layout
7937 Document\SpecialChar menuseparator
7945 \begin_inset Quotes eld
7949 \begin_inset Quotes erd
7952 in the example) is also used in the
7953 \begin_inset Flex MenuItem
7956 \begin_layout Plain Layout
7957 Document\SpecialChar menuseparator
7963 dialog: the text classes are grouped by these categories (which are usually
7964 genres, so typical categories are
7965 \begin_inset Quotes eld
7969 \begin_inset Quotes erd
7973 \begin_inset Quotes eld
7977 \begin_inset Quotes erd
7981 \begin_inset Quotes eld
7985 \begin_inset Quotes erd
7989 \begin_inset Quotes eld
7993 \begin_inset Quotes erd
7997 \begin_inset Quotes eld
8001 \begin_inset Quotes erd
8005 \begin_inset Quotes eld
8009 \begin_inset Quotes erd
8013 If no category has been declared, the class will be put in the
8014 \begin_inset Quotes eld
8018 \begin_inset Quotes erd
8024 \begin_layout Standard
8025 Let's assume that you wrote your own text class that uses the
8026 \begin_inset Flex Code
8029 \begin_layout Plain Layout
8035 document class, but where you changed the appearance of the section headings.
8036 If you put it in a file
8037 \begin_inset Flex Code
8040 \begin_layout Plain Layout
8046 , the header of this file should be:
8049 \begin_layout LyX-Code
8052 #% Do not delete the line below; configure depends on this
8055 \begin_layout LyX-Code
8066 \begin_layout Plain Layout
8075 eXClass[article]{Article (with My Own Headings)}
8078 \begin_layout LyX-Code
8083 DeclareCategory{Articles}
8086 \begin_layout Standard
8087 This declares a text class
8088 \begin_inset Flex Code
8091 \begin_layout Plain Layout
8097 , associated with the \SpecialChar LaTeX
8099 \begin_inset Flex Code
8102 \begin_layout Plain Layout
8109 \begin_inset Quotes eld
8112 Article (with My Own Headings)
8113 \begin_inset Quotes erd
8117 If your text class depends on several packages, you can declare it as:
8120 \begin_layout LyX-Code
8123 #% Do not delete the line below; configure depends on this
8126 \begin_layout LyX-Code
8132 \change_deleted -712698321 1437634376
8139 \begin_layout Plain Layout
8150 eXClass[article,foo.sty]{Article (with My Own Headings)}
8153 \begin_layout LyX-Code
8158 DeclareCategory{Articles}
8161 \begin_layout Standard
8162 This indicates that your text class uses the
8163 \begin_inset Flex Code
8166 \begin_layout Plain Layout
8173 Finally, it is also possible to declare classes for DocBook code.
8174 Typical declarations will look like:
8177 \begin_layout LyX-Code
8180 #% Do not delete the line below; configure depends on this
8183 \begin_layout LyX-Code
8188 DeclareDocBookClass[article]{SGML (DocBook Article)}
8191 \begin_layout LyX-Code
8196 DeclareCategory{Articles (DocBook)}
8199 \begin_layout Standard
8200 Note that these declarations can also be given an optional parameter declaring
8201 the name of the document class (but not a list).
8204 \begin_layout Standard
8205 So, to be as explicit as possible, the form of the layout declaration is:
8208 \begin_layout LyX-Code
8214 \change_deleted -712698321 1437634381
8221 \begin_layout Plain Layout
8232 eXClass[class,package.sty]{layout description}
8235 \begin_layout LyX-Code
8240 DeclareCategory{category}
8243 \begin_layout Standard
8244 The class need only be specified if the name of the \SpecialChar LaTeX
8246 name of the layout file are different or if there are packages to load.
8247 If the name of the class file is not specified, then \SpecialChar LyX
8249 that it is the same as the name of the layout file.
8252 \begin_layout Standard
8253 When the text class has been modified to your taste, all you have to do
8254 is to copy it either to
8255 \begin_inset Flex Code
8258 \begin_layout Plain Layout
8260 \change_deleted -712698321 1437634783
8263 \change_inserted -712698321 1437634784
8272 \begin_inset Flex Code
8275 \begin_layout Plain Layout
8282 \begin_inset Flex MenuItem
8285 \begin_layout Plain Layout
8286 Tools\SpecialChar menuseparator
8292 , exit \SpecialChar LyX
8294 Then your new text class should be available along with the others.
8297 \begin_layout Standard
8298 Once the layout file is installed, you can edit it and see your changes
8299 without having to reconfigure or to restart \SpecialChar LyX
8305 \begin_layout Plain Layout
8306 In versions of \SpecialChar LyX
8307 prior to 1.6, this was not true.
8308 As a result, editing layout files was very time consuming, since you had
8309 constantly to restart \SpecialChar LyX
8315 You can force a reload of the current layout by using the \SpecialChar LyX
8317 \begin_inset Flex MenuItem
8320 \begin_layout Plain Layout
8327 There is no default binding for this function—though, of course, you can
8328 bind it to a key yourself.
8329 But you will normally use this function simply by entering it in the mini-buffe
8334 \begin_layout Standard
8340 \begin_inset Flex MenuItem
8343 \begin_layout Plain Layout
8349 is very much an `advanced feature'.
8354 recommended that you save your work before using this function.
8359 recommended that you not attempt to edit layout information while simultaneousl
8360 y working on a document that you care about.
8361 Use a test document.
8362 Syntax errors and the like in your layout file could cause peculiar behavior.
8363 In particular, such errors could cause \SpecialChar LyX
8364 to regard the current layout as
8365 invalid and to attempt to switch to some other layout.
8369 \begin_layout Plain Layout
8370 Really bad syntax errors may even caused \SpecialChar LyX
8372 This is because certain sorts of errors may make \SpecialChar LyX
8383 The \SpecialChar LyX
8384 team strives to keep \SpecialChar LyX
8385 stable in such situations, but safe is better
8390 \begin_layout Plain Layout
8391 While we're giving advice: make regular backups.
8392 And be nice to your mother.
8400 \begin_layout Subsection
8401 The Module declaration
8404 \begin_layout Standard
8405 A module must begin with a line like the following:
8408 \begin_layout LyX-Code
8412 \change_deleted -712698321 1437634801
8417 \begin_layout Plain Layout
8426 yXModule[endnotes.sty]{Endnotes}
8429 \begin_layout Standard
8430 The mandatory argument, in curly brackets, is the name of the module, as
8432 \begin_inset Flex MenuItem
8435 \begin_layout Plain Layout
8436 Document\SpecialChar menuseparator
8437 Settings\SpecialChar menuseparator
8444 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8446 on which the module depends.
8447 It is also possible to use the form
8448 \begin_inset Flex MenuItem
8451 \begin_layout Plain Layout
8457 as an optional argument, which declares that the module can only be used
8458 when there exists a conversion chain between the formats `
8459 \begin_inset Flex Code
8462 \begin_layout Plain Layout
8469 \begin_inset Flex Code
8472 \begin_layout Plain Layout
8481 \begin_layout Standard
8482 The module declaration should then be followed by lines like the following
8486 \begin_layout Plain Layout
8487 Preferably in English if the module should be published with \SpecialChar LyX
8489 This description will appear in the list of messages to be translated and
8490 will be thus translated with the next interface update.
8498 \begin_layout LyX-Code
8502 \begin_layout LyX-Code
8503 #Adds an endnote command, in addition to footnotes.
8507 \begin_layout LyX-Code
8508 #You will need to add
8511 \change_deleted -712698321 1437634393
8514 \change_inserted -712698321 1437634395
8520 \begin_layout LyX-Code
8521 #want the endnotes to appear.
8525 \begin_layout LyX-Code
8529 \begin_layout LyX-Code
8530 #Requires: somemodule | othermodule
8533 \begin_layout LyX-Code
8534 #Excludes: badmodule
8537 \begin_layout Standard
8538 The description is used in
8539 \begin_inset Flex MenuItem
8542 \begin_layout Plain Layout
8543 Document\SpecialChar menuseparator
8544 Settings\SpecialChar menuseparator
8550 to provide the user with information about what the module does.
8552 \begin_inset Flex Code
8555 \begin_layout Plain Layout
8561 line is used to identify other modules with which this one must be used;
8563 \begin_inset Flex Code
8566 \begin_layout Plain Layout
8572 line is used to identify modules with which this one may not be used.
8573 Both are optional, and, as shown, multiple modules should be separated
8574 with the pipe symbol: |.
8575 Note that the required modules are treated disjunctively:
8579 of the required modules must be used.
8584 excluded module may be used.
8585 Note that modules are identified here by their filenames without the
8586 \begin_inset Flex Code
8589 \begin_layout Plain Layout
8597 \begin_inset Flex Code
8600 \begin_layout Plain Layout
8607 \begin_inset Flex Code
8610 \begin_layout Plain Layout
8619 \begin_layout Subsection
8623 \begin_layout Standard
8624 The first non-comment line of any layout file, included file, or module
8629 contain the file format number:
8632 \begin_layout Description
8633 \begin_inset Flex Code
8636 \begin_layout Plain Layout
8643 \begin_inset Flex Code
8646 \begin_layout Plain Layout
8652 ] The format number of the layout file.
8655 \begin_layout Standard
8656 This tag was introduced with \SpecialChar LyX
8658 \begin_inset space ~
8662 Layout files from older \SpecialChar LyX
8663 versions do not have an explicit file format and
8664 are considered to have
8665 \begin_inset Flex Code
8668 \begin_layout Plain Layout
8670 \begin_inset space ~
8679 The format for the present version of \SpecialChar LyX
8681 But each version of \SpecialChar LyX
8682 is capable of reading earlier versions' layout files,
8683 just as they are capable of reading files produced by earlier versions
8686 There is, however, no provision for converting to earlier formats.
8689 \begin_layout Subsection
8690 \begin_inset CommandInset label
8692 name "subsec:General-text-class"
8696 General text class parameters
8699 \begin_layout Standard
8700 These are general parameters that govern the behavior of an entire document
8706 mean that they must appear in
8707 \begin_inset Flex Code
8710 \begin_layout Plain Layout
8716 files rather than in modules.
8717 A module can contain any layout tag.)
8720 \begin_layout Description
8721 \begin_inset Flex Code
8724 \begin_layout Plain Layout
8730 Adds information that will be output in the
8731 \begin_inset Flex Code
8734 \begin_layout Plain Layout
8740 block when the document is output to XHTML.
8741 Typically, this would be used to output CSS style information, but it can
8742 be used for anything that can appear in
8743 \begin_inset Flex Code
8746 \begin_layout Plain Layout
8754 \begin_inset Quotes eld
8758 \begin_inset Flex Code
8761 \begin_layout Plain Layout
8768 \begin_inset Quotes erd
8774 \begin_layout Description
8775 \begin_inset Flex Code
8778 \begin_layout Plain Layout
8784 Adds information to the document preamble.
8786 \begin_inset Newline newline
8790 \begin_inset Quotes eld
8794 \begin_inset Flex Code
8797 \begin_layout Plain Layout
8804 \begin_inset Quotes erd
8810 \begin_layout Description
8811 \begin_inset Flex Code
8814 \begin_layout Plain Layout
8820 Defines formats for use in the display of bibliographic information.
8822 \begin_inset CommandInset ref
8824 reference "subsec:Citation-format-description"
8830 \begin_inset Quotes eld
8834 \begin_inset Flex Code
8837 \begin_layout Plain Layout
8844 \begin_inset Quotes erd
8850 \begin_layout Description
8851 \begin_inset Flex Code
8854 \begin_layout Plain Layout
8860 Describes various global options supported by the document class.
8862 \begin_inset CommandInset ref
8864 reference "subsec:ClassOptions"
8870 \begin_inset Quotes eld
8874 \begin_inset Flex Code
8877 \begin_layout Plain Layout
8884 \begin_inset Quotes erd
8890 \begin_layout Description
8891 \begin_inset Flex Code
8894 \begin_layout Plain Layout
8901 \begin_inset Flex Code
8904 \begin_layout Plain Layout
8913 \begin_inset space \thinspace{}
8917 \begin_inset Flex Code
8920 \begin_layout Plain Layout
8926 ] Whether the class should
8930 to having one or two columns.
8931 Can be changed in the
8932 \begin_inset Flex MenuItem
8935 \begin_layout Plain Layout
8936 Document\SpecialChar menuseparator
8945 \begin_layout Description
8946 \begin_inset Flex Code
8949 \begin_layout Plain Layout
8956 \begin_inset Flex Code
8959 \begin_layout Plain Layout
8965 ] This sequence defines the properties for a counter.
8966 If the counter does not yet exist, it is created; if it does exist, it
8969 \begin_inset Quotes eld
8973 \begin_inset Flex Code
8976 \begin_layout Plain Layout
8983 \begin_inset Quotes erd
8987 \begin_inset Newline newline
8991 \begin_inset CommandInset ref
8993 reference "subsec:Counters"
8997 for details on counters.
9000 \begin_layout Description
9001 \begin_inset Flex Code
9004 \begin_layout Plain Layout
9010 Sets the default font used to display the document.
9012 \begin_inset CommandInset ref
9014 reference "subsec:Font-description"
9018 for how to declare fonts.
9020 \begin_inset Quotes eld
9024 \begin_inset Flex Code
9027 \begin_layout Plain Layout
9034 \begin_inset Quotes erd
9040 \begin_layout Description
9041 \begin_inset Flex Code
9044 \begin_layout Plain Layout
9051 \begin_inset Flex Code
9054 \begin_layout Plain Layout
9060 ] Specifies a module to be included by default with this document class.
9061 The module is specified as filename without the
9062 \begin_inset Flex Code
9065 \begin_layout Plain Layout
9072 The user can still remove the module, but it will be active at the outset.
9073 (This applies only when new files are created, or when this class is chosen
9074 for an existing document.)
9077 \begin_layout Description
9078 \begin_inset Flex Code
9081 \begin_layout Plain Layout
9088 \begin_inset Flex Code
9091 \begin_layout Plain Layout
9097 ] This is the style that will be assigned to new paragraphs, usually
9098 \begin_inset Flex MenuItem
9101 \begin_layout Plain Layout
9108 This will default to the first defined style if not given, but you are
9109 encouraged to use this directive.
9112 \begin_layout Description
9113 \begin_inset Flex Code
9116 \begin_layout Plain Layout
9123 \begin_inset Flex Code
9126 \begin_layout Plain Layout
9132 ] This tag indicates that the module (which is specified by filename without
9134 \begin_inset Flex Code
9137 \begin_layout Plain Layout
9143 extension) cannot be used with this document class.
9144 This might be used in a journal-specific layout file to prevent, say, the
9146 \begin_inset Flex Code
9149 \begin_layout Plain Layout
9155 module that numbers theorems by section.
9160 be used in a module.
9161 Modules have their own way of excluding other modules (see
9162 \begin_inset CommandInset ref
9164 reference "subsec:Layout-modules"
9171 \begin_layout Description
9172 \begin_inset Flex Code
9175 \begin_layout Plain Layout
9181 Defines a new float.
9183 \begin_inset CommandInset ref
9185 reference "subsec:Floats"
9191 \begin_inset Quotes eld
9195 \begin_inset Flex Code
9198 \begin_layout Plain Layout
9205 \begin_inset Quotes erd
9211 \begin_layout Description
9212 \begin_inset Flex Code
9215 \begin_layout Plain Layout
9221 Sets the information that will be output in the
9222 \begin_inset Flex Code
9225 \begin_layout Plain Layout
9231 block when this document class is output to XHTML.
9232 Note that this will completely override any prior
9233 \begin_inset Flex Code
9236 \begin_layout Plain Layout
9243 \begin_inset Flex Code
9246 \begin_layout Plain Layout
9254 \begin_inset Newline newline
9258 \begin_inset Flex Code
9261 \begin_layout Plain Layout
9267 if you just want to add material to the preamble.) Must end with
9268 \begin_inset Quotes eld
9272 \begin_inset Flex Code
9275 \begin_layout Plain Layout
9282 \begin_inset Quotes erd
9288 \begin_layout Description
9289 \begin_inset Flex Code
9292 \begin_layout Plain Layout
9299 \begin_inset Flex Code
9302 \begin_layout Plain Layout
9308 ] The style to use for the table of contents, bibliography, and so forth,
9309 when the document is output to HTML.
9310 For articles, this should normally be
9311 \begin_inset Flex Code
9314 \begin_layout Plain Layout
9321 \begin_inset Flex Code
9324 \begin_layout Plain Layout
9331 If it is not given, then \SpecialChar LyX
9332 will attempt to figure out which layout to use.
9335 \begin_layout Description
9336 \begin_inset Flex Code
9339 \begin_layout Plain Layout
9346 \begin_inset Flex Code
9349 \begin_layout Plain Layout
9355 ] Modifies the properties of the given counter.
9356 If the counter does not exist, the statement is ignored.
9358 \begin_inset Quotes eld
9362 \begin_inset Flex Code
9365 \begin_layout Plain Layout
9372 \begin_inset Quotes erd
9376 \begin_inset Newline newline
9380 \begin_inset CommandInset ref
9382 reference "subsec:Counters"
9386 for details on counters.
9389 \begin_layout Description
9390 \begin_inset Flex Code
9393 \begin_layout Plain Layout
9400 \begin_inset Flex Code
9403 \begin_layout Plain Layout
9409 ] Modifies the properties of the given paragraph style.
9410 If the style does not exist, the statement is ignored.
9412 \begin_inset Quotes eld
9416 \begin_inset Flex Code
9419 \begin_layout Plain Layout
9426 \begin_inset Quotes erd
9432 \begin_layout Description
9433 \begin_inset Flex Code
9436 \begin_layout Plain Layout
9443 \begin_inset Flex Code
9446 \begin_layout Plain Layout
9452 ] This allows you to include another layout definition file within yours
9453 to avoid duplicating commands.
9454 Common examples are the standard layout files, for example,
9455 \begin_inset Flex Code
9458 \begin_layout Plain Layout
9464 , which contains most of the basic layouts.
9467 \begin_layout Description
9468 \begin_inset Flex Code
9471 \begin_layout Plain Layout
9478 \begin_inset Flex Code
9481 \begin_layout Plain Layout
9487 ] This section (re-)defines the layout of an inset.
9488 It can be applied to an existing inset or to a new, user-defined inset,
9489 e.g., a new character style.
9491 \begin_inset Quotes eld
9495 \begin_inset Flex Code
9498 \begin_layout Plain Layout
9505 \begin_inset Quotes erd
9509 \begin_inset Newline newline
9513 \begin_inset CommandInset ref
9515 reference "subsec:Flex-insets-and"
9519 for more information.
9523 \begin_layout Description
9524 \begin_inset Flex Code
9527 \begin_layout Plain Layout
9534 \begin_inset Flex Code
9537 \begin_layout Plain Layout
9543 ] A string that indicates the width of the left margin on the screen, for
9545 \begin_inset Quotes eld
9549 \begin_inset Flex Code
9552 \begin_layout Plain Layout
9559 \begin_inset Quotes erd
9563 (Note that this is not a `length', like
9564 \begin_inset Quotes eld
9568 \begin_inset Quotes erd
9574 \begin_layout Description
9575 \begin_inset Flex Code
9578 \begin_layout Plain Layout
9585 \begin_inset Flex Code
9588 \begin_layout Plain Layout
9594 ] Deletes an existing counter, usually one defined in an included file.
9597 \begin_layout Description
9598 \begin_inset Flex Code
9601 \begin_layout Plain Layout
9608 \begin_inset Flex Code
9611 \begin_layout Plain Layout
9617 ] Deletes an existing float.
9618 This is particularly useful when you want to suppress a float that has
9619 been defined in an input file.
9622 \begin_layout Description
9623 \begin_inset Flex Code
9626 \begin_layout Plain Layout
9633 \begin_inset Flex Code
9636 \begin_layout Plain Layout
9642 ] Deletes an existing style.
9645 \begin_layout Description
9646 \begin_inset Flex Code
9649 \begin_layout Plain Layout
9656 \begin_inset Flex Code
9659 \begin_layout Plain Layout
9665 ] The file format (as defined in the \SpecialChar LyX
9666 preferences) produced by this document
9668 It is mainly useful when
9669 \begin_inset Flex Code
9672 \begin_layout Plain Layout
9679 \begin_inset Flex Code
9682 \begin_layout Plain Layout
9688 and one wants to define a new type of literate document.
9689 The format is reset to
9690 \begin_inset Quotes eld
9694 \begin_inset Flex Code
9697 \begin_layout Plain Layout
9704 \begin_inset Quotes erd
9708 \begin_inset Quotes eld
9712 \begin_inset Flex Code
9715 \begin_layout Plain Layout
9722 \begin_inset Quotes erd
9725 when the corresponding
9726 \begin_inset Flex Code
9729 \begin_layout Plain Layout
9735 parameter is encountered.
9738 \begin_layout Description
9739 \begin_inset Flex Code
9742 \begin_layout Plain Layout
9749 \begin_inset Flex Code
9752 \begin_layout Plain Layout
9763 \begin_inset Flex Code
9766 \begin_layout Plain Layout
9773 \begin_inset Flex Code
9776 \begin_layout Plain Layout
9782 ] Specifies what sort of output documents using this class will produce.
9785 \begin_layout Description
9786 \begin_inset Flex Code
9789 \begin_layout Plain Layout
9796 \begin_inset Flex Code
9799 \begin_layout Plain Layout
9806 \begin_inset Flex Code
9809 \begin_layout Plain Layout
9815 ] Specifies options, given in the second string, for the package named by
9818 \begin_inset Quotes eld
9822 \begin_inset Flex Code
9825 \begin_layout Plain Layout
9826 PackageOptions natbib square
9832 \begin_inset Quotes erd
9836 \begin_inset Flex Code
9839 \begin_layout Plain Layout
9845 to be loaded with the
9846 \begin_inset Flex Code
9849 \begin_layout Plain Layout
9856 (For \SpecialChar TeX
9857 perts, this causes \SpecialChar LyX
9859 \begin_inset Flex Code
9862 \begin_layout Plain Layout
9865 PassOptionsToPackage{natbib}{square}
9871 \begin_inset Flex Code
9874 \begin_layout Plain Layout
9883 \begin_layout Description
9884 \begin_inset Flex Code
9887 \begin_layout Plain Layout
9894 \begin_inset Flex Code
9897 \begin_layout Plain Layout
9906 \begin_inset Flex Code
9909 \begin_layout Plain Layout
9916 \begin_inset Flex Code
9919 \begin_layout Plain Layout
9925 ] The default pagestyle.
9926 Can be changed in the
9927 \begin_inset Flex MenuItem
9930 \begin_layout Plain Layout
9931 Document\SpecialChar menuseparator
9940 \begin_layout Description
9941 \begin_inset Flex Code
9944 \begin_layout Plain Layout
9950 Sets the preamble for the \SpecialChar LaTeX
9952 Note that this will completely override any prior
9953 \begin_inset Flex Code
9956 \begin_layout Plain Layout
9963 \begin_inset Flex Code
9966 \begin_layout Plain Layout
9974 \begin_inset Flex Code
9977 \begin_layout Plain Layout
9983 if you just want to add material to the preamble.) Must end with
9984 \begin_inset Quotes eld
9988 \begin_inset Flex Code
9991 \begin_layout Plain Layout
9998 \begin_inset Quotes erd
10004 \begin_layout Description
10005 \begin_inset Flex Code
10008 \begin_layout Plain Layout
10015 \begin_inset Flex Code
10018 \begin_layout Plain Layout
10025 \begin_inset Flex Code
10028 \begin_layout Plain Layout
10037 \begin_inset space \thinspace{}
10041 \begin_inset Flex Code
10044 \begin_layout Plain Layout
10050 ] Whether the class already provides the feature
10051 \begin_inset Flex Code
10054 \begin_layout Plain Layout
10061 A feature is in general the name of a package (e.
10062 \begin_inset space \thinspace{}
10066 \begin_inset space \space{}
10070 \begin_inset Flex Code
10073 \begin_layout Plain Layout
10080 \begin_inset Flex Code
10083 \begin_layout Plain Layout
10090 \begin_inset space \thinspace{}
10094 \begin_inset space \space{}
10098 \begin_inset Flex Code
10101 \begin_layout Plain Layout
10108 \begin_inset Flex Code
10111 \begin_layout Plain Layout
10119 \begin_inset CommandInset ref
10121 reference "chap:List-of-functions"
10125 for the list of features.
10128 \begin_layout Description
10129 \begin_inset Flex Code
10132 \begin_layout Plain Layout
10139 \begin_inset Flex Code
10142 \begin_layout Plain Layout
10148 ] Indicates that this layout provides the functionality of the module mentioned,
10149 which should be specified by the filename without the
10150 \begin_inset Flex Code
10153 \begin_layout Plain Layout
10160 This will typically be used if the layout includes the module directly,
10161 rather than using the
10162 \begin_inset Flex Code
10165 \begin_layout Plain Layout
10171 tag to indicate that it ought to be used.
10172 It could also be used in a module that provided an alternate implementation
10173 of the same functionality.
10176 \begin_layout Description
10177 \begin_inset Flex Code
10180 \begin_layout Plain Layout
10187 \begin_inset Flex Code
10190 \begin_layout Plain Layout
10196 ] Whether the class requires the feature
10197 \begin_inset Flex Code
10200 \begin_layout Plain Layout
10207 Multiple features must be separated by commas.
10208 Note that you can only request supported features.
10210 \begin_inset CommandInset ref
10212 reference "chap:List-of-functions"
10216 for the list of features.)
10217 \change_inserted -712698321 1438601536
10219 If you require a package with specific options, you can additionally use
10221 \begin_inset Flex Code
10224 \begin_layout Plain Layout
10226 \change_inserted -712698321 1438601526
10237 \begin_layout Description
10238 \begin_inset Flex Code
10241 \begin_layout Plain Layout
10248 \begin_inset Flex Code
10251 \begin_layout Plain Layout
10257 ] A string that indicates the width of the right margin on the screen, for
10259 \begin_inset Quotes eld
10263 \begin_inset Flex Code
10266 \begin_layout Plain Layout
10273 \begin_inset Quotes erd
10279 \begin_layout Description
10280 \begin_inset Flex Code
10283 \begin_layout Plain Layout
10290 \begin_inset Flex Code
10293 \begin_layout Plain Layout
10299 ] Sets which divisions get numbered.
10301 \begin_inset Newline newline
10305 \begin_inset Flex Code
10308 \begin_layout Plain Layout
10314 counter in \SpecialChar LaTeX
10318 \begin_layout Description
10319 \begin_inset Flex Code
10322 \begin_layout Plain Layout
10329 \begin_inset Flex Code
10332 \begin_layout Plain Layout
10341 \begin_inset space \thinspace{}
10345 \begin_inset Flex Code
10348 \begin_layout Plain Layout
10354 ] Whether the class-default should be printing on one or both sides of the
10356 Can be changed in the
10357 \begin_inset Flex MenuItem
10360 \begin_layout Plain Layout
10361 Document\SpecialChar menuseparator
10370 \begin_layout Description
10371 \begin_inset Flex Code
10374 \begin_layout Plain Layout
10381 \begin_inset Flex Code
10384 \begin_layout Plain Layout
10390 ] This sequence defines a paragraph style.
10391 If the style does not yet exist, it is created; if it does exist, its parameter
10394 \begin_inset Quotes eld
10398 \begin_inset Flex Code
10401 \begin_layout Plain Layout
10408 \begin_inset Quotes erd
10412 \begin_inset Newline newline
10416 \begin_inset CommandInset ref
10418 reference "subsec:Paragraph-Styles"
10422 for details on paragraph styles.
10425 \begin_layout Description
10426 \begin_inset Flex Code
10429 \begin_layout Plain Layout
10436 \begin_inset Flex Code
10439 \begin_layout Plain Layout
10445 ] The name of the command or environment to be used with
10446 \begin_inset Flex Code
10449 \begin_layout Plain Layout
10458 \begin_layout Description
10459 \begin_inset Flex Code
10462 \begin_layout Plain Layout
10469 \begin_inset Flex Code
10472 \begin_layout Plain Layout
10481 \begin_inset Flex Code
10484 \begin_layout Plain Layout
10490 ] Indicates what kind of markup is used to define the title of a document.
10492 \begin_inset Flex Code
10495 \begin_layout Plain Layout
10501 means that the macro with name
10502 \begin_inset Flex Code
10505 \begin_layout Plain Layout
10511 will be inserted after the last layout which has
10512 \begin_inset Quotes eld
10516 \begin_inset Flex Code
10519 \begin_layout Plain Layout
10521 \begin_inset space ~
10530 \begin_inset Quotes erd
10535 \begin_inset Flex Code
10538 \begin_layout Plain Layout
10544 corresponds to the case where all layouts which have
10545 \begin_inset Quotes eld
10549 \begin_inset Flex Code
10552 \begin_layout Plain Layout
10554 \begin_inset space ~
10563 \begin_inset Quotes erd
10566 should be enclosed into the
10567 \begin_inset Flex Code
10570 \begin_layout Plain Layout
10579 \begin_layout Description
10580 \begin_inset Flex Code
10583 \begin_layout Plain Layout
10590 \begin_inset Flex Code
10593 \begin_layout Plain Layout
10599 ] Sets which divisions are included in the table of contents.
10601 \begin_inset Flex Code
10604 \begin_layout Plain Layout
10610 counter in \SpecialChar LaTeX
10614 \begin_layout Subsection
10615 \begin_inset Flex Code
10618 \begin_layout Plain Layout
10625 \begin_inset CommandInset label
10627 name "subsec:ClassOptions"
10634 \begin_layout Standard
10636 \begin_inset Flex Code
10639 \begin_layout Plain Layout
10645 section can contain the following entries:
10648 \begin_layout Description
10649 \begin_inset Flex Code
10652 \begin_layout Plain Layout
10659 \begin_inset Flex Code
10662 \begin_layout Plain Layout
10668 ] The list of available font sizes for the document's main font, separated
10670 \begin_inset Quotes eld
10674 \begin_inset Flex Code
10677 \begin_layout Plain Layout
10684 \begin_inset Quotes erd
10690 \begin_layout Description
10691 \begin_inset Flex Code
10694 \begin_layout Plain Layout
10700 Used to set the DTD line with XML-based output classes.
10702 \begin_inset space \thinspace{}
10706 \begin_inset Quotes eld
10709 -//OASIS//DTD DocBook V4.2//EN
10710 \begin_inset Quotes erd
10716 \begin_layout Description
10717 \begin_inset Flex Code
10720 \begin_layout Plain Layout
10727 \begin_inset Flex Code
10730 \begin_layout Plain Layout
10731 string="empty|plain|headings|fancy"
10736 ] The list of available page sty\SpecialChar softhyphen
10738 \begin_inset Quotes eld
10742 \begin_inset Flex Code
10745 \begin_layout Plain Layout
10752 \begin_inset Quotes erd
10758 \begin_layout Description
10759 \begin_inset Flex Code
10762 \begin_layout Plain Layout
10769 \begin_inset Flex Code
10772 \begin_layout Plain Layout
10778 ] Some document class options, separated by a comma, that will be added
10779 to the optional part of the
10780 \begin_inset Flex Code
10783 \begin_layout Plain Layout
10794 \begin_layout Standard
10796 \begin_inset Flex Code
10799 \begin_layout Plain Layout
10805 section must end with
10806 \begin_inset Quotes eld
10810 \begin_inset Flex Code
10813 \begin_layout Plain Layout
10820 \begin_inset Quotes erd
10826 \begin_layout Subsection
10828 \begin_inset CommandInset label
10830 name "subsec:Paragraph-Styles"
10837 \begin_layout Standard
10838 A paragraph style description looks like this:
10842 \begin_layout Plain Layout
10843 Note that this will either define a new style or modify an existing one.
10851 \begin_layout LyX-Code
10858 \begin_layout LyX-Code
10862 \begin_layout LyX-Code
10866 \begin_layout Standard
10867 where the following commands are allowed:
10870 \begin_layout Description
10871 \begin_inset Flex Code
10874 \begin_layout Plain Layout
10881 \begin_inset Flex Code
10884 \begin_layout Plain Layout
10889 , left, right, center
10894 ] Paragraph alignment.
10897 \begin_layout Description
10898 \begin_inset Flex Code
10901 \begin_layout Plain Layout
10908 \begin_inset Flex Code
10911 \begin_layout Plain Layout
10916 , left, right, center
10921 ] A comma separated list of permitted alignments.
10922 (Some \SpecialChar LaTeX
10923 styles prohibit certain alignments, since those wouldn't make sense.
10924 For example a right-aligned or centered enumeration isn't possible.)
10927 \begin_layout Description
10928 \begin_inset Flex Code
10931 \begin_layout Plain Layout
10938 \begin_inset Flex Code
10941 \begin_layout Plain Layout
10947 ] Defines argument number <int> of a command\SpecialChar breakableslash
10948 environment associated with
10950 This is useful for things like section headings, and only makes sense with
10953 Every (optional or required) argument of a command or environment – except
10954 for the required argument that is associated with the content of the paragraph
10955 itself – has a separate definition, where the number specifies the order
10957 The definition must end with
10958 \begin_inset Flex Code
10961 \begin_layout Plain Layout
10968 So a command with two optional arguments has:
10969 \begin_inset Separator parbreak
10976 \begin_layout Quote
10982 \begin_layout Quote
10988 \begin_layout Quote
10994 \begin_layout Quote
11000 \begin_layout Quote
11006 \begin_layout Quote
11012 \begin_layout Standard
11014 \begin_inset Flex Code
11017 \begin_layout Plain Layout
11023 definition, the following specifications are possible:
11026 \begin_layout Itemize
11027 \begin_inset Flex Code
11030 \begin_layout Plain Layout
11037 \begin_inset Flex Code
11040 \begin_layout Plain Layout
11046 The string that will appear both in the menu (to insert this argument)
11047 and on the argument inset button (unless you also specify a separate
11048 \begin_inset Flex Code
11051 \begin_layout Plain Layout
11058 For the menu, you can define an accelerator by appending the respective
11059 character to the string, divided by
11060 \begin_inset Quotes eld
11064 \begin_inset Quotes erd
11068 \begin_inset space \thinspace{}
11072 \begin_inset space \space{}
11076 \begin_inset Quotes eld
11080 \begin_inset Flex Code
11083 \begin_layout Plain Layout
11090 \begin_inset Quotes erd
11096 \begin_layout Itemize
11097 \begin_inset Flex Code
11100 \begin_layout Plain Layout
11107 \begin_inset Flex Code
11110 \begin_layout Plain Layout
11116 A separate string for the menu.
11117 You can define an accelerator by appending the respective character to
11118 the string, divided by
11119 \begin_inset Quotes eld
11123 \begin_inset Quotes erd
11127 \begin_inset space \thinspace{}
11131 \begin_inset space \space{}
11135 \begin_inset Quotes eld
11139 \begin_inset Flex Code
11142 \begin_layout Plain Layout
11149 \begin_inset Quotes erd
11153 This specification is optional.
11154 If it is not given the
11155 \begin_inset Flex Code
11158 \begin_layout Plain Layout
11164 will be used instead for the menu.
11167 \begin_layout Itemize
11168 \begin_inset Flex Code
11171 \begin_layout Plain Layout
11178 \begin_inset Flex Code
11181 \begin_layout Plain Layout
11187 A longer explanatory text that appears in the tooltip when hovering over
11188 the argument inset.
11191 \begin_layout Itemize
11192 \begin_inset Flex Code
11195 \begin_layout Plain Layout
11202 \begin_inset Flex Code
11205 \begin_layout Plain Layout
11214 \begin_inset space \thinspace{}
11218 \begin_inset Flex Code
11221 \begin_layout Plain Layout
11227 ] Declare if this is a mandatory (1) or an optional (0) argument.
11228 Mandatory arguments will be output empty if not given, while optional arguments
11229 will not be output at all.
11230 By default, mandatory arguments are delimited by
11231 \begin_inset Flex Code
11234 \begin_layout Plain Layout
11240 , while optional arguments are delimited by
11241 \begin_inset Flex Code
11244 \begin_layout Plain Layout
11253 \begin_layout Itemize
11254 \begin_inset Flex Code
11257 \begin_layout Plain Layout
11264 \begin_inset Flex Code
11267 \begin_layout Plain Layout
11273 defines another argument (by its number) which this argument requires to
11274 be output if it is itself output.
11276 \begin_inset space \thinspace{}
11279 g., in \SpecialChar LaTeX
11280 commands, optional arguments often require previous optional arguments
11281 to be output (at least empty), as in
11282 \begin_inset Flex Code
11285 \begin_layout Plain Layout
11288 command[][argument]{text}
11294 This can be achieved by the statement
11295 \begin_inset Flex Code
11298 \begin_layout Plain Layout
11305 \begin_inset Flex Code
11308 \begin_layout Plain Layout
11317 \begin_layout Itemize
11318 \begin_inset Flex Code
11321 \begin_layout Plain Layout
11328 \begin_inset Flex Code
11331 \begin_layout Plain Layout
11337 defines a custom left delimiter (instead of
11338 \begin_inset Flex Code
11341 \begin_layout Plain Layout
11348 \begin_inset Flex Code
11351 \begin_layout Plain Layout
11358 A line break in the output can be indicated by
11359 \begin_inset Flex Code
11362 \begin_layout Plain Layout
11371 \begin_layout Itemize
11372 \begin_inset Flex Code
11375 \begin_layout Plain Layout
11382 \begin_inset Flex Code
11385 \begin_layout Plain Layout
11391 defines a custom right delimiter (instead of
11392 \begin_inset Flex Code
11395 \begin_layout Plain Layout
11402 \begin_inset Flex Code
11405 \begin_layout Plain Layout
11412 A line break in the output can be indicated by
11413 \begin_inset Flex Code
11416 \begin_layout Plain Layout
11425 \begin_layout Itemize
11426 \begin_inset Flex Code
11429 \begin_layout Plain Layout
11436 \begin_inset Flex Code
11439 \begin_layout Plain Layout
11445 defines an argument that is inserted if and only if no user-specified arguments
11447 \begin_inset space \thinspace{}
11451 \begin_inset space \space{}
11454 if no argument inset has been inserted (note that also an empty argument
11455 inset omits the DefaultArg).
11456 Multiple arguments need to be separated by comma.
11459 \begin_layout Itemize
11460 \begin_inset Flex Code
11463 \begin_layout Plain Layout
11470 \begin_inset Flex Code
11473 \begin_layout Plain Layout
11479 defines an argument that is inserted in any case (alone or in addition
11480 to user-specified arguments).
11481 Multiple arguments need to be separated by comma.
11484 \begin_layout Itemize
11485 \begin_inset Flex Code
11488 \begin_layout Plain Layout
11494 The font used for the argument content, see
11495 \begin_inset CommandInset ref
11497 reference "subsec:Font-description"
11504 \begin_layout Itemize
11505 \begin_inset Flex Code
11508 \begin_layout Plain Layout
11514 The font used for the label; see
11515 \begin_inset CommandInset ref
11517 reference "subsec:Font-description"
11524 \begin_layout Itemize
11525 \begin_inset Flex Code
11528 \begin_layout Plain Layout
11535 \begin_inset Flex Code
11538 \begin_layout Plain Layout
11543 , Minimalistic, Conglomerate
11548 ] describes the rendering style used for the inset's frame and buttons.
11551 \begin_layout Itemize
11552 \begin_inset Flex Code
11555 \begin_layout Plain Layout
11562 \begin_inset Flex Code
11565 \begin_layout Plain Layout
11572 \begin_inset Flex Code
11575 \begin_layout Plain Layout
11581 , this argument is automatically inserted when the respective style is selected.
11582 Currently, only one argument per style\SpecialChar breakableslash
11583 layout can be automatically inserted.
11584 \change_inserted -712698321 1431166542
11588 \begin_layout Itemize
11590 \change_inserted -712698321 1431166604
11591 \begin_inset Flex Code
11594 \begin_layout Plain Layout
11596 \change_inserted -712698321 1431166548
11603 \begin_inset Flex Code
11606 \begin_layout Plain Layout
11608 \change_inserted -712698321 1431166543
11615 \begin_inset Flex Code
11618 \begin_layout Plain Layout
11620 \change_inserted -712698321 1431166543
11626 , this argument will be inserted with a copy of the co-text (either selected
11627 text or the whole paragraph) as content.
11630 \begin_layout Itemize
11632 \change_inserted -712698321 1431070588
11633 \begin_inset Flex Code
11636 \begin_layout Plain Layout
11638 \change_inserted -712698321 1431070522
11645 \begin_inset Flex Code
11648 \begin_layout Plain Layout
11650 \change_inserted -712698321 1431070522
11651 string of characters
11660 Defines individual characters that should be output in raw form, meaning
11661 without special translations that \SpecialChar LaTeX
11663 Note that, contrary to PassThru, this needs to be explicitly defined for
11665 That is, arguments do not inherit PassThruChars from their parent inset
11671 \begin_layout Standard
11672 By default, the text entered in the \SpecialChar LyX
11673 workarea in the respective layout is
11674 the last (mandatory) argument of a command if the
11675 \begin_inset Flex Code
11678 \begin_layout Plain Layout
11685 \begin_inset Flex Code
11688 \begin_layout Plain Layout
11695 However, arguments with the prefix
11696 \begin_inset Flex Code
11699 \begin_layout Plain Layout
11705 are output after this workarea argument.
11706 Note that post-argument numbering restarts at 1, so the first argument
11707 following the workarea argument is
11708 \begin_inset Flex Code
11711 \begin_layout Plain Layout
11718 Post-arguments are ignored in any other
11719 \begin_inset Flex Code
11722 \begin_layout Plain Layout
11729 \begin_inset Flex Code
11732 \begin_layout Plain Layout
11741 \begin_layout Standard
11743 \begin_inset Flex Code
11746 \begin_layout Plain Layout
11755 \begin_inset Flex Code
11758 \begin_layout Plain Layout
11767 \begin_inset Flex Code
11770 \begin_layout Plain Layout
11776 followed by the number (e.
11777 \begin_inset space \thinspace{}
11781 \begin_inset space \space{}
11785 \begin_inset Flex Code
11788 \begin_layout Plain Layout
11798 \begin_layout Description
11799 \begin_inset Flex Code
11802 \begin_layout Plain Layout
11808 Note that this will completely override any prior
11809 \begin_inset Flex Code
11812 \begin_layout Plain Layout
11818 declaration for this style.
11820 \begin_inset Quotes eld
11824 \begin_inset Flex Code
11827 \begin_layout Plain Layout
11834 \begin_inset Quotes erd
11839 \begin_inset CommandInset ref
11841 reference "subsec:I18n"
11845 for details on its use.
11848 \begin_layout Description
11849 \begin_inset Flex Code
11852 \begin_layout Plain Layout
11859 \begin_inset Flex Code
11862 \begin_layout Plain Layout
11872 \begin_layout Plain Layout
11873 Note that a `float' here is a real number, such as: 1.5.
11878 The vertical space with which the last of a chain of paragraphs with this
11879 style is separated from the following paragraph.
11880 If the next paragraph has another style, the separations are not simply
11881 added, but the maximum is taken.
11884 \begin_layout Description
11885 \begin_inset Flex Code
11888 \begin_layout Plain Layout
11895 \begin_inset Flex Code
11898 \begin_layout Plain Layout
11904 ] The category for this style.
11905 This is used to group related styles in the style combobox on the toolbar.
11906 Any string can be used, but you may want to use existing categories with
11911 \begin_layout Description
11912 \begin_inset Flex Code
11915 \begin_layout Plain Layout
11921 Depth of XML command.
11922 Used only with XML-type formats.
11925 \begin_layout Description
11926 \begin_inset Flex Code
11929 \begin_layout Plain Layout
11936 \begin_inset Flex Code
11939 \begin_layout Plain Layout
11945 ] Copies all the features of an existing style into the current one.
11949 \begin_layout Description
11950 \begin_inset Flex Code
11953 \begin_layout Plain Layout
11960 \begin_inset Flex Code
11963 \begin_layout Plain Layout
11969 ] The name of a style whose preamble should be output
11974 This allows to ensure some ordering of the preamble snippets when macros
11975 definitions depend on one another.
11979 \begin_layout Plain Layout
11980 Note that, besides that functionality, there is no way to ensure any ordering
11982 The ordering that you see in a given version of \SpecialChar LyX
11983 may change without warning
11992 \begin_layout Description
11993 \begin_inset Flex Code
11996 \begin_layout Plain Layout
12003 \begin_inset Flex Code
12006 \begin_layout Plain Layout
12011 , Box, Filled_Box, Static
12016 ] The type of label that stands at the end of the paragraph (or sequence
12018 \begin_inset Flex Code
12021 \begin_layout Plain Layout
12028 \begin_inset Newline newline
12032 \begin_inset Flex Code
12035 \begin_layout Plain Layout
12042 \begin_inset Flex Code
12045 \begin_layout Plain Layout
12052 \begin_inset Flex Code
12055 \begin_layout Plain Layout
12063 \begin_inset Flex Code
12066 \begin_layout Plain Layout
12073 \begin_inset Quotes eld
12077 \begin_inset Quotes erd
12081 \begin_inset Flex Code
12084 \begin_layout Plain Layout
12091 \begin_inset space \space{}
12095 \begin_inset Flex Code
12098 \begin_layout Plain Layout
12104 ) is a white (resp.
12105 \begin_inset space ~
12108 black) square suitable for end of proof markers,
12109 \begin_inset Flex Code
12112 \begin_layout Plain Layout
12118 is an explicit text string.
12121 \begin_layout Description
12122 \begin_inset Flex Code
12125 \begin_layout Plain Layout
12132 \begin_inset Flex Code
12135 \begin_layout Plain Layout
12141 ] The string used for a label with a
12142 \begin_inset Flex Code
12145 \begin_layout Plain Layout
12152 \begin_inset Newline newline
12156 \begin_inset Flex Code
12159 \begin_layout Plain Layout
12169 \begin_layout Description
12170 \begin_inset Flex Code
12173 \begin_layout Plain Layout
12179 The font used for both the text body
12185 \begin_inset CommandInset ref
12187 reference "subsec:Font-description"
12192 Note that defining this font automatically defines the
12193 \begin_inset Flex Code
12196 \begin_layout Plain Layout
12203 So you should define this one first if you also want to define
12204 \begin_inset Flex Code
12207 \begin_layout Plain Layout
12216 \begin_layout Description
12217 \begin_inset Flex Code
12220 \begin_layout Plain Layout
12227 \begin_inset Flex Code
12230 \begin_layout Plain Layout
12236 ] Used for backporting new styles to stable \SpecialChar LyX
12238 The first stable version that supports this tag is \SpecialChar LyX
12240 The argument is a number which may either be 0, -1 or any value greater
12243 \begin_inset Flex Code
12246 \begin_layout Plain Layout
12252 flag of a style is greater than zero, it will always be written to the
12254 If a .lyx file is read, the style definitions from the document header are
12255 added to the document class.
12256 Therefore even older \SpecialChar LyX
12257 versions can handle the style.
12259 \begin_inset Flex Code
12262 \begin_layout Plain Layout
12268 is a version number: If the style is read, and the version number is less
12269 than the version number of the already existing style in the document class,
12270 the new style is ignored.
12271 If the version number is greater, the new style replaces the existing style.
12272 A value of -1 means an infinite version number, i.
12273 \begin_inset space \thinspace{}
12277 \begin_inset space \space{}
12280 the style is always used.
12283 \begin_layout Description
12284 \begin_inset Flex Code
12287 \begin_layout Plain Layout
12294 \begin_inset Flex Code
12297 \begin_layout Plain Layout
12306 \begin_inset space \thinspace{}
12310 \begin_inset Flex Code
12313 \begin_layout Plain Layout
12319 ] Usually \SpecialChar LyX
12320 does not allow you to insert more than one space between words,
12321 since a space is considered as the separation between two words, not a
12322 character or symbol of its own.
12323 This is a very fine thing but sometimes annoying, for example, when typing
12324 program code or plain \SpecialChar LaTeX
12327 \begin_inset Flex Code
12330 \begin_layout Plain Layout
12337 Note that \SpecialChar LyX
12338 will create protected blanks for the additional blanks when
12339 in another mode than \SpecialChar LaTeX
12343 \begin_layout Description
12344 \begin_inset Flex Code
12347 \begin_layout Plain Layout
12353 These tags are used with XHTML output.
12355 \begin_inset CommandInset ref
12357 reference "subsec:Paragraph-Style-XHTML"
12364 \begin_layout Description
12365 \begin_inset Flex Code
12368 \begin_layout Plain Layout
12374 [FIXME] (Used only with XML-type formats.)
12377 \begin_layout Description
12378 \begin_inset Flex Code
12381 \begin_layout Plain Layout
12388 \begin_inset Flex Code
12391 \begin_layout Plain Layout
12400 \begin_inset space \thinspace{}
12404 \begin_inset Flex Code
12407 \begin_layout Plain Layout
12414 \begin_inset Flex Code
12417 \begin_layout Plain Layout
12423 , marks the style as to be included in the document preamble and not in
12425 This is useful for document classes that want such information as the title
12426 and author to appear in the preamble.
12427 Note that this works only for styles for which the
12428 \begin_inset Flex Code
12431 \begin_layout Plain Layout
12438 \begin_inset Flex Code
12441 \begin_layout Plain Layout
12448 \begin_inset Flex Code
12451 \begin_layout Plain Layout
12460 \begin_layout Description
12461 \begin_inset Flex Code
12464 \begin_layout Plain Layout
12471 \begin_inset Flex Code
12474 \begin_layout Plain Layout
12483 \begin_inset space \thinspace{}
12487 \begin_inset Flex Code
12490 \begin_layout Plain Layout
12497 \begin_inset Flex Code
12500 \begin_layout Plain Layout
12506 , marks the style as being part of a title block (see also the
12507 \begin_inset Flex Code
12510 \begin_layout Plain Layout
12517 \begin_inset Flex Code
12520 \begin_layout Plain Layout
12529 \begin_layout Description
12530 \begin_inset Flex Code
12533 \begin_layout Plain Layout
12540 \begin_inset Flex Code
12543 \begin_layout Plain Layout
12549 ] The \SpecialChar LaTeX
12550 command sequence declaring an item in a list.
12551 The command is to be defined without the preceding backslash (the default
12553 \begin_inset Quotes eld
12557 \begin_inset Quotes erd
12561 \begin_inset Flex Code
12564 \begin_layout Plain Layout
12572 in the \SpecialChar LaTeX
12576 \begin_layout Description
12577 \begin_inset Flex Code
12580 \begin_layout Plain Layout
12587 \begin_inset Flex Code
12590 \begin_layout Plain Layout
12596 ] This provides extra space between paragraphs that have the same style.
12597 If you put other styles into an environment, each is separated with the
12599 \begin_inset Flex Code
12602 \begin_layout Plain Layout
12609 But the whole items of the environment are additionally separated with
12611 \begin_inset Flex Code
12614 \begin_layout Plain Layout
12621 Note that this is a
12626 \begin_layout Description
12627 \begin_inset Flex Code
12630 \begin_layout Plain Layout
12636 [FIXME] (Used only with XML-type formats.)
12639 \begin_layout Description
12640 \begin_inset Flex Code
12643 \begin_layout Plain Layout
12650 \begin_inset Flex Code
12653 \begin_layout Plain Layout
12662 \begin_inset space \thinspace{}
12666 \begin_inset Flex Code
12669 \begin_layout Plain Layout
12675 ] Usually \SpecialChar LyX
12676 does not allow you to leave a paragraph empty, since it would
12677 lead to empty \SpecialChar LaTeX
12679 There are some cases where this could be desirable however: in a letter
12680 template, the required fields can be provided as empty fields, so that
12681 people do not forget them; in some special classes, a style can be used
12682 as some kind of break, which does not contain actual text.
12685 \begin_layout Description
12686 \begin_inset Flex Code
12689 \begin_layout Plain Layout
12696 \begin_inset Flex Code
12699 \begin_layout Plain Layout
12705 ] The vertical space between the label and the text body.
12706 Only used for labels that are above the text body (
12707 \begin_inset Flex Code
12710 \begin_layout Plain Layout
12717 \begin_inset Newline newline
12721 \begin_inset Flex Code
12724 \begin_layout Plain Layout
12725 Centered_Top_Environment
12733 \begin_layout Description
12734 \begin_inset Flex Code
12737 \begin_layout Plain Layout
12744 \begin_inset Flex Code
12747 \begin_layout Plain Layout
12753 ] The name of the counter for automatic numbering.
12754 In order to have the counter appear with your label, you will need to reference
12756 \begin_inset Flex Code
12759 \begin_layout Plain Layout
12768 This will work with
12769 \begin_inset Flex Code
12772 \begin_layout Plain Layout
12779 \begin_inset Flex Code
12782 \begin_layout Plain Layout
12789 \begin_inset Flex Code
12792 \begin_layout Plain Layout
12799 \begin_inset Flex Code
12802 \begin_layout Plain Layout
12809 \begin_inset Newline newline
12817 \begin_inset Flex Code
12820 \begin_layout Plain Layout
12827 \begin_inset Flex Code
12830 \begin_layout Plain Layout
12836 , though this case is a bit complicated.
12837 Suppose you declare
12838 \begin_inset Quotes eld
12842 \begin_inset Flex Code
12845 \begin_layout Plain Layout
12846 LabelCounter myenum
12852 \begin_inset Quotes erd
12856 Then the actual counters used are
12857 \begin_inset Flex Code
12860 \begin_layout Plain Layout
12867 \begin_inset Flex Code
12870 \begin_layout Plain Layout
12877 \begin_inset Flex Code
12880 \begin_layout Plain Layout
12887 \begin_inset Flex Code
12890 \begin_layout Plain Layout
12896 , much as in \SpecialChar LaTeX
12898 These counters must all be declared separately.
12899 \begin_inset Newline newline
12903 \begin_inset CommandInset ref
12905 reference "subsec:Counters"
12909 for details on counters.
12912 \begin_layout Description
12913 \begin_inset Flex Code
12916 \begin_layout Plain Layout
12922 The font used for the label.
12924 \begin_inset CommandInset ref
12926 reference "subsec:Font-description"
12933 \begin_layout Description
12934 \begin_inset Flex Code
12937 \begin_layout Plain Layout
12944 \begin_inset Flex Code
12947 \begin_layout Plain Layout
12953 ] Text that indicates how far a label should be indented.
12956 \begin_layout Description
12957 \begin_inset Flex Code
12960 \begin_layout Plain Layout
12967 \begin_inset Flex Code
12970 \begin_layout Plain Layout
12976 ] Text that indicates the amount of horizontal space between the label and
12978 Only used for labels that are not above the text body.
12981 \begin_layout Description
12982 \begin_inset Flex Code
12985 \begin_layout Plain Layout
12992 \begin_inset Flex Code
12995 \begin_layout Plain Layout
13001 ] The string used for the label.
13003 \begin_inset Flex Code
13006 \begin_layout Plain Layout
13012 is set, this string can be contain the special formatting commands described
13014 \begin_inset CommandInset ref
13016 reference "subsec:Counters"
13023 \begin_layout Description
13024 \begin_inset Flex Code
13027 \begin_layout Plain Layout
13028 LabelStringAppendix
13034 \begin_inset Flex Code
13037 \begin_layout Plain Layout
13043 ] This is used inside the appendix instead of
13044 \begin_inset Newline newline
13048 \begin_inset Flex Code
13051 \begin_layout Plain Layout
13059 \begin_inset Flex Code
13062 \begin_layout Plain Layout
13069 \begin_inset Newline newline
13073 \begin_inset Flex Code
13076 \begin_layout Plain Layout
13077 LabelStringAppendix
13085 \begin_layout Description
13086 \begin_inset Flex Code
13089 \begin_layout Plain Layout
13095 [FIXME] (Used only with XML-type formats.)
13098 \begin_layout Description
13099 \begin_inset Flex Code
13102 \begin_layout Plain Layout
13109 \begin_inset Flex Code
13112 \begin_layout Plain Layout
13117 , Manual, Static, Above,
13118 \begin_inset Newline newline
13121 Centered, Sensitive, Enumerate,
13122 \begin_inset Newline newline
13125 Itemize, Bibliography
13131 \begin_inset Separator parbreak
13138 \begin_layout Description
13139 \begin_inset Flex Code
13142 \begin_layout Plain Layout
13148 means the label is the very first word (up to the first real blank).
13149 Use protected spaces if you want more than one word as the label.
13153 \begin_layout Description
13154 \begin_inset Flex Code
13157 \begin_layout Plain Layout
13163 means the label is simply what is declared as
13164 \begin_inset Flex Code
13167 \begin_layout Plain Layout
13174 This will be displayed
13175 \begin_inset Quotes eld
13179 \begin_inset Quotes erd
13182 , at the beginning of the paragraph.
13184 \begin_inset Flex Code
13187 \begin_layout Plain Layout
13194 \begin_inset Flex Code
13197 \begin_layout Plain Layout
13203 , then it will be displayed only in the first paragraph of any sequence
13204 of paragraphs with the same
13205 \begin_inset Flex Code
13208 \begin_layout Plain Layout
13217 \begin_layout Description
13218 \begin_inset Flex Code
13221 \begin_layout Plain Layout
13228 \begin_inset space ~
13232 \begin_inset space ~
13236 \begin_inset Flex Code
13239 \begin_layout Plain Layout
13245 are special cases of
13246 \begin_inset Flex Code
13249 \begin_layout Plain Layout
13256 The label will be printed above the paragraph either at the beginning of
13257 the line or centered.
13260 \begin_layout Description
13261 \begin_inset Flex Code
13264 \begin_layout Plain Layout
13270 is a special case for the caption-labels
13271 \begin_inset Quotes eld
13275 \begin_inset Quotes erd
13279 \begin_inset Quotes eld
13283 \begin_inset Quotes erd
13287 \begin_inset Newline newline
13291 \begin_inset Flex Code
13294 \begin_layout Plain Layout
13300 means the (hardcoded) label string depends on the kind of float: It is
13301 hardcoded to be `FloatType N', where N is the value of the counter associated
13303 For the case that a caption is inserted outside of a float the
13304 \begin_inset Flex Code
13307 \begin_layout Plain Layout
13314 \begin_inset Quotes eld
13318 \begin_inset Quotes erd
13324 \begin_layout Description
13325 \begin_inset Flex Code
13328 \begin_layout Plain Layout
13334 produces the usual sort of enumeration labels.
13335 At present, it is hardcoded to use Arabic numerals, lowercase letters,
13336 small Roman numerals, and uppercase letters for the four possible depths.
13339 \begin_layout Description
13340 \begin_inset Flex Code
13343 \begin_layout Plain Layout
13349 produces various bullets at the different levels.
13350 It is also hardcoded.
13353 \begin_layout Description
13354 \begin_inset Flex Code
13357 \begin_layout Plain Layout
13363 should be used only with
13364 \begin_inset Flex Code
13367 \begin_layout Plain Layout
13368 LatexType BibEnvironment
13377 \begin_layout Description
13378 \begin_inset Flex Code
13381 \begin_layout Plain Layout
13387 Note that this will completely override any prior
13388 \begin_inset Flex Code
13391 \begin_layout Plain Layout
13397 declaration for this style.
13399 \begin_inset Quotes eld
13403 \begin_inset Flex Code
13406 \begin_layout Plain Layout
13413 \begin_inset Quotes erd
13418 \begin_inset CommandInset ref
13420 reference "subsec:I18n"
13424 for details on its use.
13427 \begin_layout Description
13428 \begin_inset Flex Code
13431 \begin_layout Plain Layout
13438 \begin_inset Flex Code
13441 \begin_layout Plain Layout
13447 ] The name of the corresponding \SpecialChar LaTeX
13449 Either the environment or command name.
13452 \begin_layout Description
13453 \begin_inset Flex Code
13456 \begin_layout Plain Layout
13463 \begin_inset Flex Code
13466 \begin_layout Plain Layout
13472 ] An optional parameter for the corresponding
13473 \begin_inset Flex Code
13476 \begin_layout Plain Layout
13483 This parameter cannot be changed from within \SpecialChar LyX
13485 \begin_inset Flex Code
13488 \begin_layout Plain Layout
13494 for customizable parameters).
13495 This will be output as is after all \SpecialChar LaTeX
13497 \begin_inset Flex Code
13500 \begin_layout Plain Layout
13509 \begin_layout Description
13510 \begin_inset Flex Code
13513 \begin_layout Plain Layout
13520 \begin_inset Flex Code
13523 \begin_layout Plain Layout
13528 , Command, Environment, Item_Environment,
13529 \begin_inset Newline newline
13532 List_Environment, Bib_Environment
13537 ] How the style should be translated into \SpecialChar LaTeX
13542 \begin_layout Plain Layout
13543 \begin_inset Flex Code
13546 \begin_layout Plain Layout
13552 is perhaps a bit misleading, since these rules apply to SGML classes, too.
13553 Visit the SGML class files for specific examples.
13559 \begin_inset Separator parbreak
13566 \begin_layout Description
13567 \begin_inset Flex Code
13570 \begin_layout Plain Layout
13576 means nothing special.
13579 \begin_layout Description
13580 \begin_inset Flex Code
13583 \begin_layout Plain Layout
13590 \begin_inset Flex Code
13593 \begin_layout Plain Layout
13600 {\SpecialChar ldots
13609 \begin_layout Description
13610 \begin_inset Flex Code
13613 \begin_layout Plain Layout
13620 \begin_inset Flex Code
13623 \begin_layout Plain Layout
13630 }\SpecialChar ldots
13646 \begin_layout Description
13647 \begin_inset Flex Code
13650 \begin_layout Plain Layout
13657 \begin_inset Flex Code
13660 \begin_layout Plain Layout
13667 \begin_inset Flex Code
13670 \begin_layout Plain Layout
13678 is generated for each paragraph of this environment.
13682 \begin_layout Description
13683 \begin_inset Flex Code
13686 \begin_layout Plain Layout
13693 \begin_inset Flex Code
13696 \begin_layout Plain Layout
13703 \begin_inset Newline newline
13707 \begin_inset Flex Code
13710 \begin_layout Plain Layout
13716 is passed as an argument to the environment.
13717 \begin_inset Newline newline
13721 \begin_inset Flex Code
13724 \begin_layout Plain Layout
13730 can be defined in the
13731 \begin_inset Flex MenuItem
13734 \begin_layout Plain Layout
13735 Edit\SpecialChar menuseparator
13737 \begin_inset space ~
13748 \begin_layout Description
13749 \begin_inset Flex Code
13752 \begin_layout Plain Layout
13759 \begin_inset Flex Code
13762 \begin_layout Plain Layout
13768 but adds additionally the necessary mandatory argument (the longest label)
13769 to the begin statement of the bibliography environment:
13770 \begin_inset Newline newline
13774 \begin_inset Flex Code
13777 \begin_layout Plain Layout
13780 begin{thebibliography}{99}
13785 It is therefore only useful for bibliography environments.
13786 The default longest label
13787 \begin_inset Quotes eld
13791 \begin_inset Quotes erd
13794 can be changed by the user in the paragraph settings of a bibliography
13798 \begin_layout Standard
13799 Putting the last few things together, the \SpecialChar LaTeX
13800 output will be either:
13803 \begin_layout LyX-Code
13806 LatexName[LatexParam]{\SpecialChar ldots
13810 \begin_layout Standard
13814 \begin_layout LyX-Code
13817 begin{LatexName}[LatexParam] \SpecialChar ldots
13823 \begin_layout Standard
13824 depending upon the \SpecialChar LaTeX
13829 \begin_layout Description
13830 \begin_inset Flex Code
13833 \begin_layout Plain Layout
13840 \begin_inset Flex Code
13843 \begin_layout Plain Layout
13849 ] A string that is put at the beginning of the style content.
13850 A line break in the output can be indicated by
13851 \begin_inset Flex Code
13854 \begin_layout Plain Layout
13863 \begin_layout Description
13864 \begin_inset Flex Code
13867 \begin_layout Plain Layout
13874 \begin_inset Flex Code
13877 \begin_layout Plain Layout
13883 ] If you put styles into environments, the different
13884 \begin_inset Flex Code
13887 \begin_layout Plain Layout
13893 are not simply added, but added with a factor
13894 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
13898 Note that this parameter is also used when
13899 \begin_inset Flex Code
13902 \begin_layout Plain Layout
13909 \begin_inset Flex Code
13912 \begin_layout Plain Layout
13919 \begin_inset Flex Code
13922 \begin_layout Plain Layout
13929 Then it is added to the manual or dynamic margin.
13930 \begin_inset Newline newline
13934 \begin_inset Quotes eld
13938 \begin_inset Flex Code
13941 \begin_layout Plain Layout
13948 \begin_inset Quotes erd
13951 means that the paragraph is indented with the width of
13952 \begin_inset Quotes eld
13956 \begin_inset Flex Code
13959 \begin_layout Plain Layout
13966 \begin_inset Quotes erd
13969 in the normal font.
13970 You can get a negative width by prefixing the string with
13971 \begin_inset Quotes eld
13975 \begin_inset Flex Code
13978 \begin_layout Plain Layout
13985 \begin_inset Quotes erd
13989 This way was chosen so that the look is the same with each used screen
13993 \begin_layout Description
13994 \begin_inset Flex Code
13997 \begin_layout Plain Layout
14004 \begin_inset Flex Code
14007 \begin_layout Plain Layout
14012 , Manual, Dynamic, First_Dynamic, Right_Address_Box
14018 \begin_inset Newline newline
14021 The kind of margin that the style has on the left side.
14022 \begin_inset Separator parbreak
14029 \begin_layout Description
14030 \begin_inset Flex Code
14033 \begin_layout Plain Layout
14039 just means a fixed margin.
14042 \begin_layout Description
14043 \begin_inset Flex Code
14046 \begin_layout Plain Layout
14052 means that the left margin depends on the string entered in the
14053 \begin_inset Flex MenuItem
14056 \begin_layout Plain Layout
14057 Edit\SpecialChar menuseparator
14059 \begin_inset space ~
14068 This is used to typeset nice lists without tabulators.
14071 \begin_layout Description
14072 \begin_inset Flex Code
14075 \begin_layout Plain Layout
14081 means that the margin depends on the size of the label.
14082 This is used for automatic enumerated headlines.
14083 It is obvious that the headline
14084 \begin_inset Quotes eld
14087 5.4.3.2.1 Very long headline
14088 \begin_inset Quotes erd
14091 must have a wider left margin (as wide as
14092 \begin_inset Quotes eld
14096 \begin_inset Quotes erd
14099 plus the space) than
14100 \begin_inset Quotes eld
14103 3.2 Very long headline
14104 \begin_inset Quotes erd
14108 \begin_inset Quotes eld
14112 \begin_inset Quotes erd
14115 are not able to do this.
14118 \begin_layout Description
14119 \begin_inset Flex Code
14122 \begin_layout Plain Layout
14128 is similar, but only the very first row of the paragraph is dynamic, while
14129 the others are static; this is used, for example, for descriptions.
14132 \begin_layout Description
14133 \begin_inset Flex Code
14136 \begin_layout Plain Layout
14142 means the margin is chosen in a way that the longest row of this paragraph
14143 fits to the right margin.
14144 This is used to typeset an address on the right edge of the page.
14148 \begin_layout Description
14149 \begin_inset Flex Code
14152 \begin_layout Plain Layout
14159 \begin_inset Flex Code
14162 \begin_layout Plain Layout
14171 \begin_inset space \thinspace{}
14175 \begin_inset Flex Code
14178 \begin_layout Plain Layout
14184 ] Whether fragile commands in this style should be
14185 \begin_inset Flex Code
14188 \begin_layout Plain Layout
14201 whether this command should itself be protected.)
14204 \begin_layout Description
14205 \begin_inset Flex Code
14208 \begin_layout Plain Layout
14215 \begin_inset Flex Code
14218 \begin_layout Plain Layout
14225 \begin_inset space \thinspace{}
14229 \begin_inset Flex Code
14232 \begin_layout Plain Layout
14240 ] Whether newlines are translated into \SpecialChar LaTeX
14242 \begin_inset Flex Code
14245 \begin_layout Plain Layout
14256 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
14258 inside \SpecialChar LyX
14262 \begin_layout Description
14263 \begin_inset Flex Code
14266 \begin_layout Plain Layout
14273 \begin_inset Flex Code
14276 \begin_layout Plain Layout
14285 \begin_inset space \thinspace{}
14289 \begin_inset Flex Code
14292 \begin_layout Plain Layout
14298 ] If set to true, and if
14299 \begin_inset Flex Code
14302 \begin_layout Plain Layout
14309 \begin_inset Flex Code
14312 \begin_layout Plain Layout
14318 ) paragraphs are being indented, then the indentation of such a paragraph
14319 following one of this type will be suppressed.
14320 (So this will not affect the display of non-default paragraphs.)
14323 \begin_layout Description
14324 \begin_inset Flex Code
14327 \begin_layout Plain Layout
14334 \begin_inset Flex Code
14337 \begin_layout Plain Layout
14343 ] Name of a style that has replaced this style.
14344 This is used to rename a style, while keeping backward compatibility.
14345 \change_inserted -712698321 1432986397
14349 \begin_layout Description
14351 \change_inserted -712698321 1432986583
14352 \begin_inset Flex Code
14355 \begin_layout Plain Layout
14357 \change_inserted -712698321 1432986403
14364 \begin_inset Flex Code
14367 \begin_layout Plain Layout
14369 \change_inserted -712698321 1432986397
14376 \begin_inset space \thinspace{}
14380 \begin_inset Flex Code
14383 \begin_layout Plain Layout
14385 \change_inserted -712698321 1432986397
14391 ] Determines whether consecutive pragraphs of the same type are treated
14392 as belonging together.
14393 This has the effect that the
14394 \begin_inset Flex Code
14397 \begin_layout Plain Layout
14399 \change_inserted -712698321 1432986460
14405 is only printed once before such a group.
14406 By default, this is true for
14407 \begin_inset Flex Code
14410 \begin_layout Plain Layout
14412 \change_inserted -712698321 1432986491
14419 \begin_inset Flex Code
14422 \begin_layout Plain Layout
14424 \change_inserted -712698321 1432986583
14433 \begin_inset Flex Code
14436 \begin_layout Plain Layout
14438 \change_inserted -712698321 1432986572
14446 and false for all other types.
14451 \begin_layout Description
14452 \begin_inset Flex Code
14455 \begin_layout Plain Layout
14462 \begin_inset Flex Code
14465 \begin_layout Plain Layout
14474 \begin_inset space \thinspace{}
14478 \begin_inset Flex Code
14481 \begin_layout Plain Layout
14487 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
14489 but only by a line break; together with
14490 \begin_inset Flex Code
14493 \begin_layout Plain Layout
14499 , this allows to emulate a plain text editor (like the ERT inset).
14502 \begin_layout Description
14503 \begin_inset Flex Code
14506 \begin_layout Plain Layout
14513 \begin_inset Flex Code
14516 \begin_layout Plain Layout
14522 ] The indent of the very first line of a paragraph.
14524 \begin_inset Newline newline
14528 \begin_inset Flex Code
14531 \begin_layout Plain Layout
14537 will be fixed for a certain style.
14538 The exception is the default style, since the indentation for these paragraphs
14539 can be prohibited with
14540 \begin_inset Flex Code
14543 \begin_layout Plain Layout
14551 \begin_inset Flex Code
14554 \begin_layout Plain Layout
14560 style paragraphs inside environments use the
14561 \begin_inset Flex Code
14564 \begin_layout Plain Layout
14570 of the environment, not their native one.
14572 \begin_inset Flex Code
14575 \begin_layout Plain Layout
14581 paragraphs inside an enumeration are not indented.
14584 \begin_layout Description
14585 \begin_inset Flex Code
14588 \begin_layout Plain Layout
14595 \begin_inset Flex Code
14598 \begin_layout Plain Layout
14604 ] The vertical space between two paragraphs of this style.
14607 \begin_layout Description
14608 \begin_inset Flex Code
14611 \begin_layout Plain Layout
14618 \begin_inset Flex Code
14621 \begin_layout Plain Layout
14628 allows the user to choose either
14629 \begin_inset Quotes eld
14633 \begin_inset Quotes erd
14637 \begin_inset Quotes eld
14641 \begin_inset Quotes erd
14644 to separate paragraphs.
14646 \begin_inset Quotes eld
14650 \begin_inset Quotes erd
14654 \begin_inset Flex Code
14657 \begin_layout Plain Layout
14665 \begin_inset Quotes eld
14669 \begin_inset Quotes erd
14673 \begin_inset Flex Code
14676 \begin_layout Plain Layout
14682 is ignored and all paragraphs are separated by the
14683 \begin_inset Flex Code
14686 \begin_layout Plain Layout
14693 The vertical space is calculated with
14694 \begin_inset Flex Code
14697 \begin_layout Plain Layout
14699 \begin_inset space ~
14708 \begin_inset Flex Code
14711 \begin_layout Plain Layout
14717 is the height of a row with the normal font.
14718 This way, the look stays the same with different screen fonts.
14721 \begin_layout Description
14722 \begin_inset Flex Code
14725 \begin_layout Plain Layout
14732 \begin_inset Flex Code
14735 \begin_layout Plain Layout
14744 \begin_inset space \thinspace{}
14748 \begin_inset Flex Code
14751 \begin_layout Plain Layout
14757 ] Whether the contents of this paragraph should be output in raw form, meaning
14758 without special translations that \SpecialChar LaTeX
14760 \change_inserted -712698321 1429534178
14764 \begin_layout Description
14766 \change_inserted -712698321 1429534242
14769 \begin_inset Flex Code
14772 \begin_layout Plain Layout
14774 \change_inserted -712698321 1429534178
14783 \begin_inset Flex Code
14786 \begin_layout Plain Layout
14788 \change_inserted -712698321 1429534178
14789 string of characters
14798 Defines individual characters that should be output in raw form, meaning
14799 without special translations that \SpecialChar LaTeX
14805 \begin_layout Description
14806 \begin_inset Flex Code
14809 \begin_layout Plain Layout
14815 Information to be included in the \SpecialChar LaTeX
14816 preamble when this style is used.
14817 Used to define macros, load packages, etc., required by this particular
14820 \begin_inset Quotes eld
14824 \begin_inset Flex Code
14827 \begin_layout Plain Layout
14834 \begin_inset Quotes erd
14840 \begin_layout Description
14841 \begin_inset Flex Code
14844 \begin_layout Plain Layout
14851 \begin_inset Flex Code
14854 \begin_layout Plain Layout
14860 ] The prefix to use when creating labels referring to paragraphs of this
14862 This allows the use of formatted references.
14865 \begin_layout Description
14866 \begin_inset Flex Code
14869 \begin_layout Plain Layout
14876 \begin_inset Flex Code
14879 \begin_layout Plain Layout
14885 ] Whether the style requires the feature
14886 \begin_inset Flex Code
14889 \begin_layout Plain Layout
14896 \change_deleted -712698321 1438601713
14901 \change_deleted -712698321 1438601638
14902 See the description of
14903 \begin_inset Flex Code
14906 \begin_layout Plain Layout
14913 \begin_inset CommandInset ref
14915 reference "subsec:General-text-class"
14919 ) for information on `features'.
14920 \change_inserted -712698321 1438601711
14922 \begin_inset CommandInset ref
14924 reference "chap:List-of-functions"
14928 for the list of features).
14929 If you require a package with specific options, you can additionally use
14931 \begin_inset Flex Code
14934 \begin_layout Plain Layout
14936 \change_inserted -712698321 1438601638
14942 as a general text class parameter (see sec.
14943 \begin_inset space ~
14947 \begin_inset CommandInset ref
14949 reference "subsec:General-text-class"
14958 \begin_layout Description
14959 \begin_inset Flex Code
14962 \begin_layout Plain Layout
14969 \begin_inset Flex Code
14972 \begin_layout Plain Layout
14981 \begin_inset Flex Code
14984 \begin_layout Plain Layout
14990 ] Resets the \SpecialChar LaTeX
14991 arguments of this style (as defined via the
14992 \begin_inset Flex Code
14995 \begin_layout Plain Layout
15002 This is useful if you have copied a style via
15003 \begin_inset Flex Code
15006 \begin_layout Plain Layout
15012 , but you do not want to inherit its (required and optional) arguments.
15015 \begin_layout Description
15016 \begin_inset Flex Code
15019 \begin_layout Plain Layout
15026 \begin_inset Flex Code
15029 \begin_layout Plain Layout
15035 ] A string that is put at the end of the layout content.
15036 A line break in the output can be indicated by
15037 \begin_inset Flex Code
15040 \begin_layout Plain Layout
15049 \begin_layout Description
15050 \begin_inset Flex Code
15053 \begin_layout Plain Layout
15060 \begin_inset Flex Code
15063 \begin_layout Plain Layout
15070 \begin_inset Flex Code
15073 \begin_layout Plain Layout
15082 \begin_layout Description
15083 \begin_inset Flex Code
15086 \begin_layout Plain Layout
15093 \begin_inset Flex Code
15096 \begin_layout Plain Layout
15105 \begin_inset Flex Code
15108 \begin_layout Plain Layout
15115 \begin_inset Flex Code
15118 \begin_layout Plain Layout
15125 \begin_inset Flex Code
15128 \begin_layout Plain Layout
15130 \begin_inset space ~
15138 ] This defines what the default spacing should be in the style.
15140 \begin_inset Flex Code
15143 \begin_layout Plain Layout
15150 \begin_inset Flex Code
15153 \begin_layout Plain Layout
15160 \begin_inset Flex Code
15163 \begin_layout Plain Layout
15169 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
15170 If you specify the argument
15171 \begin_inset Flex Code
15174 \begin_layout Plain Layout
15180 , then you must also provide a value argument which will be the actual multiplie
15182 Note that, contrary to other parameters,
15183 \begin_inset Flex Code
15186 \begin_layout Plain Layout
15192 implies the generation of specific \SpecialChar LaTeX
15193 code, using the \SpecialChar LaTeX
15197 \begin_inset Flex Code
15200 \begin_layout Plain Layout
15209 \begin_layout Description
15210 \begin_inset Flex Code
15213 \begin_layout Plain Layout
15220 \begin_inset Flex Code
15223 \begin_layout Plain Layout
15230 \begin_inset space \thinspace{}
15234 \begin_inset Flex Code
15237 \begin_layout Plain Layout
15245 ] Allow spell-checking paragraphs of this style.
15249 \begin_layout Description
15250 \begin_inset Flex Code
15253 \begin_layout Plain Layout
15259 The font used for the text body .
15261 \begin_inset CommandInset ref
15263 reference "subsec:Font-description"
15270 \begin_layout Description
15271 \begin_inset Flex Code
15274 \begin_layout Plain Layout
15283 \begin_inset Flex Code
15286 \begin_layout Plain Layout
15296 The level of the style in the table of contents.
15297 This is used for automatic numbering of section headings.
15298 \change_inserted -712698321 1401363541
15302 \begin_layout Description
15304 \change_inserted -712698321 1401363906
15305 \begin_inset Flex Code
15308 \begin_layout Plain Layout
15310 \change_inserted -712698321 1401363547
15319 \begin_inset Flex Code
15322 \begin_layout Plain Layout
15324 \change_inserted -712698321 1401363664
15337 \begin_inset Flex Code
15340 \begin_layout Plain Layout
15342 \change_inserted -712698321 1401363669
15351 \begin_inset Flex Code
15354 \begin_layout Plain Layout
15356 \change_inserted -712698321 1401363675
15364 ] This tag determines whether the first line indentation of this paragraph
15365 can be toggled via the Paragraph settings dialog.
15369 \begin_inset Flex Code
15372 \begin_layout Plain Layout
15374 \change_inserted -712698321 1401363761
15384 is set, indentation can be toggled if the document settings use
15385 \begin_inset Quotes eld
15389 \begin_inset Quotes erd
15392 paragraph style, with
15393 \begin_inset Flex Code
15396 \begin_layout Plain Layout
15398 \change_inserted -712698321 1401363844
15404 , indentation can always be toggled, notwithstanding the document settings,
15406 \begin_inset Flex Code
15409 \begin_layout Plain Layout
15411 \change_inserted -712698321 1401363901
15417 , indentation can never be toggled.
15422 \begin_layout Description
15423 \begin_inset Flex Code
15426 \begin_layout Plain Layout
15433 \begin_inset Flex Code
15436 \begin_layout Plain Layout
15442 ] The vertical space with which the very first of a chain of paragraphs
15443 with this style is separated from the previous paragraph.
15444 If the previous paragraph has another style, the separations are not simply
15445 added, but the maximum is taken.
15448 \begin_layout Subsection
15449 \begin_inset CommandInset label
15455 Internationalization of Paragraph Styles
15458 \begin_layout Standard
15460 has long supported internationalization of layout information, but, until
15461 version 2.0, this applied only to the user interface and not to, say, PDF
15463 Thus, French authors were forced to resort to ugly hacks if they wanted
15468 1' instead of `Theorem 1'.
15469 Thanks to Georg Baum, that is no longer the case.
15472 \begin_layout Standard
15474 \begin_inset Flex Code
15477 \begin_layout Plain Layout
15483 defines text that is to appear in the typeset document, it may use
15484 \begin_inset Flex Code
15487 \begin_layout Plain Layout
15494 \begin_inset Flex Code
15497 \begin_layout Plain Layout
15503 to support non-English and even multi-language documents correctly.
15504 The following excerpt (from the
15505 \begin_inset Flex Code
15508 \begin_layout Plain Layout
15514 file) shows how this works:
15517 \begin_layout LyX-Code
15519 \begin_inset Separator parbreak
15526 \begin_layout LyX-Code
15529 theoremstyle{remark}
15532 \begin_layout LyX-Code
15535 newtheorem{claim}[thm]{
15542 \begin_layout LyX-Code
15546 \begin_layout LyX-Code
15550 \begin_layout LyX-Code
15555 claimname}{_(Claim)}
15558 \begin_layout LyX-Code
15562 \begin_layout LyX-Code
15566 \begin_layout LyX-Code
15575 claimname}{_(Claim)}}
15578 \begin_layout LyX-Code
15583 \begin_layout Standard
15584 In principle, any legal \SpecialChar LaTeX
15586 \begin_inset Flex Code
15589 \begin_layout Plain Layout
15596 \begin_inset Flex Code
15599 \begin_layout Plain Layout
15605 tags, but in practice they will typically look as they do here.
15606 The key to correct translation of the typeset text is the definition of
15607 the \SpecialChar LaTeX
15609 \begin_inset Flex Code
15612 \begin_layout Plain Layout
15621 \begin_inset Flex Code
15624 \begin_layout Plain Layout
15636 \begin_layout Standard
15638 \begin_inset Flex Code
15641 \begin_layout Plain Layout
15647 tag provides for internationalization based upon the overall language of
15649 The contents of the tag will be included in the preamble, just as with
15651 \begin_inset Flex Code
15654 \begin_layout Plain Layout
15661 What makes it special is the use of the
15662 \begin_inset Quotes eld
15666 \begin_inset Quotes erd
15670 \begin_inset Flex Code
15673 \begin_layout Plain Layout
15679 , which will be replaced, when \SpecialChar LyX
15680 produces \SpecialChar LaTeX
15681 output, with the translation of
15682 its argument into the document language.
15685 \begin_layout Standard
15687 \begin_inset Flex Code
15690 \begin_layout Plain Layout
15696 tag is more complex, since it is meant to provide support for multi-language
15697 documents and so offers an interface to the
15698 \begin_inset Flex Code
15701 \begin_layout Plain Layout
15708 Its contents will be added to the preamble once for each language that
15709 appears in the document.
15710 In this case, the argument to
15711 \begin_inset Flex Code
15714 \begin_layout Plain Layout
15720 will be replaced with its translation into the language in question; the
15722 \begin_inset Flex Code
15725 \begin_layout Plain Layout
15731 is replaced by the language name (as used by the babel package).
15734 \begin_layout Standard
15735 A German document that also included a French section would thus have the
15736 following in the preamble:
15739 \begin_layout LyX-Code
15748 claimname}{Affirmation}}
15749 \begin_inset Newline newline
15760 claimname}{Behauptung}}
15761 \begin_inset Newline newline
15768 claimname}{Behauptung}
15771 \begin_layout Standard
15774 \begin_inset Flex Code
15777 \begin_layout Plain Layout
15783 will then conspire to produce the correct text in the output.
15786 \begin_layout Standard
15787 One important point to note here is that the translations are provided by
15789 itself, through the file
15790 \begin_inset Flex Code
15793 \begin_layout Plain Layout
15800 This means, in effect, that
15801 \begin_inset Flex Code
15804 \begin_layout Plain Layout
15811 \begin_inset Flex Code
15814 \begin_layout Plain Layout
15820 are really only of use in layout files that are provided with \SpecialChar LyX
15822 entered in user-created layout files will not be seen by \SpecialChar LyX
15823 's internationalizatio
15824 n routines unless the
15825 \begin_inset Flex Code
15828 \begin_layout Plain Layout
15834 file is modified accordingly.
15835 That said, however, any layout created with the intention that it will
15836 be included with \SpecialChar LyX
15837 should use these tags where appropriate.
15838 Please note that the paragraph style translations provided by \SpecialChar LyX
15840 change with a minor update (e.
15841 \begin_inset space \thinspace{}
15845 \begin_inset space \space{}
15848 from version 2.1.x to 2.1.y).
15849 It is however quite likely that a major update (e.
15850 \begin_inset space \thinspace{}
15854 \begin_inset space \space{}
15857 from 2.0.x to 2.1.y) will introduce new translations or corrections.
15860 \begin_layout Subsection
15862 \begin_inset CommandInset label
15864 name "subsec:Floats"
15871 \begin_layout Standard
15872 It is necessary to define the floats (
15873 \begin_inset Flex MenuItem
15876 \begin_layout Plain Layout
15883 \begin_inset Flex MenuItem
15886 \begin_layout Plain Layout
15892 , \SpecialChar ldots
15893 ) in the text class itself.
15894 Standard floats are included in the file
15895 \begin_inset Flex Code
15898 \begin_layout Plain Layout
15904 , so you may have to do no more than add
15907 \begin_layout LyX-Code
15908 Input stdfloats.inc
15911 \begin_layout Standard
15912 to your layout file.
15913 If you want to implement a text class that proposes some other float types
15914 (like the AGU class bundled with \SpecialChar LyX
15915 ), the information below will hopefully
15917 \change_inserted -712698321 1432283506
15921 \begin_layout Description
15923 \change_inserted -712698321 1432313622
15924 \begin_inset Flex Code
15927 \begin_layout Plain Layout
15929 \change_inserted -712698321 1432283514
15936 \begin_inset Flex Code
15939 \begin_layout Plain Layout
15941 \change_inserted -712698321 1432283507
15947 =!htbpH] Allowed placement options for this float type.
15948 The value is a string of placement characters.
15949 Possible characters include:
15954 \begin_inset Quotes eld
15958 \begin_inset Quotes erd
15966 \begin_inset Quotes eld
15970 \begin_inset Quotes erd
15978 \begin_inset Quotes eld
15982 \begin_inset Quotes erd
15990 \begin_inset Quotes eld
15994 \begin_inset Quotes erd
16002 \begin_inset Quotes eld
16006 \begin_inset Quotes erd
16014 \begin_inset Quotes eld
16018 \begin_inset Quotes erd
16022 The order of the characters in the string does not matter.
16023 If no placement options are allowed, use the string
16030 \begin_layout Description
16032 \change_inserted -712698321 1432313755
16033 \begin_inset Flex Code
16036 \begin_layout Plain Layout
16038 \change_inserted -712698321 1432313630
16045 \begin_inset Flex Code
16048 \begin_layout Plain Layout
16050 \change_inserted -712698321 1432313646
16059 \begin_inset space \thinspace{}
16065 \begin_inset Flex Code
16068 \begin_layout Plain Layout
16070 \change_inserted -712698321 1432313646
16080 ] Defines whether the float allows to be rotated via the rotfloat package
16083 \begin_inset Flex Code
16086 \begin_layout Plain Layout
16088 \change_inserted -712698321 1432313721
16094 if the float does not support this feature.
16097 \begin_layout Description
16099 \change_inserted -712698321 1432313802
16100 \begin_inset Flex Code
16103 \begin_layout Plain Layout
16105 \change_inserted -712698321 1432313759
16112 \begin_inset Flex Code
16115 \begin_layout Plain Layout
16117 \change_inserted -712698321 1432313755
16126 \begin_inset space \thinspace{}
16132 \begin_inset Flex Code
16135 \begin_layout Plain Layout
16137 \change_inserted -712698321 1432313755
16147 ] Defines whether the float has a starred variant that spans columns in
16148 a two column paragraph.
16150 \begin_inset Flex Code
16153 \begin_layout Plain Layout
16155 \change_inserted -712698321 1432313755
16161 if the float does not support this feature.
16166 \begin_layout Description
16167 \begin_inset Flex Code
16170 \begin_layout Plain Layout
16177 \begin_inset Flex Code
16180 \begin_layout Plain Layout
16187 \begin_inset Quotes erd
16191 \begin_inset Quotes erd
16194 ] The file name extension of an auxiliary file for the list of figures (or
16197 writes the captions to this file.
16200 \begin_layout Description
16201 \begin_inset Flex Code
16204 \begin_layout Plain Layout
16211 \begin_inset Flex Code
16214 \begin_layout Plain Layout
16221 \begin_inset Quotes erd
16225 \begin_inset Quotes erd
16228 ] The string that will be used in the menus and also for the caption.
16229 This is translated to the current language if babel is used.
16232 \begin_layout Description
16233 \begin_inset Flex Code
16236 \begin_layout Plain Layout
16242 These tags control the XHTML output.
16244 \begin_inset CommandInset ref
16246 reference "sec:Tags-for-XHTML"
16253 \begin_layout Description
16254 \begin_inset Flex Code
16257 \begin_layout Plain Layout
16266 \begin_inset Flex Code
16269 \begin_layout Plain Layout
16278 \begin_inset space \thinspace{}
16282 \begin_inset Flex Code
16285 \begin_layout Plain Layout
16291 ] Indicates whether the float is already defined in the document class or
16292 if instead the \SpecialChar LaTeX
16294 \begin_inset Flex Code
16297 \begin_layout Plain Layout
16303 needs to be loaded to define it on-the-fly.
16305 \begin_inset Flex Code
16308 \begin_layout Plain Layout
16315 \begin_inset Flex Code
16318 \begin_layout Plain Layout
16325 It should be set to
16326 \begin_inset Flex Code
16329 \begin_layout Plain Layout
16335 if the float is already defined by the \SpecialChar LaTeX
16339 \begin_layout Description
16340 \begin_inset Flex Code
16343 \begin_layout Plain Layout
16350 \begin_inset Flex Code
16353 \begin_layout Plain Layout
16360 \begin_inset Quotes erd
16364 \begin_inset Quotes erd
16367 ] The command used to generate a list of floats of this type; the leading
16376 \begin_inset Flex Code
16379 \begin_layout Plain Layout
16385 is false, since there is no standard way to generate this command.
16387 \begin_inset Flex Code
16390 \begin_layout Plain Layout
16396 is true, since in that case there is a standard way to define the command.
16399 \begin_layout Description
16400 \begin_inset Flex Code
16403 \begin_layout Plain Layout
16410 \begin_inset Flex Code
16413 \begin_layout Plain Layout
16420 \begin_inset Quotes erd
16424 \begin_inset Quotes erd
16427 ] A title for a list of floats of this kind (list of figures, tables, or
16429 It is used for the screen label within \SpecialChar LyX
16430 , it is used by \SpecialChar LaTeX
16432 it is used as the title in the XHTML output.
16433 It will be translated to the document language.
16436 \begin_layout Description
16437 \begin_inset Flex Code
16440 \begin_layout Plain Layout
16447 \begin_inset Flex Code
16450 \begin_layout Plain Layout
16457 \begin_inset Quotes erd
16461 \begin_inset Quotes erd
16464 ] This (optional) argument determines whether floats of this class will
16465 be numbered within some sectional unit of the document.
16467 \begin_inset Flex Code
16470 \begin_layout Plain Layout
16477 \begin_inset Quotes eld
16481 \begin_inset Flex Code
16484 \begin_layout Plain Layout
16491 \begin_inset Quotes erd
16494 , the floats will be numbered within chapters.
16498 \begin_layout Description
16499 \begin_inset Flex Code
16502 \begin_layout Plain Layout
16509 \begin_inset Flex Code
16512 \begin_layout Plain Layout
16519 \begin_inset Quotes erd
16523 \begin_inset Quotes erd
16526 ] The default placement for the given class of floats.
16527 The string should be as in standard \SpecialChar LaTeX
16529 \begin_inset Flex Code
16532 \begin_layout Plain Layout
16539 \begin_inset Flex Code
16542 \begin_layout Plain Layout
16549 \begin_inset Flex Code
16552 \begin_layout Plain Layout
16559 \begin_inset Flex Code
16562 \begin_layout Plain Layout
16568 for top, bottom, page, and here, respectively.
16572 \begin_layout Plain Layout
16573 Note that the order of these letters in the string is irrelevant, like in
16580 On top of that there is a new type,
16581 \begin_inset Flex Code
16584 \begin_layout Plain Layout
16590 , which does not really correspond to a float, since it means: put it
16591 \begin_inset Quotes eld
16595 \begin_inset Quotes erd
16599 Note however that the
16600 \begin_inset Flex Code
16603 \begin_layout Plain Layout
16609 specifier is special and, because of implementation details, cannot be
16610 used in non-built in float types.
16611 If you do not understand what this means, just use
16612 \begin_inset Quotes eld
16616 \begin_inset Flex Code
16619 \begin_layout Plain Layout
16626 \begin_inset Quotes erd
16632 \begin_layout Description
16633 \begin_inset Flex Code
16636 \begin_layout Plain Layout
16643 \begin_inset Flex Code
16646 \begin_layout Plain Layout
16652 ] The prefix to use when creating labels referring to floats of this type.
16653 This allows the use of formatted references.
16654 Note that you can remove any
16655 \begin_inset Flex Code
16658 \begin_layout Plain Layout
16664 set by a copied style by using the special value
16665 \begin_inset Quotes eld
16669 \begin_inset Quotes erd
16672 , which must be all caps.
16675 \begin_layout Description
16676 \begin_inset Flex Code
16679 \begin_layout Plain Layout
16686 \begin_inset Flex Code
16689 \begin_layout Plain Layout
16696 \begin_inset Quotes erd
16700 \begin_inset Quotes erd
16703 ] The style used when defining the float using
16704 \begin_inset Flex Code
16707 \begin_layout Plain Layout
16718 \begin_layout Description
16719 \begin_inset Flex Code
16722 \begin_layout Plain Layout
16729 \begin_inset Flex Code
16732 \begin_layout Plain Layout
16739 \begin_inset Quotes erd
16743 \begin_inset Quotes erd
16747 \begin_inset Quotes eld
16751 \begin_inset Quotes erd
16754 of the new class of floats, like program or algorithm.
16755 After the appropriate
16756 \begin_inset Flex Code
16759 \begin_layout Plain Layout
16768 \begin_inset Flex Code
16771 \begin_layout Plain Layout
16780 \begin_inset Flex Code
16783 \begin_layout Plain Layout
16794 \begin_layout Description
16795 \begin_inset Flex Code
16798 \begin_layout Plain Layout
16805 \begin_inset Flex Code
16808 \begin_layout Plain Layout
16815 \begin_inset space \thinspace{}
16819 \begin_inset Flex Code
16822 \begin_layout Plain Layout
16830 ] Specifies whether this float is defined using the \SpecialChar LaTeX
16832 \begin_inset Flex Code
16835 \begin_layout Plain Layout
16841 , either by the class file, another package or on-the-fly by \SpecialChar LyX
16845 \begin_layout Standard
16846 Note that defining a float with type
16847 \begin_inset Flex Code
16850 \begin_layout Plain Layout
16858 automatically defines the corresponding counter with name
16859 \begin_inset Flex Code
16862 \begin_layout Plain Layout
16873 \begin_layout Subsection
16874 Flex insets and InsetLayout
16875 \begin_inset CommandInset label
16877 name "subsec:Flex-insets-and"
16884 \begin_layout Standard
16885 Flex insets come in three different kinds:
16888 \begin_layout Itemize
16890 \begin_inset Flex Code
16893 \begin_layout Plain Layout
16899 ): These define semantic markup corresponding to such \SpecialChar LaTeX
16901 \begin_inset Flex Code
16904 \begin_layout Plain Layout
16913 \begin_inset Flex Code
16916 \begin_layout Plain Layout
16927 \begin_layout Itemize
16929 \begin_inset Flex Code
16932 \begin_layout Plain Layout
16938 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
16940 footnote, and the like.
16941 An obvious example is an endnote inset, which is defined in the
16942 \begin_inset Flex Code
16945 \begin_layout Plain Layout
16954 \begin_layout Itemize
16956 \begin_inset Flex Code
16959 \begin_layout Plain Layout
16965 ): For use with DocBook classes.
16968 \begin_layout Standard
16969 Flex insets are defined using the
16970 \begin_inset Flex Code
16973 \begin_layout Plain Layout
16979 tag, which shall be explained in a moment.
16982 \begin_layout Standard
16984 \begin_inset Flex Code
16987 \begin_layout Plain Layout
16993 tag also serves another function: It can be used to customize the general
16994 layout of many different types of insets.
16996 \begin_inset Flex Code
16999 \begin_layout Plain Layout
17005 can be used to customize the layout parameters for footnotes, marginal
17006 notes, note insets, \SpecialChar TeX
17007 code (ERT) insets, branches, listings, indexes, boxes,
17008 tables, algorithms, URLs, and captions, as well as to define Flex insets.
17011 \begin_layout Standard
17013 \begin_inset Flex Code
17016 \begin_layout Plain Layout
17022 definition must begin with a line of the form:
17025 \begin_layout LyX-Code
17029 \begin_layout Standard
17031 \begin_inset Flex Code
17034 \begin_layout Plain Layout
17040 indicates the inset whose layout is being defined, and here there are four
17044 \begin_layout Enumerate
17045 The layout for a pre-existing inset is being modified.
17046 In this case, can be
17047 \begin_inset Flex Code
17050 \begin_layout Plain Layout
17056 any one of the following:
17057 \begin_inset Flex Code
17060 \begin_layout Plain Layout
17067 \begin_inset Flex Code
17070 \begin_layout Plain Layout
17077 \begin_inset Flex Code
17080 \begin_layout Plain Layout
17087 \begin_inset Flex Code
17090 \begin_layout Plain Layout
17097 \begin_inset Flex Code
17100 \begin_layout Plain Layout
17107 \begin_inset Flex Code
17110 \begin_layout Plain Layout
17117 \begin_inset Flex Code
17120 \begin_layout Plain Layout
17127 \begin_inset Flex Code
17130 \begin_layout Plain Layout
17137 \begin_inset Flex Code
17140 \begin_layout Plain Layout
17147 \begin_inset Flex Code
17150 \begin_layout Plain Layout
17157 \begin_inset Flex Code
17160 \begin_layout Plain Layout
17167 \begin_inset Flex Code
17170 \begin_layout Plain Layout
17177 \begin_inset Flex Code
17180 \begin_layout Plain Layout
17187 \begin_inset Flex Code
17190 \begin_layout Plain Layout
17197 \begin_inset Flex Code
17200 \begin_layout Plain Layout
17207 \begin_inset Flex Code
17210 \begin_layout Plain Layout
17217 \begin_inset Flex Code
17220 \begin_layout Plain Layout
17227 \begin_inset Flex Code
17230 \begin_layout Plain Layout
17237 \begin_inset Flex Code
17240 \begin_layout Plain Layout
17247 \begin_inset Flex Code
17250 \begin_layout Plain Layout
17259 \begin_layout Enumerate
17260 The layout for a Flex inset is being defined.
17262 \begin_inset Flex Code
17265 \begin_layout Plain Layout
17271 must be of the form
17272 \begin_inset Quotes eld
17276 \begin_inset Flex Code
17279 \begin_layout Plain Layout
17286 \begin_inset Quotes erd
17290 \begin_inset Flex Code
17293 \begin_layout Plain Layout
17299 may be be any valid identifier not used by a pre-existing Flex inset.
17300 The identifier may include spaces, but in that case the whole thing must
17301 be wrapped in quotes.
17302 Note that the definition of a flex inset
17307 \begin_inset Flex Code
17310 \begin_layout Plain Layout
17312 \change_deleted -712698321 1437634848
17315 \change_inserted -712698321 1437634847
17323 entry, declaring which type of inset it defines.
17326 \begin_layout Enumerate
17327 The layout for user specific branch is being defined.
17329 \begin_inset Flex Code
17332 \begin_layout Plain Layout
17338 must be of the form
17339 \begin_inset Quotes eld
17343 \begin_inset Flex Code
17346 \begin_layout Plain Layout
17353 \begin_inset Quotes erd
17357 \begin_inset Flex Code
17360 \begin_layout Plain Layout
17366 may be be any valid identifier of branch defined in user's document.
17367 The identifier may include spaces, but in that case the whole thing must
17368 be wrapped in quotes.
17369 The main purpose of this feature is to allow \SpecialChar LaTeX
17370 wrapping around specific
17371 branches as user needs.
17374 \begin_layout Enumerate
17375 The layout of a user (or class) specific caption is being defined.
17377 \begin_inset Flex Code
17380 \begin_layout Plain Layout
17386 must be of the form
17387 \begin_inset Quotes eld
17391 \begin_inset Flex Code
17394 \begin_layout Plain Layout
17401 \begin_inset Quotes erd
17405 \begin_inset Flex Code
17408 \begin_layout Plain Layout
17414 specifies the name of the caption as it appears in the menu.
17415 Have a look at the standard caption (
17416 \begin_inset Flex Code
17419 \begin_layout Plain Layout
17425 ), the specific captions of the KOMA-Script classes (
17426 \begin_inset Flex Code
17429 \begin_layout Plain Layout
17436 \begin_inset Flex Code
17439 \begin_layout Plain Layout
17448 \begin_inset space ~
17454 \begin_inset Flex Code
17457 \begin_layout Plain Layout
17463 ) for applications.
17466 \begin_layout Standard
17468 \begin_inset Flex Code
17471 \begin_layout Plain Layout
17477 definition can contain the following entries:
17480 \begin_layout Description
17481 \begin_inset Flex Code
17484 \begin_layout Plain Layout
17491 \begin_inset Flex Code
17494 \begin_layout Plain Layout
17500 ] Defines argument number of a command\SpecialChar breakableslash
17501 environment associated with the current
17503 The definition must end with
17504 \begin_inset Flex Code
17507 \begin_layout Plain Layout
17515 \begin_inset CommandInset ref
17517 reference "subsec:Paragraph-Styles"
17524 \begin_layout Description
17525 \begin_inset Flex Code
17528 \begin_layout Plain Layout
17534 Preamble for changing language commands; see
17535 \begin_inset CommandInset ref
17537 reference "subsec:I18n"
17544 \begin_layout Description
17545 \begin_inset Flex Code
17548 \begin_layout Plain Layout
17555 \begin_inset Flex Code
17558 \begin_layout Plain Layout
17564 ] The color for the inset's background.
17566 \begin_inset CommandInset ref
17568 reference "chap:Names-of-colors"
17572 for a list of the available color names.
17575 \begin_layout Description
17576 \begin_inset Flex Code
17579 \begin_layout Plain Layout
17586 \begin_inset Flex Code
17589 \begin_layout Plain Layout
17598 \begin_inset space \thinspace{}
17602 \begin_inset Flex Code
17605 \begin_layout Plain Layout
17611 ] Whether to use the content of the inset as the label, when the inset is
17616 \begin_layout Description
17617 \begin_inset Flex Code
17620 \begin_layout Plain Layout
17627 \begin_inset Flex Code
17630 \begin_layout Plain Layout
17636 ] As with paragraph styles, see
17637 \begin_inset CommandInset ref
17639 reference "subsec:Paragraph-Styles"
17644 Note that you need to specify the complete type, e.
17645 \begin_inset space \thinspace{}
17649 \begin_inset space ~
17653 \begin_inset Flex Code
17656 \begin_layout Plain Layout
17657 CopyStyle Flex:<name>
17665 \begin_layout Description
17666 \begin_inset Flex Code
17669 \begin_layout Plain Layout
17676 \begin_inset Flex Code
17679 \begin_layout Plain Layout
17688 \begin_inset space \thinspace{}
17692 \begin_inset Flex Code
17695 \begin_layout Plain Layout
17701 ] Indicates whether the user may employ the Paragraph Settings dialog to
17702 customize the paragraph.
17705 \begin_layout Description
17706 \begin_inset Flex Code
17709 \begin_layout Plain Layout
17716 \begin_inset Flex Code
17719 \begin_layout Plain Layout
17726 \begin_inset Flex Code
17729 \begin_layout Plain Layout
17736 \begin_inset Flex Code
17739 \begin_layout Plain Layout
17745 , describing the rendering style used for the inset's frame and buttons.
17746 Footnotes generally use
17747 \begin_inset Flex Code
17750 \begin_layout Plain Layout
17756 , ERT insets generally
17757 \begin_inset Flex Code
17760 \begin_layout Plain Layout
17766 , and character styles
17767 \begin_inset Flex Code
17770 \begin_layout Plain Layout
17779 \begin_layout Description
17780 \begin_inset Flex Code
17783 \begin_layout Plain Layout
17790 \begin_inset Flex Code
17793 \begin_layout Plain Layout
17802 \begin_inset space \thinspace{}
17808 \begin_inset Flex Code
17811 \begin_layout Plain Layout
17820 \begin_inset Flex Code
17823 \begin_layout Plain Layout
17830 \begin_inset Flex Code
17833 \begin_layout Plain Layout
17840 Indicates whether the environment will stand on its own in the output or
17841 will appear inline with the surrounding text.
17842 If set to false, it is supposed that the \SpecialChar LaTeX
17843 environment ignores white space
17844 (including one newline character) after the
17845 \begin_inset Flex Code
17848 \begin_layout Plain Layout
17861 \begin_inset Flex Code
17864 \begin_layout Plain Layout
17880 \begin_layout Description
17881 \begin_inset Flex Code
17884 \begin_layout Plain Layout
17890 Required at the end of the
17891 \begin_inset Flex Code
17894 \begin_layout Plain Layout
17903 \begin_layout Description
17904 \begin_inset Flex Code
17907 \begin_layout Plain Layout
17913 The font used for both the text body
17919 \begin_inset CommandInset ref
17921 reference "subsec:Font-description"
17926 Note that defining this font automatically defines the
17927 \begin_inset Flex Code
17930 \begin_layout Plain Layout
17936 to the same value, so define this first and define
17937 \begin_inset Flex Code
17940 \begin_layout Plain Layout
17946 later if you want them to be different.
17947 \change_inserted -195340706 1421002157
17951 \begin_layout Description
17953 \change_inserted -195340706 1421002157
17954 \begin_inset Flex Code
17957 \begin_layout Plain Layout
17959 \change_inserted -195340706 1421002157
17960 FixedWidthPreambleEncoding
17966 \begin_inset Flex Code
17969 \begin_layout Plain Layout
17971 \change_inserted -195340706 1421002157
17980 \begin_inset space \thinspace{}
17984 \begin_inset Flex Code
17987 \begin_layout Plain Layout
17989 \change_inserted -195340706 1421002157
17995 ] Force a fixed width encoding for the translated contents of
17996 \begin_inset Flex Code
17999 \begin_layout Plain Layout
18001 \change_inserted -195340706 1421002157
18008 \begin_inset Flex Code
18011 \begin_layout Plain Layout
18013 \change_inserted -195340706 1421002157
18019 code generated by this layout.
18020 This is needed for special packages like the listings package that do not
18021 work with variable width encodings such as utf8.
18023 This setting is ignored if fully unicode aware \SpecialChar LaTeX
18024 backends such as Xe\SpecialChar LaTeX
18031 \begin_layout Description
18032 \begin_inset Flex Code
18035 \begin_layout Plain Layout
18036 ForceLocalFontSwitch
18042 \begin_inset Flex Code
18045 \begin_layout Plain Layout
18054 \begin_inset space \thinspace{}
18058 \begin_inset Flex Code
18061 \begin_layout Plain Layout
18067 ] When using babel, always use a local font switch (
18068 \begin_inset Flex Code
18071 \begin_layout Plain Layout
18079 ), never a global one (such as
18080 \begin_inset Flex Code
18083 \begin_layout Plain Layout
18094 \begin_layout Description
18095 \begin_inset Flex Code
18098 \begin_layout Plain Layout
18105 \begin_inset Flex Code
18108 \begin_layout Plain Layout
18117 \begin_inset space \thinspace{}
18121 \begin_inset Flex Code
18124 \begin_layout Plain Layout
18131 \begin_inset Quotes eld
18135 \begin_inset Quotes erd
18138 language, leading to Left-to-Right (Latin) output, e.
18139 \begin_inset space \thinspace{}
18143 \begin_inset space \space{}
18146 in \SpecialChar TeX
18149 \change_inserted -712698321 1417441977
18153 \begin_layout Description
18155 \change_inserted -712698321 1417442090
18156 \begin_inset Flex Code
18159 \begin_layout Plain Layout
18161 \change_inserted -712698321 1417441983
18168 \begin_inset Flex Code
18171 \begin_layout Plain Layout
18173 \change_inserted -712698321 1417441978
18182 \begin_inset space \thinspace{}
18186 \begin_inset Flex Code
18189 \begin_layout Plain Layout
18191 \change_inserted -712698321 1417441978
18197 ] Force a a line break in the \SpecialChar LaTeX
18198 output before the inset starts and after
18200 This assures the inset itself is output on its own lines, for parsing purposes.
18202 \change_inserted 274215730 1419105878
18208 \begin_layout Description
18209 \begin_inset Flex Code
18212 \begin_layout Plain Layout
18219 \begin_inset Flex Code
18222 \begin_layout Plain Layout
18231 \begin_inset space \thinspace{}
18235 \begin_inset Flex Code
18238 \begin_layout Plain Layout
18244 ] Indicates whether the
18245 \begin_inset Flex Code
18248 \begin_layout Plain Layout
18254 should be used or, instead, the user can change the paragraph style used
18259 \begin_layout Description
18260 \begin_inset Flex Code
18263 \begin_layout Plain Layout
18270 \begin_inset Flex Code
18273 \begin_layout Plain Layout
18282 \begin_inset space \thinspace{}
18286 \begin_inset Flex Code
18289 \begin_layout Plain Layout
18295 ] As with paragraph styles, see
18296 \begin_inset CommandInset ref
18298 reference "subsec:Paragraph-Styles"
18305 \begin_layout Description
18306 \begin_inset Flex Code
18309 \begin_layout Plain Layout
18315 These tags control the XHTML output.
18317 \begin_inset CommandInset ref
18319 reference "sec:Tags-for-XHTML"
18326 \begin_layout Description
18327 \begin_inset Flex Code
18330 \begin_layout Plain Layout
18337 \begin_inset Flex Code
18340 \begin_layout Plain Layout
18349 \begin_inset space \thinspace{}
18353 \begin_inset Flex Code
18356 \begin_layout Plain Layout
18362 ] Whether to include the contents of this inset in the strings generated
18363 for the `Outline' pane.
18364 One would not, for example, want the content of a footnote in a section
18365 header to be included in the TOC displayed in the outline, but one would
18366 normally want the content of a character style displayed.
18367 Default is false: not to include.
18370 \begin_layout Description
18371 \begin_inset Flex Code
18374 \begin_layout Plain Layout
18383 \begin_inset Flex Code
18386 \begin_layout Plain Layout
18395 \begin_inset space \thinspace{}
18399 \begin_inset Flex Code
18402 \begin_layout Plain Layout
18408 ] As with paragraph styles, see
18409 \begin_inset CommandInset ref
18411 reference "subsec:Paragraph-Styles"
18418 \begin_layout Description
18419 \begin_inset Flex Code
18422 \begin_layout Plain Layout
18428 The font used for the label.
18430 \begin_inset CommandInset ref
18432 reference "subsec:Font-description"
18437 Note that this definition can never appear before
18438 \begin_inset Flex Code
18441 \begin_layout Plain Layout
18447 , lest it be ineffective.
18450 \begin_layout Description
18451 \begin_inset Flex Code
18454 \begin_layout Plain Layout
18461 \begin_inset Flex Code
18464 \begin_layout Plain Layout
18471 \begin_inset Quotes erd
18475 \begin_inset Quotes erd
18478 ] What will be displayed on the button or elsewhere as the inset label.
18480 \begin_inset Flex Code
18483 \begin_layout Plain Layout
18491 \begin_inset Flex Code
18494 \begin_layout Plain Layout
18500 ) modify this label on the fly.
18503 \begin_layout Description
18504 \begin_inset Flex Code
18507 \begin_layout Plain Layout
18513 Language dependent preamble; see
18514 \begin_inset CommandInset ref
18516 reference "subsec:I18n"
18523 \begin_layout Description
18524 \begin_inset Flex Code
18527 \begin_layout Plain Layout
18534 \begin_inset Flex Code
18537 \begin_layout Plain Layout
18543 ] The name of the corresponding \SpecialChar LaTeX
18545 Either the environment or command name.
18548 \begin_layout Description
18549 \begin_inset Flex Code
18552 \begin_layout Plain Layout
18559 \begin_inset Flex Code
18562 \begin_layout Plain Layout
18568 ] The optional parameter for the corresponding
18569 \begin_inset Flex Code
18572 \begin_layout Plain Layout
18578 stuff, including possible bracket pairs like
18579 \begin_inset Flex Code
18582 \begin_layout Plain Layout
18589 This parameter cannot be changed from within \SpecialChar LyX
18591 \begin_inset Flex Code
18594 \begin_layout Plain Layout
18600 for customizable parameters).
18601 It will be output as is after all \SpecialChar LaTeX
18603 \begin_inset Flex Code
18606 \begin_layout Plain Layout
18615 \begin_layout Description
18616 \begin_inset Flex Code
18619 \begin_layout Plain Layout
18626 \begin_inset Flex Code
18629 \begin_layout Plain Layout
18630 Command, Environment, None
18635 ] How the style should be translated into \SpecialChar LaTeX
18640 \begin_layout Plain Layout
18641 \begin_inset Flex Code
18644 \begin_layout Plain Layout
18650 is perhaps a bit misleading, since these rules apply to SGML classes too.
18651 Visit the SGML class files for specific examples.
18657 \begin_inset Separator parbreak
18664 \begin_layout Description
18665 \begin_inset Flex Code
18668 \begin_layout Plain Layout
18674 means nothing special
18677 \begin_layout Description
18678 \begin_inset Flex Code
18681 \begin_layout Plain Layout
18688 \begin_inset Flex Code
18691 \begin_layout Plain Layout
18698 {\SpecialChar ldots
18707 \begin_layout Description
18708 \begin_inset Flex Code
18711 \begin_layout Plain Layout
18718 \begin_inset Flex Code
18721 \begin_layout Plain Layout
18728 }\SpecialChar ldots
18743 \begin_layout Standard
18744 Putting the last few things together, the \SpecialChar LaTeX
18745 output will be either:
18748 \begin_layout LyX-Code
18751 LatexName[LatexParam]{\SpecialChar ldots
18755 \begin_layout Standard
18759 \begin_layout LyX-Code
18762 begin{LatexName}[LatexParam] \SpecialChar ldots
18768 \begin_layout Standard
18769 depending upon the \SpecialChar LaTeX
18774 \begin_layout Description
18775 \begin_inset Flex Code
18778 \begin_layout Plain Layout
18785 \begin_inset Flex Code
18788 \begin_layout Plain Layout
18794 ] A string that is put at the beginning of the layout content.
18795 A line break in the output can be indicated by
18796 \begin_inset Flex Code
18799 \begin_layout Plain Layout
18808 \begin_layout Description
18809 \begin_inset Flex Code
18812 \begin_layout Plain Layout
18819 \begin_inset Flex Code
18822 \begin_layout Plain Layout
18829 \begin_inset Flex Code
18832 \begin_layout Plain Layout
18839 \begin_inset Flex Code
18842 \begin_layout Plain Layout
18849 \begin_inset Flex Code
18852 \begin_layout Plain Layout
18858 (indicating a dummy definition ending definitions of charstyles, etc).
18859 This entry is required in and is only meaningful for Flex insets.
18860 Among other things, it determines on which menu this inset will appear.
18862 \begin_inset Flex Code
18865 \begin_layout Plain Layout
18867 \change_deleted -712698321 1437634857
18870 \change_inserted -712698321 1437634858
18879 \begin_inset Flex Code
18882 \begin_layout Plain Layout
18888 will automatically set
18889 \begin_inset Flex Code
18892 \begin_layout Plain Layout
18900 \begin_inset Flex Code
18903 \begin_layout Plain Layout
18909 can be set to true for
18910 \begin_inset Flex Code
18913 \begin_layout Plain Layout
18919 insets by setting it
18924 \begin_inset Flex Code
18927 \begin_layout Plain Layout
18929 \change_deleted -712698321 1437634864
18932 \change_inserted -712698321 1437634865
18943 \begin_layout Description
18944 \begin_inset Flex Code
18947 \begin_layout Plain Layout
18954 \begin_inset Flex Code
18957 \begin_layout Plain Layout
18966 \begin_inset space \thinspace{}
18970 \begin_inset Flex Code
18973 \begin_layout Plain Layout
18979 ] Whether multiple paragraphs are permitted in this inset.
18981 \begin_inset Flex Code
18984 \begin_layout Plain Layout
18990 to the same value and
18991 \begin_inset Flex Code
18994 \begin_layout Plain Layout
19000 to the opposite value.
19001 These can be reset to other values, if they are used
19006 \begin_inset Flex Code
19009 \begin_layout Plain Layout
19019 \begin_layout Description
19020 \begin_inset Flex Code
19023 \begin_layout Plain Layout
19030 \begin_inset Flex Code
19033 \begin_layout Plain Layout
19042 \begin_inset space \thinspace{}
19046 \begin_inset Flex Code
19049 \begin_layout Plain Layout
19055 ] Whether fragile commands in this inset should be
19056 \begin_inset Flex Code
19059 \begin_layout Plain Layout
19072 whether the command should itself be protected.) Default is false.
19075 \begin_layout Description
19076 \begin_inset Flex Code
19079 \begin_layout Plain Layout
19086 \begin_inset Flex Code
19089 \begin_layout Plain Layout
19095 ] Deletes an existing
19096 \begin_inset Flex Code
19099 \begin_layout Plain Layout
19106 \change_inserted -712698321 1417953494
19110 \begin_layout Description
19112 \change_inserted -712698321 1417953559
19113 \begin_inset Flex Code
19116 \begin_layout Plain Layout
19118 \change_inserted -712698321 1417953494
19125 \begin_inset Flex Code
19128 \begin_layout Plain Layout
19130 \change_inserted -712698321 1417953574
19137 \begin_inset Flex Code
19140 \begin_layout Plain Layout
19142 \change_inserted -712698321 1417953533
19148 that has replaced this
19149 \begin_inset Flex Code
19152 \begin_layout Plain Layout
19154 \change_inserted -712698321 1417953551
19161 This is used to rename an
19162 \begin_inset Flex Code
19165 \begin_layout Plain Layout
19167 \change_inserted -712698321 1417953559
19173 , while keeping backward compatibility.
19178 \begin_layout Description
19179 \begin_inset Flex Code
19182 \begin_layout Plain Layout
19189 \begin_inset Flex Code
19192 \begin_layout Plain Layout
19201 \begin_inset space \thinspace{}
19205 \begin_inset Flex Code
19208 \begin_layout Plain Layout
19214 ] As with paragraph styles, see
19215 \begin_inset CommandInset ref
19217 reference "subsec:Paragraph-Styles"
19225 \begin_layout Description
19226 \begin_inset Flex Code
19229 \begin_layout Plain Layout
19236 \begin_inset Flex Code
19239 \begin_layout Plain Layout
19248 \begin_inset space \thinspace{}
19252 \begin_inset Flex Code
19255 \begin_layout Plain Layout
19261 ] As with paragraph styles, see
19262 \begin_inset CommandInset ref
19264 reference "subsec:Paragraph-Styles"
19272 \begin_layout Description
19273 \begin_inset Flex Code
19276 \begin_layout Plain Layout
19282 As with paragraph styles, see
19283 \begin_inset CommandInset ref
19285 reference "subsec:Paragraph-Styles"
19292 \begin_layout Description
19293 \begin_inset Flex Code
19296 \begin_layout Plain Layout
19303 \begin_inset Flex Code
19306 \begin_layout Plain Layout
19312 ] The prefix to use when creating labels referring to insets of this type.
19313 This allows the use of formatted references.
19316 \begin_layout Description
19317 \begin_inset Flex Code
19320 \begin_layout Plain Layout
19327 \begin_inset Flex Code
19330 \begin_layout Plain Layout
19336 ] As with paragraph styles, see
19337 \begin_inset CommandInset ref
19339 reference "subsec:Paragraph-Styles"
19346 \begin_layout Description
19347 \begin_inset Flex Code
19350 \begin_layout Plain Layout
19357 \begin_inset Flex Code
19360 \begin_layout Plain Layout
19369 \begin_inset space \thinspace{}
19373 \begin_inset Flex Code
19376 \begin_layout Plain Layout
19382 ] Resets the \SpecialChar LaTeX
19383 arguments of this layout (as defined via the
19384 \begin_inset Flex Code
19387 \begin_layout Plain Layout
19394 This is useful if you have copied a style via
19395 \begin_inset Flex Code
19398 \begin_layout Plain Layout
19404 , but you do not want to inherit its (required and optional) arguments.
19407 \begin_layout Description
19408 \begin_inset Flex Code
19411 \begin_layout Plain Layout
19418 \begin_inset Flex Code
19421 \begin_layout Plain Layout
19428 \begin_inset space \thinspace{}
19432 \begin_inset Flex Code
19435 \begin_layout Plain Layout
19443 ] Whether this inset should use the font of its surrounding environment
19445 Default is false: use the font of the surrounding environment.
19448 \begin_layout Description
19449 \begin_inset Flex Code
19452 \begin_layout Plain Layout
19459 \begin_inset Flex Code
19462 \begin_layout Plain Layout
19468 ] A string that is put at the end of the layout content.
19469 A line break in the output can be indicated by
19470 \begin_inset Flex Code
19473 \begin_layout Plain Layout
19482 \begin_layout Description
19483 \begin_inset Flex Code
19486 \begin_layout Plain Layout
19493 \begin_inset Flex Code
19496 \begin_layout Plain Layout
19503 \begin_inset space \thinspace{}
19507 \begin_inset Flex Code
19510 \begin_layout Plain Layout
19518 ] Allow spell-checking the contents of this inset.
19522 \begin_layout Subsection
19524 \begin_inset CommandInset label
19526 name "subsec:Counters"
19533 \begin_layout Standard
19534 It is necessary to define the counters (
19535 \begin_inset Flex MenuItem
19538 \begin_layout Plain Layout
19545 \begin_inset Flex MenuItem
19548 \begin_layout Plain Layout
19554 , \SpecialChar ldots
19555 ) in the text class itself.
19556 The standard counters are defined in the file
19557 \begin_inset Flex Code
19560 \begin_layout Plain Layout
19566 , so you may have to do no more than add
19569 \begin_layout LyX-Code
19570 Input stdcounters.inc
19573 \begin_layout Standard
19574 to your layout file to get them to work.
19575 But if you want to define custom counters, then you can do so.
19576 The counter declaration must begin with:
19579 \begin_layout LyX-Code
19580 Counter CounterName
19583 \begin_layout Standard
19585 \begin_inset Flex Code
19588 \begin_layout Plain Layout
19594 ' is replaced by the name of the counter.
19595 And it must end with
19596 \begin_inset Quotes eld
19600 \begin_inset Flex Code
19603 \begin_layout Plain Layout
19610 \begin_inset Quotes erd
19614 The following parameters can also be used:
19617 \begin_layout Description
19618 \begin_inset Flex Code
19621 \begin_layout Plain Layout
19628 \begin_inset Flex Code
19631 \begin_layout Plain Layout
19637 ] Sets the initial value for the counter, to which it will be reset whenever
19639 Normally, one will want the default, 1.
19642 \begin_layout Description
19643 \begin_inset Flex Code
19646 \begin_layout Plain Layout
19653 \begin_inset Flex Code
19656 \begin_layout Plain Layout
19663 \begin_inset Quotes erd
19667 \begin_inset Quotes erd
19670 ] When defined, this string defines how the counter is displayed.
19671 Setting this value sets
19672 \begin_inset Flex Code
19675 \begin_layout Plain Layout
19676 LabelStringAppendix
19682 The following special constructs can be used in the string:
19683 \begin_inset Separator parbreak
19690 \begin_layout Itemize
19691 \begin_inset Flex Code
19694 \begin_layout Plain Layout
19702 will be replaced by the expansion of the
19703 \begin_inset Flex Code
19706 \begin_layout Plain Layout
19713 \begin_inset Flex Code
19716 \begin_layout Plain Layout
19717 LabelStringAppendix
19723 \begin_inset Flex Code
19726 \begin_layout Plain Layout
19736 \begin_layout Itemize
19737 counter values can be expressed using \SpecialChar LaTeX
19739 \begin_inset Newline newline
19743 \begin_inset Flex Code
19746 \begin_layout Plain Layout
19763 \begin_inset Flex Code
19766 \begin_layout Plain Layout
19778 \begin_layout Plain Layout
19788 Actually, the situation is a bit more complicated: any
19807 other than those described below will produce arabic numerals.
19808 It would not be surprising to see this change in the future.
19814 \begin_inset Flex Code
19817 \begin_layout Plain Layout
19823 : 1, 2, 3,\SpecialChar ldots
19825 \begin_inset Flex Code
19828 \begin_layout Plain Layout
19834 for lower-case letters: a, b, c, \SpecialChar ldots
19836 \begin_inset Flex Code
19839 \begin_layout Plain Layout
19845 for upper-case letters: A, B, C, \SpecialChar ldots
19847 \begin_inset Flex Code
19850 \begin_layout Plain Layout
19856 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
19858 \begin_inset Flex Code
19861 \begin_layout Plain Layout
19867 for upper-case roman numerals: I, II, III\SpecialChar ldots
19869 \begin_inset Flex Code
19872 \begin_layout Plain Layout
19878 for hebrew numerals.
19882 \begin_layout Standard
19883 If LabelString is not defined, a default value is constructed as follows:
19884 if the counter has a master counter
19885 \begin_inset Flex Code
19888 \begin_layout Plain Layout
19895 \begin_inset Flex Code
19898 \begin_layout Plain Layout
19905 \begin_inset Newline newline
19909 \begin_inset Flex Code
19912 \begin_layout Plain Layout
19922 is used; otherwise the string
19923 \begin_inset Flex Code
19926 \begin_layout Plain Layout
19937 \begin_layout Description
19938 \begin_inset Flex Code
19941 \begin_layout Plain Layout
19942 LabelStringAppendix
19948 \begin_inset Flex Code
19951 \begin_layout Plain Layout
19958 \begin_inset Quotes erd
19962 \begin_inset Quotes erd
19966 \begin_inset Flex Code
19969 \begin_layout Plain Layout
19975 , but for use in the Appendix.
19978 \begin_layout Description
19979 \begin_inset Flex Code
19982 \begin_layout Plain Layout
19989 \begin_inset Flex Code
19992 \begin_layout Plain Layout
19999 \begin_inset Quotes erd
20003 \begin_inset Quotes erd
20006 ] A format for use with formatted references to this counter.
20007 For example, one might want to have references to section numbers appear
20009 \begin_inset Quotes eld
20013 \begin_inset Quotes erd
20017 The string should contain
20018 \begin_inset Quotes eld
20022 \begin_inset Quotes erd
20026 This will be replaced by the counter number itself.
20027 So, for sections, it would be: Section ##.
20030 \begin_layout Description
20031 \begin_inset Flex Code
20034 \begin_layout Plain Layout
20041 \begin_inset Flex Code
20044 \begin_layout Plain Layout
20051 \begin_inset Quotes erd
20055 \begin_inset Quotes erd
20058 ] If this is set to the name of another counter, the present counter will
20059 be reset every time the other one is increased.
20061 \begin_inset Flex Code
20064 \begin_layout Plain Layout
20071 \begin_inset Flex Code
20074 \begin_layout Plain Layout
20083 \begin_layout Subsection
20085 \begin_inset CommandInset label
20087 name "subsec:Font-description"
20094 \begin_layout Standard
20095 A font description looks like this:
20098 \begin_layout LyX-Code
20112 \begin_layout LyX-Code
20116 \begin_layout LyX-Code
20120 \begin_layout Standard
20121 The following commands are available:
20124 \begin_layout Description
20125 \begin_inset Flex Code
20128 \begin_layout Plain Layout
20135 \begin_inset Flex Code
20138 \begin_layout Plain Layout
20147 \begin_inset Flex Code
20150 \begin_layout Plain Layout
20157 \begin_inset Flex Code
20160 \begin_layout Plain Layout
20167 \begin_inset Flex Code
20170 \begin_layout Plain Layout
20177 \begin_inset Flex Code
20180 \begin_layout Plain Layout
20187 \begin_inset Flex Code
20190 \begin_layout Plain Layout
20197 \begin_inset Flex Code
20200 \begin_layout Plain Layout
20207 \begin_inset Flex Code
20210 \begin_layout Plain Layout
20217 \begin_inset Flex Code
20220 \begin_layout Plain Layout
20229 \begin_layout Description
20230 \begin_inset Flex Code
20233 \begin_layout Plain Layout
20240 \begin_inset Flex Code
20243 \begin_layout Plain Layout
20252 \begin_inset Flex Code
20255 \begin_layout Plain Layout
20262 \begin_inset Flex Code
20265 \begin_layout Plain Layout
20274 \begin_layout Description
20275 \begin_inset Flex Code
20278 \begin_layout Plain Layout
20285 \begin_inset Flex Code
20288 \begin_layout Plain Layout
20294 ] Valid arguments are:
20295 \begin_inset Flex Code
20298 \begin_layout Plain Layout
20305 \begin_inset Flex Code
20308 \begin_layout Plain Layout
20315 \begin_inset Flex Code
20318 \begin_layout Plain Layout
20325 \begin_inset Flex Code
20328 \begin_layout Plain Layout
20335 \begin_inset Flex Code
20338 \begin_layout Plain Layout
20345 \begin_inset Flex Code
20348 \begin_layout Plain Layout
20355 \begin_inset Flex Code
20358 \begin_layout Plain Layout
20365 \begin_inset Flex Code
20368 \begin_layout Plain Layout
20375 \begin_inset Flex Code
20378 \begin_layout Plain Layout
20385 \begin_inset Flex Code
20388 \begin_layout Plain Layout
20395 \begin_inset Flex Code
20398 \begin_layout Plain Layout
20405 \begin_inset Flex Code
20408 \begin_layout Plain Layout
20415 Each of these turns on or off the corresponding attribute.
20417 \begin_inset Flex Code
20420 \begin_layout Plain Layout
20426 turns on emphasis, and
20427 \begin_inset Flex Code
20430 \begin_layout Plain Layout
20438 \begin_inset Newline newline
20441 If the latter seems puzzling, remember that the font settings for the present
20442 context are generally inherited from the surrounding context.
20444 \begin_inset Flex Code
20447 \begin_layout Plain Layout
20453 would turn off the emphasis that was anyway in effect, say, in a theorem
20457 \begin_layout Description
20458 \begin_inset Flex Code
20461 \begin_layout Plain Layout
20468 \begin_inset Flex Code
20471 \begin_layout Plain Layout
20480 \begin_inset Flex Code
20483 \begin_layout Plain Layout
20492 \begin_layout Description
20493 \begin_inset Flex Code
20496 \begin_layout Plain Layout
20503 \begin_inset Flex Code
20506 \begin_layout Plain Layout
20515 \begin_inset Flex Code
20518 \begin_layout Plain Layout
20525 \begin_inset Flex Code
20528 \begin_layout Plain Layout
20535 \begin_inset Flex Code
20538 \begin_layout Plain Layout
20547 \begin_layout Description
20548 \begin_inset Flex Code
20551 \begin_layout Plain Layout
20558 \begin_inset Flex Code
20561 \begin_layout Plain Layout
20568 \begin_inset Flex Code
20571 \begin_layout Plain Layout
20578 \begin_inset Flex Code
20581 \begin_layout Plain Layout
20590 \begin_inset Flex Code
20593 \begin_layout Plain Layout
20600 \begin_inset Flex Code
20603 \begin_layout Plain Layout
20610 \begin_inset Flex Code
20613 \begin_layout Plain Layout
20620 \begin_inset Flex Code
20623 \begin_layout Plain Layout
20630 \begin_inset Flex Code
20633 \begin_layout Plain Layout
20642 \begin_layout Subsection
20643 \begin_inset CommandInset label
20645 name "subsec:Citation-format-description"
20649 Citation format description
20652 \begin_layout Standard
20654 \begin_inset Flex Code
20657 \begin_layout Plain Layout
20663 blocks are used to describe how bibliographic information should be displayed,
20664 both within \SpecialChar LyX
20665 itself (in the citation dialog and in tooltips, for example)
20666 and in XHTML output.
20667 Such a block might look like this:
20670 \begin_layout LyX-Code
20674 \begin_layout LyX-Code
20678 \begin_layout LyX-Code
20682 \begin_layout LyX-Code
20686 \begin_layout Standard
20687 The individual lines define how the bibliographic information associated
20688 with an article or book, respectively, is to be displayed, and such a definitio
20689 n can be given for any `entry type' that might be present in a Bib\SpecialChar TeX
20692 defines a default format in the source code that will be used if no specific
20693 definition has been given.
20695 predefines several formats in the file
20696 \begin_inset Flex Code
20699 \begin_layout Plain Layout
20705 , which is included in most of \SpecialChar LyX
20706 's document classes.
20709 \begin_layout Standard
20710 The definitions use a simple language that allows Bib\SpecialChar TeX
20711 keys to be replaced
20713 Keys should be enclosed in
20714 \begin_inset Flex Code
20717 \begin_layout Plain Layout
20724 \begin_inset Flex Code
20727 \begin_layout Plain Layout
20734 So a simple definition might look like this:
20737 \begin_layout LyX-Code
20739 \begin_inset Quotes eld
20743 \begin_inset Quotes erd
20749 \begin_layout Standard
20750 This would print the author, followed by a comma, followed by the title,
20751 in quotes, followed by a period.
20754 \begin_layout Standard
20755 Of course, sometimes you may want to print a key only if it exists.
20756 This can be done by using a conditional construction, such as:
20757 \begin_inset Flex Code
20760 \begin_layout Plain Layout
20762 \begin_inset space ~
20772 \begin_inset Flex Code
20775 \begin_layout Plain Layout
20781 key exists, then print
20782 \begin_inset Quotes eld
20786 \begin_inset space ~
20790 \begin_inset Quotes erd
20793 followed by the volume key.
20794 It is also possible to have an else clause in the conditional, such as:
20795 \begin_inset Newline newline
20799 \begin_inset Flex Code
20802 \begin_layout Plain Layout
20803 {%author%[[%author%]][[%editor%, ed.]]}
20809 \begin_inset Newline newline
20813 \begin_inset Flex Code
20816 \begin_layout Plain Layout
20822 key is printed if it exists; otherwise, the editor key is printed, followed
20824 \begin_inset Quotes eld
20828 \begin_inset space ~
20832 \begin_inset Quotes erd
20835 Note that the key is again enclosed in
20836 \begin_inset Flex Code
20839 \begin_layout Plain Layout
20845 signs; the entire conditional is enclosed in braces; and the if and else
20846 clauses are enclosed in double brackets,
20847 \begin_inset Quotes eld
20851 \begin_inset Flex Code
20854 \begin_layout Plain Layout
20861 \begin_inset Quotes eld
20865 \begin_inset Quotes eld
20869 \begin_inset Flex Code
20872 \begin_layout Plain Layout
20879 \begin_inset Quotes erd
20883 There must be no space between any of these.
20886 \begin_layout Standard
20887 There is one other piece of syntax available in definitions, which looks
20889 \begin_inset Flex Code
20892 \begin_layout Plain Layout
20899 This defines a piece of formatting information that is to be used when
20901 \begin_inset Quotes eld
20905 \begin_inset Quotes erd
20909 Obviously, we do not want to output HTML tags when writing plain text,
20910 so they should be wrapped in
20911 \begin_inset Quotes eld
20915 \begin_inset Quotes erd
20919 \begin_inset Quotes eld
20923 \begin_inset Quotes erd
20929 \begin_layout Standard
20930 Two special sorts of definitions are also possible in a
20931 \begin_inset Flex Code
20934 \begin_layout Plain Layout
20941 An example of the first would be:
20944 \begin_layout LyX-Code
20946 \begin_inset Quotes eld
20950 \begin_inset Quotes erd
20956 \begin_layout Standard
20957 This is an abbreviation, or macro, and it can be used by treating it as
20959 \begin_inset Flex Code
20962 \begin_layout Plain Layout
20971 \begin_inset Flex Code
20974 \begin_layout Plain Layout
20980 exactly as it would treat its definition.
20981 So, let us issue the obvious
20989 \begin_layout LyX-Code
20993 \begin_layout Standard
20994 or anything like it.
20996 shouldn't go into an infinite loop, but it may go into a long one before
21000 \begin_layout Standard
21001 The second sort of special definition might look like this:
21004 \begin_layout LyX-Code
21008 \begin_layout Standard
21009 This defines a translatable piece of text, which allows relevant parts of
21010 the bibliography to be translated.
21011 It can be included in a definition by treating it as a key:
21012 \begin_inset Flex Code
21015 \begin_layout Plain Layout
21022 Several of these are predefined in
21023 \begin_inset Flex Code
21026 \begin_layout Plain Layout
21033 Note that these are not macros, in the sense just defined.
21034 They will not be expanded.
21037 \begin_layout Standard
21038 So here then is an example that use all these features:
21039 \begin_inset VSpace defskip
21045 \begin_layout Standard
21049 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
21052 \begin_layout Standard
21053 \begin_inset VSpace defskip
21056 This defines a macro that prints the author, followed by a comma, if the
21058 \begin_inset Flex Code
21061 \begin_layout Plain Layout
21067 key is defined, or else prints the name of the editor, followed by the
21069 \begin_inset Flex Code
21072 \begin_layout Plain Layout
21078 or its translation (it is by default
21079 \begin_inset Quotes eld
21083 \begin_inset Quotes erd
21087 \begin_inset Flex Code
21090 \begin_layout Plain Layout
21097 Note that this is in fact defined in
21098 \begin_inset Flex Code
21101 \begin_layout Plain Layout
21107 , so you can use it in your own definitions, or re-definitions, if you load
21111 \begin_layout Section
21112 \begin_inset CommandInset label
21114 name "sec:Tags-for-XHTML"
21118 Tags for XHTML output
21121 \begin_layout Standard
21122 As with \SpecialChar LaTeX
21123 or DocBook, the format of \SpecialChar LyX
21124 's XHTML output is also controlled by
21125 layout information.
21126 In general, \SpecialChar LyX
21127 provides sensible defaults and, as mentioned earlier, it will
21128 even construct default CSS style rules from the other layout tags.
21129 For example, \SpecialChar LyX
21130 will attempt to use the information provided in the
21131 \begin_inset Flex Code
21134 \begin_layout Plain Layout
21140 declaration for the Chapter style to write CSS that will appropriately
21141 format chapter headings.
21144 \begin_layout Standard
21145 In many cases, then, you may not have to do anything at all to get acceptable
21146 XHTML output for your own environments, custom insets, and so forth.
21147 But in some cases you will, and so \SpecialChar LyX
21148 provides a number of layout tags that
21149 can be used to customize the XHTML and CSS that are generated.
21152 \begin_layout Standard
21153 Note that there are two tags,
21154 \begin_inset Flex Code
21157 \begin_layout Plain Layout
21164 \begin_inset Flex Code
21167 \begin_layout Plain Layout
21173 that may appear outside style and inset declarations.
21175 \begin_inset CommandInset ref
21177 reference "subsec:General-text-class"
21181 for details on these.
21184 \begin_layout Subsection
21185 \begin_inset CommandInset label
21187 name "subsec:Paragraph-Style-XHTML"
21194 \begin_layout Standard
21195 The sort of XHTML \SpecialChar LyX
21196 outputs for a paragraph depends upon whether we are dealing
21197 with a normal paragraph, a command, or an environment, where this is itself
21198 determined by the contents of the corresponding
21199 \begin_inset Flex Code
21202 \begin_layout Plain Layout
21213 \begin_layout Standard
21214 For a command or normal paragraph, the output XHTML has the following form:
21217 \begin_layout LyX-Code
21219 \begin_inset Quotes erd
21223 \begin_inset Quotes erd
21229 \begin_layout LyX-Code
21231 \begin_inset Quotes erd
21235 \begin_inset Quotes erd
21241 \begin_layout LyX-Code
21242 Contents of the paragraph.
21245 \begin_layout LyX-Code
21249 \begin_layout Standard
21250 The label tags are of course omitted if the paragraph does not have a label.
21253 \begin_layout Standard
21254 For an environment that is not some sort of list, the XHTML takes this form:
21257 \begin_layout LyX-Code
21259 \begin_inset Quotes erd
21263 \begin_inset Quotes erd
21269 \begin_layout LyX-Code
21271 \begin_inset Quotes erd
21275 \begin_inset Quotes erd
21279 \begin_inset Quotes erd
21283 \begin_inset Quotes erd
21286 >Environment Label</labeltag>First paragraph.</itemtag>
21289 \begin_layout LyX-Code
21290 <itemtag>Second paragraph.</itemtag>
21293 \begin_layout LyX-Code
21297 \begin_layout Standard
21298 Note that the label is output only for the first paragraph, as it should
21299 be for a theorem, for example.
21303 \begin_layout Standard
21304 For a list, we have one of these forms:
21307 \begin_layout LyX-Code
21309 \begin_inset Quotes erd
21313 \begin_inset Quotes erd
21319 \begin_layout LyX-Code
21321 \begin_inset Quotes erd
21325 \begin_inset Quotes erd
21329 \begin_inset Quotes erd
21333 \begin_inset Quotes erd
21336 >List Label</labeltag>First item.</itemtag>
21339 \begin_layout LyX-Code
21341 \begin_inset Quotes erd
21345 \begin_inset Quotes erd
21349 \begin_inset Quotes erd
21353 \begin_inset Quotes erd
21356 >List Label</labeltag>Second item.</itemtag>
21359 \begin_layout LyX-Code
21363 \begin_layout LyX-Code
21367 \begin_layout LyX-Code
21369 \begin_inset Quotes erd
21373 \begin_inset Quotes erd
21379 \begin_layout LyX-Code
21381 \begin_inset Quotes erd
21385 \begin_inset Quotes erd
21388 >List Label</labeltag><itemtag attr=
21389 \begin_inset Quotes erd
21393 \begin_inset Quotes erd
21396 >First item.</itemtag>
21399 \begin_layout LyX-Code
21401 \begin_inset Quotes erd
21405 \begin_inset Quotes erd
21408 >List Label</labeltag><itemtag attr=
21409 \begin_inset Quotes erd
21413 \begin_inset Quotes erd
21416 >Second item.</itemtag>
21419 \begin_layout LyX-Code
21423 \begin_layout Standard
21424 Note the different orders of
21425 \begin_inset Flex Code
21428 \begin_layout Plain Layout
21435 \begin_inset Flex Code
21438 \begin_layout Plain Layout
21445 Which order we get depends upon the setting of
21446 \begin_inset Flex Code
21449 \begin_layout Plain Layout
21456 \begin_inset Flex Code
21459 \begin_layout Plain Layout
21465 is false (the default), you get the first of these, with the label within
21466 the item; if true, you get the second, with the label outside the item.
21469 \begin_layout Standard
21470 The specific tags and attributes output for each paragraph type can be controlle
21471 d by means of the layout tags we are about to describe.
21472 As mentioned earlier, however, \SpecialChar LyX
21473 uses sensible defaults for many of these,
21474 so you often may not need to do very much to get good XHTML output.
21475 Think of the available tags as there so you can tweak things to your liking.
21478 \begin_layout Description
21479 \begin_inset Flex Code
21482 \begin_layout Plain Layout
21489 \begin_inset Flex Code
21492 \begin_layout Plain Layout
21498 ] Specifies attribute information to be output with the main tag.
21500 \begin_inset Quotes eld
21504 \begin_inset Flex Code
21507 \begin_layout Plain Layout
21514 \begin_inset Quotes erd
21518 By default, \SpecialChar LyX
21520 \begin_inset Quotes eld
21524 \begin_inset Flex Code
21527 \begin_layout Plain Layout
21534 \begin_inset Quotes erd
21538 \begin_inset Flex Code
21541 \begin_layout Plain Layout
21547 is the \SpecialChar LyX
21548 name of the layout, made lowercase, for example: chapter.
21553 contain any style information.
21555 \begin_inset Flex Code
21558 \begin_layout Plain Layout
21567 \begin_layout Description
21568 \begin_inset Flex Code
21571 \begin_layout Plain Layout
21578 \begin_inset Flex Code
21581 \begin_layout Plain Layout
21591 ] Whether to output the default CSS information \SpecialChar LyX
21592 generates for this layout,
21593 even if additional information is explicitly provided via
21594 \begin_inset Flex Code
21597 \begin_layout Plain Layout
21605 \begin_inset Flex Code
21608 \begin_layout Plain Layout
21614 allows you to alter or augment the generated CSS, rather than to override
21617 \begin_inset Flex Code
21620 \begin_layout Plain Layout
21629 \begin_layout Description
21630 \begin_inset Flex Code
21633 \begin_layout Plain Layout
21640 \begin_inset Flex Code
21643 \begin_layout Plain Layout
21649 ] The tag to be used for individual paragraphs of environments, replacing
21651 \begin_inset Flex Code
21654 \begin_layout Plain Layout
21660 in the examples above.
21662 \begin_inset Flex Code
21665 \begin_layout Plain Layout
21674 \begin_layout Description
21675 \begin_inset Flex Code
21678 \begin_layout Plain Layout
21685 \begin_inset Flex Code
21688 \begin_layout Plain Layout
21694 ] Attributes for the item tag.
21696 \begin_inset Quotes eld
21700 \begin_inset Flex Code
21703 \begin_layout Plain Layout
21704 class=`layoutname_item'
21710 \begin_inset Quotes erd
21718 contain any style information.
21720 \begin_inset Flex Code
21723 \begin_layout Plain Layout
21732 \begin_layout Description
21733 \begin_inset Flex Code
21736 \begin_layout Plain Layout
21743 \begin_inset Flex Code
21746 \begin_layout Plain Layout
21752 ] The tag to be used for paragraph and item labels, replacing
21753 \begin_inset Flex Code
21756 \begin_layout Plain Layout
21762 in the examples above.
21764 \begin_inset Flex Code
21767 \begin_layout Plain Layout
21774 \begin_inset Flex Code
21777 \begin_layout Plain Layout
21784 \begin_inset Flex Code
21787 \begin_layout Plain Layout
21794 \begin_inset Flex Code
21797 \begin_layout Plain Layout
21798 Centered_Top_Environment
21803 , in which case it defaults to
21804 \begin_inset Flex Code
21807 \begin_layout Plain Layout
21816 \begin_layout Description
21817 \begin_inset Flex Code
21820 \begin_layout Plain Layout
21827 \begin_inset Flex Code
21830 \begin_layout Plain Layout
21836 ] Attributes for the label tag.
21838 \begin_inset Quotes eld
21842 \begin_inset Flex Code
21845 \begin_layout Plain Layout
21846 class=`layoutname_label'
21852 \begin_inset Quotes erd
21860 contain any style information.
21862 \begin_inset Flex Code
21865 \begin_layout Plain Layout
21874 \begin_layout Description
21875 \begin_inset Flex Code
21878 \begin_layout Plain Layout
21885 \begin_inset Flex Code
21888 \begin_layout Plain Layout
21898 ] Meaningful only for list-like environments, this tag controls whether
21899 the label tag is output before or inside the item tag.
21900 This is used, for example, in the description environment, where we want
21902 \begin_inset Flex Code
21905 \begin_layout Plain Layout
21906 <dt>\SpecialChar ldots
21907 </dt><dd>\SpecialChar ldots
21915 \begin_inset Flex Code
21918 \begin_layout Plain Layout
21924 : The label tag is output inside the item tag.
21927 \begin_layout Description
21928 \begin_inset Flex Code
21931 \begin_layout Plain Layout
21937 Information to be output in the
21938 \begin_inset Flex Code
21941 \begin_layout Plain Layout
21947 section when this style is used.
21948 This might, for example, be used to include a
21949 \begin_inset Flex Code
21952 \begin_layout Plain Layout
21959 \begin_inset Flex Code
21962 \begin_layout Plain Layout
21971 \begin_layout Description
21972 \begin_inset Flex Code
21975 \begin_layout Plain Layout
21981 CSS style information to be included when this style is used.
21982 Note that this will automatically be wrapped in a layout-generated
21983 \begin_inset Flex Code
21986 \begin_layout Plain Layout
21992 block, so only the CSS itself need be included.
21994 \begin_inset Flex Code
21997 \begin_layout Plain Layout
22006 \begin_layout Description
22007 \begin_inset Flex Code
22010 \begin_layout Plain Layout
22017 \begin_inset Flex Code
22020 \begin_layout Plain Layout
22026 ] The tag to be used for the main label, replacing
22027 \begin_inset Flex Code
22030 \begin_layout Plain Layout
22036 in the examples above.
22038 \begin_inset Flex Code
22041 \begin_layout Plain Layout
22050 \begin_layout Description
22051 \begin_inset Flex Code
22054 \begin_layout Plain Layout
22061 \begin_inset Flex Code
22064 \begin_layout Plain Layout
22074 ] Marks this style as the one to be used to generate the
22075 \begin_inset Flex Code
22078 \begin_layout Plain Layout
22084 tag for the XHTML file.
22085 By default, it is false.
22087 \begin_inset Flex Code
22090 \begin_layout Plain Layout
22096 file sets it to true for the
22097 \begin_inset Flex Code
22100 \begin_layout Plain Layout
22110 \begin_layout Subsection
22114 \begin_layout Standard
22115 The XHTML output of insets can also be controlled by information in layout
22120 \begin_layout Plain Layout
22121 At present, this is true only for
22122 \begin_inset Quotes eld
22126 \begin_inset Quotes erd
22129 insets (insets you can type into) and is not true for
22130 \begin_inset Quotes eld
22134 \begin_inset Quotes erd
22137 insets (insets that are associated with dialog boxes).
22142 Here, too, \SpecialChar LyX
22143 tries to provide sensible defaults, and it constructs default
22145 But everything can be customized.
22148 \begin_layout Standard
22149 The XHTML \SpecialChar LyX
22150 outputs for an inset has the following form:
22153 \begin_layout LyX-Code
22155 \begin_inset Quotes erd
22159 \begin_inset Quotes erd
22165 \begin_layout LyX-Code
22166 <labeltag>Label</labeltag>
22169 \begin_layout LyX-Code
22171 \begin_inset Quotes erd
22175 \begin_inset Quotes erd
22178 >Contents of the inset.</innertag>
22181 \begin_layout LyX-Code
22185 \begin_layout Standard
22186 If the inset permits multiple paragraphs—that is, if
22187 \begin_inset Flex Code
22190 \begin_layout Plain Layout
22196 is true—then the contents of the inset will itself be output as paragraphs
22197 formatted according to the styles used for those paragraphs (standard,
22198 quote, and the like).
22199 The label tag is of course omitted if the paragraph does not have a label
22200 and, at present, is always
22201 \begin_inset Flex Code
22204 \begin_layout Plain Layout
22211 The inner tag is optional and, by default, does not appear.
22214 \begin_layout Standard
22215 The specific tags and attributes output for each inset can be controlled
22216 by means of the following layout tags.
22219 \begin_layout Description
22220 \begin_inset Flex Code
22223 \begin_layout Plain Layout
22230 \begin_inset Flex Code
22233 \begin_layout Plain Layout
22239 ] Specifies attribute information to be output with the main tag.
22241 \begin_inset Quotes eld
22245 \begin_inset Flex Code
22248 \begin_layout Plain Layout
22249 class=`myinset' onclick=`\SpecialChar ldots
22256 \begin_inset Quotes erd
22260 By default, \SpecialChar LyX
22262 \begin_inset Quotes eld
22266 \begin_inset Flex Code
22269 \begin_layout Plain Layout
22276 \begin_inset Quotes erd
22280 \begin_inset Flex Code
22283 \begin_layout Plain Layout
22289 is the \SpecialChar LyX
22290 name of the inset, made lowercase and with non-alphanumeric characters
22291 converted to underscores, for example: footnote.
22294 \begin_layout Description
22295 \begin_inset Flex Code
22298 \begin_layout Plain Layout
22305 \begin_inset Flex Code
22308 \begin_layout Plain Layout
22318 ] Whether to output the default CSS information \SpecialChar LyX
22319 generates for this layout,
22320 even if additional information is explicitly provided via
22321 \begin_inset Flex Code
22324 \begin_layout Plain Layout
22332 \begin_inset Flex Code
22335 \begin_layout Plain Layout
22341 allows you to alter or augment the generated CSS, rather than to override
22346 \begin_layout Description
22347 \begin_inset Flex Code
22350 \begin_layout Plain Layout
22357 \begin_inset Flex Code
22360 \begin_layout Plain Layout
22366 ] Attributes for the inner tag.
22368 \begin_inset Quotes eld
22372 \begin_inset Flex Code
22375 \begin_layout Plain Layout
22376 class=`insetname_inner'
22382 \begin_inset Quotes erd
22388 \begin_layout Description
22389 \begin_inset Flex Code
22392 \begin_layout Plain Layout
22399 \begin_inset Flex Code
22402 \begin_layout Plain Layout
22408 ] The inner tag, replacing
22409 \begin_inset Flex Code
22412 \begin_layout Plain Layout
22418 in the examples above.
22419 By default, there is none.
22422 \begin_layout Description
22423 \begin_inset Flex Code
22426 \begin_layout Plain Layout
22433 \begin_inset Flex Code
22436 \begin_layout Plain Layout
22444 ] Whether this inset represents a standalone block of text (such as a footnote)
22445 or instead represents material that is included in the surrounding text
22446 (such as a branch).
22450 \begin_layout Description
22451 \begin_inset Flex Code
22454 \begin_layout Plain Layout
22461 \begin_inset Flex Code
22464 \begin_layout Plain Layout
22470 ] A label for this inset, possibly including a reference to a counter.
22471 For example, for footnote, it might be:
22472 \begin_inset Flex Code
22475 \begin_layout Plain Layout
22484 This is optional, and there is no default.
22487 \begin_layout Description
22488 \begin_inset Flex Code
22491 \begin_layout Plain Layout
22497 Information to be output in the
22498 \begin_inset Flex Code
22501 \begin_layout Plain Layout
22507 section when this style is used.
22508 This might, for example, be used to include a
22509 \begin_inset Flex Code
22512 \begin_layout Plain Layout
22519 \begin_inset Flex Code
22522 \begin_layout Plain Layout
22531 \begin_layout Description
22532 \begin_inset Flex Code
22535 \begin_layout Plain Layout
22541 CSS style information to be included when this style is used.
22542 Note that this will automatically be wrapped in a layout-generated
22543 \begin_inset Flex Code
22546 \begin_layout Plain Layout
22552 block, so only the CSS itself need be included.
22555 \begin_layout Description
22556 \begin_inset Flex Code
22559 \begin_layout Plain Layout
22566 \begin_inset Flex Code
22569 \begin_layout Plain Layout
22575 ] The tag to be used for the main label, replacing
22576 \begin_inset Flex Code
22579 \begin_layout Plain Layout
22585 in the examples above.
22586 The default depends upon the setting of
22587 \begin_inset Flex Code
22590 \begin_layout Plain Layout
22597 \begin_inset Flex Code
22600 \begin_layout Plain Layout
22606 is true, the default is
22607 \begin_inset Flex Code
22610 \begin_layout Plain Layout
22616 ; if it is false, the default is
22617 \begin_inset Flex Code
22620 \begin_layout Plain Layout
22629 \begin_layout Subsection
22633 \begin_layout Standard
22634 The XHTML output for floats too can be controlled by layout information.
22635 The output has the following form:
22638 \begin_layout LyX-Code
22640 \begin_inset Quotes erd
22644 \begin_inset Quotes erd
22650 \begin_layout LyX-Code
22651 Contents of the float.
22654 \begin_layout LyX-Code
22658 \begin_layout Standard
22659 The caption, if there is one, is a separate inset and will be output as
22661 Its appearance can be controlled via the InsetLayout for caption insets.
22665 \begin_layout Description
22666 \begin_inset Flex Code
22669 \begin_layout Plain Layout
22676 \begin_inset Flex Code
22679 \begin_layout Plain Layout
22685 ] Specifies attribute information to be output with the main tag.
22687 \begin_inset Quotes eld
22691 \begin_inset Flex Code
22694 \begin_layout Plain Layout
22695 class=`myfloat' onclick=`\SpecialChar ldots
22702 \begin_inset Quotes erd
22706 By default, \SpecialChar LyX
22708 \begin_inset Quotes eld
22712 \begin_inset Flex Code
22715 \begin_layout Plain Layout
22716 class=`float float-floattype'
22722 \begin_inset Quotes erd
22726 \begin_inset Flex Code
22729 \begin_layout Plain Layout
22735 is \SpecialChar LyX
22736 's name for this type of float, as determined by the float declaration
22738 \begin_inset CommandInset ref
22740 reference "subsec:Floats"
22744 ), though made lowercase and with non-alphanumeric characters converted
22745 to underscores, for example: float-table.
22748 \begin_layout Description
22749 \begin_inset Flex Code
22752 \begin_layout Plain Layout
22758 CSS style information to be included when this float is used.
22759 Note that this will automatically be wrapped in a layout-generated
22760 \begin_inset Flex Code
22763 \begin_layout Plain Layout
22769 block, so only the CSS itself need be included.
22772 \begin_layout Description
22773 \begin_inset Flex Code
22776 \begin_layout Plain Layout
22783 \begin_inset Flex Code
22786 \begin_layout Plain Layout
22792 ] The tag to be used for this float, replacing
22793 \begin_inset Quotes eld
22797 \begin_inset Flex Code
22800 \begin_layout Plain Layout
22807 \begin_inset Quotes erd
22810 in the example above.
22812 \begin_inset Flex Code
22815 \begin_layout Plain Layout
22821 and will rarely need changing.
22824 \begin_layout Subsection
22825 Bibliography formatting
22828 \begin_layout Standard
22829 The bibliography can be formatted using
22830 \begin_inset Flex Code
22833 \begin_layout Plain Layout
22841 \begin_inset CommandInset ref
22843 reference "subsec:Citation-format-description"
22850 \begin_layout Subsection
22855 \begin_layout Standard
22856 We have several times mentioned that \SpecialChar LyX
22857 will generate default CSS style rules
22858 for both insets and paragraph styles, based upon the other layout information
22860 In this section, we shall say a word about which layout information \SpecialChar LyX
22865 \begin_layout Standard
22866 At present, \SpecialChar LyX
22867 auto-generates CSS only for font information, making use of
22869 \begin_inset Flex Code
22872 \begin_layout Plain Layout
22879 \begin_inset Flex Code
22882 \begin_layout Plain Layout
22889 \begin_inset Flex Code
22892 \begin_layout Plain Layout
22899 \begin_inset Flex Code
22902 \begin_layout Plain Layout
22909 \begin_inset Flex Code
22912 \begin_layout Plain Layout
22919 \begin_inset CommandInset ref
22921 reference "subsec:Font-description"
22926 The translation is mostly straightforward and obvious.
22928 \begin_inset Quotes eld
22932 \begin_inset Flex Code
22935 \begin_layout Plain Layout
22942 \begin_inset Quotes erd
22946 \begin_inset Quotes eld
22950 \begin_inset Flex Code
22953 \begin_layout Plain Layout
22954 font-family: sans-serif;
22960 \begin_inset Quotes erd
22964 The correspondence of \SpecialChar LyX
22965 sizes and CSS sizes is a little less obvious but
22966 nonetheless intuitive.
22968 \begin_inset Flex Code
22971 \begin_layout Plain Layout
22978 \begin_inset Flex URL
22981 \begin_layout Plain Layout
22991 \begin_layout Chapter
22992 Including External Material
22993 \begin_inset CommandInset label
22995 name "chap:Including-External-Material"
23002 \begin_layout Standard
23003 \begin_inset Box Shadowbox
23013 height_special "totalheight"
23018 backgroundcolor "none"
23021 \begin_layout Plain Layout
23022 WARNING: This portion of the documentation has not been updated for some
23024 We certainly hope that it is still accurate, but there are no guarantees.
23032 \begin_layout Standard
23033 The use of material from sources external to \SpecialChar LyX
23034 is covered in detail in the
23040 This part of the manual covers what needs to happen behind the scenes for
23041 new sorts of material to be included.
23044 \begin_layout Section
23048 \begin_layout Standard
23049 The external material feature is based on the concept of a
23054 A template is a specification of how \SpecialChar LyX
23055 should interface with a certain kind
23057 As bundled, \SpecialChar LyX
23058 comes with predefined templates for Xfig figures, various
23059 raster format images, chess diagrams, and LilyPond music notation.
23060 You can check the actual list by using the menu
23061 \begin_inset Flex MenuItem
23064 \begin_layout Plain Layout
23065 Insert\SpecialChar menuseparator
23066 File\SpecialChar menuseparator
23073 Furthermore, it is possible to roll your own template to support a specific
23075 Later we'll describe in more detail what is involved, and hopefully you
23076 will submit all the templates you create so we can include them in a later
23081 \begin_layout Standard
23082 Another basic idea of the external material feature is to distinguish between
23083 the original file that serves as a base for final material and the produced
23084 file that is included in your exported or printed document.
23085 For example, consider the case of a figure produced with
23086 \begin_inset Flex Code
23089 \begin_layout Plain Layout
23096 The Xfig application itself works on an original file with the
23097 \begin_inset Flex Code
23100 \begin_layout Plain Layout
23107 Within Xfig, you create and change your figure, and when you are done,
23109 \begin_inset Flex Code
23112 \begin_layout Plain Layout
23119 When you want to include the figure in your document, you invoke
23120 \begin_inset Flex Code
23123 \begin_layout Plain Layout
23129 in order to create a PostScript file that can readily be included in your
23133 \begin_inset Flex Code
23136 \begin_layout Plain Layout
23142 file is the original file, and the PostScript file is the produced file.
23145 \begin_layout Standard
23146 This distinction is important in order to allow updating of the material
23147 while you are in the process of writing the document.
23148 Furthermore, it provides us with the flexibility that is needed to support
23149 multiple export formats.
23150 For instance, in the case of a plain text file, it is not exactly an award-winn
23151 ing idea to include the figure as raw PostScript.
23152 Instead, you would either prefer to just include a reference to the figure
23153 or try to invoke some graphics to ASCII converter to make the final result
23154 look similar to the real graphics.
23155 The external material management allows you to do this, because it is parametri
23156 zed on the different export formats that \SpecialChar LyX
23160 \begin_layout Standard
23161 Besides supporting the production of different products according to the
23162 exported format, it supports tight integration with editing and viewing
23164 In the case of an Xfig figure, you are able to invoke Xfig on the original
23165 file with a single click from within the external material dialog in \SpecialChar LyX
23167 and also preview the produced PostScript file with Ghostview with another
23169 No more fiddling around with the command line and/or file browsers to locate
23170 and manipulate the original or produced files.
23171 In this way, you are finally able to take full advantage of the many different
23172 applications that are relevant to use when you write your documents, and
23173 ultimately be more productive.
23176 \begin_layout Section
23177 The external template configuration file
23180 \begin_layout Standard
23181 It is relatively easy to add custom external template definitions to \SpecialChar LyX
23183 However, be aware that doing this in an careless manner most probably
23187 introduce an easily exploitable security hole.
23188 So before you do this, please read the discussion about security in
23189 \begin_inset CommandInset ref
23191 reference "sec:Security-discussion"
23198 \begin_layout Standard
23199 Having said that, we encourage you to submit any interesting templates that
23204 \begin_layout Standard
23205 The external templates are defined in the
23206 \begin_inset Flex Code
23209 \begin_layout Plain Layout
23211 \change_deleted -712698321 1437634905
23214 \change_inserted -712698321 1437634906
23217 Dir/lib/external_templates
23223 You can place your own version in
23224 \begin_inset Flex Code
23227 \begin_layout Plain Layout
23228 UserDir/external_templates
23236 \begin_layout Standard
23237 A typical template looks like this:
23240 \begin_layout LyX-Code
23244 \begin_layout LyX-Code
23245 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
23248 \begin_layout LyX-Code
23252 \begin_layout LyX-Code
23256 \begin_layout LyX-Code
23260 \begin_layout LyX-Code
23264 \begin_layout LyX-Code
23268 \begin_layout LyX-Code
23269 AutomaticProduction true
23272 \begin_layout LyX-Code
23276 \begin_layout LyX-Code
23280 \begin_layout LyX-Code
23281 Format \SpecialChar LaTeX
23285 \begin_layout LyX-Code
23286 TransformCommand Rotate RotationLatexCommand
23289 \begin_layout LyX-Code
23290 TransformCommand Resize ResizeLatexCommand
23293 \begin_layout LyX-Code
23294 Product "$$RotateFront$$ResizeFront
23297 \begin_layout LyX-Code
23302 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
23305 \begin_layout LyX-Code
23306 $$ResizeBack$$RotateBack"
23309 \begin_layout LyX-Code
23313 \begin_layout LyX-Code
23314 UpdateResult "$$AbsPath$$Basename.pstex_t"
23317 \begin_layout LyX-Code
23318 Requirement "graphicx"
23321 \begin_layout LyX-Code
23322 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
23325 \begin_layout LyX-Code
23326 ReferencedFile latex "$$AbsPath$$Basename.eps"
23329 \begin_layout LyX-Code
23330 ReferencedFile dvi "$$AbsPath$$Basename.eps"
23333 \begin_layout LyX-Code
23337 \begin_layout LyX-Code
23338 Format PDF\SpecialChar LaTeX
23342 \begin_layout LyX-Code
23343 TransformCommand Rotate RotationLatexCommand
23346 \begin_layout LyX-Code
23347 TransformCommand Resize ResizeLatexCommand
23350 \begin_layout LyX-Code
23351 Product "$$RotateFront$$ResizeFront
23354 \begin_layout LyX-Code
23359 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
23362 \begin_layout LyX-Code
23363 $$ResizeBack$$RotateBack"
23366 \begin_layout LyX-Code
23367 UpdateFormat pdftex
23370 \begin_layout LyX-Code
23371 UpdateResult "$$AbsPath$$Basename.pdftex_t"
23374 \begin_layout LyX-Code
23375 Requirement "graphicx"
23378 \begin_layout LyX-Code
23379 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
23382 \begin_layout LyX-Code
23383 ReferencedFile latex "$$AbsPath$$Basename.pdf"
23386 \begin_layout LyX-Code
23390 \begin_layout LyX-Code
23394 \begin_layout LyX-Code
23395 Product "$$Contents(
23397 "$$AbsPath$$Basename.asc
23402 \begin_layout LyX-Code
23403 UpdateFormat asciixfig
23406 \begin_layout LyX-Code
23407 UpdateResult "$$AbsPath$$Basename.asc"
23410 \begin_layout LyX-Code
23414 \begin_layout LyX-Code
23418 \begin_layout LyX-Code
23419 Product "<graphic fileref=
23421 "$$AbsOrRelPathMaster$$Basename.eps
23426 \begin_layout LyX-Code
23430 \begin_layout LyX-Code
23434 \begin_layout LyX-Code
23435 UpdateResult "$$AbsPath$$Basename.eps"
23438 \begin_layout LyX-Code
23439 ReferencedFile docbook "$$AbsPath$$Basename.eps"
23442 \begin_layout LyX-Code
23443 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
23446 \begin_layout LyX-Code
23450 \begin_layout LyX-Code
23451 Product "[XFig: $$FName]"
23454 \begin_layout LyX-Code
23458 \begin_layout LyX-Code
23462 \begin_layout Standard
23463 As you can see, the template is enclosed in
23464 \begin_inset Flex Code
23467 \begin_layout Plain Layout
23475 \begin_inset Flex Code
23478 \begin_layout Plain Layout
23485 It contains a header specifying some general settings and, for each supported
23486 primary document file format, a section
23487 \begin_inset Flex Code
23490 \begin_layout Plain Layout
23498 \begin_inset Flex Code
23501 \begin_layout Plain Layout
23510 \begin_layout Subsection
23511 The template header
23514 \begin_layout Description
23515 \begin_inset Flex Code
23518 \begin_layout Plain Layout
23519 AutomaticProduction
23520 \begin_inset space ~
23528 Whether the file represented by the template must be generated by \SpecialChar LyX
23530 This command must occur exactly once.
23533 \begin_layout Description
23534 \begin_inset Flex Code
23537 \begin_layout Plain Layout
23539 \begin_inset space ~
23547 A glob pattern that is used in the file dialog to filter out the desired
23549 If there is more than one possible file extension (e.
23550 \begin_inset space \thinspace{}
23554 \begin_inset space \space{}
23558 \begin_inset Flex Code
23561 \begin_layout Plain Layout
23568 \begin_inset Flex Code
23571 \begin_layout Plain Layout
23577 ), use something like
23578 \begin_inset Flex Code
23581 \begin_layout Plain Layout
23588 This command must occur exactly once.
23591 \begin_layout Description
23592 \begin_inset Flex Code
23595 \begin_layout Plain Layout
23597 \begin_inset space ~
23605 The text that is displayed on the button.
23606 This command must occur exactly once.
23609 \begin_layout Description
23610 \begin_inset Flex Code
23613 \begin_layout Plain Layout
23615 \begin_inset space ~
23619 \begin_inset space ~
23627 The help text that is used in the External dialog.
23628 Provide enough information to explain to the user just what the template
23629 can provide him with.
23630 This command must occur exactly once.
23633 \begin_layout Description
23634 \begin_inset Flex Code
23637 \begin_layout Plain Layout
23639 \begin_inset space ~
23647 The file format of the original file.
23648 This must be the name of a format that is known to \SpecialChar LyX
23650 \begin_inset CommandInset ref
23652 reference "sec:Formats"
23658 \begin_inset Quotes eld
23662 \begin_inset Flex Code
23665 \begin_layout Plain Layout
23672 \begin_inset Quotes erd
23675 if the template can handle original files of more than one format.
23677 will attempt to interrogate the file itself in order to deduce its format
23679 This command must occur exactly once.
23682 \begin_layout Description
23683 \begin_inset Flex Code
23686 \begin_layout Plain Layout
23688 \begin_inset space ~
23696 A unique name for the template.
23697 It must not contain substitution macros (see below).
23700 \begin_layout Description
23701 \begin_inset Flex Code
23704 \begin_layout Plain Layout
23706 \begin_inset space ~
23709 Rotate|Resize|Clip|Extra
23714 This command specifies which transformations are supported by this template.
23715 It may occur zero or more times.
23716 This command enables the corresponding tabs in the external dialog.
23718 \begin_inset Flex Code
23721 \begin_layout Plain Layout
23727 command must have either a corresponding
23728 \begin_inset Flex Code
23731 \begin_layout Plain Layout
23738 \begin_inset Flex Code
23741 \begin_layout Plain Layout
23748 \begin_inset Flex Code
23751 \begin_layout Plain Layout
23758 Otherwise the transformation will not be supported by that format.
23761 \begin_layout Subsection
23765 \begin_layout Description
23766 \begin_inset Flex Code
23769 \begin_layout Plain Layout
23771 \begin_inset space ~
23775 \change_inserted -195340706 1437418821
23777 \change_inserted -712698321 1437634430
23779 \change_deleted -712698321 1437634429
23781 \change_inserted -195340706 1437418821
23783 \change_deleted -195340706 1437418827
23788 \change_inserted -195340706 1437418856
23790 \change_inserted -712698321 1437634432
23792 \change_deleted -712698321 1437634432
23794 \change_inserted -195340706 1437418856
23796 \change_deleted -195340706 1437418857
23805 The primary document file format that this format definition is for.
23806 Not every template has a sensible representation in all document file formats.
23807 Please define nevertheless a
23808 \begin_inset Flex Code
23811 \begin_layout Plain Layout
23817 section for all templates.
23818 Use a dummy text when no representation is available.
23819 Then you can at least see a reference to the external material in the exported
23823 \begin_layout Description
23824 \begin_inset Flex Code
23827 \begin_layout Plain Layout
23829 \begin_inset space ~
23833 \begin_inset space ~
23841 This command defines an additional macro
23842 \begin_inset Flex Code
23845 \begin_layout Plain Layout
23851 for substitution in
23852 \begin_inset Flex Code
23855 \begin_layout Plain Layout
23863 \begin_inset Flex Code
23866 \begin_layout Plain Layout
23872 itself may contain substitution macros.
23873 The advantage over using
23874 \begin_inset Flex Code
23877 \begin_layout Plain Layout
23884 \begin_inset Flex Code
23887 \begin_layout Plain Layout
23893 is that the substituted value of
23894 \begin_inset Flex Code
23897 \begin_layout Plain Layout
23903 is sanitized so that it is a valid optional argument in the document format.
23904 This command may occur zero or more times.
23907 \begin_layout Description
23908 \begin_inset Flex Code
23911 \begin_layout Plain Layout
23913 \begin_inset space ~
23921 The text that is inserted in the exported document.
23922 This is actually the most important command and can be quite complex.
23923 This command must occur exactly once.
23926 \begin_layout Description
23927 \begin_inset Flex Code
23930 \begin_layout Plain Layout
23932 \begin_inset space ~
23940 This command specifies a preamble snippet that will be included in the
23943 It has to be defined using
23944 \begin_inset Flex Code
23947 \begin_layout Plain Layout
23955 \begin_inset Flex Code
23958 \begin_layout Plain Layout
23965 This command may occur zero or more times.
23968 \begin_layout Description
23969 \begin_inset Flex Code
23972 \begin_layout Plain Layout
23974 \begin_inset space ~
23978 \begin_inset space ~
23986 This command denotes files that are created by the conversion process and
23987 are needed for a particular export format.
23988 If the filename is relative, it is interpreted relative to the master document.
23989 This command may be given zero or more times.
23992 \begin_layout Description
23993 \begin_inset Flex Code
23996 \begin_layout Plain Layout
23998 \begin_inset space ~
24006 The name of a required \SpecialChar LaTeX
24008 The package is included via
24009 \begin_inset Flex Code
24012 \begin_layout Plain Layout
24020 in the \SpecialChar LaTeX
24022 This command may occur zero or more times.
24025 \begin_layout Description
24026 \begin_inset Flex Code
24029 \begin_layout Plain Layout
24031 \begin_inset space ~
24035 \begin_inset space ~
24038 RotationLatexCommand
24043 This command specifies that the built in \SpecialChar LaTeX
24044 command should be used for rotation.
24045 This command may occur once or not at all.
24048 \begin_layout Description
24049 \begin_inset Flex Code
24052 \begin_layout Plain Layout
24054 \begin_inset space ~
24058 \begin_inset space ~
24066 This command specifies that the built in \SpecialChar LaTeX
24067 command should be used for resizing.
24068 This command may occur once or not at all.
24071 \begin_layout Description
24072 \begin_inset Flex Code
24075 \begin_layout Plain Layout
24077 \begin_inset space ~
24081 \begin_inset space ~
24084 RotationLatexOption
24089 This command specifies that rotation is done via an optional argument.
24090 This command may occur once or not at all.
24093 \begin_layout Description
24094 \begin_inset Flex Code
24097 \begin_layout Plain Layout
24099 \begin_inset space ~
24103 \begin_inset space ~
24111 This command specifies that resizing is done via an optional argument.
24112 This command may occur once or not at all.
24115 \begin_layout Description
24116 \begin_inset Flex Code
24119 \begin_layout Plain Layout
24121 \begin_inset space ~
24125 \begin_inset space ~
24133 This command specifies that clipping is done via an optional argument.
24134 This command may occur once or not at all.
24137 \begin_layout Description
24138 \begin_inset Flex Code
24141 \begin_layout Plain Layout
24143 \begin_inset space ~
24147 \begin_inset space ~
24155 This command specifies that an extra optional argument is used.
24156 This command may occur once or not at all.
24159 \begin_layout Description
24160 \begin_inset Flex Code
24163 \begin_layout Plain Layout
24165 \begin_inset space ~
24173 The file format of the converted file.
24174 This must be the name of a format that is known to \SpecialChar LyX
24176 \begin_inset Flex MenuItem
24179 \begin_layout Plain Layout
24180 Tools\SpecialChar menuseparator
24181 Preferences\SpecialChar menuseparator
24182 File Handling\SpecialChar menuseparator
24189 This command must occur exactly once.
24190 If the resulting file format is PDF, you need to specify the format
24191 \begin_inset Flex Code
24194 \begin_layout Plain Layout
24201 This is the PDF format used for including graphics.
24202 The other defined PDF formats are for document export.
24205 \begin_layout Description
24206 \begin_inset Flex Code
24209 \begin_layout Plain Layout
24211 \begin_inset space ~
24219 The file name of the converted file.
24220 The file name must be absolute.
24221 This command must occur exactly once.
24224 \begin_layout Subsection
24225 Preamble definitions
24228 \begin_layout Standard
24229 The external template configuration file may contain additional preamble
24230 definitions enclosed by
24231 \begin_inset Flex Code
24234 \begin_layout Plain Layout
24242 \begin_inset Flex Code
24245 \begin_layout Plain Layout
24252 They can be used by the templates in the
24253 \begin_inset Flex Code
24256 \begin_layout Plain Layout
24265 \begin_layout Section
24266 The substitution mechanism
24269 \begin_layout Standard
24270 When the external material facility invokes an external program, it is done
24271 on the basis of a command defined in the template configuration file.
24272 These commands can contain various macros that are expanded before execution.
24273 Execution always take place in the directory of the containing document.
24276 \begin_layout Standard
24277 Also, whenever external material is to be displayed, the name will be produced
24278 by the substitution mechanism, and most other commands in the template
24279 definition support substitution as well.
24282 \begin_layout Standard
24283 The available macros are the following:
24286 \begin_layout Description
24287 \begin_inset Flex Code
24290 \begin_layout Plain Layout
24291 $$AbsOrRelPathMaster
24296 The file path, absolute or relative to the master \SpecialChar LyX
24300 \begin_layout Description
24301 \begin_inset Flex Code
24304 \begin_layout Plain Layout
24305 $$AbsOrRelPathParent
24310 The file path, absolute or relative to the \SpecialChar LyX
24314 \begin_layout Description
24315 \begin_inset Flex Code
24318 \begin_layout Plain Layout
24324 The absolute file path.
24327 \begin_layout Description
24328 \begin_inset Flex Code
24331 \begin_layout Plain Layout
24337 The filename without path and without the extension.
24340 \begin_layout Description
24341 \begin_inset Flex Code
24344 \begin_layout Plain Layout
24346 \begin_inset Quotes eld
24350 \begin_inset Quotes erd
24358 This macro will expand to the contents of the file with the name
24359 \begin_inset Flex Code
24362 \begin_layout Plain Layout
24371 \begin_layout Description
24372 \begin_inset Flex Code
24375 \begin_layout Plain Layout
24381 The file extension (including the dot).
24382 \change_inserted -195340706 1437418878
24386 \begin_layout Description
24388 \change_inserted -195340706 1437418878
24389 \begin_inset Flex Code
24392 \begin_layout Plain Layout
24394 \change_inserted -195340706 1437418878
24400 This will be the string
24401 \begin_inset Quotes eld
24405 \begin_inset Quotes erd
24408 if the file is in JPEG format, otherwise it will be the string
24409 \begin_inset Quotes eld
24413 \begin_inset Quotes erd
24417 This is useful to avoid uneeded conversions for output formats that support
24418 both PNG and JPEG fomats.
24419 The predefined RasterImage template uses this macro for the PDFL
24420 \change_deleted -712698321 1437634446
24422 \change_inserted -712698321 1437634446
24424 \change_inserted -195340706 1437418878
24430 \begin_layout Description
24431 \begin_inset Flex Code
24434 \begin_layout Plain Layout
24440 The filename of the file specified in the external material dialog.
24441 This is either an absolute name, or it is relative to the \SpecialChar LyX
24445 \begin_layout Description
24446 \begin_inset Flex Code
24449 \begin_layout Plain Layout
24456 \begin_inset Flex Code
24459 \begin_layout Plain Layout
24465 (absolute name or relative to the \SpecialChar LyX
24469 \begin_layout Description
24470 \begin_inset Flex Code
24473 \begin_layout Plain Layout
24479 The file path, relative to the master \SpecialChar LyX
24483 \begin_layout Description
24484 \begin_inset Flex Code
24487 \begin_layout Plain Layout
24493 The file path, relative to the \SpecialChar LyX
24497 \begin_layout Description
24498 \begin_inset Flex Code
24501 \begin_layout Plain Layout
24507 This macro will expand to the absolute path of the system directory.
24508 This is typically used to point to the various helper scripts that are
24509 bundled with \SpecialChar LyX
24513 \begin_layout Description
24514 \begin_inset Flex Code
24517 \begin_layout Plain Layout
24523 A name and full path to a temporary file which will be automatically deleted
24524 whenever the containing document is closed, or the external material insertion
24528 \begin_layout Standard
24529 All path macros contain a trailing directory separator, so you can construct
24531 \begin_inset space \thinspace{}
24535 \begin_inset space \space{}
24538 the absolute filename with
24539 \begin_inset Flex Code
24542 \begin_layout Plain Layout
24543 $$AbsPath$$Basename$$Extension
24551 \begin_layout Standard
24552 The macros above are substituted in all commands unless otherwise noted.
24554 \begin_inset Flex Code
24557 \begin_layout Plain Layout
24563 supports additionally the following substitutions if they are enabled by
24565 \begin_inset Flex Code
24568 \begin_layout Plain Layout
24575 \begin_inset Flex Code
24578 \begin_layout Plain Layout
24587 \begin_layout Description
24588 \begin_inset Flex Code
24591 \begin_layout Plain Layout
24597 The front part of the resize command.
24600 \begin_layout Description
24601 \begin_inset Flex Code
24604 \begin_layout Plain Layout
24610 The back part of the resize command.
24613 \begin_layout Description
24614 \begin_inset Flex Code
24617 \begin_layout Plain Layout
24623 The front part of the rotation command.
24626 \begin_layout Description
24627 \begin_inset Flex Code
24630 \begin_layout Plain Layout
24636 The back part of the rotation command.
24639 \begin_layout Standard
24640 The value string of the
24641 \begin_inset Flex Code
24644 \begin_layout Plain Layout
24650 command supports additionally the following substitutions if they are enabled
24652 \begin_inset Flex Code
24655 \begin_layout Plain Layout
24662 \begin_inset Flex Code
24665 \begin_layout Plain Layout
24674 \begin_layout Description
24675 \begin_inset Flex Code
24678 \begin_layout Plain Layout
24687 \begin_layout Description
24688 \begin_inset Flex Code
24691 \begin_layout Plain Layout
24700 \begin_layout Description
24701 \begin_inset Flex Code
24704 \begin_layout Plain Layout
24713 \begin_layout Description
24714 \begin_inset Flex Code
24717 \begin_layout Plain Layout
24723 The rotation option.
24726 \begin_layout Standard
24727 You may ask why there are so many path macros.
24728 There are mainly two reasons:
24731 \begin_layout Enumerate
24732 Relative and absolute file names should remain relative or absolute, respectivel
24734 Users may have reasons to prefer either form.
24735 Relative names are useful for portable documents that should work on different
24736 machines, for example.
24737 Absolute names may be required by some programs.
24740 \begin_layout Enumerate
24742 treats relative file names differently than \SpecialChar LyX
24743 and other programs in nested
24745 For \SpecialChar LyX
24746 , a relative file name is always relative to the document that contains
24748 For \SpecialChar LaTeX
24749 , it is always relative to the master document.
24750 These two definitions are identical if you have only one document, but
24751 differ if you have a master document that includes part documents.
24752 That means that relative filenames must be transformed when presented to
24755 Fortunately \SpecialChar LyX
24756 does this automatically for you if you choose the right macros.
24759 \begin_layout Standard
24760 So which path macro should be used in new template definitions? The rule
24764 \begin_layout Itemize
24766 \begin_inset Flex Code
24769 \begin_layout Plain Layout
24775 if an absolute path is required.
24778 \begin_layout Itemize
24780 \begin_inset Flex Code
24783 \begin_layout Plain Layout
24784 $$AbsOrRelPathMaster
24789 if the substituted string is some kind of \SpecialChar LaTeX
24793 \begin_layout Itemize
24795 \begin_inset Flex Code
24798 \begin_layout Plain Layout
24799 $$AbsOrRelPathParent
24804 in order to preserve the user's choice.
24807 \begin_layout Standard
24808 There are special cases where this rule does not work and e.
24809 \begin_inset space \thinspace{}
24813 \begin_inset space \space{}
24816 relative names are needed, but normally it will work just fine.
24817 One example for such a case is the command
24818 \begin_inset Flex Code
24821 \begin_layout Plain Layout
24822 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
24827 in the XFig template above: We can't use the absolute name because the
24829 \begin_inset Flex Code
24832 \begin_layout Plain Layout
24838 files needs the relative name in order to rewrite the file content.
24841 \begin_layout Section
24842 Security discussion
24843 \begin_inset CommandInset label
24845 name "sec:Security-discussion"
24852 \begin_layout Standard
24853 The external material feature interfaces with a lot of external programs
24854 and does so automatically, so we have to consider the security implications
24856 In particular, since you have the option of including your own filenames
24857 and/or parameter strings and those are expanded into a command, it seems
24858 that it would be possible to create a malicious document which executes
24859 arbitrary commands when a user views or prints the document.
24860 This is something we definitely want to avoid.
24863 \begin_layout Standard
24864 However, since the external program commands are specified in the template
24865 configuration file only, there are no security issues if \SpecialChar LyX
24866 is properly configure
24867 d with safe templates only.
24868 This is so because the external programs are invoked with the
24869 \begin_inset Flex Code
24872 \begin_layout Plain Layout
24878 -system call rather than the
24879 \begin_inset Flex Code
24882 \begin_layout Plain Layout
24888 system-call, so it's not possible to execute arbitrary commands from the
24889 filename or parameter section via the shell.
24892 \begin_layout Standard
24893 This also implies that you are restricted in what command strings you can
24894 use in the external material templates.
24895 In particular, pipes and redirection are not readily available.
24896 This has to be so if \SpecialChar LyX
24897 should remain safe.
24898 If you want to use some of the shell features, you should write a safe
24899 script to do this in a controlled manner, and then invoke the script from
24900 the command string.
24904 \begin_layout Standard
24905 It is possible to design a template that interacts directly with the shell,
24906 but since this would allow a malicious user to execute arbitrary commands
24907 by writing clever filenames and/or parameters, we generally recommend that
24908 you only use safe scripts that work with the
24909 \begin_inset Flex Code
24912 \begin_layout Plain Layout
24918 system call in a controlled manner.
24919 Of course, for use in a controlled environment, it can be tempting to just
24920 fall back to use ordinary shell scripts.
24921 If you do so, be aware that you
24925 provide an easily exploitable security hole in your system.
24926 Of course it stands to reason that such unsafe templates will never be
24927 included in the standard \SpecialChar LyX
24928 distribution, although we do encourage people
24929 to submit new templates in the open source tradition.
24930 But \SpecialChar LyX
24931 as shipped from the official distribution channels will never have
24935 \begin_layout Standard
24936 Including external material provides a lot of power, and you have to be
24937 careful not to introduce security hazards with this power.
24938 A subtle error in a single line in an innocent looking script can open
24939 the door to huge security problems.
24940 So if you do not fully understand the issues, we recommend that you consult
24941 a knowledgeable security professional or the \SpecialChar LyX
24942 development team if you have
24943 any questions about whether a given template is safe or not.
24944 And do this before you use it in an uncontrolled environment.
24947 \begin_layout Chapter
24949 List of supported \SpecialChar LyX
24950 functions to be used in layouts
24951 \begin_inset CommandInset label
24953 name "chap:List-of-functions"
24960 \begin_layout Standard
24962 \begin_inset Tabular
24963 <lyxtabular version="3" rows="11" columns="8">
24964 <features tabularvalignment="middle">
24965 <column alignment="left" valignment="top">
24966 <column alignment="left" valignment="top">
24967 <column alignment="left" valignment="top">
24968 <column alignment="left" valignment="top">
24969 <column alignment="left" valignment="top">
24970 <column alignment="left" valignment="top">
24971 <column alignment="left" valignment="top">
24972 <column alignment="left" valignment="top">
24974 <cell alignment="left" valignment="top" usebox="none">
24977 \begin_layout Plain Layout
24983 <cell alignment="left" valignment="top" usebox="none">
24986 \begin_layout Plain Layout
24992 <cell alignment="left" valignment="top" usebox="none">
24995 \begin_layout Plain Layout
25001 <cell alignment="left" valignment="top" usebox="none">
25004 \begin_layout Plain Layout
25010 <cell alignment="center" valignment="top" usebox="none">
25013 \begin_layout Plain Layout
25019 <cell alignment="center" valignment="top" usebox="none">
25022 \begin_layout Plain Layout
25028 <cell alignment="center" valignment="top" usebox="none">
25031 \begin_layout Plain Layout
25037 <cell alignment="center" valignment="top" usebox="none">
25040 \begin_layout Plain Layout
25048 <cell alignment="left" valignment="top" usebox="none">
25051 \begin_layout Plain Layout
25057 <cell alignment="left" valignment="top" usebox="none">
25060 \begin_layout Plain Layout
25066 <cell alignment="left" valignment="top" usebox="none">
25069 \begin_layout Plain Layout
25075 <cell alignment="left" valignment="top" usebox="none">
25078 \begin_layout Plain Layout
25084 <cell alignment="center" valignment="top" usebox="none">
25087 \begin_layout Plain Layout
25093 <cell alignment="center" valignment="top" usebox="none">
25096 \begin_layout Plain Layout
25102 <cell alignment="center" valignment="top" usebox="none">
25105 \begin_layout Plain Layout
25111 <cell alignment="center" valignment="top" usebox="none">
25114 \begin_layout Plain Layout
25122 <cell alignment="left" valignment="top" usebox="none">
25125 \begin_layout Plain Layout
25131 <cell alignment="left" valignment="top" usebox="none">
25134 \begin_layout Plain Layout
25140 <cell alignment="left" valignment="top" usebox="none">
25143 \begin_layout Plain Layout
25149 <cell alignment="left" valignment="top" usebox="none">
25152 \begin_layout Plain Layout
25158 <cell alignment="center" valignment="top" usebox="none">
25161 \begin_layout Plain Layout
25167 <cell alignment="center" valignment="top" usebox="none">
25170 \begin_layout Plain Layout
25176 <cell alignment="center" valignment="top" usebox="none">
25179 \begin_layout Plain Layout
25185 <cell alignment="center" valignment="top" usebox="none">
25188 \begin_layout Plain Layout
25196 <cell alignment="left" valignment="top" usebox="none">
25199 \begin_layout Plain Layout
25205 <cell alignment="left" valignment="top" usebox="none">
25208 \begin_layout Plain Layout
25214 <cell alignment="left" valignment="top" usebox="none">
25217 \begin_layout Plain Layout
25223 <cell alignment="left" valignment="top" usebox="none">
25226 \begin_layout Plain Layout
25232 <cell alignment="center" valignment="top" usebox="none">
25235 \begin_layout Plain Layout
25241 <cell alignment="center" valignment="top" usebox="none">
25244 \begin_layout Plain Layout
25250 <cell alignment="center" valignment="top" usebox="none">
25253 \begin_layout Plain Layout
25259 <cell alignment="center" valignment="top" usebox="none">
25262 \begin_layout Plain Layout
25270 <cell alignment="left" valignment="top" usebox="none">
25273 \begin_layout Plain Layout
25279 <cell alignment="left" valignment="top" usebox="none">
25282 \begin_layout Plain Layout
25288 <cell alignment="left" valignment="top" usebox="none">
25291 \begin_layout Plain Layout
25297 <cell alignment="left" valignment="top" usebox="none">
25300 \begin_layout Plain Layout
25306 <cell alignment="center" valignment="top" usebox="none">
25309 \begin_layout Plain Layout
25315 <cell alignment="center" valignment="top" usebox="none">
25318 \begin_layout Plain Layout
25324 <cell alignment="center" valignment="top" usebox="none">
25327 \begin_layout Plain Layout
25333 <cell alignment="center" valignment="top" usebox="none">
25336 \begin_layout Plain Layout
25344 <cell alignment="left" valignment="top" usebox="none">
25347 \begin_layout Plain Layout
25353 <cell alignment="left" valignment="top" usebox="none">
25356 \begin_layout Plain Layout
25362 <cell alignment="left" valignment="top" usebox="none">
25365 \begin_layout Plain Layout
25371 <cell alignment="left" valignment="top" usebox="none">
25374 \begin_layout Plain Layout
25380 <cell alignment="center" valignment="top" usebox="none">
25383 \begin_layout Plain Layout
25389 <cell alignment="center" valignment="top" usebox="none">
25392 \begin_layout Plain Layout
25398 <cell alignment="center" valignment="top" usebox="none">
25401 \begin_layout Plain Layout
25407 <cell alignment="center" valignment="top" usebox="none">
25410 \begin_layout Plain Layout
25418 <cell alignment="left" valignment="top" usebox="none">
25421 \begin_layout Plain Layout
25427 <cell alignment="left" valignment="top" usebox="none">
25430 \begin_layout Plain Layout
25436 <cell alignment="left" valignment="top" usebox="none">
25439 \begin_layout Plain Layout
25445 <cell alignment="left" valignment="top" usebox="none">
25448 \begin_layout Plain Layout
25454 <cell alignment="center" valignment="top" usebox="none">
25457 \begin_layout Plain Layout
25463 <cell alignment="center" valignment="top" usebox="none">
25466 \begin_layout Plain Layout
25472 <cell alignment="center" valignment="top" usebox="none">
25475 \begin_layout Plain Layout
25481 <cell alignment="center" valignment="top" usebox="none">
25484 \begin_layout Plain Layout
25492 <cell alignment="left" valignment="top" usebox="none">
25495 \begin_layout Plain Layout
25501 <cell alignment="left" valignment="top" usebox="none">
25504 \begin_layout Plain Layout
25510 <cell alignment="left" valignment="top" usebox="none">
25513 \begin_layout Plain Layout
25519 <cell alignment="left" valignment="top" usebox="none">
25522 \begin_layout Plain Layout
25528 <cell alignment="center" valignment="top" usebox="none">
25531 \begin_layout Plain Layout
25537 <cell alignment="center" valignment="top" usebox="none">
25540 \begin_layout Plain Layout
25546 <cell alignment="center" valignment="top" usebox="none">
25549 \begin_layout Plain Layout
25555 <cell alignment="center" valignment="top" usebox="none">
25558 \begin_layout Plain Layout
25566 <cell alignment="left" valignment="top" usebox="none">
25569 \begin_layout Plain Layout
25575 <cell alignment="left" valignment="top" usebox="none">
25578 \begin_layout Plain Layout
25584 <cell alignment="left" valignment="top" usebox="none">
25587 \begin_layout Plain Layout
25593 <cell alignment="left" valignment="top" usebox="none">
25596 \begin_layout Plain Layout
25602 <cell alignment="center" valignment="top" usebox="none">
25605 \begin_layout Plain Layout
25611 <cell alignment="center" valignment="top" usebox="none">
25614 \begin_layout Plain Layout
25620 <cell alignment="center" valignment="top" usebox="none">
25623 \begin_layout Plain Layout
25629 <cell alignment="center" valignment="top" usebox="none">
25632 \begin_layout Plain Layout
25640 <cell alignment="left" valignment="top" usebox="none">
25643 \begin_layout Plain Layout
25649 <cell alignment="left" valignment="top" usebox="none">
25652 \begin_layout Plain Layout
25658 <cell alignment="left" valignment="top" usebox="none">
25661 \begin_layout Plain Layout
25667 <cell alignment="left" valignment="top" usebox="none">
25670 \begin_layout Plain Layout
25676 <cell alignment="center" valignment="top" usebox="none">
25679 \begin_layout Plain Layout
25685 <cell alignment="center" valignment="top" usebox="none">
25688 \begin_layout Plain Layout
25694 <cell alignment="center" valignment="top" usebox="none">
25697 \begin_layout Plain Layout
25703 <cell alignment="center" valignment="top" usebox="none">
25706 \begin_layout Plain Layout
25714 <cell alignment="center" valignment="top" usebox="none">
25717 \begin_layout Plain Layout
25723 <cell alignment="center" valignment="top" usebox="none">
25726 \begin_layout Plain Layout
25732 <cell alignment="center" valignment="top" usebox="none">
25735 \begin_layout Plain Layout
25741 <cell alignment="center" valignment="top" usebox="none">
25744 \begin_layout Plain Layout
25750 <cell alignment="center" valignment="top" usebox="none">
25753 \begin_layout Plain Layout
25759 <cell alignment="center" valignment="top" usebox="none">
25762 \begin_layout Plain Layout
25768 <cell alignment="center" valignment="top" usebox="none">
25771 \begin_layout Plain Layout
25777 <cell alignment="center" valignment="top" usebox="none">
25780 \begin_layout Plain Layout
25794 \begin_layout Chapter
25795 Names of available colors to be used in layouts
25796 \begin_inset CommandInset label
25798 name "chap:Names-of-colors"
25805 \begin_layout Standard
25806 The colors listed here are the standard colors and the those that you can
25807 adjust in the \SpecialChar LyX
25811 \begin_layout Description
25824 No particular color – clear or default
25827 \begin_layout Description
25831 \begin_layout Description
25835 \begin_layout Description
25839 \begin_layout Description
25843 \begin_layout Description
25847 \begin_layout Description
25851 \begin_layout Description
25855 \begin_layout Description
25859 \begin_layout Description
25860 added_space Added space marker color
25863 \begin_layout Description
25864 addedtext Added text color
25867 \begin_layout Description
25868 appendix Appendix marker color
25871 \begin_layout Description
25872 background Background color
25875 \begin_layout Description
25876 bottomarea Bottom area color
25879 \begin_layout Description
25880 branchlabel Label color for branches
25883 \begin_layout Description
25884 buttonbg Color used for bottom background
25887 \begin_layout Description
25888 buttonhoverbg Color used for button background under focus
25891 \begin_layout Description
25892 buttonframe Color for inset button frames
25895 \begin_layout Description
25896 changebar Changebar color
25899 \begin_layout Description
25900 changedtextauthor1 Changed text color author 1
25903 \begin_layout Description
25904 changedtextauthor2 Changed text color author 2
25907 \begin_layout Description
25908 changedtextauthor3 Changed text color author 3
25911 \begin_layout Description
25912 changedtextauthor4 Changed text color author 4
25915 \begin_layout Description
25916 changedtextauthor5 Changed text color author 5
25919 \begin_layout Description
25920 collapsable_inset_frame Collapsable insets framecolor
25923 \begin_layout Description
25924 collapsable_inset_text Collapsable insets text color
25927 \begin_layout Description
25928 command Text color for command insets
25931 \begin_layout Description
25932 commandbg Background color for command insets
25935 \begin_layout Description
25936 commandframe Frame color for command insets
25939 \begin_layout Description
25940 comment color for comments
25943 \begin_layout Description
25944 commentbg Background color of comments
25947 \begin_layout Description
25948 cursor Cursor color
25951 \begin_layout Description
25952 deletedtext Deleted text color
25955 \begin_layout Description
25956 deletedtextmodifier Deleted text modifying color
25959 \begin_layout Description
25960 depthbar Color for the depth bars in the margin
25963 \begin_layout Description
25964 eolmarker End of line marker color
25967 \begin_layout Description
25968 error Color of the \SpecialChar LaTeX
25972 \begin_layout Description
25973 footlabel Label color for footnotes
25976 \begin_layout Description
25977 graphicsbg Graphics inset background color
25980 \begin_layout Description
25981 greyedout Label color for greyedout insets
25984 \begin_layout Description
25985 greyedoutbg Background color of greyedout inset
25988 \begin_layout Description
25989 greyedouttext Color for greyedout inset text
25992 \begin_layout Description
25993 indexlabel Label color for index insets
25996 \begin_layout Description
25997 ignore The color is ignored
26000 \begin_layout Description
26001 inherit The color is inherited
26004 \begin_layout Description
26005 inlinecompletion Inline completion color
26008 \begin_layout Description
26009 insetbg Inset marker background color
26012 \begin_layout Description
26013 insetframe Inset marker frame color
26016 \begin_layout Description
26017 language Color for marking foreign language words
26020 \begin_layout Description
26021 latex Text color in \SpecialChar LaTeX
26025 \begin_layout Description
26026 listingsbg Background color of listings inset
26029 \begin_layout Description
26030 marginlabel Label color for margin notes
26033 \begin_layout Description
26034 math Math inset text color
26037 \begin_layout Description
26038 mathbg Math inset background color
26041 \begin_layout Description
26042 mathcorners Math inset frame color not under focus
26045 \begin_layout Description
26046 mathframe Math inset frame color under focus
26049 \begin_layout Description
26050 mathline Math line color
26053 \begin_layout Description
26054 mathmacrobg Macro math inset background color
26057 \begin_layout Description
26058 mathmacroblend Macro math blended color
26061 \begin_layout Description
26062 mathmacroframe Macro math frame color
26065 \begin_layout Description
26066 mathmacrohoverbg Macro math inset background color hovered
26069 \begin_layout Description
26070 mathmacrolabel Macro math label color
26073 \begin_layout Description
26074 mathmacronewarg Macro template color for new parameters
26077 \begin_layout Description
26078 mathmacrooldarg Macro template color for old parameters
26081 \begin_layout Description
26082 newpage New page color
26085 \begin_layout Description
26086 nonunique_inlinecompletion Inline completion color for the non-unique part
26089 \begin_layout Description
26090 notebg Background color of notes
26093 \begin_layout Description
26094 notelabel Label color for notes
26097 \begin_layout Description
26098 pagebreak Page break/line break color
26101 \begin_layout Description
26102 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
26105 \begin_layout Description
26106 phantomtext Text color for phantom insets
26109 \begin_layout Description
26110 preview The color used for previews
26113 \begin_layout Description
26114 previewframe Preview frame color
26117 \begin_layout Description
26118 regexpframe Color for regexp frame
26121 \begin_layout Description
26122 selection Background color of selected text
26125 \begin_layout Description
26126 selectiontext Foreground color of selected text
26129 \begin_layout Description
26130 shadedbg Background color of shaded box
26133 \begin_layout Description
26134 special Special chars text color
26137 \begin_layout Description
26138 tabularline Table line color
26141 \begin_layout Description
26142 tabularonoffline Table line color
26145 \begin_layout Description
26146 urllabel Label color for URL insets
26149 \begin_layout Description
26150 urltext Color for URL inset text