1 #LyX 2.1 created this file. For more info see http://www.lyx.org/
7 % DO NOT ALTER THIS PREAMBLE!!!
9 % This preamble is designed to ensure that this document prints
10 % out as advertised. If you mess with this preamble,
11 % parts of this document may not print out as expected. If you
12 % have problems LaTeXing this file, please contact
13 % the documentation team
14 % email: lyx-docs@lists.lyx.org
16 \usepackage{ifpdf} % part of the hyperref bundle
17 \ifpdf % if pdflatex is used
19 % set fonts for nicer pdf view
20 \IfFileExists{lmodern.sty}
21 {\usepackage{lmodern}}{}
23 \fi % end if pdflatex is used
25 % the pages of the TOC is numbered roman
26 % and a pdf-bookmark for the TOC is added
27 \let\myTOC\tableofcontents
28 \renewcommand\tableofcontents{%
30 \pdfbookmark[1]{\contentsname}{}
34 \options fleqn,bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
35 \use_default_options false
39 \maintain_unincluded_children false
42 InsetLayout Flex:MenuItem
51 \newcommand*{\menuitem}[1]{{\sffamily #1}}
54 # In case we need to do with sans...
55 #InsetLayout CharStyle:Code
60 #\renewcommand{\code}[1]{{\sffamily #1}}
65 \language_package default
70 \font_typewriter default
72 \font_default_family default
73 \use_non_tex_fonts false
79 \default_output_format default
81 \bibtex_command default
82 \index_command default
86 \pdf_title "LyX Configuration Manual"
87 \pdf_author "LyX Team"
88 \pdf_subject "LyX-documentation Customization"
89 \pdf_keywords "LyX, documentation, customization"
91 \pdf_bookmarksnumbered true
92 \pdf_bookmarksopen true
93 \pdf_bookmarksopenlevel 1
98 \pdf_pdfusetitle false
99 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
102 \use_package amsmath 0
103 \use_package amssymb 0
104 \use_package cancel 0
106 \use_package mathdots 1
107 \use_package mathtools 0
108 \use_package mhchem 0
109 \use_package stackrel 0
110 \use_package stmaryrd 0
111 \use_package undertilde 0
113 \cite_engine_type default
117 \paperorientation portrait
132 \paragraph_separation indent
133 \paragraph_indentation default
134 \quotes_language english
137 \paperpagestyle headings
138 \tracking_changes true
139 \output_changes false
143 \author -712698321 "Jürgen Spitzmüller"
144 \author -195340706 "Georg Baum"
146 \author 155139281 "Jrgen Spitzmller"
147 \author 1082167584 "Kayvan Sylvan" kayvan@sylvan.com
148 \author 1414654397 "Richard Heck"
149 \author 2090807402 "usti"
155 Customizing LyX: Features for the Advanced User
163 \begin_layout Plain Layout
165 If you have comments or error corrections, please send them to the LyX Documenta
167 \begin_inset CommandInset href
169 target "lyx-docs@lists.lyx.org"
176 \begin_inset Quotes eld
180 \begin_inset Quotes erd
183 in the subject header, and please cc the current maintainer of this file,
184 Richard Heck <rgheck@comcast.net>.
190 \begin_inset Newline newline
194 \begin_inset Newline newline
198 \change_deleted -712698321 1357054389
200 \change_inserted -712698321 1357054389
206 \begin_layout Standard
207 \begin_inset CommandInset toc
208 LatexCommand tableofcontents
215 \begin_layout Standard
216 \begin_inset Note Note
219 \begin_layout Plain Layout
220 Please use change tracking when modifying this document.
221 This makes it easier for our translators to recognize things that have
222 been changed, and it helps the maintainer keep up-to-date with what's been
231 \begin_layout Chapter
235 \begin_layout Standard
236 This manual covers the customization features present in LyX.
237 In it, we discuss issues like keyboard shortcuts, screen previewing options,
238 printer options, sending commands to LyX via the LyX Server, internationalizati
239 on, installing new LaTeX classes and LyX layouts, etc.
240 We can't possibly hope to touch on everything you can change—our developers
241 add new features faster than we can document them—but we will explain the
242 most common customizations and hopefully point you in the right direction
243 for some of the more obscure ones.
246 \begin_layout Standard
247 \begin_inset Branch OutDated
250 \begin_layout Standard
251 Information from previous versions of this document that now seems to be
252 outdated is contained in the OutDated branch of this document.
253 By default, this information will not appear in the LaTeX output.
261 \begin_layout Chapter
262 LyX configuration files
265 \begin_layout Standard
266 This chapter aims to help you to find your way through the LyX configuration
268 Before continuing to read this chapter, you should find out where your
269 LyX library and user directories are by using
270 \begin_inset Flex MenuItem
273 \begin_layout Plain Layout
274 Help\SpecialChar \menuseparator
285 The library directory is the place where LyX places its system-wide configurati
286 on files; the user directory is where you can place your modified versions.
287 We will call the former
288 \begin_inset Flex Code
291 \begin_layout Plain Layout
298 \begin_inset Flex MenuItem
301 \begin_layout Plain Layout
307 in the remainder of this document.
311 \begin_layout Section
313 \begin_inset Flex Code
316 \begin_layout Plain Layout
325 \begin_layout Standard
326 \begin_inset Flex Code
329 \begin_layout Plain Layout
335 and its sub-directories contain a number of files and that can be used
336 to customize LyX's behavior.
337 You can change many of these files from within LyX itself through the
338 \begin_inset Flex MenuItem
341 \begin_layout Plain Layout
342 Tools\SpecialChar \menuseparator
349 Most customization that you will want to do in LyX is possible through
351 However, many other inner aspects of LyX can be customized by modifying
353 \begin_inset Flex Code
356 \begin_layout Plain Layout
363 These files fall in different categories, described in the following subsection
367 \begin_layout Subsection
368 Automatically generated files
371 \begin_layout Standard
372 The files, which are to be found in
373 \begin_inset Flex MenuItem
376 \begin_layout Plain Layout
382 , are generated when you configure LyX.
383 They contain various default values that are guessed by inspection.
384 In general, it is not a good idea to modify them, since they might be overwritt
388 \begin_layout Labeling
389 \labelwidthstring 00.00.0000
390 \begin_inset Flex Code
393 \begin_layout Plain Layout
399 contains defaults for various commands.
402 \begin_layout Labeling
403 \labelwidthstring 00.00.0000
404 \begin_inset Flex Code
407 \begin_layout Plain Layout
413 contains the list of packages that have been recognized by LyX.
414 It is currently unused by the LyX program itself, but the information extracted
415 , and more, is made available with
416 \begin_inset Flex MenuItem
419 \begin_layout Plain Layout
420 Help\SpecialChar \menuseparator
433 \begin_layout Labeling
434 \labelwidthstring 00.00.0000
435 \begin_inset Flex Code
438 \begin_layout Plain Layout
444 the list of text classes that have been found in your
445 \begin_inset Flex Code
448 \begin_layout Plain Layout
454 directories, along with the associated LaTeX document class and their descripti
458 \begin_layout Labeling
459 \labelwidthstring 00.00.0000
460 \begin_inset Flex Code
463 \begin_layout Plain Layout
469 the list of layout modules found in your
470 \begin_inset Flex Code
473 \begin_layout Plain Layout
482 \begin_layout Labeling
483 \labelwidthstring 00.00.0000
484 \begin_inset Flex Code
487 \begin_layout Plain Layout
493 lists of various sorts of LaTeX-related files found on your system
496 \begin_layout Labeling
497 \labelwidthstring 00.00.0000
498 \begin_inset Flex Code
501 \begin_layout Plain Layout
507 is automatically generated during configuration from the file
508 \begin_inset Flex Code
511 \begin_layout Plain Layout
518 It contains information on your LaTeX configuration.
521 \begin_layout Subsection
525 \begin_layout Standard
526 These directories are duplicated between
527 \begin_inset Flex Code
530 \begin_layout Plain Layout
537 \begin_inset Flex Code
540 \begin_layout Plain Layout
547 If a particular files exists in both places, the one in
548 \begin_inset Flex Code
551 \begin_layout Plain Layout
560 \begin_layout Labeling
561 \labelwidthstring 00.00.0000
562 \begin_inset Flex Code
565 \begin_layout Plain Layout
571 this directory contains files with the extension
572 \begin_inset Flex Code
575 \begin_layout Plain Layout
581 that define the keybindings used in LyX.
582 If there exists an internationalized version of the bind file named
583 \begin_inset Flex Code
586 \begin_layout Plain Layout
592 , that will be used first.
595 \begin_layout Labeling
596 \labelwidthstring 00.00.0000
597 \begin_inset Flex Code
600 \begin_layout Plain Layout
606 contains graphics files that can be included in documents.
610 \begin_layout Labeling
611 \labelwidthstring 00.00.0000
612 \begin_inset Flex Code
615 \begin_layout Plain Layout
621 contains LyX documentation files (including the one you are currently reading).
623 \begin_inset Flex Code
626 \begin_layout Plain Layout
632 deserves special attention, as noted above.
633 The internationalized help docs are in subdirectories
634 \begin_inset Flex Code
637 \begin_layout Plain Layout
644 \begin_inset Quotes eld
648 \begin_inset Quotes erd
651 is the ISO language code.
657 \begin_inset CommandInset ref
659 reference "cha:Internationalizing-LyX"
666 \begin_layout Labeling
667 \labelwidthstring 00.00.0000
668 \begin_inset Flex Code
671 \begin_layout Plain Layout
677 contains example files that explain how to use some features.
678 In the file browser, press the
679 \begin_inset Flex MenuItem
682 \begin_layout Plain Layout
691 \begin_layout Labeling
692 \labelwidthstring 00.00.0000
693 \begin_inset Flex Code
696 \begin_layout Plain Layout
702 contains image files that are used by the
703 \begin_inset Flex MenuItem
706 \begin_layout Plain Layout
713 In addition, it also contains the individual icons used in the toolbar
714 and the banners that can be shown when LyX is launched.
717 \begin_layout Labeling
718 \labelwidthstring 00.00.0000
719 \begin_inset Flex Code
722 \begin_layout Plain Layout
728 contains keyboard keymapping files.
734 \begin_inset CommandInset ref
736 reference "sec:International-Keymap-Stuff"
743 \begin_layout Labeling
744 \labelwidthstring 00.00.0000
745 \begin_inset Flex Code
748 \begin_layout Plain Layout
754 contains the text class and module files described in Chapter
759 \begin_inset CommandInset ref
761 reference "cha:Installing-New-Document"
768 \begin_layout Labeling
769 \labelwidthstring 00.00.0000
770 \begin_inset Flex Code
773 \begin_layout Plain Layout
780 \begin_inset Flex Code
783 \begin_layout Plain Layout
789 Python scripts used to convert between LyX versions.
790 These can be run from the command line if, say, you want to batch-convert
794 \begin_layout Labeling
795 \labelwidthstring 00.00.0000
796 \begin_inset Flex Code
799 \begin_layout Plain Layout
805 contains some files that demonstrate the capabilities of the
806 \begin_inset Flex MenuItem
809 \begin_layout Plain Layout
820 Also contains some scripts used by LyX itself.
823 \begin_layout Labeling
824 \labelwidthstring 00.00.0000
825 \begin_inset Flex Code
828 \begin_layout Plain Layout
834 contains the standard LyX template files described in Chapter
839 \begin_inset CommandInset ref
841 reference "sub:Creating-Templates"
848 \begin_layout Labeling
849 \labelwidthstring 00.00.0000
850 \begin_inset Flex Code
853 \begin_layout Plain Layout
859 contains files with the extension
860 \begin_inset Flex Code
863 \begin_layout Plain Layout
869 that define the user interface to LyX.
870 That is, the files define which items appear in which menus and the items
871 appearing on the toolbar.
874 \begin_layout Subsection
875 Files you don't want to modify
878 \begin_layout Standard
879 These files are used internally by LyX and you generally do not need to
880 modify them unless you are a developer.
883 \begin_layout Labeling
884 \labelwidthstring 00.00.0000
885 \begin_inset Flex Code
888 \begin_layout Plain Layout
894 this file contains the list of LyX developers.
895 The contents are displayed with the menu entry
896 \begin_inset Flex MenuItem
899 \begin_layout Plain Layout
900 Help\SpecialChar \menuseparator
913 \begin_layout Labeling
914 \labelwidthstring 00.00.0000
915 \begin_inset Flex Code
918 \begin_layout Plain Layout
924 this is a LaTeX script used during the configuration process.
928 \begin_layout Labeling
929 \labelwidthstring 00.00.0000
930 \begin_inset Flex Code
933 \begin_layout Plain Layout
939 this is the script that is used to re-configure LyX.
940 It creates configuration files in the directory it was run from.
943 \begin_layout Subsection
944 Other files needing a line or two
945 \change_deleted -712698321 1357054454
947 \change_inserted -712698321 1357054454
948 \SpecialChar \ldots{}
954 \begin_layout Labeling
955 \labelwidthstring 00.00.0000
956 \begin_inset Flex Code
959 \begin_layout Plain Layout
965 this contains tables describing how different character encodings can be
969 \begin_layout Labeling
970 \labelwidthstring 00.00.0000
971 \begin_inset Flex Code
974 \begin_layout Plain Layout
980 this file contains the templates available to the new
981 \begin_inset Flex MenuItem
984 \begin_layout Plain Layout
997 \begin_layout Labeling
998 \labelwidthstring 00.00.0000
999 \begin_inset Flex Code
1002 \begin_layout Plain Layout
1008 this file contains a list of all the languages currently supported by LyX.
1009 \change_inserted -712698321 1357054565
1013 \begin_layout Labeling
1014 \labelwidthstring 00.00.0000
1016 \change_inserted -712698321 1357054669
1017 \begin_inset Flex Code
1020 \begin_layout Plain Layout
1022 \change_inserted -712698321 1357054669
1030 contains information about the supported fonts.
1031 \change_inserted -195340706 1334775793
1035 \begin_layout Labeling
1036 \labelwidthstring 00.00.0000
1038 \change_inserted -195340706 1334775793
1039 \begin_inset Flex Code
1042 \begin_layout Plain Layout
1044 \change_inserted -195340706 1334775793
1050 this file contains translations for internationalized paragraph styles
1052 \begin_inset space \thinspace{}
1056 \begin_inset CommandInset ref
1058 reference "sub:I18n"
1063 \change_inserted -712698321 1357054494
1067 \begin_layout Labeling
1068 \labelwidthstring 00.00.0000
1070 \change_inserted -712698321 1357054554
1071 \begin_inset Flex Code
1074 \begin_layout Plain Layout
1076 \change_inserted -712698321 1357054508
1084 this file contains information about unicode-encoded glyphs and the way
1085 they are supported by LyX via LaTeX.
1090 \begin_layout Section
1091 Your local configuration directory
1094 \begin_layout Standard
1095 Even if you are using LyX as an unprivileged user, you might want to change
1096 LyX configuration for your own use.
1098 \begin_inset Flex Code
1101 \begin_layout Plain Layout
1107 directory contains all your personal configuration files.
1108 This is the directory described as
1109 \begin_inset Quotes eld
1113 \begin_inset Quotes erd
1117 \begin_inset Flex MenuItem
1120 \begin_layout Plain Layout
1121 Help\SpecialChar \menuseparator
1123 \begin_inset space ~
1132 This directory is used as a mirror of
1133 \begin_inset Flex Code
1136 \begin_layout Plain Layout
1142 , which means that every file in
1143 \begin_inset Flex Code
1146 \begin_layout Plain Layout
1152 is a replacement for the corresponding file in
1153 \begin_inset Flex Code
1156 \begin_layout Plain Layout
1163 Any configuration file described in the above sections can be placed either
1164 in the system-wide directory, in which case it will affect all users, or
1165 in your local directory for your own use.
1168 \begin_layout Standard
1169 To make things clearer, let's provide a few examples:
1172 \begin_layout Itemize
1173 The preferences set in the
1174 \begin_inset Flex MenuItem
1177 \begin_layout Plain Layout
1178 Tools\SpecialChar \menuseparator
1184 dialog are saved to a file
1185 \begin_inset Flex Code
1188 \begin_layout Plain Layout
1195 \begin_inset Flex Code
1198 \begin_layout Plain Layout
1207 \begin_layout Itemize
1208 When you reconfigure using
1209 \begin_inset Flex MenuItem
1212 \begin_layout Plain Layout
1213 Tools\SpecialChar \menuseparator
1220 \begin_inset Flex Code
1223 \begin_layout Plain Layout
1229 script, and the resulting files are written in your local configuration
1231 This means that any additional text class file that you might have added
1233 \begin_inset Flex Code
1236 \begin_layout Plain Layout
1242 will be added to the list of classes in the
1243 \begin_inset Flex MenuItem
1246 \begin_layout Plain Layout
1247 Document\SpecialChar \menuseparator
1256 \begin_layout Itemize
1257 If you get some updated documentation from LyX ftp site and cannot install
1258 it because you do not have sysadmin rights on your system, you can just
1260 \begin_inset Flex Code
1263 \begin_layout Plain Layout
1269 and the items in the
1270 \begin_inset Flex MenuItem
1273 \begin_layout Plain Layout
1279 menu will open them!
1282 \begin_layout Section
1283 Running LyX with multiple configurations
1286 \begin_layout Standard
1287 The configuration freedom of the local configuration directory may not suffice
1288 if you want to have more than one configuration at your disposal.
1289 For example, you may want to be use different key bindings or printer settings
1291 You can achieve this by having several such directories.
1292 You then specify which directory to use at run-time.
1295 \begin_layout Standard
1296 Invoking LyX with the command line switch
1297 \begin_inset Flex Code
1300 \begin_layout Plain Layout
1310 instructs the program to read the configuration from that directory, and
1311 not from the default directory.
1312 (You can determine the default directory by running LyX without the
1313 \begin_inset Flex Code
1316 \begin_layout Plain Layout
1322 switch.) If the specified directory does not exist, LyX offers to create
1323 it for you, just like it does for the default directory on the first time
1324 you run the program.
1325 You can modify the configuration options in this additional user directory
1326 exactly as you would for the default directory.
1327 These directories are completely independent (but read on).
1328 Note that setting the environment variable
1329 \begin_inset Flex Code
1332 \begin_layout Plain Layout
1338 to some value has exactly the same effect.
1341 \begin_layout Standard
1342 Having several configurations also requires more maintenance: if you want
1343 to add a new layout to
1344 \begin_inset Flex Code
1347 \begin_layout Plain Layout
1353 which you want available from all your configurations, you must add it
1354 to each directory separately.
1355 You can avoid this with the following trick: after LyX creates the additional
1356 directory, most of the subdirectories (see above) are empty.
1357 If you want the new configuration to mirror an existing one, replace the
1358 empty subdirectory with a symbolic link to the matching subdirectory in
1359 the existing configuration.
1361 \begin_inset Flex Code
1364 \begin_layout Plain Layout
1370 subdirectory, however, since it contains a file written by the configuration
1371 script (also accessible through
1372 \begin_inset Flex MenuItem
1375 \begin_layout Plain Layout
1376 Tools\SpecialChar \menuseparator
1382 ) which is configuration-specific.
1385 \begin_layout Chapter
1386 The Preferences dialog
1389 \begin_layout Standard
1390 All options of the preferences dialog are described in the Appendix
1392 The Preferences Dialog
1399 For some options you might find here more details.
1402 \begin_layout Section
1404 \begin_inset CommandInset label
1413 \begin_layout Standard
1414 The first step is to define your file formats if they are not already defined.
1416 \begin_inset Flex MenuItem
1419 \begin_layout Plain Layout
1420 Tools\SpecialChar \menuseparator
1428 \begin_inset Flex MenuItem
1431 \begin_layout Plain Layout
1432 File Handling\SpecialChar \menuseparator
1439 \begin_inset Flex MenuItem
1442 \begin_layout Plain Layout
1443 New\SpecialChar \ldots{}
1449 button to define your new format.
1451 \begin_inset Flex MenuItem
1454 \begin_layout Plain Layout
1460 field contains the name used to identify the format in the GUI.
1462 \begin_inset Flex MenuItem
1465 \begin_layout Plain Layout
1471 is used to identify the format internally.
1472 You will also need to enter a file extension.
1473 These are all required.
1475 \begin_inset Flex MenuItem
1478 \begin_layout Plain Layout
1484 field is used to provide a keyboard shortcut on the menus.
1485 (For example, pressing
1486 \begin_inset Flex MenuItem
1489 \begin_layout Plain Layout
1496 \begin_inset Flex MenuItem
1499 \begin_layout Plain Layout
1500 View\SpecialChar \menuseparator
1501 View (Other Formats)\SpecialChar \menuseparator
1510 \begin_layout Standard
1512 \begin_inset Flex MenuItem
1515 \begin_layout Plain Layout
1522 \begin_inset Flex MenuItem
1525 \begin_layout Plain Layout
1532 For example, you might want to use
1533 \begin_inset Flex MenuItem
1536 \begin_layout Plain Layout
1542 to view PostScript files.
1543 You can enter the command needed to start the program in the corresponding
1545 In defining this command, you can use the four variables listed in the
1547 The viewer is launched when you view an image in LyX or use the
1548 \begin_inset Flex MenuItem
1551 \begin_layout Plain Layout
1558 The editor is for example launched when you right-click on an image and
1560 \begin_inset Flex MenuItem
1563 \begin_layout Plain Layout
1569 in the appearing context menu.
1572 \begin_layout Standard
1574 \change_inserted -195340706 1329851811
1576 \begin_inset Flex MenuItem
1579 \begin_layout Plain Layout
1585 type of a format is optional, but if it is specified, it must be unique
1587 It is used to detect files of this format from the file contents.
1588 For some important file formats there is no MIME type officially registered
1590 \begin_inset CommandInset href
1593 target "http://www.iana.org/assignments/media-types/"
1598 Therefore LyX uses the extended list of MIME types as specified by
1599 \begin_inset CommandInset href
1601 name "freedesktop.org"
1602 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1609 \begin_layout Standard
1611 \begin_inset Flex MenuItem
1614 \begin_layout Plain Layout
1620 option tells LyX that a format is suitable for document export.
1621 If this is set and if a suitable conversion route exists (see sec.
1622 \begin_inset space \thinspace{}
1626 \begin_inset CommandInset ref
1628 reference "sec:Converters"
1632 ), the format will appear in the
1633 \begin_inset Flex MenuItem
1636 \begin_layout Plain Layout
1637 File\SpecialChar \menuseparator
1644 The format will also appear in the
1645 \begin_inset Flex MenuItem
1648 \begin_layout Plain Layout
1654 menu if a viewer is specified for the format.
1655 Pure image formats, such as
1656 \begin_inset Flex Code
1659 \begin_layout Plain Layout
1665 , should not use this option.
1666 Formats that can both represent vector graphics and documents like
1667 \begin_inset Flex Code
1670 \begin_layout Plain Layout
1679 \begin_layout Standard
1681 \begin_inset Flex MenuItem
1684 \begin_layout Plain Layout
1685 Vector graphics format
1690 tells LyX that a format can contain vector graphics.
1691 This information is used to determine the target format of included graphics
1693 \begin_inset Flex MenuItem
1696 \begin_layout Plain Layout
1703 Included graphics may need to be converted to either
1704 \begin_inset Flex MenuItem
1707 \begin_layout Plain Layout
1714 \begin_inset Flex MenuItem
1717 \begin_layout Plain Layout
1724 \begin_inset Flex MenuItem
1727 \begin_layout Plain Layout
1734 \begin_inset Flex MenuItem
1737 \begin_layout Plain Layout
1743 cannot handle other image formats.
1744 If an included graphic is not already in
1745 \begin_inset Flex MenuItem
1748 \begin_layout Plain Layout
1755 \begin_inset Flex MenuItem
1758 \begin_layout Plain Layout
1765 \begin_inset Flex MenuItem
1768 \begin_layout Plain Layout
1774 format, it is converted to
1775 \begin_inset Flex MenuItem
1778 \begin_layout Plain Layout
1784 if the vector format option is set, and otherwise to
1785 \begin_inset Flex MenuItem
1788 \begin_layout Plain Layout
1797 \begin_layout Section
1801 \begin_layout Standard
1802 Since all conversions from one format to another take place in LyX's temporary
1803 directory, it is sometimes necessary to modify a file before copying it
1804 to the temporary directory in order that the conversion may be performed.
1808 \begin_layout Plain Layout
1809 For example, the file may refer to other files—images, for example—using
1810 relative file names, and these may become invalid when the file is copied
1811 to the temporary directory.
1816 This is done by a Copier: It copies a file to (or from) the temporary directory
1817 and may modify it in the process.
1820 \begin_layout Standard
1821 The definitions of the copiers may use four variables:
1824 \begin_layout Labeling
1825 \labelwidthstring 00.00.0000
1826 \begin_inset Flex Code
1829 \begin_layout Plain Layout
1835 The LyX system directory (e.
1836 \begin_inset space \thinspace{}
1840 \begin_inset space \space{}
1844 \begin_inset Flex MenuItem
1847 \begin_layout Plain Layout
1856 \begin_layout Labeling
1857 \labelwidthstring 00.00.0000
1858 \begin_inset Flex Code
1861 \begin_layout Plain Layout
1870 \begin_layout Labeling
1871 \labelwidthstring 00.00.0000
1872 \begin_inset Flex Code
1875 \begin_layout Plain Layout
1882 \change_inserted 1082167584 1348453985
1886 \begin_layout Labeling
1887 \labelwidthstring 00.00.0000
1889 \change_inserted 2090807402 1369935163
1890 \begin_inset Flex Code
1893 \begin_layout Plain Layout
1895 \change_inserted 2090807402 1369935165
1902 \change_inserted 1082167584 1348453986
1903 The base name (without filename extension) in the LyX temporary directory
1906 \begin_layout Labeling
1907 \labelwidthstring 00.00.0000
1909 \change_inserted 2090807402 1369935168
1910 \begin_inset Flex Code
1913 \begin_layout Plain Layout
1915 \change_inserted 2090807402 1369935170
1922 \change_inserted 1082167584 1348453986
1923 The full directory path of the LyX temporary directory
1926 \begin_layout Labeling
1927 \labelwidthstring 00.00.0000
1929 \change_inserted 2090807402 1369935172
1930 \begin_inset Flex Code
1933 \begin_layout Plain Layout
1935 \change_inserted 2090807402 1369935174
1942 \change_inserted 1082167584 1348453986
1943 The full pathname to the original LyX file being processed
1946 \begin_layout Labeling
1947 \labelwidthstring 00.00.0000
1949 \change_inserted 2090807402 1369935180
1950 \begin_inset Flex Code
1953 \begin_layout Plain Layout
1955 \change_inserted 2090807402 1369935182
1962 \change_inserted 1082167584 1348453986
1963 The filename (without any directory path) of the LyX file.
1966 \begin_layout Labeling
1967 \labelwidthstring 00.00.0000
1968 \begin_inset Flex Code
1971 \begin_layout Plain Layout
1978 \change_inserted 1082167584 1348453720
1982 \begin_layout Standard
1983 The latter should be the filename as it would be used in a LaTeX's
1990 It is relevant only when exporting files suitable for such inclusion.
1993 \begin_layout Standard
1994 Copiers can be used to do almost anything with output files.
1995 For example, suppose you want generated pdf files to be copied to a special
1997 \begin_inset Flex Code
2000 \begin_layout Plain Layout
2007 Then you could write a shell script such as this one:
2010 \begin_layout Standard
2011 \begin_inset listings
2015 \begin_layout Plain Layout
2020 \begin_layout Plain Layout
2025 \begin_layout Plain Layout
2027 TOFILE=`basename $2`
2030 \begin_layout Plain Layout
2032 cp $FROMFILE /home/you/pdf/$TOFILE
2037 Save it in your local LyX directory—say,
2038 \begin_inset Flex Code
2041 \begin_layout Plain Layout
2042 /home/you/.lyx/scripts/pdfcopier.sh
2047 —and make it executable, if you need to do so on your platform.
2049 \begin_inset Flex MenuItem
2052 \begin_layout Plain Layout
2053 Tools\SpecialChar \menuseparator
2059 dialog, select under
2060 \begin_inset Flex MenuItem
2063 \begin_layout Plain Layout
2064 File Handling\SpecialChar \menuseparator
2071 \begin_inset Flex MenuItem
2074 \begin_layout Plain Layout
2080 format—or one of the other pdf formats—and enter
2081 \begin_inset Flex Code
2084 \begin_layout Plain Layout
2085 pdfcopier.sh $$i $$o
2091 \begin_inset Flex MenuItem
2094 \begin_layout Plain Layout
2104 \begin_layout Standard
2105 Copiers are used by LyX in various of its own conversions.
2106 For example, if appropriate programs are found, LyX will automatically
2107 install copiers for the
2108 \begin_inset Flex MenuItem
2111 \begin_layout Plain Layout
2118 \begin_inset Flex MenuItem
2121 \begin_layout Plain Layout
2123 \begin_inset space ~
2132 When these formats are exported, the copier sees that not just the main
2133 HTML file but various associated files (style files, images, etc.) are also
2135 All these files are written to a subdirectory of the directory in which
2136 the original LyX file was found.
2140 \begin_layout Plain Layout
2141 This copier can be customized.
2143 \begin_inset Quotes eld
2147 \begin_inset Quotes erd
2150 argument takes a comma-separated list of extensions to be copied; if it
2151 is omitted, all files will be copied.
2153 \begin_inset Quotes eld
2157 \begin_inset Quotes erd
2160 argument determines the extension added to the generated directory.
2162 \begin_inset Quotes eld
2166 \begin_inset Flex MenuItem
2169 \begin_layout Plain Layout
2176 \begin_inset Quotes erd
2179 , so HTML generated from
2180 \begin_inset Flex MenuItem
2183 \begin_layout Plain Layout
2184 /path/to/filename.lyx
2190 \begin_inset Flex MenuItem
2193 \begin_layout Plain Layout
2194 /path/to/filename.html.LyXconv
2208 \begin_layout Section
2210 \begin_inset CommandInset label
2212 name "sec:Converters"
2219 \begin_layout Standard
2220 You can define your own Converters to convert files between different formats.
2222 \begin_inset Flex MenuItem
2225 \begin_layout Plain Layout
2226 Tools\SpecialChar \menuseparator
2227 Preferences\SpecialChar \menuseparator
2228 File Handling\SpecialChar \menuseparator
2237 \begin_layout Standard
2238 To define a new converter, select the
2239 \begin_inset Flex MenuItem
2242 \begin_layout Plain Layout
2244 \begin_inset space ~
2253 \begin_inset Flex MenuItem
2256 \begin_layout Plain Layout
2258 \begin_inset space ~
2266 from the drop-down lists, enter the command needed for the conversion,
2268 \begin_inset Flex MenuItem
2271 \begin_layout Plain Layout
2278 Several variables can be used in the definition of converters:
2281 \begin_layout Labeling
2282 \labelwidthstring 00.00.0000
2283 \begin_inset Flex Code
2286 \begin_layout Plain Layout
2292 The LyX system directory
2295 \begin_layout Labeling
2296 \labelwidthstring 00.00.0000
2297 \begin_inset Flex Code
2300 \begin_layout Plain Layout
2309 \begin_layout Labeling
2310 \labelwidthstring 00.00.0000
2311 \begin_inset Flex Code
2314 \begin_layout Plain Layout
2323 \begin_layout Labeling
2324 \labelwidthstring 00.00.0000
2325 \begin_inset Flex Code
2328 \begin_layout Plain Layout
2334 The base filename of the input file (i.
2335 \begin_inset space \thinspace{}
2338 g., without the extension)
2341 \begin_layout Labeling
2342 \labelwidthstring 00.00.0000
2343 \begin_inset Flex Code
2346 \begin_layout Plain Layout
2352 The path to the input file
2355 \begin_layout Labeling
2356 \labelwidthstring 00.00.0000
2357 \begin_inset Flex Code
2360 \begin_layout Plain Layout
2366 The path to the original input file (this is different from $$p when a
2367 chain of converters is called)
2370 \begin_layout Labeling
2371 \labelwidthstring 00.00.0000
2372 \begin_inset Flex Code
2375 \begin_layout Plain Layout
2381 The iconv name for the encoding of the document.
2384 \begin_layout Standard
2386 \begin_inset Flex MenuItem
2389 \begin_layout Plain Layout
2391 \begin_inset space ~
2399 field you can enter the following flags, separated by commas:
2402 \begin_layout Labeling
2403 \labelwidthstring 00.00.0000
2404 \begin_inset Flex Code
2407 \begin_layout Plain Layout
2413 This converter runs some form of LaTeX.
2414 This will make LyX's LaTeX error logs available.
2417 \begin_layout Labeling
2418 \labelwidthstring 00.00.0000
2419 \begin_inset Flex Code
2422 \begin_layout Plain Layout
2429 \begin_inset Flex MenuItem
2432 \begin_layout Plain Layout
2438 file for the conversion.
2439 \change_inserted 1414654397 1337693117
2443 \begin_layout Labeling
2444 \labelwidthstring 00.00.0000
2446 \change_inserted 1414654397 1337693188
2447 \begin_inset Flex Code
2450 \begin_layout Plain Layout
2452 \change_inserted 1414654397 1337693129
2461 \begin_inset Quotes eld
2465 \begin_inset Quotes erd
2468 file from the backend, which in practice means a LaTeX file like the one
2469 we would export, without
2470 \begin_inset Flex Code
2473 \begin_layout Plain Layout
2475 \change_inserted 1414654397 1337693184
2488 \begin_layout Labeling
2489 \labelwidthstring 00.00.0000
2490 \begin_inset Flex Code
2493 \begin_layout Plain Layout
2502 \begin_layout Standard
2503 The following three flags are not really flags at all because they take
2505 \begin_inset Flex MenuItem
2508 \begin_layout Plain Layout
2510 \begin_inset space ~
2514 \begin_inset space ~
2525 \begin_layout Labeling
2526 \labelwidthstring 00.00.0000
2527 \begin_inset Flex Code
2530 \begin_layout Plain Layout
2536 If set, the converter's standard error will be redirected to a file
2537 \begin_inset Flex Code
2540 \begin_layout Plain Layout
2546 , and the script given as argument will be run as:
2547 \begin_inset Flex Code
2550 \begin_layout Plain Layout
2551 script < infile.out > infile.log
2557 The argument may contain
2558 \begin_inset Flex Code
2561 \begin_layout Plain Layout
2570 \begin_layout Labeling
2571 \labelwidthstring 00.00.0000
2572 \begin_inset Flex Code
2575 \begin_layout Plain Layout
2581 The name of the directory in which the converter will dump the generated
2583 LyX will not create this directory, and it does not copy anything into
2584 it, though it will copy this directory to the destination.
2585 The argument may contain
2586 \begin_inset Flex Code
2589 \begin_layout Plain Layout
2595 , which will be replaced by the base name of the input and output files,
2596 respectively, when the directory is copied.
2597 \begin_inset Newline newline
2600 Note that resultdir and usetempdir make no sense together.
2601 The latter will be ignored if the former is given.
2604 \begin_layout Labeling
2605 \labelwidthstring 00.00.0000
2606 \begin_inset Flex Code
2609 \begin_layout Plain Layout
2615 Determines the output file name and may, contain
2616 \begin_inset Flex Code
2619 \begin_layout Plain Layout
2626 Sensible only with resultdir and optional even then; if not given, it defaults
2630 \begin_layout Standard
2631 None of these last three are presently used in any of the converters that
2632 are installed with LyX.
2636 \begin_layout Standard
2637 You do not have to define converters for all formats between which you want
2639 For example, you will note that there is no `LyX to PostScript' converter,
2640 but LyX will export PostScript.
2641 It does so by first creating a LaTeX file (no converter needs to be defined
2642 for this) which is then converted to DVI using the `LaTeX to DVI' converter,
2643 and finally converting the resulting DVI file to PostScript.
2644 LyX finds such `chains' of converters automatically, and it will always
2645 choose the shortest possible chain.
2646 You can, though, still define multiple conversion methods between file
2648 For example, the standard LyX configuration provides
2649 \change_inserted -195340706 1363813100
2651 \change_deleted -195340706 1363813102
2654 ways to convert LaTeX to PDF: Directly, using
2655 \begin_inset Flex MenuItem
2658 \begin_layout Plain Layout
2664 ; via (DVI and) PostScript, using
2665 \begin_inset Flex MenuItem
2668 \begin_layout Plain Layout
2675 \begin_inset Flex MenuItem
2678 \begin_layout Plain Layout
2685 \change_inserted -195340706 1363813143
2686 ; or directly using XeTeX or LuaTeX
2689 To define such alternate chains, you must define multiple target `file
2690 formats', as described in section
2691 \begin_inset CommandInset ref
2693 reference "sec:Formats"
2698 For example, in the standard configuration, the formats named
2699 \begin_inset Flex MenuItem
2702 \begin_layout Plain Layout
2709 \begin_inset Flex MenuItem
2712 \begin_layout Plain Layout
2719 \change_inserted -195340706 1363813075
2721 \begin_inset Flex MenuItem
2724 \begin_layout Plain Layout
2726 \change_inserted -195340706 1363813079
2733 \begin_inset Flex MenuItem
2736 \begin_layout Plain Layout
2738 \change_inserted -195340706 1363813082
2747 \begin_inset Flex MenuItem
2750 \begin_layout Plain Layout
2752 \change_inserted -195340706 1363813086
2754 \change_deleted -195340706 1363813086
2762 are defined, all of which share the extension
2763 \begin_inset Flex MenuItem
2766 \begin_layout Plain Layout
2772 , and which correspond to the conversion methods just mentioned.
2775 \begin_layout Chapter
2776 Internationalizing LyX
2777 \begin_inset CommandInset label
2779 name "cha:Internationalizing-LyX"
2786 \begin_layout Standard
2787 LyX supports using a translated interface.
2788 Last time we checked, LyX provided text in thirty languages.
2789 The language of choice is called your
2794 (For further reading on locale settings, see also the documentation for
2795 locale that comes with your operating system.
2796 For Linux, the manual page for
2797 \begin_inset Flex Code
2800 \begin_layout Plain Layout
2806 could be a good place to start).
2809 \begin_layout Standard
2810 Notice that these translations will work, but do contain a few flaws.
2811 In particular, all dialogs have been designed with the English text in
2812 mind, which means that some of the translated text will be too large to
2813 fit within the space allocated.
2814 This is only a display problem and will not cause any harm.
2815 Also, you will find that some of the translations do not define shortcut
2816 keys for everything.
2817 Sometimes, there are simply not enough free letters to do it.
2818 Other times, the translator just hasn't got around to doing it yet.
2819 Our localization team, which you may wish to join,
2823 \begin_layout Plain Layout
2824 If you are a fluent speaker of a language other than English, joining these
2825 teams is a great way to give back to the LyX community!
2830 will of course try to fix these shortcomings in future versions of LyX.
2833 \begin_layout Section
2837 \begin_layout Subsection
2838 Translating the graphical user interface (text messages).
2841 \begin_layout Standard
2843 \begin_inset Flex Code
2846 \begin_layout Plain Layout
2852 library to handle the internationalization of the interface.
2853 To have LyX speak your favorite language in all menus and dialogs, you
2855 \begin_inset Flex Code
2858 \begin_layout Plain Layout
2864 -file for that language.
2865 When this is available, you'll have to generate a
2866 \begin_inset Flex Code
2869 \begin_layout Plain Layout
2875 -file from it and install the
2876 \begin_inset Flex Code
2879 \begin_layout Plain Layout
2886 The process of doing all of this is explained in the documentation for
2888 \begin_inset Flex Code
2891 \begin_layout Plain Layout
2898 It is possible to do this just for yourself, but if you're going to do
2899 it, you might as well share the results of your labors with the rest of
2901 Send a message to the LyX developers' list for more information about how
2905 \begin_layout Standard
2906 In short, this is what you should do (xx denotes the language code):
2909 \begin_layout Itemize
2910 Check out the LyX source code.
2912 \begin_inset CommandInset href
2914 name "information on the web"
2915 target "http://www.lyx.org/HowToUseSVN"
2922 \begin_layout Itemize
2924 \begin_inset Flex Code
2927 \begin_layout Plain Layout
2933 to the folder of the
2934 \begin_inset Flex Code
2937 \begin_layout Plain Layout
2945 \begin_inset Flex Code
2948 \begin_layout Plain Layout
2956 \begin_inset Flex Code
2959 \begin_layout Plain Layout
2965 doesn't exist anywhere, it can be remade with the console command
2966 \begin_inset Flex Code
2969 \begin_layout Plain Layout
2975 in that directory, or you can use an existing po-file for some other language
2979 \begin_layout Itemize
2981 \begin_inset Flex Code
2984 \begin_layout Plain Layout
2994 \begin_layout Plain Layout
2995 This is just a text file, so it can be edited in any text editor.
2996 But there are also specialized programs that support such editing, such
3001 (for all platforms) or
3010 contains a `mode' for editing
3011 \begin_inset Flex Code
3014 \begin_layout Plain Layout
3025 For some menu- and widget-labels, there are also shortcut keys that should
3027 Those keys are marked after a `|', and should be translated according to
3028 the words and phrases of the language.
3029 You should also fill also out the information at the beginning of the new
3031 \begin_inset Flex Code
3034 \begin_layout Plain Layout
3040 -file with your email-address, etc., so people know where to reach you with
3041 suggestions and entertaining flames.
3044 \begin_layout Standard
3045 If you are just doing this on your own, then:
3048 \begin_layout Itemize
3050 \begin_inset Flex Code
3053 \begin_layout Plain Layout
3060 This can be done with
3061 \begin_inset Flex Code
3064 \begin_layout Plain Layout
3065 msgfmt -o xx.mo < xx.po
3073 \begin_layout Itemize
3075 \begin_inset Flex Code
3078 \begin_layout Plain Layout
3084 -file to your locale-tree, at the correct directory for application messages
3089 xx, and under the name
3090 \begin_inset Flex Code
3093 \begin_layout Plain Layout
3100 \begin_inset space \thinspace{}
3104 \begin_inset space \space{}
3108 \begin_inset Flex Code
3111 \begin_layout Plain Layout
3112 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3122 \begin_layout Standard
3123 As said, however, it would be best if the new
3124 \begin_inset Flex Code
3127 \begin_layout Plain Layout
3133 -file could be added to the LyX distribution, so others can use it.
3134 Adding it involves making additional changes to LyX.
3135 So send an email to the developers' mailing list if you're interested in
3139 \begin_layout Subsubsection
3143 \begin_layout Standard
3144 Sometimes it turns out that one English message needs to be translated into
3145 different messages in the target language.
3146 One example is the message
3147 \begin_inset Flex Code
3150 \begin_layout Plain Layout
3156 which has the German translation
3164 , depending upon exactly what the English
3165 \begin_inset Quotes eld
3169 \begin_inset Quotes erd
3174 \begin_inset Flex Code
3177 \begin_layout Plain Layout
3183 does not handle such ambiguous translations.
3184 Therefore you have to add some context information to the message: Instead
3186 \begin_inset Flex Code
3189 \begin_layout Plain Layout
3196 \begin_inset Flex Code
3199 \begin_layout Plain Layout
3200 To[[as in 'From format x to format y']]
3206 \begin_inset Flex Code
3209 \begin_layout Plain Layout
3210 To[[as in 'From page x to page y']].
3215 Now the two occurrences of
3216 \begin_inset Flex Code
3219 \begin_layout Plain Layout
3226 \begin_inset Flex Code
3229 \begin_layout Plain Layout
3235 and can be translated correctly to
3246 \begin_layout Standard
3247 Of course the context information needs to be stripped off the original
3248 message when no translation is used.
3249 Therefore you have to put it in double square brackets at the end of the
3250 message (see the example above).
3251 The translation mechanism of LyX ensures that everything in double square
3252 brackets at the end of messages is removed before displaying the message.
3255 \begin_layout Subsection
3256 Translating the documentation.
3259 \begin_layout Standard
3260 The online documentation (in the
3261 \begin_inset Flex MenuItem
3264 \begin_layout Plain Layout
3270 -menu) can (and should!) be translated.
3271 If there are translated versions of the documentation available
3275 \begin_layout Plain Layout
3276 As of March 2008, at least some of the documents have been translated into
3277 fourteen languages, with the Tutorial available in a few more.
3282 and the locale is set accordingly, these will be used automagically by
3284 LyX looks for translated versions as
3285 \begin_inset Flex Code
3288 \begin_layout Plain Layout
3289 LyXDir/doc/xx/DocName.lyx
3295 \begin_inset Flex Code
3298 \begin_layout Plain Layout
3304 is the code for the language currently in use.
3305 If there are no translated documents, the default English versions will
3307 Note that the translated versions must have the same filenames (
3308 \begin_inset Flex Code
3311 \begin_layout Plain Layout
3317 above) as the original.
3318 If you feel up to translating the documentation (an excellent way to proof-read
3319 the original documentation by the way!), there are a few things you should
3323 \begin_layout Itemize
3324 Check out the documentation translation web page at
3325 \begin_inset CommandInset href
3327 name "http://www.lyx.org/Translation"
3328 target "http://www.lyx.org/Translation"
3333 That way, you can find out which (if any) documents have already been translate
3334 d into your language.
3335 You can also find out who (if anyone) is organizing the effort to translate
3336 the documentation into your language.
3337 If no one is organizing the effort, please let us know that you're interested.
3340 \begin_layout Standard
3341 Once you get to actually translating, here's a few hints for you that may
3345 \begin_layout Itemize
3346 Join the documentation team! There is information on how to do that in
3347 \begin_inset Flex Code
3350 \begin_layout Plain Layout
3357 \begin_inset Flex MenuItem
3360 \begin_layout Plain Layout
3361 Help\SpecialChar \menuseparator
3367 ), which by the way is the first document you should translate.
3370 \begin_layout Itemize
3371 Learn the typographic conventions for the language you are translating to.
3372 Typography is an ancient art and over the centuries, a great variety of
3373 conventions have developed throughout different parts of the world.
3374 Also study the professional terminology amongst typographers in your country.
3375 Inventing your own terminology will only confuse the users.
3378 (Warning! Typography is addictive!)
3381 \begin_layout Itemize
3382 Make a copy of the document.
3383 This will be your working copy.
3384 You can use this as your personal translated help-file by placing it in
3386 \begin_inset Flex Code
3389 \begin_layout Plain Layout
3398 \begin_layout Itemize
3399 Sometimes the original document (from the LyX-team) will be updated.
3400 Use the source viewer at
3401 \begin_inset CommandInset href
3403 name "http://www.lyx.org/trac/timeline"
3404 target "http://www.lyx.org/trac/timeline"
3408 to see what has been changed.
3409 That way you can easily see which parts of the translated document need
3413 \begin_layout Standard
3414 If you ever find an error in the original document, fix it and notify the
3415 rest of the documentation team of the changes! (You didn't forget to join
3416 the documentation team, did you?)
3419 \begin_layout Standard
3420 \begin_inset Branch OutDated
3423 \begin_layout Section
3424 International Keyboard Support
3427 \begin_layout Standard
3430 [Editor's Note: The following section is by
3438 It needs to be fixed to conform to the new Documentation Style sheet and
3439 to make use of the new v1.0 features.
3440 The whole thing also needs to be merged with the section following it.-jw
3441 It may also be badly out of date.-rh (2008)]
3444 \begin_layout Subsection
3445 Defining Own Keymaps: Keymap File Format
3448 \begin_layout Standard
3449 Let's look at a keyboard definition file a little closer.
3450 It is a plain text file defining
3453 \begin_layout Itemize
3454 key-to-key or key-to-string translations
3457 \begin_layout Itemize
3461 \begin_layout Itemize
3462 dead keys exceptions
3465 \begin_layout Standard
3466 To define key-to-key or key-to-string translation, use this command:
3469 \begin_layout Quotation
3470 \begin_inset Flex Code
3473 \begin_layout Plain Layout
3482 \begin_inset Flex Code
3485 \begin_layout Plain Layout
3494 \begin_layout Standard
3496 \begin_inset Flex Code
3499 \begin_layout Plain Layout
3505 is the key to be translated and
3506 \begin_inset Flex Code
3509 \begin_layout Plain Layout
3515 is the string to be inserted into the document.
3516 To define dead keys, use:
3519 \begin_layout Quotation
3520 \begin_inset Flex Code
3523 \begin_layout Plain Layout
3532 \begin_inset Flex Code
3535 \begin_layout Plain Layout
3544 \begin_layout Standard
3546 \begin_inset Flex Code
3549 \begin_layout Plain Layout
3555 is a keyboard key and
3556 \begin_inset Flex Code
3559 \begin_layout Plain Layout
3566 The following dead keys are supported (shortcut name is in parentheses):
3569 \begin_layout Quotation
3573 \begin_inset space \hfill{}
3579 \begin_layout Quotation
3581 \begin_inset space \hfill{}
3587 \begin_layout Quotation
3589 \begin_inset space \hfill{}
3595 \begin_layout Quotation
3597 \begin_inset space \hfill{}
3603 \begin_layout Quotation
3605 \begin_inset space \hfill{}
3611 \begin_layout Quotation
3613 \begin_inset space \hfill{}
3620 \begin_layout Plain Layout
3632 \begin_layout Quotation
3634 \begin_inset space \hfill{}
3640 \begin_layout Quotation
3642 \begin_inset space \hfill{}
3649 \begin_layout Plain Layout
3661 \begin_layout Quotation
3663 \begin_inset space \hfill{}
3669 \begin_layout Quotation
3671 \begin_inset space \hfill{}
3677 \begin_layout Quotation
3679 \begin_inset space \hfill{}
3686 \begin_layout Plain Layout
3698 \begin_layout Quotation
3700 \begin_inset space \hfill{}
3707 \begin_layout Plain Layout
3719 \begin_layout Quotation
3721 \begin_inset space \hfill{}
3727 \begin_layout Quotation
3728 hungarian umlaut (hug)
3729 \begin_inset space \hfill{}
3735 \begin_layout Quotation
3737 \begin_inset space \hfill{}
3743 \begin_layout Quotation
3745 \begin_inset space \hfill{}
3752 \begin_layout Plain Layout
3764 \begin_layout Standard
3765 Since in many international keyboards there are exceptions to what some
3766 dead keys should do, you can define them using
3769 \begin_layout Quotation
3770 \begin_inset Flex Code
3773 \begin_layout Plain Layout
3781 deadkey key outstring
3784 \begin_layout Standard
3785 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
3789 \begin_layout Quotation
3790 \begin_inset Flex Code
3793 \begin_layout Plain Layout
3806 \begin_layout Standard
3807 to make it work correctly.
3808 Also, you have to define as exceptions dead keys over i and j, to remove
3809 the dot from them before inserting an accent mark.
3810 I will change this when the time comes, but so far I haven't had time.
3813 \begin_layout Standard
3814 Oh, and about characters: backslash is escaped, so to enter it, you'll need
3817 \begin_inset Flex Code
3820 \begin_layout Plain Layout
3826 have different meaning.
3828 \begin_inset Flex Code
3831 \begin_layout Plain Layout
3837 marks comments, quotes start and end LaTeX-style commands.
3838 To enter quote, you'll need to use
3839 \begin_inset Flex Code
3842 \begin_layout Plain Layout
3851 \begin_inset Flex Code
3854 \begin_layout Plain Layout
3861 \begin_inset Flex Code
3864 \begin_layout Plain Layout
3875 \begin_layout Standard
3876 If you make a keyboard description file that works for your language, please
3877 mail it to me, so I can include it in the next keymap distribution.
3880 \begin_layout Standard
3881 More keywords will be supported in keymap configuration file in future,
3885 \begin_layout Itemize
3886 \begin_inset Flex Code
3889 \begin_layout Plain Layout
3900 \begin_inset space \hfill{}
3904 \begin_inset Flex Code
3907 \begin_layout Plain Layout
3916 \begin_layout Itemize
3917 \begin_inset Flex Code
3920 \begin_layout Plain Layout
3931 \begin_inset space \hfill{}
3935 \begin_inset Flex Code
3938 \begin_layout Plain Layout
3944 an external keymap translation program
3947 \begin_layout Standard
3948 Also, it should look into
3949 \begin_inset Flex Code
3952 \begin_layout Plain Layout
3958 file for defaults, too (for example, a
3959 \begin_inset Flex Code
3962 \begin_layout Plain Layout
3970 option to include default keyboard).
3978 \begin_layout Section
3979 International Keymap Stuff
3980 \begin_inset CommandInset label
3982 name "sec:International-Keymap-Stuff"
3989 \begin_layout Standard
3990 \begin_inset Note Note
3993 \begin_layout Plain Layout
3994 In doing the revisions on this document in March 2008, I did not look over
3995 this stuff, as I do not understand it.
3996 It would be good if someone else could do so.
4005 \begin_layout Standard
4006 The next two sections describe the
4007 \begin_inset Flex Code
4010 \begin_layout Plain Layout
4019 \begin_inset Flex Code
4022 \begin_layout Plain Layout
4030 file syntax in detail.
4031 These sections should help you design your own key map if the ones provided
4032 do not meet your needs.
4035 \begin_layout Subsection
4039 \begin_layout Standard
4043 \begin_inset Flex Code
4046 \begin_layout Plain Layout
4052 file maps keystrokes to characters or strings.
4053 As the name suggests, it sets a keyboard mapping.
4055 \begin_inset Flex Code
4058 \begin_layout Plain Layout
4069 \begin_inset Flex Code
4072 \begin_layout Plain Layout
4087 \begin_inset Flex Code
4090 \begin_layout Plain Layout
4103 \begin_inset Flex Code
4106 \begin_layout Plain Layout
4115 \begin_inset Flex Code
4118 \begin_layout Plain Layout
4126 are described in this section.
4129 \begin_layout Labeling
4130 \labelwidthstring 00.00.0000
4131 \begin_inset Flex Code
4134 \begin_layout Plain Layout
4142 Map a character to a string
4145 \begin_layout LyX-Code
4160 \begin_layout Standard
4193 the double-quote (")
4210 must be escaped with a preceding backslash (
4221 \begin_layout Standard
4223 \begin_inset Flex MenuItem
4226 \begin_layout Plain Layout
4234 statement to cause the symbol
4235 \begin_inset Flex MenuItem
4238 \begin_layout Plain Layout
4246 to be output for the keystroke
4247 \begin_inset Flex MenuItem
4250 \begin_layout Plain Layout
4261 \begin_layout LyX-Code
4267 \begin_layout Labeling
4268 \labelwidthstring 00.00.0000
4269 \begin_inset Flex Code
4272 \begin_layout Plain Layout
4280 Specify an accent character
4283 \begin_layout LyX-Code
4292 \begin_layout Standard
4293 This will make the cha
4331 This is the dead key
4335 \begin_layout Plain Layout
4342 refers to a key that does not produce a character by itself, but when followed
4343 with another key, produces the desired accent character.
4344 For example, a German characte
4346 r with an umlaut like
4356 can be produced in this manner.
4365 \begin_layout Standard
4378 and then another key not in
4395 followed by the other, not allowed key, as output.
4399 \begin_inset Flex MenuItem
4402 \begin_layout Plain Layout
4410 cancels a dead key, so if
4421 \begin_inset Flex MenuItem
4424 \begin_layout Plain Layout
4433 , the cursor will not go one position backwards but will instead cancel
4449 might have had on the next keystroke.
4453 \begin_layout Standard
4454 The following example specifies that the character ' is to be an acute accent,
4455 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4458 \begin_layout LyX-Code
4461 kmod ' acute aeiouAEIOU
4464 \begin_layout Labeling
4465 \labelwidthstring 00.00.0000
4466 \begin_inset Flex Code
4469 \begin_layout Plain Layout
4475 Specify an exception to the accent character
4478 \begin_layout LyX-Code
4487 \begin_layout Standard
4488 This defines an exce
4529 have been assigned a keystroke with a previous
4532 \begin_inset Flex Code
4535 \begin_layout Plain Layout
4559 must not belong in the
4606 If such a declaration does not exist in
4614 \begin_inset Flex Code
4617 \begin_layout Plain Layout
4651 \begin_inset Flex Code
4654 \begin_layout Plain Layout
4668 \begin_layout Standard
4669 The following command produces causes äi to be produced when you enter acute-i
4673 \begin_layout LyX-Code
4687 \begin_layout Labeling
4688 \labelwidthstring 00.00.0000
4689 \begin_inset Flex Code
4692 \begin_layout Plain Layout
4698 Combine two accent characters
4701 \begin_layout LyX-Code
4707 accent1 accent2 allowed
4710 \begin_layout Standard
4711 This one is getting pretty esoteric.
4712 It allows you to combine the effect
4768 \begin_inset Flex Code
4771 \begin_layout Plain Layout
4799 \begin_layout Standard
4800 Consider this example from the
4801 \begin_inset Flex Code
4804 \begin_layout Plain Layout
4815 \begin_layout LyX-Code
4818 kmod ; acute aeioyvhAEIOYVH
4822 kcomb acute umlaut iyIY
4825 \begin_layout Standard
4826 This allows you to press
4827 \begin_inset Flex MenuItem
4830 \begin_layout Plain Layout
4838 and get the effect of
4839 \begin_inset Flex Code
4842 \begin_layout Plain Layout
4861 in this case cancels the last dead key, so if you press
4862 \begin_inset Flex MenuItem
4865 \begin_layout Plain Layout
4874 \begin_inset Flex Code
4877 \begin_layout Plain Layout
4890 \begin_layout Subsection
4894 \begin_layout Standard
4896 \begin_inset Flex Code
4899 \begin_layout Plain Layout
4907 mapping is performed, a
4908 \begin_inset Flex Code
4911 \begin_layout Plain Layout
4921 file maps the strings that the symbols generate to characters in the current
4923 The LyX distribution currently includes at least the
4924 \begin_inset Flex Code
4927 \begin_layout Plain Layout
4936 \begin_inset Flex Code
4939 \begin_layout Plain Layout
4950 \begin_layout Standard
4952 \begin_inset Flex Code
4955 \begin_layout Plain Layout
4963 file is a sequence of declarations of the form
4966 \begin_layout LyX-Code
4979 \begin_layout Standard
4980 For example, in order to map
4981 \begin_inset Flex MenuItem
4984 \begin_layout Plain Layout
4994 to the corresponding character in the iso-8859-1 set (233), the following
4998 \begin_layout LyX-Code
5006 \begin_layout Standard
5008 \begin_inset Flex Code
5011 \begin_layout Plain Layout
5020 \begin_inset Flex Code
5023 \begin_layout Plain Layout
5041 the same character can apply to more than one string.
5043 \begin_inset Flex Code
5046 \begin_layout Plain Layout
5057 \begin_layout LyX-Code
5069 \begin_inset Newline newline
5085 \begin_layout Standard
5086 If LyX cannot find a mapping for the string produced by the keystroke or
5087 a deadkey sequence, it will check if it looks like an accented char and
5088 try to draw an accent over the character on screen.
5091 \begin_layout Subsection
5095 \begin_layout Standard
5096 There is a second way to add support for international characters through
5097 so-called dead-keys.
5098 A dead-key works in combination with a letter to produce an accented character.
5099 Here, we'll explain how to create a really simple dead-key to illustrate
5103 \begin_layout Standard
5104 Suppose you happen to need the circumflex character,
5105 \begin_inset Quotes eld
5109 \begin_inset Quotes erd
5114 \begin_inset Flex MenuItem
5117 \begin_layout Plain Layout
5124 \begin_inset space ~
5128 \begin_inset Flex MenuItem
5131 \begin_layout Plain Layout
5137 ] to the LyX command
5138 \begin_inset Flex Code
5141 \begin_layout Plain Layout
5148 \begin_inset Flex Code
5151 \begin_layout Plain Layout
5158 Now, whenever you type the
5159 \begin_inset Flex MenuItem
5162 \begin_layout Plain Layout
5168 -key followed by a letter, that letter will have a circumflex accent on
5170 For example, the sequence
5171 \begin_inset Quotes eld
5175 \begin_inset Flex MenuItem
5178 \begin_layout Plain Layout
5185 \begin_inset Quotes erd
5188 produces the letter:
5189 \begin_inset Quotes eld
5193 \begin_inset Quotes erd
5197 If you tried to type
5198 \begin_inset Quotes eld
5202 \begin_inset Flex MenuItem
5205 \begin_layout Plain Layout
5212 \begin_inset Quotes erd
5215 , however, LyX will complain with a beep, since a
5216 \begin_inset Quotes eld
5220 \begin_inset Flex MenuItem
5223 \begin_layout Plain Layout
5230 \begin_inset Quotes erd
5233 never takes a circumflex accent.
5235 \begin_inset Flex MenuItem
5238 \begin_layout Plain Layout
5244 after a dead-key produces the bare-accent.
5245 Please note this last point! If you bind a key to a dead-key, you'll need
5246 to rebind the character on that key to yet another key.
5248 \begin_inset Flex MenuItem
5251 \begin_layout Plain Layout
5257 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5260 \begin_layout Standard
5261 One common way to bind dead-keys is to use
5262 \begin_inset Flex MenuItem
5265 \begin_layout Plain Layout
5272 \begin_inset Flex MenuItem
5275 \begin_layout Plain Layout
5282 \begin_inset Flex MenuItem
5285 \begin_layout Plain Layout
5291 in combination with an accent, like
5292 \begin_inset Quotes eld
5296 \begin_inset Flex MenuItem
5299 \begin_layout Plain Layout
5306 \begin_inset Quotes erd
5310 \begin_inset Quotes eld
5314 \begin_inset Flex MenuItem
5317 \begin_layout Plain Layout
5324 \begin_inset Quotes erd
5328 \begin_inset Quotes eld
5332 \begin_inset Flex MenuItem
5335 \begin_layout Plain Layout
5342 \begin_inset Quotes erd
5346 Another way involves using
5347 \begin_inset Flex Code
5350 \begin_layout Plain Layout
5357 \begin_inset Flex Code
5360 \begin_layout Plain Layout
5366 to set up the special
5367 \begin_inset Flex Code
5370 \begin_layout Plain Layout
5378 \begin_inset Flex Code
5381 \begin_layout Plain Layout
5387 acts in some ways just like
5388 \begin_inset Flex MenuItem
5391 \begin_layout Plain Layout
5397 and permits you to bind keys to accented characters.
5398 You can also turn keys into dead-keys by binding them to something like
5400 \begin_inset Flex Code
5403 \begin_layout Plain Layout
5409 and then binding this symbolic key to the corresponding LyX command.
5413 \begin_layout Plain Layout
5418 : This is exactly what I do in my
5419 \begin_inset Flex Code
5422 \begin_layout Plain Layout
5429 \begin_inset Flex Code
5432 \begin_layout Plain Layout
5440 \begin_inset Flex MenuItem
5443 \begin_layout Plain Layout
5445 \begin_inset space ~
5454 \begin_inset Flex Code
5457 \begin_layout Plain Layout
5463 and a bunch of these
5464 \begin_inset Quotes eld
5468 \begin_inset Flex Code
5471 \begin_layout Plain Layout
5478 \begin_inset Quotes erd
5481 symbolic keys bound such things as
5482 \begin_inset Flex MenuItem
5485 \begin_layout Plain Layout
5487 \begin_inset space ~
5496 \begin_inset Flex MenuItem
5499 \begin_layout Plain Layout
5501 \begin_inset space ~
5510 This is how I produce my accented characters.
5515 You can make just about anything into the
5516 \begin_inset Flex Code
5519 \begin_layout Plain Layout
5526 \begin_inset Flex MenuItem
5529 \begin_layout Plain Layout
5535 keys, a spare function key, etc.
5536 As for the LyX commands that produce accents, check the entry for
5537 \begin_inset Flex Code
5540 \begin_layout Plain Layout
5551 You'll find the complete list there.
5554 \begin_layout Subsection
5555 Saving your Language Configuration
5558 \begin_layout Standard
5559 You can edit your preferences so that your desired language environment
5560 is automatically configured when LyX starts up, via the
5561 \begin_inset Flex MenuItem
5564 \begin_layout Plain Layout
5565 Edit\SpecialChar \menuseparator
5574 \begin_layout Chapter
5575 Installing New Document Classes, Layouts, and Templates
5576 \begin_inset CommandInset label
5578 name "cha:Installing-New-Document"
5583 \begin_inset Argument 1
5586 \begin_layout Plain Layout
5587 Installing New Document Classes
5595 \begin_layout Standard
5596 In this chapter, we describe the procedures for creating and installing
5597 new LyX layout and template files, as well as offer a refresher on correctly
5598 installing new LaTeX document classes.
5602 \begin_layout Standard
5603 First, let us a say a few words about how one ought to think about the relation
5604 between LyX and LaTeX.
5605 The thing to understand is that, in a certain sense, LyX doesn't know anything
5607 Indeed, from LyX's point of view, LaTeX is just one of several
5608 \begin_inset Quotes eld
5612 \begin_inset Quotes erd
5615 in which it is capable of producing output.
5616 Other such formats are DocBook, plaintext, and XHTML.
5617 LaTeX is, of course, a particularly important format, but very little of
5618 the information LyX has about LaTeX is actually contained in the program
5623 \begin_layout Plain Layout
5624 Some commands are sufficiently complex that they are
5625 \begin_inset Quotes eld
5629 \begin_inset Quotes erd
5633 But the developers generally regard this as a Bad Thing.
5638 Rather, that information, even for the standard classes like
5639 \begin_inset Flex Code
5642 \begin_layout Plain Layout
5648 , is contained in `layout files'.
5649 Similarly, LyX itself does not know much about DocBook or XHTML.
5650 What it knows is contained in layout files.
5653 \begin_layout Standard
5654 You can think of the layout file for a given document class as a translation
5655 manual between LyX constructs---paragraphs with their corresponding styles,
5656 certain sorts of insets, etc---and the corresponding LaTeX, DocBook, or
5658 Almost everything LyX knows about
5659 \begin_inset Flex Code
5662 \begin_layout Plain Layout
5668 , for example, is contained in the file
5669 \begin_inset Flex Code
5672 \begin_layout Plain Layout
5678 and in various other files it includes.
5679 For this reason, anyone intending to write layout files should plan to
5680 study the existing files.
5681 A good place to start is with
5682 \begin_inset Flex Code
5685 \begin_layout Plain Layout
5691 , which is included in
5692 \begin_inset Flex Code
5695 \begin_layout Plain Layout
5702 \begin_inset Flex Code
5705 \begin_layout Plain Layout
5711 , and many of the other layout files for document classes.
5712 This file is where sections and the like are defined:
5713 \begin_inset Flex Code
5716 \begin_layout Plain Layout
5722 tells LyX how paragraphs that are marked with the Section, Subsection,
5723 etc, styles can be translated into corresponding LaTeX, DocBook, and XHTML
5726 \begin_inset Flex Code
5729 \begin_layout Plain Layout
5735 file basically just includes several of these
5736 \begin_inset Flex Code
5739 \begin_layout Plain Layout
5748 \begin_layout Standard
5749 Defining the LyX--LaTeX correspondence is not the only thing layout files
5751 Their other job is to define how the LyX constructs themselves will appear
5753 The fact that layout files have these two jobs is often a source of confusion,
5754 because they are completely separate.
5755 Telling LyX how to translate a certain paragraph style into LaTeX does
5756 not tell LyX how to display it; conversely, telling LyX how to display
5757 a certain paragraph style does not tell LyX how to translate it into LaTeX
5758 (let alone tell LaTeX how to display it).
5759 So, in general, when you define a new LyX construct, you must always do
5760 two quite separate things: (i)
5761 \begin_inset space ~
5764 tell LyX how to translate it into LaTeX and (ii)
5765 \begin_inset space ~
5768 tell LyX how to display it.
5771 \begin_layout Standard
5772 Much the same is true, of course, as regards LyX's other backend formats,
5773 though XHTML is in some ways different, because in that case LyX
5777 able, to some extent, to use information about how it should display a
5778 paragraph on the screen to output information (in the form of CSS) about
5779 how the paragraph should be displayed in a browser.
5780 Even in this case, however, the distinction between what LyX does internally
5781 and how things are rendered externally remains in force, and the two can
5782 be controlled separately.
5784 \begin_inset CommandInset ref
5786 reference "sec:Tags-for-XHTML"
5793 \begin_layout Section
5794 Installing new LaTeX files
5797 \begin_layout Standard
5798 Some installations may not include a LaTeX package or class file that you
5799 would like to use within LyX.
5800 For example, you might need FoilTeX, a package for preparing slides for
5801 overhead projectors.
5802 Modern LaTeX distributions like TeXLive (2008 or newer) or MiKTeX provide
5803 a user interface for installing such packages.
5804 For example, with MiKTeX, you start the program
5805 \begin_inset Quotes eld
5809 \begin_inset space ~
5813 \begin_inset Quotes erd
5816 to get a list of available packages.
5817 To install one of them, right click on it or use the corresponding toolbar
5821 \begin_layout Standard
5822 If your LaTeX distribution does not provide such a `package manager', or
5823 if the package is not available from your distribution, then follow these
5824 steps to install it manually:
5827 \begin_layout Enumerate
5828 Get the package from
5829 \begin_inset CommandInset href
5832 target "http://www.ctan.org/"
5839 \begin_layout Enumerate
5840 If the package contains a file with the ending
5841 \begin_inset Quotes eld
5845 \begin_inset Flex Code
5848 \begin_layout Plain Layout
5855 \begin_inset Quotes erd
5858 (is the case for FoilTeX) then open a console, change to the folder of
5859 this file and execute the command
5860 \begin_inset Flex Code
5863 \begin_layout Plain Layout
5870 You have now unpacked the package and have all files to install it.
5871 Most LaTeX-packages are not packed and you can skip this step.
5874 \begin_layout Enumerate
5875 Now you need to decide if the package should be available for all users
5880 \begin_layout Enumerate
5881 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
5882 for all users on your system, then install it in your `local' TeX tree,
5883 otherwise install it in your own `user' TeX tree.
5884 Where these trees should be created, if they do not already exist, depends
5886 To find this out, look in the file
5887 \begin_inset Flex Code
5890 \begin_layout Plain Layout
5900 \begin_layout Plain Layout
5901 This is usually in the directory
5902 \begin_inset Flex Code
5905 \begin_layout Plain Layout
5911 , though you can execute the command
5912 \begin_inset Flex Code
5915 \begin_layout Plain Layout
5926 The location of the `local' TeX tree is defined by the
5927 \begin_inset Flex Code
5930 \begin_layout Plain Layout
5936 variable; this is usually somewhere like
5937 \begin_inset Flex Code
5940 \begin_layout Plain Layout
5941 /usr/local/share/texmf
5947 The location of the `user' TeX tree is defined by
5948 \begin_inset Flex Code
5951 \begin_layout Plain Layout
5958 \begin_inset Flex Code
5961 \begin_layout Plain Layout
5968 (If these variables are not predefined, you have to define them.) You'll
5969 probably need root permissions to create or modify the `local' tree, but
5970 not for your `user' tree.
5971 \begin_inset Newline newline
5974 In general, it is recommended to install in the user tree because your user
5975 will not be modified or even overwritten when you upgrade your system.
5976 It will typically also be backed up together with everything else when
5977 you backup your home directory (which, of course, you do on a regular basis).
5980 \begin_layout Enumerate
5981 On Windows, if you want the new package to be available for all users on
5982 your system, change to the folder where LaTeX is installed and then change
5984 \begin_inset Flex Code
5987 \begin_layout Plain Layout
5998 (For MiKTeX, this would be by default the folder
5999 \begin_inset Flex Code
6002 \begin_layout Plain Layout
6020 \begin_layout Plain Layout
6021 Note that this will be the correct path only on English installations.
6022 On a German one, it would be
6023 \begin_inset Flex Code
6026 \begin_layout Plain Layout
6040 , and similarly for other languages.
6045 Create there a new folder
6046 \begin_inset Flex Code
6049 \begin_layout Plain Layout
6055 and copy all files of the package into it.
6057 \begin_inset Newline newline
6060 If the package should only available for you or you don't have admin permissions
6061 , do the same, but in the local LaTeX folder.
6063 \begin_inset space \thinspace{}
6067 \begin_inset space ~
6070 2.8 under Windows XP, this would be the folder:
6071 \begin_inset Newline newline
6077 \begin_inset Flex Code
6080 \begin_layout Plain Layout
6083 Documents and Settings
6095 \begin_inset Newline newline
6101 \begin_inset Phantom HPhantom
6104 \begin_layout Plain Layout
6115 \begin_inset Flex Code
6118 \begin_layout Plain Layout
6131 \begin_inset Newline newline
6134 On Vista, it would be:
6135 \begin_inset Newline newline
6139 \begin_inset Flex Code
6142 \begin_layout Plain Layout
6168 \begin_layout Enumerate
6169 Now one only need to tell LaTeX that there are new files.
6170 This depends on the used LaTeX-Distribution:
6174 \begin_layout Enumerate
6175 For TeXLive execute the command
6176 \begin_inset Flex Code
6179 \begin_layout Plain Layout
6186 If you installed the package for all users, then you will probably need
6187 to have root permissions for that.
6190 \begin_layout Enumerate
6191 For MiKTeX, if you have installed the package for all users, start the program
6193 \begin_inset Quotes eld
6197 \begin_inset space ~
6201 \begin_inset Quotes erd
6204 and press the button marked
6205 \begin_inset Quotes eld
6209 \begin_inset Quotes erd
6213 Otherwise start the program
6214 \begin_inset Quotes eld
6218 \begin_inset Quotes erd
6225 \begin_layout Enumerate
6226 Finally, you need to tell LyX that there are new packages available.
6227 So, in LyX, use the menu
6228 \begin_inset Flex MenuItem
6231 \begin_layout Plain Layout
6234 \SpecialChar \menuseparator
6240 and then restart LyX.
6243 \begin_layout Standard
6244 Now the package is installed.
6245 In our example, the document class
6246 \begin_inset Flex Code
6249 \begin_layout Plain Layout
6251 \begin_inset space ~
6258 \begin_layout Plain Layout
6270 will now be available under
6271 \begin_inset Flex MenuItem
6274 \begin_layout Plain Layout
6275 Document\SpecialChar \menuseparator
6276 Settings\SpecialChar \menuseparator
6286 \begin_layout Standard
6287 If you would like to use a LaTeX document class that is not even listed
6289 \begin_inset Flex MenuItem
6292 \begin_layout Plain Layout
6293 Document\SpecialChar \menuseparator
6294 Settings\SpecialChar \menuseparator
6300 , then you need to create a `layout' file for it.
6301 That is the topic of the next section.
6304 \begin_layout Section
6305 Types of layout files
6308 \begin_layout Standard
6309 This section describes the various sorts of LyX files that contain layout
6311 These files describe various paragraph and character styles, determining
6312 how LyX should display them and how they should be translated into LaTeX,
6313 DocBook, XHTML, or whatever output format is being used.
6317 \begin_layout Standard
6318 We shall try to provide a thorough description of the process of writing
6320 However, there are so many different types of documents supported even
6321 by just LaTeX that we can't hope to cover every different possibility or
6322 problem you might encounter.
6323 The LyX users' list is frequented by people with lots of experience with
6324 layout design who are willing to share what they've learned, so please
6325 feel free to ask questions there.
6328 \begin_layout Standard
6329 As you prepare to write a new layout, it is extremely helpful to look at
6330 the layouts distributed with LyX.
6331 If you write a LyX layout for a LaTeX document class that might also be
6332 used by others, or write a module that might be useful to others, then
6333 you should consider posting your layout to the
6334 \begin_inset CommandInset href
6336 name "layout section on the LyX wiki"
6337 target "http://wiki.lyx.org/Layouts/Layouts"
6341 or even to the LyX developers' list, so that it might be included in LyX
6346 \begin_layout Plain Layout
6347 Note that LyX is licensed under the General Public License, so any material
6348 that is contributed to LyX must be similarly licensed.
6356 \begin_layout Subsection
6358 \begin_inset CommandInset label
6360 name "sub:Layout-modules"
6367 \begin_layout Standard
6368 We have spoken to this point about `layout files'.
6369 But there are different sorts of files that contain layout information.
6370 Layout files, strictly so called, have the
6371 \begin_inset Flex Code
6374 \begin_layout Plain Layout
6380 extension and provide LyX with information about document classes.
6381 As of LyX 1.6, however, layout information can also be contained in layout
6387 \begin_inset Flex Code
6390 \begin_layout Plain Layout
6397 Modules are to LaTeX packages much as layouts are to LaTeX classes, and
6398 some modules—such as the
6399 \begin_inset Flex Code
6402 \begin_layout Plain Layout
6408 module—specifically provide support for one package.
6409 In a sense, layout modules are similar to included
6413 \begin_layout Plain Layout
6414 These can have any extension, but by convention have the
6415 \begin_inset Flex Code
6418 \begin_layout Plain Layout
6430 \begin_inset Flex Code
6433 \begin_layout Plain Layout
6439 —in that modules are not specific to a given document class but may be used
6440 with many different classes.
6441 The difference is that using an included file with
6442 \begin_inset Flex Code
6445 \begin_layout Plain Layout
6451 requires editing that file.
6452 Modules, by contrast, are selected in the
6453 \begin_inset Flex MenuItem
6456 \begin_layout Plain Layout
6457 Document\SpecialChar \menuseparator
6466 \begin_layout Standard
6467 Building modules is the easiest way to get started with layout editing,
6468 since it can be as simple as adding a single new paragraph style or flex
6470 But modules may, in principle, contain anything a layout file can contain.
6473 \begin_layout Standard
6474 After creating a new module and copying it to the
6475 \begin_inset Flex Code
6478 \begin_layout Plain Layout
6484 folder, you will need to reconfigure and then restart LyX for the module
6485 to appear in the menu.
6486 However, changes you make to the module will be seen immediately, if you
6488 \begin_inset Flex MenuItem
6491 \begin_layout Plain Layout
6492 Document\SpecialChar \menuseparator
6498 , highlight something, and then hit
6499 \begin_inset Quotes eld
6503 \begin_inset Quotes erd
6509 It is strongly recommended that you save your work before doing this
6514 it is strongly recommended that you not attempt to edit modules while simultaneo
6515 usly working on actual documents
6518 Though of course the developers strive to keep LyX stable in such situations,
6519 syntax errors and the like in your module file could cause strange behavior.
6522 \begin_layout Subsubsection
6526 \begin_layout Standard
6527 Modules are to LyX as packages are to LaTeX.
6528 Sometimes, however, you find yourself wanting a specific inset or character
6529 style just for one document and writing a module that will also be available
6530 to other documents makes little sense.
6531 What you need is LyX's
6532 \begin_inset Quotes eld
6536 \begin_inset Quotes erd
6542 \begin_layout Standard
6543 You will find it under
6545 Document\SpecialChar \menuseparator
6546 Settings\SpecialChar \menuseparator
6550 The large text box allows you to enter anything that you might enter in
6551 a layout file or module.
6552 You can think of a document's local layout, in fact, as a module that belongs
6554 So, in particular, you must enter a
6555 \begin_inset Flex Code
6558 \begin_layout Plain Layout
6565 Any format is acceptable, but one would normally use the format current
6567 (In LyX 2.0, the current layout format is 35.) You should be aware that local
6568 layout is not supported by versions of LyX prior to 1.6, so you should not
6569 use it if you want to be able to export your document to LyX 1.5 or earlier
6570 (without, that is, losing the local layout information).
6571 If you wish to be able to export to 1.6---local layout is supported in 1.6,
6572 though there is no UI for it---then you should use format 11 and, of course,
6573 use only layout constructs that were available in LyX 1.6.
6576 \begin_layout Standard
6577 When you have entered something in the
6578 \begin_inset Flex Code
6581 \begin_layout Plain Layout
6587 pane, LyX will enable the
6588 \begin_inset Quotes eld
6592 \begin_inset Quotes erd
6595 button at the bottom.
6596 Clicking this button will cause LyX to determine whether what you have
6597 entered is valid layout information for the chosen format.
6598 LyX will report the result but, unfortunately, will not tell you what errors
6599 there might have been.
6600 These will be written to the terminal, however, if LyX is started from
6602 You will not be permitted to save your local layout until you have entered
6606 \begin_layout Standard
6607 The warnings at the end of the previous section apply here, too.
6608 Do not play with local layout while you are actually working, especially
6609 if you have not saved your document.
6610 That said, using local layout with a test document can be a very convenient
6611 way to try out layout ideas, or even to start developing a module.
6614 \begin_layout Subsection
6616 \begin_inset Flex MenuItem
6619 \begin_layout Plain Layout
6628 \begin_layout Standard
6629 There are two situations you are likely to encounter when wanting to support
6630 a new LaTeX document class, involving style (
6631 \begin_inset Flex Code
6634 \begin_layout Plain Layout
6640 ) files and LaTeX2e class (
6641 \begin_inset Flex Code
6644 \begin_layout Plain Layout
6651 Supporting a style file is usually fairly easy.
6652 Supporting a new class file is a bit harder.
6653 We'll discuss the former in this section and the latter in the next.
6654 Similar remarks apply, of course, if you want to support a new DocBook
6658 \begin_layout Standard
6659 The easier case is the one in which your new document class is provided
6660 as a style file that is to be used in conjunction with an already supported
6662 For the sake of the example, we'll assume that the style file is called
6664 \begin_inset Flex MenuItem
6667 \begin_layout Plain Layout
6673 and that it is meant to be used with
6674 \begin_inset Flex MenuItem
6677 \begin_layout Plain Layout
6683 , which is a standard class.
6687 \begin_layout Standard
6688 Start by copying the existing class's layout file into your local directory:
6692 \begin_layout Plain Layout
6693 Of course, which directory is your local directory will vary by platform,
6694 and LyX allows you to specify your local directory on startup, too, using
6696 \begin_inset Flex Code
6699 \begin_layout Plain Layout
6713 \begin_layout LyX-Code
6714 cp report.layout ~/.lyx/layouts/myclass.layout
6717 \begin_layout Standard
6719 \begin_inset Flex Code
6722 \begin_layout Plain Layout
6728 and change the line:
6731 \begin_layout LyX-Code
6734 DeclareLaTeXClass{report}
6737 \begin_layout Standard
6741 \begin_layout LyX-Code
6744 DeclareLaTeXClass[report, myclass.sty]{report (myclass)}
6747 \begin_layout Standard
6751 \begin_layout LyX-Code
6753 \begin_inset Newline newline
6759 \begin_inset Newline newline
6765 \begin_layout Standard
6766 near the top of the file.
6769 \begin_layout Standard
6770 Start LyX and select
6771 \begin_inset Flex MenuItem
6774 \begin_layout Plain Layout
6775 Tools\SpecialChar \menuseparator
6782 Then restart LyX and try creating a new document.
6784 \begin_inset Flex MenuItem
6787 \begin_layout Plain Layout
6793 " as a document class option in the
6794 \begin_inset Flex MenuItem
6797 \begin_layout Plain Layout
6798 Document\SpecialChar \menuseparator
6805 It is likely that some of the sectioning commands and such in your new
6806 class will work differently from how they worked in the base class—
6807 \begin_inset Flex Code
6810 \begin_layout Plain Layout
6816 in this example—so you can fiddle around with the settings for the different
6817 sections if you wish.
6818 The layout information for sections is contained in
6819 \begin_inset Flex Code
6822 \begin_layout Plain Layout
6828 , but you do not need to copy and change this file.
6829 Instead, you can simply add your changes to your layout file, after the
6831 \begin_inset Flex Code
6834 \begin_layout Plain Layout
6840 , which itself includes
6841 \begin_inset Flex Code
6844 \begin_layout Plain Layout
6851 For example, you might add these lines:
6854 \begin_layout LyX-Code
6858 \begin_layout LyX-Code
6862 \begin_layout LyX-Code
6866 \begin_layout LyX-Code
6870 \begin_layout LyX-Code
6874 \begin_layout Standard
6875 to change the font for chapter headings to sans-serif.
6876 This will override (or, in this case, add to) the existing declaration
6877 for the Chapter style.
6881 \begin_layout Standard
6882 Your new package may also provide commands or environments not present in
6884 In this case, you will want to add these to the layout file.
6886 \begin_inset space ~
6890 \begin_inset CommandInset ref
6892 reference "sec:TextClass"
6896 for information on how to do so.
6899 \begin_layout Standard
6901 \begin_inset Flex MenuItem
6904 \begin_layout Plain Layout
6910 can be used with several different document classes, and even if it cannot,
6911 you might find it easiest just to write a module that you can load with
6913 The simplest possible such module would be:
6916 \begin_layout LyX-Code
6919 DeclareLyXModule{My Package}
6922 \begin_layout LyX-Code
6926 \begin_layout LyX-Code
6927 #Support for mypkg.sty.
6930 \begin_layout LyX-Code
6932 \begin_inset Newline newline
6938 \begin_layout LyX-Code
6940 \begin_inset Newline newline
6946 \begin_layout LyX-Code
6948 \begin_inset Newline newline
6954 \begin_inset Newline newline
6960 \begin_layout Standard
6961 A more complex module might modify the behavior of some existing constructs
6962 or define some new ones.
6964 \begin_inset space ~
6968 \begin_inset CommandInset ref
6970 reference "sec:TextClass"
6977 \begin_layout Subsection
6979 \begin_inset Flex MenuItem
6982 \begin_layout Plain Layout
6991 \begin_layout Standard
6992 There are two possibilities here.
6993 One is that the class file is itself based upon an existing document class.
6994 For example, many thesis classes are based upon
6995 \begin_inset Flex MenuItem
6998 \begin_layout Plain Layout
7005 To see whether yours is, look for a line like
7008 \begin_layout LyX-Code
7014 \begin_layout Standard
7016 If so, then you may proceed largely as in the previous section, though
7018 \begin_inset Flex Code
7021 \begin_layout Plain Layout
7027 line will be different.
7028 If your new class is
7029 \begin_inset Flex Code
7032 \begin_layout Plain Layout
7038 and it is based upon
7039 \begin_inset Flex Code
7042 \begin_layout Plain Layout
7048 , then the line should read:
7052 \begin_layout Plain Layout
7053 And it will be easiest if you save the file to
7054 \begin_inset Flex Code
7057 \begin_layout Plain Layout
7063 : LyX assumes that the document class has the same name as the layout file.
7072 \begin_layout LyX-Code
7075 DeclareLaTeXClass[thesis,book]{thesis}
7078 \begin_layout Standard
7079 If, on the other hand, the new class is not based upon an existing class,
7080 you will probably have to
7081 \begin_inset Quotes eld
7085 \begin_inset Quotes erd
7089 We strongly suggest copying an existing layout file which uses a similar
7090 LaTeX class and then modifying it, if you can do so.
7091 At least use an existing file as a starting point so you can find out what
7092 items you need to worry about.
7093 Again, the specifics are covered below.
7096 \begin_layout Subsection
7098 \begin_inset CommandInset label
7100 name "sub:Creating-Templates"
7107 \begin_layout Standard
7108 Once you have written a layout file for a new document class, you might
7109 want to consider writing a
7114 A template acts as a kind of tutorial for your layout, showing how it might
7115 be used, though containing dummy content.
7116 You can of course look at the various templates included with LyX for ideas.
7119 \begin_layout Standard
7120 Templates are created just like usual documents: using LyX.
7121 The only difference is that usual documents contain all possible settings,
7122 including the font scheme and the paper size.
7123 Usually a user doesn't want a template to overwrite his preferred settings
7124 for such parameters.
7125 For that reason, the designer of a template should remove the corresponding
7127 \begin_inset Flex Code
7130 \begin_layout Plain Layout
7139 \begin_inset Flex Code
7142 \begin_layout Plain Layout
7150 from the template LyX file.
7151 This can be done with any simple text-editor, for example
7152 \begin_inset Flex Code
7155 \begin_layout Plain Layout
7162 \begin_inset Flex Code
7165 \begin_layout Plain Layout
7174 \begin_layout Standard
7175 Put the edited template files you create in
7176 \begin_inset Flex Code
7179 \begin_layout Plain Layout
7185 , copy the ones you use from the global template directory in
7186 \begin_inset Flex Code
7189 \begin_layout Plain Layout
7195 to the same place, and redefine the template path in the
7196 \begin_inset Flex MenuItem
7199 \begin_layout Plain Layout
7200 Tools\SpecialChar \menuseparator
7201 Preferences\SpecialChar \menuseparator
7210 \begin_layout Standard
7211 Note, by the way, that there is a template which has a particular meaning:
7213 \begin_inset Flex Code
7216 \begin_layout Plain Layout
7223 This template is loaded every time you create a new document with
7224 \begin_inset Flex MenuItem
7227 \begin_layout Plain Layout
7228 File\SpecialChar \menuseparator
7234 in order to provide useful defaults.
7235 To create this template from inside LyX, all you have to do is to open
7236 a document with the correct settings, and use the
7237 \begin_inset Flex MenuItem
7240 \begin_layout Plain Layout
7241 Save as Document Defaults
7249 \begin_layout Subsection
7250 Upgrading old layout files
7253 \begin_layout Standard
7254 The format of layout files changes with each LyX release, so old layout
7255 files need to be converted to the new format.
7256 If LyX reads a layout file in an older format, it automatically calls the
7258 \begin_inset Flex Code
7261 \begin_layout Plain Layout
7267 to convert it to a temporary file in current format.
7268 The original file is left untouched.
7269 If you use the layout file often, then, you may want to convert it permanently,
7270 so that LyX does not have to do so itself every time.
7271 To do this, you can call the converter manually:
7274 \begin_layout Enumerate
7276 \begin_inset Flex Code
7279 \begin_layout Plain Layout
7286 \begin_inset Flex Code
7289 \begin_layout Plain Layout
7298 \begin_layout Enumerate
7300 \begin_inset Newline newline
7304 \begin_inset Flex Code
7307 \begin_layout Plain Layout
7308 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7314 \begin_inset Newline newline
7318 \begin_inset Flex Code
7321 \begin_layout Plain Layout
7327 is the name of your LyX system directory.
7330 \begin_layout Standard
7331 Note that manual conversion does not affect included files, so these will
7332 have to be converted separately.
7335 \begin_layout Section
7336 \begin_inset CommandInset label
7338 name "sec:TextClass"
7342 The layout file format
7345 \begin_layout Standard
7346 The following sections describe how layout files are structured and written.
7347 Our advice is to go slowly, save and test often.
7348 It is really not that hard, except that the multitude of options can become
7349 overwhelming, especially if you try to check out too many at once.
7350 It becomes easier if you use existing layouts of LyX as examples/reference
7351 or if you modify an existing layout to your needs.
7354 \begin_layout Standard
7355 Note that all the tags used in layout files are case-insensitive.
7357 \begin_inset Flex Code
7360 \begin_layout Plain Layout
7367 \begin_inset Flex Code
7370 \begin_layout Plain Layout
7377 \begin_inset Flex Code
7380 \begin_layout Plain Layout
7386 are really the same tag.
7387 The possible arguments are printed in brackets after the tag's name.
7388 The default argument is typeset
7389 \begin_inset Flex Code
7392 \begin_layout Plain Layout
7401 If the argument has a data type like
7402 \begin_inset Quotes eld
7406 \begin_inset Quotes erd
7410 \begin_inset Quotes eld
7414 \begin_inset Quotes erd
7417 , the default is shown like this:
7418 \begin_inset Flex Code
7421 \begin_layout Plain Layout
7432 \begin_layout Subsection
7433 The document class declaration
7434 \change_inserted -712698321 1349766602
7440 \begin_layout Standard
7441 Lines in a layout file which begin with
7442 \begin_inset Flex Code
7445 \begin_layout Plain Layout
7452 There is one exception to this rule.
7454 \begin_inset Flex Code
7457 \begin_layout Plain Layout
7463 files should begin with
7464 \change_deleted -712698321 1349766533
7468 \change_inserted -712698321 1349766536
7474 \begin_layout LyX-Code
7477 #% Do not delete the line below; configure depends on this
7480 \begin_layout LyX-Code
7486 \change_deleted -712698321 1349766193
7488 \change_inserted -712698321 1349766201
7489 Article (Standard Class)
7492 \change_inserted -712698321 1349766538
7496 \begin_layout LyX-Code
7498 \change_inserted -712698321 1349766581
7503 DeclareCategory{Articles}
7508 \begin_layout Standard
7510 \change_inserted -712698321 1349766695
7514 \change_inserted -712698321 1349766626
7518 \change_deleted -712698321 1349766628
7520 \change_inserted -712698321 1349766628
7523 used when you (re)configure LyX.
7524 The layout file is read by the LaTeX script
7525 \begin_inset Flex Code
7528 \begin_layout Plain Layout
7534 , in a special mode where
7535 \begin_inset Flex Code
7538 \begin_layout Plain Layout
7545 The first line is just a LaTeX comment,
7546 \change_deleted -712698321 1349766656
7549 the second one contains the
7550 \change_inserted -712698321 1349766650
7553 declaration of the text class
7554 \change_inserted -712698321 1349766689
7555 , and the third line contains the optional classification of the class
7558 If these lines appear in a file named
7559 \begin_inset Flex Code
7562 \begin_layout Plain Layout
7568 , then they define a text class of name
7569 \begin_inset Flex Code
7572 \begin_layout Plain Layout
7578 (the name of the layout file) which uses the LaTeX document class
7579 \begin_inset Flex Code
7582 \begin_layout Plain Layout
7588 (the default is to use the same name as the layout).
7590 \begin_inset Quotes eld
7594 \change_deleted -712698321 1349766253
7596 \change_inserted -712698321 1349766260
7597 Article (Standard Class)
7600 \begin_inset Quotes erd
7603 that appears above is used as a description of the text class in the
7604 \begin_inset Flex MenuItem
7607 \begin_layout Plain Layout
7608 Document\SpecialChar \menuseparator
7616 \change_inserted -712698321 1349767097
7618 \begin_inset Quotes eld
7622 \begin_inset Quotes erd
7625 in the example) is also used in the
7626 \begin_inset Flex MenuItem
7629 \begin_layout Plain Layout
7631 \change_inserted -712698321 1349766801
7632 Document\SpecialChar \menuseparator
7638 dialog: the text classes are grouped by these categories (which are usually
7639 genres, so typical categories are
7640 \begin_inset Quotes eld
7644 \begin_inset Quotes erd
7648 \begin_inset Quotes eld
7652 \begin_inset Quotes erd
7656 \begin_inset Quotes eld
7660 \begin_inset Quotes erd
7664 \begin_inset Quotes eld
7668 \begin_inset Quotes erd
7672 \begin_inset Quotes eld
7676 \begin_inset Quotes erd
7680 \begin_inset Quotes eld
7684 \begin_inset Quotes erd
7688 If no category has been declared, the class will be put in the
7689 \begin_inset Quotes eld
7693 \begin_inset Quotes erd
7701 \begin_layout Standard
7702 Let's assume that you wrote your own text class that uses the
7703 \begin_inset Flex Code
7706 \begin_layout Plain Layout
7712 document class, but where you changed the appearance of the section headings.
7713 If you put it in a file
7714 \begin_inset Flex Code
7717 \begin_layout Plain Layout
7723 , the header of this file should be:
7726 \begin_layout LyX-Code
7729 #% Do not delete the line below; configure depends on this
7732 \begin_layout LyX-Code
7737 DeclareLaTeXClass[article]{
7738 \change_deleted -712698321 1349766303
7740 \change_inserted -712698321 1349766303
7744 \change_deleted -712698321 1349766338
7746 \change_inserted -712698321 1349766338
7750 \change_deleted -712698321 1349766340
7752 \change_inserted -712698321 1349766340
7756 \change_deleted -712698321 1349766343
7758 \change_inserted -712698321 1349766343
7762 \change_inserted -712698321 1349767223
7766 \begin_layout LyX-Code
7768 \change_inserted -712698321 1349767223
7773 DeclareCategory{Articles}
7778 \begin_layout Standard
7779 This declares a text class
7780 \begin_inset Flex Code
7783 \begin_layout Plain Layout
7789 , associated with the LaTeX document class
7790 \begin_inset Flex Code
7793 \begin_layout Plain Layout
7800 \begin_inset Quotes eld
7804 \change_deleted -712698321 1349766329
7806 \change_inserted -712698321 1349766329
7810 \change_deleted -712698321 1349766347
7812 \change_inserted -712698321 1349766347
7816 \change_deleted -712698321 1349766350
7818 \change_inserted -712698321 1349766350
7822 \change_deleted -712698321 1349766352
7824 \change_inserted -712698321 1349766352
7828 \begin_inset Quotes erd
7832 If your text class depends on several packages, you can declare it as:
7835 \begin_layout LyX-Code
7838 #% Do not delete the line below; configure depends on this
7841 \begin_layout LyX-Code
7846 DeclareLaTeXClass[article,foo.sty]{
7847 \change_deleted -712698321 1349766366
7849 \change_inserted -712698321 1349766366
7853 \change_deleted -712698321 1349766369
7855 \change_inserted -712698321 1349766369
7859 \change_deleted -712698321 1349766371
7861 \change_inserted -712698321 1349766371
7865 \change_deleted -712698321 1349766374
7867 \change_inserted -712698321 1349766374
7871 \change_inserted -712698321 1349767240
7875 \begin_layout LyX-Code
7877 \change_inserted -712698321 1349767240
7882 DeclareCategory{Articles}
7887 \begin_layout Standard
7888 This indicates that your text class uses the
7889 \begin_inset Flex Code
7892 \begin_layout Plain Layout
7899 Finally, it is also possible to declare classes for DocBook code.
7900 Typical declarations will look like:
7903 \begin_layout LyX-Code
7906 #% Do not delete the line below; configure depends on this
7909 \begin_layout LyX-Code
7914 DeclareDocBookClass[article]{SGML (DocBook
7915 \change_deleted -712698321 1349766387
7917 \change_inserted -712698321 1349766387
7921 \change_inserted -712698321 1349767247
7925 \begin_layout LyX-Code
7927 \change_inserted -712698321 1349767302
7932 DeclareCategory{Articles (DocBook)}
7937 \begin_layout Standard
7938 Note that these declarations can also be given an optional parameter declaring
7939 the name of the document class (but not a list).
7942 \begin_layout Standard
7943 So, to be as explicit as possible, the form of the layout declaration is:
7946 \begin_layout LyX-Code
7951 DeclareLaTeXClass[class,package.sty]{layout description}
7952 \change_inserted -712698321 1349767329
7956 \begin_layout LyX-Code
7958 \change_inserted -712698321 1349767339
7963 DeclareCategory{category}
7968 \begin_layout Standard
7969 The class need only be specified if the name of the LaTeX class file and
7970 the name of the layout file are different or if there are packages to load.
7971 If the name of the class file is not specified, then LyX will simply assume
7972 that it is the same as the name of the layout file.
7975 \begin_layout Standard
7976 When the text class has been modified to your taste, all you have to do
7977 is to copy it either to
7978 \begin_inset Flex Code
7981 \begin_layout Plain Layout
7988 \begin_inset Flex Code
7991 \begin_layout Plain Layout
7998 \begin_inset Flex MenuItem
8001 \begin_layout Plain Layout
8002 Tools\SpecialChar \menuseparator
8008 , exit LyX and restart.
8009 Then your new text class should be available along with the others.
8012 \begin_layout Standard
8013 Once the layout file is installed, you can edit it and see your changes
8014 without having to reconfigure or to restart LyX.
8019 \begin_layout Plain Layout
8020 In versions of LyX prior to 1.6, this was not true.
8021 As a result, editing layout files was very time consuming, since you had
8022 constantly to restart LyX to see changes.
8027 You can force a reload of the current layout by using the LyX function
8029 \begin_inset Flex MenuItem
8032 \begin_layout Plain Layout
8039 There is no default binding for this function—though, of course, you can
8040 bind it to a key yourself.
8041 But you will normally use this function simply by entering it in the mini-buffe
8046 \begin_layout Standard
8052 \begin_inset Flex MenuItem
8055 \begin_layout Plain Layout
8061 is very much an `advanced feature'.
8066 recommended that you save your work before using this function.
8071 recommended that you not attempt to edit layout information while simultaneousl
8072 y working on a document that you care about.
8073 Use a test document.
8074 Syntax errors and the like in your layout file could cause peculiar behavior.
8075 In particular, such errors could cause LyX to regard the current layout
8076 as invalid and to attempt to switch to some other layout.
8080 \begin_layout Plain Layout
8081 Really bad syntax errors may even caused LyX to exit.
8082 This is because certain sorts of errors may make LyX unable to read
8092 The LyX team strives to keep LyX stable in such situations, but safe is
8097 \begin_layout Plain Layout
8098 While we're giving advice: make regular backups.
8099 And be nice to your mother.
8107 \begin_layout Subsection
8108 The Module declaration
8111 \begin_layout Standard
8112 A module must begin with a line like the following:
8115 \begin_layout LyX-Code
8118 DeclareLyXModule[endnotes.sty]{Endnotes}
8121 \begin_layout Standard
8122 The mandatory argument, in curly brackets, is the name of the module, as
8124 \begin_inset Flex MenuItem
8127 \begin_layout Plain Layout
8128 Document\SpecialChar \menuseparator
8129 Settings\SpecialChar \menuseparator
8136 The argument in square brackets is optional: It declares any LaTeX packages
8137 on which the module depends.
8138 It is also possible to use the form
8139 \begin_inset Flex MenuItem
8142 \begin_layout Plain Layout
8148 as an optional argument, which declares that the module can only be used
8149 when there exists a conversion chain between the formats `
8150 \begin_inset Flex Code
8153 \begin_layout Plain Layout
8160 \begin_inset Flex Code
8163 \begin_layout Plain Layout
8172 \begin_layout Standard
8173 The module declaration should then be followed by lines like the following
8177 \begin_layout Plain Layout
8178 Preferably in English if the module should be published with LyX.
8179 This description will appear in the list of messages to be translated and
8180 will be thus translated with the next interface update.
8188 \begin_layout LyX-Code
8192 \begin_layout LyX-Code
8193 #Adds an endnote command, in addition to footnotes.
8197 \begin_layout LyX-Code
8198 #You will need to add
8200 theendnotes in TeX code where you
8203 \begin_layout LyX-Code
8204 #want the endnotes to appear.
8208 \begin_layout LyX-Code
8212 \begin_layout LyX-Code
8213 #Requires: somemodule | othermodule
8216 \begin_layout LyX-Code
8217 #Excludes: badmodule
8220 \begin_layout Standard
8221 The description is used in
8222 \begin_inset Flex MenuItem
8225 \begin_layout Plain Layout
8226 Document\SpecialChar \menuseparator
8227 Settings\SpecialChar \menuseparator
8233 to provide the user with information about what the module does.
8235 \begin_inset Flex Code
8238 \begin_layout Plain Layout
8244 line is used to identify other modules with which this one must be used;
8246 \begin_inset Flex Code
8249 \begin_layout Plain Layout
8255 line is used to identify modules with which this one may not be used.
8256 Both are optional, and, as shown, multiple modules should be separated
8257 with the pipe symbol: |.
8258 Note that the required modules are treated disjunctively:
8262 of the required modules must be used.
8267 excluded module may be used.
8268 Note that modules are identified here by their filenames without the
8269 \begin_inset Flex Code
8272 \begin_layout Plain Layout
8280 \begin_inset Flex Code
8283 \begin_layout Plain Layout
8290 \begin_inset Flex Code
8293 \begin_layout Plain Layout
8302 \begin_layout Subsection
8306 \begin_layout Standard
8307 The first non-comment line of any layout file, included file, or module
8312 contain the file format number:
8315 \begin_layout Description
8316 \begin_inset Flex Code
8319 \begin_layout Plain Layout
8326 \begin_inset Flex Code
8329 \begin_layout Plain Layout
8335 ] The format number of the layout file.
8338 \begin_layout Standard
8339 This tag was introduced with LyX
8340 \begin_inset space ~
8344 Layout files from older LyX versions do not have an explicit file format
8345 and are considered to have
8346 \begin_inset Flex Code
8349 \begin_layout Plain Layout
8351 \begin_inset space ~
8360 The format for the present version of LyX is format 35.
8361 But each version of LyX is capable of reading earlier versions' layout
8362 files, just as they are capable of reading files produced by earlier versions
8364 There is, however, no provision for converting to earlier formats.
8367 \begin_layout Subsection
8368 \begin_inset CommandInset label
8370 name "sub:General-text-class"
8374 General text class parameters
8377 \begin_layout Standard
8378 These are general parameters that govern the behavior of an entire document
8384 mean that they must appear in
8385 \begin_inset Flex Code
8388 \begin_layout Plain Layout
8394 files rather than in modules.
8395 A module can contain any layout tag.)
8398 \begin_layout Description
8399 \begin_inset Flex Code
8402 \begin_layout Plain Layout
8408 Adds information that will be output in the
8409 \begin_inset Flex Code
8412 \begin_layout Plain Layout
8418 block when the document is output to XHTML.
8419 Typically, this would be used to output CSS style information, but it can
8420 be used for anything that can appear in
8421 \begin_inset Flex Code
8424 \begin_layout Plain Layout
8432 \begin_inset Quotes eld
8436 \begin_inset Flex Code
8439 \begin_layout Plain Layout
8446 \begin_inset Quotes erd
8452 \begin_layout Description
8453 \begin_inset Flex Code
8456 \begin_layout Plain Layout
8462 Adds information to the document preamble.
8464 \begin_inset Newline newline
8468 \begin_inset Quotes eld
8472 \begin_inset Flex Code
8475 \begin_layout Plain Layout
8482 \begin_inset Quotes erd
8488 \begin_layout Description
8489 \begin_inset Flex Code
8492 \begin_layout Plain Layout
8498 Defines formats for use in the display of bibliographic information.
8500 \begin_inset CommandInset ref
8502 reference "sub:Citation-format-description"
8508 \begin_inset Quotes eld
8512 \begin_inset Flex Code
8515 \begin_layout Plain Layout
8522 \begin_inset Quotes erd
8528 \begin_layout Description
8529 \begin_inset Flex Code
8532 \begin_layout Plain Layout
8538 Describes various global options supported by the document class.
8540 \begin_inset space ~
8544 \begin_inset CommandInset ref
8546 reference "sub:ClassOptions"
8552 \begin_inset Quotes eld
8556 \begin_inset Flex Code
8559 \begin_layout Plain Layout
8566 \begin_inset Quotes erd
8572 \begin_layout Description
8573 \begin_inset Flex Code
8576 \begin_layout Plain Layout
8583 \begin_inset Flex Code
8586 \begin_layout Plain Layout
8595 \begin_inset space \thinspace{}
8599 \begin_inset Flex Code
8602 \begin_layout Plain Layout
8608 ] Whether the class should
8612 to having one or two columns.
8613 Can be changed in the
8614 \begin_inset Flex MenuItem
8617 \begin_layout Plain Layout
8618 Document\SpecialChar \menuseparator
8627 \begin_layout Description
8628 \begin_inset Flex Code
8631 \begin_layout Plain Layout
8638 \begin_inset Flex Code
8641 \begin_layout Plain Layout
8647 ] This sequence defines the properties for a counter.
8648 If the counter does not yet exist, it is created; if it does exist, it
8651 \begin_inset Quotes eld
8655 \begin_inset Flex Code
8658 \begin_layout Plain Layout
8665 \begin_inset Quotes erd
8669 \begin_inset Newline newline
8673 \begin_inset space ~
8677 \begin_inset CommandInset ref
8679 reference "sub:Counters"
8683 for details on counters.
8686 \begin_layout Description
8687 \begin_inset Flex Code
8690 \begin_layout Plain Layout
8696 Sets the default font used to display the document.
8698 \begin_inset space ~
8702 \begin_inset CommandInset ref
8704 reference "sub:Font-description"
8708 for how to declare fonts.
8710 \begin_inset Quotes eld
8714 \begin_inset Flex Code
8717 \begin_layout Plain Layout
8724 \begin_inset Quotes erd
8730 \begin_layout Description
8731 \begin_inset Flex Code
8734 \begin_layout Plain Layout
8741 \begin_inset Flex Code
8744 \begin_layout Plain Layout
8750 ] Specifies a module to be included by default with this document class.
8751 The module is specified as filename without the
8752 \begin_inset Flex Code
8755 \begin_layout Plain Layout
8762 The user can still remove the module, but it will be active at the outset.
8763 (This applies only when new files are created, or when this class is chosen
8764 for an existing document.)
8767 \begin_layout Description
8768 \begin_inset Flex Code
8771 \begin_layout Plain Layout
8778 \begin_inset Flex Code
8781 \begin_layout Plain Layout
8787 ] This is the style that will be assigned to new paragraphs, usually
8788 \begin_inset Flex MenuItem
8791 \begin_layout Plain Layout
8798 This will default to the first defined style if not given, but you are
8799 encouraged to use this directive.
8802 \begin_layout Description
8803 \begin_inset Flex Code
8806 \begin_layout Plain Layout
8813 \begin_inset Flex Code
8816 \begin_layout Plain Layout
8822 ] This tag indicates that the module (which is specified by filename without
8824 \begin_inset Flex Code
8827 \begin_layout Plain Layout
8833 extension) cannot be used with this document class.
8834 This might be used in a journal-specific layout file to prevent, say, the
8836 \begin_inset Flex Code
8839 \begin_layout Plain Layout
8845 module that numbers theorems by section.
8850 be used in a module.
8851 Modules have their own way of excluding other modules (see section
8852 \begin_inset space ~
8856 \begin_inset CommandInset ref
8858 reference "sub:Layout-modules"
8865 \begin_layout Description
8866 \begin_inset Flex Code
8869 \begin_layout Plain Layout
8875 Defines a new float.
8877 \begin_inset space ~
8881 \begin_inset CommandInset ref
8883 reference "sub:Floats"
8889 \begin_inset Quotes eld
8893 \begin_inset Flex Code
8896 \begin_layout Plain Layout
8903 \begin_inset Quotes erd
8909 \begin_layout Description
8910 \begin_inset Flex Code
8913 \begin_layout Plain Layout
8919 Sets the information that will be output in the
8920 \begin_inset Flex Code
8923 \begin_layout Plain Layout
8929 block when this document class is output to XHTML.
8930 Note that this will completely override any prior
8931 \begin_inset Flex Code
8934 \begin_layout Plain Layout
8941 \begin_inset Flex Code
8944 \begin_layout Plain Layout
8952 \begin_inset Newline newline
8956 \begin_inset Flex Code
8959 \begin_layout Plain Layout
8965 if you just want to add material to the preamble.) Must end with
8966 \begin_inset Quotes eld
8970 \begin_inset Flex Code
8973 \begin_layout Plain Layout
8980 \begin_inset Quotes erd
8986 \begin_layout Description
8987 \begin_inset Flex Code
8990 \begin_layout Plain Layout
8997 \begin_inset Flex Code
9000 \begin_layout Plain Layout
9006 ] The style to use for the table of contents, bibliography, and so forth,
9007 when the document is output to HTML.
9008 For articles, this should normally be
9009 \begin_inset Flex Code
9012 \begin_layout Plain Layout
9019 \begin_inset Flex Code
9022 \begin_layout Plain Layout
9029 If it is not given, then LyX will attempt to figure out which layout to
9033 \begin_layout Description
9034 \begin_inset Flex Code
9037 \begin_layout Plain Layout
9044 \begin_inset Flex Code
9047 \begin_layout Plain Layout
9053 ] Modifies the properties of the given counter.
9054 If the counter does not exist, the statement is ignored.
9056 \begin_inset Quotes eld
9060 \begin_inset Flex Code
9063 \begin_layout Plain Layout
9070 \begin_inset Quotes erd
9074 \begin_inset Newline newline
9078 \begin_inset space ~
9082 \begin_inset CommandInset ref
9084 reference "sub:Counters"
9088 for details on counters.
9091 \begin_layout Description
9092 \begin_inset Flex Code
9095 \begin_layout Plain Layout
9102 \begin_inset Flex Code
9105 \begin_layout Plain Layout
9111 ] Modifies the properties of the given paragraph style.
9112 If the style does not exist, the statement is ignored.
9114 \begin_inset Quotes eld
9118 \begin_inset Flex Code
9121 \begin_layout Plain Layout
9128 \begin_inset Quotes erd
9134 \begin_layout Description
9135 \begin_inset Flex Code
9138 \begin_layout Plain Layout
9145 \begin_inset Flex Code
9148 \begin_layout Plain Layout
9154 ] This allows you to include another layout definition file within yours
9155 to avoid duplicating commands.
9156 Common examples are the standard layout files, for example,
9157 \begin_inset Flex Code
9160 \begin_layout Plain Layout
9166 , which contains most of the basic layouts.
9169 \begin_layout Description
9170 \begin_inset Flex Code
9173 \begin_layout Plain Layout
9180 \begin_inset Flex Code
9183 \begin_layout Plain Layout
9189 ] This section (re-)defines the layout of an inset.
9190 It can be applied to an existing inset or to a new, user-defined inset,
9191 e.g., a new character style.
9193 \begin_inset Quotes eld
9197 \begin_inset Flex Code
9200 \begin_layout Plain Layout
9207 \begin_inset Quotes erd
9211 \begin_inset Newline newline
9215 \begin_inset space ~
9219 \begin_inset CommandInset ref
9221 reference "sub:Flex-insets-and"
9225 for more information.
9229 \begin_layout Description
9230 \begin_inset Flex Code
9233 \begin_layout Plain Layout
9240 \begin_inset Flex Code
9243 \begin_layout Plain Layout
9249 ] A string that indicates the width of the left margin on the screen, for
9251 \begin_inset Quotes eld
9255 \begin_inset Flex Code
9258 \begin_layout Plain Layout
9265 \begin_inset Quotes erd
9269 (Note that this is not a `length', like
9270 \begin_inset Quotes eld
9274 \begin_inset Quotes erd
9280 \begin_layout Description
9281 \begin_inset Flex Code
9284 \begin_layout Plain Layout
9291 \begin_inset Flex Code
9294 \begin_layout Plain Layout
9300 ] Deletes an existing counter, usually one defined in an included file.
9303 \begin_layout Description
9304 \begin_inset Flex Code
9307 \begin_layout Plain Layout
9314 \begin_inset Flex Code
9317 \begin_layout Plain Layout
9323 ] Deletes an existing float.
9324 This is particularly useful when you want to suppress a float that has
9325 been defined in an input file.
9328 \begin_layout Description
9329 \begin_inset Flex Code
9332 \begin_layout Plain Layout
9339 \begin_inset Flex Code
9342 \begin_layout Plain Layout
9348 ] Deletes an existing style.
9351 \begin_layout Description
9352 \begin_inset Flex Code
9355 \begin_layout Plain Layout
9362 \begin_inset Flex Code
9365 \begin_layout Plain Layout
9371 ] The file format (as defined in the LyX preferences) produced by this document
9373 It is mainly useful when
9374 \begin_inset Flex Code
9377 \begin_layout Plain Layout
9384 \begin_inset Flex Code
9387 \begin_layout Plain Layout
9393 and one wants to define a new type of literate document.
9394 The format is reset to
9395 \begin_inset Quotes eld
9399 \begin_inset Flex Code
9402 \begin_layout Plain Layout
9409 \begin_inset Quotes erd
9413 \begin_inset Quotes eld
9417 \begin_inset Flex Code
9420 \begin_layout Plain Layout
9427 \begin_inset Quotes erd
9430 when the corresponding
9431 \begin_inset Flex Code
9434 \begin_layout Plain Layout
9440 parameter is encountered.
9443 \begin_layout Description
9444 \begin_inset Flex Code
9447 \begin_layout Plain Layout
9454 \begin_inset Flex Code
9457 \begin_layout Plain Layout
9468 \begin_inset Flex Code
9471 \begin_layout Plain Layout
9478 \begin_inset Flex Code
9481 \begin_layout Plain Layout
9487 ] Specifies what sort of output documents using this class will produce.
9488 \change_inserted 1414654397 1369315909
9492 \begin_layout Description
9494 \change_inserted 1414654397 1369316059
9495 \begin_inset Flex Code
9498 \begin_layout Plain Layout
9500 \change_inserted 1414654397 1369315915
9507 \begin_inset Flex Code
9510 \begin_layout Plain Layout
9512 \change_inserted 1414654397 1369315909
9519 \begin_inset Flex Code
9522 \begin_layout Plain Layout
9524 \change_inserted 1414654397 1369315919
9530 ] Specifies options, given in the second string, for the package named by
9533 \begin_inset Quotes eld
9537 \begin_inset Flex Code
9540 \begin_layout Plain Layout
9542 \change_inserted 1414654397 1369315957
9543 PackageOptions natbib square
9551 \begin_inset Quotes erd
9555 \begin_inset Flex Code
9558 \begin_layout Plain Layout
9560 \change_inserted 1414654397 1369315966
9568 to be loaded with the
9569 \begin_inset Flex Code
9572 \begin_layout Plain Layout
9574 \change_inserted 1414654397 1369315985
9583 (For TeXperts, this causes LyX to output:
9584 \begin_inset Flex Code
9587 \begin_layout Plain Layout
9589 \change_inserted 1414654397 1369316019
9592 PassOptionsToPackage{natbib}{square}
9600 \begin_inset Flex Code
9603 \begin_layout Plain Layout
9605 \change_inserted 1414654397 1369316061
9618 \begin_layout Description
9619 \begin_inset Flex Code
9622 \begin_layout Plain Layout
9629 \begin_inset Flex Code
9632 \begin_layout Plain Layout
9641 \begin_inset Flex Code
9644 \begin_layout Plain Layout
9651 \begin_inset Flex Code
9654 \begin_layout Plain Layout
9660 ] The default pagestyle.
9661 Can be changed in the
9662 \begin_inset Flex MenuItem
9665 \begin_layout Plain Layout
9666 Document\SpecialChar \menuseparator
9675 \begin_layout Description
9676 \begin_inset Flex Code
9679 \begin_layout Plain Layout
9685 Sets the preamble for the LaTeX document.
9686 Note that this will completely override any prior
9687 \begin_inset Flex Code
9690 \begin_layout Plain Layout
9697 \begin_inset Flex Code
9700 \begin_layout Plain Layout
9708 \begin_inset Flex Code
9711 \begin_layout Plain Layout
9717 if you just want to add material to the preamble.) Must end with
9718 \begin_inset Quotes eld
9722 \begin_inset Flex Code
9725 \begin_layout Plain Layout
9732 \begin_inset Quotes erd
9738 \begin_layout Description
9739 \begin_inset Flex Code
9742 \begin_layout Plain Layout
9749 \begin_inset Flex Code
9752 \begin_layout Plain Layout
9759 \begin_inset Flex Code
9762 \begin_layout Plain Layout
9771 \begin_inset space \thinspace{}
9775 \begin_inset Flex Code
9778 \begin_layout Plain Layout
9784 ] Whether the class already provides the feature
9785 \begin_inset Flex Code
9788 \begin_layout Plain Layout
9795 A feature is in general the name of a package (e.
9796 \begin_inset space \thinspace{}
9800 \begin_inset space \space{}
9804 \begin_inset Flex Code
9807 \begin_layout Plain Layout
9814 \begin_inset Flex Code
9817 \begin_layout Plain Layout
9824 \begin_inset space \thinspace{}
9828 \begin_inset space \space{}
9832 \begin_inset Flex Code
9835 \begin_layout Plain Layout
9842 \begin_inset Flex Code
9845 \begin_layout Plain Layout
9853 \begin_inset space ~
9857 \begin_inset CommandInset ref
9859 reference "chap:List-of-functions"
9863 for the list of features.
9866 \begin_layout Description
9867 \begin_inset Flex Code
9870 \begin_layout Plain Layout
9877 \begin_inset Flex Code
9880 \begin_layout Plain Layout
9886 ] Indicates that this layout provides the functionality of the module mentioned,
9887 which should be specified by the filename without the
9888 \begin_inset Flex Code
9891 \begin_layout Plain Layout
9898 This will typically be used if the layout includes the module directly,
9899 rather than using the
9900 \begin_inset Flex Code
9903 \begin_layout Plain Layout
9909 tag to indicate that it ought to be used.
9910 It could also be used in a module that provided an alternate implementation
9911 of the same functionality.
9914 \begin_layout Description
9915 \begin_inset Flex Code
9918 \begin_layout Plain Layout
9925 \begin_inset Flex Code
9928 \begin_layout Plain Layout
9934 ] Whether the class requires the feature
9935 \begin_inset Flex Code
9938 \begin_layout Plain Layout
9945 Multiple features must be separated by commas.
9946 Note that you can only request supported features.
9948 \begin_inset space ~
9952 \begin_inset CommandInset ref
9954 reference "chap:List-of-functions"
9958 for the list of features.)
9961 \begin_layout Description
9962 \begin_inset Flex Code
9965 \begin_layout Plain Layout
9972 \begin_inset Flex Code
9975 \begin_layout Plain Layout
9981 ] A string that indicates the width of the right margin on the screen, for
9983 \begin_inset Quotes eld
9987 \begin_inset Flex Code
9990 \begin_layout Plain Layout
9997 \begin_inset Quotes erd
10003 \begin_layout Description
10004 \begin_inset Flex Code
10007 \begin_layout Plain Layout
10014 \begin_inset Flex Code
10017 \begin_layout Plain Layout
10023 ] Sets which divisions get numbered.
10025 \begin_inset Newline newline
10029 \begin_inset Flex Code
10032 \begin_layout Plain Layout
10041 \begin_layout Description
10042 \begin_inset Flex Code
10045 \begin_layout Plain Layout
10052 \begin_inset Flex Code
10055 \begin_layout Plain Layout
10064 \begin_inset space \thinspace{}
10068 \begin_inset Flex Code
10071 \begin_layout Plain Layout
10077 ] Whether the class-default should be printing on one or both sides of the
10079 Can be changed in the
10080 \begin_inset Flex MenuItem
10083 \begin_layout Plain Layout
10084 Document\SpecialChar \menuseparator
10093 \begin_layout Description
10094 \begin_inset Flex Code
10097 \begin_layout Plain Layout
10104 \begin_inset Flex Code
10107 \begin_layout Plain Layout
10113 ] This sequence defines a paragraph style.
10114 If the style does not yet exist, it is created; if it does exist, its parameter
10117 \begin_inset Quotes eld
10121 \begin_inset Flex Code
10124 \begin_layout Plain Layout
10131 \begin_inset Quotes erd
10135 \begin_inset Newline newline
10139 \begin_inset space ~
10143 \begin_inset CommandInset ref
10145 reference "sub:Paragraph-Styles"
10149 for details on paragraph styles.
10152 \begin_layout Description
10153 \begin_inset Flex Code
10156 \begin_layout Plain Layout
10163 \begin_inset Flex Code
10166 \begin_layout Plain Layout
10172 ] The name of the command or environment to be used with
10173 \begin_inset Flex Code
10176 \begin_layout Plain Layout
10185 \begin_layout Description
10186 \begin_inset Flex Code
10189 \begin_layout Plain Layout
10196 \begin_inset Flex Code
10199 \begin_layout Plain Layout
10208 \begin_inset Flex Code
10211 \begin_layout Plain Layout
10217 ] Indicates what kind of markup is used to define the title of a document.
10219 \begin_inset Flex Code
10222 \begin_layout Plain Layout
10228 means that the macro with name
10229 \begin_inset Flex Code
10232 \begin_layout Plain Layout
10238 will be inserted after the last layout which has
10239 \begin_inset Quotes eld
10243 \begin_inset Flex Code
10246 \begin_layout Plain Layout
10248 \begin_inset space ~
10257 \begin_inset Quotes erd
10262 \begin_inset Flex Code
10265 \begin_layout Plain Layout
10271 corresponds to the case where all layouts which have
10272 \begin_inset Quotes eld
10276 \begin_inset Flex Code
10279 \begin_layout Plain Layout
10281 \begin_inset space ~
10290 \begin_inset Quotes erd
10293 should be enclosed into the
10294 \begin_inset Flex Code
10297 \begin_layout Plain Layout
10306 \begin_layout Description
10307 \begin_inset Flex Code
10310 \begin_layout Plain Layout
10317 \begin_inset Flex Code
10320 \begin_layout Plain Layout
10326 ] Sets which divisions are included in the table of contents.
10328 \begin_inset Flex Code
10331 \begin_layout Plain Layout
10340 \begin_layout Subsection
10341 \begin_inset Flex Code
10344 \begin_layout Plain Layout
10351 \begin_inset CommandInset label
10353 name "sub:ClassOptions"
10360 \begin_layout Standard
10362 \begin_inset Flex Code
10365 \begin_layout Plain Layout
10371 section can contain the following entries:
10374 \begin_layout Description
10375 \begin_inset Flex Code
10378 \begin_layout Plain Layout
10385 \begin_inset Flex Code
10388 \begin_layout Plain Layout
10394 ] The list of available font sizes for the document's main font, separated
10396 \begin_inset Quotes eld
10400 \begin_inset Flex Code
10403 \begin_layout Plain Layout
10410 \begin_inset Quotes erd
10416 \begin_layout Description
10417 \begin_inset Flex Code
10420 \begin_layout Plain Layout
10426 Used to set the DTD line with XML-based output classes.
10428 \begin_inset space \thinspace{}
10432 \begin_inset Quotes eld
10435 -//OASIS//DTD DocBook V4.2//EN
10436 \begin_inset Quotes erd
10442 \begin_layout Description
10443 \begin_inset Flex Code
10446 \begin_layout Plain Layout
10453 \begin_inset Flex Code
10456 \begin_layout Plain Layout
10457 string="empty|plain|headings|fancy"
10462 ] The list of available page sty\SpecialChar \-
10464 \begin_inset Quotes eld
10468 \begin_inset Flex Code
10471 \begin_layout Plain Layout
10478 \begin_inset Quotes erd
10484 \begin_layout Description
10485 \begin_inset Flex Code
10488 \begin_layout Plain Layout
10495 \begin_inset Flex Code
10498 \begin_layout Plain Layout
10504 ] Some document class options, separated by a comma, that will be added
10505 to the optional part of the
10506 \begin_inset Flex Code
10509 \begin_layout Plain Layout
10520 \begin_layout Standard
10522 \begin_inset Flex Code
10525 \begin_layout Plain Layout
10531 section must end with
10532 \begin_inset Quotes eld
10536 \begin_inset Flex Code
10539 \begin_layout Plain Layout
10546 \begin_inset Quotes erd
10552 \begin_layout Subsection
10554 \begin_inset CommandInset label
10556 name "sub:Paragraph-Styles"
10563 \begin_layout Standard
10564 A paragraph style description looks like this:
10568 \begin_layout Plain Layout
10569 Note that this will either define a new style or modify an existing one.
10577 \begin_layout LyX-Code
10584 \begin_layout LyX-Code
10588 \begin_layout LyX-Code
10592 \begin_layout Standard
10593 where the following commands are allowed:
10596 \begin_layout Description
10597 \begin_inset Flex Code
10600 \begin_layout Plain Layout
10607 \begin_inset Flex Code
10610 \begin_layout Plain Layout
10615 , left, right, center
10620 ] Paragraph alignment.
10623 \begin_layout Description
10624 \begin_inset Flex Code
10627 \begin_layout Plain Layout
10634 \begin_inset Flex Code
10637 \begin_layout Plain Layout
10642 , left, right, center
10647 ] A comma separated list of permitted alignments.
10648 (Some LaTeX styles prohibit certain alignments, since those wouldn't make
10650 For example a right-aligned or centered enumeration isn't possible.)
10651 \change_inserted -712698321 1353679769
10655 \begin_layout Description
10657 \change_inserted -712698321 1353680268
10658 \begin_inset Flex Code
10661 \begin_layout Plain Layout
10663 \change_inserted -712698321 1353679781
10670 \begin_inset Flex Code
10673 \begin_layout Plain Layout
10675 \change_inserted -712698321 1353679772
10681 ] Defines argument number <int> of a command\SpecialChar \slash{}
10682 environment associated with
10684 This is useful for things like section headings, and only makes sense with
10686 Every (optional or required) argument of a command or environment -- except
10687 for the required argument that is associated with the content of the paragraph
10688 itself -- has a separate definition, where the number specifies the order
10690 The definition must end with
10691 \begin_inset Flex Code
10694 \begin_layout Plain Layout
10696 \change_inserted -712698321 1353680069
10703 So a command with two optional arguments has:
10707 \begin_layout Quote
10709 \change_inserted -712698321 1353680127
10715 \begin_layout Quote
10717 \change_inserted -712698321 1353680195
10723 \begin_layout Quote
10725 \change_inserted -712698321 1353680135
10731 \begin_layout Quote
10733 \change_inserted -712698321 1353680140
10739 \begin_layout Quote
10741 \change_inserted -712698321 1353680197
10747 \begin_layout Quote
10749 \change_inserted -712698321 1353680147
10755 \begin_layout Standard
10757 \change_inserted -712698321 1353680528
10759 \begin_inset Flex Code
10762 \begin_layout Plain Layout
10764 \change_inserted -712698321 1353680412
10770 definition, the following specifications are possible:
10773 \begin_layout Itemize
10775 \change_inserted -712698321 1355076779
10776 \begin_inset Flex Code
10779 \begin_layout Plain Layout
10781 \change_inserted -712698321 1353680543
10790 \begin_inset Flex Code
10793 \begin_layout Plain Layout
10795 \change_inserted -712698321 1353680567
10801 The string that will appear both in the menu (to insert this argument)
10802 and on the argument inset button (unless you also specify a separate
10803 \begin_inset Flex Code
10806 \begin_layout Plain Layout
10808 \change_inserted -712698321 1355076779
10815 For the menu, you can define an accelerator by appending the respective
10816 character to the string, divided by
10817 \begin_inset Quotes eld
10821 \begin_inset Quotes erd
10825 \begin_inset space \thinspace{}
10830 \begin_inset Flex Code
10833 \begin_layout Plain Layout
10835 \change_inserted -712698321 1353691482
10836 \begin_inset Quotes eld
10840 \begin_inset Quotes erd
10853 \begin_layout Itemize
10855 \change_inserted -712698321 1355076754
10856 \begin_inset Flex Code
10859 \begin_layout Plain Layout
10861 \change_inserted -712698321 1355076658
10868 \begin_inset Flex Code
10871 \begin_layout Plain Layout
10873 \change_inserted -712698321 1355076654
10879 A separate string for the menu.
10880 You can define an accelerator by appending the respective character to
10881 the string, divided by
10882 \begin_inset Quotes eld
10886 \begin_inset Quotes erd
10890 \begin_inset space \thinspace{}
10895 \begin_inset Flex Code
10898 \begin_layout Plain Layout
10900 \change_inserted -712698321 1355076654
10901 \begin_inset Quotes eld
10905 \begin_inset Quotes erd
10914 This specification is optional.
10915 If it is not given the
10916 \begin_inset Flex Code
10919 \begin_layout Plain Layout
10921 \change_inserted -712698321 1355076736
10929 will be used instead for the menu.
10932 \begin_layout Itemize
10934 \change_inserted -712698321 1353680665
10935 \begin_inset Flex Code
10938 \begin_layout Plain Layout
10940 \change_inserted -712698321 1353680616
10947 \begin_inset Flex Code
10950 \begin_layout Plain Layout
10952 \change_inserted -712698321 1353680623
10958 A longer explanatory text that appears in the tooltip when hovering over
10959 the argument inset.
10962 \begin_layout Itemize
10964 \change_inserted -712698321 1353680874
10965 \begin_inset Flex Code
10968 \begin_layout Plain Layout
10970 \change_inserted -712698321 1353680732
10977 \begin_inset Flex Code
10980 \begin_layout Plain Layout
10982 \change_inserted -712698321 1353680738
10988 Declare if this is a mandatory
10989 \change_inserted 2090807402 1353765594
10991 \change_inserted -712698321 1353680874
10993 \change_inserted 2090807402 1353765599
10995 \change_inserted -712698321 1353680874
10997 Mandatory arguments will be output empty if not given, while optional arguments
10998 will not be output at all.
10999 By default, mandatory arguments are delimited by
11000 \begin_inset Flex Code
11003 \begin_layout Plain Layout
11005 \change_inserted -712698321 1353680808
11013 , while optional arguments are delimited by
11014 \begin_inset Flex Code
11017 \begin_layout Plain Layout
11019 \change_inserted -712698321 1353680833
11028 \begin_layout Itemize
11030 \change_inserted -712698321 1353917199
11031 \begin_inset Flex Code
11034 \begin_layout Plain Layout
11036 \change_inserted -712698321 1353680879
11043 \begin_inset Flex Code
11046 \begin_layout Plain Layout
11048 \change_inserted -712698321 1353680874
11054 defines another argument (by its number) which this argument requires to
11055 be output if it is itself output.
11057 \begin_inset space \thinspace{}
11060 g., in LaTeX commands, optional arguments often require previous optional
11061 arguments to be output (at least empty), as in
11062 \begin_inset Flex Code
11065 \begin_layout Plain Layout
11067 \change_inserted -712698321 1353688183
11070 command[][arg]{text}
11078 This can be achieved by the statement
11079 \begin_inset Flex Code
11082 \begin_layout Plain Layout
11084 \change_inserted -712698321 1353681031
11093 \begin_inset Flex Code
11096 \begin_layout Plain Layout
11098 \change_inserted -712698321 1353681045
11109 \begin_layout Itemize
11111 \change_inserted -712698321 1354263104
11112 \begin_inset Flex Code
11115 \begin_layout Plain Layout
11117 \change_inserted -712698321 1353681072
11126 \begin_inset Flex Code
11129 \begin_layout Plain Layout
11131 \change_inserted -712698321 1353681067
11137 defines a custom left delimiter (instead of
11138 \begin_inset Flex Code
11141 \begin_layout Plain Layout
11143 \change_inserted -712698321 1353681127
11152 \begin_inset Flex Code
11155 \begin_layout Plain Layout
11157 \change_inserted -712698321 1353681133
11166 A line break in the output can be indicated by
11167 \begin_inset Flex Code
11170 \begin_layout Plain Layout
11172 \change_inserted -712698321 1354263104
11183 \begin_layout Itemize
11185 \change_inserted -712698321 1355144479
11186 \begin_inset Flex Code
11189 \begin_layout Plain Layout
11191 \change_inserted -712698321 1353681149
11198 \begin_inset Flex Code
11201 \begin_layout Plain Layout
11203 \change_inserted -712698321 1353681146
11209 defines a custom right delimiter (instead of
11210 \begin_inset Flex Code
11213 \begin_layout Plain Layout
11215 \change_inserted -712698321 1353681158
11222 \begin_inset Flex Code
11225 \begin_layout Plain Layout
11227 \change_inserted -712698321 1353681161
11234 A line break in the output can be indicated by
11235 \begin_inset Flex Code
11238 \begin_layout Plain Layout
11240 \change_inserted -712698321 1354263106
11249 \begin_layout Itemize
11251 \change_inserted -712698321 1361701444
11252 \begin_inset Flex Code
11255 \begin_layout Plain Layout
11257 \change_inserted -712698321 1361701356
11264 \begin_inset Flex Code
11267 \begin_layout Plain Layout
11269 \change_inserted -712698321 1361701356
11275 defines an argument that is inserted if and only if no user-specified arguments
11277 \begin_inset space \thinspace{}
11281 if no argument inset has been inserted (note that also an empty argument
11282 inset omits the DefaultArg).
11283 Multiple arguments need to be separated by comma.
11286 \begin_layout Itemize
11288 \change_inserted -712698321 1361701337
11289 \begin_inset Flex Code
11292 \begin_layout Plain Layout
11294 \change_inserted -712698321 1355144487
11303 \begin_inset Flex Code
11306 \begin_layout Plain Layout
11308 \change_inserted -712698321 1355144500
11314 defines an argument that is inserted in any case (alone or in addition
11315 to user-specified arguments).
11316 Multiple arguments need to be separated by comma.
11319 \begin_layout Itemize
11321 \change_inserted -712698321 1353917320
11322 \begin_inset Flex Code
11325 \begin_layout Plain Layout
11327 \change_inserted -712698321 1353917320
11333 The font used for the argument content.
11335 \begin_inset space ~
11339 \begin_inset CommandInset ref
11341 reference "sub:Font-description"
11348 \begin_layout Itemize
11350 \change_inserted -712698321 1353917320
11351 \begin_inset Flex Code
11354 \begin_layout Plain Layout
11356 \change_inserted -712698321 1353917320
11362 The font used for the label.
11364 \begin_inset space ~
11368 \begin_inset CommandInset ref
11370 reference "sub:Font-description"
11377 \begin_layout Itemize
11379 \change_inserted -712698321 1355661048
11380 \begin_inset Flex Code
11383 \begin_layout Plain Layout
11385 \change_inserted -712698321 1353917320
11392 \begin_inset Flex Code
11395 \begin_layout Plain Layout
11397 \change_inserted -712698321 1353917320
11404 \begin_inset Flex Code
11407 \begin_layout Plain Layout
11409 \change_inserted -712698321 1353917320
11416 \begin_inset Flex Code
11419 \begin_layout Plain Layout
11421 \change_inserted -712698321 1353917320
11427 , describing the rendering style used for the inset's frame and buttons.
11429 \begin_inset Flex Code
11432 \begin_layout Plain Layout
11434 \change_inserted -712698321 1353917320
11443 \begin_layout Itemize
11445 \change_inserted -712698321 1355747298
11446 \begin_inset Flex Code
11449 \begin_layout Plain Layout
11451 \change_inserted -712698321 1355661057
11458 \begin_inset Flex Code
11461 \begin_layout Plain Layout
11463 \change_inserted -712698321 1355661049
11470 \begin_inset Flex Code
11473 \begin_layout Plain Layout
11475 \change_inserted -712698321 1355661077
11483 , this argument is automatically inserted when the respective style is selected.
11484 Currently, only one argument per style\SpecialChar \slash{}
11485 layout can be automatically inserted.
11486 \change_inserted 155139281 1354198988
11490 \begin_layout Standard
11492 \change_inserted -712698321 1356689813
11493 By default, the text entered in the LyX workarea in the respective layout
11494 is the last (mandatory) argument of a command if the
11495 \begin_inset Flex Code
11498 \begin_layout Plain Layout
11500 \change_inserted -712698321 1356689619
11509 \begin_inset Flex Code
11512 \begin_layout Plain Layout
11514 \change_inserted -712698321 1356689629
11523 However, arguments with the prefix
11524 \begin_inset Flex Code
11527 \begin_layout Plain Layout
11529 \change_inserted -712698321 1356689679
11537 are output after this workarea argument.
11538 Note that post-argument numbering restarts at 1, so the first argument
11539 following the workarea argument is
11540 \begin_inset Flex Code
11543 \begin_layout Plain Layout
11545 \change_inserted -712698321 1356689813
11554 Post-arguments are ignored in any other
11555 \begin_inset Flex Code
11558 \begin_layout Plain Layout
11560 \change_inserted -712698321 1356689801
11567 \begin_inset Flex Code
11570 \begin_layout Plain Layout
11572 \change_inserted -712698321 1356689801
11583 \begin_layout Standard
11585 \change_inserted 155139281 1354199102
11587 \begin_inset Flex Code
11590 \begin_layout Plain Layout
11592 \change_inserted 155139281 1354199013
11603 \begin_inset Flex Code
11606 \begin_layout Plain Layout
11608 \change_inserted 155139281 1354199102
11619 \begin_inset Flex Code
11622 \begin_layout Plain Layout
11624 \change_inserted 155139281 1354199044
11632 followed by the number (e.
11633 \begin_inset space \thinspace{}
11638 \begin_inset Flex Code
11641 \begin_layout Plain Layout
11643 \change_inserted 155139281 1354199064
11657 \begin_layout Description
11658 \begin_inset Flex Code
11661 \begin_layout Plain Layout
11667 Note that this will completely override any prior
11668 \begin_inset Flex Code
11671 \begin_layout Plain Layout
11677 declaration for this style.
11679 \begin_inset Quotes eld
11683 \begin_inset Flex Code
11686 \begin_layout Plain Layout
11693 \begin_inset Quotes erd
11698 \begin_inset space ~
11702 \begin_inset CommandInset ref
11704 reference "sub:I18n"
11708 for details on its use.
11711 \begin_layout Description
11712 \begin_inset Flex Code
11715 \begin_layout Plain Layout
11722 \begin_inset Flex Code
11725 \begin_layout Plain Layout
11735 \begin_layout Plain Layout
11736 Note that a `float' here is a real number, such as: 1.5.
11741 The vertical space with which the last of a chain of paragraphs with this
11742 style is separated from the following paragraph.
11743 If the next paragraph has another style, the separations are not simply
11744 added, but the maximum is taken.
11747 \begin_layout Description
11748 \begin_inset Flex Code
11751 \begin_layout Plain Layout
11758 \begin_inset Flex Code
11761 \begin_layout Plain Layout
11767 ] The category for this style.
11768 This is used to group related styles in the style combobox on the toolbar.
11769 Any string can be used, but you may want to use existing categories with
11774 \begin_layout Description
11775 \begin_inset Flex Code
11778 \begin_layout Plain Layout
11784 Depth of XML command.
11785 Used only with XML-type formats.
11788 \begin_layout Description
11789 \begin_inset Flex Code
11792 \begin_layout Plain Layout
11799 \begin_inset Flex Code
11802 \begin_layout Plain Layout
11808 ] Copies all the features of an existing style into the current one.
11812 \begin_layout Description
11813 \begin_inset Flex Code
11816 \begin_layout Plain Layout
11823 \begin_inset Flex Code
11826 \begin_layout Plain Layout
11832 ] The name of a style whose preamble should be output
11837 This allows to ensure some ordering of the preamble snippets when macros
11838 definitions depend on one another.
11842 \begin_layout Plain Layout
11843 Note that, besides that functionality, there is no way to ensure any ordering
11845 The ordering that you see in a given version of LyX may change without
11846 warning in later versions.
11854 \begin_layout Description
11855 \begin_inset Flex Code
11858 \begin_layout Plain Layout
11865 \begin_inset Flex Code
11868 \begin_layout Plain Layout
11873 , Box, Filled_Box, Static
11878 ] The type of label that stands at the end of the paragraph (or sequence
11880 \begin_inset Flex Code
11883 \begin_layout Plain Layout
11890 \begin_inset Newline newline
11894 \begin_inset Flex Code
11897 \begin_layout Plain Layout
11904 \begin_inset Flex Code
11907 \begin_layout Plain Layout
11914 \begin_inset Flex Code
11917 \begin_layout Plain Layout
11925 \begin_inset Flex Code
11928 \begin_layout Plain Layout
11935 \begin_inset Quotes eld
11939 \begin_inset Quotes erd
11943 \begin_inset Flex Code
11946 \begin_layout Plain Layout
11953 \begin_inset space \space{}
11957 \begin_inset Flex Code
11960 \begin_layout Plain Layout
11966 ) is a white (resp.
11967 \begin_inset space ~
11970 black) square suitable for end of proof markers,
11971 \begin_inset Flex Code
11974 \begin_layout Plain Layout
11980 is an explicit text string.
11983 \begin_layout Description
11984 \begin_inset Flex Code
11987 \begin_layout Plain Layout
11994 \begin_inset Flex Code
11997 \begin_layout Plain Layout
12003 ] The string used for a label with a
12004 \begin_inset Flex Code
12007 \begin_layout Plain Layout
12014 \begin_inset Newline newline
12018 \begin_inset Flex Code
12021 \begin_layout Plain Layout
12031 \begin_layout Description
12032 \begin_inset Flex Code
12035 \begin_layout Plain Layout
12041 The font used for both the text body
12047 \begin_inset space ~
12051 \begin_inset CommandInset ref
12053 reference "sub:Font-description"
12058 Note that defining this font automatically defines the
12059 \begin_inset Flex Code
12062 \begin_layout Plain Layout
12069 So you should define this one first if you also want to define
12070 \begin_inset Flex Code
12073 \begin_layout Plain Layout
12080 \change_inserted -195340706 1364753581
12084 \begin_layout Description
12086 \change_inserted -195340706 1364753581
12087 \begin_inset Flex Code
12090 \begin_layout Plain Layout
12092 \change_inserted -195340706 1364753581
12098 Used for backporting new styles to stable LyX versions.
12099 The first stable version that supports this tag is LyX 2.1.0.
12101 \begin_inset Flex Code
12104 \begin_layout Plain Layout
12106 \change_inserted -195340706 1364753581
12112 is a number which may either be 0 (this is the default if the tag is not
12113 given), -1 or any value greater than zero.
12115 \begin_inset Flex Code
12118 \begin_layout Plain Layout
12120 \change_inserted -195340706 1364753581
12126 flag of a style is greater than zero, it will always be written to the
12128 If a .lyx file is read, the style definitions from the document header are
12129 added to the document class.
12130 Therefore even older versions can handle the style.
12132 \begin_inset Flex Code
12135 \begin_layout Plain Layout
12137 \change_inserted -195340706 1364753581
12143 is a version number: If such a style is read, and the version number is
12144 less than the version number of the already existing style in the document
12145 class, the new style is ignored.
12146 If the version number is higher, the new style replaces the existing style.
12147 A value of -1 means an infinite version number, i.e.
12153 \begin_layout Description
12154 \begin_inset Flex Code
12157 \begin_layout Plain Layout
12164 \begin_inset Flex Code
12167 \begin_layout Plain Layout
12176 \begin_inset space \thinspace{}
12180 \begin_inset Flex Code
12183 \begin_layout Plain Layout
12189 ] Usually LyX does not allow you to insert more than one space between words,
12190 since a space is considered as the separation between two words, not a
12191 character or symbol of its own.
12192 This is a very fine thing but sometimes annoying, for example, when typing
12193 program code or plain LaTeX code.
12195 \begin_inset Flex Code
12198 \begin_layout Plain Layout
12205 Note that LyX will create protected blanks for the additional blanks when
12206 in another mode than LaTeX-mode.
12209 \begin_layout Description
12210 \begin_inset Flex Code
12213 \begin_layout Plain Layout
12219 These tags are used with XHTML output.
12221 \begin_inset CommandInset ref
12223 reference "sub:Paragraph-Style-XHTML"
12230 \begin_layout Description
12231 \begin_inset Flex Code
12234 \begin_layout Plain Layout
12240 [FIXME] (Used only with XML-type formats.)
12243 \begin_layout Description
12244 \begin_inset Flex Code
12247 \begin_layout Plain Layout
12254 \begin_inset Flex Code
12257 \begin_layout Plain Layout
12266 \begin_inset space \thinspace{}
12270 \begin_inset Flex Code
12273 \begin_layout Plain Layout
12280 \begin_inset Flex Code
12283 \begin_layout Plain Layout
12289 , marks the style as to be included in the document preamble and not in
12291 This is useful for document classes that want such information as the title
12292 and author to appear in the preamble.
12293 Note that this works only for styles for which the
12294 \begin_inset Flex Code
12297 \begin_layout Plain Layout
12304 \begin_inset Flex Code
12307 \begin_layout Plain Layout
12314 \begin_inset Flex Code
12317 \begin_layout Plain Layout
12326 \begin_layout Description
12327 \begin_inset Flex Code
12330 \begin_layout Plain Layout
12337 \begin_inset Flex Code
12340 \begin_layout Plain Layout
12349 \begin_inset space \thinspace{}
12353 \begin_inset Flex Code
12356 \begin_layout Plain Layout
12363 \begin_inset Flex Code
12366 \begin_layout Plain Layout
12372 , marks the style as being part of a title block (see also the
12373 \begin_inset Flex Code
12376 \begin_layout Plain Layout
12383 \begin_inset Flex Code
12386 \begin_layout Plain Layout
12395 \begin_layout Description
12397 \change_inserted -712698321 1355932296
12398 \begin_inset Flex Code
12401 \begin_layout Plain Layout
12403 \change_inserted -712698321 1355932178
12410 \begin_inset Flex Code
12413 \begin_layout Plain Layout
12415 \change_inserted -712698321 1355932181
12421 ] The LaTeX command sequence declaring an item in a list.
12422 The command is to be defined without the preceding backslash (the default
12424 \begin_inset Quotes eld
12428 \begin_inset Quotes erd
12432 \begin_inset Flex Code
12435 \begin_layout Plain Layout
12437 \change_inserted -712698321 1355932279
12447 in the LaTeX output).
12450 \begin_layout Description
12451 \begin_inset Flex Code
12454 \begin_layout Plain Layout
12461 \begin_inset Flex Code
12464 \begin_layout Plain Layout
12470 ] This provides extra space between paragraphs that have the same style.
12471 If you put other styles into an environment, each is separated with the
12473 \begin_inset Flex Code
12476 \begin_layout Plain Layout
12483 But the whole items of the environment are additionally separated with
12485 \begin_inset Flex Code
12488 \begin_layout Plain Layout
12495 Note that this is a
12500 \begin_layout Description
12501 \begin_inset Flex Code
12504 \begin_layout Plain Layout
12510 [FIXME] (Used only with XML-type formats.)
12513 \begin_layout Description
12514 \begin_inset Flex Code
12517 \begin_layout Plain Layout
12524 \begin_inset Flex Code
12527 \begin_layout Plain Layout
12536 \begin_inset space \thinspace{}
12540 \begin_inset Flex Code
12543 \begin_layout Plain Layout
12549 ] Usually LyX does not allow you to leave a paragraph empty, since it would
12550 lead to empty LaTeX output.
12551 There are some cases where this could be desirable however: in a letter
12552 template, the required fields can be provided as empty fields, so that
12553 people do not forget them; in some special classes, a style can be used
12554 as some kind of break, which does not contain actual text.
12557 \begin_layout Description
12558 \begin_inset Flex Code
12561 \begin_layout Plain Layout
12568 \begin_inset Flex Code
12571 \begin_layout Plain Layout
12577 ] The vertical space between the label and the text body.
12578 Only used for labels that are above the text body (
12579 \begin_inset Flex Code
12582 \begin_layout Plain Layout
12589 \begin_inset Newline newline
12593 \begin_inset Flex Code
12596 \begin_layout Plain Layout
12597 Centered_Top_Environment
12605 \begin_layout Description
12606 \begin_inset Flex Code
12609 \begin_layout Plain Layout
12616 \begin_inset Flex Code
12619 \begin_layout Plain Layout
12625 ] The name of the counter for automatic numbering.
12627 \change_inserted 1414654397 1360434581
12628 In order to have the counter appear with your label, you will need to reference
12629 it in the LabelString.
12630 This will work with
12631 \begin_inset Flex Code
12634 \begin_layout Plain Layout
12636 \change_inserted 1414654397 1360434565
12645 \begin_inset Flex Code
12648 \begin_layout Plain Layout
12650 \change_inserted 1414654397 1360434569
12659 \begin_inset Flex Code
12662 \begin_layout Plain Layout
12664 \change_inserted 1414654397 1360434574
12673 \begin_inset Flex Code
12676 \begin_layout Plain Layout
12678 \change_inserted 1414654397 1360434578
12689 \begin_inset Newline newline
12693 \change_deleted 1414654397 1360434393
12699 \begin_inset Flex Code
12702 \begin_layout Plain Layout
12709 \begin_inset Flex Code
12712 \begin_layout Plain Layout
12719 In that case, the counter will be stepped each time the style appears.
12720 \begin_inset Newline newline
12730 \begin_inset Flex Code
12733 \begin_layout Plain Layout
12740 \begin_inset Flex Code
12743 \begin_layout Plain Layout
12749 , though this case is a bit complicated.
12750 Suppose you declare
12751 \begin_inset Quotes eld
12755 \begin_inset Flex Code
12758 \begin_layout Plain Layout
12759 LabelCounter myenum
12765 \begin_inset Quotes erd
12769 Then the actual counters used are
12770 \begin_inset Flex Code
12773 \begin_layout Plain Layout
12780 \begin_inset Flex Code
12783 \begin_layout Plain Layout
12790 \begin_inset Flex Code
12793 \begin_layout Plain Layout
12800 \begin_inset Flex Code
12803 \begin_layout Plain Layout
12809 , much as in LaTeX.
12810 These counters must all be declared separately.
12811 \begin_inset Newline newline
12815 \begin_inset CommandInset ref
12817 reference "sub:Counters"
12821 for details on counters.
12824 \begin_layout Description
12825 \begin_inset Flex Code
12828 \begin_layout Plain Layout
12834 The font used for the label.
12836 \begin_inset space ~
12840 \begin_inset CommandInset ref
12842 reference "sub:Font-description"
12849 \begin_layout Description
12850 \begin_inset Flex Code
12853 \begin_layout Plain Layout
12860 \begin_inset Flex Code
12863 \begin_layout Plain Layout
12869 ] Text that indicates how far a label should be indented.
12872 \begin_layout Description
12873 \begin_inset Flex Code
12876 \begin_layout Plain Layout
12883 \begin_inset Flex Code
12886 \begin_layout Plain Layout
12892 ] Text that indicates the amount of horizontal space between the label and
12894 Only used for labels that are not above the text body.
12897 \begin_layout Description
12898 \begin_inset Flex Code
12901 \begin_layout Plain Layout
12908 \begin_inset Flex Code
12911 \begin_layout Plain Layout
12917 ] The string used for
12918 \change_inserted 1414654397 1360434358
12920 \change_deleted 1414654397 1360434353
12925 \begin_inset Flex Code
12928 \begin_layout Plain Layout
12934 is set, this string can be contain the special formatting commands described
12936 \begin_inset CommandInset ref
12938 reference "sub:Counters"
12945 \begin_layout Description
12946 \begin_inset Flex Code
12949 \begin_layout Plain Layout
12950 LabelStringAppendix
12956 \begin_inset Flex Code
12959 \begin_layout Plain Layout
12965 ] This is used inside the appendix instead of
12966 \begin_inset Newline newline
12970 \begin_inset Flex Code
12973 \begin_layout Plain Layout
12981 \begin_inset Flex Code
12984 \begin_layout Plain Layout
12991 \begin_inset Newline newline
12995 \begin_inset Flex Code
12998 \begin_layout Plain Layout
12999 LabelStringAppendix
13007 \begin_layout Description
13008 \begin_inset Flex Code
13011 \begin_layout Plain Layout
13017 [FIXME] (Used only with XML-type formats.)
13020 \begin_layout Description
13021 \begin_inset Flex Code
13024 \begin_layout Plain Layout
13031 \begin_inset Flex Code
13034 \begin_layout Plain Layout
13040 \change_inserted 1414654397 1360434611
13042 \change_deleted 1414654397 1360434612
13046 \begin_inset Newline newline
13050 \change_inserted 1414654397 1360434627
13052 \change_deleted 1414654397 1360434623
13053 _Top_Environment, Counter,
13055 Sensitive, Enumerate,
13056 \begin_inset Newline newline
13059 Itemize, Bibliography
13068 \begin_layout Description
13069 \begin_inset Flex Code
13072 \begin_layout Plain Layout
13078 means the label is the very first word (up to the first real blank).
13079 Use protected spaces if you want more than one word as the label.
13083 \begin_layout Description
13084 \begin_inset Flex Code
13087 \begin_layout Plain Layout
13093 means the label is simply what is declared as
13094 \begin_inset Flex Code
13097 \begin_layout Plain Layout
13105 \change_deleted 1414654397 1360434660
13106 Note that this really is `static'.
13108 \change_inserted 1414654397 1360434794
13109 This will be displayed
13110 \begin_inset Quotes eld
13114 \begin_inset Quotes erd
13117 , at the beginning of the paragraph.
13119 \begin_inset Flex Code
13122 \begin_layout Plain Layout
13124 \change_inserted 1414654397 1360434743
13133 \begin_inset Flex Code
13136 \begin_layout Plain Layout
13138 \change_inserted 1414654397 1360434747
13146 , then it will be displayed only in the first paragraph in any sequence
13147 of paragraphs with the same
13148 \begin_inset Flex Code
13151 \begin_layout Plain Layout
13153 \change_inserted 1414654397 1360434794
13166 \begin_layout Description
13167 \begin_inset Flex Code
13170 \begin_layout Plain Layout
13172 \change_deleted 1414654397 1360434641
13174 \change_inserted 1414654397 1360434643
13183 \begin_inset space ~
13187 \begin_inset space ~
13191 \begin_inset Flex Code
13194 \begin_layout Plain Layout
13196 \change_deleted 1414654397 1360434649
13204 are special cases of
13205 \begin_inset Flex Code
13208 \begin_layout Plain Layout
13215 The label will be printed above the paragraph
13216 \change_inserted 1414654397 1360434839
13217 either at the beginning of the line or centered
13218 \change_deleted 1414654397 1360434813
13219 , but only at the top of an environment or the top of a chain of paragraphs
13221 This might be used with the
13222 \begin_inset Flex MenuItem
13225 \begin_layout Plain Layout
13236 \begin_layout Description
13237 \begin_inset Flex Code
13240 \begin_layout Plain Layout
13246 is a special case for the caption-labels
13247 \begin_inset Quotes eld
13251 \begin_inset Quotes erd
13255 \begin_inset Quotes eld
13259 \begin_inset Quotes erd
13263 \begin_inset Newline newline
13267 \begin_inset Flex Code
13270 \begin_layout Plain Layout
13276 means the (hardcoded) label string depends on the kind of float: It is
13277 hardcoded to be `FloatType N', where N is the value of the counter associated
13279 For the case that a caption is inserted outside of a float
13280 \change_inserted 1414654397 1360434861
13284 \begin_inset Flex Code
13287 \begin_layout Plain Layout
13294 \change_inserted 1414654397 1360434866
13296 \change_deleted 1414654397 1360434868
13297 should be set to e.
13298 \begin_inset space \thinspace{}
13302 \begin_inset space \space{}
13308 \begin_inset Quotes eld
13312 \begin_inset Quotes erd
13318 \begin_layout Description
13320 \change_deleted 1414654397 1360434875
13321 \begin_inset Flex Code
13324 \begin_layout Plain Layout
13330 defines automatically numbered labels.
13332 \begin_inset Flex Code
13335 \begin_layout Plain Layout
13341 will be expanded to contain any counters: So the result will for example
13343 \begin_inset Quotes eld
13347 \begin_inset Flex Code
13350 \begin_layout Plain Layout
13361 \begin_inset Quotes erd
13366 \begin_inset space ~
13370 \begin_inset CommandInset ref
13372 reference "sub:Counters"
13376 for more information on counters.
13379 \begin_layout Description
13380 \begin_inset Flex Code
13383 \begin_layout Plain Layout
13389 produces the usual sort of enumeration labels.
13390 At present, it is hardcoded to use Arabic numerals, lowercase letters,
13391 small Roman numerals, and uppercase letters for the four possible depths.
13394 \begin_layout Description
13395 \begin_inset Flex Code
13398 \begin_layout Plain Layout
13404 produces various bullets at the different levels.
13405 It is also hardcoded.
13408 \begin_layout Description
13409 \begin_inset Flex Code
13412 \begin_layout Plain Layout
13419 \change_deleted 1414654397 1360434898
13420 is used internally by LyX and
13422 should be used only with
13423 \begin_inset Flex Code
13426 \begin_layout Plain Layout
13427 LatexType BibEnvironment
13436 \begin_layout Description
13437 \begin_inset Flex Code
13440 \begin_layout Plain Layout
13446 Note that this will completely override any prior
13447 \begin_inset Flex Code
13450 \begin_layout Plain Layout
13456 declaration for this style.
13458 \begin_inset Quotes eld
13462 \begin_inset Flex Code
13465 \begin_layout Plain Layout
13472 \begin_inset Quotes erd
13477 \begin_inset CommandInset ref
13479 reference "sub:I18n"
13483 for details on its use.
13486 \begin_layout Description
13487 \begin_inset Flex Code
13490 \begin_layout Plain Layout
13497 \begin_inset Flex Code
13500 \begin_layout Plain Layout
13506 ] The name of the corresponding LaTeX stuff.
13507 Either the environment or command name.
13510 \begin_layout Description
13511 \begin_inset Flex Code
13514 \begin_layout Plain Layout
13521 \begin_inset Flex Code
13524 \begin_layout Plain Layout
13530 ] An optional parameter for the corresponding
13531 \begin_inset Flex Code
13534 \begin_layout Plain Layout
13541 This parameter cannot be changed from within LyX
13542 \change_inserted -712698321 1355144804
13544 \begin_inset Flex Code
13547 \begin_layout Plain Layout
13549 \change_inserted -712698321 1355144804
13555 for customizable parameters)
13559 \change_inserted -712698321 1355144804
13560 This will be output as is after all LaTeX
13561 \begin_inset Flex Code
13564 \begin_layout Plain Layout
13566 \change_inserted -712698321 1355144658
13579 \begin_layout Description
13580 \begin_inset Flex Code
13583 \begin_layout Plain Layout
13590 \begin_inset Flex Code
13593 \begin_layout Plain Layout
13598 , Command, Environment, Item_Environment,
13599 \begin_inset Newline newline
13602 List_Environment, Bib_Environment
13607 ] How the style should be translated into LaTeX.
13611 \begin_layout Plain Layout
13612 \begin_inset Flex Code
13615 \begin_layout Plain Layout
13621 is perhaps a bit misleading, since these rules apply to SGML classes, too.
13622 Visit the SGML class files for specific examples.
13631 \begin_layout Description
13632 \begin_inset Flex Code
13635 \begin_layout Plain Layout
13641 means nothing special.
13644 \begin_layout Description
13645 \begin_inset Flex Code
13648 \begin_layout Plain Layout
13655 \begin_inset Flex Code
13658 \begin_layout Plain Layout
13665 {\SpecialChar \ldots{}
13674 \begin_layout Description
13675 \begin_inset Flex Code
13678 \begin_layout Plain Layout
13685 \begin_inset Flex Code
13688 \begin_layout Plain Layout
13695 }\SpecialChar \ldots{}
13711 \begin_layout Description
13712 \begin_inset Flex Code
13715 \begin_layout Plain Layout
13722 \begin_inset Flex Code
13725 \begin_layout Plain Layout
13732 \begin_inset Flex Code
13735 \begin_layout Plain Layout
13743 is generated for each paragraph of this environment.
13747 \begin_layout Description
13748 \begin_inset Flex Code
13751 \begin_layout Plain Layout
13758 \begin_inset Flex Code
13761 \begin_layout Plain Layout
13768 \begin_inset Newline newline
13772 \begin_inset Flex Code
13775 \begin_layout Plain Layout
13781 is passed as an argument to the environment.
13782 \begin_inset Newline newline
13786 \begin_inset Flex Code
13789 \begin_layout Plain Layout
13795 can be defined in the
13796 \begin_inset Flex MenuItem
13799 \begin_layout Plain Layout
13800 Edit\SpecialChar \menuseparator
13802 \begin_inset space ~
13813 \begin_layout Description
13814 \begin_inset Flex Code
13817 \begin_layout Plain Layout
13824 \begin_inset Flex Code
13827 \begin_layout Plain Layout
13833 but adds additionally the necessary mandatory argument (the longest label)
13834 to the begin statement of the bibliography environment:
13835 \begin_inset Newline newline
13839 \begin_inset Flex Code
13842 \begin_layout Plain Layout
13845 begin{thebibliography}{99}
13850 It is therefore only useful for bibliography environments.
13851 The default longest label
13852 \begin_inset Quotes eld
13856 \begin_inset Quotes erd
13859 can be changed by the user in the paragraph settings of a bibliography
13863 \begin_layout Standard
13864 Putting the last few things together, the LaTeX output will be either:
13867 \begin_layout LyX-Code
13870 LatexName[LatexParam]{\SpecialChar \ldots{}
13874 \begin_layout Standard
13878 \begin_layout LyX-Code
13881 begin{LatexName}[LatexParam] \SpecialChar \ldots{}
13887 \begin_layout Standard
13888 depending upon the LaTeX type.
13892 \begin_layout Description
13894 \change_inserted -712698321 1354263086
13895 \begin_inset Flex Code
13898 \begin_layout Plain Layout
13900 \change_inserted -712698321 1353866852
13907 \begin_inset Flex Code
13910 \begin_layout Plain Layout
13912 \change_inserted -712698321 1353866852
13918 ] A string that is put at the beginning of the style content.
13919 A line break in the output can be indicated by
13920 \begin_inset Flex Code
13923 \begin_layout Plain Layout
13925 \change_inserted -712698321 1354263086
13936 \begin_layout Description
13937 \begin_inset Flex Code
13940 \begin_layout Plain Layout
13947 \begin_inset Flex Code
13950 \begin_layout Plain Layout
13956 ] If you put styles into environments, the different
13957 \begin_inset Flex Code
13960 \begin_layout Plain Layout
13966 are not simply added, but added with a factor
13967 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
13971 Note that this parameter is also used when
13972 \begin_inset Flex Code
13975 \begin_layout Plain Layout
13982 \begin_inset Flex Code
13985 \begin_layout Plain Layout
13992 \begin_inset Flex Code
13995 \begin_layout Plain Layout
14002 Then it is added to the manual or dynamic margin.
14003 \begin_inset Newline newline
14007 \begin_inset Quotes eld
14011 \begin_inset Flex Code
14014 \begin_layout Plain Layout
14021 \begin_inset Quotes erd
14024 means that the paragraph is indented with the width of
14025 \begin_inset Quotes eld
14029 \begin_inset Flex Code
14032 \begin_layout Plain Layout
14039 \begin_inset Quotes erd
14042 in the normal font.
14043 You can get a negative width by prefixing the string with
14044 \begin_inset Quotes eld
14048 \begin_inset Flex Code
14051 \begin_layout Plain Layout
14058 \begin_inset Quotes erd
14062 This way was chosen so that the look is the same with each used screen
14066 \begin_layout Description
14067 \begin_inset Flex Code
14070 \begin_layout Plain Layout
14077 \begin_inset Flex Code
14080 \begin_layout Plain Layout
14085 , Manual, Dynamic, First_Dynamic, Right_Address_Box
14091 \begin_inset Newline newline
14094 The kind of margin that the style has on the left side.
14098 \begin_layout Description
14099 \begin_inset Flex Code
14102 \begin_layout Plain Layout
14108 just means a fixed margin.
14111 \begin_layout Description
14112 \begin_inset Flex Code
14115 \begin_layout Plain Layout
14121 means that the left margin depends on the string entered in the
14122 \begin_inset Flex MenuItem
14125 \begin_layout Plain Layout
14126 Edit\SpecialChar \menuseparator
14128 \begin_inset space ~
14137 This is used to typeset nice lists without tabulators.
14140 \begin_layout Description
14141 \begin_inset Flex Code
14144 \begin_layout Plain Layout
14150 means that the margin depends on the size of the label.
14151 This is used for automatic enumerated headlines.
14152 It is obvious that the headline
14153 \begin_inset Quotes eld
14156 5.4.3.2.1 Very long headline
14157 \begin_inset Quotes erd
14160 must have a wider left margin (as wide as
14161 \begin_inset Quotes eld
14165 \begin_inset Quotes erd
14168 plus the space) than
14169 \begin_inset Quotes eld
14172 3.2 Very long headline
14173 \begin_inset Quotes erd
14177 \begin_inset Quotes eld
14181 \begin_inset Quotes erd
14184 are not able to do this.
14187 \begin_layout Description
14188 \begin_inset Flex Code
14191 \begin_layout Plain Layout
14197 is similar, but only the very first row of the paragraph is dynamic, while
14198 the others are static; this is used, for example, for descriptions.
14201 \begin_layout Description
14202 \begin_inset Flex Code
14205 \begin_layout Plain Layout
14211 means the margin is chosen in a way that the longest row of this paragraph
14212 fits to the right margin.
14213 This is used to typeset an address on the right edge of the page.
14217 \begin_layout Description
14218 \begin_inset Flex Code
14221 \begin_layout Plain Layout
14228 \begin_inset Flex Code
14231 \begin_layout Plain Layout
14240 \begin_inset space \thinspace{}
14244 \begin_inset Flex Code
14247 \begin_layout Plain Layout
14253 ] Whether fragile commands in this style should be
14254 \begin_inset Flex Code
14257 \begin_layout Plain Layout
14270 whether this command should itself be protected.)
14273 \begin_layout Description
14274 \begin_inset Flex Code
14277 \begin_layout Plain Layout
14284 \begin_inset Flex Code
14287 \begin_layout Plain Layout
14294 \begin_inset space \thinspace{}
14298 \begin_inset Flex Code
14301 \begin_layout Plain Layout
14309 ] Whether newlines are translated into LaTeX newlines (
14310 \begin_inset Flex Code
14313 \begin_layout Plain Layout
14324 The translation can be switched off to allow more comfortable LaTeX editing
14328 \begin_layout Description
14329 \begin_inset Flex Code
14332 \begin_layout Plain Layout
14339 \begin_inset Flex Code
14342 \begin_layout Plain Layout
14351 \begin_inset space \thinspace{}
14355 \begin_inset Flex Code
14358 \begin_layout Plain Layout
14364 ] If set to true, and if
14365 \begin_inset Flex Code
14368 \begin_layout Plain Layout
14375 \begin_inset Flex Code
14378 \begin_layout Plain Layout
14384 ) paragraphs are being indented, then the indentation of such a paragraph
14385 following one of this type will be suppressed.
14386 (So this will not affect the display of non-default paragraphs.)
14389 \begin_layout Description
14390 \begin_inset Flex Code
14393 \begin_layout Plain Layout
14400 \begin_inset Flex Code
14403 \begin_layout Plain Layout
14409 ] Name of a style that has replaced this style.
14410 This is used to rename a style, while keeping backward compatibility.
14413 \begin_layout Description
14415 \change_deleted -712698321 1353679722
14416 \begin_inset Flex Code
14419 \begin_layout Plain Layout
14426 \begin_inset Flex Code
14429 \begin_layout Plain Layout
14435 ] The number of optional arguments that can be used with this style.
14436 This is useful for things like section headings, and only makes sense with
14438 Note that, on output, the optional arguments will all precede any required
14439 arguments (see below).
14440 So one can have constructs like:
14444 \begin_layout LyX-Code
14446 \change_deleted -712698321 1353679722
14449 mycmd[opt1]{req1}{contents of paragraph}
14452 \begin_layout Standard
14454 \change_deleted -712698321 1353679722
14455 but one cannot have things like:
14458 \begin_layout LyX-Code
14460 \change_deleted -712698321 1353679722
14463 mycmd[opt1]{req1}[opt2]{contents of paragraph}
14466 \begin_layout Standard
14468 \change_deleted -712698321 1353679722
14469 at least, not without ERT (with which you can have anything).
14476 \begin_layout Description
14477 \begin_inset Flex Code
14480 \begin_layout Plain Layout
14487 \begin_inset Flex Code
14490 \begin_layout Plain Layout
14499 \begin_inset space \thinspace{}
14503 \begin_inset Flex Code
14506 \begin_layout Plain Layout
14512 ] Indicates that paragraphs will not be separated by an empty line in LaTeX
14513 output, but only by a line break; together with
14514 \begin_inset Flex Code
14517 \begin_layout Plain Layout
14523 , this allows to emulate a plain text editor (like the ERT inset).
14526 \begin_layout Description
14527 \begin_inset Flex Code
14530 \begin_layout Plain Layout
14537 \begin_inset Flex Code
14540 \begin_layout Plain Layout
14546 ] The indent of the very first line of a paragraph.
14548 \begin_inset Newline newline
14552 \begin_inset Flex Code
14555 \begin_layout Plain Layout
14561 will be fixed for a certain style.
14562 The exception is the default style, since the indentation for these paragraphs
14563 can be prohibited with
14564 \begin_inset Flex Code
14567 \begin_layout Plain Layout
14575 \begin_inset Flex Code
14578 \begin_layout Plain Layout
14584 style paragraphs inside environments use the
14585 \begin_inset Flex Code
14588 \begin_layout Plain Layout
14594 of the environment, not their native one.
14596 \begin_inset Flex Code
14599 \begin_layout Plain Layout
14605 paragraphs inside an enumeration are not indented.
14608 \begin_layout Description
14609 \begin_inset Flex Code
14612 \begin_layout Plain Layout
14619 \begin_inset Flex Code
14622 \begin_layout Plain Layout
14628 ] The vertical space between two paragraphs of this style.
14631 \begin_layout Description
14632 \begin_inset Flex Code
14635 \begin_layout Plain Layout
14642 \begin_inset Flex Code
14645 \begin_layout Plain Layout
14651 ] LyX allows the user to choose either
14652 \begin_inset Quotes eld
14656 \begin_inset Quotes erd
14660 \begin_inset Quotes eld
14664 \begin_inset Quotes erd
14667 to separate paragraphs.
14669 \begin_inset Quotes eld
14673 \begin_inset Quotes erd
14677 \begin_inset Flex Code
14680 \begin_layout Plain Layout
14688 \begin_inset Quotes eld
14692 \begin_inset Quotes erd
14696 \begin_inset Flex Code
14699 \begin_layout Plain Layout
14705 is ignored and all paragraphs are separated by the
14706 \begin_inset Flex Code
14709 \begin_layout Plain Layout
14716 The vertical space is calculated with
14717 \begin_inset Flex Code
14720 \begin_layout Plain Layout
14722 \begin_inset space ~
14731 \begin_inset Flex Code
14734 \begin_layout Plain Layout
14740 is the height of a row with the normal font.
14741 This way, the look stays the same with different screen fonts.
14744 \begin_layout Description
14745 \begin_inset Flex Code
14748 \begin_layout Plain Layout
14755 \begin_inset Flex Code
14758 \begin_layout Plain Layout
14767 \begin_inset space \thinspace{}
14771 \begin_inset Flex Code
14774 \begin_layout Plain Layout
14780 ] Whether the contents of this paragraph should be output in raw form, meaning
14781 without special translations that LaTeX would require.
14784 \begin_layout Description
14785 \begin_inset Flex Code
14788 \begin_layout Plain Layout
14794 Information to be included in the LaTeX preamble when this style is used.
14795 Used to define macros, load packages, etc., required by this particular
14798 \begin_inset Quotes eld
14802 \begin_inset Flex Code
14805 \begin_layout Plain Layout
14812 \begin_inset Quotes erd
14818 \begin_layout Description
14819 \begin_inset Flex Code
14822 \begin_layout Plain Layout
14829 \begin_inset Flex Code
14832 \begin_layout Plain Layout
14838 ] The prefix to use when creating labels referring to paragraphs of this
14840 This allows the use of formatted references.
14843 \begin_layout Description
14845 \change_deleted -712698321 1353681258
14846 \begin_inset Flex Code
14849 \begin_layout Plain Layout
14856 \begin_inset Flex Code
14859 \begin_layout Plain Layout
14865 ] The number of required arguments that the LaTeX command or environment
14866 corresponding to this style expects.
14867 In the case of a command, these are required arguments
14871 that associated with the content of the paragraph itself.
14872 These do not actually have to be provided: LyX will output empty arguments
14874 Note that optional arguments will be output before required arguments.
14875 See the discussion of the
14876 \begin_inset Flex Code
14879 \begin_layout Plain Layout
14885 tag above for more information.
14890 \begin_layout Description
14891 \begin_inset Flex Code
14894 \begin_layout Plain Layout
14901 \begin_inset Flex Code
14904 \begin_layout Plain Layout
14910 ] Whether the style requires the feature
14911 \begin_inset Flex Code
14914 \begin_layout Plain Layout
14921 See the description of
14922 \begin_inset Flex Code
14925 \begin_layout Plain Layout
14932 \begin_inset space ~
14936 \begin_inset CommandInset ref
14938 reference "sub:General-text-class"
14942 ) for information on `features'.
14945 \begin_layout Description
14947 \change_inserted -712698321 1353693371
14948 \begin_inset Flex Code
14951 \begin_layout Plain Layout
14953 \change_inserted -712698321 1353693146
14962 \begin_inset Flex Code
14965 \begin_layout Plain Layout
14967 \change_inserted -712698321 1353693235
14976 \begin_inset Flex Code
14979 \begin_layout Plain Layout
14981 \change_inserted -712698321 1353693235
14987 ] Resets the LaTeX arguments of this style (as defined via the
14988 \begin_inset Flex Code
14991 \begin_layout Plain Layout
14993 \change_inserted -712698321 1353693371
15002 This is useful if you have copied a style via
15003 \begin_inset Flex Code
15006 \begin_layout Plain Layout
15008 \change_inserted -712698321 1353693302
15016 , but you do not want to inherit its (required and optional) arguments.
15021 \begin_layout Description
15023 \change_inserted -712698321 1354263074
15024 \begin_inset Flex Code
15027 \begin_layout Plain Layout
15029 \change_inserted -712698321 1353866876
15036 \begin_inset Flex Code
15039 \begin_layout Plain Layout
15041 \change_inserted -712698321 1353866873
15047 ] A string that is put at the end of the layout content.
15048 A line break in the output can be indicated by
15049 \begin_inset Flex Code
15052 \begin_layout Plain Layout
15054 \change_inserted -712698321 1354263069
15065 \begin_layout Description
15066 \begin_inset Flex Code
15069 \begin_layout Plain Layout
15076 \begin_inset Flex Code
15079 \begin_layout Plain Layout
15086 \begin_inset Flex Code
15089 \begin_layout Plain Layout
15098 \begin_layout Description
15099 \begin_inset Flex Code
15102 \begin_layout Plain Layout
15109 \begin_inset Flex Code
15112 \begin_layout Plain Layout
15121 \begin_inset Flex Code
15124 \begin_layout Plain Layout
15131 \begin_inset Flex Code
15134 \begin_layout Plain Layout
15141 \begin_inset Flex Code
15144 \begin_layout Plain Layout
15146 \begin_inset space ~
15154 ] This defines what the default spacing should be in the style.
15156 \begin_inset Flex Code
15159 \begin_layout Plain Layout
15166 \begin_inset Flex Code
15169 \begin_layout Plain Layout
15176 \begin_inset Flex Code
15179 \begin_layout Plain Layout
15185 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
15186 If you specify the argument
15187 \begin_inset Flex Code
15190 \begin_layout Plain Layout
15196 , then you must also provide a value argument which will be the actual multiplie
15198 Note that, contrary to other parameters,
15199 \begin_inset Flex Code
15202 \begin_layout Plain Layout
15208 implies the generation of specific LaTeX code, using the LaTeX package
15212 \begin_inset Flex Code
15215 \begin_layout Plain Layout
15224 \begin_layout Description
15225 \begin_inset Flex Code
15228 \begin_layout Plain Layout
15235 \begin_inset Flex Code
15238 \begin_layout Plain Layout
15245 \begin_inset space \thinspace{}
15249 \begin_inset Flex Code
15252 \begin_layout Plain Layout
15260 ] Allow spell-checking paragraphs of this style.
15264 \begin_layout Description
15265 \begin_inset Flex Code
15268 \begin_layout Plain Layout
15274 The font used for the text body .
15276 \begin_inset CommandInset ref
15278 reference "sub:Font-description"
15285 \begin_layout Description
15286 \begin_inset Flex Code
15289 \begin_layout Plain Layout
15298 \begin_inset Flex Code
15301 \begin_layout Plain Layout
15311 The level of the style in the table of contents.
15312 This is used for automatic numbering of section headings.
15315 \begin_layout Description
15316 \begin_inset Flex Code
15319 \begin_layout Plain Layout
15326 \begin_inset Flex Code
15329 \begin_layout Plain Layout
15335 ] The vertical space with which the very first of a chain of paragraphs
15336 with this style is separated from the previous paragraph.
15337 If the previous paragraph has another style, the separations are not simply
15338 added, but the maximum is taken.
15341 \begin_layout Subsection
15342 \begin_inset CommandInset label
15348 Internationalization of Paragraph Styles
15351 \begin_layout Standard
15352 LyX has long supported internationalization of layout information, but,
15353 until version 2.0, this applied only to the user interface and not to, say,
15355 Thus, French authors were forced to resort to ugly hacks if they wanted
15360 1' instead of `Theorem 1'.
15361 Thanks to Georg Baum, that is no longer the case.
15364 \begin_layout Standard
15366 \begin_inset Flex Code
15369 \begin_layout Plain Layout
15375 defines text that is to appear in the typeset document, it may use
15376 \begin_inset Flex Code
15379 \begin_layout Plain Layout
15386 \begin_inset Flex Code
15389 \begin_layout Plain Layout
15395 to support non-English and even multi-language documents correctly.
15396 The following excerpt (from the
15397 \begin_inset Flex Code
15400 \begin_layout Plain Layout
15406 file) shows how this works:
15409 \begin_layout LyX-Code
15414 \begin_layout LyX-Code
15417 theoremstyle{remark}
15420 \begin_layout LyX-Code
15423 newtheorem{claim}[thm]{
15430 \begin_layout LyX-Code
15434 \begin_layout LyX-Code
15438 \begin_layout LyX-Code
15443 claimname}{_(Claim)}
15446 \begin_layout LyX-Code
15450 \begin_layout LyX-Code
15454 \begin_layout LyX-Code
15463 claimname}{_(Claim)}}
15466 \begin_layout LyX-Code
15471 \begin_layout Standard
15472 In principle, any legal LaTeX may appear in the
15473 \begin_inset Flex Code
15476 \begin_layout Plain Layout
15483 \begin_inset Flex Code
15486 \begin_layout Plain Layout
15492 tags, but in practice they will typically look as they do here.
15493 The key to correct translation of the typeset text is the definition of
15495 \begin_inset Flex Code
15498 \begin_layout Plain Layout
15507 \begin_inset Flex Code
15510 \begin_layout Plain Layout
15522 \begin_layout Standard
15524 \begin_inset Flex Code
15527 \begin_layout Plain Layout
15533 tag provides for internationalization based upon the overall language of
15535 The contents of the tag will be included in the preamble, just as with
15537 \begin_inset Flex Code
15540 \begin_layout Plain Layout
15547 What makes it special is the use of the
15548 \begin_inset Quotes eld
15552 \begin_inset Quotes erd
15556 \begin_inset Flex Code
15559 \begin_layout Plain Layout
15565 , which will be replaced, when LyX produces LaTeX output, with the translation
15566 of its argument into the document language.
15569 \begin_layout Standard
15571 \begin_inset Flex Code
15574 \begin_layout Plain Layout
15580 tag is more complex, since it is meant to provide support for multi-language
15581 documents and so offers an interface to the
15582 \begin_inset Flex Code
15585 \begin_layout Plain Layout
15592 Its contents will be added to the preamble once for each language that
15593 appears in the document.
15594 In this case, the argument to
15595 \begin_inset Flex Code
15598 \begin_layout Plain Layout
15604 will be replaced with its translation into the language in question; the
15606 \begin_inset Flex Code
15609 \begin_layout Plain Layout
15615 is replaced by the language name (as used by the babel package).
15618 \begin_layout Standard
15619 A German document that also included a French section would thus have the
15620 following in the preamble:
15623 \begin_layout LyX-Code
15632 claimname}{Affirmation}}
15633 \begin_inset Newline newline
15644 claimname}{Behauptung}}
15645 \begin_inset Newline newline
15652 claimname}{Behauptung}
15655 \begin_layout Standard
15657 \begin_inset Flex Code
15660 \begin_layout Plain Layout
15666 will then conspire to produce the correct text in the output.
15669 \begin_layout Standard
15670 One important point to note here is that the translations are provided by
15671 LyX itself, through the
15672 \change_inserted -195340706 1334775793
15674 \begin_inset Flex Code
15677 \begin_layout Plain Layout
15679 \change_inserted -195340706 1334775793
15686 \change_deleted -195340706 1334775793
15687 same mechanism it uses for internationalization of the user interface
15690 This means, in effect, that
15691 \begin_inset Flex Code
15694 \begin_layout Plain Layout
15701 \begin_inset Flex Code
15704 \begin_layout Plain Layout
15710 are really only of use in layout files that are provided with LyX, since
15711 text entered in user-created layout files will not be seen by LyX's internation
15713 \change_inserted -195340706 1334775793
15715 \begin_inset Flex Code
15718 \begin_layout Plain Layout
15720 \change_inserted -195340706 1334775793
15726 file is modified accordingly
15729 That said, however, any layout created with the intention that it will
15730 be included with LyX should use these tags where appropriate.
15732 \change_inserted -195340706 1334775793
15733 Please note that the paragraph style translations provided by LyX will
15734 never change with a minor update (e.g.
15735 from version 2.1.x to 2.1.y).
15736 It is however quite likely that a major update (e.g.
15737 from 2.0.x to 2.1.y) will introduce new translations or corrections.
15742 \begin_layout Subsection
15744 \begin_inset CommandInset label
15753 \begin_layout Standard
15754 It is necessary to define the floats (
15755 \begin_inset Flex MenuItem
15758 \begin_layout Plain Layout
15765 \begin_inset Flex MenuItem
15768 \begin_layout Plain Layout
15774 , \SpecialChar \ldots{}
15775 ) in the text class itself.
15776 Standard floats are included in the file
15777 \begin_inset Flex Code
15780 \begin_layout Plain Layout
15786 , so you may have to do no more than add
15789 \begin_layout LyX-Code
15790 Input stdfloats.inc
15793 \begin_layout Standard
15794 to your layout file.
15795 If you want to implement a text class that proposes some other float types
15796 (like the AGU class bundled with LyX), the information below will hopefully
15800 \begin_layout Description
15801 \begin_inset Flex Code
15804 \begin_layout Plain Layout
15811 \begin_inset Flex Code
15814 \begin_layout Plain Layout
15821 \begin_inset Quotes erd
15825 \begin_inset Quotes erd
15828 ] The file name extension of an auxiliary file for the list of figures (or
15830 LaTeX writes the captions to this file.
15833 \begin_layout Description
15834 \begin_inset Flex Code
15837 \begin_layout Plain Layout
15844 \begin_inset Flex Code
15847 \begin_layout Plain Layout
15854 \begin_inset Quotes erd
15858 \begin_inset Quotes erd
15861 ] The string that will be used in the menus and also for the caption.
15862 This is translated to the current language if babel is used.
15865 \begin_layout Description
15866 \begin_inset Flex Code
15869 \begin_layout Plain Layout
15875 These tags control the XHTML output.
15877 \begin_inset space ~
15881 \begin_inset CommandInset ref
15883 reference "sec:Tags-for-XHTML"
15890 \begin_layout Description
15891 \begin_inset Flex Code
15894 \begin_layout Plain Layout
15903 \begin_inset Flex Code
15906 \begin_layout Plain Layout
15915 \begin_inset space \thinspace{}
15919 \begin_inset Flex Code
15922 \begin_layout Plain Layout
15928 ] Indicates whether the float is already defined in the document class or
15929 if instead the LaTeX package
15930 \begin_inset Flex Code
15933 \begin_layout Plain Layout
15939 needs to be loaded to define it on-the-fly.
15941 \begin_inset Flex Code
15944 \begin_layout Plain Layout
15951 \begin_inset Flex Code
15954 \begin_layout Plain Layout
15961 It should be set to
15962 \begin_inset Flex Code
15965 \begin_layout Plain Layout
15971 if the float is already defined by the LaTeX document class.
15974 \begin_layout Description
15975 \begin_inset Flex Code
15978 \begin_layout Plain Layout
15985 \begin_inset Flex Code
15988 \begin_layout Plain Layout
15995 \begin_inset Quotes erd
15999 \begin_inset Quotes erd
16002 ] The command used to generate a list of floats of this type; the leading
16011 \begin_inset Flex Code
16014 \begin_layout Plain Layout
16020 is false, since there is no standard way to generate this command.
16022 \begin_inset Flex Code
16025 \begin_layout Plain Layout
16031 is true, since in that case there is a standard way to define the command.
16034 \begin_layout Description
16035 \begin_inset Flex Code
16038 \begin_layout Plain Layout
16045 \begin_inset Flex Code
16048 \begin_layout Plain Layout
16055 \begin_inset Quotes erd
16059 \begin_inset Quotes erd
16062 ] A title for a list of floats of this kind (list of figures, tables, or
16064 It is used for the screen label within LyX, it is used by LaTeX for the
16065 title and it is used as the title in the XHTML output.
16066 It will be translated to the document language.
16069 \begin_layout Description
16070 \begin_inset Flex Code
16073 \begin_layout Plain Layout
16080 \begin_inset Flex Code
16083 \begin_layout Plain Layout
16090 \begin_inset Quotes erd
16094 \begin_inset Quotes erd
16097 ] This (optional) argument determines whether floats of this class will
16098 be numbered within some sectional unit of the document.
16100 \begin_inset Flex Code
16103 \begin_layout Plain Layout
16110 \begin_inset Quotes eld
16114 \begin_inset Flex Code
16117 \begin_layout Plain Layout
16124 \begin_inset Quotes erd
16127 , the floats will be numbered within chapters.
16131 \begin_layout Description
16132 \begin_inset Flex Code
16135 \begin_layout Plain Layout
16142 \begin_inset Flex Code
16145 \begin_layout Plain Layout
16152 \begin_inset Quotes erd
16156 \begin_inset Quotes erd
16159 ] The default placement for the given class of floats.
16160 The string should be as in standard LaTeX:
16161 \begin_inset Flex Code
16164 \begin_layout Plain Layout
16171 \begin_inset Flex Code
16174 \begin_layout Plain Layout
16181 \begin_inset Flex Code
16184 \begin_layout Plain Layout
16191 \begin_inset Flex Code
16194 \begin_layout Plain Layout
16200 for top, bottom, page, and here, respectively.
16204 \begin_layout Plain Layout
16205 Note that the order of these letters in the string is irrelevant, like in
16211 On top of that there is a new type,
16212 \begin_inset Flex Code
16215 \begin_layout Plain Layout
16221 , which does not really correspond to a float, since it means: put it
16222 \begin_inset Quotes eld
16226 \begin_inset Quotes erd
16230 Note however that the
16231 \begin_inset Flex Code
16234 \begin_layout Plain Layout
16240 specifier is special and, because of implementation details, cannot be
16241 used in non-built in float types.
16242 If you do not understand what this means, just use
16243 \begin_inset Quotes eld
16247 \begin_inset Flex Code
16250 \begin_layout Plain Layout
16257 \begin_inset Quotes erd
16263 \begin_layout Description
16264 \begin_inset Flex Code
16267 \begin_layout Plain Layout
16274 \begin_inset Flex Code
16277 \begin_layout Plain Layout
16283 ] The prefix to use when creating labels referring to floats of this type.
16284 This allows the use of formatted references.
16285 Note that you can remove any
16286 \begin_inset Flex Code
16289 \begin_layout Plain Layout
16295 set by a copied style by using the special value
16296 \begin_inset Quotes eld
16300 \begin_inset Quotes erd
16303 , which must be all caps.
16306 \begin_layout Description
16307 \begin_inset Flex Code
16310 \begin_layout Plain Layout
16317 \begin_inset Flex Code
16320 \begin_layout Plain Layout
16327 \begin_inset Quotes erd
16331 \begin_inset Quotes erd
16334 ] The style used when defining the float using
16335 \begin_inset Flex Code
16338 \begin_layout Plain Layout
16349 \begin_layout Description
16350 \begin_inset Flex Code
16353 \begin_layout Plain Layout
16360 \begin_inset Flex Code
16363 \begin_layout Plain Layout
16370 \begin_inset Quotes erd
16374 \begin_inset Quotes erd
16378 \begin_inset Quotes eld
16382 \begin_inset Quotes erd
16385 of the new class of floats, like program or algorithm.
16386 After the appropriate
16387 \begin_inset Flex Code
16390 \begin_layout Plain Layout
16399 \begin_inset Flex Code
16402 \begin_layout Plain Layout
16411 \begin_inset Flex Code
16414 \begin_layout Plain Layout
16425 \begin_layout Description
16426 \begin_inset Flex Code
16429 \begin_layout Plain Layout
16436 \begin_inset Flex Code
16439 \begin_layout Plain Layout
16446 \begin_inset space \thinspace{}
16450 \begin_inset Flex Code
16453 \begin_layout Plain Layout
16461 ] Specifies whether this float is defined using the LaTeX package
16462 \begin_inset Flex Code
16465 \begin_layout Plain Layout
16471 , either by the class file, another package or on-the-fly by LyX itself.
16474 \begin_layout Standard
16475 Note that defining a float with type
16476 \begin_inset Flex Code
16479 \begin_layout Plain Layout
16487 automatically defines the corresponding counter with name
16488 \begin_inset Flex Code
16491 \begin_layout Plain Layout
16502 \begin_layout Subsection
16503 Flex insets and InsetLayout
16504 \begin_inset CommandInset label
16506 name "sub:Flex-insets-and"
16513 \begin_layout Standard
16514 Flex insets come in three different kinds:
16517 \begin_layout Itemize
16519 \begin_inset Flex Code
16522 \begin_layout Plain Layout
16528 ): These define semantic markup corresponding to such LaTeX commands as
16530 \begin_inset Flex Code
16533 \begin_layout Plain Layout
16542 \begin_inset Flex Code
16545 \begin_layout Plain Layout
16556 \begin_layout Itemize
16558 \begin_inset Flex Code
16561 \begin_layout Plain Layout
16567 ): These can be used to define custom collapsible insets, similar to TeX
16568 code, footnote, and the like.
16569 An obvious example is an endnote inset, which is defined in the
16570 \begin_inset Flex Code
16573 \begin_layout Plain Layout
16582 \begin_layout Itemize
16584 \begin_inset Flex Code
16587 \begin_layout Plain Layout
16593 ): For use with DocBook classes.
16596 \begin_layout Standard
16597 Flex insets are defined using the
16598 \begin_inset Flex Code
16601 \begin_layout Plain Layout
16607 tag, which shall be explained in a moment.
16610 \begin_layout Standard
16612 \begin_inset Flex Code
16615 \begin_layout Plain Layout
16621 tag also serves another function: It can be used to customize the general
16622 layout of many different types of insets.
16624 \begin_inset Flex Code
16627 \begin_layout Plain Layout
16633 can be used to customize the layout parameters for footnotes, marginal
16634 notes, note insets, TeX code (ERT) insets, branches, listings, indexes,
16635 boxes, tables, algorithms, URLs, and
16636 \change_deleted -712698321 1356964515
16638 \change_inserted -712698321 1356964516
16641 s, as well as to define Flex insets.
16644 \begin_layout Standard
16646 \begin_inset Flex Code
16649 \begin_layout Plain Layout
16655 definition must begin with a line of the form:
16658 \begin_layout LyX-Code
16662 \begin_layout Standard
16664 \begin_inset Flex Code
16667 \begin_layout Plain Layout
16673 indicates the inset whose layout is being defined, and here there are
16674 \change_deleted -712698321 1356964888
16676 \change_inserted -712698321 1356964888
16678 \change_deleted 5863208 1334489267
16684 \begin_layout Enumerate
16685 The layout for a pre-existing inset is being modified.
16686 In this case, can be
16687 \begin_inset Flex Code
16690 \begin_layout Plain Layout
16696 any one of the following:
16697 \begin_inset Flex Code
16700 \begin_layout Plain Layout
16707 \begin_inset Flex Code
16710 \begin_layout Plain Layout
16717 \begin_inset Flex Code
16720 \begin_layout Plain Layout
16727 \begin_inset Flex Code
16730 \begin_layout Plain Layout
16737 \change_inserted -712698321 1356964563
16739 \begin_inset Flex Code
16742 \begin_layout Plain Layout
16744 \change_inserted -712698321 1356964560
16755 \begin_inset Flex Code
16758 \begin_layout Plain Layout
16765 \begin_inset Flex Code
16768 \begin_layout Plain Layout
16775 \begin_inset Flex Code
16778 \begin_layout Plain Layout
16785 \begin_inset Flex Code
16788 \begin_layout Plain Layout
16795 \begin_inset Flex Code
16798 \begin_layout Plain Layout
16805 \begin_inset Flex Code
16808 \begin_layout Plain Layout
16815 \begin_inset Flex Code
16818 \begin_layout Plain Layout
16825 \begin_inset Flex Code
16828 \begin_layout Plain Layout
16835 \begin_inset Flex Code
16838 \begin_layout Plain Layout
16845 \begin_inset Flex Code
16848 \begin_layout Plain Layout
16855 \begin_inset Flex Code
16858 \begin_layout Plain Layout
16865 \begin_inset Flex Code
16868 \begin_layout Plain Layout
16875 \begin_inset Flex Code
16878 \begin_layout Plain Layout
16885 \change_deleted -712698321 1356964592
16887 \begin_inset Flex Code
16890 \begin_layout Plain Layout
16892 \change_deleted -712698321 1353866704
16896 \change_inserted -712698321 1353866707
16907 \begin_inset Flex Code
16910 \begin_layout Plain Layout
16917 \begin_inset Flex Code
16920 \begin_layout Plain Layout
16929 \begin_layout Enumerate
16930 The layout for a Flex inset is being defined.
16932 \begin_inset Flex Code
16935 \begin_layout Plain Layout
16941 must be of the form
16942 \begin_inset Quotes eld
16946 \begin_inset Flex Code
16949 \begin_layout Plain Layout
16956 \begin_inset Quotes erd
16960 \begin_inset Flex Code
16963 \begin_layout Plain Layout
16969 may be be any valid identifier not used by a pre-existing Flex inset.
16970 The identifier may include spaces, but in that case the whole thing must
16971 be wrapped in quotes.
16972 Note that the definition of a flex inset
16977 \begin_inset Flex Code
16980 \begin_layout Plain Layout
16986 entry, declaring which type of inset it defines.
16987 \change_inserted 5863208 1334489312
16991 \begin_layout Enumerate
16993 \change_inserted 5863208 1334492248
16994 The layout for user specific branch is being defined.
16996 \begin_inset Flex Code
16999 \begin_layout Plain Layout
17001 \change_inserted 5863208 1334489384
17007 must be of the form
17008 \begin_inset Quotes eld
17012 \begin_inset Flex Code
17015 \begin_layout Plain Layout
17017 \change_inserted 5863208 1334489392
17024 \begin_inset Quotes erd
17028 \begin_inset Flex Code
17031 \begin_layout Plain Layout
17033 \change_inserted 5863208 1334489384
17039 may be be any valid identifier of branch defined in user's document.
17040 The identifier may include spaces, but in that case the whole thing must
17041 be wrapped in quotes.
17042 The main purpose of this feature is to allow LaTeX wrapping around specific
17043 branches as user needs.
17044 \change_inserted -712698321 1356964893
17048 \begin_layout Enumerate
17050 \change_inserted -712698321 1356965125
17051 The layout of a user (or class) specific caption is being defined.
17053 \begin_inset Flex Code
17056 \begin_layout Plain Layout
17058 \change_inserted -712698321 1356964939
17064 must be of the form
17065 \begin_inset Quotes eld
17069 \begin_inset Flex Code
17072 \begin_layout Plain Layout
17074 \change_inserted -712698321 1356964943
17081 \begin_inset Quotes erd
17085 \begin_inset Flex Code
17088 \begin_layout Plain Layout
17090 \change_inserted -712698321 1356964939
17096 specifies the name of the caption as it appears in the menu.
17097 Have a look at the standard caption (
17098 \begin_inset Flex Code
17101 \begin_layout Plain Layout
17103 \change_inserted -712698321 1356964987
17109 ), the specific captions of the KOMA-Script classes (
17110 \begin_inset Flex Code
17113 \begin_layout Plain Layout
17115 \change_inserted -712698321 1356965018
17122 \begin_inset Flex Code
17125 \begin_layout Plain Layout
17127 \change_inserted -712698321 1356965021
17138 \begin_inset Flex Code
17141 \begin_layout Plain Layout
17143 \change_inserted -712698321 1356965045
17149 ) for applications.
17154 \begin_layout Standard
17156 \begin_inset Flex Code
17159 \begin_layout Plain Layout
17165 definition can contain the following entries:
17168 \begin_layout Description
17170 \change_inserted -712698321 1353681390
17171 \begin_inset Flex Code
17174 \begin_layout Plain Layout
17176 \change_inserted -712698321 1353681344
17183 \begin_inset Flex Code
17186 \begin_layout Plain Layout
17188 \change_inserted -712698321 1353681344
17194 ] Defines argument number <int> of a command\SpecialChar \slash{}
17195 environment associated with
17196 the current layout.
17197 The definition must end with
17198 \begin_inset Flex Code
17201 \begin_layout Plain Layout
17203 \change_inserted -712698321 1353681344
17211 \begin_inset space ~
17215 \begin_inset CommandInset ref
17217 reference "sub:Paragraph-Styles"
17224 \begin_layout Description
17226 \change_inserted -195340706 1333913893
17227 \begin_inset Flex Code
17230 \begin_layout Plain Layout
17236 Preamble for changing languages.
17238 \begin_inset space ~
17242 \begin_inset CommandInset ref
17244 reference "sub:I18n"
17251 \begin_layout Description
17252 \begin_inset Flex Code
17255 \begin_layout Plain Layout
17262 \begin_inset Flex Code
17265 \begin_layout Plain Layout
17271 ] The color for the inset's background.
17273 \begin_inset space ~
17277 \begin_inset CommandInset ref
17279 reference "chap:Names-of-colors"
17283 for a list of the available color names.
17286 \begin_layout Description
17287 \begin_inset Flex Code
17290 \begin_layout Plain Layout
17297 \begin_inset Flex Code
17300 \begin_layout Plain Layout
17309 \begin_inset space \thinspace{}
17313 \begin_inset Flex Code
17316 \begin_layout Plain Layout
17322 ] Whether to use the content of the inset as the label, when the inset is
17327 \begin_layout Description
17328 \begin_inset Flex Code
17331 \begin_layout Plain Layout
17338 \begin_inset Flex Code
17341 \begin_layout Plain Layout
17347 ] As with paragraph styles, see sec.
17348 \begin_inset space ~
17352 \begin_inset CommandInset ref
17354 reference "sub:Paragraph-Styles"
17359 Note that you need to specify the complete type, e.
17360 \begin_inset space \thinspace{}
17364 \begin_inset space ~
17368 \begin_inset Flex Code
17371 \begin_layout Plain Layout
17372 CopyStyle Flex:<name>
17380 \begin_layout Description
17381 \begin_inset Flex Code
17384 \begin_layout Plain Layout
17391 \begin_inset Flex Code
17394 \begin_layout Plain Layout
17403 \begin_inset space \thinspace{}
17407 \begin_inset Flex Code
17410 \begin_layout Plain Layout
17416 ] Indicates whether the user may employ the Paragraph Settings dialog to
17417 customize the paragraph.
17420 \begin_layout Description
17421 \begin_inset Flex Code
17424 \begin_layout Plain Layout
17431 \begin_inset Flex Code
17434 \begin_layout Plain Layout
17441 \begin_inset Flex Code
17444 \begin_layout Plain Layout
17451 \begin_inset Flex Code
17454 \begin_layout Plain Layout
17460 , describing the rendering style used for the inset's frame and buttons.
17461 Footnotes generally use
17462 \begin_inset Flex Code
17465 \begin_layout Plain Layout
17471 , ERT insets generally
17472 \begin_inset Flex Code
17475 \begin_layout Plain Layout
17481 , and character styles
17482 \begin_inset Flex Code
17485 \begin_layout Plain Layout
17494 \begin_layout Description
17495 \begin_inset Flex Code
17498 \begin_layout Plain Layout
17505 \begin_inset Flex Code
17508 \begin_layout Plain Layout
17517 \begin_inset space \thinspace{}
17523 \begin_inset Flex Code
17526 \begin_layout Plain Layout
17535 \begin_inset Flex Code
17538 \begin_layout Plain Layout
17545 \begin_inset Flex Code
17548 \begin_layout Plain Layout
17555 Indicates whether the environment will stand on its own in the output or
17556 will appear inline with the surrounding text.
17557 If set to false, it is supposed that the LaTeX environment ignores white
17558 space (including one newline character) after the
17559 \begin_inset Flex Code
17562 \begin_layout Plain Layout
17575 \begin_inset Flex Code
17578 \begin_layout Plain Layout
17594 \begin_layout Description
17595 \begin_inset Flex Code
17598 \begin_layout Plain Layout
17604 Required at the end of the
17605 \begin_inset Flex Code
17608 \begin_layout Plain Layout
17617 \begin_layout Description
17618 \begin_inset Flex Code
17621 \begin_layout Plain Layout
17627 The font used for both the text body
17633 \begin_inset space ~
17637 \begin_inset CommandInset ref
17639 reference "sub:Font-description"
17644 Note that defining this font automatically defines the
17645 \begin_inset Flex Code
17648 \begin_layout Plain Layout
17654 to the same value, so define this first and define
17655 \begin_inset Flex Code
17658 \begin_layout Plain Layout
17664 later if you want them to be different.
17665 \change_inserted 155139281 1354130923
17669 \begin_layout Description
17671 \change_inserted 155139281 1354130923
17672 \begin_inset Flex Code
17675 \begin_layout Plain Layout
17677 \change_inserted 155139281 1354130923
17678 ForceLocalFontSwitch
17684 \begin_inset Flex Code
17687 \begin_layout Plain Layout
17689 \change_inserted 155139281 1354130923
17698 \begin_inset Flex Code
17701 \begin_layout Plain Layout
17703 \change_inserted 155139281 1354130923
17709 ] When using babel, always use a local font switch (
17710 \begin_inset Flex Code
17713 \begin_layout Plain Layout
17715 \change_inserted 155139281 1354130923
17723 ), never a global one (such as
17724 \begin_inset Flex Code
17727 \begin_layout Plain Layout
17729 \change_inserted 155139281 1354130923
17742 \begin_layout Description
17743 \begin_inset Flex Code
17746 \begin_layout Plain Layout
17753 \begin_inset Flex Code
17756 \begin_layout Plain Layout
17765 \begin_inset space \thinspace{}
17769 \begin_inset Flex Code
17772 \begin_layout Plain Layout
17779 \begin_inset Quotes eld
17783 \begin_inset Quotes erd
17786 language, leading to Left-to-Right (Latin) output, e.
17787 \begin_inset space \thinspace{}
17791 \begin_inset space \space{}
17794 in TeX code or URL.
17798 \begin_layout Description
17799 \begin_inset Flex Code
17802 \begin_layout Plain Layout
17809 \begin_inset Flex Code
17812 \begin_layout Plain Layout
17821 \begin_inset space \thinspace{}
17825 \begin_inset Flex Code
17828 \begin_layout Plain Layout
17834 ] Indicates whether the
17835 \begin_inset Flex Code
17838 \begin_layout Plain Layout
17844 should be used or, instead, the user can change the paragraph style used
17849 \begin_layout Description
17850 \begin_inset Flex Code
17853 \begin_layout Plain Layout
17860 \begin_inset Flex Code
17863 \begin_layout Plain Layout
17872 \begin_inset space \thinspace{}
17876 \begin_inset Flex Code
17879 \begin_layout Plain Layout
17885 ] As with paragraph styles, see sec.
17886 \begin_inset space ~
17890 \begin_inset CommandInset ref
17892 reference "sub:Paragraph-Styles"
17899 \begin_layout Description
17900 \begin_inset Flex Code
17903 \begin_layout Plain Layout
17909 These tags control the XHTML output.
17911 \begin_inset space ~
17915 \begin_inset CommandInset ref
17917 reference "sec:Tags-for-XHTML"
17924 \begin_layout Description
17925 \begin_inset Flex Code
17928 \begin_layout Plain Layout
17935 \begin_inset Flex Code
17938 \begin_layout Plain Layout
17947 \begin_inset space \thinspace{}
17951 \begin_inset Flex Code
17954 \begin_layout Plain Layout
17960 ] Whether to include the contents of this inset in the strings generated
17961 for the `Outline' pane.
17962 One would not, for example, want the content of a footnote in a section
17963 header to be included in the TOC displayed in the outline, but one would
17964 normally want the content of a character style displayed.
17965 Default is false: not to include.
17968 \begin_layout Description
17969 \begin_inset Flex Code
17972 \begin_layout Plain Layout
17981 \begin_inset Flex Code
17984 \begin_layout Plain Layout
17993 \begin_inset space \thinspace{}
17997 \begin_inset Flex Code
18000 \begin_layout Plain Layout
18006 ] As with paragraph styles, see sec.
18007 \begin_inset space ~
18011 \begin_inset CommandInset ref
18013 reference "sub:Paragraph-Styles"
18020 \begin_layout Description
18021 \begin_inset Flex Code
18024 \begin_layout Plain Layout
18030 The font used for the label.
18032 \begin_inset space ~
18036 \begin_inset CommandInset ref
18038 reference "sub:Font-description"
18043 Note that this definition can never appear before
18044 \begin_inset Flex Code
18047 \begin_layout Plain Layout
18053 , lest it be ineffective.
18056 \begin_layout Description
18057 \begin_inset Flex Code
18060 \begin_layout Plain Layout
18067 \begin_inset Flex Code
18070 \begin_layout Plain Layout
18077 \begin_inset Quotes erd
18081 \begin_inset Quotes erd
18084 ] What will be displayed on the button or elsewhere as the inset label.
18086 \begin_inset Flex Code
18089 \begin_layout Plain Layout
18096 \begin_inset Flex Code
18099 \begin_layout Plain Layout
18105 ) modify this label on the fly.
18108 \begin_layout Description
18110 \change_inserted -195340706 1333913893
18111 \begin_inset Flex Code
18114 \begin_layout Plain Layout
18120 Language dependent preamble.
18122 \begin_inset space ~
18126 \begin_inset CommandInset ref
18128 reference "sub:I18n"
18135 \begin_layout Description
18136 \begin_inset Flex Code
18139 \begin_layout Plain Layout
18146 \begin_inset Flex Code
18149 \begin_layout Plain Layout
18155 ] The name of the corresponding LaTeX stuff.
18156 Either the environment or command name.
18159 \begin_layout Description
18160 \begin_inset Flex Code
18163 \begin_layout Plain Layout
18170 \begin_inset Flex Code
18173 \begin_layout Plain Layout
18179 ] The optional parameter for the corresponding
18180 \begin_inset Flex Code
18183 \begin_layout Plain Layout
18189 stuff, including possible bracket pairs like
18190 \begin_inset Flex Code
18193 \begin_layout Plain Layout
18201 \change_inserted -712698321 1355144715
18202 This will be output as is after all LaTeX
18203 \begin_inset Flex Code
18206 \begin_layout Plain Layout
18208 \change_inserted -712698321 1355144713
18217 This parameter cannot be changed from within LyX
18218 \change_inserted -712698321 1355144775
18220 \begin_inset Flex Code
18223 \begin_layout Plain Layout
18225 \change_inserted -712698321 1355144747
18231 for customizable parameters)
18236 \begin_layout Description
18237 \begin_inset Flex Code
18240 \begin_layout Plain Layout
18247 \begin_inset Flex Code
18250 \begin_layout Plain Layout
18252 \change_deleted -712698321 1353867544
18259 Command, Environment,
18260 \change_inserted -712698321 1353867573
18262 \change_deleted -712698321 1353867557
18271 \begin_inset Flex Code
18274 \begin_layout Plain Layout
18276 \change_deleted -712698321 1353867564
18280 \change_deleted -712698321 1353867569
18288 ] How the style should be translated into LaTeX.
18292 \begin_layout Plain Layout
18293 \begin_inset Flex Code
18296 \begin_layout Plain Layout
18302 is perhaps a bit misleading, since these rules apply to SGML classes, too.
18303 Visit the SGML class files for specific examples.
18312 \begin_layout Description
18313 \begin_inset Flex Code
18316 \begin_layout Plain Layout
18318 \change_deleted -712698321 1353867582
18320 \change_inserted -712698321 1353867583
18328 means nothing special.
18332 \begin_layout Description
18333 \begin_inset Flex Code
18336 \begin_layout Plain Layout
18343 \begin_inset Flex Code
18346 \begin_layout Plain Layout
18353 {\SpecialChar \ldots{}
18362 \begin_layout Description
18363 \begin_inset Flex Code
18366 \begin_layout Plain Layout
18373 \begin_inset Flex Code
18376 \begin_layout Plain Layout
18383 }\SpecialChar \ldots{}
18399 \begin_layout Description
18401 \change_deleted -712698321 1353867600
18402 \begin_inset Flex Code
18405 \begin_layout Plain Layout
18412 \begin_inset Flex Code
18415 \begin_layout Plain Layout
18422 \begin_inset Flex Code
18425 \begin_layout Plain Layout
18433 is generated for each paragraph of this environment.
18437 \begin_layout Description
18439 \change_deleted -712698321 1353867600
18440 \begin_inset Flex Code
18443 \begin_layout Plain Layout
18450 \begin_inset Flex Code
18453 \begin_layout Plain Layout
18460 \begin_inset Flex Code
18463 \begin_layout Plain Layout
18469 is passed as an argument to the environment.
18471 \begin_inset Flex Code
18474 \begin_layout Plain Layout
18480 can be defined in the
18481 \begin_inset Flex MenuItem
18484 \begin_layout Plain Layout
18489 \SpecialChar \menuseparator
18495 \begin_inset space ~
18509 \begin_layout Standard
18510 Putting the last few things together, the LaTeX output will be either:
18513 \begin_layout LyX-Code
18517 \change_deleted 2090807402 1356919073
18519 \change_inserted 2090807402 1356919073
18523 \change_deleted 2090807402 1356919073
18525 \change_inserted 2090807402 1356919002
18528 ]{\SpecialChar \ldots{}
18532 \begin_layout Standard
18536 \begin_layout LyX-Code
18540 \change_deleted 2090807402 1356919013
18542 \change_inserted 2090807402 1356919014
18546 \change_deleted 2090807402 1356919013
18548 \change_inserted 2090807402 1356919008
18551 ] \SpecialChar \ldots{}
18555 \change_deleted 2090807402 1356919016
18557 \change_inserted 2090807402 1356919016
18563 \begin_layout Standard
18564 depending upon the LaTeX type.
18568 \begin_layout Description
18570 \change_inserted -712698321 1354263128
18571 \begin_inset Flex Code
18574 \begin_layout Plain Layout
18576 \change_inserted -712698321 1353866742
18585 \begin_inset Flex Code
18588 \begin_layout Plain Layout
18590 \change_inserted -712698321 1353866752
18596 ] A string that is put at the beginning of the layout content.
18597 A line break in the output can be indicated by
18598 \begin_inset Flex Code
18601 \begin_layout Plain Layout
18603 \change_inserted -712698321 1354263128
18614 \begin_layout Description
18615 \begin_inset Flex Code
18618 \begin_layout Plain Layout
18625 \begin_inset Flex Code
18628 \begin_layout Plain Layout
18635 \begin_inset Flex Code
18638 \begin_layout Plain Layout
18645 \begin_inset Flex Code
18648 \begin_layout Plain Layout
18655 \begin_inset Flex Code
18658 \begin_layout Plain Layout
18664 (indicating a dummy definition ending definitions of charstyles, etc).
18665 This entry is required in and is only meaningful for Flex insets.
18666 Among other things, it determines on which menu this inset will appear.
18668 \begin_inset Flex Code
18671 \begin_layout Plain Layout
18678 \begin_inset Flex Code
18681 \begin_layout Plain Layout
18687 will automatically set
18688 \begin_inset Flex Code
18691 \begin_layout Plain Layout
18699 \begin_inset Flex Code
18702 \begin_layout Plain Layout
18708 can be set to true for
18709 \begin_inset Flex Code
18712 \begin_layout Plain Layout
18718 insets by setting it
18723 \begin_inset Flex Code
18726 \begin_layout Plain Layout
18735 \begin_layout Description
18736 \begin_inset Flex Code
18739 \begin_layout Plain Layout
18746 \begin_inset Flex Code
18749 \begin_layout Plain Layout
18758 \begin_inset space \thinspace{}
18762 \begin_inset Flex Code
18765 \begin_layout Plain Layout
18771 ] Whether multiple paragraphs are permitted in this inset.
18773 \begin_inset Flex Code
18776 \begin_layout Plain Layout
18782 to the same value and
18783 \begin_inset Flex Code
18786 \begin_layout Plain Layout
18792 to the opposite value.
18793 These can be reset to other values, if they are used
18798 \begin_inset Flex Code
18801 \begin_layout Plain Layout
18811 \begin_layout Description
18812 \begin_inset Flex Code
18815 \begin_layout Plain Layout
18822 \begin_inset Flex Code
18825 \begin_layout Plain Layout
18834 \begin_inset space \thinspace{}
18838 \begin_inset Flex Code
18841 \begin_layout Plain Layout
18847 ] Whether fragile commands in this inset should be
18848 \begin_inset Flex Code
18851 \begin_layout Plain Layout
18864 whether the command should itself be protected.) Default is false.
18865 \change_inserted 1414654397 1360681873
18869 \begin_layout Description
18871 \change_inserted 1414654397 1360681892
18872 \begin_inset Flex Code
18875 \begin_layout Plain Layout
18877 \change_inserted 1414654397 1360681880
18884 \begin_inset Flex Code
18887 \begin_layout Plain Layout
18889 \change_inserted 1414654397 1360681883
18895 ] Deletes an existing
18896 \begin_inset Flex Code
18899 \begin_layout Plain Layout
18901 \change_inserted 1414654397 1360681892
18912 \begin_layout Description
18913 \begin_inset Flex Code
18916 \begin_layout Plain Layout
18923 \begin_inset Flex Code
18926 \begin_layout Plain Layout
18935 \begin_inset space \thinspace{}
18939 \begin_inset Flex Code
18942 \begin_layout Plain Layout
18948 ] As with paragraph styles, see sec.
18949 \begin_inset space ~
18953 \begin_inset CommandInset ref
18955 reference "sub:Paragraph-Styles"
18963 \begin_layout Description
18964 \begin_inset Flex Code
18967 \begin_layout Plain Layout
18974 \begin_inset Flex Code
18977 \begin_layout Plain Layout
18986 \begin_inset space \thinspace{}
18990 \begin_inset Flex Code
18993 \begin_layout Plain Layout
18999 ] As with paragraph styles, see sec.
19000 \begin_inset space ~
19004 \begin_inset CommandInset ref
19006 reference "sub:Paragraph-Styles"
19014 \begin_layout Description
19015 \begin_inset Flex Code
19018 \begin_layout Plain Layout
19024 As with paragraph styles, see sec.
19025 \begin_inset space ~
19029 \begin_inset CommandInset ref
19031 reference "sub:Paragraph-Styles"
19038 \begin_layout Description
19039 \begin_inset Flex Code
19042 \begin_layout Plain Layout
19049 \begin_inset Flex Code
19052 \begin_layout Plain Layout
19058 ] The prefix to use when creating labels referring to insets of this type.
19059 This allows the use of formatted references.
19062 \begin_layout Description
19063 \begin_inset Flex Code
19066 \begin_layout Plain Layout
19073 \begin_inset Flex Code
19076 \begin_layout Plain Layout
19082 ] As with paragraph styles, see sec.
19083 \begin_inset space ~
19087 \begin_inset CommandInset ref
19089 reference "sub:Paragraph-Styles"
19094 \change_inserted -712698321 1354439699
19098 \begin_layout Description
19100 \change_inserted -712698321 1354439705
19101 \begin_inset Flex Code
19104 \begin_layout Plain Layout
19106 \change_inserted -712698321 1354439699
19113 \begin_inset Flex Code
19116 \begin_layout Plain Layout
19118 \change_inserted -712698321 1354439699
19127 \begin_inset Flex Code
19130 \begin_layout Plain Layout
19132 \change_inserted -712698321 1354439699
19138 ] Resets the LaTeX arguments of this layout (as defined via the
19139 \begin_inset Flex Code
19142 \begin_layout Plain Layout
19144 \change_inserted -712698321 1354439699
19151 This is useful if you have copied a style via
19152 \begin_inset Flex Code
19155 \begin_layout Plain Layout
19157 \change_inserted -712698321 1354439699
19163 , but you do not want to inherit its (required and optional) arguments.
19165 \change_deleted -712698321 1354439698
19171 \begin_layout Description
19172 \begin_inset Flex Code
19175 \begin_layout Plain Layout
19182 \begin_inset Flex Code
19185 \begin_layout Plain Layout
19192 \begin_inset space \thinspace{}
19196 \begin_inset Flex Code
19199 \begin_layout Plain Layout
19207 ] Whether this inset should use the font of its surrounding environment
19209 Default is true: uses its own.
19212 \begin_layout Description
19214 \change_inserted -712698321 1354263134
19215 \begin_inset Flex Code
19218 \begin_layout Plain Layout
19220 \change_inserted -712698321 1353866810
19227 \begin_inset Flex Code
19230 \begin_layout Plain Layout
19232 \change_inserted -712698321 1353866806
19238 ] A string that is put at the end of the layout content.
19239 A line break in the output can be indicated by
19240 \begin_inset Flex Code
19243 \begin_layout Plain Layout
19245 \change_inserted -712698321 1354263134
19256 \begin_layout Description
19257 \begin_inset Flex Code
19260 \begin_layout Plain Layout
19267 \begin_inset Flex Code
19270 \begin_layout Plain Layout
19277 \begin_inset space \thinspace{}
19281 \begin_inset Flex Code
19284 \begin_layout Plain Layout
19292 ] Allow spell-checking the contents of this inset.
19296 \begin_layout Subsection
19298 \begin_inset CommandInset label
19300 name "sub:Counters"
19307 \begin_layout Standard
19308 It is necessary to define the counters (
19309 \begin_inset Flex MenuItem
19312 \begin_layout Plain Layout
19319 \begin_inset Flex MenuItem
19322 \begin_layout Plain Layout
19328 , \SpecialChar \ldots{}
19329 ) in the text class itself.
19330 The standard counters are defined in the file
19331 \begin_inset Flex Code
19334 \begin_layout Plain Layout
19340 , so you may have to do no more than add
19343 \begin_layout LyX-Code
19344 Input stdcounters.inc
19347 \begin_layout Standard
19348 to your layout file to get them to work.
19349 But if you want to define custom counters, then you can do so.
19350 The counter declaration must begin with:
19353 \begin_layout LyX-Code
19354 Counter CounterName
19357 \begin_layout Standard
19359 \begin_inset Flex Code
19362 \begin_layout Plain Layout
19368 ' is replaced by the name of the counter.
19369 And it must end with
19370 \begin_inset Quotes eld
19374 \begin_inset Flex Code
19377 \begin_layout Plain Layout
19384 \begin_inset Quotes erd
19388 The following parameters can also be used:
19391 \begin_layout Description
19393 \change_inserted 1414654397 1370012684
19394 \begin_inset Flex Code
19397 \begin_layout Plain Layout
19399 \change_inserted 1414654397 1370012589
19406 \begin_inset Flex Code
19409 \begin_layout Plain Layout
19411 \change_inserted 1414654397 1370012639
19417 =1] Sets the initial value for the counter, to which it will be reset whenever
19419 Normally, one will want the default, 1.
19422 \begin_layout Description
19423 \begin_inset Flex Code
19426 \begin_layout Plain Layout
19433 \begin_inset Flex Code
19436 \begin_layout Plain Layout
19443 \begin_inset Quotes erd
19447 \begin_inset Quotes erd
19450 ] When defined, this string defines how the counter is displayed.
19451 Setting this value sets
19452 \begin_inset Flex Code
19455 \begin_layout Plain Layout
19456 LabelStringAppendix
19462 The following special constructs can be used in the string:
19466 \begin_layout Itemize
19467 \begin_inset Flex Code
19470 \begin_layout Plain Layout
19478 will be replaced by the expansion of the
19479 \begin_inset Flex Code
19482 \begin_layout Plain Layout
19489 \begin_inset Flex Code
19492 \begin_layout Plain Layout
19493 LabelStringAppendix
19499 \begin_inset Flex Code
19502 \begin_layout Plain Layout
19512 \begin_layout Itemize
19513 counter values can be expressed using LaTeX-like macros
19514 \begin_inset Newline newline
19518 \begin_inset Flex Code
19521 \begin_layout Plain Layout
19538 \begin_inset Flex Code
19541 \begin_layout Plain Layout
19553 \begin_layout Plain Layout
19563 Actually, the situation is a bit more complicated: any
19582 other than those described below will produce arabic numerals.
19583 It would not be surprising to see this change in the future.
19589 \begin_inset Flex Code
19592 \begin_layout Plain Layout
19598 : 1, 2, 3,\SpecialChar \ldots{}
19600 \begin_inset Flex Code
19603 \begin_layout Plain Layout
19609 for lower-case letters: a, b, c, \SpecialChar \ldots{}
19611 \begin_inset Flex Code
19614 \begin_layout Plain Layout
19620 for upper-case letters: A, B, C, \SpecialChar \ldots{}
19622 \begin_inset Flex Code
19625 \begin_layout Plain Layout
19631 for lower-case roman numerals: i, ii, iii, \SpecialChar \ldots{}
19633 \begin_inset Flex Code
19636 \begin_layout Plain Layout
19642 for upper-case roman numerals: I, II, III\SpecialChar \ldots{}
19644 \begin_inset Flex Code
19647 \begin_layout Plain Layout
19653 for hebrew numerals.
19657 \begin_layout Standard
19658 If LabelString is not defined, a default value is constructed as follows:
19659 if the counter has a master counter
19660 \begin_inset Flex Code
19663 \begin_layout Plain Layout
19670 \begin_inset Flex Code
19673 \begin_layout Plain Layout
19680 \begin_inset Newline newline
19684 \begin_inset Flex Code
19687 \begin_layout Plain Layout
19697 is used; otherwise the string
19698 \begin_inset Flex Code
19701 \begin_layout Plain Layout
19712 \begin_layout Description
19713 \begin_inset Flex Code
19716 \begin_layout Plain Layout
19717 LabelStringAppendix
19723 \begin_inset Flex Code
19726 \begin_layout Plain Layout
19733 \begin_inset Quotes erd
19737 \begin_inset Quotes erd
19741 \begin_inset Flex Code
19744 \begin_layout Plain Layout
19750 , but for use in the Appendix.
19753 \begin_layout Description
19754 \begin_inset Flex Code
19757 \begin_layout Plain Layout
19764 \begin_inset Flex Code
19767 \begin_layout Plain Layout
19774 \begin_inset Quotes erd
19778 \begin_inset Quotes erd
19781 ] A format for use with formatted references to this counter.
19782 For example, one might want to have references to section numbers appear
19784 \begin_inset Quotes eld
19788 \begin_inset Quotes erd
19792 The string should contain
19793 \begin_inset Quotes eld
19797 \begin_inset Quotes erd
19801 This will be replaced by the counter number itself.
19802 So, for sections, it would be: Section ##.
19805 \begin_layout Description
19806 \begin_inset Flex Code
19809 \begin_layout Plain Layout
19816 \begin_inset Flex Code
19819 \begin_layout Plain Layout
19826 \begin_inset Quotes erd
19830 \begin_inset Quotes erd
19833 ] If this is set to the name of another counter, the present counter will
19834 be reset every time the other one is increased.
19836 \begin_inset Flex Code
19839 \begin_layout Plain Layout
19846 \begin_inset Flex Code
19849 \begin_layout Plain Layout
19858 \begin_layout Subsection
19860 \begin_inset CommandInset label
19862 name "sub:Font-description"
19869 \begin_layout Standard
19870 A font description looks like this:
19873 \begin_layout LyX-Code
19887 \begin_layout LyX-Code
19891 \begin_layout LyX-Code
19895 \begin_layout Standard
19896 The following commands are available:
19899 \begin_layout Description
19900 \begin_inset Flex Code
19903 \begin_layout Plain Layout
19910 \begin_inset Flex Code
19913 \begin_layout Plain Layout
19922 \begin_inset Flex Code
19925 \begin_layout Plain Layout
19932 \begin_inset Flex Code
19935 \begin_layout Plain Layout
19942 \begin_inset Flex Code
19945 \begin_layout Plain Layout
19952 \begin_inset Flex Code
19955 \begin_layout Plain Layout
19962 \begin_inset Flex Code
19965 \begin_layout Plain Layout
19972 \begin_inset Flex Code
19975 \begin_layout Plain Layout
19982 \begin_inset Flex Code
19985 \begin_layout Plain Layout
19992 \begin_inset Flex Code
19995 \begin_layout Plain Layout
20004 \begin_layout Description
20005 \begin_inset Flex Code
20008 \begin_layout Plain Layout
20015 \begin_inset Flex Code
20018 \begin_layout Plain Layout
20027 \begin_inset Flex Code
20030 \begin_layout Plain Layout
20037 \begin_inset Flex Code
20040 \begin_layout Plain Layout
20049 \begin_layout Description
20050 \begin_inset Flex Code
20053 \begin_layout Plain Layout
20060 \begin_inset Flex Code
20063 \begin_layout Plain Layout
20069 ] Valid arguments are:
20070 \begin_inset Flex Code
20073 \begin_layout Plain Layout
20080 \begin_inset Flex Code
20083 \begin_layout Plain Layout
20090 \begin_inset Flex Code
20093 \begin_layout Plain Layout
20100 \begin_inset Flex Code
20103 \begin_layout Plain Layout
20110 \begin_inset Flex Code
20113 \begin_layout Plain Layout
20120 \begin_inset Flex Code
20123 \begin_layout Plain Layout
20130 \begin_inset Flex Code
20133 \begin_layout Plain Layout
20140 \begin_inset Flex Code
20143 \begin_layout Plain Layout
20150 \begin_inset Flex Code
20153 \begin_layout Plain Layout
20160 \begin_inset Flex Code
20163 \begin_layout Plain Layout
20170 \begin_inset Flex Code
20173 \begin_layout Plain Layout
20180 \begin_inset Flex Code
20183 \begin_layout Plain Layout
20190 Each of these turns on or off the corresponding attribute.
20192 \begin_inset Flex Code
20195 \begin_layout Plain Layout
20201 turns on emphasis, and
20202 \begin_inset Flex Code
20205 \begin_layout Plain Layout
20213 \begin_inset Newline newline
20216 If the latter seems puzzling, remember that the font settings for the present
20217 context are generally inherited from the surrounding context.
20219 \begin_inset Flex Code
20222 \begin_layout Plain Layout
20228 would turn off the emphasis that was anyway in effect, say, in a theorem
20232 \begin_layout Description
20233 \begin_inset Flex Code
20236 \begin_layout Plain Layout
20243 \begin_inset Flex Code
20246 \begin_layout Plain Layout
20255 \begin_inset Flex Code
20258 \begin_layout Plain Layout
20267 \begin_layout Description
20268 \begin_inset Flex Code
20271 \begin_layout Plain Layout
20278 \begin_inset Flex Code
20281 \begin_layout Plain Layout
20290 \begin_inset Flex Code
20293 \begin_layout Plain Layout
20300 \begin_inset Flex Code
20303 \begin_layout Plain Layout
20310 \begin_inset Flex Code
20313 \begin_layout Plain Layout
20322 \begin_layout Description
20323 \begin_inset Flex Code
20326 \begin_layout Plain Layout
20333 \begin_inset Flex Code
20336 \begin_layout Plain Layout
20343 \begin_inset Flex Code
20346 \begin_layout Plain Layout
20353 \begin_inset Flex Code
20356 \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
20417 \begin_layout Subsection
20418 \begin_inset CommandInset label
20420 name "sub:Citation-format-description"
20424 Citation format description
20427 \begin_layout Standard
20429 \begin_inset Flex Code
20432 \begin_layout Plain Layout
20438 blocks are used to describe how bibliographic information should be displayed,
20439 both within LyX itself (in the citation dialog and in tooltips, for example)
20440 and in XHTML output.
20441 Such a block might look like this:
20444 \begin_layout LyX-Code
20448 \begin_layout LyX-Code
20452 \begin_layout LyX-Code
20456 \begin_layout LyX-Code
20460 \begin_layout Standard
20461 The individual lines define how the bibliographic information associated
20462 with an article or book, respectively, is to be displayed, and such a definitio
20463 n can be given for any `entry type' that might be present in a BibTeX file.
20464 LyX defines a default format in the source code that will be used if no
20465 specific definition has been given.
20466 LyX predefines several formats in the file
20467 \begin_inset Flex Code
20470 \begin_layout Plain Layout
20476 , which is included in most of LyX's document classes.
20479 \begin_layout Standard
20480 The definitions use a simple language that allows BibTeX keys to be replaced
20482 Keys should be enclosed in
20483 \begin_inset Flex Code
20486 \begin_layout Plain Layout
20493 \begin_inset Flex Code
20496 \begin_layout Plain Layout
20503 So a simple definition might look like this:
20506 \begin_layout LyX-Code
20508 \begin_inset Quotes eld
20512 \begin_inset Quotes erd
20518 \begin_layout Standard
20519 This would print the author, followed by a comma, followed by the title,
20520 in quotes, followed by a period.
20523 \begin_layout Standard
20524 Of course, sometimes you may want to print a key only if it exists.
20525 This can be done by using a conditional construction, such as:
20526 \begin_inset Flex Code
20529 \begin_layout Plain Layout
20531 \begin_inset space ~
20541 \begin_inset Flex Code
20544 \begin_layout Plain Layout
20550 key exists, then print
20551 \begin_inset Quotes eld
20555 \begin_inset space ~
20559 \begin_inset Quotes erd
20562 followed by the volume key.
20563 It is also possible to have an else clause in the conditional, such as:
20564 \begin_inset Newline newline
20568 \begin_inset Flex Code
20571 \begin_layout Plain Layout
20572 {%author%[[%author%]][[%editor%, ed.]]}
20578 \begin_inset Newline newline
20582 \begin_inset Flex Code
20585 \begin_layout Plain Layout
20591 key is printed if it exists; otherwise, the editor key is printed, followed
20593 \begin_inset Quotes eld
20597 \begin_inset space ~
20601 \begin_inset Quotes erd
20604 Note that the key is again enclosed in
20605 \begin_inset Flex Code
20608 \begin_layout Plain Layout
20614 signs; the entire conditional is enclosed in braces; and the if and else
20615 clauses are enclosed in double brackets,
20616 \begin_inset Quotes eld
20620 \begin_inset Flex Code
20623 \begin_layout Plain Layout
20630 \begin_inset Quotes eld
20634 \begin_inset Quotes eld
20638 \begin_inset Flex Code
20641 \begin_layout Plain Layout
20648 \begin_inset Quotes erd
20652 There must be no space between any of these.
20655 \begin_layout Standard
20656 There is one other piece of syntax available in definitions, which looks
20658 \begin_inset Flex Code
20661 \begin_layout Plain Layout
20668 This defines a piece of formatting information that is to be used when
20670 \begin_inset Quotes eld
20674 \begin_inset Quotes erd
20678 Obviously, we do not want to output HTML tags when writing plain text,
20679 so they should be wrapped in
20680 \begin_inset Quotes eld
20684 \begin_inset Quotes erd
20688 \begin_inset Quotes eld
20692 \begin_inset Quotes erd
20698 \begin_layout Standard
20699 Two special sorts of definitions are also possible in a
20700 \begin_inset Flex Code
20703 \begin_layout Plain Layout
20710 An example of the first would be:
20713 \begin_layout LyX-Code
20715 \begin_inset Quotes eld
20719 \begin_inset Quotes erd
20725 \begin_layout Standard
20726 This is an abbreviation, or macro, and it can be used by treating it as
20728 \begin_inset Flex Code
20731 \begin_layout Plain Layout
20739 \begin_inset Flex Code
20742 \begin_layout Plain Layout
20748 exactly as it would treat its definition.
20749 So, let us issue the obvious
20757 \begin_layout LyX-Code
20761 \begin_layout Standard
20762 or anything like it.
20763 LyX shouldn't go into an infinite loop, but it may go into a long one before
20767 \begin_layout Standard
20768 The second sort of special definition might look like this:
20771 \begin_layout LyX-Code
20775 \begin_layout Standard
20776 This defines a translatable piece of text, which allows relevant parts of
20777 the bibliography to be translated.
20778 It can be included in a definition by treating it as a key:
20779 \begin_inset Flex Code
20782 \begin_layout Plain Layout
20789 Several of these are predefined in
20790 \begin_inset Flex Code
20793 \begin_layout Plain Layout
20800 Note that these are not macros, in the sense just defined.
20801 They will not be expanded.
20804 \begin_layout Standard
20805 So here then is an example that use all these features:
20806 \begin_inset VSpace defskip
20812 \begin_layout Standard
20816 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
20819 \begin_layout Standard
20820 \begin_inset VSpace defskip
20823 This defines a macro that prints the author, followed by a comma, if the
20825 \begin_inset Flex Code
20828 \begin_layout Plain Layout
20834 key is defined, or else prints the name of the editor, followed by the
20836 \begin_inset Flex Code
20839 \begin_layout Plain Layout
20845 or its translation (it is by default
20846 \begin_inset Quotes eld
20850 \begin_inset Quotes erd
20854 \begin_inset Flex Code
20857 \begin_layout Plain Layout
20864 Note that this is in fact defined in
20865 \begin_inset Flex Code
20868 \begin_layout Plain Layout
20874 , so you can use it in your own definitions, or re-definitions, if you load
20878 \begin_layout Section
20879 \begin_inset CommandInset label
20881 name "sec:Tags-for-XHTML"
20885 Tags for XHTML output
20888 \begin_layout Standard
20889 As with LaTeX or DocBook, the format of LyX's XHTML output is also controlled
20890 by layout information.
20891 In general, LyX provides sensible defaults and, as mentioned earlier, it
20892 will even construct default CSS style rules from the other layout tags.
20893 For example, LyX will attempt to use the information provided in the
20894 \begin_inset Flex Code
20897 \begin_layout Plain Layout
20903 declaration for the Chapter style to write CSS that will appropriately
20904 format chapter headings.
20907 \begin_layout Standard
20908 In many cases, then, you may not have to do anything at all to get acceptable
20909 XHTML output for your own environments, custom insets, and so forth.
20910 But in some cases you will, and so LyX provides a number of layout tags
20911 that can be used to customize the XHTML and CSS that are generated.
20914 \begin_layout Standard
20915 Note that there are two tags,
20916 \begin_inset Flex Code
20919 \begin_layout Plain Layout
20926 \begin_inset Flex Code
20929 \begin_layout Plain Layout
20935 that may appear outside style and inset declarations.
20937 \begin_inset CommandInset ref
20939 reference "sub:General-text-class"
20943 for details on these.
20946 \begin_layout Subsection
20947 \begin_inset CommandInset label
20949 name "sub:Paragraph-Style-XHTML"
20956 \begin_layout Standard
20957 The sort of XHTML LyX outputs for a paragraph depends upon whether we are
20958 dealing with a normal paragraph, a command, or an environment, where this
20959 is itself determined by the contents of the corresponding
20960 \begin_inset Flex Code
20963 \begin_layout Plain Layout
20973 \begin_layout Standard
20974 For a command or normal paragraph, the output XHTML has the following form:
20977 \begin_layout LyX-Code
20979 \begin_inset Quotes erd
20983 \begin_inset Quotes erd
20989 \begin_layout LyX-Code
20991 \begin_inset Quotes erd
20995 \begin_inset Quotes erd
21001 \begin_layout LyX-Code
21002 Contents of the paragraph.
21005 \begin_layout LyX-Code
21009 \begin_layout Standard
21010 The label tags are of course omitted if the paragraph does not have a label.
21013 \begin_layout Standard
21014 For an environment that is not some sort of list, the XHTML takes this form:
21017 \begin_layout LyX-Code
21019 \begin_inset Quotes erd
21023 \begin_inset Quotes erd
21029 \begin_layout LyX-Code
21031 \begin_inset Quotes erd
21035 \begin_inset Quotes erd
21039 \begin_inset Quotes erd
21043 \begin_inset Quotes erd
21046 >Environment Label</labeltag>First paragraph.</itemtag>
21049 \begin_layout LyX-Code
21050 <itemtag>Second paragraph.</itemtag>
21053 \begin_layout LyX-Code
21057 \begin_layout Standard
21058 Note that the label is output only for the first paragraph, as it should
21059 be for a theorem, for example.
21063 \begin_layout Standard
21064 For a list, we have one of these forms:
21067 \begin_layout LyX-Code
21069 \begin_inset Quotes erd
21073 \begin_inset Quotes erd
21079 \begin_layout LyX-Code
21081 \begin_inset Quotes erd
21085 \begin_inset Quotes erd
21089 \begin_inset Quotes erd
21093 \begin_inset Quotes erd
21096 >List Label</labeltag>First item.</itemtag>
21099 \begin_layout LyX-Code
21101 \begin_inset Quotes erd
21105 \begin_inset Quotes erd
21109 \begin_inset Quotes erd
21113 \begin_inset Quotes erd
21116 >List Label</labeltag>Second item.</itemtag>
21119 \begin_layout LyX-Code
21123 \begin_layout LyX-Code
21127 \begin_layout LyX-Code
21129 \begin_inset Quotes erd
21133 \begin_inset Quotes erd
21139 \begin_layout LyX-Code
21141 \begin_inset Quotes erd
21145 \begin_inset Quotes erd
21148 >List Label</labeltag><itemtag attr=
21149 \begin_inset Quotes erd
21153 \begin_inset Quotes erd
21156 >First item.</itemtag>
21159 \begin_layout LyX-Code
21161 \begin_inset Quotes erd
21165 \begin_inset Quotes erd
21168 >List Label</labeltag><itemtag attr=
21169 \begin_inset Quotes erd
21173 \begin_inset Quotes erd
21176 >Second item.</itemtag>
21179 \begin_layout LyX-Code
21183 \begin_layout Standard
21184 Note the different orders of
21185 \begin_inset Flex Code
21188 \begin_layout Plain Layout
21195 \begin_inset Flex Code
21198 \begin_layout Plain Layout
21205 Which order we get depends upon the setting of
21206 \begin_inset Flex Code
21209 \begin_layout Plain Layout
21216 \begin_inset Flex Code
21219 \begin_layout Plain Layout
21225 is false (the default), you get the first of these, with the label within
21226 the item; if true, you get the second, with the label outside the item.
21229 \begin_layout Standard
21230 The specific tags and attributes output for each paragraph type can be controlle
21231 d by means of the layout tags we are about to describe.
21232 As mentioned earlier, however, LyX uses sensible defaults for many of these,
21233 so you often may not need to do very much to get good XHTML output.
21234 Think of the available tags as there so you can tweak things to your liking.
21237 \begin_layout Description
21238 \begin_inset Flex Code
21241 \begin_layout Plain Layout
21248 \begin_inset Flex Code
21251 \begin_layout Plain Layout
21257 ] Specifies attribute information to be output with the main tag.
21259 \begin_inset Quotes eld
21263 \begin_inset Flex Code
21266 \begin_layout Plain Layout
21273 \begin_inset Quotes erd
21277 By default, LyX will output
21278 \begin_inset Quotes eld
21282 \begin_inset Flex Code
21285 \begin_layout Plain Layout
21292 \begin_inset Quotes erd
21296 \begin_inset Flex Code
21299 \begin_layout Plain Layout
21305 is the LyX name of the layout, made lowercase, for example: chapter.
21310 contain any style information.
21312 \begin_inset Flex Code
21315 \begin_layout Plain Layout
21324 \begin_layout Description
21325 \begin_inset Flex Code
21328 \begin_layout Plain Layout
21335 \begin_inset Flex Code
21338 \begin_layout Plain Layout
21348 ] Whether to output the default CSS information LyX generates for this layout,
21349 even if additional information is explicitly provided via
21350 \begin_inset Flex Code
21353 \begin_layout Plain Layout
21361 \begin_inset Flex Code
21364 \begin_layout Plain Layout
21370 allows you to alter or augment the generated CSS, rather than to override
21373 \begin_inset Flex Code
21376 \begin_layout Plain Layout
21385 \begin_layout Description
21386 \begin_inset Flex Code
21389 \begin_layout Plain Layout
21396 \begin_inset Flex Code
21399 \begin_layout Plain Layout
21405 ] The tag to be used for individual paragraphs of environments, replacing
21407 \begin_inset Flex Code
21410 \begin_layout Plain Layout
21416 in the examples above.
21418 \begin_inset Flex Code
21421 \begin_layout Plain Layout
21430 \begin_layout Description
21431 \begin_inset Flex Code
21434 \begin_layout Plain Layout
21441 \begin_inset Flex Code
21444 \begin_layout Plain Layout
21450 ] Attributes for the item tag.
21452 \begin_inset Quotes eld
21456 \begin_inset Flex Code
21459 \begin_layout Plain Layout
21460 class=`layoutname_item'
21466 \begin_inset Quotes erd
21474 contain any style information.
21476 \begin_inset Flex Code
21479 \begin_layout Plain Layout
21488 \begin_layout Description
21489 \begin_inset Flex Code
21492 \begin_layout Plain Layout
21499 \begin_inset Flex Code
21502 \begin_layout Plain Layout
21508 ] The tag to be used for paragraph and item labels, replacing
21509 \begin_inset Flex Code
21512 \begin_layout Plain Layout
21518 in the examples above.
21520 \begin_inset Flex Code
21523 \begin_layout Plain Layout
21530 \begin_inset Flex Code
21533 \begin_layout Plain Layout
21540 \begin_inset Flex Code
21543 \begin_layout Plain Layout
21550 \begin_inset Flex Code
21553 \begin_layout Plain Layout
21554 Centered_Top_Environment
21559 , in which case it defaults to
21560 \begin_inset Flex Code
21563 \begin_layout Plain Layout
21572 \begin_layout Description
21573 \begin_inset Flex Code
21576 \begin_layout Plain Layout
21583 \begin_inset Flex Code
21586 \begin_layout Plain Layout
21592 ] Attributes for the label tag.
21594 \begin_inset Quotes eld
21598 \begin_inset Flex Code
21601 \begin_layout Plain Layout
21602 class=`layoutname_label'
21608 \begin_inset Quotes erd
21616 contain any style information.
21618 \begin_inset Flex Code
21621 \begin_layout Plain Layout
21630 \begin_layout Description
21631 \begin_inset Flex Code
21634 \begin_layout Plain Layout
21641 \begin_inset Flex Code
21644 \begin_layout Plain Layout
21654 ] Meaningful only for list-like environments, this tag controls whether
21655 the label tag is output before or inside the item tag.
21656 This is used, for example, in the description environment, where we want
21658 \begin_inset Flex Code
21661 \begin_layout Plain Layout
21662 <dt>\SpecialChar \ldots{}
21663 </dt><dd>\SpecialChar \ldots{}
21671 \begin_inset Flex Code
21674 \begin_layout Plain Layout
21680 : The label tag is output inside the item tag.
21683 \begin_layout Description
21684 \begin_inset Flex Code
21687 \begin_layout Plain Layout
21693 Information to be output in the
21694 \begin_inset Flex Code
21697 \begin_layout Plain Layout
21703 section when this style is used.
21704 This might, for example, be used to include a
21705 \begin_inset Flex Code
21708 \begin_layout Plain Layout
21715 \begin_inset Flex Code
21718 \begin_layout Plain Layout
21727 \begin_layout Description
21728 \begin_inset Flex Code
21731 \begin_layout Plain Layout
21737 CSS style information to be included when this style is used.
21738 Note that this will automatically be wrapped in a layout-generated
21739 \begin_inset Flex Code
21742 \begin_layout Plain Layout
21748 block, so only the CSS itself need be included.
21750 \change_inserted 1414654397 1364133464
21752 \begin_inset Flex Code
21755 \begin_layout Plain Layout
21757 \change_inserted 1414654397 1364133462
21770 \begin_layout Description
21771 \begin_inset Flex Code
21774 \begin_layout Plain Layout
21781 \begin_inset Flex Code
21784 \begin_layout Plain Layout
21790 ] The tag to be used for the main label, replacing
21791 \begin_inset Flex Code
21794 \begin_layout Plain Layout
21800 in the examples above.
21802 \begin_inset Flex Code
21805 \begin_layout Plain Layout
21814 \begin_layout Description
21815 \begin_inset Flex Code
21818 \begin_layout Plain Layout
21825 \begin_inset Flex Code
21828 \begin_layout Plain Layout
21838 ] Marks this style as the one to be used to generate the
21839 \begin_inset Flex Code
21842 \begin_layout Plain Layout
21848 tag for the XHTML file.
21849 By default, it is false.
21851 \begin_inset Flex Code
21854 \begin_layout Plain Layout
21860 file sets it to true for the
21861 \begin_inset Flex Code
21864 \begin_layout Plain Layout
21874 \begin_layout Subsection
21878 \begin_layout Standard
21879 The XHTML output of insets can also be controlled by information in layout
21884 \begin_layout Plain Layout
21885 At present, this is true only for
21886 \begin_inset Quotes eld
21890 \begin_inset Quotes erd
21893 insets (insets you can type into) and is not true for
21894 \begin_inset Quotes eld
21898 \begin_inset Quotes erd
21901 insets (insets that are associated with dialog boxes).
21906 Here, too, LyX tries to provide sensible defaults, and it constructs default
21908 But everything can be customized.
21911 \begin_layout Standard
21912 The XHTML LyX outputs for an inset has the following form:
21915 \begin_layout LyX-Code
21917 \begin_inset Quotes erd
21921 \begin_inset Quotes erd
21927 \begin_layout LyX-Code
21928 <labeltag>Label</labeltag>
21931 \begin_layout LyX-Code
21933 \begin_inset Quotes erd
21937 \begin_inset Quotes erd
21940 >Contents of the inset.</innertag>
21943 \begin_layout LyX-Code
21947 \begin_layout Standard
21948 If the inset permits multiple paragraphs---that is, if
21949 \begin_inset Flex Code
21952 \begin_layout Plain Layout
21958 is true---then the contents of the inset will itself be output as paragraphs
21959 formatted according to the styles used for those paragraphs (standard,
21960 quote, and the like).
21961 The label tag is of course omitted if the paragraph does not have a label
21962 and, at present, is always
21963 \begin_inset Flex Code
21966 \begin_layout Plain Layout
21973 The inner tag is optional and, by default, does not appear.
21976 \begin_layout Standard
21977 The specific tags and attributes output for each inset can be controlled
21978 by means of the following layout tags.
21981 \begin_layout Description
21982 \begin_inset Flex Code
21985 \begin_layout Plain Layout
21992 \begin_inset Flex Code
21995 \begin_layout Plain Layout
22001 ] Specifies attribute information to be output with the main tag.
22003 \begin_inset Quotes eld
22007 \begin_inset Flex Code
22010 \begin_layout Plain Layout
22011 class=`myinset' onclick=`\SpecialChar \ldots{}
22018 \begin_inset Quotes erd
22022 By default, LyX will output
22023 \begin_inset Quotes eld
22027 \begin_inset Flex Code
22030 \begin_layout Plain Layout
22037 \begin_inset Quotes erd
22041 \begin_inset Flex Code
22044 \begin_layout Plain Layout
22050 is the LyX name of the inset, made lowercase and with non-alphanumeric
22051 characters converted to underscores, for example: footnote.
22054 \begin_layout Description
22055 \begin_inset Flex Code
22058 \begin_layout Plain Layout
22065 \begin_inset Flex Code
22068 \begin_layout Plain Layout
22078 ] Whether to output the default CSS information LyX generates for this layout,
22079 even if additional information is explicitly provided via
22080 \begin_inset Flex Code
22083 \begin_layout Plain Layout
22091 \begin_inset Flex Code
22094 \begin_layout Plain Layout
22100 allows you to alter or augment the generated CSS, rather than to override
22105 \begin_layout Description
22106 \begin_inset Flex Code
22109 \begin_layout Plain Layout
22116 \begin_inset Flex Code
22119 \begin_layout Plain Layout
22125 ] Attributes for the inner tag.
22127 \begin_inset Quotes eld
22131 \begin_inset Flex Code
22134 \begin_layout Plain Layout
22135 class=`insetname_inner'
22141 \begin_inset Quotes erd
22147 \begin_layout Description
22148 \begin_inset Flex Code
22151 \begin_layout Plain Layout
22158 \begin_inset Flex Code
22161 \begin_layout Plain Layout
22167 ] The inner tag, replacing
22168 \begin_inset Flex Code
22171 \begin_layout Plain Layout
22177 in the examples above.
22178 By default, there is none.
22181 \begin_layout Description
22182 \begin_inset Flex Code
22185 \begin_layout Plain Layout
22192 \begin_inset Flex Code
22195 \begin_layout Plain Layout
22203 ] Whether this inset represents a standalone block of text (such as a footnote)
22204 or instead represents material that is included in the surrounding text
22205 (such as a branch).
22209 \begin_layout Description
22210 \begin_inset Flex Code
22213 \begin_layout Plain Layout
22220 \begin_inset Flex Code
22223 \begin_layout Plain Layout
22229 ] A label for this inset, possibly including a reference to a counter.
22230 For example, for footnote, it might be:
22231 \begin_inset Flex Code
22234 \begin_layout Plain Layout
22243 This is optional, and there is no default.
22246 \begin_layout Description
22247 \begin_inset Flex Code
22250 \begin_layout Plain Layout
22256 Information to be output in the
22257 \begin_inset Flex Code
22260 \begin_layout Plain Layout
22266 section when this style is used.
22267 This might, for example, be used to include a
22268 \begin_inset Flex Code
22271 \begin_layout Plain Layout
22278 \begin_inset Flex Code
22281 \begin_layout Plain Layout
22290 \begin_layout Description
22291 \begin_inset Flex Code
22294 \begin_layout Plain Layout
22300 CSS style information to be included when this style is used.
22301 Note that this will automatically be wrapped in a layout-generated
22302 \begin_inset Flex Code
22305 \begin_layout Plain Layout
22311 block, so only the CSS itself need be included.
22314 \begin_layout Description
22315 \begin_inset Flex Code
22318 \begin_layout Plain Layout
22325 \begin_inset Flex Code
22328 \begin_layout Plain Layout
22334 ] The tag to be used for the main label, replacing
22335 \begin_inset Flex Code
22338 \begin_layout Plain Layout
22344 in the examples above.
22345 The default depends upon the setting of
22346 \begin_inset Flex Code
22349 \begin_layout Plain Layout
22356 \begin_inset Flex Code
22359 \begin_layout Plain Layout
22365 is true, the default is
22366 \begin_inset Flex Code
22369 \begin_layout Plain Layout
22375 ; if it is false, the default is
22376 \begin_inset Flex Code
22379 \begin_layout Plain Layout
22388 \begin_layout Subsection
22392 \begin_layout Standard
22393 The XHTML output for floats too can be controlled by layout information.
22394 The output has the following form:
22397 \begin_layout LyX-Code
22399 \begin_inset Quotes erd
22403 \begin_inset Quotes erd
22409 \begin_layout LyX-Code
22410 Contents of the float.
22413 \begin_layout LyX-Code
22417 \begin_layout Standard
22418 The caption, if there is one, is a separate inset and will be output as
22420 Its appearance can be controlled via the InsetLayout for caption insets.
22424 \begin_layout Description
22425 \begin_inset Flex Code
22428 \begin_layout Plain Layout
22435 \begin_inset Flex Code
22438 \begin_layout Plain Layout
22444 ] Specifies attribute information to be output with the main tag.
22446 \begin_inset Quotes eld
22450 \begin_inset Flex Code
22453 \begin_layout Plain Layout
22454 class=`myfloat' onclick=`\SpecialChar \ldots{}
22461 \begin_inset Quotes erd
22465 By default, LyX will output
22466 \begin_inset Quotes eld
22470 \begin_inset Flex Code
22473 \begin_layout Plain Layout
22474 class=`float float-floattype'
22480 \begin_inset Quotes erd
22484 \begin_inset Flex Code
22487 \begin_layout Plain Layout
22493 is LyX's name for this type of float, as determined by the float declaration
22495 \begin_inset CommandInset ref
22497 reference "sub:Floats"
22501 ), though made lowercase and with non-alphanumeric characters converted
22502 to underscores, for example: float-table.
22505 \begin_layout Description
22506 \begin_inset Flex Code
22509 \begin_layout Plain Layout
22515 CSS style information to be included when this float is used.
22516 Note that this will automatically be wrapped in a layout-generated
22517 \begin_inset Flex Code
22520 \begin_layout Plain Layout
22526 block, so only the CSS itself need be included.
22529 \begin_layout Description
22530 \begin_inset Flex Code
22533 \begin_layout Plain Layout
22540 \begin_inset Flex Code
22543 \begin_layout Plain Layout
22549 ] The tag to be used for this float, replacing
22550 \begin_inset Quotes eld
22554 \begin_inset Flex Code
22557 \begin_layout Plain Layout
22564 \begin_inset Quotes erd
22567 in the example above.
22569 \begin_inset Flex Code
22572 \begin_layout Plain Layout
22578 and will rarely need changing.
22581 \begin_layout Subsection
22582 Bibliography formatting
22585 \begin_layout Standard
22586 The bibliography can be formatted using
22587 \begin_inset Flex Code
22590 \begin_layout Plain Layout
22598 \begin_inset CommandInset ref
22600 reference "sub:Citation-format-description"
22607 \begin_layout Subsection
22611 \begin_layout Standard
22612 We have several times mentioned that LyX will generate default CSS style
22613 rules for both insets and paragraph styles, based upon the other layout
22614 information that is provided.
22615 In this section, we shall say a word about which layout information LyX
22619 \begin_layout Standard
22620 At present, LyX auto-generates CSS only for font information, making use
22622 \begin_inset Flex Code
22625 \begin_layout Plain Layout
22632 \begin_inset Flex Code
22635 \begin_layout Plain Layout
22642 \begin_inset Flex Code
22645 \begin_layout Plain Layout
22652 \begin_inset Flex Code
22655 \begin_layout Plain Layout
22662 \begin_inset Flex Code
22665 \begin_layout Plain Layout
22673 \begin_inset CommandInset ref
22675 reference "sub:Font-description"
22679 .) The translation is mostly straightforward and obvious.
22681 \begin_inset Quotes eld
22685 \begin_inset Flex Code
22688 \begin_layout Plain Layout
22695 \begin_inset Quotes erd
22699 \begin_inset Quotes eld
22703 \begin_inset Flex Code
22706 \begin_layout Plain Layout
22707 font-family: sans-serif;
22713 \begin_inset Quotes erd
22717 The correspondence of LyX sizes and CSS sizes is a little less obvious
22718 but nonetheless intuitive.
22720 \begin_inset Flex Code
22723 \begin_layout Plain Layout
22730 \begin_inset Flex URL
22733 \begin_layout Plain Layout
22743 \begin_layout Chapter
22744 Including External Material
22747 \begin_layout Standard
22748 \begin_inset Box Shadowbox
22758 height_special "totalheight"
22761 \begin_layout Plain Layout
22762 WARNING: This portion of the documentation has not been updated for some
22764 We certainly hope that it is still accurate, but there are no guarantees.
22772 \begin_layout Standard
22773 The use of material from sources external to LyX is covered in detail in
22779 This part of the manual covers what needs to happen behind the scenes for
22780 new sorts of material to be included.
22783 \begin_layout Section
22787 \begin_layout Standard
22788 The external material feature is based on the concept of a
22793 A template is a specification of how LyX should interface with a certain
22795 As bundled, LyX comes with predefined templates for Xfig figures, various
22796 raster format images, chess diagrams, and LilyPond music notation.
22797 You can check the actual list by using the menu
22798 \begin_inset Flex MenuItem
22801 \begin_layout Plain Layout
22802 Insert\SpecialChar \menuseparator
22803 File\SpecialChar \menuseparator
22810 Furthermore, it is possible to roll your own template to support a specific
22812 Later we'll describe in more detail what is involved, and hopefully you
22813 will submit all the templates you create so we can include them in a later
22817 \begin_layout Standard
22818 Another basic idea of the external material feature is to distinguish between
22819 the original file that serves as a base for final material and the produced
22820 file that is included in your exported or printed document.
22821 For example, consider the case of a figure produced with
22822 \begin_inset Flex Code
22825 \begin_layout Plain Layout
22832 The Xfig application itself works on an original file with the
22833 \begin_inset Flex Code
22836 \begin_layout Plain Layout
22843 Within Xfig, you create and change your figure, and when you are done,
22845 \begin_inset Flex Code
22848 \begin_layout Plain Layout
22855 When you want to include the figure in your document, you invoke
22856 \begin_inset Flex Code
22859 \begin_layout Plain Layout
22865 in order to create a PostScript file that can readily be included in your
22868 \begin_inset Flex Code
22871 \begin_layout Plain Layout
22877 file is the original file, and the PostScript file is the produced file.
22880 \begin_layout Standard
22881 This distinction is important in order to allow updating of the material
22882 while you are in the process of writing the document.
22883 Furthermore, it provides us with the flexibility that is needed to support
22884 multiple export formats.
22885 For instance, in the case of a plain text file, it is not exactly an award-winn
22886 ing idea to include the figure as raw PostScript.
22887 Instead, you would either prefer to just include a reference to the figure
22888 or try to invoke some graphics to ASCII converter to make the final result
22889 look similar to the real graphics.
22890 The external material management allows you to do this, because it is parametri
22891 zed on the different export formats that LyX supports.
22894 \begin_layout Standard
22895 Besides supporting the production of different products according to the
22896 exported format, it supports tight integration with editing and viewing
22898 In the case of an Xfig figure, you are able to invoke Xfig on the original
22899 file with a single click from within the external material dialog in LyX,
22900 and also preview the produced PostScript file with Ghostview with another
22902 No more fiddling around with the command line and/or file browsers to locate
22903 and manipulate the original or produced files.
22904 In this way, you are finally able to take full advantage of the many different
22905 applications that are relevant to use when you write your documents, and
22906 ultimately be more productive.
22909 \begin_layout Section
22910 The external template configuration file
22913 \begin_layout Standard
22914 It is relatively easy to add custom external template definitions to LyX.
22915 However, be aware that doing this in an careless manner most probably
22919 introduce an easily exploitable security hole.
22920 So before you do this, please read the discussion about security in section
22922 \begin_inset CommandInset ref
22924 reference "sec:Security-discussion"
22931 \begin_layout Standard
22932 Having said that, we encourage you to submit any interesting templates that
22937 \begin_layout Standard
22938 The external templates are defined in the
22939 \begin_inset Flex Code
22942 \begin_layout Plain Layout
22943 LyXDir/lib/external_templates
22949 You can place your own version in
22950 \begin_inset Flex Code
22953 \begin_layout Plain Layout
22954 UserDir/external_templates
22962 \begin_layout Standard
22963 A typical template looks like this:
22966 \begin_layout LyX-Code
22970 \begin_layout LyX-Code
22971 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
22974 \begin_layout LyX-Code
22978 \begin_layout LyX-Code
22982 \begin_layout LyX-Code
22986 \begin_layout LyX-Code
22990 \begin_layout LyX-Code
22994 \begin_layout LyX-Code
22995 AutomaticProduction true
22998 \begin_layout LyX-Code
23002 \begin_layout LyX-Code
23006 \begin_layout LyX-Code
23010 \begin_layout LyX-Code
23011 TransformCommand Rotate RotationLatexCommand
23014 \begin_layout LyX-Code
23015 TransformCommand Resize ResizeLatexCommand
23018 \begin_layout LyX-Code
23019 Product "$$RotateFront$$ResizeFront
23022 \begin_layout LyX-Code
23027 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
23030 \begin_layout LyX-Code
23031 $$ResizeBack$$RotateBack"
23034 \begin_layout LyX-Code
23038 \begin_layout LyX-Code
23039 UpdateResult "$$AbsPath$$Basename.pstex_t"
23042 \begin_layout LyX-Code
23043 Requirement "graphicx"
23046 \begin_layout LyX-Code
23047 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
23050 \begin_layout LyX-Code
23051 ReferencedFile latex "$$AbsPath$$Basename.eps"
23054 \begin_layout LyX-Code
23055 ReferencedFile dvi "$$AbsPath$$Basename.eps"
23058 \begin_layout LyX-Code
23062 \begin_layout LyX-Code
23066 \begin_layout LyX-Code
23067 TransformCommand Rotate RotationLatexCommand
23070 \begin_layout LyX-Code
23071 TransformCommand Resize ResizeLatexCommand
23074 \begin_layout LyX-Code
23075 Product "$$RotateFront$$ResizeFront
23078 \begin_layout LyX-Code
23083 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
23086 \begin_layout LyX-Code
23087 $$ResizeBack$$RotateBack"
23090 \begin_layout LyX-Code
23091 UpdateFormat pdftex
23094 \begin_layout LyX-Code
23095 UpdateResult "$$AbsPath$$Basename.pdftex_t"
23098 \begin_layout LyX-Code
23099 Requirement "graphicx"
23102 \begin_layout LyX-Code
23103 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
23106 \begin_layout LyX-Code
23107 ReferencedFile latex "$$AbsPath$$Basename.pdf"
23110 \begin_layout LyX-Code
23114 \begin_layout LyX-Code
23118 \begin_layout LyX-Code
23119 Product "$$Contents(
23121 "$$AbsPath$$Basename.asc
23126 \begin_layout LyX-Code
23127 UpdateFormat asciixfig
23130 \begin_layout LyX-Code
23131 UpdateResult "$$AbsPath$$Basename.asc"
23134 \begin_layout LyX-Code
23138 \begin_layout LyX-Code
23142 \begin_layout LyX-Code
23143 Product "<graphic fileref=
23145 "$$AbsOrRelPathMaster$$Basename.eps
23150 \begin_layout LyX-Code
23154 \begin_layout LyX-Code
23158 \begin_layout LyX-Code
23159 UpdateResult "$$AbsPath$$Basename.eps"
23162 \begin_layout LyX-Code
23163 ReferencedFile docbook "$$AbsPath$$Basename.eps"
23166 \begin_layout LyX-Code
23167 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
23170 \begin_layout LyX-Code
23174 \begin_layout LyX-Code
23175 Product "[XFig: $$FName]"
23178 \begin_layout LyX-Code
23182 \begin_layout LyX-Code
23186 \begin_layout Standard
23187 As you can see, the template is enclosed in
23188 \begin_inset Flex Code
23191 \begin_layout Plain Layout
23197 \SpecialChar \ldots{}
23199 \begin_inset Flex Code
23202 \begin_layout Plain Layout
23209 It contains a header specifying some general settings and, for each supported
23210 primary document file format, a section
23211 \begin_inset Flex Code
23214 \begin_layout Plain Layout
23220 \SpecialChar \ldots{}
23222 \begin_inset Flex Code
23225 \begin_layout Plain Layout
23234 \begin_layout Subsection
23235 The template header
23238 \begin_layout Description
23239 \begin_inset Flex Code
23242 \begin_layout Plain Layout
23243 AutomaticProduction
23244 \begin_inset space ~
23252 Whether the file represented by the template must be generated by LyX.
23253 This command must occur exactly once.
23256 \begin_layout Description
23257 \begin_inset Flex Code
23260 \begin_layout Plain Layout
23262 \begin_inset space ~
23270 A glob pattern that is used in the file dialog to filter out the desired
23272 If there is more than one possible file extension (e.
23273 \begin_inset space \thinspace{}
23277 \begin_inset space \space{}
23281 \begin_inset Flex Code
23284 \begin_layout Plain Layout
23291 \begin_inset Flex Code
23294 \begin_layout Plain Layout
23300 ), use something like
23301 \begin_inset Flex Code
23304 \begin_layout Plain Layout
23311 This command must occur exactly once.
23314 \begin_layout Description
23315 \begin_inset Flex Code
23318 \begin_layout Plain Layout
23320 \begin_inset space ~
23328 The text that is displayed on the button.
23329 This command must occur exactly once.
23332 \begin_layout Description
23333 \begin_inset Flex Code
23336 \begin_layout Plain Layout
23338 \begin_inset space ~
23342 \begin_inset space ~
23350 The help text that is used in the External dialog.
23351 Provide enough information to explain to the user just what the template
23352 can provide him with.
23353 This command must occur exactly once.
23356 \begin_layout Description
23357 \begin_inset Flex Code
23360 \begin_layout Plain Layout
23362 \begin_inset space ~
23370 The file format of the original file.
23371 This must be the name of a format that is known to LyX (see section
23372 \begin_inset space ~
23376 \begin_inset CommandInset ref
23378 reference "sec:Formats"
23384 \begin_inset Quotes eld
23388 \begin_inset Flex Code
23391 \begin_layout Plain Layout
23398 \begin_inset Quotes erd
23401 if the template can handle original files of more than one format.
23402 LyX will attempt to interrogate the file itself in order to deduce its
23403 format in this case.
23404 This command must occur exactly once.
23407 \begin_layout Description
23408 \begin_inset Flex Code
23411 \begin_layout Plain Layout
23413 \begin_inset space ~
23421 A unique name for the template.
23422 It must not contain substitution macros (see below).
23425 \begin_layout Description
23426 \begin_inset Flex Code
23429 \begin_layout Plain Layout
23431 \begin_inset space ~
23434 Rotate|Resize|Clip|Extra
23439 This command specifies which transformations are supported by this template.
23440 It may occur zero or more times.
23441 This command enables the corresponding tabs in the external dialog.
23443 \begin_inset Flex Code
23446 \begin_layout Plain Layout
23452 command must have either a corresponding
23453 \begin_inset Flex Code
23456 \begin_layout Plain Layout
23463 \begin_inset Flex Code
23466 \begin_layout Plain Layout
23473 \begin_inset Flex Code
23476 \begin_layout Plain Layout
23483 Otherwise the transformation will not be supported by that format.
23486 \begin_layout Subsection
23490 \begin_layout Description
23491 \begin_inset Flex Code
23494 \begin_layout Plain Layout
23496 \begin_inset space ~
23499 LaTeX|PDFLaTeX|PlainText|DocBook
23504 The primary document file format that this format definition is for.
23505 Not every template has a sensible representation in all document file formats.
23506 Please define nevertheless a
23507 \begin_inset Flex Code
23510 \begin_layout Plain Layout
23516 section for all templates.
23517 Use a dummy text when no representation is available.
23518 Then you can at least see a reference to the external material in the exported
23522 \begin_layout Description
23523 \begin_inset Flex Code
23526 \begin_layout Plain Layout
23528 \begin_inset space ~
23532 \begin_inset space ~
23540 This command defines an additional macro
23541 \begin_inset Flex Code
23544 \begin_layout Plain Layout
23550 for substitution in
23551 \begin_inset Flex Code
23554 \begin_layout Plain Layout
23562 \begin_inset Flex Code
23565 \begin_layout Plain Layout
23571 itself may contain substitution macros.
23572 The advantage over using
23573 \begin_inset Flex Code
23576 \begin_layout Plain Layout
23583 \begin_inset Flex Code
23586 \begin_layout Plain Layout
23592 is that the substituted value of
23593 \begin_inset Flex Code
23596 \begin_layout Plain Layout
23602 is sanitized so that it is a valid optional argument in the document format.
23603 This command may occur zero or more times.
23606 \begin_layout Description
23607 \begin_inset Flex Code
23610 \begin_layout Plain Layout
23612 \begin_inset space ~
23620 The text that is inserted in the exported document.
23621 This is actually the most important command and can be quite complex.
23622 This command must occur exactly once.
23625 \begin_layout Description
23626 \begin_inset Flex Code
23629 \begin_layout Plain Layout
23631 \begin_inset space ~
23639 This command specifies a preamble snippet that will be included in the
23641 It has to be defined using
23642 \begin_inset Flex Code
23645 \begin_layout Plain Layout
23651 \SpecialChar \ldots{}
23653 \begin_inset Flex Code
23656 \begin_layout Plain Layout
23663 This command may occur zero or more times.
23666 \begin_layout Description
23667 \begin_inset Flex Code
23670 \begin_layout Plain Layout
23672 \begin_inset space ~
23676 \begin_inset space ~
23684 This command denotes files that are created by the conversion process and
23685 are needed for a particular export format.
23686 If the filename is relative, it is interpreted relative to the master document.
23687 This command may be given zero or more times.
23690 \begin_layout Description
23691 \begin_inset Flex Code
23694 \begin_layout Plain Layout
23696 \begin_inset space ~
23704 The name of a required LaTeX package.
23705 The package is included via
23706 \begin_inset Flex Code
23709 \begin_layout Plain Layout
23717 in the LaTeX preamble.
23718 This command may occur zero or more times.
23721 \begin_layout Description
23722 \begin_inset Flex Code
23725 \begin_layout Plain Layout
23727 \begin_inset space ~
23731 \begin_inset space ~
23734 RotationLatexCommand
23739 This command specifies that the built in LaTeX command should be used for
23741 This command may occur once or not at all.
23744 \begin_layout Description
23745 \begin_inset Flex Code
23748 \begin_layout Plain Layout
23750 \begin_inset space ~
23754 \begin_inset space ~
23762 This command specifies that the built in LaTeX command should be used for
23764 This command may occur once or not at all.
23767 \begin_layout Description
23768 \begin_inset Flex Code
23771 \begin_layout Plain Layout
23773 \begin_inset space ~
23777 \begin_inset space ~
23780 RotationLatexOption
23785 This command specifies that rotation is done via an optional argument.
23786 This command may occur once or not at all.
23789 \begin_layout Description
23790 \begin_inset Flex Code
23793 \begin_layout Plain Layout
23795 \begin_inset space ~
23799 \begin_inset space ~
23807 This command specifies that resizing is done via an optional argument.
23808 This command may occur once or not at all.
23811 \begin_layout Description
23812 \begin_inset Flex Code
23815 \begin_layout Plain Layout
23817 \begin_inset space ~
23821 \begin_inset space ~
23829 This command specifies that clipping is done via an optional argument.
23830 This command may occur once or not at all.
23833 \begin_layout Description
23834 \begin_inset Flex Code
23837 \begin_layout Plain Layout
23839 \begin_inset space ~
23843 \begin_inset space ~
23851 This command specifies that an extra optional argument is used.
23852 This command may occur once or not at all.
23855 \begin_layout Description
23856 \begin_inset Flex Code
23859 \begin_layout Plain Layout
23861 \begin_inset space ~
23869 The file format of the converted file.
23870 This must be the name of a format that is known to LyX (see the
23871 \begin_inset Flex MenuItem
23874 \begin_layout Plain Layout
23879 ools\SpecialChar \menuseparator
23884 references\SpecialChar \menuseparator
23885 File Handling\SpecialChar \menuseparator
23892 This command must occur exactly once.
23894 \change_inserted -195340706 1363813305
23895 If the resulting file format is PDF, you need to specify the format
23896 \begin_inset Flex Code
23899 \begin_layout Plain Layout
23901 \change_inserted -195340706 1363813269
23908 This is the PDF format used for including graphics.
23909 The other defined PDF formats are for document export.
23914 \begin_layout Description
23915 \begin_inset Flex Code
23918 \begin_layout Plain Layout
23920 \begin_inset space ~
23928 The file name of the converted file.
23929 The file name must be absolute.
23930 This command must occur exactly once.
23933 \begin_layout Subsection
23934 Preamble definitions
23937 \begin_layout Standard
23938 The external template configuration file may contain additional preamble
23939 definitions enclosed by
23940 \begin_inset Flex Code
23943 \begin_layout Plain Layout
23949 \SpecialChar \ldots{}
23951 \begin_inset Flex Code
23954 \begin_layout Plain Layout
23961 They can be used by the templates in the
23962 \begin_inset Flex Code
23965 \begin_layout Plain Layout
23974 \begin_layout Section
23975 The substitution mechanism
23978 \begin_layout Standard
23979 When the external material facility invokes an external program, it is done
23980 on the basis of a command defined in the template configuration file.
23981 These commands can contain various macros that are expanded before execution.
23982 Execution always take place in the directory of the containing document.
23985 \begin_layout Standard
23986 Also, whenever external material is to be displayed, the name will be produced
23987 by the substitution mechanism, and most other commands in the template
23988 definition support substitution as well.
23991 \begin_layout Standard
23992 The available macros are the following:
23995 \begin_layout Description
23996 \begin_inset Flex Code
23999 \begin_layout Plain Layout
24000 $$AbsOrRelPathMaster
24005 The file path, absolute or relative to the master LyX document.
24008 \begin_layout Description
24009 \begin_inset Flex Code
24012 \begin_layout Plain Layout
24013 $$AbsOrRelPathParent
24018 The file path, absolute or relative to the LyX document.
24021 \begin_layout Description
24022 \begin_inset Flex Code
24025 \begin_layout Plain Layout
24031 The absolute file path.
24034 \begin_layout Description
24035 \begin_inset Flex Code
24038 \begin_layout Plain Layout
24044 The filename without path and without the extension.
24047 \begin_layout Description
24048 \begin_inset Flex Code
24051 \begin_layout Plain Layout
24053 \begin_inset Quotes eld
24057 \begin_inset Quotes erd
24065 This macro will expand to the contents of the file with the name
24066 \begin_inset Flex Code
24069 \begin_layout Plain Layout
24078 \begin_layout Description
24079 \begin_inset Flex Code
24082 \begin_layout Plain Layout
24088 The file extension (including the dot).
24091 \begin_layout Description
24092 \begin_inset Flex Code
24095 \begin_layout Plain Layout
24101 The filename of the file specified in the external material dialog.
24102 This is either an absolute name, or it is relative to the LyX document.
24105 \begin_layout Description
24106 \begin_inset Flex Code
24109 \begin_layout Plain Layout
24116 \begin_inset Flex Code
24119 \begin_layout Plain Layout
24125 (absolute name or relative to the LyX document).
24128 \begin_layout Description
24129 \begin_inset Flex Code
24132 \begin_layout Plain Layout
24138 The file path, relative to the master LyX document.
24141 \begin_layout Description
24142 \begin_inset Flex Code
24145 \begin_layout Plain Layout
24151 The file path, relative to the LyX document.
24154 \begin_layout Description
24155 \begin_inset Flex Code
24158 \begin_layout Plain Layout
24164 This macro will expand to the absolute path of the system directory.
24165 This is typically used to point to the various helper scripts that are
24169 \begin_layout Description
24170 \begin_inset Flex Code
24173 \begin_layout Plain Layout
24179 A name and full path to a temporary file which will be automatically deleted
24180 whenever the containing document is closed, or the external material insertion
24184 \begin_layout Standard
24185 All path macros contain a trailing directory separator, so you can construct
24187 \begin_inset space \thinspace{}
24191 \begin_inset space \space{}
24194 the absolute filename with
24195 \begin_inset Flex Code
24198 \begin_layout Plain Layout
24199 $$AbsPath$$Basename$$Extension
24207 \begin_layout Standard
24208 The macros above are substituted in all commands unless otherwise noted.
24210 \begin_inset Flex Code
24213 \begin_layout Plain Layout
24219 supports additionally the following substitutions if they are enabled by
24221 \begin_inset Flex Code
24224 \begin_layout Plain Layout
24231 \begin_inset Flex Code
24234 \begin_layout Plain Layout
24243 \begin_layout Description
24244 \begin_inset Flex Code
24247 \begin_layout Plain Layout
24253 The front part of the resize command.
24256 \begin_layout Description
24257 \begin_inset Flex Code
24260 \begin_layout Plain Layout
24266 The back part of the resize command.
24269 \begin_layout Description
24270 \begin_inset Flex Code
24273 \begin_layout Plain Layout
24279 The front part of the rotation command.
24282 \begin_layout Description
24283 \begin_inset Flex Code
24286 \begin_layout Plain Layout
24292 The back part of the rotation command.
24295 \begin_layout Standard
24296 The value string of the
24297 \begin_inset Flex Code
24300 \begin_layout Plain Layout
24306 command supports additionally the following substitutions if they are enabled
24308 \begin_inset Flex Code
24311 \begin_layout Plain Layout
24318 \begin_inset Flex Code
24321 \begin_layout Plain Layout
24330 \begin_layout Description
24331 \begin_inset Flex Code
24334 \begin_layout Plain Layout
24343 \begin_layout Description
24344 \begin_inset Flex Code
24347 \begin_layout Plain Layout
24356 \begin_layout Description
24357 \begin_inset Flex Code
24360 \begin_layout Plain Layout
24369 \begin_layout Description
24370 \begin_inset Flex Code
24373 \begin_layout Plain Layout
24379 The rotation option.
24382 \begin_layout Standard
24383 You may ask why there are so many path macros.
24384 There are mainly two reasons:
24387 \begin_layout Enumerate
24388 Relative and absolute file names should remain relative or absolute, respectivel
24390 Users may have reasons to prefer either form.
24391 Relative names are useful for portable documents that should work on different
24392 machines, for example.
24393 Absolute names may be required by some programs.
24396 \begin_layout Enumerate
24397 LaTeX treats relative file names differently than LyX and other programs
24398 in nested included files.
24399 For LyX, a relative file name is always relative to the document that contains
24401 For LaTeX, it is always relative to the master document.
24402 These two definitions are identical if you have only one document, but
24403 differ if you have a master document that includes part documents.
24404 That means that relative filenames must be transformed when presented to
24406 Fortunately LyX does this automatically for you if you choose the right
24410 \begin_layout Standard
24411 So which path macro should be used in new template definitions? The rule
24415 \begin_layout Itemize
24417 \begin_inset Flex Code
24420 \begin_layout Plain Layout
24426 if an absolute path is required.
24429 \begin_layout Itemize
24431 \begin_inset Flex Code
24434 \begin_layout Plain Layout
24435 $$AbsOrRelPathMaster
24440 if the substituted string is some kind of LaTeX input.
24443 \begin_layout Itemize
24445 \begin_inset Flex Code
24448 \begin_layout Plain Layout
24449 $$AbsOrRelPathParent
24454 in order to preserve the user's choice.
24457 \begin_layout Standard
24458 There are special cases where this rule does not work and e.
24459 \begin_inset space \thinspace{}
24463 \begin_inset space \space{}
24466 relative names are needed, but normally it will work just fine.
24467 One example for such a case is the command
24468 \begin_inset Flex Code
24471 \begin_layout Plain Layout
24472 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
24477 in the XFig template above: We can't use the absolute name because the
24479 \begin_inset Flex Code
24482 \begin_layout Plain Layout
24488 files needs the relative name in order to rewrite the file content.
24491 \begin_layout Section
24492 Security discussion
24493 \begin_inset CommandInset label
24495 name "sec:Security-discussion"
24502 \begin_layout Standard
24503 The external material feature interfaces with a lot of external programs
24504 and does so automatically, so we have to consider the security implications
24506 In particular, since you have the option of including your own filenames
24507 and/or parameter strings and those are expanded into a command, it seems
24508 that it would be possible to create a malicious document which executes
24509 arbitrary commands when a user views or prints the document.
24510 This is something we definitely want to avoid.
24513 \begin_layout Standard
24514 However, since the external program commands are specified in the template
24515 configuration file only, there are no security issues if LyX is properly
24516 configured with safe templates only.
24517 This is so because the external programs are invoked with the
24518 \begin_inset Flex Code
24521 \begin_layout Plain Layout
24527 -system call rather than the
24528 \begin_inset Flex Code
24531 \begin_layout Plain Layout
24537 system-call, so it's not possible to execute arbitrary commands from the
24538 filename or parameter section via the shell.
24541 \begin_layout Standard
24542 This also implies that you are restricted in what command strings you can
24543 use in the external material templates.
24544 In particular, pipes and redirection are not readily available.
24545 This has to be so if LyX should remain safe.
24546 If you want to use some of the shell features, you should write a safe
24547 script to do this in a controlled manner, and then invoke the script from
24548 the command string.
24552 \begin_layout Standard
24553 It is possible to design a template that interacts directly with the shell,
24554 but since this would allow a malicious user to execute arbitrary commands
24555 by writing clever filenames and/or parameters, we generally recommend that
24556 you only use safe scripts that work with the
24557 \begin_inset Flex Code
24560 \begin_layout Plain Layout
24566 system call in a controlled manner.
24567 Of course, for use in a controlled environment, it can be tempting to just
24568 fall back to use ordinary shell scripts.
24569 If you do so, be aware that you
24573 provide an easily exploitable security hole in your system.
24574 Of course it stands to reason that such unsafe templates will never be
24575 included in the standard LyX distribution, although we do encourage people
24576 to submit new templates in the open source tradition.
24577 But LyX as shipped from the official distribution channels will never have
24581 \begin_layout Standard
24582 Including external material provides a lot of power, and you have to be
24583 careful not to introduce security hazards with this power.
24584 A subtle error in a single line in an innocent looking script can open
24585 the door to huge security problems.
24586 So if you do not fully understand the issues, we recommend that you consult
24587 a knowledgeable security professional or the LyX development team if you
24588 have any questions about whether a given template is safe or not.
24589 And do this before you use it in an uncontrolled environment.
24592 \begin_layout Chapter
24594 List of supported LyX functions to be used in layouts
24595 \begin_inset CommandInset label
24597 name "chap:List-of-functions"
24604 \begin_layout Standard
24606 \begin_inset Tabular
24607 <lyxtabular version="3" rows="11" columns="8">
24608 <features rotate="0" tabularvalignment="middle">
24609 <column alignment="left" valignment="top">
24610 <column alignment="left" valignment="top">
24611 <column alignment="left" valignment="top">
24612 <column alignment="left" valignment="top">
24613 <column alignment="left" valignment="top">
24614 <column alignment="left" valignment="top">
24615 <column alignment="left" valignment="top">
24616 <column alignment="left" valignment="top">
24618 <cell alignment="left" valignment="top" usebox="none">
24621 \begin_layout Plain Layout
24627 <cell alignment="left" valignment="top" usebox="none">
24630 \begin_layout Plain Layout
24636 <cell alignment="left" valignment="top" usebox="none">
24639 \begin_layout Plain Layout
24645 <cell alignment="left" valignment="top" usebox="none">
24648 \begin_layout Plain Layout
24654 <cell alignment="center" valignment="top" usebox="none">
24657 \begin_layout Plain Layout
24663 <cell alignment="center" valignment="top" usebox="none">
24666 \begin_layout Plain Layout
24672 <cell alignment="center" valignment="top" usebox="none">
24675 \begin_layout Plain Layout
24681 <cell alignment="center" valignment="top" usebox="none">
24684 \begin_layout Plain Layout
24692 <cell alignment="left" valignment="top" usebox="none">
24695 \begin_layout Plain Layout
24701 <cell alignment="left" valignment="top" usebox="none">
24704 \begin_layout Plain Layout
24710 <cell alignment="left" valignment="top" usebox="none">
24713 \begin_layout Plain Layout
24719 <cell alignment="left" valignment="top" usebox="none">
24722 \begin_layout Plain Layout
24728 <cell alignment="center" valignment="top" usebox="none">
24731 \begin_layout Plain Layout
24737 <cell alignment="center" valignment="top" usebox="none">
24740 \begin_layout Plain Layout
24746 <cell alignment="center" valignment="top" usebox="none">
24749 \begin_layout Plain Layout
24755 <cell alignment="center" valignment="top" usebox="none">
24758 \begin_layout Plain Layout
24766 <cell alignment="left" valignment="top" usebox="none">
24769 \begin_layout Plain Layout
24775 <cell alignment="left" valignment="top" usebox="none">
24778 \begin_layout Plain Layout
24784 <cell alignment="left" valignment="top" usebox="none">
24787 \begin_layout Plain Layout
24793 <cell alignment="left" valignment="top" usebox="none">
24796 \begin_layout Plain Layout
24802 <cell alignment="center" valignment="top" usebox="none">
24805 \begin_layout Plain Layout
24811 <cell alignment="center" valignment="top" usebox="none">
24814 \begin_layout Plain Layout
24820 <cell alignment="center" valignment="top" usebox="none">
24823 \begin_layout Plain Layout
24829 <cell alignment="center" valignment="top" usebox="none">
24832 \begin_layout Plain Layout
24840 <cell alignment="left" valignment="top" usebox="none">
24843 \begin_layout Plain Layout
24849 <cell alignment="left" valignment="top" usebox="none">
24852 \begin_layout Plain Layout
24858 <cell alignment="left" valignment="top" usebox="none">
24861 \begin_layout Plain Layout
24867 <cell alignment="left" valignment="top" usebox="none">
24870 \begin_layout Plain Layout
24876 <cell alignment="center" valignment="top" usebox="none">
24879 \begin_layout Plain Layout
24885 <cell alignment="center" valignment="top" usebox="none">
24888 \begin_layout Plain Layout
24894 <cell alignment="center" valignment="top" usebox="none">
24897 \begin_layout Plain Layout
24903 <cell alignment="center" valignment="top" usebox="none">
24906 \begin_layout Plain Layout
24914 <cell alignment="left" valignment="top" usebox="none">
24917 \begin_layout Plain Layout
24923 <cell alignment="left" valignment="top" usebox="none">
24926 \begin_layout Plain Layout
24932 <cell alignment="left" valignment="top" usebox="none">
24935 \begin_layout Plain Layout
24941 <cell alignment="left" valignment="top" usebox="none">
24944 \begin_layout Plain Layout
24950 <cell alignment="center" valignment="top" usebox="none">
24953 \begin_layout Plain Layout
24959 <cell alignment="center" valignment="top" usebox="none">
24962 \begin_layout Plain Layout
24968 <cell alignment="center" valignment="top" usebox="none">
24971 \begin_layout Plain Layout
24977 <cell alignment="center" valignment="top" usebox="none">
24980 \begin_layout Plain Layout
24988 <cell alignment="left" valignment="top" usebox="none">
24991 \begin_layout Plain Layout
24997 <cell alignment="left" valignment="top" usebox="none">
25000 \begin_layout Plain Layout
25006 <cell alignment="left" valignment="top" usebox="none">
25009 \begin_layout Plain Layout
25015 <cell alignment="left" valignment="top" usebox="none">
25018 \begin_layout Plain Layout
25024 <cell alignment="center" valignment="top" usebox="none">
25027 \begin_layout Plain Layout
25033 <cell alignment="center" valignment="top" usebox="none">
25036 \begin_layout Plain Layout
25042 <cell alignment="center" valignment="top" usebox="none">
25045 \begin_layout Plain Layout
25051 <cell alignment="center" valignment="top" usebox="none">
25054 \begin_layout Plain Layout
25062 <cell alignment="left" valignment="top" usebox="none">
25065 \begin_layout Plain Layout
25071 <cell alignment="left" valignment="top" usebox="none">
25074 \begin_layout Plain Layout
25080 <cell alignment="left" valignment="top" usebox="none">
25083 \begin_layout Plain Layout
25089 <cell alignment="left" valignment="top" usebox="none">
25092 \begin_layout Plain Layout
25098 <cell alignment="center" valignment="top" usebox="none">
25101 \begin_layout Plain Layout
25107 <cell alignment="center" valignment="top" usebox="none">
25110 \begin_layout Plain Layout
25116 <cell alignment="center" valignment="top" usebox="none">
25119 \begin_layout Plain Layout
25125 <cell alignment="center" valignment="top" usebox="none">
25128 \begin_layout Plain Layout
25136 <cell alignment="left" valignment="top" usebox="none">
25139 \begin_layout Plain Layout
25145 <cell alignment="left" valignment="top" usebox="none">
25148 \begin_layout Plain Layout
25154 <cell alignment="left" valignment="top" usebox="none">
25157 \begin_layout Plain Layout
25163 <cell alignment="left" valignment="top" usebox="none">
25166 \begin_layout Plain Layout
25172 <cell alignment="center" valignment="top" usebox="none">
25175 \begin_layout Plain Layout
25181 <cell alignment="center" valignment="top" usebox="none">
25184 \begin_layout Plain Layout
25190 <cell alignment="center" valignment="top" usebox="none">
25193 \begin_layout Plain Layout
25199 <cell alignment="center" valignment="top" usebox="none">
25202 \begin_layout Plain Layout
25210 <cell alignment="left" valignment="top" usebox="none">
25213 \begin_layout Plain Layout
25219 <cell alignment="left" valignment="top" usebox="none">
25222 \begin_layout Plain Layout
25228 <cell alignment="left" valignment="top" usebox="none">
25231 \begin_layout Plain Layout
25237 <cell alignment="left" valignment="top" usebox="none">
25240 \begin_layout Plain Layout
25246 <cell alignment="center" valignment="top" usebox="none">
25249 \begin_layout Plain Layout
25255 <cell alignment="center" valignment="top" usebox="none">
25258 \begin_layout Plain Layout
25264 <cell alignment="center" valignment="top" usebox="none">
25267 \begin_layout Plain Layout
25273 <cell alignment="center" valignment="top" usebox="none">
25276 \begin_layout Plain Layout
25284 <cell alignment="left" valignment="top" usebox="none">
25287 \begin_layout Plain Layout
25293 <cell alignment="left" valignment="top" usebox="none">
25296 \begin_layout Plain Layout
25302 <cell alignment="left" valignment="top" usebox="none">
25305 \begin_layout Plain Layout
25311 <cell alignment="left" valignment="top" usebox="none">
25314 \begin_layout Plain Layout
25320 <cell alignment="center" valignment="top" usebox="none">
25323 \begin_layout Plain Layout
25329 <cell alignment="center" valignment="top" usebox="none">
25332 \begin_layout Plain Layout
25338 <cell alignment="center" valignment="top" usebox="none">
25341 \begin_layout Plain Layout
25347 <cell alignment="center" valignment="top" usebox="none">
25350 \begin_layout Plain Layout
25358 <cell alignment="center" valignment="top" usebox="none">
25361 \begin_layout Plain Layout
25367 <cell alignment="center" valignment="top" usebox="none">
25370 \begin_layout Plain Layout
25376 <cell alignment="center" valignment="top" usebox="none">
25379 \begin_layout Plain Layout
25385 <cell alignment="center" valignment="top" usebox="none">
25388 \begin_layout Plain Layout
25394 <cell alignment="center" valignment="top" usebox="none">
25397 \begin_layout Plain Layout
25403 <cell alignment="center" valignment="top" usebox="none">
25406 \begin_layout Plain Layout
25412 <cell alignment="center" valignment="top" usebox="none">
25415 \begin_layout Plain Layout
25421 <cell alignment="center" valignment="top" usebox="none">
25424 \begin_layout Plain Layout
25438 \begin_layout Chapter
25439 Names of available colors to be used in layouts
25440 \begin_inset CommandInset label
25442 name "chap:Names-of-colors"
25449 \begin_layout Standard
25450 The colors listed here are the standard colors and the those that you can
25451 adjust in the LyX preferences.
25454 \begin_layout Description
25467 No particular color -- clear or default
25470 \begin_layout Description
25474 \begin_layout Description
25478 \begin_layout Description
25482 \begin_layout Description
25486 \begin_layout Description
25490 \begin_layout Description
25494 \begin_layout Description
25498 \begin_layout Description
25502 \begin_layout Description
25503 cursor Cursor color
25506 \begin_layout Description
25507 background Background color
25510 \begin_layout Description
25511 foreground Foreground color
25514 \begin_layout Description
25515 selection Background color of selected text
25518 \begin_layout Description
25519 selectiontext Foreground color of selected text
25522 \begin_layout Description
25523 latex Text color in LaTeX mode
25526 \begin_layout Description
25527 preview The color used for previews
25530 \begin_layout Description
25531 inlinecompletion Inline completion color
25534 \begin_layout Description
25535 nonunique_inlinecompletion Inline completion color for the non-unique part
25538 \begin_layout Description
25539 notelabel Label color for notes
25542 \begin_layout Description
25543 notebg Background color of notes
25546 \begin_layout Description
25547 commentlabel Label color for comments
25550 \begin_layout Description
25551 commentbg Background color of comments
25554 \begin_layout Description
25555 greyedoutlabel Label color for greyedout insets
25558 \begin_layout Description
25559 greyedouttext Color for greyedout inset text
25562 \begin_layout Description
25563 greyedoutbg Background color of greyedout inset
25566 \begin_layout Description
25567 shadedbg Background color of shaded box
25570 \begin_layout Description
25571 listingsbg Background color of listings inset
25574 \begin_layout Description
25575 branchlabel Label color for branches
25578 \begin_layout Description
25579 footlabel Label color for footnotes
25582 \begin_layout Description
25583 indexlabel Label color for index insets
25586 \begin_layout Description
25587 marginlabel Label color for margin notes
25590 \begin_layout Description
25591 phantomtext Text color for phantom insets
25594 \begin_layout Description
25595 urllabel Label color for URL insets
25598 \begin_layout Description
25599 urltext Color for URL inset text
25602 \begin_layout Description
25603 depthbar Color for the depth bars in the margin
25606 \begin_layout Description
25607 language Color for marking foreign language words
25610 \begin_layout Description
25611 command Text color for command insets
25614 \begin_layout Description
25615 commandbg Background color for command insets
25618 \begin_layout Description
25619 commandframe Frame color for command insets
25622 \begin_layout Description
25623 special Special chars text color
25626 \begin_layout Description
25627 graphicsbg Graphics inset background color
25630 \begin_layout Description
25631 math Math inset text color
25634 \begin_layout Description
25635 mathbg Math inset background color
25638 \begin_layout Description
25639 mathmacrobg Macro math inset background color
25642 \begin_layout Description
25643 mathmacrohoverbg Macro math inset background color hovered
25646 \begin_layout Description
25647 mathmacrolabel Macro math label color
25650 \begin_layout Description
25651 mathmacroframe Macro math frame color
25654 \begin_layout Description
25655 mathmacroblend Macro math blended color
25658 \begin_layout Description
25659 mathmacrooldarg Macro template color for old parameters
25662 \begin_layout Description
25663 mathmacronewarg Macro template color for new parameters
25666 \begin_layout Description
25667 mathframe Math inset frame color under focus
25670 \begin_layout Description
25671 mathcorners Math inset frame color not under focus
25674 \begin_layout Description
25675 mathline Math line color
25678 \begin_layout Description
25679 collapsable Collapsable insets text
25682 \begin_layout Description
25683 collapsableframe Collapsable insets frame
25686 \begin_layout Description
25687 insetbg Inset marker background color
25690 \begin_layout Description
25691 insetframe Inset marker frame color
25694 \begin_layout Description
25695 error Error box text color
25698 \begin_layout Description
25699 eolmarker End of line marker color
25702 \begin_layout Description
25703 added_space Added space colour
25706 \begin_layout Description
25707 appendix Appendix marker color
25710 \begin_layout Description
25711 changebar Changebar color
25714 \begin_layout Description
25715 deletedtext Deleted text color
25718 \begin_layout Description
25719 addedtext Added text color
25722 \begin_layout Description
25723 changedtextauthor1 Changed text color author 1
25726 \begin_layout Description
25727 changedtextauthor2 Changed text color author 2
25730 \begin_layout Description
25731 changedtextauthor3 Changed text color author 3
25734 \begin_layout Description
25735 changedtextauthor4 Changed text color author 4
25738 \begin_layout Description
25739 changedtextauthor5 Changed text color author 5
25742 \begin_layout Description
25743 deletedtextmodifier Deleted text modifying color
25746 \begin_layout Description
25747 tabularline Table line color
25750 \begin_layout Description
25751 tabularonoffline Table line color
25754 \begin_layout Description
25755 bottomarea Bottom area color
25758 \begin_layout Description
25759 newpage New page color
25762 \begin_layout Description
25763 pagebreak Page break color
25766 \begin_layout Description
25767 buttonframe Color used for button frame
25770 \begin_layout Description
25771 buttonbg Color used for bottom background
25774 \begin_layout Description
25775 buttonhoverbg Color used for buttom under focus
25778 \begin_layout Description
25779 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
25783 \begin_layout Description
25784 previewframe Preview frame color
25787 \begin_layout Description
25788 inherit Color is inherited
25791 \begin_layout Description
25792 regexpframe Color for regexp frame
25795 \begin_layout Description
25796 ignore For ignoring updates of a color