1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that this document prints
12 % out as advertised. If you mess with this preamble,
13 % parts of this document may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC is numbered roman
19 % and a pdf-bookmark for the TOC is added
20 \let\myTOC\tableofcontents
21 \renewcommand\tableofcontents{%
23 \pdfbookmark[1]{\contentsname}{}
27 % increase link area for cross-references and autoname them,
28 \AtBeginDocument{\renewcommand{\ref}[1]{\mbox{\autoref{#1}}}}
29 \@ifundefined{extrasenglish}{\usepackage[english]{babel}}{}
30 \@ifpackageloaded{babel}{
31 \addto\extrasenglish{%
32 \renewcommand*{\equationautorefname}[1]{}%
33 \renewcommand{\sectionautorefname}{sec.\negthinspace}%
34 \renewcommand{\subsectionautorefname}{sec.\negthinspace}%
35 \renewcommand{\subsubsectionautorefname}{sec.\negthinspace}%
39 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
40 \use_default_options false
44 \maintain_unincluded_children no
46 \language_package default
49 \font_roman "lmodern" "default"
50 \font_sans "lmss" "default"
51 \font_typewriter "lmtt" "default"
52 \font_math "auto" "auto"
53 \font_default_family default
54 \use_non_tex_fonts false
58 \font_typewriter_osf false
59 \font_sf_scale 100 100
60 \font_tt_scale 100 100
62 \use_dash_ligatures true
64 \default_output_format pdf2
66 \bibtex_command default
67 \index_command default
71 \pdf_title "LyX Configuration Manual"
72 \pdf_author "LyX Team"
73 \pdf_subject "LyX-documentation Customization"
74 \pdf_keywords "LyX, documentation, customization"
76 \pdf_bookmarksnumbered true
77 \pdf_bookmarksopen true
78 \pdf_bookmarksopenlevel 1
83 \pdf_pdfusetitle false
84 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
87 \use_package amsmath 1
88 \use_package amssymb 1
91 \use_package mathdots 1
92 \use_package mathtools 1
94 \use_package stackrel 1
95 \use_package stmaryrd 1
96 \use_package undertilde 1
98 \cite_engine_type default
102 \paperorientation portrait
108 \notefontcolor #0000ff
120 \paragraph_separation indent
121 \paragraph_indentation default
123 \math_indentation default
124 \math_numbering_side default
125 \quotes_style english
129 \paperpagestyle headings
131 \tracking_changes true
132 \output_changes false
134 \postpone_fragile_content false
138 \docbook_table_output 0
139 \author -970929547 "Thibaut Cuvelier"
140 \author -712698321 "Jürgen Spitzmüller"
141 \author -495245474 "Jean-Marc Lasgouttes"
143 \author 731793113 "Richard Kimberly Heck" rikiheck@lyx.org
144 \author 1075283030 "Thibaut"
150 Customizing \SpecialChar LyX
151 : Features for the Advanced User
155 by the \SpecialChar LyX
160 \begin_layout Plain Layout
162 If you have comments or error corrections, please send them to the \SpecialChar LyX
165 \begin_inset CommandInset href
167 target "lyx-docs@lists.lyx.org"
175 \begin_inset Quotes eld
179 \begin_inset Quotes erd
182 in the subject header, and please cc the current maintainer of this file,
183 Richard Heck <rgheck@comcast.net>.
189 \begin_inset Newline newline
193 \begin_inset Newline newline
199 \begin_layout Standard
200 \begin_inset CommandInset toc
201 LatexCommand tableofcontents
208 \begin_layout Standard
209 \begin_inset Note Note
212 \begin_layout Plain Layout
213 Please use change tracking when modifying this document.
214 This makes it easier for our translators to recognize things that have
215 been changed, and it helps the maintainer keep up-to-date with what's been
224 \begin_layout Chapter
228 \begin_layout Standard
229 This manual covers the customization features present in \SpecialChar LyX
231 In it, we discuss issues like keyboard shortcuts, screen previewing options,
232 printer options, sending commands to \SpecialChar LyX
233 via the \SpecialChar LyX
234 Server, internationalization,
235 installing new \SpecialChar LaTeX
236 classes and \SpecialChar LyX
238 We can't possibly hope to touch on everything you can change—our developers
239 add new features faster than we can document them—but we will explain the
240 most common customizations and hopefully point you in the right direction
241 for some of the more obscure ones.
244 \begin_layout Standard
245 \begin_inset Branch OutDated
249 \begin_layout Standard
250 Information from previous versions of this document that now seems to be
251 outdated is contained in the OutDated branch of this document.
252 By default, this information will not appear in the \SpecialChar LaTeX
261 \begin_layout Chapter
266 \begin_layout Standard
267 This chapter aims to help you to find your way through the \SpecialChar LyX
270 Before continuing to read this chapter, you should find out where your
272 library and user directories are by using
273 \begin_inset Flex Noun
276 \begin_layout Plain Layout
277 Help\SpecialChar menuseparator
288 The library directory is the place where \SpecialChar LyX
289 places its system-wide configuration
290 files; the user directory is where you can place your modified versions.
291 We will call the former
292 \begin_inset Flex Code
295 \begin_layout Plain Layout
302 \begin_inset Flex Noun
305 \begin_layout Plain Layout
311 in the remainder of this document.
315 \begin_layout Section
317 \begin_inset Flex Code
320 \begin_layout Plain Layout
329 \begin_layout Standard
330 \begin_inset Flex Code
333 \begin_layout Plain Layout
339 and its sub-directories contain a number of files and that can be used
340 to customize \SpecialChar LyX
342 You can change many of these files from within \SpecialChar LyX
344 \begin_inset Flex Noun
347 \begin_layout Plain Layout
348 Tools\SpecialChar menuseparator
355 Most customization that you will want to do in \SpecialChar LyX
356 is possible through this
358 However, many other inner aspects of \SpecialChar LyX
359 can be customized by modifying the
361 \begin_inset Flex Code
364 \begin_layout Plain Layout
371 These files fall in different categories, described in the following subsection
375 \begin_layout Subsection
376 Automatically generated files
379 \begin_layout Standard
380 The files, which are to be found in
381 \begin_inset Flex Noun
384 \begin_layout Plain Layout
390 , are generated when you configure \SpecialChar LyX
392 They contain various default values that are guessed by inspection.
393 In general, it is not a good idea to modify them, since they might be overwritt
397 \begin_layout Labeling
398 \labelwidthstring 00.00.0000
399 \begin_inset Flex Code
402 \begin_layout Plain Layout
408 contains defaults for various commands.
411 \begin_layout Labeling
412 \labelwidthstring 00.00.0000
413 \begin_inset Flex Code
416 \begin_layout Plain Layout
422 contains the list of packages that have been recognized by \SpecialChar LyX
424 It is currently unused by the \SpecialChar LyX
425 program itself, but the information extracted,
426 and more, is made available with
427 \begin_inset Flex Noun
430 \begin_layout Plain Layout
431 Help\SpecialChar menuseparator
445 \begin_layout Labeling
446 \labelwidthstring 00.00.0000
447 \begin_inset Flex Code
450 \begin_layout Plain Layout
456 the list of text classes that have been found in your
457 \begin_inset Flex Code
460 \begin_layout Plain Layout
466 directories, along with the associated \SpecialChar LaTeX
467 document class and their description.
470 \begin_layout Labeling
471 \labelwidthstring 00.00.0000
472 \begin_inset Flex Code
475 \begin_layout Plain Layout
481 the list of layout modules found in your
482 \begin_inset Flex Code
485 \begin_layout Plain Layout
494 \begin_layout Labeling
495 \labelwidthstring 00.00.0000
496 \begin_inset Flex Code
499 \begin_layout Plain Layout
505 lists of various sorts of \SpecialChar LaTeX
506 -related files found on your system
509 \begin_layout Labeling
510 \labelwidthstring 00.00.0000
511 \begin_inset Flex Code
514 \begin_layout Plain Layout
515 doc/\SpecialChar LaTeX
521 is automatically generated during configuration from the file
522 \begin_inset Flex Code
525 \begin_layout Plain Layout
533 It contains information on your \SpecialChar LaTeX
537 \begin_layout Subsection
541 \begin_layout Standard
542 These directories are duplicated between
543 \begin_inset Flex Code
546 \begin_layout Plain Layout
553 \begin_inset Flex Code
556 \begin_layout Plain Layout
563 If a particular files exists in both places, the one in
564 \begin_inset Flex Code
567 \begin_layout Plain Layout
576 \begin_layout Labeling
577 \labelwidthstring 00.00.0000
578 \begin_inset Flex Code
581 \begin_layout Plain Layout
587 this directory contains files with the extension
588 \begin_inset Flex Code
591 \begin_layout Plain Layout
597 that define the keybindings used in \SpecialChar LyX
599 If there exists an internationalized version of the bind file named
600 \begin_inset Flex Code
603 \begin_layout Plain Layout
609 , that will be used first.
612 \begin_layout Labeling
613 \labelwidthstring 00.00.0000
614 \begin_inset Flex Code
617 \begin_layout Plain Layout
623 contains files with the extension
624 \begin_inset Flex Code
627 \begin_layout Plain Layout
633 which define the diverse citation possibilities (natbib, biblatex etc.).
635 \begin_inset CommandInset ref
637 reference "subsec:Cite-Engine-Files"
647 \begin_layout Labeling
648 \labelwidthstring 00.00.0000
649 \begin_inset Flex Code
652 \begin_layout Plain Layout
658 contains graphics files that can be included in documents.
662 \begin_layout Labeling
663 \labelwidthstring 00.00.0000
664 \begin_inset Flex Code
667 \begin_layout Plain Layout
673 contains \SpecialChar LyX
674 documentation files (including the one you are currently reading).
676 \begin_inset Flex Code
679 \begin_layout Plain Layout
686 deserves special attention, as noted above.
687 The internationalized help docs are in subdirectories
688 \begin_inset Flex Code
691 \begin_layout Plain Layout
698 \begin_inset Quotes eld
702 \begin_inset Quotes erd
705 is the ISO language code.
707 \begin_inset CommandInset ref
709 reference "cha:Internationalizing-LyX"
716 \begin_layout Labeling
717 \labelwidthstring 00.00.0000
718 \begin_inset Flex Code
721 \begin_layout Plain Layout
727 contains example files that explain how to use some features.
728 In the file browser, press the
729 \begin_inset Flex Noun
732 \begin_layout Plain Layout
741 \begin_layout Labeling
742 \labelwidthstring 00.00.0000
743 \begin_inset Flex Code
746 \begin_layout Plain Layout
752 contains image files that are used by the
753 \begin_inset Flex Noun
756 \begin_layout Plain Layout
763 In addition, it also contains the individual icons used in the toolbar
764 and the banners that can be shown when \SpecialChar LyX
768 \begin_layout Labeling
769 \labelwidthstring 00.00.0000
770 \begin_inset Flex Code
773 \begin_layout Plain Layout
779 contains keyboard keymapping files.
781 \begin_inset CommandInset ref
783 reference "sec:International-Keymap-Stuff"
790 \begin_layout Labeling
791 \labelwidthstring 00.00.0000
792 \begin_inset Flex Code
795 \begin_layout Plain Layout
801 contains the text class and module files described in
802 \begin_inset CommandInset ref
804 reference "cha:Installing-New-Document"
811 \begin_layout Labeling
812 \labelwidthstring 00.00.0000
813 \begin_inset Flex Code
816 \begin_layout Plain Layout
823 \begin_inset Flex Code
826 \begin_layout Plain Layout
832 Python scripts used to convert between \SpecialChar LyX
834 These can be run from the command line if, say, you want to batch-convert
838 \begin_layout Labeling
839 \labelwidthstring 00.00.0000
840 \begin_inset Flex Code
843 \begin_layout Plain Layout
849 contains some files that demonstrate the capabilities of the
850 \begin_inset Flex Noun
853 \begin_layout Plain Layout
864 Also contains some scripts used by \SpecialChar LyX
868 \begin_layout Labeling
869 \labelwidthstring 00.00.0000
870 \begin_inset Flex Code
873 \begin_layout Plain Layout
879 contains the standard \SpecialChar LyX
880 template files described in
881 \begin_inset CommandInset ref
883 reference "subsec:Creating-Templates"
890 \begin_layout Labeling
891 \labelwidthstring 00.00.0000
892 \begin_inset Flex Code
895 \begin_layout Plain Layout
901 contains files with the extension
902 \begin_inset Flex Code
905 \begin_layout Plain Layout
911 that define the user interface to \SpecialChar LyX
913 That is, the files define which items appear in which menus and the items
914 appearing on the toolbar.
917 \begin_layout Labeling
918 \labelwidthstring 00.00.0000
919 \begin_inset Flex Code
922 \begin_layout Plain Layout
928 contains files with the extension
929 \begin_inset Flex Code
932 \begin_layout Plain Layout
938 which define the templates for the insertion of external material to a
941 \begin_inset CommandInset ref
943 reference "chap:Including-External-Material"
950 \begin_layout Subsection
951 Files you don't want to modify
954 \begin_layout Standard
955 These files are used internally by \SpecialChar LyX
956 and you generally do not need to modify
957 them unless you are a developer.
960 \begin_layout Labeling
961 \labelwidthstring 00.00.0000
962 \begin_inset Flex Code
965 \begin_layout Plain Layout
971 this file contains the list of \SpecialChar LyX
973 The contents are displayed with the menu entry
974 \begin_inset Flex Noun
977 \begin_layout Plain Layout
978 Help\SpecialChar menuseparator
991 \begin_layout Labeling
992 \labelwidthstring 00.00.0000
993 \begin_inset Flex Code
996 \begin_layout Plain Layout
1002 this is a \SpecialChar LaTeX
1003 script used during the configuration process.
1004 Do not run directly.
1007 \begin_layout Labeling
1008 \labelwidthstring 00.00.0000
1009 \begin_inset Flex Code
1012 \begin_layout Plain Layout
1018 this is a Python script that is used to re-configure \SpecialChar LyX
1020 It creates configuration files in the directory it was run from.
1023 \begin_layout Subsection
1024 Other files needing a line or two
1027 \begin_layout Labeling
1028 \labelwidthstring 00.00.0000
1029 \begin_inset Flex Code
1032 \begin_layout Plain Layout
1038 this contains tables describing how different character encodings can be
1042 \begin_layout Labeling
1043 \labelwidthstring 00.00.0000
1044 \begin_inset Flex Code
1047 \begin_layout Plain Layout
1053 this file contains a list of all the languages currently supported by \SpecialChar LyX
1057 \begin_layout Labeling
1058 \labelwidthstring 00.00.0000
1059 \begin_inset Flex Code
1062 \begin_layout Plain Layout
1068 contains information about the supported fonts.
1071 \begin_layout Labeling
1072 \labelwidthstring 00.00.0000
1073 \begin_inset Flex Code
1076 \begin_layout Plain Layout
1082 this file contains translations for internationalized paragraph styles
1084 \begin_inset CommandInset ref
1086 reference "subsec:I18n"
1093 \begin_layout Labeling
1094 \labelwidthstring 00.00.0000
1095 \begin_inset Flex Code
1098 \begin_layout Plain Layout
1104 this file contains information about Unicode-encoded glyphs and the way
1105 they are supported by \SpecialChar LyX
1106 via \SpecialChar LaTeX
1110 \begin_layout Section
1111 Your local configuration directory
1114 \begin_layout Standard
1115 Even if you are using \SpecialChar LyX
1116 as an unprivileged user, you might want to change
1118 configuration for your own use.
1120 \begin_inset Flex Code
1123 \begin_layout Plain Layout
1129 directory contains all your personal configuration files.
1130 This is the directory described as
1131 \begin_inset Quotes eld
1135 \begin_inset Quotes erd
1139 \begin_inset Flex Noun
1142 \begin_layout Plain Layout
1143 Help\SpecialChar menuseparator
1145 \begin_inset space ~
1154 This directory is used as a mirror of
1155 \begin_inset Flex Code
1158 \begin_layout Plain Layout
1164 , which means that every file in
1165 \begin_inset Flex Code
1168 \begin_layout Plain Layout
1174 is a replacement for the corresponding file in
1175 \begin_inset Flex Code
1178 \begin_layout Plain Layout
1185 Any configuration file described in the above sections can be placed either
1186 in the system-wide directory, in which case it will affect all users, or
1187 in your local directory for your own use.
1190 \begin_layout Standard
1191 To make things clearer, let's provide a few examples:
1194 \begin_layout Itemize
1195 The preferences set in the
1196 \begin_inset Flex Noun
1199 \begin_layout Plain Layout
1200 Tools\SpecialChar menuseparator
1206 dialog are saved to a file
1207 \begin_inset Flex Code
1210 \begin_layout Plain Layout
1217 \begin_inset Flex Code
1220 \begin_layout Plain Layout
1229 \begin_layout Itemize
1230 When you reconfigure using
1231 \begin_inset Flex Noun
1234 \begin_layout Plain Layout
1235 Tools\SpecialChar menuseparator
1243 \begin_inset Flex Code
1246 \begin_layout Plain Layout
1252 script, and the resulting files are written in your local configuration
1254 This means that any additional text class file that you might have added
1256 \begin_inset Flex Code
1259 \begin_layout Plain Layout
1265 will be added to the list of classes in the
1266 \begin_inset Flex Noun
1269 \begin_layout Plain Layout
1270 Document\SpecialChar menuseparator
1279 \begin_layout Itemize
1280 If you get some updated documentation from \SpecialChar LyX
1281 ftp site and cannot install
1282 it because you do not have sysadmin rights on your system, you can just
1284 \begin_inset Flex Code
1287 \begin_layout Plain Layout
1293 and the items in the
1294 \begin_inset Flex Noun
1297 \begin_layout Plain Layout
1303 menu will open them!
1306 \begin_layout Section
1307 Running \SpecialChar LyX
1308 with multiple configurations
1311 \begin_layout Standard
1312 The configuration freedom of the local configuration directory may not suffice
1313 if you want to have more than one configuration at your disposal.
1314 For example, you may want to be use different key bindings or printer settings
1316 You can achieve this by having several such directories.
1317 You then specify which directory to use at run-time.
1320 \begin_layout Standard
1321 Invoking \SpecialChar LyX
1322 with the command line switch
1323 \begin_inset Flex Code
1326 \begin_layout Plain Layout
1336 instructs the program to read the configuration from that directory, and
1337 not from the default directory.
1338 (You can determine the default directory by running \SpecialChar LyX
1340 \begin_inset Flex Code
1343 \begin_layout Plain Layout
1349 switch.) If the specified directory does not exist, \SpecialChar LyX
1351 for you, just like it does for the default directory on the first time
1352 you run the program.
1353 You can modify the configuration options in this additional user directory
1354 exactly as you would for the default directory.
1355 These directories are completely independent (but read on).
1356 Note that setting the environment variable
1357 \begin_inset Flex Code
1360 \begin_layout Plain Layout
1366 to some value has exactly the same effect.
1369 \begin_layout Standard
1370 Having several configurations also requires more maintenance: if you want
1371 to add a new layout to
1372 \begin_inset Flex Code
1375 \begin_layout Plain Layout
1381 which you want available from all your configurations, you must add it
1382 to each directory separately.
1383 You can avoid this with the following trick: after \SpecialChar LyX
1384 creates the additional
1385 directory, most of the subdirectories (see above) are empty.
1386 If you want the new configuration to mirror an existing one, replace the
1387 empty subdirectory with a symbolic link to the matching subdirectory in
1388 the existing configuration.
1390 \begin_inset Flex Code
1393 \begin_layout Plain Layout
1399 subdirectory, however, since it contains a file written by the configuration
1400 script (also accessible through
1401 \begin_inset Flex Noun
1404 \begin_layout Plain Layout
1405 Tools\SpecialChar menuseparator
1411 ) which is configuration-specific.
1414 \begin_layout Chapter
1415 The Preferences dialog
1418 \begin_layout Standard
1419 All options of the preferences dialog are described in the Appendix
1421 The Preferences Dialog
1428 For some options you might find here more details.
1431 \begin_layout Section
1433 \begin_inset CommandInset label
1442 \begin_layout Standard
1443 The first step is to define your file formats if they are not already defined.
1445 \begin_inset Flex Noun
1448 \begin_layout Plain Layout
1449 Tools\SpecialChar menuseparator
1457 \begin_inset Flex Noun
1460 \begin_layout Plain Layout
1461 File Handling\SpecialChar menuseparator
1468 \begin_inset Flex Noun
1471 \begin_layout Plain Layout
1477 button to define your new format.
1479 \begin_inset Flex Noun
1482 \begin_layout Plain Layout
1488 field contains the name used to identify the format in the GUI.
1490 \begin_inset Flex Noun
1493 \begin_layout Plain Layout
1499 is used to identify the format internally.
1500 You will also need to enter a file extension.
1501 These are all required.
1503 \begin_inset Flex Noun
1506 \begin_layout Plain Layout
1512 field is used to provide a keyboard shortcut on the menus.
1513 (For example, pressing
1514 \begin_inset Flex Noun
1517 \begin_layout Plain Layout
1524 \begin_inset Flex Noun
1527 \begin_layout Plain Layout
1528 Document\SpecialChar menuseparator
1529 View (Other Formats)\SpecialChar menuseparator
1538 \begin_layout Standard
1540 \begin_inset Flex Noun
1543 \begin_layout Plain Layout
1550 \begin_inset Flex Noun
1553 \begin_layout Plain Layout
1560 For example, you might want to use
1561 \begin_inset Flex Noun
1564 \begin_layout Plain Layout
1570 to view PostScript files.
1571 You can enter the command needed to start the program in the corresponding
1573 In defining this command, you can use the four variables listed in the
1575 The viewer is launched when you view an image in \SpecialChar LyX
1577 \begin_inset Flex Noun
1580 \begin_layout Plain Layout
1581 Document\SpecialChar menuseparator
1588 The editor is for example launched when you right-click on an image and
1590 \begin_inset Flex Noun
1593 \begin_layout Plain Layout
1599 in the appearing context menu.
1602 \begin_layout Standard
1604 \begin_inset Flex Noun
1607 \begin_layout Plain Layout
1613 type of a format is optional, but if it is specified, it must be unique
1615 It is used to detect files of this format from the file contents.
1616 For some important file formats there is no MIME type officially registered
1618 \begin_inset CommandInset href
1621 target "http://www.iana.org/assignments/media-types/"
1627 Therefore \SpecialChar LyX
1628 uses the extended list of MIME types as specified by
1629 \begin_inset CommandInset href
1631 name "freedesktop.org"
1632 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1640 \begin_layout Standard
1642 \begin_inset Flex Noun
1645 \begin_layout Plain Layout
1651 option tells \SpecialChar LyX
1652 that a format is suitable for document export.
1653 If this is set and if a suitable conversion route exists (see
1654 \begin_inset CommandInset ref
1656 reference "sec:Converters"
1660 ), the format will appear in the
1661 \begin_inset Flex Noun
1664 \begin_layout Plain Layout
1665 File\SpecialChar menuseparator
1672 The format will also appear in the
1673 \begin_inset Flex Noun
1676 \begin_layout Plain Layout
1677 Document\SpecialChar menuseparator
1683 menu if a viewer is specified for the format.
1684 Pure image formats, such as
1685 \begin_inset Flex Code
1688 \begin_layout Plain Layout
1694 , should not use this option.
1695 Formats that can both represent vector graphics and documents like
1696 \begin_inset Flex Code
1699 \begin_layout Plain Layout
1708 \begin_layout Standard
1710 \begin_inset Flex Noun
1713 \begin_layout Plain Layout
1714 Vector graphics format
1719 tells \SpecialChar LyX
1720 that a format can contain vector graphics.
1721 This information is used to determine the target format of included graphics
1723 \begin_inset Flex Noun
1726 \begin_layout Plain Layout
1733 Included graphics may need to be converted to either
1734 \begin_inset Flex Noun
1737 \begin_layout Plain Layout
1744 \begin_inset Flex Noun
1747 \begin_layout Plain Layout
1754 \begin_inset Flex Noun
1757 \begin_layout Plain Layout
1764 \begin_inset Flex Noun
1767 \begin_layout Plain Layout
1773 cannot handle other image formats.
1774 If an included graphic is not already in
1775 \begin_inset Flex Noun
1778 \begin_layout Plain Layout
1785 \begin_inset Flex Noun
1788 \begin_layout Plain Layout
1795 \begin_inset Flex Noun
1798 \begin_layout Plain Layout
1804 format, it is converted to
1805 \begin_inset Flex Noun
1808 \begin_layout Plain Layout
1814 if the vector format option is set, and otherwise to
1815 \begin_inset Flex Noun
1818 \begin_layout Plain Layout
1827 \begin_layout Section
1831 \begin_layout Standard
1832 Since all conversions from one format to another take place in \SpecialChar LyX
1834 directory, it is sometimes necessary to modify a file before copying it
1835 to the temporary directory in order that the conversion may be performed.
1839 \begin_layout Plain Layout
1840 For example, the file may refer to other files—images, for example—using
1841 relative file names, and these may become invalid when the file is copied
1842 to the temporary directory.
1847 This is done by a Copier: It copies a file to (or from) the temporary directory
1848 and may modify it in the process.
1851 \begin_layout Standard
1852 The definitions of the copiers may use eight variables:
1855 \begin_layout Labeling
1856 \labelwidthstring 00.00.0000
1857 \begin_inset Flex Code
1860 \begin_layout Plain Layout
1866 The \SpecialChar LyX
1867 system directory (e.
1868 \begin_inset space \thinspace{}
1872 \begin_inset space \space{}
1876 \begin_inset Flex Noun
1879 \begin_layout Plain Layout
1888 \begin_layout Labeling
1889 \labelwidthstring 00.00.0000
1890 \begin_inset Flex Code
1893 \begin_layout Plain Layout
1902 \begin_layout Labeling
1903 \labelwidthstring 00.00.0000
1904 \begin_inset Flex Code
1907 \begin_layout Plain Layout
1916 \begin_layout Labeling
1917 \labelwidthstring 00.00.0000
1918 \begin_inset Flex Code
1921 \begin_layout Plain Layout
1927 The base name (without filename extension) in the \SpecialChar LyX
1931 \begin_layout Labeling
1932 \labelwidthstring 00.00.0000
1933 \begin_inset Flex Code
1936 \begin_layout Plain Layout
1942 The full directory path of the \SpecialChar LyX
1946 \begin_layout Labeling
1947 \labelwidthstring 00.00.0000
1948 \begin_inset Flex Code
1951 \begin_layout Plain Layout
1957 The full pathname to the original \SpecialChar LyX
1958 file being processed
1961 \begin_layout Labeling
1962 \labelwidthstring 00.00.0000
1963 \begin_inset Flex Code
1966 \begin_layout Plain Layout
1972 The filename (without any directory path) of the \SpecialChar LyX
1976 \begin_layout Labeling
1977 \labelwidthstring 00.00.0000
1978 \begin_inset Flex Code
1981 \begin_layout Plain Layout
1987 The `\SpecialChar LaTeX
1991 \begin_layout Standard
1992 The latter should be the filename as it would be used in a \SpecialChar LaTeX
2000 It is relevant only when exporting files suitable for such inclusion.
2003 \begin_layout Standard
2004 Copiers can be used to do almost anything with output files.
2005 For example, suppose you want generated pdf files to be copied to a special
2007 \begin_inset Flex Code
2010 \begin_layout Plain Layout
2017 Then you could write a shell script such as this one:
2020 \begin_layout Standard
2021 \begin_inset listings
2025 \begin_layout Plain Layout
2030 \begin_layout Plain Layout
2035 \begin_layout Plain Layout
2037 TOFILE=`basename $2`
2040 \begin_layout Plain Layout
2042 cp $FROMFILE /home/you/pdf/$TOFILE
2047 Save it in your local \SpecialChar LyX
2049 \begin_inset Flex Code
2052 \begin_layout Plain Layout
2053 /home/you/.lyx/scripts/pdfcopier.sh
2058 —and make it executable, if you need to do so on your platform.
2060 \begin_inset Flex Noun
2063 \begin_layout Plain Layout
2064 Tools\SpecialChar menuseparator
2070 dialog, select under
2071 \begin_inset Flex Noun
2074 \begin_layout Plain Layout
2075 File Handling\SpecialChar menuseparator
2082 \begin_inset Flex Noun
2085 \begin_layout Plain Layout
2091 format—or one of the other pdf formats—and enter
2092 \begin_inset Flex Code
2095 \begin_layout Plain Layout
2096 pdfcopier.sh $$i $$o
2102 \begin_inset Flex Noun
2105 \begin_layout Plain Layout
2115 \begin_layout Standard
2116 Copiers are used by \SpecialChar LyX
2117 in various of its own conversions.
2118 For example, if appropriate programs are found, \SpecialChar LyX
2119 will automatically install
2121 \begin_inset Flex Noun
2124 \begin_layout Plain Layout
2131 \begin_inset Flex Noun
2134 \begin_layout Plain Layout
2136 \begin_inset space ~
2145 When these formats are exported, the copier sees that not just the main
2146 HTML file but various associated files (style files, images, etc.) are also
2148 All these files are written to a subdirectory of the directory in which
2149 the original \SpecialChar LyX
2154 \begin_layout Plain Layout
2155 This copier can be customized.
2157 \begin_inset Quotes eld
2161 \begin_inset Quotes erd
2164 argument takes a comma-separated list of extensions to be copied; if it
2165 is omitted, all files will be copied.
2167 \begin_inset Quotes eld
2171 \begin_inset Quotes erd
2174 argument determines the extension added to the generated directory.
2176 \begin_inset Quotes eld
2180 \begin_inset Flex Noun
2183 \begin_layout Plain Layout
2190 \begin_inset Quotes erd
2193 , so HTML generated from
2194 \begin_inset Flex Noun
2197 \begin_layout Plain Layout
2198 /path/to/filename.lyx
2204 \begin_inset Flex Noun
2207 \begin_layout Plain Layout
2208 /path/to/filename.html.LyXconv
2222 \begin_layout Section
2224 \begin_inset CommandInset label
2226 name "sec:Converters"
2233 \begin_layout Standard
2234 You can define your own Converters to convert files between different formats.
2236 \begin_inset Flex Noun
2239 \begin_layout Plain Layout
2240 Tools\SpecialChar menuseparator
2241 Preferences\SpecialChar menuseparator
2242 File Handling\SpecialChar menuseparator
2251 \begin_layout Standard
2252 To define a new converter, select the
2253 \begin_inset Flex Noun
2256 \begin_layout Plain Layout
2258 \begin_inset space ~
2267 \begin_inset Flex Noun
2270 \begin_layout Plain Layout
2272 \begin_inset space ~
2280 from the drop-down lists, enter the command needed for the conversion,
2282 \begin_inset Flex Noun
2285 \begin_layout Plain Layout
2292 Several variables can be used in the definition of converters:
2295 \begin_layout Labeling
2296 \labelwidthstring 00.00.0000
2297 \begin_inset Flex Code
2300 \begin_layout Plain Layout
2306 The \SpecialChar LyX
2310 \begin_layout Labeling
2311 \labelwidthstring 00.00.0000
2312 \begin_inset Flex Code
2315 \begin_layout Plain Layout
2324 \begin_layout Labeling
2325 \labelwidthstring 00.00.0000
2326 \begin_inset Flex Code
2329 \begin_layout Plain Layout
2338 \begin_layout Labeling
2339 \labelwidthstring 00.00.0000
2340 \begin_inset Flex Code
2343 \begin_layout Plain Layout
2349 The base filename of the input file (i.
2350 \begin_inset space \thinspace{}
2353 g., without the extension)
2356 \begin_layout Labeling
2357 \labelwidthstring 00.00.0000
2358 \begin_inset Flex Code
2361 \begin_layout Plain Layout
2367 The path to the input file
2370 \begin_layout Labeling
2371 \labelwidthstring 00.00.0000
2372 \begin_inset Flex Code
2375 \begin_layout Plain Layout
2381 The path to the original input file (this is different from $$p when a
2382 chain of converters is called)
2385 \begin_layout Labeling
2386 \labelwidthstring 00.00.0000
2387 \begin_inset Flex Code
2390 \begin_layout Plain Layout
2396 The iconv name for the encoding of the document.
2399 \begin_layout Standard
2401 \begin_inset Flex Noun
2404 \begin_layout Plain Layout
2406 \begin_inset space ~
2414 field you can enter the following flags, separated by commas:
2417 \begin_layout Labeling
2418 \labelwidthstring 00.00.0000
2419 \begin_inset Flex Code
2422 \begin_layout Plain Layout
2424 \change_inserted -712698321 1524656940
2432 This converter runs some form of \SpecialChar LaTeX
2434 This will make \SpecialChar LyX
2435 's \SpecialChar LaTeX
2436 error logs available.
2438 \change_inserted -712698321 1524657018
2440 \begin_inset Flex Code
2443 \begin_layout Plain Layout
2445 \change_inserted -712698321 1524657012
2453 value specifies the form of \SpecialChar LaTeX
2455 \begin_inset Flex Code
2458 \begin_layout Plain Layout
2460 \change_inserted -712698321 1524657005
2461 latex, pdflatex, platex, xetex, luatex
2469 If no value is specified,
2470 \begin_inset Flex Code
2473 \begin_layout Plain Layout
2475 \change_inserted -712698321 1524657018
2488 \begin_layout Labeling
2489 \labelwidthstring 00.00.0000
2490 \begin_inset Flex Code
2493 \begin_layout Plain Layout
2495 \change_inserted -712698321 1524656935
2503 Needs the \SpecialChar LaTeX
2505 \begin_inset Flex Noun
2508 \begin_layout Plain Layout
2514 file for the conversion.
2516 \change_inserted -712698321 1524657047
2518 \begin_inset Flex Code
2521 \begin_layout Plain Layout
2523 \change_inserted -712698321 1524657030
2531 value specifies the form of \SpecialChar LaTeX
2532 that is run in order to generate the
2533 \begin_inset Flex Noun
2536 \begin_layout Plain Layout
2538 \change_inserted -712698321 1524657047
2547 \begin_inset Flex Code
2550 \begin_layout Plain Layout
2552 \change_inserted -712698321 1524657030
2553 latex, pdflatex, platex, xetex, luatex
2561 If no value is specified,
2562 \begin_inset Flex Code
2565 \begin_layout Plain Layout
2567 \change_inserted -712698321 1524657030
2580 \begin_layout Labeling
2581 \labelwidthstring 00.00.0000
2582 \begin_inset Flex Code
2585 \begin_layout Plain Layout
2592 \begin_inset Quotes eld
2596 \begin_inset Quotes erd
2599 file from the backend, which in practice means a \SpecialChar LaTeX
2600 file like the one we
2601 would export, without
2602 \begin_inset Flex Code
2605 \begin_layout Plain Layout
2614 \begin_layout Labeling
2615 \labelwidthstring 00.00.0000
2616 \begin_inset Flex Code
2619 \begin_layout Plain Layout
2628 \begin_layout Standard
2629 The following three flags are not really flags at all because they take
2631 \begin_inset Flex Noun
2634 \begin_layout Plain Layout
2636 \begin_inset space ~
2640 \begin_inset space ~
2651 \begin_layout Labeling
2652 \labelwidthstring 00.00.0000
2654 \change_inserted -712698321 1523206314
2655 \begin_inset Flex Code
2658 \begin_layout Plain Layout
2660 \change_inserted -712698321 1523206193
2668 The name of the driver that needs to be loaded with the
2672 package for this converter.
2673 The loading of the correct driver is necessary to get some PDF-specific
2682 \begin_layout Labeling
2683 \labelwidthstring 00.00.0000
2684 \begin_inset Flex Code
2687 \begin_layout Plain Layout
2693 If set, the converter's standard error will be redirected to a file
2694 \begin_inset Flex Code
2697 \begin_layout Plain Layout
2703 , and the script given as argument will be run as:
2704 \begin_inset Flex Code
2707 \begin_layout Plain Layout
2708 script < infile.out > infile.log
2714 The argument may contain
2715 \begin_inset Flex Code
2718 \begin_layout Plain Layout
2727 \begin_layout Labeling
2728 \labelwidthstring 00.00.0000
2729 \begin_inset Flex Code
2732 \begin_layout Plain Layout
2738 The name of the directory in which the converter will dump the generated
2741 will not create this directory, and it does not copy anything into it,
2742 though it will copy this directory to the destination.
2743 The argument may contain
2744 \begin_inset Flex Code
2747 \begin_layout Plain Layout
2753 , which will be replaced by the base name of the input and output files,
2754 respectively, when the directory is copied.
2755 \begin_inset Newline newline
2758 Note that resultdir and usetempdir make no sense together.
2759 The latter will be ignored if the former is given.
2762 \begin_layout Labeling
2763 \labelwidthstring 00.00.0000
2764 \begin_inset Flex Code
2767 \begin_layout Plain Layout
2773 Determines the output file name and may, contain
2774 \begin_inset Flex Code
2777 \begin_layout Plain Layout
2784 Sensible only with resultdir and optional even then; if not given, it defaults
2788 \begin_layout Standard
2790 \change_inserted -712698321 1523206384
2791 A suitable hyperref-driver is set for some converters that are installed
2792 with \SpecialChar LyX
2795 \change_deleted -712698321 1523206388
2797 \change_inserted -712698321 1523206389
2801 \change_inserted -712698321 1523206400
2805 \change_inserted -712698321 1523206407
2809 \change_inserted -712698321 1523206437
2813 \change_deleted -712698321 1523206442
2814 that are installed with \SpecialChar LyX
2821 \begin_layout Standard
2822 You do not have to define converters for all formats between which you want
2824 For example, you will note that there is no `\SpecialChar LyX
2825 to PostScript' converter,
2826 but \SpecialChar LyX
2827 will export PostScript.
2828 It does so by first creating a \SpecialChar LaTeX
2829 file (no converter needs to be defined
2830 for this) which is then converted to DVI using the `\SpecialChar LaTeX
2832 and finally converting the resulting DVI file to PostScript.
2834 finds such `chains' of converters automatically, and it will always choose
2835 the shortest possible chain.
2836 You can, though, still define multiple conversion methods between file
2838 For example, the standard \SpecialChar LyX
2839 configuration provides five ways to convert
2844 \begin_layout Enumerate
2846 \begin_inset Flex Noun
2849 \begin_layout Plain Layout
2858 \begin_layout Enumerate
2859 via (DVI and) PostScript, using
2860 \begin_inset Flex Noun
2863 \begin_layout Plain Layout
2872 \begin_layout Enumerate
2874 \begin_inset Flex Noun
2877 \begin_layout Plain Layout
2886 \begin_layout Enumerate
2888 \begin_inset Flex Noun
2891 \begin_layout Plain Layout
2901 \begin_layout Enumerate
2903 \begin_inset Flex Noun
2906 \begin_layout Plain Layout
2916 \begin_layout Standard
2917 To define such alternate chains, you must define multiple target `file formats',
2919 \begin_inset CommandInset ref
2921 reference "sec:Formats"
2926 For example, in the standard configuration, the formats named
2927 \begin_inset Flex Noun
2930 \begin_layout Plain Layout
2937 \begin_inset Flex Noun
2940 \begin_layout Plain Layout
2947 \begin_inset Flex Noun
2950 \begin_layout Plain Layout
2957 \begin_inset Flex Noun
2960 \begin_layout Plain Layout
2967 \begin_inset Flex Noun
2970 \begin_layout Plain Layout
2977 \begin_inset Flex Noun
2980 \begin_layout Plain Layout
2987 \begin_inset Flex Noun
2990 \begin_layout Plain Layout
2997 \begin_inset Flex Noun
3000 \begin_layout Plain Layout
3008 \begin_inset Flex Noun
3011 \begin_layout Plain Layout
3018 \begin_inset Flex Noun
3021 \begin_layout Plain Layout
3028 ) are defined, all of which share the extension
3029 \begin_inset Flex Noun
3032 \begin_layout Plain Layout
3038 , and which correspond to the conversion methods just mentioned.
3041 \begin_layout Chapter
3042 Internationalizing \SpecialChar LyX
3044 \begin_inset CommandInset label
3046 name "cha:Internationalizing-LyX"
3053 \begin_layout Standard
3055 supports using a translated interface.
3056 Last time we checked, \SpecialChar LyX
3057 provided text in thirty languages.
3058 The language of choice is called your
3063 (For further reading on locale settings, see also the documentation for
3064 locale that comes with your operating system.
3065 For Linux, the manual page for
3066 \begin_inset Flex Code
3069 \begin_layout Plain Layout
3075 could be a good place to start).
3078 \begin_layout Standard
3079 Notice that these translations will work, but do contain a few flaws.
3080 In particular, all dialogs have been designed with the English text in
3081 mind, which means that some of the translated text will be too large to
3082 fit within the space allocated.
3083 This is only a display problem and will not cause any harm.
3084 Also, you will find that some of the translations do not define shortcut
3085 keys for everything.
3086 Sometimes, there are simply not enough free letters to do it.
3087 Other times, the translator just hasn't got around to doing it yet.
3088 Our localization team, which you may wish to join,
3092 \begin_layout Plain Layout
3093 If you are a fluent speaker of a language other than English, joining these
3094 teams is a great way to give back to the \SpecialChar LyX
3100 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
3104 \begin_layout Section
3105 Translating \SpecialChar LyX
3109 \begin_layout Subsection
3110 Translating the graphical user interface (text messages).
3113 \begin_layout Standard
3116 \begin_inset Flex Code
3119 \begin_layout Plain Layout
3125 library to handle the internationalization of the interface.
3126 To have \SpecialChar LyX
3127 speak your favorite language in all menus and dialogs, you need
3129 \begin_inset Flex Code
3132 \begin_layout Plain Layout
3138 -file for that language.
3139 When this is available, you'll have to generate a
3140 \begin_inset Flex Code
3143 \begin_layout Plain Layout
3149 -file from it and install the
3150 \begin_inset Flex Code
3153 \begin_layout Plain Layout
3160 The process of doing all of this is explained in the documentation for
3162 \begin_inset Flex Code
3165 \begin_layout Plain Layout
3172 It is possible to do this just for yourself, but if you're going to do
3173 it, you might as well share the results of your labors with the rest of
3174 the \SpecialChar LyX
3176 Send a message to the \SpecialChar LyX
3177 developers' list for more information about how
3181 \begin_layout Standard
3182 In short, this is what you should do (xx denotes the language code):
3185 \begin_layout Itemize
3186 Check out the \SpecialChar LyX
3189 \begin_inset CommandInset href
3191 name "information on the web"
3192 target "https://www.lyx.org/HowToUseGIT"
3200 \begin_layout Itemize
3202 \begin_inset Flex Code
3205 \begin_layout Plain Layout
3211 to the folder of the
3212 \begin_inset Flex Code
3215 \begin_layout Plain Layout
3223 \begin_inset Flex Code
3226 \begin_layout Plain Layout
3234 \begin_inset Flex Code
3237 \begin_layout Plain Layout
3243 doesn't exist anywhere, it can be remade with the console command
3244 \begin_inset Flex Code
3247 \begin_layout Plain Layout
3253 in that directory, or you can use an existing po-file for some other language
3257 \begin_layout Itemize
3259 \begin_inset Flex Code
3262 \begin_layout Plain Layout
3272 \begin_layout Plain Layout
3273 This is just a text file, so it can be edited in any text editor.
3274 But there are also specialized programs that support such editing, such
3279 (for all platforms) or
3288 contains a `mode' for editing
3289 \begin_inset Flex Code
3292 \begin_layout Plain Layout
3299 \begin_inset Flex URL
3302 \begin_layout Plain Layout
3304 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html#PO-Mode
3314 For some menu- and widget-labels, there are also shortcut keys that should
3316 Those keys are marked after a `|', and should be translated according to
3317 the words and phrases of the language.
3318 You should also fill also out the information at the beginning of the new
3320 \begin_inset Flex Code
3323 \begin_layout Plain Layout
3329 -file with your email-address, etc., so people know where to reach you with
3330 suggestions and entertaining flames.
3333 \begin_layout Standard
3334 If you are just doing this on your own, then:
3337 \begin_layout Itemize
3339 \begin_inset Flex Code
3342 \begin_layout Plain Layout
3349 This can be done with
3350 \begin_inset Flex Code
3353 \begin_layout Plain Layout
3354 msgfmt -o xx.mo < xx.po
3362 \begin_layout Itemize
3364 \begin_inset Flex Code
3367 \begin_layout Plain Layout
3373 -file to your locale-tree, at the correct directory for application messages
3378 xx, and under the name
3379 \begin_inset Flex Code
3382 \begin_layout Plain Layout
3389 \begin_inset space \thinspace{}
3393 \begin_inset space \space{}
3397 \begin_inset Flex Code
3400 \begin_layout Plain Layout
3401 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3411 \begin_layout Standard
3412 As said, however, it would be best if the new
3413 \begin_inset Flex Code
3416 \begin_layout Plain Layout
3422 file could be added to the \SpecialChar LyX
3423 distribution, so others can use it.
3424 Adding it involves making additional changes to \SpecialChar LyX
3426 So send an email to the developers' mailing list if you're interested in
3430 \begin_layout Subsubsection
3434 \begin_layout Standard
3435 Sometimes it turns out that one English message needs to be translated into
3436 different messages in the target language.
3437 One example is the message
3438 \begin_inset Flex Code
3441 \begin_layout Plain Layout
3447 which has the German translation
3455 , depending upon exactly what the English
3456 \begin_inset Quotes eld
3460 \begin_inset Quotes erd
3465 \begin_inset Flex Code
3468 \begin_layout Plain Layout
3474 does not handle such ambiguous translations.
3475 Therefore you have to add some context information to the message: Instead
3477 \begin_inset Flex Code
3480 \begin_layout Plain Layout
3487 \begin_inset Flex Code
3490 \begin_layout Plain Layout
3491 To[[as in 'From format x to format y']]
3497 \begin_inset Flex Code
3500 \begin_layout Plain Layout
3501 To[[as in 'From page x to page y']].
3506 Now the two occurrences of
3507 \begin_inset Flex Code
3510 \begin_layout Plain Layout
3517 \begin_inset Flex Code
3520 \begin_layout Plain Layout
3526 and can be translated correctly to
3537 \begin_layout Standard
3538 Of course the context information needs to be stripped off the original
3539 message when no translation is used.
3540 Therefore you have to put it in double square brackets at the end of the
3541 message (see the example above).
3542 The translation mechanism of \SpecialChar LyX
3543 ensures that everything in double square
3544 brackets at the end of messages is removed before displaying the message.
3547 \begin_layout Subsection
3548 Translating the documentation.
3551 \begin_layout Standard
3552 The online documentation (in the
3553 \begin_inset Flex Noun
3556 \begin_layout Plain Layout
3562 -menu) can (and should!) be translated.
3563 If there are translated versions of the documentation available
3567 \begin_layout Plain Layout
3568 As of March 2008, at least some of the documents have been translated into
3569 fourteen languages, with the Tutorial available in a few more.
3574 and the locale is set accordingly, these will be used automagically by
3578 looks for translated versions as
3579 \begin_inset Flex Code
3582 \begin_layout Plain Layout
3583 LyXDir/doc/xx/DocName.lyx
3589 \begin_inset Flex Code
3592 \begin_layout Plain Layout
3598 is the code for the language currently in use.
3599 If there are no translated documents, the default English versions will
3601 Note that the translated versions must have the same filenames (
3602 \begin_inset Flex Code
3605 \begin_layout Plain Layout
3611 above) as the original.
3612 If you feel up to translating the documentation (an excellent way to proof-read
3613 the original documentation by the way!), there are a few things you should
3617 \begin_layout Itemize
3618 Check out the documentation translation web page at
3619 \begin_inset CommandInset href
3621 name "https://www.lyx.org/Translation"
3622 target "https://www.lyx.org/Translation"
3628 That way, you can find out which (if any) documents have already been translate
3629 d into your language.
3630 You can also find out who (if anyone) is organizing the effort to translate
3631 the documentation into your language.
3632 If no one is organizing the effort, please let us know that you're interested.
3635 \begin_layout Standard
3636 Once you get to actually translating, here's a few hints for you that may
3640 \begin_layout Itemize
3641 Join the documentation team! There is information on how to do that in
3642 \begin_inset Flex Code
3645 \begin_layout Plain Layout
3652 \begin_inset Flex Noun
3655 \begin_layout Plain Layout
3656 Help\SpecialChar menuseparator
3662 ), which by the way is the first document you should translate.
3665 \begin_layout Itemize
3666 Learn the typographic conventions for the language you are translating to.
3667 Typography is an ancient art and over the centuries, a great variety of
3668 conventions have developed throughout different parts of the world.
3669 Also study the professional terminology amongst typographers in your country.
3670 Inventing your own terminology will only confuse the users.
3673 (Warning! Typography is addictive!)
3676 \begin_layout Itemize
3677 Make a copy of the document.
3678 This will be your working copy.
3679 You can use this as your personal translated help-file by placing it in
3681 \begin_inset Flex Code
3684 \begin_layout Plain Layout
3691 \begin_inset Note Greyedout
3694 \begin_layout Plain Layout
3699 For a complex document with external material (images, etc.), if you make
3701 \begin_inset space \thinspace{}
3705 \begin_inset space \space{}
3708 in a temp dir, beware that the links to external material may be broken
3709 when the document is moved to a different place.
3710 The best way is to retrieve the \SpecialChar LyX
3712 \begin_inset Flex URL
3715 \begin_layout Plain Layout
3717 https://www.lyx.org/HowToUseGIT
3722 ) and to edit the doc file in place.
3730 \begin_layout Itemize
3731 Sometimes the original document (from the \SpecialChar LyX
3732 team) will be updated.
3733 Use the source viewer at
3734 \begin_inset CommandInset href
3736 name "https://www.lyx.org/trac/timeline"
3737 target "https://www.lyx.org/trac/timeline"
3742 to see what has been changed.
3743 That way you can easily see which parts of the translated document need
3747 \begin_layout Standard
3748 If you ever find an error in the original document, fix it and notify the
3749 rest of the documentation team of the changes! (You didn't forget to join
3750 the documentation team, did you?)
3753 \begin_layout Standard
3754 \begin_inset Branch OutDated
3758 \begin_layout Section
3759 International Keyboard Support
3762 \begin_layout Standard
3765 [Editor's Note: The following section is by
3773 It needs to be fixed to conform to the new Documentation Style sheet and
3774 to make use of the new v1.0 features.
3775 The whole thing also needs to be merged with the section following it.-jw
3776 It may also be badly out of date.-rh (2008)]
3779 \begin_layout Subsection
3780 Defining Own Keymaps: Keymap File Format
3783 \begin_layout Standard
3784 Let's look at a keyboard definition file a little closer.
3785 It is a plain text file defining
3788 \begin_layout Itemize
3789 key-to-key or key-to-string translations
3792 \begin_layout Itemize
3796 \begin_layout Itemize
3797 dead keys exceptions
3800 \begin_layout Standard
3801 To define key-to-key or key-to-string translation, use this command:
3804 \begin_layout Quotation
3805 \begin_inset Flex Code
3808 \begin_layout Plain Layout
3817 \begin_inset Flex Code
3820 \begin_layout Plain Layout
3829 \begin_layout Standard
3831 \begin_inset Flex Code
3834 \begin_layout Plain Layout
3840 is the key to be translated and
3841 \begin_inset Flex Code
3844 \begin_layout Plain Layout
3850 is the string to be inserted into the document.
3851 To define dead keys, use:
3854 \begin_layout Quotation
3855 \begin_inset Flex Code
3858 \begin_layout Plain Layout
3867 \begin_inset Flex Code
3870 \begin_layout Plain Layout
3879 \begin_layout Standard
3881 \begin_inset Flex Code
3884 \begin_layout Plain Layout
3890 is a keyboard key and
3891 \begin_inset Flex Code
3894 \begin_layout Plain Layout
3901 The following dead keys are supported (shortcut name is in parentheses):
3904 \begin_layout Quotation
3908 \begin_inset space \hfill{}
3914 \begin_layout Quotation
3916 \begin_inset space \hfill{}
3922 \begin_layout Quotation
3924 \begin_inset space \hfill{}
3930 \begin_layout Quotation
3932 \begin_inset space \hfill{}
3938 \begin_layout Quotation
3940 \begin_inset space \hfill{}
3946 \begin_layout Quotation
3948 \begin_inset space \hfill{}
3955 \begin_layout Plain Layout
3967 \begin_layout Quotation
3969 \begin_inset space \hfill{}
3975 \begin_layout Quotation
3977 \begin_inset space \hfill{}
3984 \begin_layout Plain Layout
3996 \begin_layout Quotation
3998 \begin_inset space \hfill{}
4004 \begin_layout Quotation
4006 \begin_inset space \hfill{}
4012 \begin_layout Quotation
4014 \begin_inset space \hfill{}
4021 \begin_layout Plain Layout
4033 \begin_layout Quotation
4035 \begin_inset space \hfill{}
4042 \begin_layout Plain Layout
4054 \begin_layout Quotation
4056 \begin_inset space \hfill{}
4062 \begin_layout Quotation
4063 hungarian umlaut (hug)
4064 \begin_inset space \hfill{}
4070 \begin_layout Quotation
4072 \begin_inset space \hfill{}
4078 \begin_layout Quotation
4080 \begin_inset space \hfill{}
4087 \begin_layout Plain Layout
4099 \begin_layout Standard
4100 Since in many international keyboards there are exceptions to what some
4101 dead keys should do, you can define them using
4104 \begin_layout Quotation
4105 \begin_inset Flex Code
4108 \begin_layout Plain Layout
4116 deadkey key outstring
4119 \begin_layout Standard
4120 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
4124 \begin_layout Quotation
4125 \begin_inset Flex Code
4128 \begin_layout Plain Layout
4141 \begin_layout Standard
4142 to make it work correctly.
4143 Also, you have to define as exceptions dead keys over i and j, to remove
4144 the dot from them before inserting an accent mark.
4145 I will change this when the time comes, but so far I haven't had time.
4148 \begin_layout Standard
4149 Oh, and about characters: backslash is escaped, so to enter it, you'll need
4152 \begin_inset Flex Code
4155 \begin_layout Plain Layout
4161 have different meaning.
4163 \begin_inset Flex Code
4166 \begin_layout Plain Layout
4172 marks comments, quotes start and end \SpecialChar LaTeX
4174 To enter quote, you'll need to use
4175 \begin_inset Flex Code
4178 \begin_layout Plain Layout
4187 \begin_inset Flex Code
4190 \begin_layout Plain Layout
4197 \begin_inset Flex Code
4200 \begin_layout Plain Layout
4211 \begin_layout Standard
4212 If you make a keyboard description file that works for your language, please
4213 mail it to me, so I can include it in the next keymap distribution.
4216 \begin_layout Standard
4217 More keywords will be supported in keymap configuration file in future,
4221 \begin_layout Itemize
4222 \begin_inset Flex Code
4225 \begin_layout Plain Layout
4236 \begin_inset space \hfill{}
4240 \begin_inset Flex Code
4243 \begin_layout Plain Layout
4252 \begin_layout Itemize
4253 \begin_inset Flex Code
4256 \begin_layout Plain Layout
4267 \begin_inset space \hfill{}
4271 \begin_inset Flex Code
4274 \begin_layout Plain Layout
4280 an external keymap translation program
4283 \begin_layout Standard
4284 Also, it should look into
4285 \begin_inset Flex Code
4288 \begin_layout Plain Layout
4294 file for defaults, too (for example, a
4295 \begin_inset Flex Code
4298 \begin_layout Plain Layout
4306 option to include default keyboard).
4314 \begin_layout Section
4315 International Keymap Stuff
4316 \begin_inset CommandInset label
4318 name "sec:International-Keymap-Stuff"
4325 \begin_layout Standard
4326 \begin_inset Note Note
4329 \begin_layout Plain Layout
4330 In doing the revisions on this document in March 2008, I did not look over
4331 this stuff, as I do not understand it.
4332 It would be good if someone else could do so.
4341 \begin_layout Standard
4342 The next two sections describe the
4343 \begin_inset Flex Code
4346 \begin_layout Plain Layout
4355 \begin_inset Flex Code
4358 \begin_layout Plain Layout
4366 file syntax in detail.
4367 These sections should help you design your own key map if the ones provided
4368 do not meet your needs.
4371 \begin_layout Subsection
4375 \begin_layout Standard
4379 \begin_inset Flex Code
4382 \begin_layout Plain Layout
4388 file maps keystrokes to characters or strings.
4389 As the name suggests, it sets a keyboard mapping.
4391 \begin_inset Flex Code
4394 \begin_layout Plain Layout
4405 \begin_inset Flex Code
4408 \begin_layout Plain Layout
4423 \begin_inset Flex Code
4426 \begin_layout Plain Layout
4439 \begin_inset Flex Code
4442 \begin_layout Plain Layout
4451 \begin_inset Flex Code
4454 \begin_layout Plain Layout
4462 are described in this section.
4465 \begin_layout Labeling
4466 \labelwidthstring 00.00.0000
4467 \begin_inset Flex Code
4470 \begin_layout Plain Layout
4478 Map a character to a string
4481 \begin_layout LyX-Code
4496 \begin_layout Standard
4529 the double-quote (")
4546 must be escaped with a preceding backslash (
4557 \begin_layout Standard
4559 \begin_inset Flex Noun
4562 \begin_layout Plain Layout
4570 statement to cause the symbol
4571 \begin_inset Flex Noun
4574 \begin_layout Plain Layout
4582 to be output for the keystroke
4583 \begin_inset Flex Noun
4586 \begin_layout Plain Layout
4597 \begin_layout LyX-Code
4603 \begin_layout Labeling
4604 \labelwidthstring 00.00.0000
4605 \begin_inset Flex Code
4608 \begin_layout Plain Layout
4616 Specify an accent character
4619 \begin_layout LyX-Code
4628 \begin_layout Standard
4629 This will make the cha
4667 This is the dead key
4671 \begin_layout Plain Layout
4678 refers to a key that does not produce a character by itself, but when followed
4679 with another key, produces the desired accent character.
4680 For example, a German characte
4682 r with an umlaut like
4692 can be produced in this manner.
4701 \begin_layout Standard
4714 and then another key not in
4731 followed by the other, not allowed key, as output.
4735 \begin_inset Flex Noun
4738 \begin_layout Plain Layout
4746 cancels a dead key, so if
4757 \begin_inset Flex Noun
4760 \begin_layout Plain Layout
4769 , the cursor will not go one position backwards but will instead cancel
4785 might have had on the next keystroke.
4789 \begin_layout Standard
4790 The following example specifies that the character ' is to be an acute accent,
4791 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4794 \begin_layout LyX-Code
4797 kmod ' acute aeiouAEIOU
4800 \begin_layout Labeling
4801 \labelwidthstring 00.00.0000
4802 \begin_inset Flex Code
4805 \begin_layout Plain Layout
4811 Specify an exception to the accent character
4814 \begin_layout LyX-Code
4823 \begin_layout Standard
4824 This defines an exce
4865 have been assigned a keystroke with a previous
4868 \begin_inset Flex Code
4871 \begin_layout Plain Layout
4895 must not belong in the
4942 If such a declaration does not exist in
4950 \begin_inset Flex Code
4953 \begin_layout Plain Layout
4987 \begin_inset Flex Code
4990 \begin_layout Plain Layout
5004 \begin_layout Standard
5005 The following command produces causes äi to be produced when you enter acute-i
5009 \begin_layout LyX-Code
5023 \begin_layout Labeling
5024 \labelwidthstring 00.00.0000
5025 \begin_inset Flex Code
5028 \begin_layout Plain Layout
5034 Combine two accent characters
5037 \begin_layout LyX-Code
5043 accent1 accent2 allowed
5046 \begin_layout Standard
5047 This one is getting pretty esoteric.
5048 It allows you to combine the effect
5104 \begin_inset Flex Code
5107 \begin_layout Plain Layout
5135 \begin_layout Standard
5136 Consider this example from the
5137 \begin_inset Flex Code
5140 \begin_layout Plain Layout
5151 \begin_layout LyX-Code
5154 kmod ; acute aeioyvhAEIOYVH
5158 kcomb acute umlaut iyIY
5161 \begin_layout Standard
5162 This allows you to press
5163 \begin_inset Flex Noun
5166 \begin_layout Plain Layout
5174 and get the effect of
5175 \begin_inset Flex Code
5178 \begin_layout Plain Layout
5197 in this case cancels the last dead key, so if you press
5198 \begin_inset Flex Noun
5201 \begin_layout Plain Layout
5210 \begin_inset Flex Code
5213 \begin_layout Plain Layout
5226 \begin_layout Subsection
5230 \begin_layout Standard
5232 \begin_inset Flex Code
5235 \begin_layout Plain Layout
5243 mapping is performed, a
5244 \begin_inset Flex Code
5247 \begin_layout Plain Layout
5257 file maps the strings that the symbols generate to characters in the current
5259 The \SpecialChar LyX
5260 distribution currently includes at least the
5261 \begin_inset Flex Code
5264 \begin_layout Plain Layout
5273 \begin_inset Flex Code
5276 \begin_layout Plain Layout
5287 \begin_layout Standard
5289 \begin_inset Flex Code
5292 \begin_layout Plain Layout
5300 file is a sequence of declarations of the form
5303 \begin_layout LyX-Code
5316 \begin_layout Standard
5317 For example, in order to map
5318 \begin_inset Flex Noun
5321 \begin_layout Plain Layout
5331 to the corresponding character in the iso-8859-1 set (233), the following
5335 \begin_layout LyX-Code
5343 \begin_layout Standard
5345 \begin_inset Flex Code
5348 \begin_layout Plain Layout
5357 \begin_inset Flex Code
5360 \begin_layout Plain Layout
5378 the same character can apply to more than one string.
5380 \begin_inset Flex Code
5383 \begin_layout Plain Layout
5394 \begin_layout LyX-Code
5406 \begin_inset Newline newline
5422 \begin_layout Standard
5424 cannot find a mapping for the string produced by the keystroke or a
5425 deadkey sequence, it will check if it looks like an accented char and try
5426 to draw an accent over the character on screen.
5429 \begin_layout Subsection
5433 \begin_layout Standard
5434 There is a second way to add support for international characters through
5435 so-called dead-keys.
5436 A dead-key works in combination with a letter to produce an accented character.
5437 Here, we'll explain how to create a really simple dead-key to illustrate
5441 \begin_layout Standard
5442 Suppose you happen to need the circumflex character,
5443 \begin_inset Quotes eld
5447 \begin_inset Quotes erd
5452 \begin_inset Flex Noun
5455 \begin_layout Plain Layout
5462 \begin_inset space ~
5466 \begin_inset Flex Noun
5469 \begin_layout Plain Layout
5475 ] to the \SpecialChar LyX
5477 \begin_inset Flex Code
5480 \begin_layout Plain Layout
5487 \begin_inset Flex Code
5490 \begin_layout Plain Layout
5497 Now, whenever you type the
5498 \begin_inset Flex Noun
5501 \begin_layout Plain Layout
5507 -key followed by a letter, that letter will have a circumflex accent on
5509 For example, the sequence
5510 \begin_inset Quotes eld
5514 \begin_inset Flex Noun
5517 \begin_layout Plain Layout
5524 \begin_inset Quotes erd
5527 produces the letter:
5528 \begin_inset Quotes eld
5532 \begin_inset Quotes erd
5536 If you tried to type
5537 \begin_inset Quotes eld
5541 \begin_inset Flex Noun
5544 \begin_layout Plain Layout
5551 \begin_inset Quotes erd
5554 , however, \SpecialChar LyX
5555 will complain with a beep, since a
5556 \begin_inset Quotes eld
5560 \begin_inset Flex Noun
5563 \begin_layout Plain Layout
5570 \begin_inset Quotes erd
5573 never takes a circumflex accent.
5575 \begin_inset Flex Noun
5578 \begin_layout Plain Layout
5584 after a dead-key produces the bare-accent.
5585 Please note this last point! If you bind a key to a dead-key, you'll need
5586 to rebind the character on that key to yet another key.
5588 \begin_inset Flex Noun
5591 \begin_layout Plain Layout
5597 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5600 \begin_layout Standard
5601 One common way to bind dead-keys is to use
5602 \begin_inset Flex Noun
5605 \begin_layout Plain Layout
5612 \begin_inset Flex Noun
5615 \begin_layout Plain Layout
5622 \begin_inset Flex Noun
5625 \begin_layout Plain Layout
5631 in combination with an accent, like
5632 \begin_inset Quotes eld
5636 \begin_inset Flex Noun
5639 \begin_layout Plain Layout
5646 \begin_inset Quotes erd
5650 \begin_inset Quotes eld
5654 \begin_inset Flex Noun
5657 \begin_layout Plain Layout
5664 \begin_inset Quotes erd
5668 \begin_inset Quotes eld
5672 \begin_inset Flex Noun
5675 \begin_layout Plain Layout
5682 \begin_inset Quotes erd
5686 Another way involves using
5687 \begin_inset Flex Code
5690 \begin_layout Plain Layout
5697 \begin_inset Flex Code
5700 \begin_layout Plain Layout
5706 to set up the special
5707 \begin_inset Flex Code
5710 \begin_layout Plain Layout
5718 \begin_inset Flex Code
5721 \begin_layout Plain Layout
5727 acts in some ways just like
5728 \begin_inset Flex Noun
5731 \begin_layout Plain Layout
5737 and permits you to bind keys to accented characters.
5738 You can also turn keys into dead-keys by binding them to something like
5740 \begin_inset Flex Code
5743 \begin_layout Plain Layout
5749 and then binding this symbolic key to the corresponding \SpecialChar LyX
5754 \begin_layout Plain Layout
5759 : This is exactly what I do in my
5760 \begin_inset Flex Code
5763 \begin_layout Plain Layout
5770 \begin_inset Flex Code
5773 \begin_layout Plain Layout
5781 \begin_inset Flex Noun
5784 \begin_layout Plain Layout
5786 \begin_inset space ~
5795 \begin_inset Flex Code
5798 \begin_layout Plain Layout
5804 and a bunch of these
5805 \begin_inset Quotes eld
5809 \begin_inset Flex Code
5812 \begin_layout Plain Layout
5819 \begin_inset Quotes erd
5822 symbolic keys bound such things as
5823 \begin_inset Flex Noun
5826 \begin_layout Plain Layout
5828 \begin_inset space ~
5837 \begin_inset Flex Noun
5840 \begin_layout Plain Layout
5842 \begin_inset space ~
5851 This is how I produce my accented characters.
5856 You can make just about anything into the
5857 \begin_inset Flex Code
5860 \begin_layout Plain Layout
5867 \begin_inset Flex Noun
5870 \begin_layout Plain Layout
5876 keys, a spare function key, etc.
5877 As for the \SpecialChar LyX
5878 commands that produce accents, check the entry for
5879 \begin_inset Flex Code
5882 \begin_layout Plain Layout
5893 You'll find the complete list there.
5896 \begin_layout Subsection
5897 Saving your Language Configuration
5900 \begin_layout Standard
5901 You can edit your preferences so that your desired language environment
5902 is automatically configured when \SpecialChar LyX
5904 \begin_inset Flex Noun
5907 \begin_layout Plain Layout
5908 Edit\SpecialChar menuseparator
5917 \begin_layout Chapter
5918 Installing New Document Classes, Layouts, and Templates
5919 \begin_inset CommandInset label
5921 name "cha:Installing-New-Document"
5926 \begin_inset Argument 1
5929 \begin_layout Plain Layout
5930 Installing New Document Classes
5938 \begin_layout Standard
5939 In this chapter, we describe the procedures for creating and installing
5940 new \SpecialChar LyX
5941 layout and template files, as well as offer a refresher on correctly
5942 installing new \SpecialChar LaTeX
5947 \begin_layout Standard
5948 First, let us a say a few words about how one ought to think about the relation
5949 between \SpecialChar LyX
5950 and \SpecialChar LaTeX
5952 The thing to understand is that, in a certain sense, \SpecialChar LyX
5953 doesn't know anything
5954 about \SpecialChar LaTeX
5956 Indeed, from \SpecialChar LyX
5957 's point of view, \SpecialChar LaTeX
5958 is just one of several
5959 \begin_inset Quotes eld
5963 \begin_inset Quotes erd
5966 in which it is capable of producing output.
5967 Other such formats are DocBook, plaintext, and XHTML.
5969 is, of course, a particularly important format, but very little of the
5970 information \SpecialChar LyX
5971 has about \SpecialChar LaTeX
5972 is actually contained in the program itself.
5976 \begin_layout Plain Layout
5977 Some commands are sufficiently complex that they are
5978 \begin_inset Quotes eld
5982 \begin_inset Quotes erd
5985 into \SpecialChar LyX
5987 But the developers generally regard this as a Bad Thing.
5992 Rather, that information, even for the standard classes like
5993 \begin_inset Flex Code
5996 \begin_layout Plain Layout
6002 , is contained in `layout files'.
6003 Similarly, \SpecialChar LyX
6004 itself does not know much about DocBook or XHTML.
6005 What it knows is contained in layout files.
6008 \begin_layout Standard
6009 You can think of the layout file for a given document class as a translation
6010 manual between \SpecialChar LyX
6011 constructs—paragraphs with their corresponding styles,
6012 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
6015 Almost everything \SpecialChar LyX
6017 \begin_inset Flex Code
6020 \begin_layout Plain Layout
6026 , for example, is contained in the file
6027 \begin_inset Flex Code
6030 \begin_layout Plain Layout
6036 and in various other files it includes.
6037 For this reason, anyone intending to write layout files should plan to
6038 study the existing files.
6039 A good place to start is with
6040 \begin_inset Flex Code
6043 \begin_layout Plain Layout
6049 , which is included in
6050 \begin_inset Flex Code
6053 \begin_layout Plain Layout
6060 \begin_inset Flex Code
6063 \begin_layout Plain Layout
6069 , and many of the other layout files for document classes.
6070 This file is where sections and the like are defined:
6071 \begin_inset Flex Code
6074 \begin_layout Plain Layout
6080 tells \SpecialChar LyX
6081 how paragraphs that are marked with the Section, Subsection, etc,
6082 styles can be translated into corresponding \SpecialChar LaTeX
6083 , DocBook, and XHTML commands
6086 \begin_inset Flex Code
6089 \begin_layout Plain Layout
6095 file basically just includes several of these
6096 \begin_inset Flex Code
6099 \begin_layout Plain Layout
6108 \begin_layout Standard
6109 Defining the \SpecialChar LyX
6111 correspondence is not the only thing layout files do, though.
6112 Their other job is to define how the \SpecialChar LyX
6113 constructs themselves will appear
6115 The fact that layout files have these two jobs is often a source of confusion,
6116 because they are completely separate.
6117 Telling \SpecialChar LyX
6118 how to translate a certain paragraph style into \SpecialChar LaTeX
6121 how to display it; conversely, telling \SpecialChar LyX
6122 how to display a certain paragraph
6123 style does not tell \SpecialChar LyX
6124 how to translate it into \SpecialChar LaTeX
6125 (let alone tell \SpecialChar LaTeX
6128 So, in general, when you define a new \SpecialChar LyX
6129 construct, you must always do two
6130 quite separate things: (i)
6131 \begin_inset space ~
6134 tell \SpecialChar LyX
6135 how to translate it into \SpecialChar LaTeX
6137 \begin_inset space ~
6140 tell \SpecialChar LyX
6144 \begin_layout Standard
6145 Much the same is true, of course, as regards \SpecialChar LyX
6146 's other backend formats, though
6147 XHTML is in some ways different, because in that case \SpecialChar LyX
6152 able, to some extent, to use information about how it should display a
6153 paragraph on the screen to output information (in the form of CSS) about
6154 how the paragraph should be displayed in a browser.
6155 Even in this case, however, the distinction between what \SpecialChar LyX
6157 and how things are rendered externally remains in force, and the two can
6158 be controlled separately.
6160 \begin_inset CommandInset ref
6162 reference "sec:Tags-for-XHTML"
6169 \begin_layout Section
6170 Installing new \SpecialChar LaTeX
6174 \begin_layout Standard
6175 Some installations may not include a \SpecialChar LaTeX
6176 package or class file that you would
6177 like to use within \SpecialChar LyX
6179 For example, you might need Foil\SpecialChar TeX
6180 , a package for preparing slides for overhead
6182 Modern \SpecialChar LaTeX
6183 distributions like \SpecialChar TeX
6184 Live (2008 or newer) or MiK\SpecialChar TeX
6185 provide a user interface
6186 for installing such packages.
6187 For example, with MiK\SpecialChar TeX
6188 , you start the program
6189 \begin_inset Quotes eld
6193 \begin_inset space ~
6197 \begin_inset Quotes erd
6200 to get a list of available packages.
6201 To install one of them, right click on it or use the corresponding toolbar
6205 \begin_layout Standard
6206 If your \SpecialChar LaTeX
6207 distribution does not provide such a `package manager', or if the
6208 package is not available from your distribution, then follow these steps
6209 to install it manually:
6212 \begin_layout Enumerate
6213 Get the package from
6214 \begin_inset CommandInset href
6217 target "http://www.ctan.org/"
6225 \begin_layout Enumerate
6226 If the package contains a file with the ending
6227 \begin_inset Quotes eld
6231 \begin_inset Flex Code
6234 \begin_layout Plain Layout
6241 \begin_inset Quotes erd
6244 (is the case for Foil\SpecialChar TeX
6245 ) then open a console, change to the folder of this
6246 file and execute the command
6247 \begin_inset Flex Code
6250 \begin_layout Plain Layout
6257 You have now unpacked the package and have all files to install it.
6258 Most \SpecialChar LaTeX
6259 -packages are not packed and you can skip this step.
6262 \begin_layout Enumerate
6263 Now you need to decide if the package should be available for all users
6268 \begin_layout Enumerate
6269 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6270 for all users on your system, then install it in your `local' \SpecialChar TeX
6272 install it in your own `user' \SpecialChar TeX
6274 Where these trees should be created, if they do not already exist, depends
6276 To find this out, look in the file
6277 \begin_inset Flex Code
6280 \begin_layout Plain Layout
6290 \begin_layout Plain Layout
6291 This is usually in the directory
6292 \begin_inset Flex Code
6295 \begin_layout Plain Layout
6301 , though you can execute the command
6302 \begin_inset Flex Code
6305 \begin_layout Plain Layout
6316 The location of the `local' \SpecialChar TeX
6317 tree is defined by the
6318 \begin_inset Flex Code
6321 \begin_layout Plain Layout
6327 variable; this is usually somewhere like
6328 \begin_inset Flex Code
6331 \begin_layout Plain Layout
6332 /usr/local/share/texmf
6337 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6340 The location of the `user' \SpecialChar TeX
6342 \begin_inset Flex Code
6345 \begin_layout Plain Layout
6352 \begin_inset Flex Code
6355 \begin_layout Plain Layout
6362 \begin_inset Flex Code
6365 \begin_layout Plain Layout
6374 (If these variables are not predefined, you have to define them.) You'll
6375 probably need root permissions to create or modify the `local' tree, but
6376 not for your `user' tree.
6377 \begin_inset Newline newline
6380 In general, it is recommended to install in the user tree because your user
6381 will not be modified or even overwritten when you upgrade your system.
6382 It will typically also be backed up together with everything else when
6383 you backup your home directory (which, of course, you do on a regular basis).
6386 \begin_layout Enumerate
6387 On Windows, if you want the new package to be available for all users on
6388 your system, change to the folder where \SpecialChar LaTeX
6389 is installed and then change to
6391 \begin_inset Flex Code
6394 \begin_layout Plain Layout
6405 (For MiK\SpecialChar TeX
6406 , this would be by default the folder
6407 \begin_inset Flex Code
6410 \begin_layout Plain Layout
6428 \begin_layout Plain Layout
6429 Note that this will be the correct path only on English installations.
6430 On a German one, it would be
6431 \begin_inset Flex Code
6434 \begin_layout Plain Layout
6448 , and similarly for other languages.
6453 Create there a new folder
6454 \begin_inset Flex Code
6457 \begin_layout Plain Layout
6463 and copy all files of the package into it.
6465 \begin_inset Newline newline
6468 If the package should only available for you or you don't have admin permissions
6469 , do the same, but in the local \SpecialChar LaTeX
6472 \begin_inset space \thinspace{}
6475 g., for MiK\SpecialChar TeX
6477 \begin_inset space ~
6480 2.8 under Windows XP, this would be the folder:
6481 \begin_inset Newline newline
6487 \begin_inset Flex Code
6490 \begin_layout Plain Layout
6493 Documents and Settings
6505 \begin_inset Newline newline
6511 \begin_inset Phantom HPhantom
6514 \begin_layout Plain Layout
6525 \begin_inset Flex Code
6528 \begin_layout Plain Layout
6541 \begin_inset Newline newline
6544 On Vista, it would be:
6545 \begin_inset Newline newline
6549 \begin_inset Flex Code
6552 \begin_layout Plain Layout
6578 \begin_layout Enumerate
6579 Now one only need to tell \SpecialChar LaTeX
6580 that there are new files.
6581 This depends on the used \SpecialChar LaTeX
6586 \begin_layout Enumerate
6587 For \SpecialChar TeX
6588 Live execute the command
6589 \begin_inset Flex Code
6592 \begin_layout Plain Layout
6599 If you installed the package for all users, then you will probably need
6600 to have root permissions for that.
6603 \begin_layout Enumerate
6604 For MiK\SpecialChar TeX
6605 , if you have installed the package for all users, start the program
6607 \begin_inset Quotes eld
6611 \begin_inset space ~
6615 \begin_inset Quotes erd
6618 and press the button marked
6619 \begin_inset Quotes eld
6623 \begin_inset Quotes erd
6627 Otherwise start the program
6628 \begin_inset Quotes eld
6632 \begin_inset Quotes erd
6639 \begin_layout Enumerate
6640 Finally, you need to tell \SpecialChar LyX
6641 that there are new packages available.
6642 So, in \SpecialChar LyX
6644 \begin_inset Flex Noun
6647 \begin_layout Plain Layout
6650 \SpecialChar menuseparator
6656 and then restart \SpecialChar LyX
6660 \begin_layout Standard
6661 Now the package is installed.
6662 In our example, the document class
6663 \begin_inset Flex Code
6666 \begin_layout Plain Layout
6672 will now be available under
6673 \begin_inset Flex Noun
6676 \begin_layout Plain Layout
6677 Document\SpecialChar menuseparator
6678 Settings\SpecialChar menuseparator
6685 \begin_inset Quotes eld
6689 \begin_inset Quotes erd
6696 \begin_layout Standard
6697 If you would like to use a \SpecialChar LaTeX
6698 document class that is not even listed in the
6700 \begin_inset Flex Noun
6703 \begin_layout Plain Layout
6704 Document\SpecialChar menuseparator
6705 Settings\SpecialChar menuseparator
6711 , then you need to create a `layout' file for it.
6712 That is the topic of the next section.
6715 \begin_layout Section
6716 Types of layout files
6719 \begin_layout Standard
6720 This section describes the various sorts of \SpecialChar LyX
6721 files that contain layout informati
6723 These files describe various paragraph and character styles, determining
6724 how \SpecialChar LyX
6725 should display them and how they should be translated into \SpecialChar LaTeX
6727 XHTML, or whatever output format is being used.
6731 \begin_layout Standard
6732 We shall try to provide a thorough description of the process of writing
6734 However, there are so many different types of documents supported even
6735 by just \SpecialChar LaTeX
6736 that we can't hope to cover every different possibility or problem
6737 you might encounter.
6738 The \SpecialChar LyX
6739 users' list is frequented by people with lots of experience with layout
6740 design who are willing to share what they've learned, so please feel free
6741 to ask questions there.
6744 \begin_layout Standard
6745 As you prepare to write a new layout, it is extremely helpful to look at
6746 the layouts distributed with \SpecialChar LyX
6748 If you write a \SpecialChar LyX
6749 layout for a \SpecialChar LaTeX
6750 document class that might also be used by
6751 others, or write a module that might be useful to others, then you should
6752 consider posting your layout to the
6753 \begin_inset CommandInset href
6755 name "layout section on the LyX wiki"
6756 target "https://wiki.lyx.org/Layouts/Layouts"
6761 or even to the \SpecialChar LyX
6762 developers' list, so that it might be included in \SpecialChar LyX
6767 \begin_layout Plain Layout
6768 Note that \SpecialChar LyX
6769 is licensed under the General Public License, so any material
6770 that is contributed to \SpecialChar LyX
6771 must be similarly licensed.
6779 \begin_layout Subsection
6781 \begin_inset CommandInset label
6783 name "subsec:Layout-modules"
6790 \begin_layout Standard
6791 We have spoken to this point about `layout files'.
6792 But there are different sorts of files that contain layout information.
6793 Layout files, strictly so called, have the
6794 \begin_inset Flex Code
6797 \begin_layout Plain Layout
6803 extension and provide \SpecialChar LyX
6804 with information about document classes.
6805 Since \SpecialChar LyX
6806 1.6 layout information can also be contained in layout
6811 \begin_inset Flex Code
6814 \begin_layout Plain Layout
6821 Modules are to \SpecialChar LaTeX
6822 packages much as layouts are to \SpecialChar LaTeX
6823 classes, and some modules—such
6825 \begin_inset Flex Code
6828 \begin_layout Plain Layout
6834 module—specifically provide support for one package.
6835 In a sense, layout modules are similar to included
6839 \begin_layout Plain Layout
6840 These can have any extension, but by convention have the
6841 \begin_inset Flex Code
6844 \begin_layout Plain Layout
6856 \begin_inset Flex Code
6859 \begin_layout Plain Layout
6865 —in that modules are not specific to a given document class but may be used
6866 with many different classes.
6867 The difference is that using an included file with
6868 \begin_inset Flex Code
6871 \begin_layout Plain Layout
6877 requires editing that file.
6878 Modules, by contrast, are selected in the
6879 \begin_inset Flex Noun
6882 \begin_layout Plain Layout
6883 Document\SpecialChar menuseparator
6892 \begin_layout Standard
6893 Building modules is the easiest way to get started with layout editing,
6894 since it can be as simple as adding a single new paragraph style or flex
6896 But modules may, in principle, contain anything a layout file can contain.
6899 \begin_layout Standard
6900 After creating a new module and copying it to the
6901 \begin_inset Flex Code
6904 \begin_layout Plain Layout
6910 folder, you will need to reconfigure and then restart \SpecialChar LyX
6913 However, changes you make to the module will be seen immediately, if you
6915 \begin_inset Flex Noun
6918 \begin_layout Plain Layout
6919 Document\SpecialChar menuseparator
6925 , highlight something, and then hit
6926 \begin_inset Quotes eld
6930 \begin_inset Quotes erd
6936 It is strongly recommended that you save your work before doing this
6941 it is strongly recommended that you not attempt to edit modules while simultaneo
6942 usly working on actual documents
6945 Though of course the developers strive to keep \SpecialChar LyX
6946 stable in such situations,
6947 syntax errors and the like in your module file could cause strange behavior.
6950 \begin_layout Subsubsection
6954 \begin_layout Standard
6955 Modules are to \SpecialChar LyX
6956 as packages are to \SpecialChar LaTeX
6958 Sometimes, however, you find yourself wanting a specific inset or character
6959 style just for one document and writing a module that will also be available
6960 to other documents makes little sense.
6961 What you need is \SpecialChar LyX
6963 \begin_inset Quotes eld
6967 \begin_inset Quotes erd
6973 \begin_layout Standard
6974 You will find it under
6976 Document\SpecialChar menuseparator
6977 Settings\SpecialChar menuseparator
6981 The large text box allows you to enter anything that you might enter in
6982 a layout file or module.
6983 You can think of a document's local layout, in fact, as a module that belongs
6985 So, in particular, you must enter a
6986 \begin_inset Flex Code
6989 \begin_layout Plain Layout
6996 Any format is acceptable, but one would normally use the format current
6998 (In \SpecialChar LyX
7005 , the current layout format is
7014 \begin_layout Standard
7015 When you have entered something in the
7016 \begin_inset Flex Code
7019 \begin_layout Plain Layout
7025 pane, \SpecialChar LyX
7027 \begin_inset Quotes eld
7031 \begin_inset Quotes erd
7034 button at the bottom.
7035 Clicking this button will cause \SpecialChar LyX
7036 to determine whether what you have entered
7037 is valid layout information for the chosen format.
7039 will report the result but, unfortunately, will not tell you what errors
7040 there might have been.
7041 These will be written to the terminal, however, if \SpecialChar LyX
7042 is started from a terminal.
7043 You will not be permitted to save your local layout until you have entered
7047 \begin_layout Standard
7048 The warnings at the end of the previous section apply here, too.
7049 Do not play with local layout while you are actually working, especially
7050 if you have not saved your document.
7051 That said, using local layout with a test document can be a very convenient
7052 way to try out layout ideas, or even to start developing a module.
7055 \begin_layout Subsection
7057 \begin_inset Flex Noun
7060 \begin_layout Plain Layout
7069 \begin_layout Standard
7070 There are two situations you are likely to encounter when wanting to support
7071 a new \SpecialChar LaTeX
7072 document class, involving style (
7073 \begin_inset Flex Code
7076 \begin_layout Plain Layout
7082 ) files and \SpecialChar LaTeX2e
7084 \begin_inset Flex Code
7087 \begin_layout Plain Layout
7094 Supporting a style file is usually fairly easy.
7095 Supporting a new class file is a bit harder.
7096 We'll discuss the former in this section and the latter in the next.
7098 \change_deleted 5863208 1594239023
7099 Similar remarks apply, of course, if you want to support a new DocBook DTD.
7104 \begin_layout Standard
7105 The easier case is the one in which your new document class is provided
7106 as a style file that is to be used in conjunction with an already supported
7108 For the sake of the example, we'll assume that the style file is called
7110 \begin_inset Flex Noun
7113 \begin_layout Plain Layout
7119 and that it is meant to be used with
7120 \begin_inset Flex Noun
7123 \begin_layout Plain Layout
7129 , which is a standard class.
7133 \begin_layout Standard
7134 Start by copying the existing class's layout file into your local directory:
7138 \begin_layout Plain Layout
7139 Of course, which directory is your local directory will vary by platform,
7140 and \SpecialChar LyX
7141 allows you to specify your local directory on startup, too, using
7143 \begin_inset Flex Code
7146 \begin_layout Plain Layout
7160 \begin_layout LyX-Code
7161 cp report.layout ~/.lyx/layouts/myclass.layout
7164 \begin_layout Standard
7166 \begin_inset Flex Code
7169 \begin_layout Plain Layout
7175 and change the line:
7178 \begin_layout LyX-Code
7181 DeclareLaTeXClass{Report (Standard Class)}
7184 \begin_layout Standard
7188 \begin_layout LyX-Code
7191 DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
7194 \begin_layout Standard
7198 \begin_layout LyX-Code
7200 \begin_inset Newline newline
7206 \begin_inset Newline newline
7212 \begin_layout Standard
7213 near the top of the file.
7216 \begin_layout Standard
7217 Start \SpecialChar LyX
7219 \begin_inset Flex Noun
7222 \begin_layout Plain Layout
7223 Tools\SpecialChar menuseparator
7230 Then restart \SpecialChar LyX
7231 and try creating a new document.
7233 \begin_inset Flex Noun
7236 \begin_layout Plain Layout
7242 " as a document class option in the
7243 \begin_inset Flex Noun
7246 \begin_layout Plain Layout
7247 Document\SpecialChar menuseparator
7254 It is likely that some of the sectioning commands and such in your new
7255 class will work differently from how they worked in the base class—
7256 \begin_inset Flex Code
7259 \begin_layout Plain Layout
7265 in this example—so you can fiddle around with the settings for the different
7266 sections if you wish.
7267 The layout information for sections is contained in
7268 \begin_inset Flex Code
7271 \begin_layout Plain Layout
7277 , but you do not need to copy and change this file.
7278 Instead, you can simply add your changes to your layout file, after the
7280 \begin_inset Flex Code
7283 \begin_layout Plain Layout
7289 , which itself includes
7290 \begin_inset Flex Code
7293 \begin_layout Plain Layout
7300 For example, you might add these lines:
7303 \begin_layout LyX-Code
7307 \begin_layout LyX-Code
7311 \begin_layout LyX-Code
7315 \begin_layout LyX-Code
7319 \begin_layout LyX-Code
7323 \begin_layout Standard
7324 to change the font for chapter headings to sans-serif.
7325 This will override (or, in this case, add to) the existing declaration
7326 for the Chapter style.
7330 \begin_layout Standard
7331 Your new package may also provide commands or environments not present in
7333 In this case, you will want to add these to the layout file.
7335 \begin_inset CommandInset ref
7337 reference "sec:TextClass"
7341 for information on how to do so.
7344 \begin_layout Standard
7346 \begin_inset Flex Noun
7349 \begin_layout Plain Layout
7355 can be used with several different document classes, and even if it cannot,
7356 you might find it easiest just to write a module that you can load with
7358 The simplest possible such module would be:
7361 \begin_layout LyX-Code
7364 DeclareLyXModule{My Class}
7367 \begin_layout LyX-Code
7371 \begin_layout LyX-Code
7372 #Support for myclass.sty.
7375 \begin_layout LyX-Code
7377 \begin_inset Newline newline
7383 \begin_layout LyX-Code
7391 \begin_inset Newline newline
7397 \begin_layout LyX-Code
7399 \begin_inset Newline newline
7405 \begin_inset Newline newline
7411 \begin_layout Standard
7412 A more complex module might modify the behavior of some existing constructs
7413 or define some new ones.
7415 \begin_inset CommandInset ref
7417 reference "sec:TextClass"
7424 \begin_layout Subsection
7426 \begin_inset Flex Noun
7429 \begin_layout Plain Layout
7438 \begin_layout Standard
7439 There are two possibilities here.
7440 One is that the class file is itself based upon an existing document class.
7441 For example, many thesis classes are based upon
7442 \begin_inset Flex Noun
7445 \begin_layout Plain Layout
7452 To see whether yours is, look for a line like
7455 \begin_layout LyX-Code
7461 \begin_layout Standard
7463 If so, then you may proceed largely as in the previous section, though
7465 \begin_inset Flex Code
7468 \begin_layout Plain Layout
7469 Declare\SpecialChar LaTeX
7475 line will be different.
7476 If your new class is
7477 \begin_inset Flex Code
7480 \begin_layout Plain Layout
7486 and it is based upon
7487 \begin_inset Flex Code
7490 \begin_layout Plain Layout
7496 , then the line should read:
7500 \begin_layout Plain Layout
7501 And it will be easiest if you save the file to
7502 \begin_inset Flex Code
7505 \begin_layout Plain Layout
7512 assumes that the document class has the same name as the layout file.
7521 \begin_layout LyX-Code
7524 DeclareLaTeXClass[thesis,book]{thesis}
7527 \begin_layout Standard
7528 If, on the other hand, the new class is not based upon an existing class,
7529 you will probably have to
7530 \begin_inset Quotes eld
7534 \begin_inset Quotes erd
7538 We strongly suggest copying an existing layout file which uses a similar
7540 class and then modifying it, if you can do so.
7541 At least use an existing file as a starting point so you can find out what
7542 items you need to worry about.
7543 Again, the specifics are covered below.
7546 \begin_layout Subsection
7548 \begin_inset CommandInset label
7550 name "subsec:Creating-Templates"
7557 \begin_layout Standard
7558 Once you have written a layout file for a new document class, you might
7559 want to consider writing a
7564 A template acts as a kind of tutorial for your layout, showing how it might
7565 be used, though containing dummy content.
7566 You can of course look at the various templates included with \SpecialChar LyX
7570 \begin_layout Standard
7571 Templates are created just like usual documents: using \SpecialChar LyX
7573 The only difference is that usual documents contain all possible settings,
7574 including the font scheme and the paper size.
7575 Usually a user doesn't want a template to overwrite his preferred settings
7576 for such parameters.
7577 For that reason, the designer of a template should remove the corresponding
7579 \begin_inset Flex Code
7582 \begin_layout Plain Layout
7591 \begin_inset Flex Code
7594 \begin_layout Plain Layout
7602 from the template \SpecialChar LyX
7604 This can be done with any simple text-editor, for example
7605 \begin_inset Flex Code
7608 \begin_layout Plain Layout
7615 \begin_inset Flex Code
7618 \begin_layout Plain Layout
7627 \begin_layout Standard
7628 Put the edited template files you create in
7629 \begin_inset Flex Code
7632 \begin_layout Plain Layout
7638 , copy the ones you use from the global template directory in
7639 \begin_inset Flex Code
7642 \begin_layout Plain Layout
7648 to the same place, and redefine the template path in the
7649 \begin_inset Flex Noun
7652 \begin_layout Plain Layout
7653 Tools\SpecialChar menuseparator
7654 Preferences\SpecialChar menuseparator
7663 \begin_layout Standard
7664 Note, by the way, that there is a template which has a particular meaning:
7665 \begin_inset Newline linebreak
7669 \begin_inset Flex Code
7672 \begin_layout Plain Layout
7679 This template is loaded every time you create a new document with
7680 \begin_inset Flex Noun
7683 \begin_layout Plain Layout
7684 File\SpecialChar menuseparator
7690 in order to provide useful defaults.
7691 To create this template from inside \SpecialChar LyX
7692 , all you have to do is to open a document
7693 with the correct settings, and use the
7694 \begin_inset Flex Noun
7697 \begin_layout Plain Layout
7698 Save as Document Defaults
7706 \begin_layout Subsection
7707 Upgrading old layout files
7710 \begin_layout Standard
7711 The format of layout files changes with each \SpecialChar LyX
7712 release, so old layout files
7713 need to be converted to the new format.
7715 reads a layout file in an older format, it automatically calls the
7717 \begin_inset Flex Code
7720 \begin_layout Plain Layout
7726 to convert it to a temporary file in current format.
7727 The original file is left untouched.
7728 If you use the layout file often, then, you may want to convert it permanently,
7729 so that \SpecialChar LyX
7730 does not have to do so itself every time.
7731 To do this, you can call the converter manually:
7734 \begin_layout Enumerate
7736 \begin_inset Flex Code
7739 \begin_layout Plain Layout
7746 \begin_inset Flex Code
7749 \begin_layout Plain Layout
7758 \begin_layout Enumerate
7760 \begin_inset Newline newline
7764 \begin_inset Flex Code
7767 \begin_layout Plain Layout
7768 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7774 \begin_inset Newline newline
7778 \begin_inset Flex Code
7781 \begin_layout Plain Layout
7787 is the name of your \SpecialChar LyX
7791 \begin_layout Standard
7792 Note that manual conversion does not affect included files, so these will
7793 have to be converted separately.
7796 \begin_layout Subsection
7797 \begin_inset CommandInset label
7799 name "subsec:Cite-Engine-Files"
7806 \begin_layout Standard
7807 A specific form of layout files are the so-called
7808 \begin_inset Flex Code
7811 \begin_layout Plain Layout
7817 files that are located in the
7818 \begin_inset Flex Code
7821 \begin_layout Plain Layout
7828 Their purpose is to define the specifics of \SpecialChar LaTeX
7829 packages aimed at bibliography
7842 , but also the way how normal Bib\SpecialChar TeX
7843 citations (without additional packages)
7844 are handled in \SpecialChar LyX
7845 is defined in such a file.
7849 \begin_layout Standard
7850 More specifically, it is defined which packages \SpecialChar LyX
7851 needs to load, which citation
7852 commands are available, how these are to be displayed in \SpecialChar LyX
7854 the dialogs, the context menus) as well as in the XHTML and plain text
7856 Furthermore, the files specify available style variants (author-year, numerical
7857 , etc.) and their specifics.
7858 The cite engine files are also used to generate the options that are available
7861 Document\SpecialChar menuseparator
7862 Settings\SpecialChar menuseparator
7863 Bibliography\SpecialChar menuseparator
7869 \begin_layout Standard
7870 Even though a cite engine file is essentially a normal layout file that
7871 could theoretically include any layout information, it usually primarily
7872 includes some specific parameters such as
7873 \begin_inset Flex Code
7876 \begin_layout Plain Layout
7883 \begin_inset Flex Code
7886 \begin_layout Plain Layout
7893 \begin_inset Flex Code
7896 \begin_layout Plain Layout
7903 \begin_inset Flex Code
7906 \begin_layout Plain Layout
7913 The syntax of the latter two is described in
7914 \begin_inset CommandInset ref
7916 reference "subsec:Citation-engine-description"
7924 \begin_inset CommandInset ref
7926 reference "subsec:Citation-format-description"
7930 , as well as in the files themselves.
7933 \begin_layout Section
7934 \begin_inset CommandInset label
7936 name "sec:TextClass"
7940 The layout file format
7943 \begin_layout Standard
7944 The following sections describe how layout files are structured and written.
7945 Our advice is to go slowly, save and test often.
7946 It is really not that hard, except that the multitude of options can become
7947 overwhelming, especially if you try to check out too many at once.
7948 It becomes easier if you use existing layouts of \SpecialChar LyX
7949 as examples/reference
7950 or if you modify an existing layout to your needs.
7953 \begin_layout Standard
7954 Note that all the tags used in layout files are case-insensitive.
7956 \begin_inset Flex Code
7959 \begin_layout Plain Layout
7966 \begin_inset Flex Code
7969 \begin_layout Plain Layout
7976 \begin_inset Flex Code
7979 \begin_layout Plain Layout
7985 are really the same tag.
7986 The possible arguments are printed in brackets after the tag's name.
7987 The default argument is typeset
7988 \begin_inset Flex Code
7991 \begin_layout Plain Layout
8000 If the argument has a data type like
8001 \begin_inset Quotes eld
8005 \begin_inset Quotes erd
8009 \begin_inset Quotes eld
8013 \begin_inset Quotes erd
8016 , the default is shown like this:
8017 \begin_inset Flex Code
8020 \begin_layout Plain Layout
8031 \begin_layout Subsection
8032 The document class declaration and classification
8035 \begin_layout Standard
8036 Lines in a layout file which begin with
8037 \begin_inset Flex Code
8040 \begin_layout Plain Layout
8047 There is one exception to this rule.
8049 \begin_inset Flex Code
8052 \begin_layout Plain Layout
8058 files should begin with lines like:
8061 \begin_layout LyX-Code
8064 #% Do not delete the line below; configure depends on this
8067 \begin_layout LyX-Code
8072 DeclareLaTeXClass{Article (Standard Class)}
8075 \begin_layout LyX-Code
8080 DeclareCategory{Articles}
8083 \begin_layout Standard
8084 The second and third lines are used when you (re)configure \SpecialChar LyX
8086 The layout file is read by the \SpecialChar LaTeX
8088 \begin_inset Flex Code
8091 \begin_layout Plain Layout
8097 , in a special mode where
8098 \begin_inset Flex Code
8101 \begin_layout Plain Layout
8108 The first line is just a \SpecialChar LaTeX
8109 comment, the second one contains the mandatory
8110 declaration of the text class and the third line contains the optional
8111 classification of the class.
8112 If these lines appear in a file named
8113 \begin_inset Flex Code
8116 \begin_layout Plain Layout
8122 , then they define a text class of name
8123 \begin_inset Flex Code
8126 \begin_layout Plain Layout
8132 (the name of the layout file) which uses the \SpecialChar LaTeX
8134 \begin_inset Flex Code
8137 \begin_layout Plain Layout
8143 (the default is to use the same name as the layout).
8145 \begin_inset Quotes eld
8148 Article (Standard Class)
8149 \begin_inset Quotes erd
8152 that appears above is used as a description of the text class in the
8153 \begin_inset Flex Noun
8156 \begin_layout Plain Layout
8157 Document\SpecialChar menuseparator
8165 \begin_inset Quotes eld
8169 \begin_inset Quotes erd
8172 in the example) is also used in the
8173 \begin_inset Flex Noun
8176 \begin_layout Plain Layout
8177 Document\SpecialChar menuseparator
8183 dialog: the text classes are grouped by these categories (which are usually
8184 genres, so typical categories are
8185 \begin_inset Quotes eld
8189 \begin_inset Quotes erd
8193 \begin_inset Quotes eld
8197 \begin_inset Quotes erd
8201 \begin_inset Quotes eld
8205 \begin_inset Quotes erd
8209 \begin_inset Quotes eld
8213 \begin_inset Quotes erd
8217 \begin_inset Quotes eld
8221 \begin_inset Quotes erd
8225 \begin_inset Quotes eld
8229 \begin_inset Quotes erd
8233 If no category has been declared, the class will be put in the
8234 \begin_inset Quotes eld
8238 \begin_inset Quotes erd
8244 \begin_layout Standard
8245 Let's assume that you wrote your own text class that uses the
8246 \begin_inset Flex Code
8249 \begin_layout Plain Layout
8255 document class, but where you changed the appearance of the section headings.
8256 If you put it in a file
8257 \begin_inset Flex Code
8260 \begin_layout Plain Layout
8266 , the header of this file should be:
8269 \begin_layout LyX-Code
8272 #% Do not delete the line below; configure depends on this
8275 \begin_layout LyX-Code
8280 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8283 \begin_layout LyX-Code
8288 DeclareCategory{Articles}
8291 \begin_layout Standard
8292 This declares a text class
8293 \begin_inset Flex Code
8296 \begin_layout Plain Layout
8302 , associated with the \SpecialChar LaTeX
8304 \begin_inset Flex Code
8307 \begin_layout Plain Layout
8314 \begin_inset Quotes eld
8317 Article (with My Own Headings)
8318 \begin_inset Quotes erd
8322 If your text class depends on several packages, you can declare it as:
8325 \begin_layout LyX-Code
8328 #% Do not delete the line below; configure depends on this
8331 \begin_layout LyX-Code
8336 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8339 \begin_layout LyX-Code
8344 DeclareCategory{Articles}
8347 \begin_layout Standard
8348 This indicates that your text class uses the
8349 \begin_inset Flex Code
8352 \begin_layout Plain Layout
8360 \change_deleted 5863208 1594239179
8361 Finally, it is also possible to declare classes for DocBook code.
8362 Typical declarations will look like:
8365 \begin_layout LyX-Code
8367 \change_deleted 5863208 1594239179
8370 #% Do not delete the line below; configure depends on this
8373 \begin_layout LyX-Code
8375 \change_deleted 5863208 1594239179
8380 DeclareDocBookClass[article]{SGML (DocBook Article)}
8383 \begin_layout LyX-Code
8385 \change_deleted 5863208 1594239179
8390 DeclareCategory{Articles (DocBook)}
8395 \begin_layout Standard
8396 Note that these declarations can also be given an optional parameter declaring
8397 the name of the document class (but not a list).
8400 \begin_layout Standard
8401 So, to be as explicit as possible, the form of the layout declaration is:
8404 \begin_layout LyX-Code
8409 DeclareLaTeXClass[class,package.sty]{layout description}
8412 \begin_layout LyX-Code
8417 DeclareCategory{category}
8420 \begin_layout Standard
8421 The class need only be specified if the name of the \SpecialChar LaTeX
8423 name of the layout file are different or if there are packages to load.
8424 If the name of the class file is not specified, then \SpecialChar LyX
8426 that it is the same as the name of the layout file.
8429 \begin_layout Standard
8430 When the text class has been modified to your taste, all you have to do
8431 is to copy it either to
8432 \begin_inset Flex Code
8435 \begin_layout Plain Layout
8442 \begin_inset Flex Code
8445 \begin_layout Plain Layout
8452 \begin_inset Flex Noun
8455 \begin_layout Plain Layout
8456 Tools\SpecialChar menuseparator
8462 , exit \SpecialChar LyX
8464 Then your new text class should be available along with the others.
8467 \begin_layout Standard
8468 Once the layout file is installed, you can edit it and see your changes
8469 without having to reconfigure or to restart \SpecialChar LyX
8474 \begin_layout Plain Layout
8475 In versions of \SpecialChar LyX
8476 prior to 1.6, this was not true.
8477 As a result, editing layout files was very time consuming, since you had
8478 constantly to restart \SpecialChar LyX
8484 You can force a reload of the current layout by using the \SpecialChar LyX
8486 \begin_inset Flex Noun
8489 \begin_layout Plain Layout
8496 There is no default binding for this function—though, of course, you can
8497 bind it to a key yourself.
8498 But you will normally use this function simply by entering it in the mini-buffe
8503 \begin_layout Standard
8509 \begin_inset Flex Noun
8512 \begin_layout Plain Layout
8518 is very much an `advanced feature'.
8523 recommended that you save your work before using this function.
8528 recommended that you not attempt to edit layout information while simultaneousl
8529 y working on a document that you care about.
8530 Use a test document.
8531 Syntax errors and the like in your layout file could cause peculiar behavior.
8532 In particular, such errors could cause \SpecialChar LyX
8533 to regard the current layout as
8534 invalid and to attempt to switch to some other layout.
8538 \begin_layout Plain Layout
8539 Really bad syntax errors may even caused \SpecialChar LyX
8541 This is because certain sorts of errors may make \SpecialChar LyX
8552 The \SpecialChar LyX
8553 team strives to keep \SpecialChar LyX
8554 stable in such situations, but safe is better
8559 \begin_layout Plain Layout
8560 While we're giving advice: make regular backups.
8561 And be nice to your mother.
8569 \begin_layout Subsection
8570 The Module declaration
8573 \begin_layout Standard
8574 A module must begin with a line like the following:
8577 \begin_layout LyX-Code
8580 DeclareLyXModule[endnotes.sty]{Endnotes}
8581 \change_inserted -712698321 1554395911
8585 \begin_layout LyX-Code
8587 \change_inserted -712698321 1554395924
8592 DeclareCategory{Foot- and Endnotes}
8593 \change_deleted -712698321 1554395911
8601 \begin_layout Standard
8602 The mandatory argument
8603 \change_inserted -712698321 1554395956
8612 , in curly brackets, is the name of the module, as it should appear in
8613 \begin_inset Flex Noun
8616 \begin_layout Plain Layout
8617 Document\SpecialChar menuseparator
8618 Settings\SpecialChar menuseparator
8625 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8627 on which the module depends.
8628 It is also possible to use the form
8629 \begin_inset Flex Noun
8632 \begin_layout Plain Layout
8638 as an optional argument, which declares that the module can only be used
8639 when there exists a conversion chain between the formats `
8640 \begin_inset Flex Code
8643 \begin_layout Plain Layout
8650 \begin_inset Flex Code
8653 \begin_layout Plain Layout
8661 \change_inserted -712698321 1554396133
8668 declaration is not strictly mandatory, but you should add it, since it
8669 is helpful to find the module.
8670 Please have a look at the existing module categories and if appropriate,
8676 \begin_layout Standard
8678 \change_inserted -712698321 1554395988
8681 declaration should then be followed by lines like the following:
8685 \begin_layout Plain Layout
8686 Preferably in English if the module should be published with \SpecialChar LyX
8688 This description will appear in the list of messages to be translated and
8689 will be thus translated with the next interface update.
8697 \begin_layout LyX-Code
8701 \begin_layout LyX-Code
8702 #Adds an endnote command, in addition to footnotes.
8706 \begin_layout LyX-Code
8707 #You will need to add
8709 theendnotes in TeX code where you
8712 \begin_layout LyX-Code
8713 #want the endnotes to appear.
8717 \begin_layout LyX-Code
8721 \begin_layout LyX-Code
8722 #Requires: somemodule | othermodule
8725 \begin_layout LyX-Code
8726 #Excludes: badmodule
8729 \begin_layout Standard
8730 The description is used in
8731 \begin_inset Flex Noun
8734 \begin_layout Plain Layout
8735 Document\SpecialChar menuseparator
8736 Settings\SpecialChar menuseparator
8742 to provide the user with information about what the module does.
8744 \begin_inset Flex Code
8747 \begin_layout Plain Layout
8753 line is used to identify other modules with which this one must be used;
8755 \begin_inset Flex Code
8758 \begin_layout Plain Layout
8764 line is used to identify modules with which this one may not be used.
8765 Both are optional, and, as shown, multiple modules should be separated
8766 with the pipe symbol: |.
8767 Note that the required modules are treated disjunctively:
8771 of the required modules must be used.
8776 excluded module may be used.
8777 Note that modules are identified here by their filenames without the
8778 \begin_inset Flex Code
8781 \begin_layout Plain Layout
8789 \begin_inset Flex Code
8792 \begin_layout Plain Layout
8799 \begin_inset Flex Code
8802 \begin_layout Plain Layout
8811 \begin_layout Subsection
8812 The CiteEngine file declaration
8815 \begin_layout Standard
8816 A cite engine file must begin with a line like the following:
8819 \begin_layout LyX-Code
8822 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
8825 \begin_layout Standard
8826 The mandatory argument, in curly brackets, is the name of the cite style,
8827 as it should appear in
8828 \begin_inset Flex Noun
8831 \begin_layout Plain Layout
8832 Document\SpecialChar menuseparator
8833 Settings\SpecialChar menuseparator
8840 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8842 on which the cite engine depends.
8845 \begin_layout Standard
8846 The cite engine declaration should then be followed by lines like the following:
8850 \begin_layout Plain Layout
8851 Preferably in English if the module should be published with \SpecialChar LyX
8853 This description will appear in the list of messages to be translated and
8854 will be thus translated with the next interface update.
8862 \begin_layout LyX-Code
8866 \begin_layout LyX-Code
8867 # Biblatex supports many author-year and numerical styles.
8870 \begin_layout LyX-Code
8871 # It is mainly aimed at the Humanities.
8875 \begin_layout LyX-Code
8876 # customizable, fully localized and provides many features
8879 \begin_layout LyX-Code
8880 # that are not possible with BibTeX.
8881 The use of 'biber' as
8884 \begin_layout LyX-Code
8885 # bibliography processor is advised.
8888 \begin_layout LyX-Code
8892 \begin_layout Standard
8893 The description is used in
8894 \begin_inset Flex Noun
8897 \begin_layout Plain Layout
8898 Document\SpecialChar menuseparator
8899 Settings\SpecialChar menuseparator
8905 to provide the user with information about the cite engine.
8908 \begin_layout Subsection
8912 \begin_layout Standard
8913 The first non-comment line of any layout file, included file, or module
8918 contain the file format number:
8921 \begin_layout Description
8922 \begin_inset Flex Code
8925 \begin_layout Plain Layout
8932 \begin_inset Flex Code
8935 \begin_layout Plain Layout
8941 ] The format number of the layout file.
8944 \begin_layout Standard
8945 This tag was introduced with \SpecialChar LyX
8947 \begin_inset space ~
8951 Layout files from older \SpecialChar LyX
8952 versions do not have an explicit file format and
8953 are considered to have
8954 \begin_inset Flex Code
8957 \begin_layout Plain Layout
8959 \begin_inset space ~
8968 The format for the present version of \SpecialChar LyX
8970 But each version of \SpecialChar LyX
8971 is capable of reading earlier versions' layout files,
8972 just as they are capable of reading files produced by earlier versions
8975 There is, however, no provision for converting to earlier formats.
8978 \begin_layout Subsection
8979 \begin_inset CommandInset label
8981 name "subsec:General-text-class"
8985 General text class parameters
8988 \begin_layout Standard
8989 These are general parameters that govern the behavior of an entire document
8995 mean that they must appear in
8996 \begin_inset Flex Code
8999 \begin_layout Plain Layout
9005 files rather than in modules.
9006 A module can contain any layout tag.)
9009 \begin_layout Description
9011 \change_inserted -712698321 1526899478
9012 \begin_inset Flex Code
9015 \begin_layout Plain Layout
9017 \change_inserted -712698321 1526898610
9018 AddToCiteEngine <engine>
9025 Extends the possibilities for displaying citation references.
9027 \begin_inset CommandInset ref
9029 reference "subsec:Citation-engine-description"
9038 \begin_inset Flex Code
9041 \begin_layout Plain Layout
9043 \change_inserted -712698321 1526898823
9054 \begin_layout Description
9055 \begin_inset Flex Code
9058 \begin_layout Plain Layout
9064 Adds information that will be output in the
9065 \begin_inset Flex Code
9068 \begin_layout Plain Layout
9074 block when the document is output to XHTML.
9075 Typically, this would be used to output CSS style information, but it can
9076 be used for anything that can appear in
9077 \begin_inset Flex Code
9080 \begin_layout Plain Layout
9088 \begin_inset Quotes eld
9092 \begin_inset Flex Code
9095 \begin_layout Plain Layout
9102 \begin_inset Quotes erd
9108 \begin_layout Description
9109 \begin_inset Flex Code
9112 \begin_layout Plain Layout
9118 Adds information to the document preamble.
9120 \begin_inset Newline newline
9124 \begin_inset Quotes eld
9128 \begin_inset Flex Code
9131 \begin_layout Plain Layout
9138 \begin_inset Quotes erd
9142 \change_inserted -712698321 1562592950
9146 \begin_layout Description
9148 \change_inserted -712698321 1562593040
9149 \begin_inset Flex Code
9152 \begin_layout Plain Layout
9154 \change_inserted -712698321 1562592954
9163 \begin_inset Flex Code
9166 \begin_layout Plain Layout
9168 \change_inserted -712698321 1562592950
9179 \begin_inset space \thinspace{}
9183 \begin_inset Flex Code
9186 \begin_layout Plain Layout
9188 \change_inserted -712698321 1562592950
9196 ] If the document class adds the bibliography to the table of contents,
9197 add this option with value
9198 \begin_inset Flex Code
9201 \begin_layout Plain Layout
9203 \change_inserted -712698321 1562592996
9212 \begin_inset Flex Code
9215 \begin_layout Plain Layout
9217 \change_inserted -712698321 1562593006
9226 This prevents the bibliography from being added twice.
9231 \begin_layout Description
9232 \begin_inset Flex Code
9235 \begin_layout Plain Layout
9241 Defines the possibilities for displaying citation references.
9243 \begin_inset CommandInset ref
9245 reference "subsec:Citation-engine-description"
9254 \begin_inset Quotes eld
9258 \begin_inset Flex Code
9261 \begin_layout Plain Layout
9268 \begin_inset Quotes erd
9272 Primarily used in cite engine files (see
9273 \begin_inset CommandInset ref
9275 reference "subsec:Cite-Engine-Files"
9284 \change_inserted -712698321 1526898530
9285 Note that if you specify this in a layout file or module, any cite engine
9286 definition will be overridden.
9288 \begin_inset Flex Code
9291 \begin_layout Plain Layout
9293 \change_inserted -712698321 1526898530
9306 \begin_layout Description
9307 \begin_inset Flex Code
9310 \begin_layout Plain Layout
9316 Defines formats for use in the display of bibliographic information.
9318 \begin_inset CommandInset ref
9320 reference "subsec:Citation-format-description"
9326 \begin_inset Quotes eld
9330 \begin_inset Flex Code
9333 \begin_layout Plain Layout
9340 \begin_inset Quotes erd
9344 Primarily used in cite engine files (see
9345 \begin_inset CommandInset ref
9347 reference "subsec:Cite-Engine-Files"
9356 \change_inserted -712698321 1526898585
9357 A cite format defined in a layout or module will override the cite engine
9363 \begin_layout Description
9364 \begin_inset Flex Code
9367 \begin_layout Plain Layout
9374 \begin_inset Flex Code
9377 \begin_layout Plain Layout
9386 \begin_inset Flex Code
9389 \begin_layout Plain Layout
9395 ] Determines whether
9399 or Bib\SpecialChar TeX
9400 is used to generate a Bibliography.
9401 Primarily used in cite engine files (see
9402 \begin_inset CommandInset ref
9404 reference "subsec:Cite-Engine-Files"
9414 \begin_layout Description
9415 \begin_inset Flex Code
9418 \begin_layout Plain Layout
9424 Describes various global options supported by the document class.
9426 \begin_inset CommandInset ref
9428 reference "subsec:ClassOptions"
9434 \begin_inset Quotes eld
9438 \begin_inset Flex Code
9441 \begin_layout Plain Layout
9448 \begin_inset Quotes erd
9454 \begin_layout Description
9455 \begin_inset Flex Code
9458 \begin_layout Plain Layout
9465 \begin_inset Flex Code
9468 \begin_layout Plain Layout
9477 \begin_inset space \thinspace{}
9481 \begin_inset Flex Code
9484 \begin_layout Plain Layout
9490 ] Whether the class should
9494 to having one or two columns.
9495 Can be changed in the
9496 \begin_inset Flex Noun
9499 \begin_layout Plain Layout
9500 Document\SpecialChar menuseparator
9509 \begin_layout Description
9510 \begin_inset Flex Code
9513 \begin_layout Plain Layout
9520 \begin_inset Flex Code
9523 \begin_layout Plain Layout
9529 ] This sequence defines the properties for a counter.
9530 If the counter does not yet exist, it is created; if it does exist, it
9533 \begin_inset Quotes eld
9537 \begin_inset Flex Code
9540 \begin_layout Plain Layout
9547 \begin_inset Quotes erd
9551 \begin_inset Newline newline
9555 \begin_inset CommandInset ref
9557 reference "subsec:Counters"
9561 for details on counters.
9564 \begin_layout Description
9565 \begin_inset Flex Code
9568 \begin_layout Plain Layout
9574 Sets the default font used to display the document.
9576 \begin_inset CommandInset ref
9578 reference "subsec:Font-description"
9582 for how to declare fonts.
9584 \begin_inset Quotes eld
9588 \begin_inset Flex Code
9591 \begin_layout Plain Layout
9598 \begin_inset Quotes erd
9604 \begin_layout Description
9605 \begin_inset Flex Code
9608 \begin_layout Plain Layout
9615 \begin_inset Flex Code
9618 \begin_layout Plain Layout
9624 ] Specifies a module to be included by default with this document class.
9625 The module is specified as filename without the
9626 \begin_inset Flex Code
9629 \begin_layout Plain Layout
9636 The user can still remove the module, but it will be active at the outset.
9637 (This applies only when new files are created, or when this class is chosen
9638 for an existing document.)
9641 \begin_layout Description
9642 \begin_inset Flex Code
9645 \begin_layout Plain Layout
9652 \begin_inset Flex Code
9655 \begin_layout Plain Layout
9661 ] This is the style that will be assigned to new paragraphs, usually
9662 \begin_inset Flex Noun
9665 \begin_layout Plain Layout
9672 This will default to the first defined style if not given, but you are
9673 encouraged to use this directive.
9676 \begin_layout Description
9678 \change_inserted -970929547 1515112870
9679 \begin_inset Flex Code
9682 \begin_layout Plain Layout
9684 \change_inserted -970929547 1515112782
9693 \begin_inset Flex Code
9696 \begin_layout Plain Layout
9698 \change_inserted -970929547 1515112766
9706 ] The root element (at the top of the document) to use when outputting documents
9707 with this class in DocBook.
9708 The default value is
9709 \begin_inset Quotes eld
9713 \begin_inset Flex Code
9716 \begin_layout Plain Layout
9718 \change_inserted -970929547 1515112845
9727 \begin_inset Quotes erd
9732 \change_deleted 1075283030 1594226862
9734 \change_inserted 1075283030 1594226777
9738 \begin_layout Description
9740 \change_inserted 1075283030 1594226859
9741 \begin_inset Flex Code
9744 \begin_layout Plain Layout
9746 \change_inserted 1075283030 1594226785
9747 DocBookForceAbstract
9755 \begin_inset Flex Code
9758 \begin_layout Plain Layout
9760 \change_inserted 1075283030 1594226804
9769 \begin_inset Quotes eld
9777 \begin_inset Quotes erd
9780 , the root element will always have an
9785 The default value is
9786 \begin_inset Quotes eld
9794 \begin_inset Quotes erd
9802 \begin_layout Description
9803 \begin_inset Flex Code
9806 \begin_layout Plain Layout
9813 \begin_inset Flex Code
9816 \begin_layout Plain Layout
9822 ] This tag indicates that the module (which is specified by filename without
9824 \begin_inset Flex Code
9827 \begin_layout Plain Layout
9833 extension) cannot be used with this document class.
9834 This might be used in a journal-specific layout file to prevent, say, the
9836 \begin_inset Flex Code
9839 \begin_layout Plain Layout
9845 module that numbers theorems by section.
9850 be used in a module.
9851 Modules have their own way of excluding other modules (see
9852 \begin_inset CommandInset ref
9854 reference "subsec:Layout-modules"
9861 \begin_layout Description
9862 \begin_inset Flex Code
9865 \begin_layout Plain Layout
9871 Defines a new float.
9873 \begin_inset CommandInset ref
9875 reference "subsec:Floats"
9881 \begin_inset Quotes eld
9885 \begin_inset Flex Code
9888 \begin_layout Plain Layout
9895 \begin_inset Quotes erd
9901 \begin_layout Description
9902 \begin_inset Flex Code
9905 \begin_layout Plain Layout
9911 Sets the information that will be output in the
9912 \begin_inset Flex Code
9915 \begin_layout Plain Layout
9921 block when this document class is output to XHTML.
9922 Note that this will completely override any prior
9923 \begin_inset Flex Code
9926 \begin_layout Plain Layout
9933 \begin_inset Flex Code
9936 \begin_layout Plain Layout
9944 \begin_inset Newline newline
9948 \begin_inset Flex Code
9951 \begin_layout Plain Layout
9957 if you just want to add material to the preamble.) Must end with
9958 \begin_inset Quotes eld
9962 \begin_inset Flex Code
9965 \begin_layout Plain Layout
9972 \begin_inset Quotes erd
9978 \begin_layout Description
9979 \begin_inset Flex Code
9982 \begin_layout Plain Layout
9989 \begin_inset Flex Code
9992 \begin_layout Plain Layout
9998 ] The style to use for the table of contents, bibliography, and so forth,
9999 when the document is output to HTML.
10000 For articles, this should normally be
10001 \begin_inset Flex Code
10004 \begin_layout Plain Layout
10011 \begin_inset Flex Code
10014 \begin_layout Plain Layout
10021 If it is not given, then \SpecialChar LyX
10022 will attempt to figure out which layout to use.
10025 \begin_layout Description
10026 \begin_inset Flex Code
10029 \begin_layout Plain Layout
10036 \begin_inset Flex Code
10039 \begin_layout Plain Layout
10045 ] Modifies the properties of the given counter.
10046 If the counter does not exist, the statement is ignored.
10048 \begin_inset Quotes eld
10052 \begin_inset Flex Code
10055 \begin_layout Plain Layout
10062 \begin_inset Quotes erd
10066 \begin_inset Newline newline
10070 \begin_inset CommandInset ref
10072 reference "subsec:Counters"
10076 for details on counters.
10079 \begin_layout Description
10080 \begin_inset Flex Code
10083 \begin_layout Plain Layout
10090 \begin_inset Flex Code
10093 \begin_layout Plain Layout
10099 ] This allows you to include another layout definition file within yours
10100 to avoid duplicating commands.
10101 Common examples are the standard layout files, for example,
10102 \begin_inset Flex Code
10105 \begin_layout Plain Layout
10111 , which contains most of the basic layouts.
10114 \begin_layout Description
10115 \begin_inset Flex Code
10118 \begin_layout Plain Layout
10125 \begin_inset Flex Code
10128 \begin_layout Plain Layout
10134 ] This section (re-)defines the layout of an inset.
10135 It can be applied to an existing inset or to a new, user-defined inset,
10136 e.g., a new character style.
10138 \begin_inset Quotes eld
10142 \begin_inset Flex Code
10145 \begin_layout Plain Layout
10152 \begin_inset Quotes erd
10156 \begin_inset Newline newline
10160 \begin_inset CommandInset ref
10162 reference "subsec:Flex-insets-and"
10166 for more information.
10170 \begin_layout Description
10171 \begin_inset Flex Code
10174 \begin_layout Plain Layout
10181 \begin_inset Flex Code
10184 \begin_layout Plain Layout
10190 ] A string that indicates the width of the left margin on the screen, for
10192 \begin_inset Quotes eld
10196 \begin_inset Flex Code
10199 \begin_layout Plain Layout
10206 \begin_inset Quotes erd
10210 (Note that this is not a `length', like
10211 \begin_inset Quotes eld
10215 \begin_inset Quotes erd
10221 \begin_layout Description
10222 \begin_inset Flex Code
10225 \begin_layout Plain Layout
10232 \begin_inset Flex Code
10235 \begin_layout Plain Layout
10241 ] An integer that determines the maximal number of names displayed in an
10242 author-year citation before the citation switches to
10243 \begin_inset Quotes eld
10247 \begin_inset Quotes erd
10251 Primarily used in cite engine files (see
10252 \begin_inset CommandInset ref
10254 reference "subsec:Cite-Engine-Files"
10264 \begin_layout Description
10265 \begin_inset Flex Code
10268 \begin_layout Plain Layout
10275 \begin_inset Flex Code
10278 \begin_layout Plain Layout
10284 ] Modifies the properties of the given paragraph style.
10285 If the style does not exist, this section is ignored.
10287 \begin_inset Quotes eld
10291 \begin_inset Flex Code
10294 \begin_layout Plain Layout
10301 \begin_inset Quotes erd
10307 \begin_layout Description
10308 \begin_inset Flex Code
10311 \begin_layout Plain Layout
10318 \begin_inset Flex Code
10321 \begin_layout Plain Layout
10327 ] Deletes an existing counter, usually one defined in an included file.
10330 \begin_layout Description
10331 \begin_inset Flex Code
10334 \begin_layout Plain Layout
10341 \begin_inset Flex Code
10344 \begin_layout Plain Layout
10350 ] Deletes an existing float.
10351 This is particularly useful when you want to suppress a float that has
10352 been defined in an input file.
10355 \begin_layout Description
10356 \begin_inset Flex Code
10359 \begin_layout Plain Layout
10366 \begin_inset Flex Code
10369 \begin_layout Plain Layout
10375 ] Deletes an existing style.
10378 \begin_layout Description
10379 \begin_inset Flex Code
10382 \begin_layout Plain Layout
10389 \begin_inset Flex Code
10392 \begin_layout Plain Layout
10399 \begin_inset Flex Code
10402 \begin_layout Plain Layout
10408 ] Define a new table of contents with type
10409 \begin_inset Flex Code
10412 \begin_layout Plain Layout
10419 \begin_inset Flex Code
10422 \begin_layout Plain Layout
10429 See also the AddToToc commands.
10432 \begin_layout Description
10433 \begin_inset Flex Code
10436 \begin_layout Plain Layout
10443 \begin_inset Flex Code
10446 \begin_layout Plain Layout
10452 ] The file format (as defined in the \SpecialChar LyX
10453 preferences) produced by this document
10455 It is mainly useful when
10456 \begin_inset Flex Code
10459 \begin_layout Plain Layout
10466 \begin_inset Flex Code
10469 \begin_layout Plain Layout
10475 and one wants to define a new type of literate document.
10476 The format is reset to
10477 \change_deleted 5863208 1594239413
10479 \begin_inset Quotes eld
10483 \begin_inset Flex Code
10486 \begin_layout Plain Layout
10493 \begin_inset Quotes erd
10499 \begin_inset Quotes eld
10503 \begin_inset Flex Code
10506 \begin_layout Plain Layout
10513 \begin_inset Quotes erd
10516 when the corresponding
10517 \begin_inset Flex Code
10520 \begin_layout Plain Layout
10526 parameter is encountered.
10529 \begin_layout Description
10530 \begin_inset Flex Code
10533 \begin_layout Plain Layout
10540 \begin_inset Flex Code
10543 \begin_layout Plain Layout
10554 \change_deleted 5863208 1594239430
10556 \begin_inset Flex Code
10559 \begin_layout Plain Layout
10568 \begin_inset Flex Code
10571 \begin_layout Plain Layout
10577 ] Specifies what sort of output documents using this class will produce.
10580 \begin_layout Description
10581 \begin_inset Flex Code
10584 \begin_layout Plain Layout
10591 \begin_inset Flex Code
10594 \begin_layout Plain Layout
10601 \begin_inset Flex Code
10604 \begin_layout Plain Layout
10610 ] Specifies options, given in the second string, for the package named by
10613 \begin_inset Quotes eld
10617 \begin_inset Flex Code
10620 \begin_layout Plain Layout
10621 PackageOptions natbib square
10627 \begin_inset Quotes erd
10631 \begin_inset Flex Code
10634 \begin_layout Plain Layout
10640 to be loaded with the
10641 \begin_inset Flex Code
10644 \begin_layout Plain Layout
10651 (For \SpecialChar TeX
10652 perts, this causes \SpecialChar LyX
10654 \begin_inset Flex Code
10657 \begin_layout Plain Layout
10660 PassOptionsToPackage{natbib}{square}
10666 \begin_inset Flex Code
10669 \begin_layout Plain Layout
10676 \change_inserted -712698321 1565102364
10680 \begin_layout Description
10682 \change_inserted -712698321 1565102470
10683 \begin_inset Flex Code
10686 \begin_layout Plain Layout
10688 \change_inserted -712698321 1565102365
10697 \begin_inset Flex Code
10700 \begin_layout Plain Layout
10702 \change_inserted -712698321 1565105222
10707 , letter, legal, executive, a0, a1, a2, a3, a4, a5, a6, b0, b1, b2, b3,
10708 b4, b5, b6, c0, c1, c2, c3, c4, c5, c6, b0j, b1j, b2j, b3j, b4j, b5j, b6j
10715 ] The default page size.
10716 This is used by some converters.
10721 \begin_layout Description
10722 \begin_inset Flex Code
10725 \begin_layout Plain Layout
10732 \begin_inset Flex Code
10735 \begin_layout Plain Layout
10744 \begin_inset Flex Code
10747 \begin_layout Plain Layout
10754 \begin_inset Flex Code
10757 \begin_layout Plain Layout
10763 ] The default pagestyle.
10764 Can be changed in the
10765 \begin_inset Flex Noun
10768 \begin_layout Plain Layout
10769 Document\SpecialChar menuseparator
10778 \begin_layout Description
10779 \begin_inset Flex Code
10782 \begin_layout Plain Layout
10788 Sets the preamble for the \SpecialChar LaTeX
10790 Note that this will completely override any prior
10791 \begin_inset Flex Code
10794 \begin_layout Plain Layout
10801 \begin_inset Flex Code
10804 \begin_layout Plain Layout
10812 \begin_inset Flex Code
10815 \begin_layout Plain Layout
10821 if you just want to add material to the preamble.) Must end with
10822 \begin_inset Quotes eld
10826 \begin_inset Flex Code
10829 \begin_layout Plain Layout
10836 \begin_inset Quotes erd
10842 \begin_layout Description
10843 \begin_inset Flex Code
10846 \begin_layout Plain Layout
10853 \begin_inset Flex Code
10856 \begin_layout Plain Layout
10863 \begin_inset Flex Code
10866 \begin_layout Plain Layout
10875 \begin_inset space \thinspace{}
10879 \begin_inset Flex Code
10882 \begin_layout Plain Layout
10888 ] Whether the class already provides the feature
10889 \begin_inset Flex Code
10892 \begin_layout Plain Layout
10899 A feature is in general the name of a package (e.
10900 \begin_inset space \thinspace{}
10904 \begin_inset space \space{}
10908 \begin_inset Flex Code
10911 \begin_layout Plain Layout
10918 \begin_inset Flex Code
10921 \begin_layout Plain Layout
10928 \begin_inset space \thinspace{}
10932 \begin_inset space \space{}
10936 \begin_inset Flex Code
10939 \begin_layout Plain Layout
10946 \begin_inset Flex Code
10949 \begin_layout Plain Layout
10957 \begin_inset CommandInset ref
10959 reference "chap:List-of-functions"
10963 for the list of features.
10966 \begin_layout Description
10967 \begin_inset Flex Code
10970 \begin_layout Plain Layout
10977 \begin_inset Flex Code
10980 \begin_layout Plain Layout
10986 ] Indicates that this layout provides the functionality of the module mentioned,
10987 which should be specified by the filename without the
10988 \begin_inset Flex Code
10991 \begin_layout Plain Layout
10998 This will typically be used if the layout includes the module directly,
10999 rather than using the
11000 \begin_inset Flex Code
11003 \begin_layout Plain Layout
11009 tag to indicate that it ought to be used.
11010 It could also be used in a module that provided an alternate implementation
11011 of the same functionality.
11014 \begin_layout Description
11015 \begin_inset Flex Code
11018 \begin_layout Plain Layout
11025 \begin_inset Flex Code
11028 \begin_layout Plain Layout
11034 ] Creates a new paragraph style if it does not already exist.
11035 If the style does exist, this section is ignored.
11037 \begin_inset Quotes eld
11041 \begin_inset Flex Code
11044 \begin_layout Plain Layout
11051 \begin_inset Quotes erd
11057 \begin_layout Description
11058 \begin_inset Flex Code
11061 \begin_layout Plain Layout
11068 \begin_inset Flex Code
11071 \begin_layout Plain Layout
11077 ] Whether the class requires the feature
11078 \begin_inset Flex Code
11081 \begin_layout Plain Layout
11088 Multiple features must be separated by commas.
11089 Note that you can only request supported features.
11091 \begin_inset CommandInset ref
11093 reference "chap:List-of-functions"
11097 for the list of features.).
11098 If you require a package with specific options, you can additionally use
11100 \begin_inset Flex Code
11103 \begin_layout Plain Layout
11112 \begin_layout Description
11113 \begin_inset Flex Code
11116 \begin_layout Plain Layout
11123 \begin_inset Flex Code
11126 \begin_layout Plain Layout
11132 ] A string that indicates the width of the right margin on the screen, for
11134 \begin_inset Quotes eld
11138 \begin_inset Flex Code
11141 \begin_layout Plain Layout
11148 \begin_inset Quotes erd
11154 \begin_layout Description
11155 \begin_inset Flex Code
11158 \begin_layout Plain Layout
11165 \begin_inset Flex Code
11168 \begin_layout Plain Layout
11174 ] Sets which divisions get numbered.
11176 \begin_inset Newline newline
11180 \begin_inset Flex Code
11183 \begin_layout Plain Layout
11189 counter in \SpecialChar LaTeX
11193 \begin_layout Description
11194 \begin_inset Flex Code
11197 \begin_layout Plain Layout
11204 \begin_inset Flex Code
11207 \begin_layout Plain Layout
11216 \begin_inset space \thinspace{}
11220 \begin_inset Flex Code
11223 \begin_layout Plain Layout
11229 ] Whether the class-default should be printing on one or both sides of the
11231 Can be changed in the
11232 \begin_inset Flex Noun
11235 \begin_layout Plain Layout
11236 Document\SpecialChar menuseparator
11245 \begin_layout Description
11246 \begin_inset Flex Code
11249 \begin_layout Plain Layout
11256 \begin_inset Flex Code
11259 \begin_layout Plain Layout
11265 ] This sequence defines a paragraph style.
11266 If the style does not yet exist, it is created; if it does exist, its parameter
11269 \begin_inset Quotes eld
11273 \begin_inset Flex Code
11276 \begin_layout Plain Layout
11283 \begin_inset Quotes erd
11287 \begin_inset Newline newline
11291 \begin_inset CommandInset ref
11293 reference "subsec:Paragraph-Styles"
11297 for details on paragraph styles.
11298 \change_inserted -712698321 1553617804
11302 \begin_layout Description
11304 \change_inserted -712698321 1553617862
11305 \begin_inset Flex Code
11308 \begin_layout Plain Layout
11310 \change_inserted -712698321 1553617809
11319 \begin_inset Flex Code
11322 \begin_layout Plain Layout
11324 \change_inserted -712698321 1553617805
11332 ] defines the default table style that is used when inserting a table.
11333 The following styles are available:
11337 \begin_layout Itemize
11339 \change_inserted -712698321 1554308039
11340 \begin_inset Flex Code
11343 \begin_layout Plain Layout
11345 \change_inserted -712698321 1554307928
11346 Formal_with_Footline
11354 \begin_inset Quotes eld
11358 \begin_inset Quotes erd
11361 ) style with horizontal lines only, using a bold top and bottom line, the
11362 first and last row are additionally separated from the table body with
11363 a thin middle line.
11366 \begin_layout Itemize
11368 \change_inserted -712698321 1554308087
11369 \begin_inset Flex Code
11372 \begin_layout Plain Layout
11374 \change_inserted -712698321 1554308042
11375 Formal_without_Footline
11382 : same as the above, but the last row is not separated with a middle line
11386 \begin_layout Itemize
11388 \change_inserted -712698321 1553618031
11389 \begin_inset Flex Code
11392 \begin_layout Plain Layout
11394 \change_inserted -712698321 1553618006
11402 : Simple table lines.
11405 \begin_layout Itemize
11407 \change_inserted -712698321 1553618309
11408 \begin_inset Flex Code
11411 \begin_layout Plain Layout
11413 \change_inserted -712698321 1553618031
11422 \begin_inset Flex Code
11425 \begin_layout Plain Layout
11427 \change_inserted -712698321 1553618043
11435 , but with the header column offset with a second horizontal line.
11436 This is also the default style of \SpecialChar LyX
11440 \begin_layout Itemize
11442 \change_inserted -712698321 1553618280
11443 \begin_inset Flex Code
11446 \begin_layout Plain Layout
11448 \change_inserted -712698321 1553618261
11456 : Table without lines.
11462 \begin_layout Description
11463 \begin_inset Flex Code
11466 \begin_layout Plain Layout
11473 \begin_inset Flex Code
11476 \begin_layout Plain Layout
11482 ] The name of the command or environment to be used with
11483 \begin_inset Flex Code
11486 \begin_layout Plain Layout
11495 \begin_layout Description
11496 \begin_inset Flex Code
11499 \begin_layout Plain Layout
11506 \begin_inset Flex Code
11509 \begin_layout Plain Layout
11518 \begin_inset Flex Code
11521 \begin_layout Plain Layout
11527 ] Indicates what kind of markup is used to define the title of a document.
11529 \begin_inset Flex Code
11532 \begin_layout Plain Layout
11538 means that the macro with name
11539 \begin_inset Flex Code
11542 \begin_layout Plain Layout
11548 will be inserted after the last layout which has
11549 \begin_inset Quotes eld
11553 \begin_inset Flex Code
11556 \begin_layout Plain Layout
11558 \begin_inset space ~
11567 \begin_inset Quotes erd
11572 \begin_inset Flex Code
11575 \begin_layout Plain Layout
11581 corresponds to the case where all layouts which have
11582 \begin_inset Quotes eld
11586 \begin_inset Flex Code
11589 \begin_layout Plain Layout
11591 \begin_inset space ~
11600 \begin_inset Quotes erd
11603 should be enclosed into the
11604 \begin_inset Flex Code
11607 \begin_layout Plain Layout
11616 \begin_layout Description
11617 \begin_inset Flex Code
11620 \begin_layout Plain Layout
11627 \begin_inset Flex Code
11630 \begin_layout Plain Layout
11636 ] Sets which divisions are included in the table of contents.
11638 \begin_inset Flex Code
11641 \begin_layout Plain Layout
11647 counter in \SpecialChar LaTeX
11651 \begin_layout Subsection
11652 \begin_inset Flex Code
11655 \begin_layout Plain Layout
11662 \begin_inset CommandInset label
11664 name "subsec:ClassOptions"
11671 \begin_layout Standard
11673 \begin_inset Flex Code
11676 \begin_layout Plain Layout
11682 section can contain the following entries:
11685 \begin_layout Description
11686 \begin_inset Flex Code
11689 \begin_layout Plain Layout
11696 \begin_inset Flex Code
11699 \begin_layout Plain Layout
11705 ] The list of available font sizes for the document's main font, separated
11707 \begin_inset Quotes eld
11711 \begin_inset Flex Code
11714 \begin_layout Plain Layout
11721 \begin_inset Quotes erd
11726 \change_inserted -712698321 1565110196
11727 Any number is possible.
11730 \begin_layout Description
11732 \change_inserted -712698321 1565110259
11733 \begin_inset Flex Code
11736 \begin_layout Plain Layout
11738 \change_inserted -712698321 1565110199
11747 \begin_inset Flex Code
11750 \begin_layout Plain Layout
11752 \change_inserted -712698321 1565110196
11760 ] The format for the font size option.
11762 \begin_inset Flex Code
11765 \begin_layout Plain Layout
11767 \change_inserted -712698321 1565110238
11777 \begin_inset Flex Code
11780 \begin_layout Plain Layout
11782 \change_inserted -712698321 1565110248
11790 is a placeholder for the font size.
11795 \begin_layout Description
11797 \change_deleted 5863208 1594239483
11798 \begin_inset Flex Code
11801 \begin_layout Plain Layout
11807 Used to set the DTD line with XML-based output classes.
11809 \begin_inset space \thinspace{}
11813 \begin_inset Quotes eld
11816 -//OASIS//DTD DocBook V4.2//EN
11817 \begin_inset Quotes erd
11821 \change_inserted -712698321 1565101761
11825 \begin_layout Description
11827 \change_inserted -712698321 1565180598
11828 \begin_inset Flex Code
11831 \begin_layout Plain Layout
11833 \change_inserted -712698321 1565101918
11842 \begin_inset Flex Code
11845 \begin_layout Plain Layout
11847 \change_inserted -712698321 1565105399
11848 string="letter|\SpecialChar allowbreak
11849 legal|\SpecialChar allowbreak
11850 executive|\SpecialChar allowbreak
11851 a0|\SpecialChar allowbreak
11852 a1|\SpecialChar allowbreak
11853 a2|\SpecialChar allowbreak
11854 a3|\SpecialChar allowbreak
11855 a4|\SpecialChar allowbreak
11856 a5|\SpecialChar allowbreak
11857 a6|\SpecialChar allowbreak
11858 b0|\SpecialChar allowbreak
11859 b1|\SpecialChar allowbreak
11860 b2|\SpecialChar allowbreak
11861 b3|\SpecialChar allowbreak
11862 b4|\SpecialChar allowbreak
11863 b5|\SpecialChar allowbreak
11864 b6|\SpecialChar allowbreak
11865 c0|\SpecialChar allowbreak
11866 c1|\SpecialChar allowbreak
11868 2|\SpecialChar allowbreak
11869 c3|\SpecialChar allowbreak
11870 c4|\SpecialChar allowbreak
11871 c5|\SpecialChar allowbreak
11872 c6|\SpecialChar allowbreak
11873 b0j|\SpecialChar allowbreak
11874 b1j|\SpecialChar allowbreak
11875 b2j|\SpecialChar allowbreak
11876 b3j|\SpecialChar allowbreak
11877 b4j|\SpecialChar allowbreak
11878 b5j|\SpecialChar allowbreak
11886 ] The list of available page sizes, separated by
11887 \begin_inset Quotes eld
11891 \begin_inset Flex Code
11894 \begin_layout Plain Layout
11896 \change_inserted -712698321 1565101779
11905 \begin_inset Quotes erd
11909 Currently, only the listed sizes are supported.
11910 Other sizes might be entered as custom class option.
11913 \begin_layout Description
11915 \change_inserted -712698321 1565180623
11916 \begin_inset Flex Code
11919 \begin_layout Plain Layout
11921 \change_inserted -712698321 1565180605
11930 \begin_inset Flex Code
11933 \begin_layout Plain Layout
11935 \change_inserted -712698321 1565180601
11943 ] The format for the page size option.
11945 \begin_inset Flex Code
11948 \begin_layout Plain Layout
11950 \change_inserted -712698321 1565180618
11960 \begin_inset Flex Code
11963 \begin_layout Plain Layout
11965 \change_inserted -712698321 1565180601
11973 is a placeholder for the paper size.
11978 \begin_layout Description
11979 \begin_inset Flex Code
11982 \begin_layout Plain Layout
11989 \begin_inset Flex Code
11992 \begin_layout Plain Layout
11993 string="empty|plain|headings|fancy"
11998 ] The list of available page sty\SpecialChar softhyphen
12000 \begin_inset Quotes eld
12004 \begin_inset Flex Code
12007 \begin_layout Plain Layout
12014 \begin_inset Quotes erd
12020 \begin_layout Description
12021 \begin_inset Flex Code
12024 \begin_layout Plain Layout
12031 \begin_inset Flex Code
12034 \begin_layout Plain Layout
12040 ] Some document class options, separated by a comma, that will be added
12041 to the optional part of the
12042 \begin_inset Flex Code
12045 \begin_layout Plain Layout
12056 \begin_layout Standard
12058 \begin_inset Flex Code
12061 \begin_layout Plain Layout
12067 section must end with
12068 \begin_inset Quotes eld
12072 \begin_inset Flex Code
12075 \begin_layout Plain Layout
12082 \begin_inset Quotes erd
12088 \begin_layout Subsection
12090 \begin_inset CommandInset label
12092 name "subsec:Paragraph-Styles"
12099 \begin_layout Standard
12100 A paragraph style description looks like this:
12104 \begin_layout Plain Layout
12105 Note that this will either define a new style or modify an existing one.
12113 \begin_layout LyX-Code
12120 \begin_layout LyX-Code
12124 \begin_layout LyX-Code
12128 \begin_layout Standard
12129 where the following commands are allowed:
12132 \begin_layout Description
12133 \begin_inset Flex Code
12136 \begin_layout Plain Layout
12143 \begin_inset Flex Code
12146 \begin_layout Plain Layout
12152 =""] This paragraph will appear in the table of contents of the given type.
12153 An empty string disables.
12154 See also the OutlinerName and the IsTocCaption commands.
12158 \begin_layout Description
12159 \begin_inset Flex Code
12162 \begin_layout Plain Layout
12169 \begin_inset Flex Code
12172 \begin_layout Plain Layout
12177 , left, right, center
12182 ] Paragraph alignment.
12185 \begin_layout Description
12186 \begin_inset Flex Code
12189 \begin_layout Plain Layout
12196 \begin_inset Flex Code
12199 \begin_layout Plain Layout
12204 , left, right, center
12209 ] A comma separated list of permitted alignments.
12210 (Some \SpecialChar LaTeX
12211 styles prohibit certain alignments, since those wouldn't make sense.
12212 For example a right-aligned or centered enumeration isn't possible.)
12215 \begin_layout Description
12216 \begin_inset Flex Code
12219 \begin_layout Plain Layout
12226 \begin_inset Flex Code
12229 \begin_layout Plain Layout
12235 ] Defines argument number <int> of a command\SpecialChar breakableslash
12236 environment associated with
12238 This is useful for things like section headings, and only makes sense with
12241 Every (optional or required) argument of a command or environment – except
12242 for the required argument that is associated with the content of the paragraph
12243 itself – has a separate definition, where the number specifies the order
12245 The definition must end with
12246 \begin_inset Flex Code
12249 \begin_layout Plain Layout
12256 So a command with two optional arguments has:
12260 \begin_layout Quote
12266 \begin_layout Quote
12272 \begin_layout Quote
12278 \begin_layout Quote
12284 \begin_layout Quote
12290 \begin_layout Quote
12296 \begin_layout Standard
12298 \begin_inset Flex Code
12301 \begin_layout Plain Layout
12307 definition, the following specifications are possible:
12310 \begin_layout Itemize
12311 \begin_inset Flex Code
12314 \begin_layout Plain Layout
12321 \begin_inset Flex Code
12324 \begin_layout Plain Layout
12330 The string that will appear both in the menu (to insert this argument)
12331 and on the argument inset button (unless you also specify a separate
12332 \begin_inset Flex Code
12335 \begin_layout Plain Layout
12342 For the menu, you can define an accelerator by appending the respective
12343 character to the string, divided by
12344 \begin_inset Quotes eld
12348 \begin_inset Quotes erd
12352 \begin_inset space \thinspace{}
12356 \begin_inset space \space{}
12360 \begin_inset Quotes eld
12364 \begin_inset Flex Code
12367 \begin_layout Plain Layout
12374 \begin_inset Quotes erd
12380 \begin_layout Itemize
12381 \begin_inset Flex Code
12384 \begin_layout Plain Layout
12391 \begin_inset Flex Code
12394 \begin_layout Plain Layout
12400 A separate string for the menu.
12401 You can define an accelerator by appending the respective character to
12402 the string, divided by
12403 \begin_inset Quotes eld
12407 \begin_inset Quotes erd
12411 \begin_inset space \thinspace{}
12415 \begin_inset space \space{}
12419 \begin_inset Quotes eld
12423 \begin_inset Flex Code
12426 \begin_layout Plain Layout
12433 \begin_inset Quotes erd
12437 This specification is optional.
12438 If it is not given the
12439 \begin_inset Flex Code
12442 \begin_layout Plain Layout
12448 will be used instead for the menu.
12451 \begin_layout Itemize
12452 \begin_inset Flex Code
12455 \begin_layout Plain Layout
12462 \begin_inset Flex Code
12465 \begin_layout Plain Layout
12471 A longer explanatory text that appears in the tooltip when hovering over
12472 the argument inset.
12475 \begin_layout Itemize
12476 \begin_inset Flex Code
12479 \begin_layout Plain Layout
12486 \begin_inset Flex Code
12489 \begin_layout Plain Layout
12498 \begin_inset space \thinspace{}
12502 \begin_inset Flex Code
12505 \begin_layout Plain Layout
12511 ] Declare if this is a mandatory (1) or an optional (0) argument.
12512 Mandatory arguments will be output empty if not given, while optional arguments
12513 will not be output at all.
12514 By default, mandatory arguments are delimited by
12515 \begin_inset Flex Code
12518 \begin_layout Plain Layout
12524 , while optional arguments are delimited by
12525 \begin_inset Flex Code
12528 \begin_layout Plain Layout
12535 \change_inserted -712698321 1555579782
12539 \begin_layout Itemize
12541 \change_inserted -712698321 1555579780
12542 \begin_inset Flex Code
12545 \begin_layout Plain Layout
12547 \change_inserted -712698321 1555579780
12556 \begin_inset Flex Code
12559 \begin_layout Plain Layout
12561 \change_inserted -712698321 1555579780
12569 Option to define a different command (from the default
12570 \begin_inset Flex Code
12573 \begin_layout Plain Layout
12575 \change_inserted -712698321 1555579780
12587 ) to be used for line breaks.
12588 The initial backslash must not be specified.
12593 \begin_layout Itemize
12594 \begin_inset Flex Code
12597 \begin_layout Plain Layout
12604 \begin_inset Flex Code
12607 \begin_layout Plain Layout
12613 defines another argument (by its number) which this argument requires to
12614 be output if it is itself output.
12616 \begin_inset space \thinspace{}
12619 g., in \SpecialChar LaTeX
12620 commands, optional arguments often require previous optional arguments
12621 to be output (at least empty), as in
12622 \begin_inset Flex Code
12625 \begin_layout Plain Layout
12628 command[][argument]{text}
12634 This can be achieved by the statement
12635 \begin_inset Flex Code
12638 \begin_layout Plain Layout
12645 \begin_inset Flex Code
12648 \begin_layout Plain Layout
12657 \begin_layout Itemize
12658 \begin_inset Flex Code
12661 \begin_layout Plain Layout
12668 \begin_inset Flex Code
12671 \begin_layout Plain Layout
12677 defines a custom left delimiter (instead of
12678 \begin_inset Flex Code
12681 \begin_layout Plain Layout
12688 \begin_inset Flex Code
12691 \begin_layout Plain Layout
12698 A line break in the output can be indicated by
12699 \begin_inset Flex Code
12702 \begin_layout Plain Layout
12711 \begin_layout Itemize
12712 \begin_inset Flex Code
12715 \begin_layout Plain Layout
12722 \begin_inset Flex Code
12725 \begin_layout Plain Layout
12731 defines a custom right delimiter (instead of
12732 \begin_inset Flex Code
12735 \begin_layout Plain Layout
12742 \begin_inset Flex Code
12745 \begin_layout Plain Layout
12752 A line break in the output can be indicated by
12753 \begin_inset Flex Code
12756 \begin_layout Plain Layout
12765 \begin_layout Itemize
12766 \begin_inset Flex Code
12769 \begin_layout Plain Layout
12776 \begin_inset Flex Code
12779 \begin_layout Plain Layout
12785 defines an argument that is inserted if and only if no user-specified arguments
12787 \begin_inset space \thinspace{}
12791 \begin_inset space \space{}
12794 if no argument inset has been inserted (note that also an empty argument
12795 inset omits the DefaultArg).
12796 Multiple arguments need to be separated by comma.
12799 \begin_layout Itemize
12800 \begin_inset Flex Code
12803 \begin_layout Plain Layout
12810 \begin_inset Flex Code
12813 \begin_layout Plain Layout
12819 defines an argument that is inserted in any case (alone or in addition
12820 to user-specified arguments).
12821 Multiple arguments need to be separated by comma.
12824 \begin_layout Itemize
12825 \begin_inset Flex Code
12828 \begin_layout Plain Layout
12834 The font used for the argument content, see
12835 \begin_inset CommandInset ref
12837 reference "subsec:Font-description"
12842 \change_inserted -712698321 1559484228
12846 \begin_layout Itemize
12848 \change_inserted -712698321 1559484228
12849 \begin_inset Flex Code
12852 \begin_layout Plain Layout
12854 \change_inserted -712698321 1559484228
12863 \begin_inset Flex Code
12866 \begin_layout Plain Layout
12868 \change_inserted -712698321 1559484228
12879 \begin_inset space \thinspace{}
12883 \begin_inset Flex Code
12886 \begin_layout Plain Layout
12888 \change_inserted -712698321 1559484228
12896 ] As with paragraph styles, see
12897 \begin_inset CommandInset ref
12899 reference "subsec:Paragraph-Styles"
12908 \begin_layout Itemize
12909 \begin_inset Flex Code
12912 \begin_layout Plain Layout
12918 The font used for the label; see
12919 \begin_inset CommandInset ref
12921 reference "subsec:Font-description"
12928 \begin_layout Itemize
12929 \begin_inset Flex Code
12932 \begin_layout Plain Layout
12939 \begin_inset Flex Code
12942 \begin_layout Plain Layout
12947 , Minimalistic, Conglomerate
12952 ] describes the rendering style used for the inset's frame and buttons.
12955 \begin_layout Itemize
12956 \begin_inset Flex Code
12959 \begin_layout Plain Layout
12966 \begin_inset Flex Code
12969 \begin_layout Plain Layout
12976 \begin_inset Flex Code
12979 \begin_layout Plain Layout
12985 , this argument is automatically inserted when the respective style is selected.
12987 \change_deleted -712698321 1559484200
12988 Currently, only one argument per style\SpecialChar breakableslash
12989 layout can be automatically inserted.
12994 \begin_layout Itemize
12996 \change_inserted -712698321 1559491402
12997 \begin_inset Flex Code
13000 \begin_layout Plain Layout
13002 \change_inserted -712698321 1559490711
13011 \begin_inset Flex Code
13014 \begin_layout Plain Layout
13016 \change_inserted -712698321 1559490703
13025 \begin_inset Flex Code
13028 \begin_layout Plain Layout
13030 \change_inserted -712698321 1559490703
13038 , this argument will be inserted on a new line with
13039 \begin_inset Flex Code
13042 \begin_layout Plain Layout
13044 \change_inserted -712698321 1559491402
13052 (only available within Flex insets).
13055 \begin_layout Itemize
13056 \begin_inset Flex Code
13059 \begin_layout Plain Layout
13066 \begin_inset Flex Code
13069 \begin_layout Plain Layout
13076 \begin_inset Flex Code
13079 \begin_layout Plain Layout
13085 , this argument will be inserted with a copy of the co-text (either selected
13086 text or the whole paragraph) as content.
13089 \begin_layout Itemize
13090 \begin_inset Flex Code
13093 \begin_layout Plain Layout
13100 \begin_inset Flex Code
13103 \begin_layout Plain Layout
13113 ] Whether the contents of this argument should be output in raw form, meaning
13114 without special translations that \SpecialChar LaTeX
13117 \begin_inset Flex Code
13120 \begin_layout Plain Layout
13126 status is inherited by the inset or paragraph layout the argument belongs
13127 to, true and false change the status for the given argument only.
13130 \begin_layout Itemize
13131 \begin_inset Flex Code
13134 \begin_layout Plain Layout
13141 \begin_inset Flex Code
13144 \begin_layout Plain Layout
13145 string of characters
13154 Defines individual characters
13155 \begin_inset Newline linebreak
13158 that should be output in raw form, meaning without special translations
13159 that \SpecialChar LaTeX
13161 Note that, contrary to PassThru, this needs to be explicitly defined for
13163 That is, arguments do not inherit PassThruChars from their parent inset
13167 \begin_layout Itemize
13168 \begin_inset Flex Code
13171 \begin_layout Plain Layout
13178 \begin_inset Flex Code
13181 \begin_layout Plain Layout
13190 \begin_inset space \thinspace{}
13194 \begin_inset Flex Code
13197 \begin_layout Plain Layout
13203 ] If this is set to 1, the argument will output its content in the corresponding
13204 item in the table of contents.
13208 \begin_layout Standard
13209 By default, the text entered in the \SpecialChar LyX
13210 workarea in the respective layout is
13211 the last (mandatory) argument of a command if the
13212 \begin_inset Flex Code
13215 \begin_layout Plain Layout
13222 \begin_inset Flex Code
13225 \begin_layout Plain Layout
13232 However, arguments with the prefix
13233 \begin_inset Flex Code
13236 \begin_layout Plain Layout
13242 are output after this workarea argument.
13243 Note that post-argument numbering restarts at 1, so the first argument
13244 following the workarea argument is
13245 \begin_inset Flex Code
13248 \begin_layout Plain Layout
13255 Post-arguments are ignored in any other
13256 \begin_inset Flex Code
13259 \begin_layout Plain Layout
13266 \begin_inset Flex Code
13269 \begin_layout Plain Layout
13278 \begin_layout Standard
13280 \begin_inset Flex Code
13283 \begin_layout Plain Layout
13292 \begin_inset Flex Code
13295 \begin_layout Plain Layout
13304 \begin_inset Flex Code
13307 \begin_layout Plain Layout
13313 followed by the number (e.
13314 \begin_inset space \thinspace{}
13318 \begin_inset space \space{}
13322 \begin_inset Flex Code
13325 \begin_layout Plain Layout
13332 \change_inserted -712698321 1534487781
13336 \begin_layout Standard
13338 \change_inserted -712698321 1534488561
13339 Finally, there is a special argument type with the prefix
13340 \begin_inset Flex Code
13343 \begin_layout Plain Layout
13345 \change_inserted -712698321 1534487844
13354 It is not really an argument, but uses the argument interface (thus, the
13355 prefix is also followed by a number, e.
13356 \begin_inset space \thinspace{}
13361 \begin_inset Flex Code
13364 \begin_layout Plain Layout
13366 \change_inserted -712698321 1534488412
13367 Argument listpreamble:1
13375 As the name implies, it is targeted at lists such as
13392 Its content will be output at the list start, before the first
13393 \begin_inset Flex Code
13396 \begin_layout Plain Layout
13398 \change_inserted -712698321 1534488058
13408 , on an own line (a place that is otherwise not accessible in \SpecialChar LyX
13410 This way, users can insert redefinitions (of lengths etc.) to individual
13412 By default, these arguments do not have a delimiter.
13418 \begin_layout Description
13419 \begin_inset Flex Code
13422 \begin_layout Plain Layout
13428 Includes a comma-separated list of layouts that should be nested in and
13429 after the current layout.
13430 Only makes sense for nestable layouts (such as environments).
13432 \begin_inset Quotes eld
13436 \begin_inset Flex Code
13439 \begin_layout Plain Layout
13446 \begin_inset Quotes erd
13451 \begin_inset Flex Code
13454 \begin_layout Plain Layout
13463 \begin_layout Description
13464 \begin_inset Flex Code
13467 \begin_layout Plain Layout
13473 Note that this will completely override any prior
13474 \begin_inset Flex Code
13477 \begin_layout Plain Layout
13483 declaration for this style.
13485 \begin_inset Quotes eld
13489 \begin_inset Flex Code
13492 \begin_layout Plain Layout
13499 \begin_inset Quotes erd
13504 \begin_inset CommandInset ref
13506 reference "subsec:I18n"
13510 for details on its use.
13513 \begin_layout Description
13514 \begin_inset Flex Code
13517 \begin_layout Plain Layout
13524 \begin_inset Flex Code
13527 \begin_layout Plain Layout
13537 \begin_layout Plain Layout
13538 Note that a `float' here is a real number, such as: 1.5.
13543 The vertical space with which the last of a chain of paragraphs with this
13544 style is separated from the following paragraph.
13545 If the next paragraph has another style, the separations are not simply
13546 added, but the maximum is taken.
13549 \begin_layout Description
13550 \begin_inset Flex Code
13553 \begin_layout Plain Layout
13560 \begin_inset Flex Code
13563 \begin_layout Plain Layout
13569 ] The category for this style.
13570 This is used to group related styles in the style combobox on the toolbar.
13571 Any string can be used, but you may want to use existing categories with
13576 \begin_layout Description
13577 \begin_inset Flex Code
13580 \begin_layout Plain Layout
13586 Depth of XML command.
13587 Used only with XML-type formats.
13590 \begin_layout Description
13591 \begin_inset Flex Code
13594 \begin_layout Plain Layout
13601 \begin_inset Flex Code
13604 \begin_layout Plain Layout
13610 ] Copies all the features of an existing style into the current one.
13614 \begin_layout Description
13615 \begin_inset Flex Code
13618 \begin_layout Plain Layout
13625 \begin_inset Flex Code
13628 \begin_layout Plain Layout
13634 ] The name of a style whose preamble should be output
13639 This allows to ensure some ordering of the preamble snippets when macros
13640 definitions depend on one another.
13644 \begin_layout Plain Layout
13645 Note that, besides that functionality, there is no way to ensure any ordering
13647 The ordering that you see in a given version of \SpecialChar LyX
13648 may change without warning
13657 \begin_layout Description
13658 \begin_inset Flex Code
13661 \begin_layout Plain Layout
13668 \begin_inset Flex Code
13671 \begin_layout Plain Layout
13676 , Box, Filled_Box, Static
13681 ] The type of label that stands at the end of the paragraph (or sequence
13683 \begin_inset Flex Code
13686 \begin_layout Plain Layout
13693 \begin_inset Newline newline
13697 \begin_inset Flex Code
13700 \begin_layout Plain Layout
13707 \begin_inset Flex Code
13710 \begin_layout Plain Layout
13717 \begin_inset Flex Code
13720 \begin_layout Plain Layout
13728 \begin_inset Flex Code
13731 \begin_layout Plain Layout
13738 \begin_inset Quotes eld
13742 \begin_inset Quotes erd
13746 \begin_inset Flex Code
13749 \begin_layout Plain Layout
13756 \begin_inset space \space{}
13760 \begin_inset Flex Code
13763 \begin_layout Plain Layout
13769 ) is a white (resp.
13770 \begin_inset space ~
13773 black) square suitable for end of proof markers,
13774 \begin_inset Flex Code
13777 \begin_layout Plain Layout
13783 is an explicit text string.
13786 \begin_layout Description
13787 \begin_inset Flex Code
13790 \begin_layout Plain Layout
13797 \begin_inset Flex Code
13800 \begin_layout Plain Layout
13806 ] The string used for a label with a
13807 \begin_inset Flex Code
13810 \begin_layout Plain Layout
13817 \begin_inset Newline newline
13821 \begin_inset Flex Code
13824 \begin_layout Plain Layout
13834 \begin_layout Description
13835 \begin_inset Flex Code
13838 \begin_layout Plain Layout
13844 The font used for both the text body
13850 \begin_inset CommandInset ref
13852 reference "subsec:Font-description"
13857 Note that defining this font automatically defines the
13858 \begin_inset Flex Code
13861 \begin_layout Plain Layout
13868 So you should define this one first if you also want to define
13869 \begin_inset Flex Code
13872 \begin_layout Plain Layout
13881 \begin_layout Description
13882 \begin_inset Flex Code
13885 \begin_layout Plain Layout
13892 \begin_inset Flex Code
13895 \begin_layout Plain Layout
13901 ] Used for backporting new styles to stable \SpecialChar LyX
13903 The first stable version that supports this tag is \SpecialChar LyX
13905 The argument is a number which may either be 0, -1 or any value greater
13908 \begin_inset Flex Code
13911 \begin_layout Plain Layout
13917 flag of a style is greater than zero, it will always be written to the
13919 If a .lyx file is read, the style definitions from the document header are
13920 added to the document class.
13921 Therefore even older \SpecialChar LyX
13922 versions can handle the style.
13924 \begin_inset Flex Code
13927 \begin_layout Plain Layout
13933 is a version number: if the style is read, and the version number is less
13934 than the version number of the already existing style in the document class,
13935 the new style is ignored.
13936 If the version number is greater, the new style replaces the existing style.
13937 A value of -1 means an infinite version number, i.
13938 \begin_inset space \thinspace{}
13942 \begin_inset space \space{}
13945 the style is always used.
13948 \begin_layout Description
13949 \begin_inset Flex Code
13952 \begin_layout Plain Layout
13959 \begin_inset Flex Code
13962 \begin_layout Plain Layout
13971 \begin_inset space \thinspace{}
13975 \begin_inset Flex Code
13978 \begin_layout Plain Layout
13984 ] Usually \SpecialChar LyX
13985 does not allow you to insert more than one space between words,
13986 since a space is considered as the separation between two words, not a
13987 character or symbol of its own.
13988 This is a very fine thing but sometimes annoying, for example, when typing
13989 program code or plain \SpecialChar LaTeX
13992 \begin_inset Flex Code
13995 \begin_layout Plain Layout
14003 \change_deleted -495245474 1550490105
14007 will create protected blanks for the additional blanks when in
14008 \change_inserted -495245474 1550490096
14010 \begin_inset Flex Code
14013 \begin_layout Plain Layout
14015 \change_inserted -495245474 1550490089
14024 \change_deleted -495245474 1550490116
14025 another mode than \SpecialChar LaTeX
14028 \change_inserted -495245474 1550247760
14030 \begin_inset Flex Code
14033 \begin_layout Plain Layout
14035 \change_inserted -495245474 1550247736
14044 \begin_inset Flex Code
14047 \begin_layout Plain Layout
14049 \change_inserted -495245474 1550247755
14062 \begin_layout Description
14063 \begin_inset Flex Code
14066 \begin_layout Plain Layout
14072 These tags are used with XHTML output.
14074 \begin_inset CommandInset ref
14076 reference "subsec:Paragraph-Style-XHTML"
14083 \begin_layout Description
14084 \begin_inset Flex Code
14087 \begin_layout Plain Layout
14093 [FIXME] (Used only with XML-type formats.)
14096 \begin_layout Description
14097 \begin_inset Flex Code
14100 \begin_layout Plain Layout
14107 \begin_inset Flex Code
14110 \begin_layout Plain Layout
14119 \begin_inset space \thinspace{}
14123 \begin_inset Flex Code
14126 \begin_layout Plain Layout
14133 \begin_inset Flex Code
14136 \begin_layout Plain Layout
14142 , marks the style as to be included in the document preamble and not in
14144 This is useful for document classes that want such information as the title
14145 and author to appear in the preamble.
14146 Note that this works only for styles for which the
14147 \begin_inset Flex Code
14150 \begin_layout Plain Layout
14157 \begin_inset Flex Code
14160 \begin_layout Plain Layout
14167 \begin_inset Flex Code
14170 \begin_layout Plain Layout
14179 \begin_layout Description
14180 \begin_inset Flex Code
14183 \begin_layout Plain Layout
14190 \begin_inset Flex Code
14193 \begin_layout Plain Layout
14202 \begin_inset space \thinspace{}
14206 \begin_inset Flex Code
14209 \begin_layout Plain Layout
14216 \begin_inset Flex Code
14219 \begin_layout Plain Layout
14225 , marks the style as being part of a title block (see also the
14226 \begin_inset Flex Code
14229 \begin_layout Plain Layout
14236 \begin_inset Flex Code
14239 \begin_layout Plain Layout
14248 \begin_layout Description
14249 \begin_inset Flex Code
14252 \begin_layout Plain Layout
14258 Includes a comma-separated list of layouts after which this one should
14260 Only makes sense with regard to nestable layouts (such as environments).
14262 \begin_inset Quotes eld
14266 \begin_inset Flex Code
14269 \begin_layout Plain Layout
14276 \begin_inset Quotes erd
14281 \begin_inset Flex Code
14284 \begin_layout Plain Layout
14293 \begin_layout Description
14294 \begin_inset Flex Code
14297 \begin_layout Plain Layout
14304 \begin_inset Flex Code
14307 \begin_layout Plain Layout
14316 \begin_inset space \thinspace{}
14320 \begin_inset Flex Code
14323 \begin_layout Plain Layout
14329 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
14330 of its contents in its item in the table of contents.
14331 Otherwise, only the label, if it exists, appears.
14334 \begin_layout Description
14335 \begin_inset Flex Code
14338 \begin_layout Plain Layout
14345 \begin_inset Flex Code
14348 \begin_layout Plain Layout
14354 ] The \SpecialChar LaTeX
14355 command sequence declaring an item in a list.
14356 The command is to be defined without the preceding backslash (the default
14358 \begin_inset Quotes eld
14362 \begin_inset Quotes erd
14366 \begin_inset Flex Code
14369 \begin_layout Plain Layout
14377 in the \SpecialChar LaTeX
14381 \begin_layout Description
14382 \begin_inset Flex Code
14385 \begin_layout Plain Layout
14392 \begin_inset Flex Code
14395 \begin_layout Plain Layout
14401 ] This provides extra space between paragraphs that have the same style.
14402 If you put other styles into an environment, each is separated with the
14404 \begin_inset Flex Code
14407 \begin_layout Plain Layout
14414 But the whole items of the environment are additionally separated with
14416 \begin_inset Flex Code
14419 \begin_layout Plain Layout
14426 Note that this is a
14431 \begin_layout Description
14432 \begin_inset Flex Code
14435 \begin_layout Plain Layout
14441 [FIXME] (Used only with XML-type formats.)
14444 \begin_layout Description
14445 \begin_inset Flex Code
14448 \begin_layout Plain Layout
14455 \begin_inset Flex Code
14458 \begin_layout Plain Layout
14467 \begin_inset space \thinspace{}
14471 \begin_inset Flex Code
14474 \begin_layout Plain Layout
14480 ] Usually \SpecialChar LyX
14481 does not allow you to leave a paragraph empty, since it would
14482 lead to empty \SpecialChar LaTeX
14484 There are some cases where this could be desirable however: in a letter
14485 template, the required fields can be provided as empty fields, so that
14486 people do not forget them; in some special classes, a style can be used
14487 as some kind of break, which does not contain actual text.
14490 \begin_layout Description
14491 \begin_inset Flex Code
14494 \begin_layout Plain Layout
14501 \begin_inset Flex Code
14504 \begin_layout Plain Layout
14510 ] The vertical space between the label and the text body.
14511 Only used for labels that are above the text body (
14512 \begin_inset Flex Code
14515 \begin_layout Plain Layout
14522 \begin_inset Newline newline
14526 \begin_inset Flex Code
14529 \begin_layout Plain Layout
14530 Centered_Top_Environment
14538 \begin_layout Description
14539 \begin_inset Flex Code
14542 \begin_layout Plain Layout
14549 \begin_inset Flex Code
14552 \begin_layout Plain Layout
14558 ] The name of the counter for automatic numbering.
14559 In order to have the counter appear with your label, you will need to reference
14561 \begin_inset Flex Code
14564 \begin_layout Plain Layout
14573 This will work with
14574 \begin_inset Flex Code
14577 \begin_layout Plain Layout
14584 \begin_inset Flex Code
14587 \begin_layout Plain Layout
14594 \begin_inset Flex Code
14597 \begin_layout Plain Layout
14604 \begin_inset Flex Code
14607 \begin_layout Plain Layout
14614 \begin_inset Newline newline
14622 \begin_inset Flex Code
14625 \begin_layout Plain Layout
14632 \begin_inset Flex Code
14635 \begin_layout Plain Layout
14641 , though this case is a bit complicated.
14642 Suppose you declare
14643 \begin_inset Quotes eld
14647 \begin_inset Flex Code
14650 \begin_layout Plain Layout
14651 LabelCounter myenum
14657 \begin_inset Quotes erd
14661 Then the actual counters used are
14662 \begin_inset Flex Code
14665 \begin_layout Plain Layout
14672 \begin_inset Flex Code
14675 \begin_layout Plain Layout
14682 \begin_inset Flex Code
14685 \begin_layout Plain Layout
14692 \begin_inset Flex Code
14695 \begin_layout Plain Layout
14701 , much as in \SpecialChar LaTeX
14703 These counters must all be declared separately.
14704 \begin_inset Newline newline
14708 \begin_inset CommandInset ref
14710 reference "subsec:Counters"
14714 for details on counters.
14717 \begin_layout Description
14718 \begin_inset Flex Code
14721 \begin_layout Plain Layout
14727 The font used for the label.
14729 \begin_inset CommandInset ref
14731 reference "subsec:Font-description"
14738 \begin_layout Description
14739 \begin_inset Flex Code
14742 \begin_layout Plain Layout
14749 \begin_inset Flex Code
14752 \begin_layout Plain Layout
14758 ] Text that indicates how far a label should be indented.
14761 \begin_layout Description
14762 \begin_inset Flex Code
14765 \begin_layout Plain Layout
14772 \begin_inset Flex Code
14775 \begin_layout Plain Layout
14781 ] Text that indicates the amount of horizontal space between the label and
14783 Only used for labels that are not above the text body.
14786 \begin_layout Description
14787 \begin_inset Flex Code
14790 \begin_layout Plain Layout
14797 \begin_inset Flex Code
14800 \begin_layout Plain Layout
14806 ] The string used for the label.
14808 \begin_inset Flex Code
14811 \begin_layout Plain Layout
14817 is set, this string can be contain the special formatting commands described
14819 \begin_inset CommandInset ref
14821 reference "subsec:Counters"
14828 \begin_layout Description
14829 \begin_inset Flex Code
14832 \begin_layout Plain Layout
14833 LabelStringAppendix
14839 \begin_inset Flex Code
14842 \begin_layout Plain Layout
14848 ] This is used inside the appendix instead of
14849 \begin_inset Newline newline
14853 \begin_inset Flex Code
14856 \begin_layout Plain Layout
14864 \begin_inset Flex Code
14867 \begin_layout Plain Layout
14874 \begin_inset Newline newline
14878 \begin_inset Flex Code
14881 \begin_layout Plain Layout
14882 LabelStringAppendix
14890 \begin_layout Description
14891 \begin_inset Flex Code
14894 \begin_layout Plain Layout
14900 [FIXME] (Used only with XML-type formats.)
14903 \begin_layout Description
14904 \begin_inset Flex Code
14907 \begin_layout Plain Layout
14914 \begin_inset Flex Code
14917 \begin_layout Plain Layout
14922 , Manual, Static, Above,
14923 \begin_inset Newline newline
14926 Centered, Sensitive, Enumerate,
14927 \begin_inset Newline newline
14930 Itemize, Bibliography
14939 \begin_layout Description
14940 \begin_inset Flex Code
14943 \begin_layout Plain Layout
14949 means the label is the very first word (up to the first real blank).
14950 Use protected spaces if you want more than one word as the label.
14954 \begin_layout Description
14955 \begin_inset Flex Code
14958 \begin_layout Plain Layout
14964 means the label is simply what is declared as
14965 \begin_inset Flex Code
14968 \begin_layout Plain Layout
14975 This will be displayed
14976 \begin_inset Quotes eld
14980 \begin_inset Quotes erd
14983 , at the beginning of the paragraph.
14985 \begin_inset Flex Code
14988 \begin_layout Plain Layout
14995 \begin_inset Flex Code
14998 \begin_layout Plain Layout
15004 , then it will be displayed only in the first paragraph of any sequence
15005 of paragraphs with the same
15006 \begin_inset Flex Code
15009 \begin_layout Plain Layout
15018 \begin_layout Description
15019 \begin_inset Flex Code
15022 \begin_layout Plain Layout
15029 \begin_inset space ~
15033 \begin_inset space ~
15037 \begin_inset Flex Code
15040 \begin_layout Plain Layout
15046 are special cases of
15047 \begin_inset Flex Code
15050 \begin_layout Plain Layout
15057 The label will be printed above the paragraph either at the beginning of
15058 the line or centered.
15061 \begin_layout Description
15062 \begin_inset Flex Code
15065 \begin_layout Plain Layout
15071 is a special case for the caption-labels
15072 \begin_inset Quotes eld
15076 \begin_inset Quotes erd
15080 \begin_inset Quotes eld
15084 \begin_inset Quotes erd
15088 \begin_inset Newline newline
15092 \begin_inset Flex Code
15095 \begin_layout Plain Layout
15101 means the (hardcoded) label string depends on the kind of float: It is
15102 hardcoded to be `FloatType N', where N is the value of the counter associated
15104 For the case that a caption is inserted outside of a float the
15105 \begin_inset Flex Code
15108 \begin_layout Plain Layout
15115 \begin_inset Quotes eld
15119 \begin_inset Quotes erd
15125 \begin_layout Description
15126 \begin_inset Flex Code
15129 \begin_layout Plain Layout
15135 produces the usual sort of enumeration labels.
15136 The number type needs to be set in the
15141 \begin_inset CommandInset ref
15143 reference "subsec:Counters"
15150 \begin_layout Description
15151 \begin_inset Flex Code
15154 \begin_layout Plain Layout
15160 produces various bullets at the different levels.
15161 The bullet types displayed can be set via
15162 \begin_inset Flex Noun
15165 \begin_layout Plain Layout
15166 Document\SpecialChar menuseparator
15167 Settings\SpecialChar menuseparator
15176 \begin_layout Description
15177 \begin_inset Flex Code
15180 \begin_layout Plain Layout
15186 should be used only with
15187 \begin_inset Flex Code
15190 \begin_layout Plain Layout
15191 LatexType BibEnvironment
15200 \begin_layout Description
15201 \begin_inset Flex Code
15204 \begin_layout Plain Layout
15210 Note that this will completely override any prior
15211 \begin_inset Flex Code
15214 \begin_layout Plain Layout
15220 declaration for this style.
15222 \begin_inset Quotes eld
15226 \begin_inset Flex Code
15229 \begin_layout Plain Layout
15236 \begin_inset Quotes erd
15241 \begin_inset CommandInset ref
15243 reference "subsec:I18n"
15247 for details on its use.
15250 \begin_layout Description
15251 \begin_inset Flex Code
15254 \begin_layout Plain Layout
15261 \begin_inset Flex Code
15264 \begin_layout Plain Layout
15270 ] The name of the corresponding \SpecialChar LaTeX
15272 Either the environment or command name.
15275 \begin_layout Description
15276 \begin_inset Flex Code
15279 \begin_layout Plain Layout
15286 \begin_inset Flex Code
15289 \begin_layout Plain Layout
15295 ] An optional parameter for the corresponding
15296 \begin_inset Flex Code
15299 \begin_layout Plain Layout
15306 This parameter cannot be changed from within \SpecialChar LyX
15308 \begin_inset Flex Code
15311 \begin_layout Plain Layout
15317 for customizable parameters).
15318 This will be output as is after all \SpecialChar LaTeX
15320 \begin_inset Flex Code
15323 \begin_layout Plain Layout
15332 \begin_layout Description
15333 \begin_inset Flex Code
15336 \begin_layout Plain Layout
15343 \begin_inset Flex Code
15346 \begin_layout Plain Layout
15351 , Command, Environment, Item_Environment,
15352 \begin_inset Newline newline
15355 List_Environment, Bib_Environment
15360 ] How the style should be translated into \SpecialChar LaTeX
15365 \begin_layout Plain Layout
15366 \begin_inset Flex Code
15369 \begin_layout Plain Layout
15375 is perhaps a bit misleading, since these rules apply to SGML classes, too.
15376 Visit the SGML class files for specific examples.
15385 \begin_layout Description
15386 \begin_inset Flex Code
15389 \begin_layout Plain Layout
15395 means nothing special.
15398 \begin_layout Description
15399 \begin_inset Flex Code
15402 \begin_layout Plain Layout
15409 \begin_inset Flex Code
15412 \begin_layout Plain Layout
15419 {\SpecialChar ldots
15428 \begin_layout Description
15429 \begin_inset Flex Code
15432 \begin_layout Plain Layout
15439 \begin_inset Flex Code
15442 \begin_layout Plain Layout
15449 }\SpecialChar ldots
15465 \begin_layout Description
15466 \begin_inset Flex Code
15469 \begin_layout Plain Layout
15476 \begin_inset Flex Code
15479 \begin_layout Plain Layout
15486 \begin_inset Flex Code
15489 \begin_layout Plain Layout
15497 is generated for each paragraph of this environment.
15501 \begin_layout Description
15502 \begin_inset Flex Code
15505 \begin_layout Plain Layout
15512 \begin_inset Flex Code
15515 \begin_layout Plain Layout
15522 \begin_inset Newline newline
15526 \begin_inset Flex Code
15529 \begin_layout Plain Layout
15535 is passed as an argument to the environment.
15536 \begin_inset Newline newline
15540 \begin_inset Flex Code
15543 \begin_layout Plain Layout
15549 can be defined in the
15550 \begin_inset Flex Noun
15553 \begin_layout Plain Layout
15554 Edit\SpecialChar menuseparator
15556 \begin_inset space ~
15567 \begin_layout Description
15568 \begin_inset Flex Code
15571 \begin_layout Plain Layout
15578 \begin_inset Flex Code
15581 \begin_layout Plain Layout
15587 but adds the necessary mandatory argument (the longest label) to the begin
15588 statement of the bibliography environment:
15589 \begin_inset Newline newline
15593 \begin_inset Flex Code
15596 \begin_layout Plain Layout
15599 begin{thebibliography}{99}
15605 It is therefore only useful for bibliography environments.
15606 The default longest label
15607 \begin_inset Quotes eld
15611 \begin_inset Quotes erd
15614 can be changed by the user in the paragraph settings of a bibliography
15618 \begin_layout Standard
15619 Putting the last few things together, the \SpecialChar LaTeX
15620 output will be either:
15623 \begin_layout LyX-Code
15626 LatexName[LatexParam]{\SpecialChar ldots
15630 \begin_layout Standard
15634 \begin_layout LyX-Code
15637 begin{LatexName}[LatexParam] \SpecialChar ldots
15643 \begin_layout Standard
15644 depending upon the \SpecialChar LaTeX
15649 \begin_layout Description
15650 \begin_inset Flex Code
15653 \begin_layout Plain Layout
15660 \begin_inset Flex Code
15663 \begin_layout Plain Layout
15669 ] A string that is put at the beginning of the style content.
15670 A line break in the output can be indicated by
15671 \begin_inset Flex Code
15674 \begin_layout Plain Layout
15683 \begin_layout Description
15684 \begin_inset Flex Code
15687 \begin_layout Plain Layout
15694 \begin_inset Flex Code
15697 \begin_layout Plain Layout
15703 ] If you put styles into environments, the different
15704 \begin_inset Flex Code
15707 \begin_layout Plain Layout
15713 are not simply added, but added with a factor
15714 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
15718 Note that this parameter is also used when
15719 \begin_inset Flex Code
15722 \begin_layout Plain Layout
15729 \begin_inset Flex Code
15732 \begin_layout Plain Layout
15739 \begin_inset Flex Code
15742 \begin_layout Plain Layout
15749 Then it is added to the manual or dynamic margin.
15750 \begin_inset Newline newline
15754 \begin_inset Quotes eld
15758 \begin_inset Flex Code
15761 \begin_layout Plain Layout
15768 \begin_inset Quotes erd
15771 means that the paragraph is indented with the width of
15772 \begin_inset Quotes eld
15776 \begin_inset Flex Code
15779 \begin_layout Plain Layout
15786 \begin_inset Quotes erd
15789 in the normal font.
15790 You can get a negative width by prefixing the string with
15791 \begin_inset Quotes eld
15795 \begin_inset Flex Code
15798 \begin_layout Plain Layout
15805 \begin_inset Quotes erd
15809 This way was chosen so that the look is the same with each used screen
15813 \begin_layout Description
15814 \begin_inset Flex Code
15817 \begin_layout Plain Layout
15824 \begin_inset Flex Code
15827 \begin_layout Plain Layout
15832 , Manual, Dynamic, First_Dynamic, Right_Address_Box
15838 \begin_inset Newline newline
15841 The kind of margin that the style has on the left side.
15845 \begin_layout Description
15846 \begin_inset Flex Code
15849 \begin_layout Plain Layout
15855 just means a fixed margin.
15858 \begin_layout Description
15859 \begin_inset Flex Code
15862 \begin_layout Plain Layout
15868 means that the left margin depends on the string entered in the
15869 \begin_inset Flex Noun
15872 \begin_layout Plain Layout
15873 Edit\SpecialChar menuseparator
15875 \begin_inset space ~
15884 This is used to typeset nice lists without tabulators.
15887 \begin_layout Description
15888 \begin_inset Flex Code
15891 \begin_layout Plain Layout
15897 means that the margin depends on the size of the label.
15898 This is used for automatic enumerated headlines.
15899 It is obvious that the headline
15900 \begin_inset Quotes eld
15903 5.4.3.2.1 Very long headline
15904 \begin_inset Quotes erd
15907 must have a wider left margin (as wide as
15908 \begin_inset Quotes eld
15912 \begin_inset Quotes erd
15915 plus the space) than
15916 \begin_inset Quotes eld
15919 3.2 Very long headline
15920 \begin_inset Quotes erd
15924 \begin_inset Quotes eld
15928 \begin_inset Quotes erd
15931 are not able to do this.
15934 \begin_layout Description
15935 \begin_inset Flex Code
15938 \begin_layout Plain Layout
15944 is similar, but only the very first row of the paragraph is dynamic, while
15945 the others are static; this is used, for example, for descriptions.
15948 \begin_layout Description
15949 \begin_inset Flex Code
15952 \begin_layout Plain Layout
15958 means the margin is chosen in a way that the longest row of this paragraph
15959 fits to the right margin.
15960 This is used to typeset an address on the right edge of the page.
15964 \begin_layout Description
15965 \begin_inset Flex Code
15968 \begin_layout Plain Layout
15975 \begin_inset Flex Code
15978 \begin_layout Plain Layout
15987 \begin_inset space \thinspace{}
15991 \begin_inset Flex Code
15994 \begin_layout Plain Layout
16000 ] Whether fragile commands in this style should be
16001 \begin_inset Flex Code
16004 \begin_layout Plain Layout
16017 whether this command should itself be protected.)
16018 \change_inserted -712698321 1523696949
16022 \begin_layout Description
16024 \change_inserted -712698321 1552395557
16025 \begin_inset Flex Code
16028 \begin_layout Plain Layout
16030 \change_inserted -712698321 1523696950
16039 \begin_inset Flex Code
16042 \begin_layout Plain Layout
16044 \change_inserted -712698321 1523696950
16055 \begin_inset space \thinspace{}
16059 \begin_inset Flex Code
16062 \begin_layout Plain Layout
16064 \change_inserted -712698321 1523696950
16072 ] This causes macros that contain this layout to be protected with
16073 \begin_inset Flex Code
16076 \begin_layout Plain Layout
16078 \change_inserted -712698321 1523696950
16093 ) if necessary and thus allows (some) verbatim stuff in macros.
16096 \begin_layout Description
16098 \change_inserted -712698321 1552395844
16099 \begin_inset Flex Code
16102 \begin_layout Plain Layout
16104 \change_inserted -712698321 1552395561
16113 \begin_inset Flex Code
16116 \begin_layout Plain Layout
16118 \change_inserted -712698321 1552395557
16129 \begin_inset space \thinspace{}
16133 \begin_inset Flex Code
16136 \begin_layout Plain Layout
16138 \change_inserted -712698321 1552395557
16146 ] Whether specific commands in this style (such as
16147 \begin_inset Flex Code
16150 \begin_layout Plain Layout
16152 \change_inserted -712698321 1552395655
16163 \begin_inset Flex Code
16166 \begin_layout Plain Layout
16168 \change_inserted -712698321 1552395661
16178 ) should be protected in an
16179 \begin_inset Flex Code
16182 \begin_layout Plain Layout
16184 \change_inserted -712698321 1552395631
16195 This is particularly needed for styles that draw on
16203 commands which parse their content in complex ways.
16208 \begin_layout Description
16209 \begin_inset Flex Code
16212 \begin_layout Plain Layout
16219 \begin_inset Flex Code
16222 \begin_layout Plain Layout
16229 \begin_inset space \thinspace{}
16233 \begin_inset Flex Code
16236 \begin_layout Plain Layout
16244 ] Whether newlines are translated into \SpecialChar LaTeX
16246 \begin_inset Flex Code
16249 \begin_layout Plain Layout
16260 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
16262 inside \SpecialChar LyX
16266 \begin_layout Description
16267 \begin_inset Flex Code
16270 \begin_layout Plain Layout
16277 \begin_inset Flex Code
16280 \begin_layout Plain Layout
16289 \begin_inset space \thinspace{}
16293 \begin_inset Flex Code
16296 \begin_layout Plain Layout
16302 ] If set to true, and if
16303 \begin_inset Flex Code
16306 \begin_layout Plain Layout
16313 \begin_inset Flex Code
16316 \begin_layout Plain Layout
16322 ) paragraphs are being indented, then the indentation of such a paragraph
16323 following one of this type will be suppressed.
16324 (So this will not affect the display of non-default paragraphs.)
16327 \begin_layout Description
16328 \begin_inset Flex Code
16331 \begin_layout Plain Layout
16338 \begin_inset Flex Code
16341 \begin_layout Plain Layout
16347 ] Name of a style that has replaced this style.
16348 This is used to rename a style, while keeping backward compatibility.
16351 \begin_layout Description
16352 \begin_inset Flex Code
16355 \begin_layout Plain Layout
16362 \begin_inset Flex Code
16365 \begin_layout Plain Layout
16372 \begin_inset space \thinspace{}
16376 \begin_inset Flex Code
16379 \begin_layout Plain Layout
16385 ] Determines whether consecutive paragraphs of the same type are treated
16386 as belonging together.
16387 This has the effect that the
16388 \begin_inset Flex Code
16391 \begin_layout Plain Layout
16397 is only printed once before such a group.
16398 By default, this is true for
16399 \begin_inset Flex Code
16402 \begin_layout Plain Layout
16409 \begin_inset Flex Code
16412 \begin_layout Plain Layout
16419 \begin_inset Flex Code
16422 \begin_layout Plain Layout
16428 and false for all other types.
16431 \begin_layout Description
16432 \begin_inset Flex Code
16435 \begin_layout Plain Layout
16442 \begin_inset Flex Code
16445 \begin_layout Plain Layout
16454 \begin_inset space \thinspace{}
16458 \begin_inset Flex Code
16461 \begin_layout Plain Layout
16467 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
16469 but only by a line break; together with
16470 \begin_inset Flex Code
16473 \begin_layout Plain Layout
16479 , this allows to emulate a plain text editor (like the ERT inset).
16482 \begin_layout Description
16483 \begin_inset Flex Code
16486 \begin_layout Plain Layout
16493 \begin_inset Flex Code
16496 \begin_layout Plain Layout
16502 ] The indent of the very first line of a paragraph.
16504 \begin_inset Newline newline
16508 \begin_inset Flex Code
16511 \begin_layout Plain Layout
16517 will be fixed for a certain style.
16518 The exception is the default style, since the indentation for these paragraphs
16519 can be prohibited with
16520 \begin_inset Flex Code
16523 \begin_layout Plain Layout
16531 \begin_inset Flex Code
16534 \begin_layout Plain Layout
16540 style paragraphs inside environments use the
16541 \begin_inset Flex Code
16544 \begin_layout Plain Layout
16550 of the environment, not their native one.
16552 \begin_inset Flex Code
16555 \begin_layout Plain Layout
16561 paragraphs inside an enumeration are not indented.
16564 \begin_layout Description
16565 \begin_inset Flex Code
16568 \begin_layout Plain Layout
16575 \begin_inset Flex Code
16578 \begin_layout Plain Layout
16584 ] The vertical space between two paragraphs of this style.
16587 \begin_layout Description
16588 \begin_inset Flex Code
16591 \begin_layout Plain Layout
16598 \begin_inset Flex Code
16601 \begin_layout Plain Layout
16608 allows the user to choose either
16609 \begin_inset Quotes eld
16613 \begin_inset Quotes erd
16617 \begin_inset Quotes eld
16621 \begin_inset Quotes erd
16624 to separate paragraphs.
16626 \begin_inset Quotes eld
16630 \begin_inset Quotes erd
16634 \begin_inset Flex Code
16637 \begin_layout Plain Layout
16645 \begin_inset Quotes eld
16649 \begin_inset Quotes erd
16653 \begin_inset Flex Code
16656 \begin_layout Plain Layout
16662 is ignored and all paragraphs are separated by the
16663 \begin_inset Flex Code
16666 \begin_layout Plain Layout
16673 The vertical space is calculated with
16674 \begin_inset Flex Code
16677 \begin_layout Plain Layout
16679 \begin_inset space ~
16688 \begin_inset Flex Code
16691 \begin_layout Plain Layout
16697 is the height of a row with the normal font.
16698 This way, the look stays the same with different screen fonts.
16701 \begin_layout Description
16702 \begin_inset Flex Code
16705 \begin_layout Plain Layout
16712 \begin_inset Flex Code
16715 \begin_layout Plain Layout
16724 \begin_inset space \thinspace{}
16728 \begin_inset Flex Code
16731 \begin_layout Plain Layout
16737 ] Whether the contents of this paragraph should be output in raw form, meaning
16738 without special translations that \SpecialChar LaTeX
16742 \begin_layout Description
16743 \begin_inset Flex Code
16746 \begin_layout Plain Layout
16753 \begin_inset Flex Code
16756 \begin_layout Plain Layout
16766 Defines individual characters that should be output in raw form, meaning
16767 without special translations that \SpecialChar LaTeX
16771 \begin_layout Description
16772 \begin_inset Flex Code
16775 \begin_layout Plain Layout
16781 Information to be included in the \SpecialChar LaTeX
16782 preamble when this style is used.
16783 Used to define macros, load packages, etc., required by this particular
16786 \begin_inset Quotes eld
16790 \begin_inset Flex Code
16793 \begin_layout Plain Layout
16800 \begin_inset Quotes erd
16806 \begin_layout Description
16807 \begin_inset Flex Code
16810 \begin_layout Plain Layout
16817 \begin_inset Flex Code
16820 \begin_layout Plain Layout
16826 ] The prefix to use when creating labels referring to paragraphs of this
16828 This allows the use of formatted references.
16831 \begin_layout Description
16832 \begin_inset Flex Code
16835 \begin_layout Plain Layout
16842 \begin_inset Flex Code
16845 \begin_layout Plain Layout
16851 ] Whether the style requires the feature
16852 \begin_inset Flex Code
16855 \begin_layout Plain Layout
16862 \begin_inset CommandInset ref
16864 reference "chap:List-of-functions"
16868 for the list of features).
16869 If you require a package with specific options, you can additionally use
16871 \begin_inset Flex Code
16874 \begin_layout Plain Layout
16880 as a general text class parameter (see
16881 \begin_inset CommandInset ref
16883 reference "subsec:General-text-class"
16890 \begin_layout Description
16891 \begin_inset Flex Code
16894 \begin_layout Plain Layout
16901 \begin_inset Flex Code
16904 \begin_layout Plain Layout
16913 \begin_inset Flex Code
16916 \begin_layout Plain Layout
16922 ] Resets the \SpecialChar LaTeX
16923 arguments of this style (as defined via the
16924 \begin_inset Flex Code
16927 \begin_layout Plain Layout
16934 This is useful if you have copied a style via
16935 \begin_inset Flex Code
16938 \begin_layout Plain Layout
16944 , but you do not want to inherit its (required and optional) arguments.
16947 \begin_layout Description
16948 \begin_inset Flex Code
16951 \begin_layout Plain Layout
16958 \begin_inset Flex Code
16961 \begin_layout Plain Layout
16970 \begin_inset Flex Code
16973 \begin_layout Plain Layout
16979 ] Resumes a counter that is usually reset at each new sequence of layouts.
16980 This is currently only useful when
16981 \begin_inset Flex Code
16984 \begin_layout Plain Layout
16991 \begin_inset Flex Code
16994 \begin_layout Plain Layout
17003 \begin_layout Description
17004 \begin_inset Flex Code
17007 \begin_layout Plain Layout
17014 \begin_inset Flex Code
17017 \begin_layout Plain Layout
17023 ] A string that is put at the end of the layout content.
17024 A line break in the output can be indicated by
17025 \begin_inset Flex Code
17028 \begin_layout Plain Layout
17037 \begin_layout Description
17038 \begin_inset Flex Code
17041 \begin_layout Plain Layout
17048 \begin_inset Flex Code
17051 \begin_layout Plain Layout
17058 \begin_inset Flex Code
17061 \begin_layout Plain Layout
17070 \begin_layout Description
17071 \begin_inset Flex Code
17074 \begin_layout Plain Layout
17081 \begin_inset Flex Code
17084 \begin_layout Plain Layout
17093 \begin_inset Flex Code
17096 \begin_layout Plain Layout
17103 \begin_inset Flex Code
17106 \begin_layout Plain Layout
17113 \begin_inset Flex Code
17116 \begin_layout Plain Layout
17118 \begin_inset space ~
17126 ] This defines what the default spacing should be in the style.
17128 \begin_inset Flex Code
17131 \begin_layout Plain Layout
17138 \begin_inset Flex Code
17141 \begin_layout Plain Layout
17148 \begin_inset Flex Code
17151 \begin_layout Plain Layout
17157 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
17158 If you specify the argument
17159 \begin_inset Flex Code
17162 \begin_layout Plain Layout
17168 , then you must also provide a value argument which will be the actual multiplie
17170 Note that, contrary to other parameters,
17171 \begin_inset Flex Code
17174 \begin_layout Plain Layout
17180 implies the generation of specific \SpecialChar LaTeX
17181 code, using the \SpecialChar LaTeX
17185 \begin_inset Flex Code
17188 \begin_layout Plain Layout
17197 \begin_layout Description
17198 \begin_inset Flex Code
17201 \begin_layout Plain Layout
17208 \begin_inset Flex Code
17211 \begin_layout Plain Layout
17218 \begin_inset space \thinspace{}
17222 \begin_inset Flex Code
17225 \begin_layout Plain Layout
17233 ] Allow spell-checking paragraphs of this style.
17237 \begin_layout Description
17238 \begin_inset Flex Code
17241 \begin_layout Plain Layout
17248 \begin_inset Flex Code
17251 \begin_layout Plain Layout
17260 \begin_inset Flex Code
17263 \begin_layout Plain Layout
17269 ] Steps the master counter of a given counter at the beginning of a new
17270 sequence of layouts.
17271 This is currently only useful when
17272 \begin_inset Flex Code
17275 \begin_layout Plain Layout
17282 \begin_inset Flex Code
17285 \begin_layout Plain Layout
17294 \begin_layout Description
17295 \begin_inset Flex Code
17298 \begin_layout Plain Layout
17304 The font used for the text body .
17306 \begin_inset CommandInset ref
17308 reference "subsec:Font-description"
17315 \begin_layout Description
17316 \begin_inset Flex Code
17319 \begin_layout Plain Layout
17328 \begin_inset Flex Code
17331 \begin_layout Plain Layout
17341 The level of the style in the table of contents.
17342 This is used for automatic numbering of section headings.
17345 \begin_layout Description
17346 \begin_inset Flex Code
17349 \begin_layout Plain Layout
17358 \begin_inset Flex Code
17361 \begin_layout Plain Layout
17372 \begin_inset Flex Code
17375 \begin_layout Plain Layout
17382 \begin_inset Flex Code
17385 \begin_layout Plain Layout
17391 ] This tag determines whether the first line indentation of this paragraph
17392 can be toggled via the Paragraph settings dialog.
17396 \begin_inset Flex Code
17399 \begin_layout Plain Layout
17409 is set, indentation can be toggled if the document settings use
17410 \begin_inset Quotes eld
17414 \begin_inset Quotes erd
17417 paragraph style, with
17418 \begin_inset Flex Code
17421 \begin_layout Plain Layout
17427 , indentation can always be toggled, notwithstanding the document settings,
17429 \begin_inset Flex Code
17432 \begin_layout Plain Layout
17438 , indentation can never be toggled.
17441 \begin_layout Description
17442 \begin_inset Flex Code
17445 \begin_layout Plain Layout
17452 \begin_inset Flex Code
17455 \begin_layout Plain Layout
17461 ] The vertical space with which the very first of a chain of paragraphs
17462 with this style is separated from the previous paragraph.
17463 If the previous paragraph has another style, the separations are not simply
17464 added, but the maximum is taken.
17467 \begin_layout Subsection
17468 \begin_inset CommandInset label
17474 Internationalization of Paragraph Styles
17477 \begin_layout Standard
17479 has long supported internationalization of layout information, but, until
17480 version 2.0, this applied only to the user interface and not to, say, PDF
17482 Thus, French authors were forced to resort to ugly hacks if they wanted
17487 1' instead of `Theorem 1'.
17488 Thanks to Georg Baum, that is no longer the case.
17491 \begin_layout Standard
17493 \begin_inset Flex Code
17496 \begin_layout Plain Layout
17502 defines text that is to appear in the typeset document, it may use
17503 \begin_inset Flex Code
17506 \begin_layout Plain Layout
17513 \begin_inset Flex Code
17516 \begin_layout Plain Layout
17522 to support non-English and even multi-language documents correctly.
17523 The following excerpt (from the
17524 \begin_inset Flex Code
17527 \begin_layout Plain Layout
17533 file) shows how this works:
17536 \begin_layout LyX-Code
17541 \begin_layout LyX-Code
17544 theoremstyle{remark}
17547 \begin_layout LyX-Code
17550 newtheorem{claim}[thm]{
17557 \begin_layout LyX-Code
17561 \begin_layout LyX-Code
17565 \begin_layout LyX-Code
17570 claimname}{_(Claim)}
17573 \begin_layout LyX-Code
17577 \begin_layout LyX-Code
17581 \begin_layout LyX-Code
17590 claimname}{_(Claim)}}
17593 \begin_layout LyX-Code
17598 \begin_layout Standard
17599 In principle, any legal \SpecialChar LaTeX
17601 \begin_inset Flex Code
17604 \begin_layout Plain Layout
17611 \begin_inset Flex Code
17614 \begin_layout Plain Layout
17620 tags, but in practice they will typically look as they do here.
17621 The key to correct translation of the typeset text is the definition of
17622 the \SpecialChar LaTeX
17624 \begin_inset Flex Code
17627 \begin_layout Plain Layout
17636 \begin_inset Flex Code
17639 \begin_layout Plain Layout
17651 \begin_layout Standard
17653 \begin_inset Flex Code
17656 \begin_layout Plain Layout
17662 tag provides for internationalization based upon the overall language of
17664 The contents of the tag will be included in the preamble, just as with
17666 \begin_inset Flex Code
17669 \begin_layout Plain Layout
17676 What makes it special is the use of the
17677 \begin_inset Quotes eld
17681 \begin_inset Quotes erd
17685 \begin_inset Flex Code
17688 \begin_layout Plain Layout
17694 , which will be replaced, when \SpecialChar LyX
17695 produces \SpecialChar LaTeX
17696 output, with the translation of
17697 its argument into the document language.
17700 \begin_layout Standard
17702 \begin_inset Flex Code
17705 \begin_layout Plain Layout
17711 tag is more complex, since it is meant to provide support for multi-language
17712 documents and so offers an interface to the
17713 \begin_inset Flex Code
17716 \begin_layout Plain Layout
17723 Its contents will be added to the preamble once for each language that
17724 appears in the document.
17725 In this case, the argument to
17726 \begin_inset Flex Code
17729 \begin_layout Plain Layout
17735 will be replaced with its translation into the language in question; the
17737 \begin_inset Flex Code
17740 \begin_layout Plain Layout
17746 is replaced by the language name (as used by the babel package).
17749 \begin_layout Standard
17750 A German document that also included a French section would thus have the
17751 following in the preamble:
17754 \begin_layout LyX-Code
17763 claimname}{Affirmation}}
17764 \begin_inset Newline newline
17775 claimname}{Behauptung}}
17776 \begin_inset Newline newline
17783 claimname}{Behauptung}
17786 \begin_layout Standard
17789 \begin_inset Flex Code
17792 \begin_layout Plain Layout
17798 will then conspire to produce the correct text in the output.
17801 \begin_layout Standard
17802 One important point to note here is that the translations are provided by
17804 itself, through the file
17805 \begin_inset Flex Code
17808 \begin_layout Plain Layout
17815 This means, in effect, that
17816 \begin_inset Flex Code
17819 \begin_layout Plain Layout
17826 \begin_inset Flex Code
17829 \begin_layout Plain Layout
17835 are really only of use in layout files that are provided with \SpecialChar LyX
17837 entered in user-created layout files will not be seen by \SpecialChar LyX
17838 's internationalizatio
17839 n routines unless the
17840 \begin_inset Flex Code
17843 \begin_layout Plain Layout
17849 file is modified accordingly.
17850 That said, however, any layout created with the intention that it will
17851 be included with \SpecialChar LyX
17852 should use these tags where appropriate.
17853 Please note that the paragraph style translations provided by \SpecialChar LyX
17855 change with a minor update (e.
17856 \begin_inset space \thinspace{}
17860 \begin_inset space \space{}
17863 from version 2.1.x to 2.1.y).
17864 It is however quite likely that a major update (e.
17865 \begin_inset space \thinspace{}
17869 \begin_inset space \space{}
17872 from 2.0.x to 2.1.0) will introduce new translations or corrections.
17875 \begin_layout Subsection
17877 \begin_inset CommandInset label
17879 name "subsec:Floats"
17886 \begin_layout Standard
17887 It is necessary to define the floats (
17888 \begin_inset Flex Noun
17891 \begin_layout Plain Layout
17898 \begin_inset Flex Noun
17901 \begin_layout Plain Layout
17907 , \SpecialChar ldots
17908 ) in the text class itself.
17909 Standard floats are included in the file
17910 \begin_inset Flex Code
17913 \begin_layout Plain Layout
17919 , so you may have to do no more than add
17922 \begin_layout LyX-Code
17923 Input stdfloats.inc
17926 \begin_layout Standard
17927 to your layout file.
17928 If you want to implement a text class that proposes some other float types
17929 (like the AGU class bundled with \SpecialChar LyX
17930 ), the information below will hopefully
17934 \begin_layout Description
17935 \begin_inset Flex Code
17938 \begin_layout Plain Layout
17945 \begin_inset Flex Code
17948 \begin_layout Plain Layout
17954 =!htbpH] Allowed placement options for this float type.
17955 The value is a string of placement characters.
17956 Possible characters include:
17961 \begin_inset Quotes eld
17965 \begin_inset Quotes erd
17973 \begin_inset Quotes eld
17977 \begin_inset Quotes erd
17985 \begin_inset Quotes eld
17989 \begin_inset Quotes erd
17997 \begin_inset Quotes eld
18001 \begin_inset Quotes erd
18009 \begin_inset Quotes eld
18013 \begin_inset Quotes erd
18021 \begin_inset Quotes eld
18025 \begin_inset Quotes erd
18029 The order of the characters in the string does not matter.
18030 If no placement options are allowed, use the string
18037 \begin_layout Description
18038 \begin_inset Flex Code
18041 \begin_layout Plain Layout
18048 \begin_inset Flex Code
18051 \begin_layout Plain Layout
18060 \begin_inset space \thinspace{}
18066 \begin_inset Flex Code
18069 \begin_layout Plain Layout
18079 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
18086 \begin_inset Flex Code
18089 \begin_layout Plain Layout
18095 if the float does not support this feature.
18098 \begin_layout Description
18099 \begin_inset Flex Code
18102 \begin_layout Plain Layout
18109 \begin_inset Flex Code
18112 \begin_layout Plain Layout
18121 \begin_inset space \thinspace{}
18127 \begin_inset Flex Code
18130 \begin_layout Plain Layout
18140 ] Defines whether the float has a starred variant that spans columns in
18141 a two column paragraph.
18143 \begin_inset Flex Code
18146 \begin_layout Plain Layout
18152 if the float does not support this feature.
18155 \begin_layout Description
18156 \begin_inset Flex Code
18159 \begin_layout Plain Layout
18166 \begin_inset Flex Code
18169 \begin_layout Plain Layout
18176 \begin_inset Quotes erd
18180 \begin_inset Quotes erd
18183 ] The file name extension of an auxiliary file for the list of figures (or
18186 writes the captions to this file.
18189 \begin_layout Description
18190 \begin_inset Flex Code
18193 \begin_layout Plain Layout
18200 \begin_inset Flex Code
18203 \begin_layout Plain Layout
18210 \begin_inset Quotes erd
18214 \begin_inset Quotes erd
18217 ] The string that will be used in the menus and also for the caption.
18218 This is translated to the current language if babel is used.
18221 \begin_layout Description
18222 \begin_inset Flex Code
18225 \begin_layout Plain Layout
18231 These tags control the XHTML output.
18233 \begin_inset CommandInset ref
18235 reference "sec:Tags-for-XHTML"
18242 \begin_layout Description
18243 \begin_inset Flex Code
18246 \begin_layout Plain Layout
18255 \begin_inset Flex Code
18258 \begin_layout Plain Layout
18267 \begin_inset space \thinspace{}
18271 \begin_inset Flex Code
18274 \begin_layout Plain Layout
18280 ] Indicates whether the float is already defined in the document class or
18281 if instead the \SpecialChar LaTeX
18283 \begin_inset Flex Code
18286 \begin_layout Plain Layout
18292 needs to be loaded to define it on-the-fly.
18294 \begin_inset Flex Code
18297 \begin_layout Plain Layout
18304 \begin_inset Flex Code
18307 \begin_layout Plain Layout
18314 It should be set to
18315 \begin_inset Flex Code
18318 \begin_layout Plain Layout
18324 if the float is already defined by the \SpecialChar LaTeX
18328 \begin_layout Description
18329 \begin_inset Flex Code
18332 \begin_layout Plain Layout
18339 \begin_inset Flex Code
18342 \begin_layout Plain Layout
18349 \begin_inset Quotes erd
18353 \begin_inset Quotes erd
18356 ] The command used to generate a list of floats of this type; the leading
18365 \begin_inset Flex Code
18368 \begin_layout Plain Layout
18374 is false, since there is no standard way to generate this command.
18376 \begin_inset Flex Code
18379 \begin_layout Plain Layout
18385 is true, since in that case there is a standard way to define the command.
18388 \begin_layout Description
18389 \begin_inset Flex Code
18392 \begin_layout Plain Layout
18399 \begin_inset Flex Code
18402 \begin_layout Plain Layout
18409 \begin_inset Quotes erd
18413 \begin_inset Quotes erd
18416 ] A title for a list of floats of this kind (list of figures, tables, or
18418 It is used for the screen label within \SpecialChar LyX
18419 , it is used by \SpecialChar LaTeX
18421 it is used as the title in the XHTML output.
18422 It will be translated to the document language.
18425 \begin_layout Description
18426 \begin_inset Flex Code
18429 \begin_layout Plain Layout
18436 \begin_inset Flex Code
18439 \begin_layout Plain Layout
18446 \begin_inset Quotes erd
18450 \begin_inset Quotes erd
18453 ] This (optional) argument determines whether floats of this class will
18454 be numbered within some sectional unit of the document.
18456 \begin_inset Flex Code
18459 \begin_layout Plain Layout
18466 \begin_inset Quotes eld
18470 \begin_inset Flex Code
18473 \begin_layout Plain Layout
18480 \begin_inset Quotes erd
18483 , the floats will be numbered within chapters.
18487 \begin_layout Description
18488 \begin_inset Flex Code
18491 \begin_layout Plain Layout
18498 \begin_inset Flex Code
18501 \begin_layout Plain Layout
18508 \begin_inset Quotes erd
18512 \begin_inset Quotes erd
18515 ] The default placement for the given class of floats.
18516 The string should be as in standard \SpecialChar LaTeX
18518 \begin_inset Flex Code
18521 \begin_layout Plain Layout
18528 \begin_inset Flex Code
18531 \begin_layout Plain Layout
18538 \begin_inset Flex Code
18541 \begin_layout Plain Layout
18548 \begin_inset Flex Code
18551 \begin_layout Plain Layout
18557 for top, bottom, page, and here, respectively.
18561 \begin_layout Plain Layout
18562 Note that the order of these letters in the string is irrelevant, like in
18569 On top of that there is a new type,
18570 \begin_inset Flex Code
18573 \begin_layout Plain Layout
18579 , which does not really correspond to a float, since it means: put it
18580 \begin_inset Quotes eld
18584 \begin_inset Quotes erd
18588 Note however that the
18589 \begin_inset Flex Code
18592 \begin_layout Plain Layout
18598 specifier is special and, because of implementation details, cannot be
18599 used in non-built in float types.
18600 If you do not understand what this means, just use
18601 \begin_inset Quotes eld
18605 \begin_inset Flex Code
18608 \begin_layout Plain Layout
18615 \begin_inset Quotes erd
18621 \begin_layout Description
18622 \begin_inset Flex Code
18625 \begin_layout Plain Layout
18632 \begin_inset Flex Code
18635 \begin_layout Plain Layout
18641 ] The prefix to use when creating labels referring to floats of this type.
18642 This allows the use of formatted references.
18643 Note that you can remove any
18644 \begin_inset Flex Code
18647 \begin_layout Plain Layout
18653 set by a copied style by using the special value
18654 \begin_inset Quotes eld
18658 \begin_inset Quotes erd
18661 , which must be all caps.
18662 \change_inserted -712698321 1565605014
18666 \begin_layout Description
18668 \change_inserted -712698321 1565605014
18669 \begin_inset Flex Code
18672 \begin_layout Plain Layout
18674 \change_inserted -712698321 1565605014
18683 \begin_inset Flex Code
18686 \begin_layout Plain Layout
18688 \change_inserted -712698321 1565605014
18696 ] As with paragraph styles, see
18697 \begin_inset CommandInset ref
18699 reference "subsec:Paragraph-Styles"
18708 \begin_layout Description
18709 \begin_inset Flex Code
18712 \begin_layout Plain Layout
18719 \begin_inset Flex Code
18722 \begin_layout Plain Layout
18729 \begin_inset Quotes erd
18733 \begin_inset Quotes erd
18736 ] The style used when defining the float using
18737 \begin_inset Flex Code
18740 \begin_layout Plain Layout
18751 \begin_layout Description
18752 \begin_inset Flex Code
18755 \begin_layout Plain Layout
18762 \begin_inset Flex Code
18765 \begin_layout Plain Layout
18772 \begin_inset Quotes erd
18776 \begin_inset Quotes erd
18780 \begin_inset Quotes eld
18784 \begin_inset Quotes erd
18787 of the new class of floats, like program or algorithm.
18788 After the appropriate
18789 \begin_inset Flex Code
18792 \begin_layout Plain Layout
18801 \begin_inset Flex Code
18804 \begin_layout Plain Layout
18813 \begin_inset Flex Code
18816 \begin_layout Plain Layout
18827 \begin_layout Description
18828 \begin_inset Flex Code
18831 \begin_layout Plain Layout
18838 \begin_inset Flex Code
18841 \begin_layout Plain Layout
18848 \begin_inset space \thinspace{}
18852 \begin_inset Flex Code
18855 \begin_layout Plain Layout
18863 ] Specifies whether this float is defined using the \SpecialChar LaTeX
18865 \begin_inset Flex Code
18868 \begin_layout Plain Layout
18874 , either by the class file, another package or on-the-fly by \SpecialChar LyX
18878 \begin_layout Standard
18879 Note that defining a float with type
18880 \begin_inset Flex Code
18883 \begin_layout Plain Layout
18891 automatically defines the corresponding counter with name
18892 \begin_inset Flex Code
18895 \begin_layout Plain Layout
18906 \begin_layout Subsection
18907 Flex insets and InsetLayout
18908 \begin_inset CommandInset label
18910 name "subsec:Flex-insets-and"
18917 \begin_layout Standard
18918 Flex insets come in
18919 \change_deleted 5863208 1594239511
18921 \change_inserted 5863208 1594239512
18927 \begin_layout Itemize
18929 \begin_inset Flex Code
18932 \begin_layout Plain Layout
18938 ): These define semantic markup corresponding to such \SpecialChar LaTeX
18940 \begin_inset Flex Code
18943 \begin_layout Plain Layout
18952 \begin_inset Flex Code
18955 \begin_layout Plain Layout
18966 \begin_layout Itemize
18968 \begin_inset Flex Code
18971 \begin_layout Plain Layout
18977 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
18979 footnote, and the like.
18980 An obvious example is an endnote inset, which is defined in the
18981 \begin_inset Flex Code
18984 \begin_layout Plain Layout
18993 \begin_layout Itemize
18995 \change_deleted 5863208 1594239528
18997 \begin_inset Flex Code
19000 \begin_layout Plain Layout
19006 ): For use with DocBook classes.
19011 \begin_layout Standard
19012 Flex insets are defined using the
19013 \begin_inset Flex Code
19016 \begin_layout Plain Layout
19022 tag, which shall be explained in a moment.
19025 \begin_layout Standard
19027 \begin_inset Flex Code
19030 \begin_layout Plain Layout
19036 tag also serves another function: It can be used to customize the general
19037 layout of many different types of insets.
19039 \begin_inset Flex Code
19042 \begin_layout Plain Layout
19048 can be used to customize the layout parameters for footnotes, marginal
19049 notes, note insets, \SpecialChar TeX
19050 code (ERT) insets, branches, listings, indexes, boxes,
19051 tables, algorithms, URLs, and captions, as well as to define Flex insets.
19054 \begin_layout Standard
19056 \begin_inset Flex Code
19059 \begin_layout Plain Layout
19065 definition must begin with a line of the form:
19068 \begin_layout LyX-Code
19072 \begin_layout Standard
19074 \begin_inset Flex Code
19077 \begin_layout Plain Layout
19083 indicates the inset whose layout is being defined, and here there are four
19087 \begin_layout Enumerate
19088 The layout for a pre-existing inset is being modified.
19089 In this case, can be
19090 \begin_inset Flex Code
19093 \begin_layout Plain Layout
19099 any one of the following:
19100 \begin_inset Flex Code
19103 \begin_layout Plain Layout
19110 \begin_inset Flex Code
19113 \begin_layout Plain Layout
19120 \begin_inset Flex Code
19123 \begin_layout Plain Layout
19130 \begin_inset Flex Code
19133 \begin_layout Plain Layout
19140 \begin_inset Flex Code
19143 \begin_layout Plain Layout
19150 \begin_inset Flex Code
19153 \begin_layout Plain Layout
19160 \begin_inset Flex Code
19163 \begin_layout Plain Layout
19170 \begin_inset Flex Code
19173 \begin_layout Plain Layout
19180 \begin_inset Flex Code
19183 \begin_layout Plain Layout
19190 \begin_inset Flex Code
19193 \begin_layout Plain Layout
19200 \begin_inset Flex Code
19203 \begin_layout Plain Layout
19210 \begin_inset Flex Code
19213 \begin_layout Plain Layout
19220 \begin_inset Flex Code
19223 \begin_layout Plain Layout
19230 \begin_inset Flex Code
19233 \begin_layout Plain Layout
19240 \begin_inset Flex Code
19243 \begin_layout Plain Layout
19250 \begin_inset Flex Code
19253 \begin_layout Plain Layout
19260 \begin_inset Flex Code
19263 \begin_layout Plain Layout
19270 \begin_inset Flex Code
19273 \begin_layout Plain Layout
19280 \begin_inset Flex Code
19283 \begin_layout Plain Layout
19290 \begin_inset Flex Code
19293 \begin_layout Plain Layout
19302 \begin_layout Enumerate
19303 The layout for a Flex inset is being defined.
19305 \begin_inset Flex Code
19308 \begin_layout Plain Layout
19314 must be of the form
19315 \begin_inset Quotes eld
19319 \begin_inset Flex Code
19322 \begin_layout Plain Layout
19329 \begin_inset Quotes erd
19333 \begin_inset Flex Code
19336 \begin_layout Plain Layout
19342 may be be any valid identifier not used by a pre-existing Flex inset.
19343 The identifier may include spaces, but in that case the whole thing must
19344 be wrapped in quotes.
19345 Note that the definition of a flex inset
19350 \begin_inset Flex Code
19353 \begin_layout Plain Layout
19359 entry, declaring which type of inset it defines.
19362 \begin_layout Enumerate
19363 The layout for user specific branch is being defined.
19365 \begin_inset Flex Code
19368 \begin_layout Plain Layout
19374 must be of the form
19375 \begin_inset Quotes eld
19379 \begin_inset Flex Code
19382 \begin_layout Plain Layout
19389 \begin_inset Quotes erd
19393 \begin_inset Flex Code
19396 \begin_layout Plain Layout
19402 may be be any valid identifier of branch defined in user's document.
19403 The identifier may include spaces, but in that case the whole thing must
19404 be wrapped in quotes.
19405 The main purpose of this feature is to allow \SpecialChar LaTeX
19406 wrapping around specific
19407 branches as user needs.
19410 \begin_layout Enumerate
19411 The layout of a user (or class) specific caption is being defined.
19413 \begin_inset Flex Code
19416 \begin_layout Plain Layout
19422 must be of the form
19423 \begin_inset Quotes eld
19427 \begin_inset Flex Code
19430 \begin_layout Plain Layout
19437 \begin_inset Quotes erd
19441 \begin_inset Flex Code
19444 \begin_layout Plain Layout
19450 specifies the name of the caption as it appears in the menu.
19451 Have a look at the standard caption (
19452 \begin_inset Flex Code
19455 \begin_layout Plain Layout
19461 ), the specific captions of the KOMA-Script classes (
19462 \begin_inset Flex Code
19465 \begin_layout Plain Layout
19472 \begin_inset Flex Code
19475 \begin_layout Plain Layout
19484 \begin_inset space ~
19488 \begin_inset Newline linebreak
19494 \begin_inset Flex Code
19497 \begin_layout Plain Layout
19503 ) for applications.
19506 \begin_layout Standard
19508 \begin_inset Flex Code
19511 \begin_layout Plain Layout
19517 definition can contain the following entries:
19520 \begin_layout Description
19521 \begin_inset Flex Code
19524 \begin_layout Plain Layout
19531 \begin_inset Flex Code
19534 \begin_layout Plain Layout
19540 =""] This inset will appear in the table of contents of the given type.
19541 An empty string disables.
19542 See also the OutlinerName and the IsTocCaption commands.
19543 This is only implemented for Flex insets.
19547 \begin_layout Description
19548 \begin_inset Flex Code
19551 \begin_layout Plain Layout
19558 \begin_inset Flex Code
19561 \begin_layout Plain Layout
19567 ] Defines argument number of a command\SpecialChar breakableslash
19568 environment associated with the current
19570 The definition must end with
19571 \begin_inset Flex Code
19574 \begin_layout Plain Layout
19582 \begin_inset CommandInset ref
19584 reference "subsec:Paragraph-Styles"
19591 \begin_layout Description
19592 \begin_inset Flex Code
19595 \begin_layout Plain Layout
19601 Preamble for changing language commands; see
19602 \begin_inset CommandInset ref
19604 reference "subsec:I18n"
19611 \begin_layout Description
19612 \begin_inset Flex Code
19615 \begin_layout Plain Layout
19622 \begin_inset Flex Code
19625 \begin_layout Plain Layout
19631 ] The color for the inset's background.
19633 \begin_inset CommandInset ref
19635 reference "chap:Names-of-colors"
19639 for a list of the available color names.
19642 \begin_layout Description
19643 \begin_inset Flex Code
19646 \begin_layout Plain Layout
19653 \begin_inset Flex Code
19656 \begin_layout Plain Layout
19665 \begin_inset space \thinspace{}
19669 \begin_inset Flex Code
19672 \begin_layout Plain Layout
19678 ] Whether to use the content of the inset as the label, when the inset is
19683 \begin_layout Description
19684 \begin_inset Flex Code
19687 \begin_layout Plain Layout
19694 \begin_inset Flex Code
19697 \begin_layout Plain Layout
19703 ] As with paragraph styles, see
19704 \begin_inset CommandInset ref
19706 reference "subsec:Paragraph-Styles"
19711 Note that you need to specify the complete type, e.
19712 \begin_inset space \thinspace{}
19716 \begin_inset space ~
19720 \begin_inset Flex Code
19723 \begin_layout Plain Layout
19724 CopyStyle Flex:<name>
19732 \begin_layout Description
19733 \begin_inset Flex Code
19736 \begin_layout Plain Layout
19743 \begin_inset Flex Code
19746 \begin_layout Plain Layout
19755 \begin_inset space \thinspace{}
19759 \begin_inset Flex Code
19762 \begin_layout Plain Layout
19768 ] Indicates whether the user may employ the Paragraph Settings dialog to
19769 customize the paragraph.
19772 \begin_layout Description
19773 \begin_inset Flex Code
19776 \begin_layout Plain Layout
19783 \begin_inset Flex Code
19786 \begin_layout Plain Layout
19793 \begin_inset Flex Code
19796 \begin_layout Plain Layout
19803 \begin_inset Flex Code
19806 \begin_layout Plain Layout
19812 , describing the rendering style used for the inset's frame and buttons.
19813 Footnotes generally use
19814 \begin_inset Flex Code
19817 \begin_layout Plain Layout
19823 , ERT insets generally
19824 \begin_inset Flex Code
19827 \begin_layout Plain Layout
19833 , and character styles
19834 \begin_inset Flex Code
19837 \begin_layout Plain Layout
19846 \begin_layout Description
19847 \begin_inset Flex Code
19850 \begin_layout Plain Layout
19857 \begin_inset Flex Code
19860 \begin_layout Plain Layout
19869 \begin_inset space \thinspace{}
19875 \begin_inset Flex Code
19878 \begin_layout Plain Layout
19887 \begin_inset Flex Code
19890 \begin_layout Plain Layout
19897 \begin_inset Flex Code
19900 \begin_layout Plain Layout
19907 Indicates whether the environment will stand on its own in the output or
19908 will appear inline with the surrounding text.
19909 If set to false, it is supposed that the \SpecialChar LaTeX
19910 environment ignores white space
19911 (including one newline character) after the
19912 \begin_inset Flex Code
19915 \begin_layout Plain Layout
19928 \begin_inset Flex Code
19931 \begin_layout Plain Layout
19945 \change_inserted 731793113 1538674858
19949 \begin_layout Description
19951 \change_inserted 731793113 1538674891
19952 \begin_inset Flex Code
19955 \begin_layout Plain Layout
19957 \change_inserted 731793113 1538674863
19969 ,1] Allow the contents of the inset to be edited externally (using whatever
19970 editor is defined for the document's output format).
19975 \begin_layout Description
19976 \begin_inset Flex Code
19979 \begin_layout Plain Layout
19985 Required at the end of the
19986 \begin_inset Flex Code
19989 \begin_layout Plain Layout
19998 \begin_layout Description
19999 \begin_inset Flex Code
20002 \begin_layout Plain Layout
20008 The font used for both the text body
20014 \begin_inset CommandInset ref
20016 reference "subsec:Font-description"
20021 Note that defining this font automatically defines the
20022 \begin_inset Flex Code
20025 \begin_layout Plain Layout
20031 to the same value, so define this first and define
20032 \begin_inset Flex Code
20035 \begin_layout Plain Layout
20041 later if you want them to be different.
20044 \begin_layout Description
20045 \begin_inset Flex Code
20048 \begin_layout Plain Layout
20049 FixedWidthPreambleEncoding
20055 \begin_inset Flex Code
20058 \begin_layout Plain Layout
20067 \begin_inset space \thinspace{}
20071 \begin_inset Flex Code
20074 \begin_layout Plain Layout
20080 ] Force a fixed width encoding for the translated contents of
20081 \begin_inset Flex Code
20084 \begin_layout Plain Layout
20091 \begin_inset Flex Code
20094 \begin_layout Plain Layout
20100 code generated by this layout.
20101 This is needed for special \SpecialChar LaTeX
20106 that do not work with variable width encodings such as
20111 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
20112 backends such as Xe\SpecialChar TeX
20114 Lua\SpecialChar TeX
20118 \begin_layout Description
20119 \begin_inset Flex Code
20122 \begin_layout Plain Layout
20123 ForceLocalFontSwitch
20129 \begin_inset Flex Code
20132 \begin_layout Plain Layout
20141 \begin_inset space \thinspace{}
20145 \begin_inset Flex Code
20148 \begin_layout Plain Layout
20154 ] When using babel, always use a local font switch (
20155 \begin_inset Flex Code
20158 \begin_layout Plain Layout
20166 ), never a global one (such as
20167 \begin_inset Flex Code
20170 \begin_layout Plain Layout
20181 \begin_layout Description
20182 \begin_inset Flex Code
20185 \begin_layout Plain Layout
20192 \begin_inset Flex Code
20195 \begin_layout Plain Layout
20204 \begin_inset space \thinspace{}
20208 \begin_inset Flex Code
20211 \begin_layout Plain Layout
20218 \begin_inset Quotes eld
20222 \begin_inset Quotes erd
20225 language, leading to Left-to-Right (Latin) output, e.
20226 \begin_inset space \thinspace{}
20230 \begin_inset space \space{}
20233 in \SpecialChar TeX
20238 \begin_layout Description
20239 \begin_inset Flex Code
20242 \begin_layout Plain Layout
20249 \begin_inset Flex Code
20252 \begin_layout Plain Layout
20261 \begin_inset space \thinspace{}
20265 \begin_inset Flex Code
20268 \begin_layout Plain Layout
20274 ] Force a a line break in the \SpecialChar LaTeX
20275 output before the inset starts and after
20277 This assures the inset itself is output on its own lines, for parsing purposes.
20280 \begin_layout Description
20281 \begin_inset Flex Code
20284 \begin_layout Plain Layout
20291 \begin_inset Flex Code
20294 \begin_layout Plain Layout
20303 \begin_inset space \thinspace{}
20307 \begin_inset Flex Code
20310 \begin_layout Plain Layout
20316 ] Indicates whether the
20317 \begin_inset Flex Code
20320 \begin_layout Plain Layout
20326 should be used or, instead, the user can change the paragraph style used
20331 \begin_layout Description
20332 \begin_inset Flex Code
20335 \begin_layout Plain Layout
20342 \begin_inset Flex Code
20345 \begin_layout Plain Layout
20354 \begin_inset space \thinspace{}
20358 \begin_inset Flex Code
20361 \begin_layout Plain Layout
20367 ] As with paragraph styles, see
20368 \begin_inset CommandInset ref
20370 reference "subsec:Paragraph-Styles"
20377 \begin_layout Description
20378 \begin_inset Flex Code
20381 \begin_layout Plain Layout
20387 These tags control the XHTML output.
20389 \begin_inset CommandInset ref
20391 reference "sec:Tags-for-XHTML"
20398 \begin_layout Description
20399 \begin_inset Flex Code
20402 \begin_layout Plain Layout
20409 \begin_inset Flex Code
20412 \begin_layout Plain Layout
20421 \begin_inset space \thinspace{}
20425 \begin_inset Flex Code
20428 \begin_layout Plain Layout
20434 ] Whether to include the contents of this inset in the strings generated
20435 for the `Outline' pane for all table of contents, regardless of the AddToToc
20437 One would not, for example, want the content of a footnote in a section
20438 header to be included in the TOC displayed in the outline, but one would
20439 normally want the content of a character style displayed.
20440 Default is false: not to include.
20443 \begin_layout Description
20444 \begin_inset Flex Code
20447 \begin_layout Plain Layout
20454 \begin_inset Flex Code
20457 \begin_layout Plain Layout
20466 \begin_inset space \thinspace{}
20470 \begin_inset Flex Code
20473 \begin_layout Plain Layout
20479 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
20480 of its contents in its item in the table of contents.
20481 Otherwise, only the label appears.
20484 \begin_layout Description
20485 \begin_inset Flex Code
20488 \begin_layout Plain Layout
20497 \begin_inset Flex Code
20500 \begin_layout Plain Layout
20509 \begin_inset space \thinspace{}
20513 \begin_inset Flex Code
20516 \begin_layout Plain Layout
20522 ] As with paragraph styles, see
20523 \begin_inset CommandInset ref
20525 reference "subsec:Paragraph-Styles"
20532 \begin_layout Description
20533 \begin_inset Flex Code
20536 \begin_layout Plain Layout
20542 The font used for the label.
20544 \begin_inset CommandInset ref
20546 reference "subsec:Font-description"
20551 Note that this definition can never appear before
20552 \begin_inset Flex Code
20555 \begin_layout Plain Layout
20561 , lest it be ineffective.
20564 \begin_layout Description
20565 \begin_inset Flex Code
20568 \begin_layout Plain Layout
20575 \begin_inset Flex Code
20578 \begin_layout Plain Layout
20585 \begin_inset Quotes erd
20589 \begin_inset Quotes erd
20592 ] What will be displayed on the button or elsewhere as the inset label.
20594 \begin_inset Flex Code
20597 \begin_layout Plain Layout
20605 \begin_inset Flex Code
20608 \begin_layout Plain Layout
20614 ) modify this label on the fly.
20617 \begin_layout Description
20618 \begin_inset Flex Code
20621 \begin_layout Plain Layout
20627 Language dependent preamble; see
20628 \begin_inset CommandInset ref
20630 reference "subsec:I18n"
20637 \begin_layout Description
20638 \begin_inset Flex Code
20641 \begin_layout Plain Layout
20648 \begin_inset Flex Code
20651 \begin_layout Plain Layout
20657 ] The name of the corresponding \SpecialChar LaTeX
20659 Either the environment or command name.
20662 \begin_layout Description
20663 \begin_inset Flex Code
20666 \begin_layout Plain Layout
20673 \begin_inset Flex Code
20676 \begin_layout Plain Layout
20682 ] The optional parameter for the corresponding
20683 \begin_inset Flex Code
20686 \begin_layout Plain Layout
20692 stuff, including possible bracket pairs like
20693 \begin_inset Flex Code
20696 \begin_layout Plain Layout
20703 This parameter cannot be changed from within \SpecialChar LyX
20705 \begin_inset Flex Code
20708 \begin_layout Plain Layout
20714 for customizable parameters).
20715 It will be output as is after all \SpecialChar LaTeX
20717 \begin_inset Flex Code
20720 \begin_layout Plain Layout
20729 \begin_layout Description
20730 \begin_inset Flex Code
20733 \begin_layout Plain Layout
20740 \begin_inset Flex Code
20743 \begin_layout Plain Layout
20744 Command, Environment, None
20749 ] How the style should be translated into \SpecialChar LaTeX
20754 \begin_layout Plain Layout
20755 \begin_inset Flex Code
20758 \begin_layout Plain Layout
20764 is perhaps a bit misleading, since these rules apply to SGML classes too.
20765 Visit the SGML class files for specific examples.
20774 \begin_layout Description
20775 \begin_inset Flex Code
20778 \begin_layout Plain Layout
20784 means nothing special
20787 \begin_layout Description
20788 \begin_inset Flex Code
20791 \begin_layout Plain Layout
20798 \begin_inset Flex Code
20801 \begin_layout Plain Layout
20808 {\SpecialChar ldots
20817 \begin_layout Description
20818 \begin_inset Flex Code
20821 \begin_layout Plain Layout
20828 \begin_inset Flex Code
20831 \begin_layout Plain Layout
20838 }\SpecialChar ldots
20853 \begin_layout Standard
20854 Putting the last few things together, the \SpecialChar LaTeX
20855 output will be either:
20858 \begin_layout LyX-Code
20861 LatexName[LatexParam]{\SpecialChar ldots
20865 \begin_layout Standard
20869 \begin_layout LyX-Code
20872 begin{LatexName}[LatexParam] \SpecialChar ldots
20878 \begin_layout Standard
20879 depending upon the \SpecialChar LaTeX
20884 \begin_layout Description
20885 \begin_inset Flex Code
20888 \begin_layout Plain Layout
20895 \begin_inset Flex Code
20898 \begin_layout Plain Layout
20904 ] A string that is put at the beginning of the layout content.
20905 A line break in the output can be indicated by
20906 \begin_inset Flex Code
20909 \begin_layout Plain Layout
20918 \begin_layout Description
20919 \begin_inset Flex Code
20922 \begin_layout Plain Layout
20929 \begin_inset Flex Code
20932 \begin_layout Plain Layout
20939 \begin_inset Flex Code
20942 \begin_layout Plain Layout
20949 \begin_inset Flex Code
20952 \begin_layout Plain Layout
20959 \begin_inset Flex Code
20962 \begin_layout Plain Layout
20968 (indicating a dummy definition ending definitions of charstyles, etc).
20969 This entry is required in and is only meaningful for Flex insets.
20970 Among other things, it determines on which menu this inset will appear.
20972 \begin_inset Flex Code
20975 \begin_layout Plain Layout
20982 \begin_inset Flex Code
20985 \begin_layout Plain Layout
20991 will automatically set
20992 \begin_inset Flex Code
20995 \begin_layout Plain Layout
21002 \begin_inset Flex Code
21005 \begin_layout Plain Layout
21013 \begin_inset Flex Code
21016 \begin_layout Plain Layout
21022 can be set to true, or
21023 \begin_inset Flex Code
21026 \begin_layout Plain Layout
21033 \begin_inset Flex Code
21036 \begin_layout Plain Layout
21042 insets by setting it
21047 \begin_inset Flex Code
21050 \begin_layout Plain Layout
21057 \change_inserted -712698321 1555575738
21061 \begin_layout Description
21063 \change_inserted -712698321 1555575844
21064 \begin_inset Flex Code
21067 \begin_layout Plain Layout
21069 \change_inserted -712698321 1555575740
21078 \begin_inset Flex Code
21081 \begin_layout Plain Layout
21083 \change_inserted -712698321 1555575740
21091 A dedicated string for the menu.
21092 You can define an accelerator by appending the respective character to
21093 the string, divided by
21094 \begin_inset Quotes eld
21098 \begin_inset Quotes erd
21102 \begin_inset space \thinspace{}
21106 \begin_inset space \space{}
21110 \begin_inset Quotes eld
21114 \begin_inset Flex Code
21117 \begin_layout Plain Layout
21119 \change_inserted -712698321 1555575781
21128 \begin_inset Quotes erd
21132 This specification is optional.
21133 If it is not given the inset name as specified in the type declaration
21134 will be used instead for the menu.
21139 \begin_layout Description
21140 \begin_inset Flex Code
21143 \begin_layout Plain Layout
21150 \begin_inset Flex Code
21153 \begin_layout Plain Layout
21162 \begin_inset space \thinspace{}
21166 \begin_inset Flex Code
21169 \begin_layout Plain Layout
21175 ] Whether multiple paragraphs are permitted in this inset.
21177 \begin_inset Flex Code
21180 \begin_layout Plain Layout
21186 to the same value and
21187 \begin_inset Flex Code
21190 \begin_layout Plain Layout
21196 to the opposite value.
21197 These can be reset to other values, if they are used
21202 \begin_inset Flex Code
21205 \begin_layout Plain Layout
21215 \begin_layout Description
21216 \begin_inset Flex Code
21219 \begin_layout Plain Layout
21226 \begin_inset Flex Code
21229 \begin_layout Plain Layout
21238 \begin_inset space \thinspace{}
21242 \begin_inset Flex Code
21245 \begin_layout Plain Layout
21251 ] Whether fragile commands in this inset should be
21252 \begin_inset Flex Code
21255 \begin_layout Plain Layout
21268 whether the command should itself be protected.) Default is false.
21269 \change_inserted -712698321 1523633958
21273 \begin_layout Description
21275 \change_inserted -712698321 1552395786
21276 \begin_inset Flex Code
21279 \begin_layout Plain Layout
21281 \change_inserted -712698321 1523633961
21290 \begin_inset Flex Code
21293 \begin_layout Plain Layout
21295 \change_inserted -712698321 1523633958
21306 \begin_inset space \thinspace{}
21310 \begin_inset Flex Code
21313 \begin_layout Plain Layout
21315 \change_inserted -712698321 1523633958
21323 ] This causes macros that contain this inset to be protected with
21324 \begin_inset Flex Code
21327 \begin_layout Plain Layout
21329 \change_inserted -712698321 1523634038
21344 ) if necessary and thus allows (some) verbatim stuff in macros.
21348 \begin_layout Description
21350 \change_inserted -712698321 1555579651
21351 \begin_inset Flex Code
21354 \begin_layout Plain Layout
21356 \change_inserted -712698321 1552395787
21365 \begin_inset Flex Code
21368 \begin_layout Plain Layout
21370 \change_inserted -712698321 1552395787
21381 \begin_inset space \thinspace{}
21385 \begin_inset Flex Code
21388 \begin_layout Plain Layout
21390 \change_inserted -712698321 1552395787
21398 ] Whether specific commands in this inset (such as
21399 \begin_inset Flex Code
21402 \begin_layout Plain Layout
21404 \change_inserted -712698321 1552395787
21415 \begin_inset Flex Code
21418 \begin_layout Plain Layout
21420 \change_inserted -712698321 1552395787
21430 ) should be protected in an
21431 \begin_inset Flex Code
21434 \begin_layout Plain Layout
21436 \change_inserted -712698321 1552395787
21447 This is particularly needed for insets that draw on
21455 commands which parse their content in complex ways.
21459 \begin_layout Description
21461 \change_inserted -712698321 1555579742
21462 \begin_inset Flex Code
21465 \begin_layout Plain Layout
21467 \change_inserted -712698321 1555579658
21476 \begin_inset Flex Code
21479 \begin_layout Plain Layout
21481 \change_inserted -712698321 1555579651
21489 Option to define a different command (from the default
21490 \begin_inset Flex Code
21493 \begin_layout Plain Layout
21495 \change_inserted -712698321 1555579742
21507 ) to be used for line breaks.
21508 The initial backslash must not be specified.
21513 \begin_layout Description
21514 \begin_inset Flex Code
21517 \begin_layout Plain Layout
21524 \begin_inset Flex Code
21527 \begin_layout Plain Layout
21533 ] Deletes an existing
21534 \begin_inset Flex Code
21537 \begin_layout Plain Layout
21546 \begin_layout Description
21547 \begin_inset Flex Code
21550 \begin_layout Plain Layout
21557 \begin_inset Flex Code
21560 \begin_layout Plain Layout
21567 \begin_inset Flex Code
21570 \begin_layout Plain Layout
21576 that has replaced this
21577 \begin_inset Flex Code
21580 \begin_layout Plain Layout
21587 This is used to rename an
21588 \begin_inset Flex Code
21591 \begin_layout Plain Layout
21597 , while keeping backward compatibility.
21598 \change_inserted -712698321 1559491850
21602 \begin_layout Description
21604 \change_inserted -712698321 1559492002
21605 \begin_inset Flex Code
21608 \begin_layout Plain Layout
21610 \change_inserted -712698321 1559491854
21619 \begin_inset Flex Code
21622 \begin_layout Plain Layout
21624 \change_inserted -712698321 1559491850
21635 \begin_inset space \thinspace{}
21639 \begin_inset Flex Code
21642 \begin_layout Plain Layout
21644 \change_inserted -712698321 1559491850
21652 ] If this is set to
21653 \begin_inset Flex Code
21656 \begin_layout Plain Layout
21658 \change_inserted -712698321 1559491881
21666 , paragraph breaks will be ignored in the output.
21667 This might be useful for insets where the content should be alignable on
21668 different lines only in the \SpecialChar LyX
21669 workarea, without any effect in the output.
21674 \begin_layout Description
21675 \begin_inset Flex Code
21678 \begin_layout Plain Layout
21685 \begin_inset Flex Code
21688 \begin_layout Plain Layout
21697 \begin_inset space \thinspace{}
21701 \begin_inset Flex Code
21704 \begin_layout Plain Layout
21710 ] As with paragraph styles, see
21711 \begin_inset CommandInset ref
21713 reference "subsec:Paragraph-Styles"
21721 \begin_layout Description
21722 \begin_inset Flex Code
21725 \begin_layout Plain Layout
21732 \begin_inset Flex Code
21735 \begin_layout Plain Layout
21744 \begin_inset space \thinspace{}
21748 \begin_inset Flex Code
21751 \begin_layout Plain Layout
21757 ] As with paragraph styles, see
21758 \begin_inset CommandInset ref
21760 reference "subsec:Paragraph-Styles"
21768 \begin_layout Description
21769 \begin_inset Flex Code
21772 \begin_layout Plain Layout
21778 As with paragraph styles, see
21779 \begin_inset CommandInset ref
21781 reference "subsec:Paragraph-Styles"
21788 \begin_layout Description
21789 \begin_inset Flex Code
21792 \begin_layout Plain Layout
21799 \begin_inset Flex Code
21802 \begin_layout Plain Layout
21808 ] The prefix to use when creating labels referring to insets of this type.
21809 This allows the use of formatted references.
21812 \begin_layout Description
21813 \begin_inset Flex Code
21816 \begin_layout Plain Layout
21823 \begin_inset Flex Code
21826 \begin_layout Plain Layout
21832 ] As with paragraph styles, see
21833 \begin_inset CommandInset ref
21835 reference "subsec:Paragraph-Styles"
21842 \begin_layout Description
21843 \begin_inset Flex Code
21846 \begin_layout Plain Layout
21853 \begin_inset Flex Code
21856 \begin_layout Plain Layout
21865 \begin_inset space \thinspace{}
21869 \begin_inset Flex Code
21872 \begin_layout Plain Layout
21878 ] Resets the \SpecialChar LaTeX
21879 arguments of this layout (as defined via the
21880 \begin_inset Flex Code
21883 \begin_layout Plain Layout
21890 This is useful if you have copied a style via
21891 \begin_inset Flex Code
21894 \begin_layout Plain Layout
21900 , but you do not want to inherit its (required and optional) arguments.
21903 \begin_layout Description
21904 \begin_inset Flex Code
21907 \begin_layout Plain Layout
21914 \begin_inset Flex Code
21917 \begin_layout Plain Layout
21926 \begin_inset space \thinspace{}
21930 \begin_inset Flex Code
21933 \begin_layout Plain Layout
21940 \change_inserted -712698321 1597733473
21942 \begin_inset Flex Code
21945 \begin_layout Plain Layout
21947 \change_inserted -712698321 1597732178
21955 , font changes are redone inside the respective inset (in the output) even
21956 if the inset itself is in the context of this font changes (e.
21957 \begin_inset space \thinspace{}
21961 \begin_inset Flex Code
21964 \begin_layout Plain Layout
21966 \change_inserted -712698321 1597733683
21969 textbf{Sourrounding text
21973 textbf{content}}\SpecialChar ldots
21982 \begin_inset Flex Code
21985 \begin_layout Plain Layout
21987 \change_inserted -712698321 1597733686
21990 textbf{Sourrounding text
21992 myinset{content}\SpecialChar ldots
21999 Setting this makes sense for commands that internally reset font settings
22001 \begin_inset space \thinspace{}
22005 Note that wrongly setting this might lead to unwanted result (e.
22006 \begin_inset space \thinspace{}
22010 \begin_inset Flex Code
22013 \begin_layout Plain Layout
22015 \change_inserted -712698321 1597733688
22018 emph{Sourrounding text
22022 emph{content}}\SpecialChar ldots
22028 , content is upright, as
22029 \begin_inset Flex Code
22032 \begin_layout Plain Layout
22034 \change_inserted -712698321 1597733278
22044 \change_deleted -712698321 1597733283
22045 Whether this inset should use the font of its surrounding environment or
22050 \change_deleted -712698321 1597733290
22052 \change_inserted -712698321 1597733290
22054 \begin_inset Flex Code
22057 \begin_layout Plain Layout
22059 \change_inserted -712698321 1597733292
22068 \change_deleted -712698321 1597733327
22069 use the font of the surrounding environment
22070 \change_inserted -712698321 1597733343
22071 font changes are not redone inside the inset
22076 \begin_layout Description
22077 \begin_inset Flex Code
22080 \begin_layout Plain Layout
22087 \begin_inset Flex Code
22090 \begin_layout Plain Layout
22096 ] A string that is put at the end of the layout content.
22097 A line break in the output can be indicated by
22098 \begin_inset Flex Code
22101 \begin_layout Plain Layout
22110 \begin_layout Description
22111 \begin_inset Flex Code
22114 \begin_layout Plain Layout
22121 \begin_inset Flex Code
22124 \begin_layout Plain Layout
22131 \begin_inset space \thinspace{}
22135 \begin_inset Flex Code
22138 \begin_layout Plain Layout
22146 ] Allow spell-checking the contents of this inset.
22150 \begin_layout Subsection
22152 \begin_inset CommandInset label
22154 name "subsec:Counters"
22161 \begin_layout Standard
22162 It is necessary to define the counters (
22163 \begin_inset Flex Noun
22166 \begin_layout Plain Layout
22173 \begin_inset Flex Noun
22176 \begin_layout Plain Layout
22182 , \SpecialChar ldots
22183 ) in the text class itself.
22184 The standard counters are defined in the file
22185 \begin_inset Flex Code
22188 \begin_layout Plain Layout
22194 , so you may have to do no more than add
22197 \begin_layout LyX-Code
22198 Input stdcounters.inc
22201 \begin_layout Standard
22202 to your layout file to get them to work.
22203 But if you want to define custom counters, then you can do so.
22204 The counter declaration must begin with:
22207 \begin_layout LyX-Code
22208 Counter CounterName
22211 \begin_layout Standard
22213 \begin_inset Flex Code
22216 \begin_layout Plain Layout
22222 ' is replaced by the name of the counter.
22223 And it must end with
22224 \begin_inset Quotes eld
22228 \begin_inset Flex Code
22231 \begin_layout Plain Layout
22238 \begin_inset Quotes erd
22242 The following parameters can also be used:
22245 \begin_layout Description
22246 \begin_inset Flex Code
22249 \begin_layout Plain Layout
22256 \begin_inset Flex Code
22259 \begin_layout Plain Layout
22265 ] Sets the initial value for the counter, to which it will be reset whenever
22267 Normally, one will want the default, 1.
22270 \begin_layout Description
22271 \begin_inset Flex Code
22274 \begin_layout Plain Layout
22281 \begin_inset Flex Code
22284 \begin_layout Plain Layout
22291 \begin_inset Quotes erd
22295 \begin_inset Quotes erd
22298 ] When defined, this string defines how the counter is displayed.
22299 Setting this value sets
22300 \begin_inset Flex Code
22303 \begin_layout Plain Layout
22304 LabelStringAppendix
22310 The following special constructs can be used in the string:
22314 \begin_layout Itemize
22315 \begin_inset Flex Code
22318 \begin_layout Plain Layout
22326 will be replaced by the expansion of the
22327 \begin_inset Flex Code
22330 \begin_layout Plain Layout
22337 \begin_inset Flex Code
22340 \begin_layout Plain Layout
22341 LabelStringAppendix
22347 \begin_inset Flex Code
22350 \begin_layout Plain Layout
22360 \begin_layout Itemize
22361 counter values can be expressed using \SpecialChar LaTeX
22363 \begin_inset Newline newline
22367 \begin_inset Flex Code
22370 \begin_layout Plain Layout
22387 \begin_inset Flex Code
22390 \begin_layout Plain Layout
22402 \begin_layout Plain Layout
22412 Actually, the situation is a bit more complicated: any
22431 other than those described below will produce arabic numerals.
22432 It would not be surprising to see this change in the future.
22438 \begin_inset Flex Code
22441 \begin_layout Plain Layout
22447 : 1, 2, 3,\SpecialChar ldots
22449 \begin_inset Flex Code
22452 \begin_layout Plain Layout
22458 for lower-case letters: a, b, c, \SpecialChar ldots
22460 \begin_inset Flex Code
22463 \begin_layout Plain Layout
22469 for upper-case letters: A, B, C, \SpecialChar ldots
22471 \begin_inset Flex Code
22474 \begin_layout Plain Layout
22480 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
22482 \begin_inset Flex Code
22485 \begin_layout Plain Layout
22491 for upper-case roman numerals: I, II, III\SpecialChar ldots
22493 \begin_inset Flex Code
22496 \begin_layout Plain Layout
22502 for hebrew numerals.
22506 \begin_layout Standard
22507 If LabelString is not defined, a default value is constructed as follows:
22508 if the counter has a master counter
22509 \begin_inset Flex Code
22512 \begin_layout Plain Layout
22519 \begin_inset Flex Code
22522 \begin_layout Plain Layout
22529 \begin_inset Newline newline
22533 \begin_inset Flex Code
22536 \begin_layout Plain Layout
22546 is used; otherwise the string
22547 \begin_inset Flex Code
22550 \begin_layout Plain Layout
22561 \begin_layout Description
22562 \begin_inset Flex Code
22565 \begin_layout Plain Layout
22566 LabelStringAppendix
22572 \begin_inset Flex Code
22575 \begin_layout Plain Layout
22582 \begin_inset Quotes erd
22586 \begin_inset Quotes erd
22590 \begin_inset Flex Code
22593 \begin_layout Plain Layout
22599 , but for use in the Appendix.
22602 \begin_layout Description
22603 \begin_inset Flex Code
22606 \begin_layout Plain Layout
22613 \begin_inset Flex Code
22616 \begin_layout Plain Layout
22623 \begin_inset Quotes erd
22627 \begin_inset Quotes erd
22630 ] A format for use with formatted references to this counter.
22631 For example, one might want to have references to section numbers appear
22633 \begin_inset Quotes eld
22637 \begin_inset Quotes erd
22641 The string should contain
22642 \begin_inset Quotes eld
22646 \begin_inset Quotes erd
22650 This will be replaced by the counter number itself.
22651 So, for sections, it would be: Section ##.
22654 \begin_layout Description
22655 \begin_inset Flex Code
22658 \begin_layout Plain Layout
22665 \begin_inset Flex Code
22668 \begin_layout Plain Layout
22675 \begin_inset Quotes erd
22679 \begin_inset Quotes erd
22682 ] If this is set to the name of another counter, the present counter will
22683 be reset every time the other one is increased.
22685 \begin_inset Flex Code
22688 \begin_layout Plain Layout
22695 \begin_inset Flex Code
22698 \begin_layout Plain Layout
22707 \begin_layout Subsection
22709 \begin_inset CommandInset label
22711 name "subsec:Font-description"
22718 \begin_layout Standard
22719 A font description looks like this:
22722 \begin_layout LyX-Code
22739 \begin_layout LyX-Code
22743 \begin_layout LyX-Code
22747 \begin_layout Standard
22748 The following commands are available:
22751 \begin_layout Description
22752 \begin_inset Flex Code
22755 \begin_layout Plain Layout
22762 \begin_inset Flex Code
22765 \begin_layout Plain Layout
22774 \begin_inset Flex Code
22777 \begin_layout Plain Layout
22784 \begin_inset Flex Code
22787 \begin_layout Plain Layout
22794 \begin_inset Flex Code
22797 \begin_layout Plain Layout
22804 \begin_inset Flex Code
22807 \begin_layout Plain Layout
22814 \begin_inset Flex Code
22817 \begin_layout Plain Layout
22824 \begin_inset Flex Code
22827 \begin_layout Plain Layout
22834 \begin_inset Flex Code
22837 \begin_layout Plain Layout
22844 \begin_inset Flex Code
22847 \begin_layout Plain Layout
22854 \begin_inset Flex Code
22857 \begin_layout Plain Layout
22864 \begin_inset Flex Code
22867 \begin_layout Plain Layout
22874 \begin_inset Flex Code
22877 \begin_layout Plain Layout
22884 \begin_inset Flex Code
22887 \begin_layout Plain Layout
22894 \begin_inset Flex Code
22897 \begin_layout Plain Layout
22904 \begin_inset Flex Code
22907 \begin_layout Plain Layout
22914 \begin_inset Flex Code
22917 \begin_layout Plain Layout
22924 \begin_inset Flex Code
22927 \begin_layout Plain Layout
22934 \begin_inset Flex Code
22937 \begin_layout Plain Layout
22944 \begin_inset Flex Code
22947 \begin_layout Plain Layout
22954 \begin_inset Flex Code
22957 \begin_layout Plain Layout
22966 \begin_layout Description
22967 \begin_inset Flex Code
22970 \begin_layout Plain Layout
22977 \begin_inset Flex Code
22980 \begin_layout Plain Layout
22989 \begin_inset Flex Code
22992 \begin_layout Plain Layout
22999 \begin_inset Flex Code
23002 \begin_layout Plain Layout
23011 \begin_layout Description
23012 \begin_inset Flex Code
23015 \begin_layout Plain Layout
23022 \begin_inset Flex Code
23025 \begin_layout Plain Layout
23031 ] Valid arguments are:
23032 \begin_inset Flex Code
23035 \begin_layout Plain Layout
23042 \begin_inset Flex Code
23045 \begin_layout Plain Layout
23052 \begin_inset Flex Code
23055 \begin_layout Plain Layout
23062 \begin_inset Flex Code
23065 \begin_layout Plain Layout
23072 \begin_inset Flex Code
23075 \begin_layout Plain Layout
23082 \begin_inset Flex Code
23085 \begin_layout Plain Layout
23092 \begin_inset Flex Code
23095 \begin_layout Plain Layout
23102 \begin_inset Flex Code
23105 \begin_layout Plain Layout
23112 \begin_inset Flex Code
23115 \begin_layout Plain Layout
23122 \begin_inset Flex Code
23125 \begin_layout Plain Layout
23132 \begin_inset Flex Code
23135 \begin_layout Plain Layout
23142 \begin_inset Flex Code
23145 \begin_layout Plain Layout
23152 Each of these turns on or off the corresponding attribute.
23154 \begin_inset Flex Code
23157 \begin_layout Plain Layout
23163 turns on emphasis, and
23164 \begin_inset Flex Code
23167 \begin_layout Plain Layout
23175 \begin_inset Newline newline
23178 If the latter seems puzzling, remember that the font settings for the present
23179 context are generally inherited from the surrounding context.
23181 \begin_inset Flex Code
23184 \begin_layout Plain Layout
23190 would turn off the emphasis that was anyway in effect, say, in a theorem
23194 \begin_layout Description
23195 \begin_inset Flex Code
23198 \begin_layout Plain Layout
23205 \begin_inset Flex Code
23208 \begin_layout Plain Layout
23217 \begin_inset Flex Code
23220 \begin_layout Plain Layout
23229 \begin_layout Description
23230 \begin_inset Flex Code
23233 \begin_layout Plain Layout
23240 \begin_inset Flex Code
23243 \begin_layout Plain Layout
23252 \begin_inset Flex Code
23255 \begin_layout Plain Layout
23262 \begin_inset Flex Code
23265 \begin_layout Plain Layout
23272 \begin_inset Flex Code
23275 \begin_layout Plain Layout
23284 \begin_layout Description
23285 \begin_inset Flex Code
23288 \begin_layout Plain Layout
23295 \begin_inset Flex Code
23298 \begin_layout Plain Layout
23305 \begin_inset Flex Code
23308 \begin_layout Plain Layout
23315 \begin_inset Flex Code
23318 \begin_layout Plain Layout
23327 \begin_inset Flex Code
23330 \begin_layout Plain Layout
23337 \begin_inset Flex Code
23340 \begin_layout Plain Layout
23347 \begin_inset Flex Code
23350 \begin_layout Plain Layout
23357 \begin_inset Flex Code
23360 \begin_layout Plain Layout
23367 \begin_inset Flex Code
23370 \begin_layout Plain Layout
23379 \begin_layout Subsection
23380 \begin_inset CommandInset label
23382 name "subsec:Citation-engine-description"
23386 Cite engine description
23389 \begin_layout Standard
23391 \begin_inset Flex Code
23394 \begin_layout Plain Layout
23400 blocks, as used mainly in cite engine files (see
23401 \begin_inset CommandInset ref
23403 reference "subsec:Cite-Engine-Files"
23410 ), define the citation commands provided by a specific
23411 \begin_inset Quotes eld
23415 \begin_inset Quotes erd
23419 A cite engine, in \SpecialChar LyX
23420 terms, is way specific way to format citations, using
23421 numbers, author names and/or years.
23422 Currently, \SpecialChar LyX
23423 supports three such engine types, namely:
23426 \begin_layout Enumerate
23427 \begin_inset Flex Code
23430 \begin_layout Plain Layout
23436 : the default Bib\SpecialChar TeX
23437 way to format citations, a simple numeric style (e.
23438 \begin_inset space \thinspace{}
23442 \begin_inset Quotes eld
23446 \begin_inset Quotes erd
23452 \begin_layout Enumerate
23453 \begin_inset Flex Code
23456 \begin_layout Plain Layout
23462 : Harvard-styled citations using author names and publication year (e.
23463 \begin_inset space \thinspace{}
23467 \begin_inset Quotes eld
23470 Smith and Miller (2017b)
23471 \begin_inset Quotes erd
23477 \begin_layout Enumerate
23478 \begin_inset Flex Code
23481 \begin_layout Plain Layout
23487 : extended numerical citations that also allow for author or title next
23489 \begin_inset space \thinspace{}
23493 \begin_inset Quotes eld
23496 Smith and Miller [1]
23497 \begin_inset Quotes erd
23503 \begin_layout Standard
23504 \begin_inset Flex Code
23507 \begin_layout Plain Layout
23513 blocks look like this:
23516 \begin_layout LyX-Code
23520 \begin_layout LyX-Code
23524 \begin_layout LyX-Code
23528 \begin_layout LyX-Code
23529 citeyearpar[][]=parencite*
23532 \begin_layout LyX-Code
23536 \begin_layout LyX-Code
23540 \begin_layout Standard
23542 \begin_inset Flex Code
23545 \begin_layout Plain Layout
23551 denotes the engine.
23552 The individual lines respectively define a cite command or cite command
23553 paradigm supported by this engine.
23554 The line can be as simple as a cite command that is used both to name the
23555 respective \SpecialChar LyX
23556 command and the \SpecialChar LaTeX
23557 output or more complex in order to differentiate
23559 The full syntax is:
23562 \begin_layout LyX-Code
23563 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
23566 \begin_layout Itemize
23567 \begin_inset Flex Code
23570 \begin_layout Plain Layout
23576 : The name as used in the
23577 \begin_inset Flex Code
23580 \begin_layout Plain Layout
23590 \begin_layout Standard
23591 For portability reasons, we try to use the same name for same-formatted
23592 commands in different cite packages (thus many names stem from natbib,
23593 and thus we need to differentiate a
23594 \begin_inset Flex Code
23597 \begin_layout Plain Layout
23603 sometimes, if the \SpecialChar LaTeX
23604 command names differ).
23608 \begin_layout Itemize
23609 \begin_inset Flex Code
23612 \begin_layout Plain Layout
23618 : a (comma-separated) list of commands that fall back to the given
23619 \begin_inset Flex Code
23622 \begin_layout Plain Layout
23628 in the current engine.
23629 This eases the switch of citation packages and engines.
23631 \begin_inset Flex Code
23634 \begin_layout Plain Layout
23641 \begin_inset Flex Code
23644 \begin_layout Plain Layout
23650 in layout definitions.
23653 \begin_layout Itemize
23654 \begin_inset Flex Code
23657 \begin_layout Plain Layout
23663 : The actual \SpecialChar LaTeX
23664 command that is output.
23668 \begin_layout Standard
23669 \begin_inset Flex Code
23672 \begin_layout Plain Layout
23679 \begin_inset Flex Code
23682 \begin_layout Plain Layout
23690 \begin_inset Flex Code
23693 \begin_layout Plain Layout
23700 \begin_inset Flex Code
23703 \begin_layout Plain Layout
23709 will be output to \SpecialChar LaTeX
23713 \begin_layout Standard
23717 \begin_layout Itemize
23718 Capitalization indicates that the command also has a capitalized form (
23719 \begin_inset Flex Code
23722 \begin_layout Plain Layout
23732 \begin_inset Flex Code
23735 \begin_layout Plain Layout
23744 These usually enforce up-casing of name prefixes (
23749 \begin_inset Formula $\Rightarrow$
23759 \begin_layout Itemize
23761 \begin_inset Flex Code
23764 \begin_layout Plain Layout
23770 indicate the number of optional arguments (there can be 0–2).
23773 \begin_layout Itemize
23775 \begin_inset Flex Code
23778 \begin_layout Plain Layout
23784 indicates there is a starred version of the command (
23785 \begin_inset Flex Code
23788 \begin_layout Plain Layout
23798 \begin_inset Flex Code
23801 \begin_layout Plain Layout
23814 \begin_layout Standard
23815 By default, the starred version means: Output all authors even if it should
23817 \begin_inset Quotes eld
23821 \begin_inset Quotes erd
23825 \begin_inset Flex Code
23828 \begin_layout Plain Layout
23837 \begin_layout Standard
23838 If the star has a different meaning for a given command, it can be specified
23840 \begin_inset Flex Code
23843 \begin_layout Plain Layout
23844 <!_stardesc!_stardesctooltip>
23850 Maximal two translatable macro keywords, marked by the prefix
23851 \begin_inset Flex Code
23854 \begin_layout Plain Layout
23861 The first points to the string that replaces the
23862 \begin_inset Quotes eld
23866 \begin_inset Quotes erd
23869 checkbox label in the citation dialog, the second one to an optional tool
23870 tip for this checkbox.
23874 \begin_layout Standard
23875 Note that these two macros have to be defined in a
23876 \begin_inset Flex Code
23879 \begin_layout Plain Layout
23885 (see next section), dropping the
23886 \begin_inset Flex Code
23889 \begin_layout Plain Layout
23895 from the prefix, like this:
23898 \begin_layout LyX-Code
23899 _stardesc Sta&rred command label
23902 \begin_layout LyX-Code
23903 _stardesctooltip Tooltip for the starred command checkbox.
23907 \begin_layout Itemize
23909 \begin_inset Flex Code
23912 \begin_layout Plain Layout
23918 indicates that this command features
23919 \begin_inset Quotes eld
23922 qualified citation lists
23923 \begin_inset Quotes erd
23931 -specific feature for multi-reference citations where an individual pre-
23932 and postnote can be given to each reference in the list.
23933 Please refer to the
23937 manual for details.
23938 \change_inserted -712698321 1526898670
23942 \begin_layout Standard
23944 \change_inserted -712698321 1526899524
23945 If you want to add a cite command to a cite engine (e.
23946 \begin_inset space \thinspace{}
23949 g., add a specific command provided by a class), you can use
23950 \begin_inset Flex Code
23953 \begin_layout Plain Layout
23955 \change_inserted -712698321 1526898768
23956 AddToCiteEngine <engine type> \SpecialChar ldots
23965 Note that only cite commands that do not exist yet are added.
23970 \begin_layout Subsection
23971 \begin_inset CommandInset label
23973 name "subsec:Citation-format-description"
23977 Cite format description
23980 \begin_layout Standard
23982 \begin_inset Flex Code
23985 \begin_layout Plain Layout
23991 blocks are used to describe how bibliographic information should be displayed,
23992 both within \SpecialChar LyX
23993 itself (in the citation dialog and in tooltips, for example)
23994 and in XHTML output.
23995 Such a block might look like this:
23998 \begin_layout LyX-Code
24002 \begin_layout LyX-Code
24006 \begin_layout LyX-Code
24010 \begin_layout LyX-Code
24014 \begin_layout Standard
24018 \begin_layout LyX-Code
24022 \begin_layout LyX-Code
24026 \begin_layout LyX-Code
24030 \begin_layout LyX-Code
24034 \begin_layout Standard
24035 In the first case, the individual lines define how the bibliographic information
24036 associated with an article or book, respectively, is to be displayed, and
24037 such a definition can be given for any
24038 \begin_inset Quotes els
24042 \begin_inset Quotes ers
24045 that might be present in a Bib\SpecialChar TeX
24048 defines a default format in the source code that will be used if no specific
24049 definition has been given.
24051 predefines several formats in the file
24052 \begin_inset Flex Code
24055 \begin_layout Plain Layout
24061 , which is included in most of \SpecialChar LyX
24062 's document classes.
24065 \begin_layout Standard
24066 In the second case, the lines define how a specific citation command (in
24068 \begin_inset Flex Code
24071 \begin_layout Plain Layout
24080 \begin_inset Flex Code
24083 \begin_layout Plain Layout
24091 ) is to be displayed on the citation inset label, in the citation dialog,
24092 menu or XHTML output.
24094 defines such formats for the citation style variants it supports via
24096 Document\SpecialChar menuseparator
24097 Setting\SpecialChar menuseparator
24098 Bibliography\SpecialChar ldots
24102 \begin_inset Flex Code
24105 \begin_layout Plain Layout
24111 files that are shipped with \SpecialChar LyX
24113 \begin_inset CommandInset ref
24115 reference "subsec:Cite-Engine-Files"
24125 \begin_layout Standard
24126 The definitions use a simple language that allows Bib\SpecialChar TeX
24127 keys to be replaced
24129 Keys should be enclosed in
24130 \begin_inset Flex Code
24133 \begin_layout Plain Layout
24140 \begin_inset Flex Code
24143 \begin_layout Plain Layout
24150 So a simple definition might look like this:
24153 \begin_layout LyX-Code
24155 \begin_inset Quotes eld
24159 \begin_inset Quotes erd
24165 \begin_layout Standard
24166 This would print the author, followed by a comma, followed by the title,
24167 in quotes, followed by a period.
24170 \begin_layout Standard
24171 Of course, sometimes you may want to print a key only if it exists.
24172 This can be done by using a conditional construction, such as:
24173 \begin_inset Flex Code
24176 \begin_layout Plain Layout
24178 \begin_inset space ~
24188 \begin_inset Flex Code
24191 \begin_layout Plain Layout
24197 key exists, then print
24198 \begin_inset Quotes eld
24202 \begin_inset space ~
24206 \begin_inset Quotes erd
24209 followed by the volume key.
24210 It is also possible to have an else clause in the conditional, such as:
24211 \begin_inset Newline newline
24215 \begin_inset Flex Code
24218 \begin_layout Plain Layout
24219 {%author%[[%author%]][[%editor%, ed.]]}
24225 \begin_inset Newline newline
24229 \begin_inset Flex Code
24232 \begin_layout Plain Layout
24238 key is printed if it exists; otherwise, the editor key is printed, followed
24240 \begin_inset Quotes eld
24244 \begin_inset space ~
24248 \begin_inset Quotes erd
24251 Note that the key is again enclosed in
24252 \begin_inset Flex Code
24255 \begin_layout Plain Layout
24261 signs; the entire conditional is enclosed in braces; and the if and else
24262 clauses are enclosed in double brackets,
24263 \begin_inset Quotes eld
24267 \begin_inset Flex Code
24270 \begin_layout Plain Layout
24277 \begin_inset Quotes eld
24281 \begin_inset Quotes eld
24285 \begin_inset Flex Code
24288 \begin_layout Plain Layout
24295 \begin_inset Quotes erd
24299 There must be no space between any of these.
24302 \begin_layout Standard
24303 Next to the entry keys, there are some special keys that can be used for
24304 these conditionals:
24307 \begin_layout Itemize
24308 \begin_inset Flex Code
24311 \begin_layout Plain Layout
24312 {%dialog%[[true]][[false]]}
24318 \begin_inset Quotes eld
24322 \begin_inset Quotes erd
24325 part for dialogs and menus, the
24326 \begin_inset Quotes eld
24330 \begin_inset Quotes erd
24333 part for other contexts (workarea, export)
24336 \begin_layout Itemize
24337 \begin_inset Flex Code
24340 \begin_layout Plain Layout
24341 {%export%[[true]][[false]]}
24347 \begin_inset Quotes eld
24351 \begin_inset Quotes erd
24354 part for export and menus, the
24355 \begin_inset Quotes eld
24359 \begin_inset Quotes erd
24362 part for other contexts (workarea, dialog)
24365 \begin_layout Itemize
24366 \begin_inset Flex Code
24369 \begin_layout Plain Layout
24376 \begin_inset Quotes eld
24380 \begin_inset Quotes erd
24383 part if another item follows (e.
24384 \begin_inset space \thinspace{}
24387 g., in a citation with multiple keys)
24390 \begin_layout Itemize
24391 \begin_inset Flex Code
24394 \begin_layout Plain Layout
24395 {%second%[[true]][[false]]}
24401 \begin_inset Quotes eld
24405 \begin_inset Quotes erd
24408 if this is the second of multiple items, else the
24409 \begin_inset Quotes eld
24413 \begin_inset Quotes erd
24419 \begin_layout Itemize
24420 \begin_inset Flex Code
24423 \begin_layout Plain Layout
24424 {%ifstar%[[true]][[false]]}
24430 \begin_inset Quotes eld
24434 \begin_inset Quotes erd
24437 part for starred citation commands (such as
24438 \begin_inset Flex Code
24441 \begin_layout Plain Layout
24449 ), the false part for unstarred
24452 \begin_layout Itemize
24453 \begin_inset Flex Code
24456 \begin_layout Plain Layout
24457 {%ifentrytype:<type>%[[true]][[false]]}
24463 \begin_inset Quotes eld
24467 \begin_inset Quotes erd
24470 if the current entry type matches
24471 \begin_inset Flex Code
24474 \begin_layout Plain Layout
24480 , else the false part (e.g., in a citation definition:
24481 \begin_inset Flex Code
24484 \begin_layout Plain Layout
24485 {%ifentrytype:book%[[this is a book]][[this is no book]]}
24493 \begin_layout Itemize
24494 \begin_inset Flex Code
24497 \begin_layout Plain Layout
24498 {%ifmultiple:<authortype>%[[true]][[false]]}
24504 \begin_inset Quotes eld
24508 \begin_inset Quotes erd
24511 if the current author type (author, editor etc.) has multiple authors, else
24512 the false part (e.g., in a bibliography definition:
24513 \begin_inset Flex Code
24516 \begin_layout Plain Layout
24517 {%ifmultiple:editor%[[eds.]][[ed.]]}
24525 \begin_layout Itemize
24526 \begin_inset Flex Code
24529 \begin_layout Plain Layout
24530 {%ifqualified%[[true]][[false]]}
24536 \begin_inset Quotes eld
24540 \begin_inset Quotes erd
24543 part if the current citation is a qualified citation list (a specific
24547 format for multi-reference citations), the false part if this is not the
24551 \begin_layout Standard
24553 \begin_inset Flex Code
24556 \begin_layout Plain Layout
24562 prints the author key as it is recorded in the bibliography file.
24563 This might not be what you want, since it will result in a string such
24565 \begin_inset Quotes eld
24568 Miller, Peter and Smith, Mary and White, Jane
24569 \begin_inset Quotes erd
24573 \begin_inset Quotes eld
24577 \begin_inset Quotes erd
24580 is used by Bib\SpecialChar TeX
24581 to delimit authors).
24583 therefore provides some methods to get properly formatted name lists (which
24584 will also get translated).
24585 The following keys are provided:
24588 \begin_layout Enumerate
24589 For name lists with pre- and surname, suitable for the main authors/editors
24590 of a bibliography item.
24592 \begin_inset Flex Code
24595 \begin_layout Plain Layout
24601 part denotes the kind of list that is requested (e.g.
24603 \begin_inset Flex Code
24606 \begin_layout Plain Layout
24616 \begin_layout Itemize
24617 \begin_inset Flex Code
24620 \begin_layout Plain Layout
24621 %abbrvnames:<nametype>%
24626 : Provides a name list which is abbreviated (with
24627 \begin_inset Quotes eld
24631 \begin_inset Quotes erd
24635 \begin_inset Flex Code
24638 \begin_layout Plain Layout
24647 \begin_layout Itemize
24648 \begin_inset Flex Code
24651 \begin_layout Plain Layout
24652 %fullnames:<nametype>%
24657 : Provides a full name list (never abbreviated with
24658 \begin_inset Quotes eld
24662 \begin_inset Quotes erd
24668 \begin_layout Itemize
24669 \begin_inset Flex Code
24672 \begin_layout Plain Layout
24673 %forceabbrvnames:<nametype>%
24678 : Provides a name list which is always abbreviated (with
24679 \begin_inset Quotes eld
24683 \begin_inset Quotes erd
24687 \begin_inset Flex Code
24690 \begin_layout Plain Layout
24700 \begin_layout Enumerate
24701 Alternative name lists with pre- and surname, if the order of pre- and surname
24702 inside the bibliography item differs (as in:
24703 \begin_inset Quotes eld
24706 Miller, John: Some text, in: Mary Smith, ed.: A volume
24707 \begin_inset Quotes erd
24714 \begin_layout Itemize
24715 \begin_inset Flex Code
24718 \begin_layout Plain Layout
24719 %abbrvbynames:<nametype>%
24724 : Provides a name list which is abbreviated (with
24725 \begin_inset Quotes eld
24729 \begin_inset Quotes erd
24733 \begin_inset Flex Code
24736 \begin_layout Plain Layout
24745 \begin_layout Itemize
24746 \begin_inset Flex Code
24749 \begin_layout Plain Layout
24750 %fullbynames:<nametype>%
24755 : Provides a full name list (never abbreviated with
24756 \begin_inset Quotes eld
24760 \begin_inset Quotes erd
24766 \begin_layout Itemize
24767 \begin_inset Flex Code
24770 \begin_layout Plain Layout
24771 %forceabbrvbynames:<nametype>%
24776 : Provides a name list which is always abbreviated (with
24777 \begin_inset Quotes eld
24781 \begin_inset Quotes erd
24785 \begin_inset Flex Code
24788 \begin_layout Plain Layout
24798 \begin_layout Enumerate
24799 And finally name lists which consist of family names only, as used in author-yea
24801 These do not take a
24802 \begin_inset Flex Code
24805 \begin_layout Plain Layout
24811 part, but always return either an author list or, if this does not exist,
24812 an editor list (as common in author-year labels):
24816 \begin_layout Itemize
24817 \begin_inset Flex Code
24820 \begin_layout Plain Layout
24826 : Provides a name list which is abbreviated (with
24827 \begin_inset Quotes eld
24831 \begin_inset Quotes erd
24835 \begin_inset Flex Code
24838 \begin_layout Plain Layout
24847 \begin_layout Itemize
24848 \begin_inset Flex Code
24851 \begin_layout Plain Layout
24857 : Provides a full name list (never abbreviated with
24858 \begin_inset Quotes eld
24862 \begin_inset Quotes erd
24868 \begin_layout Itemize
24869 \begin_inset Flex Code
24872 \begin_layout Plain Layout
24873 %forceabbrvciteauthor%
24878 : Provides a name list which is always abbreviated (with
24879 \begin_inset Quotes eld
24883 \begin_inset Quotes erd
24887 \begin_inset Flex Code
24890 \begin_layout Plain Layout
24900 \begin_layout Standard
24901 The order of pre- and surname in the former two lists can be adjusted by
24905 \begin_layout Itemize
24906 \begin_inset Flex Code
24909 \begin_layout Plain Layout
24910 !firstnameform %surname%, %prename%
24915 (first author in lists of type 1)
24918 \begin_layout Itemize
24919 \begin_inset Flex Code
24922 \begin_layout Plain Layout
24923 !othernameform %surname%, %prename%
24928 (other authors in lists of type 1)
24931 \begin_layout Itemize
24932 \begin_inset Flex Code
24935 \begin_layout Plain Layout
24936 !firstbynameform %prename% %surname%
24941 (first author in lists of type 2)
24944 \begin_layout Itemize
24945 \begin_inset Flex Code
24948 \begin_layout Plain Layout
24949 !otherbynameform %prename% %surname%
24954 (other authors in lists of type 2)
24957 \begin_layout Standard
24958 This allows you to configure namings like
24959 \begin_inset Quotes eld
24962 Miller, Peter and Mary Smith: \SpecialChar ldots
24963 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
24965 \begin_inset Quotes erd
24971 \begin_layout Standard
24972 There is one other piece of syntax available in definitions, which looks
24974 \begin_inset Flex Code
24977 \begin_layout Plain Layout
24984 This defines a piece of formatting information that is to be used when
24986 \begin_inset Quotes eld
24990 \begin_inset Quotes erd
24994 Obviously, we do not want to output HTML tags when writing plain text,
24995 so they should be wrapped in
24996 \begin_inset Quotes eld
25000 \begin_inset Quotes erd
25004 \begin_inset Quotes eld
25008 \begin_inset Quotes erd
25014 \begin_layout Standard
25015 Two special sorts of definitions are also possible in a
25016 \begin_inset Flex Code
25019 \begin_layout Plain Layout
25026 An example of the first would be:
25029 \begin_layout LyX-Code
25031 \begin_inset Quotes eld
25035 \begin_inset Quotes erd
25041 \begin_layout Standard
25042 This is an abbreviation, or macro, and it can be used by treating it as
25044 \begin_inset Flex Code
25047 \begin_layout Plain Layout
25056 \begin_inset Flex Code
25059 \begin_layout Plain Layout
25065 exactly as it would treat its definition.
25066 So, let us issue the obvious
25074 \begin_layout LyX-Code
25078 \begin_layout Standard
25079 or anything like it.
25081 shouldn't go into an infinite loop, but it may go into a long one before
25085 \begin_layout Standard
25086 The second sort of special definition might look like this:
25089 \begin_layout LyX-Code
25093 \begin_layout Standard
25094 This defines a translatable piece of text, which allows relevant parts of
25095 the bibliography or citation to be translated.
25096 It can be included in a definition by treating it as a key:
25097 \begin_inset Flex Code
25100 \begin_layout Plain Layout
25107 Note that there are two different translation paths: All definitions starting
25109 \begin_inset Flex Code
25112 \begin_layout Plain Layout
25118 , such as in the example above, will be translated to the currently active
25119 buffer language (so the translation will match the generated document).
25120 All definitions starting with underscore only will be translated to the
25122 This is the proper translation for strings that only occur in the dialogs
25123 or on buttons, such as this one:
25126 \begin_layout LyX-Code
25127 _addtobib Add to bibliography only.
25130 \begin_layout Standard
25131 Several of these translatable strings are predefined in
25132 \begin_inset Flex Code
25135 \begin_layout Plain Layout
25142 \begin_inset Flex Code
25145 \begin_layout Plain Layout
25152 Note that these are not macros, in the sense just defined.
25153 They will not be expanded.
25156 \begin_layout Standard
25157 So here then is an example that uses several of these features:
25158 \begin_inset VSpace defskip
25164 \begin_layout Standard
25168 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
25171 \begin_layout Standard
25172 \begin_inset VSpace defskip
25175 This defines a macro that prints the author, followed by a comma, if the
25177 \begin_inset Flex Code
25180 \begin_layout Plain Layout
25186 key is defined, or else prints the name of the editor, followed by the
25188 \begin_inset Flex Code
25191 \begin_layout Plain Layout
25197 or its translation (it is by default
25198 \begin_inset Quotes eld
25202 \begin_inset Quotes erd
25206 \begin_inset Flex Code
25209 \begin_layout Plain Layout
25216 Note that this is in fact defined in
25217 \begin_inset Flex Code
25220 \begin_layout Plain Layout
25226 , so you can use it in your own definitions, or re-definitions, if you load
25230 \begin_layout Section
25231 \begin_inset CommandInset label
25233 name "sec:Tags-for-XHTML"
25237 Tags for XHTML output
25240 \begin_layout Standard
25241 As with \SpecialChar LaTeX
25242 or DocBook, the format of \SpecialChar LyX
25243 's XHTML output is also controlled by
25244 layout information.
25245 In general, \SpecialChar LyX
25246 provides sensible defaults and, as mentioned earlier, it will
25247 even construct default CSS style rules from the other layout tags.
25248 For example, \SpecialChar LyX
25249 will attempt to use the information provided in the
25250 \begin_inset Flex Code
25253 \begin_layout Plain Layout
25259 declaration for the Chapter style to write CSS that will appropriately
25260 format chapter headings.
25263 \begin_layout Standard
25264 In many cases, then, you may not have to do anything at all to get acceptable
25265 XHTML output for your own environments, custom insets, and so forth.
25266 But in some cases you will, and so \SpecialChar LyX
25267 provides a number of layout tags that
25268 can be used to customize the XHTML and CSS that are generated.
25271 \begin_layout Standard
25272 Note that there are two tags,
25273 \begin_inset Flex Code
25276 \begin_layout Plain Layout
25283 \begin_inset Flex Code
25286 \begin_layout Plain Layout
25292 that may appear outside style and inset declarations.
25294 \begin_inset CommandInset ref
25296 reference "subsec:General-text-class"
25300 for details on these.
25303 \begin_layout Subsection
25304 \begin_inset CommandInset label
25306 name "subsec:Paragraph-Style-XHTML"
25313 \begin_layout Standard
25314 The sort of XHTML \SpecialChar LyX
25315 outputs for a paragraph depends upon whether we are dealing
25316 with a normal paragraph, a command, or an environment, where this is itself
25317 determined by the contents of the corresponding
25318 \begin_inset Flex Code
25321 \begin_layout Plain Layout
25332 \begin_layout Standard
25333 For a command or normal paragraph, the output XHTML has the following form:
25336 \begin_layout LyX-Code
25340 \begin_inset Quotes erd
25344 \begin_inset Quotes erd
25350 \begin_layout LyX-Code
25354 \begin_inset Quotes erd
25358 \begin_inset Quotes erd
25364 \begin_layout LyX-Code
25367 Contents of the paragraph.
25370 \begin_layout LyX-Code
25376 \begin_layout Standard
25377 The label tags are of course omitted if the paragraph does not have a label.
25380 \begin_layout Standard
25381 For an environment that is not some sort of list, the XHTML takes this form:
25384 \begin_layout LyX-Code
25388 \begin_inset Quotes erd
25392 \begin_inset Quotes erd
25398 \begin_layout LyX-Code
25402 \begin_inset Quotes erd
25406 \begin_inset Quotes erd
25410 \begin_inset Quotes erd
25414 \begin_inset Quotes erd
25417 >Environment Label</labeltag>First paragraph.</itemtag>
25420 \begin_layout LyX-Code
25423 <itemtag>Second paragraph.</itemtag>
25426 \begin_layout LyX-Code
25432 \begin_layout Standard
25433 Note that the label is output only for the first paragraph, as it should
25434 be for a theorem, for example.
25438 \begin_layout Standard
25439 For a list, we have one of these forms:
25442 \begin_layout LyX-Code
25446 \begin_inset Quotes erd
25450 \begin_inset Quotes erd
25456 \begin_layout LyX-Code
25460 \begin_inset Quotes erd
25464 \begin_inset Quotes erd
25468 \begin_inset Quotes erd
25472 \begin_inset Quotes erd
25475 >List Label</labeltag>First item.</itemtag>
25478 \begin_layout LyX-Code
25482 \begin_inset Quotes erd
25486 \begin_inset Quotes erd
25490 \begin_inset Quotes erd
25494 \begin_inset Quotes erd
25497 >List Label</labeltag>Second item.</itemtag>
25500 \begin_layout LyX-Code
25506 \begin_layout LyX-Code
25510 \begin_layout LyX-Code
25514 \begin_inset Quotes erd
25518 \begin_inset Quotes erd
25524 \begin_layout LyX-Code
25528 \begin_inset Quotes erd
25532 \begin_inset Quotes erd
25535 >List Label</labeltag><itemtag attr=
25536 \begin_inset Quotes erd
25540 \begin_inset Quotes erd
25543 >First item.</itemtag>
25546 \begin_layout LyX-Code
25550 \begin_inset Quotes erd
25554 \begin_inset Quotes erd
25557 >List Label</labeltag><itemtag attr=
25558 \begin_inset Quotes erd
25562 \begin_inset Quotes erd
25565 >Second item.</itemtag>
25568 \begin_layout LyX-Code
25574 \begin_layout Standard
25575 Note the different orders of
25576 \begin_inset Flex Code
25579 \begin_layout Plain Layout
25586 \begin_inset Flex Code
25589 \begin_layout Plain Layout
25596 Which order we get depends upon the setting of
25597 \begin_inset Flex Code
25600 \begin_layout Plain Layout
25607 \begin_inset Flex Code
25610 \begin_layout Plain Layout
25616 is false (the default), you get the first of these, with the label within
25617 the item; if true, you get the second, with the label outside the item.
25620 \begin_layout Standard
25621 The specific tags and attributes output for each paragraph type can be controlle
25622 d by means of the layout tags we are about to describe.
25623 As mentioned earlier, however, \SpecialChar LyX
25624 uses sensible defaults for many of these,
25625 so you often may not need to do very much to get good XHTML output.
25626 Think of the available tags as there so you can tweak things to your liking.
25629 \begin_layout Description
25630 \begin_inset Flex Code
25633 \begin_layout Plain Layout
25640 \begin_inset Flex Code
25643 \begin_layout Plain Layout
25649 ] Specifies attribute information to be output with the main tag.
25651 \begin_inset Quotes eld
25655 \begin_inset Flex Code
25658 \begin_layout Plain Layout
25665 \begin_inset Quotes erd
25669 By default, \SpecialChar LyX
25671 \begin_inset Quotes eld
25675 \begin_inset Flex Code
25678 \begin_layout Plain Layout
25685 \begin_inset Quotes erd
25689 \begin_inset Flex Code
25692 \begin_layout Plain Layout
25698 is the \SpecialChar LyX
25699 name of the layout, made lowercase, for example: chapter.
25704 contain any style information.
25706 \begin_inset Flex Code
25709 \begin_layout Plain Layout
25718 \begin_layout Description
25719 \begin_inset Flex Code
25722 \begin_layout Plain Layout
25729 \begin_inset Flex Code
25732 \begin_layout Plain Layout
25742 ] Whether to output the default CSS information \SpecialChar LyX
25743 generates for this layout,
25744 even if additional information is explicitly provided via
25745 \begin_inset Flex Code
25748 \begin_layout Plain Layout
25756 \begin_inset Flex Code
25759 \begin_layout Plain Layout
25765 allows you to alter or augment the generated CSS, rather than to override
25768 \begin_inset Flex Code
25771 \begin_layout Plain Layout
25780 \begin_layout Description
25781 \begin_inset Flex Code
25784 \begin_layout Plain Layout
25791 \begin_inset Flex Code
25794 \begin_layout Plain Layout
25800 ] The tag to be used for individual paragraphs of environments, replacing
25802 \begin_inset Flex Code
25805 \begin_layout Plain Layout
25811 in the examples above.
25813 \begin_inset Flex Code
25816 \begin_layout Plain Layout
25825 \begin_layout Description
25826 \begin_inset Flex Code
25829 \begin_layout Plain Layout
25836 \begin_inset Flex Code
25839 \begin_layout Plain Layout
25845 ] Attributes for the item tag.
25847 \begin_inset Newline newline
25851 \begin_inset Quotes eld
25855 \begin_inset Flex Code
25858 \begin_layout Plain Layout
25859 class=`layoutname_item'
25865 \begin_inset Quotes erd
25873 contain any style information.
25875 \begin_inset Flex Code
25878 \begin_layout Plain Layout
25887 \begin_layout Description
25888 \begin_inset Flex Code
25891 \begin_layout Plain Layout
25898 \begin_inset Flex Code
25901 \begin_layout Plain Layout
25907 ] The tag to be used for paragraph and item labels, replacing
25908 \begin_inset Flex Code
25911 \begin_layout Plain Layout
25917 in the examples above.
25919 \begin_inset Flex Code
25922 \begin_layout Plain Layout
25929 \begin_inset Flex Code
25932 \begin_layout Plain Layout
25939 \begin_inset Flex Code
25942 \begin_layout Plain Layout
25949 \begin_inset Flex Code
25952 \begin_layout Plain Layout
25953 Centered_Top_Environment
25958 , in which case it defaults to
25959 \begin_inset Flex Code
25962 \begin_layout Plain Layout
25971 \begin_layout Description
25972 \begin_inset Flex Code
25975 \begin_layout Plain Layout
25982 \begin_inset Flex Code
25985 \begin_layout Plain Layout
25991 ] Attributes for the label tag.
25993 \begin_inset Newline newline
25997 \begin_inset Quotes eld
26001 \begin_inset Flex Code
26004 \begin_layout Plain Layout
26005 class=`layoutname_label'
26011 \begin_inset Quotes erd
26019 contain any style information.
26021 \begin_inset Flex Code
26024 \begin_layout Plain Layout
26033 \begin_layout Description
26034 \begin_inset Flex Code
26037 \begin_layout Plain Layout
26044 \begin_inset Flex Code
26047 \begin_layout Plain Layout
26057 ] Meaningful only for list-like environments, this tag controls whether
26058 the label tag is output before or inside the item tag.
26059 This is used, for example, in the description environment, where we want
26061 \begin_inset Flex Code
26064 \begin_layout Plain Layout
26065 <dt>\SpecialChar ldots
26066 </dt><dd>\SpecialChar ldots
26074 \begin_inset Flex Code
26077 \begin_layout Plain Layout
26083 : The label tag is output inside the item tag.
26086 \begin_layout Description
26087 \begin_inset Flex Code
26090 \begin_layout Plain Layout
26096 Information to be output in the
26097 \begin_inset Flex Code
26100 \begin_layout Plain Layout
26106 section when this style is used.
26107 This might, for example, be used to include a
26108 \begin_inset Flex Code
26111 \begin_layout Plain Layout
26118 \begin_inset Flex Code
26121 \begin_layout Plain Layout
26130 \begin_layout Description
26131 \begin_inset Flex Code
26134 \begin_layout Plain Layout
26140 CSS style information to be included when this style is used.
26141 Note that this will automatically be wrapped in a layout-generated
26142 \begin_inset Flex Code
26145 \begin_layout Plain Layout
26151 block, so only the CSS itself need be included.
26153 \begin_inset Flex Code
26156 \begin_layout Plain Layout
26165 \begin_layout Description
26166 \begin_inset Flex Code
26169 \begin_layout Plain Layout
26176 \begin_inset Flex Code
26179 \begin_layout Plain Layout
26185 ] The tag to be used for the main label, replacing
26186 \begin_inset Flex Code
26189 \begin_layout Plain Layout
26195 in the examples above.
26197 \begin_inset Flex Code
26200 \begin_layout Plain Layout
26209 \begin_layout Description
26210 \begin_inset Flex Code
26213 \begin_layout Plain Layout
26220 \begin_inset Flex Code
26223 \begin_layout Plain Layout
26233 ] Marks this style as the one to be used to generate the
26234 \begin_inset Flex Code
26237 \begin_layout Plain Layout
26243 tag for the XHTML file.
26244 By default, it is false.
26246 \begin_inset Flex Code
26249 \begin_layout Plain Layout
26255 file sets it to true for the
26256 \begin_inset Flex Code
26259 \begin_layout Plain Layout
26269 \begin_layout Subsection
26273 \begin_layout Standard
26274 The XHTML output of insets can also be controlled by information in layout
26279 \begin_layout Plain Layout
26280 At present, this is true only for
26281 \begin_inset Quotes eld
26285 \begin_inset Quotes erd
26288 insets (insets you can type into) and is not true for
26289 \begin_inset Quotes eld
26293 \begin_inset Quotes erd
26296 insets (insets that are associated with dialog boxes).
26301 Here, too, \SpecialChar LyX
26302 tries to provide sensible defaults, and it constructs default
26304 But everything can be customized.
26307 \begin_layout Standard
26308 The XHTML \SpecialChar LyX
26309 outputs for an inset has the following form:
26312 \begin_layout LyX-Code
26314 \begin_inset Quotes erd
26318 \begin_inset Quotes erd
26324 \begin_layout LyX-Code
26325 <labeltag>Label</labeltag>
26328 \begin_layout LyX-Code
26330 \begin_inset Quotes erd
26334 \begin_inset Quotes erd
26337 >Contents of the inset.</innertag>
26340 \begin_layout LyX-Code
26344 \begin_layout Standard
26345 If the inset permits multiple paragraphs—that is, if
26346 \begin_inset Flex Code
26349 \begin_layout Plain Layout
26355 is true—then the contents of the inset will itself be output as paragraphs
26356 formatted according to the styles used for those paragraphs (standard,
26357 quote, and the like).
26358 The label tag is of course omitted if the paragraph does not have a label
26359 and, at present, is always
26360 \begin_inset Flex Code
26363 \begin_layout Plain Layout
26370 The inner tag is optional and, by default, does not appear.
26373 \begin_layout Standard
26374 The specific tags and attributes output for each inset can be controlled
26375 by means of the following layout tags.
26378 \begin_layout Description
26379 \begin_inset Flex Code
26382 \begin_layout Plain Layout
26389 \begin_inset Flex Code
26392 \begin_layout Plain Layout
26398 ] Specifies attribute information to be output with the main tag.
26400 \begin_inset Quotes eld
26404 \begin_inset Flex Code
26407 \begin_layout Plain Layout
26408 class=`myinset' onclick=`\SpecialChar ldots
26415 \begin_inset Quotes erd
26419 By default, \SpecialChar LyX
26421 \begin_inset Quotes eld
26425 \begin_inset Flex Code
26428 \begin_layout Plain Layout
26435 \begin_inset Quotes erd
26439 \begin_inset Flex Code
26442 \begin_layout Plain Layout
26448 is the \SpecialChar LyX
26449 name of the inset, made lowercase and with non-alphanumeric characters
26450 converted to underscores, for example: footnote.
26453 \begin_layout Description
26454 \begin_inset Flex Code
26457 \begin_layout Plain Layout
26464 \begin_inset Flex Code
26467 \begin_layout Plain Layout
26477 ] Whether to output the default CSS information \SpecialChar LyX
26478 generates for this layout,
26479 even if additional information is explicitly provided via
26480 \begin_inset Flex Code
26483 \begin_layout Plain Layout
26491 \begin_inset Flex Code
26494 \begin_layout Plain Layout
26500 allows you to alter or augment the generated CSS, rather than to override
26505 \begin_layout Description
26506 \begin_inset Flex Code
26509 \begin_layout Plain Layout
26516 \begin_inset Flex Code
26519 \begin_layout Plain Layout
26525 ] Attributes for the inner tag.
26527 \begin_inset Newline newline
26531 \begin_inset Quotes eld
26535 \begin_inset Flex Code
26538 \begin_layout Plain Layout
26539 class=`insetname_inner'
26545 \begin_inset Quotes erd
26551 \begin_layout Description
26552 \begin_inset Flex Code
26555 \begin_layout Plain Layout
26562 \begin_inset Flex Code
26565 \begin_layout Plain Layout
26571 ] The inner tag, replacing
26572 \begin_inset Flex Code
26575 \begin_layout Plain Layout
26581 in the examples above.
26582 By default, there is none.
26585 \begin_layout Description
26586 \begin_inset Flex Code
26589 \begin_layout Plain Layout
26596 \begin_inset Flex Code
26599 \begin_layout Plain Layout
26607 ] Whether this inset represents a standalone block of text (such as a footnote)
26608 or instead represents material that is included in the surrounding text
26609 (such as a branch).
26613 \begin_layout Description
26614 \begin_inset Flex Code
26617 \begin_layout Plain Layout
26624 \begin_inset Flex Code
26627 \begin_layout Plain Layout
26633 ] A label for this inset, possibly including a reference to a counter.
26634 For example, for footnote, it might be:
26635 \begin_inset Flex Code
26638 \begin_layout Plain Layout
26647 This is optional, and there is no default.
26650 \begin_layout Description
26651 \begin_inset Flex Code
26654 \begin_layout Plain Layout
26660 Information to be output in the
26661 \begin_inset Flex Code
26664 \begin_layout Plain Layout
26670 section when this style is used.
26671 This might, for example, be used to include a
26672 \begin_inset Flex Code
26675 \begin_layout Plain Layout
26682 \begin_inset Flex Code
26685 \begin_layout Plain Layout
26694 \begin_layout Description
26695 \begin_inset Flex Code
26698 \begin_layout Plain Layout
26704 CSS style information to be included when this style is used.
26705 Note that this will automatically be wrapped in a layout-generated
26706 \begin_inset Flex Code
26709 \begin_layout Plain Layout
26715 block, so only the CSS itself need be included.
26718 \begin_layout Description
26719 \begin_inset Flex Code
26722 \begin_layout Plain Layout
26729 \begin_inset Flex Code
26732 \begin_layout Plain Layout
26738 ] The tag to be used for the main label, replacing
26739 \begin_inset Flex Code
26742 \begin_layout Plain Layout
26748 in the examples above.
26749 The default depends upon the setting of
26750 \begin_inset Flex Code
26753 \begin_layout Plain Layout
26760 \begin_inset Flex Code
26763 \begin_layout Plain Layout
26769 is true, the default is
26770 \begin_inset Flex Code
26773 \begin_layout Plain Layout
26779 ; if it is false, the default is
26780 \begin_inset Flex Code
26783 \begin_layout Plain Layout
26792 \begin_layout Subsection
26796 \begin_layout Standard
26797 The XHTML output for floats too can be controlled by layout information.
26798 The output has the following form:
26801 \begin_layout LyX-Code
26803 \begin_inset Quotes erd
26807 \begin_inset Quotes erd
26813 \begin_layout LyX-Code
26814 Contents of the float.
26817 \begin_layout LyX-Code
26821 \begin_layout Standard
26822 The caption, if there is one, is a separate inset and will be output as
26824 Its appearance can be controlled via the InsetLayout for caption insets.
26828 \begin_layout Description
26829 \begin_inset Flex Code
26832 \begin_layout Plain Layout
26839 \begin_inset Flex Code
26842 \begin_layout Plain Layout
26848 ] Specifies attribute information to be output with the main tag.
26850 \begin_inset Quotes eld
26854 \begin_inset Flex Code
26857 \begin_layout Plain Layout
26858 class=`myfloat' onclick=`\SpecialChar ldots
26865 \begin_inset Quotes erd
26869 By default, \SpecialChar LyX
26871 \begin_inset Quotes eld
26875 \begin_inset Flex Code
26878 \begin_layout Plain Layout
26879 class=`float float-floattype'
26885 \begin_inset Quotes erd
26889 \begin_inset Flex Code
26892 \begin_layout Plain Layout
26898 is \SpecialChar LyX
26899 's name for this type of float, as determined by the float declaration
26901 \begin_inset CommandInset ref
26903 reference "subsec:Floats"
26907 ), though made lowercase and with non-alphanumeric characters converted
26908 to underscores, for example: float-table.
26911 \begin_layout Description
26912 \begin_inset Flex Code
26915 \begin_layout Plain Layout
26921 CSS style information to be included when this float is used.
26922 Note that this will automatically be wrapped in a layout-generated
26923 \begin_inset Flex Code
26926 \begin_layout Plain Layout
26932 block, so only the CSS itself need be included.
26935 \begin_layout Description
26936 \begin_inset Flex Code
26939 \begin_layout Plain Layout
26946 \begin_inset Flex Code
26949 \begin_layout Plain Layout
26955 ] The tag to be used for this float, replacing
26956 \begin_inset Quotes eld
26960 \begin_inset Flex Code
26963 \begin_layout Plain Layout
26970 \begin_inset Quotes erd
26973 in the example above.
26975 \begin_inset Flex Code
26978 \begin_layout Plain Layout
26984 and will rarely need changing.
26987 \begin_layout Subsection
26988 Bibliography formatting
26991 \begin_layout Standard
26992 The bibliography can be formatted using
26993 \begin_inset Flex Code
26996 \begin_layout Plain Layout
27004 \begin_inset CommandInset ref
27006 reference "subsec:Citation-format-description"
27013 \begin_layout Subsection
27018 \begin_layout Standard
27019 We have several times mentioned that \SpecialChar LyX
27020 will generate default CSS style rules
27021 for both insets and paragraph styles, based upon the other layout information
27023 In this section, we shall say a word about which layout information \SpecialChar LyX
27028 \begin_layout Standard
27029 At present, \SpecialChar LyX
27030 auto-generates CSS only for font information, making use of
27032 \begin_inset Flex Code
27035 \begin_layout Plain Layout
27042 \begin_inset Flex Code
27045 \begin_layout Plain Layout
27052 \begin_inset Flex Code
27055 \begin_layout Plain Layout
27062 \begin_inset Flex Code
27065 \begin_layout Plain Layout
27072 \begin_inset Flex Code
27075 \begin_layout Plain Layout
27082 \begin_inset CommandInset ref
27084 reference "subsec:Font-description"
27089 The translation is mostly straightforward and obvious.
27091 \begin_inset Quotes eld
27095 \begin_inset Flex Code
27098 \begin_layout Plain Layout
27105 \begin_inset Quotes erd
27109 \begin_inset Quotes eld
27113 \begin_inset Flex Code
27116 \begin_layout Plain Layout
27117 font-family: sans-serif;
27123 \begin_inset Quotes erd
27127 The correspondence of \SpecialChar LyX
27128 sizes and CSS sizes is a little less obvious but
27129 nonetheless intuitive.
27131 \begin_inset Flex Code
27134 \begin_layout Plain Layout
27141 \begin_inset Flex URL
27144 \begin_layout Plain Layout
27152 \change_inserted -970929547 1496610908
27156 \begin_layout Section
27158 \change_inserted -970929547 1496610966
27159 \begin_inset CommandInset label
27161 name "sec:Tags-for-DocBook"
27165 Tags for DocBook output
27168 \begin_layout Standard
27170 \change_inserted -970929547 1496611615
27171 As with \SpecialChar LaTeX
27172 or XHTML, the format of \SpecialChar LyX
27173 's DocBook output is also controlled by
27174 layout information.
27175 In general, \SpecialChar LyX
27176 provides sensible defaults; however, much of the styling is
27177 lost during the conversion, as DocBook is strictly semantic and does not
27179 When possible, information from \SpecialChar LyX
27180 will be rendered in
27188 \begin_layout Standard
27190 \change_inserted -970929547 1496612080
27191 In many cases, then, you may not have to do anything at all to get acceptable
27192 DocBook output for your own environments, custom insets, and so forth.
27193 But in some cases you will, and so \SpecialChar LyX
27194 provides a number of layout tags that
27195 can be used to customize the DocBook that is generated.
27198 \begin_layout Standard
27200 \change_inserted -970929547 1515109912
27201 Labels are rarely output, as they are redundant in DocBook: this information
27202 is carried by the tags themselves, and whether labels appear in the final
27203 documents (after processing of DocBook files) is controlled by the stylesheets.
27204 However, sometimes, labels are not redundant content, such as definition
27205 lists: in this case, the term being defined will be the label.
27209 \begin_layout Subsection
27211 \change_inserted -970929547 1496610966
27212 \begin_inset CommandInset label
27214 name "subsec:Paragraph-Style-XHTML-1"
27221 \begin_layout Standard
27223 \change_inserted -970929547 1496612059
27224 The sort of DocBook \SpecialChar LyX
27225 outputs for a paragraph depends upon whether we are
27226 dealing with a normal paragraph, a command, or an environment, where this
27227 is itself determined by the contents of the corresponding
27228 \begin_inset Flex Code
27231 \begin_layout Plain Layout
27233 \change_inserted -970929547 1496610966
27246 \begin_layout Standard
27248 \change_inserted -970929547 1496612107
27249 For a command or normal paragraph, the output DocBook has the following
27253 \begin_layout LyX-Code
27255 \change_inserted -970929547 1515109666
27259 \begin_layout LyX-Code
27261 \change_inserted -970929547 1496610966
27262 Contents of the paragraph.
27265 \begin_layout LyX-Code
27267 \change_inserted -970929547 1496610966
27271 \begin_layout Standard
27273 \change_inserted -970929547 1515109821
27274 For an environment that is not some sort of list, the generated DocBook
27278 \begin_layout LyX-Code
27280 \change_inserted -970929547 1515109671
27284 \begin_layout LyX-Code
27286 \change_inserted -970929547 1496612114
27287 <itemtag>First paragraph.</itemtag>
27290 \begin_layout LyX-Code
27292 \change_inserted -970929547 1496610966
27293 <itemtag>Second paragraph.</itemtag>
27296 \begin_layout LyX-Code
27298 \change_inserted -970929547 1496610966
27302 \begin_layout Standard
27304 \change_inserted -970929547 1515109825
27305 For a list, the resulting DocBook takes this form:
27308 \begin_layout LyX-Code
27310 \change_inserted -970929547 1515109672
27314 \begin_layout LyX-Code
27316 \change_inserted -970929547 1515109676
27317 <itemtag attr>First item.</itemtag>
27320 \begin_layout LyX-Code
27322 \change_inserted -970929547 1515109678
27323 <itemtag attr>Second item.</itemtag>
27326 \begin_layout LyX-Code
27328 \change_inserted -970929547 1496610966
27332 \begin_layout Standard
27334 \change_inserted -970929547 1496612243
27335 The specific tags and roles output for each paragraph type can be controlled
27336 by means of the layout tags we are about to describe.
27337 Please note that, due to the very nature of DocBook, no sensible defaults
27338 really exist, and the values must always be carefully chosen.
27342 \begin_layout Description
27344 \change_inserted -970929547 1515110057
27345 \begin_inset Flex Code
27348 \begin_layout Plain Layout
27350 \change_inserted -970929547 1515109656
27359 \begin_inset Flex Code
27362 \begin_layout Plain Layout
27364 \change_inserted -970929547 1496610966
27372 ] Specifies attribute information to be output with the main tag, replacing
27374 \begin_inset Quotes eld
27378 \begin_inset Flex Code
27381 \begin_layout Plain Layout
27383 \change_inserted -970929547 1515110057
27392 \begin_inset Quotes erd
27395 in the example above.
27396 This information can be used in further processing of the DocBook files.
27402 \begin_layout Description
27404 \change_inserted -970929547 1496612296
27405 \begin_inset Flex Code
27408 \begin_layout Plain Layout
27410 \change_inserted -970929547 1496612269
27419 \begin_inset Flex Code
27422 \begin_layout Plain Layout
27424 \change_inserted -970929547 1496610966
27432 ] The tag to be used for this inset, replacing
27433 \begin_inset Quotes eld
27437 \begin_inset Flex Code
27440 \begin_layout Plain Layout
27442 \change_inserted -970929547 1496612296
27451 \begin_inset Quotes erd
27454 in the example above.
27455 The default is the name of the float and always needs to be changed, as
27456 DocBook provides no generic tag.
27461 \begin_layout Subsection
27463 \change_inserted -970929547 1515111533
27464 InsetLayout DocBook
27469 \begin_layout Standard
27471 \change_inserted -970929547 1496611894
27472 The DocBook output of insets can also be controlled by information in layout
27476 \begin_layout Standard
27478 \change_inserted -970929547 1496612045
27479 The DocBook \SpecialChar LyX
27480 outputs for an inset has the following form:
27483 \begin_layout LyX-Code
27485 \change_inserted -970929547 1515110861
27486 <wrappertag wrapperattr>
27489 \begin_layout LyX-Code
27491 \change_inserted -970929547 1515110868
27495 \begin_layout LyX-Code
27497 \change_inserted -970929547 1515110869
27498 <innertag innerattr>
27501 \begin_layout LyX-Code
27503 \change_inserted -970929547 1515110869
27504 Contents of the inset.
27507 \begin_layout LyX-Code
27509 \change_inserted -970929547 1515110870
27513 \begin_layout LyX-Code
27515 \change_inserted -970929547 1515110871
27519 \begin_layout LyX-Code
27521 \change_inserted -970929547 1515111172
27525 \begin_layout Standard
27527 \change_inserted -970929547 1515111186
27528 For an itemising inset, it rather looks like this:
27531 \begin_layout LyX-Code
27533 \change_inserted -970929547 1515111186
27534 <wrappertag wrapperattr>
27537 \begin_layout LyX-Code
27539 \change_inserted -970929547 1515111186
27543 \begin_layout LyX-Code
27545 \change_inserted -970929547 1515111186
27546 <innertag innerattr>
27549 \begin_layout LyX-Code
27551 \change_inserted -970929547 1515111362
27552 <itemwrappertag itemwrapperattr>
27555 \begin_layout LyX-Code
27557 \change_inserted -970929547 1515111364
27558 <itemlabeltag itemattr>
27561 \begin_layout LyX-Code
27563 \change_inserted -970929547 1515111367
27564 Label of the first item.
27567 \begin_layout LyX-Code
27569 \change_inserted -970929547 1515111362
27575 \begin_layout LyX-Code
27577 \change_inserted -970929547 1515111517
27581 \begin_layout LyX-Code
27583 \change_inserted -970929547 1515111517
27589 \begin_layout LyX-Code
27591 \change_inserted -970929547 1515111516
27592 Contents of the first item.
27595 \begin_layout LyX-Code
27597 \change_inserted -970929547 1515111514
27603 \begin_layout LyX-Code
27605 \change_inserted -970929547 1515111247
27611 \begin_layout LyX-Code
27613 \change_inserted -970929547 1515111221
27617 \begin_layout LyX-Code
27619 \change_inserted -970929547 1515111370
27620 <itemwrappertag itemwrapperattr>
27623 \begin_layout LyX-Code
27625 \change_inserted -970929547 1515111370
27626 <itemlabeltag itemattr>
27629 \begin_layout LyX-Code
27631 \change_inserted -970929547 1515111372
27632 Label of the second item.
27635 \begin_layout LyX-Code
27637 \change_inserted -970929547 1515111370
27643 \begin_layout LyX-Code
27645 \change_inserted -970929547 1515111504
27649 \begin_layout LyX-Code
27651 \change_inserted -970929547 1515111505
27657 \begin_layout LyX-Code
27659 \change_inserted -970929547 1515111507
27660 Contents of the second item.
27663 \begin_layout LyX-Code
27665 \change_inserted -970929547 1515111509
27671 \begin_layout LyX-Code
27673 \change_inserted -970929547 1515111251
27679 \begin_layout LyX-Code
27681 \change_inserted -970929547 1515111221
27687 \begin_layout LyX-Code
27689 \change_inserted -970929547 1515111219
27695 \begin_layout LyX-Code
27697 \change_inserted -970929547 1515111186
27701 \begin_layout LyX-Code
27703 \change_inserted -970929547 1515111186
27707 \begin_layout LyX-Code
27709 \change_inserted -970929547 1515111186
27713 \begin_layout Standard
27715 \change_inserted -970929547 1515111183
27716 If the inset permits multiple paragraphs—that is, if
27717 \begin_inset Flex Code
27720 \begin_layout Plain Layout
27722 \change_inserted -970929547 1496610966
27730 is true—then the contents of the inset will itself be output as paragraphs
27731 formatted according to the styles used for those paragraphs (standard,
27732 quote, and the like).
27733 The inner tag is optional and, by default, does not appear.
27736 \begin_layout Standard
27738 \change_inserted -970929547 1496610966
27739 The specific tags and attributes output for each inset can be controlled
27740 by means of the following layout tags.
27743 \begin_layout Description
27745 \change_inserted -970929547 1515110317
27746 \begin_inset Flex Code
27749 \begin_layout Plain Layout
27751 \change_inserted -970929547 1515109695
27760 \begin_inset Flex Code
27763 \begin_layout Plain Layout
27765 \change_inserted -970929547 1496611854
27773 ] Specifies attribute information to be output with the main tag, replacing
27775 \begin_inset Quotes eld
27779 \begin_inset Flex Code
27782 \begin_layout Plain Layout
27784 \change_inserted -970929547 1515110044
27793 \begin_inset Quotes erd
27796 in the example above.
27797 This information can be used in further processing of the DocBook files.
27801 \begin_layout Description
27803 \change_inserted -970929547 1515110973
27804 \begin_inset Flex Code
27807 \begin_layout Plain Layout
27809 \change_inserted -970929547 1515110319
27818 \begin_inset Flex Code
27821 \begin_layout Plain Layout
27823 \change_inserted -970929547 1515110384
27824 never, always, maybe
27831 ] Specifies whether this tag goes into the
27832 \begin_inset Flex Code
27835 \begin_layout Plain Layout
27837 \change_inserted -970929547 1515110412
27845 tag at the beginning of the parent layout.
27847 \begin_inset Flex Code
27850 \begin_layout Plain Layout
27852 \change_inserted -970929547 1515110437
27860 indicates that the tag never goes into
27861 \begin_inset Flex Code
27864 \begin_layout Plain Layout
27866 \change_inserted -970929547 1515110497
27874 (this is default value, and corresponds to usual content).
27876 \begin_inset Flex Code
27879 \begin_layout Plain Layout
27881 \change_inserted -970929547 1515110517
27889 indicates that the tag always goes into
27890 \begin_inset Flex Code
27893 \begin_layout Plain Layout
27895 \change_inserted -970929547 1515110514
27903 (this corresponds to usual metadata): if there is no
27904 \begin_inset Flex Code
27907 \begin_layout Plain Layout
27909 \change_inserted -970929547 1515110550
27917 tag for the parent, one
27923 \begin_inset Flex Code
27926 \begin_layout Plain Layout
27928 \change_inserted -970929547 1515110540
27936 indicates that the tag may go into
27937 \begin_inset Flex Code
27940 \begin_layout Plain Layout
27942 \change_inserted -970929547 1515110538
27950 (this is only the case for titles): if there is no
27951 \begin_inset Flex Code
27954 \begin_layout Plain Layout
27956 \change_inserted -970929547 1515110585
27964 tag for the parent,
27968 will be generated, the corresponding tag will be output directly as content.
27972 \begin_layout Description
27974 \change_inserted -970929547 1515111461
27975 \begin_inset Flex Code
27978 \begin_layout Plain Layout
27980 \change_inserted -970929547 1515110974
27989 \begin_inset Flex Code
27992 \begin_layout Plain Layout
27994 \change_inserted -970929547 1515110973
28002 ] Specifies attribute information to be output with the item tag, replacing
28004 \begin_inset Quotes eld
28008 \begin_inset Flex Code
28011 \begin_layout Plain Layout
28013 \change_inserted -970929547 1515110984
28022 \begin_inset Quotes erd
28025 in the example above.
28026 This information can be used in further processing of the DocBook files.
28030 \begin_layout Description
28032 \change_inserted -970929547 1515111471
28033 \begin_inset Flex Code
28036 \begin_layout Plain Layout
28038 \change_inserted -970929547 1515111465
28039 DocBookItemInnerAttr
28047 \begin_inset Flex Code
28050 \begin_layout Plain Layout
28052 \change_inserted -970929547 1515111461
28060 ] Specifies attribute information to be output with the item inner tag,
28062 \begin_inset Quotes eld
28066 \begin_inset Flex Code
28069 \begin_layout Plain Layout
28071 \change_inserted -970929547 1515111476
28080 \begin_inset Quotes erd
28083 in the example above.
28084 This information can be used in further processing of the DocBook files.
28088 \begin_layout Description
28090 \change_inserted -970929547 1515111494
28091 \begin_inset Flex Code
28094 \begin_layout Plain Layout
28096 \change_inserted -970929547 1515111467
28097 DocBookItemInnerTag
28105 \begin_inset Flex Code
28108 \begin_layout Plain Layout
28110 \change_inserted -970929547 1515111461
28118 ] The tag to be used for the item inner tag within the inset, replacing
28120 \begin_inset Quotes eld
28124 \begin_inset Flex Code
28127 \begin_layout Plain Layout
28129 \change_inserted -970929547 1515111486
28138 \begin_inset Quotes erd
28141 in the example above.
28143 \begin_inset Flex Code
28146 \begin_layout Plain Layout
28148 \change_inserted -970929547 1515111461
28156 , indicating that there is no item inner tag: content is directly output
28157 without it for each itemised element.
28158 This parameter only makes sense when itemising layouts are used, such as
28165 \begin_layout Description
28167 \change_inserted -970929547 1515111290
28168 \begin_inset Flex Code
28171 \begin_layout Plain Layout
28173 \change_inserted -970929547 1515111283
28174 DocBookItemLabelAttr
28182 \begin_inset Flex Code
28185 \begin_layout Plain Layout
28187 \change_inserted -970929547 1515111279
28195 ] Specifies attribute information to be output with the item label tag,
28197 \begin_inset Quotes eld
28201 \begin_inset Flex Code
28204 \begin_layout Plain Layout
28206 \change_inserted -970929547 1515111304
28215 \begin_inset Quotes erd
28218 in the example above.
28219 This information can be used in further processing of the DocBook files.
28223 \begin_layout Description
28225 \change_inserted -970929547 1515111337
28226 \begin_inset Flex Code
28229 \begin_layout Plain Layout
28231 \change_inserted -970929547 1515111285
28232 DocBookItemLabelTag
28240 \begin_inset Flex Code
28243 \begin_layout Plain Layout
28245 \change_inserted -970929547 1515111279
28253 ] The tag to be used for the item label tag within the inset, replacing
28255 \begin_inset Quotes eld
28259 \begin_inset Flex Code
28262 \begin_layout Plain Layout
28264 \change_inserted -970929547 1515111311
28273 \begin_inset Quotes erd
28276 in the example above.
28277 This parameter only makes sense when itemising layouts are used with a
28278 notion of labels, such as definition lists.
28284 \begin_layout Description
28286 \change_inserted -970929547 1515111124
28287 \begin_inset Flex Code
28290 \begin_layout Plain Layout
28292 \change_inserted -970929547 1515111060
28301 \begin_inset Flex Code
28304 \begin_layout Plain Layout
28306 \change_inserted -970929547 1515111060
28314 ] The tag to be used for the item tag within the inset, replacing
28315 \begin_inset Quotes eld
28319 \begin_inset Flex Code
28322 \begin_layout Plain Layout
28324 \change_inserted -970929547 1515111060
28333 \begin_inset Quotes erd
28336 in the example above.
28338 \begin_inset Flex Code
28341 \begin_layout Plain Layout
28343 \change_inserted -970929547 1515111060
28351 , indicating that there is no item tag.
28352 This parameter only makes sense when itemising layouts are used, such as
28357 \begin_layout Description
28359 \change_inserted -970929547 1515111298
28360 \begin_inset Flex Code
28363 \begin_layout Plain Layout
28365 \change_inserted -970929547 1515111124
28366 DocBookItemWrapperAttr
28374 \begin_inset Flex Code
28377 \begin_layout Plain Layout
28379 \change_inserted -970929547 1515111124
28387 ] Specifies attribute information to be output with the item wrapper tag,
28389 \begin_inset Quotes eld
28393 \begin_inset Flex Code
28396 \begin_layout Plain Layout
28398 \change_inserted -970929547 1515111150
28407 \begin_inset Quotes erd
28410 in the example above.
28411 This information can be used in further processing of the DocBook files.
28417 \begin_layout Description
28419 \change_inserted -970929547 1515111113
28420 \begin_inset Flex Code
28423 \begin_layout Plain Layout
28425 \change_inserted -970929547 1515111073
28426 DocBookItemWrapperTag
28434 \begin_inset Flex Code
28437 \begin_layout Plain Layout
28439 \change_inserted -970929547 1515111073
28447 ] The tag to be used for the item wrapper tag within the inset, replacing
28449 \begin_inset Quotes eld
28453 \begin_inset Flex Code
28456 \begin_layout Plain Layout
28458 \change_inserted -970929547 1515111083
28467 \begin_inset Quotes erd
28470 in the example above.
28472 \begin_inset Flex Code
28475 \begin_layout Plain Layout
28477 \change_inserted -970929547 1515111073
28485 , indicating that there is no item wrapper tag: tag and content are directly
28486 output without it for each itemised element.
28487 This parameter only makes sense when itemising layouts are used, such as
28494 \begin_layout Description
28496 \change_inserted -970929547 1515110104
28497 \begin_inset Flex Code
28500 \begin_layout Plain Layout
28502 \change_inserted -970929547 1515110104
28511 \begin_inset Flex Code
28514 \begin_layout Plain Layout
28516 \change_inserted -970929547 1515110104
28524 ] Specifies attribute information to be output with the inner tag, replacing
28526 \begin_inset Quotes eld
28530 \begin_inset Flex Code
28533 \begin_layout Plain Layout
28535 \change_inserted -970929547 1515110104
28544 \begin_inset Quotes erd
28547 in the example above.
28548 This information can be used in further processing of the DocBook files.
28552 \begin_layout Description
28554 \change_inserted -970929547 1515110906
28555 \begin_inset Flex Code
28558 \begin_layout Plain Layout
28560 \change_inserted -970929547 1515110104
28569 \begin_inset Flex Code
28572 \begin_layout Plain Layout
28574 \change_inserted -970929547 1515110104
28582 ] The tag to be used for the inner tag within the inset, replacing
28583 \begin_inset Quotes eld
28587 \begin_inset Flex Code
28590 \begin_layout Plain Layout
28592 \change_inserted -970929547 1515110104
28601 \begin_inset Quotes erd
28604 in the example above.
28606 \begin_inset Flex Code
28609 \begin_layout Plain Layout
28611 \change_inserted -970929547 1515110791
28619 , indicating that there is no inner tag: content is directly output without
28623 \begin_layout Description
28625 \change_inserted -970929547 1515110753
28626 \begin_inset Flex Code
28629 \begin_layout Plain Layout
28631 \change_inserted -970929547 1515110665
28640 \begin_inset Flex Code
28643 \begin_layout Plain Layout
28645 \change_inserted -970929547 1515110661
28653 ] Specifies the tag that corresponds to this kind of section.
28654 This parameter only makes sense for sectioning elements (part, chapter,
28656 The default value is
28657 \begin_inset Flex Code
28660 \begin_layout Plain Layout
28662 \change_inserted -970929547 1515110721
28670 , and is only overridden when DocBook uses something else for sectioning
28671 (parts and chapters of a book).
28677 \begin_layout Description
28679 \change_inserted -970929547 1515110811
28680 \begin_inset Flex Code
28683 \begin_layout Plain Layout
28685 \change_inserted -970929547 1496612023
28694 \begin_inset Flex Code
28697 \begin_layout Plain Layout
28699 \change_inserted -970929547 1496610966
28707 ] The tag to be used for this inset, replacing
28708 \begin_inset Quotes eld
28712 \begin_inset Flex Code
28715 \begin_layout Plain Layout
28717 \change_inserted -970929547 1496612033
28726 \begin_inset Quotes erd
28729 in the example above.
28730 The default is the name of the float and always needs to be changed, as
28731 DocBook provides no generic inset tag.
28734 \begin_layout Description
28736 \change_inserted -970929547 1515110832
28737 \begin_inset Flex Code
28740 \begin_layout Plain Layout
28742 \change_inserted -970929547 1515110822
28751 \begin_inset Flex Code
28754 \begin_layout Plain Layout
28756 \change_inserted -970929547 1515110811
28764 ] Specifies attribute information to be output with the outer tag, replacing
28766 \begin_inset Quotes eld
28770 \begin_inset Flex Code
28773 \begin_layout Plain Layout
28775 \change_inserted -970929547 1515110845
28784 \begin_inset Quotes erd
28787 in the example above.
28788 This information can be used in further processing of the DocBook files.
28792 \begin_layout Description
28794 \change_inserted -970929547 1515110917
28795 \begin_inset Flex Code
28798 \begin_layout Plain Layout
28800 \change_inserted -970929547 1515110826
28809 \begin_inset Flex Code
28812 \begin_layout Plain Layout
28814 \change_inserted -970929547 1515110811
28822 ] The tag to be used for the wrapper tag around the inset, replacing
28823 \begin_inset Quotes eld
28827 \begin_inset Flex Code
28830 \begin_layout Plain Layout
28832 \change_inserted -970929547 1515110842
28841 \begin_inset Quotes erd
28844 in the example above.
28846 \begin_inset Flex Code
28849 \begin_layout Plain Layout
28851 \change_inserted -970929547 1515110811
28859 , indicating that there is no wrapper tag: tag and content are directly
28861 \change_deleted -970929547 1515111523
28865 \begin_layout Subsection
28867 \change_inserted -970929547 1515110040
28871 \begin_layout Standard
28873 \change_inserted -970929547 1496611700
28874 The DocBook output for floats too can be controlled by layout information.
28875 The output has the following form:
28878 \begin_layout LyX-Code
28880 \change_inserted -970929547 1515109700
28884 \begin_layout LyX-Code
28886 \change_inserted -970929547 1515110138
28887 Contents of the float as DocBook.
28890 \begin_layout LyX-Code
28892 \change_inserted -970929547 1496610966
28896 \begin_layout Standard
28898 \change_inserted -970929547 1496611715
28899 The caption, if there is one, is a separate inset and will be output as
28904 \begin_layout Description
28906 \change_inserted -970929547 1515110033
28907 \begin_inset Flex Code
28910 \begin_layout Plain Layout
28912 \change_inserted -970929547 1515109702
28921 \begin_inset Flex Code
28924 \begin_layout Plain Layout
28926 \change_inserted -970929547 1496610966
28934 ] Specifies attribute information to be output with the main tag, replacing
28936 \begin_inset Quotes eld
28940 \begin_inset Flex Code
28943 \begin_layout Plain Layout
28945 \change_inserted -970929547 1515110035
28954 \begin_inset Quotes erd
28957 in the example above.
28958 This information can be used in further processing of the DocBook files.
28962 \begin_layout Description
28964 \change_inserted -970929547 1515110157
28965 \begin_inset Flex Code
28968 \begin_layout Plain Layout
28970 \change_inserted -970929547 1496611782
28979 \begin_inset Flex Code
28982 \begin_layout Plain Layout
28984 \change_inserted -970929547 1496610966
28992 ] The tag to be used for this float, replacing
28993 \begin_inset Quotes eld
28997 \begin_inset Flex Code
29000 \begin_layout Plain Layout
29002 \change_inserted -970929547 1496610966
29011 \begin_inset Quotes erd
29014 in the example above.
29015 The default is the name of the float and always needs to be changed, as
29016 DocBook provides no generic float tag.
29019 \begin_layout Subsection
29021 \change_inserted -970929547 1515110157
29022 Bibliography formatting
29025 \begin_layout Standard
29027 \change_inserted -970929547 1515110187
29028 The bibliography cannot be formatted: all fields are always output in the
29029 database-like DocBook format (equivalent to a BibTeX file).
29034 \begin_layout Chapter
29035 Including External Material
29036 \begin_inset CommandInset label
29038 name "chap:Including-External-Material"
29045 \begin_layout Standard
29046 \begin_inset Box Shadowbox
29056 height_special "totalheight"
29061 backgroundcolor "none"
29064 \begin_layout Plain Layout
29065 WARNING: This portion of the documentation has not been updated for some
29067 We certainly hope that it is still accurate, but there are no guarantees.
29075 \begin_layout Standard
29076 The use of material from sources external to \SpecialChar LyX
29077 is covered in detail in the
29083 This part of the manual covers what needs to happen behind the scenes for
29084 new sorts of material to be included.
29087 \begin_layout Section
29091 \begin_layout Standard
29092 The external material feature is based on the concept of a
29097 A template is a specification of how \SpecialChar LyX
29098 should interface with a certain kind
29100 As bundled, \SpecialChar LyX
29101 comes with predefined templates for Xfig figures, various
29102 raster format images, chess diagrams, and LilyPond music notation.
29103 You can check the actual list by using the menu
29104 \begin_inset Flex Noun
29107 \begin_layout Plain Layout
29108 Insert\SpecialChar menuseparator
29109 File\SpecialChar menuseparator
29116 Furthermore, it is possible to roll your own template to support a specific
29118 Later we'll describe in more detail what is involved, and hopefully you
29119 will submit all the templates you create so we can include them in a later
29124 \begin_layout Standard
29125 Another basic idea of the external material feature is to distinguish between
29126 the original file that serves as a base for final material and the produced
29127 file that is included in your exported or printed document.
29128 For example, consider the case of a figure produced with
29129 \begin_inset Flex Code
29132 \begin_layout Plain Layout
29139 The Xfig application itself works on an original file with the
29140 \begin_inset Flex Code
29143 \begin_layout Plain Layout
29150 Within Xfig, you create and change your figure, and when you are done,
29152 \begin_inset Flex Code
29155 \begin_layout Plain Layout
29162 When you want to include the figure in your document, you invoke
29163 \begin_inset Flex Code
29166 \begin_layout Plain Layout
29172 in order to create a PostScript file that can readily be included in your
29176 \begin_inset Flex Code
29179 \begin_layout Plain Layout
29185 file is the original file, and the PostScript file is the produced file.
29188 \begin_layout Standard
29189 This distinction is important in order to allow updating of the material
29190 while you are in the process of writing the document.
29191 Furthermore, it provides us with the flexibility that is needed to support
29192 multiple export formats.
29193 For instance, in the case of a plain text file, it is not exactly an award-winn
29194 ing idea to include the figure as raw PostScript.
29195 Instead, you would either prefer to just include a reference to the figure
29196 or try to invoke some graphics to ASCII converter to make the final result
29197 look similar to the real graphics.
29198 The external material management allows you to do this, because it is parametri
29199 zed on the different export formats that \SpecialChar LyX
29203 \begin_layout Standard
29204 Besides supporting the production of different products according to the
29205 exported format, it supports tight integration with editing and viewing
29207 In the case of an Xfig figure, you are able to invoke Xfig on the original
29208 file with a single click from within the external material dialog in \SpecialChar LyX
29210 and also preview the produced PostScript file with Ghostview with another
29212 No more fiddling around with the command line and/or file browsers to locate
29213 and manipulate the original or produced files.
29214 In this way, you are finally able to take full advantage of the many different
29215 applications that are relevant to use when you write your documents, and
29216 ultimately be more productive.
29219 \begin_layout Section
29220 The external template configuration files
29223 \begin_layout Standard
29224 It is relatively easy to add custom external template definitions to \SpecialChar LyX
29226 However, be aware that doing this in an careless manner most probably
29230 introduce an easily exploitable security hole.
29231 So before you do this, please read the discussion about security in
29232 \begin_inset CommandInset ref
29234 reference "sec:Security-discussion"
29241 \begin_layout Standard
29242 Having said that, we encourage you to submit any interesting templates that
29247 \begin_layout Standard
29248 The external templates are defined in the
29249 \begin_inset Flex Code
29252 \begin_layout Plain Layout
29258 files that are stored in the
29259 \begin_inset Flex Code
29262 \begin_layout Plain Layout
29263 LyXDir/lib/xtemplates/
29269 Each template is defined in a file of its own.
29270 You can place your own templates in
29271 \begin_inset Flex Code
29274 \begin_layout Plain Layout
29275 UserDir/xtemplates/
29280 or copy existing templates to that directory in order to modify them.
29283 \begin_layout Standard
29284 A typical template looks like this:
29287 \begin_layout LyX-Code
29291 \begin_layout LyX-Code
29292 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
29295 \begin_layout LyX-Code
29299 \begin_layout LyX-Code
29303 \begin_layout LyX-Code
29307 \begin_layout LyX-Code
29311 \begin_layout LyX-Code
29315 \begin_layout LyX-Code
29316 AutomaticProduction true
29319 \begin_layout LyX-Code
29323 \begin_layout LyX-Code
29327 \begin_layout LyX-Code
29331 \begin_layout LyX-Code
29332 TransformCommand Rotate RotationLatexCommand
29335 \begin_layout LyX-Code
29336 TransformCommand Resize ResizeLatexCommand
29339 \begin_layout LyX-Code
29340 Product "$$RotateFront$$ResizeFront
29343 \begin_layout LyX-Code
29348 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
29351 \begin_layout LyX-Code
29352 $$ResizeBack$$RotateBack"
29355 \begin_layout LyX-Code
29359 \begin_layout LyX-Code
29360 UpdateResult "$$AbsPath$$Basename.pstex_t"
29363 \begin_layout LyX-Code
29364 Requirement "graphicx"
29367 \begin_layout LyX-Code
29368 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
29371 \begin_layout LyX-Code
29372 ReferencedFile latex "$$AbsPath$$Basename.eps"
29375 \begin_layout LyX-Code
29376 ReferencedFile dvi "$$AbsPath$$Basename.eps"
29379 \begin_layout LyX-Code
29383 \begin_layout LyX-Code
29387 \begin_layout LyX-Code
29388 TransformCommand Rotate RotationLatexCommand
29391 \begin_layout LyX-Code
29392 TransformCommand Resize ResizeLatexCommand
29395 \begin_layout LyX-Code
29396 Product "$$RotateFront$$ResizeFront
29399 \begin_layout LyX-Code
29404 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
29407 \begin_layout LyX-Code
29408 $$ResizeBack$$RotateBack"
29411 \begin_layout LyX-Code
29412 UpdateFormat pdftex
29415 \begin_layout LyX-Code
29416 UpdateResult "$$AbsPath$$Basename.pdftex_t"
29419 \begin_layout LyX-Code
29420 Requirement "graphicx"
29423 \begin_layout LyX-Code
29424 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
29427 \begin_layout LyX-Code
29428 ReferencedFile latex "$$AbsPath$$Basename.pdf"
29431 \begin_layout LyX-Code
29435 \begin_layout LyX-Code
29439 \begin_layout LyX-Code
29440 Product "[XFig: $$FName]"
29443 \begin_layout LyX-Code
29447 \begin_layout LyX-Code
29451 \begin_layout LyX-Code
29452 Product "<graphic fileref=
29454 "$$AbsOrRelPathMaster$$Basename.eps
29459 \begin_layout LyX-Code
29463 \begin_layout LyX-Code
29467 \begin_layout LyX-Code
29468 UpdateResult "$$AbsPath$$Basename.eps"
29471 \begin_layout LyX-Code
29472 ReferencedFile docbook "$$AbsPath$$Basename.eps"
29475 \begin_layout LyX-Code
29476 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
29479 \begin_layout LyX-Code
29483 \begin_layout LyX-Code
29487 \begin_layout Standard
29488 As you can see, the template is enclosed in
29489 \begin_inset Flex Code
29492 \begin_layout Plain Layout
29500 \begin_inset Flex Code
29503 \begin_layout Plain Layout
29510 It contains a header specifying some general settings and, for each supported
29511 primary document file format, a section
29512 \begin_inset Flex Code
29515 \begin_layout Plain Layout
29523 \begin_inset Flex Code
29526 \begin_layout Plain Layout
29535 \begin_layout Subsection
29536 The template header
29539 \begin_layout Description
29540 \begin_inset Flex Code
29543 \begin_layout Plain Layout
29544 AutomaticProduction
29545 \begin_inset space ~
29553 Whether the file represented by the template must be generated by \SpecialChar LyX
29555 This command must occur exactly once.
29558 \begin_layout Description
29559 \begin_inset Flex Code
29562 \begin_layout Plain Layout
29564 \begin_inset space ~
29572 A glob pattern that is used in the file dialog to filter out the desired
29574 If there is more than one possible file extension (e.
29575 \begin_inset space \thinspace{}
29579 \begin_inset space \space{}
29583 \begin_inset Flex Code
29586 \begin_layout Plain Layout
29593 \begin_inset Flex Code
29596 \begin_layout Plain Layout
29602 ), use something like
29603 \begin_inset Flex Code
29606 \begin_layout Plain Layout
29613 This command must occur exactly once.
29616 \begin_layout Description
29617 \begin_inset Flex Code
29620 \begin_layout Plain Layout
29622 \begin_inset space ~
29630 The text that is displayed on the button.
29631 This command must occur exactly once.
29634 \begin_layout Description
29635 \begin_inset Flex Code
29638 \begin_layout Plain Layout
29640 \begin_inset space ~
29644 \begin_inset space ~
29652 The help text that is used in the External dialog.
29653 Provide enough information to explain to the user just what the template
29654 can provide him with.
29655 This command must occur exactly once.
29658 \begin_layout Description
29659 \begin_inset Flex Code
29662 \begin_layout Plain Layout
29664 \begin_inset space ~
29672 The file format of the original file.
29673 This must be the name of a format that is known to \SpecialChar LyX
29675 \begin_inset CommandInset ref
29677 reference "sec:Formats"
29683 \begin_inset Quotes eld
29687 \begin_inset Flex Code
29690 \begin_layout Plain Layout
29697 \begin_inset Quotes erd
29700 if the template can handle original files of more than one format.
29702 will attempt to interrogate the file itself in order to deduce its format
29704 This command must occur exactly once.
29707 \begin_layout Description
29708 \begin_inset Flex Code
29711 \begin_layout Plain Layout
29713 \begin_inset space ~
29721 A unique name for the template.
29722 It must not contain substitution macros (see below).
29725 \begin_layout Description
29726 \begin_inset Flex Code
29729 \begin_layout Plain Layout
29731 \begin_inset space ~
29734 Rotate|Resize|Clip|Extra
29739 This command specifies which transformations are supported by this template.
29740 It may occur zero or more times.
29741 This command enables the corresponding tabs in the external dialog.
29743 \begin_inset Flex Code
29746 \begin_layout Plain Layout
29752 command must have either a corresponding
29753 \begin_inset Flex Code
29756 \begin_layout Plain Layout
29763 \begin_inset Flex Code
29766 \begin_layout Plain Layout
29773 \begin_inset Flex Code
29776 \begin_layout Plain Layout
29783 Otherwise the transformation will not be supported by that format.
29786 \begin_layout Subsection
29790 \begin_layout Description
29791 \begin_inset Flex Code
29794 \begin_layout Plain Layout
29796 \begin_inset space ~
29799 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
29804 The primary document file format that this format definition is for.
29805 Not every template has a sensible representation in all document file formats.
29806 Please define nevertheless a
29807 \begin_inset Flex Code
29810 \begin_layout Plain Layout
29816 section for all templates.
29817 Use a dummy text when no representation is available.
29818 Then you can at least see a reference to the external material in the exported
29822 \begin_layout Description
29823 \begin_inset Flex Code
29826 \begin_layout Plain Layout
29828 \begin_inset space ~
29832 \begin_inset space ~
29840 This command defines an additional macro
29841 \begin_inset Flex Code
29844 \begin_layout Plain Layout
29850 for substitution in
29851 \begin_inset Flex Code
29854 \begin_layout Plain Layout
29862 \begin_inset Flex Code
29865 \begin_layout Plain Layout
29871 itself may contain substitution macros.
29872 The advantage over using
29873 \begin_inset Flex Code
29876 \begin_layout Plain Layout
29883 \begin_inset Flex Code
29886 \begin_layout Plain Layout
29892 is that the substituted value of
29893 \begin_inset Flex Code
29896 \begin_layout Plain Layout
29902 is sanitized so that it is a valid optional argument in the document format.
29903 This command may occur zero or more times.
29906 \begin_layout Description
29907 \begin_inset Flex Code
29910 \begin_layout Plain Layout
29912 \begin_inset space ~
29920 The text that is inserted in the exported document.
29921 This is actually the most important command and can be quite complex.
29922 This command must occur exactly once.
29925 \begin_layout Description
29926 \begin_inset Flex Code
29929 \begin_layout Plain Layout
29931 \begin_inset space ~
29939 This command specifies a preamble snippet that will be included in the
29942 It has to be defined using
29943 \begin_inset Flex Code
29946 \begin_layout Plain Layout
29954 \begin_inset Flex Code
29957 \begin_layout Plain Layout
29964 This command may occur zero or more times.
29967 \begin_layout Description
29968 \begin_inset Flex Code
29971 \begin_layout Plain Layout
29973 \begin_inset space ~
29977 \begin_inset space ~
29985 This command denotes files that are created by the conversion process and
29986 are needed for a particular export format.
29987 If the filename is relative, it is interpreted relative to the master document.
29988 This command may be given zero or more times.
29991 \begin_layout Description
29992 \begin_inset Flex Code
29995 \begin_layout Plain Layout
29997 \begin_inset space ~
30005 The name of a required \SpecialChar LaTeX
30007 The package is included via
30008 \begin_inset Flex Code
30011 \begin_layout Plain Layout
30019 in the \SpecialChar LaTeX
30021 This command may occur zero or more times.
30024 \begin_layout Description
30025 \begin_inset Flex Code
30028 \begin_layout Plain Layout
30030 \begin_inset space ~
30034 \begin_inset space ~
30037 RotationLatexCommand
30042 This command specifies that the built in \SpecialChar LaTeX
30043 command should be used for rotation.
30044 This command may occur once or not at all.
30047 \begin_layout Description
30048 \begin_inset Flex Code
30051 \begin_layout Plain Layout
30053 \begin_inset space ~
30057 \begin_inset space ~
30065 This command specifies that the built in \SpecialChar LaTeX
30066 command should be used for resizing.
30067 This command may occur once or not at all.
30070 \begin_layout Description
30071 \begin_inset Flex Code
30074 \begin_layout Plain Layout
30076 \begin_inset space ~
30080 \begin_inset space ~
30083 RotationLatexOption
30088 This command specifies that rotation is done via an optional argument.
30089 This command may occur once or not at all.
30092 \begin_layout Description
30093 \begin_inset Flex Code
30096 \begin_layout Plain Layout
30098 \begin_inset space ~
30102 \begin_inset space ~
30110 This command specifies that resizing is done via an optional argument.
30111 This command may occur once or not at all.
30114 \begin_layout Description
30115 \begin_inset Flex Code
30118 \begin_layout Plain Layout
30120 \begin_inset space ~
30124 \begin_inset space ~
30132 This command specifies that clipping is done via an optional argument.
30133 This command may occur once or not at all.
30136 \begin_layout Description
30137 \begin_inset Flex Code
30140 \begin_layout Plain Layout
30142 \begin_inset space ~
30146 \begin_inset space ~
30154 This command specifies that an extra optional argument is used.
30155 This command may occur once or not at all.
30158 \begin_layout Description
30159 \begin_inset Flex Code
30162 \begin_layout Plain Layout
30164 \begin_inset space ~
30172 The file format of the converted file.
30173 This must be the name of a format that is known to \SpecialChar LyX
30175 \begin_inset Flex Noun
30178 \begin_layout Plain Layout
30179 Tools\SpecialChar menuseparator
30180 Preferences\SpecialChar menuseparator
30181 File Handling\SpecialChar menuseparator
30188 This command must occur exactly once.
30189 If the resulting file format is PDF, you need to specify the format
30190 \begin_inset Flex Code
30193 \begin_layout Plain Layout
30200 This is the PDF format used for including graphics.
30201 The other defined PDF formats are for document export.
30204 \begin_layout Description
30205 \begin_inset Flex Code
30208 \begin_layout Plain Layout
30210 \begin_inset space ~
30218 The file name of the converted file.
30219 The file name must be absolute.
30220 This command must occur exactly once.
30223 \begin_layout Subsection
30224 Preamble definitions
30227 \begin_layout Standard
30228 The external template configuration file may contain additional preamble
30229 definitions enclosed by
30230 \begin_inset Flex Code
30233 \begin_layout Plain Layout
30241 \begin_inset Flex Code
30244 \begin_layout Plain Layout
30251 They can be used by the templates in the
30252 \begin_inset Flex Code
30255 \begin_layout Plain Layout
30264 \begin_layout Section
30265 The substitution mechanism
30268 \begin_layout Standard
30269 When the external material facility invokes an external program, it is done
30270 on the basis of a command defined in the template configuration file.
30271 These commands can contain various macros that are expanded before execution.
30272 Execution always take place in the directory of the containing document.
30275 \begin_layout Standard
30276 Also, whenever external material is to be displayed, the name will be produced
30277 by the substitution mechanism, and most other commands in the template
30278 definition support substitution as well.
30281 \begin_layout Standard
30282 The available macros are the following:
30285 \begin_layout Description
30286 \begin_inset Flex Code
30289 \begin_layout Plain Layout
30290 $$AbsOrRelPathMaster
30295 The file path, absolute or relative to the master \SpecialChar LyX
30299 \begin_layout Description
30300 \begin_inset Flex Code
30303 \begin_layout Plain Layout
30304 $$AbsOrRelPathParent
30309 The file path, absolute or relative to the \SpecialChar LyX
30313 \begin_layout Description
30314 \begin_inset Flex Code
30317 \begin_layout Plain Layout
30323 The absolute file path.
30326 \begin_layout Description
30327 \begin_inset Flex Code
30330 \begin_layout Plain Layout
30336 The filename without path and without the extension.
30339 \begin_layout Description
30340 \begin_inset Flex Code
30343 \begin_layout Plain Layout
30345 \begin_inset Quotes eld
30349 \begin_inset Quotes erd
30357 This macro will expand to the contents of the file with the name
30358 \begin_inset Flex Code
30361 \begin_layout Plain Layout
30370 \begin_layout Description
30371 \begin_inset Flex Code
30374 \begin_layout Plain Layout
30380 The file extension (including the dot).
30383 \begin_layout Description
30384 \begin_inset Flex Code
30387 \begin_layout Plain Layout
30393 This will be the string
30394 \begin_inset Quotes eld
30398 \begin_inset Quotes erd
30401 if the file is in JPEG format, otherwise it will be the string
30402 \begin_inset Quotes eld
30406 \begin_inset Quotes erd
30410 This is useful to avoid uneeded conversions for output formats that support
30411 both PNG and JPEG fomats.
30412 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
30417 \begin_layout Description
30418 \begin_inset Flex Code
30421 \begin_layout Plain Layout
30427 The filename of the file specified in the external material dialog.
30428 This is either an absolute name, or it is relative to the \SpecialChar LyX
30432 \begin_layout Description
30433 \begin_inset Flex Code
30436 \begin_layout Plain Layout
30443 \begin_inset Flex Code
30446 \begin_layout Plain Layout
30452 (absolute name or relative to the \SpecialChar LyX
30456 \begin_layout Description
30457 \begin_inset Flex Code
30460 \begin_layout Plain Layout
30466 The file path, relative to the master \SpecialChar LyX
30470 \begin_layout Description
30471 \begin_inset Flex Code
30474 \begin_layout Plain Layout
30480 The file path, relative to the \SpecialChar LyX
30484 \begin_layout Description
30485 \begin_inset Flex Code
30488 \begin_layout Plain Layout
30494 This macro will expand to the absolute path of the system directory.
30495 This is typically used to point to the various helper scripts that are
30496 bundled with \SpecialChar LyX
30500 \begin_layout Description
30501 \begin_inset Flex Code
30504 \begin_layout Plain Layout
30510 A name and full path to a temporary file which will be automatically deleted
30511 whenever the containing document is closed, or the external material insertion
30515 \begin_layout Standard
30516 All path macros contain a trailing directory separator, so you can construct
30518 \begin_inset space \thinspace{}
30522 \begin_inset space \space{}
30525 the absolute filename with
30526 \begin_inset Flex Code
30529 \begin_layout Plain Layout
30530 $$AbsPath$$Basename$$Extension
30538 \begin_layout Standard
30539 The macros above are substituted in all commands unless otherwise noted.
30541 \begin_inset Flex Code
30544 \begin_layout Plain Layout
30550 supports additionally the following substitutions if they are enabled by
30552 \begin_inset Flex Code
30555 \begin_layout Plain Layout
30562 \begin_inset Flex Code
30565 \begin_layout Plain Layout
30574 \begin_layout Description
30575 \begin_inset Flex Code
30578 \begin_layout Plain Layout
30584 The front part of the resize command.
30587 \begin_layout Description
30588 \begin_inset Flex Code
30591 \begin_layout Plain Layout
30597 The back part of the resize command.
30600 \begin_layout Description
30601 \begin_inset Flex Code
30604 \begin_layout Plain Layout
30610 The front part of the rotation command.
30613 \begin_layout Description
30614 \begin_inset Flex Code
30617 \begin_layout Plain Layout
30623 The back part of the rotation command.
30626 \begin_layout Standard
30627 The value string of the
30628 \begin_inset Flex Code
30631 \begin_layout Plain Layout
30637 command supports additionally the following substitutions if they are enabled
30639 \begin_inset Flex Code
30642 \begin_layout Plain Layout
30649 \begin_inset Flex Code
30652 \begin_layout Plain Layout
30661 \begin_layout Description
30662 \begin_inset Flex Code
30665 \begin_layout Plain Layout
30674 \begin_layout Description
30675 \begin_inset Flex Code
30678 \begin_layout Plain Layout
30687 \begin_layout Description
30688 \begin_inset Flex Code
30691 \begin_layout Plain Layout
30700 \begin_layout Description
30701 \begin_inset Flex Code
30704 \begin_layout Plain Layout
30710 The rotation option.
30713 \begin_layout Standard
30714 You may ask why there are so many path macros.
30715 There are mainly two reasons:
30718 \begin_layout Enumerate
30719 Relative and absolute file names should remain relative or absolute, respectivel
30721 Users may have reasons to prefer either form.
30722 Relative names are useful for portable documents that should work on different
30723 machines, for example.
30724 Absolute names may be required by some programs.
30727 \begin_layout Enumerate
30729 treats relative file names differently than \SpecialChar LyX
30730 and other programs in nested
30732 For \SpecialChar LyX
30733 , a relative file name is always relative to the document that contains
30735 For \SpecialChar LaTeX
30736 , it is always relative to the master document.
30737 These two definitions are identical if you have only one document, but
30738 differ if you have a master document that includes part documents.
30739 That means that relative filenames must be transformed when presented to
30742 Fortunately \SpecialChar LyX
30743 does this automatically for you if you choose the right macros.
30746 \begin_layout Standard
30747 So which path macro should be used in new template definitions? The rule
30751 \begin_layout Itemize
30753 \begin_inset Flex Code
30756 \begin_layout Plain Layout
30762 if an absolute path is required.
30765 \begin_layout Itemize
30767 \begin_inset Flex Code
30770 \begin_layout Plain Layout
30771 $$AbsOrRelPathMaster
30776 if the substituted string is some kind of \SpecialChar LaTeX
30780 \begin_layout Itemize
30782 \begin_inset Flex Code
30785 \begin_layout Plain Layout
30786 $$AbsOrRelPathParent
30791 in order to preserve the user's choice.
30794 \begin_layout Standard
30795 There are special cases where this rule does not work and e.
30796 \begin_inset space \thinspace{}
30800 \begin_inset space \space{}
30803 relative names are needed, but normally it will work just fine.
30804 One example for such a case is the command
30805 \begin_inset Flex Code
30808 \begin_layout Plain Layout
30809 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
30814 in the XFig template above: We can't use the absolute name because the
30816 \begin_inset Flex Code
30819 \begin_layout Plain Layout
30825 files needs the relative name in order to rewrite the file content.
30828 \begin_layout Section
30829 Security discussion
30830 \begin_inset CommandInset label
30832 name "sec:Security-discussion"
30839 \begin_layout Standard
30840 The external material feature interfaces with a lot of external programs
30841 and does so automatically, so we have to consider the security implications
30843 In particular, since you have the option of including your own filenames
30844 and/or parameter strings and those are expanded into a command, it seems
30845 that it would be possible to create a malicious document which executes
30846 arbitrary commands when a user views or prints the document.
30847 This is something we definitely want to avoid.
30850 \begin_layout Standard
30851 However, since the external program commands are specified in the template
30852 configuration file only, there are no security issues if \SpecialChar LyX
30853 is properly configure
30854 d with safe templates only.
30855 This is so because the external programs are invoked with the
30856 \begin_inset Flex Code
30859 \begin_layout Plain Layout
30865 -system call rather than the
30866 \begin_inset Flex Code
30869 \begin_layout Plain Layout
30875 system-call, so it's not possible to execute arbitrary commands from the
30876 filename or parameter section via the shell.
30879 \begin_layout Standard
30880 This also implies that you are restricted in what command strings you can
30881 use in the external material templates.
30882 In particular, pipes and redirection are not readily available.
30883 This has to be so if \SpecialChar LyX
30884 should remain safe.
30885 If you want to use some of the shell features, you should write a safe
30886 script to do this in a controlled manner, and then invoke the script from
30887 the command string.
30891 \begin_layout Standard
30892 It is possible to design a template that interacts directly with the shell,
30893 but since this would allow a malicious user to execute arbitrary commands
30894 by writing clever filenames and/or parameters, we generally recommend that
30895 you only use safe scripts that work with the
30896 \begin_inset Flex Code
30899 \begin_layout Plain Layout
30905 system call in a controlled manner.
30906 Of course, for use in a controlled environment, it can be tempting to just
30907 fall back to use ordinary shell scripts.
30908 If you do so, be aware that you
30912 provide an easily exploitable security hole in your system.
30913 Of course it stands to reason that such unsafe templates will never be
30914 included in the standard \SpecialChar LyX
30915 distribution, although we do encourage people
30916 to submit new templates in the open source tradition.
30917 But \SpecialChar LyX
30918 as shipped from the official distribution channels will never have
30922 \begin_layout Standard
30923 Including external material provides a lot of power, and you have to be
30924 careful not to introduce security hazards with this power.
30925 A subtle error in a single line in an innocent looking script can open
30926 the door to huge security problems.
30927 So if you do not fully understand the issues, we recommend that you consult
30928 a knowledgeable security professional or the \SpecialChar LyX
30929 development team if you have
30930 any questions about whether a given template is safe or not.
30931 And do this before you use it in an uncontrolled environment.
30934 \begin_layout Chapter
30936 List of supported \SpecialChar LyX
30937 functions to be used in layouts
30938 \begin_inset CommandInset label
30940 name "chap:List-of-functions"
30947 \begin_layout Standard
30949 \begin_inset Tabular
30950 <lyxtabular version="3" rows="11" columns="8">
30951 <features tabularvalignment="middle">
30952 <column alignment="left" valignment="top">
30953 <column alignment="left" valignment="top">
30954 <column alignment="left" valignment="top">
30955 <column alignment="left" valignment="top">
30956 <column alignment="left" valignment="top">
30957 <column alignment="left" valignment="top">
30958 <column alignment="left" valignment="top">
30959 <column alignment="left" valignment="top">
30961 <cell alignment="left" valignment="top" usebox="none">
30964 \begin_layout Plain Layout
30970 <cell alignment="left" valignment="top" usebox="none">
30973 \begin_layout Plain Layout
30979 <cell alignment="left" valignment="top" usebox="none">
30982 \begin_layout Plain Layout
30988 <cell alignment="left" valignment="top" usebox="none">
30991 \begin_layout Plain Layout
30997 <cell alignment="center" valignment="top" usebox="none">
31000 \begin_layout Plain Layout
31006 <cell alignment="center" valignment="top" usebox="none">
31009 \begin_layout Plain Layout
31015 <cell alignment="center" valignment="top" usebox="none">
31018 \begin_layout Plain Layout
31024 <cell alignment="center" valignment="top" usebox="none">
31027 \begin_layout Plain Layout
31035 <cell alignment="left" valignment="top" usebox="none">
31038 \begin_layout Plain Layout
31044 <cell alignment="left" valignment="top" usebox="none">
31047 \begin_layout Plain Layout
31053 <cell alignment="left" valignment="top" usebox="none">
31056 \begin_layout Plain Layout
31062 <cell alignment="left" valignment="top" usebox="none">
31065 \begin_layout Plain Layout
31071 <cell alignment="center" valignment="top" usebox="none">
31074 \begin_layout Plain Layout
31080 <cell alignment="center" valignment="top" usebox="none">
31083 \begin_layout Plain Layout
31089 <cell alignment="center" valignment="top" usebox="none">
31092 \begin_layout Plain Layout
31098 <cell alignment="center" valignment="top" usebox="none">
31101 \begin_layout Plain Layout
31109 <cell alignment="left" valignment="top" usebox="none">
31112 \begin_layout Plain Layout
31118 <cell alignment="left" valignment="top" usebox="none">
31121 \begin_layout Plain Layout
31127 <cell alignment="left" valignment="top" usebox="none">
31130 \begin_layout Plain Layout
31136 <cell alignment="left" valignment="top" usebox="none">
31139 \begin_layout Plain Layout
31145 <cell alignment="center" valignment="top" usebox="none">
31148 \begin_layout Plain Layout
31154 <cell alignment="center" valignment="top" usebox="none">
31157 \begin_layout Plain Layout
31163 <cell alignment="center" valignment="top" usebox="none">
31166 \begin_layout Plain Layout
31172 <cell alignment="center" valignment="top" usebox="none">
31175 \begin_layout Plain Layout
31183 <cell alignment="left" valignment="top" usebox="none">
31186 \begin_layout Plain Layout
31192 <cell alignment="left" valignment="top" usebox="none">
31195 \begin_layout Plain Layout
31201 <cell alignment="left" valignment="top" usebox="none">
31204 \begin_layout Plain Layout
31210 <cell alignment="left" valignment="top" usebox="none">
31213 \begin_layout Plain Layout
31219 <cell alignment="center" valignment="top" usebox="none">
31222 \begin_layout Plain Layout
31228 <cell alignment="center" valignment="top" usebox="none">
31231 \begin_layout Plain Layout
31237 <cell alignment="center" valignment="top" usebox="none">
31240 \begin_layout Plain Layout
31246 <cell alignment="center" valignment="top" usebox="none">
31249 \begin_layout Plain Layout
31257 <cell alignment="left" valignment="top" usebox="none">
31260 \begin_layout Plain Layout
31266 <cell alignment="left" valignment="top" usebox="none">
31269 \begin_layout Plain Layout
31275 <cell alignment="left" valignment="top" usebox="none">
31278 \begin_layout Plain Layout
31284 <cell alignment="left" valignment="top" usebox="none">
31287 \begin_layout Plain Layout
31293 <cell alignment="center" valignment="top" usebox="none">
31296 \begin_layout Plain Layout
31302 <cell alignment="center" valignment="top" usebox="none">
31305 \begin_layout Plain Layout
31311 <cell alignment="center" valignment="top" usebox="none">
31314 \begin_layout Plain Layout
31320 <cell alignment="center" valignment="top" usebox="none">
31323 \begin_layout Plain Layout
31331 <cell alignment="left" valignment="top" usebox="none">
31334 \begin_layout Plain Layout
31340 <cell alignment="left" valignment="top" usebox="none">
31343 \begin_layout Plain Layout
31349 <cell alignment="left" valignment="top" usebox="none">
31352 \begin_layout Plain Layout
31358 <cell alignment="left" valignment="top" usebox="none">
31361 \begin_layout Plain Layout
31367 <cell alignment="center" valignment="top" usebox="none">
31370 \begin_layout Plain Layout
31376 <cell alignment="center" valignment="top" usebox="none">
31379 \begin_layout Plain Layout
31385 <cell alignment="center" valignment="top" usebox="none">
31388 \begin_layout Plain Layout
31394 <cell alignment="center" valignment="top" usebox="none">
31397 \begin_layout Plain Layout
31405 <cell alignment="left" valignment="top" usebox="none">
31408 \begin_layout Plain Layout
31414 <cell alignment="left" valignment="top" usebox="none">
31417 \begin_layout Plain Layout
31423 <cell alignment="left" valignment="top" usebox="none">
31426 \begin_layout Plain Layout
31432 <cell alignment="left" valignment="top" usebox="none">
31435 \begin_layout Plain Layout
31441 <cell alignment="center" valignment="top" usebox="none">
31444 \begin_layout Plain Layout
31450 <cell alignment="center" valignment="top" usebox="none">
31453 \begin_layout Plain Layout
31459 <cell alignment="center" valignment="top" usebox="none">
31462 \begin_layout Plain Layout
31468 <cell alignment="center" valignment="top" usebox="none">
31471 \begin_layout Plain Layout
31479 <cell alignment="left" valignment="top" usebox="none">
31482 \begin_layout Plain Layout
31488 <cell alignment="left" valignment="top" usebox="none">
31491 \begin_layout Plain Layout
31497 <cell alignment="left" valignment="top" usebox="none">
31500 \begin_layout Plain Layout
31506 <cell alignment="left" valignment="top" usebox="none">
31509 \begin_layout Plain Layout
31515 <cell alignment="center" valignment="top" usebox="none">
31518 \begin_layout Plain Layout
31524 <cell alignment="center" valignment="top" usebox="none">
31527 \begin_layout Plain Layout
31533 <cell alignment="center" valignment="top" usebox="none">
31536 \begin_layout Plain Layout
31542 <cell alignment="center" valignment="top" usebox="none">
31545 \begin_layout Plain Layout
31553 <cell alignment="left" valignment="top" usebox="none">
31556 \begin_layout Plain Layout
31562 <cell alignment="left" valignment="top" usebox="none">
31565 \begin_layout Plain Layout
31571 <cell alignment="left" valignment="top" usebox="none">
31574 \begin_layout Plain Layout
31580 <cell alignment="left" valignment="top" usebox="none">
31583 \begin_layout Plain Layout
31589 <cell alignment="center" valignment="top" usebox="none">
31592 \begin_layout Plain Layout
31598 <cell alignment="center" valignment="top" usebox="none">
31601 \begin_layout Plain Layout
31607 <cell alignment="center" valignment="top" usebox="none">
31610 \begin_layout Plain Layout
31616 <cell alignment="center" valignment="top" usebox="none">
31619 \begin_layout Plain Layout
31627 <cell alignment="left" valignment="top" usebox="none">
31630 \begin_layout Plain Layout
31636 <cell alignment="left" valignment="top" usebox="none">
31639 \begin_layout Plain Layout
31645 <cell alignment="left" valignment="top" usebox="none">
31648 \begin_layout Plain Layout
31654 <cell alignment="left" valignment="top" usebox="none">
31657 \begin_layout Plain Layout
31663 <cell alignment="center" valignment="top" usebox="none">
31666 \begin_layout Plain Layout
31672 <cell alignment="center" valignment="top" usebox="none">
31675 \begin_layout Plain Layout
31681 <cell alignment="center" valignment="top" usebox="none">
31684 \begin_layout Plain Layout
31690 <cell alignment="center" valignment="top" usebox="none">
31693 \begin_layout Plain Layout
31701 <cell alignment="center" valignment="top" usebox="none">
31704 \begin_layout Plain Layout
31710 <cell alignment="center" valignment="top" usebox="none">
31713 \begin_layout Plain Layout
31719 <cell alignment="center" valignment="top" usebox="none">
31722 \begin_layout Plain Layout
31728 <cell alignment="center" valignment="top" usebox="none">
31731 \begin_layout Plain Layout
31737 <cell alignment="center" valignment="top" usebox="none">
31740 \begin_layout Plain Layout
31746 <cell alignment="center" valignment="top" usebox="none">
31749 \begin_layout Plain Layout
31755 <cell alignment="center" valignment="top" usebox="none">
31758 \begin_layout Plain Layout
31764 <cell alignment="center" valignment="top" usebox="none">
31767 \begin_layout Plain Layout
31781 \begin_layout Chapter
31782 Names of available colors to be used in layouts
31783 \begin_inset CommandInset label
31785 name "chap:Names-of-colors"
31792 \begin_layout Standard
31793 The colors listed below are the standard colors and those that you can adjust
31794 in the \SpecialChar LyX
31798 \begin_layout Section
31802 \begin_layout Standard
31803 The following are no real colors, but rather act on color definitions:
31806 \begin_layout Description
31807 ignore The color is ignored
31810 \begin_layout Description
31811 inherit The color is inherited
31814 \begin_layout Description
31827 No particular color – clear or default
31830 \begin_layout Section
31834 \begin_layout Standard
31835 These are fixed colors that cannot be customized:
31838 \begin_layout Description
31842 \begin_layout Description
31846 \begin_layout Description
31850 \begin_layout Description
31854 \begin_layout Description
31858 \begin_layout Description
31862 \begin_layout Description
31866 \begin_layout Description
31870 \begin_layout Description
31874 \begin_layout Description
31878 \begin_layout Description
31882 \begin_layout Description
31886 \begin_layout Description
31890 \begin_layout Description
31894 \begin_layout Description
31898 \begin_layout Description
31902 \begin_layout Description
31906 \begin_layout Description
31910 \begin_layout Description
31914 \begin_layout Section
31918 \begin_layout Standard
31919 These are the colors allocated to specific elements in
31922 arg "dialog-show prefs"
31928 \begin_layout Description
31929 added_space Added space color
31932 \begin_layout Description
31933 addedtext Added text color
31936 \begin_layout Description
31937 appendix Appendix marker color
31940 \begin_layout Description
31941 background Background color
31944 \begin_layout Description
31945 bottomarea Bottom area color
31948 \begin_layout Description
31949 branchlabel Label color for branches
31952 \begin_layout Description
31953 buttonbg Color used for button background
31956 \begin_layout Description
31957 buttonframe Color for inset button frames
31960 \begin_layout Description
31961 buttonhoverbg Color used for button background under focus
31964 \begin_layout Description
31965 changebar Changebar color
31968 \begin_layout Description
31969 changedtextauthor1 Changed text color author 1
31972 \begin_layout Description
31973 changedtextauthor2 Changed text color author 2
31976 \begin_layout Description
31977 changedtextauthor3 Changed text color author 3
31980 \begin_layout Description
31981 changedtextauthor4 Changed text color author 4
31984 \begin_layout Description
31985 changedtextauthor5 Changed text color author 5
31988 \begin_layout Description
31989 collapsible Collapsible insets text color
31992 \begin_layout Description
31993 collapsibleframe Collapsible insets framecolor
31996 \begin_layout Description
31997 command Text color for command insets
32000 \begin_layout Description
32001 commandbg Background color for command insets
32004 \begin_layout Description
32005 commandframe Frame color for command insets
32008 \begin_layout Description
32009 comment Label color for comments
32012 \begin_layout Description
32013 commentbg Background color of comments
32016 \begin_layout Description
32017 cursor Cursor color
32020 \begin_layout Description
32021 deletedtext Deleted text color
32024 \begin_layout Description
32025 deletedtextmodifier Deleted text modifying color
32028 \begin_layout Description
32029 depthbar Color for the depth bars in the margin
32032 \begin_layout Description
32033 eolmarker End of line marker color
32036 \begin_layout Description
32037 error Color of the \SpecialChar LaTeX
32041 \begin_layout Description
32042 footlabel Label color for footnotes
32045 \begin_layout Description
32046 foreground Foreground color
32049 \begin_layout Description
32050 graphicsbg Graphics inset background color
32053 \begin_layout Description
32054 greyedoutbg Background color of greyedout inset
32057 \begin_layout Description
32058 greyedoutlabel Label color for greyedout insets
32061 \begin_layout Description
32062 greyedouttext Color for greyedout inset text
32065 \begin_layout Description
32066 indexlabel Label color for index insets
32069 \begin_layout Description
32070 inlinecompletion Inline completion color
32073 \begin_layout Description
32074 insetbg Inset marker background color
32077 \begin_layout Description
32078 insetframe Inset marker frame color
32081 \begin_layout Description
32082 language Color for marking foreign language words
32085 \begin_layout Description
32086 latex Text color in \SpecialChar LaTeX
32090 \begin_layout Description
32091 listingsbg Background color of listings inset
32094 \begin_layout Description
32095 marginlabel Label color for margin notes
32098 \begin_layout Description
32099 math Math inset text color
32102 \begin_layout Description
32103 mathbg Math inset background color
32106 \begin_layout Description
32107 mathcorners Math inset frame color not under focus
32110 \begin_layout Description
32111 mathframe Math inset frame color under focus
32114 \begin_layout Description
32115 mathline Math line color
32118 \begin_layout Description
32119 mathmacrobg Macro math inset background color
32122 \begin_layout Description
32123 mathmacroblend Macro math blended color
32126 \begin_layout Description
32127 mathmacroframe Macro math frame color
32130 \begin_layout Description
32131 mathmacrohoverbg Macro math inset background color hovered
32134 \begin_layout Description
32135 mathmacrolabel Macro math label color
32138 \begin_layout Description
32139 mathmacronewarg Macro template color for new parameters
32142 \begin_layout Description
32143 mathmacrooldarg Macro template color for old parameters
32146 \begin_layout Description
32147 newpage New page color
32150 \begin_layout Description
32151 nonunique_inlinecompletion Inline completion color for the non-unique part
32154 \begin_layout Description
32155 note Label color for notes
32158 \begin_layout Description
32159 notebg Background color of notes
32162 \begin_layout Description
32163 pagebreak Page break/line break color
32166 \begin_layout Description
32167 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
32170 \begin_layout Description
32171 phantomtext Text color for phantom insets
32174 \begin_layout Description
32175 preview The color used for previews
32178 \begin_layout Description
32179 previewframe Preview frame color
32182 \begin_layout Description
32183 regexpframe Color for regexp frame
32186 \begin_layout Description
32187 scroll Color that indicates when a row can be scrolled
32190 \begin_layout Description
32191 selection Background color of selected text
32194 \begin_layout Description
32195 selectiontext Foreground color of selected text
32198 \begin_layout Description
32199 shadedbg Background color of shaded box
32202 \begin_layout Description
32203 special Special chars text color
32206 \begin_layout Description
32207 tabularline Table line color
32210 \begin_layout Description
32211 tabularonoffline Table line color
32214 \begin_layout Description
32215 urllabel Label color for URL insets
32218 \begin_layout Description
32219 urltext Color for URL inset text